core/lib/Thelia/Action/Document.php line 68

  1. <?php
  3. /*
  4.  * This file is part of the Thelia package.
  5.  * http://www.thelia.net
  6.  *
  7.  * (c) OpenStudio <info@thelia.net>
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Thelia\Action;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Thelia\Core\Event\Document\DocumentEvent;
  17. use Thelia\Core\Event\TheliaEvents;
  18. use Thelia\Exception\DocumentException;
  19. use Thelia\Model\ConfigQuery;
  20. use Thelia\Tools\URL;
  22. /**
  23.  * Document management actions. This class handles document processing an caching.
  24.  *
  25.  * Basically, documents are stored outside the web space (by default in local/media/documents),
  26.  * and cached in the web space (by default in web/local/documents).
  27.  *
  28.  * In the documents caches directory, a subdirectory for documents categories (eg. product, category, folder, etc.) is
  29.  * automatically created, and the cached document is created here. Plugin may use their own subdirectory as required.
  30.  *
  31.  * The cached document name contains a hash of the processing options, and the original (normalized) name of the document.
  32.  *
  33.  * A copy (or symbolic link, by default) of the original document is always created in the cache, so that the full
  34.  * resolution document is always available.
  35.  *
  36.  * If a problem occurs, an DocumentException may be thrown.
  37.  *
  38.  * @author Franck Allimant <franck@cqfdev.fr>
  39.  */
  40. class Document extends BaseCachedFile implements EventSubscriberInterface
  41. {
  42.     /**
  43.      * @var string Config key for document delivery mode
  44.      */
  45.     public const CONFIG_DELIVERY_MODE = 'original_document_delivery_mode';
  47.     /**
  48.      * @return string root of the document cache directory in web space
  49.      */
  50.     protected function getCacheDirFromWebRoot()
  51.     {
  52.         return ConfigQuery::read('document_cache_dir_from_web_root', 'cache'.DS.'documents');
  53.     }
  55.     /**
  56.      * Process document and write the result in the document cache.
  57.      *
  58.      * When the original document is required, create either a symbolic link with the
  59.      * original document in the cache dir, or copy it in the cache dir if it's not already done.
  60.      *
  61.      * This method updates the cache_file_path and file_url attributes of the event
  62.      *
  63.      * @param DocumentEvent $event Event
  64.      *
  65.      * @throws \Thelia\Exception\DocumentException
  66.      * @throws \InvalidArgumentException           , DocumentException
  67.      */
  68.     public function processDocument(DocumentEvent $event): void
  69.     {
  70.         $subdir = $event->getCacheSubdirectory();
  71.         $sourceFile = $event->getSourceFilepath();
  73.         if (null == $subdir || null == $sourceFile) {
  74.             throw new \InvalidArgumentException('Cache sub-directory and source file path cannot be null');
  75.         }
  77.         $originalDocumentPathInCache = $this->getCacheFilePath($subdir, $sourceFile, true);
  79.         if (!file_exists($originalDocumentPathInCache)) {
  80.             if (!file_exists($sourceFile)) {
  81.                 throw new DocumentException(sprintf('Source document file %s does not exists.', $sourceFile));
  82.             }
  84.             $mode = ConfigQuery::read(self::CONFIG_DELIVERY_MODE, 'symlink');
  86.             if ($mode == 'symlink') {
  87.                 if (false === symlink($sourceFile, $originalDocumentPathInCache)) {
  88.                     throw new DocumentException(sprintf('Failed to create symbolic link for %s in %s document cache directory', basename($sourceFile), $subdir));
  89.                 }
  90.             } else {
  91.                 // mode = 'copy'
  92.                 if (false === @copy($sourceFile, $originalDocumentPathInCache)) {
  93.                     throw new DocumentException(sprintf('Failed to copy %s in %s document cache directory', basename($sourceFile), $subdir));
  94.                 }
  95.             }
  96.         }
  98.         // Compute the document URL
  99.         $documentUrl = $this->getCacheFileURL($subdir, basename($originalDocumentPathInCache));
  101.         // Update the event with file path and file URL
  102.         $event->setDocumentPath($documentUrl);
  103.         $event->setDocumentUrl(URL::getInstance()->absoluteUrl($documentUrl, null, URL::PATH_TO_FILE, $this->cdnBaseUrl));
  104.     }
  106.     /**
  107.      * {@inheritdoc}
  108.      */
  109.     public static function getSubscribedEvents()
  110.     {
  111.         return [
  112.             TheliaEvents::DOCUMENT_PROCESS => ['processDocument', 128],
  114.             // Implemented in parent class BaseCachedFile
  115.             TheliaEvents::DOCUMENT_CLEAR_CACHE => ['clearCache', 128],
  116.             TheliaEvents::DOCUMENT_DELETE => ['deleteFile', 128],
  117.             TheliaEvents::DOCUMENT_SAVE => ['saveFile', 128],
  118.             TheliaEvents::DOCUMENT_UPDATE => ['updateFile', 128],
  119.             TheliaEvents::DOCUMENT_UPDATE_POSITION => ['updatePosition', 128],
  120.             TheliaEvents::DOCUMENT_TOGGLE_VISIBILITY => ['toggleVisibility', 128],
  121.         ];
  122.     }
  123. }