180 lines
5.8 KiB
PHP
180 lines
5.8 KiB
PHP
<?php declare(strict_types = 1);
|
|
namespace WapplerSystems\Meilisearch\Domain\Search\FrequentSearches;
|
|
|
|
/*
|
|
* 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 WapplerSystems\Meilisearch\Domain\Search\Statistics\StatisticsRepository;
|
|
use WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration;
|
|
use WapplerSystems\Meilisearch\Util;
|
|
use TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend;
|
|
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
|
|
|
|
/**
|
|
* The FrequentSearchesService is used to retrieve the frequent searches from the database or cache.
|
|
*
|
|
* @author Dimitri Ebert <dimitri.ebert@dkd.de>
|
|
* @author Timo Schmidt <timo.schmidt@dkd.de>
|
|
* @copyright (c) 2015-2021 dkd Internet Service GmbH <info@dkd.de>
|
|
*/
|
|
class FrequentSearchesService
|
|
{
|
|
|
|
/**
|
|
* Instance of the caching frontend used to cache this command's output.
|
|
*
|
|
* @var AbstractFrontend
|
|
*/
|
|
protected $cache;
|
|
|
|
/**
|
|
* @var TypoScriptFrontendController
|
|
*/
|
|
protected $tsfe;
|
|
|
|
/**
|
|
* @var StatisticsRepository
|
|
*/
|
|
protected $statisticsRepository;
|
|
|
|
/**
|
|
* @var TypoScriptConfiguration
|
|
*/
|
|
protected $configuration;
|
|
|
|
/**
|
|
* @param TypoScriptConfiguration $typoscriptConfiguration
|
|
* @param AbstractFrontend|null $cache
|
|
* @param TypoScriptFrontendController|null $tsfe
|
|
* @param StatisticsRepository|null $statisticsRepository
|
|
*/
|
|
public function __construct(
|
|
TypoScriptConfiguration $typoscriptConfiguration,
|
|
AbstractFrontend $cache = null,
|
|
TypoScriptFrontendController $tsfe = null,
|
|
StatisticsRepository $statisticsRepository = null
|
|
) {
|
|
$this->configuration = $typoscriptConfiguration;
|
|
$this->cache = $cache;
|
|
$this->tsfe = $tsfe;
|
|
$this->statisticsRepository = $statisticsRepository ?? GeneralUtility::makeInstance(StatisticsRepository::class);
|
|
}
|
|
|
|
/**
|
|
* Generates an array with terms and hits
|
|
*
|
|
* @return array Tags as array with terms and hits
|
|
*/
|
|
public function getFrequentSearchTerms() : array
|
|
{
|
|
$frequentSearchConfiguration = $this->configuration->getSearchFrequentSearchesConfiguration();
|
|
|
|
$identifier = $this->getCacheIdentifier($frequentSearchConfiguration);
|
|
|
|
if ($this->hasValidCache() && $this->cache->has($identifier)) {
|
|
$terms = $this->cache->get($identifier);
|
|
} else {
|
|
$terms = $this->getFrequentSearchTermsFromStatistics($frequentSearchConfiguration);
|
|
|
|
if ($frequentSearchConfiguration['sortBy'] === 'hits') {
|
|
arsort($terms);
|
|
} else {
|
|
ksort($terms);
|
|
}
|
|
|
|
$lifetime = null;
|
|
if (isset($frequentSearchConfiguration['cacheLifetime'])) {
|
|
$lifetime = intval($frequentSearchConfiguration['cacheLifetime']);
|
|
}
|
|
|
|
if ($this->hasValidCache()) {
|
|
$this->cache->set($identifier, $terms, [], $lifetime);
|
|
}
|
|
}
|
|
|
|
return $terms;
|
|
}
|
|
|
|
/**
|
|
* Gets frequent search terms from the statistics tracking table.
|
|
*
|
|
* @param array $frequentSearchConfiguration
|
|
* @return array Array of frequent search terms, keys are the terms, values are hits
|
|
*/
|
|
protected function getFrequentSearchTermsFromStatistics(array $frequentSearchConfiguration) : array
|
|
{
|
|
$terms = [];
|
|
|
|
if ($frequentSearchConfiguration['select.']['checkRootPageId']) {
|
|
$checkRootPidWhere = 'root_pid = ' . $this->tsfe->tmpl->rootLine[0]['uid'];
|
|
} else {
|
|
$checkRootPidWhere = '1';
|
|
}
|
|
if ($frequentSearchConfiguration['select.']['checkLanguage']) {
|
|
$checkLanguageWhere = ' AND language =' . Util::getLanguageUid();
|
|
} else {
|
|
$checkLanguageWhere = '';
|
|
}
|
|
|
|
$frequentSearchConfiguration['select.']['ADD_WHERE'] = $checkRootPidWhere .
|
|
$checkLanguageWhere . ' ' .
|
|
$frequentSearchConfiguration['select.']['ADD_WHERE'];
|
|
|
|
$frequentSearchTerms = $this->statisticsRepository
|
|
->getFrequentSearchTermsFromStatisticsByFrequentSearchConfiguration($frequentSearchConfiguration);
|
|
|
|
if (!is_array($frequentSearchTerms)) {
|
|
return $terms;
|
|
}
|
|
|
|
foreach ($frequentSearchTerms as $term) {
|
|
$cleanedTerm = html_entity_decode($term['search_term'], ENT_QUOTES, 'UTF-8');
|
|
$terms[$cleanedTerm] = $term['hits'];
|
|
}
|
|
|
|
return $terms;
|
|
}
|
|
|
|
/**
|
|
* @param array $frequentSearchConfiguration
|
|
* @return string
|
|
*/
|
|
protected function getCacheIdentifier(array $frequentSearchConfiguration) : string
|
|
{
|
|
// Use configuration as cache identifier
|
|
$identifier = 'frequentSearchesTags';
|
|
|
|
if ($frequentSearchConfiguration['select.']['checkRootPageId']) {
|
|
$identifier .= '_RP' . (int)$this->tsfe->tmpl->rootLine[0]['uid'];
|
|
}
|
|
if ($frequentSearchConfiguration['select.']['checkLanguage']) {
|
|
$identifier .= '_L' . Util::getLanguageUid();
|
|
}
|
|
|
|
$identifier .= '_' . md5(serialize($frequentSearchConfiguration));
|
|
return $identifier;
|
|
}
|
|
|
|
/**
|
|
* Checks if this service has a valid cache class
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function hasValidCache(): bool
|
|
{
|
|
return ($this->cache instanceof FrontendInterface);
|
|
}
|
|
}
|