Changeset 599025

Timestamp:

09/14/2012 03:09:07 PM (13 years ago)

Author:

ekeller

Message:

Upgrade last OpenSearchServer PHP library

Location:

opensearchserver-search/trunk

Files:

• index.php (modified) (2 diffs)
• lib/oss_abstract.class.php (added)
• lib/oss_api.class.php (modified) (22 diffs)
• lib/oss_autocompletion.class.php (added)
• lib/oss_delete.class.php (modified) (3 diffs)
• lib/oss_indexdocument.class.php (modified) (1 diff)
• lib/oss_paging.class.php (modified) (3 diffs)
• lib/oss_results.class.php (modified) (4 diffs)
• lib/oss_search.class.php (modified) (13 diffs)
• lib/oss_searchtemplate.class.php (modified) (5 diffs)

opensearchserver-search/trunk/index.php

@@ -6 +6 @@
  Author: Naveen.A.N
  Requires at least: 3.0.0
- Tested up to: 3.1.3
- Version:1.0.6
+ Tested up to: 3.4.2
+ Version:1.0.7
  */
 require_once 'lib/oss_api.class.php';
@@ -73 +73 @@
         $table_name =$wpdb->prefix ."opensearchserver";
         $result = $wpdb->get_results('SELECT * FROM '.$table_name);
-        $ossAPI->setField('id','','NO','YES','YES','','NO','YES');
-        $ossAPI->setField('type','','NO','YES','YES','','NO','NO');
-        $ossAPI->setField('url','','NO','YES','YES','','NO','NO');
-        $ossAPI->setField('title','TextAnalyzer','compress','YES','positions_offsets','','NO','NO');
-        $ossAPI->setField('content','TextAnalyzer','compress','YES','positions_offsets','','YES','NO');
-        $ossAPI->setField('timestamp','','NO','YES','YES','','NO','NO');
-        $ossAPI->setField('user_name','','compress','YES','YES','','NO','NO');
-        $ossAPI->setField('user_email','','compress','YES','YES','','NO','NO');
-        $ossAPI->setField('user_url','','NO','YES','YES','','NO','NO');
+        $ossAPI->setField('id','','NO','YES','YES','NO','YES');
+        $ossAPI->setField('type','','NO','YES','YES','NO','NO');
+        $ossAPI->setField('url','','NO','YES','YES','NO','NO');
+        $ossAPI->setField('title','TextAnalyzer','compress','YES','positions_offsets','NO','NO');
+        $ossAPI->setField('content','TextAnalyzer','compress','YES','positions_offsets','YES','NO');
+        $ossAPI->setField('timestamp','','NO','YES','YES','NO','NO');
+        $ossAPI->setField('user_name','','compress','YES','YES','NO','NO');
+        $ossAPI->setField('user_email','','compress','YES','YES','NO','NO');
+        $ossAPI->setField('user_url','','NO','YES','YES','NO','NO');
         $searchTemplate->createSearchTemplate("search",'    title:($$)^10 OR title:("$$")^10
                 OR

opensearchserver-search/trunk/lib/oss_api.class.php

@@ -1 +1 @@
 <?php
 /*
-*  This file is part of OpenSearchServer.
+ *  This file is part of OpenSearchServer.
 *
-*  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
+*  Copyright (C) 2008-2012 Emmanuel Keller / Jaeksoft
 *
 *  http://www.open-search-server.com
@@ -47 +47 @@
  */
 
-
-class OssApi {
+require_once('oss_abstract.class.php');
+
+class OssApi extends OssAbstract {
 
   const API_SELECT   = 'select';
@@ -54 +55 @@
   const API_DELETE   = 'delete';
   const API_OPTIMIZE = 'optimize';
-  //const API_RELOAD   = 'reload';
+  const API_RELOAD   = 'reload';
   const API_INDEX    = 'index';
   const API_ENGINE   = 'engine';
@@ -86 +87 @@
    */
   protected static $supportedLanguages = array(
-    ""   => "Undefined",
-    "zh" => "Chinese",
-    "da" => "Danish",
-    "nl" => "Dutch",
-    "en" => "English",
-    "fi" => "Finnish",
-    "fr" => "French",
-    "de" => "German",
-    "hu" => "Hungarian",
-    "it" => "Italian",
-    "no" => "Norwegian",
-    "pt" => "Portuguese",
-    "ro" => "Romanian",
-    "ru" => "Russian",
-    "es" => "Spanish",
-    "sv" => "Swedish",
-    "tr" => "Turkish"
+          ""   => "Undefined",
+          "zh" => "Chinese",
+          "da" => "Danish",
+          "nl" => "Dutch",
+          "en" => "English",
+          "fi" => "Finnish",
+          "fr" => "French",
+          "de" => "German",
+          "hu" => "Hungarian",
+          "it" => "Italian",
+          "no" => "Norwegian",
+          "pt" => "Portuguese",
+          "ro" => "Romanian",
+          "ru" => "Russian",
+          "es" => "Spanish",
+          "sv" => "Swedish",
+          "tr" => "Turkish"
   );
-
-  /* @var string */
-  protected $enginePath;
-
-  /* @var string */
-  protected $index;
-
-  /* @var string */
-  protected $login;
-
-  /* @var string */
-  protected $apiKey;
 
   /**
@@ -124 +113 @@
   public function __construct($enginePath, $index = NULL, $login = NULL, $apiKey = NULL) {
 
-    $parsedPath = OssApi::parseEnginePath($enginePath, $index);
-    $this->enginePath  = $parsedPath['enginePath'];
-    $this->index    = $parsedPath['index'];
-
-    $this->credential($login, $apiKey);
-
-    if (!function_exists('OssApi_Dummy_Function')) {
-      function OssApi_Dummy_Function() {
-      }
-    }
+    $this->init($enginePath, $index, $login, $apiKey);
+
   }
 
@@ -148 +129 @@
   public function getIndex() {
     return $this->index;
-  }
-
-  /**
-   * Assign credential information for the next queries
-   * @param $login string
-   * @param $apiKey string
-   * If $login is empty, credential is removed
-   */
-  public function credential($login, $apiKey) {
-    // Remove credentials
-    if (empty($login)) {
-      $this->login  = NULL;
-      $this->apiKey  = NULL;
-      return;
-    }
-
-    // Else parse and affect new credentials
-    if (empty($login) || empty($apiKey)) {
-      if (class_exists('OssException')) {
-        throw new UnexpectedValueException('You must provide a login and an api key to use credential.');
-      }
-      trigger_error(__CLASS__ . '::' . __METHOD__ . ': You must provide a login and an api key to use credential.', E_USER_ERROR);
-      return FALSE;
-    }
-
-    $this->login  = $login;
-    $this->apiKey  = $apiKey;
   }
 
@@ -184 +138 @@
    * It's expected to be in the same directory as OssApi.class.php.
    */
-  public function select($index = NULL) {
-    $index = $index ? $index : $this->index;
+  public function select() {
     if (!class_exists('OssSearch')) {
       require(dirname(__FILE__) . '/OssSearch.class.php');
     }
-    return new OssSearch($this->enginePath, $index, NULL, NULL, $this->login, $this->apiKey);
+    return new OssSearch($this->enginePath, NULL, NULL, $this->login, $this->apiKey);
   }
 
   /**
    * Return an OssSearch using the current engine path and index
-   * @param string $index If provided, this index name is used in place of the one defined in the API instance
    * @return OssSearch
    * @deprecated Use OssApi::select
    */
-  public function search($index = NULL) {
-    $index = $index ? $index : $this->index;
-    return $this->select($index);
+  public function search() {
+    return $this->select();
   }
 
   /**
    * Optimize the index
-   * param string $index If provided, this index name is used in place of the one defined in the API instance
    * return boolean True on success
    * see OSS Wiki [Web API optimize] documentation before using this method
    * FIXME Provide a link to the OSS WiKi
    */
-  public function optimize($index = NULL) {
-    $index = $index ? $index : $this->index;
-    $return = $this->queryServer($this->getQueryURL(OssApi::API_OPTIMIZE, $index));
+  public function optimize() {
+    $return = $this->queryServer($this->getQueryURL(OssApi::API_OPTIMIZE));
     return ($return !== FALSE);
   }
@@ -223 +172 @@
    * FIXME See why API have been removed
    */
-  public function reload($index = NULL) {
-    $index = $index ? $index : $this->index;
-    $return = $this->queryServer($this->getQueryURL(OssApi::API_RELOAD, $index));
+  public function reload() {
+    $return = $this->queryServer($this->getQueryURL(OssApi::API_RELOAD));
     return ($return !== FALSE);
-  }
-
-  /**
-   * todo Next release
-   * ignore
-   * param string $file
-   * return NULL
-   * FIXME See with ekeller if this's api won't be deprecated soon
-   */
-  public function push($file) {
-    // http://localhost:8080/oss/push?use=fileNiet&fileName=test.pdf&version=1
   }
 
@@ -244 +181 @@
    * param string|string[] $patterns
    * param boolean $deleteAll The provided patterns will replace the patterns already in the search engine
-   * param string $index If provided, this index name is used in place of the one defined in the API instance
    * return boolean True on success
    */
-  public function pattern($patterns, $deleteAll = FALSE, $index = NULL) {
-    $index = $index ? $index : $this->index;
+  public function pattern($patterns, $deleteAll = FALSE) {
     if (is_array($patterns)) {
       $patterns = implode("\n", $patterns);
     }
-    $return = $this->queryServer($this->getQueryURL(OssApi::API_PATTERN, $index) . ($deleteAll?'&deleteAll=yes':'&deleteAll=no'), $patterns);
+    $return = $this->queryServer($this->getQueryURL(OssApi::API_PATTERN) . ($deleteAll?'&deleteAll=yes':'&deleteAll=no'), $patterns);
     return ($return !== FALSE);
-  }
-
-  /**
-   * Return the url to use with curl
-   * param string $apiCall The Web API to call. Refer to the OSS Wiki documentation of [Web API]
-   * param string $index The index to query. If none given, index of the current object will be used
-   * param string $command The optional command to send to the API call
-   * param string[] $options Additional query parameters
-   * return string
-   * Use OssApi::API_* constants for $apiCall.
-   * Optionals query parameters are provided as a named list:
-   * array(
-   *   "arg1" => "value1",
-   *   "arg2" => "value2"
-   * )
-   */
-  protected function getQueryURL($apiCall, $index = NULL, $cmd = NULL, $options = NULL) {
-
-    $path = $this->enginePath . '/' . $apiCall;
-    $chunks = array();
-
-    if (!empty($index)) {
-      $chunks[] = 'use=' . urlencode($index);
-    }
-
-    if (!empty($cmd)) {
-      $chunks[] = 'cmd=' . urlencode($cmd);
-    }
-
-    // If credential provided, include them in the query url
-    if (!empty($this->login)) {
-      $chunks[] = "login=" . urlencode($this->login);
-      $chunks[] = "key="  . urlencode($this->apiKey);
-    }
-
-    // Prepare additionnal parameters
-    if (is_array($options)) {
-      foreach ($options as $argName => $argValue) {
-        $chunks[] = $argName . "=" . urlencode($argValue);
-      }
-    }
-
-    $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . implode("&", $chunks);
-
-    return $path;
   }
 
@@ -306 +196 @@
    *                   a DOMDocument or any object that implement the __toString
    *                   magic method
-   * @param string $index If provided, this index name is used in place of the one defined in the API instance
    * @return boolean True on success
    */
-  public function update($xml, $index = NULL) {
-
-    $index = $index ? $index : $this->index;
+  public function update($xml) {
 
     // Cast $xml to a string
@@ -336 +223 @@
     }
 
-    $return = $this->queryServer($this->getQueryURL(OssApi::API_UPDATE, $index), $xml);
+    $return = $this->queryServer($this->getQueryURL(OssApi::API_UPDATE), $xml);
     return ($return !== FALSE);
 
@@ -349 +236 @@
   public function getEngineInformations() {
     $infos = array(
-      'engine_url'    => $this->enginePath,
-      'engine_version'  => 'unknown',
-      'login'        => $this->login,
-      'apiKey'      => $this->apiKey
+            'engine_url'    => $this->enginePath,
+            'engine_version'  => 'unknown',
+            'login'        => $this->login,
+            'apiKey'      => $this->apiKey
     );
     return $infos;
@@ -364 +251 @@
    * @return string[]
    */
-  public function getIndexInformations($index = NULL) {
-    $index = $index ? $index : $this->index;
+  public function getIndexInformations() {
 
     $infos  = array(
-      'name'  => $index,
-      'size'  => NULL
+            'name'  => $index,
+            'size'  => NULL
     );
 
     set_error_handler('OssApi_Dummy_Function', E_ALL);
     try {
-      $result = $this->queryServerXML($this->getQueryURL(OssApi::API_SELECT, $index) . '&q=*:*&rows=0');
+      $result = $this->queryServerXML($this->getQueryURL(OssApi::API_SELECT) . '&q=*:*&rows=0');
     }
     catch (Exception $e) {
@@ -395 +281 @@
 
     // Check if the select api is answering
-    $rcurl = curl_init($this->getQueryURL(OssApi::API_SELECT, $index) . '&q=!*:*&rows=0');
+    $rcurl = curl_init($this->getQueryURL(OssApi::API_SELECT) . '&q=!*:*&rows=0');
     curl_setopt($rcurl, CURLOPT_HTTP_VERSION, '1.0');
     curl_setopt($rcurl, CURLOPT_RETURNTRANSFER, TRUE);
@@ -420 +306 @@
    * @todo Recode this method once API is provided
    */
-  public function isIndexAvailable($index = NULL) {
+  public function isIndexAvailable($index = NULL,$queryTemplate = NULL) {
     $index = $index ? $index : $this->index;
     // Check if the select api is answering
     set_error_handler('OssApi_Dummy_Function', E_ALL);
     try {
-      $result = $this->queryServerXML($this->getQueryURL(OssApi::API_SELECT, $index) . '&q=!*:*&rows=0');
+      if($queryTemplate != NULL) {
+        $result = $this->queryServerXML($this->getQueryURL(OssApi::API_SELECT) . '&q=!*:*&rows=0&qt=' . $queryTemplate);
+      }
+      else {
+        $result = $this->queryServerXML($this->getQueryURL(OssApi::API_SELECT) . '&q=!*:*&rows=0');
+      }
     }
     catch (Exception $e) {
@@ -439 +330 @@
    */
   public function indexList() {
-    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, NULL, OssApi::API_SCHEMA_INDEX_LIST));
+    $params = array('cmd' => OssApi::API_SCHEMA_INDEX_LIST);
+    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $params));
     $indexes = array();
     foreach ($return->index as $index) {
@@ -455 +347 @@
   public function createIndex($index, $template = FALSE) {
 
-    $params = array("index.name" => $index);
+    $params = array('index.name' => $index);
     if ($template) {
-      $params["index.template"] = $template;
-    }
-    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, NULL, OssApi::API_SCHEMA_CREATE_INDEX, $params));
+      $params['index.template'] = $template;
+    }
+    $params['cmd'] = OssApi::API_SCHEMA_CREATE_INDEX;
+    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $params));
     if ($return === FALSE) {
       return FALSE;
@@ -468 +361 @@
   /**
    * Retreive the complete schema of the index
-   * @param string $index If provided, this index name is used in place of the one defined in the API instance
    * @return SimpleXMLElement|OSS_Schema
    * The schema is provided by the OSS engine as an xml. This xml is actualy the complete configuration of the schema.
    * If you want to manipulate the schema, pass it to OSS_Schema::factoryFromXML(...) for easier access.
    */
-  public function getSchema($index = NULL) {
-    $index = $index ? $index : $this->index;
-    return $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $index, OssApi::API_SCHEMA_GET_SCHEMA));
-  }
-
+  public function getSchema() {
+    $params = array('cmd' => OssApi::API_SCHEMA_GET_SCHEMA);
+    return $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $params));
+  }
+  
   /**
    * Create or alter a field
@@ -485 +377 @@
    * @param string $indexed
    * @param string $termVector
-   * @param string $index If provided, this index name is used in place of the one defined in the API instance
    * @return boolean
    */
-  public function setField($name, $analyzer = NULL, $stored = NULL, $indexed = NULL, $termVector = NULL, $index = NULL, $default = NULL, $unique = NULL) {
-    $index = $index ? $index : $this->index;
+  public function setField($name, $analyzer = NULL, $stored = NULL, $indexed = NULL, $termVector = NULL, $default = NULL, $unique = NULL) {
     $params = array("field.name" => $name);
     if ($analyzer) {
@@ -503 +393 @@
       $params["field.termVector"] = $termVector;
     }
-    if ($termVector) {
+    if ($default) {
       $params["field.default"] = $default;
     }
-    if ($termVector) {
+    if ($unique) {
       $params["field.unique"] = $unique;
     }
 
-    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $index, OssApi::API_SCHEMA_SET_FIELD, $params));
+    $params['cmd'] = OssApi::API_SCHEMA_SET_FIELD;
+    $return = $this->queryServerXML($this->getQueryURL(OssApi::API_SCHEMA, $params));
 
     if ($return === FALSE) {
@@ -705 +596 @@
   public static function escape($string) {
     static $escaping = array(
-    array("+",   "-",   "&&",   "||",  "!",  "(",  ")",  "{",  "}",  "[",  "]",  "^", "\"",  "~",  "*",  "?",  ":", '\\'),
-    array('\+', '\-', '\&\&', '\|\|', '\!', '\(', '\)', '\{', '\}', '\[', '\]', '\^', '\"', '\~', '\*', '\?', '\:', '\\\\')
+            array("+",   "-",   "&&",   "||",  "!",  "(",  ")",  "{",  "}",  "[",  "]",  "^", "\"",  "~",  "*",  "?",  ":", '\\'),
+            array('\+', '\-', '\&\&', '\|\|', '\!', '\(', '\)', '\{', '\}', '\[', '\]', '\^', '\"', '\~', '\*', '\?', '\:', '\\\\')
     );
     return str_replace($escaping[0], $escaping[1], $string);
@@ -719 +610 @@
 
     static $remove = array(
-      "\x00", "\x01", "\x02", "\x03", "\x04", "\x05", "\x06", "\x07",
-      "\x08",                 "\x0B", "\x0C",         "0x0E", "\x0F",
-      "\x10", "\x11", "\x12", "\x13", "\x14", "\x15", "\x16", "\x17",
-      "\x18", "\x19", "\x1A", "\x1B", "\x1C", "\x1D", "\x1E", "\x1F"
+            "\x00", "\x01", "\x02", "\x03", "\x04", "\x05", "\x06", "\x07",
+            "\x08",                 "\x0B", "\x0C",         "0x0E", "\x0F",
+            "\x10", "\x11", "\x12", "\x13", "\x14", "\x15", "\x16", "\x17",
+            "\x18", "\x19", "\x1A", "\x1B", "\x1C", "\x1D", "\x1E", "\x1F"
     );
     return str_replace($remove, $replacement, $string);

opensearchserver-search/trunk/lib/oss_delete.class.php

@@ -2 +2 @@
 /*
  *  This file is part of OpenSearchServer.
- *
- *  Copyright (C)2011 Emmanuel Keller / Jaeksoft
- *
- *  http://www.open-search-server.com
- *
- *  OpenSearchServer 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 3 of the License, or
- *  (at your option) any later version.
- *
- *  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
- */
+*
+*  Copyright (C)2011 Emmanuel Keller / Jaeksoft
+*
+*  http://www.open-search-server.com
+*
+*  OpenSearchServer 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 3 of the License, or
+*  (at your option) any later version.
+*
+*  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 /**
@@ -30 +30 @@
 }
 
-class OssDelete {
+require_once('oss_abstract.class.php');
 
-  protected $enginePath;
-  protected $index;
+class OssDelete extends OssAbstract {
 
   public function __construct($enginePath, $index = NULL, $login = NULL, $apiKey = NULL) {
-    $ossAPI = new OssApi($enginePath, $index);
-    $this->enginePath  = $ossAPI->getEnginePath();
-    $this->index    = $ossAPI->getIndex();
-    $this->credential($login, $apiKey);
+    $this->init($enginePath, $index, $login, $apiKey);
   }
 
   public function delete($query) {
-    $params = array("q" => $query);
-    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_DELETE, $this->index  , OssApi::API_SCHEMA_DELETE_FIELD, $params));
+    $params = array('q' => $query);
+    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_DELETE, $params));
     if ($return === FALSE) {
       return FALSE;
@@ -51 +47 @@
   }
 
-  public function credential($login, $apiKey) {
-    // Remove credentials
-    if (empty($login)) {
-      $this->login  = NULL;
-      $this->apiKey  = NULL;
-      return;
-    }
 
-    // Else parse and affect new credentials
-    if (empty($login) || empty($apiKey)) {
-      if (class_exists('OssException')) {
-        throw new UnexpectedValueException('You must provide a login and an api key to use credential.');
-      }
-      trigger_error(__CLASS__ . '::' . __METHOD__ . ': You must provide a login and an api key to use credential.', E_USER_ERROR);
-      return FALSE;
-    }
-
-    $this->login  = $login;
-    $this->apiKey  = $apiKey;
-  }
-
-  protected function getQueryURL($apiCall, $index = NULL, $cmd = NULL, $options = NULL) {
-
-    $path = $this->enginePath . '/' . $apiCall;
-    $chunks = array();
-
-    if (!empty($index)) {
-      $chunks[] = 'use=' . urlencode($index);
-    }
-
-    if (!empty($cmd)) {
-      $chunks[] = 'cmd=' . urlencode($cmd);
-    }
-
-    // If credential provided, include them in the query url
-    if (!empty($this->login)) {
-      $chunks[] = "login=" . urlencode($this->login);
-      $chunks[] = "key="  . urlencode($this->apiKey);
-    }
-
-    // Prepare additionnal parameters
-    if (is_array($options)) {
-      foreach ($options as $argName => $argValue) {
-        $chunks[] = $argName . "=" . urlencode($argValue);
-      }
-    }
-
-    $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . implode("&", $chunks);
-
-    return $path;
-  }
 }
 ?>

opensearchserver-search/trunk/lib/oss_indexdocument.class.php

@@ -3 +3 @@
 *  This file is part of OpenSearchServer.
 *
-*  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
+*  Copyright (C) 2008-2012 Emmanuel Keller / Jaeksoft
 *
 *  http://www.open-search-server.com

opensearchserver-search/trunk/lib/oss_paging.class.php

@@ -2 +2 @@
 /*
  *  This file is part of OpenSearchServer.
- *
- *  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
- *
- *  http://www.open-search-server.com
- *
- *  OpenSearchServer 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 3 of the License, or
- *  (at your option) any later version.
- *
- *  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
- */
+*
+*  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
+*
+*  http://www.open-search-server.com
+*
+*  OpenSearchServer 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 3 of the License, or
+*  (at your option) any later version.
+*
+*  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 /**
@@ -103 +103 @@
     $this->resultStart   = (int) $this->oss_result->result['start'];
 
-    $this->resultCurrentPage = floor($this->resultStart / $this->resultRows);
-    $this->resultTotal  = ceil($this->resultFound / $this->resultRows);
+    $this->resultCurrentPage = ($this->resultRows > 0) ? floor($this->resultStart / $this->resultRows) : 0;
+    $this->resultTotal = ($this->resultRows > 0) ? ceil($this->resultFound / $this->resultRows) : 0;
 
     if ($this->resultTotal > 1) {
@@ -120 +120 @@
       $this->resultPrev = max($this->resultCurrentPage - 1, 0);
       if($this->resultCurrentPage + 1 < $this->resultHigh) {
-      $this->resultNext = min($this->resultCurrentPage + 1, $this->resultTotal);
+        $this->resultNext = min($this->resultCurrentPage + 1, $this->resultTotal);
       }
       $this->pageBaseURI = preg_replace('/&(?:' . $this->pageParameter . '|' . $this->rowsParameter . ')=[\d]+/', '', $_SERVER['REQUEST_URI']) . '&' . $this->rowsParameter . '=' . $this->resultRows . '&' . $this->pageParameter . '=';

opensearchserver-search/trunk/lib/oss_results.class.php

@@ -1 +1 @@
 <?php
 /*
- *  This file is part of OpenSearchServer.
- *
- *  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
- *
- *  http://www.open-search-server.com
- *
- *  OpenSearchServer 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 3 of the License, or
- *  (at your option) any later version.
- *
- *  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
- */
+*  This file is part of OpenSearchServer.
+*
+*  Copyright (C) 2008-2012 Emmanuel Keller / Jaeksoft
+*
+*  http://www.open-search-server.com
+*
+*  OpenSearchServer 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 3 of the License, or
+*  (at your option) any later version.
+*
+*  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 if (!extension_loaded('SimpleXML')) {
@@ -39 +39 @@
   protected $resultRows;
   protected $resultStart;
-
+  protected $resultCollapsedCount;
 
   /**
@@ -52 +52 @@
     $this->resultRows = (int)$this->result->result['rows'];
     $this->resultStart = (int)$this->result->result['start'];
-
+    $this->resultCollapsedCount = (int)$this->result->result['collapsedDocCount'];
     if (!function_exists('OssApi_Dummy_Function')) {
       function OssApi_Dummy_Function() {
       }
     }
+  }
+  public function getResultCollapsedCount() {
+    return $this->resultCollapsedCount;
   }
 
@@ -152 +155 @@
   }
 
+  /**
+  *
+  * @return Return the spellsuggest array.
+  */
+  public function getSpellSuggestions($fieldName) {
+    $currentSpellCheck = isset($fieldName)? $this->result->xpath('spellcheck/field[@name="' . $fieldName . '"]/word/suggest'):NULL;
+    if (!isset($currentSpellCheck) || ( isset($currentSpellCheck) && $currentSpellCheck === FALSE)) {
+      $currentSpellCheck = array();
+    }
+    return $currentSpellCheck;
+  }
+  /**
+   *
+   * @return Return the spellsuggest terms.
+   */
+  public function getSpellSuggest($fieldName) {
+    $spellCheckWord = isset($fieldName)? $this->result->xpath('spellcheck/field[@name="' . $fieldName . '"]/word'):NULL;
+    foreach ($spellCheckWord as $each) {
+      $queryExact .= $each[0]->suggest.' ';
+    }
+    return $queryExact;
+  }
+
 }
 ?>

opensearchserver-search/trunk/lib/oss_search.class.php

@@ -2 +2 @@
 /*
  *  This file is part of OpenSearchServer.
- *
- *  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
- *
- *  http://www.open-search-server.com
- *
- *  OpenSearchServer 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 3 of the License, or
- *  (at your option) any later version.
- *
- *  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
- */
+*
+*  Copyright (C) 2008-2012 Emmanuel Keller / Jaeksoft
+*
+*  http://www.open-search-server.com
+*
+*  OpenSearchServer 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 3 of the License, or
+*  (at your option) any later version.
+*
+*  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 
@@ -30 +30 @@
   trigger_error("OssSearch won't work whitout OssApi", E_USER_ERROR); die();
 }
+
+require_once('oss_abstract.class.php');
+
 
 /**
@@ -37 +40 @@
  * FIXME Clean this class and use facilities provided by OssApi
  */
-class OssSearch {
-
-  protected $enginePath;
-  protected $index;
+class OssSearch extends OssAbstract {
+
   protected $query;
   protected $template;
@@ -56 +57 @@
   protected $log;
   protected $customLogs;
-
-  protected $login;
-  protected $apiKey;
+  protected $uniqueKeys;
+  protected $docIds;
 
   protected $lastQueryString;
@@ -69 +69 @@
   public function __construct($enginePath, $index = NULL, $rows = NULL, $start = NULL, $login = NULL, $apiKey = NULL) {
 
-    $ossAPI = new OssApi($enginePath, $index);
-
-    $this->enginePath  = $ossAPI->getEnginePath();
-    $this->index    = $ossAPI->getIndex();
-
-    $this->credential($login, $apiKey);
+    $this->init($enginePath, $index, $login, $apiKey);
 
     $this->rows($rows);
@@ -85 +80 @@
     $this->collapse  = array('field' => NULL, 'max' => NULL, 'mode' => NULL);
     $this->moreLikeThis = array('active' => NULL, 'docquery' => NULL, 'minwordlen' => NULL,
-      'maxwordlen' => NULL, 'mindocfreq' => NULL, 'mintermfreq' => NULL, 'stopwords' => NULL);
+            'maxwordlen' => NULL, 'mindocfreq' => NULL, 'mintermfreq' => NULL, 'stopwords' => NULL);
     $this->log = FALSE;
     $this->customLogs = array();
-  }
-
-  /**
-   * Specify the index name to query
-   * @param $index string
-   * @return OssSearch
-   */
-  public function index($index = NULL) {
-    $this->index = $index;
-    return $this;
+    $this->uniqueKey = array();
+    $this->docIds = array();
   }
 
@@ -143 +130 @@
 
   /**
-   * @param $login string
-   * @param $apiKey string
-   * If $login is empty, credential is removed
-   */
-  public function credential($login, $apiKey) {
-    // Remove credentials
-    if (empty($login)) {
-      $this->login  = NULL;
-      $this->apiKey  = NULL;
-      return;
-    }
-
-    // Else parse and affect new credentials
-    if (empty($login) || empty($apiKey)) {
-      if (class_exists('OssException')) {
-        throw new UnexpectedValueException('You must provide a login and an api key to use credential.');
-      }
-      trigger_error(__CLASS__ . '::' . __METHOD__ . ': You must provide a login and an api key to use credential.', E_USER_ERROR);
-      return FALSE;
-    }
-
-    $this->login  = $login;
-    $this->apiKey  = $apiKey;
-  }
-
-  /**
    * @return OssSearch
    */
@@ -197 +158 @@
   public function sort($fields) {
     foreach ((array)$fields as $field)
-    $this->sort[] = $field;
+      $this->sort[] = $field;
     return $this;
   }
@@ -228 +189 @@
    * @return OssSearch
    */
+  public function uniqueKey($uniqueKey = NULL) {
+    $this->uniqueKeys[] = $uniqueKey;
+    return $this;
+  }
+
+  /**
+   * @return OssSearch
+   */
+  public function docId($docId = NULL) {
+    $this->docIds[] = $docId;
+    return $this;
+  }
+
+  /**
+   * @return OssSearch
+   */
   public function facet($field, $min = NULL, $multi = FALSE) {
     $this->facet[$field] = array('min' => $min, 'multi' => $multi);
@@ -238 +215 @@
 
   public function moreLikeThisDocQuery($docQuery) {
-    $this->moreLikeThis['docquery'] = $active;
+    $this->moreLikeThis['docquery'] = $docQuery;
   }
 
@@ -296 +273 @@
     $queryChunks = array();
 
-    // If credential provided, include them in the query url
-    if (!empty($this->login)) {
-      $queryChunks[] = "login=" . $this->login;
-      $queryChunks[] = "key="   . $this->apiKey;
-    }
-
     $queryChunks[] = 'q=' . urlencode((empty($this->query) ? "*:*" : $this->query));
 
-    if (!empty($this->index)) {
-      $queryChunks[] = 'use='  . $this->index;
-    }
     if (!empty($this->template)) {
       $queryChunks[] = 'qt='   . $this->template;
     }
+
     if (!empty($this->lang)) {
       $queryChunks[] = 'lang=' . $this->lang;
@@ -317 +286 @@
       $queryChunks[] = 'rows='  . (int) $this->rows;
     }
+
     if ($this->start !== NULL) {
       $queryChunks[] = 'start=' . (int) $this->start;
@@ -398 +368 @@
       $queryChunks[] = 'log' . $pos . '=' . urlencode($customLog);
     }
-    return $this->enginePath . '/' . OssApi::API_SELECT . '?' . implode('&', $queryChunks);
-
+
+    // DocID
+    foreach ((array) $this->docIds as $docId) {
+      if (empty($docId)) {
+        continue;
+      }
+      $queryChunks[] = 'id=' . urlencode($docId);
+    }
+
+    // UniqueKey
+    foreach ((array) $this->uniqueKeys as $uniqueKey) {
+      if (empty($uniqueKey)) {
+        continue;
+      }
+      $queryChunks[] = 'uk=' . urlencode($uniqueKey);
+    }
+    return  $this->getQueryURL(OssApi::API_SELECT) . '&' . implode('&', $queryChunks);
   }
 }

opensearchserver-search/trunk/lib/oss_searchtemplate.class.php

@@ -2 +2 @@
 /*
  *  This file is part of OpenSearchServer.
- *
- *  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
- *
- *  http://www.open-search-server.com
- *
- *  OpenSearchServer 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 3 of the License, or
- *  (at your option) any later version.
- *
- *  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
- */
+*
+*  Copyright (C) 2008-2011 Emmanuel Keller / Jaeksoft
+*
+*  http://www.open-search-server.com
+*
+*  OpenSearchServer 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 3 of the License, or
+*  (at your option) any later version.
+*
+*  OpenSearchServer 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 OpenSearchServer.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 
@@ -31 +31 @@
 }
 
-class OssSearchTemplate {
+require_once('oss_abstract.class.php');
 
-  protected $enginePath;
-  protected $index;
+
+class OssSearchTemplate extends OssAbstract {
+
   protected $query;
   protected $template;
 
   public function __construct($enginePath, $index = NULL, $login = NULL, $apiKey = NULL) {
-    $ossAPI = new OssApi($enginePath, $index);
-    $this->enginePath  = $ossAPI->getEnginePath();
-    $this->index    = $ossAPI->getIndex();
-    $this->credential($login, $apiKey);
+    $this->init($enginePath, $index, $login, $apiKey);
   }
 
@@ -62 +60 @@
       $params['qt.lang'] = $qtlang;
     }
-    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $this->index  , OssApi::API_SEARCH_TEMPLATE_CREATE, $params));
+    $params['cmd'] = OssApi::API_SEARCH_TEMPLATE_CREATE;
+    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $params));
     return $return === FALSE ? FALSE : TRUE;
   }
@@ -69 +68 @@
     $params = array("qt.name" => $qtname);
     $params['returnfield']=$returnField;
-    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $this->index  , OssApi::API_SEARCH_TEMPLATE_SETRETURNFIELD, $params));
+    $params['cmd'] = OssApi::API_SEARCH_TEMPLATE_SETRETURNFIELD;
+    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $params));
     return $return === FALSE ? FALSE : TRUE;
   }
@@ -88 +88 @@
     }
     $params['snippetfield'] = $snippetField;
-    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $this->index  , OssApi::API_SEARCH_TEMPLATE_SETSNIPPETFIELD, $params));
+    $params['cmd'] = OssApi::API_SEARCH_TEMPLATE_SETSNIPPETFIELD;
+    $return = OssApi::queryServerXML($this->getQueryURL(OssApi::API_SEARCH_TEMPLATE, $params));
     return $return === FALSE ? FALSE : TRUE;
   }
 
-  public function credential($login, $apiKey) {
-    // Remove credentials
-    if (empty($login)) {
-      $this->login  = NULL;
-      $this->apiKey  = NULL;
-      return;
-    }
-
-    // Else parse and affect new credentials
-    if (empty($login) || empty($apiKey)) {
-      if (class_exists('OssException')) {
-        throw new UnexpectedValueException('You must provide a login and an api key to use credential.');
-      }
-      trigger_error(__CLASS__ . '::' . __METHOD__ . ': You must provide a login and an api key to use credential.', E_USER_ERROR);
-      return FALSE;
-    }
-
-    $this->login  = $login;
-    $this->apiKey  = $apiKey;
-  }
-
-  protected function getQueryURL($apiCall, $index = NULL, $cmd = NULL, $options = NULL) {
-
-    $path = $this->enginePath . '/' . $apiCall;
-    $chunks = array();
-    if (!empty($index)) {
-      $chunks[] = 'use=' . urlencode($index);
-    }
-    if (!empty($cmd)) {
-      $chunks[] = 'cmd=' . urlencode($cmd);
-    }
-    // If credential provided, include them in the query url
-    if (!empty($this->login)) {
-      $chunks[] = "login=" . urlencode($this->login);
-      $chunks[] = "key="  . urlencode($this->apiKey);
-    }
-
-    // Prepare additionnal parameters
-    if (is_array($options)) {
-      foreach ($options as $argName => $argValue) {
-        $chunks[] = $argName . "=" . urlencode($argValue);
-      }
-    }
-
-    $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . implode("&", $chunks);
-
-    return $path;
-  }
 }
 ?>