MediaWiki REL1_29
|
Class for setting up the MediaWiki database using MySQL. More...
Public Member Functions | |
canCreateAccounts () | |
Return true if the install user can create accounts. | |
getCharsets () | |
Get a list of character sets that are available and supported. | |
getConnectForm () | |
getEngines () | |
Get a list of storage engines that are available and supported. | |
getLocalSettings () | |
Get the DBMS-specific options for LocalSettings.php generation. | |
getName () | |
getSchemaVars () | |
Get variables to substitute into tables.sql and the SQL patch files. | |
getSettingsForm () | |
isCompiled () | |
openConnection () | |
preInstall () | |
Allow DB installers a chance to make last-minute changes before installation occurs. | |
preUpgrade () | |
Allow DB installers a chance to make checks before upgrade. | |
setupDatabase () | |
setupUser () | |
submitConnectForm () | |
Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm(). | |
submitSettingsForm () | |
Public Member Functions inherited from DatabaseInstaller | |
__construct ( $parent) | |
Construct and initialise parent. | |
checkPrerequisites () | |
Checks for installation prerequisites other than those checked by isCompiled() | |
createExtensionTables () | |
Create the tables for each extension the user enabled. | |
createTables () | |
Create database tables from scratch. | |
doUpgrade () | |
Perform database upgrades. | |
enableLB () | |
Set up LBFactory so that wfGetDB() etc. | |
getCheckBox ( $var, $label, $attribs=[], $helpData="") | |
Get a labelled checkbox to configure a local boolean variable. | |
getConnection () | |
Connect to the database using the administrative user/password currently defined in the session. | |
getGlobalDefaults () | |
Get a name=>value map of MW configuration globals for the default values. | |
getGlobalNames () | |
Get an array of MW configuration globals that will be configured by this class. | |
getInstallUserBox () | |
Get a standard install-user fieldset. | |
getInternalDefaults () | |
Get a name=>value map of internal variables used during installation. | |
getPasswordBox ( $var, $label, $attribs=[], $helpData="") | |
Get a labelled password box to configure a local variable. | |
getRadioSet ( $params) | |
Get a set of labelled radio buttons. | |
getReadableName () | |
Get the internationalised name for this DBMS. | |
getSchemaPath ( $db) | |
Return a path to the DBMS-specific schema file, otherwise default to tables.sql. | |
getTextBox ( $var, $label, $attribs=[], $helpData="") | |
Get a labelled text box to configure a local variable. | |
getUpdateKeysPath ( $db) | |
Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql. | |
getVar ( $var, $default=null) | |
Get a variable, taking local defaults into account. | |
getWebUserBox ( $noCreateMsg=false) | |
Get a standard web-user fieldset. | |
insertUpdateKeys () | |
Insert update keys into table to prevent running unneded updates. | |
needsUpgrade () | |
Determine whether an existing installation of MediaWiki is present in the configured administrative connection. | |
outputHandler ( $string) | |
populateInterwikiTable () | |
Common function for databases that don't understand the MySQLish syntax of interwiki.sql. | |
setupSchemaVars () | |
Set appropriate schema variables in the current database connection. | |
setVar ( $name, $value) | |
Convenience alias for $this->parent->setVar() | |
setVarsFromRequest ( $varNames) | |
Convenience function to set variables based on form data. | |
submitInstallUserBox () | |
Submit a standard install user fieldset. | |
submitWebUserBox () | |
Submit the form from getWebUserBox(). | |
Public Attributes | |
$minimumVersion = '5.0.3' | |
$supportedEngines = [ 'InnoDB', 'MyISAM' ] | |
$webUserPrivs | |
Public Attributes inherited from DatabaseInstaller | |
Database | $db = null |
The database connection. | |
WebInstaller | $parent |
The Installer object. | |
Protected Member Functions | |
escapeLikeInternal ( $s, $escapeChar='`') | |
getTableOptions () | |
Return any table options to be applied to all tables that don't override them. | |
likeToRegex ( $wildcard) | |
Convert a wildcard (as used in LIKE) to a regex Slashes are escaped, slash terminators included. | |
Protected Attributes | |
$globalNames | |
$internalDefaults | |
Protected Attributes inherited from DatabaseInstaller | |
array | $globalNames = [] |
Array of MW configuration globals this class uses. | |
array | $internalDefaults = [] |
Internal variables for installation. | |
Private Member Functions | |
buildFullUserName ( $name, $host) | |
Return a formal 'User'@'Host' username for use in queries. | |
userDefinitelyExists ( $host, $user) | |
Try to see if the user account exists. | |
Additional Inherited Members | |
Static Protected Member Functions inherited from DatabaseInstaller | |
static | checkExtension ( $name) |
Convenience function. | |
Class for setting up the MediaWiki database using MySQL.
Definition at line 34 of file MysqlInstaller.php.
|
private |
Return a formal 'User'@'Host' username for use in queries.
string | $name | Username, quotes will be added |
string | $host | Hostname, quotes will be added |
Definition at line 620 of file MysqlInstaller.php.
References $name.
Referenced by setupUser().
MysqlInstaller::canCreateAccounts | ( | ) |
Return true if the install user can create accounts.
Definition at line 273 of file MysqlInstaller.php.
References $res, $status, as, DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and likeToRegex().
Referenced by getSettingsForm(), and submitSettingsForm().
|
protected |
string | $s |
Definition at line 228 of file MysqlInstaller.php.
References $s.
Referenced by preUpgrade().
MysqlInstaller::getCharsets | ( | ) |
Get a list of character sets that are available and supported.
Definition at line 264 of file MysqlInstaller.php.
Referenced by getSettingsForm(), and submitSettingsForm().
MysqlInstaller::getConnectForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 81 of file MysqlInstaller.php.
References DatabaseInstaller\getInstallUserBox(), DatabaseInstaller\getTextBox(), text, and wfMessage().
MysqlInstaller::getEngines | ( | ) |
Get a list of storage engines that are available and supported.
Definition at line 239 of file MysqlInstaller.php.
References $res, $status, as, and DatabaseInstaller\getConnection().
Referenced by getSettingsForm(), and submitSettingsForm().
MysqlInstaller::getLocalSettings | ( | ) |
Get the DBMS-specific options for LocalSettings.php generation.
Reimplemented from DatabaseInstaller.
Definition at line 674 of file MysqlInstaller.php.
References getTableOptions(), DatabaseInstaller\getVar(), and wfBoolToStr().
MysqlInstaller::getName | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 67 of file MysqlInstaller.php.
MysqlInstaller::getSchemaVars | ( | ) |
Get variables to substitute into tables.sql and the SQL patch files.
Reimplemented from DatabaseInstaller.
Definition at line 665 of file MysqlInstaller.php.
References getTableOptions(), and DatabaseInstaller\getVar().
MysqlInstaller::getSettingsForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 358 of file MysqlInstaller.php.
References $s, canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getRadioSet(), DatabaseInstaller\getVar(), DatabaseInstaller\getWebUserBox(), DatabaseInstaller\setVar(), text, and wfMessage().
|
protected |
Return any table options to be applied to all tables that don't override them.
Definition at line 648 of file MysqlInstaller.php.
References $options, and DatabaseInstaller\getVar().
Referenced by getLocalSettings(), and getSchemaVars().
MysqlInstaller::isCompiled | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 74 of file MysqlInstaller.php.
References DatabaseInstaller\checkExtension().
|
protected |
Convert a wildcard (as used in LIKE) to a regex Slashes are escaped, slash terminators included.
Definition at line 346 of file MysqlInstaller.php.
Referenced by canCreateAccounts().
MysqlInstaller::openConnection | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 147 of file MysqlInstaller.php.
References DatabaseInstaller\$db, $e, $status, and DatabaseInstaller\getVar().
MysqlInstaller::preInstall | ( | ) |
Allow DB installers a chance to make last-minute changes before installation occurs.
This happens before setupDatabase() or createTables() is called, but long after the constructor. Helpful for things like modifying setup steps :)
Reimplemented from DatabaseInstaller.
Definition at line 484 of file MysqlInstaller.php.
MysqlInstaller::preUpgrade | ( | ) |
Allow DB installers a chance to make checks before upgrade.
Reimplemented from DatabaseInstaller.
Definition at line 165 of file MysqlInstaller.php.
References $res, $status, $wgDBpassword, $wgDBuser, escapeLikeInternal(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), global, and DatabaseInstaller\setVar().
MysqlInstaller::setupDatabase | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 496 of file MysqlInstaller.php.
References $status, DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and DatabaseInstaller\setupSchemaVars().
MysqlInstaller::setupUser | ( | ) |
Definition at line 519 of file MysqlInstaller.php.
References $e, $fullName, $name, $status, as, buildFullUserName(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), DatabaseInstaller\setupSchemaVars(), and userDefinitelyExists().
MysqlInstaller::submitConnectForm | ( | ) |
Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm().
Validate the connection settings by attempting to connect with them.
If this is called, $this->parent can be assumed to be a WebInstaller.
Reimplemented from DatabaseInstaller.
Definition at line 98 of file MysqlInstaller.php.
References $status, DatabaseInstaller\getConnection(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitInstallUserBox().
MysqlInstaller::submitSettingsForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 438 of file MysqlInstaller.php.
References $e, $status, canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getVar(), DatabaseInstaller\setVar(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitWebUserBox().
|
private |
Try to see if the user account exists.
Our "superuser" may not have access to mysql.user, so false means "no" or "maybe"
string | $host | Hostname to check |
string | $user | Username to check |
Definition at line 631 of file MysqlInstaller.php.
Referenced by setupUser().
|
protected |
Definition at line 36 of file MysqlInstaller.php.
|
protected |
Definition at line 46 of file MysqlInstaller.php.
MysqlInstaller::$minimumVersion = '5.0.3' |
Definition at line 54 of file MysqlInstaller.php.
MysqlInstaller::$supportedEngines = [ 'InnoDB', 'MyISAM' ] |
Definition at line 52 of file MysqlInstaller.php.
MysqlInstaller::$webUserPrivs |
Definition at line 56 of file MysqlInstaller.php.