meilisearch/Classes/System/Meilisearch/Service/MeilisearchAdminService.php
2021-04-17 21:20:54 +02:00

391 lines
12 KiB
PHP

<?php
namespace WapplerSystems\Meilisearch\System\Meilisearch\Service;
/***************************************************************
* Copyright notice
*
* (c) 2009-2017 Timo Hund <timo.hund@dkd.de>
* 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\System\Configuration\TypoScriptConfiguration;
use WapplerSystems\Meilisearch\System\Logging\MeilisearchLogManager;
use WapplerSystems\Meilisearch\System\Meilisearch\Parser\SchemaParser;
use WapplerSystems\Meilisearch\System\Meilisearch\Parser\StopWordParser;
use WapplerSystems\Meilisearch\System\Meilisearch\Parser\SynonymParser;
use WapplerSystems\Meilisearch\System\Meilisearch\ResponseAdapter;
use WapplerSystems\Meilisearch\System\Meilisearch\Schema\Schema;
use Solarium\Client;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Class MeilisearchAdminService
*/
class MeilisearchAdminService extends AbstractMeilisearchService
{
const PLUGINS_SERVLET = 'admin/plugins';
const LUKE_SERVLET = 'admin/luke';
const SYSTEM_SERVLET = 'admin/system';
const CORES_SERVLET = '../admin/cores';
const FILE_SERVLET = 'admin/file';
const SCHEMA_SERVLET = 'schema';
const SYNONYMS_SERVLET = 'schema/analysis/synonyms/';
const STOPWORDS_SERVLET = 'schema/analysis/stopwords/';
/**
* @var array
*/
protected $lukeData = [];
protected $systemData = null;
protected $pluginsData = [];
/**
* @var string|null
*/
protected $meilisearchconfigName;
/**
* @var SchemaParser
*/
protected $schemaParser = null;
/**
* @var Schema
*/
protected $schema;
/**
* @var string
*/
protected $_synonymsUrl;
/**
* @var string
*/
protected $_stopWordsUrl;
/**
* @var SynonymParser
*/
protected $synonymParser = null;
/**
* @var StopWordParser
*/
protected $stopWordParser = null;
/**
* Constructor
*
* @param TypoScriptConfiguration $typoScriptConfiguration
* @param SynonymParser $synonymParser
* @param StopWordParser $stopWordParser
* @param SchemaParser $schemaParser
* @param MeilisearchLogManager $logManager
*/
public function __construct(
Client $client,
TypoScriptConfiguration $typoScriptConfiguration = null,
MeilisearchLogManager $logManager = null,
SynonymParser $synonymParser = null,
StopWordParser $stopWordParser = null,
SchemaParser $schemaParser = null
)
{
parent::__construct($client, $typoScriptConfiguration);
$this->synonymParser = $synonymParser ?? GeneralUtility::makeInstance(SynonymParser::class);
$this->stopWordParser = $stopWordParser ?? GeneralUtility::makeInstance(StopWordParser::class);
$this->schemaParser = $schemaParser ?? GeneralUtility::makeInstance(SchemaParser::class);
}
/**
* Call the /admin/system servlet and retrieve system information about Meilisearch
*
* @return ResponseAdapter
*/
public function system()
{
return $this->_sendRawGet($this->_constructUrl(self::SYSTEM_SERVLET, ['wt' => 'json']));
}
/**
* Gets information about the plugins installed in Meilisearch
*
* @return array A nested array of plugin data.
*/
public function getPluginsInformation()
{
if (count($this->pluginsData) == 0) {
$url = $this->_constructUrl(self::PLUGINS_SERVLET, ['wt' => 'json']);
$pluginsInformation = $this->_sendRawGet($url);
// access a random property to trigger response parsing
$pluginsInformation->responseHeader;
$this->pluginsData = $pluginsInformation;
}
return $this->pluginsData;
}
/**
* get field meta data for the index
*
* @param int $numberOfTerms Number of top terms to fetch for each field
* @return \stdClass
*/
public function getFieldsMetaData($numberOfTerms = 0)
{
return $this->getLukeMetaData($numberOfTerms)->fields;
}
/**
* Retrieves meta data about the index from the luke request handler
*
* @param int $numberOfTerms Number of top terms to fetch for each field
* @return ResponseAdapter Index meta data
*/
public function getLukeMetaData($numberOfTerms = 0)
{
if (!isset($this->lukeData[$numberOfTerms])) {
$lukeUrl = $this->_constructUrl(
self::LUKE_SERVLET, ['numTerms' => $numberOfTerms, 'wt' => 'json', 'fl' => '*']
);
$this->lukeData[$numberOfTerms] = $this->_sendRawGet($lukeUrl);
}
return $this->lukeData[$numberOfTerms];
}
/**
* Gets information about the Meilisearch server
*
* @return ResponseAdapter
*/
public function getSystemInformation()
{
if (empty($this->systemData)) {
$systemInformation = $this->system();
// access a random property to trigger response parsing
$systemInformation->responseHeader;
$this->systemData = $systemInformation;
}
return $this->systemData;
}
/**
* Gets the name of the meilisearchconfig.xml file installed and in use on the Meilisearch
* server.
*
* @return string Name of the active meilisearchconfig.xml
*/
public function getMeilisearchconfigName()
{
if (is_null($this->meilisearchconfigName)) {
$meilisearchconfigXmlUrl = $this->_constructUrl(self::FILE_SERVLET, ['file' => 'meilisearchconfig.xml']);
$response = $this->_sendRawGet($meilisearchconfigXmlUrl);
$meilisearchconfigXml = simplexml_load_string($response->getRawResponse());
if ($meilisearchconfigXml === false) {
throw new \InvalidArgumentException('No valid xml response from schema file: ' . $meilisearchconfigXmlUrl);
}
$this->meilisearchconfigName = (string)$meilisearchconfigXml->attributes()->name;
}
return $this->meilisearchconfigName;
}
/**
* Gets the Meilisearch server's version number.
*
* @return string Meilisearch version number
*/
public function getMeilisearchServerVersion()
{
$systemInformation = $this->getSystemInformation();
// don't know why $systemInformation->lucene->meilisearch-spec-version won't work
$luceneInformation = (array)$systemInformation->lucene;
return $luceneInformation['meilisearch-spec-version'];
}
/**
* Reloads the current core
*
* @return ResponseAdapter
*/
public function reloadCore()
{
$response = $this->reloadCoreByName($this->getPrimaryEndpoint()->getCore());
return $response;
}
/**
* Reloads a core of the connection by a given corename.
*
* @param string $coreName
* @return ResponseAdapter
*/
public function reloadCoreByName($coreName)
{
$coreAdminReloadUrl = $this->_constructUrl(self::CORES_SERVLET) . '?action=reload&core=' . $coreName;
$response = $this->_sendRawGet($coreAdminReloadUrl);
return $response;
}
/**
* Get the configured schema for the current core.
*
* @return Schema
*/
public function getSchema()
{
if ($this->schema !== null) {
return $this->schema;
}
$response = $this->_sendRawGet($this->_constructUrl(self::SCHEMA_SERVLET));
$this->schema = $this->schemaParser->parseJson($response->getRawResponse());
return $this->schema;
}
/**
* Get currently configured synonyms
*
* @param string $baseWord If given a base word, retrieves the synonyms for that word only
* @return array
*/
public function getSynonyms($baseWord = '')
{
$this->initializeSynonymsUrl();
$synonymsUrl = $this->_synonymsUrl;
if (!empty($baseWord)) {
$synonymsUrl .= '/' . $baseWord;
}
$response = $this->_sendRawGet($synonymsUrl);
return $this->synonymParser->parseJson($baseWord, $response->getRawResponse());
}
/**
* Add list of synonyms for base word to managed synonyms map
*
* @param string $baseWord
* @param array $synonyms
*
* @return ResponseAdapter
*
* @throws \InvalidArgumentException If $baseWord or $synonyms are empty
*/
public function addSynonym($baseWord, array $synonyms)
{
$this->initializeSynonymsUrl();
$json = $this->synonymParser->toJson($baseWord, $synonyms);
$response = $this->_sendRawPost($this->_synonymsUrl, $json, 'application/json');
return $response;
}
/**
* Remove a synonym from the synonyms map
*
* @param string $baseWord
* @return ResponseAdapter
* @throws \InvalidArgumentException
*/
public function deleteSynonym($baseWord)
{
$this->initializeSynonymsUrl();
if (empty($baseWord)) {
throw new \InvalidArgumentException('Must provide base word.');
}
$response = $this->_sendRawDelete($this->_synonymsUrl . '/' . urlencode($baseWord));
return $response;
}
/**
* Get currently configured stop words
*
* @return array
*/
public function getStopWords()
{
$this->initializeStopWordsUrl();
$response = $this->_sendRawGet($this->_stopWordsUrl);
return $this->stopWordParser->parseJson($response->getRawResponse());
}
/**
* Adds stop words to the managed stop word list
*
* @param array|string $stopWords string for a single word, array for multiple words
* @return ResponseAdapter
* @throws \InvalidArgumentException If $stopWords is empty
*/
public function addStopWords($stopWords)
{
$this->initializeStopWordsUrl();
$json = $this->stopWordParser->toJson($stopWords);
return $this->_sendRawPost($this->_stopWordsUrl, $json, 'application/json');
}
/**
* Deletes a words from the managed stop word list
*
* @param string $stopWord stop word to delete
* @return ResponseAdapter
* @throws \InvalidArgumentException If $stopWords is empty
*/
public function deleteStopWord($stopWord)
{
$this->initializeStopWordsUrl();
if (empty($stopWord)) {
throw new \InvalidArgumentException('Must provide stop word.');
}
return $this->_sendRawDelete($this->_stopWordsUrl . '/' . urlencode($stopWord));
}
/**
* @return void
*/
protected function initializeSynonymsUrl()
{
if (trim($this->_synonymsUrl) !== '') {
return;
}
$this->_synonymsUrl = $this->_constructUrl(self::SYNONYMS_SERVLET) . $this->getSchema()->getLanguage();
}
/**
* @return void
*/
protected function initializeStopWordsUrl()
{
if (trim($this->_stopWordsUrl) !== '') {
return;
}
$this->_stopWordsUrl = $this->_constructUrl(self::STOPWORDS_SERVLET) . $this->getSchema()->getLanguage();
}
}