MediaWiki REL1_32
PageArchive.php
Go to the documentation of this file.
1<?php
25use Wikimedia\Assert\Assert;
28
34 protected $title;
35
37 protected $fileStatus;
38
40 protected $revisionStatus;
41
43 protected $config;
44
45 public function __construct( $title, Config $config = null ) {
46 if ( is_null( $title ) ) {
47 throw new MWException( __METHOD__ . ' given a null title.' );
48 }
49 $this->title = $title;
50 if ( $config === null ) {
51 wfDebug( __METHOD__ . ' did not have a Config object passed to it' );
52 $config = MediaWikiServices::getInstance()->getMainConfig();
53 }
54 $this->config = $config;
55 }
56
60 private function getRevisionStore() {
61 // TODO: Refactor: delete()/undelete() should live in a PageStore service;
62 // Methods in PageArchive and RevisionStore that deal with archive revisions
63 // should move into an ArchiveStore service (but could still be implemented
64 // together with RevisionStore).
65 return MediaWikiServices::getInstance()->getRevisionStore();
66 }
67
68 public function doesWrites() {
69 return true;
70 }
71
81 public static function listAllPages() {
82 wfDeprecated( __METHOD__, '1.32' );
83
85
86 return self::listPages( $dbr, '' );
87 }
88
97 public static function listPagesBySearch( $term ) {
98 $title = Title::newFromText( $term );
99 if ( $title ) {
100 $ns = $title->getNamespace();
101 $termMain = $title->getText();
102 $termDb = $title->getDBkey();
103 } else {
104 // Prolly won't work too good
105 // @todo handle bare namespace names cleanly?
106 $ns = 0;
107 $termMain = $termDb = $term;
108 }
109
110 // Try search engine first
111 $engine = MediaWikiServices::getInstance()->newSearchEngine();
112 $engine->setLimitOffset( 100 );
113 $engine->setNamespaces( [ $ns ] );
114 $results = $engine->searchArchiveTitle( $termMain );
115 if ( !$results->isOK() ) {
116 $results = [];
117 } else {
118 $results = $results->getValue();
119 }
120
121 if ( !$results ) {
122 // Fall back to regular prefix search
124 }
125
127 $condTitles = array_unique( array_map( function ( Title $t ) {
128 return $t->getDBkey();
129 }, $results ) );
130 $conds = [
131 'ar_namespace' => $ns,
132 $dbr->makeList( [ 'ar_title' => $condTitles ], LIST_OR ) . " OR ar_title " .
133 $dbr->buildLike( $termDb, $dbr->anyString() )
134 ];
135
136 return self::listPages( $dbr, $conds );
137 }
138
147 public static function listPagesByPrefix( $prefix ) {
149
150 $title = Title::newFromText( $prefix );
151 if ( $title ) {
152 $ns = $title->getNamespace();
153 $prefix = $title->getDBkey();
154 } else {
155 // Prolly won't work too good
156 // @todo handle bare namespace names cleanly?
157 $ns = 0;
158 }
159
160 $conds = [
161 'ar_namespace' => $ns,
162 'ar_title' . $dbr->buildLike( $prefix, $dbr->anyString() ),
163 ];
164
165 return self::listPages( $dbr, $conds );
166 }
167
173 protected static function listPages( $dbr, $condition ) {
174 return $dbr->select(
175 [ 'archive' ],
176 [
177 'ar_namespace',
178 'ar_title',
179 'count' => 'COUNT(*)'
180 ],
181 $condition,
182 __METHOD__,
183 [
184 'GROUP BY' => [ 'ar_namespace', 'ar_title' ],
185 'ORDER BY' => [ 'ar_namespace', 'ar_title' ],
186 'LIMIT' => 100,
187 ]
188 );
189 }
190
197 public function listRevisions() {
198 $revisionStore = $this->getRevisionStore();
199 $queryInfo = $revisionStore->getArchiveQueryInfo();
200
201 $conds = [
202 'ar_namespace' => $this->title->getNamespace(),
203 'ar_title' => $this->title->getDBkey(),
204 ];
205
206 // NOTE: ordering by ar_timestamp and ar_id, to remove ambiguity.
207 // XXX: Ideally, we would be ordering by ar_timestamp and ar_rev_id, but since we
208 // don't have an index on ar_rev_id, that causes a file sort.
209 $options = [ 'ORDER BY' => 'ar_timestamp DESC, ar_id DESC' ];
210
211 ChangeTags::modifyDisplayQuery(
212 $queryInfo['tables'],
213 $queryInfo['fields'],
214 $conds,
215 $queryInfo['joins'],
216 $options,
217 ''
218 );
219
221 return $dbr->select(
222 $queryInfo['tables'],
223 $queryInfo['fields'],
224 $conds,
225 __METHOD__,
226 $options,
227 $queryInfo['joins']
228 );
229 }
230
239 public function listFiles() {
240 if ( $this->title->getNamespace() != NS_FILE ) {
241 return null;
242 }
243
245 $fileQuery = ArchivedFile::getQueryInfo();
246 return $dbr->select(
247 $fileQuery['tables'],
248 $fileQuery['fields'],
249 [ 'fa_name' => $this->title->getDBkey() ],
250 __METHOD__,
251 [ 'ORDER BY' => 'fa_timestamp DESC' ],
252 $fileQuery['joins']
253 );
254 }
255
264 public function getRevision( $timestamp ) {
266 $rec = $this->getRevisionByConditions(
267 [ 'ar_timestamp' => $dbr->timestamp( $timestamp ) ]
268 );
269 return $rec ? new Revision( $rec ) : null;
270 }
271
278 public function getArchivedRevision( $revId ) {
279 // Protect against code switching from getRevision() passing in a timestamp.
280 Assert::parameterType( 'integer', $revId, '$revId' );
281
282 $rec = $this->getRevisionByConditions( [ 'ar_rev_id' => $revId ] );
283 return $rec ? new Revision( $rec ) : null;
284 }
285
292 private function getRevisionByConditions( array $conditions, array $options = [] ) {
294 $arQuery = $this->getRevisionStore()->getArchiveQueryInfo();
295
296 $conditions = $conditions + [
297 'ar_namespace' => $this->title->getNamespace(),
298 'ar_title' => $this->title->getDBkey(),
299 ];
300
301 $row = $dbr->selectRow(
302 $arQuery['tables'],
303 $arQuery['fields'],
304 $conditions,
305 __METHOD__,
306 $options,
307 $arQuery['joins']
308 );
309
310 if ( $row ) {
311 return $this->getRevisionStore()->newRevisionFromArchiveRow( $row, 0, $this->title );
312 }
313
314 return null;
315 }
316
327 public function getPreviousRevision( $timestamp ) {
329
330 // Check the previous deleted revision...
331 $row = $dbr->selectRow( 'archive',
332 [ 'ar_rev_id', 'ar_timestamp' ],
333 [ 'ar_namespace' => $this->title->getNamespace(),
334 'ar_title' => $this->title->getDBkey(),
335 'ar_timestamp < ' .
336 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
337 __METHOD__,
338 [
339 'ORDER BY' => 'ar_timestamp DESC',
340 'LIMIT' => 1 ] );
341 $prevDeleted = $row ? wfTimestamp( TS_MW, $row->ar_timestamp ) : false;
342 $prevDeletedId = $row ? intval( $row->ar_rev_id ) : null;
343
344 $row = $dbr->selectRow( [ 'page', 'revision' ],
345 [ 'rev_id', 'rev_timestamp' ],
346 [
347 'page_namespace' => $this->title->getNamespace(),
348 'page_title' => $this->title->getDBkey(),
349 'page_id = rev_page',
350 'rev_timestamp < ' .
351 $dbr->addQuotes( $dbr->timestamp( $timestamp ) ) ],
352 __METHOD__,
353 [
354 'ORDER BY' => 'rev_timestamp DESC',
355 'LIMIT' => 1 ] );
356 $prevLive = $row ? wfTimestamp( TS_MW, $row->rev_timestamp ) : false;
357 $prevLiveId = $row ? intval( $row->rev_id ) : null;
358
359 if ( $prevLive && $prevLive > $prevDeleted ) {
360 // Most prior revision was live
361 $rec = $this->getRevisionStore()->getRevisionById( $prevLiveId );
362 $rec = $rec ? new Revision( $rec ) : null;
363 } elseif ( $prevDeleted ) {
364 // Most prior revision was deleted
365 $rec = $this->getArchivedRevision( $prevDeletedId );
366 } else {
367 $rec = null;
368 }
369
370 return $rec;
371 }
372
384 public function getTextFromRow( $row ) {
385 wfDeprecated( __METHOD__, '1.32' );
386
387 if ( empty( $row->ar_text_id ) ) {
388 throw new InvalidArgumentException( '$row->ar_text_id must be set and not empty!' );
389 }
390
391 $address = SqlBlobStore::makeAddressFromTextId( $row->ar_text_id );
392 $blobStore = MediaWikiServices::getInstance()->getBlobStore();
393
394 return $blobStore->getBlob( $address );
395 }
396
412 public function getLastRevisionText() {
413 wfDeprecated( __METHOD__, '1.32' );
414
415 $revId = $this->getLastRevisionId();
416
417 if ( $revId ) {
418 $rev = $this->getArchivedRevision( $revId );
419 $content = $rev->getContent( RevisionRecord::RAW );
420 return $content->serialize();
421 }
422
423 return null;
424 }
425
431 public function getLastRevisionId() {
433 $revId = $dbr->selectField(
434 'archive',
435 'ar_rev_id',
436 [ 'ar_namespace' => $this->title->getNamespace(),
437 'ar_title' => $this->title->getDBkey() ],
438 __METHOD__,
439 [ 'ORDER BY' => 'ar_timestamp DESC, ar_id DESC' ]
440 );
441
442 return $revId ? intval( $revId ) : false;
443 }
444
451 public function isDeleted() {
453 $row = $dbr->selectRow(
454 [ 'archive' ],
455 '1', // We don't care about the value. Allow the database to optimize.
456 [ 'ar_namespace' => $this->title->getNamespace(),
457 'ar_title' => $this->title->getDBkey() ],
458 __METHOD__
459 );
460
461 return (bool)$row;
462 }
463
483 public function undelete( $timestamps, $comment = '', $fileVersions = [],
484 $unsuppress = false, User $user = null, $tags = null
485 ) {
486 // If both the set of text revisions and file revisions are empty,
487 // restore everything. Otherwise, just restore the requested items.
488 $restoreAll = empty( $timestamps ) && empty( $fileVersions );
489
490 $restoreText = $restoreAll || !empty( $timestamps );
491 $restoreFiles = $restoreAll || !empty( $fileVersions );
492
493 if ( $restoreFiles && $this->title->getNamespace() == NS_FILE ) {
494 $img = wfLocalFile( $this->title );
495 $img->load( File::READ_LATEST );
496 $this->fileStatus = $img->restore( $fileVersions, $unsuppress );
497 if ( !$this->fileStatus->isOK() ) {
498 return false;
499 }
500 $filesRestored = $this->fileStatus->successCount;
501 } else {
502 $filesRestored = 0;
503 }
504
505 if ( $restoreText ) {
506 $this->revisionStatus = $this->undeleteRevisions( $timestamps, $unsuppress, $comment );
507 if ( !$this->revisionStatus->isOK() ) {
508 return false;
509 }
510
511 $textRestored = $this->revisionStatus->getValue();
512 } else {
513 $textRestored = 0;
514 }
515
516 // Touch the log!
517
518 if ( !$textRestored && !$filesRestored ) {
519 wfDebug( "Undelete: nothing undeleted...\n" );
520
521 return false;
522 }
523
524 if ( $user === null ) {
525 global $wgUser;
526 $user = $wgUser;
527 }
528
529 $logEntry = new ManualLogEntry( 'delete', 'restore' );
530 $logEntry->setPerformer( $user );
531 $logEntry->setTarget( $this->title );
532 $logEntry->setComment( $comment );
533 $logEntry->setTags( $tags );
534 $logEntry->setParameters( [
535 ':assoc:count' => [
536 'revisions' => $textRestored,
537 'files' => $filesRestored,
538 ],
539 ] );
540
541 Hooks::run( 'ArticleUndeleteLogEntry', [ $this, &$logEntry, $user ] );
542
543 $logid = $logEntry->insert();
544 $logEntry->publish( $logid );
545
546 return [ $textRestored, $filesRestored, $comment ];
547 }
548
560 private function undeleteRevisions( $timestamps, $unsuppress = false, $comment = '' ) {
561 if ( wfReadOnly() ) {
562 throw new ReadOnlyError();
563 }
564
565 $dbw = wfGetDB( DB_MASTER );
566 $dbw->startAtomic( __METHOD__ );
567
568 $restoreAll = empty( $timestamps );
569
570 # Does this page already exist? We'll have to update it...
571 $article = WikiPage::factory( $this->title );
572 # Load latest data for the current page (T33179)
573 $article->loadPageData( 'fromdbmaster' );
574 $oldcountable = $article->isCountable();
575
576 $page = $dbw->selectRow( 'page',
577 [ 'page_id', 'page_latest' ],
578 [ 'page_namespace' => $this->title->getNamespace(),
579 'page_title' => $this->title->getDBkey() ],
580 __METHOD__,
581 [ 'FOR UPDATE' ] // lock page
582 );
583
584 if ( $page ) {
585 $makepage = false;
586 # Page already exists. Import the history, and if necessary
587 # we'll update the latest revision field in the record.
588
589 # Get the time span of this page
590 $previousTimestamp = $dbw->selectField( 'revision', 'rev_timestamp',
591 [ 'rev_id' => $page->page_latest ],
592 __METHOD__ );
593
594 if ( $previousTimestamp === false ) {
595 wfDebug( __METHOD__ . ": existing page refers to a page_latest that does not exist\n" );
596
597 $status = Status::newGood( 0 );
598 $status->warning( 'undeleterevision-missing' );
599 $dbw->endAtomic( __METHOD__ );
600
601 return $status;
602 }
603 } else {
604 # Have to create a new article...
605 $makepage = true;
606 $previousTimestamp = 0;
607 }
608
609 $oldWhere = [
610 'ar_namespace' => $this->title->getNamespace(),
611 'ar_title' => $this->title->getDBkey(),
612 ];
613 if ( !$restoreAll ) {
614 $oldWhere['ar_timestamp'] = array_map( [ &$dbw, 'timestamp' ], $timestamps );
615 }
616
617 $revisionStore = $this->getRevisionStore();
618 $queryInfo = $revisionStore->getArchiveQueryInfo();
619 $queryInfo['tables'][] = 'revision';
620 $queryInfo['fields'][] = 'rev_id';
621 $queryInfo['joins']['revision'] = [ 'LEFT JOIN', 'ar_rev_id=rev_id' ];
622
626 $result = $dbw->select(
627 $queryInfo['tables'],
628 $queryInfo['fields'],
629 $oldWhere,
630 __METHOD__,
631 /* options */
632 [ 'ORDER BY' => 'ar_timestamp' ],
633 $queryInfo['joins']
634 );
635
636 $rev_count = $result->numRows();
637 if ( !$rev_count ) {
638 wfDebug( __METHOD__ . ": no revisions to restore\n" );
639
640 $status = Status::newGood( 0 );
641 $status->warning( "undelete-no-results" );
642 $dbw->endAtomic( __METHOD__ );
643
644 return $status;
645 }
646
647 // We use ar_id because there can be duplicate ar_rev_id even for the same
648 // page. In this case, we may be able to restore the first one.
649 $restoreFailedArIds = [];
650
651 // Map rev_id to the ar_id that is allowed to use it. When checking later,
652 // if it doesn't match, the current ar_id can not be restored.
653
654 // Value can be an ar_id or -1 (-1 means no ar_id can use it, since the
655 // rev_id is taken before we even start the restore).
656 $allowedRevIdToArIdMap = [];
657
658 $latestRestorableRow = null;
659
660 foreach ( $result as $row ) {
661 if ( $row->ar_rev_id ) {
662 // rev_id is taken even before we start restoring.
663 if ( $row->ar_rev_id === $row->rev_id ) {
664 $restoreFailedArIds[] = $row->ar_id;
665 $allowedRevIdToArIdMap[$row->ar_rev_id] = -1;
666 } else {
667 // rev_id is not taken yet in the DB, but it might be taken
668 // by a prior revision in the same restore operation. If
669 // not, we need to reserve it.
670 if ( isset( $allowedRevIdToArIdMap[$row->ar_rev_id] ) ) {
671 $restoreFailedArIds[] = $row->ar_id;
672 } else {
673 $allowedRevIdToArIdMap[$row->ar_rev_id] = $row->ar_id;
674 $latestRestorableRow = $row;
675 }
676 }
677 } else {
678 // If ar_rev_id is null, there can't be a collision, and a
679 // rev_id will be chosen automatically.
680 $latestRestorableRow = $row;
681 }
682 }
683
684 $result->seek( 0 ); // move back
685
686 $oldPageId = 0;
687 if ( $latestRestorableRow !== null ) {
688 $oldPageId = (int)$latestRestorableRow->ar_page_id; // pass this to ArticleUndelete hook
689
690 // Grab the content to check consistency with global state before restoring the page.
691 // XXX: The only current use case is Wikibase, which tries to enforce uniqueness of
692 // certain things across all pages. There may be a better way to do that.
693 $revision = $revisionStore->newRevisionFromArchiveRow(
694 $latestRestorableRow,
695 0,
696 $this->title
697 );
698
699 // TODO: use User::newFromUserIdentity from If610c68f4912e
700 // TODO: The User isn't used for anything in prepareSave()! We should drop it.
701 $user = User::newFromName( $revision->getUser( RevisionRecord::RAW )->getName(), false );
702
703 foreach ( $revision->getSlotRoles() as $role ) {
704 $content = $revision->getContent( $role, RevisionRecord::RAW );
705
706 // NOTE: article ID may not be known yet. prepareSave() should not modify the database.
707 $status = $content->prepareSave( $article, 0, -1, $user );
708 if ( !$status->isOK() ) {
709 $dbw->endAtomic( __METHOD__ );
710
711 return $status;
712 }
713 }
714 }
715
716 $newid = false; // newly created page ID
717 $restored = 0; // number of revisions restored
719 $revision = null;
720 $restoredPages = [];
721 // If there are no restorable revisions, we can skip most of the steps.
722 if ( $latestRestorableRow === null ) {
723 $failedRevisionCount = $rev_count;
724 } else {
725 if ( $makepage ) {
726 // Check the state of the newest to-be version...
727 if ( !$unsuppress
728 && ( $latestRestorableRow->ar_deleted & RevisionRecord::DELETED_TEXT )
729 ) {
730 $dbw->endAtomic( __METHOD__ );
731
732 return Status::newFatal( "undeleterevdel" );
733 }
734 // Safe to insert now...
735 $newid = $article->insertOn( $dbw, $latestRestorableRow->ar_page_id );
736 if ( $newid === false ) {
737 // The old ID is reserved; let's pick another
738 $newid = $article->insertOn( $dbw );
739 }
740 $pageId = $newid;
741 } else {
742 // Check if a deleted revision will become the current revision...
743 if ( $latestRestorableRow->ar_timestamp > $previousTimestamp ) {
744 // Check the state of the newest to-be version...
745 if ( !$unsuppress
746 && ( $latestRestorableRow->ar_deleted & RevisionRecord::DELETED_TEXT )
747 ) {
748 $dbw->endAtomic( __METHOD__ );
749
750 return Status::newFatal( "undeleterevdel" );
751 }
752 }
753
754 $newid = false;
755 $pageId = $article->getId();
756 }
757
758 foreach ( $result as $row ) {
759 // Check for key dupes due to needed archive integrity.
760 if ( $row->ar_rev_id && $allowedRevIdToArIdMap[$row->ar_rev_id] !== $row->ar_id ) {
761 continue;
762 }
763 // Insert one revision at a time...maintaining deletion status
764 // unless we are specifically removing all restrictions...
765 $revision = $revisionStore->newRevisionFromArchiveRow(
766 $row,
767 0,
768 $this->title,
769 [
770 'page_id' => $pageId,
771 'deleted' => $unsuppress ? 0 : $row->ar_deleted
772 ]
773 );
774
775 // This will also copy the revision to ip_changes if it was an IP edit.
776 $revisionStore->insertRevisionOn( $revision, $dbw );
777
778 $restored++;
779
780 $legacyRevision = new Revision( $revision );
781 Hooks::run( 'ArticleRevisionUndeleted',
782 [ &$this->title, $legacyRevision, $row->ar_page_id ] );
783 $restoredPages[$row->ar_page_id] = true;
784 }
785
786 // Now that it's safely stored, take it out of the archive
787 // Don't delete rows that we failed to restore
788 $toDeleteConds = $oldWhere;
789 $failedRevisionCount = count( $restoreFailedArIds );
790 if ( $failedRevisionCount > 0 ) {
791 $toDeleteConds[] = 'ar_id NOT IN ( ' . $dbw->makeList( $restoreFailedArIds ) . ' )';
792 }
793
794 $dbw->delete( 'archive',
795 $toDeleteConds,
796 __METHOD__ );
797 }
798
799 $status = Status::newGood( $restored );
800
801 if ( $failedRevisionCount > 0 ) {
802 $status->warning(
803 wfMessage( 'undeleterevision-duplicate-revid', $failedRevisionCount ) );
804 }
805
806 // Was anything restored at all?
807 if ( $restored ) {
808 $created = (bool)$newid;
809 // Attach the latest revision to the page...
810 // XXX: updateRevisionOn should probably move into a PageStore service.
811 $wasnew = $article->updateIfNewerOn( $dbw, $legacyRevision );
812 if ( $created || $wasnew ) {
813 // Update site stats, link tables, etc
814 // TODO: use DerivedPageDataUpdater from If610c68f4912e!
815 $article->doEditUpdates(
816 $legacyRevision,
817 User::newFromName( $revision->getUser( RevisionRecord::RAW )->getName(), false ),
818 [
819 'created' => $created,
820 'oldcountable' => $oldcountable,
821 'restored' => true
822 ]
823 );
824 }
825
826 Hooks::run( 'ArticleUndelete',
827 [ &$this->title, $created, $comment, $oldPageId, $restoredPages ] );
828 if ( $this->title->getNamespace() == NS_FILE ) {
829 DeferredUpdates::addUpdate(
830 new HTMLCacheUpdate( $this->title, 'imagelinks', 'file-restore' )
831 );
832 }
833 }
834
835 $dbw->endAtomic( __METHOD__ );
836
837 return $status;
838 }
839
843 public function getFileStatus() {
844 return $this->fileStatus;
845 }
846
850 public function getRevisionStatus() {
852 }
853}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new archivedfile object.
Class to invalidate the HTML cache of all the pages linking to a given title.
MediaWiki exception.
Class for creating new log entries and inserting them into the database.
Definition LogEntry.php:437
MediaWikiServices is the service locator for the application scope of MediaWiki.
Page revision base class.
Service for looking up page revisions.
Service for storing and loading Content objects.
Used to show archived pages and eventually restore them.
getTextFromRow( $row)
Get the text from an archive row containing ar_text_id.
listFiles()
List the deleted file revisions for this page, if it's a file page.
Config $config
Status $fileStatus
static listPages( $dbr, $condition)
static listPagesBySearch( $term)
List deleted pages recorded in the archive matching the given term, using search engine archive.
getLastRevisionId()
Returns the ID of the latest deleted revision.
getArchivedRevision( $revId)
Return the archived revision with the given ID.
listRevisions()
List the revisions of the given page.
undeleteRevisions( $timestamps, $unsuppress=false, $comment='')
This is the meaty bit – It restores archived revisions of the given page to the revision table.
undelete( $timestamps, $comment='', $fileVersions=[], $unsuppress=false, User $user=null, $tags=null)
Restore the given (or all) text and file revisions for the page.
static listPagesByPrefix( $prefix)
List deleted pages recorded in the archive table matching the given title prefix.
static listAllPages()
List all deleted pages recorded in the archive table.
getLastRevisionText()
Fetch (and decompress if necessary) the stored text of the most recently edited deleted revision of t...
getRevision( $timestamp)
Return a Revision object containing data for the deleted revision.
Status $revisionStatus
__construct( $title, Config $config=null)
isDeleted()
Quick check if any archived revisions are present for the page.
getPreviousRevision( $timestamp)
Return the most-previous revision, either live or deleted, against the deleted revision given by time...
getRevisionByConditions(array $conditions, array $options=[])
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Represents a title within MediaWiki.
Definition Title.php:39
getNamespace()
Get the namespace index, i.e.
Definition Title.php:974
getDBkey()
Get the main part with underscores.
Definition Title.php:951
getText()
Get the text form (spaces not underscores) of the main part.
Definition Title.php:933
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
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
const NS_FILE
Definition Defines.php:70
const LIST_OR
Definition Defines.php:46
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 since 1.16! 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 since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit '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:1305
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:2050
For QUnit the mediawiki tests qunit testrunner dependency will be added to any module whereas SearchGetNearMatch runs after $term
Definition hooks.txt:2926
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:2055
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition hooks.txt:1619
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition hooks.txt:2962
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1818
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for configuration instances.
Definition Config.php:28
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:38
Result wrapper for grabbing data queried from an IDatabase object.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$content
title
const DB_REPLICA
Definition defines.php:25
const DB_MASTER
Definition defines.php:26