MediaWiki  1.28.0
PrefixSearch.php
Go to the documentation of this file.
1 <?php
30 abstract class PrefixSearch {
41  public static function titleSearch( $search, $limit, $namespaces = [], $offset = 0 ) {
42  $prefixSearch = new StringPrefixSearch;
43  return $prefixSearch->search( $search, $limit, $namespaces, $offset );
44  }
45 
55  public function search( $search, $limit, $namespaces = [], $offset = 0 ) {
56  $search = trim( $search );
57  if ( $search == '' ) {
58  return []; // Return empty result
59  }
60 
61  $hasNamespace = $this->extractNamespace( $search );
62  if ( $hasNamespace ) {
63  list( $namespace, $search ) = $hasNamespace;
64  $namespaces = [ $namespace ];
65  } else {
67  Hooks::run( 'PrefixSearchExtractNamespace', [ &$namespaces, &$search ] );
68  }
69 
70  return $this->searchBackend( $namespaces, $search, $limit, $offset );
71  }
72 
79  protected function extractNamespace( $input ) {
80  if ( strpos( $input, ':' ) === false ) {
81  return false;
82  }
83 
84  // Namespace prefix only
85  $title = Title::newFromText( $input . 'Dummy' );
86  if (
87  $title &&
88  $title->getText() === 'Dummy' &&
89  !$title->inNamespace( NS_MAIN ) &&
90  !$title->isExternal()
91  ) {
92  return [ $title->getNamespace(), '' ];
93  }
94 
95  // Namespace prefix with additional input
96  $title = Title::newFromText( $input );
97  if (
98  $title &&
99  !$title->inNamespace( NS_MAIN ) &&
100  !$title->isExternal()
101  ) {
102  // getText provides correct capitalization
103  return [ $title->getNamespace(), $title->getText() ];
104  }
105 
106  return false;
107  }
108 
118  public function searchWithVariants( $search, $limit, array $namespaces, $offset = 0 ) {
119  $searches = $this->search( $search, $limit, $namespaces, $offset );
120 
121  // if the content language has variants, try to retrieve fallback results
122  $fallbackLimit = $limit - count( $searches );
123  if ( $fallbackLimit > 0 ) {
125 
126  $fallbackSearches = $wgContLang->autoConvertToAllVariants( $search );
127  $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
128 
129  foreach ( $fallbackSearches as $fbs ) {
130  $fallbackSearchResult = $this->search( $fbs, $fallbackLimit, $namespaces );
131  $searches = array_merge( $searches, $fallbackSearchResult );
132  $fallbackLimit -= count( $fallbackSearchResult );
133 
134  if ( $fallbackLimit == 0 ) {
135  break;
136  }
137  }
138  }
139  return $searches;
140  }
141 
149  abstract protected function titles( array $titles );
150 
159  abstract protected function strings( array $strings );
160 
169  protected function searchBackend( $namespaces, $search, $limit, $offset ) {
170  if ( count( $namespaces ) == 1 ) {
171  $ns = $namespaces[0];
172  if ( $ns == NS_MEDIA ) {
173  $namespaces = [ NS_FILE ];
174  } elseif ( $ns == NS_SPECIAL ) {
175  return $this->titles( $this->specialSearch( $search, $limit, $offset ) );
176  }
177  }
178  $srchres = [];
179  if ( Hooks::run(
180  'PrefixSearchBackend',
181  [ $namespaces, $search, $limit, &$srchres, $offset ]
182  ) ) {
183  return $this->titles( $this->defaultSearchBackend( $namespaces, $search, $limit, $offset ) );
184  }
185  return $this->strings(
186  $this->handleResultFromHook( $srchres, $namespaces, $search, $limit, $offset ) );
187  }
188 
189  private function handleResultFromHook( $srchres, $namespaces, $search, $limit, $offset ) {
190  if ( $offset === 0 ) {
191  // Only perform exact db match if offset === 0
192  // This is still far from perfect but at least we avoid returning the
193  // same title afain and again when the user is scrolling with a query
194  // that matches a title in the db.
195  $rescorer = new SearchExactMatchRescorer();
196  $srchres = $rescorer->rescore( $search, $namespaces, $srchres, $limit );
197  }
198  return $srchres;
199  }
200 
209  protected function specialSearch( $search, $limit, $offset ) {
211 
212  $searchParts = explode( '/', $search, 2 );
213  $searchKey = $searchParts[0];
214  $subpageSearch = isset( $searchParts[1] ) ? $searchParts[1] : null;
215 
216  // Handle subpage search separately.
217  if ( $subpageSearch !== null ) {
218  // Try matching the full search string as a page name
219  $specialTitle = Title::makeTitleSafe( NS_SPECIAL, $searchKey );
220  if ( !$specialTitle ) {
221  return [];
222  }
223  $special = SpecialPageFactory::getPage( $specialTitle->getText() );
224  if ( $special ) {
225  $subpages = $special->prefixSearchSubpages( $subpageSearch, $limit, $offset );
226  return array_map( function ( $sub ) use ( $specialTitle ) {
227  return $specialTitle->getSubpage( $sub );
228  }, $subpages );
229  } else {
230  return [];
231  }
232  }
233 
234  # normalize searchKey, so aliases with spaces can be found - bug 25675
235  $searchKey = str_replace( ' ', '_', $searchKey );
236  $searchKey = $wgContLang->caseFold( $searchKey );
237 
238  // Unlike SpecialPage itself, we want the canonical forms of both
239  // canonical and alias title forms...
240  $keys = [];
241  foreach ( SpecialPageFactory::getNames() as $page ) {
242  $keys[$wgContLang->caseFold( $page )] = $page;
243  }
244 
245  foreach ( $wgContLang->getSpecialPageAliases() as $page => $aliases ) {
246  if ( !in_array( $page, SpecialPageFactory::getNames() ) ) {# bug 20885
247  continue;
248  }
249 
250  foreach ( $aliases as $alias ) {
251  $keys[$wgContLang->caseFold( $alias )] = $alias;
252  }
253  }
254  ksort( $keys );
255 
256  $srchres = [];
257  $skipped = 0;
258  foreach ( $keys as $pageKey => $page ) {
259  if ( $searchKey === '' || strpos( $pageKey, $searchKey ) === 0 ) {
260  // bug 27671: Don't use SpecialPage::getTitleFor() here because it
261  // localizes its input leading to searches for e.g. Special:All
262  // returning Spezial:MediaWiki-Systemnachrichten and returning
263  // Spezial:Alle_Seiten twice when $wgLanguageCode == 'de'
264  if ( $offset > 0 && $skipped < $offset ) {
265  $skipped++;
266  continue;
267  }
268  $srchres[] = Title::makeTitleSafe( NS_SPECIAL, $page );
269  }
270 
271  if ( count( $srchres ) >= $limit ) {
272  break;
273  }
274  }
275 
276  return $srchres;
277  }
278 
291  public function defaultSearchBackend( $namespaces, $search, $limit, $offset ) {
292  // Backwards compatability with old code. Default to NS_MAIN if no namespaces provided.
293  if ( $namespaces === null ) {
294  $namespaces = [];
295  }
296  if ( !$namespaces ) {
297  $namespaces[] = NS_MAIN;
298  }
299 
300  // Construct suitable prefix for each namespace. They differ in cases where
301  // some namespaces always capitalize and some don't.
302  $prefixes = [];
303  foreach ( $namespaces as $namespace ) {
304  // For now, if special is included, ignore the other namespaces
305  if ( $namespace == NS_SPECIAL ) {
306  return $this->specialSearch( $search, $limit, $offset );
307  }
308 
309  $title = Title::makeTitleSafe( $namespace, $search );
310  // Why does the prefix default to empty?
311  $prefix = $title ? $title->getDBkey() : '';
312  $prefixes[$prefix][] = $namespace;
313  }
314 
315  $dbr = wfGetDB( DB_REPLICA );
316  // Often there is only one prefix that applies to all requested namespaces,
317  // but sometimes there are two if some namespaces do not always capitalize.
318  $conds = [];
319  foreach ( $prefixes as $prefix => $namespaces ) {
320  $condition = [
321  'page_namespace' => $namespaces,
322  'page_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
323  ];
324  $conds[] = $dbr->makeList( $condition, LIST_AND );
325  }
326 
327  $table = 'page';
328  $fields = [ 'page_id', 'page_namespace', 'page_title' ];
329  $conds = $dbr->makeList( $conds, LIST_OR );
330  $options = [
331  'LIMIT' => $limit,
332  'ORDER BY' => [ 'page_title', 'page_namespace' ],
333  'OFFSET' => $offset
334  ];
335 
336  $res = $dbr->select( $table, $fields, $conds, __METHOD__, $options );
337 
338  return iterator_to_array( TitleArray::newFromResult( $res ) );
339  }
340 
347  protected function validateNamespaces( $namespaces ) {
349 
350  // We will look at each given namespace against wgContLang namespaces
351  $validNamespaces = $wgContLang->getNamespaces();
352  if ( is_array( $namespaces ) && count( $namespaces ) > 0 ) {
353  $valid = [];
354  foreach ( $namespaces as $ns ) {
355  if ( is_numeric( $ns ) && array_key_exists( $ns, $validNamespaces ) ) {
356  $valid[] = $ns;
357  }
358  }
359  if ( count( $valid ) > 0 ) {
360  return $valid;
361  }
362  }
363 
364  return [ NS_MAIN ];
365  }
366 }
367 
374 
375  protected function titles( array $titles ) {
376  return $titles;
377  }
378 
379  protected function strings( array $strings ) {
380  $titles = array_map( 'Title::newFromText', $strings );
381  $lb = new LinkBatch( $titles );
382  $lb->setCaller( __METHOD__ );
383  $lb->execute();
384  return $titles;
385  }
386 }
387 
394 
395  protected function titles( array $titles ) {
396  return array_map( function ( Title $t ) {
397  return $t->getPrefixedText();
398  }, $titles );
399  }
400 
401  protected function strings( array $strings ) {
402  return $strings;
403  }
404 }
extractNamespace($input)
Figure out if given input contains an explicit namespace.
validateNamespaces($namespaces)
Validate an array of numerical namespace indexes.
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:1007
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
searchWithVariants($search, $limit, array $namespaces, $offset=0)
Do a prefix search for all possible variants of the prefix.
Performs prefix search, returning strings.
the array() calling protocol came about after MediaWiki 1.4rc1.
const NS_MAIN
Definition: Defines.php:56
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
handleResultFromHook($srchres, $namespaces, $search, $limit, $offset)
search($search, $limit, $namespaces=[], $offset=0)
Do a prefix search of titles and return a list of matching page names.
const NS_SPECIAL
Definition: Defines.php:45
strings(array $strings)
When implemented in a descendant class, receives an array of titles as strings and returns either an ...
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1455
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
strings(array $strings)
specialSearch($search, $limit, $offset)
Prefix search special-case for Special: namespace.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
static getPage($name)
Find the object with a given name and return it (or NULL)
titles(array $titles)
const LIST_AND
Definition: Defines.php:35
titles(array $titles)
static getNames()
Returns a list of canonical special page names.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
defaultSearchBackend($namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
const NS_MEDIA
Definition: Defines.php:44
$res
Definition: database.txt:21
searchBackend($namespaces, $search, $limit, $offset)
Do a prefix search of titles and return a list of matching page names.
An utility class to rescore search results by looking for an exact match in the db and add the page f...
strings(array $strings)
static titleSearch($search, $limit, $namespaces=[], $offset=0)
Do a prefix search of titles and return a list of matching page names.
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
const NS_FILE
Definition: Defines.php:62
static newFromResult($res)
Definition: TitleArray.php:38
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:953
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Performs prefix search, returning Title objects.
Handles searching prefixes of titles and finding any page names that match.
const LIST_OR
Definition: Defines.php:38
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
titles(array $titles)
When implemented in a descendant class, receives an array of Title objects and returns either an unmo...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
const DB_REPLICA
Definition: defines.php:22
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2491