BootTrait.php

<?php
namespace Civi\Cv\Util;

use Civi\Cv\ErrorHandler;
use Civi\Cv\Log\InternalLogger;
use Civi\Cv\Log\SymfonyConsoleLogger;
use Civi\Cv\PharOut\PharOut;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * This trait can be mixed into a Symfony `Command` to provide Civi/CMS-bootstrap options.
 *
 * It first boots Civi and then boots the CMS.
 */
trait BootTrait {

  public function configureBootOptions($defaultLevel = 'full|cms-full') {
    $this->addOption('level', NULL, InputOption::VALUE_REQUIRED, 'Bootstrap level (none,classloader,settings,full,cms-only,cms-full)', $defaultLevel);
    $this->addOption('hostname', NULL, InputOption::VALUE_REQUIRED, 'Hostname (for a multisite system)');
    $this->addOption('test', 't', InputOption::VALUE_NONE, 'Bootstrap the test database (CIVICRM_UF=UnitTests)');
    $this->addOption('user', 'U', InputOption::VALUE_REQUIRED, 'CMS user');
  }

  public function boot(InputInterface $input, OutputInterface $output) {
    $logger = $this->bootLogger($output);
    $logger->debug('Start');

    $GLOBALS['civicrm_url_defaults'] = $GLOBALS['civicrm_url_defaults'] ?? [];
    array_unshift($GLOBALS['civicrm_url_defaults'], [
      'format' => 'absolute',
      'scheme' => 'default',
    ]);

    $this->setupErrorHandling($output);

    if ($input->hasOption('test') && $input->getOption('test')) {
      $logger->debug('Use test mode');
      putenv('CIVICRM_UF=UnitTests');
      $_ENV['CIVICRM_UF'] = 'UnitTests';
    }

    if ($input->getOption('level') === 'full|cms-full') {
      if (getenv('CIVICRM_UF') === 'UnitTests') {
        $input->setOption('level', 'full');
      }
      elseif (getenv('CIVICRM_BOOT')) {
        $input->setOption('level', 'cms-full');
      }
      elseif (getenv('CIVICRM_SETTINGS')) {
        $input->setOption('level', 'full');
      }
      else {
        $input->setOption('level', 'full');
        // TODO (when tests pass, for v0.4): $input->setOption('level', 'cms-full');
      }
    }

    if (getenv('CIVICRM_UF') === 'UnitTests' && preg_match('/^cms-/', $input->getOption('level'))) {
      throw new \Exception("UnitTest bootstrapping is not compatible with CMS bootstrapping");
    }

    $func = '_boot_' . strtr($input->getOption('level'), '-', '_');

    if (is_callable([$this, $func])) {
      call_user_func([$this, $func], $input, $output);
    }
    else {
      throw new \Exception("Unrecognized bootstrap level");
    }

    // CMS may have installed wonky error-handling. Add our own.
    ErrorHandler::pushHandler();

    $logger->debug('Finished');
  }

  /**
   * Do not do anything for bootstrap. Just use the given environment.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   */
  public function _boot_none(InputInterface $input, OutputInterface $output) {
    $this->bootLogger($output)->debug('Skip');
  }

  /**
   * Setup the CiviCRM classloader.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   */
  public function _boot_classloader(InputInterface $input, OutputInterface $output) {
    $this->bootLogger($output)->debug('Call basic cv bootstrap (' . $input->getOption('level') . ')');
    \Civi\Cv\Bootstrap::singleton()->boot($this->createBootParams($input, $output) + array(
      'prefetch' => FALSE,
    ));
  }

  /**
   * Get the CiviCRM classloader and settings file.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   */
  public function _boot_settings(InputInterface $input, OutputInterface $output) {
    $this->bootLogger($output)->debug('Call basic cv bootstrap (' . $input->getOption('level') . ')');

    \Civi\Cv\Bootstrap::singleton()->boot($this->createBootParams($input, $output) + array(
      'prefetch' => FALSE,
    ));
  }

  /**
   * Boot CiviCRM, then boot the corresponding CMS.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @throws \Exception
   */
  public function _boot_full(InputInterface $input, OutputInterface $output) {
    PharOut::prepare();

    $logger = $this->bootLogger($output);
    $logger->debug('Call standard cv bootstrap');

    \Civi\Cv\Bootstrap::singleton()->boot($this->createBootParams($input, $output));

    $logger->debug('Call core bootstrap');

    \CRM_Core_Config::singleton();

    $logger->debug('Call CMS bootstrap');

    \CRM_Utils_System::loadBootStrap(array(), FALSE);

    if ($input->getOption('user')) {
      $logger->debug('Set system user');

      if (is_callable(array(\CRM_Core_Config::singleton()->userSystem, 'loadUser'))) {
        if (!\CRM_Core_Config::singleton()->userSystem->loadUser($input->getOption('user')) || !$this->ensureUserContact($output)) {
          throw new \Exception("Failed to determine contactID for user=" . $input->getOption('user'));
        }
      }
      else {
        $output->getErrorOutput()->writeln("<error>Failed to set user. Feature not supported by UF (" . CIVICRM_UF . ")</error>");
      }
    }

    if (is_callable([\CRM_Core_Config::singleton()->userSystem, 'setMySQLTimeZone'])) {
      $logger->debug('Set active MySQL timezone');

      \CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
    }

    if (CIVICRM_UF === 'Joomla') {
      PharOut::reset();
    }
  }

  /**
   * Boot only the CMS.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @return \Civi\Cv\CmsBootstrap
   */
  public function _boot_cms_only(InputInterface $input, OutputInterface $output) {
    $bootstrap = $this->createCmsBootstrap($input, $output);
    $this->bootLogger($output)->debug('Call CMS bootstrap');

    $bootstrap->bootCms();
    return $bootstrap;
  }

  /**
   * Boot the CMS, then boot CiviCRM.
   *
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @return \Civi\Cv\CmsBootstrap
   */
  public function _boot_cms_full(InputInterface $input, OutputInterface $output) {
    $bootstrap = $this->_boot_cms_only($input, $output);
    $this->bootLogger($output)->debug('Call Civi bootstrap');

    $bootstrap->bootCivi();
    return $bootstrap;
  }

  /**
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @return \Civi\Cv\CmsBootstrap
   */
  protected function createCmsBootstrap(InputInterface $input, OutputInterface $output) {
    if ($output->isDebug()) {
      // add the output object to allow the bootstrapper to output debug messages
      // and track verboisty
      $boot_params = array('output' => $output);
    }
    else {
      $boot_params = array();
    }

    if ($input->getOption('user')) {
      $boot_params['user'] = $input->getOption('user');
    }
    if ($input->getOption('hostname')) {
      $boot_params['httpHost'] = $input->getOption('hostname');
    }

    return \Civi\Cv\CmsBootstrap::singleton()->addOptions($boot_params);
  }

  /**
   * Ensure that the current user has a contact record.
   *
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @return int|NULL
   *   The user's contact ID, or NULL
   */
  public function ensureUserContact(OutputInterface $output) {
    if ($cid = \CRM_Core_Session::getLoggedInContactID()) {
      return $cid;
    }

    // Ugh, this codepath is ridiculous.
    switch (CIVICRM_UF) {
      case 'Drupal':
      case 'Drupal6':
      case 'Backdrop':
        \CRM_Core_BAO_UFMatch::synchronize($GLOBALS['user'], TRUE, CIVICRM_UF, 'Individual');
        break;

      case 'Drupal8':
        $user = \Drupal\user\Entity\User::load(\Drupal::currentUser()->id());
        \CRM_Core_BAO_UFMatch::synchronize($user, TRUE, CIVICRM_UF, 'Individual');
        break;

      case 'Joomla':
        \CRM_Core_BAO_UFMatch::synchronize(\JFactory::getUser(), TRUE, CIVICRM_UF, 'Individual');
        break;

      case 'Standalone':
        // At time of writing, support for 'loggedInUser' is in a PR. Once the functionality is merged, we can update/simplify this.
        if (empty($GLOBALS['loggedInUser'])) {
          $this->bootLogger($output)->error('Failed to sync user/contact. You may be running a pre-release of civicrm-standalone.');

        }
        else {
          \CRM_Core_BAO_UFMatch::synchronize($GLOBALS['loggedInUser'], TRUE, CIVICRM_UF, 'Individual');
        }
        break;

      case 'WordPress':
        \CRM_Core_BAO_UFMatch::synchronize($GLOBALS['current_user'], TRUE, CIVICRM_UF, 'Individual');
        break;

      default:
        $this->bootLogger($output)->error("Unrecognized UF: " . CIVICRM_UF);

    }

    return \CRM_Core_Session::getLoggedInContactID();
  }

  protected function setupErrorHandling(OutputInterface $output) {
    $this->bootLogger($output)->debug('Attempting to set verbose error reporting');

    // standard php debug chat settings
    error_reporting(E_ALL | E_STRICT);
    ini_set('display_errors', 'stderr');
    ini_set('display_startup_errors', TRUE);
  }

  /**
   * @param \Symfony\Component\Console\Input\InputInterface $input
   * @param \Symfony\Component\Console\Output\OutputInterface $output
   * @return array
   */
  protected function createBootParams(InputInterface $input, OutputInterface $output) {
    $boot_params = [];
    if ($output->isDebug()) {
      $boot_params['output'] = $output;
    }
    if ($input->getOption('hostname')) {
      $boot_params['httpHost'] = $input->getOption('hostname');
    }
    return $boot_params;
  }

  private function bootLogger(OutputInterface $output): InternalLogger {
    return new SymfonyConsoleLogger('BootTrait', $output);
  }

}