MediaWiki  master
ApiEditPage.php
Go to the documentation of this file.
1 <?php
24 
34 class ApiEditPage extends ApiBase {
35  public function execute() {
37 
38  $user = $this->getUser();
39  $params = $this->extractRequestParams();
40 
41  $this->requireAtLeastOneParameter( $params, 'text', 'appendtext', 'prependtext', 'undo' );
42 
43  $pageObj = $this->getTitleOrPageId( $params );
44  $titleObj = $pageObj->getTitle();
45  $apiResult = $this->getResult();
46 
47  if ( $params['redirect'] ) {
48  if ( $params['prependtext'] === null && $params['appendtext'] === null
49  && $params['section'] !== 'new'
50  ) {
51  $this->dieWithError( 'apierror-redirect-appendonly' );
52  }
53  if ( $titleObj->isRedirect() ) {
54  $oldTitle = $titleObj;
55 
56  $titles = Revision::newFromTitle( $oldTitle, false, Revision::READ_LATEST )
57  ->getContent( RevisionRecord::FOR_THIS_USER, $user )
58  ->getRedirectChain();
59  // array_shift( $titles );
60 
61  $redirValues = [];
62 
64  foreach ( $titles as $id => $newTitle ) {
65  if ( !isset( $titles[$id - 1] ) ) {
66  $titles[$id - 1] = $oldTitle;
67  }
68 
69  $redirValues[] = [
70  'from' => $titles[$id - 1]->getPrefixedText(),
71  'to' => $newTitle->getPrefixedText()
72  ];
73 
74  $titleObj = $newTitle;
75  }
76 
77  ApiResult::setIndexedTagName( $redirValues, 'r' );
78  $apiResult->addValue( null, 'redirects', $redirValues );
79 
80  // Since the page changed, update $pageObj
81  $pageObj = WikiPage::factory( $titleObj );
82  }
83  }
84 
85  if ( !isset( $params['contentmodel'] ) || $params['contentmodel'] == '' ) {
86  $contentHandler = $pageObj->getContentHandler();
87  } else {
88  $contentHandler = ContentHandler::getForModelID( $params['contentmodel'] );
89  }
90  $contentModel = $contentHandler->getModelID();
91 
92  $name = $titleObj->getPrefixedDBkey();
93  $model = $contentHandler->getModelID();
94 
95  if ( $params['undo'] > 0 ) {
96  // allow undo via api
97  } elseif ( $contentHandler->supportsDirectApiEditing() === false ) {
98  $this->dieWithError( [ 'apierror-no-direct-editing', $model, $name ] );
99  }
100 
101  if ( !isset( $params['contentformat'] ) || $params['contentformat'] == '' ) {
102  $contentFormat = $contentHandler->getDefaultFormat();
103  } else {
104  $contentFormat = $params['contentformat'];
105  }
106 
107  if ( !$contentHandler->isSupportedFormat( $contentFormat ) ) {
108  $this->dieWithError( [ 'apierror-badformat', $contentFormat, $model, $name ] );
109  }
110 
111  if ( $params['createonly'] && $titleObj->exists() ) {
112  $this->dieWithError( 'apierror-articleexists' );
113  }
114  if ( $params['nocreate'] && !$titleObj->exists() ) {
115  $this->dieWithError( 'apierror-missingtitle' );
116  }
117 
118  // Now let's check whether we're even allowed to do this
120  $titleObj,
121  $titleObj->exists() ? 'edit' : [ 'edit', 'create' ],
122  [ 'autoblock' => true ]
123  );
124 
125  $toMD5 = $params['text'];
126  if ( !is_null( $params['appendtext'] ) || !is_null( $params['prependtext'] ) ) {
127  $content = $pageObj->getContent();
128 
129  if ( !$content ) {
130  if ( $titleObj->getNamespace() == NS_MEDIAWIKI ) {
131  # If this is a MediaWiki:x message, then load the messages
132  # and return the message value for x.
133  $text = $titleObj->getDefaultMessageText();
134  if ( $text === false ) {
135  $text = '';
136  }
137 
138  try {
139  $content = ContentHandler::makeContent( $text, $titleObj );
140  } catch ( MWContentSerializationException $ex ) {
141  $this->dieWithException( $ex, [
142  'wrap' => ApiMessage::create( 'apierror-contentserializationexception', 'parseerror' )
143  ] );
144  return;
145  }
146  } else {
147  # Otherwise, make a new empty content.
148  $content = $contentHandler->makeEmptyContent();
149  }
150  }
151 
152  // @todo Add support for appending/prepending to the Content interface
153 
154  if ( !( $content instanceof TextContent ) ) {
155  $modelName = $contentHandler->getModelID();
156  $this->dieWithError( [ 'apierror-appendnotsupported', $modelName ] );
157  }
158 
159  if ( !is_null( $params['section'] ) ) {
160  if ( !$contentHandler->supportsSections() ) {
161  $modelName = $contentHandler->getModelID();
162  $this->dieWithError( [ 'apierror-sectionsnotsupported', $modelName ] );
163  }
164 
165  if ( $params['section'] == 'new' ) {
166  // DWIM if they're trying to prepend/append to a new section.
167  $content = null;
168  } else {
169  // Process the content for section edits
170  $section = $params['section'];
171  $content = $content->getSection( $section );
172 
173  if ( !$content ) {
174  $this->dieWithError( [ 'apierror-nosuchsection', wfEscapeWikiText( $section ) ] );
175  }
176  }
177  }
178 
179  if ( !$content ) {
180  $text = '';
181  } else {
182  $text = $content->serialize( $contentFormat );
183  }
184 
185  $params['text'] = $params['prependtext'] . $text . $params['appendtext'];
186  $toMD5 = $params['prependtext'] . $params['appendtext'];
187  }
188 
189  if ( $params['undo'] > 0 ) {
190  if ( $params['undoafter'] > 0 ) {
191  if ( $params['undo'] < $params['undoafter'] ) {
192  list( $params['undo'], $params['undoafter'] ) =
193  [ $params['undoafter'], $params['undo'] ];
194  }
195  $undoafterRev = Revision::newFromId( $params['undoafter'] );
196  }
197  $undoRev = Revision::newFromId( $params['undo'] );
198  if ( is_null( $undoRev ) || $undoRev->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
199  $this->dieWithError( [ 'apierror-nosuchrevid', $params['undo'] ] );
200  }
201 
202  if ( $params['undoafter'] == 0 ) {
203  $undoafterRev = $undoRev->getPrevious();
204  }
205  if ( is_null( $undoafterRev ) || $undoafterRev->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
206  $this->dieWithError( [ 'apierror-nosuchrevid', $params['undoafter'] ] );
207  }
208 
209  if ( $undoRev->getPage() != $pageObj->getId() ) {
210  $this->dieWithError( [ 'apierror-revwrongpage', $undoRev->getId(),
211  $titleObj->getPrefixedText() ] );
212  }
213  if ( $undoafterRev->getPage() != $pageObj->getId() ) {
214  $this->dieWithError( [ 'apierror-revwrongpage', $undoafterRev->getId(),
215  $titleObj->getPrefixedText() ] );
216  }
217 
218  $newContent = $contentHandler->getUndoContent(
219  $pageObj->getRevision(),
220  $undoRev,
221  $undoafterRev
222  );
223 
224  if ( !$newContent ) {
225  $this->dieWithError( 'undo-failure', 'undofailure' );
226  }
227  if ( empty( $params['contentmodel'] )
228  && empty( $params['contentformat'] )
229  ) {
230  // If we are reverting content model, the new content model
231  // might not support the current serialization format, in
232  // which case go back to the old serialization format,
233  // but only if the user hasn't specified a format/model
234  // parameter.
235  if ( !$newContent->isSupportedFormat( $contentFormat ) ) {
236  $contentFormat = $undoafterRev->getContentFormat();
237  }
238  // Override content model with model of undid revision.
239  $contentModel = $newContent->getModel();
240  }
241  $params['text'] = $newContent->serialize( $contentFormat );
242  // If no summary was given and we only undid one rev,
243  // use an autosummary
244  if ( is_null( $params['summary'] ) &&
245  $titleObj->getNextRevisionID( $undoafterRev->getId() ) == $params['undo']
246  ) {
247  $params['summary'] = wfMessage( 'undo-summary' )
248  ->params( $params['undo'], $undoRev->getUserText() )->inContentLanguage()->text();
249  }
250  }
251 
252  // See if the MD5 hash checks out
253  if ( !is_null( $params['md5'] ) && md5( $toMD5 ) !== $params['md5'] ) {
254  $this->dieWithError( 'apierror-badmd5' );
255  }
256 
257  // EditPage wants to parse its stuff from a WebRequest
258  // That interface kind of sucks, but it's workable
259  $requestArray = [
260  'wpTextbox1' => $params['text'],
261  'format' => $contentFormat,
262  'model' => $contentModel,
263  'wpEditToken' => $params['token'],
264  'wpIgnoreBlankSummary' => true,
265  'wpIgnoreBlankArticle' => true,
266  'wpIgnoreSelfRedirect' => true,
267  'bot' => $params['bot'],
268  'wpUnicodeCheck' => EditPage::UNICODE_CHECK,
269  ];
270 
271  if ( !is_null( $params['summary'] ) ) {
272  $requestArray['wpSummary'] = $params['summary'];
273  }
274 
275  if ( !is_null( $params['sectiontitle'] ) ) {
276  $requestArray['wpSectionTitle'] = $params['sectiontitle'];
277  }
278 
279  // TODO: Pass along information from 'undoafter' as well
280  if ( $params['undo'] > 0 ) {
281  $requestArray['wpUndidRevision'] = $params['undo'];
282  }
283 
284  // Watch out for basetimestamp == '' or '0'
285  // It gets treated as NOW, almost certainly causing an edit conflict
286  if ( $params['basetimestamp'] !== null && (bool)$this->getMain()->getVal( 'basetimestamp' ) ) {
287  $requestArray['wpEdittime'] = $params['basetimestamp'];
288  } else {
289  $requestArray['wpEdittime'] = $pageObj->getTimestamp();
290  }
291 
292  if ( $params['starttimestamp'] !== null ) {
293  $requestArray['wpStarttime'] = $params['starttimestamp'];
294  } else {
295  $requestArray['wpStarttime'] = wfTimestampNow(); // Fake wpStartime
296  }
297 
298  if ( $params['minor'] || ( !$params['notminor'] && $user->getOption( 'minordefault' ) ) ) {
299  $requestArray['wpMinoredit'] = '';
300  }
301 
302  if ( $params['recreate'] ) {
303  $requestArray['wpRecreate'] = '';
304  }
305 
306  if ( !is_null( $params['section'] ) ) {
307  $section = $params['section'];
308  if ( !preg_match( '/^((T-)?\d+|new)$/', $section ) ) {
309  $this->dieWithError( 'apierror-invalidsection' );
310  }
311  $content = $pageObj->getContent();
312  if ( $section !== '0' && $section != 'new'
313  && ( !$content || !$content->getSection( $section ) )
314  ) {
315  $this->dieWithError( [ 'apierror-nosuchsection', $section ] );
316  }
317  $requestArray['wpSection'] = $params['section'];
318  } else {
319  $requestArray['wpSection'] = '';
320  }
321 
322  $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
323 
324  // Deprecated parameters
325  if ( $params['watch'] ) {
326  $watch = true;
327  } elseif ( $params['unwatch'] ) {
328  $watch = false;
329  }
330 
331  if ( $watch ) {
332  $requestArray['wpWatchthis'] = '';
333  }
334 
335  // Apply change tags
336  if ( $params['tags'] ) {
337  $tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
338  if ( $tagStatus->isOK() ) {
339  $requestArray['wpChangeTags'] = implode( ',', $params['tags'] );
340  } else {
341  $this->dieStatus( $tagStatus );
342  }
343  }
344 
345  // Pass through anything else we might have been given, to support extensions
346  // This is kind of a hack but it's the best we can do to make extensions work
347  $requestArray += $this->getRequest()->getValues();
348 
349  global $wgTitle, $wgRequest;
350 
351  $req = new DerivativeRequest( $this->getRequest(), $requestArray, true );
352 
353  // Some functions depend on $wgTitle == $ep->mTitle
354  // TODO: Make them not or check if they still do
355  $wgTitle = $titleObj;
356 
357  $articleContext = new RequestContext;
358  $articleContext->setRequest( $req );
359  $articleContext->setWikiPage( $pageObj );
360  $articleContext->setUser( $this->getUser() );
361 
363  $articleObject = Article::newFromWikiPage( $pageObj, $articleContext );
364 
365  $ep = new EditPage( $articleObject );
366 
367  $ep->setApiEditOverride( true );
368  $ep->setContextTitle( $titleObj );
369  $ep->importFormData( $req );
370  $content = $ep->textbox1;
371 
372  // Do the actual save
373  $oldRevId = $articleObject->getRevIdFetched();
374  $result = null;
375  // Fake $wgRequest for some hooks inside EditPage
376  // @todo FIXME: This interface SUCKS
377  $oldRequest = $wgRequest;
378  $wgRequest = $req;
379 
380  $status = $ep->attemptSave( $result );
381  $wgRequest = $oldRequest;
382 
383  switch ( $status->value ) {
386  if ( isset( $status->apiHookResult ) ) {
387  $r = $status->apiHookResult;
388  $r['result'] = 'Failure';
389  $apiResult->addValue( null, $this->getModuleName(), $r );
390  return;
391  }
392  if ( !$status->getErrors() ) {
393  // This appears to be unreachable right now, because all
394  // code paths will set an error. Could change, though.
395  $status->fatal( 'hookaborted' ); //@codeCoverageIgnore
396  }
397  $this->dieStatus( $status );
398 
399  // These two cases will normally have been caught earlier, and will
400  // only occur if something blocks the user between the earlier
401  // check and the check in EditPage (presumably a hook). It's not
402  // obvious that this is even possible.
403  // @codeCoverageIgnoreStart
405  $this->dieBlocked( $user->getBlock() );
406 
408  $this->dieReadOnly();
409  // @codeCoverageIgnoreEnd
410 
412  $r['new'] = true;
413  // fall-through
414 
416  $r['result'] = 'Success';
417  $r['pageid'] = (int)$titleObj->getArticleID();
418  $r['title'] = $titleObj->getPrefixedText();
419  $r['contentmodel'] = $articleObject->getContentModel();
420  $newRevId = $articleObject->getLatest();
421  if ( $newRevId == $oldRevId ) {
422  $r['nochange'] = true;
423  } else {
424  $r['oldrevid'] = (int)$oldRevId;
425  $r['newrevid'] = (int)$newRevId;
426  $r['newtimestamp'] = wfTimestamp( TS_ISO_8601,
427  $pageObj->getTimestamp() );
428  }
429  break;
430 
431  default:
432  if ( !$status->getErrors() ) {
433  // EditPage sometimes only sets the status code without setting
434  // any actual error messages. Supply defaults for those cases.
435  switch ( $status->value ) {
436  // Currently needed
438  $status->fatal( 'apierror-noimageredirect-anon' );
439  break;
441  $status->fatal( 'apierror-noimageredirect' );
442  break;
445  $status->fatal( 'apierror-contenttoobig', $this->getConfig()->get( 'MaxArticleSize' ) );
446  break;
448  $status->fatal( 'apierror-noedit-anon' );
449  break;
451  $status->fatal( 'apierror-cantchangecontentmodel' );
452  break;
454  $status->fatal( 'apierror-pagedeleted' );
455  break;
457  $status->fatal( 'editconflict' );
458  break;
459 
460  // Currently shouldn't be needed, but here in case
461  // hooks use them without setting appropriate
462  // errors on the status.
463  // @codeCoverageIgnoreStart
465  $status->fatal( 'apierror-spamdetected', $result['spam'] );
466  break;
468  $status->fatal( 'apierror-noedit' );
469  break;
471  $status->fatal( 'apierror-ratelimited' );
472  break;
474  $status->fatal( 'nocreate-loggedin' );
475  break;
477  $status->fatal( 'apierror-emptypage' );
478  break;
480  $status->fatal( 'apierror-emptynewsection' );
481  break;
483  $status->fatal( 'apierror-summaryrequired' );
484  break;
485  default:
486  wfWarn( __METHOD__ . ": Unknown EditPage code {$status->value} with no message" );
487  $status->fatal( 'apierror-unknownerror-editpage', $status->value );
488  break;
489  // @codeCoverageIgnoreEnd
490  }
491  }
492  $this->dieStatus( $status );
493  }
494  $apiResult->addValue( null, $this->getModuleName(), $r );
495  }
496 
497  public function mustBePosted() {
498  return true;
499  }
500 
501  public function isWriteMode() {
502  return true;
503  }
504 
505  public function getAllowedParams() {
506  return [
507  'title' => [
508  ApiBase::PARAM_TYPE => 'string',
509  ],
510  'pageid' => [
511  ApiBase::PARAM_TYPE => 'integer',
512  ],
513  'section' => null,
514  'sectiontitle' => [
515  ApiBase::PARAM_TYPE => 'string',
516  ],
517  'text' => [
518  ApiBase::PARAM_TYPE => 'text',
519  ],
520  'summary' => null,
521  'tags' => [
522  ApiBase::PARAM_TYPE => 'tags',
523  ApiBase::PARAM_ISMULTI => true,
524  ],
525  'minor' => false,
526  'notminor' => false,
527  'bot' => false,
528  'basetimestamp' => [
529  ApiBase::PARAM_TYPE => 'timestamp',
530  ],
531  'starttimestamp' => [
532  ApiBase::PARAM_TYPE => 'timestamp',
533  ],
534  'recreate' => false,
535  'createonly' => false,
536  'nocreate' => false,
537  'watch' => [
538  ApiBase::PARAM_DFLT => false,
540  ],
541  'unwatch' => [
542  ApiBase::PARAM_DFLT => false,
544  ],
545  'watchlist' => [
546  ApiBase::PARAM_DFLT => 'preferences',
548  'watch',
549  'unwatch',
550  'preferences',
551  'nochange'
552  ],
553  ],
554  'md5' => null,
555  'prependtext' => [
556  ApiBase::PARAM_TYPE => 'text',
557  ],
558  'appendtext' => [
559  ApiBase::PARAM_TYPE => 'text',
560  ],
561  'undo' => [
562  ApiBase::PARAM_TYPE => 'integer',
563  ApiBase::PARAM_MIN => 0,
565  ],
566  'undoafter' => [
567  ApiBase::PARAM_TYPE => 'integer',
568  ApiBase::PARAM_MIN => 0,
570  ],
571  'redirect' => [
572  ApiBase::PARAM_TYPE => 'boolean',
573  ApiBase::PARAM_DFLT => false,
574  ],
575  'contentformat' => [
577  ],
578  'contentmodel' => [
580  ],
581  'token' => [
582  // Standard definition automatically inserted
583  ApiBase::PARAM_HELP_MSG_APPEND => [ 'apihelp-edit-param-token' ],
584  ],
585  ];
586  }
587 
588  public function needsToken() {
589  return 'csrf';
590  }
591 
592  protected function getExamplesMessages() {
593  return [
594  'action=edit&title=Test&summary=test%20summary&' .
595  'text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
596  => 'apihelp-edit-example-edit',
597  'action=edit&title=Test&summary=NOTOC&minor=&' .
598  'prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
599  => 'apihelp-edit-example-prepend',
600  'action=edit&title=Test&undo=13585&undoafter=13579&' .
601  'basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
602  => 'apihelp-edit-example-undo',
603  ];
604  }
605 
606  public function getHelpUrls() {
607  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Edit';
608  }
609 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
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
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
const AS_READ_ONLY_PAGE_ANON
Status: this anonymous user is not allowed to edit this page.
Definition: EditPage.php:85
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
getResult()
Get the result object.
Definition: ApiBase.php:640
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
static getAllContentFormats()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const AS_ARTICLE_WAS_DELETED
Status: article was deleted while editing and param wpRecreate == false or form was not posted...
Definition: EditPage.php:106
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:2080
const AS_HOOK_ERROR
Status: Article update aborted by a hook function.
Definition: EditPage.php:65
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: ApiBase.php:1866
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:536
dieBlocked(AbstractBlock $block)
Throw an ApiUsageException, which will (if uncaught) call the main module&#39;s error handler and die wit...
Definition: ApiBase.php:2049
static getContentModels()
The edit page/HTML interface (split from Article) The actual database and text munging is still in Ar...
Definition: EditPage.php:46
Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base reque...
const AS_SUMMARY_NEEDED
Status: no edit summary given and the user has forceeditsummary set and the user is not editing in hi...
Definition: EditPage.php:128
const AS_HOOK_ERROR_EXPECTED
Status: A hook function returned an error.
Definition: EditPage.php:70
const AS_BLOCKED_PAGE_FOR_USER
Status: User is blocked from editing this page.
Definition: EditPage.php:75
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
dieWithException( $exception, array $options=[])
Abort execution with an error derived from an exception.
Definition: ApiBase.php:2021
const AS_NO_CREATE_PERMISSION
Status: user tried to create this page, but is not allowed to do that ( Title->userCan(&#39;create&#39;) == f...
Definition: EditPage.php:112
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that&#39;s attached to a given link target...
Definition: Revision.php:137
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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:1970
const AS_CONTENT_TOO_BIG
Status: Content too big (> $wgMaxArticleSize)
Definition: EditPage.php:80
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:1972
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:138
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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 '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). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. '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:1244
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getWatchlistValue( $watchlist, $titleObj, $userOption=null)
Return true if we&#39;re to watch the page, false if not, null if no change.
Definition: ApiBase.php:1099
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
const AS_SPAM_ERROR
Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex.
Definition: EditPage.php:148
requireAtLeastOneParameter( $params, $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:959
const PARAM_RANGE_ENFORCE
(boolean) For PARAM_TYPE &#39;integer&#39;, enforce PARAM_MIN and PARAM_MAX?
Definition: ApiBase.php:124
const AS_SUCCESS_UPDATE
Status: Article successfully updated.
Definition: EditPage.php:55
const AS_READ_ONLY_PAGE
Status: wiki is in readonly mode (wfReadOnly() == true)
Definition: EditPage.php:95
A module that allows for editing and creating pages.
Definition: ApiEditPage.php:34
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
const UNICODE_CHECK
Used for Unicode support checks.
Definition: EditPage.php:50
const AS_NO_CHANGE_CONTENT_MODEL
Status: user tried to modify the content model, but is not allowed to do that ( User::isAllowed(&#39;edit...
Definition: EditPage.php:164
$params
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:767
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
const AS_SUCCESS_NEW_ARTICLE
Status: Article successfully created.
Definition: EditPage.php:60
checkTitleUserPermissions(LinkTarget $linkTarget, $actions, $options=[])
Helper function for permission-denied errors.
Definition: ApiBase.php:2148
const AS_IMAGE_REDIRECT_LOGGED
Status: logged in user is not allowed to upload (User::isAllowed(&#39;upload&#39;) == false) ...
Definition: EditPage.php:158
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
const NS_MEDIAWIKI
Definition: Defines.php:68
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3039
getTitleOrPageId( $params, $load=false)
Get a WikiPage object from a title or pageid param, if possible.
Definition: ApiBase.php:1034
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 hook is for auditing only $req
Definition: hooks.txt:960
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
dieReadOnly()
Helper function for readonly errors.
Definition: ApiBase.php:2108
const AS_RATE_LIMITED
Status: rate limiter for action &#39;edit&#39; was tripped.
Definition: EditPage.php:100
versus $oldTitle
Definition: globals.txt:16
const AS_MAX_ARTICLE_SIZE_EXCEEDED
Status: article is too big (> $wgMaxArticleSize), after merging in the new section.
Definition: EditPage.php:138
const AS_IMAGE_REDIRECT_ANON
Status: anonymous user is not allowed to upload (User::isAllowed(&#39;upload&#39;) == false) ...
Definition: EditPage.php:153
const AS_TEXTBOX_EMPTY
Status: user tried to create a new section without content.
Definition: EditPage.php:133
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const AS_BLANK_ARTICLE
Status: user tried to create a blank page and wpIgnoreBlankArticle == false.
Definition: EditPage.php:117
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:776
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition: ApiBase.php:112
static canAddTagsAccompanyingChange(array $tags, User $user=null)
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the cha...
Definition: ChangeTags.php:521
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:57
const AS_CONFLICT_DETECTED
Status: (non-resolvable) edit conflict.
Definition: EditPage.php:122
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
static newFromWikiPage(WikiPage $page, IContextSource $context)
Create an Article object of the appropriate class for the given page.
Definition: Article.php:192
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:118
const AS_READ_ONLY_PAGE_LOGGED
Status: this logged in user is not allowed to edit this page.
Definition: EditPage.php:90
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
$content
Definition: pageupdater.txt:72
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
Exception representing a failure to serialize or unserialize a content object.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:40