MediaWiki  master
CliInstaller.php
Go to the documentation of this file.
1 <?php
25 
32 class CliInstaller extends Installer {
33  private $specifiedScriptPath = false;
34 
35  private $optionMap = [
36  'dbtype' => 'wgDBtype',
37  'dbserver' => 'wgDBserver',
38  'dbname' => 'wgDBname',
39  'dbuser' => 'wgDBuser',
40  'dbpass' => 'wgDBpassword',
41  'dbprefix' => 'wgDBprefix',
42  'dbtableoptions' => 'wgDBTableOptions',
43  'dbport' => 'wgDBport',
44  'dbschema' => 'wgDBmwschema',
45  'dbpath' => 'wgSQLiteDataDir',
46  'server' => 'wgServer',
47  'scriptpath' => 'wgScriptPath',
48  ];
49 
55  function __construct( $siteName, $admin = null, array $options = [] ) {
56  global $wgContLang;
57 
58  parent::__construct();
59 
60  if ( isset( $options['scriptpath'] ) ) {
61  $this->specifiedScriptPath = true;
62  }
63 
64  foreach ( $this->optionMap as $opt => $global ) {
65  if ( isset( $options[$opt] ) ) {
66  $GLOBALS[$global] = $options[$opt];
67  $this->setVar( $global, $options[$opt] );
68  }
69  }
70 
71  if ( isset( $options['lang'] ) ) {
72  global $wgLang, $wgLanguageCode;
73  $this->setVar( '_UserLang', $options['lang'] );
74  $wgLanguageCode = $options['lang'];
75  $this->setVar( 'wgLanguageCode', $wgLanguageCode );
76  $wgContLang = MediaWikiServices::getInstance()->getContentLanguage();
77  $wgLang = Language::factory( $options['lang'] );
78  RequestContext::getMain()->setLanguage( $wgLang );
79  }
80 
81  $this->setVar( 'wgSitename', $siteName );
82 
83  $metaNS = $wgContLang->ucfirst( str_replace( ' ', '_', $siteName ) );
84  if ( $metaNS == 'MediaWiki' ) {
85  $metaNS = 'Project';
86  }
87  $this->setVar( 'wgMetaNamespace', $metaNS );
88 
89  if ( $admin ) {
90  $this->setVar( '_AdminName', $admin );
91  }
92 
93  if ( !isset( $options['installdbuser'] ) ) {
94  $this->setVar( '_InstallUser',
95  $this->getVar( 'wgDBuser' ) );
96  $this->setVar( '_InstallPassword',
97  $this->getVar( 'wgDBpassword' ) );
98  } else {
99  $this->setVar( '_InstallUser',
100  $options['installdbuser'] );
101  $this->setVar( '_InstallPassword',
102  $options['installdbpass'] ?? "" );
103 
104  // Assume that if we're given the installer user, we'll create the account.
105  $this->setVar( '_CreateDBAccount', true );
106  }
107 
108  if ( isset( $options['pass'] ) ) {
109  $this->setVar( '_AdminPassword', $options['pass'] );
110  }
111 
112  // Detect and inject any extension found
113  if ( isset( $options['extensions'] ) ) {
114  $status = $this->validateExtensions(
115  'extension', 'extensions', $options['extensions'] );
116  if ( !$status->isOK() ) {
117  $this->showStatusMessage( $status );
118  }
119  $this->setVar( '_Extensions', $status->value );
120  } elseif ( isset( $options['with-extensions'] ) ) {
121  $this->setVar( '_Extensions', array_keys( $this->findExtensions() ) );
122  }
123 
124  // Set up the default skins
125  if ( isset( $options['skins'] ) ) {
126  $status = $this->validateExtensions( 'skin', 'skins', $options['skins'] );
127  if ( !$status->isOK() ) {
128  $this->showStatusMessage( $status );
129  }
130  $skins = $status->value;
131  } else {
132  $skins = array_keys( $this->findExtensions( 'skins' ) );
133  }
134  $this->setVar( '_Skins', $skins );
135 
136  if ( $skins ) {
137  $skinNames = array_map( 'strtolower', $skins );
138  $this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
139  }
140  }
141 
142  private function validateExtensions( $type, $directory, $nameLists ) {
143  $extensions = [];
144  $status = new Status;
145  foreach ( (array)$nameLists as $nameList ) {
146  foreach ( explode( ',', $nameList ) as $name ) {
147  $name = trim( $name );
148  if ( $name === '' ) {
149  continue;
150  }
151  $extStatus = $this->getExtensionInfo( $type, $directory, $name );
152  if ( $extStatus->isOK() ) {
153  $extensions[] = $name;
154  } else {
155  $status->merge( $extStatus );
156  }
157  }
158  }
159  $extensions = array_unique( $extensions );
160  $status->value = $extensions;
161  return $status;
162  }
163 
167  public function execute() {
168  // If APC is available, use that as the MainCacheType, instead of nothing.
169  // This is hacky and should be consolidated with WebInstallerOptions.
170  // This is here instead of in __construct(), because it should run run after
171  // doEnvironmentChecks(), which populates '_Caches'.
172  if ( count( $this->getVar( '_Caches' ) ) ) {
173  // We detected a CACHE_ACCEL implementation, use it.
174  $this->setVar( '_MainCacheType', 'accel' );
175  }
176 
178  if ( $vars ) {
179  $this->showStatusMessage(
180  Status::newFatal( "config-localsettings-cli-upgrade" )
181  );
182  }
183 
184  $this->performInstallation(
185  [ $this, 'startStage' ],
186  [ $this, 'endStage' ]
187  );
188  }
189 
195  public function writeConfigurationFile( $path ) {
197  $ls->writeFile( "$path/LocalSettings.php" );
198  }
199 
200  public function startStage( $step ) {
201  // Messages: config-install-database, config-install-tables, config-install-interwiki,
202  // config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
203  // config-install-extensions
204  $this->showMessage( "config-install-$step" );
205  }
206 
207  public function endStage( $step, $status ) {
208  $this->showStatusMessage( $status );
209  $this->showMessage( 'config-install-step-done' );
210  }
211 
212  public function showMessage( $msg, ...$params ) {
213  echo $this->getMessageText( $msg, $params ) . "\n";
214  flush();
215  }
216 
217  public function showError( $msg, ...$params ) {
218  echo "***{$this->getMessageText( $msg, $params )}***\n";
219  flush();
220  }
221 
228  protected function getMessageText( $msg, $params ) {
229  $text = wfMessage( $msg, $params )->parse();
230 
231  $text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 &lt;$1&gt;', $text );
232 
233  return Sanitizer::stripAllTags( $text );
234  }
235 
239  public function showHelpBox( $msg /*, ... */ ) {
240  }
241 
242  public function showStatusMessage( Status $status ) {
243  $warnings = array_merge( $status->getWarningsArray(),
244  $status->getErrorsArray() );
245 
246  if ( count( $warnings ) !== 0 ) {
247  foreach ( $warnings as $w ) {
248  $this->showMessage( ...$w );
249  }
250  }
251 
252  if ( !$status->isOK() ) {
253  echo "\n";
254  exit( 1 );
255  }
256  }
257 
258  public function envCheckPath() {
259  if ( !$this->specifiedScriptPath ) {
260  $this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
261  }
262 
263  return parent::envCheckPath();
264  }
265 
266  protected function envGetDefaultServer() {
267  return null; // Do not guess if installing from CLI
268  }
269 
270  public function dirIsExecutable( $dir, $url ) {
271  $this->showMessage( 'config-no-cli-uploads-check', $dir );
272 
273  return false;
274  }
275 }
endStage( $step, $status)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
dirIsExecutable( $dir, $url)
showError( $msg,... $params)
execute()
Main entry point.
validateExtensions( $type, $directory, $nameLists)
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 MediaWikiServices
Definition: injection.txt:23
static getLocalSettingsGenerator(Installer $installer)
Instantiates and returns an instance of LocalSettingsGenerator or its descendant classes.
getWarningsArray()
Get the list of warnings (but not errors)
Definition: Status.php:353
getMessageText( $msg, $params)
Class for the core installer command line interface.
$wgLanguageCode
Site language code.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
static stripAllTags( $html)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed, encoded as plain text.
Definition: Sanitizer.php:1995
$wgLang
Definition: Setup.php:931
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
getErrorsArray()
Get the list of errors (but not warnings)
Definition: Status.php:342
getExtensionInfo( $type, $parentRelPath, $name)
Definition: Installer.php:1327
showMessage( $msg,... $params)
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
Definition: Installer.php:592
$params
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 & $options
Definition: hooks.txt:1982
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:541
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
findExtensions( $directory='extensions')
Find extensions or skins in a subdirectory of $IP.
Definition: Installer.php:1274
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
$GLOBALS['IP']
isOK()
Returns whether the operation completed.
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:9
writeConfigurationFile( $path)
Write LocalSettings.php to a given path.
__construct( $siteName, $admin=null, array $options=[])
performInstallation( $startCB, $endCB)
Actually perform the installation.
Definition: Installer.php:1591
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:35
showHelpBox( $msg)
Dummy.
Base installer class.
Definition: Installer.php:46
startStage( $step)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
showStatusMessage(Status $status)
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Definition: Installer.php:527
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2217
$wgContLang
Definition: Setup.php:846
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings, but will fall back to another if the default skin is missing and some other one is present instead.
Definition: Installer.php:1459