You are here

Home » API reference » Demonstration site (Sandbox / Snapshot) 8 » ConfigDownloadController.php

class ConfigDownloadController in Demonstration site (Sandbox / Snapshot) 8

Returns responses for config module routes.

Hierarchy

Expanded class hierarchy of ConfigDownloadController

File

src/Controller/ConfigDownloadController.php, line 23

Namespace

Drupal\demo\Controller
View source 
class ConfigDownloadController extends ControllerBase 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;

  /**
   * {@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'));
  }

  /**
   * 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\system\FileDownloadController $file_download_controller
   *   The file download controller.
   */
  public function __construct(StorageInterface $target_storage, StorageInterface $source_storage, ConfigManagerInterface $config_manager, FileDownloadController $file_download_controller, DiffFormatter $diff_formatter) {
    $this->targetStorage = $target_storage;
    $this->sourceStorage = $source_storage;
    $this->configManager = $config_manager;
    $this->fileDownloadController = $file_download_controller;
    $this->diffFormatter = $diff_formatter;
  }

  /**
   * Downloads a tarball of the site configuration.
   */
  public function downloadExport() {
    $fileconfig = 'private://' . \Drupal::config('demo.settings')
      ->get('demo_dump_path', 'demo');
    $request = \Drupal::request();
    $date_string = date("Y-m-d-H-i");
    $hostname = str_replace('.', '-', $request
      ->getHttpHost());
    $filename = '/config' . '-' . $hostname . '-' . $date_string . '.tar.gz';
    $archiver = new ArchiveTar($fileconfig . $filename, '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' => $filename,
    ]);
    if (!\Drupal::service('file_system')
      ->prepareDirectory($fileconfig, FileSystemInterface::CREATE_DIRECTORY)) {
      return FALSE;
    }

    // ----------------------------------------------------------------------.
    $scheme = 'private';
    $target = $request->query
      ->get('file');

    // Merge remaining path arguments into relative file path.
    $uri = $scheme . '://demo' . $target;
    if (file_stream_wrapper_valid_scheme($scheme)) {

      // Let other modules provide headers and controls access to the file.
      $headers = $this
        ->moduleHandler()
        ->invoke('demo', 'file_download', [
        $uri,
      ]);
      foreach ($headers as $result) {
        if ($result == -1) {
          throw new AccessDeniedHttpException();
        }
      }
      if (count($headers)) {

        // \Drupal\Core\EventSubscriber\FinishResponseSubscriber::onRespond()
        // sets response as not cacheable if the Cache-Control header is not
        // already modified. We pass in FALSE for non-private schemes for the
        // $public parameter to make sure we don't change the headers.
        \Drupal::messenger()
          ->addMessage(t('Snapshot has been created.'));
        return $this
          ->redirect('demo.manage_config');
      }
      throw new AccessDeniedHttpException();
    }
    throw new NotFoundHttpException();

    // ----------------------------------------------------------------------.
  }

  /**
   * 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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigDownloadController::$configManager protected property The configuration manager.
ConfigDownloadController::$diffFormatter protected property The diff formatter.
ConfigDownloadController::$fileDownloadController protected property The file download controller.
ConfigDownloadController::$sourceStorage protected property The source storage.
ConfigDownloadController::$targetStorage protected property The target storage.
ConfigDownloadController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ConfigDownloadController::diff public function Shows diff of specified configuration file.
ConfigDownloadController::downloadExport public function Downloads a tarball of the site configuration.
ConfigDownloadController::__construct public function Constructs a ConfigController object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.