vendor/shopware/core/Framework/Update/Services/UpdateHtaccess.php line 39

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Update\Services;
  5. use Shopware\Core\Framework\Update\Event\UpdatePostFinishEvent;
  6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. /**
  9.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  10.  */
  11. class UpdateHtaccess implements EventSubscriberInterface
  12. {
  13.     private const MARKER_START = '# BEGIN Shopware';
  14.     private const MARKER_STOP = '# END Shopware';
  15.     private const INSTRUCTIONS = '# The directives (lines) between "# BEGIN Shopware" and "# END Shopware" are dynamically generated. Any changes to the directives between these markers will be overwritten.';
  17.     private const OLD_FILES = [
  18.         '9ab5be8c4bbff3490f3ae367af8a30d7', // https://github.com/shopware/production/commit/bebf9adc90bf5d7b0d53a149cc5bdba328696086
  19.         'ba812f2a64b337b032b10685ca6e2308', // https://github.com/shopware/production/commit/18ce6ffc904b8d2d237dc4ee6654c1fa9a6df719
  20.     ];
  22.     private string $htaccessPath;
  24.     /**
  25.      * @internal
  26.      */
  27.     public function __construct(string $htaccessPath)
  28.     {
  29.         $this->htaccessPath = $htaccessPath;
  30.     }
  32.     public static function getSubscribedEvents(): array
  33.     {
  34.         return [
  35.             UpdatePostFinishEvent::class => 'update',
  36.         ];
  37.     }
  39.     public function update(): void
  40.     {
  41.         if (!file_exists($this->htaccessPath) || !file_exists($this->htaccessPath . '.dist')) {
  42.             return;
  43.         }
  45.         if (\in_array(md5_file($this->htaccessPath), self::OLD_FILES, true)) {
  46.             $this->replaceFile($this->htaccessPath);
  48.             return;
  49.         }
  51.         $content = file_get_contents($this->htaccessPath);
  53.         // User has deleted the markers. So we will ignore the update process
  54.         if (!$content || strpos($content, self::MARKER_START) === false || strpos($content, self::MARKER_STOP) === false) {
  55.             return;
  56.         }
  58.         $this->updateByMarkers($this->htaccessPath);
  59.     }
  61.     /**
  62.      * Replace entire .htaccess from dist
  63.      */
  64.     private function replaceFile(string $path): void
  65.     {
  66.         $dist = $path . '.dist';
  68.         if (!file_exists($dist)) {
  69.             return;
  70.         }
  72.         $perms = fileperms($dist);
  73.         copy($dist, $path);
  75.         if ($perms) {
  76.             chmod($path, $perms | 0644);
  77.         }
  78.     }
  80.     private function updateByMarkers(string $path): void
  81.     {
  82.         [$pre, $_, $post] = $this->getLinesFromMarkedFile($path);
  83.         [$_, $existing, $_] = $this->getLinesFromMarkedFile($path . '.dist');
  85.         if (!\in_array(self::INSTRUCTIONS, $existing, true)) {
  86.             array_unshift($existing, self::INSTRUCTIONS);
  87.         }
  89.         array_unshift($existing, self::MARKER_START);
  90.         $existing[] = self::MARKER_STOP;
  92.         $newFile = implode("\n", array_merge($pre, $existing, $post));
  94.         $perms = fileperms($path);
  95.         file_put_contents($path, $newFile);
  97.         if ($perms) {
  98.             chmod($path, $perms | 0644);
  99.         }
  100.     }
  102.     /**
  103.      * @return array{0: list<string>, 1: list<string>, 2: list<string>}
  104.      */
  105.     private function getLinesFromMarkedFile(string $path): array
  106.     {
  107.         $fp = fopen($path, 'rb+');
  108.         if (!$fp) {
  109.             return [[], [], []];
  110.         }
  112.         $lines = [];
  113.         while (!feof($fp)) {
  114.             if ($line = fgets($fp)) {
  115.                 $lines[] = rtrim($line, "\r\n");
  116.             }
  117.         }
  119.         $foundStart = false;
  120.         $foundStop = false;
  121.         $preLines = [];
  122.         $postLines = [];
  123.         $existingLines = [];
  125.         foreach ($lines as $line) {
  126.             if (!$foundStart && strpos($line, self::MARKER_START) === 0) {
  127.                 $foundStart = true;
  129.                 continue;
  130.             }
  132.             if (!$foundStop && strpos($line, self::MARKER_STOP) === 0) {
  133.                 $foundStop = true;
  135.                 continue;
  136.             }
  138.             if (!$foundStart) {
  139.                 $preLines[] = $line;
  140.             } elseif ($foundStop) {
  141.                 $postLines[] = $line;
  142.             } else {
  143.                 $existingLines[] = $line;
  144.             }
  145.         }
  147.         return [$preLines, $existingLines, $postLines];
  148.     }
  149. }