src/module-elasticsuite-core/Helper/IndexSettings.php
<?php
/**
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Smile ElasticSuite to newer
* versions in the future.
*
* @category Smile
* @package Smile\ElasticsuiteCore
* @author Aurelien FOUCRET <aurelien.foucret@smile.fr>
* @copyright 2020 Smile
* @license Open Software License ("OSL") v. 3.0
*/
namespace Smile\ElasticsuiteCore\Helper;
use DateTime;
use Magento\Store\Api\Data\StoreInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Serialize\Serializer\Json;
/**
* Indices related configuration helper.
*
* @category Smile
* @package Smile\ElasticsuiteCore
* @author Aurelien FOUCRET <aurelien.foucret@smile.fr>
*/
class IndexSettings extends AbstractConfiguration
{
/**
* Location of ElasticSuite base settings configuration.
*
* @var string
*/
const BASE_CONFIG_XML_PREFIX = 'smile_elasticsuite_core_base_settings';
/**
* @var string
*/
const INDICES_SETTINGS_CONFIG_XML_PREFIX = 'indices_settings';
/**
* Location of Elasticsuite analysis settings configuration.
*
* @var string
*/
const ANALYSIS_CONFIG_XML_PREFIX = 'smile_elasticsuite_core_analysis_settings';
/**
* @var string
*/
const REFERENCE_ANALYZER_CONFIG_XML_PREFIX = 'reference_analyzer';
/**
* @var string
*/
const OLD_DEFAULT_INDICES_PATTERN = '{{YYYYMMdd}}_{{HHmmss}}';
/**
* @var string
*/
const DEFAULT_INDICES_PATTERN = '{{Ymd}}_{{His}}';
/**
* @var string
*/
const LOCALE_CODE_CONFIG_XML_PATH = 'general/locale/code';
/**
* @var integer
*/
const PER_SHARD_MAX_RESULT_WINDOW = 100000;
/**
* @var integer
*/
const MIN_SHINGLE_SIZE_DEFAULT = 2;
/**
* @var integer
*/
const MAX_SHINGLE_SIZE_DEFAULT = 2;
/**
* @var integer
*/
const MIN_NGRAM_SIZE_DEFAULT = 1;
/**
* @var integer
*/
const MAX_NGRAM_SIZE_DEFAULT = 2;
/**
* Return the locale code (e.g.: "en_US") for a store.
*
* @param integer|string|StoreInterface $store The store.
*
* @return string
*/
public function getLocaleCode($store)
{
$configPath = self::LOCALE_CODE_CONFIG_XML_PATH;
$scopeType = ScopeInterface::SCOPE_STORES;
$store = $this->getStore($store);
return $this->scopeConfig->getValue($configPath, $scopeType, $store);
}
/**
* Return the locale code (e.g.: "en") for a store.
*
* @param integer|string|StoreInterface $store The store.
*
* @return string
*/
public function getLanguageCode($store)
{
$store = $this->getStore($store);
$languageCode = current(explode('_', $this->getLocaleCode($store)));
return $languageCode;
}
/**
* Create a new index for an identifier (e.g. catalog_product) by store including current date.
*
* @param string $indexIdentifier Index identifier.
* @param integer|string|StoreInterface $store The store.
*
* @return string
*/
public function createIndexNameFromIdentifier($indexIdentifier, $store): string
{
$indexNameSuffix = $this->getIndexNameSuffix(new DateTime());
return sprintf('%s_%s', $this->getIndexAliasFromIdentifier($indexIdentifier, $store), $indexNameSuffix);
}
/**
* Get index name suffix.
*
* @param DateTime $date Date
* @return string
*/
public function getIndexNameSuffix(DateTime $date): string
{
/*
* Generate the suffix of the index name from the current date.
* e.g : Default pattern "{{Ymd}}_{{His}}" is converted to "20160221_123421".
*/
$indexNameSuffix = $this->getIndicesSettingsConfigParam('indices_pattern');
if ($indexNameSuffix === self::OLD_DEFAULT_INDICES_PATTERN) {
$indexNameSuffix = self::DEFAULT_INDICES_PATTERN;
}
// Parse pattern to extract datetime tokens.
$matches = [];
preg_match_all('/{{([\w]*)}}/', $indexNameSuffix, $matches);
foreach (array_combine($matches[0], $matches[1]) as $k => $v) {
// Replace tokens (UTC date used).
$indexNameSuffix = str_replace($k, $date->format($v), $indexNameSuffix);
}
return $indexNameSuffix;
}
/**
* Returns the index alias for an identifier (eg. catalog_product) by store.
*
* @param string $indexIdentifier An index identifier.
* @param integer|string|StoreInterface $store The store.
*
* @return string
*/
public function getIndexAliasFromIdentifier($indexIdentifier, $store)
{
$store = strtolower($this->getStoreCode($store));
return sprintf('%s_%s_%s', $this->getIndexAlias(), $store, $indexIdentifier);
}
/**
* Returns custom indices settings.
*
* @return array
*/
public function getCustomIndicesSettings(): array
{
$serializedConfigValue = $this->getSerializedConfigValue('indices_settings/custom_number_of_shards_and_replicas_per_index');
if ($serializedConfigValue !== null) {
return $this->normalize($serializedConfigValue);
}
return [];
}
/**
* Get serialized config value.
*
* @param string $indexType Index type.
*
* @return mixed|null
*/
public function getSerializedConfigValue(string $indexType)
{
$configValue = $this->getConfigValue($indexType);
if ($configValue !== null) {
$json = ObjectManager::getInstance()->get(Json::class);
return $json->unserialize($configValue);
}
return null;
}
/**
* Get the number of shards based on the provided index identifier.
*
* @param string|null $indexIdentifier If provided, the index identifier; otherwise, null.
*
* @return int
*/
public function getNumberOfShards(?string $indexIdentifier = null): int
{
// If $indexIdentifier is null, return the default number of shards from the configuration.
if ($indexIdentifier === null) {
return (int) $this->getIndicesSettingsConfigParam('number_of_shards');
}
// Otherwise, retrieve custom number of shards per index type.
return $this->getNumberOfShardsPerIndex($indexIdentifier);
}
/**
* Get custom number of shards per index type.
*
* @param string $indexIdentifier Index type identifier
*
* @return int
*/
public function getNumberOfShardsPerIndex(string $indexIdentifier): int
{
// Retrieve custom indices settings from the database.
$customSettings = $this->getCustomIndicesSettings();
if ($customSettings) {
foreach ($customSettings as $data) {
if ($data['index_type'] === $indexIdentifier && isset($data['custom_number_shards'])) {
return (int) $data['custom_number_shards'];
}
}
}
// If the custom setting doesn't exist in the database, return the default value from the configuration.
return (int) $this->getIndicesSettingsConfigParam('number_of_shards');
}
/**
* Get the number of replicas based on the provided index identifier.
*
* @param string|null $indexIdentifier If provided, the index identifier; otherwise, null.
*
* @return int
*/
public function getNumberOfReplicas(?string $indexIdentifier = null): int
{
// If $indexIdentifier is null, return the default number of replicas from the configuration.
if ($indexIdentifier === null) {
return (int) $this->getIndicesSettingsConfigParam('number_of_replicas');
}
// Otherwise, retrieve custom number of replicas per index type.
return $this->getNumberOfReplicasPerIndex($indexIdentifier);
}
/**
* Get custom number of replicas per index type.
*
* @param string $indexIdentifier Index type identifier
*
* @return int
*/
public function getNumberOfReplicasPerIndex(string $indexIdentifier): int
{
// Retrieve specific indices settings from the database.
$customSettings = $this->getCustomIndicesSettings();
if ($customSettings) {
foreach ($customSettings as $data) {
if ($data['index_type'] === $indexIdentifier && isset($data['custom_number_replicas'])) {
return (int) $data['custom_number_replicas'];
}
}
}
// If the custom setting doesn't exist in the database, return the default value from the configuration.
return (int) $this->getIndicesSettingsConfigParam('number_of_replicas');
}
/**
* Get number the batch indexing size from the configuration.
*
* @return integer
*/
public function getBatchIndexingSize()
{
return (int) $this->getIndicesSettingsConfigParam('batch_indexing_size');
}
/**
* Get the indices pattern from the configuration.
*
* @return string
*/
public function getIndicesPattern(): string
{
return $this->getIndicesSettingsConfigParam('indices_pattern');
}
/**
* Get the index alias from the configuration.
*
* @return string
*/
public function getIndexAlias(): string
{
return $this->getIndicesSettingsConfigParam('alias');
}
/**
* Max number of results per query.
*
* @param string $indexIdentifier Index identifier.
*
* @return integer
*/
public function getMaxResultWindow($indexIdentifier)
{
return (int) $this->getNumberOfShards($indexIdentifier) * self::PER_SHARD_MAX_RESULT_WINDOW;
}
/**
* Get maximum shingle diff for an index.
*
* @param array $analysisSettings Analysis Settings
*
* @return int|false
*/
public function getMaxShingleDiff($analysisSettings)
{
$maxShingleDiff = false;
foreach ($analysisSettings['filter'] ?? [] as $filter) {
if (($filter['type'] ?? null) === 'shingle') {
// @codingStandardsIgnoreStart
$filterDiff = ($filter['max_shingle_size'] ?? self::MAX_SHINGLE_SIZE_DEFAULT)
- ($filter['min_shingle_size'] ?? self::MIN_SHINGLE_SIZE_DEFAULT);
// codingStandardsIgnoreEnd
$maxShingleDiff = max((int) $maxShingleDiff, $filterDiff) + 1;
}
}
return $maxShingleDiff;
}
/**
* Get maximum ngram diff for an index.
*
* @param array $analysisSettings Analysis Settings
*
* @return int|false
*/
public function getMaxNgramDiff($analysisSettings)
{
$maxNgramDiff = false;
foreach ($analysisSettings['filter'] ?? [] as $filter) {
if (in_array(($filter['type'] ?? null), ['ngram', 'edge_ngram'])) {
$filterDiff = ($filter['max_gram'] ?? self::MAX_NGRAM_SIZE_DEFAULT)
- ($filter['min_gram'] ?? self::MIN_NGRAM_SIZE_DEFAULT);
$maxNgramDiff = max((int) $maxNgramDiff, $filterDiff) + 1;
}
}
return $maxNgramDiff;
}
/**
* Read config under the path smile_elasticsuite_core_base_settings/indices_settings.
*
* @param string $configField Configuration field name.
*
* @return mixed
*/
public function getIndicesSettingsConfigParam($configField)
{
$path = self::INDICES_SETTINGS_CONFIG_XML_PREFIX . '/' . $configField;
return $this->getElasticSuiteConfigParam($path);
}
/**
* Read config flag under the path smile_elasticsuite_core_analysis_settings/reference_analyzer.
*
* @param string $configFlag Config flag name.
* @param integer|string|StoreInterface $store Store.
*
* @return mixed
*/
public function getReferenceAnalyzerConfigFlag($configFlag, $store)
{
$path = self::ANALYSIS_CONFIG_XML_PREFIX . '/' . self::REFERENCE_ANALYZER_CONFIG_XML_PREFIX . '/' . $configFlag;
return $this->scopeConfig->isSetFlag($path, ScopeInterface::SCOPE_STORE, $store);
}
/**
* Retrieve a configuration value by its key.
*
* @param string $indexType The configuration key
*
* @return mixed
*/
protected function getConfigValue(string $indexType)
{
return $this->scopeConfig->getValue(self::BASE_CONFIG_XML_PREFIX . "/" . $indexType);
}
/**
* Normalize config data.
*
* @param array $data Data.
*
* @return array
*/
private function normalize(array $data): array
{
$result = [];
foreach ($data as $item) {
$result[] = [
'index_type' => $item['index_type'],
'custom_number_shards' => $item['custom_number_shards'],
'custom_number_replicas' => $item['custom_number_replicas'],
];
}
return $result;
}
/**
* Retrieve the store code from object or store id.
*
* @param StoreInterface|integer $store The store or it's id.
*
* @return string
*/
private function getStoreCode($store)
{
return $this->getStore($store)->getCode();
}
/**
* Ensure store is an object or load it from it's id / identifier.
*
* @param integer|string|StoreInterface $store The store identifier or id.
*
* @return StoreInterface
*/
private function getStore($store)
{
if (!is_object($store)) {
$store = $this->storeManager->getStore($store);
}
return $store;
}
}