ImportSiteScripts

Complexity

Total Complexity

12

Size/Duplication

Total Lines	84
Duplicated Lines	5.95 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
B	execute()	5	33	4
C	fetchScriptList()	0	40	7

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 32 and the first side effect is on line 24.

/**
 * Import all scripts in the MediaWiki namespace from a local site.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Maintenance
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script to import all scripts in the MediaWiki namespace from a
 * local site.
 *
 * @ingroup Maintenance
 */
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' );
	}

	public function execute() {
		global $wgUser;

		$username = $this->getOption( 'username', false );
		if ( $username === false ) {
			$user = User::newSystemUser( 'ScriptImporter', [ 'steal' => true ] );
		} else {
			$user = User::newFromName( $username );
		}
		$wgUser = $user;

		$baseUrl = $this->getArg( 1 );
		$pageList = $this->fetchScriptList();
		$this->output( 'Importing ' . count( $pageList ) . " pages\n" );

		foreach ( $pageList 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 = Http::get( $url, [], __METHOD__ );

			$wikiPage = WikiPage::factory( $title );
			$content = ContentHandler::makeContent( $text, $wikiPage->getTitle() );

It seems like $text defined by \Http::get($url, array(), __METHOD__) on line 67 can also be of type boolean; however, ContentHandler::makeContent() does only seem to accept string, maybe add an additional type check?

			$wikiPage->doEditContent( $content, "Importing from $url", 0, false, $user );

It seems like $user defined by \User::newFromName($username) on line 48 can also be of type false; however, WikiPage::doEditContent() does only seem to accept null|object<User>, did you maybe forget to handle an error condition?

		}
	}

	protected function fetchScriptList() {
		$data = [
			'action' => 'query',
			'format' => 'json',
			'list' => 'allpages',
			'apnamespace' => '8',
			'aplimit' => '500',
			'continue' => '',
		];
		$baseUrl = $this->getArg( 0 );
		$pages = [];

		while ( true ) {
			$url = wfAppendQuery( $baseUrl, $data );
			$strResult = Http::get( $url, [], __METHOD__ );
			$result = FormatJson::decode( $strResult, true );

It seems like $strResult defined by \Http::get($url, array(), __METHOD__) on line 89 can also be of type boolean; however, FormatJson::decode() does only seem to accept string, maybe add an additional type check?

			$page = null;
			foreach ( $result['query']['allpages'] as $page ) {
				if ( substr( $page['title'], -3 ) === '.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;
	}
}

$maintClass = 'ImportSiteScripts';
require_once RUN_MAINTENANCE_IF_MAIN;