Go to the documentation of this file.
30 use InvalidArgumentException;
71 if ( isset( $p[
'dbFilePath'] ) ) {
72 $this->dbPath = $p[
'dbFilePath'];
73 $lockDomain = md5( $this->dbPath );
75 if ( !isset( $p[
'dbname'] ) || !strlen( $p[
'dbname'] ) ) {
76 $p[
'dbname'] = preg_replace(
'/\.sqlite\d?$/',
'', basename( $this->dbPath ) );
78 } elseif ( isset( $p[
'dbDirectory'] ) ) {
79 $this->dbDir = $p[
'dbDirectory'];
80 $lockDomain = $p[
'dbname'];
82 throw new InvalidArgumentException(
"Need 'dbDirectory' or 'dbFilePath' parameter." );
85 $this->trxMode = isset( $p[
'trxMode'] ) ? strtoupper( $p[
'trxMode'] ) :
null;
86 if ( $this->trxMode &&
87 !in_array( $this->trxMode, [
'DEFERRED',
'IMMEDIATE',
'EXCLUSIVE' ] )
89 $this->trxMode =
null;
90 $this->queryLogger->warning(
"Invalid SQLite transaction mode provided." );
94 'domain' => $lockDomain,
95 'lockDirectory' =>
"{$this->dbDir}/locks"
98 parent::__construct( $p );
102 return [ self::ATTR_DB_LEVEL_LOCKING =>
true ];
115 $p[
'dbFilePath'] = $filename;
117 $p[
'tablePrefix'] =
'';
125 if ( $this->dbPath !==
null ) {
129 $this->connectionParams[
'dbname'],
130 $this->connectionParams[
'tablePrefix']
132 } elseif ( $this->dbDir !==
null ) {
134 if ( strlen( $this->connectionParams[
'dbname'] ) ) {
136 $this->connectionParams[
'host'],
137 $this->connectionParams[
'user'],
138 $this->connectionParams[
'password'],
139 $this->connectionParams[
'dbname'],
140 $this->connectionParams[
'schema'],
141 $this->connectionParams[
'tablePrefix']
145 $this->connLogger->debug( __METHOD__ .
': no database opened.' );
148 throw new InvalidArgumentException(
"Need 'dbDirectory' or 'dbFilePath' parameter." );
171 if ( !is_readable( $fileName ) ) {
176 $this->
openFile( $fileName, $dbName, $tablePrefix );
190 protected function openFile( $fileName, $dbName, $tablePrefix ) {
193 $this->dbPath = $fileName;
196 $this->conn =
new PDO(
"sqlite:$fileName",
'',
'',
197 [ PDO::ATTR_PERSISTENT =>
true ] );
199 $this->conn =
new PDO(
"sqlite:$fileName",
'',
'' );
201 }
catch ( PDOException
$e ) {
202 $err =
$e->getMessage();
205 if ( !$this->conn ) {
206 $this->queryLogger->debug(
"DB connection error: $err\n" );
210 $this->opened = is_object( $this->conn );
211 if ( $this->opened ) {
212 $this->currentDomain =
new DatabaseDomain( $dbName,
null, $tablePrefix );
213 # Set error codes only, don't raise exceptions
214 $this->conn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT );
215 # Enforce LIKE to be case sensitive, just like MySQL
216 $this->
query(
'PRAGMA case_sensitive_like = 1' );
249 return "$dir/$dbName.sqlite";
257 if ( self::$fulltextEnabled ===
null ) {
258 self::$fulltextEnabled =
false;
259 $table = $this->
tableName(
'searchindex' );
260 $res = $this->
query(
"SELECT sql FROM sqlite_master WHERE tbl_name = '$table'", __METHOD__ );
262 $row =
$res->fetchRow();
263 self::$fulltextEnabled = stristr( $row[
'sql'],
'fts' ) !==
false;
275 static $cachedResult =
null;
276 if ( $cachedResult !==
null ) {
277 return $cachedResult;
279 $cachedResult =
false;
280 $table =
'dummy_search_test';
283 if ( $db->query(
"CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__,
true ) ) {
284 $cachedResult =
'FTS3';
288 return $cachedResult;
308 return $this->
query(
"ATTACH DATABASE $file AS $name",
$fname );
312 return parent::isWriteQuery( $sql ) && !preg_match(
'/^(ATTACH|PRAGMA)\b/i', $sql );
316 return parent::isTransactableQuery( $sql ) && !in_array(
318 [
'ATTACH',
'PRAGMA' ],
331 if (
$res ===
false ) {
336 $this->lastAffectedRowCount = $r->rowCount();
364 $cur = current( $r );
365 if ( is_array( $cur ) ) {
368 foreach ( $cur
as $k => $v ) {
369 if ( !is_numeric( $k ) ) {
390 $cur = current( $r );
391 if ( is_array( $cur ) ) {
410 return is_array( $r ) ?
count( $r ) : 0;
419 if ( is_array( $r ) &&
count( $r ) > 0 ) {
421 return count( $r[0] ) / 2;
435 if ( is_array( $r ) ) {
436 $keys = array_keys( $r[0] );
453 if ( strpos(
$name,
'sqlite_' ) === 0 ) {
482 for ( $i = 0; $i < $row; $i++ ) {
492 if ( !is_object( $this->conn ) ) {
493 return "Cannot return last error, no db connection";
495 $e = $this->conn->errorInfo();
504 if ( !is_object( $this->conn ) ) {
505 return "Cannot return last error, no db connection";
507 $info = $this->conn->errorInfo();
521 $tableRaw = $this->
tableName( $table,
'raw' );
522 if ( isset( $this->sessionTempTables[$tableRaw] ) ) {
526 $encTable = $this->
addQuotes( $tableRaw );
528 "SELECT 1 FROM sqlite_master WHERE type='table' AND name=$encTable" );
530 return $res->numRows() ?
true :
false;
546 if ( !
$res ||
$res->numRows() == 0 ) {
550 foreach (
$res as $row ) {
551 $info[] = $row->name;
564 $row = $this->
selectRow(
'sqlite_master',
'*',
569 if ( !$row || !isset( $row->sql ) ) {
574 $indexPos = strpos( $row->sql,
'INDEX' );
575 if ( $indexPos ===
false ) {
578 $firstPart = substr( $row->sql, 0, $indexPos );
579 $options = explode(
' ', $firstPart );
581 return in_array(
'UNIQUE',
$options );
592 if ( is_numeric( $k ) && ( $v ==
'FOR UPDATE' || $v ==
'LOCK IN SHARE MODE' ) ) {
597 return parent::makeSelectOptions(
$options );
616 # SQLite uses OR IGNORE not just IGNORE
618 if ( $v ==
'IGNORE' ) {
633 return parent::makeInsertOptions(
$options );
645 if ( !
count( $a ) ) {
649 # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts
650 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
652 foreach ( $a
as $v ) {
676 # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries
677 if ( isset(
$rows[0] ) && is_array(
$rows[0] ) ) {
680 if ( !$this->
nativeReplace( $table, $v,
"$fname/multi-row" ) ) {
716 $glue = $all ?
' UNION ALL ' :
' UNION ';
718 return implode( $glue, $sqls );
751 return "[{{int:version-db-sqlite-url}} SQLite]";
773 $sql =
'PRAGMA table_info(' . $this->
addQuotes( $tableName ) .
')';
775 foreach (
$res as $row ) {
776 if ( $row->name == $field ) {
785 if ( $this->trxMode ) {
806 return new Blob( $b );
814 if ( $b instanceof
Blob ) {
826 if (
$s instanceof
Blob ) {
827 return "x'" . bin2hex(
$s->fetch() ) .
"'";
828 } elseif ( is_bool(
$s ) ) {
830 } elseif ( strpos( (
string)
$s,
"\0" ) !==
false ) {
840 $this->queryLogger->debug(
842 ': Quoting value containing null byte. ' .
843 'For consistency all binary data should have been ' .
844 'first processed with self::encodeBlob()'
846 return "x'" . bin2hex( (
string)
$s ) .
"'";
855 if ( $length !==
null ) {
858 return 'SUBSTR(' . implode(
',',
$params ) .
')';
867 return 'CAST ( ' . $field .
' AS TEXT )';
876 $args = func_get_args();
877 $function = array_shift(
$args );
879 return $function( ...
$args );
887 $s = parent::replaceVars(
$s );
888 if ( preg_match(
'/^\s*(CREATE|ALTER) TABLE/i',
$s ) ) {
892 $s = preg_replace(
'/\b(var)?binary(\(\d+\))/i',
'BLOB',
$s );
894 $s = preg_replace(
'/\b(un)?signed\b/i',
'',
$s );
896 $s = preg_replace(
'/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i',
'INTEGER',
$s );
899 '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i',
904 $s = preg_replace(
'/\b(var)?char\s*\(.*?\)/i',
'TEXT',
$s );
906 $s = preg_replace(
'/\b(tiny|medium|long)text\b/i',
'TEXT',
$s );
908 $s = preg_replace(
'/\b(tiny|small|medium|long|)blob\b/i',
'BLOB',
$s );
910 $s = preg_replace(
'/\bbool(ean)?\b/i',
'INTEGER',
$s );
912 $s = preg_replace(
'/\b(datetime|timestamp)\b/i',
'TEXT',
$s );
914 $s = preg_replace(
'/\benum\s*\([^)]*\)/i',
'TEXT',
$s );
916 $s = preg_replace(
'/\bbinary\b/i',
'',
$s );
918 $s = preg_replace(
'/\bauto_increment\b/i',
'AUTOINCREMENT',
$s );
920 $s = preg_replace(
'/\)[^);]*(;?)\s*$/',
')\1',
$s );
922 $s = preg_replace(
'/primary key (.*?) autoincrement/i',
'PRIMARY KEY AUTOINCREMENT $1',
$s );
923 } elseif ( preg_match(
'/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i',
$s ) ) {
925 $s = preg_replace(
'/\(\d+\)/',
'',
$s );
927 $s = preg_replace(
'/\bfulltext\b/i',
'',
$s );
928 } elseif ( preg_match(
'/^\s*DROP INDEX/i',
$s ) ) {
930 $s = preg_replace(
'/\sON\s+[^\s]*/i',
'',
$s );
931 } elseif ( preg_match(
'/^\s*INSERT IGNORE\b/i',
$s ) ) {
933 $s = preg_replace(
'/^\s*INSERT IGNORE\b/i',
'INSERT OR IGNORE',
$s );
939 public function lock( $lockName, $method, $timeout = 5 ) {
940 if ( !is_dir(
"{$this->dbDir}/locks" ) ) {
941 if ( !is_writable( $this->dbDir ) || !mkdir(
"{$this->dbDir}/locks" ) ) {
942 throw new DBError( $this,
"Cannot create directory \"{$this->dbDir}/locks\"." );
949 public function unlock( $lockName, $method ) {
960 return '(' . implode(
') || (', $stringList ) .
')';
964 $delim, $table, $field, $conds =
'', $join_conds = []
966 $fld =
"group_concat($field," . $this->
addQuotes( $delim ) .
')';
968 return '(' . $this->
selectSQLText( $table, $fld, $conds,
null, [], $join_conds ) .
')';
980 $res = $this->
query(
"SELECT sql FROM sqlite_master WHERE tbl_name=" .
984 throw new RuntimeException(
"Couldn't retrieve structure for table $oldName" );
996 if ( preg_match(
'/^\\s*CREATE\\s+VIRTUAL\\s+TABLE\b/i', $sql ) ) {
997 $this->queryLogger->debug(
998 "Table $oldName is virtual, can't create a temporary duplicate.\n" );
1000 $sql = str_replace(
'CREATE TABLE',
'CREATE TEMPORARY TABLE', $sql );
1007 $indexList = $this->
query(
'PRAGMA INDEX_LIST(' . $this->
addQuotes( $oldName ) .
')' );
1008 foreach ( $indexList
as $index ) {
1009 if ( strpos( $index->name,
'sqlite_autoindex' ) === 0 ) {
1013 if ( $index->unique ) {
1014 $sql =
'CREATE UNIQUE INDEX';
1016 $sql =
'CREATE INDEX';
1019 $indexName = $newName .
'_' . $index->name;
1020 $sql .=
' ' . $indexName .
' ON ' . $newName;
1022 $indexInfo = $this->
query(
'PRAGMA INDEX_INFO(' . $this->
addQuotes( $index->name ) .
')' );
1024 foreach ( $indexInfo
as $indexInfoRow ) {
1025 $fields[$indexInfoRow->seqno] = $indexInfoRow->name;
1028 $sql .=
'(' . implode(
',', $fields ) .
')';
1030 $this->
query( $sql );
1054 $vars = get_object_vars( $table );
1055 $table = array_pop(
$vars );
1057 if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
1058 if ( strpos( $table,
'sqlite_' ) !== 0 ) {
1059 $endArray[] = $table;
1075 public function dropTable( $tableName, $fName = __METHOD__ ) {
1076 if ( !$this->
tableExists( $tableName, $fName ) ) {
1079 $sql =
"DROP TABLE " . $this->
tableName( $tableName );
1081 return $this->
query( $sql, $fName );
1085 parent::setTableAliases( $aliases );
1086 foreach ( $this->tableAliases
as $params ) {
1087 if ( isset( $this->alreadyAttached[
$params[
'dbname']] ) ) {
1091 $this->alreadyAttached[
$params[
'dbname']] =
true;
1098 $this->
query(
"DELETE FROM $encTable WHERE name = $encName",
$fname );
1109 return is_object( $this->conn )
1110 ?
'SQLite ' . (
string)$this->conn->getAttribute( PDO::ATTR_SERVER_VERSION )
1111 :
'(not connected)';
1118 return parent::getBindingHandle();
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and insert
Class for handling resource locking.
Simple version of LockManager based on using FS lock files.
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. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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
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
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for tableName() and addQuotes(). You will need both of them. ------------------------------------------------------------------------ Basic query optimisation ------------------------------------------------------------------------ MediaWiki developers who need to write DB queries should have some understanding of databases and the performance issues associated with them. Patches containing unacceptably slow features will not be accepted. Unindexed queries are generally not welcome in MediaWiki
if(is_array( $mode)) switch( $mode) $input
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 configuration should be added through ResourceLoaderGetConfigVars instead & $vars
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Allows to change the fields on the form that will be generated $name
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
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
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
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 & $options
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
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 true
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Class to handle database/prefix specification for IDatabase domains.