UpdateManagerInstall.php

<?php

namespace Drupal\update\Form;

use Drupal\Core\Archiver\ArchiverManager;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\File\FileExists;
use Drupal\Core\FileTransfer\Local;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Updater\Updater;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Response;

/**
 * Configure update settings for this site.
 *
 * @internal
 */
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 = [
                'FileExtension' => [
                    'extensions' => $this->archiverManager
                        ->getExtensions(),
                ],
            ];
            if (!($finfo = file_save_upload('project_upload', $validators, NULL, 0, FileExists::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());
        }
    }

}