MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
36  public static $minimumVersion = '3.8.0';
37  protected static $notMiniumumVerisonMessage = 'config-outdated-sqlite';
42  public $db;
44  protected $globalNames = [
45  'wgDBname',
46  'wgSQLiteDataDir',
47  ];
49  public function getName() {
50  return 'sqlite';
51  }
53  public function isCompiled() {
54  return self::checkExtension( 'pdo_sqlite' );
55  }
61  public function checkPrerequisites() {
62  // Bail out if SQLite is too old
63  $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
64  $result = static::meetsMinimumRequirement( $db->getServerVersion() );
65  // Check for FTS3 full-text search module
66  if ( DatabaseSqlite::getFulltextSearchModule() != 'FTS3' ) {
67  $result->warning( 'config-no-fts3' );
68  }
70  return $result;
71  }
73  public function getGlobalDefaults() {
74  $defaults = parent::getGlobalDefaults();
75  if ( isset( $_SERVER['DOCUMENT_ROOT'] ) ) {
76  $path = str_replace(
77  [ '/', '\\' ],
79  dirname( $_SERVER['DOCUMENT_ROOT'] ) . '/data'
80  );
82  $defaults['wgSQLiteDataDir'] = $path;
83  }
84  return $defaults;
85  }
87  public function getConnectForm() {
88  return $this->getTextBox(
89  'wgSQLiteDataDir',
90  'config-sqlite-dir', [],
91  $this->parent->getHelpBox( 'config-sqlite-dir-help' )
92  ) .
93  $this->getTextBox(
94  'wgDBname',
95  'config-db-name',
96  [],
97  $this->parent->getHelpBox( 'config-sqlite-name-help' )
98  );
99  }
108  private static function realpath( $path ) {
109  $result = realpath( $path );
110  if ( !$result ) {
111  return $path;
112  }
114  return $result;
115  }
120  public function submitConnectForm() {
121  $this->setVarsFromRequest( [ 'wgSQLiteDataDir', 'wgDBname' ] );
123  # Try realpath() if the directory already exists
124  $dir = self::realpath( $this->getVar( 'wgSQLiteDataDir' ) );
125  $result = self::dataDirOKmaybeCreate( $dir, true /* create? */ );
126  if ( $result->isOK() ) {
127  # Try expanding again in case we've just created it
128  $dir = self::realpath( $dir );
129  $this->setVar( 'wgSQLiteDataDir', $dir );
130  }
131  # Table prefix is not used on SQLite, keep it empty
132  $this->setVar( 'wgDBprefix', '' );
134  return $result;
135  }
142  private static function dataDirOKmaybeCreate( $dir, $create = false ) {
143  if ( !is_dir( $dir ) ) {
144  if ( !is_writable( dirname( $dir ) ) ) {
145  $webserverGroup = Installer::maybeGetWebserverPrimaryGroup();
146  if ( $webserverGroup !== null ) {
147  return Status::newFatal(
148  'config-sqlite-parent-unwritable-group',
149  $dir, dirname( $dir ), basename( $dir ),
150  $webserverGroup
151  );
152  } else {
153  return Status::newFatal(
154  'config-sqlite-parent-unwritable-nogroup',
155  $dir, dirname( $dir ), basename( $dir )
156  );
157  }
158  }
160  # Called early on in the installer, later we just want to sanity check
161  # if it's still writable
162  if ( $create ) {
163  Wikimedia\suppressWarnings();
164  $ok = wfMkdirParents( $dir, 0700, __METHOD__ );
165  Wikimedia\restoreWarnings();
166  if ( !$ok ) {
167  return Status::newFatal( 'config-sqlite-mkdir-error', $dir );
168  }
169  # Put a .htaccess file in in case the user didn't take our advice
170  file_put_contents( "$dir/.htaccess", "Deny from all\n" );
171  }
172  }
173  if ( !is_writable( $dir ) ) {
174  return Status::newFatal( 'config-sqlite-dir-unwritable', $dir );
175  }
177  # We haven't blown up yet, fall through
178  return Status::newGood();
179  }
184  public function openConnection() {
186  $dir = $this->getVar( 'wgSQLiteDataDir' );
187  $dbName = $this->getVar( 'wgDBname' );
188  try {
189  # @todo FIXME: Need more sensible constructor parameters, e.g. single associative array
190  $db = Database::factory( 'sqlite', [ 'dbname' => $dbName, 'dbDirectory' => $dir ] );
191  $status->value = $db;
192  } catch ( DBConnectionError $e ) {
193  $status->fatal( 'config-sqlite-connection-error', $e->getMessage() );
194  }
196  return $status;
197  }
202  public function needsUpgrade() {
203  $dir = $this->getVar( 'wgSQLiteDataDir' );
204  $dbName = $this->getVar( 'wgDBname' );
205  // Don't create the data file yet
206  if ( !file_exists( DatabaseSqlite::generateFileName( $dir, $dbName ) ) ) {
207  return false;
208  }
210  // If the data file exists, look inside it
211  return parent::needsUpgrade();
212  }
217  public function setupDatabase() {
218  $dir = $this->getVar( 'wgSQLiteDataDir' );
220  # Sanity check. We checked this before but maybe someone deleted the
221  # data dir between then and now
222  $dir_status = self::dataDirOKmaybeCreate( $dir, false /* create? */ );
223  if ( !$dir_status->isOK() ) {
224  return $dir_status;
225  }
227  $db = $this->getVar( 'wgDBname' );
229  # Make the main and cache stub DB files
231  $status->merge( $this->makeStubDBFile( $dir, $db ) );
232  $status->merge( $this->makeStubDBFile( $dir, "wikicache" ) );
233  $status->merge( $this->makeStubDBFile( $dir, "{$db}_l10n_cache" ) );
234  $status->merge( $this->makeStubDBFile( $dir, "{$db}_jobqueue" ) );
235  if ( !$status->isOK() ) {
236  return $status;
237  }
239  # Nuke the unused settings for clarity
240  $this->setVar( 'wgDBserver', '' );
241  $this->setVar( 'wgDBuser', '' );
242  $this->setVar( 'wgDBpassword', '' );
243  $this->setupSchemaVars();
245  # Create the global cache DB
246  try {
247  $conn = Database::factory(
248  'sqlite', [ 'dbname' => 'wikicache', 'dbDirectory' => $dir ] );
249  # @todo: don't duplicate objectcache definition, though it's very simple
250  $sql =
251 <<<EOT
252  CREATE TABLE IF NOT EXISTS objectcache (
253  keyname BLOB NOT NULL default '' PRIMARY KEY,
254  value BLOB,
255  exptime TEXT
256  )
257 EOT;
258  $conn->query( $sql );
259  $conn->query( "CREATE INDEX IF NOT EXISTS exptime ON objectcache (exptime)" );
260  $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
261  $conn->close();
262  } catch ( DBConnectionError $e ) {
263  return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
264  }
266  # Create the l10n cache DB
267  try {
268  $conn = Database::factory(
269  'sqlite', [ 'dbname' => "{$db}_l10n_cache", 'dbDirectory' => $dir ] );
270  # @todo: don't duplicate l10n_cache definition, though it's very simple
271  $sql =
272 <<<EOT
273  CREATE TABLE l10n_cache (
274  lc_lang BLOB NOT NULL,
275  lc_key TEXT NOT NULL,
276  lc_value BLOB NOT NULL,
277  PRIMARY KEY (lc_lang, lc_key)
278  );
279 EOT;
280  $conn->query( $sql );
281  $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
282  $conn->close();
283  } catch ( DBConnectionError $e ) {
284  return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
285  }
287  # Create the job queue DB
288  try {
289  $conn = Database::factory(
290  'sqlite', [ 'dbname' => "{$db}_jobqueue", 'dbDirectory' => $dir ] );
291  # @todo: don't duplicate job definition, though it's very static
292  $sql =
293 <<<EOT
294  CREATE TABLE job (
296  job_cmd BLOB NOT NULL default '',
297  job_namespace INTEGER NOT NULL,
298  job_title TEXT NOT NULL,
299  job_timestamp BLOB NULL default NULL,
300  job_params BLOB NOT NULL,
301  job_random integer NOT NULL default 0,
302  job_attempts integer NOT NULL default 0,
303  job_token BLOB NOT NULL default '',
304  job_token_timestamp BLOB NULL default NULL,
305  job_sha1 BLOB NOT NULL default ''
306  );
307  CREATE INDEX job_sha1 ON job (job_sha1);
308  CREATE INDEX job_cmd_token ON job (job_cmd,job_token,job_random);
309  CREATE INDEX job_cmd_token_id ON job (job_cmd,job_token,job_id);
310  CREATE INDEX job_cmd ON job (job_cmd, job_namespace, job_title, job_params);
311  CREATE INDEX job_timestamp ON job (job_timestamp);
312 EOT;
313  $conn->query( $sql );
314  $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
315  $conn->close();
316  } catch ( DBConnectionError $e ) {
317  return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
318  }
320  # Open the main DB
321  return $this->getConnection();
322  }
329  protected function makeStubDBFile( $dir, $db ) {
330  $file = DatabaseSqlite::generateFileName( $dir, $db );
331  if ( file_exists( $file ) ) {
332  if ( !is_writable( $file ) ) {
333  return Status::newFatal( 'config-sqlite-readonly', $file );
334  }
335  } elseif ( file_put_contents( $file, '' ) === false ) {
336  return Status::newFatal( 'config-sqlite-cant-create-db', $file );
337  }
339  return Status::newGood();
340  }
345  public function createTables() {
346  $status = parent::createTables();
348  return $this->setupSearchIndex( $status );
349  }
355  public function setupSearchIndex( &$status ) {
356  global $IP;
358  $module = DatabaseSqlite::getFulltextSearchModule();
359  $fts3tTable = $this->db->checkForEnabledSearch();
360  if ( $fts3tTable && !$module ) {
361  $status->warning( 'config-sqlite-fts3-downgrade' );
362  $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
363  } elseif ( !$fts3tTable && $module == 'FTS3' ) {
364  $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
365  }
367  return $status;
368  }
373  public function getLocalSettings() {
374  $dir = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
375  // These tables have frequent writes and are thus split off from the main one.
376  // Since the code using these tables only uses transactions for writes then set
377  // them to using BEGIN IMMEDIATE. This avoids frequent lock errors on first write.
378  return "# SQLite-specific settings
379 \$wgSQLiteDataDir = \"{$dir}\";
380 \$wgObjectCaches[CACHE_DB] = [
381  'class' => SqlBagOStuff::class,
382  'loggroup' => 'SQLBagOStuff',
383  'server' => [
384  'type' => 'sqlite',
385  'dbname' => 'wikicache',
386  'tablePrefix' => '',
387  'variables' => [ 'synchronous' => 'NORMAL' ],
388  'dbDirectory' => \$wgSQLiteDataDir,
389  'trxMode' => 'IMMEDIATE',
390  'flags' => 0
391  ]
392 ];
393 \$wgLocalisationCacheConf['storeServer'] = [
394  'type' => 'sqlite',
395  'dbname' => \"{\$wgDBname}_l10n_cache\",
396  'tablePrefix' => '',
397  'variables' => [ 'synchronous' => 'NORMAL' ],
398  'dbDirectory' => \$wgSQLiteDataDir,
399  'trxMode' => 'IMMEDIATE',
400  'flags' => 0
401 ];
402 \$wgJobTypeConf['default'] = [
403  'class' => 'JobQueueDB',
404  'claimTTL' => 3600,
405  'server' => [
406  'type' => 'sqlite',
407  'dbname' => \"{\$wgDBname}_jobqueue\",
408  'tablePrefix' => '',
409  'dbDirectory' => \$wgSQLiteDataDir,
410  'trxMode' => 'IMMEDIATE',
411  'flags' => 0
412  ]
413 ];";
414  }
415 }
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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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:1266
makeStubDBFile( $dir, $db)
Definition: SqliteInstaller.php:329
Relational database abstraction object.
Definition: Database.php:48
Definition: SqliteInstaller.php:217
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
Definition: DatabaseSqlite.php:38
Class for setting up the MediaWiki database using SQLLite.
Definition: SqliteInstaller.php:34
Definition: SqliteInstaller.php:184
static checkExtension( $name)
Convenience function.
Definition: DatabaseInstaller.php:441
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
Definition: GlobalFunctions.php:2008
static dataDirOKmaybeCreate( $dir, $create=false)
Definition: SqliteInstaller.php:142
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1983
Connect to the database using the administrative user/password currently defined in the session.
Definition: DatabaseInstaller.php:181
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
getTextBox( $var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
Definition: DatabaseInstaller.php:513
Definition: DatabaseSqlite.php:774
if( $inline) $status value
Definition: SyntaxHighlight.php:345
Get HTML for a web form that configures this database.
Definition: SqliteInstaller.php:87
Definition: SqliteInstaller.php:53
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
Definition: SqliteInstaller.php:44
static realpath( $path)
Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
Definition: SqliteInstaller.php:108
Definition: update.php:3
Set appropriate schema variables in the current database connection.
Definition: DatabaseInstaller.php:341
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
Definition: MIT-LICENSE.txt:10
Definition: SqliteInstaller.php:355
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2162
Definition: SqliteInstaller.php:120
getVar( $var, $default=null)
Get a variable, taking local defaults into account.
Definition: DatabaseInstaller.php:483
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Definition: SqliteInstaller.php:345
Base class for DBMS-specific installation helper classes.
Definition: DatabaseInstaller.php:35
static $notMiniumumVerisonMessage
Definition: SqliteInstaller.php:37
Get a name=>value map of MW configuration globals for the default values.
Definition: SqliteInstaller.php:73
Definition: SqliteInstaller.php:61
Definition: SqliteInstaller.php:373
Return the internal name, e.g.
Definition: SqliteInstaller.php:49
Definition: NoLocalSettings.php:25
Definition: SqliteInstaller.php:202
setVar( $name, $value)
Convenience alias for $this->parent->setVar()
Definition: DatabaseInstaller.php:500
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
Definition: DatabaseInstaller.php:606
Definition: DBConnectionError.php:26
static $minimumVersion
Definition: SqliteInstaller.php:36
static escapePhpString( $string)
Returns the escaped version of a string of php code.
Definition: LocalSettingsGenerator.php:112
DatabaseSqlite $db
Definition: SqliteInstaller.php:42
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
Definition: Installer.php:658