FileIdentifierHashUpdate.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Updates;

use TYPO3\CMS\Core\Resource\ResourceStorage;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

class FileIdentifierHashUpdate extends AbstractUpdate {

    protected $title = 'Add the file identifier hash to existing sys_file records and update the settings for local storages';

    protected $db;

    protected $sqlQueries = array();

    protected $storages;

    protected $storageRepository;

    public function __construct() {
        $this->db = $GLOBALS['TYPO3_DB'];
    }

    public function init() {
        $this->storageRepository = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Resource\\StorageRepository');
        $this->storages = $this->storageRepository->findAll();
        // Add default storage for core files
        $this->storages[] = \TYPO3\CMS\Core\Resource\ResourceFactory::getInstance()->getStorageObject(0);
    }

    public function checkForUpdate(&$description) {
        $description = 'Add file identifier hash to sys_file records, where it is missing. Additionally upgrade storage configurations.';
        $unhashedFileCount = $this->db->exec_SELECTcountRows(
            'uid',
            'sys_file',
            'identifier_hash = ' . $this->db->fullQuoteStr('', 'sys_file') . ' OR folder_hash = ' . $this->db->fullQuoteStr('', 'sys_file')
        );

        $unmigratedStorageCount = $this->db->exec_SELECTcountRows(
            'uid',
            'sys_file_storage',
            'driver = ' . $this->db->fullQuoteStr('Local', 'sys_file_storage') . ' AND configuration NOT LIKE ' . $this->db->fullQuoteStr('%caseSensitive%', 'sys_file_storage')
        );

        return $unhashedFileCount > 0 || $unmigratedStorageCount > 0;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {
        $this->init();
        foreach ($this->storages as $storage) {
            $dbQueries = array_merge($dbQueries, $this->updateIdentifierHashesForStorage($storage));
        }

        $dbQueries = array_merge($dbQueries, $this->migrateStorages());

        $this->markWizardAsDone();
        return TRUE;
    }

    protected function migrateStorages() {
        $dbQueries = array();
        $unmigratedStorages = $this->db->exec_SELECTgetRows(
            'uid, configuration',
            'sys_file_storage',
            'driver = ' . $this->db->fullQuoteStr('Local', 'sys_file_storage') . ' AND configuration NOT LIKE ' . $this->db->fullQuoteStr('%caseSensitive%', 'sys_file_storage')
        );

        $flexObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\FlexForm\\FlexFormTools');


        foreach ($unmigratedStorages as $storage) {
            $flexFormXml = $storage['configuration'];
            $configurationArray = \TYPO3\CMS\Core\Utility\GeneralUtility::xml2array($flexFormXml);

            $caseSensitive = $this->testCaseSensitivity(
                $configurationArray['data']['sDEF']['lDEF']['pathType']['vDEF'] == 'relative' ?
                    PATH_site . $configurationArray['data']['sDEF']['lDEF']['basePath']['vDEF'] :
                    $configurationArray['data']['sDEF']['lDEF']['basePath']['vDEF']
            );
            $configurationArray['data']['sDEF']['lDEF']['caseSensitive'] = array('vDEF' => $caseSensitive);

            $configuration = $flexObj->flexArray2Xml($configurationArray);
            $dbQueries[] = $query = $this->db->UPDATEquery(
                'sys_file_storage',
                'uid=' . $storage['uid'],
                array(
                    'configuration' => $configuration
                )
            );
            $this->db->sql_query($query);
        }
        return $dbQueries;
    }

    protected function updateIdentifierHashesForStorage(ResourceStorage $storage) {
        $queries = array();

        if (!ExtensionManagementUtility::isLoaded('dbal')) {
            // if DBAL is not loaded, we're using MySQL and can thus use their
            // SHA1() function
            if ($storage->usesCaseSensitiveIdentifiers()) {
                $updateCall = 'SHA1(identifier)';
            } else {
                $updateCall = 'SHA1(LOWER(identifier))';
            }
            $queries[] = $query = sprintf(
                'UPDATE sys_file SET identifier_hash = %s WHERE storage=%d',
                $updateCall,
                $storage->getUid()
            );
            $this->db->sql_query($query);

            // folder hashes cannot be done with one call: so do it manually
            $files = $this->db->exec_SELECTgetRows('uid, storage, identifier', 'sys_file',
                sprintf('storage=%d AND folder_hash=%s', $storage->getUid(), $this->db->fullQuoteStr('', 'sys_file'))
            );

            foreach ($files as $file) {
                $folderHash = $storage->hashFileIdentifier($storage->getFolderIdentifierFromFileIdentifier($file['identifier']));

                $queries[] = $query = $this->db->UPDATEquery(
                    'sys_file',
                    'uid=' . $file['uid'],
                    array(
                        'folder_hash' => $folderHash
                    )
                );

                $this->db->sql_query($query);
            }
        } else {
            // manually hash the identifiers when using DBAL
            $files = $this->db->exec_SELECTgetRows('uid, storage, identifier', 'sys_file',
                sprintf('storage=%d AND identifier_hash=""', $storage->getUid())
            );

            foreach ($files as $file) {
                $hash = $storage->hashFileIdentifier($file['identifier']);
                $folderHash = $storage->hashFileIdentifier($storage->getFolderIdentifierFromFileIdentifier($file['identifier']));

                $queries[] = $query = $this->db->UPDATEquery(
                    'sys_file',
                    'uid=' . $file['uid'],
                    array(
                        'identifier_hash' => $hash,
                        'folder_hash' => $folderHash
                    )
                );

                $this->db->sql_query($query);
            }
        }

        return $queries;
    }


    protected function testCaseSensitivity($absolutePath) {
        $caseSensitive = TRUE;
        $path = rtrim($absolutePath, '/') . '/aAbB';
        $testFileExists = file_exists($path);

        // create test file
        if (!$testFileExists) {
            @touch($path);
        }

        // do the actual sensitivity check
        if (file_exists(strtoupper($path)) && file_exists(strtolower($path))) {
            $caseSensitive = FALSE;
        }

        // clean filesystem
        if (!$testFileExists) {
            @unlink($path);
        }

        return $caseSensitive;
    }
}