Update docs/hooks.txt for ShowSearchHitTitle
[mediawiki.git] / includes / revisiondelete / RevDelRevisionList.php
blobf0b1907d837f4975ce120a9b7518d909c93a16e7
1 <?php
2 /**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
18 * @file
19 * @ingroup RevisionDelete
22 /**
23 * List for revision table items
25 * This will check both the 'revision' table for live revisions and the
26 * 'archive' table for traditionally-deleted revisions that have an
27 * ar_rev_id saved.
29 * See RevDelRevisionItem and RevDelArchivedRevisionItem for items.
31 class RevDelRevisionList extends RevDelList {
32 /** @var int */
33 public $currentRevId;
35 public function getType() {
36 return 'revision';
39 public static function getRelationType() {
40 return 'rev_id';
43 public static function getRestriction() {
44 return 'deleterevision';
47 public static function getRevdelConstant() {
48 return Revision::DELETED_TEXT;
51 public static function suggestTarget( $target, array $ids ) {
52 $rev = Revision::newFromId( $ids[0] );
53 return $rev ? $rev->getTitle() : $target;
56 /**
57 * @param IDatabase $db
58 * @return mixed
60 public function doQuery( $db ) {
61 $ids = array_map( 'intval', $this->ids );
62 $queryInfo = [
63 'tables' => [ 'revision', 'page', 'user' ],
64 'fields' => array_merge( Revision::selectFields(), Revision::selectUserFields() ),
65 'conds' => [
66 'rev_page' => $this->title->getArticleID(),
67 'rev_id' => $ids,
69 'options' => [
70 'ORDER BY' => 'rev_id DESC',
71 'USE INDEX' => [ 'revision' => 'PRIMARY' ] // workaround for MySQL bug (T104313)
73 'join_conds' => [
74 'page' => Revision::pageJoinCond(),
75 'user' => Revision::userJoinCond(),
78 ChangeTags::modifyDisplayQuery(
79 $queryInfo['tables'],
80 $queryInfo['fields'],
81 $queryInfo['conds'],
82 $queryInfo['join_conds'],
83 $queryInfo['options'],
87 $live = $db->select(
88 $queryInfo['tables'],
89 $queryInfo['fields'],
90 $queryInfo['conds'],
91 __METHOD__,
92 $queryInfo['options'],
93 $queryInfo['join_conds']
95 if ( $live->numRows() >= count( $ids ) ) {
96 // All requested revisions are live, keeps things simple!
97 return $live;
100 $archiveQueryInfo = [
101 'tables' => [ 'archive' ],
102 'fields' => Revision::selectArchiveFields(),
103 'conds' => [
104 'ar_rev_id' => $ids,
106 'options' => [ 'ORDER BY' => 'ar_rev_id DESC' ],
107 'join_conds' => [],
110 ChangeTags::modifyDisplayQuery(
111 $archiveQueryInfo['tables'],
112 $archiveQueryInfo['fields'],
113 $archiveQueryInfo['conds'],
114 $archiveQueryInfo['join_conds'],
115 $archiveQueryInfo['options'],
119 // Check if any requested revisions are available fully deleted.
120 $archived = $db->select(
121 $archiveQueryInfo['tables'],
122 $archiveQueryInfo['fields'],
123 $archiveQueryInfo['conds'],
124 __METHOD__,
125 $archiveQueryInfo['options'],
126 $archiveQueryInfo['join_conds']
129 if ( $archived->numRows() == 0 ) {
130 return $live;
131 } elseif ( $live->numRows() == 0 ) {
132 return $archived;
133 } else {
134 // Combine the two! Whee
135 $rows = [];
136 foreach ( $live as $row ) {
137 $rows[$row->rev_id] = $row;
139 foreach ( $archived as $row ) {
140 $rows[$row->ar_rev_id] = $row;
142 krsort( $rows );
143 return new FakeResultWrapper( array_values( $rows ) );
147 public function newItem( $row ) {
148 if ( isset( $row->rev_id ) ) {
149 return new RevDelRevisionItem( $this, $row );
150 } elseif ( isset( $row->ar_rev_id ) ) {
151 return new RevDelArchivedRevisionItem( $this, $row );
152 } else {
153 // This shouldn't happen. :)
154 throw new MWException( 'Invalid row type in RevDelRevisionList' );
158 public function getCurrent() {
159 if ( is_null( $this->currentRevId ) ) {
160 $dbw = wfGetDB( DB_MASTER );
161 $this->currentRevId = $dbw->selectField(
162 'page', 'page_latest', $this->title->pageCond(), __METHOD__ );
164 return $this->currentRevId;
167 public function getSuppressBit() {
168 return Revision::DELETED_RESTRICTED;
171 public function doPreCommitUpdates() {
172 $this->title->invalidateCache();
173 return Status::newGood();
176 public function doPostCommitUpdates( array $visibilityChangeMap ) {
177 $this->title->purgeSquid();
178 // Extensions that require referencing previous revisions may need this
179 Hooks::run( 'ArticleRevisionVisibilitySet', [ $this->title, $this->ids, $visibilityChangeMap ] );
180 return Status::newGood();