MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
27  private $source;
29  private $allModules = [];
30  private $generatedModules = [];
32  private $continuationData = [];
36  private $generatorParams = [];
37  private $generatorDone = false;
45  public function __construct(
46  ApiBase $module, array $allModules = [], array $generatedModules = []
47  ) {
48  $this->source = get_class( $module );
49  $request = $module->getRequest();
51  $this->generatedModules = $generatedModules
52  ? array_combine( $generatedModules, $generatedModules )
53  : [];
55  $skip = [];
56  $continue = $request->getVal( 'continue', '' );
57  if ( $continue !== '' ) {
58  $continue = explode( '||', $continue );
59  if ( count( $continue ) !== 2 ) {
60  throw ApiUsageException::newWithMessage( $module->getMain(), 'apierror-badcontinue' );
61  }
62  $this->generatorDone = ( $continue[0] === '-' );
63  $skip = explode( '|', $continue[1] );
64  if ( !$this->generatorDone ) {
65  $params = explode( '|', $continue[0] );
66  if ( $params ) {
67  $this->generatorParams = array_intersect_key(
68  $request->getValues(),
69  array_flip( $params )
70  );
71  }
72  } else {
73  // When the generator is complete, don't run any modules that
74  // depend on it.
75  $skip += $this->generatedModules;
76  }
77  }
79  foreach ( $allModules as $module ) {
80  $name = $module->getModuleName();
81  if ( in_array( $name, $skip, true ) ) {
82  $this->allModules[$name] = false;
83  // Prevent spurious "unused parameter" warnings
84  $module->extractRequestParams();
85  } else {
86  $this->allModules[$name] = $module;
87  }
88  }
89  }
95  public function getSource() {
96  return $this->source;
97  }
103  public function isGeneratorDone() {
104  return $this->generatorDone;
105  }
111  public function getRunModules() {
112  return array_values( array_filter( $this->allModules ) );
113  }
122  public function addContinueParam( ApiBase $module, $paramName, $paramValue ) {
123  $name = $module->getModuleName();
124  if ( !isset( $this->allModules[$name] ) ) {
125  throw new UnexpectedValueException(
126  "Module '$name' called " . __METHOD__ .
127  ' but was not passed to ' . __CLASS__ . '::__construct'
128  );
129  }
130  if ( !$this->allModules[$name] ) {
131  throw new UnexpectedValueException(
132  "Module '$name' was not supposed to have been executed, but " .
133  'it was executed anyway'
134  );
135  }
136  $paramName = $module->encodeParamName( $paramName );
137  if ( is_array( $paramValue ) ) {
138  $paramValue = implode( '|', $paramValue );
139  }
140  $this->continuationData[$name][$paramName] = $paramValue;
141  }
154  public function addGeneratorNonContinueParam( ApiBase $module, $paramName, $paramValue ) {
155  $name = $module->getModuleName();
156  $paramName = $module->encodeParamName( $paramName );
157  if ( is_array( $paramValue ) ) {
158  $paramValue = implode( '|', $paramValue );
159  }
160  $this->generatorNonContinuationData[$name][$paramName] = $paramValue;
161  }
169  public function addGeneratorContinueParam( ApiBase $module, $paramName, $paramValue ) {
170  $name = $module->getModuleName();
171  $paramName = $module->encodeParamName( $paramName );
172  if ( is_array( $paramValue ) ) {
173  $paramValue = implode( '|', $paramValue );
174  }
175  $this->generatorContinuationData[$name][$paramName] = $paramValue;
176  }
182  public function getRawContinuation() {
183  return array_merge_recursive( $this->continuationData, $this->generatorContinuationData );
184  }
191  public function getRawNonContinuation() {
193  }
199  public function getContinuation() {
200  $data = [];
201  $batchcomplete = false;
203  $finishedModules = array_diff(
204  array_keys( $this->allModules ),
205  array_keys( $this->continuationData )
206  );
208  // First, grab the non-generator-using continuation data
209  $continuationData = array_diff_key( $this->continuationData, $this->generatedModules );
210  foreach ( $continuationData as $module => $kvp ) {
211  $data += $kvp;
212  }
214  // Next, handle the generator-using continuation data
215  $continuationData = array_intersect_key( $this->continuationData, $this->generatedModules );
216  if ( $continuationData ) {
217  // Some modules are unfinished: include those params, and copy
218  // the generator params.
219  foreach ( $continuationData as $module => $kvp ) {
220  // XXX: Not sure why phan is complaining here...
221  // @phan-suppress-next-line PhanTypeInvalidLeftOperand
222  $data += $kvp;
223  }
224  $generatorParams = [];
225  foreach ( $this->generatorNonContinuationData as $kvp ) {
226  $generatorParams += $kvp;
227  }
230  $generatorKeys = implode( '|', array_keys( $generatorParams ) );
231  } elseif ( $this->generatorContinuationData ) {
232  // All the generator-using modules are complete, but the
233  // generator isn't. Continue the generator and restart the
234  // generator-using modules
235  $generatorParams = [];
236  foreach ( $this->generatorContinuationData as $kvp ) {
237  $generatorParams += $kvp;
238  }
240  $finishedModules = array_diff( $finishedModules, $this->generatedModules );
241  $generatorKeys = implode( '|', array_keys( $generatorParams ) );
242  $batchcomplete = true;
243  } else {
244  // Generator and prop modules are all done. Mark it so.
245  $generatorKeys = '-';
246  $batchcomplete = true;
247  }
249  // Set 'continue' if any continuation data is set or if the generator
250  // still needs to run
251  if ( $data || $generatorKeys !== '-' ) {
252  $data['continue'] = $generatorKeys . '||' . implode( '|', $finishedModules );
253  }
255  return [ $data, $batchcomplete ];
256  }
263  list( $data, $batchcomplete ) = $this->getContinuation();
264  if ( $data ) {
265  $result->addValue( null, 'continue', $data,
267  }
268  if ( $batchcomplete ) {
269  $result->addValue( null, 'batchcomplete', true,
271  }
272  }
273 }
setContinuationIntoResult(ApiResult $result)
Store the continuation data into the result.
Definition: ApiContinuationManager.php:262
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 as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs source
Definition: hooks.txt:1640
This manages continuation state.
Definition: ApiContinuationManager.php:26
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
addContinueParam(ApiBase $module, $paramName, $paramValue)
Set the continuation parameter for a module.
Definition: ApiContinuationManager.php:122
Get the list of modules that should actually be run.
Definition: ApiContinuationManager.php:111
Definition: styleTest.css.php:44
Definition: ApiContinuationManager.php:33
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition: ApiResult.php:58
Definition: ContextSource.php:71
Definition: ApiContinuationManager.php:37
static newWithMessage(ApiBase $module=null, $msg, $code=null, $data=null, $httpCode=0)
Definition: ApiUsageException.php:63
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
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
Fetch continuation result data.
Definition: ApiContinuationManager.php:199
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
Definition: ApiContinuationManager.php:34
This class represents the result of the API operations.
Definition: ApiResult.php:35
Definition: ApiContinuationManager.php:32
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("", 2))
addValue( $path, $name, $value, $flags=0)
Add value to the output data at the given path.
Definition: ApiResult.php:405
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
Definition: ApiContinuationManager.php:30
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
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
addGeneratorNonContinueParam(ApiBase $module, $paramName, $paramValue)
Set the non-continuation parameter for the generator module.
Definition: ApiContinuationManager.php:154
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:721
Fetch raw non-continuation data.
Definition: ApiContinuationManager.php:191
const ADD_ON_TOP
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first el...
Definition: ApiResult.php:49
Is the generator done?
Definition: ApiContinuationManager.php:103
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
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
Get the main module.
Definition: ApiBase.php:528
__construct(ApiBase $module, array $allModules=[], array $generatedModules=[])
Definition: ApiContinuationManager.php:45
Fetch raw continuation data.
Definition: ApiContinuationManager.php:182
addGeneratorContinueParam(ApiBase $module, $paramName, $paramValue)
Set the continuation parameter for the generator module.
Definition: ApiContinuationManager.php:169
Definition: ApiContinuationManager.php:36
Definition: ApiContinuationManager.php:27
Get the class that created this manager.
Definition: ApiContinuationManager.php:95
Definition: ApiContinuationManager.php:29