MediaWiki REL1_39
|
Class for the core installer web interface. More...
Public Member Functions | |
__construct (WebRequest $request) | |
envCheckPath () | |
envPrepPath () | |
Environment prep for setting $IP and $wgScriptPath. | |
errorHandler ( $errno, $errstr) | |
Temporary error handler for session start debugging. | |
execute (array $session) | |
Main entry point. | |
finish () | |
Clean up from execute() | |
getAcceptLanguage () | |
Retrieves MediaWiki language from Accept-Language HTTP header. | |
getCheckBox ( $params) | |
Get a labelled checkbox to configure a boolean variable. | |
getDocUrl ( $page) | |
Helper for WebInstallerOutput. | |
getFingerprint () | |
Get a hash of data identifying this MW installation. | |
getHelpBox ( $msg,... $args) | |
Get small text indented help for a preceding form field. | |
getInfoBox ( $text, $icon=false, $class='') | |
Get HTML for an information message box with an icon. | |
getLocalSettingsLocation () | |
If the software package wants the LocalSettings.php file to be placed in a specific location, override this function (see mw-config/overrides/README) to return the path of where the file should be saved, or false for a generic "in the base of your install". | |
getLowestUnhappy () | |
Find the next page in sequence that hasn't been completed. | |
getPageByName ( $pageName) | |
Get a WebInstallerPage by name. | |
getPasswordBox ( $params) | |
Get a labelled password box to configure a variable. | |
getPhpErrors () | |
getRadioElements ( $params) | |
Get a set of labelled radio buttons. | |
getRadioSet ( $params) | |
Get a set of labelled radio buttons. | |
getSession ( $name, $default=null) | |
Get a session variable. | |
getTextArea ( $params) | |
Get a labelled textarea to configure a variable. | |
getTextBox ( $params) | |
Get a labelled text box to configure a variable. | |
getUrl ( $query=[]) | |
Get a URL for submission back to the same script. | |
label ( $msg, $forId, $contents, $helpData="") | |
Label a control by wrapping a config-input div around it and putting a label before it. | |
makeDownloadLinkHtml () | |
Helper for "Download LocalSettings" link. | |
makeLinkItem ( $url, $linkText) | |
Helper for sidebar links. | |
nextTabIndex () | |
Get the next tabindex attribute value. | |
outputCss () | |
Output stylesheet for web installer pages. | |
reset () | |
We're restarting the installation, reset the session, happyPages, etc. | |
setSession ( $name, $value) | |
Set a session variable. | |
setupLanguage () | |
Initializes language-related variables. | |
setVarsFromRequest ( $varNames, $prefix='config_') | |
Convenience function to set variables based on form data. | |
showError ( $msg,... $params) | |
Show an error message in a box. | |
showHelpBox ( $msg,... $params) | |
Output a help box. | |
showMessage ( $msg,... $params) | |
Show a short informational message. | |
showStatusBox ( $status) | |
Output an error or warning box using a Status object. | |
showStatusMessage (Status $status) | |
startSession () | |
Start the PHP session. | |
Public Member Functions inherited from Installer | |
__construct () | |
Constructor, always call this from child classes. | |
addInstallStep ( $callback, $findStep='BEGINNING') | |
Add an installation step following the given step. | |
dirIsExecutable ( $dir, $url) | |
Checks if scripts located in the given directory can be executed via the given URL. | |
disableLinkPopups () | |
doEnvironmentChecks () | |
Do initial checks of the PHP environment. | |
doEnvironmentPreps () | |
findExtensions ( $directory='extensions') | |
Find extensions or skins in a subdirectory of $IP. | |
generateKeys () | |
Generate $wgSecretKey. | |
getAutoExtensionHookContainer () | |
Get the hook container previously populated by includeExtensions(). | |
getCompiledDBs () | |
Get a list of DBs supported by current PHP setup. | |
getDBInstaller ( $type=false) | |
Get an instance of DatabaseInstaller for the specified DB type. | |
getDefaultSkin (array $skinNames) | |
Returns a default value to be used for $wgDefaultSkin: normally the DefaultSkin from config-schema.yaml, but will fall back to another if the default skin is missing and some other one is present instead. | |
getFakePassword ( $realPassword) | |
Get a fake password for sending back to the user in HTML. | |
getParserOptions () | |
getVar ( $name, $default=null) | |
Get an MW configuration variable, or internal installer configuration variable. | |
parse ( $text, $lineStart=false) | |
Convert wikitext $text to HTML. | |
performInstallation ( $startCB, $endCB) | |
Actually perform the installation. | |
populateSiteStats (DatabaseInstaller $installer) | |
Install step which adds a row to the site_stats table with appropriate initial values. | |
resetMediaWikiServices (Config $installerConfig=null, $serviceOverrides=[]) | |
Reset the global service container and associated global state to accommodate different stages of the installation. | |
restoreLinkPopups () | |
restoreServices () | |
Restore services that have been redefined in the early stage of installation. | |
setParserLanguage ( $lang) | |
ParserOptions are constructed before we determined the language, so fix it. | |
setPassword ( $name, $value) | |
Set a variable which stores a password, except if the new value is a fake password in which case leave it as it is. | |
setVar ( $name, $value) | |
Set a MW configuration variable, or internal installer configuration variable. | |
Public Attributes | |
WebInstallerOutput | $output |
string[] | $pageSequence |
The main sequence of page names. | |
WebRequest | $request |
WebRequest object. | |
bool | $showSessionWarning = false |
Flag indicating that session data may have been lost. | |
Public Attributes inherited from Installer | |
array | $licenses |
License types. | |
array | $rightsProfiles |
User rights profiles. | |
const | MINIMUM_PCRE_VERSION = '7.2' |
The oldest version of PCRE we can support. | |
Protected Member Functions | |
envGetDefaultServer () | |
Protected Member Functions inherited from Installer | |
createMainpage (DatabaseInstaller $installer) | |
Insert Main Page with default content. | |
createSysop () | |
Create the first user account, grant it sysop, bureaucrat and interface-admin rights. | |
disableTimeLimit () | |
Disable the time limit for execution. | |
doGenerateKeys ( $keys) | |
Generate a secret value for variables using a secure generator. | |
envCheck64Bit () | |
Checks if we're running on 64 bit or not. | |
envCheckCache () | |
Environment check for compiled object cache types. | |
envCheckDB () | |
Environment check for DB types. | |
envCheckDiff3 () | |
Search for GNU diff3. | |
envCheckGit () | |
Search for git. | |
envCheckGraphics () | |
Environment check for ImageMagick and GD. | |
envCheckLibicu () | |
Check the libicu version. | |
envCheckMemory () | |
Environment check for available memory. | |
envCheckModSecurity () | |
Scare user to death if they have mod_security or mod_security2. | |
envCheckPCRE () | |
Environment check for the PCRE module. | |
envCheckServer () | |
Environment check to inform user which server we've assumed. | |
envCheckSuhosinMaxValueLength () | |
Checks if suhosin.get.max_value_length is set, and if so generate a warning because it is incompatible with ResourceLoader. | |
envCheckUploadsDirectory () | |
Environment check for the permissions of the uploads directory. | |
envPrepServer () | |
Environment prep for the server hostname. | |
findExtensionsByType ( $type='extension', $directory='extensions') | |
Find extensions or skins, and return an array containing the value for 'Name' for each found extension. | |
getAutoExtensionData () | |
Auto-detect extensions with an extension.json file. | |
getAutoExtensionLegacyHooks () | |
Auto-detect extensions with an old style .php registration file, load the extensions, and return the merged $wgHooks array. | |
getExtensionInfo ( $type, $parentRelPath, $name) | |
getInstallSteps (DatabaseInstaller $installer) | |
Get an array of install steps. | |
includeExtensionFiles ( $files) | |
Include the specified extension PHP files. | |
includeExtensions () | |
Installs the auto-detected extensions. | |
Static Protected Member Functions | |
static | infoBox ( $rawHtml, $icon, $alt, $class='') |
Get HTML for an information message box with an icon. | |
Protected Attributes | |
string | $currentPageName |
Name of the page we're on. | |
bool[] | $happyPages |
Array of pages which have declared that they have been submitted, have validated their input, and need no further processing. | |
int | $helpBoxId = 1 |
Numeric index of the help box. | |
string[] | $otherPages |
Out of sequence pages, selectable by the user at any time. | |
string[] | $phpErrors |
Captured PHP error text. | |
array[] | $session |
Cached session array. | |
bool[] | $skippedPages |
List of "skipped" pages. | |
int | $tabIndex = 1 |
Numeric index of the page we're on. | |
Protected Attributes inherited from Installer | |
HookContainer null | $autoExtensionHookContainer |
array | $compiledDBs |
List of detected DBs, access using getCompiledDBs(). | |
array | $dbInstallers = [] |
Cached DB installer instances, access using getDBInstaller(). | |
array | $envChecks |
A list of environment check methods called by doEnvironmentChecks(). | |
array | $envPreps |
A list of environment preparation methods called by doEnvironmentPreps(). | |
array | $extraInstallSteps = [] |
Extra steps for installation, for things like DatabaseInstallers to modify. | |
array | $internalDefaults |
Variables that are stored alongside globals, and are used for any configuration of the installation process aside from the MediaWiki configuration. | |
int | $minMemorySize = 50 |
Minimum memory size in MiB. | |
array | $objectCaches |
Known object cache types and the functions used to test for their existence. | |
ParserOptions | $parserOptions |
Cached ParserOptions, used by parse(). | |
Title | $parserTitle |
Cached Title, used by parse(). | |
array | $settings |
Additional Inherited Members | |
Static Public Member Functions inherited from Installer | |
static | apacheModulePresent ( $moduleName) |
Checks for presence of an Apache module. | |
static | getDBInstallerClass ( $type) |
Get the DatabaseInstaller class name for this type. | |
static | getDBTypes () |
Get a list of known DB types. | |
static | getExistingLocalSettings () |
Determine if LocalSettings.php exists. | |
static | getInstallerConfig (Config $baseConfig) |
Constructs a Config object that contains configuration settings that should be overwritten for the installation process. | |
static | maybeGetWebserverPrimaryGroup () |
On POSIX systems return the primary group of the webserver we're running under. | |
static | overrideConfig (SettingsBuilder $settings) |
Override the necessary bits of the config to run an installation. | |
Static Protected Attributes inherited from Installer | |
static array | $dbTypes |
Known database types. | |
Class for the core installer web interface.
Definition at line 33 of file WebInstaller.php.
WebInstaller::__construct | ( | WebRequest | $request | ) |
WebInstaller::envCheckPath | ( | ) |
Reimplemented from Installer.
Definition at line 1151 of file WebInstaller.php.
References $path, and showError().
|
protected |
Reimplemented from Installer.
Definition at line 1198 of file WebInstaller.php.
References Installer\getVar().
WebInstaller::envPrepPath | ( | ) |
Environment prep for setting $IP and $wgScriptPath.
Reimplemented from Installer.
Definition at line 1169 of file WebInstaller.php.
References $path, and Installer\setVar().
WebInstaller::errorHandler | ( | $errno, | |
$errstr ) |
Temporary error handler for session start debugging.
int | $errno | Unused |
string | $errstr |
Definition at line 409 of file WebInstaller.php.
WebInstaller::execute | ( | array | $session | ) |
Main entry point.
array[] | $session | Initial session array |
Definition at line 157 of file WebInstaller.php.
References $session, Installer\$settings, Installer\disableTimeLimit(), finish(), getLowestUnhappy(), getPageByName(), getUrl(), Installer\getVar(), outputCss(), and setupLanguage().
WebInstaller::finish | ( | ) |
Clean up from execute()
Definition at line 418 of file WebInstaller.php.
References $happyPages, $session, Installer\$settings, and $skippedPages.
Referenced by execute().
WebInstaller::getAcceptLanguage | ( | ) |
Retrieves MediaWiki language from Accept-Language HTTP header.
Definition at line 523 of file WebInstaller.php.
References $lang, $wgLanguageCode, and $wgRequest.
Referenced by setupLanguage().
WebInstaller::getCheckBox | ( | $params | ) |
Get a labelled checkbox to configure a boolean variable.
mixed[] | $params | Parameters are: var: The variable to be configured (required) label: The message name for the label (required) labelAttribs:Additional attributes for the label element (optional) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional) |
Definition at line 906 of file WebInstaller.php.
References Installer\getVar(), nextTabIndex(), Installer\parse(), and wfMessage().
WebInstaller::getDocUrl | ( | $page | ) |
Helper for WebInstallerOutput.
string | $page |
Reimplemented from Installer.
Definition at line 1095 of file WebInstaller.php.
References $currentPageName, and getUrl().
WebInstaller::getFingerprint | ( | ) |
Get a hash of data identifying this MW installation.
This is used by mw-config/index.php to prevent multiple installations of MW on the same cookie domain from interfering with each other.
Definition at line 365 of file WebInstaller.php.
References MW_VERSION, and serialize().
WebInstaller::getHelpBox | ( | $msg, | |
$args ) |
Get small text indented help for a preceding form field.
Parameters like wfMessage().
string | $msg | |
mixed | ...$args |
Definition at line 676 of file WebInstaller.php.
References $args, Installer\parse(), and wfMessage().
Referenced by showHelpBox().
WebInstaller::getInfoBox | ( | $text, | |
$icon = false, | |||
$class = '' ) |
Get HTML for an information message box with an icon.
string | HtmlArmor | $text | Wikitext to be parsed (from Message::plain) or raw HTML. |
string | false | $icon | Icon name, file in mw-config/images. Default: false |
string | $class | Additional class name to add to the wrapper div. Default: Empty string. |
Definition at line 655 of file WebInstaller.php.
References infoBox(), Installer\parse(), and wfMessage().
WebInstaller::getLocalSettingsLocation | ( | ) |
If the software package wants the LocalSettings.php file to be placed in a specific location, override this function (see mw-config/overrides/README) to return the path of where the file should be saved, or false for a generic "in the base of your install".
Definition at line 1144 of file WebInstaller.php.
WebInstaller::getLowestUnhappy | ( | ) |
Find the next page in sequence that hasn't been completed.
Definition at line 313 of file WebInstaller.php.
Referenced by execute().
WebInstaller::getPageByName | ( | $pageName | ) |
Get a WebInstallerPage by name.
string | $pageName |
Definition at line 462 of file WebInstaller.php.
Referenced by execute().
WebInstaller::getPasswordBox | ( | $params | ) |
Get a labelled password box to configure a variable.
Implements password hiding
mixed[] | $params | Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional) |
Definition at line 875 of file WebInstaller.php.
References Installer\getFakePassword(), getTextBox(), and Installer\getVar().
WebInstaller::getPhpErrors | ( | ) |
WebInstaller::getRadioElements | ( | $params | ) |
Get a set of labelled radio buttons.
You probably want to use getRadioSet(), not this.
mixed[] | $params |
Definition at line 995 of file WebInstaller.php.
References Installer\getVar(), nextTabIndex(), Installer\parse(), and wfMessage().
Referenced by getRadioSet().
WebInstaller::getRadioSet | ( | $params | ) |
Get a set of labelled radio buttons.
mixed[] | $params | Parameters are: var: The variable to be configured (required) label: The message name for the label (required) itemLabelPrefix: The message name prefix for the item labels (required) itemLabels: List of message names to use for the item labels instead of itemLabelPrefix, keyed by values values: List of allowed values (required) itemAttribs: Array of attribute arrays, outer key is the value name (optional) commonAttribs: Attribute array applied to all items controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional) |
Definition at line 964 of file WebInstaller.php.
References $s, getRadioElements(), and label().
WebInstaller::getSession | ( | $name, | |
$default = null ) |
Get a session variable.
string | $name | |
array | null | $default |
Definition at line 476 of file WebInstaller.php.
Referenced by setupLanguage().
WebInstaller::getTextArea | ( | $params | ) |
Get a labelled textarea to configure a variable.
mixed[] | $params | Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional) |
Definition at line 825 of file WebInstaller.php.
References Installer\getVar(), label(), and nextTabIndex().
WebInstaller::getTextBox | ( | $params | ) |
Get a labelled text box to configure a variable.
mixed[] | $params | Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional) |
Definition at line 778 of file WebInstaller.php.
References Installer\getVar(), label(), and nextTabIndex().
Referenced by getPasswordBox().
WebInstaller::getUrl | ( | $query = [] | ) |
Get a URL for submission back to the same script.
string[] | $query |
Definition at line 444 of file WebInstaller.php.
References wfArrayToCgi().
Referenced by execute(), getDocUrl(), and makeDownloadLinkHtml().
|
staticprotected |
Get HTML for an information message box with an icon.
string | $rawHtml | HTML |
string | $icon | Path to icon file (used as 'src' attribute) |
string | $alt | Alternate text for the icon |
string | $class | Additional class name to add to the wrapper div |
Definition at line 1247 of file WebInstaller.php.
References $s.
Referenced by getInfoBox().
WebInstaller::label | ( | $msg, | |
$forId, | |||
$contents, | |||
$helpData = "" ) |
Label a control by wrapping a config-input div around it and putting a label before it.
string | $msg | |
string | false | $forId | |
string | $contents | HTML |
string | $helpData |
Definition at line 736 of file WebInstaller.php.
References wfMessage().
Referenced by getRadioSet(), getTextArea(), and getTextBox().
WebInstaller::makeDownloadLinkHtml | ( | ) |
Helper for "Download LocalSettings" link.
Definition at line 1125 of file WebInstaller.php.
References getUrl(), Installer\parse(), and wfMessage().
WebInstaller::makeLinkItem | ( | $url, | |
$linkText ) |
Helper for sidebar links.
string | $url | |
string | $linkText |
Definition at line 1113 of file WebInstaller.php.
WebInstaller::nextTabIndex | ( | ) |
Get the next tabindex attribute value.
Definition at line 495 of file WebInstaller.php.
Referenced by getCheckBox(), getRadioElements(), getTextArea(), and getTextBox().
WebInstaller::outputCss | ( | ) |
Output stylesheet for web installer pages.
Definition at line 1225 of file WebInstaller.php.
Referenced by execute().
WebInstaller::reset | ( | ) |
We're restarting the installation, reset the session, happyPages, etc.
Definition at line 431 of file WebInstaller.php.
WebInstaller::setSession | ( | $name, | |
$value ) |
Set a session variable.
string | $name | Key for the variable |
mixed | $value |
Definition at line 486 of file WebInstaller.php.
WebInstaller::setupLanguage | ( | ) |
Initializes language-related variables.
Definition at line 502 of file WebInstaller.php.
References $wgLang, $wgLanguageCode, getAcceptLanguage(), getSession(), Installer\getVar(), and Installer\setVar().
Referenced by execute().
WebInstaller::setVarsFromRequest | ( | $varNames, | |
$prefix = 'config_' ) |
Convenience function to set variables based on form data.
Assumes that variables containing "password" in the name are (potentially fake) passwords.
string[] | $varNames | |
string | $prefix | The prefix added to variables to obtain form names |
Definition at line 1064 of file WebInstaller.php.
References Installer\setPassword(), and Installer\setVar().
WebInstaller::showError | ( | $msg, | |
$params ) |
Show an error message in a box.
Parameters are like wfMessage(), or alternatively, pass a Message object in.
string | Message | $msg | |
mixed | ...$params |
Reimplemented from Installer.
Definition at line 391 of file WebInstaller.php.
References wfMessage().
Referenced by envCheckPath().
WebInstaller::showHelpBox | ( | $msg, | |
$params ) |
Output a help box.
string | $msg | Key for wfMessage() |
mixed | ...$params |
Definition at line 696 of file WebInstaller.php.
References getHelpBox().
WebInstaller::showMessage | ( | $msg, | |
$params ) |
Show a short informational message.
Output looks like a list.
string | $msg | |
mixed | ...$params |
Reimplemented from Installer.
Definition at line 708 of file WebInstaller.php.
References Installer\parse(), and wfMessage().
Referenced by showStatusMessage().
WebInstaller::showStatusBox | ( | $status | ) |
Output an error or warning box using a Status object.
Status | $status |
Definition at line 1040 of file WebInstaller.php.
WebInstaller::showStatusMessage | ( | Status | $status | ) |
Status | $status |
Reimplemented from Installer.
Definition at line 718 of file WebInstaller.php.
References Status\getErrorsArray(), Status\getWarningsArray(), and showMessage().
WebInstaller::startSession | ( | ) |
Start the PHP session.
This may be called before execute() to start the PHP session.
Exception |
Definition at line 327 of file WebInstaller.php.
References wfIniGetBool().
|
protected |
Name of the page we're on.
Definition at line 139 of file WebInstaller.php.
Referenced by getDocUrl().
|
protected |
Array of pages which have declared that they have been submitted, have validated their input, and need no further processing.
Definition at line 102 of file WebInstaller.php.
Referenced by finish().
|
protected |
Numeric index of the help box.
Definition at line 132 of file WebInstaller.php.
|
protected |
Out of sequence pages, selectable by the user at any time.
Definition at line 89 of file WebInstaller.php.
WebInstallerOutput WebInstaller::$output |
Definition at line 38 of file WebInstaller.php.
string [] WebInstaller::$pageSequence |
The main sequence of page names.
These will be displayed in turn.
To add a new installer page:
Definition at line 71 of file WebInstaller.php.
|
protected |
Captured PHP error text.
Temporary.
Definition at line 59 of file WebInstaller.php.
Referenced by getPhpErrors().
WebRequest WebInstaller::$request |
|
protected |
Cached session array.
Definition at line 52 of file WebInstaller.php.
bool WebInstaller::$showSessionWarning = false |
Flag indicating that session data may have been lost.
Definition at line 118 of file WebInstaller.php.
|
protected |
List of "skipped" pages.
These are pages that will automatically continue to the next page on any GET request. To avoid breaking the "back" button, they need to be skipped during a back operation.
Definition at line 111 of file WebInstaller.php.
Referenced by finish().
|
protected |
Numeric index of the page we're on.
Definition at line 125 of file WebInstaller.php.