includes/PrefixSearch.php

   1 <?php
   2 /**
   3  * PrefixSearch - Handles searching prefixes of titles and finding any page
   4  * names that match. Used largely by the OpenSearch implementation.
   5  *
   6  * @ingroup Search
   7  */
   8
   9 class PrefixSearch {
  10         /**
  11          * Do a prefix search of titles and return a list of matching page names.
  12          *
  13          * @param $search String
  14          * @param $limit Integer
  15          * @param $namespaces Array: used if query is not explicitely prefixed
  16          * @return Array of strings
  17          */
  18         public static function titleSearch( $search, $limit, $namespaces=array() ) {
  19                 $search = trim( $search );
  20                 if( $search == '' ) {
  21                         return array(); // Return empty result
  22                 }
  23                 $namespaces = self::validateNamespaces( $namespaces );
  24
  25                 $title = Title::newFromText( $search );
  26                 if( $title && $title->getInterwiki() == '' ) {
  27                         $ns = array($title->getNamespace());
  28                         if($ns[0] == NS_MAIN)
  29                                 $ns = $namespaces; // no explicit prefix, use default namespaces
  30                         return self::searchBackend(
  31                                 $ns, $title->getText(), $limit );
  32                 }
  33
  34                 // Is this a namespace prefix?
  35                 $title = Title::newFromText( $search . 'Dummy' );
  36                 if( $title && $title->getText() == 'Dummy'
  37                         && $title->getNamespace() != NS_MAIN
  38                         && $title->getInterwiki() == '' ) {
  39                         return self::searchBackend(
  40                                 array($title->getNamespace()), '', $limit );
  41                 }
  42
  43                 return self::searchBackend( $namespaces, $search, $limit );
  44         }
  45
  46
  47         /**
  48          * Do a prefix search of titles and return a list of matching page names.
  49          * @param $namespaces Array
  50          * @param $search String
  51          * @param $limit Integer
  52          * @return Array of strings
  53          */
  54         protected static function searchBackend( $namespaces, $search, $limit ) {
  55                 if( count($namespaces) == 1 ){
  56                         $ns = $namespaces[0];
  57                         if( $ns == NS_MEDIA ) {
  58                                 $namespaces = array(NS_FILE);
  59                         } elseif( $ns == NS_SPECIAL ) {
  60                                 return self::specialSearch( $search, $limit );
  61                         }
  62                 }
  63                 $srchres = array();
  64                 if( wfRunHooks( 'PrefixSearchBackend', array( $namespaces, $search, $limit, &$srchres ) ) ) {
  65                         return self::defaultSearchBackend( $namespaces, $search, $limit );
  66                 }
  67                 return $srchres;
  68         }
  69
  70         /**
  71          * Prefix search special-case for Special: namespace.
  72          *
  73          * @param $search String: term
  74          * @param $limit Integer: max number of items to return
  75          * @return Array
  76          */
  77         protected static function specialSearch( $search, $limit ) {
  78                 global $wgContLang;
  79
  80                 $searchKey = $wgContLang->caseFold( $search );
  81
  82                 // Unlike SpecialPage itself, we want the canonical forms of both
  83                 // canonical and alias title forms...
  84                 SpecialPage::initList();
  85                 SpecialPage::initAliasList();
  86                 $keys = array();
  87                 foreach( array_keys( SpecialPage::$mList ) as $page ) {
  88                         $keys[$wgContLang->caseFold( $page )] = $page;
  89                 }
  90
  91                 foreach( $wgContLang->getSpecialPageAliases() as $page => $aliases ) {
  92                         if( !array_key_exists( $page, SpecialPage::$mList ) ) {# bug 20885
  93                                 continue;
  94                         }
  95
  96                         foreach( $aliases as $alias ) {
  97                                 $keys[$wgContLang->caseFold( $alias )] = $alias;
  98                         }
  99                 }
 100                 ksort( $keys );
 101
 102                 $srchres = array();
 103                 foreach( $keys as $pageKey => $page ) {
 104                         if( $searchKey === '' || strpos( $pageKey, $searchKey ) === 0 ) {
 105                                 wfSuppressWarnings();
 106                                 $srchres[] = SpecialPage::getTitleFor( $page )->getPrefixedText();
 107                                 wfRestoreWarnings();
 108                         }
 109
 110                         if( count( $srchres ) >= $limit ) {
 111                                 break;
 112                         }
 113                 }
 114
 115                 return $srchres;
 116         }
 117
 118         /**
 119          * Unless overridden by PrefixSearchBackend hook...
 120          * This is case-sensitive (First character may
 121          * be automatically capitalized by Title::secureAndSpit()
 122          * later on depending on $wgCapitalLinks)
 123          *
 124          * @param $namespaces Array: namespaces to search in
 125          * @param $search String: term
 126          * @param $limit Integer: max number of items to return
 127          * @return Array of title strings
 128          */
 129         protected static function defaultSearchBackend( $namespaces, $search, $limit ) {
 130                 $ns = array_shift($namespaces); // support only one namespace
 131                 if( in_array(NS_MAIN,$namespaces))
 132                         $ns = NS_MAIN; // if searching on many always default to main
 133
 134                 // Prepare nested request
 135                 $req = new FauxRequest(array (
 136                         'action' => 'query',
 137                         'list' => 'allpages',
 138                         'apnamespace' => $ns,
 139                         'aplimit' => $limit,
 140                         'apprefix' => $search
 141                 ));
 142
 143                 // Execute
 144                 $module = new ApiMain($req);
 145                 $module->execute();
 146
 147                 // Get resulting data
 148                 $data = $module->getResultData();
 149
 150                 // Reformat useful data for future printing by JSON engine
 151                 $srchres = array ();
 152                 foreach ((array)$data['query']['allpages'] as $pageinfo) {
 153                         // Note: this data will no be printable by the xml engine
 154                         // because it does not support lists of unnamed items
 155                         $srchres[] = $pageinfo['title'];
 156                 }
 157
 158                 return $srchres;
 159         }
 160
 161         /**
 162          * Validate an array of numerical namespace indexes
 163          *
 164          * @param $namespaces Array
 165          * @return Array
 166          */
 167         protected static function validateNamespaces($namespaces){
 168                 global $wgContLang;
 169                 $validNamespaces = $wgContLang->getNamespaces();
 170                 if( is_array($namespaces) && count($namespaces)>0 ){
 171                         $valid = array();
 172                         foreach ($namespaces as $ns){
 173                                 if( is_numeric($ns) && array_key_exists($ns, $validNamespaces) )
 174                                         $valid[] = $ns;
 175                         }
 176                         if( count($valid) > 0 )
 177                                 return $valid;
 178                 }
 179
 180                 return array( NS_MAIN );
 181         }
 182 }