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

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Update\Services;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Framework\Update\Event\UpdatePostFinishEvent;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. /**
  10.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  11.  */
  12. #[Package('system-settings')]
  13. class UpdateHtaccess implements EventSubscriberInterface
  14. {
  15.     private const MARKER_START = '# BEGIN Shopware';
  16.     private const MARKER_STOP = '# END Shopware';
  17.     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.';
  19.     private const OLD_FILES = [
  20.         '9ab5be8c4bbff3490f3ae367af8a30d7', // https://github.com/shopware/production/commit/bebf9adc90bf5d7b0d53a149cc5bdba328696086
  21.         'ba812f2a64b337b032b10685ca6e2308', // https://github.com/shopware/production/commit/18ce6ffc904b8d2d237dc4ee6654c1fa9a6df719
  22.     ];
  24.     private string $htaccessPath;
  26.     /**
  27.      * @internal
  28.      */
  29.     public function __construct(string $htaccessPath)
  30.     {
  31.         $this->htaccessPath = $htaccessPath;
  32.     }
  34.     public static function getSubscribedEvents(): array
  35.     {
  36.         return [
  37.             UpdatePostFinishEvent::class => 'update',
  38.         ];
  39.     }
  41.     public function update(): void
  42.     {
  43.         if (!file_exists($this->htaccessPath) || !file_exists($this->htaccessPath . '.dist')) {
  44.             return;
  45.         }
  47.         if (\in_array(md5_file($this->htaccessPath), self::OLD_FILES, true)) {
  48.             $this->replaceFile($this->htaccessPath);
  50.             return;
  51.         }
  53.         $content = file_get_contents($this->htaccessPath);
  55.         // User has deleted the markers. So we will ignore the update process
  56.         if (!$content || strpos($content, self::MARKER_START) === false || strpos($content, self::MARKER_STOP) === false) {
  57.             return;
  58.         }
  60.         $this->updateByMarkers($this->htaccessPath);
  61.     }
  63.     /**
  64.      * Replace entire .htaccess from dist
  65.      */
  66.     private function replaceFile(string $path): void
  67.     {
  68.         $dist = $path . '.dist';
  70.         if (!file_exists($dist)) {
  71.             return;
  72.         }
  74.         $perms = fileperms($dist);
  75.         copy($dist, $path);
  77.         if ($perms) {
  78.             chmod($path, $perms | 0644);
  79.         }
  80.     }
  82.     private function updateByMarkers(string $path): void
  83.     {
  84.         [$pre, $_, $post] = $this->getLinesFromMarkedFile($path);
  85.         [$_, $existing, $_] = $this->getLinesFromMarkedFile($path . '.dist');
  87.         if (!\in_array(self::INSTRUCTIONS, $existing, true)) {
  88.             array_unshift($existing, self::INSTRUCTIONS);
  89.         }
  91.         array_unshift($existing, self::MARKER_START);
  92.         $existing[] = self::MARKER_STOP;
  94.         $newFile = implode("\n", array_merge($pre, $existing, $post));
  96.         $perms = fileperms($path);
  97.         file_put_contents($path, $newFile);
  99.         if ($perms) {
  100.             chmod($path, $perms | 0644);
  101.         }
  102.     }
  104.     /**
  105.      * @return array{0: list<string>, 1: list<string>, 2: list<string>}
  106.      */
  107.     private function getLinesFromMarkedFile(string $path): array
  108.     {
  109.         $fp = fopen($path, 'rb+');
  110.         if (!$fp) {
  111.             return [[], [], []];
  112.         }
  114.         $lines = [];
  115.         while (!feof($fp)) {
  116.             if ($line = fgets($fp)) {
  117.                 $lines[] = rtrim($line, "\r\n");
  118.             }
  119.         }
  121.         $foundStart = false;
  122.         $foundStop = false;
  123.         $preLines = [];
  124.         $postLines = [];
  125.         $existingLines = [];
  127.         foreach ($lines as $line) {
  128.             if (!$foundStart && strpos($line, self::MARKER_START) === 0) {
  129.                 $foundStart = true;
  131.                 continue;
  132.             }
  134.             if (!$foundStop && strpos($line, self::MARKER_STOP) === 0) {
  135.                 $foundStop = true;
  137.                 continue;
  138.             }
  140.             if (!$foundStart) {
  141.                 $preLines[] = $line;
  142.             } elseif ($foundStop) {
  143.                 $postLines[] = $line;
  144.             } else {
  145.                 $existingLines[] = $line;
  146.             }
  147.         }
  149.         return [$preLines, $existingLines, $postLines];
  150.     }
  151. }