MediaWiki  1.28.0
ApiOpenSearch.php
Go to the documentation of this file.
1 <?php
28 
32 class ApiOpenSearch extends ApiBase {
33  use SearchApi;
34 
35  private $format = null;
36  private $fm = null;
37 
39  private $allowedParams = null;
40 
46  protected function getFormat() {
47  if ( $this->format === null ) {
48  $params = $this->extractRequestParams();
49  $format = $params['format'];
50 
52  if ( !in_array( $format, $allowedParams['format'][ApiBase::PARAM_TYPE] ) ) {
54  }
55 
56  if ( substr( $format, -2 ) === 'fm' ) {
57  $this->format = substr( $format, 0, -2 );
58  $this->fm = 'fm';
59  } else {
60  $this->format = $format;
61  $this->fm = '';
62  }
63  }
64  return $this->format;
65  }
66 
67  public function getCustomPrinter() {
68  switch ( $this->getFormat() ) {
69  case 'json':
70  return new ApiOpenSearchFormatJson(
71  $this->getMain(), $this->fm, $this->getParameter( 'warningsaserror' )
72  );
73 
74  case 'xml':
75  $printer = $this->getMain()->createPrinterByName( 'xml' . $this->fm );
76  $printer->setRootElement( 'SearchSuggestion' );
77  return $printer;
78 
79  default:
80  ApiBase::dieDebug( __METHOD__, "Unsupported format '{$this->getFormat()}'" );
81  }
82  }
83 
84  public function execute() {
85  $params = $this->extractRequestParams();
86  $search = $params['search'];
87  $suggest = $params['suggest'];
88  $results = [];
89  if ( !$suggest || $this->getConfig()->get( 'EnableOpenSearchSuggest' ) ) {
90  // Open search results may be stored for a very long time
91  $this->getMain()->setCacheMaxAge( $this->getConfig()->get( 'SearchSuggestCacheExpiry' ) );
92  $this->getMain()->setCacheMode( 'public' );
93  $results = $this->search( $search, $params );
94 
95  // Allow hooks to populate extracts and images
96  Hooks::run( 'ApiOpenSearchSuggest', [ &$results ] );
97 
98  // Trim extracts, if necessary
99  $length = $this->getConfig()->get( 'OpenSearchDescriptionLength' );
100  foreach ( $results as &$r ) {
101  if ( is_string( $r['extract'] ) && !$r['extract trimmed'] ) {
102  $r['extract'] = self::trimExtract( $r['extract'], $length );
103  }
104  }
105  }
106 
107  // Populate result object
108  $this->populateResult( $search, $results );
109  }
110 
117  private function search( $search, array $params ) {
118  $searchEngine = $this->buildSearchEngine( $params );
119  $titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
120  $results = [];
121 
122  if ( !$titles ) {
123  return $results;
124  }
125 
126  // Special pages need unique integer ids in the return list, so we just
127  // assign them negative numbers because those won't clash with the
128  // always positive articleIds that non-special pages get.
129  $nextSpecialPageId = -1;
130 
131  if ( $params['redirects'] === null ) {
132  // Backwards compatibility, don't resolve for JSON.
133  $resolveRedir = $this->getFormat() !== 'json';
134  } else {
135  $resolveRedir = $params['redirects'] === 'resolve';
136  }
137 
138  if ( $resolveRedir ) {
139  // Query for redirects
140  $redirects = [];
141  $lb = new LinkBatch( $titles );
142  if ( !$lb->isEmpty() ) {
143  $db = $this->getDB();
144  $res = $db->select(
145  [ 'page', 'redirect' ],
146  [ 'page_namespace', 'page_title', 'rd_namespace', 'rd_title' ],
147  [
148  'rd_from = page_id',
149  'rd_interwiki IS NULL OR rd_interwiki = ' . $db->addQuotes( '' ),
150  $lb->constructSet( 'page', $db ),
151  ],
152  __METHOD__
153  );
154  foreach ( $res as $row ) {
155  $redirects[$row->page_namespace][$row->page_title] =
156  [ $row->rd_namespace, $row->rd_title ];
157  }
158  }
159 
160  // Bypass any redirects
161  $seen = [];
162  foreach ( $titles as $title ) {
163  $ns = $title->getNamespace();
164  $dbkey = $title->getDBkey();
165  $from = null;
166  if ( isset( $redirects[$ns][$dbkey] ) ) {
167  list( $ns, $dbkey ) = $redirects[$ns][$dbkey];
168  $from = $title;
169  $title = Title::makeTitle( $ns, $dbkey );
170  }
171  if ( !isset( $seen[$ns][$dbkey] ) ) {
172  $seen[$ns][$dbkey] = true;
173  $resultId = $title->getArticleID();
174  if ( $resultId === 0 ) {
175  $resultId = $nextSpecialPageId;
176  $nextSpecialPageId -= 1;
177  }
178  $results[$resultId] = [
179  'title' => $title,
180  'redirect from' => $from,
181  'extract' => false,
182  'extract trimmed' => false,
183  'image' => false,
184  'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ),
185  ];
186  }
187  }
188  } else {
189  foreach ( $titles as $title ) {
190  $resultId = $title->getArticleID();
191  if ( $resultId === 0 ) {
192  $resultId = $nextSpecialPageId;
193  $nextSpecialPageId -= 1;
194  }
195  $results[$resultId] = [
196  'title' => $title,
197  'redirect from' => null,
198  'extract' => false,
199  'extract trimmed' => false,
200  'image' => false,
201  'url' => wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ),
202  ];
203  }
204  }
205 
206  return $results;
207  }
208 
213  protected function populateResult( $search, &$results ) {
214  $result = $this->getResult();
215 
216  switch ( $this->getFormat() ) {
217  case 'json':
218  // http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1
219  $result->addArrayType( null, 'array' );
220  $result->addValue( null, 0, strval( $search ) );
221  $terms = [];
222  $descriptions = [];
223  $urls = [];
224  foreach ( $results as $r ) {
225  $terms[] = $r['title']->getPrefixedText();
226  $descriptions[] = strval( $r['extract'] );
227  $urls[] = $r['url'];
228  }
229  $result->addValue( null, 1, $terms );
230  $result->addValue( null, 2, $descriptions );
231  $result->addValue( null, 3, $urls );
232  break;
233 
234  case 'xml':
235  // http://msdn.microsoft.com/en-us/library/cc891508%28v=vs.85%29.aspx
236  $imageKeys = [
237  'source' => true,
238  'alt' => true,
239  'width' => true,
240  'height' => true,
241  'align' => true,
242  ];
243  $items = [];
244  foreach ( $results as $r ) {
245  $item = [
246  'Text' => $r['title']->getPrefixedText(),
247  'Url' => $r['url'],
248  ];
249  if ( is_string( $r['extract'] ) && $r['extract'] !== '' ) {
250  $item['Description'] = $r['extract'];
251  }
252  if ( is_array( $r['image'] ) && isset( $r['image']['source'] ) ) {
253  $item['Image'] = array_intersect_key( $r['image'], $imageKeys );
254  }
255  ApiResult::setSubelementsList( $item, array_keys( $item ) );
256  $items[] = $item;
257  }
258  ApiResult::setIndexedTagName( $items, 'Item' );
259  $result->addValue( null, 'version', '2.0' );
260  $result->addValue( null, 'xmlns', 'http://opensearch.org/searchsuggest2' );
261  $result->addValue( null, 'Query', strval( $search ) );
262  $result->addSubelementsList( null, 'Query' );
263  $result->addValue( null, 'Section', $items );
264  break;
265 
266  default:
267  ApiBase::dieDebug( __METHOD__, "Unsupported format '{$this->getFormat()}'" );
268  }
269  }
270 
271  public function getAllowedParams() {
272  if ( $this->allowedParams !== null ) {
273  return $this->allowedParams;
274  }
275  $this->allowedParams = $this->buildCommonApiParams( false ) + [
276  'suggest' => false,
277  'redirects' => [
278  ApiBase::PARAM_TYPE => [ 'return', 'resolve' ],
279  ],
280  'format' => [
281  ApiBase::PARAM_DFLT => 'json',
282  ApiBase::PARAM_TYPE => [ 'json', 'jsonfm', 'xml', 'xmlfm' ],
283  ],
284  'warningsaserror' => false,
285  ];
286 
287  // Use open search specific default limit
288  $this->allowedParams['limit'][ApiBase::PARAM_DFLT] = $this->getConfig()->get(
289  'OpenSearchDefaultLimit'
290  );
291 
292  return $this->allowedParams;
293  }
294 
295  public function getSearchProfileParams() {
296  return [
297  'profile' => [
298  'profile-type' => SearchEngine::COMPLETION_PROFILE_TYPE,
299  'help-message' => 'apihelp-query+prefixsearch-param-profile'
300  ],
301  ];
302  }
303 
304  protected function getExamplesMessages() {
305  return [
306  'action=opensearch&search=Te'
307  => 'apihelp-opensearch-example-te',
308  ];
309  }
310 
311  public function getHelpUrls() {
312  return 'https://www.mediawiki.org/wiki/API:Opensearch';
313  }
314 
325  public static function trimExtract( $text, $length ) {
326  static $regex = null;
327 
328  if ( $regex === null ) {
329  $endchars = [
330  '([^\d])\.\s', '\!\s', '\?\s', // regular ASCII
331  '。', // full-width ideographic full-stop
332  '.', '!', '?', // double-width roman forms
333  '。', // half-width ideographic full stop
334  ];
335  $endgroup = implode( '|', $endchars );
336  $end = "(?:$endgroup)";
337  $sentence = ".{{$length},}?$end+";
338  $regex = "/^($sentence)/u";
339  }
340 
341  $matches = [];
342  if ( preg_match( $regex, $text, $matches ) ) {
343  return trim( $matches[1] );
344  } else {
345  // Just return the first line
346  return trim( explode( "\n", $text )[0] );
347  }
348  }
349 
357  public static function getOpenSearchTemplate( $type ) {
358  $config = MediaWikiServices::getInstance()->getSearchEngineConfig();
359  $template = $config->getConfig()->get( 'OpenSearchTemplate' );
360 
361  if ( $template && $type === 'application/x-suggestions+json' ) {
362  return $template;
363  }
364 
365  $ns = implode( '|', $config->defaultNamespaces() );
366  if ( !$ns ) {
367  $ns = '0';
368  }
369 
370  switch ( $type ) {
371  case 'application/x-suggestions+json':
372  return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
373  . '?action=opensearch&search={searchTerms}&namespace=' . $ns;
374 
375  case 'application/x-suggestions+xml':
376  return $config->getConfig()->get( 'CanonicalServer' ) . wfScript( 'api' )
377  . '?action=opensearch&format=xml&search={searchTerms}&namespace=' . $ns;
378 
379  default:
380  throw new MWException( __METHOD__ . ": Unknown type '$type'" );
381  }
382  }
383 }
384 
386  private $warningsAsError = false;
387 
388  public function __construct( ApiMain $main, $fm, $warningsAsError ) {
389  parent::__construct( $main, "json$fm" );
390  $this->warningsAsError = $warningsAsError;
391  }
392 
393  public function execute() {
394  if ( !$this->getResult()->getResultData( 'error' ) ) {
395  $result = $this->getResult();
396 
397  // Ignore warnings or treat as errors, as requested
398  $warnings = $result->removeValue( 'warnings', null );
399  if ( $this->warningsAsError && $warnings ) {
400  $this->dieUsage(
401  'Warnings cannot be represented in OpenSearch JSON format', 'warnings', 0,
402  [ 'warnings' => $warnings ]
403  );
404  }
405 
406  // Ignore any other unexpected keys (e.g. from $wgDebugToolbar)
407  $remove = array_keys( array_diff_key(
408  $result->getResultData(),
409  [ 0 => 'search', 1 => 'terms', 2 => 'descriptions', 3 => 'urls' ]
410  ) );
411  foreach ( $remove as $key ) {
412  $result->removeValue( $key, null );
413  }
414  }
415 
416  parent::execute();
417  }
418 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
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
the array() calling protocol came about after MediaWiki 1.4rc1.
getResult()
Get the result object.
Definition: ApiBase.php:577
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
getParameter($paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:702
$batch execute()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getMain()
Get the main module.
Definition: ApiBase.php:473
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
trait SearchApi
Traits for API components that use a SearchEngine.
Definition: SearchApi.php:28
__construct(ApiMain $main, $fm, $warningsAsError)
populateResult($search, &$results)
getDB()
Gets a default replica DB connection object.
Definition: ApiBase.php:605
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
buildCommonApiParams($isScrollable=true)
The set of api parameters that are shared between api calls that call the SearchEngine.
Definition: SearchApi.php:46
const PROTO_CURRENT
Definition: Defines.php:226
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 MediaWikiServices
Definition: injection.txt:23
static trimExtract($text, $length)
Trim an extract to a sensible length.
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template
Definition: hooks.txt:802
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
$res
Definition: database.txt:21
getFormat()
Get the output format.
getConfig()
Get the Config object.
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
const COMPLETION_PROFILE_TYPE
string profile type for completionSearch
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
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
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes...
Definition: ApiResult.php:567
$from
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
buildSearchEngine(array $params=null)
Build the search engine to use.
Definition: SearchApi.php:151
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
search($search, array $params)
Perform the search.
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1574
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
API JSON output formatter.
static dieDebug($method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2284
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 one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
array $allowedParams
list of api allowed params
static getOpenSearchTemplate($type)
Fetch the template for a type.
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1610
$matches