MediaWiki  REL1_31
DoubleRedirectJob.php
Go to the documentation of this file.
1 <?php
29 class DoubleRedirectJob extends Job {
33  private $reason;
34 
38  private $redirTitle;
39 
41  private static $user;
42 
48  parent::__construct( 'fixDoubleRedirect', $title, $params );
49  $this->reason = $params['reason'];
50  $this->redirTitle = Title::newFromText( $params['redirTitle'] );
51  }
52 
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 
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 (T16904)
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();
171  $article->doEditContent( $newContent, $reason, $flags, false, $user );
172  $wgUser = $oldUser;
173 
174  return true;
175  }
176 
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 (T42352).
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 
240  function getUser() {
241  if ( !self::$user ) {
242  $username = wfMessage( 'double-redirect-fixer' )->inContentLanguage()->text();
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 }
$user
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 account $user
Definition: hooks.txt:247
$wgUser
$wgUser
Definition: Setup.php:902
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
wfMessage
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 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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
EDIT_INTERNAL
const EDIT_INTERNAL
Definition: Defines.php:169
Title\getPrefixedDBkey
getPrefixedDBkey()
Get the prefixed database key form.
Definition: Title.php:1613
DoubleRedirectJob\getFinalDestination
static getFinalDestination( $title)
Get the final destination of a redirect.
Definition: DoubleRedirectJob.php:185
Job\$title
Title $title
Definition: Job.php:42
DoubleRedirectJob\getUser
getUser()
Get a user object for doing edits, from a request-lifetime cache False will be returned if the user n...
Definition: DoubleRedirectJob.php:240
MagicWord\get
static & get( $id)
Factory: creates an object representing an ID.
Definition: MagicWord.php:277
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
$res
$res
Definition: database.txt:21
Title\isExternal
isExternal()
Is this Title interwiki?
Definition: Title.php:846
Job\$params
array $params
Array of job parameters.
Definition: Job.php:36
Job\setLastError
setLastError( $error)
Definition: Job.php:419
php
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
DoubleRedirectJob
Job to fix double redirects after moving a page.
Definition: DoubleRedirectJob.php:29
Job
Class to both describe a background job and handle jobs.
Definition: Job.php:31
Revision\newFromTitle
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition: Revision.php:133
Title\getDBkey
getDBkey()
Get the main part with underscores.
Definition: Title.php:947
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
Title\getNamespace
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:970
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
title
title
Definition: parserTests.txt:219
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
DoubleRedirectJob\fixRedirects
static fixRedirects( $reason, $redirTitle, $destTitle=false)
Insert jobs into the job queue to fix redirects to the given title.
Definition: DoubleRedirectJob.php:61
DoubleRedirectJob\$redirTitle
Title $redirTitle
The title which has changed, redirects pointing to this title are fixed.
Definition: DoubleRedirectJob.php:38
EDIT_UPDATE
const EDIT_UPDATE
Definition: Defines.php:163
DoubleRedirectJob\__construct
__construct(Title $title, array $params)
Definition: DoubleRedirectJob.php:47
DoubleRedirectJob\$user
static User $user
Definition: DoubleRedirectJob.php:41
Title
Represents a title within MediaWiki.
Definition: Title.php:39
JobQueueGroup\singleton
static singleton( $domain=false)
Definition: JobQueueGroup.php:72
as
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:22
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
EDIT_SUPPRESS_RC
const EDIT_SUPPRESS_RC
Definition: Defines.php:165
DoubleRedirectJob\run
run()
Definition: DoubleRedirectJob.php:97
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
$article
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
DoubleRedirectJob\$reason
string $reason
Reason for the change, 'maintenance' or 'move'.
Definition: DoubleRedirectJob.php:33