9.5/core_2_classes_2_resource_2_file_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Resource;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪File extends ‪AbstractFile

{

    protected ‪$metaDataLoaded = false;


    protected ‪$metaDataProperties = [];


    protected ‪$indexingInProgress = false;


    protected ‪$updatedProperties = [];


    public function ‪__construct(array $fileData, ‪ResourceStorage ‪$storage, array $metaData = [])

    {

        $this->identifier = $fileData['identifier'] ?? null;

        $this->name = $fileData['name'] ?? '';

        $this->properties = $fileData;

        $this->storage = ‪$storage;

        if (!empty($metaData)) {

            $this->metaDataLoaded = true;

            $this->metaDataProperties = $metaData;

        }

    }


    /*******************************

     * VARIOUS FILE PROPERTY GETTERS

     *******************************/

    public function ‪getProperty($key)

    {

        if (parent::hasProperty($key)) {

            return parent::getProperty($key);

        }

        $metaData = $this->‪_getMetaData();

        return $metaData[$key] ?? null;

    }


    public function ‪hasProperty($key)

    {

        if (!parent::hasProperty($key)) {

            return array_key_exists($key, $this->‪_getMetaData());

        }

        return true;

    }


    public function ‪getProperties()

    {

        return array_merge(parent::getProperties(), array_diff_key($this->‪_getMetaData(), parent::getProperties()));

    }


    public function ‪_getMetaData()

    {

        if (!$this->metaDataLoaded) {

            $this->‪loadMetaData();

        }

        return ‪$this->metaDataProperties;

    }


    /******************

     * CONTENTS RELATED

     ******************/

    public function ‪getContents()

    {

        return $this->‪getStorage()->‪getFileContents($this);

    }


    public function ‪getSha1()

    {

        if (empty($this->properties['sha1'])) {

            $this->properties['sha1'] = parent::getSha1();

        }

        return $this->properties['sha1'];

    }


    public function ‪setContents($contents)

    {

        $this->‪getStorage()->‪setFileContents($this, $contents);

        return $this;

    }


    /***********************

     * INDEX RELATED METHODS

     ***********************/

    public function ‪isIndexed()

    {

        return true;

    }


    protected function ‪loadMetaData()

    {

        if (!$this->indexingInProgress) {

            $this->indexingInProgress = true;

            $this->metaDataProperties = $this->‪getMetaDataRepository()->findByFile($this);

            $this->metaDataLoaded = true;

            $this->indexingInProgress = false;

        }

    }


    public function ‪updateProperties(array ‪$properties)

    {

        // Setting identifier and name to update values; we have to do this

        // here because we might need a new identifier when loading

        // (and thus possibly indexing) a file.

        if (isset(‪$properties['identifier'])) {

            $this->identifier = ‪$properties['identifier'];

        }

        if (isset(‪$properties['name'])) {

            $this->name = ‪$properties['name'];

        }


        if (isset(‪$properties['uid']) && $this->properties['uid'] != 0) {

            unset(‪$properties['uid']);

        }

        foreach (‪$properties as $key => $value) {

            if ($this->properties[$key] !== $value) {

                if (!in_array($key, $this->updatedProperties)) {

                    $this->updatedProperties[] = $key;

                }

                $this->properties[$key] = $value;

            }

        }

        // If the mime_type property should be updated and it was changed also update the type.

        if (array_key_exists('mime_type', ‪$properties) && in_array('mime_type', $this->updatedProperties)) {

            $this->updatedProperties[] = 'type';

            unset($this->properties['type']);

            $this->‪getType();

        }

        if (array_key_exists('storage', ‪$properties) && in_array('storage', $this->updatedProperties)) {

            $this->storage = ‪ResourceFactory::getInstance()->‪getStorageObject(‪$properties['storage']);

        }

    }


    public function ‪_updateMetaDataProperties(array ‪$properties)

    {

        $this->metaDataProperties = array_merge($this->metaDataProperties, ‪$properties);

    }


    public function ‪getUpdatedProperties()

    {

        return ‪$this->updatedProperties;

    }


    /****************************************

     * STORAGE AND MANAGEMENT RELATED METHODS

     ****************************************/

    public function ‪checkActionPermission($action)

    {

        return $this->‪getStorage()->‪checkFileActionPermission($action, $this);

    }


    /*****************

     * SPECIAL METHODS

     *****************/

    public function ‪calculateChecksum()

    {

        return md5(

            $this->‪getCombinedIdentifier() . '|' .

            $this->‪getMimeType() . '|' .

            ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']

        );

    }


    public function ‪process($taskType, array $configuration)

    {

        return $this->‪getStorage()->‪processFile($this, $taskType, $configuration);

    }


    public function ‪toArray()

    {

        $array = [

            'id' => $this->‪getCombinedIdentifier(),

            'name' => $this->‪getName(),

            'extension' => $this->‪getExtension(),

            'type' => $this->‪getType(),

            'mimetype' => $this->‪getMimeType(),

            'size' => $this->‪getSize(),

            'url' => $this->‪getPublicUrl(),

            'indexed' => true,

            'uid' => $this->‪getUid(),

            'permissions' => [

                'read' => $this->‪checkActionPermission('read'),

                'write' => $this->‪checkActionPermission('write'),

                'delete' => $this->‪checkActionPermission('delete')

            ],

            'checksum' => $this->‪calculateChecksum()

        ];

        foreach ($this->properties as $key => $value) {

            $array[$key] = $value;

        }

        $stat = $this->‪getStorage()->‪getFileInfo($this);

        foreach ($stat as $key => $value) {

            $array[$key] = $value;

        }

        return $array;

    }


    public function ‪isMissing()

    {

        return (bool)$this->‪getProperty('missing');

    }


    public function ‪setMissing($missing)

    {

        $this->‪updateProperties(['missing' => $missing ? 1 : 0]);

    }


    public function ‪getPublicUrl($relativeToCurrentScript = false)

    {

        if ($this->‪isMissing() || $this->deleted) {

            return null;

        }

        return $this->‪getStorage()->‪getPublicUrl($this, $relativeToCurrentScript);

    }


    protected function ‪getMetaDataRepository()

    {

        return GeneralUtility::makeInstance(Index\MetaDataRepository::class);

    }


    protected function ‪getFileIndexRepository()

    {

        return GeneralUtility::makeInstance(Index\FileIndexRepository::class);

    }


    public function ‪setIndexingInProgess($indexingState)

    {

        $this->indexingInProgress = (bool)$indexingState;

    }


    public function ‪_getPropertyRaw($key)

    {

        return parent::getProperty($key);

    }

}