diff --git a/core/modules/config/config.admin.inc b/core/modules/config/config.admin.inc index e81c582..9d6a605 100644 --- a/core/modules/config/config.admin.inc +++ b/core/modules/config/config.admin.inc @@ -10,136 +10,6 @@ use Drupal\Core\Ajax\OpenModalDialogCommand; /** - * Helper function to construct the storage changes in a configuration synchronization form. - * - * @param array $form - * The form structure to add to. Passed by reference. - * @param array $form_state - * The current state of the form. Passed by reference. - * @param Drupal\Core\Config\StorageInterface $source_storage - * The source storage to retrieve differences from. - * @param Drupal\Core\Config\StorageInterface $target_storage - * The target storage to compare differences to. - */ -function config_admin_sync_form(array &$form, array &$form_state, StorageInterface $source_storage, StorageInterface $target_storage) { - $source_list = $source_storage->listAll(); - if (empty($source_list)) { - $form['no_changes'] = array( - '#markup' => t('There is no configuration to import.'), - ); - $form['actions']['#access'] = FALSE; - return $form; - } - - $config_changes = config_sync_get_changes($source_storage, $target_storage); - if (empty($config_changes)) { - $form['no_changes'] = array( - '#markup' => t('There are no configuration changes.'), - ); - return $form; - } - - // Add the AJAX library to the form for dialog support. - $form['#attached']['library'][] = array('system', 'drupal.ajax'); - - foreach ($config_changes as $config_change_type => $config_files) { - if (empty($config_files)) { - continue; - } - - // @todo A table caption would be more appropriate, but does not have the - // visual importance of a heading. - $form[$config_change_type]['heading'] = array( - '#theme' => 'html_tag__h3', - '#tag' => 'h3', - ); - switch ($config_change_type) { - case 'create': - $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count new', '@count new'); - break; - - case 'change': - $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count changed', '@count changed'); - break; - - case 'delete': - $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count removed', '@count removed'); - break; - } - $form[$config_change_type]['list'] = array( - '#theme' => 'table', - '#header' => array('Name', 'Operations'), - ); - - foreach ($config_files as $config_file) { - $links['view_diff'] = array( - 'title' => t('View differences'), - 'href' => 'admin/config/development/sync/diff/' . $config_file, - 'attributes' => array( - 'class' => array('use-ajax'), - ), - ); - $form[$config_change_type]['list']['#rows'][] = array( - 'name' => $config_file, - 'operations' => array( - 'data' => array( - '#type' => 'operations', - '#links' => $links, - ), - ), - ); - } - } -} - -/** - * Form constructor for configuration import form. - * - * @see config_admin_import_form_submit() - * @see config_import() - */ -function config_admin_import_form($form, &$form_state) { - // Retrieve a list of differences between last known state and active store. - $source_storage = drupal_container()->get('config.storage.staging'); - $target_storage = drupal_container()->get('config.storage'); - - $form['actions'] = array('#type' => 'actions'); - $form['actions']['submit'] = array( - '#type' => 'submit', - '#value' => t('Import all'), - ); - - config_admin_sync_form($form, $form_state, $source_storage, $target_storage); - - return $form; -} - -/** - * Form submission handler for config_admin_import_form(). - */ -function config_admin_import_form_submit($form, &$form_state) { - if (!lock()->lockMayBeAvailable(CONFIG_IMPORT_LOCK)) { - drupal_set_message(t('Another request may be synchronizing configuration already.')); - } - else if (config_import()) { - // Once a sync completes, we empty the staging directory. This prevents - // changes from being accidentally overwritten by stray files getting - // imported later. - $source_storage = drupal_container()->get('config.storage.staging'); - foreach ($source_storage->listAll() as $name) { - $source_storage->delete($name); - } - - drupal_flush_all_caches(); - - drupal_set_message(t('The configuration was imported successfully.')); - } - else { - drupal_set_message(t('The import failed due to an error. Any errors have been logged.'), 'error'); - } -} - -/** * Page callback: Shows diff of specificed configuration file. * * @param string $config_file diff --git a/core/modules/config/config.module b/core/modules/config/config.module index e3b6027..c7dd2c4 100644 --- a/core/modules/config/config.module +++ b/core/modules/config/config.module @@ -43,10 +43,7 @@ function config_menu() { $items['admin/config/development/sync'] = array( 'title' => 'Synchronize configuration', 'description' => 'Synchronize configuration changes.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('config_admin_import_form'), - 'access arguments' => array('synchronize configuration'), - 'file' => 'config.admin.inc', + 'route_name' => 'config_admin_import', ); $items['admin/config/development/sync/diff/%'] = array( 'title' => 'Configuration file diff', diff --git a/core/modules/config/config.routing.yml b/core/modules/config/config.routing.yml new file mode 100644 index 0000000..f76dd07 --- /dev/null +++ b/core/modules/config/config.routing.yml @@ -0,0 +1,6 @@ +config_admin_import: + pattern: '/admin/config/development/sync' + defaults: + _form: '\Drupal\config\Form\ConfigAdminImportForm' + requirements: + _permission: 'synchronize configuration' diff --git a/core/modules/config/lib/Drupal/config/Form/ConfigAdminImportForm.php b/core/modules/config/lib/Drupal/config/Form/ConfigAdminImportForm.php new file mode 100644 index 0000000..3c36e1e --- /dev/null +++ b/core/modules/config/lib/Drupal/config/Form/ConfigAdminImportForm.php @@ -0,0 +1,188 @@ +sourceStorage = $source_storage; + $this->targetStorage = $target_storage; + $this->lock = $lock; + } + + /** + * Implements \Drupal\Core\ControllerInterface::create(). + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('config.storage.staging'), + $container->get('config.storage'), + $container->get('lock') + ); + } + + /** + * Implements \Drupal\Core\Form\FormInterface::getFormID(). + */ + public function getFormID() { + return 'config_admin_import'; + } + + /** + * Implements \Drupal\Core\Form\FormInterface::buildForm(). + */ + public function buildForm(array $form, array &$form_state) { + $form['actions'] = array( + '#type' => 'actions', + ); + $form['actions']['submit'] = array( + '#type' => 'submit', + '#value' => t('Import all'), + ); + + $source_list = $this->sourceStorage->listAll(); + if (empty($source_list)) { + $form['no_changes'] = array( + '#markup' => t('There is no configuration to import.'), + ); + $form['actions']['#access'] = FALSE; + return $form; + } + + $config_changes = config_sync_get_changes($this->sourceStorage, $this->targetStorage); + if (empty($config_changes)) { + $form['no_changes'] = array( + '#markup' => t('There are no configuration changes.'), + ); + return $form; + } + + // Add the AJAX library to the form for dialog support. + $form['#attached']['library'][] = array('system', 'drupal.ajax'); + + foreach ($config_changes as $config_change_type => $config_files) { + if (empty($config_files)) { + continue; + } + + // @todo A table caption would be more appropriate, but does not have the + // visual importance of a heading. + $form[$config_change_type]['heading'] = array( + '#theme' => 'html_tag__h3', + '#tag' => 'h3', + ); + switch ($config_change_type) { + case 'create': + $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count new', '@count new'); + break; + + case 'change': + $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count changed', '@count changed'); + break; + + case 'delete': + $form[$config_change_type]['heading']['#value'] = format_plural(count($config_files), '@count removed', '@count removed'); + break; + } + $form[$config_change_type]['list'] = array( + '#theme' => 'table', + '#header' => array('Name', 'Operations'), + ); + + foreach ($config_files as $config_file) { + $links['view_diff'] = array( + 'title' => t('View differences'), + 'href' => 'admin/config/development/sync/diff/' . $config_file, + 'attributes' => array( + 'class' => array('use-ajax'), + ), + ); + $form[$config_change_type]['list']['#rows'][] = array( + 'name' => $config_file, + 'operations' => array( + 'data' => array( + '#type' => 'operations', + '#links' => $links, + ), + ), + ); + } + } + return $form; + } + + /** + * Implements \Drupal\Core\Form\FormInterface::validateForm(). + */ + public function validateForm(array &$form, array &$form_state) { + } + + /** + * Implements \Drupal\Core\Form\FormInterface::validateForm(). + */ + public function submitForm(array &$form, array &$form_state) { + if (!$this->lock->lockMayBeAvailable(CONFIG_IMPORT_LOCK)) { + drupal_set_message(t('Another request may be synchronizing configuration already.')); + } + else if (config_import()) { + // Once a sync completes, we empty the staging directory. This prevents + // changes from being accidentally overwritten by stray files getting + // imported later. + foreach ($this->sourceStorage->listAll() as $name) { + $this->sourceStorage->delete($name); + } + + drupal_flush_all_caches(); + + drupal_set_message(t('The configuration was imported successfully.')); + } + else { + drupal_set_message(t('The import failed due to an error. Any errors have been logged.'), 'error'); + } + } +}