PageLinkHandler.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Recordlist\LinkHandler;

/*
 * 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 Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Database\DatabaseConnection;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Recordlist\Tree\View\LinkParameterProviderInterface;

class PageLinkHandler extends AbstractLinkHandler implements LinkHandlerInterface, LinkParameterProviderInterface
{
    protected $expandPage = 0;

    protected $linkParts = [];

    public function canHandleLink(array $linkParts)
    {
        if (!$linkParts['url']) {
            return false;
        }

        $id = $linkParts['url'];
        $parts = explode('#', $id);
        if (count($parts) > 1) {
            $id = $parts[0];
            $anchor = $parts[1];
        } else {
            $anchor = '';
        }
        // Checking if the id-parameter is an alias.
        if (!MathUtility::canBeInterpretedAsInteger($id)) {
            $records = BackendUtility::getRecordsByField('pages', 'alias', $id);
            if (empty($records)) {
                return false;
            }
            $id = (int)$records[0]['uid'];
        }
        $pageRow = BackendUtility::getRecordWSOL('pages', $id);
        if (!$pageRow) {
            return false;
        }

        $this->linkParts = $linkParts;
        $this->linkParts['pageid'] = $id;
        $this->linkParts['anchor'] = $anchor;

        return true;
    }

    public function formatCurrentUrl()
    {
        $lang = $this->getLanguageService();
        $titleLen = (int)$this->getBackendUser()->uc['titleLen'];

        $id = $this->linkParts['pageid'];
        $pageRow = BackendUtility::getRecordWSOL('pages', $id);

        return $lang->getLL('page', true)
            . ' \'' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($pageRow['title'], $titleLen)) . '\''
            . ' (ID:' . $id . ($this->linkParts['anchor'] ? ', #' . $this->linkParts['anchor'] : '') . ')';
    }

    public function render(ServerRequestInterface $request)
    {
        GeneralUtility::makeInstance(PageRenderer::class)->loadRequireJsModule('TYPO3/CMS/Recordlist/PageLinkHandler');

        $this->expandPage = isset($request->getQueryParams()['expandPage']) ? (int)$request->getQueryParams()['expandPage'] : 0;
        $this->setTemporaryDbMounts();

        $backendUser = $this->getBackendUser();

        $pageTree = GeneralUtility::makeInstance(ElementBrowserPageTreeView::class);
        $pageTree->setLinkParameterProvider($this);
        $pageTree->ext_showNavTitle = (bool)$backendUser->getTSConfigVal('options.pageTree.showNavTitle');
        $pageTree->ext_showPageId = (bool)$backendUser->getTSConfigVal('options.pageTree.showPageIdWithTitle');
        $pageTree->ext_showPathAboveMounts = (bool)$backendUser->getTSConfigVal('options.pageTree.showPathAboveMounts');
        $pageTree->addField('nav_title');
        $tree = $pageTree->getBrowsableTree();

        return '

                <!--
                    Wrapper table for page tree / record list:
                -->
                <table border="0" cellpadding="0" cellspacing="0" id="typo3-linkPages">
                    <tr>
                        <td class="c-wCell" valign="top"><h3>' . $this->getLanguageService()->getLL('pageTree') . ':</h3>'
                            . $this->getTemporaryTreeMountCancelNotice() . $tree . '</td>
                        <td class="c-wCell" valign="top">' . $this->expandPage($this->expandPage) . '</td>
                    </tr>
                </table>';
    }

    public function expandPage($expPageId)
    {
        // If there is an anchor value (content element reference) in the element reference, then force an ID to expand:
        if (!$expPageId && isset($this->linkParts['anchor'])) {
            // Set to the current link page id.
            $expPageId = $this->linkParts['pageid'];
        }
        // Draw the record list IF there is a page id to expand:
        if (!$expPageId || !MathUtility::canBeInterpretedAsInteger($expPageId) || !$this->getBackendUser()->isInWebMount($expPageId)) {
            return '';
        }

        // Set header:
        $out = '<h3>' . $this->getLanguageService()->getLL('contentElements') . ':</h3>';
        // Create header for listing, showing the page title/icon:
        $mainPageRec = BackendUtility::getRecordWSOL('pages', $expPageId);
        $db = $this->getDatabaseConnection();
        $out .= '
            <ul class="list-tree list-tree-root list-tree-root-clean">
                <li class="list-tree-control-open">
                    <span class="list-tree-group">
                        <span class="list-tree-icon">' . $this->iconFactory->getIconForRecord('pages', $mainPageRec, Icon::SIZE_SMALL)->render() . '</span>
                        <span class="list-tree-title">' . htmlspecialchars(BackendUtility::getRecordTitle('pages', $mainPageRec, true)) . '</span>
                    </span>
                    <ul>
            ';

        // Look up tt_content elements from the expanded page:
        $res = $db->exec_SELECTquery(
            '*',
            'tt_content',
            'pid=' . (int)$expPageId . BackendUtility::deleteClause('tt_content')
            . BackendUtility::versioningPlaceholderClause('tt_content'),
            '',
            'colPos,sorting'
        );
        // Traverse list of records:
        $c = 0;
        while ($row = $db->sql_fetch_assoc($res)) {
            $c++;
            $icon = $this->iconFactory->getIconForRecord('tt_content', $row, Icon::SIZE_SMALL)->render();
            $selected = '';
            if (!empty($this->linkParts) && (int)$this->linkParts['anchor'] === (int)$row['uid']) {
                $selected = ' class="active"';
            }
            // Putting list element HTML together:
            // Output of BackendUtility::getRecordTitle() is already hsc'ed
            $out .= '
                <li' . $selected . '>
                    <span class="list-tree-group">
                        <span class="list-tree-icon">
                            ' . $icon . '
                        </span>
                        <span class="list-tree-title">
                            <a href="#" class="t3js-pageLink" data-id="' . (int)$expPageId . '" data-anchor="#' . (int)$row['uid'] . '">
                                ' . BackendUtility::getRecordTitle('tt_content', $row, true) . '
                            </a>
                        </span>
                    </span>
                </li>
                ';
        }
        $out .= '
                    </ul>
                </li>
            </ul>
            ';

        return $out;
    }

    protected function getTemporaryTreeMountCancelNotice()
    {
        if ((int)$this->getBackendUser()->getSessionData('pageTree_temporaryMountPoint') === 0) {
            return '';
        }
        $link = '<p><a href="' . htmlspecialchars(GeneralUtility::linkThisScript(['setTempDBmount' => 0])) . '" class="btn btn-primary">'
            . $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.temporaryDBmount', true) . '</a></p>';
        return $link;
    }

    protected function setTemporaryDbMounts()
    {
        $backendUser = $this->getBackendUser();

        // Clear temporary DB mounts
        $tmpMount = GeneralUtility::_GET('setTempDBmount');
        if (isset($tmpMount)) {
            $backendUser->setAndSaveSessionData('pageTree_temporaryMountPoint', (int)$tmpMount);
        }
        // Set temporary DB mounts
        $alternativeWebmountPoint = (int)$backendUser->getSessionData('pageTree_temporaryMountPoint');
        if ($alternativeWebmountPoint) {
            $alternativeWebmountPoint = GeneralUtility::intExplode(',', $alternativeWebmountPoint);
            $backendUser->setWebmounts($alternativeWebmountPoint);
        } else {
            // Setting alternative browsing mounts (ONLY local to browse_links.php this script so they stay "read-only")
            $alternativeWebmountPoints = trim($backendUser->getTSConfigVal('options.pageTree.altElementBrowserMountPoints'));
            $appendAlternativeWebmountPoints = $backendUser->getTSConfigVal('options.pageTree.altElementBrowserMountPoints.append');
            if ($alternativeWebmountPoints) {
                $alternativeWebmountPoints = GeneralUtility::intExplode(',', $alternativeWebmountPoints);
                $this->getBackendUser()->setWebmounts($alternativeWebmountPoints, $appendAlternativeWebmountPoints);
            }
        }
    }

    public function getBodyTagAttributes()
    {
        if (empty($this->linkParts)) {
            return [];
        }
        return [
            'data-current-link' => $this->linkParts['pageid'] . ($this->linkParts['anchor'] !== '' ? '#' . $this->linkParts['anchor'] : '')
        ];
    }

    public function getUrlParameters(array $values)
    {
        $parameters = [
            'expandPage' => isset($values['pid']) ? (int)$values['pid'] : $this->expandPage
        ];
        return array_merge($this->linkBrowser->getUrlParameters($values), $parameters);
    }

    public function isCurrentlySelectedItem(array $values)
    {
        return !empty($this->linkParts) && (int)$this->linkParts['pageid'] === (int)$values['pid'];
    }

    public function getScriptUrl()
    {
        return $this->linkBrowser->getScriptUrl();
    }

    public function modifyLinkAttributes(array $fieldDefinitions)
    {
        $configuration = $this->linkBrowser->getConfiguration();
        if (!empty($configuration['pageIdSelector.']['enabled'])) {
            array_push($this->linkAttributes, 'pageIdSelector');
            $fieldDefinitions['pageIdSelector'] = '
                <tr>
                    <td>
                        <label>
                            ' . $this->getLanguageService()->getLL('page_id', true) . ':
                        </label>
                    </td>
                    <td colspan="3">
                        <input type="text" size="6" name="luid" id="luid" /> <input class="btn btn-default t3js-pageLink" type="submit" value="'
            . $this->getLanguageService()->getLL('setLink', true) . '" />
                    </td>
                </tr>';
        }
        return $fieldDefinitions;
    }

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