Implement extension registration from an extension.json file
[mediawiki.git] / includes / db / DatabaseSqlite.php
blob9257ffe50822a0ee43c84f572d1376860ef141f5
1 <?php
2 /**
3 * This is the SQLite database abstraction layer.
4 * See maintenance/sqlite/README for development notes and other specific information
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
21 * @file
22 * @ingroup Database
25 /**
26 * @ingroup Database
28 class DatabaseSqlite extends DatabaseBase {
29 /** @var bool Whether full text is enabled */
30 private static $fulltextEnabled = null;
32 /** @var string File name for SQLite database file */
33 public $mDatabaseFile;
35 /** @var int The number of rows affected as an integer */
36 protected $mAffectedRows;
38 /** @var resource */
39 protected $mLastResult;
41 /** @var PDO */
42 protected $mConn;
44 /** @var FSLockManager (hopefully on the same server as the DB) */
45 protected $lockMgr;
47 function __construct( $p = null ) {
48 global $wgSharedDB, $wgSQLiteDataDir;
50 if ( !is_array( $p ) ) { // legacy calling pattern
51 wfDeprecated( __METHOD__ . " method called without parameter array.", "1.22" );
52 $args = func_get_args();
53 $p = array(
54 'host' => isset( $args[0] ) ? $args[0] : false,
55 'user' => isset( $args[1] ) ? $args[1] : false,
56 'password' => isset( $args[2] ) ? $args[2] : false,
57 'dbname' => isset( $args[3] ) ? $args[3] : false,
58 'flags' => isset( $args[4] ) ? $args[4] : 0,
59 'tablePrefix' => isset( $args[5] ) ? $args[5] : 'get from global',
60 'schema' => 'get from global',
61 'foreign' => isset( $args[6] ) ? $args[6] : false
64 $this->mDBname = $p['dbname'];
65 parent::__construct( $p );
66 // parent doesn't open when $user is false, but we can work with $dbName
67 if ( $p['dbname'] && !$this->isOpen() ) {
68 if ( $this->open( $p['host'], $p['user'], $p['password'], $p['dbname'] ) ) {
69 if ( $wgSharedDB ) {
70 $this->attachDatabase( $wgSharedDB );
75 $this->lockMgr = new FSLockManager( array( 'lockDirectory' => "$wgSQLiteDataDir/locks" ) );
78 /**
79 * @return string
81 function getType() {
82 return 'sqlite';
85 /**
86 * @todo Check if it should be true like parent class
88 * @return bool
90 function implicitGroupby() {
91 return false;
94 /** Open an SQLite database and return a resource handle to it
95 * NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases
97 * @param string $server
98 * @param string $user
99 * @param string $pass
100 * @param string $dbName
102 * @throws DBConnectionError
103 * @return PDO
105 function open( $server, $user, $pass, $dbName ) {
106 global $wgSQLiteDataDir;
108 $this->close();
109 $fileName = self::generateFileName( $wgSQLiteDataDir, $dbName );
110 if ( !is_readable( $fileName ) ) {
111 $this->mConn = false;
112 throw new DBConnectionError( $this, "SQLite database not accessible" );
114 $this->openFile( $fileName );
116 return $this->mConn;
120 * Opens a database file
122 * @param string $fileName
123 * @throws DBConnectionError
124 * @return PDO|bool SQL connection or false if failed
126 function openFile( $fileName ) {
127 $err = false;
129 $this->mDatabaseFile = $fileName;
130 try {
131 if ( $this->mFlags & DBO_PERSISTENT ) {
132 $this->mConn = new PDO( "sqlite:$fileName", '', '',
133 array( PDO::ATTR_PERSISTENT => true ) );
134 } else {
135 $this->mConn = new PDO( "sqlite:$fileName", '', '' );
137 } catch ( PDOException $e ) {
138 $err = $e->getMessage();
141 if ( !$this->mConn ) {
142 wfDebug( "DB connection error: $err\n" );
143 throw new DBConnectionError( $this, $err );
146 $this->mOpened = !!$this->mConn;
147 # set error codes only, don't raise exceptions
148 if ( $this->mOpened ) {
149 $this->mConn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT );
150 # Enforce LIKE to be case sensitive, just like MySQL
151 $this->query( 'PRAGMA case_sensitive_like = 1' );
153 return $this->mConn;
156 return false;
160 * Does not actually close the connection, just destroys the reference for GC to do its work
161 * @return bool
163 protected function closeConnection() {
164 $this->mConn = null;
166 return true;
170 * Generates a database file name. Explicitly public for installer.
171 * @param string $dir Directory where database resides
172 * @param string $dbName Database name
173 * @return string
175 public static function generateFileName( $dir, $dbName ) {
176 return "$dir/$dbName.sqlite";
180 * Check if the searchindext table is FTS enabled.
181 * @return bool False if not enabled.
183 function checkForEnabledSearch() {
184 if ( self::$fulltextEnabled === null ) {
185 self::$fulltextEnabled = false;
186 $table = $this->tableName( 'searchindex' );
187 $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name = '$table'", __METHOD__ );
188 if ( $res ) {
189 $row = $res->fetchRow();
190 self::$fulltextEnabled = stristr( $row['sql'], 'fts' ) !== false;
194 return self::$fulltextEnabled;
198 * Returns version of currently supported SQLite fulltext search module or false if none present.
199 * @return string
201 static function getFulltextSearchModule() {
202 static $cachedResult = null;
203 if ( $cachedResult !== null ) {
204 return $cachedResult;
206 $cachedResult = false;
207 $table = 'dummy_search_test';
209 $db = new DatabaseSqliteStandalone( ':memory:' );
211 if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__, true ) ) {
212 $cachedResult = 'FTS3';
214 $db->close();
216 return $cachedResult;
220 * Attaches external database to our connection, see http://sqlite.org/lang_attach.html
221 * for details.
223 * @param string $name Database name to be used in queries like
224 * SELECT foo FROM dbname.table
225 * @param bool|string $file Database file name. If omitted, will be generated
226 * using $name and $wgSQLiteDataDir
227 * @param string $fname Calling function name
228 * @return ResultWrapper
230 function attachDatabase( $name, $file = false, $fname = __METHOD__ ) {
231 global $wgSQLiteDataDir;
232 if ( !$file ) {
233 $file = self::generateFileName( $wgSQLiteDataDir, $name );
235 $file = $this->addQuotes( $file );
237 return $this->query( "ATTACH DATABASE $file AS $name", $fname );
241 * @see DatabaseBase::isWriteQuery()
243 * @param string $sql
244 * @return bool
246 function isWriteQuery( $sql ) {
247 return parent::isWriteQuery( $sql ) && !preg_match( '/^ATTACH\b/i', $sql );
251 * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result
253 * @param string $sql
254 * @return bool|ResultWrapper
256 protected function doQuery( $sql ) {
257 $res = $this->mConn->query( $sql );
258 if ( $res === false ) {
259 return false;
260 } else {
261 $r = $res instanceof ResultWrapper ? $res->result : $res;
262 $this->mAffectedRows = $r->rowCount();
263 $res = new ResultWrapper( $this, $r->fetchAll() );
266 return $res;
270 * @param ResultWrapper|mixed $res
272 function freeResult( $res ) {
273 if ( $res instanceof ResultWrapper ) {
274 $res->result = null;
275 } else {
276 $res = null;
281 * @param ResultWrapper|array $res
282 * @return stdClass|bool
284 function fetchObject( $res ) {
285 if ( $res instanceof ResultWrapper ) {
286 $r =& $res->result;
287 } else {
288 $r =& $res;
291 $cur = current( $r );
292 if ( is_array( $cur ) ) {
293 next( $r );
294 $obj = new stdClass;
295 foreach ( $cur as $k => $v ) {
296 if ( !is_numeric( $k ) ) {
297 $obj->$k = $v;
301 return $obj;
304 return false;
308 * @param ResultWrapper|mixed $res
309 * @return array|bool
311 function fetchRow( $res ) {
312 if ( $res instanceof ResultWrapper ) {
313 $r =& $res->result;
314 } else {
315 $r =& $res;
317 $cur = current( $r );
318 if ( is_array( $cur ) ) {
319 next( $r );
321 return $cur;
324 return false;
328 * The PDO::Statement class implements the array interface so count() will work
330 * @param ResultWrapper|array $res
331 * @return int
333 function numRows( $res ) {
334 $r = $res instanceof ResultWrapper ? $res->result : $res;
336 return count( $r );
340 * @param ResultWrapper $res
341 * @return int
343 function numFields( $res ) {
344 $r = $res instanceof ResultWrapper ? $res->result : $res;
345 if ( is_array( $r ) && count( $r ) > 0 ) {
346 // The size of the result array is twice the number of fields. (Bug: 65578)
347 return count( $r[0] ) / 2;
348 } else {
349 // If the result is empty return 0
350 return 0;
355 * @param ResultWrapper $res
356 * @param int $n
357 * @return bool
359 function fieldName( $res, $n ) {
360 $r = $res instanceof ResultWrapper ? $res->result : $res;
361 if ( is_array( $r ) ) {
362 $keys = array_keys( $r[0] );
364 return $keys[$n];
367 return false;
371 * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks
373 * @param string $name
374 * @param string $format
375 * @return string
377 function tableName( $name, $format = 'quoted' ) {
378 // table names starting with sqlite_ are reserved
379 if ( strpos( $name, 'sqlite_' ) === 0 ) {
380 return $name;
383 return str_replace( '"', '', parent::tableName( $name, $format ) );
387 * Index names have DB scope
389 * @param string $index
390 * @return string
392 function indexName( $index ) {
393 return $index;
397 * This must be called after nextSequenceVal
399 * @return int
401 function insertId() {
402 // PDO::lastInsertId yields a string :(
403 return intval( $this->mConn->lastInsertId() );
407 * @param ResultWrapper|array $res
408 * @param int $row
410 function dataSeek( $res, $row ) {
411 if ( $res instanceof ResultWrapper ) {
412 $r =& $res->result;
413 } else {
414 $r =& $res;
416 reset( $r );
417 if ( $row > 0 ) {
418 for ( $i = 0; $i < $row; $i++ ) {
419 next( $r );
425 * @return string
427 function lastError() {
428 if ( !is_object( $this->mConn ) ) {
429 return "Cannot return last error, no db connection";
431 $e = $this->mConn->errorInfo();
433 return isset( $e[2] ) ? $e[2] : '';
437 * @return string
439 function lastErrno() {
440 if ( !is_object( $this->mConn ) ) {
441 return "Cannot return last error, no db connection";
442 } else {
443 $info = $this->mConn->errorInfo();
445 return $info[1];
450 * @return int
452 function affectedRows() {
453 return $this->mAffectedRows;
457 * Returns information about an index
458 * Returns false if the index does not exist
459 * - if errors are explicitly ignored, returns NULL on failure
461 * @param string $table
462 * @param string $index
463 * @param string $fname
464 * @return array
466 function indexInfo( $table, $index, $fname = __METHOD__ ) {
467 $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
468 $res = $this->query( $sql, $fname );
469 if ( !$res ) {
470 return null;
472 if ( $res->numRows() == 0 ) {
473 return false;
475 $info = array();
476 foreach ( $res as $row ) {
477 $info[] = $row->name;
480 return $info;
484 * @param string $table
485 * @param string $index
486 * @param string $fname
487 * @return bool|null
489 function indexUnique( $table, $index, $fname = __METHOD__ ) {
490 $row = $this->selectRow( 'sqlite_master', '*',
491 array(
492 'type' => 'index',
493 'name' => $this->indexName( $index ),
494 ), $fname );
495 if ( !$row || !isset( $row->sql ) ) {
496 return null;
499 // $row->sql will be of the form CREATE [UNIQUE] INDEX ...
500 $indexPos = strpos( $row->sql, 'INDEX' );
501 if ( $indexPos === false ) {
502 return null;
504 $firstPart = substr( $row->sql, 0, $indexPos );
505 $options = explode( ' ', $firstPart );
507 return in_array( 'UNIQUE', $options );
511 * Filter the options used in SELECT statements
513 * @param array $options
514 * @return array
516 function makeSelectOptions( $options ) {
517 foreach ( $options as $k => $v ) {
518 if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' || $v == 'LOCK IN SHARE MODE' ) ) {
519 $options[$k] = '';
523 return parent::makeSelectOptions( $options );
527 * @param array $options
528 * @return string
530 protected function makeUpdateOptionsArray( $options ) {
531 $options = parent::makeUpdateOptionsArray( $options );
532 $options = self::fixIgnore( $options );
534 return $options;
538 * @param array $options
539 * @return array
541 static function fixIgnore( $options ) {
542 # SQLite uses OR IGNORE not just IGNORE
543 foreach ( $options as $k => $v ) {
544 if ( $v == 'IGNORE' ) {
545 $options[$k] = 'OR IGNORE';
549 return $options;
553 * @param array $options
554 * @return string
556 function makeInsertOptions( $options ) {
557 $options = self::fixIgnore( $options );
559 return parent::makeInsertOptions( $options );
563 * Based on generic method (parent) with some prior SQLite-sepcific adjustments
564 * @param string $table
565 * @param array $a
566 * @param string $fname
567 * @param array $options
568 * @return bool
570 function insert( $table, $a, $fname = __METHOD__, $options = array() ) {
571 if ( !count( $a ) ) {
572 return true;
575 # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts
576 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
577 $ret = true;
578 foreach ( $a as $v ) {
579 if ( !parent::insert( $table, $v, "$fname/multi-row", $options ) ) {
580 $ret = false;
583 } else {
584 $ret = parent::insert( $table, $a, "$fname/single-row", $options );
587 return $ret;
591 * @param string $table
592 * @param array $uniqueIndexes Unused
593 * @param string|array $rows
594 * @param string $fname
595 * @return bool|ResultWrapper
597 function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
598 if ( !count( $rows ) ) {
599 return true;
602 # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries
603 if ( isset( $rows[0] ) && is_array( $rows[0] ) ) {
604 $ret = true;
605 foreach ( $rows as $v ) {
606 if ( !$this->nativeReplace( $table, $v, "$fname/multi-row" ) ) {
607 $ret = false;
610 } else {
611 $ret = $this->nativeReplace( $table, $rows, "$fname/single-row" );
614 return $ret;
618 * Returns the size of a text field, or -1 for "unlimited"
619 * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though.
621 * @param string $table
622 * @param string $field
623 * @return int
625 function textFieldSize( $table, $field ) {
626 return -1;
630 * @return bool
632 function unionSupportsOrderAndLimit() {
633 return false;
637 * @param string $sqls
638 * @param bool $all Whether to "UNION ALL" or not
639 * @return string
641 function unionQueries( $sqls, $all ) {
642 $glue = $all ? ' UNION ALL ' : ' UNION ';
644 return implode( $glue, $sqls );
648 * @return bool
650 function wasDeadlock() {
651 return $this->lastErrno() == 5; // SQLITE_BUSY
655 * @return bool
657 function wasErrorReissuable() {
658 return $this->lastErrno() == 17; // SQLITE_SCHEMA;
662 * @return bool
664 function wasReadOnlyError() {
665 return $this->lastErrno() == 8; // SQLITE_READONLY;
669 * @return string Wikitext of a link to the server software's web site
671 public function getSoftwareLink() {
672 return "[{{int:version-db-sqlite-url}} SQLite]";
676 * @return string Version information from the database
678 function getServerVersion() {
679 $ver = $this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION );
681 return $ver;
685 * @return string User-friendly database information
687 public function getServerInfo() {
688 return wfMessage( self::getFulltextSearchModule()
689 ? 'sqlite-has-fts'
690 : 'sqlite-no-fts', $this->getServerVersion() )->text();
694 * Get information about a given field
695 * Returns false if the field does not exist.
697 * @param string $table
698 * @param string $field
699 * @return SQLiteField|bool False on failure
701 function fieldInfo( $table, $field ) {
702 $tableName = $this->tableName( $table );
703 $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
704 $res = $this->query( $sql, __METHOD__ );
705 foreach ( $res as $row ) {
706 if ( $row->name == $field ) {
707 return new SQLiteField( $row, $tableName );
711 return false;
714 protected function doBegin( $fname = '' ) {
715 if ( $this->mTrxLevel == 1 ) {
716 $this->commit( __METHOD__ );
718 try {
719 $this->mConn->beginTransaction();
720 } catch ( PDOException $e ) {
721 throw new DBUnexpectedError( $this, 'Error in BEGIN query: ' . $e->getMessage() );
723 $this->mTrxLevel = 1;
726 protected function doCommit( $fname = '' ) {
727 if ( $this->mTrxLevel == 0 ) {
728 return;
730 try {
731 $this->mConn->commit();
732 } catch ( PDOException $e ) {
733 throw new DBUnexpectedError( $this, 'Error in COMMIT query: ' . $e->getMessage() );
735 $this->mTrxLevel = 0;
738 protected function doRollback( $fname = '' ) {
739 if ( $this->mTrxLevel == 0 ) {
740 return;
742 $this->mConn->rollBack();
743 $this->mTrxLevel = 0;
747 * @param string $s
748 * @return string
750 function strencode( $s ) {
751 return substr( $this->addQuotes( $s ), 1, -1 );
755 * @param string $b
756 * @return Blob
758 function encodeBlob( $b ) {
759 return new Blob( $b );
763 * @param Blob|string $b
764 * @return string
766 function decodeBlob( $b ) {
767 if ( $b instanceof Blob ) {
768 $b = $b->fetch();
771 return $b;
775 * @param Blob|string $s
776 * @return string
778 function addQuotes( $s ) {
779 if ( $s instanceof Blob ) {
780 return "x'" . bin2hex( $s->fetch() ) . "'";
781 } elseif ( is_bool( $s ) ) {
782 return (int)$s;
783 } elseif ( strpos( $s, "\0" ) !== false ) {
784 // SQLite doesn't support \0 in strings, so use the hex representation as a workaround.
785 // This is a known limitation of SQLite's mprintf function which PDO should work around,
786 // but doesn't. I have reported this to php.net as bug #63419:
787 // https://bugs.php.net/bug.php?id=63419
788 // There was already a similar report for SQLite3::escapeString, bug #62361:
789 // https://bugs.php.net/bug.php?id=62361
790 // There is an additional bug regarding sorting this data after insert
791 // on older versions of sqlite shipped with ubuntu 12.04
792 // https://bugzilla.wikimedia.org/show_bug.cgi?id=72367
793 wfDebugLog( __CLASS__, __FUNCTION__ . ': Quoting value containing null byte. For consistency all binary data should have been first processed with self::encodeBlob()' );
794 return "x'" . bin2hex( $s ) . "'";
795 } else {
796 return $this->mConn->quote( $s );
801 * @return string
803 function buildLike() {
804 $params = func_get_args();
805 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
806 $params = $params[0];
809 return parent::buildLike( $params ) . "ESCAPE '\' ";
813 * @return string
815 public function getSearchEngine() {
816 return "SearchSqlite";
820 * No-op version of deadlockLoop
822 * @return mixed
824 public function deadlockLoop( /*...*/ ) {
825 $args = func_get_args();
826 $function = array_shift( $args );
828 return call_user_func_array( $function, $args );
832 * @param string $s
833 * @return string
835 protected function replaceVars( $s ) {
836 $s = parent::replaceVars( $s );
837 if ( preg_match( '/^\s*(CREATE|ALTER) TABLE/i', $s ) ) {
838 // CREATE TABLE hacks to allow schema file sharing with MySQL
840 // binary/varbinary column type -> blob
841 $s = preg_replace( '/\b(var)?binary(\(\d+\))/i', 'BLOB', $s );
842 // no such thing as unsigned
843 $s = preg_replace( '/\b(un)?signed\b/i', '', $s );
844 // INT -> INTEGER
845 $s = preg_replace( '/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i', 'INTEGER', $s );
846 // floating point types -> REAL
847 $s = preg_replace(
848 '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i',
849 'REAL',
852 // varchar -> TEXT
853 $s = preg_replace( '/\b(var)?char\s*\(.*?\)/i', 'TEXT', $s );
854 // TEXT normalization
855 $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s );
856 // BLOB normalization
857 $s = preg_replace( '/\b(tiny|small|medium|long|)blob\b/i', 'BLOB', $s );
858 // BOOL -> INTEGER
859 $s = preg_replace( '/\bbool(ean)?\b/i', 'INTEGER', $s );
860 // DATETIME -> TEXT
861 $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s );
862 // No ENUM type
863 $s = preg_replace( '/\benum\s*\([^)]*\)/i', 'TEXT', $s );
864 // binary collation type -> nothing
865 $s = preg_replace( '/\bbinary\b/i', '', $s );
866 // auto_increment -> autoincrement
867 $s = preg_replace( '/\bauto_increment\b/i', 'AUTOINCREMENT', $s );
868 // No explicit options
869 $s = preg_replace( '/\)[^);]*(;?)\s*$/', ')\1', $s );
870 // AUTOINCREMENT should immedidately follow PRIMARY KEY
871 $s = preg_replace( '/primary key (.*?) autoincrement/i', 'PRIMARY KEY AUTOINCREMENT $1', $s );
872 } elseif ( preg_match( '/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i', $s ) ) {
873 // No truncated indexes
874 $s = preg_replace( '/\(\d+\)/', '', $s );
875 // No FULLTEXT
876 $s = preg_replace( '/\bfulltext\b/i', '', $s );
877 } elseif ( preg_match( '/^\s*DROP INDEX/i', $s ) ) {
878 // DROP INDEX is database-wide, not table-specific, so no ON <table> clause.
879 $s = preg_replace( '/\sON\s+[^\s]*/i', '', $s );
880 } elseif ( preg_match( '/^\s*INSERT IGNORE\b/i', $s ) ) {
881 // INSERT IGNORE --> INSERT OR IGNORE
882 $s = preg_replace( '/^\s*INSERT IGNORE\b/i', 'INSERT OR IGNORE', $s );
885 return $s;
888 public function lock( $lockName, $method, $timeout = 5 ) {
889 global $wgSQLiteDataDir;
891 if ( !is_dir( "$wgSQLiteDataDir/locks" ) ) { // create dir as needed
892 if ( !is_writable( $wgSQLiteDataDir ) || !mkdir( "$wgSQLiteDataDir/locks" ) ) {
893 throw new DBError( "Cannot create directory \"$wgSQLiteDataDir/locks\"." );
897 return $this->lockMgr->lock( array( $lockName ), LockManager::LOCK_EX, $timeout )->isOK();
900 public function unlock( $lockName, $method ) {
901 return $this->lockMgr->unlock( array( $lockName ), LockManager::LOCK_EX )->isOK();
905 * Build a concatenation list to feed into a SQL query
907 * @param string[] $stringList
908 * @return string
910 function buildConcat( $stringList ) {
911 return '(' . implode( ') || (', $stringList ) . ')';
914 public function buildGroupConcatField(
915 $delim, $table, $field, $conds = '', $join_conds = array()
917 $fld = "group_concat($field," . $this->addQuotes( $delim ) . ')';
919 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
923 * @throws MWException
924 * @param string $oldName
925 * @param string $newName
926 * @param bool $temporary
927 * @param string $fname
928 * @return bool|ResultWrapper
930 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ ) {
931 $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name=" .
932 $this->addQuotes( $oldName ) . " AND type='table'", $fname );
933 $obj = $this->fetchObject( $res );
934 if ( !$obj ) {
935 throw new MWException( "Couldn't retrieve structure for table $oldName" );
937 $sql = $obj->sql;
938 $sql = preg_replace(
939 '/(?<=\W)"?' . preg_quote( trim( $this->addIdentifierQuotes( $oldName ), '"' ) ) . '"?(?=\W)/',
940 $this->addIdentifierQuotes( $newName ),
941 $sql,
944 if ( $temporary ) {
945 if ( preg_match( '/^\\s*CREATE\\s+VIRTUAL\\s+TABLE\b/i', $sql ) ) {
946 wfDebug( "Table $oldName is virtual, can't create a temporary duplicate.\n" );
947 } else {
948 $sql = str_replace( 'CREATE TABLE', 'CREATE TEMPORARY TABLE', $sql );
952 return $this->query( $sql, $fname );
956 * List all tables on the database
958 * @param string $prefix Only show tables with this prefix, e.g. mw_
959 * @param string $fname Calling function name
961 * @return array
963 function listTables( $prefix = null, $fname = __METHOD__ ) {
964 $result = $this->select(
965 'sqlite_master',
966 'name',
967 "type='table'"
970 $endArray = array();
972 foreach ( $result as $table ) {
973 $vars = get_object_vars( $table );
974 $table = array_pop( $vars );
976 if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
977 if ( strpos( $table, 'sqlite_' ) !== 0 ) {
978 $endArray[] = $table;
983 return $endArray;
985 } // end DatabaseSqlite class
988 * This class allows simple acccess to a SQLite database independently from main database settings
989 * @ingroup Database
991 class DatabaseSqliteStandalone extends DatabaseSqlite {
992 public function __construct( $fileName, $flags = 0 ) {
993 $this->mFlags = $flags;
994 $this->tablePrefix( null );
995 $this->openFile( $fileName );
1000 * @ingroup Database
1002 class SQLiteField implements Field {
1003 private $info, $tableName;
1005 function __construct( $info, $tableName ) {
1006 $this->info = $info;
1007 $this->tableName = $tableName;
1010 function name() {
1011 return $this->info->name;
1014 function tableName() {
1015 return $this->tableName;
1018 function defaultValue() {
1019 if ( is_string( $this->info->dflt_value ) ) {
1020 // Typically quoted
1021 if ( preg_match( '/^\'(.*)\'$', $this->info->dflt_value ) ) {
1022 return str_replace( "''", "'", $this->info->dflt_value );
1026 return $this->info->dflt_value;
1030 * @return bool
1032 function isNullable() {
1033 return !$this->info->notnull;
1036 function type() {
1037 return $this->info->type;
1039 } // end SQLiteField