PreviewHook.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Version\Hook;

/*
 * 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\Backend\FrontendBackendUserAuthentication;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;

class PreviewHook implements \TYPO3\CMS\Core\SingletonInterface
{
    protected $previewKey = 'ADMCMD_prev';

    protected $tsfeObj;

    protected $previewConfiguration = false;

    protected $forceReadPermissions = false;

    public function checkForPreview($params, &$pObj)
    {
        $this->tsfeObj = $pObj;
        $this->previewConfiguration = $this->getPreviewConfiguration();
        if (is_array($this->previewConfiguration)) {
            // In case of a keyword-authenticated preview,
            // re-initialize the TSFE object:
            // because the GET variables are taken from the preview
            // configuration
            $this->tsfeObj = GeneralUtility::makeInstance(
                \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::class,
                $GLOBALS['TYPO3_CONF_VARS'],
                GeneralUtility::_GP('id'),
                GeneralUtility::_GP('type'),
                GeneralUtility::_GP('no_cache'),
                GeneralUtility::_GP('cHash'),
                GeneralUtility::_GP('jumpurl'),
                GeneralUtility::_GP('MP'),
                GeneralUtility::_GP('RDCT')
            );
            $GLOBALS['TSFE'] = $this->tsfeObj;
            // Configuration after initialization of TSFE object.
            // Basically this unsets the BE cookie if any and forces
            // the BE user set according to the preview configuration.
            // @previouslyknownas TSFE->ADMCMD_preview_postInit
            // Clear cookies:
            unset($_COOKIE['be_typo_user']);
        }
    }

    public function initializePreviewUser(&$params, &$pObj)
    {
        // if there is a valid BE user, and the full workspace should be previewed, the workspacePreview option should be set
        $workspaceUid = $this->previewConfiguration['fullWorkspace'];
        $workspaceRecord = null;
        if ((is_null($params['BE_USER']) || $params['BE_USER'] === false) && $this->previewConfiguration !== false && $this->previewConfiguration['BEUSER_uid'] > 0) {
            // First initialize a temp user object and resolve usergroup information
            $tempBackendUser = $this->createFrontendBackendUser();
            $tempBackendUser->userTS_dontGetCached = 1;
            $tempBackendUser->setBeUserByUid($this->previewConfiguration['BEUSER_uid']);
            if ($tempBackendUser->user['uid']) {
                $tempBackendUser->unpack_uc('');
                $tempBackendUser->fetchGroupData();
                // Handle degradation of admin users
                if ($tempBackendUser->isAdmin() && ExtensionManagementUtility::isLoaded('workspaces')) {
                    $workspaceRecord = $this->getDatabaseConnection()->exec_SELECTgetSingleRow(
                        'uid, adminusers, reviewers, members, db_mountpoints',
                        'sys_workspace',
                        'pid=0 AND uid=' . (int)$workspaceUid . BackendUtility::deleteClause('sys_workspace')
                    );
                    // Either use configured workspace mount or current page id, if admin user does not have any page mounts
                    if (empty($tempBackendUser->groupData['webmounts'])) {
                        $tempBackendUser->groupData['webmounts'] = !empty($workspaceRecord['db_mountpoints']) ? $workspaceRecord['db_mountpoints'] : $pObj->id;
                    }
                    // Force add degraded admin user as member of this workspace
                    $workspaceRecord['members'] = 'be_users_' . $this->previewConfiguration['BEUSER_uid'];
                    // Force read permission for degraded admin user
                    $this->forceReadPermissions = true;
                }
                // Store only needed information in the real simulate backend
                $BE_USER = $this->createFrontendBackendUser();
                $BE_USER->userTS_dontGetCached = 1;
                $BE_USER->user = $tempBackendUser->user;
                $BE_USER->user['admin'] = 0;
                $BE_USER->groupData['webmounts'] = $tempBackendUser->groupData['webmounts'];
                $BE_USER->groupList = $tempBackendUser->groupList;
                $BE_USER->userGroups = $tempBackendUser->userGroups;
                $BE_USER->userGroupsUID = $tempBackendUser->userGroupsUID;
                $pObj->beUserLogin = true;
            } else {
                $BE_USER = null;
                $pObj->beUserLogin = false;
            }
            unset($tempBackendUser);
            $params['BE_USER'] = $BE_USER;
        }
        if ($pObj->beUserLogin
            && is_object($params['BE_USER'])
            && MathUtility::canBeInterpretedAsInteger($workspaceUid)
        ) {
            if ($workspaceUid == 0
                || $workspaceUid >= -1
                && $params['BE_USER']->checkWorkspace($workspaceRecord ?: $workspaceUid)
                && $params['BE_USER']->isInWebMount($pObj->id)
            ) {
                // Check Access to workspace. Live (0) is OK to preview for all.
                $pObj->workspacePreview = (int)$workspaceUid;
            } else {
                // No preview, will default to "Live" at the moment
                $pObj->workspacePreview = -99;
            }
        }
    }

    public function overridePagePermissionClause(array $parameters)
    {
        $clause = $parameters['currentClause'];
        if ($parameters['perms'] & 1 && $this->forceReadPermissions) {
            $clause = ' 1=1';
        }
        return $clause;
    }

    public function overridePermissionCalculation(array $parameters)
    {
        $permissions = $parameters['outputPermissions'];
        if (!($permissions & Permission::PAGE_SHOW) && $this->forceReadPermissions) {
            $permissions |= Permission::PAGE_SHOW;
        }
        return $permissions;
    }

    public function getPreviewConfiguration()
    {
        $inputCode = $this->getPreviewInputCode();
        // If input code is available and shall not be ignored, look up the settings
        if ($inputCode && $inputCode !== 'IGNORE') {
            // "log out"
            if ($inputCode == 'LOGOUT') {
                setcookie($this->previewKey, '', 0, GeneralUtility::getIndpEnv('TYPO3_SITE_PATH'));
                if ($this->tsfeObj->TYPO3_CONF_VARS['FE']['workspacePreviewLogoutTemplate']) {
                    $templateFile = PATH_site . $this->tsfeObj->TYPO3_CONF_VARS['FE']['workspacePreviewLogoutTemplate'];
                    if (@is_file($templateFile)) {
                        $message = GeneralUtility::getUrl(PATH_site . $this->tsfeObj->TYPO3_CONF_VARS['FE']['workspacePreviewLogoutTemplate']);
                    } else {
                        $message = '<strong>ERROR!</strong><br>Template File "'
                            . $this->tsfeObj->TYPO3_CONF_VARS['FE']['workspacePreviewLogoutTemplate']
                            . '" configured with $TYPO3_CONF_VARS["FE"]["workspacePreviewLogoutTemplate"] not found. Please contact webmaster about this problem.';
                    }
                } else {
                    $message = 'You logged out from Workspace preview mode. Click this link to <a href="%1$s">go back to the website</a>';
                }
                $returnUrl = GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GET('returnUrl'));
                die(sprintf($message, htmlspecialchars(preg_replace('/\\&?' . $this->previewKey . '=[[:alnum:]]+/', '', $returnUrl))));
            }
            // Look for keyword configuration record:
            $where = 'keyword=' . $this->getDatabaseConnection()->fullQuoteStr($inputCode, 'sys_preview') . ' AND endtime>' . $GLOBALS['EXEC_TIME'];
            $previewData = $this->getDatabaseConnection()->exec_SELECTgetSingleRow('*', 'sys_preview', $where);
            // Get: Backend login status, Frontend login status
            // - Make sure to remove fe/be cookies (temporarily);
            // BE already done in ADMCMD_preview_postInit()
            if (is_array($previewData)) {
                if (empty(GeneralUtility::_POST())) {
                    // Unserialize configuration:
                    $previewConfig = unserialize($previewData['config']);
                    // For full workspace preview we only ADD a get variable
                    // to set the preview of the workspace - so all other Get
                    // vars are accepted. Hope this is not a security problem.
                    // Still posting is not allowed and even if a backend user
                    // get initialized it shouldn't lead to situations where
                    // users can use those credentials.
                    if ($previewConfig['fullWorkspace']) {
                        // Set the workspace preview value:
                        GeneralUtility::_GETset($previewConfig['fullWorkspace'], 'ADMCMD_previewWS');
                        // If ADMCMD_prev is set the $inputCode value cannot come
                        // from a cookie and we set that cookie here. Next time it will
                        // be found from the cookie if ADMCMD_prev is not set again...
                        if (GeneralUtility::_GP($this->previewKey)) {
                            // Lifetime is 1 hour, does it matter much?
                            // Requires the user to click the link from their email again if it expires.
                            setcookie($this->previewKey, GeneralUtility::_GP($this->previewKey), 0, GeneralUtility::getIndpEnv('TYPO3_SITE_PATH'));
                        }
                        return $previewConfig;
                    } elseif (GeneralUtility::getIndpEnv('TYPO3_SITE_URL') . 'index.php?' . $this->previewKey . '=' . $inputCode === GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL')) {
                        // Set GET variables
                        $GET_VARS = '';
                        parse_str($previewConfig['getVars'], $GET_VARS);
                        GeneralUtility::_GETset($GET_VARS);
                        // Return preview keyword configuration
                        return $previewConfig;
                    } else {
                        // This check is to prevent people from setting additional
                        // GET vars via realurl or other URL path based ways of passing parameters.
                        throw new \Exception(htmlspecialchars('Request URL did not match "'
                            . GeneralUtility::getIndpEnv('TYPO3_SITE_URL') . 'index.php?' . $this->previewKey . '='
                            . $inputCode . '"', 1294585190));
                    }
                } else {
                    throw new \Exception('POST requests are incompatible with keyword preview.', 1294585191);
                }
            } else {
                throw new \Exception('ADMCMD command could not be executed! (No keyword configuration found)', 1294585192);
            }
        }
        return false;
    }

    protected function getPreviewInputCode()
    {
        $inputCode = GeneralUtility::_GP($this->previewKey);
        // If no inputcode and a cookie is set, load input code from cookie:
        if (!$inputCode && $_COOKIE[$this->previewKey]) {
            $inputCode = $_COOKIE[$this->previewKey];
        }
        return $inputCode;
    }

    public function compilePreviewKeyword($getVarsStr, $backendUserUid, $ttl = 172800, $fullWorkspace = null)
    {
        $fieldData = [
            'keyword' => md5(uniqid(microtime(), true)),
            'tstamp' => $GLOBALS['EXEC_TIME'],
            'endtime' => $GLOBALS['EXEC_TIME'] + $ttl,
            'config' => serialize([
                'fullWorkspace' => $fullWorkspace,
                'getVars' => $getVarsStr,
                'BEUSER_uid' => $backendUserUid
            ])
        ];
        $this->getDatabaseConnection()->exec_INSERTquery('sys_preview', $fieldData);
        return $fieldData['keyword'];
    }

    public function getPreviewLinkLifetime()
    {
        $ttlHours = (int)$GLOBALS['BE_USER']->getTSConfigVal('options.workspaces.previewLinkTTLHours');
        return $ttlHours ? $ttlHours : 24 * 2;
    }

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

    protected function createFrontendBackendUser()
    {
        return GeneralUtility::makeInstance(
            FrontendBackendUserAuthentication::class
        );
    }
}