Command.php

<?php
/**
 * @link https://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license https://www.yiiframework.com/license/
 */

namespace yii\elasticsearch;

use yii\base\Component;
use yii\base\InvalidCallException;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;

/**
 * The Command class implements the API for accessing the Elasticsearch REST API.
 *
 * Check the [Elasticsearch guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)
 * for details on these commands.
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
class Command extends Component
{
    /**
     * @var Connection
     */
    public $db;
    /**
     * @var string|array the indexes to execute the query on. Defaults to null meaning all indexes
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-multi-index-type
     */
    public $index;
    /**
     * @var string|array|null the types to execute the query on. Defaults to null meaning all types
     */
    public $type;
    /**
     * @var array list of arrays or json strings that become parts of a query
     */
    public $queryParts;
    /**
     * @var array options to be appended to the query URL, such as "search_type" for search or "timeout" for delete
     */
    public $options = [];


    /**
     * Sends a request to the _search API and returns the result
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function search($options = [])
    {
        $query = $this->queryParts;
        if (empty($query)) {
            $query = '{}';
        }
        if (is_array($query)) {
            $query = Json::encode($query);
        }
        $url = [$this->index !== null ? $this->index : '_all'];

        if ($this->db->dslVersion < 7 && $this->type !== null) {
            $url[] = $this->type;
        }

        $url[] = '_search';

        return $this->db->get($url, array_merge($this->options, $options), $query);
    }

    /**
     * Sends a request to the delete by query
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function deleteByQuery($options = [])
    {
        if (!isset($this->queryParts['query'])) {
            throw new InvalidCallException('Can not call deleteByQuery when no query is given.');
        }
        $query = [
            'query' => $this->queryParts['query'],
        ];
        if (isset($this->queryParts['filter'])) {
            $query['filter'] = $this->queryParts['filter'];
        }
        $query = Json::encode($query);
        $url = [$this->index !== null ? $this->index : '_all'];
        if ($this->type !== null) {
            $url[] = $this->type;
        }
        $url[] = '_delete_by_query';

        return $this->db->post($url, array_merge($this->options, $options), $query);
    }

    /**
     * Sends a suggest request to the _search API and returns the result
     * @param string|array $suggester the suggester body
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
     */
    public function suggest($suggester, $options = [])
    {
        if (empty($suggester)) {
            $suggester = '{}';
        }
        if (is_array($suggester)) {
            $suggester = Json::encode($suggester);
        }
        $body = '{"suggest":'.$suggester.',"size":0}';
        $url = [
            $this->index !== null ? $this->index : '_all',
            '_search'
        ];

        $result = $this->db->post($url, array_merge($this->options, $options), $body);

        return $result['suggest'];
    }

    /**
     * Inserts a document into an index
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string|array $data json string or array of data to store
     * @param string|null $id the documents id. If not specified Id will be automatically chosen
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
     */
    public function insert($index, $type, $data, $id = null, $options = [])
    {
        if (empty($data)) {
            $body = '{}';
        } else {
            $body = is_array($data) ? Json::encode($data) : $data;
        }

        if ($id !== null) {
            if ($this->db->dslVersion >= 7) {
                return $this->db->put([$index, '_doc', $id], $options, $body);
            } else {
                return $this->db->put([$index, $type, $id], $options, $body);
            }
        } else {
            if ($this->db->dslVersion >= 7) {
                return $this->db->post([$index, '_doc'], $options, $body);
            } else {
                return $this->db->post([$index, $type], $options, $body);
            }
        }
    }

    /**
     * gets a document from the index
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string $id the documents id.
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
     */
    public function get($index, $type, $id, $options = [])
    {
        if ($this->db->dslVersion >= 7) {
            return $this->db->get([$index, '_doc', $id], $options);
        } else {
            return $this->db->get([$index, $type, $id], $options);
        }
    }

    /**
     * gets multiple documents from the index
     *
     * TODO allow specifying type and index + fields
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string[] $ids the documents ids as values in array.
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
     */
    public function mget($index, $type, $ids, $options = [])
    {
        $body = Json::encode(['ids' => array_values($ids)]);

        if ($this->db->dslVersion >= 7) {
            return $this->db->get([$index, '_mget'], $options, $body);
        } else {
            return $this->db->get([$index, $type, '_mget'], $options, $body);
        }
    }

    /**
     * gets a documents _source from the index (>=v0.90.1)
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string $id the documents id.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source
     */
    public function getSource($index, $type, $id)
    {
        if ($this->db->dslVersion >= 7) {
            return $this->db->get([$index, '_doc', $id]);
        } else {
            return $this->db->get([$index, $type, $id]);
        }
    }

    /**
     * gets a document from the index
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string $id the documents id.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
     */
    public function exists($index, $type, $id)
    {
        if ($this->db->dslVersion >= 7) {
            return $this->db->head([$index, '_doc', $id]);
        } else {
            return $this->db->head([$index, $type, $id]);
        }
    }

    /**
     * deletes a document from the index
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string $id the documents id.
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
     */
    public function delete($index, $type, $id, $options = [])
    {
        if ($this->db->dslVersion >= 7) {
            return $this->db->delete([$index, '_doc', $id], $options);
        } else {
            return $this->db->delete([$index, $type, $id], $options);
        }
    }

    /**
     * updates a document
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string $id the documents id.
     * @param mixed $data
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
     */
    public function update($index, $type, $id, $data, $options = [])
    {
        $body = [
            'doc' => empty($data) ? new \stdClass() : $data,
        ];
        if (isset($options["detect_noop"])) {
            $body["detect_noop"] = $options["detect_noop"];
            unset($options["detect_noop"]);
        }

        if ($this->db->dslVersion >= 7) {
            return $this->db->post([$index, '_update', $id], $options, Json::encode($body));
        } else {
            return $this->db->post([$index, $type, $id, '_update'], $options, Json::encode($body));
        }
    }

    // TODO bulk https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

    /**
     * creates an index
     * @param string $index Index that the document belongs to.
     * @param null|array $configuration
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
     */
    public function createIndex($index, $configuration = null)
    {
        $body = $configuration !== null ? Json::encode($configuration) : null;

        return $this->db->put([$index], [], $body);
    }

    /**
     * deletes an index
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
     */
    public function deleteIndex($index)
    {
        return $this->db->delete([$index]);
    }

    /**
     * deletes all indexes
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
     */
    public function deleteAllIndexes()
    {
        return $this->db->delete(['_all']);
    }

    /**
     * checks whether an index exists
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
     */
    public function indexExists($index)
    {
        return $this->db->head([$index]);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html
     */
    public function typeExists($index, $type)
    {
        if ($this->db->dslVersion >= 7) {
            return $this->db->head([$index, '_doc']);
        } else {
            return $this->db->head([$index, $type]);
        }
    }

    /**
     * @param string $alias
     *
     * @return bool
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function aliasExists($alias)
    {
        $indexes = $this->getIndexesByAlias($alias);

        return !empty($indexes);
    }

    /**
     * @return array
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving
     */
    public function getAliasInfo()
    {
        $aliasInfo = $this->db->get(['_alias', '*']);
        return $aliasInfo ?: [];
    }

    /**
     * @param string $alias
     *
     * @return array
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving
     */
    public function getIndexInfoByAlias($alias)
    {
        $responseData = $this->db->get(['_alias', $alias]);
        if (empty($responseData)) {
            return [];
        }

        return $responseData;
    }

    /**
     * @param string $alias
     *
     * @return array
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function getIndexesByAlias($alias)
    {
        return array_keys($this->getIndexInfoByAlias($alias));
    }

    /**
     * @param string $index Index that the document belongs to.
     *
     * @return array
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving
     */
    public function getIndexAliases($index)
    {
        $responseData = $this->db->get([$index, '_alias', '*']);
        if (empty($responseData)) {
            return [];
        }

        return $responseData[$index]['aliases'];
    }

    /**
     * @param string $index Index that the document belongs to.
     * @param string $alias
     * @param array $aliasParameters
     *
     * @return bool
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-adding
     */
    public function addAlias($index, $alias, $aliasParameters = [])
    {
        return (bool)$this->db->put([$index, '_alias', $alias], [], json_encode((object)$aliasParameters));
    }

    /**
     * @param string $index Index that the document belongs to.
     * @param string $alias
     *
     * @return bool
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#deleting
     */
    public function removeAlias($index, $alias)
    {
        return (bool)$this->db->delete([$index, '_alias', $alias]);
    }

    /**
     * Runs alias manipulations.
     * If you want to add alias1 to index1
     * and remove alias2 from index2 you can use following commands:
     * ~~~
     * $actions = [
     *      ['add' => ['index' => 'index1', 'alias' => 'alias1']],
     *      ['remove' => ['index' => 'index2', 'alias' => 'alias2']],
     * ];
     * ~~~
     * @param array $actions
     *
     * @return bool
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#indices-aliases
     */
    public function aliasActions(array $actions)
    {
        return (bool)$this->db->post(['_aliases'], [], json_encode(['actions' => $actions]));
    }

    /**
     * Change specific index level settings in real time.
     * Note that update analyzers required to [[close()]] the index first and [[open()]] it after the changes are made,
     * use [[updateAnalyzers()]] for it.
     *
     * @param string $index Index that the document belongs to.
     * @param string|array $setting
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html
     * @since 2.0.4
     */
    public function updateSettings($index, $setting, $options = [])
    {
        $body = $setting !== null ? (is_string($setting) ? $setting : Json::encode($setting)) : null;
        return $this->db->put([$index, '_settings'], $options, $body);
    }

    /**
     * Define new analyzers for the index.
     * For example if content analyzer hasn’t been defined on "myindex" yet
     * you can use the following commands to add it:
     *
     * ~~~
     *  $setting = [
     *      'analysis' => [
     *          'analyzer' => [
     *              'ngram_analyzer_with_filter' => [
     *                  'tokenizer' => 'ngram_tokenizer',
     *                  'filter' => 'lowercase, snowball'
     *              ],
     *          ],
     *          'tokenizer' => [
     *              'ngram_tokenizer' => [
     *                  'type' => 'nGram',
     *                  'min_gram' => 3,
     *                  'max_gram' => 10,
     *                  'token_chars' => ['letter', 'digit', 'whitespace', 'punctuation', 'symbol']
     *              ],
     *          ],
     *      ]
     * ];
     * $elasticQuery->createCommand()->updateAnalyzers('myindex', $setting);
     * ~~~
     *
     * @param string $index Index that the document belongs to.
     * @param string|array $setting
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html#update-settings-analysis
     * @since 2.0.4
     */
    public function updateAnalyzers($index, $setting, $options = [])
    {
        $this->closeIndex($index);
        $result = $this->updateSettings($index, $setting, $options);
        $this->openIndex($index);
        return $result;
    }

    // TODO https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html

    // TODO https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
     */
    public function openIndex($index)
    {
        return $this->db->post([$index, '_open']);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
     */
    public function closeIndex($index)
    {
        return $this->db->post([$index, '_close']);
    }

    /**
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
     * @since 2.0.4
     */
    public function scroll($options = [])
    {
        $body = array_filter([
            'scroll' => ArrayHelper::remove($options, 'scroll', null),
            'scroll_id' => ArrayHelper::remove($options, 'scroll_id', null),
        ]);
        if (empty($body)) {
            $body = (object) [];
        }

       return $this->db->post(['_search', 'scroll'], $options, Json::encode($body));
    }

    /**
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
     * @since 2.0.4
     */
    public function clearScroll($options = [])
    {
        $body = array_filter([
            'scroll_id' => ArrayHelper::remove($options, 'scroll_id', null),
        ]);
        if (empty($body)) {
            $body = (object) [];
        }

       return $this->db->delete(['_search', 'scroll'], $options, Json::encode($body));
    }

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
     */
    public function getIndexStats($index = '_all')
    {
        return $this->db->get([$index, '_stats']);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
     */
    public function getIndexRecoveryStats($index = '_all')
    {
        return $this->db->get([$index, '_recovery']);
    }

    // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
     */
    public function clearIndexCache($index)
    {
        return $this->db->post([$index, '_cache', 'clear']);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
     */
    public function flushIndex($index = '_all')
    {
        return $this->db->post([$index, '_flush']);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
     */
    public function refreshIndex($index)
    {
        return $this->db->post([$index, '_refresh']);
    }

    // TODO https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-optimize.html

    // TODO https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html

    /**
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @param string|array $mapping
     * @param array $options URL options
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
     */
    public function setMapping($index, $type, $mapping, $options = [])
    {
        $body = $mapping !== null ? (is_string($mapping) ? $mapping : Json::encode($mapping)) : null;

        if ($this->db->dslVersion >= 7) {
            $endpoint = [$index, '_mapping'];
        } else {
            $endpoint = [$index, '_mapping', $type];
        }
        return $this->db->put($endpoint, $options, $body);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @param string|null $type Type that the document belongs to.
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html
     */
    public function getMapping($index = '_all', $type = null)
    {
        $url = [$index, '_mapping'];
        if ($this->db->dslVersion < 7 && $type !== null) {
            $url[] = $type;
        }
        return $this->db->get($url);
    }

    /**
     * @param string $index Index that the document belongs to.
     * @param string $type
     * @return mixed
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
     */
//    public function getFieldMapping($index, $type = '_all')
//    {
//		// TODO implement
//        return $this->db->put([$index, $type, '_mapping']);
//    }

    /**
     * @param $options
     * @param string $index Index that the document belongs to.
     * @return mixed
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html
     */
//	public function analyze($options, $index = null)
//	{
//		// TODO implement
////		return $this->db->put([$index]);
//	}

    /**
     * @param $name
     * @param $pattern
     * @param $settings
     * @param $mappings
     * @param int $order
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
     */
    public function createTemplate($name, $pattern, $settings, $mappings, $order = 0)
    {
        $body = Json::encode([
            'template' => $pattern,
            'order' => $order,
            'settings' => (object) $settings,
            'mappings' => (object) $mappings,
        ]);

        return $this->db->put(['_template', $name], [], $body);

    }

    /**
     * @param $name
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
     */
    public function deleteTemplate($name)
    {
        return $this->db->delete(['_template', $name]);

    }

    /**
     * @param $name
     * @return mixed
     * @throws Exception
     * @throws \yii\base\InvalidConfigException
     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
     */
    public function getTemplate($name)
    {
        return $this->db->get(['_template', $name]);
    }
}