wikimedia/mediawiki-extensions-CirrusSearch

<?php

namespace CirrusSearch;

use MediaWiki\Status\Status;

/**
 * Fetch the Elasticsearch version
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 */
class Version extends ElasticsearchIntermediary {
    /**
     * @param Connection $conn
     */
    public function __construct( Connection $conn ) {
        parent::__construct( $conn, null, 0 );
    }

    /**
     * Get the version of Elasticsearch with which we're communicating.
     *
     * @return Status<string> version number as a string
     */
    public function get() {
        try {
            $this->startNewLog( 'fetching elasticsearch version', 'version' );
            // If this times out the cluster is in really bad shape but we should still
            // check it.
            $this->connection->setTimeout( $this->getClientTimeout( 'version' ) );
            $result = $this->connection->getClient()->request( '' );
            $this->success();
        } catch ( \Elastica\Exception\ExceptionInterface $e ) {
            return $this->failure( $e );
        }
        return Status::newGood(
            $result->getData()['version']['number']
        );
    }

    /**
     * @param string $description
     * @param string $queryType
     * @param string[] $extra
     * @return SearchRequestLog
     */
    protected function newLog( $description, $queryType, array $extra = [] ) {
        return new SearchRequestLog(
            $this->connection->getClient(),
            $description,
            $queryType,
            $extra
        );
    }
}