OpendocsToolbarItem.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Opendocs\Backend\ToolbarItems;
 
use Doctrine\DBAL\Exception\TableNotFoundException;
use ‪TYPO3\CMS\Backend\Domain\Model\Element\ImmediateActionElement;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Fluid\View\StandaloneView;
use ‪TYPO3\CMS\Opendocs\Service\OpenDocumentService;
 
class ‪OpendocsToolbarItem implements ‪ToolbarItemInterface
{
    protected ‪$documentService;
 
    public function ‪__construct(?‪OpenDocumentService ‪$documentService = null)
    {
        $this->documentService = ‪$documentService ?: GeneralUtility::makeInstance(OpenDocumentService::class);
    }
 
    public function ‪checkAccess(): bool
    {
        return !(bool)($this->‪getBackendUser()->‪getTSConfig()['backendToolbarItem.']['tx_opendocs.']['disabled'] ?? false);
    }
 
    public function ‪getItem()
    {
        $view = $this->‪getFluidTemplateObject('ToolbarItem.html');
 
        return $view->render();
    }
 
    public function ‪hasDropDown()
    {
        return true;
    }
 
    public function ‪getDropDown()
    {
        $view = $this->‪getFluidTemplateObject('DropDown.html');
        $view->assignMultiple([
            'openDocuments' => $this->‪getMenuEntries($this->documentService->getOpenDocuments()),
            // If there are "recent documents" in the list, add them
            'recentDocuments' => $this->getMenuEntries($this->documentService->getRecentDocuments()),
        ]);
 
        return $view->render();
    }
 
    public function ‪getAdditionalAttributes()
    {
        return [];
    }
 
    public function ‪getIndex()
    {
        return 30;
    }
 
    public function ‪updateNumberOfOpenDocsHook(array &$params)
    {
        $params['html'] = ‪ImmediateActionElement::dispatchCustomEvent(
            'typo3:opendocs:updateRequested',
            null,
            true
        );
    }
 
    protected function ‪getMenuEntries(array $documents): array
    {
        $entries = [];
 
        foreach ($documents as $identifier => $document) {
            $menuEntry = $this->‪getMenuEntry($document, $identifier);
 
            if (!empty($menuEntry)) {
                $entries[] = $menuEntry;
            }
        }
 
        return $entries;
    }
 
    protected function ‪getMenuEntry(array $document, string $identifier): array
    {
        $table = $document[3]['table'] ?? '';
        $uid = $document[3]['uid'] ?? 0;
 
        try {
            $record = BackendUtility::getRecordWSOL($table, $uid);
        } catch (TableNotFoundException $e) {
            // This exception is caught in cases, when you have an recently opened document
            // from an extension record (let's say a sys_note record) and then uninstall
            // the extension and drop the DB table. After then, the DB table could
            // not be found anymore and will throw an exception making the
            // whole backend unusable.
            $record = null;
        }
 
        if (!is_array($record)) {
            // Record seems to be deleted
            return [];
        }
 
        $result = [];
        $result['table'] = $table;
        $result['record'] = $record;
        $result['label'] = strip_tags(htmlspecialchars_decode($document[0]));
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        $uri = (string)$uriBuilder->buildUriFromRoute('record_edit') . '&' . $document[2];
        $pid = (int)$document[3]['pid'];
 
        if ($document[3]['table'] === 'pages') {
            $pid = (int)$document[3]['uid'];
        }
 
        $result['pid'] = $pid;
        $result['uri'] = $uri;
        $result['md5sum'] = $identifier;
 
        return $result;
    }
 
    protected function ‪getFluidTemplateObject(string $filename): ‪StandaloneView
    {
        $view = GeneralUtility::makeInstance(StandaloneView::class);
        $view->setLayoutRootPaths(['EXT:opendocs/Resources/Private/Layouts']);
        $view->setPartialRootPaths([
            'EXT:backend/Resources/Private/Partials/ToolbarItems',
            'EXT:opendocs/Resources/Private/Partials/ToolbarItems',
        ]);
        $view->setTemplateRootPaths(['EXT:opendocs/Resources/Private/Templates/ToolbarItems']);
        $view->setTemplate($filename);
        $view->getRequest()->setControllerExtensionName('Opendocs');
 
        return $view;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}