summaryrefslogtreecommitdiff
path: root/maintenance/getConfiguration.php
blob: 83b5b029cc52d55581777b0c0b9eb4923173d5f4 (plain)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php
/**
 * Print serialized output of MediaWiki config vars
 *
 * 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
 * @author Tim Starling
 * @author Antoine Musso
 */

require_once( __DIR__ . '/Maintenance.php' );

/**
 * Print serialized output of MediaWiki config vars
 *
 * @ingroup Maintenance
 */
class GetConfiguration extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->mDescription = "Get serialized MediaWiki site configuration";
		$this->addOption( 'settings', 'Space-separated list of wg* variables', true, true );
		$this->addOption( 'format', 'PHP or JSON', true, true );
		$this->addOption( 'wiki', 'Wiki ID', true, true );
	}

	public function execute() {
		$res = array();
		foreach ( explode( ' ', $this->getOption( 'settings' ) ) as $name ) {
			if ( !preg_match( '/^wg[A-Z]/', $name ) ) {
				throw new MWException( "Variable '$name' does start with 'wg'." );
			} elseif ( !isset( $GLOBALS[$name] ) ) {
				throw new MWException( "Variable '$name' is not set." );
			} elseif ( !$this->isAllowedVariable( $GLOBALS[$name] ) ) {
				throw new MWException( "Variable '$name' includes non-array, non-scalar, items." );
			}
			$res[$name] = $GLOBALS[$name];
		}

		$out = null;
		switch( $this->getOption( 'format' ) ) {
			case 'PHP':
				$out = serialize( $res );
				break;
			case 'JSON':
				$out = FormatJson::encode( $res );
				break;
			default:
				throw new MWException( "Invalid serialization format given." );
		}
		if ( !is_string( $out ) ) {
			throw new MWException( "Failed to serialize the requested settings." );
		}

		$this->output( $out . "\n" );
	}

	private function isAllowedVariable( $value ) {
		if ( is_array( $value ) ) {
			foreach ( $value as $k => $v ) {
				if ( !$this->isAllowedVariable( $v ) ) {
					return false;
				}
			}
			return true;
		} elseif ( is_scalar( $value ) ) {
			return true;
		}
		return false;
	}
}

$maintClass = "GetConfiguration";
require_once( RUN_MAINTENANCE_IF_MAIN );