Go to the documentation of this file.
68 abstract public function getName();
161 $this->db->clearFlag(
DBO_TRX );
162 $this->db->commit( __METHOD__ );
179 $archiveTableMustNotExist =
false
185 $this->db->selectDB( $this->
getVar(
'wgDBname' ) );
187 if ( $archiveTableMustNotExist && $this->db->tableExists(
'archive', __METHOD__ ) ) {
188 $status->warning(
"config-$stepName-tables-exist" );
195 $this->db->begin( __METHOD__ );
197 $error = $this->db->sourceFile(
198 call_user_func( [ $this, $sourceFileMethod ], $this->db )
200 if ( $error !==
true ) {
201 $this->db->reportQueryError( $error, 0,
'', __METHOD__ );
202 $this->db->rollback( __METHOD__ );
203 $status->fatal(
"config-$stepName-tables-failed", $error );
205 $this->db->commit( __METHOD__ );
244 $dbmsSpecificFilePath =
"$IP/maintenance/" .
$db->
getType() .
"/$filename";
245 if ( file_exists( $dbmsSpecificFilePath ) ) {
246 return $dbmsSpecificFilePath;
248 return "$IP/maintenance/$filename";
317 $msg = __METHOD__ .
': unexpected error while establishing'
318 .
' a database connection with message: '
319 .
$status->getMessage()->plain();
332 throw new MWException( __METHOD__ .
': unexpected DB connection error' );
335 \MediaWiki\MediaWikiServices::resetGlobalInstance();
336 $services = \MediaWiki\MediaWikiServices::getInstance();
339 $services->redefineService(
'DBLoadBalancerFactory',
function()
use ( $connection ) {
340 return LBFactorySingle::newFromConnection( $connection );
354 ob_start( [ $this,
'outputHandler' ] );
359 echo
"\nAn error occurred:\n";
362 }
catch ( Exception
$e ) {
363 echo
"\nAn error occurred:\n";
364 echo
$e->getMessage();
412 return extension_loaded(
$name );
453 public function getVar( $var, $default =
null ) {
456 if ( isset( $defaults[$var] ) ) {
457 $default = $defaults[$var];
458 } elseif ( isset( $internal[$var] ) ) {
459 $default = $internal[$var];
462 return $this->parent->getVar( $var, $default );
490 return $this->parent->getTextBox( [
494 'controlName' =>
$name,
517 return $this->parent->getPasswordBox( [
521 'controlName' =>
$name,
540 return $this->parent->getCheckBox( [
544 'controlName' =>
$name,
566 return $this->parent->getRadioSet(
$params );
577 return $this->parent->setVarsFromRequest( $varNames, $this->
getName() .
'_' );
596 if ( !$this->db->selectDB( $this->getVar(
'wgDBname' ) ) ) {
600 return $this->db->tableExists(
'cur', __METHOD__ ) ||
601 $this->db->tableExists(
'revision', __METHOD__ );
614 'config-db-username',
616 $this->parent->getHelpBox(
'config-db-install-username' )
620 'config-db-password',
622 $this->parent->getHelpBox(
'config-db-install-password' )
645 $wrapperStyle = $this->
getVar(
'_SameAccount' ) ?
'display: none' :
'';
649 '_SameAccount',
'config-db-web-account-same',
650 [
'class' =>
'hideShowRadio',
'rel' =>
'dbOtherAccount' ]
652 Html::openElement(
'div', [
'id' =>
'dbOtherAccount',
'style' => $wrapperStyle ] ) .
653 $this->
getTextBox(
'wgDBuser',
'config-db-username' ) .
655 $this->parent->getHelpBox(
'config-db-web-help' );
656 if ( $noCreateMsg ) {
659 $s .= $this->
getCheckBox(
'_CreateDBAccount',
'config-db-web-create' );
673 [
'wgDBuser',
'wgDBpassword',
'_SameAccount',
'_CreateDBAccount' ]
676 if ( $this->
getVar(
'_SameAccount' ) ) {
677 $this->
setVar(
'wgDBuser', $this->
getVar(
'_InstallUser' ) );
678 $this->
setVar(
'wgDBpassword', $this->
getVar(
'_InstallPassword' ) );
681 if ( $this->
getVar(
'_CreateDBAccount' ) && strval( $this->
getVar(
'wgDBpassword' ) ) ==
'' ) {
698 $this->db->selectDB( $this->
getVar(
'wgDBname' ) );
700 if ( $this->db->selectRow(
'interwiki',
'*', [], __METHOD__ ) ) {
701 $status->warning(
'config-install-interwiki-exists' );
706 MediaWiki\suppressWarnings();
707 $rows =
file(
"$IP/maintenance/interwiki.list",
708 FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
709 MediaWiki\restoreWarnings();
714 foreach ( $rows
as $row ) {
715 $row = preg_replace(
'/^\s*([^#]*?)\s*(#.*)?$/',
'\\1', $row );
720 $interwikis[] = array_combine(
721 [
'iw_prefix',
'iw_url',
'iw_local',
'iw_api',
'iw_wikiid' ],
725 $this->db->insert(
'interwiki', $interwikis, __METHOD__ );
731 return htmlspecialchars( $string );
array $globalNames
Array of MW configuration globals this class uses.
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
static checkExtension( $name)
Convenience function.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
doUpgrade()
Perform database upgrades.
Class for the core installer web interface.
getConnection()
Connect to the database using the administrative user/password currently defined in the session.
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
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static newFatal( $message)
Factory function for fatal errors.
getTextBox( $var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
checkPrerequisites()
Checks for installation prerequisites other than those checked by isCompiled()
getSchemaVars()
Override this to provide DBMS-specific schema variables, to be substituted into tables....
Allows to change the fields on the form that will be generated $name
preUpgrade()
Allow DB installers a chance to make checks before upgrade.
preInstall()
Allow DB installers a chance to make last-minute changes before installation occurs.
submitSettingsForm()
Set variables based on the request array, assuming it was submitted via the form return by getSetting...
getLocalSettings()
Get the DBMS-specific options for LocalSettings.php generation.
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
getReadableName()
Get the internationalised name for this DBMS.
createTables()
Create database tables from scratch.
getInternalDefaults()
Get a name=>value map of internal variables used during installation.
static closeElement( $element)
Returns "</$element>".
getSqlFilePath( $db, $filename)
Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file.
getConnectForm()
Get HTML for a web form that configures this database.
getPasswordBox( $var, $label, $attribs=[], $helpData="")
Get a labelled password box to configure a local variable.
submitConnectForm()
Set variables based on the request array, assuming it was submitted via the form returned by getConne...
getUpdateKeysPath( $db)
Return a path to the DBMS-specific update key file, otherwise default to update-keys....
submitWebUserBox()
Submit the form from getWebUserBox().
getName()
Return the internal name, e.g.
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
setupSchemaVars()
Set appropriate schema variables in the current database connection.
when a variable name is used in a it is silently declared as a new masking the global
getSchemaPath( $db)
Return a path to the DBMS-specific schema file, otherwise default to tables.sql.
$GLOBALS['wgAutoloadClasses']['LocalisationUpdate']
getWebUserBox( $noCreateMsg=false)
Get a standard web-user fieldset.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
getRadioSet( $params)
Get a set of labelled radio buttons.
stepApplySourceFile( $sourceFileMethod, $stepName, $archiveTableMustNotExist=false)
Apply a SQL source file to the database as part of running an installation step.
getGlobalDefaults()
Get a name=>value map of MW configuration globals for the default values.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static newForDB(Database $db, $shared=false, $maintenance=null)
getVar( $var, $default=null)
Get a variable, taking local defaults into account.
static newGood( $value=null)
Factory function for good results.
createExtensionTables()
Create the tables for each extension the user enabled.
submitInstallUserBox()
Submit a standard install user fieldset.
Base class for DBMS-specific installation helper classes.
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
getGlobalNames()
Get an array of MW configuration globals that will be configured by this class.
getSettingsForm()
Get HTML for a web form that retrieves settings used for installation.
openConnection()
Open a connection to the database using the administrative user/password currently defined in the ses...
enableLB()
Set up LBFactory so that wfGetDB() etc.
populateInterwikiTable()
Common function for databases that don't understand the MySQLish syntax of interwiki....
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
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
setVar( $name, $value)
Convenience alias for $this->parent->setVar()
getInstallUserBox()
Get a standard install-user fieldset.
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
WebInstaller $parent
The Installer object.
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 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 "<
Database $db
The database connection.
setupDatabase()
Create the database and return a Status object indicating success or failure.
insertUpdateKeys()
Insert update keys into table to prevent running unneded updates.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
array $internalDefaults
Internal variables for installation.
getCheckBox( $var, $label, $attribs=[], $helpData="")
Get a labelled checkbox to configure a local boolean variable.
the array() calling protocol came about after MediaWiki 1.4rc1.
__construct( $parent)
Construct and initialise parent.
needsUpgrade()
Determine whether an existing installation of MediaWiki is present in the configured administrative c...