Gazelle/classes/sphinxql.class.php

<?php
#declare(strict_types=1);

if (!extension_loaded('mysqli')) {
    error('Mysqli Extension not loaded.');
}

class Sphinxql extends mysqli
{
    private static $Connections = [];
    private $Server;
    private $Port;
    private $Socket;
    private $Ident;
    private $Connected = false;

    public static $Queries = [];
    public static $Time = 0.0;

    /**
     * Initialize Sphinxql object
     *
     * @param string $Server server address or hostname
     * @param int $Port listening port
     * @param string $Socket Unix socket address, overrides $Server:$Port
     */
    public function __construct($Server, $Port, $Socket)
    {
        $this->Server = $Server;
        $this->Port = $Port;
        $this->Socket = $Socket;
        $this->Ident = self::get_ident($Server, $Port, $Socket);
    }

    /**
     * Create server ident based on connection information
     *
     * @param string $Server server address or hostname
     * @param int $Port listening port
     * @param string $Socket Unix socket address, overrides $Server:$Port
     * @return identification string
     */
    private static function get_ident($Server, $Port, $Socket)
    {
        if ($Socket) {
            return $Socket;
        } else {
            return "$Server:$Port";
        }
    }

    /**
     * Create Sphinxql object or return existing one
     *
     * @param string $Server server address or hostname
     * @param int $Port listening port
     * @param string $Socket Unix socket address, overrides $Server:$Port
     * @return Sphinxql object
     */
    public static function init_connection($Server, $Port, $Socket)
    {
        $Ident = self::get_ident($Server, $Port, $Socket);
        if (!isset(self::$Connections[$Ident])) {
            self::$Connections[$Ident] = new Sphinxql($Server, $Port, $Socket);
        }
        return self::$Connections[$Ident];
    }

    /**
     * Connect the Sphinxql object to the Sphinx server
     */
    public function sph_connect()
    {
        if ($this->Connected || $this->connect_errno) {
            return;
        }

        global $Debug;
        $Debug->set_flag("Connecting to Sphinx server $this->Ident");

        for ($Attempt = 0; $Attempt < 3; $Attempt++) {
            parent::__construct($this->Server, '', '', '', $this->Port, $this->Socket);
            if (!$this->connect_errno) {
                $this->Connected = true;
                break;
            }
            sleep(1);
        }

        if ($this->connect_errno) {
            $Errno = $this->connect_errno;
            $Error = $this->connect_error;
            $this->error("Connection failed. (".strval($Errno).": ".strval($Error).")");
            $Debug->set_flag("Could not connect to Sphinx server $this->Ident. (".strval($Errno).": ".strval($Error).")");
        } else {
            $Debug->set_flag("Connected to Sphinx server $this->Ident");
        }
    }

    /**
     * Print a message to privileged users and optionally halt page processing
     *
     * @param string $Msg message to display
     * @param bool $Halt halt page processing. Default is to continue processing the page
     * @return Sphinxql object
     */
    public function error($Msg, $Halt = false)
    {
        global $Debug;
        $ErrorMsg = 'SphinxQL ('.$this->Ident.'): '.strval($Msg);
        $Debug->analysis('SphinxQL Error', $ErrorMsg, 3600*24);

        if ($Halt === true && (DEBUG_MODE || check_perms('site_debug'))) {
            echo '<pre>'.display_str($ErrorMsg).'</pre>';
            error();
        } elseif ($Halt === true) {
            error(-1);
        }
    }

    /**
     * Escape special characters before sending them to the Sphinx server.
     * Two escapes needed because the first one is eaten up by the mysql driver.
     *
     * @param string $String string to escape
     * @return escaped string
     */
    public static function sph_escape_string($String)
    {
        return strtr(
            strtolower($String),
            array(
            '('=>'\\\\(',
            ')'=>'\\\\)',
            '|'=>'\\\\|',
            '-'=>'\\\\-',
            '@'=>'\\\\@',
            '~'=>'\\\\~',
            '&'=>'\\\\&',
            '\''=>'\\\'',
            '<'=>'\\\\<',
            '!'=>'\\\\!',
            '"'=>'\\\\"',
            '/'=>'\\\\/',
            '*'=>'\\\\*',
            '$'=>'\\\\$',
            '^'=>'\\\\^',
            '\\'=>'\\\\\\\\')
        );
    }

    /**
     * Register sent queries globally for later retrieval by debug functions
     *
     * @param string $QueryString query text
     * @param param $QueryProcessTime time building and processing the query
     */
    public static function register_query($QueryString, $QueryProcessTime)
    {
        self::$Queries[] = array($QueryString, $QueryProcessTime);
        self::$Time += $QueryProcessTime;
    }
}