Updating of redirect target in Content objects
[lhc/web/wiklou.git] / includes / job / DoubleRedirectJob.php
1 <?php
2 /**
3 * Job to fix double redirects after moving a page.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup JobQueue
22 */
23
24 /**
25 * Job to fix double redirects after moving a page
26 *
27 * @ingroup JobQueue
28 */
29 class DoubleRedirectJob extends Job {
30 var $reason, $redirTitle, $destTitleText;
31
32 /**
33 * @var User
34 */
35 static $user;
36
37 /**
38 * Insert jobs into the job queue to fix redirects to the given title
39 * @param $reason String: the reason for the fix, see message "double-redirect-fixed-<reason>"
40 * @param $redirTitle Title: the title which has changed, redirects pointing to this title are fixed
41 * @param $destTitle bool Not used
42 */
43 public static function fixRedirects( $reason, $redirTitle, $destTitle = false ) {
44 # Need to use the master to get the redirect table updated in the same transaction
45 $dbw = wfGetDB( DB_MASTER );
46 $res = $dbw->select(
47 array( 'redirect', 'page' ),
48 array( 'page_namespace', 'page_title' ),
49 array(
50 'page_id = rd_from',
51 'rd_namespace' => $redirTitle->getNamespace(),
52 'rd_title' => $redirTitle->getDBkey()
53 ), __METHOD__ );
54 if ( !$res->numRows() ) {
55 return;
56 }
57 $jobs = array();
58 foreach ( $res as $row ) {
59 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
60 if ( !$title ) {
61 continue;
62 }
63
64 $jobs[] = new self( $title, array(
65 'reason' => $reason,
66 'redirTitle' => $redirTitle->getPrefixedDBkey() ) );
67 # Avoid excessive memory usage
68 if ( count( $jobs ) > 10000 ) {
69 Job::batchInsert( $jobs );
70 $jobs = array();
71 }
72 }
73 Job::batchInsert( $jobs );
74 }
75
76 function __construct( $title, $params = false, $id = 0 ) {
77 parent::__construct( 'fixDoubleRedirect', $title, $params, $id );
78 $this->reason = $params['reason'];
79 $this->redirTitle = Title::newFromText( $params['redirTitle'] );
80 $this->destTitleText = !empty( $params['destTitle'] ) ? $params['destTitle'] : '';
81 }
82
83 /**
84 * @return bool
85 */
86 function run() {
87 if ( !$this->redirTitle ) {
88 $this->setLastError( 'Invalid title' );
89 return false;
90 }
91
92 $targetRev = Revision::newFromTitle( $this->title );
93 if ( !$targetRev ) {
94 wfDebug( __METHOD__.": target redirect already deleted, ignoring\n" );
95 return true;
96 }
97 $content = $targetRev->getContent();
98 $currentDest = $content->getRedirectTarget();
99 if ( !$currentDest || !$currentDest->equals( $this->redirTitle ) ) {
100 wfDebug( __METHOD__.": Redirect has changed since the job was queued\n" );
101 return true;
102 }
103
104 # Check for a suppression tag (used e.g. in periodically archived discussions)
105 $mw = MagicWord::get( 'staticredirect' );
106 if ( $content->matchMagicWord( $mw ) ) {
107 wfDebug( __METHOD__.": skipping: suppressed with __STATICREDIRECT__\n" );
108 return true;
109 }
110
111 # Find the current final destination
112 $newTitle = self::getFinalDestination( $this->redirTitle );
113 if ( !$newTitle ) {
114 wfDebug( __METHOD__.": skipping: single redirect, circular redirect or invalid redirect destination\n" );
115 return true;
116 }
117 if ( $newTitle->equals( $this->redirTitle ) ) {
118 # The redirect is already right, no need to change it
119 # This can happen if the page was moved back (say after vandalism)
120 wfDebug( __METHOD__.": skipping, already good\n" );
121 }
122
123 # Preserve fragment (bug 14904)
124 $newTitle = Title::makeTitle( $newTitle->getNamespace(), $newTitle->getDBkey(),
125 $currentDest->getFragment() );
126
127 $text = ContentHandler::getContentText( $content ); #FIXME: get rid of this!
128
129 # Fix the text
130 $newContent = $content->updateRedirect( $newTitle );
131
132 if ( $newContent->equals( $content ) ) {
133 $this->setLastError( 'Content unchanged???' );
134 return false;
135 }
136
137 # Save it
138 global $wgUser;
139 $oldUser = $wgUser;
140 $wgUser = $this->getUser();
141 $article = WikiPage::factory( $this->title );
142 $reason = wfMessage( 'double-redirect-fixed-' . $this->reason,
143 $this->redirTitle->getPrefixedText(), $newTitle->getPrefixedText()
144 )->inContentLanguage()->text();
145 $article->doEditContent( $newContent, $reason, EDIT_UPDATE | EDIT_SUPPRESS_RC, false, $this->getUser() );
146 $wgUser = $oldUser;
147
148 return true;
149 }
150
151 /**
152 * Get the final destination of a redirect
153 *
154 * @param $title Title
155 *
156 * @return bool if the specified title is not a redirect, or if it is a circular redirect
157 */
158 public static function getFinalDestination( $title ) {
159 $dbw = wfGetDB( DB_MASTER );
160
161 $seenTitles = array(); # Circular redirect check
162 $dest = false;
163
164 while ( true ) {
165 $titleText = $title->getPrefixedDBkey();
166 if ( isset( $seenTitles[$titleText] ) ) {
167 wfDebug( __METHOD__, "Circular redirect detected, aborting\n" );
168 return false;
169 }
170 $seenTitles[$titleText] = true;
171
172 $row = $dbw->selectRow(
173 array( 'redirect', 'page' ),
174 array( 'rd_namespace', 'rd_title' ),
175 array(
176 'rd_from=page_id',
177 'page_namespace' => $title->getNamespace(),
178 'page_title' => $title->getDBkey()
179 ), __METHOD__ );
180 if ( !$row ) {
181 # No redirect from here, chain terminates
182 break;
183 } else {
184 $dest = $title = Title::makeTitle( $row->rd_namespace, $row->rd_title );
185 }
186 }
187 return $dest;
188 }
189
190 /**
191 * Get a user object for doing edits, from a request-lifetime cache
192 * @return User
193 */
194 function getUser() {
195 if ( !self::$user ) {
196 self::$user = User::newFromName( wfMessage( 'double-redirect-fixer' )->inContentLanguage()->text(), false );
197 # FIXME: newFromName could return false on a badly configured wiki.
198 if ( !self::$user->isLoggedIn() ) {
199 self::$user->addToDatabase();
200 }
201 }
202 return self::$user;
203 }
204 }
205