vendor/pimcore/pimcore/models/Document/Service.php line 542

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\Document;
  18. use Pimcore\Config;
  19. use Pimcore\Document\Renderer\DocumentRenderer;
  20. use Pimcore\Document\Renderer\DocumentRendererInterface;
  21. use Pimcore\Event\DocumentEvents;
  22. use Pimcore\Event\Model\DocumentEvent;
  23. use Pimcore\File;
  24. use Pimcore\Image\Chromium;
  25. use Pimcore\Image\HtmlToImage;
  26. use Pimcore\Model;
  27. use Pimcore\Model\Document;
  28. use Pimcore\Model\Document\Editable\IdRewriterInterface;
  29. use Pimcore\Model\Document\Editable\LazyLoadingInterface;
  30. use Pimcore\Model\Element;
  31. use Pimcore\Tool;
  32. use Pimcore\Tool\Serialize;
  33. use Symfony\Component\HttpFoundation\Request;
  35. /**
  36.  * @method \Pimcore\Model\Document\Service\Dao getDao()
  37.  * @method int[] getTranslations(Document $document, string $task = 'open')
  38.  * @method addTranslation(Document $document, Document $translation, $language = null)
  39.  * @method removeTranslation(Document $document)
  40.  * @method int getTranslationSourceId(Document $document)
  41.  * @method removeTranslationLink(Document $document, Document $targetDocument)
  42.  */
  43. class Service extends Model\Element\Service
  44. {
  45.     /**
  46.      * @var Model\User|null
  47.      */
  48.     protected $_user;
  50.     /**
  51.      * @var array
  52.      */
  53.     protected $_copyRecursiveIds;
  55.     /**
  56.      * @var Document[]
  57.      */
  58.     protected $nearestPathCache;
  60.     /**
  61.      * @param Model\User $user
  62.      */
  63.     public function __construct($user = null)
  64.     {
  65.         $this->_user = $user;
  66.     }
  68.     /**
  69.      * Renders a document outside of a view
  70.      *
  71.      * Parameter order was kept for BC (useLayout before query and options).
  72.      *
  73.      * @static
  74.      *
  75.      * @param Document\PageSnippet $document
  76.      * @param array $attributes
  77.      * @param bool $useLayout
  78.      * @param array $query
  79.      * @param array $options
  80.      *
  81.      * @return string
  82.      */
  83.     public static function render(Document\PageSnippet $document, array $attributes = [], $useLayout = false, array $query = [], array $options = []): string
  84.     {
  85.         $container = \Pimcore::getContainer();
  87.         /** @var DocumentRendererInterface $renderer */
  88.         $renderer = $container->get(DocumentRenderer::class);
  90.         // keep useLayout compatibility
  91.         $attributes['_useLayout'] = $useLayout;
  92.         $content = $renderer->render($document, $attributes, $query, $options);
  94.         return $content;
  95.     }
  97.     /**
  98.      * @param  Document $target
  99.      * @param  Document $source
  100.      *
  101.      * @return Document|null copied document
  102.      *
  103.      * @throws \Exception
  104.      */
  105.     public function copyRecursive($target, $source)
  106.     {
  107.         // avoid recursion
  108.         if (!$this->_copyRecursiveIds) {
  109.             $this->_copyRecursiveIds = [];
  110.         }
  111.         if (in_array($source->getId(), $this->_copyRecursiveIds)) {
  112.             return null;
  113.         }
  115.         if ($source instanceof Document\PageSnippet) {
  116.             $source->getEditables();
  117.         }
  119.         $source->getProperties();
  121.         // triggers actions before document cloning
  122.         $event = new DocumentEvent($source, [
  123.             'target_element' => $target,
  124.         ]);
  125.         \Pimcore::getEventDispatcher()->dispatch($event, DocumentEvents::PRE_COPY);
  126.         $target = $event->getArgument('target_element');
  128.         /** @var Document $new */
  129.         $new = Element\Service::cloneMe($source);
  130.         $new->setId(null);
  131.         $new->setChildren(null);
  132.         $new->setKey(Element\Service::getSafeCopyName($new->getKey(), $target));
  133.         $new->setParentId($target->getId());
  134.         $new->setUserOwner($this->_user ? $this->_user->getId() : 0);
  135.         $new->setUserModification($this->_user ? $this->_user->getId() : 0);
  136.         $new->setDao(null);
  137.         $new->setLocked(null);
  138.         $new->setCreationDate(time());
  139.         if ($new instanceof Page) {
  140.             $new->setPrettyUrl(null);
  141.         }
  143.         $new->save();
  145.         // add to store
  146.         $this->_copyRecursiveIds[] = $new->getId();
  148.         foreach ($source->getChildren(true) as $child) {
  149.             $this->copyRecursive($new, $child);
  150.         }
  152.         $this->updateChildren($target, $new);
  154.         // triggers actions after the complete document cloning
  155.         $event = new DocumentEvent($new, [
  156.             'base_element' => $source, // the element used to make a copy
  157.         ]);
  158.         \Pimcore::getEventDispatcher()->dispatch($event, DocumentEvents::POST_COPY);
  160.         return $new;
  161.     }
  163.     /**
  164.      * @param Document $target
  165.      * @param Document $source
  166.      * @param bool $enableInheritance
  167.      * @param bool $resetIndex
  168.      * @param string|null $language
  169.      *
  170.      * @return Document
  171.      *
  172.      * @throws \Exception
  173.      */
  174.     public function copyAsChild($target, $source, $enableInheritance = false, $resetIndex = false, $language = null)
  175.     {
  176.         if ($source instanceof Document\PageSnippet) {
  177.             $source->getEditables();
  178.         }
  180.         $source->getProperties();
  182.         // triggers actions before document cloning
  183.         $event = new DocumentEvent($source, [
  184.             'target_element' => $target,
  185.         ]);
  186.         \Pimcore::getEventDispatcher()->dispatch($event, DocumentEvents::PRE_COPY);
  187.         $target = $event->getArgument('target_element');
  189.         /**
  190.          * @var Document $new
  191.          */
  192.         $new = Element\Service::cloneMe($source);
  193.         $new->setId(null);
  194.         $new->setChildren(null);
  195.         $new->setKey(Element\Service::getSafeCopyName($new->getKey(), $target));
  196.         $new->setParentId($target->getId());
  197.         $new->setUserOwner($this->_user ? $this->_user->getId() : 0);
  198.         $new->setUserModification($this->_user ? $this->_user->getId() : 0);
  199.         $new->setDao(null);
  200.         $new->setLocked(null);
  201.         $new->setCreationDate(time());
  203.         if ($resetIndex) {
  204.             // this needs to be after $new->setParentId($target->getId()); -> dependency!
  205.             $new->setIndex($new->getDao()->getNextIndex());
  206.         }
  208.         if ($new instanceof Page) {
  209.             $new->setPrettyUrl(null);
  210.         }
  212.         if ($enableInheritance && ($new instanceof Document\PageSnippet) && $new->supportsContentMain()) {
  213.             $new->setEditables([]);
  214.             $new->setMissingRequiredEditable(false);
  215.             $new->setContentMainDocumentId($source->getId(), true);
  216.         }
  218.         if ($language) {
  219.             $new->setProperty('language', 'text', $language, false, true);
  220.         }
  222.         $new->save();
  224.         $this->updateChildren($target, $new);
  226.         //link translated document
  227.         if ($language) {
  228.             $this->addTranslation($source, $new, $language);
  229.         }
  231.         // triggers actions after the complete document cloning
  232.         $event = new DocumentEvent($new, [
  233.             'base_element' => $source, // the element used to make a copy
  234.         ]);
  235.         \Pimcore::getEventDispatcher()->dispatch($event, DocumentEvents::POST_COPY);
  237.         return $new;
  238.     }
  240.     /**
  241.      * @param Document $target
  242.      * @param Document $source
  243.      *
  244.      * @return Document
  245.      *
  246.      * @throws \Exception
  247.      */
  248.     public function copyContents($target, $source)
  249.     {
  250.         // check if the type is the same
  251.         if (get_class($source) != get_class($target)) {
  252.             throw new \Exception('Source and target have to be the same type');
  253.         }
  255.         if ($source instanceof Document\PageSnippet) {
  256.             /** @var PageSnippet $target */
  257.             $target->setEditables($source->getEditables());
  259.             $target->setTemplate($source->getTemplate());
  260.             $target->setController($source->getController());
  262.             if ($source instanceof Document\Page) {
  263.                 /** @var Page $target */
  264.                 $target->setTitle($source->getTitle());
  265.                 $target->setDescription($source->getDescription());
  266.             }
  267.         } elseif ($source instanceof Document\Link) {
  268.             /** @var Link $target */
  269.             $target->setInternalType($source->getInternalType());
  270.             $target->setInternal($source->getInternal());
  271.             $target->setDirect($source->getDirect());
  272.             $target->setLinktype($source->getLinktype());
  273.         }
  275.         $target->setUserModification($this->_user ? $this->_user->getId() : 0);
  276.         $target->setProperties(self::cloneProperties($source->getProperties()));
  277.         $target->save();
  279.         return $target;
  280.     }
  282.     /**
  283.      * @param Document $document
  284.      *
  285.      * @return array
  286.      *
  287.      * @internal
  288.      */
  289.     public static function gridDocumentData($document)
  290.     {
  291.         $data = Element\Service::gridElementData($document);
  293.         if ($document instanceof Document\Page) {
  294.             $data['title'] = $document->getTitle();
  295.             $data['description'] = $document->getDescription();
  296.         } else {
  297.             $data['title'] = '';
  298.             $data['description'] = '';
  299.             $data['name'] = '';
  300.         }
  302.         return $data;
  303.     }
  305.     /**
  306.      * @internal
  307.      *
  308.      * @param Document $doc
  309.      *
  310.      * @return Document
  311.      */
  312.     public static function loadAllDocumentFields($doc)
  313.     {
  314.         $doc->getProperties();
  316.         if ($doc instanceof Document\PageSnippet) {
  317.             foreach ($doc->getEditables() as $name => $data) {
  318.                 //TODO Pimcore 11: remove method_exists BC layer
  319.                 if ($data instanceof LazyLoadingInterface || method_exists($data, 'load')) {
  320.                     if (!$data instanceof LazyLoadingInterface) {
  321.                         trigger_deprecation('pimcore/pimcore', '10.3',
  322.                             sprintf('Usage of method_exists is deprecated since version 10.3 and will be removed in Pimcore 11.' .
  323.                                 'Implement the %s interface instead.', LazyLoadingInterface::class));
  324.                     }
  325.                     $data->load();
  326.                 }
  327.             }
  328.         }
  330.         return $doc;
  331.     }
  333.     /**
  334.      * @static
  335.      *
  336.      * @param string $path
  337.      * @param string|null $type
  338.      *
  339.      * @return bool
  340.      */
  341.     public static function pathExists($path, $type = null)
  342.     {
  343.         if (!$path) {
  344.             return false;
  345.         }
  347.         $path = Element\Service::correctPath($path);
  349.         try {
  350.             $document = new Document();
  351.             // validate path
  352.             if (self::isValidPath($path, 'document')) {
  353.                 $document->getDao()->getByPath($path);
  355.                 return true;
  356.             }
  357.         } catch (\Exception $e) {
  358.         }
  360.         return false;
  361.     }
  363.     /**
  364.      * @param string $type
  365.      *
  366.      * @return bool
  367.      */
  368.     public static function isValidType($type)
  369.     {
  370.         return in_array($type, Document::getTypes());
  371.     }
  373.     /**
  374.      * Rewrites id from source to target, $rewriteConfig contains
  375.      * array(
  376.      *  "document" => array(
  377.      *      SOURCE_ID => TARGET_ID,
  378.      *      SOURCE_ID => TARGET_ID
  379.      *  ),
  380.      *  "object" => array(...),
  381.      *  "asset" => array(...)
  382.      * )
  383.      *
  384.      * @internal
  385.      *
  386.      * @param Document $document
  387.      * @param array $rewriteConfig
  388.      * @param array $params
  389.      *
  390.      * @return Document
  391.      */
  392.     public static function rewriteIds($document, $rewriteConfig, $params = [])
  393.     {
  394.         // rewriting elements only for snippets and pages
  395.         if ($document instanceof Document\PageSnippet) {
  396.             if (array_key_exists('enableInheritance', $params) && $params['enableInheritance']) {
  397.                 $editables = $document->getEditables();
  398.                 $changedEditables = [];
  399.                 $contentMain = $document->getContentMainDocument();
  400.                 if ($contentMain instanceof Document\PageSnippet) {
  401.                     $contentMainEditables = $contentMain->getEditables();
  402.                     foreach ($contentMainEditables as $contentMainEditable) {
  403.                         //TODO Pimcore 11: remove method_exists BC layer
  404.                         if ($contentMainEditable instanceof IdRewriterInterface || method_exists($contentMainEditable, 'rewriteIds')) {
  405.                             if (!$contentMainEditable instanceof IdRewriterInterface) {
  406.                                 trigger_deprecation('pimcore/pimcore', '10.3',
  407.                                     sprintf('Usage of method_exists is deprecated since version 10.3 and will be removed in Pimcore 11.' .
  408.                                         'Implement the %s interface instead.', IdRewriterInterface::class));
  409.                             }
  410.                             $editable = clone $contentMainEditable;
  411.                             $editable->rewriteIds($rewriteConfig);
  413.                             if (Serialize::serialize($editable) != Serialize::serialize($contentMainEditable)) {
  414.                                 $changedEditables[] = $editable;
  415.                             }
  416.                         }
  417.                     }
  418.                 }
  420.                 if (count($changedEditables) > 0) {
  421.                     $editables = $changedEditables;
  422.                 }
  423.             } else {
  424.                 $editables = $document->getEditables();
  425.                 foreach ($editables as &$editable) {
  426.                     //TODO Pimcore 11: remove method_exists BC layer
  427.                     if ($editable instanceof IdRewriterInterface || method_exists($editable, 'rewriteIds')) {
  428.                         if (!$editable instanceof IdRewriterInterface) {
  429.                             trigger_deprecation('pimcore/pimcore', '10.3',
  430.                                 sprintf('Usage of method_exists is deprecated since version 10.3 and will be removed in Pimcore 11.' .
  431.                                     'Implement the %s interface instead.', IdRewriterInterface::class));
  432.                         }
  433.                         $editable->rewriteIds($rewriteConfig);
  434.                     }
  435.                 }
  436.             }
  438.             $document->setEditables($editables);
  439.         } elseif ($document instanceof Document\Hardlink) {
  440.             if (array_key_exists('document', $rewriteConfig) && $document->getSourceId() && array_key_exists((int) $document->getSourceId(), $rewriteConfig['document'])) {
  441.                 $document->setSourceId($rewriteConfig['document'][(int) $document->getSourceId()]);
  442.             }
  443.         } elseif ($document instanceof Document\Link) {
  444.             if (array_key_exists('document', $rewriteConfig) && $document->getLinktype() == 'internal' && $document->getInternalType() == 'document' && array_key_exists((int) $document->getInternal(), $rewriteConfig['document'])) {
  445.                 $document->setInternal($rewriteConfig['document'][(int) $document->getInternal()]);
  446.             }
  447.         }
  449.         // rewriting properties
  450.         $properties = $document->getProperties();
  451.         foreach ($properties as &$property) {
  452.             $property->rewriteIds($rewriteConfig);
  453.         }
  454.         $document->setProperties($properties);
  456.         return $document;
  457.     }
  459.     /**
  460.      * @internal
  461.      *
  462.      * @param string $url
  463.      *
  464.      * @return Document|null
  465.      */
  466.     public static function getByUrl($url)
  467.     {
  468.         $urlParts = parse_url($url);
  469.         $document = null;
  471.         if ($urlParts['path']) {
  472.             $document = Document::getByPath($urlParts['path']);
  474.             // search for a page in a site
  475.             if (!$document) {
  476.                 $sitesList = new Model\Site\Listing();
  477.                 $sitesObjects = $sitesList->load();
  479.                 foreach ($sitesObjects as $site) {
  480.                     if ($site->getRootDocument() && (in_array($urlParts['host'], $site->getDomains()) || $site->getMainDomain() == $urlParts['host'])) {
  481.                         if ($document = Document::getByPath($site->getRootDocument() . $urlParts['path'])) {
  482.                             break;
  483.                         }
  484.                     }
  485.                 }
  486.             }
  487.         }
  489.         return $document;
  490.     }
  492.     /**
  493.      * @param Document $item
  494.      * @param int $nr
  495.      *
  496.      * @return string
  497.      *
  498.      * @throws \Exception
  499.      */
  500.     public static function getUniqueKey($item, $nr = 0)
  501.     {
  502.         $list = new Listing();
  503.         $list->setUnpublished(true);
  504.         $key = Element\Service::getValidKey($item->getKey(), 'document');
  505.         if (!$key) {
  506.             throw new \Exception('No item key set.');
  507.         }
  508.         if ($nr) {
  509.             $key = $key . '_' . $nr;
  510.         }
  512.         $parent = $item->getParent();
  513.         if (!$parent) {
  514.             throw new \Exception('You have to set a parent document to determine a unique Key');
  515.         }
  517.         if (!$item->getId()) {
  518.             $list->setCondition('parentId = ? AND `key` = ? ', [$parent->getId(), $key]);
  519.         } else {
  520.             $list->setCondition('parentId = ? AND `key` = ? AND id != ? ', [$parent->getId(), $key, $item->getId()]);
  521.         }
  522.         $check = $list->loadIdList();
  523.         if (!empty($check)) {
  524.             $nr++;
  525.             $key = self::getUniqueKey($item, $nr);
  526.         }
  528.         return $key;
  529.     }
  531.     /**
  532.      * Get the nearest document by path. Used to match nearest document for a static route.
  533.      *
  534.      * @internal
  535.      *
  536.      * @param string|Request $path
  537.      * @param bool $ignoreHardlinks
  538.      * @param array $types
  539.      *
  540.      * @return Document|null
  541.      */
  542.     public function getNearestDocumentByPath($path, $ignoreHardlinks = false, $types = [])
  543.     {
  544.         if ($path instanceof Request) {
  545.             $path = urldecode($path->getPathInfo());
  546.         }
  548.         $cacheKey = $ignoreHardlinks . implode('-', $types);
  549.         $document = null;
  551.         if (isset($this->nearestPathCache[$cacheKey])) {
  552.             $document = $this->nearestPathCache[$cacheKey];
  553.         } else {
  554.             $paths = ['/'];
  555.             $tmpPaths = [];
  557.             $pathParts = explode('/', $path);
  558.             foreach ($pathParts as $pathPart) {
  559.                 $tmpPaths[] = $pathPart;
  561.                 $t = implode('/', $tmpPaths);
  562.                 $paths[] = $t;
  563.             }
  565.             $paths = array_reverse($paths);
  566.             foreach ($paths as $p) {
  567.                 if ($document = Document::getByPath($p)) {
  568.                     if (empty($types) || in_array($document->getType(), $types)) {
  569.                         $document = $this->nearestPathCache[$cacheKey] = $document;
  571.                         break;
  572.                     }
  573.                 } elseif (Model\Site::isSiteRequest()) {
  574.                     // also check for a pretty url in a site
  575.                     $site = Model\Site::getCurrentSite();
  577.                     // undo the changed made by the site detection in self::match()
  578.                     $originalPath = preg_replace('@^' . $site->getRootPath() . '@', '', $p);
  580.                     $sitePrettyDocId = $this->getDao()->getDocumentIdByPrettyUrlInSite($site, $originalPath);
  581.                     if ($sitePrettyDocId) {
  582.                         if ($sitePrettyDoc = Document::getById($sitePrettyDocId)) {
  583.                             $document = $this->nearestPathCache[$cacheKey] = $sitePrettyDoc;
  585.                             break;
  586.                         }
  587.                     }
  588.                 }
  589.             }
  590.         }
  592.         if ($document) {
  593.             if (!$ignoreHardlinks) {
  594.                 if ($document instanceof Document\Hardlink) {
  595.                     if ($hardLinkedDocument = Document\Hardlink\Service::getNearestChildByPath($document, $path)) {
  596.                         $document = $hardLinkedDocument;
  597.                     } else {
  598.                         $document = Document\Hardlink\Service::wrap($document);
  599.                     }
  600.                 }
  601.             }
  603.             return $document;
  604.         }
  606.         return null;
  607.     }
  609.     /**
  610.      * @param int $id
  611.      * @param Request $request
  612.      * @param string $hostUrl
  613.      *
  614.      * @return bool
  615.      *
  616.      * @throws \Exception
  617.      *
  618.      * @internal
  619.      */
  620.     public static function generatePagePreview($id, $request = null, $hostUrl = null)
  621.     {
  622.         $doc = Document\Page::getById($id);
  623.         if (!$doc) {
  624.             return false;
  625.         }
  626.         if (!$hostUrl) {
  627.             $hostUrl = Config::getSystemConfiguration('documents')['preview_url_prefix'];
  628.             if (empty($hostUrl)) {
  629.                 $hostUrl = Tool::getHostUrl(null, $request);
  630.             }
  631.         }
  633.         $url = $hostUrl . $doc->getRealFullPath();
  634.         $tmpFile = PIMCORE_SYSTEM_TEMP_DIRECTORY . '/screenshot_tmp_' . $doc->getId() . '.png';
  635.         $file = $doc->getPreviewImageFilesystemPath();
  637.         File::mkdir(dirname($file));
  639.         $tool = false;
  640.         if (Chromium::isSupported()) {
  641.             $tool = Chromium::class;
  642.         } elseif (HtmlToImage::isSupported()) {
  643.             $tool = HtmlToImage::class;
  644.         }
  646.         if ($tool) {
  647.             /** @var Chromium|HtmlToImage $tool */
  648.             if ($tool::convert($url, $tmpFile)) {
  649.                 $im = \Pimcore\Image::getInstance();
  650.                 $im->load($tmpFile);
  651.                 $im->scaleByWidth(800);
  652.                 $im->save($file, 'jpeg', 85);
  654.                 unlink($tmpFile);
  656.                 return true;
  657.             }
  658.         }
  660.         return false;
  661.     }
  662. }