e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
60 lines
1.3 KiB
PHP
60 lines
1.3 KiB
PHP
<?php
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
use MediaWiki\Site\SiteExporter;
|
|
|
|
/**
|
|
* Maintenance script for exporting site definitions from XML into the sites table.
|
|
*
|
|
* @since 1.25
|
|
*
|
|
* @license GPL-2.0-or-later
|
|
* @author Daniel Kinzler
|
|
*/
|
|
class ExportSites extends Maintenance {
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
|
|
$this->addDescription( 'Exports site definitions the sites table to XML file' );
|
|
|
|
$this->addArg( 'file', 'A file to write the XML to (see docs/sitelist.md). ' .
|
|
'Use "php://stdout" to write to stdout.', true
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Do the actual work. All child classes will need to implement this
|
|
*/
|
|
public function execute() {
|
|
$file = $this->getArg( 0 );
|
|
|
|
if ( $file === 'php://output' || $file === 'php://stdout' ) {
|
|
$this->mQuiet = true;
|
|
}
|
|
|
|
$handle = fopen( $file, 'w' );
|
|
|
|
if ( !$handle ) {
|
|
$this->fatalError( "Failed to open $file for writing.\n" );
|
|
}
|
|
|
|
$exporter = new SiteExporter( $handle );
|
|
|
|
$siteLookup = $this->getServiceContainer()->getSiteLookup();
|
|
$exporter->exportSites( $siteLookup->getSites() );
|
|
|
|
fclose( $handle );
|
|
|
|
$this->output( "Exported sites to " . realpath( $file ) . ".\n" );
|
|
}
|
|
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = ExportSites::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|