MediaWiki  1.29.1
install.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
26 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
27 define( 'MEDIAWIKI_INSTALL', true );
28 
39  function __construct() {
40  parent::__construct();
41  global $IP;
42 
43  $this->addDescription( "CLI-based MediaWiki installation and configuration.\n" .
44  "Default options are indicated in parentheses." );
45 
46  $this->addArg( 'name', 'The name of the wiki (MediaWiki)', false );
47 
48  $this->addArg( 'admin', 'The username of the wiki administrator.' );
49  $this->addOption( 'pass', 'The password for the wiki administrator.', false, true );
50  $this->addOption(
51  'passfile',
52  'An alternative way to provide pass option, as the contents of this file',
53  false,
54  true
55  );
56  /* $this->addOption( 'email', 'The email for the wiki administrator', false, true ); */
57  $this->addOption(
58  'scriptpath',
59  'The relative path of the wiki in the web server (/wiki)',
60  false,
61  true
62  );
63 
64  $this->addOption( 'lang', 'The language to use (en)', false, true );
65  /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
66 
67  $this->addOption( 'dbtype', 'The type of database (mysql)', false, true );
68  $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
69  $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
70  $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
71  $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
72  $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
73  $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
74  $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
75  $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
76  $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
77  $this->addOption(
78  'dbpassfile',
79  'An alternative way to provide dbpass option, as the contents of this file',
80  false,
81  true
82  );
83  $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
84  $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in '
85  . 'PostgreSQL/Microsoft SQL Server (mediawiki)', false, true );
86  /*
87  $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)',
88  false, true );
89  */
90  $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
91  }
92 
93  function execute() {
94  global $IP;
95 
96  $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
97  $adminName = $this->getArg( 1 );
98 
99  $dbpassfile = $this->getOption( 'dbpassfile' );
100  if ( $dbpassfile !== null ) {
101  if ( $this->getOption( 'dbpass' ) !== null ) {
102  $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
103  . 'The content of "dbpassfile" overrides "dbpass".' );
104  }
105  MediaWiki\suppressWarnings();
106  $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
107  MediaWiki\restoreWarnings();
108  if ( $dbpass === false ) {
109  $this->error( "Couldn't open $dbpassfile", true );
110  }
111  $this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
112  }
113 
114  $passfile = $this->getOption( 'passfile' );
115  if ( $passfile !== null ) {
116  if ( $this->getOption( 'pass' ) !== null ) {
117  $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
118  . 'The content of "passfile" overrides "pass".' );
119  }
120  MediaWiki\suppressWarnings();
121  $pass = file_get_contents( $passfile ); // returns false on failure
122  MediaWiki\restoreWarnings();
123  if ( $pass === false ) {
124  $this->error( "Couldn't open $passfile", true );
125  }
126  $this->mOptions['pass'] = trim( $pass, "\r\n" );
127  } elseif ( $this->getOption( 'pass' ) === null ) {
128  $this->error( 'You need to provide the option "pass" or "passfile"', true );
129  }
130 
131  $installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
132 
133  $status = $installer->doEnvironmentChecks();
134  if ( $status->isGood() ) {
135  $installer->showMessage( 'config-env-good' );
136  } else {
137  $installer->showStatusMessage( $status );
138 
139  return;
140  }
141  if ( !$this->hasOption( 'env-checks' ) ) {
142  $installer->execute();
143  $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
144  }
145  }
146 
148  if ( !$this->hasOption( 'env-checks' ) ) {
149  parent::validateParamsAndArgs();
150  }
151  }
152 }
153 
154 $maintClass = 'CommandLineInstaller';
155 
156 require_once RUN_MAINTENANCE_IF_MAIN;
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:287
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
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:35
CommandLineInstaller\validateParamsAndArgs
validateParamsAndArgs()
Run some validation checks on the params, etc.
Definition: install.php:147
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:215
$IP
$IP
Definition: update.php:3
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:250
$maintClass
$maintClass
Definition: install.php:154
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:267
CommandLineInstaller\__construct
__construct()
Default constructor.
Definition: install.php:39
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:392
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:236
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:306
CommandLineInstaller
Maintenance script to install and configure MediaWiki.
Definition: install.php:38
CommandLineInstaller\execute
execute()
Do the actual work.
Definition: install.php:93
InstallerOverrides\getCliInstaller
static getCliInstaller( $siteName, $admin=null, array $options=[])
Instantiates and returns an instance of CliInstaller or its descendant classes.
Definition: InstallerOverrides.php:72