Changeset 22670

Timestamp:

10/01/09 08:26:18 (4 years ago)

Author:

garak

Message:

[sfSphinxPluginsfSphinxPlugin] updated main lib class to Sphinx 0.9.9-rc2

Files:

• plugins/sfSphinxPlugin/trunk/lib/sfSphinxClient.class.php (modified) (40 diffs)

plugins/sfSphinxPlugin/trunk/lib/sfSphinxClient.class.php

@@ -26 +26 @@
-  const SEARCHD_COMMAND_UPDATE   = 2;
-  const SEARCHD_COMMAND_KEYWORDS = 3;
+  const SEARCHD_COMMAND_PERSIST  = 4;
+  const SEARCHD_COMMAND_STATUS   = 5;
+  const SEARCHD_COMMAND_QUERY    = 6;
-
-  // current client-side command implementation versions
-3
+6
-  const VER_COMMAND_EXCERPT  = 0x100;
-1
+2
-  const VER_COMMAND_KEYWORDS = 0x100;
+  const VER_COMMAND_STATUS   = 0x100;
+  const VER_COMMAND_QUERY    = 0x100;
-
-  // known searchd status codes
@@ -54 +59 @@
-  const SPH_RANK_WORDCOUNT      = 3; // simple word-count weighting, rank is a weighted sum of
-                                     //  per-field keyword occurence counts
+  const SPH_RANK_PROXIMITY      = 4;
+  const SPH_RANK_MATCHANY       = 5;
+  const SPH_RANK_FIELDMASK      = 6;
+
-  // known sort modes
-  const SPH_SORT_RELEVANCE     = 0;
@@ -73 +82 @@
-  const SPH_ATTR_BOOL      = 4;
-  const SPH_ATTR_FLOAT     = 5;
+  const SPH_ATTR_BIGINT    = 6;
-  const SPH_ATTR_MULTI     = 0x40000000;
-
@@ -110 +120 @@
-  protected $maxquerytime;  // max query time, milliseconds (default is 0, do not limit)
-  protected $fieldweights;  // per-field-name weights
+  protected $overrides;     // per-query attribute values overrides
+  protected $select;        // select-list (attributes or expressions, with optional aliases)
-  protected $mbenc;         // stored mbstring encoding
-  protected $arrayresult;   // whether $result['matches'] should be a hash or an array
@@ -116 +128 @@
-  private   $error;         // last error message
-  private   $warning;       // last warning message
+  private   $conerror;      // connection error vs remote error flag
-  private   $res;           // result from RunQueries()
-
@@ -127 +140 @@
-      'host'          => 'localhost',
-      'port'          => 3312,
+      'path'          => false,
+      'socket'        => false,
-      'offset'        => 0,
-      'limit'         => 20,
@@ -149 +164 @@
-      'maxquerytime'  => 0,
-      'fieldweights'  => array(),
+      'overrides'     => array(),
+      'select'        => '*',
-      'mbenc'         => '',
-      'arrayresult'   => true,
-      'timeout'       => 0,
-   
+
-    $available_options = array_keys($default_options);
-    $new_options = array_merge($default_options, $options);
@@ -162 +179 @@
-      }
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    if (PHP_INT_SIZE >= 8)
-    {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-    if (function_exists('bcmul'))
-    {
-
-
+
+
+
+
+
+
-      // conversion to float is intentional; int would lose 31st bit
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    if (PHP_INT_SIZE >= 8)
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    if (function_exists('bcmul'))
-    {
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-
@@ -288 +530 @@
-  private function EscapeString($string)
-  {
-(', ')', '|', '-', '!', '@', '~', '"', '&', '/' 
-(', '\)', '\|', '\-', '\!', '\@', '\~', '\"', '\&', '\/
+\\', '(',')','|','-','!','@','~','"','&', '/', '^', '$', '='
+\\\', '\(','\)','\|','\-','\!','\@','\~','\"', '\&', '\/', '\^', '\$', '\=
-    return str_replace($from, $to, $string);
-  }
@@ -318 +560 @@
-  {
-    return $this->warning;
+  }
+
+  /**
+   * get last error flag
+   * (to tell network connection errors from searchd errors or broken responses)
+   * @return mixed
+   */
+  public function isConnectError()
+  {
+    return $this->conerror;
-  }
-
@@ -328 +580 @@
-  {
-    $this->host = $host;
+    if ($host[0] == '/')
+    {
+      $this->path = 'unix://' . $host;
+      return;
+    }
+    if (substr($host, 0, 7) == 'unix://')
+    {
+      $this->path = $host;
+      return;
+    }
-    $this->port = $port;
+    $this->path = '';
+  }
+
+  /**
+   * set server connection timeout (0 to remove)
+   * @param integer $timeout
+   */
+  public function SetConnectTimeout($timeout)
+  {
+    $this->timeout = $timeout;
+  }
+
+  protected function Send($handle, $data, $length)
+  {
+    if (feof($handle) || fwrite($handle, $data, $length) !== $length)
+    {
+      $this->error = 'connection unexpectedly closed (timed out?)';
+      $this->connerror = true;
+      return false;
+    }
+    return true;
-  }
-
@@ -338 +621 @@
-  protected function Connect()
-  {
+    if ($this->socket !== false)
+    {
+      return $this->socket;
+    }
+
-    $errno = 0;
-    $errstr = '';
+    $this->connerror = false;
+
+    if ($this->path)
+    {
+      $host = $this->path;
+      $port = 0;
+    }
+    else
+    {
+      $host = $this->host;
+      $port = $this->port;
+    }
+
-    if ($this->timeout <= 0)
-    {
-open($this->host, $this->
+($host, $
-    }
-    else
-    {
-
-
+
+
+
-    if (!$fp)
-    {
+      if($this->path)
+      {
+        $location = $this->path;
+      }
+      else
+      {
+        $location = "{$this->host}:{$this->port}";
+      }
+
-      $errstr = trim($errstr);
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
-    // check version
-"N*"
+'N*'
-    $v = (int) $v;
-    if ($v < 1)
@@ -362 +685 @@
-      fclose($fp);
-      $this->error = "expected searchd protocol version 1+, got version '$v'";
-
-
-
-
-
+
+
+
-    return $fp;
-  }
@@ -392 +713 @@
-      }
-    }
-
+
+
+
+
-
-    // check response
@@ -449 +773 @@
-
-  /**
+   * set maximum query time, in milliseconds, per-index
+   * integer, 0 means "do not limit"
+   * @param integer $max
+   */
+  public function SetMaxQueryTime($max)
+  {
+    $this->maxquerytime = $max;
+  }
+
+  /**
-   * set match mode
-   * @param integer $mode
@@ -455 +789 @@
-  {
-    $this->mode = $mode;
+  }
+
+  /**
+   * set ranking mode
+   * @param integer $ranker
+   */
+  public function SetRankingMode($ranker)
+  {
+    $this->ranker = $ranker;
-  }
-
@@ -470 +813 @@
-  /**
-   * set per-field weights
+   * @deprecated use SetFieldWeights() instead
-   * @param array $weights
-   */
@@ -478 +822 @@
-      $this->weights = $weights;
-    }
+  }
+
+  /**
+   * bind per-field weights by name
+   * @param array $weights
+   */
+  public function SetFieldWeights(array $weights)
+  {
+    $this->fieldweights = $weights;
+  }
+
+  /**
+   * bind per-index weights by name
+   * @param array $weights
+   */
+  public function SetIndexWeights(array $weights)
+  {
+    $this->indexweights = $weights;
-  }
-
@@ -500 +862 @@
-   * @param boolean $exclude
-   */
-
+array 
-  {
-    if (is_array($values) && !empty($values))
@@ -530 +892 @@
-      'min'    => $min,
-      'max'    => $max
+    );
+  }
+
+  /**
+   * set float range filter
+   * only match records if $attribute value is beetwen $min and $max (inclusive)
+   * @param string  $attribute
+   * @param integer $max
+   * @param integer $min
+   * @param boolean $exclude
+   */
+  public function SetFilterFloatRange($attribute, $min, $max, $exclude = false)
+  {
+    $this->filters[] = array(
+      'type'    => self::SPH_FILTER_FLOATRANGE,
+      'attr'    => $attribute,
+      'exclude' => $exclude,
+      'min'     => $min,
+      'max'     => $max
+    );
+  }
+
+  /**
+   * setup anchor point for geosphere distance calculations
+   * required to use @geodist in filters and sorting
+   * latitude and longitude must be in radians
+   * @param string $attrlat
+   * @param string $attrlong
+   * @param float  $lat
+   * @param float  $long
+   */
+  public function SetGeoAnchor($attrlat, $attrlong, $lat, $long)
+  {
+    $this->anchor = array(
+      'attrlat'  => $attrlat,
+      'attrlong' => $attrlong,
+      'lat'      => $lat,
+      'long'     => $long
-    );
-  }
@@ -553 +953 @@
-   * @param string  $attribute
-   * @param integer $func
-
-
+
+
+
-  {
-    $this->groupby = $attribute;
-    $this->groupfunc = $func;
+    $this->groupsort = $groupsort;
+  }
+
+  /**
+   * set count-distinct attribute for group-by queries
+   * @param string $attribute
+   */
+  public function SetGroupDistinct($attribute)
+  {
+    $this->groupdistinct = $attribute;
+  }
+
+  /**
+   * set distributed retries count and delay
+   * @param integer $count
+   * @param integer $delay
+   */
+  public function SetRetries($count, $delay = 0)
+  {
+    $this->retrycount = $count;
+    $this->retrydelay = $delay;
+  }
+
+  /**
+   * set result set format (hash or array; hash by default)
+   * PHP specific; needed for group-by-MVA result sets that may contain duplicate IDs
+   * @param boolean $arrayresult
+   */
+  public function SetArrayResult($arrayresult)
+  {
+    $this->arrayresult = $arrayresult;
+  }
+
+  /**
+   * set attribute values override
+   * there can be only one override per attribute
+   * $values must be a hash that maps document IDs to attribute values
+   * @param string  $attrname
+   * @param integer $attrtype
+   * @param array   $values
+   */
+  public function SetOverride($attrname, $attrtype, array $values)
+  {
+    $this->overrides[$attrname] = array(
+      'attr'   => $attrname,
+      'type'   => $attrtype,
+      'values' => $values
+    );
+  }
+
+  /**
+   * set select-list (attributes or expressions), SQL-like syntax
+   * @param string $select
+   */
+  public function SetSelect($select)
+  {
+    $this->select = $select;
+  }
+
+  /**
+   * clear all filters (for multi-queries)
+   */
+  public function ResetFilters()
+  {
+    $this->filters = array();
+    $this->anchor = array();
+  }
+
+  /**
+   * clear groupby settings (for multi-queries)
+   */
+  public function ResetGroupBy()
+  {
+    $this->groupby = '';
+    $this->groupfunc  = self::SPH_GROUPBY_DAY;
+    $this->groupsort  = '@group desc';
+    $this->groupdistinct = '';
+  }
+
+  /**
+   * clear all attribute value overrides (for multi-queries)
+   */
+  public function ResetOverrides()
+  {
+    $this->overrides = array();
-  }
-
@@ -584 +1070 @@
-    $req .= pack('N', strlen($index)) . $index; // indexes
-    $req .= pack('N', 1); // id64 range marker
-64($this->min_id) . $this->sphPack
+U64($this->min_id) . $this->sphPackU
-
-    // filters
@@ -598 +1084 @@
-          foreach ($filter['values'] as $value)
-          {
-pack('N', floatval($value)); // this uberhack is to workaround 32bit signed int limit on x32 platforms
+sphPackI64($value);
-          }
-          break;
-        case self::SPH_FILTER_RANGE:
-pack('NN', $filter['min'], 
+sphPackI64($filter['min']) . sphPackI64(
-          break;
-        case self::SPH_FILTER_FLOATRANGE:
- $filter['min']) . $this->packFloat( 
+$filter['min']) . $this->packFloat(
-      }
-      $req .= pack('N', $filter['exclude']);
@@ -643 +1129 @@
-    // per-field weights
-    $req .= pack('N', count($this->fieldweights));
- 
+
-    $req .= pack('N', strlen($field)) . $field . pack('N', $weight);
-
-    // comment
-    $req .= pack('N', strlen($comment)) . $comment;
+
+    // attribute overrides
+    $req .= pack('N', count($this->overrides));
+    foreach ($this->overrides as $key => $entry)
+    {
+      $req .= pack('N', strlen($entry['attr'])) . $entry['attr'];
+      $req .= pack('NN', $entry['type'], count($entry['values']));
+      foreach ($entry['values'] as $id => $val)
+      {
+        $req .= sphPackU64($id);
+        switch ($entry['type'])
+        {
+          case self::SPH_ATTR_FLOAT:
+            $req .= $this->PackFloat($val);
+            break;
+          case self::SPH_ATTR_BIGINT:
+            $req .= sphPackI64($val);
+            break;
+          default:
+            $req .= pack('N', $val);
+        }
+      }
+    }
+
+    // select-list
+    $req .= pack('N', strlen($this->select)) . $this->select;
-
-    // mbstring workaround
@@ -731 +1243 @@
-
-    $nreqs = count($this->reqs);
- ( '', $this->reqs 
+('', $this->reqs
-    $len = 4 + strlen($req);
-    // add header
-    $req = pack('nnNN', self::SEARCHD_COMMAND_SEARCH, self::VER_COMMAND_SEARCH, $len, $nreqs) . $req;
-
-
-
+
-    {
-      $this->MBPop();
@@ -744 +1255 @@
-
-    $this->reqs = array();
+
+    return $this->ParseSearchResponse($response, $nreqs);
+  }
+
+  /**
+   * parse and return search query (or queries) response
+   * @param string  $response
+   * @param integer $nreqs
+   */
+  protected function ParseSearchResponse($response, $nreqs)
+  {
-
-    //// parse response
@@ -825 +1347 @@
-        if ($id64)
-        {
-
+U
-          $p += 8;
-          list(, $weight) = unpack('N*', substr($response, $p, 4));
@@ -865 +1387 @@
-        foreach ($attrs as $attr => $type)
-        {
+          // handle 64bit ints
+          if ($type == self::SPH_ATTR_BIGINT)
+          {
+            $attrvals[$attr] = sphUnpackI64(substr($response, $p, 8));
+            $p += 8;
+            continue;
+          }
+
-          // handle floats
-          if ($type == self::SPH_ATTR_FLOAT)
@@ -870 +1400 @@
-            list(, $uval) = unpack('N*', substr($response, $p, 4));
-            $p += 4;
- 
+
-            $attrvals[$attr] = $fval;
-            continue;
@@ -905 +1435 @@
-      }
-
-
-
+
-      $result['total'] = sprintf('%u', $total);
-      $result['total_found'] = sprintf('%u', $total_found);
@@ -1004 +1533 @@
-    // add header
-    $req = pack('nnN', self::SEARCHD_COMMAND_EXCERPT, self::VER_COMMAND_EXCERPT, $len) . $req;
-
-
+
-    {
-      $this->MBPop();
@@ -1058 +1586 @@
-    $req  = pack('N', strlen($query)) . $query; // req query
-    $req .= pack('N', strlen($index)) . $index; // req index
- 
+
-
-    //// send query, get response
@@ -1064 +1592 @@
-    $len = strlen($req);
-    $req = pack('nnN', self::SEARCHD_COMMAND_KEYWORDS, self::VER_COMMAND_KEYWORDS, $len) . $req; // add header
-
-
+
-    {
-      $this->MBPop();
@@ -1078 +1605 @@
-    list(, $nwords) = unpack('N*', substr($response, $pos, 4));
-    $pos += 4;
- ( $i=0; $i<$nwords; $i++ 
+($i = 0; $i < $nwords; $i ++
-    {
-      list(, $len) = unpack('N*', substr($response, $pos, 4));
-      $pos += 4;
- ( $response, $pos, $len 
+($response, $pos, $len
-      $pos += $len;
-
-      list(, $len) = unpack('N*', substr($response, $pos, 4));
-      $pos += 4;
- ( $response, $pos, $len 
+($response, $pos, $len
-      $pos += $len;
-
@@ -1117 +1644 @@
-   * @param  array   $attrs
-   * @param  array   $values
+   * @param  boolean $mva
-   * @return integer         amount of updated documents (0 or more) on success, or -1 on failure
-   */
-$attrs, $values
+array $attrs, array $values, $mva = false
-  {
-    // build request
@@ -1125 +1653 @@
-
-    $req .= pack('N', count($attrs));
- $attrs as $attr 
+$attrs as $attr
-    {
-      $req .= pack('N', strlen($attr)) . $attr;
+      $req .= pack('N', $mva ? 1 : 0);
-    }
-
@@ -1133 +1662 @@
-    foreach ($values as $id => $entry)
-    {
-
+U
-      foreach ($entry as $v)
-      {
-
+
+
+
+
+
+
+
+
-      }
-    }
@@ -1144 +1680 @@
-
-    // connect, send query, get response
-_
+
-    {
-      $this->MBPop();
@@ -1152 +1688 @@
-    $len = strlen($req);
-    // add header
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-      return -1;
-    }
@@ -1163 +1701 @@
-    // parse response
-    list(, $updated) = unpack('N*', substr($response, 0, 4));
+
+    return $updated;
+  }
+
+  /**
+   * open a persistent connection
+   * @return boolean
+   */
+  public function Open()
+  {
+    if ($this->socket !== false)
+    {
+      $this->error = 'already connected';
+      return false;
+    }
+    if (!$fp = $this->Connect())
+    {
+      return false;
+    }
+
+    // command, command version = 0, body length = 4, body = 1
+    $req = pack('nnNN', SEARCHD_COMMAND_PERSIST, 0, 4, 1);
+    if (!$this->Send ($fp, $req, 12))
+    {
+      return false;
+    }
+
+    $this->socket = $fp;
+    return true;
+  }
+
+  /**
+   * close a persistent connection
+   * @return boolean
+   */
+  public function Close()
+  {
+    if ($this->socket === false)
+    {
+      $this->error = 'not connected';
+      return false;
+    }
+
+    fclose($this->socket);
+    $this->socket = false;
+
+    return true;
+  }
+
+  /**
+   * status
+   * @return array
+   */
+  public function Status()
+  {
+    $this->MBPush();
+    if (!($fp = $this->Connect()))
+    {
+      $this->MBPop();
+      return false;
+    }
+
+    $req = pack('nnNN', SEARCHD_COMMAND_STATUS, VER_COMMAND_STATUS, 4, 1); // len=4, body=1
+    if (!($this->Send ($fp, $req, 12)) || !($response = $this->GetResponse ($fp, VER_COMMAND_STATUS)))
+    {
+      $this->MBPop();
+      return false;
+    }
+
+    $res = substr($response, 4); // just ignore length, error handling, etc
+    $p = 0;
+    list($rows, $cols) = array_values (unpack ('N*N*', substr ($response, $p, 8))); $p += 8;
+
+    $res = array();
+    for ($i = 0; $i < $rows; $i ++)
+    {
+      for ($j = 0; $j < $cols; $j ++)
+      {
+        list(,$len) = unpack('N*', substr($response, $p, 4));
+        $p += 4;
+        $res[$i][] = substr($response, $p, $len);
+        $p += $len;
+      }
+    }
+
-    $this->MBPop();
-updated
+res
-  }
-