class ExcludedPathsSubscriber in Automatic Updates 8.2

Defines an event subscriber to exclude certain paths from update operations.

Hierarchy

• class \Drupal\automatic_updates\Event\ExcludedPathsSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'ExcludedPathsSubscriber'

automatic_updates.services.yml in ./automatic_updates.services.yml

automatic_updates.services.yml

1 service uses ExcludedPathsSubscriber

automatic_updates.excluded_paths_subscriber in ./automatic_updates.services.yml

Drupal\automatic_updates\Event\ExcludedPathsSubscriber

File

src/Event/ExcludedPathsSubscriber.php, line 14

Namespace

Drupal\automatic_updates\Event

class ExcludedPathsSubscriber implements EventSubscriberInterface {

  /**
   * The Drupal root.
   *
   * @var string
   */
  protected $appRoot;

  /**
   * The current site path, relative to the Drupal root.
   *
   * @var string
   */
  protected $sitePath;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The stream wrapper manager service.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * Constructs an UpdateSubscriber.
   *
   * @param string $app_root
   *   The Drupal root.
   * @param string $site_path
   *   The current site path, relative to the Drupal root.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system service.
   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
   *   The stream wrapper manager service.
   */
  public function __construct(string $app_root, string $site_path, FileSystemInterface $file_system, StreamWrapperManagerInterface $stream_wrapper_manager) {
    $this->appRoot = $app_root;
    $this->sitePath = $site_path;
    $this->fileSystem = $file_system;
    $this->streamWrapperManager = $stream_wrapper_manager;
  }

  /**
   * Reacts before staged updates are committed the active directory.
   *
   * @param \Drupal\automatic_updates\Event\PreCommitEvent $event
   *   The event object.
   */
  public function preCommit(PreCommitEvent $event) : void {

    // Don't copy anything from the staging area's sites/default.
    // @todo Make this a lot smarter in https://www.drupal.org/i/3228955.
    $event
      ->excludePath('sites/default');

    // If the core-vendor-hardening plugin (used in the legacy-project template)
    // is present, it may have written a web.config file into the vendor
    // directory. We don't want to copy that.
    $event
      ->excludePath('web.config');
  }

  /**
   * Reacts to the beginning of an update process.
   *
   * @param \Drupal\automatic_updates\Event\PreStartEvent $event
   *   The event object.
   */
  public function preStart(PreStartEvent $event) : void {

    // Automated test site directories should never be staged.
    $event
      ->excludePath('sites/simpletest');

    // Windows server configuration files, like web.config, should never be
    // staged either. (These can be written in the vendor directory by the
    // core-vendor-hardening plugin, which is used in the drupal/legacy-project
    // template.)
    $event
      ->excludePath('web.config');
    if ($public = $this
      ->getFilesPath('public')) {
      $event
        ->excludePath($public);
    }
    if ($private = $this
      ->getFilesPath('private')) {
      $event
        ->excludePath($private);
    }

    // If this module is a git clone, exclude it.
    if (is_dir(__DIR__ . '/../../.git')) {
      $event
        ->excludePath($this->fileSystem
        ->realpath(__DIR__ . '/../..'));
    }

    // Exclude site-specific settings files.
    $settings_files = [
      'settings.php',
      'settings.local.php',
      'services.yml',
    ];
    foreach ($settings_files as $settings_file) {
      $file_path = implode(DIRECTORY_SEPARATOR, [
        $this->appRoot,
        $this->sitePath,
        $settings_file,
      ]);
      $file_path = $this->fileSystem
        ->realpath($file_path);
      if (file_exists($file_path)) {
        $event
          ->excludePath($file_path);
      }
      $default_file_path = implode(DIRECTORY_SEPARATOR, [
        'sites',
        'default',
        $settings_file,
      ]);
      $event
        ->excludePath($default_file_path);
    }
  }

  /**
   * Returns the storage path for a stream wrapper.
   *
   * This will only work for stream wrappers that extend
   * \Drupal\Core\StreamWrapper\LocalStream, which includes the stream wrappers
   * for public and private files.
   *
   * @param string $scheme
   *   The stream wrapper scheme.
   *
   * @return string|null
   *   The storage path for files using the given scheme, relative to the Drupal
   *   root, or NULL if the stream wrapper does not extend
   *   \Drupal\Core\StreamWrapper\LocalStream.
   */
  private function getFilesPath(string $scheme) : ?string {
    $wrapper = $this->streamWrapperManager
      ->getViaScheme($scheme);
    if ($wrapper instanceof LocalStream) {
      return $wrapper
        ->getDirectoryPath();
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    return [
      AutomaticUpdatesEvents::PRE_START => 'preStart',
      AutomaticUpdatesEvents::PRE_COMMIT => 'preCommit',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExcludedPathsSubscriber::$appRoot	protected	property	The Drupal root.
ExcludedPathsSubscriber::$fileSystem	protected	property	The file system service.
ExcludedPathsSubscriber::$sitePath	protected	property	The current site path, relative to the Drupal root.
ExcludedPathsSubscriber::$streamWrapperManager	protected	property	The stream wrapper manager service.
ExcludedPathsSubscriber::getFilesPath	private	function	Returns the storage path for a stream wrapper.
ExcludedPathsSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
ExcludedPathsSubscriber::preCommit	public	function	Reacts before staged updates are committed the active directory.
ExcludedPathsSubscriber::preStart	public	function	Reacts to the beginning of an update process.
ExcludedPathsSubscriber::__construct	public	function	Constructs an UpdateSubscriber.