MediaWiki REL1_37
importSiteScripts.php
Go to the documentation of this file.
1<?php
25
26require_once __DIR__ . '/Maintenance.php';
27
35 public function __construct() {
36 parent::__construct();
37 $this->addDescription( 'Import site scripts from a site' );
38 $this->addArg( 'api', 'API base url' );
39 $this->addArg( 'index', 'index.php base url' );
40 $this->addOption( 'username', 'User name of the script importer' );
41 }
42
43 public function execute() {
44 $username = $this->getOption( 'username', false );
45 if ( $username === false ) {
46 $user = User::newSystemUser( 'ScriptImporter', [ 'steal' => true ] );
47 } else {
48 $user = User::newFromName( $username );
49 }
51
52 $baseUrl = $this->getArg( 1 );
53 $pageList = $this->fetchScriptList();
54 $this->output( 'Importing ' . count( $pageList ) . " pages\n" );
55 $services = MediaWikiServices::getInstance();
56 $wikiPageFactory = $services->getWikiPageFactory();
57 $httpRequestFactory = $services->getHttpRequestFactory();
58
59 foreach ( $pageList as $page ) {
60 $title = Title::makeTitleSafe( NS_MEDIAWIKI, $page );
61 if ( !$title ) {
62 $this->error( "$page is an invalid title; it will not be imported\n" );
63 continue;
64 }
65
66 $this->output( "Importing $page\n" );
67 $url = wfAppendQuery( $baseUrl, [
68 'action' => 'raw',
69 'title' => "MediaWiki:{$page}" ] );
70 $text = $httpRequestFactory->get( $url, [], __METHOD__ );
71
72 $wikiPage = $wikiPageFactory->newFromTitle( $title );
73 $content = ContentHandler::makeContent( $text, $wikiPage->getTitle() );
74 $wikiPage->doUserEditContent( $content, $user, "Importing from $url" );
75 }
76 }
77
78 protected function fetchScriptList() {
79 $data = [
80 'action' => 'query',
81 'format' => 'json',
82 'list' => 'allpages',
83 'apnamespace' => '8',
84 'aplimit' => '500',
85 'continue' => '',
86 ];
87 $baseUrl = $this->getArg( 0 );
88 $pages = [];
89
90 while ( true ) {
91 $url = wfAppendQuery( $baseUrl, $data );
92 $strResult = MediaWikiServices::getInstance()->getHttpRequestFactory()->
93 get( $url, [], __METHOD__ );
94 $result = FormatJson::decode( $strResult, true );
95
96 $page = null;
97 foreach ( $result['query']['allpages'] as $page ) {
98 if ( substr( $page['title'], -3 ) === '.js' ) {
99 strtok( $page['title'], ':' );
100 $pages[] = strtok( '' );
101 }
102 }
103
104 if ( $page !== null ) {
105 $this->output( "Fetched list up to {$page['title']}\n" );
106 }
107
108 if ( isset( $result['continue'] ) ) { // >= 1.21
109 $data = array_replace( $data, $result['continue'] );
110 } elseif ( isset( $result['query-continue']['allpages'] ) ) { // <= 1.20
111 $data = array_replace( $data, $result['query-continue']['allpages'] );
112 } else {
113 break;
114 }
115 }
116
117 return $pages;
118 }
119}
120
121$maintClass = ImportSiteScripts::class;
122require_once RUN_MAINTENANCE_IF_MAIN;
const NS_MEDIAWIKI
Definition Defines.php:72
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Maintenance script to import all scripts in the MediaWiki namespace from a local site.
execute()
Do the actual work.
__construct()
Default constructor.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
output( $out, $channel=null)
Throw some output to the user.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static setUser( $user)
Reset the stub global user to a different "real" user object, while ensuring that any method calls on...
static newFromName( $name, $validate='valid')
Definition User.php:607
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition User.php:810
$content
Definition router.php:76