diff options
Diffstat (limited to 'includes/db/DatabaseSqlite.php')
| -rw-r--r-- | includes/db/DatabaseSqlite.php | 247 |
1 files changed, 139 insertions, 108 deletions
diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php index c149cf04..503ebdf6 100644 --- a/includes/db/DatabaseSqlite.php +++ b/includes/db/DatabaseSqlite.php @@ -1,10 +1,10 @@ <?php /** - * This script is the SQLite database abstraction layer - * + * This is the SQLite database abstraction layer. * See maintenance/sqlite/README for development notes and other specific information - * @ingroup Database + * * @file + * @ingroup Database */ /** @@ -12,6 +12,8 @@ */ class DatabaseSqlite extends DatabaseBase { + private static $fulltextEnabled = null; + var $mAffectedRows; var $mLastResult; var $mDatabaseFile; @@ -21,11 +23,16 @@ class DatabaseSqlite extends DatabaseBase { * Constructor. * Parameters $server, $user and $password are not used. */ - function __construct( $server = false, $user = false, $password = false, $dbName = false, $failFunction = false, $flags = 0 ) { - $this->mFailFunction = $failFunction; - $this->mFlags = $flags; + function __construct( $server = false, $user = false, $password = false, $dbName = false, $flags = 0 ) { $this->mName = $dbName; - $this->open( $server, $user, $password, $dbName ); + parent::__construct( $server, $user, $password, $dbName, $flags ); + // parent doesn't open when $user is false, but we can work with $dbName + if( !$user && $dbName ) { + global $wgSharedDB; + if( $this->open( $server, $user, $password, $dbName ) && $wgSharedDB ) { + $this->attachDatabase( $wgSharedDB ); + } + } } function getType() { @@ -37,8 +44,8 @@ class DatabaseSqlite extends DatabaseBase { */ function implicitGroupby() { return false; } - static function newFromParams( $server, $user, $password, $dbName, $failFunction = false, $flags = 0 ) { - return new DatabaseSqlite( $server, $user, $password, $dbName, $failFunction, $flags ); + static function newFromParams( $server, $user, $password, $dbName, $flags = 0 ) { + return new DatabaseSqlite( $server, $user, $password, $dbName, $flags ); } /** Open an SQLite database and return a resource handle to it @@ -49,7 +56,8 @@ class DatabaseSqlite extends DatabaseBase { $fileName = self::generateFileName( $wgSQLiteDataDir, $dbName ); if ( !is_readable( $fileName ) ) { - throw new DBConnectionError( $this, "SQLite database not accessible" ); $this->mConn = false; + $this->mConn = false; + throw new DBConnectionError( $this, "SQLite database not accessible" ); } $this->openFile( $fileName ); return $this->mConn; @@ -71,14 +79,9 @@ class DatabaseSqlite extends DatabaseBase { } catch ( PDOException $e ) { $err = $e->getMessage(); } - if ( $this->mConn === false ) { + if ( !$this->mConn ) { wfDebug( "DB connection error: $err\n" ); - if ( !$this->mFailFunction ) { - throw new DBConnectionError( $this, $err ); - } else { - return false; - } - + throw new DBConnectionError( $this, $err ); } $this->mOpened = !!$this->mConn; # set error codes only, don't raise exceptions @@ -111,17 +114,64 @@ class DatabaseSqlite extends DatabaseBase { } /** + * Check if the searchindext table is FTS enabled. + * @returns false if not enabled. + */ + function checkForEnabledSearch() { + if ( self::$fulltextEnabled === null ) { + self::$fulltextEnabled = false; + $table = $this->tableName( 'searchindex' ); + $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name = '$table'", __METHOD__ ); + if ( $res ) { + $row = $res->fetchRow(); + self::$fulltextEnabled = stristr($row['sql'], 'fts' ) !== false; + } + } + return self::$fulltextEnabled; + } + + /** * Returns version of currently supported SQLite fulltext search module or false if none present. * @return String */ - function getFulltextSearchModule() { + static function getFulltextSearchModule() { + static $cachedResult = null; + if ( $cachedResult !== null ) { + return $cachedResult; + } + $cachedResult = false; $table = 'dummy_search_test'; - $this->query( "DROP TABLE IF EXISTS $table", __METHOD__ ); - if ( $this->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__, true ) ) { - $this->query( "DROP TABLE IF EXISTS $table", __METHOD__ ); - return 'FTS3'; + + $db = new DatabaseSqliteStandalone( ':memory:' ); + + if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__, true ) ) { + $cachedResult = 'FTS3'; } - return false; + $db->close(); + return $cachedResult; + } + + /** + * Attaches external database to our connection, see http://sqlite.org/lang_attach.html + * for details. + * @param $name String: database name to be used in queries like SELECT foo FROM dbname.table + * @param $file String: database file name. If omitted, will be generated using $name and $wgSQLiteDataDir + * @param $fname String: calling function name + */ + function attachDatabase( $name, $file = false, $fname = 'DatabaseSqlite::attachDatabase' ) { + global $wgSQLiteDataDir; + if ( !$file ) { + $file = self::generateFileName( $wgSQLiteDataDir, $name ); + } + $file = $this->addQuotes( $file ); + return $this->query( "ATTACH DATABASE $file AS $name", $fname ); + } + + /** + * @see DatabaseBase::isWriteQuery() + */ + function isWriteQuery( $sql ) { + return parent::isWriteQuery( $sql ) && !preg_match( '/^ATTACH\b/i', $sql ); } /** @@ -140,25 +190,29 @@ class DatabaseSqlite extends DatabaseBase { } function freeResult( $res ) { - if ( $res instanceof ResultWrapper ) + if ( $res instanceof ResultWrapper ) { $res->result = null; - else + } else { $res = null; + } } function fetchObject( $res ) { - if ( $res instanceof ResultWrapper ) + if ( $res instanceof ResultWrapper ) { $r =& $res->result; - else + } else { $r =& $res; + } $cur = current( $r ); if ( is_array( $cur ) ) { next( $r ); $obj = new stdClass; - foreach ( $cur as $k => $v ) - if ( !is_numeric( $k ) ) + foreach ( $cur as $k => $v ) { + if ( !is_numeric( $k ) ) { $obj->$k = $v; + } + } return $obj; } @@ -166,11 +220,11 @@ class DatabaseSqlite extends DatabaseBase { } function fetchRow( $res ) { - if ( $res instanceof ResultWrapper ) + if ( $res instanceof ResultWrapper ) { $r =& $res->result; - else + } else { $r =& $res; - + } $cur = current( $r ); if ( is_array( $cur ) ) { next( $r ); @@ -205,6 +259,8 @@ class DatabaseSqlite extends DatabaseBase { * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks */ function tableName( $name ) { + // table names starting with sqlite_ are reserved + if ( strpos( $name, 'sqlite_' ) === 0 ) return $name; return str_replace( '`', '', parent::tableName( $name ) ); } @@ -223,19 +279,23 @@ class DatabaseSqlite extends DatabaseBase { } function dataSeek( $res, $row ) { - if ( $res instanceof ResultWrapper ) + if ( $res instanceof ResultWrapper ) { $r =& $res->result; - else + } else { $r =& $res; + } reset( $r ); - if ( $row > 0 ) - for ( $i = 0; $i < $row; $i++ ) + if ( $row > 0 ) { + for ( $i = 0; $i < $row; $i++ ) { next( $r ); + } + } } function lastError() { - if ( !is_object( $this->mConn ) ) + if ( !is_object( $this->mConn ) ) { return "Cannot return last error, no db connection"; + } $e = $this->mConn->errorInfo(); return isset( $e[2] ) ? $e[2] : ''; } @@ -298,9 +358,11 @@ class DatabaseSqlite extends DatabaseBase { * Filter the options used in SELECT statements */ function makeSelectOptions( $options ) { - foreach ( $options as $k => $v ) - if ( is_numeric( $k ) && $v == 'FOR UPDATE' ) + foreach ( $options as $k => $v ) { + if ( is_numeric( $k ) && $v == 'FOR UPDATE' ) { $options[$k] = ''; + } + } return parent::makeSelectOptions( $options ); } @@ -308,20 +370,28 @@ class DatabaseSqlite extends DatabaseBase { * Based on generic method (parent) with some prior SQLite-sepcific adjustments */ function insert( $table, $a, $fname = 'DatabaseSqlite::insert', $options = array() ) { - if ( !count( $a ) ) return true; - if ( !is_array( $options ) ) $options = array( $options ); + if ( !count( $a ) ) { + return true; + } + if ( !is_array( $options ) ) { + $options = array( $options ); + } # SQLite uses OR IGNORE not just IGNORE - foreach ( $options as $k => $v ) - if ( $v == 'IGNORE' ) + foreach ( $options as $k => $v ) { + if ( $v == 'IGNORE' ) { $options[$k] = 'OR IGNORE'; + } + } # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts if ( isset( $a[0] ) && is_array( $a[0] ) ) { $ret = true; - foreach ( $a as $k => $v ) - if ( !parent::insert( $table, $v, "$fname/multi-row", $options ) ) + foreach ( $a as $v ) { + if ( !parent::insert( $table, $v, "$fname/multi-row", $options ) ) { $ret = false; + } + } } else { $ret = parent::insert( $table, $a, "$fname/single-row", $options ); } @@ -331,13 +401,15 @@ class DatabaseSqlite extends DatabaseBase { function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseSqlite::replace' ) { if ( !count( $rows ) ) return true; - + # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries if ( isset( $rows[0] ) && is_array( $rows[0] ) ) { $ret = true; - foreach ( $rows as $k => $v ) - if ( !parent::replace( $table, $uniqueIndexes, $v, "$fname/multi-row" ) ) + foreach ( $rows as $v ) { + if ( !parent::replace( $table, $uniqueIndexes, $v, "$fname/multi-row" ) ) { $ret = false; + } + } } else { $ret = parent::replace( $table, $uniqueIndexes, $rows, "$fname/single-row" ); } @@ -362,6 +434,10 @@ class DatabaseSqlite extends DatabaseBase { return implode( $glue, $sqls ); } + public function unixTimestamp( $field ) { + return $field; + } + function wasDeadlock() { return $this->lastErrno() == 5; // SQLITE_BUSY } @@ -377,7 +453,7 @@ class DatabaseSqlite extends DatabaseBase { /** * @return string wikitext of a link to the server software's web site */ - function getSoftwareLink() { + public static function getSoftwareLink() { return "[http://sqlite.org/ SQLite]"; } @@ -390,11 +466,10 @@ class DatabaseSqlite extends DatabaseBase { } /** - * Query whether a given column exists in the mediawiki schema + * @return string User-friendly database information */ - function fieldExists( $table, $field, $fname = '' ) { - $info = $this->fieldInfo( $table, $field ); - return (bool)$info; + public function getServerInfo() { + return wfMsg( self::getFulltextSearchModule() ? 'sqlite-has-fts' : 'sqlite-no-fts', $this->getServerVersion() ); } /** @@ -458,10 +533,6 @@ class DatabaseSqlite extends DatabaseBase { } } - function quote_ident( $s ) { - return $s; - } - function buildLike() { $params = func_get_args(); if ( count( $params ) > 0 && is_array( $params[0] ) ) { @@ -470,43 +541,6 @@ class DatabaseSqlite extends DatabaseBase { return parent::buildLike( $params ) . "ESCAPE '\' "; } - /** - * How lagged is this slave? - */ - public function getLag() { - return 0; - } - - /** - * Called by the installer script (when modified according to the MediaWikiLite installation instructions) - * - this is the same way PostgreSQL works, MySQL reads in tables.sql and interwiki.sql using dbsource (which calls db->sourceFile) - */ - public function setup_database() { - global $IP; - - # Process common MySQL/SQLite table definitions - $err = $this->sourceFile( "$IP/maintenance/tables.sql" ); - if ( $err !== true ) { - echo " <b>FAILED</b></li>"; - dieout( htmlspecialchars( $err ) ); - } - echo " done.</li>"; - - # Use DatabasePostgres's code to populate interwiki from MySQL template - $f = fopen( "$IP/maintenance/interwiki.sql", 'r' ); - if ( $f == false ) { - dieout( "Could not find the interwiki.sql file." ); - } - - $sql = "INSERT INTO interwiki(iw_prefix,iw_url,iw_local) VALUES "; - while ( !feof( $f ) ) { - $line = fgets( $f, 1024 ); - $matches = array(); - if ( !preg_match( '/^\s*(\(.+?),(\d)\)/', $line, $matches ) ) continue; - $this->query( "$sql $matches[1],$matches[2])" ); - } - } - public function getSearchEngine() { return "SearchSqlite"; } @@ -530,9 +564,11 @@ class DatabaseSqlite extends DatabaseBase { // no such thing as unsigned $s = preg_replace( '/\b(un)?signed\b/i', '', $s ); // INT -> INTEGER - $s = preg_replace( '/\b(tiny|small|medium|big|)int(\([\s\d]*\)|\b)/i', 'INTEGER', $s ); + $s = preg_replace( '/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i', 'INTEGER', $s ); + // floating point types -> REAL + $s = preg_replace( '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i', 'REAL', $s ); // varchar -> TEXT - $s = preg_replace( '/\bvarchar\(\d+\)/i', 'TEXT', $s ); + $s = preg_replace( '/\b(var)?char\s*\(.*?\)/i', 'TEXT', $s ); // TEXT normalization $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s ); // BLOB normalization @@ -542,13 +578,15 @@ class DatabaseSqlite extends DatabaseBase { // DATETIME -> TEXT $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s ); // No ENUM type - $s = preg_replace( '/enum\([^)]*\)/i', 'BLOB', $s ); + $s = preg_replace( '/\benum\s*\([^)]*\)/i', 'TEXT', $s ); // binary collation type -> nothing $s = preg_replace( '/\bbinary\b/i', '', $s ); // auto_increment -> autoincrement $s = preg_replace( '/\bauto_increment\b/i', 'AUTOINCREMENT', $s ); // No explicit options $s = preg_replace( '/\)[^);]*(;?)\s*$/', ')\1', $s ); + // AUTOINCREMENT should immedidately follow PRIMARY KEY + $s = preg_replace( '/primary key (.*?) autoincrement/i', 'PRIMARY KEY AUTOINCREMENT $1', $s ); } elseif ( preg_match( '/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i', $s ) ) { // No truncated indexes $s = preg_replace( '/\(\d+\)/', '', $s ); @@ -585,6 +623,7 @@ class DatabaseSqlite extends DatabaseBase { class DatabaseSqliteStandalone extends DatabaseSqlite { public function __construct( $fileName, $flags = 0 ) { $this->mFlags = $flags; + $this->tablePrefix( null ); $this->openFile( $fileName ); } } @@ -592,7 +631,7 @@ class DatabaseSqliteStandalone extends DatabaseSqlite { /** * @ingroup Database */ -class SQLiteField { +class SQLiteField implements Field { private $info, $tableName; function __construct( $info, $tableName ) { $this->info = $info; @@ -617,18 +656,10 @@ class SQLiteField { return $this->info->dflt_value; } - function maxLength() { - return -1; + function isNullable() { + return !$this->info->notnull; } - function nullable() { - // SQLite dynamic types are always nullable - return true; - } - - # isKey(), isMultipleKey() not implemented, MySQL-specific concept. - # Suggest removal from base class [TS] - function type() { return $this->info->type; } |