MediaWiki master
populateInterwiki.php
Go to the documentation of this file.
1<?php
2
28
29// @codeCoverageIgnoreStart
30require_once __DIR__ . '/Maintenance.php';
31// @codeCoverageIgnoreEnd
32
34
38 private $source;
39
40 public function __construct() {
41 parent::__construct();
42
43 $this->addDescription( <<<TEXT
44This script will populate the interwiki table, pulling in interwiki links that are used on Wikipedia
45or another MediaWiki wiki.
46
47When the script has finished, it will make a note of this in the database, and will not run again
48without the --force option.
49
50--source parameter is the url for the source wiki api, such as "https://en.wikipedia.org/w/api.php"
51(the default) from which the script fetches the interwiki data and uses here to populate
52the interwiki database table.
53TEXT
54 );
55
56 $this->addOption( 'source', 'Source wiki for interwiki table, such as '
57 . 'https://en.wikipedia.org/w/api.php (the default)', false, true );
58 $this->addOption( 'force', 'Run regardless of whether the database says it has '
59 . 'been run already.' );
60 }
61
62 public function execute() {
63 $force = $this->hasOption( 'force' );
64 $this->source = $this->getOption( 'source', 'https://en.wikipedia.org/w/api.php' );
65
66 $data = $this->fetchLinks();
67
68 if ( $data === false ) {
69 $this->error( "Error during fetching data." );
70 } else {
71 $this->doPopulate( $data, $force );
72 }
73 }
74
78 protected function fetchLinks() {
80 'action' => 'query',
81 'meta' => 'siteinfo',
82 'siprop' => 'interwikimap',
83 'sifilteriw' => 'local',
84 'format' => 'json'
85 ] );
86
87 if ( $this->source ) {
88 $url = rtrim( $this->source, '?' ) . '?' . $url;
89 }
90
91 $json = $this->getServiceContainer()->getHttpRequestFactory()->get( $url, [], __METHOD__ );
92 $data = json_decode( $json, true );
93
94 if ( is_array( $data ) ) {
95 return $data['query']['interwikimap'];
96 } else {
97 return false;
98 }
99 }
100
107 protected function doPopulate( array $data, $force ) {
108 $dbw = $this->getPrimaryDB();
109
110 if ( !$force ) {
111 $row = $dbw->newSelectQueryBuilder()
112 ->select( '1' )
113 ->from( 'updatelog' )
114 ->where( [ 'ul_key' => 'populate interwiki' ] )
115 ->caller( __METHOD__ )->fetchRow();
116
117 if ( $row ) {
118 $this->output( "Interwiki table already populated. Use php " .
119 "maintenance/populateInterwiki.php\n--force from the command line " .
120 "to override.\n" );
121 return true;
122 }
123 }
124
125 $lookup = $this->getServiceContainer()->getInterwikiLookup();
126 foreach ( $data as $d ) {
127 $prefix = $d['prefix'];
128
129 $row = $dbw->newSelectQueryBuilder()
130 ->select( '1' )
131 ->from( 'interwiki' )
132 ->where( [ 'iw_prefix' => $prefix ] )
133 ->caller( __METHOD__ )->fetchRow();
134
135 if ( !$row ) {
136 $dbw->newInsertQueryBuilder()
137 ->insertInto( 'interwiki' )
138 ->ignore()
139 ->row( [
140 'iw_prefix' => $prefix,
141 'iw_url' => $d['url'],
142 'iw_local' => 1,
143 'iw_api' => '',
144 'iw_wikiid' => '',
145 ] )
146 ->caller( __METHOD__ )->execute();
147 }
148
149 $lookup->invalidateCache( $prefix );
150 }
151
152 $this->output( "Interwiki links are populated.\n" );
153
154 return true;
155 }
156
157}
158
159// @codeCoverageIgnoreStart
160$maintClass = PopulateInterwiki::class;
161require_once RUN_MAINTENANCE_IF_MAIN;
162// @codeCoverageIgnoreEnd
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
run()
Run the job.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
output( $out, $channel=null)
Throw some output to the user.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
hasOption( $name)
Checks to see if a particular option was set.
getOption( $name, $default=null)
Get an option, or return the default.
error( $err, $die=0)
Throw an error to the user.
getServiceContainer()
Returns the main service container.
addDescription( $text)
Set the description text.
execute()
Do the actual work.
__construct()
Default constructor.
doPopulate(array $data, $force)
A helper class for throttling authentication attempts.