9.5/_page_position_map_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\Tree\View;


/*

 * 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\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\BackendWorkspaceRestriction;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\EndTimeRestriction;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\StartTimeRestriction;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪PagePositionMap

{

    use ‪PublicPropertyDeprecationTrait;


    protected ‪$deprecatedPublicProperties = [

        'getModConfigCache' => 'Using $getModConfigCache of class PagePositionMap is discouraged. This property will be removed in TYPO3 v10.0.',

        'modConfigStr' => 'Using $$modConfigStr of class PagePositionMap is discouraged. This property will be removed in TYPO3 v10.0.',

    ];


    // EXTERNAL, static:

    public ‪$moveOrCopy = 'move';


    public ‪$dontPrintPageInsertIcons = 0;


    // How deep the position page tree will go.

    public ‪$depth = 2;


    // Can be set to the sys_language uid to select content elements for.

    public ‪$cur_sys_language;


    // INTERNAL, dynamic:

    // Request uri

    public ‪$R_URI = '';


    // Element id.

    public ‪$elUid = '';


    // tt_content element uid to move.

    public ‪$moveUid = '';


    // Caching arrays:

    protected ‪$getModConfigCache = [];


    public ‪$checkNewPageCache = [];


    // Label keys:

    public ‪$l_insertNewPageHere = 'insertNewPageHere';


    public ‪$l_insertNewRecordHere = 'insertNewRecordHere';


    protected ‪$modConfigStr = 'mod.web_list.newPageWiz';


    protected ‪$pageTreeClassName = ElementBrowserPageTreeView::class;


    protected ‪$iconFactory;


    protected ‪$clientContext;


    public function ‪__construct(string ‪$pageTreeClassName = null, string ‪$clientContext = 'window')

    {

        if (‪$pageTreeClassName !== null) {

            $this->pageTreeClassName = ‪$pageTreeClassName;

        }

        $this->clientContext = ‪$clientContext;

        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);

    }


    /*************************************

     *

     * Page position map:

     *

     **************************************/

    public function ‪positionTree($id, $pageinfo, $perms_clause, ‪$R_URI)

    {

        // Make page tree object:

        $pageTree = GeneralUtility::makeInstance($this->pageTreeClassName);

        $pageTree->init(' AND ' . $perms_clause);

        $pageTree->addField('pid');

        // Initialize variables:

        $this->R_URI = ‪$R_URI;

        $this->elUid = $id;

        // Create page tree, in $this->depth levels.

        $pageTree->getTree($pageinfo['pid'], $this->depth);

        // Initialize variables:

        $saveLatestUid = [];

        $latestInvDepth = ‪$this->depth;

        // Traverse the tree:

        $lines = [];

        foreach ($pageTree->tree as $cc => $dat) {

            if ($latestInvDepth > $dat['invertedDepth']) {

                $margin = 'style="margin-left: ' . ($dat['invertedDepth'] * 16 + 9) . 'px;"';

                $lines[] = '<ul class="list-tree" ' . $margin . '>';

            }

            // Make link + parameters.

            $latestInvDepth = $dat['invertedDepth'];

            $saveLatestUid[$latestInvDepth] = $dat;

            if (isset($pageTree->tree[$cc - 1])) {

                $prev_dat = $pageTree->tree[$cc - 1];

                // If current page, subpage?

                if ($prev_dat['row']['uid'] == $id) {

                    // 1) It must be allowed to create a new page and 2) If there are subpages there is no need to render a subpage icon here - it'll be done over the subpages...

                    if (!$this->dontPrintPageInsertIcons && $this->‪checkNewPageInPid($id) && !($prev_dat['invertedDepth'] > $pageTree->tree[$cc]['invertedDepth'])) {

                        end($lines);

                        $margin = 'style="margin-left: ' . (($dat['invertedDepth'] - 1) * 16 + 9) . 'px;"';

                        $lines[] = '<ul class="list-tree" ' . $margin . '><li><span class="text-nowrap"><a href="#" onclick="' . htmlspecialchars($this->‪onClickEvent($id, $id)) . '"><i class="t3-icon fa fa-long-arrow-left" title="' . $this->‪insertlabel() . '"></i></a></span></li></ul>';

                    }

                }

                // If going down

                if ($prev_dat['invertedDepth'] > $pageTree->tree[$cc]['invertedDepth']) {

                    $prevPid = $pageTree->tree[$cc]['row']['pid'];

                } elseif ($prev_dat['invertedDepth'] < $pageTree->tree[$cc]['invertedDepth']) {

                    // If going up

                    // First of all the previous level should have an icon:

                    if (!$this->dontPrintPageInsertIcons && $this->‪checkNewPageInPid($prev_dat['row']['pid'])) {

                        $prevPid = -$prev_dat['row']['uid'];

                        end($lines);

                        $lines[] = '<li><span class="text-nowrap"><a href="#" onclick="' . htmlspecialchars($this->‪onClickEvent($prevPid, $prev_dat['row']['pid'])) . '"><i class="t3-icon fa fa-long-arrow-left" title="' . $this->‪insertlabel() . '"></i></a></span></li>';

                    }

                    // Then set the current prevPid

                    $prevPid = -$prev_dat['row']['pid'];

                    if ($prevPid !== $dat['row']['pid']) {

                        $lines[] = '</ul>';

                    }

                } else {

                    // In on the same level

                    $prevPid = -$prev_dat['row']['uid'];

                }

            } else {

                // First in the tree

                $prevPid = $dat['row']['pid'];

            }

            // print arrow on the same level

            if (!$this->dontPrintPageInsertIcons && $this->‪checkNewPageInPid($dat['row']['pid'])) {

                $lines[] = '<span class="text-nowrap"><a href="#" onclick="' . htmlspecialchars($this->‪onClickEvent($prevPid, $dat['row']['pid'])) . '"><i class="t3-icon fa fa-long-arrow-left" title="' . $this->‪insertlabel() . '"></i></a></span>';

            }

            // The line with the icon and title:

            $toolTip = ‪BackendUtility::getRecordToolTip($dat['row'], 'pages');

            $icon = '<span ' . $toolTip . '>' . $this->iconFactory->getIconForRecord('pages', $dat['row'], ‪Icon::SIZE_SMALL)->render() . '</span>';


            $lines[] = '<span class="text-nowrap">' . $icon . $this->‪linkPageTitle($this->‪boldTitle(htmlspecialchars(GeneralUtility::fixed_lgd_cs($dat['row']['title'], $this->‪getBackendUser()->uc['titleLen'])), $dat, $id), $dat['row']) . '</span>';

        }

        // If the current page was the last in the tree:

        $prev_dat = end($pageTree->tree);

        if ($prev_dat['row']['uid'] == $id) {

            if (!$this->dontPrintPageInsertIcons && $this->‪checkNewPageInPid($id)) {

                $lines[] = '<ul class="list-tree" style="margin-left: 25px"><li><span class="text-nowrap"><a href="#" onclick="' . htmlspecialchars($this->‪onClickEvent($id, $id)) . '"><i class="t3-icon fa fa-long-arrow-left" title="' . $this->‪insertlabel() . '"></i></a></span></li></ul>';

            }

        }

        for ($a = $latestInvDepth; $a <= ‪$this->depth; $a++) {

            $dat = $saveLatestUid[$a];

            $prevPid = -$dat['row']['uid'];

            if (!$this->dontPrintPageInsertIcons && $this->‪checkNewPageInPid($dat['row']['pid'])) {

                if ($latestInvDepth < $dat['invertedDepth']) {

                    $lines[] = '</ul>';

                }

                $lines[] = '<span class="text-nowrap"><a href="#" onclick="' . htmlspecialchars($this->‪onClickEvent($prevPid, $dat['row']['pid'])) . '"><i class="t3-icon fa fa-long-arrow-left" title="' . $this->‪insertlabel() . '"></i></a></span>';

            }

        }


        $code = '<ul class="list-tree">';


        foreach ($lines as $line) {

            if ((strpos($line, '<ul') === 0) || (strpos($line, '</ul') === 0)) {

                $code .= $line;

            } else {

                $code .= '<li>' . $line . '</li>';

            }

        }


        $code .= '</ul>';

        return $code;

    }


    public function ‪boldTitle($t_code, $dat, $id)

    {

        if ($dat['row']['uid'] == $id) {

            $t_code = '<strong>' . $t_code . '</strong>';

        }

        return $t_code;

    }


    public function ‪onClickEvent($pid, $newPagePID)

    {

        $TSconfig = ‪BackendUtility::getPagesTSconfig($newPagePID)['mod.']['newPageWizard.'] ?? [];

        if (isset($TSconfig['override']) && !empty($TSconfig['override'])) {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $url = $uriBuilder->buildUriFromRoute(

                $TSconfig['override'],

                [

                    'positionPid' => $pid,

                    'newPageId'   => $newPagePID,

                    'cmd'         => 'crPage',

                    'returnUrl'   => GeneralUtility::getIndpEnv('REQUEST_URI')

                ]

            );

            return $this->clientContext . '.location.href=' . GeneralUtility::quoteJSvalue((string)$url) . ';';

        }

        $params = '&edit[pages][' . $pid . ']=new&returnNewPageId=1';

        return ‪BackendUtility::editOnClick($params, '', $this->R_URI);

    }


    public function ‪insertlabel()

    {

        return htmlspecialchars($this->‪getLanguageService()->getLL($this->l_insertNewPageHere));

    }


    public function ‪linkPageTitle($str, $rec)

    {

        return $str;

    }


    public function ‪checkNewPageInPid($pid)

    {

        if (!isset($this->checkNewPageCache[$pid])) {

            $pidInfo = ‪BackendUtility::getRecord('pages', $pid);

            $this->checkNewPageCache[$pid] = $this->‪getBackendUser()->‪isAdmin() || $this->‪getBackendUser()->‪doesUserHaveAccess($pidInfo, 8);

        }

        return $this->checkNewPageCache[$pid];

    }


    public function ‪getModConfig($pid)

    {

        trigger_error('PagePositionMap->getModConfig() will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);

        if (!isset($this->getModConfigCache[$pid])) {

            // Acquiring TSconfig for this PID:

            $this->getModConfigCache[$pid]['properties'] = ‪BackendUtility::getPagesTSconfig($pid)['mod.']['web_list.']['newPageWiz.'] ?? [];

        }

        return $this->getModConfigCache[$pid]['properties'];

    }


    /*************************************

     *

     * Content element positioning:

     *

     **************************************/

    public function ‪printContentElementColumns($pid, ‪$moveUid, $colPosList, $showHidden, ‪$R_URI)

    {

        $this->R_URI = ‪$R_URI;

        $this->moveUid = ‪$moveUid;

        $colPosArray = GeneralUtility::trimExplode(',', $colPosList, true);

        $lines = [];

        foreach ($colPosArray as $kk => $vv) {

            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tt_content');

            $queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));

            if ($showHidden) {

                $queryBuilder->getRestrictions()

                    ->removeByType(HiddenRestriction::class)

                    ->removeByType(StartTimeRestriction::class)

                    ->removeByType(EndTimeRestriction::class);

            }

            $queryBuilder

                ->select('*')

                ->from('tt_content')

                ->where(

                    $queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($pid, \PDO::PARAM_INT)),

                    $queryBuilder->expr()->eq('colPos', $queryBuilder->createNamedParameter($vv, \PDO::PARAM_INT))

                )

                ->orderBy('sorting');


            if ((string)$this->cur_sys_language !== '') {

                $queryBuilder->andWhere(

                    $queryBuilder->expr()->eq(

                        'sys_language_uid',

                        $queryBuilder->createNamedParameter($this->cur_sys_language, \PDO::PARAM_INT)

                    )

                );

            }


            $res = $queryBuilder->execute();

            $lines[$vv] = [];

            $lines[$vv][] = $this->‪insertPositionIcon('', $vv, $kk, ‪$moveUid, $pid);


            while ($row = $res->fetch()) {

                ‪BackendUtility::workspaceOL('tt_content', $row);

                if (is_array($row)) {

                    $lines[$vv][] = $this->‪wrapRecordHeader($this->‪getRecordHeader($row), $row);

                    $lines[$vv][] = $this->‪insertPositionIcon($row, $vv, $kk, ‪$moveUid, $pid);

                }

            }

        }

        return $this->‪printRecordMap($lines, $colPosArray, $pid);

    }


    public function ‪printRecordMap($lines, $colPosArray, $pid = 0)

    {

        $count = ‪\TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange(count($colPosArray), 1);

        $backendLayout = GeneralUtility::callUserFunction(\‪TYPO3\CMS\Backend\View\BackendLayoutView::class . '->getSelectedBackendLayout', $pid, $this);

        if (isset($backendLayout['__config']['backend_layout.'])) {

            $this->‪getLanguageService()->‪includeLLFile('EXT:backend/Resources/Private/Language/locallang_layout.xlf');

            $table = '<div class="table-fit"><table class="table table-condensed table-bordered table-vertical-top">';

            $colCount = (int)$backendLayout['__config']['backend_layout.']['colCount'];

            $rowCount = (int)$backendLayout['__config']['backend_layout.']['rowCount'];

            $table .= '<colgroup>';

            for ($i = 0; $i < $colCount; $i++) {

                $table .= '<col style="width:' . 100 / $colCount . '%"></col>';

            }

            $table .= '</colgroup>';

            $table .= '<tbody>';

            $tcaItems = GeneralUtility::callUserFunction(\‪TYPO3\CMS\Backend\View\BackendLayoutView::class . '->getColPosListItemsParsed', $pid, $this);

            // Cycle through rows

            for ($row = 1; $row <= $rowCount; $row++) {

                $rowConfig = $backendLayout['__config']['backend_layout.']['rows.'][$row . '.'];

                if (!isset($rowConfig)) {

                    continue;

                }

                $table .= '<tr>';

                for ($col = 1; $col <= $colCount; $col++) {

                    $columnConfig = $rowConfig['columns.'][$col . '.'];

                    if (!isset($columnConfig)) {

                        continue;

                    }

                    // Which tt_content colPos should be displayed inside this cell

                    $columnKey = (int)$columnConfig['colPos'];

                    $head = '';

                    foreach ($tcaItems as $item) {

                        if ($item[1] == $columnKey) {

                            $head = htmlspecialchars($this->‪getLanguageService()->sL($item[0]));

                        }

                    }

                    // Render the grid cell

                    $table .= '<td'

                        . (isset($columnConfig['colspan']) ? ' colspan="' . $columnConfig['colspan'] . '"' : '')

                        . (isset($columnConfig['rowspan']) ? ' rowspan="' . $columnConfig['rowspan'] . '"' : '')

                        . ' class="col-nowrap col-min'

                        . (!isset($columnConfig['colPos']) ? ' warning' : '')

                        . (isset($columnConfig['colPos']) && !$head ? ' danger' : '') . '">';

                    // Render header

                    $table .= '<p>';

                    if (isset($columnConfig['colPos']) && $head) {

                        $table .= '<strong>' . $this->‪wrapColumnHeader($head, '') . '</strong>';

                    } elseif ($columnConfig['colPos']) {

                        $table .= '<em>' . $this->‪wrapColumnHeader($this->‪getLanguageService()->getLL('noAccess'), '') . '</em>';

                    } else {

                        $table .= '<em>' . $this->‪wrapColumnHeader(($this->‪getLanguageService()->sL($columnConfig['name']) ?: '') . ' (' . $this->‪getLanguageService()->getLL('notAssigned') . ')', '') . '</em>';

                    }

                    $table .= '</p>';

                    // Render lines

                    if (isset($columnConfig['colPos']) && $head && !empty($lines[$columnKey])) {

                        $table .= '<ul class="list-unstyled">';

                        foreach ($lines[$columnKey] as $line) {

                            $table .= '<li>' . $line . '</li>';

                        }

                        $table .= '</ul>';

                    }

                    $table .= '</td>';

                }

                $table .= '</tr>';

            }

            $table .= '</tbody>';

            $table .= '</table></div>';

        } else {

            // Traverse the columns here:

            $row = '';

            foreach ($colPosArray as $kk => $vv) {

                $row .= '<td class="col-nowrap col-min" width="' . round(100 / $count) . '%">';

                $row .= '<p><strong>' . $this->‪wrapColumnHeader(htmlspecialchars($this->‪getLanguageService()->sL(‪BackendUtility::getLabelFromItemlist('tt_content', 'colPos', $vv))), $vv) . '</strong></p>';

                if (!empty($lines[$vv])) {

                    $row .= '<ul class="list-unstyled">';

                    foreach ($lines[$vv] as $line) {

                        $row .= '<li>' . $line . '</li>';

                    }

                    $row .= '</ul>';

                }

                $row .= '</td>';

            }

            $table = '


            <!--

                Map of records in columns:

            -->

            <div class="table-fit">

                <table class="table table-condensed table-bordered table-vertical-top">

                    <tr>' . $row . '</tr>

                </table>

            </div>


            ';

        }

        return $table;

    }


    public function ‪wrapColumnHeader($str, $vv)

    {

        return $str;

    }


    public function ‪insertPositionIcon($row, $vv, $kk, ‪$moveUid, $pid)

    {

        if (is_array($row) && !empty($row['uid'])) {

            // Use record uid for the hash when inserting after this content element

            $uid = $row['uid'];

        } else {

            // No uid means insert at first position in the column

            $uid = '';

        }

        $cc = hexdec(substr(md5($uid . '-' . $vv . '-' . $kk), 0, 4));

        return '<a href="#" onclick="' . htmlspecialchars($this->‪onClickInsertRecord($row, $vv, ‪$moveUid, $pid, $this->cur_sys_language)) . '" data-dismiss="modal">' . '<i class="t3-icon fa fa-long-arrow-left" name="mImgEnd' . $cc . '" title="' . htmlspecialchars($this->‪getLanguageService()->getLL($this->l_insertNewRecordHere)) . '"></i></a>';

    }


    public function ‪onClickInsertRecord($row, $vv, ‪$moveUid, $pid, $sys_lang = 0)

    {

        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

        if (is_array($row)) {

            $location = $uriBuilder->buildUriFromRoute('tce_db', [

                'cmd[tt_content][' . ‪$moveUid . '][' . $this->moveOrCopy . ']' => '-' . $row['uid'],

                'redirect' => $this->R_URI,

            ]);

        } else {

            $location = $uriBuilder->buildUriFromRoute('tce_db', [

                'cmd[tt_content][' . ‪$moveUid . '][' . $this->moveOrCopy . ']' => $pid,

                'data[tt_content][' . ‪$moveUid . '][colPos]' => $vv,

                'redirect' => $this->R_URI,

            ]);

        }

        // returns to prev. page

        return $this->clientContext . '.location.href=' . GeneralUtility::quoteJSvalue((string)$location) . ';return false;';

    }


    public function ‪wrapRecordHeader($str, $row)

    {

        return $str;

    }


    public function ‪getRecordHeader($row)

    {

        ‪$iconFactory = GeneralUtility::makeInstance(IconFactory::class);

        $toolTip = ‪BackendUtility::getRecordToolTip($row, 'tt_content');

        $line = '<span ' . $toolTip . ' title="' . ‪BackendUtility::getRecordIconAltText($row, 'tt_content') . '">' . ‪$iconFactory->‪getIconForRecord('tt_content', $row, ‪Icon::SIZE_SMALL)->‪render() . '</span>';

        $line .= ‪BackendUtility::getRecordTitle('tt_content', $row, true);

        return $this->‪wrapRecordTitle($line, $row);

    }


    public function ‪wrapRecordTitle($str, $row)

    {

        return '<a href="' . htmlspecialchars(GeneralUtility::linkThisScript(['uid' => (int)$row['uid'], 'moveUid' => ''])) . '">' . $str . '</a>';

    }


    protected function ‪getBackendUser()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }

}