DatabaseSqlite.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;
 
use NullLockManager;
use PDO;
use PDOException;
use Exception;
use LockManager;
use FSLockManager;
use RuntimeException;
use stdClass;
 
class DatabaseSqlite extends Database {
    protected $dbDir;
    protected $dbPath;
    protected $trxMode;
 
    protected $lastAffectedRowCount;
    protected $lastResultHandle;
 
    protected $conn;
 
    protected $lockMgr;
 
    private $sessionAttachedDbs = [];
 
    private static $VALID_TRX_MODES = [ '', 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ];
 
    public function __construct( array $p ) {
        if ( isset( $p['dbFilePath'] ) ) {
            $this->dbPath = $p['dbFilePath'];
            if ( !strlen( $p['dbname'] ) ) {
                $p['dbname'] = self::generateDatabaseName( $this->dbPath );
            }
        } elseif ( isset( $p['dbDirectory'] ) ) {
            $this->dbDir = $p['dbDirectory'];
        }
 
        parent::__construct( $p );
 
        $this->trxMode = strtoupper( $p['trxMode'] ?? '' );
 
        $lockDirectory = $this->getLockFileDirectory();
        if ( $lockDirectory !== null ) {
            $this->lockMgr = new FSLockManager( [
                'domain' => $this->getDomainID(),
                'lockDirectory' => $lockDirectory
            ] );
        } else {
            $this->lockMgr = new NullLockManager( [ 'domain' => $this->getDomainID() ] );
        }
    }
 
    protected static function getAttributes() {
        return [ self::ATTR_DB_LEVEL_LOCKING => true ];
    }
 
    public static function newStandaloneInstance( $filename, array $p = [] ) {
        $p['dbFilePath'] = $filename;
        $p['schema'] = null;
        $p['tablePrefix'] = '';
        $db = Database::factory( 'sqlite', $p );
 
        return $db;
    }
 
    public function getType() {
        return 'sqlite';
    }
 
    protected function open( $server, $user, $pass, $dbName, $schema, $tablePrefix ) {
        $this->close();
 
        // Note that for SQLite, $server, $user, and $pass are ignored
 
        if ( $schema !== null ) {
            throw $this->newExceptionAfterConnectError( "Got schema '$schema'; not supported." );
        }
 
        if ( $this->dbPath !== null ) {
            $path = $this->dbPath;
        } elseif ( $this->dbDir !== null ) {
            $path = self::generateFileName( $this->dbDir, $dbName );
        } else {
            throw $this->newExceptionAfterConnectError( "DB path or directory required" );
        }
 
        // Check if the database file already exists but is non-readable
        if (
            !self::isProcessMemoryPath( $path ) &&
            file_exists( $path ) &&
            !is_readable( $path )
        ) {
            throw $this->newExceptionAfterConnectError( 'SQLite database file is not readable' );
        } elseif ( !in_array( $this->trxMode, self::$VALID_TRX_MODES, true ) ) {
            throw $this->newExceptionAfterConnectError( "Got mode '{$this->trxMode}' for BEGIN" );
        }
 
        $attributes = [];
        if ( $this->getFlag( self::DBO_PERSISTENT ) ) {
            // Persistent connections can avoid some schema index reading overhead.
            // On the other hand, they can cause horrible contention with DBO_TRX.
            if ( $this->getFlag( self::DBO_TRX ) || $this->getFlag( self::DBO_DEFAULT ) ) {
                $this->connLogger->warning(
                    __METHOD__ . ": ignoring DBO_PERSISTENT due to DBO_TRX or DBO_DEFAULT",
                    $this->getLogContext()
                );
            } else {
                $attributes[PDO::ATTR_PERSISTENT] = true;
            }
        }
 
        try {
            // Open the database file, creating it if it does not yet exist
            $this->conn = new PDO( "sqlite:$path", null, null, $attributes );
        } catch ( PDOException $e ) {
            throw $this->newExceptionAfterConnectError( $e->getMessage() );
        }
 
        $this->currentDomain = new DatabaseDomain( $dbName, null, $tablePrefix );
 
        try {
            $flags = self::QUERY_IGNORE_DBO_TRX | self::QUERY_NO_RETRY;
            // Enforce LIKE to be case sensitive, just like MySQL
            $this->query( 'PRAGMA case_sensitive_like = 1', __METHOD__, $flags );
            // Apply optimizations or requirements regarding fsync() usage
            $sync = $this->connectionVariables['synchronous'] ?? null;
            if ( in_array( $sync, [ 'EXTRA', 'FULL', 'NORMAL', 'OFF' ], true ) ) {
                $this->query( "PRAGMA synchronous = $sync", __METHOD__, $flags );
            }
            $this->attachDatabasesFromTableAliases();
        } catch ( Exception $e ) {
            throw $this->newExceptionAfterConnectError( $e->getMessage() );
        }
    }
 
    public function getDbFilePath() {
        return $this->dbPath ?? self::generateFileName( $this->dbDir, $this->getDBname() );
    }
 
    public function getLockFileDirectory() {
        if ( $this->dbPath !== null && !self::isProcessMemoryPath( $this->dbPath ) ) {
            return dirname( $this->dbPath ) . '/locks';
        } elseif ( $this->dbDir !== null && !self::isProcessMemoryPath( $this->dbDir ) ) {
            return $this->dbDir . '/locks';
        }
 
        return null;
    }
 
    protected function closeConnection() {
        $this->conn = null;
 
        return true;
    }
 
    public static function generateFileName( $dir, $dbName ) {
        if ( $dir == '' ) {
            throw new DBUnexpectedError( null, __CLASS__ . ": no DB directory specified" );
        } elseif ( self::isProcessMemoryPath( $dir ) ) {
            throw new DBUnexpectedError(
                null,
                __CLASS__ . ": cannot use process memory directory '$dir'"
            );
        } elseif ( !strlen( $dbName ) ) {
            throw new DBUnexpectedError( null, __CLASS__ . ": no DB name specified" );
        }
 
        return "$dir/$dbName.sqlite";
    }
 
    private static function generateDatabaseName( $path ) {
        if ( preg_match( '/^(:memory:$|file::memory:)/', $path ) ) {
            // E.g. "file::memory:?cache=shared" => ":memory":
            return ':memory:';
        } elseif ( preg_match( '/^file::([^?]+)\?mode=memory(&|$)/', $path, $m ) ) {
            // E.g. "file:memdb1?mode=memory" => ":memdb1:"
            return ":{$m[1]}:";
        } else {
            // E.g. "/home/.../some_db.sqlite3" => "some_db"
            return preg_replace( '/\.sqlite\d?$/', '', basename( $path ) );
        }
    }
 
    private static function isProcessMemoryPath( $path ) {
        return preg_match( '/^(:memory:$|file:(:memory:|[^?]+\?mode=memory(&|$)))/', $path );
    }
 
    static function getFulltextSearchModule() {
        static $cachedResult = null;
        if ( $cachedResult !== null ) {
            return $cachedResult;
        }
        $cachedResult = false;
        $table = 'dummy_search_test';
 
        $db = self::newStandaloneInstance( ':memory:' );
        if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__, true ) ) {
            $cachedResult = 'FTS3';
        }
        $db->close();
 
        return $cachedResult;
    }
 
    public function attachDatabase( $name, $file = false, $fname = __METHOD__ ) {
        $file = is_string( $file ) ? $file : self::generateFileName( $this->dbDir, $name );
        $encFile = $this->addQuotes( $file );
 
        return $this->query(
            "ATTACH DATABASE $encFile AS $name",
            $fname,
            self::QUERY_IGNORE_DBO_TRX
        );
    }
 
    protected function isWriteQuery( $sql ) {
        return parent::isWriteQuery( $sql ) && !preg_match( '/^(ATTACH|PRAGMA)\b/i', $sql );
    }
 
    protected function isTransactableQuery( $sql ) {
        return parent::isTransactableQuery( $sql ) && !in_array(
            $this->getQueryVerb( $sql ),
            [ 'ATTACH', 'PRAGMA' ],
            true
        );
    }
 
    protected function doQuery( $sql ) {
        $res = $this->getBindingHandle()->query( $sql );
        if ( $res === false ) {
            return false;
        }
 
        $resource = ResultWrapper::unwrap( $res );
        $this->lastAffectedRowCount = $resource->rowCount();
        $res = new ResultWrapper( $this, $resource->fetchAll() );
 
        return $res;
    }
 
    function freeResult( $res ) {
        if ( $res instanceof ResultWrapper ) {
            $res->free();
        }
    }
 
    function fetchObject( $res ) {
        $resource =& ResultWrapper::unwrap( $res );
 
        $cur = current( $resource );
        if ( is_array( $cur ) ) {
            next( $resource );
            $obj = new stdClass;
            foreach ( $cur as $k => $v ) {
                if ( !is_numeric( $k ) ) {
                    $obj->$k = $v;
                }
            }
 
            return $obj;
        }
 
        return false;
    }
 
    function fetchRow( $res ) {
        $resource =& ResultWrapper::unwrap( $res );
        $cur = current( $resource );
        if ( is_array( $cur ) ) {
            next( $resource );
 
            return $cur;
        }
 
        return false;
    }
 
    function numRows( $res ) {
        // false does not implement Countable
        $resource = ResultWrapper::unwrap( $res );
 
        return is_array( $resource ) ? count( $resource ) : 0;
    }
 
    function numFields( $res ) {
        $resource = ResultWrapper::unwrap( $res );
        if ( is_array( $resource ) && count( $resource ) > 0 ) {
            // The size of the result array is twice the number of fields. (T67578)
            return count( $resource[0] ) / 2;
        } else {
            // If the result is empty return 0
            return 0;
        }
    }
 
    function fieldName( $res, $n ) {
        $resource = ResultWrapper::unwrap( $res );
        if ( is_array( $resource ) ) {
            $keys = array_keys( $resource[0] );
 
            return $keys[$n];
        }
 
        return false;
    }
 
    protected function doSelectDomain( DatabaseDomain $domain ) {
        if ( $domain->getSchema() !== null ) {
            throw new DBExpectedError(
                $this,
                __CLASS__ . ": domain '{$domain->getId()}' has a schema component"
            );
        }
 
        $database = $domain->getDatabase();
        // A null database means "don't care" so leave it as is and update the table prefix
        if ( $database === null ) {
            $this->currentDomain = new DatabaseDomain(
                $this->currentDomain->getDatabase(),
                null,
                $domain->getTablePrefix()
            );
 
            return true;
        }
 
        if ( $database !== $this->getDBname() ) {
            throw new DBExpectedError(
                $this,
                __CLASS__ . ": cannot change database (got '$database')"
            );
        }
 
        return true;
    }
 
    function tableName( $name, $format = 'quoted' ) {
        // table names starting with sqlite_ are reserved
        if ( strpos( $name, 'sqlite_' ) === 0 ) {
            return $name;
        }
 
        return str_replace( '"', '', parent::tableName( $name, $format ) );
    }
 
    function insertId() {
        // PDO::lastInsertId yields a string :(
        return intval( $this->getBindingHandle()->lastInsertId() );
    }
 
    function dataSeek( $res, $row ) {
        $resource =& ResultWrapper::unwrap( $res );
        reset( $resource );
        if ( $row > 0 ) {
            for ( $i = 0; $i < $row; $i++ ) {
                next( $resource );
            }
        }
    }
 
    function lastError() {
        if ( !is_object( $this->conn ) ) {
            return "Cannot return last error, no db connection";
        }
        $e = $this->conn->errorInfo();
 
        return $e[2] ?? '';
    }
 
    function lastErrno() {
        if ( !is_object( $this->conn ) ) {
            return "Cannot return last error, no db connection";
        } else {
            $info = $this->conn->errorInfo();
 
            return $info[1];
        }
    }
 
    protected function fetchAffectedRowCount() {
        return $this->lastAffectedRowCount;
    }
 
    function tableExists( $table, $fname = __METHOD__ ) {
        $tableRaw = $this->tableName( $table, 'raw' );
        if ( isset( $this->sessionTempTables[$tableRaw] ) ) {
            return true; // already known to exist
        }
 
        $encTable = $this->addQuotes( $tableRaw );
        $res = $this->query(
            "SELECT 1 FROM sqlite_master WHERE type='table' AND name=$encTable",
            __METHOD__,
            self::QUERY_IGNORE_DBO_TRX
        );
 
        return $res->numRows() ? true : false;
    }
 
    function indexInfo( $table, $index, $fname = __METHOD__ ) {
        $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
        $res = $this->query( $sql, $fname, self::QUERY_IGNORE_DBO_TRX );
        if ( !$res || $res->numRows() == 0 ) {
            return false;
        }
        $info = [];
        foreach ( $res as $row ) {
            $info[] = $row->name;
        }
 
        return $info;
    }
 
    function indexUnique( $table, $index, $fname = __METHOD__ ) {
        $row = $this->selectRow( 'sqlite_master', '*',
            [
                'type' => 'index',
                'name' => $this->indexName( $index ),
            ], $fname );
        if ( !$row || !isset( $row->sql ) ) {
            return null;
        }
 
        // $row->sql will be of the form CREATE [UNIQUE] INDEX ...
        $indexPos = strpos( $row->sql, 'INDEX' );
        if ( $indexPos === false ) {
            return null;
        }
        $firstPart = substr( $row->sql, 0, $indexPos );
        $options = explode( ' ', $firstPart );
 
        return in_array( 'UNIQUE', $options );
    }
 
    protected function makeSelectOptions( array $options ) {
        // Remove problematic options that the base implementation converts to SQL
        foreach ( $options as $k => $v ) {
            if ( is_numeric( $k ) && ( $v === 'FOR UPDATE' || $v === 'LOCK IN SHARE MODE' ) ) {
                $options[$k] = '';
            }
        }
 
        return parent::makeSelectOptions( $options );
    }
 
    protected function makeUpdateOptionsArray( $options ) {
        $options = parent::makeUpdateOptionsArray( $options );
        $options = self::fixIgnore( $options );
 
        return $options;
    }
 
    static function fixIgnore( $options ) {
        # SQLite uses OR IGNORE not just IGNORE
        foreach ( $options as $k => $v ) {
            if ( $v == 'IGNORE' ) {
                $options[$k] = 'OR IGNORE';
            }
        }
 
        return $options;
    }
 
    function makeInsertOptions( $options ) {
        $options = self::fixIgnore( $options );
 
        return parent::makeInsertOptions( $options );
    }
 
    function insert( $table, $a, $fname = __METHOD__, $options = [] ) {
        if ( !count( $a ) ) {
            return true;
        }
 
        # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts
        if ( isset( $a[0] ) && is_array( $a[0] ) ) {
            $affectedRowCount = 0;
            try {
                $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
                foreach ( $a as $v ) {
                    parent::insert( $table, $v, "$fname/multi-row", $options );
                    $affectedRowCount += $this->affectedRows();
                }
                $this->endAtomic( $fname );
            } catch ( Exception $e ) {
                $this->cancelAtomic( $fname );
                throw $e;
            }
            $this->affectedRowCount = $affectedRowCount;
        } else {
            parent::insert( $table, $a, "$fname/single-row", $options );
        }
 
        return true;
    }
 
    function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
        if ( !count( $rows ) ) {
            return;
        }
 
        # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries
        if ( isset( $rows[0] ) && is_array( $rows[0] ) ) {
            $affectedRowCount = 0;
            try {
                $this->startAtomic( $fname, self::ATOMIC_CANCELABLE );
                foreach ( $rows as $v ) {
                    $this->nativeReplace( $table, $v, "$fname/multi-row" );
                    $affectedRowCount += $this->affectedRows();
                }
                $this->endAtomic( $fname );
            } catch ( Exception $e ) {
                $this->cancelAtomic( $fname );
                throw $e;
            }
            $this->affectedRowCount = $affectedRowCount;
        } else {
            $this->nativeReplace( $table, $rows, "$fname/single-row" );
        }
    }
 
    function textFieldSize( $table, $field ) {
        return -1;
    }
 
    function unionSupportsOrderAndLimit() {
        return false;
    }
 
    function unionQueries( $sqls, $all ) {
        $glue = $all ? ' UNION ALL ' : ' UNION ';
 
        return implode( $glue, $sqls );
    }
 
    function wasDeadlock() {
        return $this->lastErrno() == 5; // SQLITE_BUSY
    }
 
    function wasReadOnlyError() {
        return $this->lastErrno() == 8; // SQLITE_READONLY;
    }
 
    public function wasConnectionError( $errno ) {
        return $errno == 17; // SQLITE_SCHEMA;
    }
 
    protected function wasKnownStatementRollbackError() {
        // ON CONFLICT ROLLBACK clauses make it so that SQLITE_CONSTRAINT error is
        // ambiguous with regard to whether it implies a ROLLBACK or an ABORT happened.
        // https://sqlite.org/lang_createtable.html#uniqueconst
        // https://sqlite.org/lang_conflict.html
        return false;
    }
 
    public function serverIsReadOnly() {
        $this->assertHasConnectionHandle();
 
        $path = $this->getDbFilePath();
 
        return ( !self::isProcessMemoryPath( $path ) && !is_writable( $path ) );
    }
 
    public function getSoftwareLink() {
        return "[{{int:version-db-sqlite-url}} SQLite]";
    }
 
    function getServerVersion() {
        $ver = $this->getBindingHandle()->getAttribute( PDO::ATTR_SERVER_VERSION );
 
        return $ver;
    }
 
    function fieldInfo( $table, $field ) {
        $tableName = $this->tableName( $table );
        $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
        $res = $this->query( $sql, __METHOD__, self::QUERY_IGNORE_DBO_TRX );
        foreach ( $res as $row ) {
            if ( $row->name == $field ) {
                return new SQLiteField( $row, $tableName );
            }
        }
 
        return false;
    }
 
    protected function doBegin( $fname = '' ) {
        if ( $this->trxMode != '' ) {
            $this->query( "BEGIN {$this->trxMode}", $fname );
        } else {
            $this->query( 'BEGIN', $fname );
        }
    }
 
    function strencode( $s ) {
        return substr( $this->addQuotes( $s ), 1, -1 );
    }
 
    function encodeBlob( $b ) {
        return new Blob( $b );
    }
 
    function decodeBlob( $b ) {
        if ( $b instanceof Blob ) {
            $b = $b->fetch();
        }
 
        return $b;
    }
 
    function addQuotes( $s ) {
        if ( $s instanceof Blob ) {
            return "x'" . bin2hex( $s->fetch() ) . "'";
        } elseif ( is_bool( $s ) ) {
            return (int)$s;
        } elseif ( strpos( (string)$s, "\0" ) !== false ) {
            // SQLite doesn't support \0 in strings, so use the hex representation as a workaround.
            // This is a known limitation of SQLite's mprintf function which PDO
            // should work around, but doesn't. I have reported this to php.net as bug #63419:
            // https://bugs.php.net/bug.php?id=63419
            // There was already a similar report for SQLite3::escapeString, bug #62361:
            // https://bugs.php.net/bug.php?id=62361
            // There is an additional bug regarding sorting this data after insert
            // on older versions of sqlite shipped with ubuntu 12.04
            // https://phabricator.wikimedia.org/T74367
            $this->queryLogger->debug(
                __FUNCTION__ .
                ': Quoting value containing null byte. ' .
                'For consistency all binary data should have been ' .
                'first processed with self::encodeBlob()'
            );
            return "x'" . bin2hex( (string)$s ) . "'";
        } else {
            return $this->getBindingHandle()->quote( (string)$s );
        }
    }
 
    public function buildSubstring( $input, $startPosition, $length = null ) {
        $this->assertBuildSubstringParams( $startPosition, $length );
        $params = [ $input, $startPosition ];
        if ( $length !== null ) {
            $params[] = $length;
        }
        return 'SUBSTR(' . implode( ',', $params ) . ')';
    }
 
    public function buildStringCast( $field ) {
        return 'CAST ( ' . $field . ' AS TEXT )';
    }
 
    public function deadlockLoop( /*...*/ ) {
        $args = func_get_args();
        $function = array_shift( $args );
 
        return $function( ...$args );
    }
 
    protected function replaceVars( $s ) {
        $s = parent::replaceVars( $s );
        if ( preg_match( '/^\s*(CREATE|ALTER) TABLE/i', $s ) ) {
            // CREATE TABLE hacks to allow schema file sharing with MySQL
 
            // binary/varbinary column type -> blob
            $s = preg_replace( '/\b(var)?binary(\‍(\d+\‍))/i', 'BLOB', $s );
            // 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*\‍(\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( '/\b(var)?char\s*\‍(.*?\‍)/i', 'TEXT', $s );
            // TEXT normalization
            $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s );
            // BLOB normalization
            $s = preg_replace( '/\b(tiny|small|medium|long|)blob\b/i', 'BLOB', $s );
            // BOOL -> INTEGER
            $s = preg_replace( '/\bbool(ean)?\b/i', 'INTEGER', $s );
            // DATETIME -> TEXT
            $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s );
            // No ENUM type
            $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 );
            // No FULLTEXT
            $s = preg_replace( '/\bfulltext\b/i', '', $s );
        } elseif ( preg_match( '/^\s*DROP INDEX/i', $s ) ) {
            // DROP INDEX is database-wide, not table-specific, so no ON <table> clause.
            $s = preg_replace( '/\sON\s+[^\s]*/i', '', $s );
        } elseif ( preg_match( '/^\s*INSERT IGNORE\b/i', $s ) ) {
            // INSERT IGNORE --> INSERT OR IGNORE
            $s = preg_replace( '/^\s*INSERT IGNORE\b/i', 'INSERT OR IGNORE', $s );
        }
 
        return $s;
    }
 
    public function lock( $lockName, $method, $timeout = 5 ) {
        $status = $this->lockMgr->lock( [ $lockName ], LockManager::LOCK_EX, $timeout );
        if (
            $this->lockMgr instanceof FSLockManager &&
            $status->hasMessage( 'lockmanager-fail-openlock' )
        ) {
            throw new DBError( $this, "Cannot create directory \"{$this->getLockFileDirectory()}\"" );
        }
 
        return $status->isOK();
    }
 
    public function unlock( $lockName, $method ) {
        return $this->lockMgr->unlock( [ $lockName ], LockManager::LOCK_EX )->isGood();
    }
 
    function buildConcat( $stringList ) {
        return '(' . implode( ') || (', $stringList ) . ')';
    }
 
    public function buildGroupConcatField(
        $delim, $table, $field, $conds = '', $join_conds = []
    ) {
        $fld = "group_concat($field," . $this->addQuotes( $delim ) . ')';
 
        return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
    }
 
    function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__ ) {
        $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name=" .
            $this->addQuotes( $oldName ) . " AND type='table'", $fname );
        $obj = $this->fetchObject( $res );
        if ( !$obj ) {
            throw new RuntimeException( "Couldn't retrieve structure for table $oldName" );
        }
        $sql = $obj->sql;
        $sql = preg_replace(
            '/(?<=\W)"?' .
                preg_quote( trim( $this->addIdentifierQuotes( $oldName ), '"' ), '/' ) .
                '"?(?=\W)/',
            $this->addIdentifierQuotes( $newName ),
            $sql,
            1
        );
        if ( $temporary ) {
            if ( preg_match( '/^\\s*CREATE\\s+VIRTUAL\\s+TABLE\b/i', $sql ) ) {
                $this->queryLogger->debug(
                    "Table $oldName is virtual, can't create a temporary duplicate.\n" );
            } else {
                $sql = str_replace( 'CREATE TABLE', 'CREATE TEMPORARY TABLE', $sql );
            }
        }
 
        $res = $this->query( $sql, $fname, self::QUERY_PSEUDO_PERMANENT );
 
        // Take over indexes
        $indexList = $this->query( 'PRAGMA INDEX_LIST(' . $this->addQuotes( $oldName ) . ')' );
        foreach ( $indexList as $index ) {
            if ( strpos( $index->name, 'sqlite_autoindex' ) === 0 ) {
                continue;
            }
 
            if ( $index->unique ) {
                $sql = 'CREATE UNIQUE INDEX';
            } else {
                $sql = 'CREATE INDEX';
            }
            // Try to come up with a new index name, given indexes have database scope in SQLite
            $indexName = $newName . '_' . $index->name;
            $sql .= ' ' . $indexName . ' ON ' . $newName;
 
            $indexInfo = $this->query( 'PRAGMA INDEX_INFO(' . $this->addQuotes( $index->name ) . ')' );
            $fields = [];
            foreach ( $indexInfo as $indexInfoRow ) {
                $fields[$indexInfoRow->seqno] = $indexInfoRow->name;
            }
 
            $sql .= '(' . implode( ',', $fields ) . ')';
 
            $this->query( $sql );
        }
 
        return $res;
    }
 
    function listTables( $prefix = null, $fname = __METHOD__ ) {
        $result = $this->select(
            'sqlite_master',
            'name',
            "type='table'"
        );
 
        $endArray = [];
 
        foreach ( $result as $table ) {
            $vars = get_object_vars( $table );
            $table = array_pop( $vars );
 
            if ( !$prefix || strpos( $table, $prefix ) === 0 ) {
                if ( strpos( $table, 'sqlite_' ) !== 0 ) {
                    $endArray[] = $table;
                }
            }
        }
 
        return $endArray;
    }
 
    public function dropTable( $tableName, $fName = __METHOD__ ) {
        if ( !$this->tableExists( $tableName, $fName ) ) {
            return false;
        }
        $sql = "DROP TABLE " . $this->tableName( $tableName );
 
        return $this->query( $sql, $fName, self::QUERY_IGNORE_DBO_TRX );
    }
 
    public function setTableAliases( array $aliases ) {
        parent::setTableAliases( $aliases );
        if ( $this->isOpen() ) {
            $this->attachDatabasesFromTableAliases();
        }
    }
 
    private function attachDatabasesFromTableAliases() {
        foreach ( $this->tableAliases as $params ) {
            if (
                $params['dbname'] !== $this->getDBname() &&
                !isset( $this->sessionAttachedDbs[$params['dbname']] )
            ) {
                $this->attachDatabase( $params['dbname'] );
                $this->sessionAttachedDbs[$params['dbname']] = true;
            }
        }
    }
 
    public function resetSequenceForTable( $table, $fname = __METHOD__ ) {
        $encTable = $this->addIdentifierQuotes( 'sqlite_sequence' );
        $encName = $this->addQuotes( $this->tableName( $table, 'raw' ) );
        $this->query(
            "DELETE FROM $encTable WHERE name = $encName",
            $fname,
            self::QUERY_IGNORE_DBO_TRX
        );
    }
 
    public function databasesAreIndependent() {
        return true;
    }
 
    protected function doHandleSessionLossPreconnect() {
        $this->sessionAttachedDbs = [];
    }
 
    protected function getBindingHandle() {
        return parent::getBindingHandle();
    }
}
 
class_alias( DatabaseSqlite::class, 'DatabaseSqlite' );