class UpdateManagerInstall in Drupal 9

Same name and namespace in other branches

8 core/modules/update/src/Form/UpdateManagerInstall.php \Drupal\update\Form\UpdateManagerInstall

Configure update settings for this site.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\update\Form\UpdateManagerInstall

Expanded class hierarchy of UpdateManagerInstall

1 string reference to 'UpdateManagerInstall'

update.routing.yml in core/modules/update/update.routing.yml: core/modules/update/update.routing.yml

File

core/modules/update/src/Form/UpdateManagerInstall.php, line 20

Namespace

Drupal\update\Form

View source

class UpdateManagerInstall extends FormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The root location under which installed projects will be saved.
   *
   * @var string
   */
  protected $root;

  /**
   * The site path.
   *
   * @var string
   */
  protected $sitePath;

  /**
   * The archiver plugin manager service.
   *
   * @var \Drupal\Core\Archiver\ArchiverManager
   */
  protected $archiverManager;

  /**
   * Constructs a new UpdateManagerInstall.
   *
   * @param string $root
   *   The root location under which installed projects will be saved.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param string $site_path
   *   The site path.
   * @param \Drupal\Core\Archiver\ArchiverManager $archiver_manager
   *   The archiver plugin manager service.
   */
  public function __construct($root, ModuleHandlerInterface $module_handler, $site_path, ArchiverManager $archiver_manager) {
    $this->root = $root;
    $this->moduleHandler = $module_handler;
    $this->sitePath = $site_path;
    $this->archiverManager = $archiver_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'update_manager_install_form';
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('update.root'), $container
      ->get('module_handler'), $container
      ->getParameter('site.path'), $container
      ->get('plugin.manager.archiver'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->moduleHandler
      ->loadInclude('update', 'inc', 'update.manager');
    if (!_update_manager_check_backends($form, 'install')) {
      return $form;
    }
    $form['help_text'] = [
      '#prefix' => '<p>',
      '#markup' => $this
        ->t('You can find <a href=":module_url">modules</a> and <a href=":theme_url">themes</a> on <a href=":drupal_org_url">drupal.org</a>. The following file extensions are supported: %extensions.', [
        ':module_url' => 'https://www.drupal.org/project/modules',
        ':theme_url' => 'https://www.drupal.org/project/themes',
        ':drupal_org_url' => 'https://www.drupal.org',
        '%extensions' => $this->archiverManager
          ->getExtensions(),
      ]),
      '#suffix' => '</p>',
    ];
    $form['project_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Add from a URL'),
      '#description' => $this
        ->t('For example: %url', [
        '%url' => 'https://ftp.drupal.org/files/projects/name.tar.gz',
      ]),
    ];

    // Provide upload option only if file module exists.
    if ($this->moduleHandler
      ->moduleExists('file')) {
      $form['information'] = [
        '#prefix' => '<strong>',
        '#markup' => $this
          ->t('Or'),
        '#suffix' => '</strong>',
      ];
      $form['project_upload'] = [
        '#type' => 'file',
        '#title' => $this
          ->t('Upload a module or theme archive'),
        '#description' => $this
          ->t('For example: %filename from your local computer', [
          '%filename' => 'name.tar.gz',
        ]),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t('Continue'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $all_files = $this
      ->getRequest()->files
      ->get('files', []);
    if ($this->moduleHandler
      ->moduleExists('file')) {
      if (!($form_state
        ->getValue('project_url') xor !empty($all_files['project_upload']))) {
        $form_state
          ->setErrorByName('project_url', $this
          ->t('You must either provide a URL or upload an archive file.'));
      }
    }
    else {
      if (!$form_state
        ->getValue('project_url')) {
        $form_state
          ->setErrorByName('project_url', $this
          ->t('You must provide a URL to install.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $local_cache = NULL;
    $all_files = $this
      ->getRequest()->files
      ->get('files', []);
    if ($form_state
      ->getValue('project_url')) {
      $local_cache = update_manager_file_get($form_state
        ->getValue('project_url'));
      if (!$local_cache) {
        $this
          ->messenger()
          ->addError($this
          ->t('Unable to retrieve Drupal project from %url.', [
          '%url' => $form_state
            ->getValue('project_url'),
        ]));
        return;
      }
    }
    elseif (!empty($all_files['project_upload']) && $this->moduleHandler
      ->moduleExists('file')) {
      $validators = [
        'file_validate_extensions' => [
          $this->archiverManager
            ->getExtensions(),
        ],
      ];
      if (!($finfo = file_save_upload('project_upload', $validators, NULL, 0, FileSystemInterface::EXISTS_REPLACE))) {

        // Failed to upload the file. file_save_upload() calls
        // \Drupal\Core\Messenger\MessengerInterface::addError() on failure.
        return;
      }
      $local_cache = $finfo
        ->getFileUri();
    }
    $directory = _update_manager_extract_directory();
    try {
      $archive = update_manager_archive_extract($local_cache, $directory);
    } catch (\Exception $e) {
      $this
        ->messenger()
        ->addError($e
        ->getMessage());
      return;
    }
    $files = $archive
      ->listContents();
    if (!$files) {
      $this
        ->messenger()
        ->addError($this
        ->t('Provided archive contains no files.'));
      return;
    }

    // Unfortunately, we can only use the directory name to determine the
    // project name. Some archivers list the first file as the directory (i.e.,
    // MODULE/) and others list an actual file (i.e., MODULE/README.TXT).
    $project = strtok($files[0], '/\\');
    $archive_errors = $this->moduleHandler
      ->invokeAll('verify_update_archive', [
      $project,
      $local_cache,
      $directory,
    ]);
    if (!empty($archive_errors)) {
      $this
        ->messenger()
        ->addError(array_shift($archive_errors));

      // @todo: Fix me in D8: We need a way to set multiple errors on the same
      // form element and have all of them appear!
      if (!empty($archive_errors)) {
        foreach ($archive_errors as $error) {
          $this
            ->messenger()
            ->addError($error);
        }
      }
      return;
    }

    // Make sure the Updater registry is loaded.
    drupal_get_updaters();
    $project_location = $directory . '/' . $project;
    try {
      $updater = Updater::factory($project_location, $this->root);
    } catch (\Exception $e) {
      $this
        ->messenger()
        ->addError($e
        ->getMessage());
      return;
    }
    try {
      $project_title = Updater::getProjectTitle($project_location);
    } catch (\Exception $e) {
      $this
        ->messenger()
        ->addError($e
        ->getMessage());
      return;
    }
    if (!$project_title) {
      $this
        ->messenger()
        ->addError($this
        ->t('Unable to determine %project name.', [
        '%project' => $project,
      ]));
    }
    if ($updater
      ->isInstalled()) {
      $this
        ->messenger()
        ->addError($this
        ->t('%project is already present.', [
        '%project' => $project_title,
      ]));
      return;
    }
    $project_real_location = \Drupal::service('file_system')
      ->realpath($project_location);
    $arguments = [
      'project' => $project,
      'updater_name' => get_class($updater),
      'local_url' => $project_real_location,
    ];

    // This process is inherently difficult to test therefore use a state flag.
    $test_authorize = FALSE;
    if (drupal_valid_test_ua()) {
      $test_authorize = \Drupal::state()
        ->get('test_uploaders_via_prompt', FALSE);
    }

    // If the owner of the directory we extracted is the same as the owner of
    // our configuration directory (e.g. sites/default) where we're trying to
    // install the code, there's no need to prompt for FTP/SSH credentials.
    // Instead, we instantiate a Drupal\Core\FileTransfer\Local and invoke
    // update_authorize_run_install() directly.
    if (fileowner($project_real_location) == fileowner($this->sitePath) && !$test_authorize) {
      $this->moduleHandler
        ->loadInclude('update', 'inc', 'update.authorize');
      $filetransfer = new Local($this->root, \Drupal::service('file_system'));
      $response = call_user_func_array('update_authorize_run_install', array_merge([
        $filetransfer,
      ], $arguments));
      if ($response instanceof Response) {
        $form_state
          ->setResponse($response);
      }
    }
    else {

      // The page title must be passed here to ensure it is initially used when
      // authorize.php loads for the first time with the FTP/SSH credentials
      // form.
      system_authorized_init('update_authorize_run_install', __DIR__ . '/../../update.authorize.inc', $arguments, $this
        ->t('Update manager'));
      $form_state
        ->setRedirectUrl(system_authorized_get_url());
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UpdateManagerInstall::$archiverManager	protected	property	The archiver plugin manager service.
UpdateManagerInstall::$moduleHandler	protected	property	The module handler.
UpdateManagerInstall::$root	protected	property	The root location under which installed projects will be saved.
UpdateManagerInstall::$sitePath	protected	property	The site path.
UpdateManagerInstall::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
UpdateManagerInstall::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
UpdateManagerInstall::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
UpdateManagerInstall::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
UpdateManagerInstall::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
UpdateManagerInstall::__construct	public	function	Constructs a new UpdateManagerInstall.

You are here

class UpdateManagerInstall in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation