SandboxDirectoryValidator.php

<?php

declare (strict_types=1);
namespace Drupal\package_manager\Validator;

use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\SandboxValidationEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Validates staging root is not a subdirectory of active.
 *
 * @internal
 *   This is an internal part of Package Manager and may be changed or removed
 *   at any time without warning. External code should not interact with this
 *   class.
 */
final class SandboxDirectoryValidator implements EventSubscriberInterface {
  use BaseRequirementValidatorTrait {
    getSubscribedEvents as private getSubscribedEventsFromTrait;
  }
  use StringTranslationTrait;
  public function __construct(private readonly PathLocator $pathLocator) {
  }
  
  /**
   * Check if staging root is a subdirectory of active.
   */
  public function validate(SandboxValidationEvent $event) : void {
    $project_root = $this->pathLocator
      ->getProjectRoot();
    $staging_root = $this->pathLocator
      ->getStagingRoot();
    if (str_starts_with($staging_root, $project_root)) {
      $message = $this->t("The sandbox directory is a subdirectory of the active directory.");
      $event->addError([
        $message,
      ]);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    $events = static::getSubscribedEventsFromTrait();
    // We don't need to listen to PreApplyEvent because once the stage directory
    // has been created, it's not going to be moved.
    unset($events[PreApplyEvent::class]);
    return $events;
  }

}