* (bug 20131) PHP Notice: Undfined index: page_latest in includes/ChangesList.php...
[lhc/web/wiklou.git] / includes / PrefixSearch.php
index 1a43afe..10c8593 100644 (file)
@@ -1,23 +1,34 @@
 <?php
 
+/**
+ * PrefixSearch - Handles searching prefixes of titles and finding any page
+ * names that match. Used largely by the OpenSearch implementation.
+ * 
+ * @ingroup Search
+ */
+
 class PrefixSearch {
        /**
         * Do a prefix search of titles and return a list of matching page names.
         * @param string $search
         * @param int $limit
+        * @param array $namespaces - used if query is not explicitely prefixed
         * @return array of strings
         */
-       public static function titleSearch( $search, $limit ) {
+       public static function titleSearch( $search, $limit, $namespaces=array() ) {
                $search = trim( $search );
                if( $search == '' ) {
                        return array(); // Return empty result
                }
-
+               $namespaces = self::validateNamespaces( $namespaces );
+               
                $title = Title::newFromText( $search );
                if( $title && $title->getInterwiki() == '' ) {
-                       $ns = $title->getNamespace();
+                       $ns = array($title->getNamespace());
+                       if($ns[0] == NS_MAIN) 
+                               $ns = $namespaces; // no explicit prefix, use default namespaces
                        return self::searchBackend(
-                               $title->getNamespace(), $title->getText(), $limit );
+                               $ns, $title->getText(), $limit );
                }
 
                // Is this a namespace prefix?
@@ -26,29 +37,32 @@ class PrefixSearch {
                        && $title->getNamespace() != NS_MAIN
                        && $title->getInterwiki() == '' ) {
                        return self::searchBackend(
-                               $title->getNamespace(), '', $limit );
+                               array($title->getNamespace()), '', $limit );
                }
-
-               return self::searchBackend( 0, $search, $limit );
+                               
+               return self::searchBackend( $namespaces, $search, $limit );
        }
 
 
        /**
         * Do a prefix search of titles and return a list of matching page names.
+        * @param array $namespaces
         * @param string $search
         * @param int $limit
         * @return array of strings
         */
-       protected static function searchBackend( $ns, $search, $limit ) {
-               if( $ns == NS_MEDIA ) {
-                       $ns = NS_IMAGE;
-               } elseif( $ns == NS_SPECIAL ) {
-                       return self::specialSearch( $search, $limit );
+       protected static function searchBackend( $namespaces, $search, $limit ) {
+               if( count($namespaces) == 1 ){
+                       $ns = $namespaces[0];
+                       if( $ns == NS_MEDIA ) {
+                               $namespaces = array(NS_FILE);
+                       } elseif( $ns == NS_SPECIAL ) {
+                               return self::specialSearch( $search, $limit );
+                       }
                }
-
                $srchres = array();
-               if( wfRunHooks( 'PrefixSearchBackend', array( $ns, $search, $limit, &$srchres ) ) ) {
-                       return self::defaultSearchBackend( $ns, $search, $limit );
+               if( wfRunHooks( 'PrefixSearchBackend', array( $namespaces, $search, $limit, &$srchres ) ) ) {
+                       return self::defaultSearchBackend( $namespaces, $search, $limit );
                }
                return $srchres;
        }
@@ -89,20 +103,20 @@ class PrefixSearch {
 
        /**
         * Unless overridden by PrefixSearchBackend hook...
-        * This is case-sensitive except the first letter (per $wgCapitalLinks)
+        * This is case-sensitive (First character may
+        * be automatically capitalized by Title::secureAndSpit()
+        * later on depending on $wgCapitalLinks)
         *
-        * @param int $ns Namespace to search in
+        * @param array $namespaces Namespaces to search in
         * @param string $search term
         * @param int $limit max number of items to return
         * @return array of title strings
         */
-       protected static function defaultSearchBackend( $ns, $search, $limit ) {
-               global $wgCapitalLinks, $wgContLang;
-
-               if( $wgCapitalLinks ) {
-                       $search = $wgContLang->ucfirst( $search );
-               }
-
+       protected static function defaultSearchBackend( $namespaces, $search, $limit ) {
+               $ns = array_shift($namespaces); // support only one namespace
+               if( in_array(NS_MAIN,$namespaces))
+                       $ns = NS_MAIN; // if searching on many always default to main 
+               
                // Prepare nested request
                $req = new FauxRequest(array (
                        'action' => 'query',
@@ -121,7 +135,7 @@ class PrefixSearch {
 
                // Reformat useful data for future printing by JSON engine
                $srchres = array ();
-               foreach ($data['query']['allpages'] as & $pageinfo) {
+               foreach ((array)$data['query']['allpages'] as $pageinfo) {
                        // Note: this data will no be printable by the xml engine
                        // because it does not support lists of unnamed items
                        $srchres[] = $pageinfo['title'];
@@ -129,5 +143,25 @@ class PrefixSearch {
 
                return $srchres;
        }
-
+       
+       /**
+        * Validate an array of numerical namespace indexes
+        * 
+        * @param array $namespaces
+        */
+       protected static function validateNamespaces($namespaces){
+               global $wgContLang;
+               $validNamespaces = $wgContLang->getNamespaces();
+               if( is_array($namespaces) && count($namespaces)>0 ){
+                       $valid = array();
+                       foreach ($namespaces as $ns){
+                               if( is_numeric($ns) && array_key_exists($ns, $validNamespaces) )
+                                       $valid[] = $ns;
+                       }
+                       if( count($valid) > 0 )
+                               return $valid;
+               }
+               
+               return array( NS_MAIN );
+       }
 }