Mercurial > hg > isophonics-drupal-site
view core/modules/config/src/Controller/ConfigController.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | af1871eacc83 |
children |
line wrap: on
line source
<?php namespace Drupal\config\Controller; use Drupal\Core\Archiver\ArchiveTar; use Drupal\Core\Config\ConfigManagerInterface; use Drupal\Core\Config\StorageInterface; use Drupal\Core\DependencyInjection\ContainerInjectionInterface; use Drupal\Core\Diff\DiffFormatter; use Drupal\Core\File\Exception\FileException; use Drupal\Core\File\FileSystemInterface; use Drupal\Core\Serialization\Yaml; use Drupal\Core\Url; use Drupal\system\FileDownloadController; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; /** * Returns responses for config module routes. */ class ConfigController implements ContainerInjectionInterface { /** * The target storage. * * @var \Drupal\Core\Config\StorageInterface */ protected $targetStorage; /** * The source storage. * * @var \Drupal\Core\Config\StorageInterface */ protected $sourceStorage; /** * The configuration manager. * * @var \Drupal\Core\Config\ConfigManagerInterface */ protected $configManager; /** * The file download controller. * * @var \Drupal\system\FileDownloadController */ protected $fileDownloadController; /** * The diff formatter. * * @var \Drupal\Core\Diff\DiffFormatter */ protected $diffFormatter; /** * The file system. * * @var \Drupal\Core\File\FileSystemInterface */ protected $fileSystem; /** * {@inheritdoc} */ public static function create(ContainerInterface $container) { return new static( $container->get('config.storage'), $container->get('config.storage.sync'), $container->get('config.manager'), new FileDownloadController(), $container->get('diff.formatter'), $container->get('file_system') ); } /** * Constructs a ConfigController object. * * @param \Drupal\Core\Config\StorageInterface $target_storage * The target storage. * @param \Drupal\Core\Config\StorageInterface $source_storage * The source storage. * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager * The config manager. * @param \Drupal\system\FileDownloadController $file_download_controller * The file download controller. * @param \Drupal\Core\Diff\DiffFormatter $diff_formatter * The diff formatter. * @param \Drupal\Core\File\FileSystemInterface $file_system * The file system. */ public function __construct(StorageInterface $target_storage, StorageInterface $source_storage, ConfigManagerInterface $config_manager, FileDownloadController $file_download_controller, DiffFormatter $diff_formatter, FileSystemInterface $file_system) { $this->targetStorage = $target_storage; $this->sourceStorage = $source_storage; $this->configManager = $config_manager; $this->fileDownloadController = $file_download_controller; $this->diffFormatter = $diff_formatter; $this->fileSystem = $file_system; } /** * Downloads a tarball of the site configuration. */ public function downloadExport() { try { $this->fileSystem->delete(file_directory_temp() . '/config.tar.gz'); } catch (FileException $e) { // Ignore failed deletes. } $archiver = new ArchiveTar(file_directory_temp() . '/config.tar.gz', 'gz'); // Get raw configuration data without overrides. foreach ($this->configManager->getConfigFactory()->listAll() as $name) { $archiver->addString("$name.yml", Yaml::encode($this->configManager->getConfigFactory()->get($name)->getRawData())); } // Get all override data from the remaining collections. foreach ($this->targetStorage->getAllCollectionNames() as $collection) { $collection_storage = $this->targetStorage->createCollection($collection); foreach ($collection_storage->listAll() as $name) { $archiver->addString(str_replace('.', '/', $collection) . "/$name.yml", Yaml::encode($collection_storage->read($name))); } } $request = new Request(['file' => 'config.tar.gz']); return $this->fileDownloadController->download($request, 'temporary'); } /** * Shows diff of specified configuration file. * * @param string $source_name * The name of the configuration file. * @param string $target_name * (optional) The name of the target configuration file if different from * the $source_name. * @param string $collection * (optional) The configuration collection name. Defaults to the default * collection. * * @return string * Table showing a two-way diff between the active and staged configuration. */ public function diff($source_name, $target_name = NULL, $collection = NULL) { if (!isset($collection)) { $collection = StorageInterface::DEFAULT_COLLECTION; } $diff = $this->configManager->diff($this->targetStorage, $this->sourceStorage, $source_name, $target_name, $collection); $this->diffFormatter->show_header = FALSE; $build = []; $build['#title'] = t('View changes of @config_file', ['@config_file' => $source_name]); // Add the CSS for the inline diff. $build['#attached']['library'][] = 'system/diff'; $build['diff'] = [ '#type' => 'table', '#attributes' => [ 'class' => ['diff'], ], '#header' => [ ['data' => t('Active'), 'colspan' => '2'], ['data' => t('Staged'), 'colspan' => '2'], ], '#rows' => $this->diffFormatter->format($diff), ]; $build['back'] = [ '#type' => 'link', '#attributes' => [ 'class' => [ 'dialog-cancel', ], ], '#title' => "Back to 'Synchronize configuration' page.", '#url' => Url::fromRoute('config.sync'), ]; return $build; } }