LogEntryRepository.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Belog\Domain\Repository;
 
use ‪TYPO3\CMS\Backend\Tree\View\PageTreeView;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Belog\Domain\Model\Constraint;
use ‪TYPO3\CMS\Belog\Domain\Model\LogEntry;
use ‪TYPO3\CMS\Belog\Domain\Model\Workspace;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Repository;
 
class ‪LogEntryRepository extends ‪Repository
{
    protected ‪$beUserList = [];
 
    public function ‪initializeObject()
    {
        $this->beUserList = $this->‪getBackendUsers();
        ‪$defaultQuerySettings = $this->objectManager->get(QuerySettingsInterface::class);
        ‪$defaultQuerySettings->‪setRespectStoragePage(false);
        $this->‪setDefaultQuerySettings(‪$defaultQuerySettings);
    }
 
    public function ‪findByConstraint(‪Constraint $constraint)
    {
        $query = $this->‪createQuery();
        $queryConstraints = $this->‪createQueryConstraints($query, $constraint);
        if (!empty($queryConstraints)) {
            $query->matching($query->logicalAnd($queryConstraints));
        }
        $query->setOrderings(['uid' => ‪QueryInterface::ORDER_DESCENDING]);
        $query->setLimit($constraint->‪getNumber());
        return $query->execute();
    }
 
    protected function ‪createQueryConstraints(‪QueryInterface $query, ‪Constraint $constraint)
    {
        $queryConstraints = [];
        // User / group handling
        $this->‪addUsersAndGroupsToQueryConstraints($constraint, $query, $queryConstraints);
        // Workspace
        if ($constraint->‪getWorkspaceUid() != ‪Workspace::UID_ANY_WORKSPACE) {
            $queryConstraints[] = $query->‪equals('workspace', $constraint->‪getWorkspaceUid());
        }
        // Action (type):
        if ($constraint->‪getAction() > 0) {
            $queryConstraints[] = $query->‪equals('type', $constraint->‪getAction());
        } elseif ($constraint->‪getAction() == -1) {
            $queryConstraints[] = $query->‪equals('type', 5);
        }
        // Start / endtime handling: The timestamp calculation was already done
        // in the controller, since we need those calculated values in the view as well.
        $queryConstraints[] = $query->‪greaterThanOrEqual('tstamp', $constraint->‪getStartTimestamp());
        $queryConstraints[] = $query->‪lessThan('tstamp', $constraint->‪getEndTimestamp());
        // Page and level constraint if in page context
        $this->‪addPageTreeConstraintsToQuery($constraint, $query, $queryConstraints);
        return $queryConstraints;
    }
 
    protected function ‪addPageTreeConstraintsToQuery(‪Constraint $constraint, ‪QueryInterface $query, array &$queryConstraints)
    {
        $pageIds = [];
        // Check if we should get a whole tree of pages and not only a single page
        if ($constraint->‪getDepth() > 0) {
            $pageTree = GeneralUtility::makeInstance(PageTreeView::class);
            $pageTree->init('AND ' . ‪$GLOBALS['BE_USER']->getPagePermsClause(‪Permission::PAGE_SHOW));
            $pageTree->makeHTML = 0;
            $pageTree->fieldArray = ['uid'];
            $pageTree->getTree($constraint->‪getPageId(), $constraint->‪getDepth());
            $pageIds = $pageTree->ids;
        }
        if (!empty($constraint->‪getPageId())) {
            $pageIds[] = $constraint->‪getPageId();
        }
        if (!empty($pageIds)) {
            $queryConstraints[] = $query->‪in('eventPid', $pageIds);
        }
    }
 
    protected function ‪addUsersAndGroupsToQueryConstraints(‪Constraint $constraint, ‪QueryInterface $query, array &$queryConstraints)
    {
        $userOrGroup = $constraint->‪getUserOrGroup();
        if ($userOrGroup === '') {
            return;
        }
        // Constraint for a group
        if (strpos($userOrGroup, 'gr-') === 0) {
            $groupId = (int)substr($userOrGroup, 3);
            $userIds = [];
            foreach ($this->beUserList as $userId => $userData) {
                if (GeneralUtility::inList($userData['usergroup_cached_list'], (string)$groupId)) {
                    $userIds[] = $userId;
                }
            }
            if (!empty($userIds)) {
                $queryConstraints[] = $query->‪in('userid', $userIds);
            } else {
                // If there are no group members -> use -1 as constraint to not find anything
                $queryConstraints[] = $query->‪in('userid', [-1]);
            }
        } elseif (strpos($userOrGroup, 'us-') === 0) {
            $queryConstraints[] = $query->‪equals('userid', (int)substr($userOrGroup, 3));
        } elseif ($userOrGroup === '-1') {
            $queryConstraints[] = $query->‪equals('userid', (int)‪$GLOBALS['BE_USER']->user['uid']);
        }
    }
 
    public function ‪deleteByMessageDetails(‪LogEntry $logEntry): int
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable('sys_log');
        $constraints = [];
        $constraints[] = $queryBuilder->expr()->eq('details', $queryBuilder->createNamedParameter($logEntry->‪getDetails()));
        // If the detailsNo is 11 or 12 we got messages that are heavily using placeholders. In this case
        // we need to compare both the message and the actual log data to not remove too many log entries.
        if (GeneralUtility::inList('11,12', (string)$logEntry->‪getDetailsNumber())) {
            $constraints[] = $queryBuilder->expr()->eq('log_data', $queryBuilder->createNamedParameter($logEntry->‪getLogData()));
        }
        return $queryBuilder->delete('sys_log')
            ->where(...$constraints)
            ->execute();
    }
 
    protected function ‪getBackendUsers()
    {
        return ‪BackendUtility::getUserNames();
    }
}