Fix the search engine, more or less

classes/sphinxql.class.php

@@ -1,121 +1,130 @@
-<?
+<?php
 if (!extension_loaded('mysqli')) {
-  error('Mysqli Extension not loaded.');
+    error('Mysqli Extension not loaded.');
 }
 
-class Sphinxql extends mysqli {
-  private static $Connections = [];
-  private $Server;
-  private $Port;
-  private $Socket;
-  private $Ident;
-  private $Connected = false;
+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;
+    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";
+    /**
+     * 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 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);
+    /**
+     * 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";
+        }
     }
-    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);
+    /**
+     * 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];
     }
-    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");
+
+    /**
+     * 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>';
-      die();
-    } elseif ($Halt === true) {
-      error('-1');
+    /**
+     * 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>';
+            die();
+        } 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(
+    /**
+     * 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(
       '('=>'\\\\(',
       ')'=>'\\\\)',
       '|'=>'\\\\|',
@@ -132,17 +141,18 @@ class Sphinxql extends mysqli {
       '$'=>'\\\\$',
       '^'=>'\\\\^',
       '\\'=>'\\\\\\\\')
-    );
-  }
+        );
+    }
 
-  /**
-   * 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;
-  }
+    /**
+     * 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;
+    }
 }

classes/sphinxqlquery.class.php

@@ -1,387 +1,409 @@
-<?
-class SphinxqlQuery {
-  private $Sphinxql;
+<?php
+class SphinxqlQuery
+{
+    private $Sphinxql;
+    private $Errors;
+    private $Expressions;
+    private $Filters;
+    private $GroupBy;
+    private $Indexes;
+    private $Limits;
+    private $Options;
+    private $QueryString;
+    private $Select;
+    private $SortBy;
+    private $SortGroupBy;
 
-  private $Errors;
-  private $Expressions;
-  private $Filters;
-  private $GroupBy;
-  private $Indexes;
-  private $Limits;
-  private $Options;
-  private $QueryString;
-  private $Select;
-  private $SortBy;
-  private $SortGroupBy;
-
-  /**
-   * 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 = SPHINXQL_HOST, $Port = SPHINXQL_PORT, $Socket = SPHINXQL_SOCK) {
-    $this->Sphinxql = Sphinxql::init_connection($Server, $Port, $Socket);
-    $this->reset();
-  }
-
-  /**
-   * Specify what data the Sphinx query is supposed to return
-   *
-   * @param string $Fields Attributes and expressions
-   * @return current Sphinxql query object
-   */
-  public function select($Fields) {
-    $this->Select = $Fields;
-    return $this;
-  }
+    /**
+     * 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 = SPHINXQL_HOST, $Port = SPHINXQL_PORT, $Socket = SPHINXQL_SOCK)
+    {
+        $this->Sphinxql = Sphinxql::init_connection($Server, $Port, $Socket);
+        $this->reset();
+    }
 
-  /**
-   * Specify the indexes to use in the search
-   *
-   * @param string $Indexes comma-separated list of indexes
-   * @return current Sphinxql query object
-   */
-  public function from($Indexes) {
-    $this->Indexes = $Indexes;
-    return $this;
-  }
+    /**
+     * Specify what data the Sphinx query is supposed to return
+     *
+     * @param string $Fields Attributes and expressions
+     * @return current Sphinxql query object
+     */
+    public function select($Fields)
+    {
+        $this->Select = $Fields;
+        return $this;
+    }
 
-  /**
-   * Add attribute filter. Calling multiple filter functions results in boolean AND between each condition.
-   *
-   * @param string $Attribute attribute which the filter will apply to
-   * @param mixed $Values scalar or array of numerical values. Array uses boolean OR in query condition
-   * @param bool $Exclude whether to exclude or include matching documents. Default mode is to include matches
-   * @return current Sphinxql query object
-   */
-  public function where($Attribute, $Values, $Exclude = false) {
-    if (empty($Attribute) || !isset($Values)) {
-      $this->error("Attribute name and filter value are required.");
-      return $this;
+    /**
+     * Specify the indexes to use in the search
+     *
+     * @param string $Indexes comma-separated list of indexes
+     * @return current Sphinxql query object
+     */
+    public function from($Indexes)
+    {
+        $this->Indexes = $Indexes;
+        return $this;
     }
-    $Filters = [];
-    if (is_array($Values)) {
-      foreach ($Values as $Value) {
-        if (!is_number($Value)) {
-          $this->error("Filters only support numeric values.");
-          return $this;
+
+    /**
+     * Add attribute filter. Calling multiple filter functions results in boolean AND between each condition.
+     *
+     * @param string $Attribute attribute which the filter will apply to
+     * @param mixed $Values scalar or array of numerical values. Array uses boolean OR in query condition
+     * @param bool $Exclude whether to exclude or include matching documents. Default mode is to include matches
+     * @return current Sphinxql query object
+     */
+    public function where($Attribute, $Values, $Exclude = false)
+    {
+        if (empty($Attribute) || !isset($Values)) {
+            $this->error("Attribute name and filter value are required.");
+            return $this;
         }
-      }
-      if ($Exclude) {
-        $Filters[] = "$Attribute NOT IN (".implode(",", $Values).")";
-      } else {
-        $Filters[] = "$Attribute IN (".implode(",", $Values).")";
-      }
-    } else {
-      if (!is_number($Values)) {
-        $this->error("Filters only support numeric values.");
+        $Filters = [];
+        if (is_array($Values)) {
+            foreach ($Values as $Value) {
+                if (!is_number($Value)) {
+                    $this->error("Filters only support numeric values.");
+                    return $this;
+                }
+            }
+            if ($Exclude) {
+                $Filters[] = "$Attribute NOT IN (".implode(",", $Values).")";
+            } else {
+                $Filters[] = "$Attribute IN (".implode(",", $Values).")";
+            }
+        } else {
+            if (!is_number($Values)) {
+                $this->error("Filters only support numeric values.");
+                return $this;
+            }
+            if ($Exclude) {
+                $Filters[] = "$Attribute != $Values";
+            } else {
+                $Filters[] = "$Attribute = $Values";
+            }
+        }
+        $this->Filters[] = implode(" AND ", $Filters);
         return $this;
-      }
-      if ($Exclude) {
-        $Filters[] = "$Attribute != $Values";
-      } else {
-        $Filters[] = "$Attribute = $Values";
-      }
     }
-    $this->Filters[] = implode(" AND ", $Filters);
-    return $this;
-  }
 
-  /**
-   * Add attribute less-than filter. Calling multiple filter functions results in boolean AND between each condition.
-   *
-   * @param string $Attribute attribute which the filter will apply to
-   * @param array $Value upper limit for matches
-   * @param bool $Inclusive whether to use <= or <
-   * @return current Sphinxql query object
-   */
-  public function where_lt($Attribute, $Value, $Inclusive = false) {
-    if (empty($Attribute) || !isset($Value) || !is_number($Value)) {
-      $this->error("Attribute name is required and only numeric filters are supported.");
-      return $this;
+    /**
+     * Add attribute less-than filter. Calling multiple filter functions results in boolean AND between each condition.
+     *
+     * @param string $Attribute attribute which the filter will apply to
+     * @param array $Value upper limit for matches
+     * @param bool $Inclusive whether to use <= or <
+     * @return current Sphinxql query object
+     */
+    public function where_lt($Attribute, $Value, $Inclusive = false)
+    {
+        if (empty($Attribute) || !isset($Value) || !is_number($Value)) {
+            $this->error("Attribute name is required and only numeric filters are supported.");
+            return $this;
+        }
+        $this->Filters[] = $Inclusive ? "$Attribute <= $Value" : "$Attribute < $Value";
+        return $this;
     }
-    $this->Filters[] = $Inclusive ? "$Attribute <= $Value" : "$Attribute < $Value";
-    return $this;
-  }
 
-  /**
-   * Add attribute greater-than filter. Calling multiple filter functions results in boolean AND between each condition.
-   *
-   * @param string $Attribute attribute which the filter will apply to
-   * @param array $Value lower limit for matches
-   * @param bool $Inclusive whether to use >= or >
-   * @return current Sphinxql query object
-   */
-  public function where_gt($Attribute, $Value, $Inclusive = false) {
-    if (empty($Attribute) || !isset($Value) || !is_number($Value)) {
-      $this->error("Attribute name is required and only numeric filters are supported.");
-      return $this;
+    /**
+     * Add attribute greater-than filter. Calling multiple filter functions results in boolean AND between each condition.
+     *
+     * @param string $Attribute attribute which the filter will apply to
+     * @param array $Value lower limit for matches
+     * @param bool $Inclusive whether to use >= or >
+     * @return current Sphinxql query object
+     */
+    public function where_gt($Attribute, $Value, $Inclusive = false)
+    {
+        if (empty($Attribute) || !isset($Value) || !is_number($Value)) {
+            $this->error("Attribute name is required and only numeric filters are supported.");
+            return $this;
+        }
+        $this->Filters[] = $Inclusive ? "$Attribute >= $Value" : "$Attribute > $Value";
+        return $this;
     }
-    $this->Filters[] = $Inclusive ? "$Attribute >= $Value" : "$Attribute > $Value";
-    return $this;
-  }
 
-  /**
-   * Add attribute range filter. Calling multiple filter functions results in boolean AND between each condition.
-   *
-   * @param string $Attribute attribute which the filter will apply to
-   * @param array $Values pair of numerical values that defines the filter range
-   * @return current Sphinxql query object
-   */
-  public function where_between($Attribute, $Values) {
-    if (empty($Attribute) || empty($Values) || count($Values) != 2 || !is_number($Values[0]) || !is_number($Values[1])) {
-      $this->error("Filter range requires array of two numerical boundaries as values.");
-      return $this;
+    /**
+     * Add attribute range filter. Calling multiple filter functions results in boolean AND between each condition.
+     *
+     * @param string $Attribute attribute which the filter will apply to
+     * @param array $Values pair of numerical values that defines the filter range
+     * @return current Sphinxql query object
+     */
+    public function where_between($Attribute, $Values)
+    {
+        if (empty($Attribute) || empty($Values) || count($Values) != 2 || !is_number($Values[0]) || !is_number($Values[1])) {
+            $this->error("Filter range requires array of two numerical boundaries as values.");
+            return $this;
+        }
+        $this->Filters[] = "$Attribute BETWEEN $Values[0] AND $Values[1]";
+        return $this;
     }
-    $this->Filters[] = "$Attribute BETWEEN $Values[0] AND $Values[1]";
-    return $this;
-  }
 
-  /**
-   * Add fulltext query expression. Calling multiple filter functions results in boolean AND between each condition.
-   * Query expression is escaped automatically
-   *
-   * @param string $Expr query expression
-   * @param string $Field field to match $Expr against. Default is *, which means all available fields
-   * @return current Sphinxql query object
-   */
-  public function where_match($Expr, $Field = '*', $Escape = true) {
-    if (empty($Expr)) {
-      return $this;
-    }
-    if ($Field !== false) {
-      $Field = "@$Field ";
-    }
-    if ($Escape === true) {
-      $this->Expressions[] = "$Field".Sphinxql::sph_escape_string($Expr);
-    } else {
-      $this->Expressions[] = $Field.$Expr;
+    /**
+     * Add fulltext query expression. Calling multiple filter functions results in boolean AND between each condition.
+     * Query expression is escaped automatically
+     *
+     * @param string $Expr query expression
+     * @param string $Field field to match $Expr against. Default is *, which means all available fields
+     * @return current Sphinxql query object
+     */
+    public function where_match($Expr, $Field = '*', $Escape = true)
+    {
+        if (empty($Expr)) {
+            return $this;
+        }
+        if ($Field !== false) {
+            $Field = "@$Field ";
+        }
+        if ($Escape === true) {
+            $this->Expressions[] = "$Field".Sphinxql::sph_escape_string($Expr);
+        } else {
+            $this->Expressions[] = $Field.$Expr;
+        }
+        return $this;
     }
-    return $this;
-  }
 
-  /**
-   * Specify the order of the matches. Calling this function multiple times sets secondary priorities
-   *
-   * @param string $Attribute attribute to use for sorting.
-   *     Passing an empty attribute value will clear the current sort settings
-   * @param string $Mode sort method to apply to the selected attribute
-   * @return current Sphinxql query object
-   */
-  public function order_by($Attribute = false, $Mode = false) {
-    if (empty($Attribute)) {
-      $this->SortBy = [];
-    } else {
-      $this->SortBy[] = "$Attribute $Mode";
+    /**
+     * Specify the order of the matches. Calling this function multiple times sets secondary priorities
+     *
+     * @param string $Attribute attribute to use for sorting.
+     *     Passing an empty attribute value will clear the current sort settings
+     * @param string $Mode sort method to apply to the selected attribute
+     * @return current Sphinxql query object
+     */
+    public function order_by($Attribute = false, $Mode = false)
+    {
+        if (empty($Attribute)) {
+            $this->SortBy = [];
+        } else {
+            $this->SortBy[] = "$Attribute $Mode";
+        }
+        return $this;
     }
-    return $this;
-  }
 
-  /**
-   * Specify how the results are grouped
-   *
-   * @param string $Attribute group matches with the same $Attribute value.
-   *     Passing an empty attribute value will clear the current group settings
-   * @return current Sphinxql query object
-   */
-  public function group_by($Attribute = false) {
-    if (empty($Attribute)) {
-      $this->GroupBy = '';
-    } else {
-      $this->GroupBy = $Attribute;
+    /**
+     * Specify how the results are grouped
+     *
+     * @param string $Attribute group matches with the same $Attribute value.
+     *     Passing an empty attribute value will clear the current group settings
+     * @return current Sphinxql query object
+     */
+    public function group_by($Attribute = false)
+    {
+        if (empty($Attribute)) {
+            $this->GroupBy = '';
+        } else {
+            $this->GroupBy = $Attribute;
+        }
+        return $this;
     }
-    return $this;
-  }
 
-  /**
-   * Specify the order of the results within groups
-   *
-   * @param string $Attribute attribute to use for sorting.
-   *     Passing an empty attribute will clear the current group sort settings
-   * @param string $Mode sort method to apply to the selected attribute
-   * @return current Sphinxql query object
-   */
-  public function order_group_by($Attribute = false, $Mode = false) {
-    if (empty($Attribute)) {
-      $this->SortGroupBy = '';
-    } else {
-      $this->SortGroupBy = "$Attribute $Mode";
+    /**
+     * Specify the order of the results within groups
+     *
+     * @param string $Attribute attribute to use for sorting.
+     *     Passing an empty attribute will clear the current group sort settings
+     * @param string $Mode sort method to apply to the selected attribute
+     * @return current Sphinxql query object
+     */
+    public function order_group_by($Attribute = false, $Mode = false)
+    {
+        if (empty($Attribute)) {
+            $this->SortGroupBy = '';
+        } else {
+            $this->SortGroupBy = "$Attribute $Mode";
+        }
+        return $this;
     }
-    return $this;
-  }
-
-  /**
-   * Specify the offset and amount of matches to return
-   *
-   * @param int $Offset number of matches to discard
-   * @param int $Limit number of matches to return
-   * @param int $MaxMatches number of results to store in the Sphinx server's memory. Must be >= ($Offset+$Limit)
-   * @return current Sphinxql query object
-   */
-  public function limit($Offset, $Limit, $MaxMatches = SPHINX_MAX_MATCHES) {
-    $this->Limits = "$Offset, $Limit";
-    $this->set('max_matches', $MaxMatches);
-    return $this;
-  }
-
-  /**
-   * Tweak the settings to use for the query. Sanity checking shouldn't be needed as Sphinx already does it
-   *
-   * @param string $Name setting name
-   * @param mixed $Value value
-   * @return current Sphinxql query object
-   */
-  public function set($Name, $Value) {
-    $this->Options[$Name] = $Value;
-    return $this;
-  }
 
-  /**
-   * Combine the query options into a valid Sphinx query segment
-   *
-   * @return string of options
-   */
-  private function build_options() {
-    $Options = [];
-    foreach ($this->Options as $Option => $Value) {
-      $Options[] = "$Option = $Value";
+    /**
+     * Specify the offset and amount of matches to return
+     *
+     * @param int $Offset number of matches to discard
+     * @param int $Limit number of matches to return
+     * @param int $MaxMatches number of results to store in the Sphinx server's memory. Must be >= ($Offset+$Limit)
+     * @return current Sphinxql query object
+     */
+    public function limit($Offset, $Limit, $MaxMatches = SPHINX_MAX_MATCHES)
+    {
+        $this->Limits = "$Offset, $Limit";
+        $this->set('max_matches', $MaxMatches);
+        return $this;
     }
-    return implode(', ', $Options);
-  }
 
-  /**
-   * Combine the query conditions into a valid Sphinx query segment
-   */
-  private function build_query() {
-    if (!$this->Indexes) {
-      $this->error('Index name is required.');
-      return false;
-    }
-    $this->QueryString = "SELECT $this->Select\nFROM $this->Indexes";
-    if (!empty($this->Expressions)) {
-      $this->Filters['expr'] = "MATCH('".implode(' ', $this->Expressions)."')";
-    }
-    if (!empty($this->Filters)) {
-      $this->QueryString .= "\nWHERE ".implode("\n\tAND ", $this->Filters);
-    }
-    if (!empty($this->GroupBy)) {
-      $this->QueryString .= "\nGROUP BY $this->GroupBy";
-    }
-    if (!empty($this->SortGroupBy)) {
-      $this->QueryString .= "\nWITHIN GROUP ORDER BY $this->SortGroupBy";
-    }
-    if (!empty($this->SortBy)) {
-      $this->QueryString .= "\nORDER BY ".implode(", ", $this->SortBy);
-    }
-    if (!empty($this->Limits)) {
-      $this->QueryString .= "\nLIMIT $this->Limits";
+    /**
+     * Tweak the settings to use for the query. Sanity checking shouldn't be needed as Sphinx already does it
+     *
+     * @param string $Name setting name
+     * @param mixed $Value value
+     * @return current Sphinxql query object
+     */
+    public function set($Name, $Value)
+    {
+        $this->Options[$Name] = $Value;
+        return $this;
     }
-    if (!empty($this->Options)) {
-      $Options = $this->build_options();
-      $this->QueryString .= "\nOPTION $Options";
+
+    /**
+     * Combine the query options into a valid Sphinx query segment
+     *
+     * @return string of options
+     */
+    private function build_options()
+    {
+        $Options = [];
+        foreach ($this->Options as $Option => $Value) {
+            $Options[] = "$Option = $Value";
+        }
+        return implode(', ', $Options);
     }
-  }
 
-  /**
-   * Construct and send the query. Register the query in the global Sphinxql object
-   *
-   * @param bool GetMeta whether to fetch meta data for the executed query. Default is yes
-   * @return Sphinxql result object
-   */
-  public function query($GetMeta = true) {
-    $QueryStartTime = microtime(true);
-    $this->build_query();
-    if (count($this->Errors) > 0) {
-      $ErrorMsg = implode("\n", $this->Errors);
-      $this->Sphinxql->error("Query builder found errors:\n$ErrorMsg");
-      return new SphinxqlResult(null, null, 1, $ErrorMsg);
+    /**
+     * Combine the query conditions into a valid Sphinx query segment
+     */
+    private function build_query()
+    {
+        if (!$this->Indexes) {
+            $this->error('Index name is required.');
+            return false;
+        }
+        $this->QueryString = "SELECT $this->Select\nFROM $this->Indexes";
+        if (!empty($this->Expressions)) {
+            $this->Filters['expr'] = "MATCH('".implode(' ', $this->Expressions)."')";
+        }
+        if (!empty($this->Filters)) {
+            $this->QueryString .= "\nWHERE ".implode("\n\tAND ", $this->Filters);
+        }
+        if (!empty($this->GroupBy)) {
+            $this->QueryString .= "\nGROUP BY $this->GroupBy";
+        }
+        if (!empty($this->SortGroupBy)) {
+            $this->QueryString .= "\nWITHIN GROUP ORDER BY $this->SortGroupBy";
+        }
+        if (!empty($this->SortBy)) {
+            $this->QueryString .= "\nORDER BY ".implode(", ", $this->SortBy);
+        }
+        if (!empty($this->Limits)) {
+            $this->QueryString .= "\nLIMIT $this->Limits";
+        }
+        if (!empty($this->Options)) {
+            $Options = $this->build_options();
+            $this->QueryString .= "\nOPTION $Options";
+        }
     }
-    $QueryString = $this->QueryString;
-    $Result = $this->send_query($GetMeta);
-    $QueryProcessTime = (microtime(true) - $QueryStartTime)*1000;
-    Sphinxql::register_query($QueryString, $QueryProcessTime);
-    return $Result;
-  }
 
-  /**
-   * Run a manually constructed query
-   *
-   * @param string Query query expression
-   * @param bool GetMeta whether to fetch meta data for the executed query. Default is yes
-   * @return Sphinxql result object
-   */
-  public function raw_query($Query, $GetMeta = true) {
-    $this->QueryString = $Query;
-    return $this->send_query($GetMeta);
-  }
+    /**
+     * Construct and send the query. Register the query in the global Sphinxql object
+     *
+     * @param bool GetMeta whether to fetch meta data for the executed query. Default is yes
+     * @return Sphinxql result object
+     */
+    public function query($GetMeta = true)
+    {
+        $QueryStartTime = microtime(true);
+        $this->build_query();
+        if (count($this->Errors) > 0) {
+            $ErrorMsg = implode("\n", $this->Errors);
+            $this->Sphinxql->error("Query builder found errors:\n$ErrorMsg");
+            return new SphinxqlResult(null, null, 1, $ErrorMsg);
+        }
+        $QueryString = $this->QueryString;
+        $Result = $this->send_query($GetMeta);
+        $QueryProcessTime = (microtime(true) - $QueryStartTime)*1000;
+        Sphinxql::register_query($QueryString, $QueryProcessTime);
+        return $Result;
+    }
 
-  /**
-   * Run a pre-processed query. Only used internally
-   *
-   * @param bool GetMeta whether to fetch meta data for the executed query
-   * @return Sphinxql result object
-   */
-  private function send_query($GetMeta) {
-    if (!$this->QueryString) {
-      return false;
+    /**
+     * Run a manually constructed query
+     *
+     * @param string Query query expression
+     * @param bool GetMeta whether to fetch meta data for the executed query. Default is yes
+     * @return Sphinxql result object
+     */
+    public function raw_query($Query, $GetMeta = true)
+    {
+        $this->QueryString = $Query;
+        return $this->send_query($GetMeta);
     }
-    $this->Sphinxql->sph_connect();
-    $Result = $this->Sphinxql->query($this->QueryString);
-    if ($Result === false) {
-      $Errno = $this->Sphinxql->errno;
-      $Error = $this->Sphinxql->error;
-      $this->Sphinxql->error("Query returned error $Errno ($Error).\n$this->QueryString");
-      $Meta = null;
-    } else {
-      $Errno = 0;
-      $Error = '';
-      $Meta = $GetMeta ? $this->get_meta() : null;
+
+    /**
+     * Run a pre-processed query. Only used internally
+     *
+     * @param bool GetMeta whether to fetch meta data for the executed query
+     * @return Sphinxql result object
+     */
+    private function send_query($GetMeta)
+    {
+        if (!$this->QueryString) {
+            return false;
+        }
+        $this->Sphinxql->sph_connect();
+        $Result = $this->Sphinxql->query($this->QueryString);
+        if ($Result === false) {
+            $Errno = $this->Sphinxql->errno;
+            $Error = $this->Sphinxql->error;
+            $this->Sphinxql->error("Query returned error $Errno ($Error).\n$this->QueryString");
+            $Meta = null;
+        } else {
+            $Errno = 0;
+            $Error = '';
+            $Meta = $GetMeta ? $this->get_meta() : null;
+        }
+        return new SphinxqlResult($Result, $Meta, $Errno, $Error);
     }
-    return new SphinxqlResult($Result, $Meta, $Errno, $Error);
-  }
 
-  /**
-   * Reset all query options and conditions
-   */
-  public function reset() {
-    $this->Errors = [];
-    $this->Expressions = [];
-    $this->Filters = [];
-    $this->GroupBy = '';
-    $this->Indexes = '';
-    $this->Limits = [];
-    $this->Options = array('ranker' => 'none');
-    $this->QueryString = '';
-    $this->Select = '*';
-    $this->SortBy = [];
-    $this->SortGroupBy = '';
-  }
+    /**
+     * Reset all query options and conditions
+     */
+    public function reset()
+    {
+        $this->Errors = [];
+        $this->Expressions = [];
+        $this->Filters = [];
+        $this->GroupBy = '';
+        $this->Indexes = '';
+        $this->Limits = [];
+        $this->Options = array('ranker' => 'none');
+        $this->QueryString = '';
+        $this->Select = '*';
+        $this->SortBy = [];
+        $this->SortGroupBy = '';
+    }
 
-  /**
-   * Fetch and store meta data for the last executed query
-   *
-   * @return meta data
-   */
-  private function get_meta() {
-    return $this->raw_query("SHOW META", false)->to_pair(0, 1);
-  }
+    /**
+     * Fetch and store meta data for the last executed query
+     *
+     * @return meta data
+     */
+    private function get_meta()
+    {
+        return $this->raw_query("SHOW META", false)->to_pair(0, 1);
+    }
 
-  /**
-   * Copy attribute filters from another SphinxqlQuery object
-   *
-   * @param SphinxqlQuery $SphQLSource object to copy the filters from
-   * @return current SphinxqlQuery object
-   */
-  public function copy_attributes_from($SphQLSource) {
-    $this->Filters = $SphQLSource->Filters;
-  }
+    /**
+     * Copy attribute filters from another SphinxqlQuery object
+     *
+     * @param SphinxqlQuery $SphQLSource object to copy the filters from
+     * @return current SphinxqlQuery object
+     */
+    public function copy_attributes_from($SphQLSource)
+    {
+        $this->Filters = $SphQLSource->Filters;
+    }
 
-  /**
-   * Store error messages
-   */
-  private function error($Msg) {
-    $this->Errors[] = $Msg;
-  }
+    /**
+     * Store error messages
+     */
+    private function error($Msg)
+    {
+        $this->Errors[] = $Msg;
+    }
 }

classes/sphinxqlresult.class.php

@@ -1,143 +1,152 @@
-<?
-class SphinxqlResult {
-  private $Result;
-  private $Meta;
-  public $Errno;
-  public $Error;
+<?php
+class SphinxqlResult
+{
+    private $Result;
+    private $Meta;
+    public $Errno;
+    public $Error;
 
-  /**
-   * Create Sphinxql result object
-   *
-   * @param mysqli_result $Result query results
-   * @param array $Meta meta data for the query
-   * @param int $Errno error code returned by the query upon failure
-   * @param string $Error error message returned by the query upon failure
-   */
-  public function __construct($Result, $Meta, $Errno, $Error) {
-    $this->Result = $Result;
-    $this->Meta = $Meta;
-    $this->Errno = $Errno;
-    $this->Error = $Error;
-  }
-
-  /**
-   * Redirect to the Mysqli result object if a nonexistent method is called
-   *
-   * @param string $Name method name
-   * @param array $Arguments arguments used in the function call
-   * @return whatever the parent function returns
-   */
-  public function __call($Name, $Arguments) {
-    return call_user_func_array(array($this->Result, $Name), $Arguments);
-  }
-
-  /**
-   * Did the query find anything?
-   *
-   * @return bool results were found
-   */
-  public function has_results() {
-    return $this->get_meta('total') > 0;
-  }
+    /**
+     * Create Sphinxql result object
+     *
+     * @param mysqli_result $Result query results
+     * @param array $Meta meta data for the query
+     * @param int $Errno error code returned by the query upon failure
+     * @param string $Error error message returned by the query upon failure
+     */
+    public function __construct($Result, $Meta, $Errno, $Error)
+    {
+        $this->Result = $Result;
+        $this->Meta = $Meta;
+        $this->Errno = $Errno;
+        $this->Error = $Error;
+    }
 
-  /**
-   * Collect and return the specified key of all results as a list
-   *
-   * @param string $Key key containing the desired data
-   * @return array with the $Key value of all results
-   */
-  public function collect($Key) {
-    $Return = [];
-    while ($Row = $this->fetch_array()) {
-      $Return[] = $Row[$Key];
+    /**
+     * Redirect to the Mysqli result object if a nonexistent method is called
+     *
+     * @param string $Name method name
+     * @param array $Arguments arguments used in the function call
+     * @return whatever the parent function returns
+     */
+    public function __call($Name, $Arguments)
+    {
+        return call_user_func_array(array($this->Result, $Name), $Arguments);
     }
-    $this->data_seek(0);
-    return $Return;
-  }
 
-  /**
-   * Collect and return all available data for the matches optionally indexed by a specified key
-   *
-   * @param string $Key key to use as indexing value
-   * @param string $ResultType method to use when fetching data from the mysqli_result object. Default is MYSQLI_ASSOC
-   * @return array with all available data for the matches
-   */
-  public function to_array($Key, $ResultType = MYSQLI_ASSOC) {
-    $Return = [];
-    while ($Row = $this->fetch_array($ResultType)) {
-      if ($Key !== false) {
-        $Return[$Row[$Key]] = $Row;
-      } else {
-        $Return[] = $Row;
-      }
+    /**
+     * Did the query find anything?
+     *
+     * @return bool results were found
+     */
+    public function has_results()
+    {
+        return $this->get_meta('total') > 0;
     }
-    $this->data_seek(0);
-    return $Return;
-  }
 
-  /**
-   * Collect pairs of keys for all matches
-   *
-   * @param string $Key1 key to use as indexing value
-   * @param string $Key2 key to use as value
-   * @return array with $Key1 => $Key2 pairs for matches
-   */
-  public function to_pair($Key1, $Key2) {
-    $Return = [];
-    while ($Row = $this->fetch_array()) {
-      $Return[$Row[$Key1]] = $Row[$Key2];
+    /**
+     * Collect and return the specified key of all results as a list
+     *
+     * @param string $Key key containing the desired data
+     * @return array with the $Key value of all results
+     */
+    public function collect($Key)
+    {
+        $Return = [];
+        while ($Row = $this->fetch_array()) {
+            $Return[] = $Row[$Key];
+        }
+        $this->data_seek(0);
+        return $Return;
     }
-    $this->data_seek(0);
-    return $Return;
-  }
 
-  /**
-   * Return specified portions of the current Sphinxql result object's meta data
-   *
-   * @param mixed $Keys scalar or array with keys to return. Default is false, which returns all meta data
-   * @return array with meta data
-   */
-  public function get_meta($Keys = false) {
-    if ($Keys !== false) {
-      if (is_array($Keys)) {
+    /**
+     * Collect and return all available data for the matches optionally indexed by a specified key
+     *
+     * @param string $Key key to use as indexing value
+     * @param string $ResultType method to use when fetching data from the mysqli_result object. Default is MYSQLI_ASSOC
+     * @return array with all available data for the matches
+     */
+    public function to_array($Key, $ResultType = MYSQLI_ASSOC)
+    {
         $Return = [];
-        foreach ($Keys as $Key) {
-          if (!isset($this->Meta[$Key])) {
-            continue;
-          }
-          $Return[$Key] = $this->Meta[$Key];
+        while ($Row = $this->fetch_array($ResultType)) {
+            if ($Key !== false) {
+                $Return[$Row[$Key]] = $Row;
+            } else {
+                $Return[] = $Row;
+            }
         }
+        $this->data_seek(0);
         return $Return;
-      } else {
-        return isset($this->Meta[$Keys]) ? $this->Meta[$Keys] : false;
-      }
-    } else {
-      return $this->Meta;
     }
-  }
 
-  /**
-   * Return specified portions of the current Mysqli result object's information
-   *
-   * @param mixed $Keys scalar or array with keys to return. Default is false, which returns all available information
-   * @return array with result information
-   */
-  public function get_result_info($Keys = false) {
-    if ($Keys !== false) {
-      if (is_array($Keys)) {
+    /**
+     * Collect pairs of keys for all matches
+     *
+     * @param string $Key1 key to use as indexing value
+     * @param string $Key2 key to use as value
+     * @return array with $Key1 => $Key2 pairs for matches
+     */
+    public function to_pair($Key1, $Key2)
+    {
         $Return = [];
-        foreach ($Keys as $Key) {
-          if (!isset($this->Result->$Key)) {
-            continue;
-          }
-          $Return[$Key] = $this->Result->$Key;
+        while ($Row = $this->fetch_array()) {
+            $Return[$Row[$Key1]] = $Row[$Key2];
         }
+        $this->data_seek(0);
         return $Return;
-      } else {
-        return isset($this->Result->$Keys) ? $this->Result->$Keys : false;
-      }
-    } else {
-      return $this->Result;
     }
-  }
+
+    /**
+     * Return specified portions of the current Sphinxql result object's meta data
+     *
+     * @param mixed $Keys scalar or array with keys to return. Default is false, which returns all meta data
+     * @return array with meta data
+     */
+    public function get_meta($Keys = false)
+    {
+        if ($Keys !== false) {
+            if (is_array($Keys)) {
+                $Return = [];
+                foreach ($Keys as $Key) {
+                    if (!isset($this->Meta[$Key])) {
+                        continue;
+                    }
+                    $Return[$Key] = $this->Meta[$Key];
+                }
+                return $Return;
+            } else {
+                return isset($this->Meta[$Keys]) ? $this->Meta[$Keys] : false;
+            }
+        } else {
+            return $this->Meta;
+        }
+    }
+
+    /**
+     * Return specified portions of the current Mysqli result object's information
+     *
+     * @param mixed $Keys scalar or array with keys to return. Default is false, which returns all available information
+     * @return array with result information
+     */
+    public function get_result_info($Keys = false)
+    {
+        if ($Keys !== false) {
+            if (is_array($Keys)) {
+                $Return = [];
+                foreach ($Keys as $Key) {
+                    if (!isset($this->Result->$Key)) {
+                        continue;
+                    }
+                    $Return[$Key] = $this->Result->$Key;
+                }
+                return $Return;
+            } else {
+                return isset($this->Result->$Keys) ? $this->Result->$Keys : false;
+            }
+        } else {
+            return $this->Result;
+        }
+    }
 }

classes/torrentsearch.class.php

@@ -51,25 +51,25 @@ class TorrentSearch
     // List of fields that can be used for fulltext searches
     private static $Fields = [
     'artistname' => 1,
-    'audioformat' => 1,
+    #'audioformat' => 1,
     'cataloguenumber' => 1,
     'codec' => 1,
     'container' => 1,
     'description' => 1,
-    'dlsiteid' => 1,
+    #'dlsiteid' => 1,
     'filelist' => 1,
     'groupname' => 1,
     'groupnamerj' => 1,
     'groupnamejp' => 1,
     'advgroupname' => 1,
-    'language' => 1,
+    #'language' => 1,
     'media' => 1,
     'resolution' => 1,
     'searchstr' => 1,
     'series' => 1,
     'studio' => 1,
-    'subber' => 1,
-    'subbing' => 1,
+    #'subber' => 1,
+    #'subbing' => 1,
     'taglist' => 1
   ];
 
@@ -86,8 +86,11 @@ class TorrentSearch
 
     // Some form field names don't match the ones in the index
     private static $FormsToFields = [
-    'searchstr' => '(groupname,groupnamerj,groupnamejp,artistname,studio,series,dlsiteid,cataloguenumber,yearfulltext)',
-    'advgroupname' => '(groupname,groupnamerj,groupnamejp)'
+        # todo: Make these filters significantly less broad
+        'searchstr' => '*',
+        'advgroupname' => '*'
+        #'searchstr' => '(groupname,groupnamerj,groupnamejp,artistname,studio,series,dlsiteid,cataloguenumber,yearfulltext)',
+        #'advgroupname' => '(groupname,groupnamerj,groupnamejp)'
   ];
 
     // Specify the operator type to use for fields. Empty key sets the default
@@ -201,7 +204,7 @@ class TorrentSearch
         }
         $Offset = ($this->Page - 1) * $ResultLimit;
         $MinMax = G::$Cache->get_value('sphinx_min_max_matches');
-        $MaxMatches = max($Offset + $ResultLimit, $MinMax ? $MinMax : 2000);
+        $MaxMatches = max($Offset + $ResultLimit, $MinMax ? $MinMax : 1000); # todo: Keep an eye on this
         $this->SphQL->from('torrents, delta')
       ->limit($Offset, $ResultLimit, $MaxMatches);
     }

design/publicheader.php

@@ -29,7 +29,7 @@ define('FOOTER_FILE', SERVER_ROOT.'/design/publicfooter.php');
 </head>
 <body>
 <div id="head"><span>
-<a href="login.php">Log in</a>
+<a href="login.php">Log In</a>
 <?php if (OPEN_REGISTRATION) { ?>
  | <a href="register.php">Register</a>
 <?php } ?>

sections/donate/donate.php

@@ -20,14 +20,19 @@ View::show_header('Donate');
   <span class="donation_info_title">Why donate?</span>
   <div class="box pad donation_info">
     <p>
-      <?= SITE_NAME ?> has no advertisements, is not sponsored, and provides its services free of charge.
-      For these reasons, <?= SITE_NAME ?>'s financial obligations can only be met with the help of voluntary user donations.
-      Supporting <?= SITE_NAME ?> is and will always remain voluntary.
-      If you are financially able, please help pay <?= SITE_NAME ?>'s bills by donating.
+      <?= SITE_NAME ?> has no advertisements, is not sponsored, and
+      provides its services free of charge.
+      For these reasons, <?= SITE_NAME ?>'s financial obligations can
+      only be met with the help of voluntary user donations.
+      Supporting <?= SITE_NAME ?> is and will always remain
+      voluntary.
+      If you are financially able, please help pay <?= SITE_NAME ?>'s
+      bills by donating.
     </p>
 
     <p>
-      <?= SITE_NAME ?> uses all voluntary donations to cover the costs of running the site, tracker, and IRC network.
+      <?= SITE_NAME ?> uses all voluntary donations to cover the
+      costs of running the site, tracker, and IRC network.
       These costs represent the hardware the site runs on (e.g., servers, upgrades, fixes),
       and recurring operating expenses (e.g., hosting, bandwidth, power).
     </p>
@@ -42,18 +47,22 @@ View::show_header('Donate');
   <span class="donation_info_title">What you will receive for donating</span>
   <div class="box pad donation_info">
     <p>
-      Please see <a href="https://www.patreon.com/biotorrents" target="_blank"><?= SITE_NAME ?>'s Patreon</a> for a detailed overview of funding goals.
+      Please see <a href="https://www.patreon.com/biotorrents" target="_blank"><?= SITE_NAME ?>'s Patreon</a> for a detailed overview of funding
+      goals.
       There are some benefits to donating that culmulate at each tier pledged.
       Each tier's awards include those already listed.
       Bitcoin donations are privately negotiable.
 
       <ul>
-        <li><strong>Bronze:</strong> A donor badge and forum access for your user account on the BioTorrents.de website</li>
+        <li><strong>Bronze:</strong> A donor badge and forum access for your user account on the BioTorrents.de website
+        </li>
         <li><strong>Silver:</strong> Unlimited API calls to the BioTorrents.de database</li>
         <li><strong>Gold:</strong> Monthly Skype calls to discuss wetlab and software ideas.
           My expertise includes fungal biotechnology, nonprofit administration, and LEMP development</li>
-        <li><strong>Sponsor a Seedbox:</strong> Shell access to, and share ratio credit from, a seedbox that I manage on your behalf.
-          Please understand that network services beyond the scope of seedbox administration should be negotiated separately</li>
+        <li><strong>Sponsor a Seedbox:</strong> Shell access to, and share ratio credit from, a seedbox that I manage on
+          your behalf.
+          Please understand that network services beyond the scope of seedbox administration should be negotiated
+          separately</li>
       </ul>
 
       <!-- Any donation or contribution option listed above gives you the opportunity to receive Donor Points.
@@ -72,12 +81,13 @@ View::show_header('Donate');
       <li>Absolutely nothing else</li>
     </ul> -->
 
-    <p>
-      Be reminded that when you make a donation, you aren't "purchasing" Donor Ranks, invites, or any <?= SITE_NAME ?>-specific benefit.
-      When donating, you are helping <?= SITE_NAME ?> pay its bills, and your donation should be made in this spirit.
-      The <?= SITE_NAME ?> Staff does its best to recognize <?= SITE_NAME ?>'s financial supporters in a fair and fun way,
-      but all Donor Perks are subject to change or cancellation at any time, without notice.
-    </p>
+      <p>
+        Be reminded that when you make a donation, you aren't "purchasing" Donor Ranks, invites, or any <?= SITE_NAME ?>-specific benefit.
+        When donating, you are helping <?= SITE_NAME ?> pay its
+        bills, and your donation should be made in this spirit.
+        The <?= SITE_NAME ?> staff does its best to recognize <?= SITE_NAME ?>'s financial supporters in a fair and fun way,
+        but all Donor Perks are subject to change or cancellation at any time, without notice.
+      </p>
   </div>
 
   <span class="donation_info_title">What you won't receive for donating</span>

sections/login/login.php

@@ -51,7 +51,7 @@ if (!$Banned) {
     </tr>
     <tr>
       <td colspan="2">
-        <input type="submit" name="login" value="Log in" class="submit" />
+        <input type="submit" name="login" value="Log In" class="submit" />
       </td>
     </tr>
   </table>