MediaWiki REL1_30
ApiStashEdit.php
Go to the documentation of this file.
1<?php
23use Wikimedia\ScopedCallback;
24
38class ApiStashEdit extends ApiBase {
39 const ERROR_NONE = 'stashed';
40 const ERROR_PARSE = 'error_parse';
41 const ERROR_CACHE = 'error_cache';
42 const ERROR_UNCACHEABLE = 'uncacheable';
43 const ERROR_BUSY = 'busy';
44
46 const MAX_CACHE_TTL = 300; // 5 minutes
48
49 public function execute() {
50 $user = $this->getUser();
52
53 if ( $user->isBot() ) { // sanity
54 $this->dieWithError( 'apierror-botsnotsupported' );
55 }
56
57 $cache = ObjectCache::getLocalClusterInstance();
58 $page = $this->getTitleOrPageId( $params );
59 $title = $page->getTitle();
60
61 if ( !ContentHandler::getForModelID( $params['contentmodel'] )
62 ->isSupportedFormat( $params['contentformat'] )
63 ) {
64 $this->dieWithError(
65 [ 'apierror-badformat-generic', $params['contentformat'], $params['contentmodel'] ],
66 'badmodelformat'
67 );
68 }
69
70 $this->requireAtLeastOneParameter( $params, 'stashedtexthash', 'text' );
71
72 $text = null;
73 $textHash = null;
74 if ( strlen( $params['stashedtexthash'] ) ) {
75 // Load from cache since the client indicates the text is the same as last stash
76 $textHash = $params['stashedtexthash'];
77 if ( !preg_match( '/^[0-9a-f]{40}$/', $textHash ) ) {
78 $this->dieWithError( 'apierror-stashedit-missingtext', 'missingtext' );
79 }
80 $textKey = $cache->makeKey( 'stashedit', 'text', $textHash );
81 $text = $cache->get( $textKey );
82 if ( !is_string( $text ) ) {
83 $this->dieWithError( 'apierror-stashedit-missingtext', 'missingtext' );
84 }
85 } elseif ( $params['text'] !== null ) {
86 // Trim and fix newlines so the key SHA1's match (see WebRequest::getText())
87 $text = rtrim( str_replace( "\r\n", "\n", $params['text'] ) );
88 $textHash = sha1( $text );
89 } else {
90 $this->dieWithError( [
91 'apierror-missingparam-at-least-one-of',
92 Message::listParam( [ '<var>stashedtexthash</var>', '<var>text</var>' ] ),
93 2,
94 ], 'missingparam' );
95 }
96
97 $textContent = ContentHandler::makeContent(
98 $text, $title, $params['contentmodel'], $params['contentformat'] );
99
100 $page = WikiPage::factory( $title );
101 if ( $page->exists() ) {
102 // Page exists: get the merged content with the proposed change
103 $baseRev = Revision::newFromPageId( $page->getId(), $params['baserevid'] );
104 if ( !$baseRev ) {
105 $this->dieWithError( [ 'apierror-nosuchrevid', $params['baserevid'] ] );
106 }
107 $currentRev = $page->getRevision();
108 if ( !$currentRev ) {
109 $this->dieWithError( [ 'apierror-missingrev-pageid', $page->getId() ], 'missingrev' );
110 }
111 // Merge in the new version of the section to get the proposed version
112 $editContent = $page->replaceSectionAtRev(
113 $params['section'],
114 $textContent,
115 $params['sectiontitle'],
116 $baseRev->getId()
117 );
118 if ( !$editContent ) {
119 $this->dieWithError( 'apierror-sectionreplacefailed', 'replacefailed' );
120 }
121 if ( $currentRev->getId() == $baseRev->getId() ) {
122 // Base revision was still the latest; nothing to merge
123 $content = $editContent;
124 } else {
125 // Merge the edit into the current version
126 $baseContent = $baseRev->getContent();
127 $currentContent = $currentRev->getContent();
128 if ( !$baseContent || !$currentContent ) {
129 $this->dieWithError( [ 'apierror-missingcontent-pageid', $page->getId() ], 'missingrev' );
130 }
131 $handler = ContentHandler::getForModelID( $baseContent->getModel() );
132 $content = $handler->merge3( $baseContent, $editContent, $currentContent );
133 }
134 } else {
135 // New pages: use the user-provided content model
136 $content = $textContent;
137 }
138
139 if ( !$content ) { // merge3() failed
140 $this->getResult()->addValue( null,
141 $this->getModuleName(), [ 'status' => 'editconflict' ] );
142 return;
143 }
144
145 // The user will abort the AJAX request by pressing "save", so ignore that
146 ignore_user_abort( true );
147
148 if ( $user->pingLimiter( 'stashedit' ) ) {
149 $status = 'ratelimited';
150 } else {
151 $status = self::parseAndStash( $page, $content, $user, $params['summary'] );
152 $textKey = $cache->makeKey( 'stashedit', 'text', $textHash );
153 $cache->set( $textKey, $text, self::MAX_CACHE_TTL );
154 }
155
156 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
157 $stats->increment( "editstash.cache_stores.$status" );
158
159 $this->getResult()->addValue(
160 null,
161 $this->getModuleName(),
162 [
163 'status' => $status,
164 'texthash' => $textHash
165 ]
166 );
167 }
168
177 public static function parseAndStash( WikiPage $page, Content $content, User $user, $summary ) {
178 $cache = ObjectCache::getLocalClusterInstance();
179 $logger = LoggerFactory::getInstance( 'StashEdit' );
180
181 $title = $page->getTitle();
182 $key = self::getStashKey( $title, self::getContentHash( $content ), $user );
183
184 // Use the master DB for fast blocking locks
185 $dbw = wfGetDB( DB_MASTER );
186 if ( !$dbw->lock( $key, __METHOD__, 1 ) ) {
187 // De-duplicate requests on the same key
188 return self::ERROR_BUSY;
189 }
191 $unlocker = new ScopedCallback( function () use ( $dbw, $key ) {
192 $dbw->unlock( $key, __METHOD__ );
193 } );
194
195 $cutoffTime = time() - self::PRESUME_FRESH_TTL_SEC;
196
197 // Reuse any freshly build matching edit stash cache
198 $editInfo = $cache->get( $key );
199 if ( $editInfo && wfTimestamp( TS_UNIX, $editInfo->timestamp ) >= $cutoffTime ) {
200 $alreadyCached = true;
201 } else {
202 $format = $content->getDefaultFormat();
203 $editInfo = $page->prepareContentForEdit( $content, null, $user, $format, false );
204 $alreadyCached = false;
205 }
206
207 if ( $editInfo && $editInfo->output ) {
208 // Let extensions add ParserOutput metadata or warm other caches
209 Hooks::run( 'ParserOutputStashForEdit',
210 [ $page, $content, $editInfo->output, $summary, $user ] );
211
212 if ( $alreadyCached ) {
213 $logger->debug( "Already cached parser output for key '$key' ('$title')." );
214 return self::ERROR_NONE;
215 }
216
217 list( $stashInfo, $ttl, $code ) = self::buildStashValue(
218 $editInfo->pstContent,
219 $editInfo->output,
220 $editInfo->timestamp,
221 $user
222 );
223
224 if ( $stashInfo ) {
225 $ok = $cache->set( $key, $stashInfo, $ttl );
226 if ( $ok ) {
227 $logger->debug( "Cached parser output for key '$key' ('$title')." );
228 return self::ERROR_NONE;
229 } else {
230 $logger->error( "Failed to cache parser output for key '$key' ('$title')." );
231 return self::ERROR_CACHE;
232 }
233 } else {
234 $logger->info( "Uncacheable parser output for key '$key' ('$title') [$code]." );
236 }
237 }
238
239 return self::ERROR_PARSE;
240 }
241
259 public static function checkCache( Title $title, Content $content, User $user ) {
260 if ( $user->isBot() ) {
261 return false; // bots never stash - don't pollute stats
262 }
263
264 $cache = ObjectCache::getLocalClusterInstance();
265 $logger = LoggerFactory::getInstance( 'StashEdit' );
266 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
267
268 $key = self::getStashKey( $title, self::getContentHash( $content ), $user );
269 $editInfo = $cache->get( $key );
270 if ( !is_object( $editInfo ) ) {
271 $start = microtime( true );
272 // We ignore user aborts and keep parsing. Block on any prior parsing
273 // so as to use its results and make use of the time spent parsing.
274 // Skip this logic if there no master connection in case this method
275 // is called on an HTTP GET request for some reason.
276 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
277 $dbw = $lb->getAnyOpenConnection( $lb->getWriterIndex() );
278 if ( $dbw && $dbw->lock( $key, __METHOD__, 30 ) ) {
279 $editInfo = $cache->get( $key );
280 $dbw->unlock( $key, __METHOD__ );
281 }
282
283 $timeMs = 1000 * max( 0, microtime( true ) - $start );
284 $stats->timing( 'editstash.lock_wait_time', $timeMs );
285 }
286
287 if ( !is_object( $editInfo ) || !$editInfo->output ) {
288 $stats->increment( 'editstash.cache_misses.no_stash' );
289 $logger->debug( "Empty cache for key '$key' ('$title'); user '{$user->getName()}'." );
290 return false;
291 }
292
293 $age = time() - wfTimestamp( TS_UNIX, $editInfo->output->getCacheTime() );
294 if ( $age <= self::PRESUME_FRESH_TTL_SEC ) {
295 // Assume nothing changed in this time
296 $stats->increment( 'editstash.cache_hits.presumed_fresh' );
297 $logger->debug( "Timestamp-based cache hit for key '$key' (age: $age sec)." );
298 } elseif ( isset( $editInfo->edits ) && $editInfo->edits === $user->getEditCount() ) {
299 // Logged-in user made no local upload/template edits in the meantime
300 $stats->increment( 'editstash.cache_hits.presumed_fresh' );
301 $logger->debug( "Edit count based cache hit for key '$key' (age: $age sec)." );
302 } elseif ( $user->isAnon()
303 && self::lastEditTime( $user ) < $editInfo->output->getCacheTime()
304 ) {
305 // Logged-out user made no local upload/template edits in the meantime
306 $stats->increment( 'editstash.cache_hits.presumed_fresh' );
307 $logger->debug( "Edit check based cache hit for key '$key' (age: $age sec)." );
308 } else {
309 // User may have changed included content
310 $editInfo = false;
311 }
312
313 if ( !$editInfo ) {
314 $stats->increment( 'editstash.cache_misses.proven_stale' );
315 $logger->info( "Stale cache for key '$key'; old key with outside edits. (age: $age sec)" );
316 } elseif ( $editInfo->output->getFlag( 'vary-revision' ) ) {
317 // This can be used for the initial parse, e.g. for filters or doEditContent(),
318 // but a second parse will be triggered in doEditUpdates(). This is not optimal.
319 $logger->info( "Cache for key '$key' ('$title') has vary_revision." );
320 } elseif ( $editInfo->output->getFlag( 'vary-revision-id' ) ) {
321 // Similar to the above if we didn't guess the ID correctly.
322 $logger->info( "Cache for key '$key' ('$title') has vary_revision_id." );
323 }
324
325 return $editInfo;
326 }
327
332 private static function lastEditTime( User $user ) {
333 $time = wfGetDB( DB_REPLICA )->selectField(
334 'recentchanges',
335 'MAX(rc_timestamp)',
336 [ 'rc_user_text' => $user->getName() ],
337 __METHOD__
338 );
339
340 return wfTimestampOrNull( TS_MW, $time );
341 }
342
349 private static function getContentHash( Content $content ) {
350 return sha1( implode( "\n", [
351 $content->getModel(),
352 $content->getDefaultFormat(),
353 $content->serialize( $content->getDefaultFormat() )
354 ] ) );
355 }
356
369 private static function getStashKey( Title $title, $contentHash, User $user ) {
370 return ObjectCache::getLocalClusterInstance()->makeKey(
371 'prepared-edit',
372 md5( $title->getPrefixedDBkey() ),
373 // Account for the edit model/text
374 $contentHash,
375 // Account for user name related variables like signatures
376 md5( $user->getId() . "\n" . $user->getName() )
377 );
378 }
379
391 private static function buildStashValue(
392 Content $pstContent, ParserOutput $parserOutput, $timestamp, User $user
393 ) {
394 // If an item is renewed, mind the cache TTL determined by config and parser functions.
395 // Put an upper limit on the TTL for sanity to avoid extreme template/file staleness.
396 $since = time() - wfTimestamp( TS_UNIX, $parserOutput->getTimestamp() );
397 $ttl = min( $parserOutput->getCacheExpiry() - $since, self::MAX_CACHE_TTL );
398
399 // Avoid extremely stale user signature timestamps (T84843)
400 if ( $parserOutput->getFlag( 'user-signature' ) ) {
401 $ttl = min( $ttl, self::MAX_SIGNATURE_TTL );
402 }
403
404 if ( $ttl <= 0 ) {
405 return [ null, 0, 'no_ttl' ];
406 }
407
408 // Only store what is actually needed
409 $stashInfo = (object)[
410 'pstContent' => $pstContent,
411 'output' => $parserOutput,
412 'timestamp' => $timestamp,
413 'edits' => $user->getEditCount()
414 ];
415
416 return [ $stashInfo, $ttl, 'ok' ];
417 }
418
419 public function getAllowedParams() {
420 return [
421 'title' => [
422 ApiBase::PARAM_TYPE => 'string',
424 ],
425 'section' => [
426 ApiBase::PARAM_TYPE => 'string',
427 ],
428 'sectiontitle' => [
429 ApiBase::PARAM_TYPE => 'string'
430 ],
431 'text' => [
432 ApiBase::PARAM_TYPE => 'text',
433 ApiBase::PARAM_DFLT => null
434 ],
435 'stashedtexthash' => [
436 ApiBase::PARAM_TYPE => 'string',
437 ApiBase::PARAM_DFLT => null
438 ],
439 'summary' => [
440 ApiBase::PARAM_TYPE => 'string',
441 ],
442 'contentmodel' => [
445 ],
446 'contentformat' => [
449 ],
450 'baserevid' => [
451 ApiBase::PARAM_TYPE => 'integer',
453 ]
454 ];
455 }
456
457 public function needsToken() {
458 return 'csrf';
459 }
460
461 public function mustBePosted() {
462 return true;
463 }
464
465 public function isWriteMode() {
466 return true;
467 }
468
469 public function isInternal() {
470 return true;
471 }
472}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:41
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition ApiBase.php:115
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
getResult()
Get the result object.
Definition ApiBase.php:632
requireAtLeastOneParameter( $params, $required)
Die if none of a certain set of parameters is set and not false.
Definition ApiBase.php:842
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition ApiBase.php:917
Prepare an edit in shared cache so that it can be reused on edit.
const PRESUME_FRESH_TTL_SEC
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
const ERROR_UNCACHEABLE
const MAX_SIGNATURE_TTL
static getStashKey(Title $title, $contentHash, User $user)
Get the temporary prepared edit stash key for a user.
static parseAndStash(WikiPage $page, Content $content, User $user, $summary)
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
static lastEditTime(User $user)
isInternal()
Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party...
static getContentHash(Content $content)
Get hash of the content, factoring in model/format.
needsToken()
Returns the token type this module requires in order to execute.
static buildStashValue(Content $pstContent, ParserOutput $parserOutput, $timestamp, User $user)
Build a value to store in memcached based on the PST content and parser output.
const MAX_CACHE_TTL
isWriteMode()
Indicates whether this module requires write mode.
static checkCache(Title $title, Content $content, User $user)
Check that a prepared edit is in cache and still up-to-date.
mustBePosted()
Indicates whether this module must be called with a POST request.
getCacheExpiry()
Returns the number of seconds after which this object should expire.
static getAllContentFormats()
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
static getContentModels()
getUser()
Get the User object.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static newFromPageId( $pageId, $revId=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given page ID.
Definition Revision.php:165
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
Class representing a MediaWiki article and history.
Definition WikiPage.php:37
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
prepareContentForEdit(Content $content, $revision=null, User $user=null, $serialFormat=null, $useCache=true)
Prepare content which is about to be saved.
getTitle()
Get the title object of the article.
Definition WikiPage.php:239
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
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition globals.txt:64
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, 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. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1245
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1778
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 see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:863
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
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:1976
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 see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:901
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
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:37
Base interface for content objects.
Definition Content.php:34
getModel()
Returns the ID of the content model used by this Content object.
serialize( $format=null)
Convenience method for serializing this Content object.
getDefaultFormat()
Convenience method that returns the default serialization format for the content model that this Cont...
$cache
Definition mcc.php:33
const DB_REPLICA
Definition defines.php:25
const DB_MASTER
Definition defines.php:26
$params