meilisearch/Classes/Domain/Site/Site.php

267 lines
7.6 KiB
PHP
Raw Normal View History

2021-04-17 00:26:33 +02:00
<?php
namespace WapplerSystems\Meilisearch\Domain\Site;
/***************************************************************
* 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 WapplerSystems\Meilisearch\Domain\Index\Queue\RecordMonitor\Helper\ConfigurationAwareRecordService;
2021-04-17 21:20:54 +02:00
use WapplerSystems\Meilisearch\NoMeilisearchConnectionFoundException;
2021-04-17 00:26:33 +02:00
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
use WapplerSystems\Meilisearch\System\Records\Pages\PagesRepository;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Base Clas for Typo3ManagedSite and LegacySite
*/
abstract class Site implements SiteInterface
{
/**
* @var TypoScriptConfiguration
*/
protected $configuration;
/**
* Root page record.
*
* @var array
*/
protected $rootPage = [];
/**
* @var string
*/
protected $domain;
/**
* @var string
*/
protected $siteHash;
/**
* @var PagesRepository
*/
protected $pagesRepository;
/**
* @var int
*/
protected $defaultLanguageId = 0;
/**
* @var int[] Available language ids
*/
protected $availableLanguageIds = [];
/**
* Takes an pagerecord and checks whether the page is marked as root page.
*
* @param array $page pagerecord
* @return bool true if the page is marked as root page, false otherwise
* @todo: move to SiteUtility?
*/
public static function isRootPage($page)
{
if ($page['is_siteroot']) {
return true;
}
return false;
}
/**
* Gets the site's root page ID (uid).
*
* @return int The site's root page ID.
*/
public function getRootPageId()
{
return (int)$this->rootPage['uid'];
}
/**
* Gets available language id's for this site
*
* @return int[] array or language id's
*/
public function getAvailableLanguageIds(): array {
return $this->availableLanguageIds;
}
/**
* Gets the site's label. The label is build from the the site title and root
* page ID (uid).
*
* @return string The site's label.
*/
public function getLabel()
{
$rootlineTitles = [];
$rootLine = BackendUtility::BEgetRootLine($this->rootPage['uid']);
// Remove last
array_pop($rootLine);
$rootLine = array_reverse($rootLine);
foreach ($rootLine as $rootLineItem) {
$rootlineTitles[] = $rootLineItem['title'];
}
return implode(' - ', $rootlineTitles) . ', Root Page ID: ' . $this->rootPage['uid'];
}
/**
2021-04-17 21:20:54 +02:00
* Gets the site's Meilisearch TypoScript configuration (plugin.tx_meilisearch.*)
2021-04-17 00:26:33 +02:00
*
2021-04-17 21:20:54 +02:00
* @return \WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration The Meilisearch TypoScript configuration
2021-04-17 00:26:33 +02:00
*/
2021-04-17 21:20:54 +02:00
public function getMeilisearchConfiguration()
2021-04-17 00:26:33 +02:00
{
return $this->configuration;
}
/**
* Gets the site's default language as configured in
* config.sys_language_uid. If sys_language_uid is not set, 0 is assumed to
* be the default.
*
* @return int The site's default language.
*/
public function getDefaultLanguage()
{
return $this->defaultLanguageId;
}
/**
* Generates a list of page IDs in this site. Attention, this includes
* all page types! Deleted pages are not included.
*
* @param int|string $rootPageId Page ID from where to start collection sub pages
* @param int $maxDepth Maximum depth to descend into the site tree
* @return array Array of pages (IDs) in this site
*/
public function getPages($rootPageId = 'SITE_ROOT', $maxDepth = 999)
{
$pageIds = [];
if ($rootPageId === 'SITE_ROOT') {
$rootPageId = (int)$this->rootPage['uid'];
$pageIds[] = $rootPageId;
}
$configurationAwareRecordService = GeneralUtility::makeInstance(ConfigurationAwareRecordService::class);
// Fetch configuration in order to be able to read initialPagesAdditionalWhereClause
2021-04-17 21:20:54 +02:00
$meilisearchConfiguration = $this->getMeilisearchConfiguration();
$indexQueueConfigurationName = $configurationAwareRecordService->getIndexingConfigurationName('pages', $this->rootPage['uid'], $meilisearchConfiguration);
2021-04-17 00:26:33 +02:00
if ($indexQueueConfigurationName === null) {
return $pageIds;
}
2021-04-17 21:20:54 +02:00
$initialPagesAdditionalWhereClause = $meilisearchConfiguration->getInitialPagesAdditionalWhereClause($indexQueueConfigurationName);
2021-04-17 00:26:33 +02:00
return array_merge($pageIds, $this->pagesRepository->findAllSubPageIdsByRootPage($rootPageId, $maxDepth, $initialPagesAdditionalWhereClause));
}
/**
* Generates the site's unique Site Hash.
*
* The Site Hash is build from the site's main domain, the system encryption
* key, and the extension "tx_meilisearch". These components are concatenated and
* sha1-hashed.
*
* @return string Site Hash.
*/
public function getSiteHash()
{
return $this->siteHash;
}
/**
* Gets the site's main domain. More specifically the first domain record in
* the site tree.
*
* @return string The site's main domain.
*/
public function getDomain()
{
return $this->domain;
}
/**
* Gets the site's root page.
*
* @return array The site's root page.
*/
public function getRootPage()
{
return $this->rootPage;
}
/**
* Gets the site's root page's title.
*
* @return string The site's root page's title
*/
public function getTitle()
{
return $this->rootPage['title'];
}
/**
* Retrieves the rootPageIds as an array from a set of sites.
*
* @param array $sites
* @return array
* @todo: move to SiteUtility?
*/
public static function getRootPageIdsFromSites(array $sites): array
{
$rootPageIds = [];
foreach ($sites as $site) {
$rootPageIds[] = (int)$site->getRootPageId();
}
return $rootPageIds;
}
/**
* @return array
2021-04-17 21:20:54 +02:00
* @throws NoMeilisearchConnectionFoundException
2021-04-17 00:26:33 +02:00
*/
2021-04-17 21:20:54 +02:00
public function getAllMeilisearchConnectionConfigurations(): array {
2021-04-17 00:26:33 +02:00
$configs = [];
foreach ($this->getAvailableLanguageIds() as $languageId) {
try {
2021-04-17 21:20:54 +02:00
$configs[$languageId] = $this->getMeilisearchConnectionConfiguration($languageId);
} catch (NoMeilisearchConnectionFoundException $e) {}
2021-04-17 00:26:33 +02:00
}
return $configs;
}
public function isEnabled(): bool
{
2021-04-17 21:20:54 +02:00
return !empty($this->getAllMeilisearchConnectionConfigurations());
2021-04-17 00:26:33 +02:00
}
/**
* @param int $languageId
* @return array
*/
2021-04-17 21:20:54 +02:00
abstract function getMeilisearchConnectionConfiguration(int $language = 0): array;
2021-04-17 00:26:33 +02:00
}