View source
<?php
namespace Drupal\config\Form;
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\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\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
class ConfigSync extends FormBase {
protected $lock;
protected $syncStorage;
protected $activeStorage;
protected $snapshotStorage;
protected $eventDispatcher;
protected $configManager;
protected $typedConfigManager;
protected $moduleHandler;
protected $themeHandler;
protected $moduleInstaller;
protected $renderer;
protected $moduleExtensionList;
protected $importTransformer;
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 = 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;
if (is_null($import_transformer)) {
@trigger_error('The config.import_transformer service must be passed to ConfigSync::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/3066005.', E_USER_DEPRECATED);
$import_transformer = \Drupal::service('config.import_transformer');
}
$this->importTransformer = $import_transformer;
}
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'));
}
public function getFormId() {
return 'config_admin_import_form';
}
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);
if (empty($source_list) || !$storage_comparer
->createChangelist()
->hasChanges()) {
$form['no_changes'] = [
'#type' => 'table',
'#header' => [
$this
->t('Name'),
$this
->t('Operations'),
],
'#rows' => [],
'#empty' => $this
->t('There are no configuration changes to import.'),
];
$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;
}
if ($this->snapshotStorage
->exists('core.extension')) {
$snapshot_comparer = new StorageComparer($this->activeStorage, $this->snapshotStorage);
if (!$form_state
->getUserInput() && $snapshot_comparer
->createChangelist()
->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
->renderPlain($message));
}
}
$form_state
->set('storage_comparer', $storage_comparer);
$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;
}
$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;
}
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);
if ($config_importer
->alreadyImporting()) {
$this
->messenger()
->addStatus($this
->t('Another request may be synchronizing configuration already.'));
}
else {
try {
$sync_steps = $config_importer
->initialize();
$batch = [
'operations' => [],
'finished' => [
ConfigImporterBatch::class,
'finish',
],
'title' => t('Synchronizing configuration'),
'init_message' => t('Starting configuration synchronization.'),
'progress_message' => t('Completed step @current of @total.'),
'error_message' => t('Configuration synchronization has encountered an error.'),
];
foreach ($sync_steps as $sync_step) {
$batch['operations'][] = [
[
ConfigImporterBatch::class,
'process',
],
[
$config_importer,
$sync_step,
],
];
}
batch_set($batch);
} catch (ConfigImporterException $e) {
$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);
}
}
}
}
public static function processBatch(ConfigImporter $config_importer, $sync_step, &$context) {
@trigger_error('\\Drupal\\config\\Form\\ConfigSync::processBatch() deprecated in drupal:8.6.0 and will be removed before drupal:9.0.0. Use \\Drupal\\Core\\Config\\Importer\\ConfigImporterBatch::process() instead. See https://www.drupal.org/node/2897299', E_USER_DEPRECATED);
ConfigImporterBatch::process($config_importer, $sync_step, $context);
}
public static function finishBatch($success, $results, $operations) {
@trigger_error('\\Drupal\\config\\Form\\ConfigSync::finishBatch() deprecated in drupal:8.6.0 and will be removed before drupal:9.0.0. Use \\Drupal\\Core\\Config\\Importer\\ConfigImporterBatch::finish() instead. See https://www.drupal.org/node/2897299', E_USER_DEPRECATED);
ConfigImporterBatch::finish($success, $results, $operations);
}
}