MediaWiki  master
DoubleRedirectJob.php
Go to the documentation of this file.
1 <?php
25 
31 class DoubleRedirectJob extends Job {
32 
36  private $redirTitle;
37 
39  private static $user;
40 
50  function __construct( Title $title, array $params ) {
51  parent::__construct( 'fixDoubleRedirect', $title, $params );
52  $this->redirTitle = Title::newFromText( $params['redirTitle'] );
53  }
54 
63  public static function fixRedirects( $reason, $redirTitle, $destTitle = false ) {
64  # Need to use the master to get the redirect table updated in the same transaction
65  $dbw = wfGetDB( DB_MASTER );
66  $res = $dbw->select(
67  [ 'redirect', 'page' ],
68  [ 'page_namespace', 'page_title' ],
69  [
70  'page_id = rd_from',
71  'rd_namespace' => $redirTitle->getNamespace(),
72  'rd_title' => $redirTitle->getDBkey()
73  ], __METHOD__ );
74  if ( !$res->numRows() ) {
75  return;
76  }
77  $jobs = [];
78  foreach ( $res as $row ) {
79  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
80  if ( !$title ) {
81  continue;
82  }
83 
84  $jobs[] = new self( $title, [
85  'reason' => $reason,
86  'redirTitle' => $redirTitle->getPrefixedDBkey() ] );
87  # Avoid excessive memory usage
88  if ( count( $jobs ) > 10000 ) {
89  JobQueueGroup::singleton()->push( $jobs );
90  $jobs = [];
91  }
92  }
93  JobQueueGroup::singleton()->push( $jobs );
94  }
95 
99  function run() {
100  if ( !$this->redirTitle ) {
101  $this->setLastError( 'Invalid title' );
102 
103  return false;
104  }
105 
106  $targetRev = Revision::newFromTitle( $this->title, false, Revision::READ_LATEST );
107  if ( !$targetRev ) {
108  wfDebug( __METHOD__ . ": target redirect already deleted, ignoring\n" );
109 
110  return true;
111  }
112  $content = $targetRev->getContent();
113  $currentDest = $content ? $content->getRedirectTarget() : null;
114  if ( !$currentDest || !$currentDest->equals( $this->redirTitle ) ) {
115  wfDebug( __METHOD__ . ": Redirect has changed since the job was queued\n" );
116 
117  return true;
118  }
119 
120  // Check for a suppression tag (used e.g. in periodically archived discussions)
121  $mw = MediaWikiServices::getInstance()->getMagicWordFactory()->get( 'staticredirect' );
122  if ( $content->matchMagicWord( $mw ) ) {
123  wfDebug( __METHOD__ . ": skipping: suppressed with __STATICREDIRECT__\n" );
124 
125  return true;
126  }
127 
128  // Find the current final destination
129  $newTitle = self::getFinalDestination( $this->redirTitle );
130  if ( !$newTitle ) {
131  wfDebug( __METHOD__ .
132  ": skipping: single redirect, circular redirect or invalid redirect destination\n" );
133 
134  return true;
135  }
136  if ( $newTitle->equals( $this->redirTitle ) ) {
137  // The redirect is already right, no need to change it
138  // This can happen if the page was moved back (say after vandalism)
139  wfDebug( __METHOD__ . " : skipping, already good\n" );
140  }
141 
142  // Preserve fragment (T16904)
143  $newTitle = Title::makeTitle( $newTitle->getNamespace(), $newTitle->getDBkey(),
144  $currentDest->getFragment(), $newTitle->getInterwiki() );
145 
146  // Fix the text
147  $newContent = $content->updateRedirect( $newTitle );
148 
149  if ( $newContent->equals( $content ) ) {
150  $this->setLastError( 'Content unchanged???' );
151 
152  return false;
153  }
154 
155  $user = $this->getUser();
156  if ( !$user ) {
157  $this->setLastError( 'Invalid user' );
158 
159  return false;
160  }
161 
162  // Save it
163  global $wgUser;
164  $oldUser = $wgUser;
165  $wgUser = $user;
166  $article = WikiPage::factory( $this->title );
167 
168  // Messages: double-redirect-fixed-move, double-redirect-fixed-maintenance
169  $reason = wfMessage( 'double-redirect-fixed-' . $this->params['reason'],
170  $this->redirTitle->getPrefixedText(), $newTitle->getPrefixedText()
171  )->inContentLanguage()->text();
173  $article->doEditContent( $newContent, $reason, $flags, false, $user );
174  $wgUser = $oldUser;
175 
176  return true;
177  }
178 
187  public static function getFinalDestination( $title ) {
188  $dbw = wfGetDB( DB_MASTER );
189 
190  // Circular redirect check
191  $seenTitles = [];
192  $dest = false;
193 
194  while ( true ) {
195  $titleText = $title->getPrefixedDBkey();
196  if ( isset( $seenTitles[$titleText] ) ) {
197  wfDebug( __METHOD__, "Circular redirect detected, aborting\n" );
198 
199  return false;
200  }
201  $seenTitles[$titleText] = true;
202 
203  if ( $title->isExternal() ) {
204  // If the target is interwiki, we have to break early (T42352).
205  // Otherwise it will look up a row in the local page table
206  // with the namespace/page of the interwiki target which can cause
207  // unexpected results (e.g. X -> foo:Bar -> Bar -> .. )
208  break;
209  }
210 
211  $row = $dbw->selectRow(
212  [ 'redirect', 'page' ],
213  [ 'rd_namespace', 'rd_title', 'rd_interwiki' ],
214  [
215  'rd_from=page_id',
216  'page_namespace' => $title->getNamespace(),
217  'page_title' => $title->getDBkey()
218  ], __METHOD__ );
219  if ( !$row ) {
220  # No redirect from here, chain terminates
221  break;
222  } else {
223  $dest = $title = Title::makeTitle(
224  $row->rd_namespace,
225  $row->rd_title,
226  '',
227  $row->rd_interwiki
228  );
229  }
230  }
231 
232  return $dest;
233  }
234 
242  function getUser() {
243  if ( !self::$user ) {
244  $username = wfMessage( 'double-redirect-fixer' )->inContentLanguage()->text();
246  # User::newFromName() can return false on a badly configured wiki.
247  if ( self::$user && !self::$user->isLoggedIn() ) {
248  self::$user->addToDatabase();
249  }
250  }
251 
252  return self::$user;
253  }
254 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
const EDIT_INTERNAL
Definition: Defines.php:139
Class to both describe a background job and handle jobs.
Definition: Job.php:30
getUser()
Get a user object for doing edits, from a request-lifetime cache False will be returned if the user n...
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:23
const EDIT_UPDATE
Definition: Defines.php:133
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that&#39;s attached to a given link target...
Definition: Revision.php:137
title
const DB_MASTER
Definition: defines.php:26
setLastError( $error)
Definition: Job.php:418
isExternal()
Is this Title interwiki?
Definition: Title.php:919
Title $redirTitle
The title which has changed, redirects pointing to this title are fixed.
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
getDBkey()
Get the main part with underscores.
Definition: Title.php:1020
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static fixRedirects( $reason, $redirTitle, $destTitle=false)
Insert jobs into the job queue to fix redirects to the given title.
const EDIT_SUPPRESS_RC
Definition: Defines.php:135
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:1044
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:9
__construct(Title $title, array $params)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:591
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:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:767
static singleton( $domain=false)
array $params
Array of job parameters.
Definition: Job.php:35
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535
$content
Definition: pageupdater.txt:72
Title $title
Definition: Job.php:41
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static getFinalDestination( $title)
Get the final destination of a redirect.
getPrefixedDBkey()
Get the prefixed database key form.
Definition: Title.php:1711
Job to fix double redirects after moving a page.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:321