MetaDataRepository.php

Go to the documentation of this file.

<?php

namespace TYPO3\CMS\Core\Resource\Index;

use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Resource\Exception\InvalidUidException;
use TYPO3\CMS\Core\Type\File as FileType;

class MetaDataRepository implements SingletonInterface {

    protected $tableName = 'sys_file_metadata';

    protected $tableFields = array();

    protected function getDatabaseConnection() {
        return $GLOBALS['TYPO3_DB'];
    }

    public function findByFile(File $file) {
        $record = $this->findByFileUid($file->getUid());

        // It could be possible that the meta information is freshly
        // created and inserted into the database. If this is the case
        // we have to take care about correct meta information for width and
        // height in case of an image.
        if (!empty($record['newlyCreated'])) {
            if ($file->getType() === File::FILETYPE_IMAGE && $file->getStorage()->getDriverType() === 'Local') {
                $fileNameAndPath = $file->getForLocalProcessing(FALSE);

                $imageInfo = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Type\\File\\ImageInfo', $fileNameAndPath);

                $additionalMetaInformation = array(
                    'width' => $imageInfo->getWidth(),
                    'height' => $imageInfo->getHeight(),
                );

                $this->update($file->getUid(), $additionalMetaInformation);
            }
            $record = $this->findByFileUid($file->getUid());
        }

        return $record;
    }

    public function findByFileUid($uid) {
        $uid = (int)$uid;
        if ($uid <= 0) {
            throw new InvalidUidException('Metadata can only be retrieved for indexed files. UID: "' . $uid . '"', 1381590731);
        }
        $record = $this->getDatabaseConnection()->exec_SELECTgetSingleRow('*', $this->tableName, 'file = ' . $uid . $this->getGeneralWhereClause());

        if ($record === FALSE) {
            $record = $this->createMetaDataRecord($uid);
        }

        $passedData = new \ArrayObject($record);
        $this->emitRecordPostRetrievalSignal($passedData);
        return $passedData->getArrayCopy();
    }

    protected function getGeneralWhereClause() {
        return ' AND sys_language_uid IN (0,-1) AND pid=0';
    }

    public function createMetaDataRecord($fileUid, array $additionalFields = array()) {
        $emptyRecord =  array(
            'file' => (int)$fileUid,
            'pid' => 0,
            'crdate' => $GLOBALS['EXEC_TIME'],
            'tstamp' => $GLOBALS['EXEC_TIME'],
            'cruser_id' => isset($GLOBALS['BE_USER']->user['uid']) ? (int)$GLOBALS['BE_USER']->user['uid'] : 0
        );
        $emptyRecord = array_merge($emptyRecord, $additionalFields);
        $this->getDatabaseConnection()->exec_INSERTquery($this->tableName, $emptyRecord);
        $record = $emptyRecord;
        $record['uid'] = $this->getDatabaseConnection()->sql_insert_id();
        $record['newlyCreated']  = TRUE;

        $this->emitRecordCreatedSignal($record);

        return $record;
    }

    public function update($fileUid, array $data) {
        if (count($this->tableFields) === 0) {
            $this->tableFields = $this->getDatabaseConnection()->admin_get_fields($this->tableName);
        }
        $updateRow = array_intersect_key($data, $this->tableFields);
        if (array_key_exists('uid', $updateRow)) {
            unset($updateRow['uid']);
        }
        $row = $this->findByFileUid($fileUid);
        if (count($updateRow) > 0) {
            $updateRow['tstamp'] = time();
            $this->getDatabaseConnection()->exec_UPDATEquery($this->tableName, 'uid = ' . (int)$row['uid'], $updateRow);

            $this->emitRecordUpdatedSignal(array_merge($row, $updateRow));
        }
    }

    public function removeByFileUid($fileUid) {
        $this->getDatabaseConnection()->exec_DELETEquery($this->tableName, 'file=' . (int)$fileUid);
        $this->emitRecordDeletedSignal($fileUid);
    }

    protected function getSignalSlotDispatcher() {
        return $this->getObjectManager()->get('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher');
    }

    protected function getObjectManager() {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
    }

    protected function emitRecordPostRetrievalSignal(\ArrayObject $data) {
        $this->getSignalSlotDispatcher()->dispatch('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository', 'recordPostRetrieval', array($data));
    }

    protected function emitRecordUpdatedSignal(array $data) {
        $this->getSignalSlotDispatcher()->dispatch('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository', 'recordUpdated', array($data));
    }

    protected function emitRecordCreatedSignal(array $data) {
        $this->getSignalSlotDispatcher()->dispatch('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository', 'recordCreated', array($data));
    }

    protected function emitRecordDeletedSignal($fileUid) {
        $this->getSignalSlotDispatcher()->dispatch('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository', 'recordDeleted', array($fileUid));
    }

    public static function getInstance() {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository');
    }
}