MediaWiki  REL1_31
getConfiguration.php
Go to the documentation of this file.
1 <?php
26 require_once __DIR__ . '/Maintenance.php';
27 
34 
35  protected $regex = null;
36 
37  protected $settings_list = [];
38 
43  protected static $outFormats = [
44  'json',
45  'php',
46  'serialize',
47  'vardump',
48  ];
49 
50  public function __construct() {
51  parent::__construct();
52  $this->addDescription( 'Get serialized MediaWiki site configuration' );
53  $this->addOption( 'regex', 'regex to filter variables with', false, true );
54  $this->addOption( 'iregex', 'same as --regex but case insensitive', false, true );
55  $this->addOption( 'settings', 'Space-separated list of wg* variables', false, true );
56  $this->addOption( 'format', implode( ', ', self::$outFormats ), false, true );
57  }
58 
59  protected function validateParamsAndArgs() {
60  $error_out = false;
61 
62  # Get the format and make sure it is set to a valid default value
63  $format = strtolower( $this->getOption( 'format', 'PHP' ) );
64 
65  $validFormat = in_array( $format, self::$outFormats );
66  if ( !$validFormat ) {
67  $this->error( "--format set to an unrecognized format" );
68  $error_out = true;
69  }
70 
71  if ( $this->getOption( 'regex' ) && $this->getOption( 'iregex' ) ) {
72  $this->error( "Can only use either --regex or --iregex" );
73  $error_out = true;
74  }
75 
76  parent::validateParamsAndArgs();
77 
78  if ( $error_out ) {
79  # Force help and quit
80  $this->maybeHelp( true );
81  }
82  }
83 
87  public function finalSetup() {
88  parent::finalSetup();
89 
90  $this->regex = $this->getOption( 'regex' ) ?: $this->getOption( 'iregex' );
91  if ( $this->regex ) {
92  $this->regex = '/' . $this->regex . '/';
93  if ( $this->hasOption( 'iregex' ) ) {
94  $this->regex .= 'i'; # case insensitive regex
95  }
96  }
97 
98  if ( $this->hasOption( 'settings' ) ) {
99  $this->settings_list = explode( ' ', $this->getOption( 'settings' ) );
100  # Values validation
101  foreach ( $this->settings_list as $name ) {
102  if ( !preg_match( '/^wg[A-Z]/', $name ) ) {
103  throw new MWException( "Variable '$name' does start with 'wg'." );
104  } elseif ( !array_key_exists( $name, $GLOBALS ) ) {
105  throw new MWException( "Variable '$name' is not set." );
106  } elseif ( !$this->isAllowedVariable( $GLOBALS[$name] ) ) {
107  throw new MWException( "Variable '$name' includes non-array, non-scalar, items." );
108  }
109  }
110  }
111  }
112 
113  public function execute() {
114  // Settings we will display
115  $res = [];
116 
117  # Sane default: dump any wg / wmg variable
118  if ( !$this->regex && !$this->getOption( 'settings' ) ) {
119  $this->regex = '/^wm?g/';
120  }
121 
122  # Filter out globals based on the regex
123  if ( $this->regex ) {
124  $res = [];
125  foreach ( $GLOBALS as $name => $value ) {
126  if ( preg_match( $this->regex, $name ) ) {
127  $res[$name] = $value;
128  }
129  }
130  }
131 
132  # Explicitly dumps a list of provided global names
133  if ( $this->settings_list ) {
134  foreach ( $this->settings_list as $name ) {
135  $res[$name] = $GLOBALS[$name];
136  }
137  }
138 
139  ksort( $res );
140 
141  $out = null;
142  switch ( strtolower( $this->getOption( 'format' ) ) ) {
143  case 'serialize':
144  case 'php':
145  $out = serialize( $res );
146  break;
147  case 'vardump':
148  $out = $this->formatVarDump( $res );
149  break;
150  case 'json':
152  break;
153  default:
154  throw new MWException( "Invalid serialization format given." );
155  }
156  if ( !is_string( $out ) ) {
157  throw new MWException( "Failed to serialize the requested settings." );
158  }
159 
160  if ( $out ) {
161  $this->output( $out . "\n" );
162  }
163  }
164 
165  protected function formatVarDump( $res ) {
166  $ret = '';
167  foreach ( $res as $key => $value ) {
168  ob_start(); # intercept var_dump() output
169  print "\${$key} = ";
170  var_dump( $value );
171  # grab var_dump() output and discard it from the output buffer
172  $ret .= trim( ob_get_clean() ) . ";\n";
173  }
174 
175  return trim( $ret, "\n" );
176  }
177 
178  private function isAllowedVariable( $value ) {
179  if ( is_array( $value ) ) {
180  foreach ( $value as $k => $v ) {
181  if ( !$this->isAllowedVariable( $v ) ) {
182  return false;
183  }
184  }
185 
186  return true;
187  } elseif ( is_scalar( $value ) || $value === null ) {
188  return true;
189  }
190 
191  return false;
192  }
193 }
194 
196 require_once RUN_MAINTENANCE_IF_MAIN;
GetConfiguration\$regex
$regex
Definition: getConfiguration.php:35
GetConfiguration\execute
execute()
Do the actual work.
Definition: getConfiguration.php:113
Maintenance\maybeHelp
maybeHelp( $force=false)
Maybe show the help.
Definition: Maintenance.php:999
$maintClass
$maintClass
Definition: getConfiguration.php:195
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2005
GetConfiguration\__construct
__construct()
Default constructor.
Definition: getConfiguration.php:50
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
GetConfiguration\finalSetup
finalSetup()
finalSetup() since we need MWException
Definition: getConfiguration.php:87
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
serialize
serialize()
Definition: ApiMessage.php:184
$res
$res
Definition: database.txt:21
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
MWException
MediaWiki exception.
Definition: MWException.php:26
GetConfiguration
Print serialized output of MediaWiki config vars.
Definition: getConfiguration.php:33
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
GetConfiguration\$outFormats
static $outFormats
List of format output internally supported.
Definition: getConfiguration.php:43
GetConfiguration\formatVarDump
formatVarDump( $res)
Definition: getConfiguration.php:165
GetConfiguration\validateParamsAndArgs
validateParamsAndArgs()
Run some validation checks on the params, etc.
Definition: getConfiguration.php:59
$value
$value
Definition: styleTest.css.php:45
GetConfiguration\isAllowedVariable
isAllowedVariable( $value)
Definition: getConfiguration.php:178
GetConfiguration\$settings_list
$settings_list
Definition: getConfiguration.php:37
print
print
Definition: opensearch_desc.php:46
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6