MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'rn' );
32  }
34  public function execute() {
35  $this->run();
36  }
38  public function executeGenerator( $resultPageSet ) {
39  $this->run( $resultPageSet );
40  }
51  protected function runQuery( $resultPageSet, $limit, $start, $startId, $end ) {
52  $params = $this->extractRequestParams();
54  $this->resetQueryParams();
55  $this->addTables( 'page' );
56  $this->addFields( [ 'page_id', 'page_random' ] );
57  if ( is_null( $resultPageSet ) ) {
58  $this->addFields( [ 'page_title', 'page_namespace' ] );
59  } else {
60  $this->addFields( $resultPageSet->getPageTableFields() );
61  }
62  $this->addWhereFld( 'page_namespace', $params['namespace'] );
63  if ( $params['redirect'] || $params['filterredir'] === 'redirects' ) {
64  $this->addWhereFld( 'page_is_redirect', 1 );
65  } elseif ( $params['filterredir'] === 'nonredirects' ) {
66  $this->addWhereFld( 'page_is_redirect', 0 );
67  } elseif ( is_null( $resultPageSet ) ) {
68  $this->addFields( [ 'page_is_redirect' ] );
69  }
70  $this->addOption( 'LIMIT', $limit + 1 );
72  if ( $start !== null ) {
73  $start = $this->getDB()->addQuotes( $start );
74  if ( $startId > 0 ) {
75  $startId = (int)$startId; // safety
76  $this->addWhere( "page_random = $start AND page_id >= $startId OR page_random > $start" );
77  } else {
78  $this->addWhere( "page_random >= $start" );
79  }
80  }
81  if ( $end !== null ) {
82  $this->addWhere( 'page_random < ' . $this->getDB()->addQuotes( $end ) );
83  }
84  $this->addOption( 'ORDER BY', [ 'page_random', 'page_id' ] );
86  $result = $this->getResult();
87  $path = [ 'query', $this->getModuleName() ];
89  $res = $this->select( __METHOD__ );
90  $count = 0;
91  foreach ( $res as $row ) {
92  if ( $count++ >= $limit ) {
93  return [ 0, "{$row->page_random}|{$row->page_id}" ];
94  }
95  if ( is_null( $resultPageSet ) ) {
96  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
97  $page = [
98  'id' => (int)$row->page_id,
99  ];
101  if ( isset( $row->page_is_redirect ) ) {
102  $page['redirect'] = (bool)$row->page_is_redirect;
103  }
104  $fit = $result->addValue( $path, null, $page );
105  if ( !$fit ) {
106  return [ 0, "{$row->page_random}|{$row->page_id}" ];
107  }
108  } else {
109  $resultPageSet->processDbRow( $row );
110  }
111  }
113  return [ $limit - $count, null ];
114  }
119  public function run( $resultPageSet = null ) {
120  $params = $this->extractRequestParams();
122  // Since 'filterredir" will always be set in $params, we have to dig
123  // into the WebRequest to see if it was actually passed.
124  $request = $this->getMain()->getRequest();
125  if ( $request->getCheck( $this->encodeParamName( 'filterredir' ) ) ) {
126  $this->requireMaxOneParameter( $params, 'filterredir', 'redirect' );
127  }
129  if ( isset( $params['continue'] ) ) {
130  $cont = explode( '|', $params['continue'] );
131  $this->dieContinueUsageIf( count( $cont ) != 4 );
132  $rand = $cont[0];
133  $start = $cont[1];
134  $startId = (int)$cont[2];
135  $end = $cont[3] ? $rand : null;
136  $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $rand ) );
137  $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $start ) );
138  $this->dieContinueUsageIf( $cont[2] !== (string)$startId );
139  $this->dieContinueUsageIf( $cont[3] !== '0' && $cont[3] !== '1' );
140  } else {
141  $rand = wfRandom();
142  $start = $rand;
143  $startId = 0;
144  $end = null;
145  }
147  // Set the non-continue if this is being used as a generator
148  // (as a list it doesn't matter because lists never non-continue)
149  if ( $resultPageSet !== null ) {
150  $endFlag = $end === null ? 0 : 1;
151  $this->getContinuationManager()->addGeneratorNonContinueParam(
152  $this, 'continue', "$rand|$start|$startId|$endFlag"
153  );
154  }
156  list( $left, $continue ) =
157  $this->runQuery( $resultPageSet, $params['limit'], $start, $startId, $end );
158  if ( $end === null && $continue === null ) {
159  // Wrap around. We do this even if $left === 0 for continuation
160  // (saving a DB query in this rare case probably isn't worth the
161  // added code complexity it would require).
162  $end = $rand;
163  list( $left, $continue ) = $this->runQuery( $resultPageSet, $left, null, null, $end );
164  }
166  if ( $continue !== null ) {
167  $endFlag = $end === null ? 0 : 1;
168  $this->setContinueEnumParameter( 'continue', "$rand|$continue|$endFlag" );
169  }
171  if ( is_null( $resultPageSet ) ) {
172  $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
173  }
174  }
176  public function getCacheMode( $params ) {
177  return 'public';
178  }
180  public function getAllowedParams() {
181  return [
182  'namespace' => [
183  ApiBase::PARAM_TYPE => 'namespace',
185  ],
186  'filterredir' => [
187  ApiBase::PARAM_TYPE => [ 'all', 'redirects', 'nonredirects' ],
188  ApiBase::PARAM_DFLT => 'nonredirects', // for BC
189  ],
190  'redirect' => [
192  ApiBase::PARAM_DFLT => false,
193  ],
194  'limit' => [
195  ApiBase::PARAM_TYPE => 'limit',
196  ApiBase::PARAM_DFLT => 1,
197  ApiBase::PARAM_MIN => 1,
200  ],
201  'continue' => [
202  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue'
203  ],
204  ];
205  }
207  protected function getExamplesMessages() {
208  return [
209  'action=query&list=random&rnnamespace=0&rnlimit=2'
210  => 'apihelp-query+random-example-simple',
211  'action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info'
212  => 'apihelp-query+random-example-generator',
213  ];
214  }
216  public function getHelpUrls() {
217  return '';
218  }
219 }
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:190
This is the main query class.
Definition: ApiQuery.php:36
Return links to more detailed help pages about the module.
Definition: ApiQueryRandom.php:216
Blank the internal arrays with query parameters.
Definition: ApiQueryBase.php:144
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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 since 1.28! 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:1983
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
Get the result object.
Definition: ApiBase.php:632
run( $resultPageSet=null)
Definition: ApiQueryRandom.php:119
Definition: styleTest.css.php:44
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryRandom.php:38
Definition: database.txt:21
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:347
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
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:105
null for the 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:1588
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryRandom.php:180
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:252
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryRandom.php:30
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:372
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:743
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:576
Returns usage examples for this module.
Definition: ApiQueryRandom.php:207
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2636
Get the continuation manager.
Definition: ApiBase.php:672
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2176
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryRandom.php:176
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:258
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:913
Definition: ApiQueryGeneratorBase.php:26
Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for ...
Definition: GlobalFunctions.php:280
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:254
Definition: NoLocalSettings.php:25
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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
Query module to get list of random pages.
Definition: ApiQueryRandom.php:29
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
runQuery( $resultPageSet, $limit, $start, $startId, $end)
Actually perform the query and add pages to the result.
Definition: ApiQueryRandom.php:51
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
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:1985
Get the main module.
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:225
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryRandom.php:34
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:510