vendor/contao/core-bundle/src/Resources/contao/models/FilesModel.php line 249

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\File\Metadata;
  14. use Contao\Model\Collection;
  15. use Contao\Model\Registry;
  16. use Symfony\Component\Filesystem\Path;
  18. /**
  19.  * Reads and writes file entries
  20.  *
  21.  * The files themselves reside in the files directory. This class only handles
  22.  * the corresponding database entries (database aided file system).
  23.  *
  24.  * @property string|integer      $id
  25.  * @property string|integer|null $pid
  26.  * @property string|integer      $tstamp
  27.  * @property string|null         $uuid
  28.  * @property string              $type
  29.  * @property string              $path
  30.  * @property string              $extension
  31.  * @property string              $hash
  32.  * @property string|boolean      $found
  33.  * @property string              $name
  34.  * @property string|float        $importantPartX
  35.  * @property string|float        $importantPartY
  36.  * @property string|float        $importantPartWidth
  37.  * @property string|float        $importantPartHeight
  38.  * @property string|array|null   $meta
  39.  *
  40.  * @method static FilesModel|null findByIdOrAlias($val, array $opt=array())
  41.  * @method static FilesModel|null findOneBy($col, $val, array $opt=array())
  42.  * @method static FilesModel|null findOneByPid($val, array $opt=array())
  43.  * @method static FilesModel|null findOneByTstamp($val, array $opt=array())
  44.  * @method static FilesModel|null findOneByType($val, array $opt=array())
  45.  * @method static FilesModel|null findOneByExtension($val, array $opt=array())
  46.  * @method static FilesModel|null findOneByHash($val, array $opt=array())
  47.  * @method static FilesModel|null findOneByFound($val, array $opt=array())
  48.  * @method static FilesModel|null findOneByName($val, array $opt=array())
  49.  * @method static FilesModel|null findOneByImportantPartX($val, array $opt=array())
  50.  * @method static FilesModel|null findOneByImportantPartY($val, array $opt=array())
  51.  * @method static FilesModel|null findOneByImportantPartWidth($val, array $opt=array())
  52.  * @method static FilesModel|null findOneByImportantPartHeight($val, array $opt=array())
  53.  * @method static FilesModel|null findOneByMeta($val, array $opt=array())
  54.  *
  55.  * @method static Collection|FilesModel[]|FilesModel|null findByTstamp($val, array $opt=array())
  56.  * @method static Collection|FilesModel[]|FilesModel|null findByType($val, array $opt=array())
  57.  * @method static Collection|FilesModel[]|FilesModel|null findByExtension($val, array $opt=array())
  58.  * @method static Collection|FilesModel[]|FilesModel|null findByHash($val, array $opt=array())
  59.  * @method static Collection|FilesModel[]|FilesModel|null findByFound($val, array $opt=array())
  60.  * @method static Collection|FilesModel[]|FilesModel|null findByName($val, array $opt=array())
  61.  * @method static Collection|FilesModel[]|FilesModel|null findByImportantPartX($val, array $opt=array())
  62.  * @method static Collection|FilesModel[]|FilesModel|null findByImportantPartY($val, array $opt=array())
  63.  * @method static Collection|FilesModel[]|FilesModel|null findByImportantPartWidth($val, array $opt=array())
  64.  * @method static Collection|FilesModel[]|FilesModel|null findByImportantPartHeight($val, array $opt=array())
  65.  * @method static Collection|FilesModel[]|FilesModel|null findByMeta($val, array $opt=array())
  66.  * @method static Collection|FilesModel[]|FilesModel|null findBy($col, $val, array $opt=array())
  67.  * @method static Collection|FilesModel[]|FilesModel|null findAll(array $opt=array())
  68.  *
  69.  * @method static integer countById($id, array $opt=array())
  70.  * @method static integer countByPid($val, array $opt=array())
  71.  * @method static integer countByTstamp($val, array $opt=array())
  72.  * @method static integer countByUuid($val, array $opt=array())
  73.  * @method static integer countByType($val, array $opt=array())
  74.  * @method static integer countByPath($val, array $opt=array())
  75.  * @method static integer countByExtension($val, array $opt=array())
  76.  * @method static integer countByHash($val, array $opt=array())
  77.  * @method static integer countByFound($val, array $opt=array())
  78.  * @method static integer countByName($val, array $opt=array())
  79.  * @method static integer countByImportantPartX($val, array $opt=array())
  80.  * @method static integer countByImportantPartY($val, array $opt=array())
  81.  * @method static integer countByImportantPartWidth($val, array $opt=array())
  82.  * @method static integer countByImportantPartHeight($val, array $opt=array())
  83.  * @method static integer countByMeta($val, array $opt=array())
  84.  */
  85. class FilesModel extends Model
  86. {
  87.     /**
  88.      * Table name
  89.      * @var string
  90.      */
  91.     protected static $strTable = 'tl_files';
  93.     /**
  94.      * Returns the full absolute path.
  95.      */
  96.     public function getAbsolutePath(): string
  97.     {
  98.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  100.         return Path::makeAbsolute($this->path, $projectDir);
  101.     }
  103.     /**
  104.      * Find a file by its primary key
  105.      *
  106.      * @param mixed $varValue   The value
  107.      * @param array $arrOptions An optional options array
  108.      *
  109.      * @return FilesModel|Model|null The model or null if there is no file
  110.      */
  111.     public static function findByPk($varValue, array $arrOptions=array())
  112.     {
  113.         if (static::$strPk == 'id')
  114.         {
  115.             return static::findById($varValue, $arrOptions);
  116.         }
  118.         return parent::findByPk($varValue, $arrOptions);
  119.     }
  121.     /**
  122.      * Find a file by its ID or UUID
  123.      *
  124.      * @param mixed $intId      The ID or UUID
  125.      * @param array $arrOptions An optional options array
  126.      *
  127.      * @return FilesModel|null The model or null if there is no file
  128.      */
  129.     public static function findById($intId, array $arrOptions=array())
  130.     {
  131.         if (Validator::isUuid($intId))
  132.         {
  133.             return static::findByUuid($intId, $arrOptions);
  134.         }
  136.         return static::findOneBy('id', $intId, $arrOptions);
  137.     }
  139.     /**
  140.      * Find a file by its parent ID
  141.      *
  142.      * @param mixed $intPid     The parent ID
  143.      * @param array $arrOptions An optional options array
  144.      *
  145.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no files
  146.      */
  147.     public static function findByPid($intPid, array $arrOptions=array())
  148.     {
  149.         $t = static::$strTable;
  151.         // Convert UUIDs to binary
  152.         if (Validator::isStringUuid($intPid))
  153.         {
  154.             $intPid = StringUtil::uuidToBin($intPid);
  155.         }
  157.         return static::findBy(array("$t.pid=UNHEX(?)"), bin2hex((string) $intPid), $arrOptions);
  158.     }
  160.     /**
  161.      * Find multiple files by their IDs or UUIDs
  162.      *
  163.      * @param array $arrIds     An array of IDs or UUIDs
  164.      * @param array $arrOptions An optional options array
  165.      *
  166.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no files
  167.      */
  168.     public static function findMultipleByIds($arrIds, array $arrOptions=array())
  169.     {
  170.         if (empty($arrIds) || !\is_array($arrIds))
  171.         {
  172.             return null;
  173.         }
  175.         if (Validator::isUuid(current($arrIds)))
  176.         {
  177.             return static::findMultipleByUuids($arrIds, $arrOptions);
  178.         }
  180.         return parent::findMultipleByIds($arrIds, $arrOptions);
  181.     }
  183.     /**
  184.      * Find a file by its UUID
  185.      *
  186.      * @param string $strUuid    The UUID string
  187.      * @param array  $arrOptions An optional options array
  188.      *
  189.      * @return FilesModel|null The model or null if there is no file
  190.      */
  191.     public static function findByUuid($strUuid, array $arrOptions=array())
  192.     {
  193.         $t = static::$strTable;
  195.         // Convert UUIDs to binary
  196.         if (Validator::isStringUuid($strUuid))
  197.         {
  198.             $strUuid = StringUtil::uuidToBin($strUuid);
  199.         }
  201.         // Check the model registry (does not work by default due to UNHEX())
  202.         if (empty($arrOptions))
  203.         {
  204.             /** @var FilesModel $objModel */
  205.             $objModel = Registry::getInstance()->fetch(static::$strTable, $strUuid, 'uuid');
  207.             if ($objModel !== null)
  208.             {
  209.                 return $objModel;
  210.             }
  211.         }
  213.         return static::findOneBy(array("$t.uuid=UNHEX(?)"), bin2hex((string) $strUuid), $arrOptions);
  214.     }
  216.     /**
  217.      * Find multiple files by their UUIDs
  218.      *
  219.      * @param array $arrUuids   An array of UUIDs
  220.      * @param array $arrOptions An optional options array
  221.      *
  222.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no files
  223.      */
  224.     public static function findMultipleByUuids($arrUuids, array $arrOptions=array())
  225.     {
  226.         if (empty($arrUuids) || !\is_array($arrUuids))
  227.         {
  228.             return null;
  229.         }
  231.         $t = static::$strTable;
  233.         foreach ($arrUuids as $k=>$v)
  234.         {
  235.             // Convert UUIDs to binary
  236.             if (Validator::isStringUuid($v))
  237.             {
  238.                 $v = StringUtil::uuidToBin($v);
  239.             }
  241.             $arrUuids[$k] = "UNHEX('" . bin2hex((string) $v) . "')";
  242.         }
  244.         if (!isset($arrOptions['order']))
  245.         {
  246.             $arrOptions['order'] = "$t.uuid!=" . implode(", $t.uuid!=", $arrUuids);
  247.         }
  249.         return static::findBy(array("$t.uuid IN(" . implode(",", $arrUuids) . ")"), null, $arrOptions);
  250.     }
  252.     /**
  253.      * Find a file by its path
  254.      *
  255.      * @param string $path       The path
  256.      * @param array  $arrOptions An optional options array
  257.      *
  258.      * @return FilesModel|null The model or null if there is no file
  259.      */
  260.     public static function findByPath($path, array $arrOptions=array())
  261.     {
  262.         if (!\is_string($path))
  263.         {
  264.             return null;
  265.         }
  267.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  268.         $uploadPath = System::getContainer()->getParameter('contao.upload_path');
  270.         if (Path::isBasePath($projectDir, $path))
  271.         {
  272.             $path = Path::makeRelative($path, $projectDir);
  273.         }
  275.         if (!Path::isBasePath($uploadPath, $path))
  276.         {
  277.             return null;
  278.         }
  280.         return static::findOneBy('path', $path, $arrOptions);
  281.     }
  283.     /**
  284.      * Find multiple files by their paths
  285.      *
  286.      * @param array $arrPaths   An array of file paths
  287.      * @param array $arrOptions An optional options array
  288.      *
  289.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no files
  290.      */
  291.     public static function findMultipleByPaths($arrPaths, array $arrOptions=array())
  292.     {
  293.         if (empty($arrPaths) || !\is_array($arrPaths))
  294.         {
  295.             return null;
  296.         }
  298.         $t = static::$strTable;
  300.         if (!isset($arrOptions['order']))
  301.         {
  302.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.path", $arrPaths);
  303.         }
  305.         return static::findBy(array("$t.path IN(" . implode(',', array_fill(0, \count($arrPaths), '?')) . ")"), $arrPaths, $arrOptions);
  306.     }
  308.     /**
  309.      * Find multiple files with the same base path
  310.      *
  311.      * @param string $strPath    The base path
  312.      * @param array  $arrOptions An optional options array
  313.      *
  314.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no matching files
  315.      */
  316.     public static function findMultipleByBasepath($strPath, array $arrOptions=array())
  317.     {
  318.         $t = static::$strTable;
  320.         if (!isset($arrOptions['order']))
  321.         {
  322.             $arrOptions['order'] = "$t.path";
  323.         }
  325.         return static::findBy(array("$t.path LIKE ?"), $strPath . '%', $arrOptions);
  326.     }
  328.     /**
  329.      * Find multiple files by UUID and a list of extensions
  330.      *
  331.      * @param array $arrUuids      An array of file UUIDs
  332.      * @param array $arrExtensions An array of file extensions
  333.      * @param array $arrOptions    An optional options array
  334.      *
  335.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null of there are no matching files
  336.      */
  337.     public static function findMultipleByUuidsAndExtensions($arrUuids, $arrExtensions, array $arrOptions=array())
  338.     {
  339.         if (empty($arrUuids) || empty($arrExtensions) || !\is_array($arrUuids) || !\is_array($arrExtensions))
  340.         {
  341.             return null;
  342.         }
  344.         foreach ($arrExtensions as $k=>$v)
  345.         {
  346.             if (!preg_match('/^[a-z0-9]{2,5}$/i', $v))
  347.             {
  348.                 unset($arrExtensions[$k]);
  349.             }
  350.         }
  352.         $t = static::$strTable;
  354.         foreach ($arrUuids as $k=>$v)
  355.         {
  356.             // Convert UUIDs to binary
  357.             if (Validator::isStringUuid($v))
  358.             {
  359.                 $v = StringUtil::uuidToBin($v);
  360.             }
  362.             $arrUuids[$k] = "UNHEX('" . bin2hex((string) $v) . "')";
  363.         }
  365.         if (!isset($arrOptions['order']))
  366.         {
  367.             $arrOptions['order'] = "$t.uuid!=" . implode(", $t.uuid!=", $arrUuids);
  368.         }
  370.         return static::findBy(array("$t.uuid IN(" . implode(",", $arrUuids) . ") AND $t.extension IN('" . implode("','", $arrExtensions) . "')"), null, $arrOptions);
  371.     }
  373.     /**
  374.      * Find all files in a folder
  375.      *
  376.      * @param string $strPath    The folder path
  377.      * @param array  $arrOptions An optional options array
  378.      *
  379.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no matching files
  380.      */
  381.     public static function findMultipleFilesByFolder($strPath, array $arrOptions=array())
  382.     {
  383.         $t = static::$strTable;
  384.         $strPath = str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $strPath);
  386.         return static::findBy(array("$t.type='file' AND $t.path LIKE ? AND $t.path NOT LIKE ?"), array($strPath . '/%', $strPath . '/%/%'), $arrOptions);
  387.     }
  389.     /**
  390.      * Find all folders in a folder
  391.      *
  392.      * @param string $strPath    The folder path
  393.      * @param array  $arrOptions An optional options array
  394.      *
  395.      * @return Collection|FilesModel[]|FilesModel|null A collection of models or null if there are no matching folders
  396.      */
  397.     public static function findMultipleFoldersByFolder($strPath, array $arrOptions=array())
  398.     {
  399.         $t = static::$strTable;
  400.         $strPath = str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $strPath);
  402.         return static::findBy(array("$t.type='folder' AND $t.path LIKE ? AND $t.path NOT LIKE ?"), array($strPath . '/%', $strPath . '/%/%'), $arrOptions);
  403.     }
  405.     /**
  406.      * Do not reload the data upon insert
  407.      *
  408.      * @param integer $intType The query type (Model::INSERT or Model::UPDATE)
  409.      */
  410.     protected function postSave($intType)
  411.     {
  412.     }
  414.     /**
  415.      * Return the meta fields defined in tl_files.meta.eval.metaFields
  416.      */
  417.     public static function getMetaFields(): array
  418.     {
  419.         Controller::loadDataContainer('tl_files');
  421.         return array_keys($GLOBALS['TL_DCA']['tl_files']['fields']['meta']['eval']['metaFields'] ?? array());
  422.     }
  424.     /**
  425.      * Return the metadata for this file
  426.      *
  427.      * Returns the metadata of the first matching locale or null if none was found.
  428.      */
  429.     public function getMetadata(string ...$locales): ?Metadata
  430.     {
  431.         $dataCollection = StringUtil::deserialize($this->meta, true);
  433.         foreach ($locales as $locale)
  434.         {
  435.             if (!\is_array($data = $dataCollection[$locale] ?? null))
  436.             {
  437.                 continue;
  438.             }
  440.             // Make sure we resolve insert tags pointing to files
  441.             if (isset($data[Metadata::VALUE_URL]))
  442.             {
  443.                 $data[Metadata::VALUE_URL] = System::getContainer()->get('contao.insert_tag.parser')->replaceInline($data[Metadata::VALUE_URL] ?? '');
  444.             }
  446.             // Fill missing meta fields with empty values
  447.             $metaFields = self::getMetaFields();
  448.             $data = array_merge(array_combine($metaFields, array_fill(0, \count($metaFields), '')), $data);
  450.             return new Metadata($data);
  451.         }
  453.         return null;
  454.     }
  455. }
  457. class_alias(FilesModel::class, 'FilesModel');