MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'rn' );
36  }
38  public function execute() {
39  $this->run();
40  }
42  public function executeGenerator( $resultPageSet ) {
43  $this->run( $resultPageSet );
44  }
55  protected function runQuery( $resultPageSet, $limit, $start, $startId, $end ) {
56  $params = $this->extractRequestParams();
58  $this->resetQueryParams();
59  $this->addTables( 'page' );
60  $this->addFields( [ 'page_id', 'page_random' ] );
61  if ( is_null( $resultPageSet ) ) {
62  $this->addFields( [ 'page_title', 'page_namespace' ] );
63  } else {
64  $this->addFields( $resultPageSet->getPageTableFields() );
65  }
66  $this->addWhereFld( 'page_namespace', $params['namespace'] );
67  if ( $params['redirect'] || $params['filterredir'] === 'redirects' ) {
68  $this->addWhereFld( 'page_is_redirect', 1 );
69  } elseif ( $params['filterredir'] === 'nonredirects' ) {
70  $this->addWhereFld( 'page_is_redirect', 0 );
71  } elseif ( is_null( $resultPageSet ) ) {
72  $this->addFields( [ 'page_is_redirect' ] );
73  }
74  $this->addOption( 'LIMIT', $limit + 1 );
76  if ( $start !== null ) {
77  $start = $this->getDB()->addQuotes( $start );
78  if ( $startId !== null ) {
79  $startId = (int)$startId;
80  $this->addWhere( "page_random = $start AND page_id >= $startId OR page_random > $start" );
81  } else {
82  $this->addWhere( "page_random >= $start" );
83  }
84  }
85  if ( $end !== null ) {
86  $this->addWhere( 'page_random < ' . $this->getDB()->addQuotes( $end ) );
87  }
88  $this->addOption( 'ORDER BY', [ 'page_random', 'page_id' ] );
90  $result = $this->getResult();
91  $path = [ 'query', $this->getModuleName() ];
93  $res = $this->select( __METHOD__ );
94  $count = 0;
95  foreach ( $res as $row ) {
96  if ( $count++ >= $limit ) {
97  return [ 0, "{$row->page_random}|{$row->page_id}" ];
98  }
99  if ( is_null( $resultPageSet ) ) {
100  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
101  $page = [
102  'id' => (int)$row->page_id,
103  ];
105  if ( isset( $row->page_is_redirect ) ) {
106  $page['redirect'] = (bool)$row->page_is_redirect;
107  }
108  $fit = $result->addValue( $path, null, $page );
109  if ( !$fit ) {
110  return [ 0, "{$row->page_random}|{$row->page_id}" ];
111  }
112  } else {
113  $resultPageSet->processDbRow( $row );
114  }
115  }
117  return [ $limit - $count, null ];
118  }
123  public function run( $resultPageSet = null ) {
124  $params = $this->extractRequestParams();
126  // Since 'filterredir" will always be set in $params, we have to dig
127  // into the WebRequest to see if it was actually passed.
128  $request = $this->getMain()->getRequest();
129  if ( $request->getCheck( $this->encodeParamName( 'filterredir' ) ) ) {
130  $this->requireMaxOneParameter( $params, 'filterredir', 'redirect' );
131  }
133  if ( isset( $params['continue'] ) ) {
134  $cont = explode( '|', $params['continue'] );
135  $this->dieContinueUsageIf( count( $cont ) != 4 );
136  $rand = $cont[0];
137  $start = $cont[1];
138  $startId = (int)$cont[2];
139  $end = $cont[3] ? $rand : null;
140  $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $rand ) );
141  $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $start ) );
142  $this->dieContinueUsageIf( $cont[2] !== (string)$startId );
143  $this->dieContinueUsageIf( $cont[3] !== '0' && $cont[3] !== '1' );
144  } else {
145  $rand = wfRandom();
146  $start = $rand;
147  $startId = null;
148  $end = null;
149  }
151  list( $left, $continue ) =
152  $this->runQuery( $resultPageSet, $params['limit'], $start, $startId, $end );
153  if ( $end === null && $continue === null ) {
154  // Wrap around. We do this even if $left === 0 for continuation
155  // (saving a DB query in this rare case probably isn't worth the
156  // added code complexity it would require).
157  $end = $rand;
158  list( $left, $continue ) = $this->runQuery( $resultPageSet, $left, null, null, $end );
159  }
161  if ( $continue !== null ) {
162  $endFlag = $end === null ? 0 : 1;
163  $this->setContinueEnumParameter( 'continue', "$rand|$continue|$endFlag" );
164  }
166  if ( is_null( $resultPageSet ) ) {
167  $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
168  }
169  }
171  public function getCacheMode( $params ) {
172  return 'public';
173  }
175  public function getAllowedParams() {
176  return [
177  'namespace' => [
178  ApiBase::PARAM_TYPE => 'namespace',
180  ],
181  'filterredir' => [
182  ApiBase::PARAM_TYPE => [ 'all', 'redirects', 'nonredirects' ],
183  ApiBase::PARAM_DFLT => 'nonredirects', // for BC
184  ],
185  'redirect' => [
187  ApiBase::PARAM_DFLT => false,
188  ],
189  'limit' => [
190  ApiBase::PARAM_TYPE => 'limit',
191  ApiBase::PARAM_DFLT => 1,
192  ApiBase::PARAM_MIN => 1,
195  ],
196  'continue' => [
197  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue'
198  ],
199  ];
200  }
202  protected function getExamplesMessages() {
203  return [
204  'action=query&list=random&rnnamespace=0&rnlimit=2'
205  => 'apihelp-query+random-example-simple',
206  'action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info'
207  => 'apihelp-query+random-example-generator',
208  ];
209  }
211  public function getHelpUrls() {
212  return '';
213  }
214 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:186
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
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
Get the result object.
Definition: ApiBase.php:584
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
requireMaxOneParameter($params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:747
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
Get the main module.
Definition: ApiBase.php:480
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:184
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Query module to get list of random pages.
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Add a set of WHERE clauses to the internal array.
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
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
Definition: database.txt:21
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
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
Die with the $prefix.
Definition: ApiBase.php:2240
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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
Get a random decimal value between 0 and 1, in a way not likely to give duplicate values for any real...
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
runQuery($resultPageSet, $limit, $start, $startId, $end)
Actually perform the query and add pages to the result.
Add a set of fields to select to the internal array.
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
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
__construct(ApiQuery $query, $moduleName)
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:106
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
Blank the internal arrays with query parameters.
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