vendor/contao/core-bundle/src/Resources/contao/elements/ContentDownloads.php line 67

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. use Contao\CoreBundle\Exception\PageNotFoundException;
  14. use Contao\Model\Collection;
  16. /**
  17.  * Front end content element "downloads".
  18.  */
  19. class ContentDownloads extends ContentDownload
  20. {
  21.     /**
  22.      * Files object
  23.      * @var Collection|FilesModel
  24.      */
  25.     protected $objFiles;
  27.     /**
  28.      * Template
  29.      * @var string
  30.      */
  31.     protected $strTemplate = 'ce_downloads';
  33.     /**
  34.      * Return if there are no files
  35.      *
  36.      * @return string
  37.      */
  38.     public function generate()
  39.     {
  40.         if ($this->isHidden())
  41.         {
  42.             return '';
  43.         }
  45.         // Use the home directory of the current user as file source
  46.         if ($this->useHomeDir && System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  47.         {
  48.             $this->import(FrontendUser::class, 'User');
  50.             if ($this->User->assignDir && $this->User->homeDir)
  51.             {
  52.                 $this->multiSRC = array($this->User->homeDir);
  53.             }
  54.         }
  55.         else
  56.         {
  57.             $this->multiSRC = StringUtil::deserialize($this->multiSRC);
  58.         }
  60.         // Return if there are no files
  61.         if (empty($this->multiSRC) && !\is_array($this->multiSRC))
  62.         {
  63.             return '';
  64.         }
  66.         // Get the file entries from the database
  67.         $this->objFiles = FilesModel::findMultipleByUuids($this->multiSRC);
  69.         if ($this->objFiles === null)
  70.         {
  71.             return '';
  72.         }
  74.         $file = Input::get('file', true);
  76.         // Send the file to the browser (see #4632 and #8375)
  77.         if ($file && \is_string($file) && (!isset($_GET['cid']) || Input::get('cid') == $this->id))
  78.         {
  79.             while ($this->objFiles->next())
  80.             {
  81.                 if ($file == $this->objFiles->path || \dirname($file) == $this->objFiles->path)
  82.                 {
  83.                     Controller::sendFileToBrowser($file, (bool) $this->inline);
  84.                 }
  85.             }
  87.             if (isset($_GET['cid']))
  88.             {
  89.                 throw new PageNotFoundException('Invalid file name');
  90.             }
  92.             $this->objFiles->reset();
  93.         }
  95.         return ContentElement::generate();
  96.     }
  98.     /**
  99.      * Generate the content element
  100.      */
  101.     protected function compile()
  102.     {
  103.         $files = array();
  104.         $allowedDownload = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  106.         $container = System::getContainer();
  107.         $projectDir = $container->getParameter('kernel.project_dir');
  108.         $request = $container->get('request_stack')->getCurrentRequest();
  109.         $isBackend = $request && $container->get('contao.routing.scope_matcher')->isBackendRequest($request);
  111.         $objFiles = $this->objFiles;
  113.         // Get all files
  114.         while ($objFiles->next())
  115.         {
  116.             // Continue if the files has been processed or does not exist
  117.             if (isset($files[$objFiles->path]) || !file_exists($projectDir . '/' . $objFiles->path))
  118.             {
  119.                 continue;
  120.             }
  122.             // Single files
  123.             if ($objFiles->type == 'file')
  124.             {
  125.                 $objFile = new File($objFiles->path);
  127.                 if (!\in_array($objFile->extension, $allowedDownload) || preg_match('/^meta(_[a-z]{2})?\.txt$/', $objFile->basename))
  128.                 {
  129.                     continue;
  130.                 }
  132.                 if ($isBackend)
  133.                 {
  134.                     $arrMeta = $this->getMetaData($objFiles->meta, $GLOBALS['TL_LANGUAGE']);
  135.                 }
  136.                 else
  137.                 {
  138.                     /** @var PageModel $objPage */
  139.                     global $objPage;
  141.                     $arrMeta = $this->getMetaData($objFiles->meta, $objPage->language);
  143.                     if (empty($arrMeta))
  144.                     {
  145.                         if ($this->metaIgnore)
  146.                         {
  147.                             continue;
  148.                         }
  150.                         if ($objPage->rootFallbackLanguage !== null)
  151.                         {
  152.                             $arrMeta = $this->getMetaData($objFiles->meta, $objPage->rootFallbackLanguage);
  153.                         }
  154.                     }
  155.                 }
  157.                 // Use the file name as title if none is given
  158.                 if (empty($arrMeta['title']))
  159.                 {
  160.                     $arrMeta['title'] = StringUtil::specialchars($objFile->basename);
  161.                 }
  163.                 $strHref = Environment::get('request');
  165.                 // Remove an existing file parameter (see #5683)
  166.                 if (isset($_GET['file']))
  167.                 {
  168.                     $strHref = preg_replace('/(&(amp;)?|\?)file=[^&]+/', '', $strHref);
  169.                 }
  171.                 if (isset($_GET['cid']))
  172.                 {
  173.                     $strHref = preg_replace('/(&(amp;)?|\?)cid=\d+/', '', $strHref);
  174.                 }
  176.                 $strHref .= (strpos($strHref, '?') !== false ? '&amp;' : '?') . 'file=' . System::urlEncode($objFiles->path) . '&amp;cid=' . $this->id;
  178.                 // Add the image
  179.                 $files[$objFiles->path] = array
  180.                 (
  181.                     'id'        => $objFiles->id,
  182.                     'uuid'      => $objFiles->uuid,
  183.                     'name'      => $objFile->basename,
  184.                     'title'     => StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['download'], $objFile->basename)),
  185.                     'link'      => $arrMeta['title'] ?? null,
  186.                     'caption'   => $arrMeta['caption'] ?? null,
  187.                     'href'      => $strHref,
  188.                     'filesize'  => $this->getReadableSize($objFile->filesize),
  189.                     'icon'      => Image::getPath($objFile->icon),
  190.                     'mime'      => $objFile->mime,
  191.                     'meta'      => $arrMeta,
  192.                     'extension' => $objFile->extension,
  193.                     'path'      => $objFile->dirname,
  194.                     'previews'  => $this->getPreviews($objFile->path, $strHref),
  195.                     'mtime'     => $objFile->mtime,
  196.                 );
  197.             }
  199.             // Folders
  200.             else
  201.             {
  202.                 $objSubfiles = FilesModel::findByPid($objFiles->uuid, array('order' => 'name'));
  204.                 if ($objSubfiles === null)
  205.                 {
  206.                     continue;
  207.                 }
  209.                 while ($objSubfiles->next())
  210.                 {
  211.                     // Skip subfolders
  212.                     if ($objSubfiles->type == 'folder')
  213.                     {
  214.                         continue;
  215.                     }
  217.                     $objFile = new File($objSubfiles->path);
  219.                     if (!\in_array($objFile->extension, $allowedDownload) || preg_match('/^meta(_[a-z]{2})?\.txt$/', $objFile->basename))
  220.                     {
  221.                         continue;
  222.                     }
  224.                     if ($isBackend)
  225.                     {
  226.                         $arrMeta = $this->getMetaData($objSubfiles->meta, $GLOBALS['TL_LANGUAGE']);
  227.                     }
  228.                     else
  229.                     {
  230.                         /** @var PageModel $objPage */
  231.                         global $objPage;
  233.                         $arrMeta = $this->getMetaData($objSubfiles->meta, $objPage->language);
  235.                         if (empty($arrMeta))
  236.                         {
  237.                             if ($this->metaIgnore)
  238.                             {
  239.                                 continue;
  240.                             }
  242.                             if ($objPage->rootFallbackLanguage !== null)
  243.                             {
  244.                                 $arrMeta = $this->getMetaData($objSubfiles->meta, $objPage->rootFallbackLanguage);
  245.                             }
  246.                         }
  247.                     }
  249.                     // Use the file name as title if none is given
  250.                     if (empty($arrMeta['title']))
  251.                     {
  252.                         $arrMeta['title'] = StringUtil::specialchars($objFile->basename);
  253.                     }
  255.                     $strHref = Environment::get('request');
  257.                     // Remove an existing file parameter (see #5683)
  258.                     if (preg_match('/(&(amp;)?|\?)file=/', $strHref))
  259.                     {
  260.                         $strHref = preg_replace('/(&(amp;)?|\?)file=[^&]+/', '', $strHref);
  261.                     }
  263.                     $strHref .= (strpos($strHref, '?') !== false ? '&amp;' : '?') . 'file=' . System::urlEncode($objSubfiles->path);
  265.                     // Add the image
  266.                     $files[$objSubfiles->path] = array
  267.                     (
  268.                         'id'        => $objSubfiles->id,
  269.                         'uuid'      => $objSubfiles->uuid,
  270.                         'name'      => $objFile->basename,
  271.                         'title'     => StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['download'], $objFile->basename)),
  272.                         'link'      => $arrMeta['title'],
  273.                         'caption'   => $arrMeta['caption'] ?? null,
  274.                         'href'      => $strHref,
  275.                         'filesize'  => $this->getReadableSize($objFile->filesize),
  276.                         'icon'      => Image::getPath($objFile->icon),
  277.                         'mime'      => $objFile->mime,
  278.                         'meta'      => $arrMeta,
  279.                         'extension' => $objFile->extension,
  280.                         'path'      => $objFile->dirname,
  281.                         'previews'  => $this->getPreviews($objFile->path, $strHref),
  282.                         'mtime'     => $objFile->mtime,
  283.                     );
  284.                 }
  285.             }
  286.         }
  288.         // Sort array
  289.         switch ($this->sortBy)
  290.         {
  291.             default:
  292.             case 'name_asc':
  293.                 uksort($files, static function ($a, $b): int
  294.                 {
  295.                     return strnatcasecmp(basename($a), basename($b));
  296.                 });
  297.                 break;
  299.             case 'name_desc':
  300.                 uksort($files, static function ($a, $b): int
  301.                 {
  302.                     return -strnatcasecmp(basename($a), basename($b));
  303.                 });
  304.                 break;
  306.             case 'date_asc':
  307.                 uasort($files, static function (array $a, array $b)
  308.                 {
  309.                     return $a['mtime'] <=> $b['mtime'];
  310.                 });
  311.                 break;
  313.             case 'date_desc':
  314.                 uasort($files, static function (array $a, array $b)
  315.                 {
  316.                     return $b['mtime'] <=> $a['mtime'];
  317.                 });
  318.                 break;
  320.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  321.             case 'meta':
  322.                 trigger_deprecation('contao/core-bundle', '4.0', 'The "meta" key in "Contao\ContentDownloads::compile()" has been deprecated and will no longer work in Contao 5.0.');
  323.                 // no break
  325.             case 'custom':
  326.                 $files = ArrayUtil::sortByOrderField($files, $this->orderSRC);
  327.                 break;
  329.             case 'random':
  330.                 shuffle($files);
  331.                 break;
  332.         }
  334.         $this->Template->files = array_values($files);
  335.     }
  336. }
  338. class_alias(ContentDownloads::class, 'ContentDownloads');