FilePermissionUpdate.php

Go to the documentation of this file.

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

class FilePermissionUpdate extends AbstractUpdate {

    protected $installToolSqlParser;

    protected $title = 'Rewrite binary file permissions into detailed list';

    public function __construct() {
        $this->installToolSqlParser = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Install\\Service\\SqlSchemaMigrationService');
    }

    public function checkForUpdate(&$description) {
        $description = 'There are backend users and backend groups with specified file permissions.' .
            ' This update migrates old combined (binary) file permissions to new separate ones.';
        $updateNeeded = FALSE;
        $updateStatements = $this->getUpdateStatements();
        if (!empty($updateStatements['add'])) {
            // Field might not be there, so we need an update run to add the field
            return TRUE;
        }
        $beUsersFieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields('be_users');
        if (isset($beUsersFieldInformation['fileoper_perms'])) {
            // Fetch user records where the old permission field is not empty but the new one is
            $notMigratedRowsCount = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows(
                'uid',
                'be_users',
                $this->getWhereClause()
            );
            if ($notMigratedRowsCount > 0) {
                $updateNeeded = TRUE;
            }
        } else {
            $beGroupsFieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields('be_groups');
            if (isset($beGroupsFieldInformation['fileoper_perms'])) {
                // Fetch group records where the old permission field is not empty but the new one is
                $notMigratedRowsCount = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows(
                    'uid',
                    'be_groups',
                    $this->getWhereClause()
                );
                if ($notMigratedRowsCount > 0) {
                    $updateNeeded = TRUE;
                }
            }
        }
        return $updateNeeded;
    }

    public function performUpdate(array &$dbQueries, &$customMessages) {
        // First perform all add update statements to database
        $updateStatements = $this->getUpdateStatements();
        foreach ((array) $updateStatements['add'] as $query) {
            $GLOBALS['TYPO3_DB']->admin_query($query);
            $dbQueries[] = $query;
            if ($GLOBALS['TYPO3_DB']->sql_error()) {
                $customMessages = 'SQL-ERROR: ' . htmlspecialchars($GLOBALS['TYPO3_DB']->sql_error());
                return FALSE;
            }
        }

        // Iterate over users and groups table to perform permission updates
        $tablesToProcess = array('be_groups', 'be_users');
        foreach ($tablesToProcess as $table) {
            $records = $this->getRecordsFromTable($table);
            foreach ($records as $singleRecord) {
                $filePermission = $this->getFilePermissions($singleRecord['fileoper_perms']);
                $updateArray = array(
                    'file_permissions' => $filePermission
                );
                $GLOBALS['TYPO3_DB']->exec_UPDATEquery($table, 'uid=' . (int)$singleRecord['uid'], $updateArray);
                // Get last executed query
                $dbQueries[] = str_replace(chr(10), ' ', $GLOBALS['TYPO3_DB']->debug_lastBuiltQuery);
                // Check for errors
                if ($GLOBALS['TYPO3_DB']->sql_error()) {
                    $customMessages = 'SQL-ERROR: ' . htmlspecialchars($GLOBALS['TYPO3_DB']->sql_error());
                    return FALSE;
                }
            }
        }

        return TRUE;
    }

    protected function getUpdateStatements() {
        $updateStatements = array();

        // Get all necessary statements for ext_tables.sql file
        $rawDefinitions = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('core') . '/ext_tables.sql');
        $fieldDefinitionsFromFile = $this->installToolSqlParser->getFieldDefinitions_fileContent($rawDefinitions);
        if (count($fieldDefinitionsFromFile)) {
            $fieldDefinitionsFromCurrentDatabase = $this->installToolSqlParser->getFieldDefinitions_database();
            $diff = $this->installToolSqlParser->getDatabaseExtra($fieldDefinitionsFromFile, $fieldDefinitionsFromCurrentDatabase);
            $updateStatements = $this->installToolSqlParser->getUpdateSuggestions($diff);
        }

        return $updateStatements;
    }

    protected function getFilePermissions($oldFileOperationPermissions) {
        if ($oldFileOperationPermissions == 0) {
            return '';
        }
        $defaultOptions = array(
            // File permissions
            'addFile' => TRUE,
            'readFile' => TRUE,
            'writeFile' => TRUE,
            'copyFile' => TRUE,
            'moveFile' => TRUE,
            'renameFile' => TRUE,
            'unzipFile' => TRUE,
            'deleteFile' => TRUE,
            // Folder permissions
            'addFolder' => TRUE,
            'readFolder' => TRUE,
            'writeFolder' => TRUE,
            'copyFolder' => TRUE,
            'moveFolder' => TRUE,
            'renameFolder' => TRUE,
            'deleteFolder' => TRUE,
            'recursivedeleteFolder' => TRUE
        );
        if (!($oldFileOperationPermissions & 1)) {
            unset($defaultOptions['addFile']);
            unset($defaultOptions['readFile']);
            unset($defaultOptions['writeFile']);
            unset($defaultOptions['copyFile']);
            unset($defaultOptions['moveFile']);
            unset($defaultOptions['renameFile']);
            unset($defaultOptions['deleteFile']);
        }
        if (!($oldFileOperationPermissions & 2)) {
            unset($defaultOptions['unzipFile']);
        }
        if (!($oldFileOperationPermissions & 4)) {
            unset($defaultOptions['addFolder']);
            unset($defaultOptions['writeFolder']);
            unset($defaultOptions['moveFolder']);
            unset($defaultOptions['renameFolder']);
            unset($defaultOptions['deleteFolder']);
        }
        if (!($oldFileOperationPermissions & 8)) {
            unset($defaultOptions['copyFolder']);
        }
        if (!($oldFileOperationPermissions & 16)) {
            unset($defaultOptions['recursivedeleteFolder']);
        }

        return implode(',', array_keys($defaultOptions));
    }

    protected function getRecordsFromTable($table) {
        $fields = implode(',', array('uid', 'fileoper_perms'));
        $records = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows($fields, $table, $this->getWhereClause());
        return $records;
    }

    protected function getWhereClause() {
        return 'fileoper_perms>0 AND file_permissions IS NULL';
    }

}