MediaWiki  master
fixDoubleRedirects.php
Go to the documentation of this file.
1 <?php
28 require_once __DIR__ . '/Maintenance.php';
29 
36  public function __construct() {
37  parent::__construct();
38  $this->addDescription( 'Script to fix double redirects' );
39  $this->addOption( 'async', 'Don\'t fix anything directly, just queue the jobs' );
40  $this->addOption( 'title', 'Fix only redirects pointing to this page', false, true );
41  $this->addOption( 'dry-run', 'Perform a dry run, fix nothing' );
42  }
43 
44  public function execute() {
45  $async = $this->hasOption( 'async' );
46  $dryrun = $this->hasOption( 'dry-run' );
47 
48  if ( $this->hasOption( 'title' ) ) {
49  $title = Title::newFromText( $this->getOption( 'title' ) );
50  if ( !$title || !$title->isRedirect() ) {
51  $this->fatalError( $title->getPrefixedText() . " is not a redirect!\n" );
52  }
53  } else {
54  $title = null;
55  }
56 
57  $dbr = $this->getDB( DB_REPLICA );
58 
59  // See also SpecialDoubleRedirects
60  $tables = [
61  'redirect',
62  'pa' => 'page',
63  'pb' => 'page',
64  ];
65  $fields = [
66  'pa.page_namespace AS pa_namespace',
67  'pa.page_title AS pa_title',
68  'pb.page_namespace AS pb_namespace',
69  'pb.page_title AS pb_title',
70  ];
71  $conds = [
72  'rd_from = pa.page_id',
73  'rd_namespace = pb.page_namespace',
74  'rd_title = pb.page_title',
75  'rd_interwiki IS NULL OR rd_interwiki = ' . $dbr->addQuotes( '' ), // T42352
76  'pb.page_is_redirect' => 1,
77  ];
78 
79  if ( $title != null ) {
80  $conds['pb.page_namespace'] = $title->getNamespace();
81  $conds['pb.page_title'] = $title->getDBkey();
82  }
83  // TODO: support batch querying
84 
85  $res = $dbr->select( $tables, $fields, $conds, __METHOD__ );
86 
87  if ( !$res->numRows() ) {
88  $this->output( "No double redirects found.\n" );
89 
90  return;
91  }
92 
93  $jobs = [];
94  $processedTitles = "\n";
95  $n = 0;
96  foreach ( $res as $row ) {
97  $titleA = Title::makeTitle( $row->pa_namespace, $row->pa_title );
98  $titleB = Title::makeTitle( $row->pb_namespace, $row->pb_title );
99 
100  $processedTitles .= "* [[$titleA]]\n";
101 
102  $job = new DoubleRedirectJob( $titleA, [
103  'reason' => 'maintenance',
104  'redirTitle' => $titleB->getPrefixedDBkey()
105  ] );
106 
107  if ( !$async ) {
108  $success = ( $dryrun ? true : $job->run() );
109  if ( !$success ) {
110  $this->error( "Error fixing " . $titleA->getPrefixedText()
111  . ": " . $job->getLastError() . "\n" );
112  }
113  } else {
114  $jobs[] = $job;
115  // @todo FIXME: Hardcoded constant 10000 copied from DoubleRedirectJob class
116  if ( count( $jobs ) > 10000 ) {
117  $this->queueJobs( $jobs, $dryrun );
118  $jobs = [];
119  }
120  }
121 
122  if ( ++$n % 100 == 0 ) {
123  $this->output( "$n...\n" );
124  }
125  }
126 
127  if ( count( $jobs ) ) {
128  $this->queueJobs( $jobs, $dryrun );
129  }
130  $this->output( "$n double redirects processed" . $processedTitles . "\n" );
131  }
132 
133  protected function queueJobs( $jobs, $dryrun = false ) {
134  $this->output( "Queuing batch of " . count( $jobs ) . " double redirects.\n" );
135  JobQueueGroup::singleton()->push( $dryrun ? [] : $jobs );
136  }
137 }
138 
140 require_once RUN_MAINTENANCE_IF_MAIN;
$success
error( $err, $die=0)
Throw an error to the user.
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
this hook is for auditing only 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 & $tables
Definition: hooks.txt:960
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1971
queueJobs( $jobs, $dryrun=false)
$res
Definition: database.txt:21
addDescription( $text)
Set the description text.
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
output( $out, $channel=null)
Throw some output to the user.
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
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
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
if(count( $args)< 1) $job
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
static singleton( $domain=false)
const DB_REPLICA
Definition: defines.php:25
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Maintenance script that fixes double redirects.
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