aboutsummaryrefslogtreecommitdiffstats
path: root/maintenance/exportSites.php
blob: 4adcf14eb5790894ed19c53a0e4bfe9e8e7cac06 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php

// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd

use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Site\SiteExporter;

/**
 * Maintenance script for exporting site definitions from the sites table to XML.
 *
 * @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 from 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