229 lines
8.3 KiB
PHP
229 lines
8.3 KiB
PHP
<?php
|
|
namespace WapplerSystems\Meilisearch\Access;
|
|
|
|
/***************************************************************
|
|
* Copyright notice
|
|
*
|
|
* (c) 2011-2015 Ingo Renner <ingo@typo3.org>
|
|
* All rights reserved
|
|
*
|
|
* This script is part of the TYPO3 project. The TYPO3 project is
|
|
* free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* The GNU General Public License can be found at
|
|
* http://www.gnu.org/copyleft/gpl.html.
|
|
*
|
|
* This script is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* This copyright notice MUST APPEAR in all copies of the script!
|
|
***************************************************************/
|
|
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Core\Utility\RootlineUtility;
|
|
use TYPO3\CMS\Frontend\Page\PageRepository;
|
|
|
|
/**
|
|
* "Access Rootline", represents all pages and specifically those setting
|
|
* frontend user group access restrictions in a page's rootline.
|
|
*
|
|
* The access rootline only contains pages which set frontend user access
|
|
* restrictions and extend them to sub-pages. The format is as follows:
|
|
*
|
|
* pageId1:group1,group2/pageId2:group3/c:group1,group4,groupN
|
|
*
|
|
* The single elements of the access rootline are separated by a slash
|
|
* character. All but the last elements represent pages, the last element
|
|
* defines the access restrictions applied to the page's content elements
|
|
* and records shown on the page.
|
|
* Each page element is composed by the page ID of the page setting frontend
|
|
* user access restrictions, a colon, and a comma separated list of frontend
|
|
* user group IDs restricting access to the page.
|
|
* The content access element does not have a page ID, instead it replaces
|
|
* the ID by a lower case C.
|
|
*
|
|
* The groups for page elements are compared using OR, so the user needs to be
|
|
* a member of only one of the groups listed for a page. The elements are
|
|
* checked combined using AND, so the user must be member of at least one
|
|
* group in each page element. However, the groups in the content access
|
|
* element are checked using AND. So the user must be member of all the groups
|
|
* listed in the content access element to see the document.
|
|
*
|
|
* An access rootline for a generic record could instead be short like this:
|
|
*
|
|
* r:group1,group2,groupN
|
|
*
|
|
* In this case the lower case R tells us that we're dealing with a record
|
|
* like tt_news or the like. For records the groups are checked using OR
|
|
* instead of using AND as it would be the case with content elements.
|
|
*
|
|
* @author Ingo Renner <ingo@typo3.org>
|
|
*/
|
|
class Rootline
|
|
{
|
|
|
|
/**
|
|
* Delimiter for page and content access right elements in the rootline.
|
|
*
|
|
* @var string
|
|
*/
|
|
const ELEMENT_DELIMITER = '/';
|
|
|
|
/**
|
|
* Storage for access rootline elements
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $rootlineElements = [];
|
|
|
|
/**
|
|
* Constructor, turns a string representation of an access rootline into an
|
|
* object representation.
|
|
*
|
|
* @param string $accessRootline Access Rootline String representation.
|
|
*/
|
|
public function __construct($accessRootline = null)
|
|
{
|
|
if (!is_null($accessRootline)) {
|
|
$rawRootlineElements = explode(self::ELEMENT_DELIMITER, $accessRootline);
|
|
foreach ($rawRootlineElements as $rawRootlineElement) {
|
|
try {
|
|
$this->push(GeneralUtility::makeInstance(RootlineElement::class, /** @scrutinizer ignore-type */ $rawRootlineElement));
|
|
} catch (RootlineElementFormatException $e) {
|
|
// just ignore the faulty element for now, might log this later
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds an Access Rootline Element to the end of the rootline.
|
|
*
|
|
* @param RootlineElement $rootlineElement Element to add.
|
|
*/
|
|
public function push(RootlineElement $rootlineElement)
|
|
{
|
|
$lastElementIndex = max(0, (count($this->rootlineElements) - 1));
|
|
|
|
if (!empty($this->rootlineElements[$lastElementIndex])) {
|
|
if ($this->rootlineElements[$lastElementIndex]->getType() == RootlineElement::ELEMENT_TYPE_CONTENT) {
|
|
throw new RootlineElementFormatException(
|
|
'Can not add an element to an Access Rootline whose\' last element is a content type element.',
|
|
1294422132
|
|
);
|
|
}
|
|
|
|
if ($this->rootlineElements[$lastElementIndex]->getType() == RootlineElement::ELEMENT_TYPE_RECORD) {
|
|
throw new RootlineElementFormatException(
|
|
'Can not add an element to an Access Rootline whose\' last element is a record type element.',
|
|
1308343423
|
|
);
|
|
}
|
|
}
|
|
|
|
$this->rootlineElements[] = $rootlineElement;
|
|
}
|
|
|
|
/**
|
|
* Gets the Access Rootline for a specific page Id.
|
|
*
|
|
* @param int $pageId The page Id to generate the Access Rootline for.
|
|
* @param string $mountPointParameter The mount point parameter for generating the rootline.
|
|
* @return \WapplerSystems\Meilisearch\Access\Rootline Access Rootline for the given page Id.
|
|
*/
|
|
public static function getAccessRootlineByPageId(
|
|
$pageId,
|
|
$mountPointParameter = ''
|
|
) {
|
|
$accessRootline = GeneralUtility::makeInstance(Rootline::class);
|
|
$rootlineUtility = GeneralUtility::makeInstance(RootlineUtility::class, $pageId, $mountPointParameter);
|
|
try {
|
|
$rootline = $rootlineUtility->get();
|
|
} catch (\RuntimeException $e) {
|
|
$rootline = [];
|
|
}
|
|
$rootline = array_reverse($rootline);
|
|
// parent pages
|
|
foreach ($rootline as $pageRecord) {
|
|
if ($pageRecord['fe_group']
|
|
&& $pageRecord['extendToSubpages']
|
|
&& $pageRecord['uid'] != $pageId
|
|
) {
|
|
$accessRootline->push(GeneralUtility::makeInstance(
|
|
RootlineElement::class,
|
|
/** @scrutinizer ignore-type */ $pageRecord['uid'] . RootlineElement::PAGE_ID_GROUP_DELIMITER . $pageRecord['fe_group']
|
|
));
|
|
}
|
|
}
|
|
|
|
/** @var $pageSelector PageRepository */
|
|
$pageSelector = GeneralUtility::makeInstance(PageRepository::class);
|
|
|
|
// current page
|
|
$currentPageRecord = $pageSelector->getPage($pageId, true);
|
|
if ($currentPageRecord['fe_group']) {
|
|
$accessRootline->push(GeneralUtility::makeInstance(
|
|
RootlineElement::class,
|
|
/** @scrutinizer ignore-type */ $currentPageRecord['uid'] . RootlineElement::PAGE_ID_GROUP_DELIMITER . $currentPageRecord['fe_group']
|
|
));
|
|
}
|
|
|
|
return $accessRootline;
|
|
}
|
|
|
|
/**
|
|
* Returns the string representation of the access rootline.
|
|
*
|
|
* @return string String representation of the access rootline.
|
|
*/
|
|
public function __toString()
|
|
{
|
|
$stringElements = [];
|
|
|
|
foreach ($this->rootlineElements as $rootlineElement) {
|
|
$stringElements[] = (string)$rootlineElement;
|
|
}
|
|
|
|
return implode(self::ELEMENT_DELIMITER, $stringElements);
|
|
}
|
|
|
|
/**
|
|
* Gets a the groups in the Access Rootline.
|
|
*
|
|
* @return array An array of sorted, unique user group IDs required to access a page.
|
|
*/
|
|
public function getGroups()
|
|
{
|
|
$groups = [];
|
|
|
|
foreach ($this->rootlineElements as $rootlineElement) {
|
|
$rootlineElementGroups = $rootlineElement->getGroups();
|
|
$groups = array_merge($groups, $rootlineElementGroups);
|
|
}
|
|
|
|
$groups = $this->cleanGroupArray($groups);
|
|
|
|
return $groups;
|
|
}
|
|
|
|
/**
|
|
* Cleans an array of frontend user group IDs. Removes duplicates and sorts
|
|
* the array.
|
|
*
|
|
* @param array $groups An array of frontend user group IDs
|
|
* @return array An array of cleaned frontend user group IDs, unique, sorted.
|
|
*/
|
|
public static function cleanGroupArray(array $groups)
|
|
{
|
|
$groups = array_unique($groups); // removes duplicates
|
|
sort($groups, SORT_NUMERIC); // sort
|
|
|
|
return $groups;
|
|
}
|
|
}
|