MediaWiki  REL1_31
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  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
180  $queryInfo = $revisionStore->getArchiveQueryInfo();
181 
182  $conds = [
183  'ar_namespace' => $this->title->getNamespace(),
184  'ar_title' => $this->title->getDBkey(),
185  ];
186  $options = [ 'ORDER BY' => 'ar_timestamp DESC' ];
187 
189  $queryInfo['tables'],
190  $queryInfo['fields'],
191  $conds,
192  $queryInfo['joins'],
193  $options,
194  ''
195  );
196 
197  $dbr = wfGetDB( DB_REPLICA );
198  return $dbr->select(
199  $queryInfo['tables'],
200  $queryInfo['fields'],
201  $conds,
202  __METHOD__,
203  $options,
204  $queryInfo['joins']
205  );
206  }
207 
216  public function listFiles() {
217  if ( $this->title->getNamespace() != NS_FILE ) {
218  return null;
219  }
220 
221  $dbr = wfGetDB( DB_REPLICA );
222  $fileQuery = ArchivedFile::getQueryInfo();
223  return $dbr->select(
224  $fileQuery['tables'],
225  $fileQuery['fields'],
226  [ 'fa_name' => $this->title->getDBkey() ],
227  __METHOD__,
228  [ 'ORDER BY' => 'fa_timestamp DESC' ],
229  $fileQuery['joins']
230  );
231  }
232 
240  public function getRevision( $timestamp ) {
241  $dbr = wfGetDB( DB_REPLICA );
242  $arQuery = Revision::getArchiveQueryInfo();
243 
244  $row = $dbr->selectRow(
245  $arQuery['tables'],
246  $arQuery['fields'],
247  [
248  'ar_namespace' => $this->title->getNamespace(),
249  'ar_title' => $this->title->getDBkey(),
250  'ar_timestamp' => $dbr->timestamp( $timestamp )
251  ],
252  __METHOD__,
253  [],
254  $arQuery['joins']
255  );
256 
257  if ( $row ) {
258  return Revision::newFromArchiveRow( $row, [ 'title' => $this->title ] );
259  }
260 
261  return null;
262  }
263 
274  public function getPreviousRevision( $timestamp ) {
275  $dbr = wfGetDB( DB_REPLICA );
276 
277  // Check the previous deleted revision...
278  $row = $dbr->selectRow( 'archive',
279  'ar_timestamp',
280  [ 'ar_namespace' => $this->title->getNamespace(),
281  'ar_title' => $this->title->getDBkey(),
282  'ar_timestamp < ' .
283  $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
284  __METHOD__,
285  [
286  'ORDER BY' => 'ar_timestamp DESC',
287  'LIMIT' => 1 ] );
288  $prevDeleted = $row ? wfTimestamp( TS_MW, $row->ar_timestamp ) : false;
289 
290  $row = $dbr->selectRow( [ 'page', 'revision' ],
291  [ 'rev_id', 'rev_timestamp' ],
292  [
293  'page_namespace' => $this->title->getNamespace(),
294  'page_title' => $this->title->getDBkey(),
295  'page_id = rev_page',
296  'rev_timestamp < ' .
297  $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
298  __METHOD__,
299  [
300  'ORDER BY' => 'rev_timestamp DESC',
301  'LIMIT' => 1 ] );
302  $prevLive = $row ? wfTimestamp( TS_MW, $row->rev_timestamp ) : false;
303  $prevLiveId = $row ? intval( $row->rev_id ) : null;
304 
305  if ( $prevLive && $prevLive > $prevDeleted ) {
306  // Most prior revision was live
307  return Revision::newFromId( $prevLiveId );
308  } elseif ( $prevDeleted ) {
309  // Most prior revision was deleted
310  return $this->getRevision( $prevDeleted );
311  }
312 
313  // No prior revision on this page.
314  return null;
315  }
316 
324  public function getTextFromRow( $row ) {
325  $dbr = wfGetDB( DB_REPLICA );
326  $text = $dbr->selectRow( 'text',
327  [ 'old_text', 'old_flags' ],
328  [ 'old_id' => $row->ar_text_id ],
329  __METHOD__ );
330 
331  return Revision::getRevisionText( $text );
332  }
333 
342  public function getLastRevisionText() {
343  $dbr = wfGetDB( DB_REPLICA );
344  $row = $dbr->selectRow(
345  [ 'archive', 'text' ],
346  [ 'old_text', 'old_flags' ],
347  [ 'ar_namespace' => $this->title->getNamespace(),
348  'ar_title' => $this->title->getDBkey() ],
349  __METHOD__,
350  [ 'ORDER BY' => 'ar_timestamp DESC, ar_id DESC' ],
351  [ 'text' => [ 'JOIN', 'old_id = ar_text_id' ] ]
352  );
353 
354  if ( $row ) {
355  return Revision::getRevisionText( $row );
356  }
357 
358  return null;
359  }
360 
366  public function isDeleted() {
367  $dbr = wfGetDB( DB_REPLICA );
368  $n = $dbr->selectField( 'archive', 'COUNT(ar_title)',
369  [ 'ar_namespace' => $this->title->getNamespace(),
370  'ar_title' => $this->title->getDBkey() ],
371  __METHOD__
372  );
373 
374  return ( $n > 0 );
375  }
376 
396  public function undelete( $timestamps, $comment = '', $fileVersions = [],
397  $unsuppress = false, User $user = null, $tags = null
398  ) {
399  // If both the set of text revisions and file revisions are empty,
400  // restore everything. Otherwise, just restore the requested items.
401  $restoreAll = empty( $timestamps ) && empty( $fileVersions );
402 
403  $restoreText = $restoreAll || !empty( $timestamps );
404  $restoreFiles = $restoreAll || !empty( $fileVersions );
405 
406  if ( $restoreFiles && $this->title->getNamespace() == NS_FILE ) {
407  $img = wfLocalFile( $this->title );
408  $img->load( File::READ_LATEST );
409  $this->fileStatus = $img->restore( $fileVersions, $unsuppress );
410  if ( !$this->fileStatus->isOK() ) {
411  return false;
412  }
413  $filesRestored = $this->fileStatus->successCount;
414  } else {
415  $filesRestored = 0;
416  }
417 
418  if ( $restoreText ) {
419  $this->revisionStatus = $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
420  if ( !$this->revisionStatus->isOK() ) {
421  return false;
422  }
423 
424  $textRestored = $this->revisionStatus->getValue();
425  } else {
426  $textRestored = 0;
427  }
428 
429  // Touch the log!
430 
431  if ( !$textRestored && !$filesRestored ) {
432  wfDebug( "Undelete: nothing undeleted...\n" );
433 
434  return false;
435  }
436 
437  if ( $user === null ) {
438  global $wgUser;
439  $user = $wgUser;
440  }
441 
442  $logEntry = new ManualLogEntry( 'delete', 'restore' );
443  $logEntry->setPerformer( $user );
444  $logEntry->setTarget( $this->title );
445  $logEntry->setComment( $comment );
446  $logEntry->setTags( $tags );
447  $logEntry->setParameters( [
448  ':assoc:count' => [
449  'revisions' => $textRestored,
450  'files' => $filesRestored,
451  ],
452  ] );
453 
454  Hooks::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
455 
456  $logid = $logEntry->insert();
457  $logEntry->publish( $logid );
458 
459  return [ $textRestored, $filesRestored, $comment ];
460  }
461 
473  private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
474  if ( wfReadOnly() ) {
475  throw new ReadOnlyError();
476  }
477 
478  $dbw = wfGetDB( DB_MASTER );
479  $dbw->startAtomic( __METHOD__ );
480 
481  $restoreAll = empty( $timestamps );
482 
483  # Does this page already exist? We'll have to update it...
484  $article = WikiPage::factory( $this->title );
485  # Load latest data for the current page (T33179)
486  $article->loadPageData( 'fromdbmaster' );
487  $oldcountable = $article->isCountable();
488 
489  $page = $dbw->selectRow( 'page',
490  [ 'page_id', 'page_latest' ],
491  [ 'page_namespace' => $this->title->getNamespace(),
492  'page_title' => $this->title->getDBkey() ],
493  __METHOD__,
494  [ 'FOR UPDATE' ] // lock page
495  );
496 
497  if ( $page ) {
498  $makepage = false;
499  # Page already exists. Import the history, and if necessary
500  # we'll update the latest revision field in the record.
501 
502  # Get the time span of this page
503  $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
504  [ 'rev_id' => $page->page_latest ],
505  __METHOD__ );
506 
507  if ( $previousTimestamp === false ) {
508  wfDebug( __METHOD__ . ": existing page refers to a page_latest that does not exist\n" );
509 
510  $status = Status::newGood( 0 );
511  $status->warning( 'undeleterevision-missing' );
512  $dbw->endAtomic( __METHOD__ );
513 
514  return $status;
515  }
516  } else {
517  # Have to create a new article...
518  $makepage = true;
519  $previousTimestamp = 0;
520  }
521 
522  $oldWhere = [
523  'ar_namespace' => $this->title->getNamespace(),
524  'ar_title' => $this->title->getDBkey(),
525  ];
526  if ( !$restoreAll ) {
527  $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
528  }
529 
530  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
531  $queryInfo = $revisionStore->getArchiveQueryInfo();
532  $queryInfo['tables'][] = 'revision';
533  $queryInfo['fields'][] = 'rev_id';
534  $queryInfo['joins']['revision'] = [ 'LEFT JOIN', 'ar_rev_id=rev_id' ];
535 
539  $result = $dbw->select(
540  $queryInfo['tables'],
541  $queryInfo['fields'],
542  $oldWhere,
543  __METHOD__,
544  /* options */
545  [ 'ORDER BY' => 'ar_timestamp' ],
546  $queryInfo['joins']
547  );
548 
549  $rev_count = $result->numRows();
550  if ( !$rev_count ) {
551  wfDebug( __METHOD__ . ": no revisions to restore\n" );
552 
553  $status = Status::newGood( 0 );
554  $status->warning( "undelete-no-results" );
555  $dbw->endAtomic( __METHOD__ );
556 
557  return $status;
558  }
559 
560  // We use ar_id because there can be duplicate ar_rev_id even for the same
561  // page. In this case, we may be able to restore the first one.
562  $restoreFailedArIds = [];
563 
564  // Map rev_id to the ar_id that is allowed to use it. When checking later,
565  // if it doesn't match, the current ar_id can not be restored.
566 
567  // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
568  // rev_id is taken before we even start the restore).
569  $allowedRevIdToArIdMap = [];
570 
571  $latestRestorableRow = null;
572 
573  foreach ( $result as $row ) {
574  if ( $row->ar_rev_id ) {
575  // rev_id is taken even before we start restoring.
576  if ( $row->ar_rev_id === $row->rev_id ) {
577  $restoreFailedArIds[] = $row->ar_id;
578  $allowedRevIdToArIdMap[$row->ar_rev_id] = -1;
579  } else {
580  // rev_id is not taken yet in the DB, but it might be taken
581  // by a prior revision in the same restore operation. If
582  // not, we need to reserve it.
583  if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id] ) ) {
584  $restoreFailedArIds[] = $row->ar_id;
585  } else {
586  $allowedRevIdToArIdMap[$row->ar_rev_id] = $row->ar_id;
587  $latestRestorableRow = $row;
588  }
589  }
590  } else {
591  // If ar_rev_id is null, there can't be a collision, and a
592  // rev_id will be chosen automatically.
593  $latestRestorableRow = $row;
594  }
595  }
596 
597  $result->seek( 0 ); // move back
598 
599  $oldPageId = 0;
600  if ( $latestRestorableRow !== null ) {
601  $oldPageId = (int)$latestRestorableRow->ar_page_id; // pass this to ArticleUndelete hook
602 
603  // grab the content to check consistency with global state before restoring the page.
604  $revision = Revision::newFromArchiveRow( $latestRestorableRow,
605  [
606  'title' => $article->getTitle(), // used to derive default content model
607  ]
608  );
609  $user = User::newFromName( $revision->getUserText( Revision::RAW ), false );
610  $content = $revision->getContent( Revision::RAW );
611 
612  // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
613  $status = $content->prepareSave( $article, 0, -1, $user );
614  if ( !$status->isOK() ) {
615  $dbw->endAtomic( __METHOD__ );
616 
617  return $status;
618  }
619  }
620 
621  $newid = false; // newly created page ID
622  $restored = 0; // number of revisions restored
624  $revision = null;
625  $restoredPages = [];
626  // If there are no restorable revisions, we can skip most of the steps.
627  if ( $latestRestorableRow === null ) {
628  $failedRevisionCount = $rev_count;
629  } else {
630  if ( $makepage ) {
631  // Check the state of the newest to-be version...
632  if ( !$unsuppress
633  && ( $latestRestorableRow->ar_deleted & Revision::DELETED_TEXT )
634  ) {
635  $dbw->endAtomic( __METHOD__ );
636 
637  return Status::newFatal( "undeleterevdel" );
638  }
639  // Safe to insert now...
640  $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id );
641  if ( $newid === false ) {
642  // The old ID is reserved; let's pick another
643  $newid = $article->insertOn( $dbw );
644  }
645  $pageId = $newid;
646  } else {
647  // Check if a deleted revision will become the current revision...
648  if ( $latestRestorableRow->ar_timestamp > $previousTimestamp ) {
649  // Check the state of the newest to-be version...
650  if ( !$unsuppress
651  && ( $latestRestorableRow->ar_deleted & Revision::DELETED_TEXT )
652  ) {
653  $dbw->endAtomic( __METHOD__ );
654 
655  return Status::newFatal( "undeleterevdel" );
656  }
657  }
658 
659  $newid = false;
660  $pageId = $article->getId();
661  }
662 
663  foreach ( $result as $row ) {
664  // Check for key dupes due to needed archive integrity.
665  if ( $row->ar_rev_id && $allowedRevIdToArIdMap[$row->ar_rev_id] !== $row->ar_id ) {
666  continue;
667  }
668  // Insert one revision at a time...maintaining deletion status
669  // unless we are specifically removing all restrictions...
670  $revision = Revision::newFromArchiveRow( $row,
671  [
672  'page' => $pageId,
673  'title' => $this->title,
674  'deleted' => $unsuppress ? 0 : $row->ar_deleted
675  ] );
676 
677  // This will also copy the revision to ip_changes if it was an IP edit.
678  $revision->insertOn( $dbw );
679 
680  $restored++;
681 
682  Hooks::run( 'ArticleRevisionUndeleted',
683  [ &$this->title, $revision, $row->ar_page_id ] );
684  $restoredPages[$row->ar_page_id] = true;
685  }
686 
687  // Now that it's safely stored, take it out of the archive
688  // Don't delete rows that we failed to restore
689  $toDeleteConds = $oldWhere;
690  $failedRevisionCount = count( $restoreFailedArIds );
691  if ( $failedRevisionCount > 0 ) {
692  $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
693  }
694 
695  $dbw->delete( 'archive',
696  $toDeleteConds,
697  __METHOD__ );
698  }
699 
700  $status = Status::newGood( $restored );
701 
702  if ( $failedRevisionCount > 0 ) {
703  $status->warning(
704  wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
705  }
706 
707  // Was anything restored at all?
708  if ( $restored ) {
709  $created = (bool)$newid;
710  // Attach the latest revision to the page...
711  $wasnew = $article->updateIfNewerOn( $dbw, $revision );
712  if ( $created || $wasnew ) {
713  // Update site stats, link tables, etc
714  $article->doEditUpdates(
715  $revision,
716  User::newFromName( $revision->getUserText( Revision::RAW ), false ),
717  [
718  'created' => $created,
719  'oldcountable' => $oldcountable,
720  'restored' => true
721  ]
722  );
723  }
724 
725  Hooks::run( 'ArticleUndelete',
726  [ &$this->title, $created, $comment, $oldPageId, $restoredPages ] );
727  if ( $this->title->getNamespace() == NS_FILE ) {
729  new HTMLCacheUpdate( $this->title, 'imagelinks', 'file-restore' )
730  );
731  }
732  }
733 
734  $dbw->endAtomic( __METHOD__ );
735 
736  return $status;
737  }
738 
742  public function getFileStatus() {
743  return $this->fileStatus;
744  }
745 
749  public function getRevisionStatus() {
750  return $this->revisionStatus;
751  }
752 }
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:167
$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:247
$wgUser
$wgUser
Definition: Setup.php:902
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:273
PageArchive\getFileStatus
getFileStatus()
Definition: PageArchive.php:742
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
PageArchive
Used to show archived pages and eventually restore them.
Definition: PageArchive.php:28
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
PageArchive\listPages
static listPages( $dbr, $condition)
Definition: PageArchive.php:154
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
PageArchive\$config
Config $config
Definition: PageArchive.php:39
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:80
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1262
Revision\getRevisionText
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Definition: Revision.php:1055
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
ArchivedFile\getQueryInfo
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new archivedfile object.
Definition: ArchivedFile.php:266
Revision\getArchiveQueryInfo
static getArchiveQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new archived revision objec...
Definition: Revision.php:506
PageArchive\listFiles
listFiles()
List the deleted file revisions for this page, if it's a file page.
Definition: PageArchive.php:216
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
$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. '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=(\d*-\d*)") 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. '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:1993
PageArchive\listPagesBySearch
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive.
Definition: PageArchive.php:78
true
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:2006
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:37
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
PageArchive\isDeleted
isDeleted()
Quick check if any archived revisions are present for the page.
Definition: PageArchive.php:366
$dbr
$dbr
Definition: testCompression.php:50
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
ChangeTags\modifyDisplayQuery
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag='')
Applies all tags-related changes to a query.
Definition: ChangeTags.php:723
Config
Interface for configuration instances.
Definition: Config.php:28
$term
For QUnit the mediawiki tests qunit testrunner dependency will be added to any module whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2845
LIST_OR
const LIST_OR
Definition: Defines.php:56
Title\getDBkey
getDBkey()
Get the main part with underscores.
Definition: Title.php:947
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:115
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:970
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:473
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
PageArchive\listRevisions
listRevisions()
List the revisions of the given page.
Definition: PageArchive.php:178
title
title
Definition: parserTests.txt:219
PageArchive\getRevisionStatus
getRevisionStatus()
Definition: PageArchive.php:749
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
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:994
$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:2001
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:240
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2881
Revision\RAW
const RAW
Definition: Revision.php:57
$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). '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:1255
PageArchive\doesWrites
doesWrites()
Definition: PageArchive.php:53
Title
Represents a title within MediaWiki.
Definition: Title.php:39
PageArchive\getLastRevisionText
getLastRevisionText()
Fetch (and decompress if necessary) the stored text of the most recently edited deleted revision of t...
Definition: PageArchive.php:342
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:396
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:22
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:432
PageArchive\getTextFromRow
getTextFromRow( $row)
Get the text from an archive row containing ar_text_id.
Definition: PageArchive.php:324
$t
$t
Definition: testCompression.php:69
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:25
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:53
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2864
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:929
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47
$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\getPreviousRevision
getPreviousRevision( $timestamp)
Return the most-previous revision, either live or deleted, against the deleted revision given by time...
Definition: PageArchive.php:274