PCBC-508: Add support for FTS advanced sorting

Change-Id: I0adaf30589dc6bbdba0e96c0c791bd6f9d8cb237
Reviewed-on: http://review.couchbase.org/89259
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

api/couchbase.php

@@ -1969,7 +1969,7 @@ public function consistentWith($state) {}
          *  - UPSERT
          *  - DELETE
          *
-         * @param boolean $readonly true if readonly should be forced, false is the default and will use the server side default.
+         * @param bool $readonly true if readonly should be forced, false is the default and will use the server side default.
          * @return N1qlQuery
          */
         public function readonly($readonly) {}
@@ -3395,6 +3395,169 @@ public function jsonSerialize() {}
         public function addRange($name, $min, $max) {}
     }
 
+    /**
+     * Base class for all FTS sort options in querying.
+     */
+    class SearchSort {
+        /** @ignore */
+        private function __construct() {}
+
+        /**
+         * Sort by the document identifier.
+         *
+         * @return SearchSortId
+         */
+        public static function id() {}
+
+        /**
+         * Sort by the hit score.
+         *
+         * @return SearchSortScore
+         */
+        public static function score() {}
+
+        /**
+         * Sort by a field in the hits.
+         *
+         * @param string $field the field name
+         *
+         * @return SearchSortField
+         */
+        public static function field($field) {}
+
+        /**
+         * Sort by geo location.
+         *
+         * @param string $field the field name
+         * @param float $longitude the longitude of the location
+         * @param float $latitude the latitude of the location
+         *
+         * @return SearchSortGeoDistance
+         */
+        public static function geoDistance($field, $longitude, $latitude) {}
+    }
+
+    /**
+     * Sort by the document identifier.
+     */
+    class SearchSortId extends SearchSort implements \JsonSerializable {
+        /** @ignore */
+        private function __construct() {}
+
+        /**
+         * Direction of the sort
+         *
+         * @param bool $descending
+         *
+         * @return SearchSortId
+         */
+        public function descending($descending) {}
+    }
+
+    /**
+     * Sort by the hit score.
+     */
+    class SearchSortScore extends SearchSort implements \JsonSerializable {
+        /** @ignore */
+        private function __construct() {}
+
+        /**
+         * Direction of the sort
+         *
+         * @param bool $descending
+         *
+         * @return SearchSortScore
+         */
+        public function descending($descending) {}
+    }
+
+    /**
+     * Sort by a field in the hits.
+     */
+    class SearchSortField extends SearchSort implements \JsonSerializable {
+        const TYPE_AUTO = "auto";
+        const TYPE_STRING = "string";
+        const TYPE_NUMBER = "number";
+        const TYPE_DATE = "date";
+
+        const MODE_DEFAULT = "default";
+        const MODE_MIN = "min";
+        const MODE_MAX = "max";
+
+        const MISSING_FIRST = "first";
+        const MISSING_LAST = "last";
+
+        /** @ignore */
+        private function __construct() {}
+
+        /**
+         * Direction of the sort
+         *
+         * @param bool $descending
+         *
+         * @return SearchSortField
+         */
+        public function descending($descending) {}
+
+        /**
+         * Set type of the field
+         *
+         * @param string type the type
+         *
+         * @see SearchSortField::TYPE_AUTO
+         * @see SearchSortField::TYPE_STRING
+         * @see SearchSortField::TYPE_NUMBER
+         * @see SearchSortField::TYPE_DATE
+         */
+        public function type($type) {}
+
+        /**
+         * Set mode of the sort
+         *
+         * @param string mode the mode
+         *
+         * @see SearchSortField::MODE_MIN
+         * @see SearchSortField::MODE_MAX
+         */
+        public function mode($mode) {}
+
+        /**
+         * Set where the hits with missing field will be inserted
+         *
+         * @param string missing strategy for hits with missing fields
+         *
+         * @see SearchSortField::MISSING_FIRST
+         * @see SearchSortField::MISSING_LAST
+         */
+        public function missing($missing) {}
+    }
+
+    /**
+     * Sort by a location and unit in the hits.
+     */
+    class SearchSortGeoDistance extends SearchSort implements \JsonSerializable {
+        /** @ignore */
+        private function __construct() {}
+
+        /**
+         * Direction of the sort
+         *
+         * @param bool $descending
+         *
+         * @return SearchSortGeoDistance
+         */
+        public function descending($descending) {}
+
+        /**
+         * Name of the units
+         *
+         * @param string $unit
+         *
+         * @return SearchSortGeoDistance
+         */
+        public function unit($unit) {}
+    }
+
     /**
      * Represents a Analytics query (currently experimental support).
      *

config.m4

@@ -91,6 +91,11 @@ COUCHBASE_FILES=" \
     src/couchbase/n1ql_query.c \
     src/couchbase/search_query.c \
     src/couchbase/search/query_part.c \
+    src/couchbase/search/sort.c \
+    src/couchbase/search/sort_field.c \
+    src/couchbase/search/sort_geo.c \
+    src/couchbase/search/sort_id.c \
+    src/couchbase/search/sort_score.c \
     src/couchbase/search/boolean_field_query.c \
     src/couchbase/search/boolean_query.c \
     src/couchbase/search/conjunction_query.c \

config.w32

@@ -68,6 +68,11 @@ if (PHP_COUCHBASE != "no") {
         src_couchbase_cluster_manager_sources =
             "user_settings.c ";
         src_couchbase_search_sources =
+            "sort.c " +
+            "sort_field.c " +
+            "sort_geo.c " +
+            "sort_id.c " +
+            "sort_score.c " +
             "boolean_field_query.c " +
             "boolean_query.c " +
             "conjunction_query.c " +

couchbase.c

@@ -312,6 +312,11 @@ PHP_MINIT_FUNCTION(couchbase)
     PHP_MINIT(TermSearchFacet)(INIT_FUNC_ARGS_PASSTHRU);
     PHP_MINIT(NumericRangeSearchFacet)(INIT_FUNC_ARGS_PASSTHRU);
     PHP_MINIT(DateRangeSearchFacet)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchSort)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchSortField)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchSortGeoDistance)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchSortId)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchSortScore)(INIT_FUNC_ARGS_PASSTHRU);
 
     PCBC_REGISTER_CONST(PERSISTTO_MASTER);
     PCBC_REGISTER_CONST(PERSISTTO_ONE);

couchbase.h

@@ -163,6 +163,11 @@ PHP_MINIT_FUNCTION(SearchFacet);
 PHP_MINIT_FUNCTION(TermSearchFacet);
 PHP_MINIT_FUNCTION(DateRangeSearchFacet);
 PHP_MINIT_FUNCTION(NumericRangeSearchFacet);
+PHP_MINIT_FUNCTION(SearchSort);
+PHP_MINIT_FUNCTION(SearchSortField);
+PHP_MINIT_FUNCTION(SearchSortGeoDistance);
+PHP_MINIT_FUNCTION(SearchSortId);
+PHP_MINIT_FUNCTION(SearchSortScore);
 
 zval *bop_get_return_doc(zval *return_value, const char *key, int key_len, int is_mapped TSRMLS_DC);
 
@@ -179,6 +184,7 @@ extern zend_class_entry *pcbc_mutation_state_ce;
 extern zend_class_entry *pcbc_exception_ce;
 extern zend_class_entry *pcbc_search_query_ce;
 extern zend_class_entry *pcbc_search_query_part_ce;
+extern zend_class_entry *pcbc_search_sort_ce;
 extern zend_class_entry *pcbc_search_facet_ce;
 extern zend_class_entry *pcbc_view_query_encodable_ce;
 extern zend_class_entry *pcbc_json_serializable_ce;
@@ -818,6 +824,11 @@ void pcbc_term_search_facet_init(zval *return_value, char *field, int field_len,
 void pcbc_date_range_search_facet_init(zval *return_value, char *field, int field_len, int limit TSRMLS_DC);
 void pcbc_numeric_range_search_facet_init(zval *return_value, char *field, int field_len, int limit TSRMLS_DC);
 
+void pcbc_search_sort_id_init(zval *return_value TSRMLS_DC);
+void pcbc_search_sort_score_init(zval *return_value TSRMLS_DC);
+void pcbc_search_sort_field_init(zval *return_value, const char *field, int field_len TSRMLS_DC);
+void pcbc_search_sort_geo_distance_init(zval *return_value, const char *field, int field_len, double lon, double lat TSRMLS_DC);
+
 #if PHP_VERSION_ID >= 70000
 void pcbc_lookup_in_builder_init(zval *return_value, zval *bucket, const char *id, int id_len, zval *args,
                                  int num_args TSRMLS_DC);

integration/SearchTest.php

@@ -16,8 +16,8 @@ public function __construct() {
         if ($this->testDsn === FALSE) {
             $this->testDsn = 'couchbase://localhost/';
         }
-        $this->authenticator = \Couchbase\ClassicAuthenticator();
-        $this->authenticator->bucket('beer-sample', getenv('CB_USER_PASSWORD'));
+        $this->authenticator = new \Couchbase\PasswordAuthenticator();
+        $this->authenticator->username(getenv('CB_USER'))->password(getenv('CB_PASSWORD'));
     }
 
     protected function setUp() {
@@ -59,7 +59,7 @@ function testSearchWithNoHits() {
 
     function testSearchWithConsistency() {
         $cluster = new \Couchbase\Cluster($this->testDsn . '?fetch_mutation_tokens=true');
-        $this->cluster->authenticate($this->authenticator);
+        $cluster->authenticate($this->authenticator);
         $bucket = $cluster->openBucket('beer-sample');
 
         $id = uniqid('testSearchWithConsistency');

package2.xml renamed to package.xml

@@ -126,9 +126,9 @@
             <file role="src" name="src/couchbase/search/date_range_query.c" />
             <file role="src" name="src/couchbase/search/disjunction_query.c" />
             <file role="src" name="src/couchbase/search/doc_id_query.c" />
+            <file role="src" name="src/couchbase/search/facet.c" />
             <file role="src" name="src/couchbase/search/geo_bounding_box_query.c" />
             <file role="src" name="src/couchbase/search/geo_distance_query.c" />
-            <file role="src" name="src/couchbase/search/facet.c" />
             <file role="src" name="src/couchbase/search/match_all_query.c" />
             <file role="src" name="src/couchbase/search/match_none_query.c" />
             <file role="src" name="src/couchbase/search/match_phrase_query.c" />
@@ -140,6 +140,11 @@
             <file role="src" name="src/couchbase/search/query_part.c" />
             <file role="src" name="src/couchbase/search/query_string_query.c" />
             <file role="src" name="src/couchbase/search/regexp_query.c" />
+            <file role="src" name="src/couchbase/search/sort.c" />
+            <file role="src" name="src/couchbase/search/sort_field.c" />
+            <file role="src" name="src/couchbase/search/sort_geo.c" />
+            <file role="src" name="src/couchbase/search/sort_id.c" />
+            <file role="src" name="src/couchbase/search/sort_score.c" />
             <file role="src" name="src/couchbase/search/term_facet.c" />
             <file role="src" name="src/couchbase/search/term_query.c" />
             <file role="src" name="src/couchbase/search/term_range_query.c" />