MediaWiki  1.30.0
PageArchive.php
Go to the documentation of this file.
1 <?php
24 
28 class PageArchive {
30  protected $title;
31 
33  protected $fileStatus;
34 
36  protected $revisionStatus;
37 
39  protected $config;
40 
41  public function __construct( $title, Config $config = null ) {
42  if ( is_null( $title ) ) {
43  throw new MWException( __METHOD__ . ' given a null title.' );
44  }
45  $this->title = $title;
46  if ( $config === null ) {
47  wfDebug( __METHOD__ . ' did not have a Config object passed to it' );
48  $config = MediaWikiServices::getInstance()->getMainConfig();
49  }
50  $this->config = $config;
51  }
52 
53  public function doesWrites() {
54  return true;
55  }
56 
64  public static function listAllPages() {
65  $dbr = wfGetDB( DB_REPLICA );
66 
67  return self::listPages( $dbr, '' );
68  }
69 
78  public static function listPagesBySearch( $term ) {
80  if ( $title ) {
81  $ns = $title->getNamespace();
82  $termMain = $title->getText();
83  $termDb = $title->getDBkey();
84  } else {
85  // Prolly won't work too good
86  // @todo handle bare namespace names cleanly?
87  $ns = 0;
88  $termMain = $termDb = $term;
89  }
90 
91  // Try search engine first
92  $engine = MediaWikiServices::getInstance()->newSearchEngine();
93  $engine->setLimitOffset( 100 );
94  $engine->setNamespaces( [ $ns ] );
95  $results = $engine->searchArchiveTitle( $termMain );
96  if ( !$results->isOK() ) {
97  $results = [];
98  } else {
99  $results = $results->getValue();
100  }
101 
102  if ( !$results ) {
103  // Fall back to regular prefix search
104  return self::listPagesByPrefix( $term );
105  }
106 
107  $dbr = wfGetDB( DB_REPLICA );
108  $condTitles = array_unique( array_map( function ( Title $t ) {
109  return $t->getDBkey();
110  }, $results ) );
111  $conds = [
112  'ar_namespace' => $ns,
113  $dbr->makeList( [ 'ar_title' => $condTitles ], LIST_OR ) . " OR ar_title " .
114  $dbr->buildLike( $termDb, $dbr->anyString() )
115  ];
116 
117  return self::listPages( $dbr, $conds );
118  }
119 
128  public static function listPagesByPrefix( $prefix ) {
129  $dbr = wfGetDB( DB_REPLICA );
130 
131  $title = Title::newFromText( $prefix );
132  if ( $title ) {
133  $ns = $title->getNamespace();
134  $prefix = $title->getDBkey();
135  } else {
136  // Prolly won't work too good
137  // @todo handle bare namespace names cleanly?
138  $ns = 0;
139  }
140 
141  $conds = [
142  'ar_namespace' => $ns,
143  'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
144  ];
145 
146  return self::listPages( $dbr, $conds );
147  }
148 
154  protected static function listPages( $dbr, $condition ) {
155  return $dbr->select(
156  [ 'archive' ],
157  [
158  'ar_namespace',
159  'ar_title',
160  'count' => 'COUNT(*)'
161  ],
162  $condition,
163  __METHOD__,
164  [
165  'GROUP BY' => [ 'ar_namespace', 'ar_title' ],
166  'ORDER BY' => [ 'ar_namespace', 'ar_title' ],
167  'LIMIT' => 100,
168  ]
169  );
170  }
171 
178  public function listRevisions() {
179  $dbr = wfGetDB( DB_REPLICA );
180  $commentQuery = CommentStore::newKey( 'ar_comment' )->getJoin();
181 
182  $tables = [ 'archive' ] + $commentQuery['tables'];
183 
184  $fields = [
185  'ar_minor_edit', 'ar_timestamp', 'ar_user', 'ar_user_text',
186  'ar_len', 'ar_deleted', 'ar_rev_id', 'ar_sha1',
187  'ar_page_id'
188  ] + $commentQuery['fields'];
189 
190  if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
191  $fields[] = 'ar_content_format';
192  $fields[] = 'ar_content_model';
193  }
194 
195  $conds = [ 'ar_namespace' => $this->title->getNamespace(),
196  'ar_title' => $this->title->getDBkey() ];
197 
198  $options = [ 'ORDER BY' => 'ar_timestamp DESC' ];
199 
200  $join_conds = [] + $commentQuery['joins'];
201 
203  $tables,
204  $fields,
205  $conds,
206  $join_conds,
207  $options,
208  ''
209  );
210 
211  return $dbr->select( $tables,
212  $fields,
213  $conds,
214  __METHOD__,
215  $options,
216  $join_conds
217  );
218  }
219 
228  public function listFiles() {
229  if ( $this->title->getNamespace() != NS_FILE ) {
230  return null;
231  }
232 
233  $dbr = wfGetDB( DB_REPLICA );
234  return $dbr->select(
235  'filearchive',
237  [ 'fa_name' => $this->title->getDBkey() ],
238  __METHOD__,
239  [ 'ORDER BY' => 'fa_timestamp DESC' ]
240  );
241  }
242 
250  public function getRevision( $timestamp ) {
251  $dbr = wfGetDB( DB_REPLICA );
252  $commentQuery = CommentStore::newKey( 'ar_comment' )->getJoin();
253 
254  $tables = [ 'archive' ] + $commentQuery['tables'];
255 
256  $fields = [
257  'ar_rev_id',
258  'ar_text',
259  'ar_user',
260  'ar_user_text',
261  'ar_timestamp',
262  'ar_minor_edit',
263  'ar_flags',
264  'ar_text_id',
265  'ar_deleted',
266  'ar_len',
267  'ar_sha1',
268  ] + $commentQuery['fields'];
269 
270  if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
271  $fields[] = 'ar_content_format';
272  $fields[] = 'ar_content_model';
273  }
274 
275  $join_conds = [] + $commentQuery['joins'];
276 
277  $row = $dbr->selectRow(
278  $tables,
279  $fields,
280  [
281  'ar_namespace' => $this->title->getNamespace(),
282  'ar_title' => $this->title->getDBkey(),
283  'ar_timestamp' => $dbr->timestamp( $timestamp )
284  ],
285  __METHOD__,
286  [],
287  $join_conds
288  );
289 
290  if ( $row ) {
291  return Revision::newFromArchiveRow( $row, [ 'title' => $this->title ] );
292  }
293 
294  return null;
295  }
296 
307  public function getPreviousRevision( $timestamp ) {
308  $dbr = wfGetDB( DB_REPLICA );
309 
310  // Check the previous deleted revision...
311  $row = $dbr->selectRow( 'archive',
312  'ar_timestamp',
313  [ 'ar_namespace' => $this->title->getNamespace(),
314  'ar_title' => $this->title->getDBkey(),
315  'ar_timestamp < ' .
316  $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
317  __METHOD__,
318  [
319  'ORDER BY' => 'ar_timestamp DESC',
320  'LIMIT' => 1 ] );
321  $prevDeleted = $row ? wfTimestamp( TS_MW, $row->ar_timestamp ) : false;
322 
323  $row = $dbr->selectRow( [ 'page', 'revision' ],
324  [ 'rev_id', 'rev_timestamp' ],
325  [
326  'page_namespace' => $this->title->getNamespace(),
327  'page_title' => $this->title->getDBkey(),
328  'page_id = rev_page',
329  'rev_timestamp < ' .
330  $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
331  __METHOD__,
332  [
333  'ORDER BY' => 'rev_timestamp DESC',
334  'LIMIT' => 1 ] );
335  $prevLive = $row ? wfTimestamp( TS_MW, $row->rev_timestamp ) : false;
336  $prevLiveId = $row ? intval( $row->rev_id ) : null;
337 
338  if ( $prevLive && $prevLive > $prevDeleted ) {
339  // Most prior revision was live
340  return Revision::newFromId( $prevLiveId );
341  } elseif ( $prevDeleted ) {
342  // Most prior revision was deleted
343  return $this->getRevision( $prevDeleted );
344  }
345 
346  // No prior revision on this page.
347  return null;
348  }
349 
356  public function getTextFromRow( $row ) {
357  if ( is_null( $row->ar_text_id ) ) {
358  // An old row from MediaWiki 1.4 or previous.
359  // Text is embedded in this row in classic compression format.
360  return Revision::getRevisionText( $row, 'ar_' );
361  }
362 
363  // New-style: keyed to the text storage backend.
364  $dbr = wfGetDB( DB_REPLICA );
365  $text = $dbr->selectRow( 'text',
366  [ 'old_text', 'old_flags' ],
367  [ 'old_id' => $row->ar_text_id ],
368  __METHOD__ );
369 
370  return Revision::getRevisionText( $text );
371  }
372 
381  public function getLastRevisionText() {
382  $dbr = wfGetDB( DB_REPLICA );
383  $row = $dbr->selectRow( 'archive',
384  [ 'ar_text', 'ar_flags', 'ar_text_id' ],
385  [ 'ar_namespace' => $this->title->getNamespace(),
386  'ar_title' => $this->title->getDBkey() ],
387  __METHOD__,
388  [ 'ORDER BY' => 'ar_timestamp DESC' ] );
389 
390  if ( $row ) {
391  return $this->getTextFromRow( $row );
392  }
393 
394  return null;
395  }
396 
402  public function isDeleted() {
403  $dbr = wfGetDB( DB_REPLICA );
404  $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
405  [ 'ar_namespace' => $this->title->getNamespace(),
406  'ar_title' => $this->title->getDBkey() ],
407  __METHOD__
408  );
409 
410  return ( $n > 0 );
411  }
412 
432  public function undelete( $timestamps, $comment = '', $fileVersions = [],
433  $unsuppress = false, User $user = null, $tags = null
434  ) {
435  // If both the set of text revisions and file revisions are empty,
436  // restore everything. Otherwise, just restore the requested items.
437  $restoreAll = empty( $timestamps ) && empty( $fileVersions );
438 
439  $restoreText = $restoreAll || !empty( $timestamps );
440  $restoreFiles = $restoreAll || !empty( $fileVersions );
441 
442  if ( $restoreFiles && $this->title->getNamespace() == NS_FILE ) {
443  $img = wfLocalFile( $this->title );
444  $img->load( File::READ_LATEST );
445  $this->fileStatus = $img->restore( $fileVersions, $unsuppress );
446  if ( !$this->fileStatus->isOK() ) {
447  return false;
448  }
449  $filesRestored = $this->fileStatus->successCount;
450  } else {
451  $filesRestored = 0;
452  }
453 
454  if ( $restoreText ) {
455  $this->revisionStatus = $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
456  if ( !$this->revisionStatus->isOK() ) {
457  return false;
458  }
459 
460  $textRestored = $this->revisionStatus->getValue();
461  } else {
462  $textRestored = 0;
463  }
464 
465  // Touch the log!
466 
467  if ( !$textRestored && !$filesRestored ) {
468  wfDebug( "Undelete: nothing undeleted...\n" );
469 
470  return false;
471  }
472 
473  if ( $user === null ) {
474  global $wgUser;
475  $user = $wgUser;
476  }
477 
478  $logEntry = new ManualLogEntry( 'delete', 'restore' );
479  $logEntry->setPerformer( $user );
480  $logEntry->setTarget( $this->title );
481  $logEntry->setComment( $comment );
482  $logEntry->setTags( $tags );
483  $logEntry->setParameters( [
484  ':assoc:count' => [
485  'revisions' => $textRestored,
486  'files' => $filesRestored,
487  ],
488  ] );
489 
490  Hooks::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
491 
492  $logid = $logEntry->insert();
493  $logEntry->publish( $logid );
494 
495  return [ $textRestored, $filesRestored, $comment ];
496  }
497 
509  private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
510  if ( wfReadOnly() ) {
511  throw new ReadOnlyError();
512  }
513 
514  $dbw = wfGetDB( DB_MASTER );
515  $dbw->startAtomic( __METHOD__ );
516 
517  $restoreAll = empty( $timestamps );
518 
519  # Does this page already exist? We'll have to update it...
520  $article = WikiPage::factory( $this->title );
521  # Load latest data for the current page (T33179)
522  $article->loadPageData( 'fromdbmaster' );
523  $oldcountable = $article->isCountable();
524 
525  $page = $dbw->selectRow( 'page',
526  [ 'page_id', 'page_latest' ],
527  [ 'page_namespace' => $this->title->getNamespace(),
528  'page_title' => $this->title->getDBkey() ],
529  __METHOD__,
530  [ 'FOR UPDATE' ] // lock page
531  );
532 
533  if ( $page ) {
534  $makepage = false;
535  # Page already exists. Import the history, and if necessary
536  # we'll update the latest revision field in the record.
537 
538  # Get the time span of this page
539  $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
540  [ 'rev_id' => $page->page_latest ],
541  __METHOD__ );
542 
543  if ( $previousTimestamp === false ) {
544  wfDebug( __METHOD__ . ": existing page refers to a page_latest that does not exist\n" );
545 
546  $status = Status::newGood( 0 );
547  $status->warning( 'undeleterevision-missing' );
548  $dbw->endAtomic( __METHOD__ );
549 
550  return $status;
551  }
552  } else {
553  # Have to create a new article...
554  $makepage = true;
555  $previousTimestamp = 0;
556  }
557 
558  $oldWhere = [
559  'ar_namespace' => $this->title->getNamespace(),
560  'ar_title' => $this->title->getDBkey(),
561  ];
562  if ( !$restoreAll ) {
563  $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
564  }
565 
566  $commentQuery = CommentStore::newKey( 'ar_comment' )->getJoin();
567 
568  $tables = [ 'archive', 'revision' ] + $commentQuery['tables'];
569 
570  $fields = [
571  'ar_id',
572  'ar_rev_id',
573  'rev_id',
574  'ar_text',
575  'ar_user',
576  'ar_user_text',
577  'ar_timestamp',
578  'ar_minor_edit',
579  'ar_flags',
580  'ar_text_id',
581  'ar_deleted',
582  'ar_page_id',
583  'ar_len',
584  'ar_sha1'
585  ] + $commentQuery['fields'];
586 
587  if ( $this->config->get( 'ContentHandlerUseDB' ) ) {
588  $fields[] = 'ar_content_format';
589  $fields[] = 'ar_content_model';
590  }
591 
592  $join_conds = [
593  'revision' => [ 'LEFT JOIN', 'ar_rev_id=rev_id' ],
594  ] + $commentQuery['joins'];
595 
599  $result = $dbw->select(
600  $tables,
601  $fields,
602  $oldWhere,
603  __METHOD__,
604  /* options */
605  [ 'ORDER BY' => 'ar_timestamp' ],
606  $join_conds
607  );
608 
609  $rev_count = $result->numRows();
610  if ( !$rev_count ) {
611  wfDebug( __METHOD__ . ": no revisions to restore\n" );
612 
613  $status = Status::newGood( 0 );
614  $status->warning( "undelete-no-results" );
615  $dbw->endAtomic( __METHOD__ );
616 
617  return $status;
618  }
619 
620  // We use ar_id because there can be duplicate ar_rev_id even for the same
621  // page. In this case, we may be able to restore the first one.
622  $restoreFailedArIds = [];
623 
624  // Map rev_id to the ar_id that is allowed to use it. When checking later,
625  // if it doesn't match, the current ar_id can not be restored.
626 
627  // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
628  // rev_id is taken before we even start the restore).
629  $allowedRevIdToArIdMap = [];
630 
631  $latestRestorableRow = null;
632 
633  foreach ( $result as $row ) {
634  if ( $row->ar_rev_id ) {
635  // rev_id is taken even before we start restoring.
636  if ( $row->ar_rev_id === $row->rev_id ) {
637  $restoreFailedArIds[] = $row->ar_id;
638  $allowedRevIdToArIdMap[$row->ar_rev_id] = -1;
639  } else {
640  // rev_id is not taken yet in the DB, but it might be taken
641  // by a prior revision in the same restore operation. If
642  // not, we need to reserve it.
643  if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id] ) ) {
644  $restoreFailedArIds[] = $row->ar_id;
645  } else {
646  $allowedRevIdToArIdMap[$row->ar_rev_id] = $row->ar_id;
647  $latestRestorableRow = $row;
648  }
649  }
650  } else {
651  // If ar_rev_id is null, there can't be a collision, and a
652  // rev_id will be chosen automatically.
653  $latestRestorableRow = $row;
654  }
655  }
656 
657  $result->seek( 0 ); // move back
658 
659  $oldPageId = 0;
660  if ( $latestRestorableRow !== null ) {
661  $oldPageId = (int)$latestRestorableRow->ar_page_id; // pass this to ArticleUndelete hook
662 
663  // grab the content to check consistency with global state before restoring the page.
664  $revision = Revision::newFromArchiveRow( $latestRestorableRow,
665  [
666  'title' => $article->getTitle(), // used to derive default content model
667  ]
668  );
669  $user = User::newFromName( $revision->getUserText( Revision::RAW ), false );
670  $content = $revision->getContent( Revision::RAW );
671 
672  // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
673  $status = $content->prepareSave( $article, 0, -1, $user );
674  if ( !$status->isOK() ) {
675  $dbw->endAtomic( __METHOD__ );
676 
677  return $status;
678  }
679  }
680 
681  $newid = false; // newly created page ID
682  $restored = 0; // number of revisions restored
684  $revision = null;
685  $restoredPages = [];
686  // If there are no restorable revisions, we can skip most of the steps.
687  if ( $latestRestorableRow === null ) {
688  $failedRevisionCount = $rev_count;
689  } else {
690  if ( $makepage ) {
691  // Check the state of the newest to-be version...
692  if ( !$unsuppress
693  && ( $latestRestorableRow->ar_deleted & Revision::DELETED_TEXT )
694  ) {
695  $dbw->endAtomic( __METHOD__ );
696 
697  return Status::newFatal( "undeleterevdel" );
698  }
699  // Safe to insert now...
700  $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id );
701  if ( $newid === false ) {
702  // The old ID is reserved; let's pick another
703  $newid = $article->insertOn( $dbw );
704  }
705  $pageId = $newid;
706  } else {
707  // Check if a deleted revision will become the current revision...
708  if ( $latestRestorableRow->ar_timestamp > $previousTimestamp ) {
709  // Check the state of the newest to-be version...
710  if ( !$unsuppress
711  && ( $latestRestorableRow->ar_deleted & Revision::DELETED_TEXT )
712  ) {
713  $dbw->endAtomic( __METHOD__ );
714 
715  return Status::newFatal( "undeleterevdel" );
716  }
717  }
718 
719  $newid = false;
720  $pageId = $article->getId();
721  }
722 
723  foreach ( $result as $row ) {
724  // Check for key dupes due to needed archive integrity.
725  if ( $row->ar_rev_id && $allowedRevIdToArIdMap[$row->ar_rev_id] !== $row->ar_id ) {
726  continue;
727  }
728  // Insert one revision at a time...maintaining deletion status
729  // unless we are specifically removing all restrictions...
730  $revision = Revision::newFromArchiveRow( $row,
731  [
732  'page' => $pageId,
733  'title' => $this->title,
734  'deleted' => $unsuppress ? 0 : $row->ar_deleted
735  ] );
736 
737  // This will also copy the revision to ip_changes if it was an IP edit.
738  $revision->insertOn( $dbw );
739 
740  $restored++;
741 
742  Hooks::run( 'ArticleRevisionUndeleted',
743  [ &$this->title, $revision, $row->ar_page_id ] );
744  $restoredPages[$row->ar_page_id] = true;
745  }
746 
747  // Now that it's safely stored, take it out of the archive
748  // Don't delete rows that we failed to restore
749  $toDeleteConds = $oldWhere;
750  $failedRevisionCount = count( $restoreFailedArIds );
751  if ( $failedRevisionCount > 0 ) {
752  $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
753  }
754 
755  $dbw->delete( 'archive',
756  $toDeleteConds,
757  __METHOD__ );
758  }
759 
760  $status = Status::newGood( $restored );
761 
762  if ( $failedRevisionCount > 0 ) {
763  $status->warning(
764  wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
765  }
766 
767  // Was anything restored at all?
768  if ( $restored ) {
769  $created = (bool)$newid;
770  // Attach the latest revision to the page...
771  $wasnew = $article->updateIfNewerOn( $dbw, $revision );
772  if ( $created || $wasnew ) {
773  // Update site stats, link tables, etc
774  $article->doEditUpdates(
775  $revision,
776  User::newFromName( $revision->getUserText( Revision::RAW ), false ),
777  [
778  'created' => $created,
779  'oldcountable' => $oldcountable,
780  'restored' => true
781  ]
782  );
783  }
784 
785  Hooks::run( 'ArticleUndelete',
786  [ &$this->title, $created, $comment, $oldPageId, $restoredPages ] );
787  if ( $this->title->getNamespace() == NS_FILE ) {
788  DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->title, 'imagelinks' ) );
789  }
790  }
791 
792  $dbw->endAtomic( __METHOD__ );
793 
794  return $status;
795  }
796 
800  public function getFileStatus() {
801  return $this->fileStatus;
802  }
803 
807  public function getRevisionStatus() {
808  return $this->revisionStatus;
809  }
810 }
ReadOnlyError
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Definition: ReadOnlyError.php:28
Revision\newFromArchiveRow
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:189
$user
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 account $user
Definition: hooks.txt:244
$wgUser
$wgUser
Definition: Setup.php:809
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:268
PageArchive\getFileStatus
getFileStatus()
Definition: PageArchive.php:800
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$tables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:988
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:116
PageArchive
Used to show archived pages and eventually restore them.
Definition: PageArchive.php:28
captcha-old.count
count
Definition: captcha-old.py:249
PageArchive\listPages
static listPages( $dbr, $condition)
Definition: PageArchive.php:154
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links: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! 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:1963
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2040
PageArchive\$config
Config $config
Definition: PageArchive.php:39
$status
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
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
DeferredUpdates\addUpdate
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
Definition: DeferredUpdates.php:76
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
PageArchive\listPagesByPrefix
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix.
Definition: PageArchive.php:128
NS_FILE
const NS_FILE
Definition: Defines.php:71
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1324
Revision\getRevisionText
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Definition: Revision.php:1266
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:550
$term
external whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2811
PageArchive\listFiles
listFiles()
List the deleted file revisions for this page, if it's a file page.
Definition: PageArchive.php:228
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
PageArchive\$revisionStatus
Status $revisionStatus
Definition: PageArchive.php:36
CommentStore\newKey
static newKey( $key)
Static constructor for easier chaining.
Definition: CommentStore.php:114
PageArchive\listPagesBySearch
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive.
Definition: PageArchive.php:78
php
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
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
PageArchive\isDeleted
isDeleted()
Quick check if any archived revisions are present for the page.
Definition: PageArchive.php:402
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
title
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
Definition: All_system_messages.txt:2696
ChangeTags\modifyDisplayQuery
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag='')
Applies all tags-related changes to a query.
Definition: ChangeTags.php:661
LIST_OR
const LIST_OR
Definition: Defines.php:47
Title\getDBkey
getDBkey()
Get the main part with underscores.
Definition: Title.php:955
MWException
MediaWiki exception.
Definition: MWException.php:26
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:121
PageArchive\listAllPages
static listAllPages()
List all deleted pages recorded in the archive table.
Definition: PageArchive.php:64
Title\getNamespace
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:978
PageArchive\undeleteRevisions
undeleteRevisions( $timestamps, $unsuppress=false, $comment='')
This is the meaty bit – It restores archived revisions of the given page to the revision table.
Definition: PageArchive.php:509
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
$article
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
PageArchive\listRevisions
listRevisions()
List the revisions of the given page.
Definition: PageArchive.php:178
PageArchive\getRevisionStatus
getRevisionStatus()
Definition: PageArchive.php:807
$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2834
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:1047
PageArchive\$fileStatus
Status $fileStatus
Definition: PageArchive.php:33
HTMLCacheUpdate
Class to invalidate the HTML cache of all the pages linking to a given title.
Definition: HTMLCacheUpdate.php:29
PageArchive\getRevision
getRevision( $timestamp)
Return a Revision object containing data for the deleted revision.
Definition: PageArchive.php:250
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Revision\RAW
const RAW
Definition: Revision.php:100
PageArchive\doesWrites
doesWrites()
Definition: PageArchive.php:53
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$dbr
if(! $regexes) $dbr
Definition: cleanup.php:94
$options
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 & $options
Definition: hooks.txt:1965
PageArchive\getLastRevisionText
getLastRevisionText()
Fetch (and decompress if necessary) the stored text of the most recently edited deleted revision of t...
Definition: PageArchive.php:381
PageArchive\undelete
undelete( $timestamps, $comment='', $fileVersions=[], $unsuppress=false, User $user=null, $tags=null)
Restore the given (or all) text and file revisions for the page.
Definition: PageArchive.php:432
as
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
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:400
PageArchive\getTextFromRow
getTextFromRow( $row)
Get the text from an archive row containing ar_text, ar_flags and ar_text_id.
Definition: PageArchive.php:356
wfMessage
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 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
$t
$t
Definition: testCompression.php:67
ArchivedFile\selectFields
static selectFields()
Fields in the filearchive table.
Definition: ArchivedFile.php:222
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
PageArchive\__construct
__construct( $title, Config $config=null)
Definition: PageArchive.php:41
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2908
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
PageArchive\$title
Title $title
Definition: PageArchive.php:30
Title\getText
getText()
Get the text form (spaces not underscores) of the main part.
Definition: Title.php:937
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:90
PageArchive\getPreviousRevision
getPreviousRevision( $timestamp)
Return the most-previous revision, either live or deleted, against the deleted revision given by time...
Definition: PageArchive.php:307