MediaWiki  1.28.0
ApiQueryBase.php
Go to the documentation of this file.
1 <?php
34 abstract class ApiQueryBase extends ApiBase {
35 
37 
43  public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
44  parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
45  $this->mQueryModule = $queryModule;
46  $this->mDb = null;
47  $this->resetQueryParams();
48  }
49 
50  /************************************************************************/
66  public function getCacheMode( $params ) {
67  return 'private';
68  }
69 
79  public function requestExtraData( $pageSet ) {
80  }
81 
84  /************************************************************************/
93  public function getQuery() {
94  return $this->mQueryModule;
95  }
96 
100  public function getParent() {
101  return $this->getQuery();
102  }
103 
108  protected function getDB() {
109  if ( is_null( $this->mDb ) ) {
110  $this->mDb = $this->getQuery()->getDB();
111  }
112 
113  return $this->mDb;
114  }
115 
124  public function selectNamedDB( $name, $db, $groups ) {
125  $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
126  return $this->mDb;
127  }
128 
133  protected function getPageSet() {
134  return $this->getQuery()->getPageSet();
135  }
136 
139  /************************************************************************/
147  protected function resetQueryParams() {
148  $this->tables = [];
149  $this->where = [];
150  $this->fields = [];
151  $this->options = [];
152  $this->join_conds = [];
153  }
154 
161  protected function addTables( $tables, $alias = null ) {
162  if ( is_array( $tables ) ) {
163  if ( !is_null( $alias ) ) {
164  ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
165  }
166  $this->tables = array_merge( $this->tables, $tables );
167  } else {
168  if ( !is_null( $alias ) ) {
169  $this->tables[$alias] = $tables;
170  } else {
171  $this->tables[] = $tables;
172  }
173  }
174  }
175 
184  protected function addJoinConds( $join_conds ) {
185  if ( !is_array( $join_conds ) ) {
186  ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
187  }
188  $this->join_conds = array_merge( $this->join_conds, $join_conds );
189  }
190 
195  protected function addFields( $value ) {
196  if ( is_array( $value ) ) {
197  $this->fields = array_merge( $this->fields, $value );
198  } else {
199  $this->fields[] = $value;
200  }
201  }
202 
209  protected function addFieldsIf( $value, $condition ) {
210  if ( $condition ) {
211  $this->addFields( $value );
212 
213  return true;
214  }
215 
216  return false;
217  }
218 
230  protected function addWhere( $value ) {
231  if ( is_array( $value ) ) {
232  // Sanity check: don't insert empty arrays,
233  // Database::makeList() chokes on them
234  if ( count( $value ) ) {
235  $this->where = array_merge( $this->where, $value );
236  }
237  } else {
238  $this->where[] = $value;
239  }
240  }
241 
248  protected function addWhereIf( $value, $condition ) {
249  if ( $condition ) {
250  $this->addWhere( $value );
251 
252  return true;
253  }
254 
255  return false;
256  }
257 
263  protected function addWhereFld( $field, $value ) {
264  // Use count() to its full documented capabilities to simultaneously
265  // test for null, empty array or empty countable object
266  if ( count( $value ) ) {
267  $this->where[$field] = $value;
268  }
269  }
270 
283  protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
284  $isDirNewer = ( $dir === 'newer' );
285  $after = ( $isDirNewer ? '>=' : '<=' );
286  $before = ( $isDirNewer ? '<=' : '>=' );
287  $db = $this->getDB();
288 
289  if ( !is_null( $start ) ) {
290  $this->addWhere( $field . $after . $db->addQuotes( $start ) );
291  }
292 
293  if ( !is_null( $end ) ) {
294  $this->addWhere( $field . $before . $db->addQuotes( $end ) );
295  }
296 
297  if ( $sort ) {
298  $order = $field . ( $isDirNewer ? '' : ' DESC' );
299  // Append ORDER BY
300  $optionOrderBy = isset( $this->options['ORDER BY'] )
301  ? (array)$this->options['ORDER BY']
302  : [];
303  $optionOrderBy[] = $order;
304  $this->addOption( 'ORDER BY', $optionOrderBy );
305  }
306  }
307 
318  protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
319  $db = $this->getDB();
320  $this->addWhereRange( $field, $dir,
321  $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
322  }
323 
330  protected function addOption( $name, $value = null ) {
331  if ( is_null( $value ) ) {
332  $this->options[] = $name;
333  } else {
334  $this->options[$name] = $value;
335  }
336  }
337 
355  protected function select( $method, $extraQuery = [], array &$hookData = null ) {
356 
357  $tables = array_merge(
358  $this->tables,
359  isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : []
360  );
361  $fields = array_merge(
362  $this->fields,
363  isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : []
364  );
365  $where = array_merge(
366  $this->where,
367  isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : []
368  );
369  $options = array_merge(
370  $this->options,
371  isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : []
372  );
373  $join_conds = array_merge(
374  $this->join_conds,
375  isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : []
376  );
377 
378  if ( $hookData !== null ) {
379  Hooks::run( 'ApiQueryBaseBeforeQuery',
380  [ $this, &$tables, &$fields, &$where, &$options, &$join_conds, &$hookData ]
381  );
382  }
383 
384  $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
385 
386  if ( $hookData !== null ) {
387  Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] );
388  }
389 
390  return $res;
391  }
392 
406  protected function processRow( $row, array &$data, array &$hookData ) {
407  return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
408  }
409 
415  public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
416  $db = $this->getDB();
417  if ( !is_null( $query ) || $query != '' ) {
418  if ( is_null( $protocol ) ) {
419  $protocol = 'http://';
420  }
421 
422  $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
423  if ( !$likeQuery ) {
424  $this->dieUsage( 'Invalid query', 'bad_query' );
425  }
426 
427  $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
428 
429  return 'el_index ' . $db->buildLike( $likeQuery );
430  } elseif ( !is_null( $protocol ) ) {
431  return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
432  }
433 
434  return null;
435  }
436 
444  public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
445  $this->addTables( 'ipblocks' );
446  $this->addJoinConds( [
447  'ipblocks' => [ 'LEFT JOIN', 'ipb_user=user_id' ],
448  ] );
449 
450  $this->addFields( 'ipb_deleted' );
451 
452  if ( $showBlockInfo ) {
453  $this->addFields( [
454  'ipb_id',
455  'ipb_by',
456  'ipb_by_text',
457  'ipb_reason',
458  'ipb_expiry',
459  'ipb_timestamp'
460  ] );
461  }
462 
463  // Don't show hidden names
464  if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
465  $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
466  }
467  }
468 
471  /************************************************************************/
483  public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
484  $arr[$prefix . 'ns'] = intval( $title->getNamespace() );
485  $arr[$prefix . 'title'] = $title->getPrefixedText();
486  }
487 
494  protected function addPageSubItems( $pageId, $data ) {
495  $result = $this->getResult();
497 
498  return $result->addValue( [ 'query', 'pages', intval( $pageId ) ],
499  $this->getModuleName(),
500  $data );
501  }
502 
511  protected function addPageSubItem( $pageId, $item, $elemname = null ) {
512  if ( is_null( $elemname ) ) {
513  $elemname = $this->getModulePrefix();
514  }
515  $result = $this->getResult();
516  $fit = $result->addValue( [ 'query', 'pages', $pageId,
517  $this->getModuleName() ], null, $item );
518  if ( !$fit ) {
519  return false;
520  }
521  $result->addIndexedTagName( [ 'query', 'pages', $pageId,
522  $this->getModuleName() ], $elemname );
523 
524  return true;
525  }
526 
532  protected function setContinueEnumParameter( $paramName, $paramValue ) {
533  $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue );
534  }
535 
546  public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
547  $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
548  if ( !$t || $t->hasFragment() ) {
549  // Invalid title (e.g. bad chars) or contained a '#'.
550  $this->dieUsageMsg( [ 'invalidtitle', $titlePart ] );
551  }
552  if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
553  // This can happen in two cases. First, if you call titlePartToKey with a title part
554  // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
555  // difficult to handle such a case. Such cases cannot exist and are therefore treated
556  // as invalid user input. The second case is when somebody specifies a title interwiki
557  // prefix.
558  $this->dieUsageMsg( [ 'invalidtitle', $titlePart ] );
559  }
560 
561  return substr( $t->getDBkey(), 0, -1 );
562  }
563 
572  public function prefixedTitlePartToKey( $titlePart, $defaultNamespace = NS_MAIN ) {
573  $t = Title::newFromText( $titlePart . 'x', $defaultNamespace );
574  if ( !$t || $t->hasFragment() || $t->isExternal() ) {
575  // Invalid title (e.g. bad chars) or contained a '#'.
576  $this->dieUsageMsg( [ 'invalidtitle', $titlePart ] );
577  }
578 
579  return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ];
580  }
581 
586  public function validateSha1Hash( $hash ) {
587  return preg_match( '/^[a-f0-9]{40}$/', $hash );
588  }
589 
594  public function validateSha1Base36Hash( $hash ) {
595  return preg_match( '/^[a-z0-9]{31}$/', $hash );
596  }
597 
603  public function userCanSeeRevDel() {
604  return $this->getUser()->isAllowedAny(
605  'deletedhistory',
606  'deletedtext',
607  'suppressrevision',
608  'viewsuppressed'
609  );
610  }
611 
613 }
static makeLikeArray($filterEntry, $protocol= 'http://')
Make an array to be used for calls to Database::buildLike(), which will match the specified string...
Definition: LinkFilter.php:94
getDB()
Get the Query database connection (read-only)
the array() calling protocol came about after MediaWiki 1.4rc1.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
if(count($args)==0) $dir
const NS_MAIN
Definition: Defines.php:56
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
addPageSubItem($pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addPageSubItems($pageId, $data)
Add a sub-element under the page element with the given page ID.
getMain()
Get the main module.
Definition: ApiBase.php:473
addWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction...
This is a base class for all Query modules.
$sort
$value
requestExtraData($pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName...
getPageSet()
Get the PageSet object to work on.
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
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
addTimestampWhereRange($field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
addWhere($value)
Add a set of WHERE clauses to the internal array.
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place.Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
addJoinConds($join_conds)
Add a set of JOIN conditions to the internal array.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
validateSha1Hash($hash)
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
prepareUrlQuerySearchString($query=null, $protocol=null)
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
addWhereIf($value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
$res
Definition: database.txt:21
getContinuationManager()
Get the continuation manager.
Definition: ApiBase.php:617
processRow($row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
prefixedTitlePartToKey($titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
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
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
This is the main query class.
Definition: ApiQuery.php:38
validateSha1Base36Hash($hash)
getQuery()
Get the main Query module.
getCacheMode($params)
Get the cache mode for the data generated by this module.
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
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
titlePartToKey($titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
static keepOneWildcard($arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder...
Definition: LinkFilter.php:177
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:465
addFields($value)
Add a set of fields to select to the internal array.
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
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
showHiddenUsersAddBlockInfo($showBlockInfo)
Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block in...
static dieDebug($method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2284
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
getUser()
Get the User object.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix= '')
dieUsageMsg($error)
Output the error message related to a certain array.
Definition: ApiBase.php:2192
resetQueryParams()
Blank the internal arrays with query parameters.
selectNamedDB($name, $db, $groups)
Selects the query database connection with the given name.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300