ConfigSync.php

<?php

namespace Drupal\config\Form;

use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Config\ConfigImporterException;
use Drupal\Core\Config\ConfigImporter;
use Drupal\Core\Config\Importer\ConfigImporterBatch;
use Drupal\Core\Config\ImportStorageTransformer;
use Drupal\Core\Config\TypedConfigManagerInterface;
use Drupal\Core\Extension\ModuleExtensionList;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Extension\ModuleInstallerInterface;
use Drupal\Core\Extension\ThemeExtensionList;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Config\ConfigManagerInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Config\StorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\Config\StorageComparer;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Url;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Construct the storage changes in a configuration synchronization form.
 *
 * @internal
 */
class ConfigSync extends FormBase {
    
    /**
     * The database lock object.
     *
     * @var \Drupal\Core\Lock\LockBackendInterface
     */
    protected $lock;
    
    /**
     * The sync configuration object.
     *
     * @var \Drupal\Core\Config\StorageInterface
     */
    protected $syncStorage;
    
    /**
     * The active configuration object.
     *
     * @var \Drupal\Core\Config\StorageInterface
     */
    protected $activeStorage;
    
    /**
     * The snapshot configuration object.
     *
     * @var \Drupal\Core\Config\StorageInterface
     */
    protected $snapshotStorage;
    
    /**
     * Event dispatcher.
     *
     * @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
     */
    protected $eventDispatcher;
    
    /**
     * The configuration manager.
     *
     * @var \Drupal\Core\Config\ConfigManagerInterface
     */
    protected $configManager;
    
    /**
     * The typed config manager.
     *
     * @var \Drupal\Core\Config\TypedConfigManagerInterface
     */
    protected $typedConfigManager;
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * The theme handler.
     *
     * @var \Drupal\Core\Extension\ThemeHandlerInterface
     */
    protected $themeHandler;
    
    /**
     * The module installer.
     *
     * @var \Drupal\Core\Extension\ModuleInstallerInterface
     */
    protected $moduleInstaller;
    
    /**
     * The renderer.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * The module extension list.
     *
     * @var \Drupal\Core\Extension\ModuleExtensionList
     */
    protected $moduleExtensionList;
    
    /**
     * The import transformer service.
     *
     * @var \Drupal\Core\Config\ImportStorageTransformer
     */
    protected $importTransformer;
    
    /**
     * The theme extension list.
     *
     * @var \Drupal\Core\Extension\ThemeExtensionList
     */
    protected $themeExtensionList;
    
    /**
     * Constructs the object.
     *
     * @param \Drupal\Core\Config\StorageInterface $sync_storage
     *   The source storage.
     * @param \Drupal\Core\Config\StorageInterface $active_storage
     *   The target storage.
     * @param \Drupal\Core\Config\StorageInterface $snapshot_storage
     *   The snapshot storage.
     * @param \Drupal\Core\Lock\LockBackendInterface $lock
     *   The lock object.
     * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
     *   Event dispatcher.
     * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
     *   Configuration manager.
     * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
     *   The typed configuration manager.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     * @param \Drupal\Core\Extension\ModuleInstallerInterface $module_installer
     *   The module installer.
     * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
     *   The theme handler.
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer.
     * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
     *   The module extension list
     * @param \Drupal\Core\Config\ImportStorageTransformer $import_transformer
     *   The import transformer service.
     * @param \Drupal\Core\Extension\ThemeExtensionList $extension_list_theme
     *   The theme extension list.
     */
    public function __construct(StorageInterface $sync_storage, StorageInterface $active_storage, StorageInterface $snapshot_storage, LockBackendInterface $lock, EventDispatcherInterface $event_dispatcher, ConfigManagerInterface $config_manager, TypedConfigManagerInterface $typed_config, ModuleHandlerInterface $module_handler, ModuleInstallerInterface $module_installer, ThemeHandlerInterface $theme_handler, RendererInterface $renderer, ModuleExtensionList $extension_list_module, ImportStorageTransformer $import_transformer, ?ThemeExtensionList $extension_list_theme = NULL) {
        $this->syncStorage = $sync_storage;
        $this->activeStorage = $active_storage;
        $this->snapshotStorage = $snapshot_storage;
        $this->lock = $lock;
        $this->eventDispatcher = $event_dispatcher;
        $this->configManager = $config_manager;
        $this->typedConfigManager = $typed_config;
        $this->moduleHandler = $module_handler;
        $this->moduleInstaller = $module_installer;
        $this->themeHandler = $theme_handler;
        $this->renderer = $renderer;
        $this->moduleExtensionList = $extension_list_module;
        $this->importTransformer = $import_transformer;
        if ($extension_list_theme === NULL) {
            @trigger_error('Calling ' . __METHOD__ . ' without the $extension_list_theme argument is deprecated in drupal:10.1.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3284397', E_USER_DEPRECATED);
            $extension_list_theme = \Drupal::service('extension.list.theme');
        }
        $this->themeExtensionList = $extension_list_theme;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.storage.sync'), $container->get('config.storage'), $container->get('config.storage.snapshot'), $container->get('lock.persistent'), $container->get('event_dispatcher'), $container->get('config.manager'), $container->get('config.typed'), $container->get('module_handler'), $container->get('module_installer'), $container->get('theme_handler'), $container->get('renderer'), $container->get('extension.list.module'), $container->get('config.import_transformer'), $container->get('extension.list.theme'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'config_admin_import_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Import all'),
        ];
        $syncStorage = $this->importTransformer
            ->transform($this->syncStorage);
        $source_list = $syncStorage->listAll();
        $storage_comparer = new StorageComparer($syncStorage, $this->activeStorage);
        $storage_comparer->createChangelist();
        if (empty($source_list) || !$storage_comparer->hasChanges()) {
            $form['no_changes'] = [
                '#type' => 'table',
                '#header' => [
                    $this->t('Name'),
                    $this->t('Operations'),
                ],
                '#rows' => [],
                '#empty' => empty($source_list) ? $this->t('There is no staged configuration.') : $this->t('The staged configuration is identical to the active configuration.'),
            ];
            $form['actions']['#access'] = FALSE;
            return $form;
        }
        elseif (!$storage_comparer->validateSiteUuid()) {
            $this->messenger()
                ->addError($this->t('The staged configuration cannot be imported, because it originates from a different site than this site. You can only synchronize configuration between cloned instances of this site.'));
            $form['actions']['#access'] = FALSE;
            return $form;
        }
        // A list of changes will be displayed, so check if the user should be
        // warned of potential losses to configuration.
        if ($this->snapshotStorage
            ->exists('core.extension')) {
            $snapshot_comparer = new StorageComparer($this->activeStorage, $this->snapshotStorage);
            $snapshot_comparer->createChangelist();
            if (!$form_state->getUserInput() && $snapshot_comparer->hasChanges()) {
                $change_list = [];
                foreach ($snapshot_comparer->getAllCollectionNames() as $collection) {
                    foreach ($snapshot_comparer->getChangelist(NULL, $collection) as $config_names) {
                        if (empty($config_names)) {
                            continue;
                        }
                        foreach ($config_names as $config_name) {
                            $change_list[] = $config_name;
                        }
                    }
                }
                sort($change_list);
                $message = [
                    [
                        '#markup' => $this->t('The following items in your active configuration have changes since the last import that may be lost on the next import.'),
                    ],
                    [
                        '#theme' => 'item_list',
                        '#items' => $change_list,
                    ],
                ];
                $this->messenger()
                    ->addWarning($this->renderer
                    ->renderInIsolation($message));
            }
        }
        // Store the comparer for use in the submit.
        $form_state->set('storage_comparer', $storage_comparer);
        // Add the AJAX library to the form for dialog support.
        $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
        foreach ($storage_comparer->getAllCollectionNames() as $collection) {
            if ($collection != StorageInterface::DEFAULT_COLLECTION) {
                $form[$collection]['collection_heading'] = [
                    '#type' => 'html_tag',
                    '#tag' => 'h2',
                    '#value' => $this->t('@collection configuration collection', [
                        '@collection' => $collection,
                    ]),
                ];
            }
            foreach ($storage_comparer->getChangelist(NULL, $collection) as $config_change_type => $config_names) {
                if (empty($config_names)) {
                    continue;
                }
                // @todo A table caption would be more appropriate, but does not have the
                //   visual importance of a heading.
                $form[$collection][$config_change_type]['heading'] = [
                    '#type' => 'html_tag',
                    '#tag' => 'h3',
                ];
                switch ($config_change_type) {
                    case 'create':
                        $form[$collection][$config_change_type]['heading']['#value'] = $this->formatPlural(count($config_names), '@count new', '@count new');
                        break;
                    case 'update':
                        $form[$collection][$config_change_type]['heading']['#value'] = $this->formatPlural(count($config_names), '@count changed', '@count changed');
                        break;
                    case 'delete':
                        $form[$collection][$config_change_type]['heading']['#value'] = $this->formatPlural(count($config_names), '@count removed', '@count removed');
                        break;
                    case 'rename':
                        $form[$collection][$config_change_type]['heading']['#value'] = $this->formatPlural(count($config_names), '@count renamed', '@count renamed');
                        break;
                }
                $form[$collection][$config_change_type]['list'] = [
                    '#type' => 'table',
                    '#header' => [
                        $this->t('Name'),
                        $this->t('Operations'),
                    ],
                ];
                foreach ($config_names as $config_name) {
                    if ($config_change_type == 'rename') {
                        $names = $storage_comparer->extractRenameNames($config_name);
                        $route_options = [
                            'source_name' => $names['old_name'],
                            'target_name' => $names['new_name'],
                        ];
                        $config_name = $this->t('@source_name to @target_name', [
                            '@source_name' => $names['old_name'],
                            '@target_name' => $names['new_name'],
                        ]);
                    }
                    else {
                        $route_options = [
                            'source_name' => $config_name,
                        ];
                    }
                    if ($collection != StorageInterface::DEFAULT_COLLECTION) {
                        $route_name = 'config.diff_collection';
                        $route_options['collection'] = $collection;
                    }
                    else {
                        $route_name = 'config.diff';
                    }
                    $links['view_diff'] = [
                        'title' => $this->t('View differences'),
                        'url' => Url::fromRoute($route_name, $route_options),
                        'attributes' => [
                            'class' => [
                                'use-ajax',
                            ],
                            'data-dialog-type' => 'modal',
                            'data-dialog-options' => json_encode([
                                'width' => 700,
                            ]),
                        ],
                    ];
                    $form[$collection][$config_change_type]['list']['#rows'][] = [
                        'name' => $config_name,
                        'operations' => [
                            'data' => [
                                '#type' => 'operations',
                                '#links' => $links,
                            ],
                        ],
                    ];
                }
            }
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $config_importer = new ConfigImporter($form_state->get('storage_comparer'), $this->eventDispatcher, $this->configManager, $this->lock, $this->typedConfigManager, $this->moduleHandler, $this->moduleInstaller, $this->themeHandler, $this->getStringTranslation(), $this->moduleExtensionList, $this->themeExtensionList);
        if ($config_importer->alreadyImporting()) {
            $this->messenger()
                ->addStatus($this->t('Another request may be synchronizing configuration already.'));
        }
        else {
            try {
                $sync_steps = $config_importer->initialize();
                $batch_builder = (new BatchBuilder())->setTitle($this->t('Synchronizing configuration'))
                    ->setFinishCallback([
                    ConfigImporterBatch::class,
                    'finish',
                ])
                    ->setInitMessage($this->t('Starting configuration synchronization.'))
                    ->setProgressMessage($this->t('Completed step @current of @total.'))
                    ->setErrorMessage($this->t('Configuration synchronization has encountered an error.'));
                foreach ($sync_steps as $sync_step) {
                    $batch_builder->addOperation([
                        ConfigImporterBatch::class,
                        'process',
                    ], [
                        $config_importer,
                        $sync_step,
                    ]);
                }
                batch_set($batch_builder->toArray());
            } catch (ConfigImporterException $e) {
                // There are validation errors.
                $this->messenger()
                    ->addError($this->t('The configuration cannot be imported because it failed validation for the following reasons:'));
                foreach ($config_importer->getErrors() as $message) {
                    $this->messenger()
                        ->addError($message);
                }
            }
        }
    }

}