includes/jobqueue/jobs/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 string Reason for the change, 'maintenance' or 'move'. Suffix fo
  31          *    message key 'double-redirect-fixed-'.
  32          */
  33         private $reason;
  34
  35         /** @var Title The title which has changed, redirects pointing to this
  36          *    title are fixed
  37          */
  38         private $redirTitle;
  39
  40         /** @var User */
  41         private static $user;
  42
  43         /**
  44          * @param Title $title
  45          * @param array $params
  46          */
  47         function __construct( Title $title, array $params ) {
  48                 parent::__construct( 'fixDoubleRedirect', $title, $params );
  49                 $this->reason = $params['reason'];
  50                 $this->redirTitle = Title::newFromText( $params['redirTitle'] );
  51         }
  52
  53         /**
  54          * Insert jobs into the job queue to fix redirects to the given title
  55          * @param string $reason The reason for the fix, see message
  56          *   "double-redirect-fixed-<reason>"
  57          * @param Title $redirTitle The title which has changed, redirects
  58          *   pointing to this title are fixed
  59          * @param bool $destTitle Not used
  60          */
  61         public static function fixRedirects( $reason, $redirTitle, $destTitle = false ) {
  62                 # Need to use the master to get the redirect table updated in the same transaction
  63                 $dbw = wfGetDB( DB_MASTER );
  64                 $res = $dbw->select(
  65                         [ 'redirect', 'page' ],
  66                         [ 'page_namespace', 'page_title' ],
  67                         [
  68                                 'page_id = rd_from',
  69                                 'rd_namespace' => $redirTitle->getNamespace(),
  70                                 'rd_title' => $redirTitle->getDBkey()
  71                         ], __METHOD__ );
  72                 if ( !$res->numRows() ) {
  73                         return;
  74                 }
  75                 $jobs = [];
  76                 foreach ( $res as $row ) {
  77                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
  78                         if ( !$title ) {
  79                                 continue;
  80                         }
  81
  82                         $jobs[] = new self( $title, [
  83                                 'reason' => $reason,
  84                                 'redirTitle' => $redirTitle->getPrefixedDBkey() ] );
  85                         # Avoid excessive memory usage
  86                         if ( count( $jobs ) > 10000 ) {
  87                                 JobQueueGroup::singleton()->push( $jobs );
  88                                 $jobs = [];
  89                         }
  90                 }
  91                 JobQueueGroup::singleton()->push( $jobs );
  92         }
  93
  94         /**
  95          * @return bool
  96          */
  97         function run() {
  98                 if ( !$this->redirTitle ) {
  99                         $this->setLastError( 'Invalid title' );
 100
 101                         return false;
 102                 }
 103
 104                 $targetRev = Revision::newFromTitle( $this->title, false, Revision::READ_LATEST );
 105                 if ( !$targetRev ) {
 106                         wfDebug( __METHOD__ . ": target redirect already deleted, ignoring\n" );
 107
 108                         return true;
 109                 }
 110                 $content = $targetRev->getContent();
 111                 $currentDest = $content ? $content->getRedirectTarget() : null;
 112                 if ( !$currentDest || !$currentDest->equals( $this->redirTitle ) ) {
 113                         wfDebug( __METHOD__ . ": Redirect has changed since the job was queued\n" );
 114
 115                         return true;
 116                 }
 117
 118                 // Check for a suppression tag (used e.g. in periodically archived discussions)
 119                 $mw = MagicWord::get( 'staticredirect' );
 120                 if ( $content->matchMagicWord( $mw ) ) {
 121                         wfDebug( __METHOD__ . ": skipping: suppressed with __STATICREDIRECT__\n" );
 122
 123                         return true;
 124                 }
 125
 126                 // Find the current final destination
 127                 $newTitle = self::getFinalDestination( $this->redirTitle );
 128                 if ( !$newTitle ) {
 129                         wfDebug( __METHOD__ .
 130                                 ": skipping: single redirect, circular redirect or invalid redirect destination\n" );
 131
 132                         return true;
 133                 }
 134                 if ( $newTitle->equals( $this->redirTitle ) ) {
 135                         // The redirect is already right, no need to change it
 136                         // This can happen if the page was moved back (say after vandalism)
 137                         wfDebug( __METHOD__ . " : skipping, already good\n" );
 138                 }
 139
 140                 // Preserve fragment (bug 14904)
 141                 $newTitle = Title::makeTitle( $newTitle->getNamespace(), $newTitle->getDBkey(),
 142                         $currentDest->getFragment(), $newTitle->getInterwiki() );
 143
 144                 // Fix the text
 145                 $newContent = $content->updateRedirect( $newTitle );
 146
 147                 if ( $newContent->equals( $content ) ) {
 148                         $this->setLastError( 'Content unchanged???' );
 149
 150                         return false;
 151                 }
 152
 153                 $user = $this->getUser();
 154                 if ( !$user ) {
 155                         $this->setLastError( 'Invalid user' );
 156
 157                         return false;
 158                 }
 159
 160                 // Save it
 161                 global $wgUser;
 162                 $oldUser = $wgUser;
 163                 $wgUser = $user;
 164                 $article = WikiPage::factory( $this->title );
 165
 166                 // Messages: double-redirect-fixed-move, double-redirect-fixed-maintenance
 167                 $reason = wfMessage( 'double-redirect-fixed-' . $this->reason,
 168                         $this->redirTitle->getPrefixedText(), $newTitle->getPrefixedText()
 169                 )->inContentLanguage()->text();
 170                 $flags = EDIT_UPDATE | EDIT_SUPPRESS_RC | EDIT_INTERNAL;
 171                 $article->doEditContent( $newContent, $reason, $flags, false, $user );
 172                 $wgUser = $oldUser;
 173
 174                 return true;
 175         }
 176
 177         /**
 178          * Get the final destination of a redirect
 179          *
 180          * @param Title $title
 181          *
 182          * @return Title|bool The final Title after following all redirects, or false if
 183          *  the page is not a redirect or the redirect loops.
 184          */
 185         public static function getFinalDestination( $title ) {
 186                 $dbw = wfGetDB( DB_MASTER );
 187
 188                 // Circular redirect check
 189                 $seenTitles = [];
 190                 $dest = false;
 191
 192                 while ( true ) {
 193                         $titleText = $title->getPrefixedDBkey();
 194                         if ( isset( $seenTitles[$titleText] ) ) {
 195                                 wfDebug( __METHOD__, "Circular redirect detected, aborting\n" );
 196
 197                                 return false;
 198                         }
 199                         $seenTitles[$titleText] = true;
 200
 201                         if ( $title->isExternal() ) {
 202                                 // If the target is interwiki, we have to break early (bug 40352).
 203                                 // Otherwise it will look up a row in the local page table
 204                                 // with the namespace/page of the interwiki target which can cause
 205                                 // unexpected results (e.g. X -> foo:Bar -> Bar -> .. )
 206                                 break;
 207                         }
 208
 209                         $row = $dbw->selectRow(
 210                                 [ 'redirect', 'page' ],
 211                                 [ 'rd_namespace', 'rd_title', 'rd_interwiki' ],
 212                                 [
 213                                         'rd_from=page_id',
 214                                         'page_namespace' => $title->getNamespace(),
 215                                         'page_title' => $title->getDBkey()
 216                                 ], __METHOD__ );
 217                         if ( !$row ) {
 218                                 # No redirect from here, chain terminates
 219                                 break;
 220                         } else {
 221                                 $dest = $title = Title::makeTitle(
 222                                         $row->rd_namespace,
 223                                         $row->rd_title,
 224                                         '',
 225                                         $row->rd_interwiki
 226                                 );
 227                         }
 228                 }
 229
 230                 return $dest;
 231         }
 232
 233         /**
 234          * Get a user object for doing edits, from a request-lifetime cache
 235          * False will be returned if the user name specified in the
 236          * 'double-redirect-fixer' message is invalid.
 237          *
 238          * @return User|bool
 239          */
 240         function getUser() {
 241                 if ( !self::$user ) {
 242                         $username = wfMessage( 'double-redirect-fixer' )->inContentLanguage()->text();
 243                         self::$user = User::newFromName( $username );
 244                         # User::newFromName() can return false on a badly configured wiki.
 245                         if ( self::$user && !self::$user->isLoggedIn() ) {
 246                                 self::$user->addToDatabase();
 247                         }
 248                 }
 249
 250                 return self::$user;
 251         }
 252 }