MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
29 class DoubleRedirectJob extends Job {
33  private $reason;
38  private $redirTitle;
41  private static $user;
48  parent::__construct( 'fixDoubleRedirect', $title, $params );
49  $this->reason = $params['reason'];
50  $this->redirTitle = Title::newFromText( $params['redirTitle'] );
51  }
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  }
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  }
97  function run() {
98  if ( !$this->redirTitle ) {
99  $this->setLastError( 'Invalid title' );
101  return false;
102  }
104  $targetRev = Revision::newFromTitle( $this->title, false, Revision::READ_LATEST );
105  if ( !$targetRev ) {
106  wfDebug( __METHOD__ . ": target redirect already deleted, ignoring\n" );
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" );
115  return true;
116  }
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" );
123  return true;
124  }
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" );
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  }
140  // Preserve fragment (T16904)
141  $newTitle = Title::makeTitle( $newTitle->getNamespace(), $newTitle->getDBkey(),
142  $currentDest->getFragment(), $newTitle->getInterwiki() );
144  // Fix the text
145  $newContent = $content->updateRedirect( $newTitle );
147  if ( $newContent->equals( $content ) ) {
148  $this->setLastError( 'Content unchanged???' );
150  return false;
151  }
153  $user = $this->getUser();
154  if ( !$user ) {
155  $this->setLastError( 'Invalid user' );
157  return false;
158  }
160  // Save it
161  global $wgUser;
162  $oldUser = $wgUser;
163  $wgUser = $user;
164  $article = WikiPage::factory( $this->title );
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;
174  return true;
175  }
185  public static function getFinalDestination( $title ) {
186  $dbw = wfGetDB( DB_MASTER );
188  // Circular redirect check
189  $seenTitles = [];
190  $dest = false;
192  while ( true ) {
193  $titleText = $title->getPrefixedDBkey();
194  if ( isset( $seenTitles[$titleText] ) ) {
195  wfDebug( __METHOD__, "Circular redirect detected, aborting\n" );
197  return false;
198  }
199  $seenTitles[$titleText] = true;
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  }
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  }
230  return $dest;
231  }
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  }
250  return self::$user;
251  }
252 }
Definition: Setup.php:781
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
Definition: Defines.php:157
Get the prefixed database key form.
Definition: Title.php:1439
static getFinalDestination( $title)
Get the final destination of a redirect.
Definition: DoubleRedirectJob.php:185
Title $title
Definition: Job.php:42
Get a user object for doing edits, from a request-lifetime cache False will be returned if the user n...
Definition: DoubleRedirectJob.php:240
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:246
static & get( $id)
Factory: creates an object representing an ID.
Definition: MagicWord.php:258
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:556
Definition: database.txt:21
Is this Title interwiki?
Definition: Title.php:800
array $params
Array of job parameters.
Definition: Job.php:36
setLastError( $error)
Definition: Job.php:393
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
Job to fix double redirects after moving a page.
Definition: DoubleRedirectJob.php:29
Class to both describe a background job and handle jobs.
Definition: Job.php:31
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:134
Get the main part with underscores.
Definition: Title.php:901
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:120
Get the namespace index, i.e.
Definition: Title.php:924
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1049
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3060
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Definition: defines.php:26
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:999
static fixRedirects( $reason, $redirTitle, $destTitle=false)
Insert jobs into the job queue to fix redirects to the given title.
Definition: DoubleRedirectJob.php:61
Title $redirTitle
The title which has changed, redirects pointing to this title are fixed.
Definition: DoubleRedirectJob.php:38
Definition: Defines.php:151
Definition: parserTests.txt:211
__construct(Title $title, array $params)
Definition: DoubleRedirectJob.php:47
static User $user
Definition: DoubleRedirectJob.php:41
Represents a title within MediaWiki.
Definition: Title.php:39
c Accompany it with the information you received as to the offer to distribute corresponding source complete source code means all the source code for all modules it plus any associated interface definition plus the scripts used to control compilation and installation of the executable as a special the source code distributed need not include anything that is normally and so on of the operating system on which the executable unless that component itself accompanies the executable If distribution of executable or object code is made by offering access to copy from a designated then offering equivalent access to copy the source code from the same place counts as distribution of the source even though third parties are not compelled to copy the source along with the object code You may not or distribute the Program except as expressly provided under this License Any attempt otherwise to sublicense or distribute the Program is and will automatically terminate your rights under this License parties who have received or from you under this License will not have their licenses terminated so long as such parties remain in full compliance You are not required to accept this since you have not signed it nothing else grants you permission to modify or distribute the Program or its derivative works These actions are prohibited by law if you do not accept this License by modifying or distributing the you indicate your acceptance of this License to do and all its terms and conditions for distributing or modifying the Program or works based on it Each time you redistribute the the recipient automatically receives a license from the original licensor to distribute or modify the Program subject to these terms and conditions You may not impose any further restrictions on the recipients exercise of the rights granted herein You are not responsible for enforcing compliance by third parties to this License as a consequence of a court judgment or allegation of patent infringement or for any other reason(not limited to patent issues)
static singleton( $wiki=false)
Definition: JobQueueGroup.php:71
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
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:78
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
Definition: Defines.php:153
Definition: DoubleRedirectJob.php:97
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:783
string $reason
Reason for the change, 'maintenance' or 'move'.
Definition: DoubleRedirectJob.php:33
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2749
the array() calling protocol came about after MediaWiki 1.4rc1.