importSiteScripts.php

Go to the documentation of this file.

<?php
use MediaWiki\Content\ContentHandler;
use MediaWiki\Json\FormatJson;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\StubObject\StubGlobalUser;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class ImportSiteScripts extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Import site scripts from a site' );
        $this->addArg( 'api', 'API base url' );
        $this->addArg( 'index', 'index.php base url' );
        $this->addOption( 'username', 'User name of the script importer' );
        $this->setBatchSize( 100 );
    }
 
    public function execute() {
        $username = $this->getOption( 'username', false );
        if ( $username === false ) {
            $user = User::newSystemUser( 'ScriptImporter', [ 'steal' => true ] );
        } else {
            $user = User::newFromName( $username );
        }
        '@phan-var User $user';
        StubGlobalUser::setUser( $user );
 
        $baseUrl = $this->getArg( 1 );
        $pageList = $this->fetchScriptList();
        $this->output( 'Importing ' . count( $pageList ) . " pages\n" );
        $services = $this->getServiceContainer();
        $wikiPageFactory = $services->getWikiPageFactory();
        $httpRequestFactory = $services->getHttpRequestFactory();
 
        $pageBatches = $this->newBatchIterator( $pageList );
 
        foreach ( $pageBatches as $pageBatch ) {
            $this->beginTransactionRound( __METHOD__ );
            foreach ( $pageBatch as $page ) {
                $title = Title::makeTitleSafe( NS_MEDIAWIKI, $page );
                if ( !$title ) {
                    $this->error( "$page is an invalid title; it will not be imported\n" );
                    continue;
                }
 
                $this->output( "Importing $page\n" );
                $url = wfAppendQuery( $baseUrl, [
                    'action' => 'raw',
                    'title' => "MediaWiki:{$page}" ] );
                $text = $httpRequestFactory->get( $url, [], __METHOD__ );
 
                $wikiPage = $wikiPageFactory->newFromTitle( $title );
                $content = ContentHandler::makeContent( $text, $wikiPage->getTitle() );
 
                $wikiPage->doUserEditContent( $content, $user, "Importing from $url" );
            }
            $this->commitTransactionRound( __METHOD__ );
        }
    }
 
    protected function fetchScriptList(): array {
        $data = [
            'action' => 'query',
            'format' => 'json',
            'list' => 'allpages',
            'apnamespace' => '8',
            'aplimit' => '500',
            'continue' => '',
        ];
        $baseUrl = $this->getArg( 0 );
        $pages = [];
 
        while ( true ) {
            $url = wfAppendQuery( $baseUrl, $data );
            $strResult = $this->getServiceContainer()->getHttpRequestFactory()->
                get( $url, [], __METHOD__ );
            $result = FormatJson::decode( $strResult, true );
 
            $page = null;
            foreach ( $result['query']['allpages'] as $page ) {
                if ( str_ends_with( $page['title'], '.js' ) ) {
                    strtok( $page['title'], ':' );
                    $pages[] = strtok( '' );
                }
            }
 
            if ( $page !== null ) {
                $this->output( "Fetched list up to {$page['title']}\n" );
            }
 
            if ( isset( $result['continue'] ) ) { // >= 1.21
                $data = array_replace( $data, $result['continue'] );
            } elseif ( isset( $result['query-continue']['allpages'] ) ) { // <= 1.20
                $data = array_replace( $data, $result['query-continue']['allpages'] );
            } else {
                break;
            }
        }
 
        return $pages;
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = ImportSiteScripts::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd