Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-elasticsearch/Elasticsearch5/Model/Client/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Elasticsearch\Elasticsearch5\Model\Client;
use Magento\Framework\Exception\LocalizedException;
use Magento\AdvancedSearch\Model\Client\ClientInterface;
/**
* Elasticsearch client
*
* @deprecated 100.3.5 the Elasticsearch 5 doesn't supported due to EOL
*/
class Elasticsearch implements ClientInterface
{
/**
* Elasticsearch Client instances
*
* @var \Elasticsearch\Client[]
*/
private $client;
/**
* @var array
*/
private $clientOptions;
/**
* @var bool
*/
private $pingResult;
/**
* @var string
*/
private $serverVersion;
/**
* Initialize Elasticsearch Client
*
* @param array $options
* @param \Elasticsearch\Client|null $elasticsearchClient
* @throws LocalizedException
*/
public function __construct(
$options = [],
$elasticsearchClient = null
) {
if (empty($options['hostname'])
|| ((!empty($options['enableAuth']) && ($options['enableAuth'] == 1))
&& (empty($options['username']) || empty($options['password'])))
) {
throw new LocalizedException(
__('The search failed because of a search engine misconfiguration.')
);
}
if (!($elasticsearchClient instanceof \Elasticsearch\Client)) {
$config = $this->buildConfig($options);
$elasticsearchClient = \Elasticsearch\ClientBuilder::fromConfig($config, true);
}
$this->client[getmypid()] = $elasticsearchClient;
$this->clientOptions = $options;
}
/**
* Get Elasticsearch Client
*
* @return \Elasticsearch\Client
*/
private function getClient()
{
$pid = getmypid();
if (!isset($this->client[$pid])) {
$config = $this->buildConfig($this->clientOptions);
$this->client[$pid] = \Elasticsearch\ClientBuilder::fromConfig($config, true);
}
return $this->client[$pid];
}
/**
* Ping the Elasticsearch client
*
* @return bool
*/
public function ping()
{
if ($this->pingResult === null) {
$this->pingResult = $this->getClient()->ping(['client' => ['timeout' => $this->clientOptions['timeout']]]);
}
return $this->pingResult;
}
/**
* Validate connection params.
*
* @return bool
*/
public function testConnection()
{
return $this->ping();
}
/**
* Build config.
*
* @param array $options
* @return array
*/
private function buildConfig($options = [])
{
$hostname = preg_replace('/http[s]?:\/\//i', '', $options['hostname']);
// @codingStandardsIgnoreStart
$protocol = parse_url($options['hostname'], PHP_URL_SCHEME);
// @codingStandardsIgnoreEnd
if (!$protocol) {
$protocol = 'http';
}
$authString = '';
if (!empty($options['enableAuth']) && (int)$options['enableAuth'] === 1) {
$authString = "{$options['username']}:{$options['password']}@";
}
$portString = '';
if (!empty($options['port'])) {
$portString = ':' . $options['port'];
}
$host = $protocol . '://' . $authString . $hostname . $portString;
$options['hosts'] = [$host];
return $options;
}
/**
* Performs bulk query over Elasticsearch index
*
* @param array $query
* @return void
*/
public function bulkQuery($query)
{
$this->getClient()->bulk($query);
}
/**
* Creates an Elasticsearch index.
*
* @param string $index
* @param array $settings
* @return void
*/
public function createIndex($index, $settings)
{
$this->getClient()->indices()->create(
[
'index' => $index,
'body' => $settings,
]
);
}
/**
* Add/update an Elasticsearch index settings.
*
* @param string $index
* @param array $settings
* @return void
*/
public function putIndexSettings(string $index, array $settings): void
{
$this->getClient()->indices()->putSettings(
[
'index' => $index,
'body' => $settings,
]
);
}
/**
* Delete an Elasticsearch index.
*
* @param string $index
* @return void
*/
public function deleteIndex($index)
{
$this->getClient()->indices()->delete(['index' => $index]);
}
/**
* Check if index is empty.
*
* @param string $index
* @return bool
*/
public function isEmptyIndex($index)
{
$stats = $this->getClient()->indices()->stats(['index' => $index, 'metric' => 'docs']);
if ($stats['indices'][$index]['primaries']['docs']['count'] == 0) {
return true;
}
return false;
}
/**
* Updates alias.
*
* @param string $alias
* @param string $newIndex
* @param string $oldIndex
* @return void
*/
public function updateAlias($alias, $newIndex, $oldIndex = '')
{
$params['body'] = ['actions' => []];
if ($oldIndex) {
$params['body']['actions'][] = ['remove' => ['alias' => $alias, 'index' => $oldIndex]];
}
if ($newIndex) {
$params['body']['actions'][] = ['add' => ['alias' => $alias, 'index' => $newIndex]];
}
$this->getClient()->indices()->updateAliases($params);
}
/**
* Checks whether Elasticsearch index exists
*
* @param string $index
* @return bool
*/
public function indexExists($index)
{
return $this->getClient()->indices()->exists(['index' => $index]);
}
/**
* Exists alias.
*
* @param string $alias
* @param string $index
* @return bool
*/
public function existsAlias($alias, $index = '')
{
$params = ['name' => $alias];
if ($index) {
$params['index'] = $index;
}
return $this->getClient()->indices()->existsAlias($params);
}
/**
* Get alias.
*
* @param string $alias
* @return array
*/
public function getAlias($alias)
{
return $this->getClient()->indices()->getAlias(['name' => $alias]);
}
/**
* Add mapping to Elasticsearch index
*
* @param array $fields
* @param string $index
* @param string $entityType
* @return void
*/
public function addFieldsMapping(array $fields, $index, $entityType)
{
$params = [
'index' => $index,
'type' => $entityType,
'body' => [
$entityType => [
'_all' => $this->prepareFieldInfo(
[
'enabled' => true,
'type' => 'text',
]
),
'properties' => [],
'dynamic_templates' => [
[
'price_mapping' => [
'match' => 'price_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'double',
'store' => true,
],
],
],
[
'position_mapping' => [
'match' => 'position_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'integer',
'index' => true,
],
],
],
[
'string_mapping' => [
'match' => '*',
'match_mapping_type' => 'string',
'mapping' => $this->prepareFieldInfo(
[
'type' => 'text',
'index' => true,
]
),
],
],
[
'integer_mapping' => [
'match_mapping_type' => 'long',
'mapping' => [
'type' => 'integer',
],
],
],
],
],
],
];
foreach ($fields as $field => $fieldInfo) {
$params['body'][$entityType]['properties'][$field] = $this->prepareFieldInfo($fieldInfo);
}
$this->getClient()->indices()->putMapping($params);
}
/**
* Fix backward compatibility of field definition. Allow to run both 2.x and 5.x servers.
*
* @param array $fieldInfo
*
* @return array
*/
private function prepareFieldInfo($fieldInfo)
{
if (strcmp($this->getServerVersion(), '5') < 0) {
if ($fieldInfo['type'] == 'keyword') {
$fieldInfo['type'] = 'string';
$fieldInfo['index'] = isset($fieldInfo['index']) ? $fieldInfo['index'] : 'not_analyzed';
}
if ($fieldInfo['type'] == 'text') {
$fieldInfo['type'] = 'string';
}
}
return $fieldInfo;
}
/**
* Get mapping from Elasticsearch index.
*
* @param array $params
* @return array
*/
public function getMapping(array $params): array
{
return $this->getClient()->indices()->getMapping($params);
}
/**
* Delete mapping in Elasticsearch index
*
* @param string $index
* @param string $entityType
* @return void
*/
public function deleteMapping($index, $entityType)
{
$this->getClient()->indices()->deleteMapping(
['index' => $index, 'type' => $entityType]
);
}
/**
* Execute search by $query
*
* @param array $query
* @return array
*/
public function query($query)
{
$query = $this->prepareSearchQuery($query);
return $this->getClient()->search($query);
}
/**
* Fix backward compatibility of the search queries. Allow to run both 2.x and 5.x servers.
*
* @param array $query
*
* @return array
*/
private function prepareSearchQuery($query)
{
if (strcmp($this->getServerVersion(), '5') < 0) {
if (isset($query['body']) && isset($query['body']['stored_fields'])) {
$query['body']['fields'] = $query['body']['stored_fields'];
unset($query['body']['stored_fields']);
}
}
return $query;
}
/**
* Execute suggest query
*
* @param array $query
* @return array
*/
public function suggest($query)
{
return $this->getClient()->suggest($query);
}
/**
* Retrieve ElasticSearch server current version.
*
* @return string
*/
private function getServerVersion()
{
if ($this->serverVersion === null) {
$info = $this->getClient()->info();
$this->serverVersion = $info['version']['number'];
}
return $this->serverVersion;
}
}