'DatabaseMysqli' => __DIR__ . '/includes/libs/rdbms/database/DatabaseMysqli.php',
'DatabaseOracle' => __DIR__ . '/includes/db/DatabaseOracle.php',
'DatabasePostgres' => __DIR__ . '/includes/db/DatabasePostgres.php',
- 'DatabaseSqlite' => __DIR__ . '/includes/db/DatabaseSqlite.php',
+ 'DatabaseSqlite' => __DIR__ . '/includes/libs/rdbms/database/DatabaseSqlite.php',
'DatabaseUpdater' => __DIR__ . '/includes/installer/DatabaseUpdater.php',
'DateFormats' => __DIR__ . '/maintenance/language/date-formats.php',
'DateFormatter' => __DIR__ . '/includes/parser/DateFormatter.php',
'FSFileBackendFileList' => __DIR__ . '/includes/filebackend/FSFileBackend.php',
'FSFileBackendList' => __DIR__ . '/includes/filebackend/FSFileBackend.php',
'FSFileOpHandle' => __DIR__ . '/includes/filebackend/FSFileBackend.php',
- 'FSLockManager' => __DIR__ . '/includes/filebackend/lockmanager/FSLockManager.php',
+ 'FSLockManager' => __DIR__ . '/includes/libs/lockmanager/FSLockManager.php',
'FSRepo' => __DIR__ . '/includes/filerepo/FSRepo.php',
'FakeAuthTemplate' => __DIR__ . '/includes/specialpage/LoginSignupSpecialPage.php',
'FakeConverter' => __DIR__ . '/languages/FakeConverter.php',
'LocalSettingsGenerator' => __DIR__ . '/includes/installer/LocalSettingsGenerator.php',
'LocalisationCache' => __DIR__ . '/includes/cache/localisation/LocalisationCache.php',
'LocalisationCacheBulkLoad' => __DIR__ . '/includes/cache/localisation/LocalisationCacheBulkLoad.php',
- 'LockManager' => __DIR__ . '/includes/filebackend/lockmanager/LockManager.php',
+ 'LockManager' => __DIR__ . '/includes/libs/lockmanager/LockManager.php',
'LockManagerGroup' => __DIR__ . '/includes/filebackend/lockmanager/LockManagerGroup.php',
'LogEntry' => __DIR__ . '/includes/logging/LogEntry.php',
'LogEntryBase' => __DIR__ . '/includes/logging/LogEntry.php',
'NullFileOp' => __DIR__ . '/includes/filebackend/FileOp.php',
'NullIndexField' => __DIR__ . '/includes/search/NullIndexField.php',
'NullJob' => __DIR__ . '/includes/jobqueue/jobs/NullJob.php',
- 'NullLockManager' => __DIR__ . '/includes/filebackend/lockmanager/LockManager.php',
+ 'NullLockManager' => __DIR__ . '/includes/libs/lockmanager/NullLockManager.php',
'NullRepo' => __DIR__ . '/includes/filerepo/NullRepo.php',
'NullStatsdDataFactory' => __DIR__ . '/includes/libs/stats/NullStatsdDataFactory.php',
'NumericUppercaseCollation' => __DIR__ . '/includes/collation/NumericUppercaseCollation.php',
'PurgeParserCache' => __DIR__ . '/maintenance/purgeParserCache.php',
'QueryPage' => __DIR__ . '/includes/specialpage/QueryPage.php',
'QuickTemplate' => __DIR__ . '/includes/skins/QuickTemplate.php',
- 'QuorumLockManager' => __DIR__ . '/includes/filebackend/lockmanager/QuorumLockManager.php',
+ 'QuorumLockManager' => __DIR__ . '/includes/libs/lockmanager/QuorumLockManager.php',
'RCCacheEntry' => __DIR__ . '/includes/changes/RCCacheEntry.php',
'RCCacheEntryFactory' => __DIR__ . '/includes/changes/RCCacheEntryFactory.php',
'RCDatabaseLogEntry' => __DIR__ . '/includes/logging/LogEntry.php',
# Obsolete aliases
define( 'DB_SLAVE', -1 );
+/**@{
+ * Obsolete IDatabase::makeList() constants
+ * These are also available as Database class constants
+ */
+define( 'LIST_COMMA', IDatabase::LIST_COMMA );
+define( 'LIST_AND', IDatabase::LIST_AND );
+define( 'LIST_SET', IDatabase::LIST_SET );
+define( 'LIST_NAMES', IDatabase::LIST_NAMES );
+define( 'LIST_OR', IDatabase::LIST_OR );
+/**@}*/
+
/**@{
* Virtual namespaces; don't appear in the page database
*/
if ( $class === 'LBFactorySimple' ) {
if ( is_array( $mainConfig->get( 'DBservers' ) ) ) {
foreach ( $mainConfig->get( 'DBservers' ) as $i => $server ) {
+ if ( $server['type'] === 'sqlite' ) {
+ $server += [ 'dbDirectory' => $mainConfig->get( 'SQLiteDataDir' ) ];
+ }
$lbConf['servers'][$i] = $server + [
'schema' => $mainConfig->get( 'DBmwschema' ),
'tablePrefix' => $mainConfig->get( 'DBprefix' ),
$flags |= $mainConfig->get( 'DebugDumpSql' ) ? DBO_DEBUG : 0;
$flags |= $mainConfig->get( 'DBssl' ) ? DBO_SSL : 0;
$flags |= $mainConfig->get( 'DBcompress' ) ? DBO_COMPRESS : 0;
- $lbConf['servers'] = [
- [
- 'host' => $mainConfig->get( 'DBserver' ),
- 'user' => $mainConfig->get( 'DBuser' ),
- 'password' => $mainConfig->get( 'DBpassword' ),
- 'dbname' => $mainConfig->get( 'DBname' ),
- 'schema' => $mainConfig->get( 'DBmwschema' ),
- 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
- 'type' => $mainConfig->get( 'DBtype' ),
- 'load' => 1,
- 'flags' => $flags,
- 'sqlMode' => $mainConfig->get( 'SQLMode' ),
- 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
- ]
+ $server = [
+ 'host' => $mainConfig->get( 'DBserver' ),
+ 'user' => $mainConfig->get( 'DBuser' ),
+ 'password' => $mainConfig->get( 'DBpassword' ),
+ 'dbname' => $mainConfig->get( 'DBname' ),
+ 'schema' => $mainConfig->get( 'DBmwschema' ),
+ 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
+ 'type' => $mainConfig->get( 'DBtype' ),
+ 'load' => 1,
+ 'flags' => $flags,
+ 'sqlMode' => $mainConfig->get( 'SQLMode' ),
+ 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
];
+ if ( $server['type'] === 'sqlite' ) {
+ $server[ 'dbDirectory'] = $mainConfig->get( 'SQLiteDataDir' );
+ }
+ $lbConf['servers'] = [ $server ];
}
+
$lbConf['externalServers'] = $mainConfig->get( 'ExternalServers' );
}
+++ /dev/null
-<?php
-/**
- * This is the SQLite database abstraction layer.
- * See maintenance/sqlite/README for development notes and other specific information
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Database
- */
-
-/**
- * @ingroup Database
- */
-class DatabaseSqlite extends DatabaseBase {
- /** @var bool Whether full text is enabled */
- private static $fulltextEnabled = null;
-
- /** @var string Directory */
- protected $dbDir;
-
- /** @var string File name for SQLite database file */
- protected $dbPath;
-
- /** @var string Transaction mode */
- protected $trxMode;
-
- /** @var int The number of rows affected as an integer */
- protected $mAffectedRows;
-
- /** @var resource */
- protected $mLastResult;
-
- /** @var PDO */
- protected $mConn;
-
- /** @var FSLockManager (hopefully on the same server as the DB) */
- protected $lockMgr;
-
- /**
- * Additional params include:
- * - dbDirectory : directory containing the DB and the lock file directory
- * [defaults to $wgSQLiteDataDir]
- * - dbFilePath : use this to force the path of the DB file
- * - trxMode : one of (deferred, immediate, exclusive)
- * @param array $p
- */
- function __construct( array $p ) {
- global $wgSQLiteDataDir;
-
- $this->dbDir = isset( $p['dbDirectory'] ) ? $p['dbDirectory'] : $wgSQLiteDataDir;
-
- if ( isset( $p['dbFilePath'] ) ) {
- parent::__construct( $p );
- // Standalone .sqlite file mode.
- // Super doesn't open when $user is false, but we can work with $dbName,
- // which is derived from the file path in this case.
- $this->openFile( $p['dbFilePath'] );
- } else {
- $this->mDBname = $p['dbname'];
- // Stock wiki mode using standard file names per DB.
- parent::__construct( $p );
- // Super doesn't open when $user is false, but we can work with $dbName
- if ( $p['dbname'] && !$this->isOpen() ) {
- if ( $this->open( $p['host'], $p['user'], $p['password'], $p['dbname'] ) ) {
- $done = [];
- foreach ( $this->tableAliases as $params ) {
- if ( isset( $done[$params['dbname']] ) ) {
- continue;
- }
- $this->attachDatabase( $params['dbname'] );
- $done[$params['dbname']] = 1;
- }
- }
- }
- }
-
- $this->trxMode = isset( $p['trxMode'] ) ? strtoupper( $p['trxMode'] ) : null;
- if ( $this->trxMode &&
- !in_array( $this->trxMode, [ 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ] )
- ) {
- $this->trxMode = null;
- wfWarn( "Invalid SQLite transaction mode provided." );
- }
-
- $this->lockMgr = new FSLockManager( [ 'lockDirectory' => "{$this->dbDir}/locks" ] );
- }
-
- /**
- * @param string $filename
- * @param array $p Options map; supports:
- * - flags : (same as __construct counterpart)
- * - trxMode : (same as __construct counterpart)
- * - dbDirectory : (same as __construct counterpart)
- * @return DatabaseSqlite
- * @since 1.25
- */
- public static function newStandaloneInstance( $filename, array $p = [] ) {
- $p['dbFilePath'] = $filename;
- $p['schema'] = false;
- $p['tablePrefix'] = '';
-
- return DatabaseBase::factory( 'sqlite', $p );
- }
-
- /**
- * @return string
- */
- function getType() {
- return 'sqlite';
- }
-
- /**
- * @todo Check if it should be true like parent class
- *
- * @return bool
- */
- function implicitGroupby() {
- return false;
- }
-
- /** Open an SQLite database and return a resource handle to it
- * NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases
- *
- * @param string $server
- * @param string $user
- * @param string $pass
- * @param string $dbName
- *
- * @throws DBConnectionError
- * @return PDO
- */
- function open( $server, $user, $pass, $dbName ) {
- $this->close();
- $fileName = self::generateFileName( $this->dbDir, $dbName );
- if ( !is_readable( $fileName ) ) {
- $this->mConn = false;
- throw new DBConnectionError( $this, "SQLite database not accessible" );
- }
- $this->openFile( $fileName );
-
- return $this->mConn;
- }
-
- /**
- * Opens a database file
- *
- * @param string $fileName
- * @throws DBConnectionError
- * @return PDO|bool SQL connection or false if failed
- */
- protected function openFile( $fileName ) {
- $err = false;
-
- $this->dbPath = $fileName;
- try {
- if ( $this->mFlags & DBO_PERSISTENT ) {
- $this->mConn = new PDO( "sqlite:$fileName", '', '',
- [ PDO::ATTR_PERSISTENT => true ] );
- } else {
- $this->mConn = new PDO( "sqlite:$fileName", '', '' );
- }
- } catch ( PDOException $e ) {
- $err = $e->getMessage();
- }
-
- if ( !$this->mConn ) {
- wfDebug( "DB connection error: $err\n" );
- throw new DBConnectionError( $this, $err );
- }
-
- $this->mOpened = !!$this->mConn;
- if ( $this->mOpened ) {
- # Set error codes only, don't raise exceptions
- $this->mConn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT );
- # Enforce LIKE to be case sensitive, just like MySQL
- $this->query( 'PRAGMA case_sensitive_like = 1' );
-
- return $this->mConn;
- }
-
- return false;
- }
-
- /**
- * @return string SQLite DB file path
- * @since 1.25
- */
- public function getDbFilePath() {
- return $this->dbPath;
- }
-
- /**
- * Does not actually close the connection, just destroys the reference for GC to do its work
- * @return bool
- */
- protected function closeConnection() {
- $this->mConn = null;
-
- return true;
- }
-
- /**
- * Generates a database file name. Explicitly public for installer.
- * @param string $dir Directory where database resides
- * @param string $dbName Database name
- * @return string
- */
- public static function generateFileName( $dir, $dbName ) {
- return "$dir/$dbName.sqlite";
- }
-
- /**
- * Check if the searchindext table is FTS enabled.
- * @return bool 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
- */
- 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;
- }
-
- /**
- * Attaches external database to our connection, see http://sqlite.org/lang_attach.html
- * for details.
- *
- * @param string $name Database name to be used in queries like
- * SELECT foo FROM dbname.table
- * @param bool|string $file Database file name. If omitted, will be generated
- * using $name and configured data directory
- * @param string $fname Calling function name
- * @return ResultWrapper
- */
- function attachDatabase( $name, $file = false, $fname = __METHOD__ ) {
- if ( !$file ) {
- $file = self::generateFileName( $this->dbDir, $name );
- }
- $file = $this->addQuotes( $file );
-
- return $this->query( "ATTACH DATABASE $file AS $name", $fname );
- }
-
- function isWriteQuery( $sql ) {
- return parent::isWriteQuery( $sql ) && !preg_match( '/^(ATTACH|PRAGMA)\b/i', $sql );
- }
-
- /**
- * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result
- *
- * @param string $sql
- * @return bool|ResultWrapper
- */
- protected function doQuery( $sql ) {
- $res = $this->mConn->query( $sql );
- if ( $res === false ) {
- return false;
- } else {
- $r = $res instanceof ResultWrapper ? $res->result : $res;
- $this->mAffectedRows = $r->rowCount();
- $res = new ResultWrapper( $this, $r->fetchAll() );
- }
-
- return $res;
- }
-
- /**
- * @param ResultWrapper|mixed $res
- */
- function freeResult( $res ) {
- if ( $res instanceof ResultWrapper ) {
- $res->result = null;
- } else {
- $res = null;
- }
- }
-
- /**
- * @param ResultWrapper|array $res
- * @return stdClass|bool
- */
- function fetchObject( $res ) {
- if ( $res instanceof ResultWrapper ) {
- $r =& $res->result;
- } else {
- $r =& $res;
- }
-
- $cur = current( $r );
- if ( is_array( $cur ) ) {
- next( $r );
- $obj = new stdClass;
- foreach ( $cur as $k => $v ) {
- if ( !is_numeric( $k ) ) {
- $obj->$k = $v;
- }
- }
-
- return $obj;
- }
-
- return false;
- }
-
- /**
- * @param ResultWrapper|mixed $res
- * @return array|bool
- */
- function fetchRow( $res ) {
- if ( $res instanceof ResultWrapper ) {
- $r =& $res->result;
- } else {
- $r =& $res;
- }
- $cur = current( $r );
- if ( is_array( $cur ) ) {
- next( $r );
-
- return $cur;
- }
-
- return false;
- }
-
- /**
- * The PDO::Statement class implements the array interface so count() will work
- *
- * @param ResultWrapper|array $res
- * @return int
- */
- function numRows( $res ) {
- $r = $res instanceof ResultWrapper ? $res->result : $res;
-
- return count( $r );
- }
-
- /**
- * @param ResultWrapper $res
- * @return int
- */
- function numFields( $res ) {
- $r = $res instanceof ResultWrapper ? $res->result : $res;
- if ( is_array( $r ) && count( $r ) > 0 ) {
- // The size of the result array is twice the number of fields. (Bug: 65578)
- return count( $r[0] ) / 2;
- } else {
- // If the result is empty return 0
- return 0;
- }
- }
-
- /**
- * @param ResultWrapper $res
- * @param int $n
- * @return bool
- */
- function fieldName( $res, $n ) {
- $r = $res instanceof ResultWrapper ? $res->result : $res;
- if ( is_array( $r ) ) {
- $keys = array_keys( $r[0] );
-
- return $keys[$n];
- }
-
- return false;
- }
-
- /**
- * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks
- *
- * @param string $name
- * @param string $format
- * @return string
- */
- 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 ) );
- }
-
- /**
- * Index names have DB scope
- *
- * @param string $index
- * @return string
- */
- protected function indexName( $index ) {
- return $index;
- }
-
- /**
- * This must be called after nextSequenceVal
- *
- * @return int
- */
- function insertId() {
- // PDO::lastInsertId yields a string :(
- return intval( $this->mConn->lastInsertId() );
- }
-
- /**
- * @param ResultWrapper|array $res
- * @param int $row
- */
- function dataSeek( $res, $row ) {
- if ( $res instanceof ResultWrapper ) {
- $r =& $res->result;
- } else {
- $r =& $res;
- }
- reset( $r );
- if ( $row > 0 ) {
- for ( $i = 0; $i < $row; $i++ ) {
- next( $r );
- }
- }
- }
-
- /**
- * @return string
- */
- function lastError() {
- if ( !is_object( $this->mConn ) ) {
- return "Cannot return last error, no db connection";
- }
- $e = $this->mConn->errorInfo();
-
- return isset( $e[2] ) ? $e[2] : '';
- }
-
- /**
- * @return string
- */
- function lastErrno() {
- if ( !is_object( $this->mConn ) ) {
- return "Cannot return last error, no db connection";
- } else {
- $info = $this->mConn->errorInfo();
-
- return $info[1];
- }
- }
-
- /**
- * @return int
- */
- function affectedRows() {
- return $this->mAffectedRows;
- }
-
- /**
- * Returns information about an index
- * Returns false if the index does not exist
- * - if errors are explicitly ignored, returns NULL on failure
- *
- * @param string $table
- * @param string $index
- * @param string $fname
- * @return array
- */
- function indexInfo( $table, $index, $fname = __METHOD__ ) {
- $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
- $res = $this->query( $sql, $fname );
- if ( !$res ) {
- return null;
- }
- if ( $res->numRows() == 0 ) {
- return false;
- }
- $info = [];
- foreach ( $res as $row ) {
- $info[] = $row->name;
- }
-
- return $info;
- }
-
- /**
- * @param string $table
- * @param string $index
- * @param string $fname
- * @return bool|null
- */
- 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 );
- }
-
- /**
- * Filter the options used in SELECT statements
- *
- * @param array $options
- * @return array
- */
- function makeSelectOptions( $options ) {
- foreach ( $options as $k => $v ) {
- if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' || $v == 'LOCK IN SHARE MODE' ) ) {
- $options[$k] = '';
- }
- }
-
- return parent::makeSelectOptions( $options );
- }
-
- /**
- * @param array $options
- * @return string
- */
- protected function makeUpdateOptionsArray( $options ) {
- $options = parent::makeUpdateOptionsArray( $options );
- $options = self::fixIgnore( $options );
-
- return $options;
- }
-
- /**
- * @param array $options
- * @return array
- */
- 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;
- }
-
- /**
- * @param array $options
- * @return string
- */
- function makeInsertOptions( $options ) {
- $options = self::fixIgnore( $options );
-
- return parent::makeInsertOptions( $options );
- }
-
- /**
- * Based on generic method (parent) with some prior SQLite-sepcific adjustments
- * @param string $table
- * @param array $a
- * @param string $fname
- * @param array $options
- * @return bool
- */
- 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] ) ) {
- $ret = true;
- 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 );
- }
-
- return $ret;
- }
-
- /**
- * @param string $table
- * @param array $uniqueIndexes Unused
- * @param string|array $rows
- * @param string $fname
- * @return bool|ResultWrapper
- */
- function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
- 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 $v ) {
- if ( !$this->nativeReplace( $table, $v, "$fname/multi-row" ) ) {
- $ret = false;
- }
- }
- } else {
- $ret = $this->nativeReplace( $table, $rows, "$fname/single-row" );
- }
-
- return $ret;
- }
-
- /**
- * Returns the size of a text field, or -1 for "unlimited"
- * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though.
- *
- * @param string $table
- * @param string $field
- * @return int
- */
- function textFieldSize( $table, $field ) {
- return -1;
- }
-
- /**
- * @return bool
- */
- function unionSupportsOrderAndLimit() {
- return false;
- }
-
- /**
- * @param string $sqls
- * @param bool $all Whether to "UNION ALL" or not
- * @return string
- */
- function unionQueries( $sqls, $all ) {
- $glue = $all ? ' UNION ALL ' : ' UNION ';
-
- return implode( $glue, $sqls );
- }
-
- /**
- * @return bool
- */
- function wasDeadlock() {
- return $this->lastErrno() == 5; // SQLITE_BUSY
- }
-
- /**
- * @return bool
- */
- function wasErrorReissuable() {
- return $this->lastErrno() == 17; // SQLITE_SCHEMA;
- }
-
- /**
- * @return bool
- */
- function wasReadOnlyError() {
- return $this->lastErrno() == 8; // SQLITE_READONLY;
- }
-
- /**
- * @return string Wikitext of a link to the server software's web site
- */
- public function getSoftwareLink() {
- return "[{{int:version-db-sqlite-url}} SQLite]";
- }
-
- /**
- * @return string Version information from the database
- */
- function getServerVersion() {
- $ver = $this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION );
-
- return $ver;
- }
-
- /**
- * @return string User-friendly database information
- */
- public function getServerInfo() {
- return wfMessage( self::getFulltextSearchModule()
- ? 'sqlite-has-fts'
- : 'sqlite-no-fts', $this->getServerVersion() )->text();
- }
-
- /**
- * Get information about a given field
- * Returns false if the field does not exist.
- *
- * @param string $table
- * @param string $field
- * @return SQLiteField|bool False on failure
- */
- function fieldInfo( $table, $field ) {
- $tableName = $this->tableName( $table );
- $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
- $res = $this->query( $sql, __METHOD__ );
- 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 );
- }
- $this->mTrxLevel = 1;
- }
-
- /**
- * @param string $s
- * @return string
- */
- function strencode( $s ) {
- return substr( $this->addQuotes( $s ), 1, -1 );
- }
-
- /**
- * @param string $b
- * @return Blob
- */
- function encodeBlob( $b ) {
- return new Blob( $b );
- }
-
- /**
- * @param Blob|string $b
- * @return string
- */
- function decodeBlob( $b ) {
- if ( $b instanceof Blob ) {
- $b = $b->fetch();
- }
-
- return $b;
- }
-
- /**
- * @param Blob|string $s
- * @return string
- */
- function addQuotes( $s ) {
- if ( $s instanceof Blob ) {
- return "x'" . bin2hex( $s->fetch() ) . "'";
- } elseif ( is_bool( $s ) ) {
- return (int)$s;
- } elseif ( strpos( $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
- wfDebugLog(
- __CLASS__,
- __FUNCTION__ .
- ': Quoting value containing null byte. ' .
- 'For consistency all binary data should have been ' .
- 'first processed with self::encodeBlob()'
- );
- return "x'" . bin2hex( $s ) . "'";
- } else {
- return $this->mConn->quote( $s );
- }
- }
-
- /**
- * @return string
- */
- function buildLike() {
- $params = func_get_args();
- if ( count( $params ) > 0 && is_array( $params[0] ) ) {
- $params = $params[0];
- }
-
- return parent::buildLike( $params ) . "ESCAPE '\' ";
- }
-
- /**
- * @param string $field Field or column to cast
- * @return string
- * @since 1.28
- */
- public function buildStringCast( $field ) {
- return 'CAST ( ' . $field . ' AS TEXT )';
- }
-
- /**
- * @return string
- */
- public function getSearchEngine() {
- return "SearchSqlite";
- }
-
- /**
- * No-op version of deadlockLoop
- *
- * @return mixed
- */
- public function deadlockLoop( /*...*/ ) {
- $args = func_get_args();
- $function = array_shift( $args );
-
- return call_user_func_array( $function, $args );
- }
-
- /**
- * @param string $s
- * @return string
- */
- 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 ) {
- if ( !is_dir( "{$this->dbDir}/locks" ) ) { // create dir as needed
- if ( !is_writable( $this->dbDir ) || !mkdir( "{$this->dbDir}/locks" ) ) {
- throw new DBError( $this, "Cannot create directory \"{$this->dbDir}/locks\"." );
- }
- }
-
- return $this->lockMgr->lock( [ $lockName ], LockManager::LOCK_EX, $timeout )->isOK();
- }
-
- public function unlock( $lockName, $method ) {
- return $this->lockMgr->unlock( [ $lockName ], LockManager::LOCK_EX )->isOK();
- }
-
- /**
- * Build a concatenation list to feed into a SQL query
- *
- * @param string[] $stringList
- * @return string
- */
- 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 ) . ')';
- }
-
- /**
- * @param string $oldName
- * @param string $newName
- * @param bool $temporary
- * @param string $fname
- * @return bool|ResultWrapper
- * @throws RuntimeException
- */
- 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 ) ) {
- wfDebug( "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 );
-
- // 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;
- }
-
- /**
- * List all tables on the database
- *
- * @param string $prefix Only show tables with this prefix, e.g. mw_
- * @param string $fname Calling function name
- *
- * @return array
- */
- 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;
- }
-
- /**
- * Override due to no CASCADE support
- *
- * @param string $tableName
- * @param string $fName
- * @return bool|ResultWrapper
- * @throws DBReadOnlyError
- */
- public function dropTable( $tableName, $fName = __METHOD__ ) {
- if ( !$this->tableExists( $tableName, $fName ) ) {
- return false;
- }
- $sql = "DROP TABLE " . $this->tableName( $tableName );
-
- return $this->query( $sql, $fName );
- }
-
- /**
- * @return string
- */
- public function __toString() {
- return 'SQLite ' . (string)$this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION );
- }
-
-} // end DatabaseSqlite class
final public function lockFiles( array $paths, $type, $timeout = 0 ) {
$paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
- return $this->lockManager->lock( $paths, $type, $timeout );
+ return $this->wrapStatus( $this->lockManager->lock( $paths, $type, $timeout ) );
}
/**
final public function unlockFiles( array $paths, $type ) {
$paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
- return $this->lockManager->unlock( $paths, $type );
+ return $this->wrapStatus( $this->lockManager->unlock( $paths, $type ) );
}
/**
// @todo change this code to work in one batch
protected function getLocksOnServer( $lockSrv, array $pathsByType ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
foreach ( $pathsByType as $type => $paths ) {
$status->merge( $this->doGetLocksOnServer( $lockSrv, $paths, $type ) );
}
abstract protected function doGetLocksOnServer( $lockSrv, array $paths, $type );
protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {
- return Status::newGood();
+ return StatusValue::newGood();
}
/**
+++ /dev/null
-<?php
-/**
- * Simple version of LockManager based on using FS lock files.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup LockManager
- */
-
-/**
- * Simple version of LockManager based on using FS lock files.
- * All locks are non-blocking, which avoids deadlocks.
- *
- * This should work fine for small sites running off one server.
- * Do not use this with 'lockDirectory' set to an NFS mount unless the
- * NFS client is at least version 2.6.12. Otherwise, the BSD flock()
- * locks will be ignored; see http://nfs.sourceforge.net/#section_d.
- *
- * @ingroup LockManager
- * @since 1.19
- */
-class FSLockManager extends LockManager {
- /** @var array Mapping of lock types to the type actually used */
- protected $lockTypeMap = [
- self::LOCK_SH => self::LOCK_SH,
- self::LOCK_UW => self::LOCK_SH,
- self::LOCK_EX => self::LOCK_EX
- ];
-
- protected $lockDir; // global dir for all servers
-
- /** @var array Map of (locked key => lock file handle) */
- protected $handles = [];
-
- /**
- * Construct a new instance from configuration.
- *
- * @param array $config Includes:
- * - lockDirectory : Directory containing the lock files
- */
- function __construct( array $config ) {
- parent::__construct( $config );
-
- $this->lockDir = $config['lockDirectory'];
- }
-
- /**
- * @see LockManager::doLock()
- * @param array $paths
- * @param int $type
- * @return StatusValue
- */
- protected function doLock( array $paths, $type ) {
- $status = Status::newGood();
-
- $lockedPaths = []; // files locked in this attempt
- foreach ( $paths as $path ) {
- $status->merge( $this->doSingleLock( $path, $type ) );
- if ( $status->isOK() ) {
- $lockedPaths[] = $path;
- } else {
- // Abort and unlock everything
- $status->merge( $this->doUnlock( $lockedPaths, $type ) );
-
- return $status;
- }
- }
-
- return $status;
- }
-
- /**
- * @see LockManager::doUnlock()
- * @param array $paths
- * @param int $type
- * @return StatusValue
- */
- protected function doUnlock( array $paths, $type ) {
- $status = Status::newGood();
-
- foreach ( $paths as $path ) {
- $status->merge( $this->doSingleUnlock( $path, $type ) );
- }
-
- return $status;
- }
-
- /**
- * Lock a single resource key
- *
- * @param string $path
- * @param int $type
- * @return StatusValue
- */
- protected function doSingleLock( $path, $type ) {
- $status = Status::newGood();
-
- if ( isset( $this->locksHeld[$path][$type] ) ) {
- ++$this->locksHeld[$path][$type];
- } elseif ( isset( $this->locksHeld[$path][self::LOCK_EX] ) ) {
- $this->locksHeld[$path][$type] = 1;
- } else {
- if ( isset( $this->handles[$path] ) ) {
- $handle = $this->handles[$path];
- } else {
- MediaWiki\suppressWarnings();
- $handle = fopen( $this->getLockPath( $path ), 'a+' );
- MediaWiki\restoreWarnings();
- if ( !$handle ) { // lock dir missing?
- wfMkdirParents( $this->lockDir );
- $handle = fopen( $this->getLockPath( $path ), 'a+' ); // try again
- }
- }
- if ( $handle ) {
- // Either a shared or exclusive lock
- $lock = ( $type == self::LOCK_SH ) ? LOCK_SH : LOCK_EX;
- if ( flock( $handle, $lock | LOCK_NB ) ) {
- // Record this lock as active
- $this->locksHeld[$path][$type] = 1;
- $this->handles[$path] = $handle;
- } else {
- fclose( $handle );
- $status->fatal( 'lockmanager-fail-acquirelock', $path );
- }
- } else {
- $status->fatal( 'lockmanager-fail-openlock', $path );
- }
- }
-
- return $status;
- }
-
- /**
- * Unlock a single resource key
- *
- * @param string $path
- * @param int $type
- * @return StatusValue
- */
- protected function doSingleUnlock( $path, $type ) {
- $status = Status::newGood();
-
- if ( !isset( $this->locksHeld[$path] ) ) {
- $status->warning( 'lockmanager-notlocked', $path );
- } elseif ( !isset( $this->locksHeld[$path][$type] ) ) {
- $status->warning( 'lockmanager-notlocked', $path );
- } else {
- $handlesToClose = [];
- --$this->locksHeld[$path][$type];
- if ( $this->locksHeld[$path][$type] <= 0 ) {
- unset( $this->locksHeld[$path][$type] );
- }
- if ( !count( $this->locksHeld[$path] ) ) {
- unset( $this->locksHeld[$path] ); // no locks on this path
- if ( isset( $this->handles[$path] ) ) {
- $handlesToClose[] = $this->handles[$path];
- unset( $this->handles[$path] );
- }
- }
- // Unlock handles to release locks and delete
- // any lock files that end up with no locks on them...
- if ( wfIsWindows() ) {
- // Windows: for any process, including this one,
- // calling unlink() on a locked file will fail
- $status->merge( $this->closeLockHandles( $path, $handlesToClose ) );
- $status->merge( $this->pruneKeyLockFiles( $path ) );
- } else {
- // Unix: unlink() can be used on files currently open by this
- // process and we must do so in order to avoid race conditions
- $status->merge( $this->pruneKeyLockFiles( $path ) );
- $status->merge( $this->closeLockHandles( $path, $handlesToClose ) );
- }
- }
-
- return $status;
- }
-
- /**
- * @param string $path
- * @param array $handlesToClose
- * @return StatusValue
- */
- private function closeLockHandles( $path, array $handlesToClose ) {
- $status = Status::newGood();
- foreach ( $handlesToClose as $handle ) {
- if ( !flock( $handle, LOCK_UN ) ) {
- $status->fatal( 'lockmanager-fail-releaselock', $path );
- }
- if ( !fclose( $handle ) ) {
- $status->warning( 'lockmanager-fail-closelock', $path );
- }
- }
-
- return $status;
- }
-
- /**
- * @param string $path
- * @return StatusValue
- */
- private function pruneKeyLockFiles( $path ) {
- $status = Status::newGood();
- if ( !isset( $this->locksHeld[$path] ) ) {
- # No locks are held for the lock file anymore
- if ( !unlink( $this->getLockPath( $path ) ) ) {
- $status->warning( 'lockmanager-fail-deletelock', $path );
- }
- unset( $this->handles[$path] );
- }
-
- return $status;
- }
-
- /**
- * Get the path to the lock file for a key
- * @param string $path
- * @return string
- */
- protected function getLockPath( $path ) {
- return "{$this->lockDir}/{$this->sha1Base36Absolute( $path )}.lock";
- }
-
- /**
- * Make sure remaining locks get cleared for sanity
- */
- function __destruct() {
- while ( count( $this->locksHeld ) ) {
- foreach ( $this->locksHeld as $path => $locks ) {
- $this->doSingleUnlock( $path, self::LOCK_EX );
- $this->doSingleUnlock( $path, self::LOCK_SH );
- }
- }
- }
-}
+++ /dev/null
-<?php
-/**
- * @defgroup LockManager Lock management
- * @ingroup FileBackend
- */
-
-/**
- * Resource locking handling.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup LockManager
- * @author Aaron Schulz
- */
-
-/**
- * @brief Class for handling resource locking.
- *
- * Locks on resource keys can either be shared or exclusive.
- *
- * Implementations must keep track of what is locked by this proccess
- * in-memory and support nested locking calls (using reference counting).
- * At least LOCK_UW and LOCK_EX must be implemented. LOCK_SH can be a no-op.
- * Locks should either be non-blocking or have low wait timeouts.
- *
- * Subclasses should avoid throwing exceptions at all costs.
- *
- * @ingroup LockManager
- * @since 1.19
- */
-abstract class LockManager {
- /** @var array Mapping of lock types to the type actually used */
- protected $lockTypeMap = [
- self::LOCK_SH => self::LOCK_SH,
- self::LOCK_UW => self::LOCK_EX, // subclasses may use self::LOCK_SH
- self::LOCK_EX => self::LOCK_EX
- ];
-
- /** @var array Map of (resource path => lock type => count) */
- protected $locksHeld = [];
-
- protected $domain; // string; domain (usually wiki ID)
- protected $lockTTL; // integer; maximum time locks can be held
-
- /** Lock types; stronger locks have higher values */
- const LOCK_SH = 1; // shared lock (for reads)
- const LOCK_UW = 2; // shared lock (for reads used to write elsewhere)
- const LOCK_EX = 3; // exclusive lock (for writes)
-
- /**
- * Construct a new instance from configuration
- *
- * @param array $config Parameters include:
- * - domain : Domain (usually wiki ID) that all resources are relative to [optional]
- * - lockTTL : Age (in seconds) at which resource locks should expire.
- * This only applies if locks are not tied to a connection/process.
- */
- public function __construct( array $config ) {
- $this->domain = isset( $config['domain'] ) ? $config['domain'] : wfWikiID();
- if ( isset( $config['lockTTL'] ) ) {
- $this->lockTTL = max( 5, $config['lockTTL'] );
- } elseif ( PHP_SAPI === 'cli' ) {
- $this->lockTTL = 3600;
- } else {
- $met = ini_get( 'max_execution_time' ); // this is 0 in CLI mode
- $this->lockTTL = max( 5 * 60, 2 * (int)$met );
- }
- }
-
- /**
- * Lock the resources at the given abstract paths
- *
- * @param array $paths List of resource names
- * @param int $type LockManager::LOCK_* constant
- * @param int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
- * @return StatusValue
- */
- final public function lock( array $paths, $type = self::LOCK_EX, $timeout = 0 ) {
- return $this->lockByType( [ $type => $paths ], $timeout );
- }
-
- /**
- * Lock the resources at the given abstract paths
- *
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @param int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
- * @return StatusValue
- * @since 1.22
- */
- final public function lockByType( array $pathsByType, $timeout = 0 ) {
- $pathsByType = $this->normalizePathsByType( $pathsByType );
-
- $status = null;
- $loop = new WaitConditionLoop(
- function () use ( &$status, $pathsByType ) {
- $status = $this->doLockByType( $pathsByType );
-
- return $status->isOK() ?: WaitConditionLoop::CONDITION_CONTINUE;
- },
- $timeout
- );
- $loop->invoke();
-
- return $status;
- }
-
- /**
- * Unlock the resources at the given abstract paths
- *
- * @param array $paths List of paths
- * @param int $type LockManager::LOCK_* constant
- * @return StatusValue
- */
- final public function unlock( array $paths, $type = self::LOCK_EX ) {
- return $this->unlockByType( [ $type => $paths ] );
- }
-
- /**
- * Unlock the resources at the given abstract paths
- *
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- * @since 1.22
- */
- final public function unlockByType( array $pathsByType ) {
- $pathsByType = $this->normalizePathsByType( $pathsByType );
- $status = $this->doUnlockByType( $pathsByType );
-
- return $status;
- }
-
- /**
- * Get the base 36 SHA-1 of a string, padded to 31 digits.
- * Before hashing, the path will be prefixed with the domain ID.
- * This should be used interally for lock key or file names.
- *
- * @param string $path
- * @return string
- */
- final protected function sha1Base36Absolute( $path ) {
- return Wikimedia\base_convert( sha1( "{$this->domain}:{$path}" ), 16, 36, 31 );
- }
-
- /**
- * Get the base 16 SHA-1 of a string, padded to 31 digits.
- * Before hashing, the path will be prefixed with the domain ID.
- * This should be used interally for lock key or file names.
- *
- * @param string $path
- * @return string
- */
- final protected function sha1Base16Absolute( $path ) {
- return sha1( "{$this->domain}:{$path}" );
- }
-
- /**
- * Normalize the $paths array by converting LOCK_UW locks into the
- * appropriate type and removing any duplicated paths for each lock type.
- *
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return array
- * @since 1.22
- */
- final protected function normalizePathsByType( array $pathsByType ) {
- $res = [];
- foreach ( $pathsByType as $type => $paths ) {
- $res[$this->lockTypeMap[$type]] = array_unique( $paths );
- }
-
- return $res;
- }
-
- /**
- * @see LockManager::lockByType()
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- * @since 1.22
- */
- protected function doLockByType( array $pathsByType ) {
- $status = Status::newGood();
- $lockedByType = []; // map of (type => paths)
- foreach ( $pathsByType as $type => $paths ) {
- $status->merge( $this->doLock( $paths, $type ) );
- if ( $status->isOK() ) {
- $lockedByType[$type] = $paths;
- } else {
- // Release the subset of locks that were acquired
- foreach ( $lockedByType as $lType => $lPaths ) {
- $status->merge( $this->doUnlock( $lPaths, $lType ) );
- }
- break;
- }
- }
-
- return $status;
- }
-
- /**
- * Lock resources with the given keys and lock type
- *
- * @param array $paths List of paths
- * @param int $type LockManager::LOCK_* constant
- * @return StatusValue
- */
- abstract protected function doLock( array $paths, $type );
-
- /**
- * @see LockManager::unlockByType()
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- * @since 1.22
- */
- protected function doUnlockByType( array $pathsByType ) {
- $status = Status::newGood();
- foreach ( $pathsByType as $type => $paths ) {
- $status->merge( $this->doUnlock( $paths, $type ) );
- }
-
- return $status;
- }
-
- /**
- * Unlock resources with the given keys and lock type
- *
- * @param array $paths List of paths
- * @param int $type LockManager::LOCK_* constant
- * @return StatusValue
- */
- abstract protected function doUnlock( array $paths, $type );
-}
-
-/**
- * Simple version of LockManager that does nothing
- * @since 1.19
- */
-class NullLockManager extends LockManager {
- protected function doLock( array $paths, $type ) {
- return Status::newGood();
- }
-
- protected function doUnlock( array $paths, $type ) {
- return Status::newGood();
- }
-}
// @todo Change this code to work in one batch
protected function getLocksOnServer( $lockSrv, array $pathsByType ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$lockedPaths = [];
foreach ( $pathsByType as $type => $paths ) {
// @todo Change this code to work in one batch
protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
foreach ( $pathsByType as $type => $paths ) {
$status->merge( $this->doFreeLocksOnServer( $lockSrv, $paths, $type ) );
* @return StatusValue
*/
protected function doGetLocksOnServer( $lockSrv, array $paths, $type ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$memc = $this->getCache( $lockSrv );
$keys = array_map( [ $this, 'recordKeyForPath' ], $paths ); // lock records
* @return StatusValue
*/
protected function doFreeLocksOnServer( $lockSrv, array $paths, $type ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$memc = $this->getCache( $lockSrv );
$keys = array_map( [ $this, 'recordKeyForPath' ], $paths ); // lock records
* @return StatusValue
*/
protected function releaseAllLocks() {
- return Status::newGood(); // not supported
+ return StatusValue::newGood(); // not supported
}
/**
* @return StatusValue
*/
protected function doGetLocksOnServer( $lockSrv, array $paths, $type ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$db = $this->getConnection( $lockSrv ); // checked in isServerUp()
* @return StatusValue
*/
protected function releaseAllLocks() {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
foreach ( $this->conns as $lockDb => $db ) {
if ( $db->trxLevel() ) { // in transaction
];
protected function doGetLocksOnServer( $lockSrv, array $paths, $type ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
if ( !count( $paths ) ) {
return $status; // nothing to lock
}
* @return StatusValue
*/
protected function releaseAllLocks() {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
foreach ( $this->conns as $lockDb => $db ) {
try {
+++ /dev/null
-<?php
-/**
- * Version of LockManager that uses a quorum from peer servers for locks.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup LockManager
- */
-
-/**
- * Version of LockManager that uses a quorum from peer servers for locks.
- * The resource space can also be sharded into separate peer groups.
- *
- * @ingroup LockManager
- * @since 1.20
- */
-abstract class QuorumLockManager extends LockManager {
- /** @var array Map of bucket indexes to peer server lists */
- protected $srvsByBucket = []; // (bucket index => (lsrv1, lsrv2, ...))
-
- /** @var array Map of degraded buckets */
- protected $degradedBuckets = []; // (buckey index => UNIX timestamp)
-
- final protected function doLock( array $paths, $type ) {
- return $this->doLockByType( [ $type => $paths ] );
- }
-
- final protected function doUnlock( array $paths, $type ) {
- return $this->doUnlockByType( [ $type => $paths ] );
- }
-
- protected function doLockByType( array $pathsByType ) {
- $status = Status::newGood();
-
- $pathsToLock = []; // (bucket => type => paths)
- // Get locks that need to be acquired (buckets => locks)...
- foreach ( $pathsByType as $type => $paths ) {
- foreach ( $paths as $path ) {
- if ( isset( $this->locksHeld[$path][$type] ) ) {
- ++$this->locksHeld[$path][$type];
- } else {
- $bucket = $this->getBucketFromPath( $path );
- $pathsToLock[$bucket][$type][] = $path;
- }
- }
- }
-
- $lockedPaths = []; // files locked in this attempt (type => paths)
- // Attempt to acquire these locks...
- foreach ( $pathsToLock as $bucket => $pathsToLockByType ) {
- // Try to acquire the locks for this bucket
- $status->merge( $this->doLockingRequestBucket( $bucket, $pathsToLockByType ) );
- if ( !$status->isOK() ) {
- $status->merge( $this->doUnlockByType( $lockedPaths ) );
-
- return $status;
- }
- // Record these locks as active
- foreach ( $pathsToLockByType as $type => $paths ) {
- foreach ( $paths as $path ) {
- $this->locksHeld[$path][$type] = 1; // locked
- // Keep track of what locks were made in this attempt
- $lockedPaths[$type][] = $path;
- }
- }
- }
-
- return $status;
- }
-
- protected function doUnlockByType( array $pathsByType ) {
- $status = Status::newGood();
-
- $pathsToUnlock = []; // (bucket => type => paths)
- foreach ( $pathsByType as $type => $paths ) {
- foreach ( $paths as $path ) {
- if ( !isset( $this->locksHeld[$path][$type] ) ) {
- $status->warning( 'lockmanager-notlocked', $path );
- } else {
- --$this->locksHeld[$path][$type];
- // Reference count the locks held and release locks when zero
- if ( $this->locksHeld[$path][$type] <= 0 ) {
- unset( $this->locksHeld[$path][$type] );
- $bucket = $this->getBucketFromPath( $path );
- $pathsToUnlock[$bucket][$type][] = $path;
- }
- if ( !count( $this->locksHeld[$path] ) ) {
- unset( $this->locksHeld[$path] ); // no SH or EX locks left for key
- }
- }
- }
- }
-
- // Remove these specific locks if possible, or at least release
- // all locks once this process is currently not holding any locks.
- foreach ( $pathsToUnlock as $bucket => $pathsToUnlockByType ) {
- $status->merge( $this->doUnlockingRequestBucket( $bucket, $pathsToUnlockByType ) );
- }
- if ( !count( $this->locksHeld ) ) {
- $status->merge( $this->releaseAllLocks() );
- $this->degradedBuckets = []; // safe to retry the normal quorum
- }
-
- return $status;
- }
-
- /**
- * Attempt to acquire locks with the peers for a bucket.
- * This is all or nothing; if any key is locked then this totally fails.
- *
- * @param int $bucket
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- */
- final protected function doLockingRequestBucket( $bucket, array $pathsByType ) {
- $status = Status::newGood();
-
- $yesVotes = 0; // locks made on trustable servers
- $votesLeft = count( $this->srvsByBucket[$bucket] ); // remaining peers
- $quorum = floor( $votesLeft / 2 + 1 ); // simple majority
- // Get votes for each peer, in order, until we have enough...
- foreach ( $this->srvsByBucket[$bucket] as $lockSrv ) {
- if ( !$this->isServerUp( $lockSrv ) ) {
- --$votesLeft;
- $status->warning( 'lockmanager-fail-svr-acquire', $lockSrv );
- $this->degradedBuckets[$bucket] = time();
- continue; // server down?
- }
- // Attempt to acquire the lock on this peer
- $status->merge( $this->getLocksOnServer( $lockSrv, $pathsByType ) );
- if ( !$status->isOK() ) {
- return $status; // vetoed; resource locked
- }
- ++$yesVotes; // success for this peer
- if ( $yesVotes >= $quorum ) {
- return $status; // lock obtained
- }
- --$votesLeft;
- $votesNeeded = $quorum - $yesVotes;
- if ( $votesNeeded > $votesLeft ) {
- break; // short-circuit
- }
- }
- // At this point, we must not have met the quorum
- $status->setResult( false );
-
- return $status;
- }
-
- /**
- * Attempt to release locks with the peers for a bucket
- *
- * @param int $bucket
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- */
- final protected function doUnlockingRequestBucket( $bucket, array $pathsByType ) {
- $status = Status::newGood();
-
- $yesVotes = 0; // locks freed on trustable servers
- $votesLeft = count( $this->srvsByBucket[$bucket] ); // remaining peers
- $quorum = floor( $votesLeft / 2 + 1 ); // simple majority
- $isDegraded = isset( $this->degradedBuckets[$bucket] ); // not the normal quorum?
- foreach ( $this->srvsByBucket[$bucket] as $lockSrv ) {
- if ( !$this->isServerUp( $lockSrv ) ) {
- $status->warning( 'lockmanager-fail-svr-release', $lockSrv );
- } else {
- // Attempt to release the lock on this peer
- $status->merge( $this->freeLocksOnServer( $lockSrv, $pathsByType ) );
- ++$yesVotes; // success for this peer
- // Normally the first peers form the quorum, and the others are ignored.
- // Ignore them in this case, but not when an alternative quorum was used.
- if ( $yesVotes >= $quorum && !$isDegraded ) {
- break; // lock released
- }
- }
- }
- // Set a bad StatusValue if the quorum was not met.
- // Assumes the same "up" servers as during the acquire step.
- $status->setResult( $yesVotes >= $quorum );
-
- return $status;
- }
-
- /**
- * Get the bucket for resource path.
- * This should avoid throwing any exceptions.
- *
- * @param string $path
- * @return int
- */
- protected function getBucketFromPath( $path ) {
- $prefix = substr( sha1( $path ), 0, 2 ); // first 2 hex chars (8 bits)
- return (int)base_convert( $prefix, 16, 10 ) % count( $this->srvsByBucket );
- }
-
- /**
- * Check if a lock server is up.
- * This should process cache results to reduce RTT.
- *
- * @param string $lockSrv
- * @return bool
- */
- abstract protected function isServerUp( $lockSrv );
-
- /**
- * Get a connection to a lock server and acquire locks
- *
- * @param string $lockSrv
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- */
- abstract protected function getLocksOnServer( $lockSrv, array $pathsByType );
-
- /**
- * Get a connection to a lock server and release locks on $paths.
- *
- * Subclasses must effectively implement this or releaseAllLocks().
- *
- * @param string $lockSrv
- * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
- * @return StatusValue
- */
- abstract protected function freeLocksOnServer( $lockSrv, array $pathsByType );
-
- /**
- * Release all locks that this session is holding.
- *
- * Subclasses must effectively implement this or freeLocksOnServer().
- *
- * @return StatusValue
- */
- abstract protected function releaseAllLocks();
-}
}
protected function getLocksOnServer( $lockSrv, array $pathsByType ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$pathList = call_user_func_array( 'array_merge', array_values( $pathsByType ) );
}
protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {
- $status = Status::newGood();
+ $status = StatusValue::newGood();
$pathList = call_user_func_array( 'array_merge', array_values( $pathsByType ) );
}
protected function releaseAllLocks() {
- return Status::newGood(); // not supported
+ return StatusValue::newGood(); // not supported
}
protected function isServerUp( $lockSrv ) {
$status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
if ( $status->successCount == 0 ) {
- $status->ok = false;
+ $status->setOK( false );
}
return $status;
$status = $this->publishBatch(
[ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
if ( $status->successCount == 0 ) {
- $status->ok = false;
+ $status->setOK( false );
}
if ( isset( $status->value[0] ) ) {
$status->value = $status->value[0];
/** @var array */
protected $fileFromRowFactory = [ 'ForeignDBFile', 'newFromRow' ];
+ /** @var bool */
+ protected $hasSharedCache;
+
/**
* @param array|null $info
*/
}
# Check the cache
+ $dbkey = $title->getDBkey();
if ( empty( $options['ignoreRedirect'] )
&& empty( $options['private'] )
&& empty( $options['bypassCache'] )
) {
$time = isset( $options['time'] ) ? $options['time'] : '';
- $dbkey = $title->getDBkey();
if ( $this->cache->has( $dbkey, $time, 60 ) ) {
return $this->cache->get( $dbkey, $time );
}
$useCache = true;
} else {
+ $time = false;
$useCache = false;
}
*/
function pageCount() {
if ( !isset( $this->pageCount ) ) {
+ // @FIXME: callers expect File objects
if ( $this->getHandler() && $this->handler->isMultiPage( $this ) ) {
$this->pageCount = $this->handler->pageCount( $this );
} else {
* @ingroup FileAbstraction
*/
class ForeignAPIFile extends File {
+ /** @var bool */
private $mExists;
+ /** @var array */
+ private $mInfo = [];
protected $repoClass = 'ForeignApiRepo';
public function getUser( $type = 'text' ) {
if ( $type == 'text' ) {
return isset( $this->mInfo['user'] ) ? strval( $this->mInfo['user'] ) : null;
- } elseif ( $type == 'id' ) {
+ } else {
return 0; // What makes sense here, for a remote user?
}
}
return $files;
}
- /**
- * @see File::purgeCache()
- */
function purgeCache( $options = [] ) {
$this->purgeThumbnails( $options );
$this->purgeDescriptionPage();
);
if ( isset( $status->value['revision'] ) ) {
+ /** @var $rev Revision */
+ $rev = $status->value['revision'];
// Associate new page revision id
- $logEntry->setAssociatedRevId( $status->value['revision']->getId() );
+ $logEntry->setAssociatedRevId( $rev->getId() );
}
// This relies on the resetArticleID() call in WikiPage::insertOn(),
// which is triggered on $descTitle by doEditContent() above.
// Even if some files could be copied, fail entirely as that is the
// easiest thing to do without data loss
$this->cleanupFailedBatch( $storeStatus, $storeBatch );
- $status->ok = false;
+ $status->setOK( false );
$this->file->unlock();
return $status;
if ( !$statusDb->isGood() ) {
$destFile->unlock();
$this->file->unlock();
- $statusDb->ok = false;
+ $statusDb->setOK( false );
return $statusDb;
}
$this->file->unlock();
wfDebugLog( 'imagemove', "Error in moving files: "
. $statusMove->getWikiText( false, false, 'en' ) );
- $statusMove->ok = false;
+ $statusMove->setOK( false );
return $statusMove;
}
* Factory function for fatal errors
*
* @param string|MessageSpecifier $message Message key or object
- * @return StatusValue
+ * @return static
*/
public static function newFatal( $message /*, parameters...*/ ) {
$params = func_get_args();
* Factory function for good results
*
* @param mixed $value
- * @return StatusValue
+ * @return static
*/
public static function newGood( $value = null ) {
$result = new static();
--- /dev/null
+<?php
+/**
+ * Simple version of LockManager based on using FS lock files.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup LockManager
+ */
+
+/**
+ * Simple version of LockManager based on using FS lock files.
+ * All locks are non-blocking, which avoids deadlocks.
+ *
+ * This should work fine for small sites running off one server.
+ * Do not use this with 'lockDirectory' set to an NFS mount unless the
+ * NFS client is at least version 2.6.12. Otherwise, the BSD flock()
+ * locks will be ignored; see http://nfs.sourceforge.net/#section_d.
+ *
+ * @ingroup LockManager
+ * @since 1.19
+ */
+class FSLockManager extends LockManager {
+ /** @var array Mapping of lock types to the type actually used */
+ protected $lockTypeMap = [
+ self::LOCK_SH => self::LOCK_SH,
+ self::LOCK_UW => self::LOCK_SH,
+ self::LOCK_EX => self::LOCK_EX
+ ];
+
+ /** @var string Global dir for all servers */
+ protected $lockDir;
+
+ /** @var array Map of (locked key => lock file handle) */
+ protected $handles = [];
+
+ /** @var bool */
+ protected $isWindows;
+
+ /**
+ * Construct a new instance from configuration.
+ *
+ * @param array $config Includes:
+ * - lockDirectory : Directory containing the lock files
+ */
+ function __construct( array $config ) {
+ parent::__construct( $config );
+
+ $this->lockDir = $config['lockDirectory'];
+ $this->isWindows = ( strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN' );
+ }
+
+ /**
+ * @see LockManager::doLock()
+ * @param array $paths
+ * @param int $type
+ * @return StatusValue
+ */
+ protected function doLock( array $paths, $type ) {
+ $status = StatusValue::newGood();
+
+ $lockedPaths = []; // files locked in this attempt
+ foreach ( $paths as $path ) {
+ $status->merge( $this->doSingleLock( $path, $type ) );
+ if ( $status->isOK() ) {
+ $lockedPaths[] = $path;
+ } else {
+ // Abort and unlock everything
+ $status->merge( $this->doUnlock( $lockedPaths, $type ) );
+
+ return $status;
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * @see LockManager::doUnlock()
+ * @param array $paths
+ * @param int $type
+ * @return StatusValue
+ */
+ protected function doUnlock( array $paths, $type ) {
+ $status = StatusValue::newGood();
+
+ foreach ( $paths as $path ) {
+ $status->merge( $this->doSingleUnlock( $path, $type ) );
+ }
+
+ return $status;
+ }
+
+ /**
+ * Lock a single resource key
+ *
+ * @param string $path
+ * @param int $type
+ * @return StatusValue
+ */
+ protected function doSingleLock( $path, $type ) {
+ $status = StatusValue::newGood();
+
+ if ( isset( $this->locksHeld[$path][$type] ) ) {
+ ++$this->locksHeld[$path][$type];
+ } elseif ( isset( $this->locksHeld[$path][self::LOCK_EX] ) ) {
+ $this->locksHeld[$path][$type] = 1;
+ } else {
+ if ( isset( $this->handles[$path] ) ) {
+ $handle = $this->handles[$path];
+ } else {
+ MediaWiki\suppressWarnings();
+ $handle = fopen( $this->getLockPath( $path ), 'a+' );
+ if ( !$handle ) { // lock dir missing?
+ mkdir( $this->lockDir, 0777, true );
+ $handle = fopen( $this->getLockPath( $path ), 'a+' ); // try again
+ }
+ MediaWiki\restoreWarnings();
+ }
+ if ( $handle ) {
+ // Either a shared or exclusive lock
+ $lock = ( $type == self::LOCK_SH ) ? LOCK_SH : LOCK_EX;
+ if ( flock( $handle, $lock | LOCK_NB ) ) {
+ // Record this lock as active
+ $this->locksHeld[$path][$type] = 1;
+ $this->handles[$path] = $handle;
+ } else {
+ fclose( $handle );
+ $status->fatal( 'lockmanager-fail-acquirelock', $path );
+ }
+ } else {
+ $status->fatal( 'lockmanager-fail-openlock', $path );
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * Unlock a single resource key
+ *
+ * @param string $path
+ * @param int $type
+ * @return StatusValue
+ */
+ protected function doSingleUnlock( $path, $type ) {
+ $status = StatusValue::newGood();
+
+ if ( !isset( $this->locksHeld[$path] ) ) {
+ $status->warning( 'lockmanager-notlocked', $path );
+ } elseif ( !isset( $this->locksHeld[$path][$type] ) ) {
+ $status->warning( 'lockmanager-notlocked', $path );
+ } else {
+ $handlesToClose = [];
+ --$this->locksHeld[$path][$type];
+ if ( $this->locksHeld[$path][$type] <= 0 ) {
+ unset( $this->locksHeld[$path][$type] );
+ }
+ if ( !count( $this->locksHeld[$path] ) ) {
+ unset( $this->locksHeld[$path] ); // no locks on this path
+ if ( isset( $this->handles[$path] ) ) {
+ $handlesToClose[] = $this->handles[$path];
+ unset( $this->handles[$path] );
+ }
+ }
+ // Unlock handles to release locks and delete
+ // any lock files that end up with no locks on them...
+ if ( $this->isWindows ) {
+ // Windows: for any process, including this one,
+ // calling unlink() on a locked file will fail
+ $status->merge( $this->closeLockHandles( $path, $handlesToClose ) );
+ $status->merge( $this->pruneKeyLockFiles( $path ) );
+ } else {
+ // Unix: unlink() can be used on files currently open by this
+ // process and we must do so in order to avoid race conditions
+ $status->merge( $this->pruneKeyLockFiles( $path ) );
+ $status->merge( $this->closeLockHandles( $path, $handlesToClose ) );
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * @param string $path
+ * @param array $handlesToClose
+ * @return StatusValue
+ */
+ private function closeLockHandles( $path, array $handlesToClose ) {
+ $status = StatusValue::newGood();
+ foreach ( $handlesToClose as $handle ) {
+ if ( !flock( $handle, LOCK_UN ) ) {
+ $status->fatal( 'lockmanager-fail-releaselock', $path );
+ }
+ if ( !fclose( $handle ) ) {
+ $status->warning( 'lockmanager-fail-closelock', $path );
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * @param string $path
+ * @return StatusValue
+ */
+ private function pruneKeyLockFiles( $path ) {
+ $status = StatusValue::newGood();
+ if ( !isset( $this->locksHeld[$path] ) ) {
+ # No locks are held for the lock file anymore
+ if ( !unlink( $this->getLockPath( $path ) ) ) {
+ $status->warning( 'lockmanager-fail-deletelock', $path );
+ }
+ unset( $this->handles[$path] );
+ }
+
+ return $status;
+ }
+
+ /**
+ * Get the path to the lock file for a key
+ * @param string $path
+ * @return string
+ */
+ protected function getLockPath( $path ) {
+ return "{$this->lockDir}/{$this->sha1Base36Absolute( $path )}.lock";
+ }
+
+ /**
+ * Make sure remaining locks get cleared for sanity
+ */
+ function __destruct() {
+ while ( count( $this->locksHeld ) ) {
+ foreach ( $this->locksHeld as $path => $locks ) {
+ $this->doSingleUnlock( $path, self::LOCK_EX );
+ $this->doSingleUnlock( $path, self::LOCK_SH );
+ }
+ }
+ }
+}
--- /dev/null
+<?php
+/**
+ * @defgroup LockManager Lock management
+ * @ingroup FileBackend
+ */
+
+/**
+ * Resource locking handling.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup LockManager
+ * @author Aaron Schulz
+ */
+
+/**
+ * @brief Class for handling resource locking.
+ *
+ * Locks on resource keys can either be shared or exclusive.
+ *
+ * Implementations must keep track of what is locked by this proccess
+ * in-memory and support nested locking calls (using reference counting).
+ * At least LOCK_UW and LOCK_EX must be implemented. LOCK_SH can be a no-op.
+ * Locks should either be non-blocking or have low wait timeouts.
+ *
+ * Subclasses should avoid throwing exceptions at all costs.
+ *
+ * @ingroup LockManager
+ * @since 1.19
+ */
+abstract class LockManager {
+ /** @var array Mapping of lock types to the type actually used */
+ protected $lockTypeMap = [
+ self::LOCK_SH => self::LOCK_SH,
+ self::LOCK_UW => self::LOCK_EX, // subclasses may use self::LOCK_SH
+ self::LOCK_EX => self::LOCK_EX
+ ];
+
+ /** @var array Map of (resource path => lock type => count) */
+ protected $locksHeld = [];
+
+ protected $domain; // string; domain (usually wiki ID)
+ protected $lockTTL; // integer; maximum time locks can be held
+
+ /** Lock types; stronger locks have higher values */
+ const LOCK_SH = 1; // shared lock (for reads)
+ const LOCK_UW = 2; // shared lock (for reads used to write elsewhere)
+ const LOCK_EX = 3; // exclusive lock (for writes)
+
+ /**
+ * Construct a new instance from configuration
+ *
+ * @param array $config Parameters include:
+ * - domain : Domain (usually wiki ID) that all resources are relative to [optional]
+ * - lockTTL : Age (in seconds) at which resource locks should expire.
+ * This only applies if locks are not tied to a connection/process.
+ */
+ public function __construct( array $config ) {
+ $this->domain = isset( $config['domain'] ) ? $config['domain'] : 'global';
+ if ( isset( $config['lockTTL'] ) ) {
+ $this->lockTTL = max( 5, $config['lockTTL'] );
+ } elseif ( PHP_SAPI === 'cli' ) {
+ $this->lockTTL = 3600;
+ } else {
+ $met = ini_get( 'max_execution_time' ); // this is 0 in CLI mode
+ $this->lockTTL = max( 5 * 60, 2 * (int)$met );
+ }
+ }
+
+ /**
+ * Lock the resources at the given abstract paths
+ *
+ * @param array $paths List of resource names
+ * @param int $type LockManager::LOCK_* constant
+ * @param int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
+ * @return StatusValue
+ */
+ final public function lock( array $paths, $type = self::LOCK_EX, $timeout = 0 ) {
+ return $this->lockByType( [ $type => $paths ], $timeout );
+ }
+
+ /**
+ * Lock the resources at the given abstract paths
+ *
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @param int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
+ * @return StatusValue
+ * @since 1.22
+ */
+ final public function lockByType( array $pathsByType, $timeout = 0 ) {
+ $pathsByType = $this->normalizePathsByType( $pathsByType );
+
+ $status = null;
+ $loop = new WaitConditionLoop(
+ function () use ( &$status, $pathsByType ) {
+ $status = $this->doLockByType( $pathsByType );
+
+ return $status->isOK() ?: WaitConditionLoop::CONDITION_CONTINUE;
+ },
+ $timeout
+ );
+ $loop->invoke();
+
+ return $status;
+ }
+
+ /**
+ * Unlock the resources at the given abstract paths
+ *
+ * @param array $paths List of paths
+ * @param int $type LockManager::LOCK_* constant
+ * @return StatusValue
+ */
+ final public function unlock( array $paths, $type = self::LOCK_EX ) {
+ return $this->unlockByType( [ $type => $paths ] );
+ }
+
+ /**
+ * Unlock the resources at the given abstract paths
+ *
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ * @since 1.22
+ */
+ final public function unlockByType( array $pathsByType ) {
+ $pathsByType = $this->normalizePathsByType( $pathsByType );
+ $status = $this->doUnlockByType( $pathsByType );
+
+ return $status;
+ }
+
+ /**
+ * Get the base 36 SHA-1 of a string, padded to 31 digits.
+ * Before hashing, the path will be prefixed with the domain ID.
+ * This should be used interally for lock key or file names.
+ *
+ * @param string $path
+ * @return string
+ */
+ final protected function sha1Base36Absolute( $path ) {
+ return Wikimedia\base_convert( sha1( "{$this->domain}:{$path}" ), 16, 36, 31 );
+ }
+
+ /**
+ * Get the base 16 SHA-1 of a string, padded to 31 digits.
+ * Before hashing, the path will be prefixed with the domain ID.
+ * This should be used interally for lock key or file names.
+ *
+ * @param string $path
+ * @return string
+ */
+ final protected function sha1Base16Absolute( $path ) {
+ return sha1( "{$this->domain}:{$path}" );
+ }
+
+ /**
+ * Normalize the $paths array by converting LOCK_UW locks into the
+ * appropriate type and removing any duplicated paths for each lock type.
+ *
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return array
+ * @since 1.22
+ */
+ final protected function normalizePathsByType( array $pathsByType ) {
+ $res = [];
+ foreach ( $pathsByType as $type => $paths ) {
+ $res[$this->lockTypeMap[$type]] = array_unique( $paths );
+ }
+
+ return $res;
+ }
+
+ /**
+ * @see LockManager::lockByType()
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ * @since 1.22
+ */
+ protected function doLockByType( array $pathsByType ) {
+ $status = StatusValue::newGood();
+ $lockedByType = []; // map of (type => paths)
+ foreach ( $pathsByType as $type => $paths ) {
+ $status->merge( $this->doLock( $paths, $type ) );
+ if ( $status->isOK() ) {
+ $lockedByType[$type] = $paths;
+ } else {
+ // Release the subset of locks that were acquired
+ foreach ( $lockedByType as $lType => $lPaths ) {
+ $status->merge( $this->doUnlock( $lPaths, $lType ) );
+ }
+ break;
+ }
+ }
+
+ return $status;
+ }
+
+ /**
+ * Lock resources with the given keys and lock type
+ *
+ * @param array $paths List of paths
+ * @param int $type LockManager::LOCK_* constant
+ * @return StatusValue
+ */
+ abstract protected function doLock( array $paths, $type );
+
+ /**
+ * @see LockManager::unlockByType()
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ * @since 1.22
+ */
+ protected function doUnlockByType( array $pathsByType ) {
+ $status = StatusValue::newGood();
+ foreach ( $pathsByType as $type => $paths ) {
+ $status->merge( $this->doUnlock( $paths, $type ) );
+ }
+
+ return $status;
+ }
+
+ /**
+ * Unlock resources with the given keys and lock type
+ *
+ * @param array $paths List of paths
+ * @param int $type LockManager::LOCK_* constant
+ * @return StatusValue
+ */
+ abstract protected function doUnlock( array $paths, $type );
+}
--- /dev/null
+<?php
+/**
+ * Resource locking handling.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup LockManager
+ * @author Aaron Schulz
+ */
+
+/**
+ * Simple version of LockManager that does nothing
+ * @since 1.19
+ */
+class NullLockManager extends LockManager {
+ protected function doLock( array $paths, $type ) {
+ return StatusValue::newGood();
+ }
+
+ protected function doUnlock( array $paths, $type ) {
+ return StatusValue::newGood();
+ }
+}
--- /dev/null
+<?php
+/**
+ * Version of LockManager that uses a quorum from peer servers for locks.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup LockManager
+ */
+
+/**
+ * Version of LockManager that uses a quorum from peer servers for locks.
+ * The resource space can also be sharded into separate peer groups.
+ *
+ * @ingroup LockManager
+ * @since 1.20
+ */
+abstract class QuorumLockManager extends LockManager {
+ /** @var array Map of bucket indexes to peer server lists */
+ protected $srvsByBucket = []; // (bucket index => (lsrv1, lsrv2, ...))
+
+ /** @var array Map of degraded buckets */
+ protected $degradedBuckets = []; // (buckey index => UNIX timestamp)
+
+ final protected function doLock( array $paths, $type ) {
+ return $this->doLockByType( [ $type => $paths ] );
+ }
+
+ final protected function doUnlock( array $paths, $type ) {
+ return $this->doUnlockByType( [ $type => $paths ] );
+ }
+
+ protected function doLockByType( array $pathsByType ) {
+ $status = StatusValue::newGood();
+
+ $pathsToLock = []; // (bucket => type => paths)
+ // Get locks that need to be acquired (buckets => locks)...
+ foreach ( $pathsByType as $type => $paths ) {
+ foreach ( $paths as $path ) {
+ if ( isset( $this->locksHeld[$path][$type] ) ) {
+ ++$this->locksHeld[$path][$type];
+ } else {
+ $bucket = $this->getBucketFromPath( $path );
+ $pathsToLock[$bucket][$type][] = $path;
+ }
+ }
+ }
+
+ $lockedPaths = []; // files locked in this attempt (type => paths)
+ // Attempt to acquire these locks...
+ foreach ( $pathsToLock as $bucket => $pathsToLockByType ) {
+ // Try to acquire the locks for this bucket
+ $status->merge( $this->doLockingRequestBucket( $bucket, $pathsToLockByType ) );
+ if ( !$status->isOK() ) {
+ $status->merge( $this->doUnlockByType( $lockedPaths ) );
+
+ return $status;
+ }
+ // Record these locks as active
+ foreach ( $pathsToLockByType as $type => $paths ) {
+ foreach ( $paths as $path ) {
+ $this->locksHeld[$path][$type] = 1; // locked
+ // Keep track of what locks were made in this attempt
+ $lockedPaths[$type][] = $path;
+ }
+ }
+ }
+
+ return $status;
+ }
+
+ protected function doUnlockByType( array $pathsByType ) {
+ $status = StatusValue::newGood();
+
+ $pathsToUnlock = []; // (bucket => type => paths)
+ foreach ( $pathsByType as $type => $paths ) {
+ foreach ( $paths as $path ) {
+ if ( !isset( $this->locksHeld[$path][$type] ) ) {
+ $status->warning( 'lockmanager-notlocked', $path );
+ } else {
+ --$this->locksHeld[$path][$type];
+ // Reference count the locks held and release locks when zero
+ if ( $this->locksHeld[$path][$type] <= 0 ) {
+ unset( $this->locksHeld[$path][$type] );
+ $bucket = $this->getBucketFromPath( $path );
+ $pathsToUnlock[$bucket][$type][] = $path;
+ }
+ if ( !count( $this->locksHeld[$path] ) ) {
+ unset( $this->locksHeld[$path] ); // no SH or EX locks left for key
+ }
+ }
+ }
+ }
+
+ // Remove these specific locks if possible, or at least release
+ // all locks once this process is currently not holding any locks.
+ foreach ( $pathsToUnlock as $bucket => $pathsToUnlockByType ) {
+ $status->merge( $this->doUnlockingRequestBucket( $bucket, $pathsToUnlockByType ) );
+ }
+ if ( !count( $this->locksHeld ) ) {
+ $status->merge( $this->releaseAllLocks() );
+ $this->degradedBuckets = []; // safe to retry the normal quorum
+ }
+
+ return $status;
+ }
+
+ /**
+ * Attempt to acquire locks with the peers for a bucket.
+ * This is all or nothing; if any key is locked then this totally fails.
+ *
+ * @param int $bucket
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ */
+ final protected function doLockingRequestBucket( $bucket, array $pathsByType ) {
+ $status = StatusValue::newGood();
+
+ $yesVotes = 0; // locks made on trustable servers
+ $votesLeft = count( $this->srvsByBucket[$bucket] ); // remaining peers
+ $quorum = floor( $votesLeft / 2 + 1 ); // simple majority
+ // Get votes for each peer, in order, until we have enough...
+ foreach ( $this->srvsByBucket[$bucket] as $lockSrv ) {
+ if ( !$this->isServerUp( $lockSrv ) ) {
+ --$votesLeft;
+ $status->warning( 'lockmanager-fail-svr-acquire', $lockSrv );
+ $this->degradedBuckets[$bucket] = time();
+ continue; // server down?
+ }
+ // Attempt to acquire the lock on this peer
+ $status->merge( $this->getLocksOnServer( $lockSrv, $pathsByType ) );
+ if ( !$status->isOK() ) {
+ return $status; // vetoed; resource locked
+ }
+ ++$yesVotes; // success for this peer
+ if ( $yesVotes >= $quorum ) {
+ return $status; // lock obtained
+ }
+ --$votesLeft;
+ $votesNeeded = $quorum - $yesVotes;
+ if ( $votesNeeded > $votesLeft ) {
+ break; // short-circuit
+ }
+ }
+ // At this point, we must not have met the quorum
+ $status->setResult( false );
+
+ return $status;
+ }
+
+ /**
+ * Attempt to release locks with the peers for a bucket
+ *
+ * @param int $bucket
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ */
+ final protected function doUnlockingRequestBucket( $bucket, array $pathsByType ) {
+ $status = StatusValue::newGood();
+
+ $yesVotes = 0; // locks freed on trustable servers
+ $votesLeft = count( $this->srvsByBucket[$bucket] ); // remaining peers
+ $quorum = floor( $votesLeft / 2 + 1 ); // simple majority
+ $isDegraded = isset( $this->degradedBuckets[$bucket] ); // not the normal quorum?
+ foreach ( $this->srvsByBucket[$bucket] as $lockSrv ) {
+ if ( !$this->isServerUp( $lockSrv ) ) {
+ $status->warning( 'lockmanager-fail-svr-release', $lockSrv );
+ } else {
+ // Attempt to release the lock on this peer
+ $status->merge( $this->freeLocksOnServer( $lockSrv, $pathsByType ) );
+ ++$yesVotes; // success for this peer
+ // Normally the first peers form the quorum, and the others are ignored.
+ // Ignore them in this case, but not when an alternative quorum was used.
+ if ( $yesVotes >= $quorum && !$isDegraded ) {
+ break; // lock released
+ }
+ }
+ }
+ // Set a bad StatusValue if the quorum was not met.
+ // Assumes the same "up" servers as during the acquire step.
+ $status->setResult( $yesVotes >= $quorum );
+
+ return $status;
+ }
+
+ /**
+ * Get the bucket for resource path.
+ * This should avoid throwing any exceptions.
+ *
+ * @param string $path
+ * @return int
+ */
+ protected function getBucketFromPath( $path ) {
+ $prefix = substr( sha1( $path ), 0, 2 ); // first 2 hex chars (8 bits)
+ return (int)base_convert( $prefix, 16, 10 ) % count( $this->srvsByBucket );
+ }
+
+ /**
+ * Check if a lock server is up.
+ * This should process cache results to reduce RTT.
+ *
+ * @param string $lockSrv
+ * @return bool
+ */
+ abstract protected function isServerUp( $lockSrv );
+
+ /**
+ * Get a connection to a lock server and acquire locks
+ *
+ * @param string $lockSrv
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ */
+ abstract protected function getLocksOnServer( $lockSrv, array $pathsByType );
+
+ /**
+ * Get a connection to a lock server and release locks on $paths.
+ *
+ * Subclasses must effectively implement this or releaseAllLocks().
+ *
+ * @param string $lockSrv
+ * @param array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
+ * @return StatusValue
+ */
+ abstract protected function freeLocksOnServer( $lockSrv, array $pathsByType );
+
+ /**
+ * Release all locks that this session is holding.
+ *
+ * Subclasses must effectively implement this or freeLocksOnServer().
+ *
+ * @return StatusValue
+ */
+ abstract protected function releaseAllLocks();
+}
return $this->__call( __FUNCTION__, func_get_args() );
}
- public function makeList( $a, $mode = LIST_COMMA ) {
+ public function makeList( $a, $mode = self::LIST_COMMA ) {
return $this->__call( __FUNCTION__, func_get_args() );
}
}
if ( isset( $options['HAVING'] ) ) {
$having = is_array( $options['HAVING'] )
- ? $this->makeList( $options['HAVING'], LIST_AND )
+ ? $this->makeList( $options['HAVING'], self::LIST_AND )
: $options['HAVING'];
$sql .= ' HAVING ' . $having;
}
if ( !empty( $conds ) ) {
if ( is_array( $conds ) ) {
- $conds = $this->makeList( $conds, LIST_AND );
+ $conds = $this->makeList( $conds, self::LIST_AND );
}
$sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex WHERE $conds $preLimitTail";
} else {
function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) {
$table = $this->tableName( $table );
$opts = $this->makeUpdateOptions( $options );
- $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET );
+ $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self::LIST_SET );
if ( $conds !== [] && $conds !== '*' ) {
- $sql .= " WHERE " . $this->makeList( $conds, LIST_AND );
+ $sql .= " WHERE " . $this->makeList( $conds, self::LIST_AND );
}
return $this->query( $sql, $fname );
}
- public function makeList( $a, $mode = LIST_COMMA ) {
+ public function makeList( $a, $mode = self::LIST_COMMA ) {
if ( !is_array( $a ) ) {
throw new DBUnexpectedError( $this, __METHOD__ . ' called with incorrect parameters' );
}
foreach ( $a as $field => $value ) {
if ( !$first ) {
- if ( $mode == LIST_AND ) {
+ if ( $mode == self::LIST_AND ) {
$list .= ' AND ';
- } elseif ( $mode == LIST_OR ) {
+ } elseif ( $mode == self::LIST_OR ) {
$list .= ' OR ';
} else {
$list .= ',';
$first = false;
}
- if ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_numeric( $field ) ) {
+ if ( ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_numeric( $field ) ) {
$list .= "($value)";
- } elseif ( ( $mode == LIST_SET ) && is_numeric( $field ) ) {
+ } elseif ( $mode == self::LIST_SET && is_numeric( $field ) ) {
$list .= "$value";
- } elseif ( ( $mode == LIST_AND || $mode == LIST_OR ) && is_array( $value ) ) {
+ } elseif (
+ ( $mode == self::LIST_AND || $mode == self::LIST_OR ) && is_array( $value )
+ ) {
// Remove null from array to be handled separately if found
$includeNull = false;
foreach ( array_keys( $value, null, true ) as $nullKey ) {
unset( $value[$nullKey] );
}
if ( count( $value ) == 0 && !$includeNull ) {
- throw new InvalidArgumentException( __METHOD__ . ": empty input for field $field" );
+ throw new InvalidArgumentException(
+ __METHOD__ . ": empty input for field $field" );
} elseif ( count( $value ) == 0 ) {
// only check if $field is null
$list .= "$field IS NULL";
}
}
} elseif ( $value === null ) {
- if ( $mode == LIST_AND || $mode == LIST_OR ) {
+ if ( $mode == self::LIST_AND || $mode == self::LIST_OR ) {
$list .= "$field IS ";
- } elseif ( $mode == LIST_SET ) {
+ } elseif ( $mode == self::LIST_SET ) {
$list .= "$field = ";
}
$list .= 'NULL';
} else {
- if ( $mode == LIST_AND || $mode == LIST_OR || $mode == LIST_SET ) {
+ if (
+ $mode == self::LIST_AND || $mode == self::LIST_OR || $mode == self::LIST_SET
+ ) {
$list .= "$field = ";
}
- $list .= $mode == LIST_NAMES ? $value : $this->addQuotes( $value );
+ $list .= $mode == self::LIST_NAMES ? $value : $this->addQuotes( $value );
}
}
if ( count( $sub ) ) {
$conds[] = $this->makeList(
[ $baseKey => $base, $subKey => array_keys( $sub ) ],
- LIST_AND );
+ self::LIST_AND );
}
}
if ( $conds ) {
- return $this->makeList( $conds, LIST_OR );
+ return $this->makeList( $conds, self::LIST_OR );
} else {
// Nothing to search for...
return false;
$tableClause .= ' ' . $ignore;
}
}
- $on = $this->makeList( (array)$conds, LIST_AND );
+ $on = $this->makeList( (array)$conds, self::LIST_AND );
if ( $on != '' ) {
$tableClause .= ' ON (' . $on . ')';
}
foreach ( $index as $column ) {
$rowKey[$column] = $row[$column];
}
- $clauses[] = $this->makeList( $rowKey, LIST_AND );
+ $clauses[] = $this->makeList( $rowKey, self::LIST_AND );
}
}
- $where = [ $this->makeList( $clauses, LIST_OR ) ];
+ $where = [ $this->makeList( $clauses, self::LIST_OR ) ];
} else {
$where = false;
}
$joinTable = $this->tableName( $joinTable );
$sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
if ( $conds != '*' ) {
- $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND );
+ $sql .= 'WHERE ' . $this->makeList( $conds, self::LIST_AND );
}
$sql .= ')';
if ( $conds != '*' ) {
if ( is_array( $conds ) ) {
- $conds = $this->makeList( $conds, LIST_AND );
+ $conds = $this->makeList( $conds, self::LIST_AND );
}
$sql .= ' WHERE ' . $conds;
}
if ( $conds != '*' ) {
if ( is_array( $conds ) ) {
- $conds = $this->makeList( $conds, LIST_AND );
+ $conds = $this->makeList( $conds, self::LIST_AND );
}
$sql .= " WHERE $conds";
}
public function conditional( $cond, $trueVal, $falseVal ) {
if ( is_array( $cond ) ) {
- $cond = $this->makeList( $cond, LIST_AND );
+ $cond = $this->makeList( $cond, self::LIST_AND );
}
return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
* @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html
*/
protected function getHeartbeatData( array $conds ) {
- $whereSQL = $this->makeList( $conds, LIST_AND );
+ $whereSQL = $this->makeList( $conds, self::LIST_AND );
// Use ORDER BY for channel based queries since that field might not be UNIQUE.
// Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
// percision field is not supported in MySQL <= 5.5.
$sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
if ( $conds != '*' ) {
- $sql .= ' AND ' . $this->makeList( $conds, LIST_AND );
+ $sql .= ' AND ' . $this->makeList( $conds, self::LIST_AND );
}
return $this->query( $sql, $fname );
$rowTuples[] = '(' . $this->makeList( $row ) . ')';
}
$sql .= implode( ',', $rowTuples );
- $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, LIST_SET );
+ $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self::LIST_SET );
return (bool)$this->query( $sql, $fname );
}
--- /dev/null
+<?php
+/**
+ * This is the SQLite database abstraction layer.
+ * See maintenance/sqlite/README for development notes and other specific information
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Database
+ */
+
+/**
+ * @ingroup Database
+ */
+class DatabaseSqlite extends DatabaseBase {
+ /** @var bool Whether full text is enabled */
+ private static $fulltextEnabled = null;
+
+ /** @var string Directory */
+ protected $dbDir;
+
+ /** @var string File name for SQLite database file */
+ protected $dbPath;
+
+ /** @var string Transaction mode */
+ protected $trxMode;
+
+ /** @var int The number of rows affected as an integer */
+ protected $mAffectedRows;
+
+ /** @var resource */
+ protected $mLastResult;
+
+ /** @var PDO */
+ protected $mConn;
+
+ /** @var FSLockManager (hopefully on the same server as the DB) */
+ protected $lockMgr;
+
+ /**
+ * Additional params include:
+ * - dbDirectory : directory containing the DB and the lock file directory
+ * [defaults to $wgSQLiteDataDir]
+ * - dbFilePath : use this to force the path of the DB file
+ * - trxMode : one of (deferred, immediate, exclusive)
+ * @param array $p
+ */
+ function __construct( array $p ) {
+ if ( isset( $p['dbFilePath'] ) ) {
+ parent::__construct( $p );
+ // Standalone .sqlite file mode.
+ // Super doesn't open when $user is false, but we can work with $dbName,
+ // which is derived from the file path in this case.
+ $this->openFile( $p['dbFilePath'] );
+ $lockDomain = md5( $p['dbFilePath'] );
+ } elseif ( !isset( $p['dbDirectory'] ) ) {
+ throw new InvalidArgumentException( "Need 'dbDirectory' or 'dbFilePath' parameter." );
+ } else {
+ $this->dbDir = $p['dbDirectory'];
+ $this->mDBname = $p['dbname'];
+ $lockDomain = $this->mDBname;
+ // Stock wiki mode using standard file names per DB.
+ parent::__construct( $p );
+ // Super doesn't open when $user is false, but we can work with $dbName
+ if ( $p['dbname'] && !$this->isOpen() ) {
+ if ( $this->open( $p['host'], $p['user'], $p['password'], $p['dbname'] ) ) {
+ $done = [];
+ foreach ( $this->tableAliases as $params ) {
+ if ( isset( $done[$params['dbname']] ) ) {
+ continue;
+ }
+ $this->attachDatabase( $params['dbname'] );
+ $done[$params['dbname']] = 1;
+ }
+ }
+ }
+ }
+
+ $this->trxMode = isset( $p['trxMode'] ) ? strtoupper( $p['trxMode'] ) : null;
+ if ( $this->trxMode &&
+ !in_array( $this->trxMode, [ 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ] )
+ ) {
+ $this->trxMode = null;
+ $this->queryLogger->warning( "Invalid SQLite transaction mode provided." );
+ }
+
+ $this->lockMgr = new FSLockManager( [
+ 'domain' => $lockDomain,
+ 'lockDirectory' => "{$this->dbDir}/locks"
+ ] );
+ }
+
+ /**
+ * @param string $filename
+ * @param array $p Options map; supports:
+ * - flags : (same as __construct counterpart)
+ * - trxMode : (same as __construct counterpart)
+ * - dbDirectory : (same as __construct counterpart)
+ * @return DatabaseSqlite
+ * @since 1.25
+ */
+ public static function newStandaloneInstance( $filename, array $p = [] ) {
+ $p['dbFilePath'] = $filename;
+ $p['schema'] = false;
+ $p['tablePrefix'] = '';
+
+ return DatabaseBase::factory( 'sqlite', $p );
+ }
+
+ /**
+ * @return string
+ */
+ function getType() {
+ return 'sqlite';
+ }
+
+ /**
+ * @todo Check if it should be true like parent class
+ *
+ * @return bool
+ */
+ function implicitGroupby() {
+ return false;
+ }
+
+ /** Open an SQLite database and return a resource handle to it
+ * NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases
+ *
+ * @param string $server
+ * @param string $user
+ * @param string $pass
+ * @param string $dbName
+ *
+ * @throws DBConnectionError
+ * @return PDO
+ */
+ function open( $server, $user, $pass, $dbName ) {
+ $this->close();
+ $fileName = self::generateFileName( $this->dbDir, $dbName );
+ if ( !is_readable( $fileName ) ) {
+ $this->mConn = false;
+ throw new DBConnectionError( $this, "SQLite database not accessible" );
+ }
+ $this->openFile( $fileName );
+
+ return $this->mConn;
+ }
+
+ /**
+ * Opens a database file
+ *
+ * @param string $fileName
+ * @throws DBConnectionError
+ * @return PDO|bool SQL connection or false if failed
+ */
+ protected function openFile( $fileName ) {
+ $err = false;
+
+ $this->dbPath = $fileName;
+ try {
+ if ( $this->mFlags & DBO_PERSISTENT ) {
+ $this->mConn = new PDO( "sqlite:$fileName", '', '',
+ [ PDO::ATTR_PERSISTENT => true ] );
+ } else {
+ $this->mConn = new PDO( "sqlite:$fileName", '', '' );
+ }
+ } catch ( PDOException $e ) {
+ $err = $e->getMessage();
+ }
+
+ if ( !$this->mConn ) {
+ $this->queryLogger->debug( "DB connection error: $err\n" );
+ throw new DBConnectionError( $this, $err );
+ }
+
+ $this->mOpened = !!$this->mConn;
+ if ( $this->mOpened ) {
+ # Set error codes only, don't raise exceptions
+ $this->mConn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT );
+ # Enforce LIKE to be case sensitive, just like MySQL
+ $this->query( 'PRAGMA case_sensitive_like = 1' );
+
+ return $this->mConn;
+ }
+
+ return false;
+ }
+
+ /**
+ * @return string SQLite DB file path
+ * @since 1.25
+ */
+ public function getDbFilePath() {
+ return $this->dbPath;
+ }
+
+ /**
+ * Does not actually close the connection, just destroys the reference for GC to do its work
+ * @return bool
+ */
+ protected function closeConnection() {
+ $this->mConn = null;
+
+ return true;
+ }
+
+ /**
+ * Generates a database file name. Explicitly public for installer.
+ * @param string $dir Directory where database resides
+ * @param string $dbName Database name
+ * @return string
+ */
+ public static function generateFileName( $dir, $dbName ) {
+ return "$dir/$dbName.sqlite";
+ }
+
+ /**
+ * Check if the searchindext table is FTS enabled.
+ * @return bool 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
+ */
+ 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;
+ }
+
+ /**
+ * Attaches external database to our connection, see http://sqlite.org/lang_attach.html
+ * for details.
+ *
+ * @param string $name Database name to be used in queries like
+ * SELECT foo FROM dbname.table
+ * @param bool|string $file Database file name. If omitted, will be generated
+ * using $name and configured data directory
+ * @param string $fname Calling function name
+ * @return ResultWrapper
+ */
+ function attachDatabase( $name, $file = false, $fname = __METHOD__ ) {
+ if ( !$file ) {
+ $file = self::generateFileName( $this->dbDir, $name );
+ }
+ $file = $this->addQuotes( $file );
+
+ return $this->query( "ATTACH DATABASE $file AS $name", $fname );
+ }
+
+ function isWriteQuery( $sql ) {
+ return parent::isWriteQuery( $sql ) && !preg_match( '/^(ATTACH|PRAGMA)\b/i', $sql );
+ }
+
+ /**
+ * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result
+ *
+ * @param string $sql
+ * @return bool|ResultWrapper
+ */
+ protected function doQuery( $sql ) {
+ $res = $this->mConn->query( $sql );
+ if ( $res === false ) {
+ return false;
+ } else {
+ $r = $res instanceof ResultWrapper ? $res->result : $res;
+ $this->mAffectedRows = $r->rowCount();
+ $res = new ResultWrapper( $this, $r->fetchAll() );
+ }
+
+ return $res;
+ }
+
+ /**
+ * @param ResultWrapper|mixed $res
+ */
+ function freeResult( $res ) {
+ if ( $res instanceof ResultWrapper ) {
+ $res->result = null;
+ } else {
+ $res = null;
+ }
+ }
+
+ /**
+ * @param ResultWrapper|array $res
+ * @return stdClass|bool
+ */
+ function fetchObject( $res ) {
+ if ( $res instanceof ResultWrapper ) {
+ $r =& $res->result;
+ } else {
+ $r =& $res;
+ }
+
+ $cur = current( $r );
+ if ( is_array( $cur ) ) {
+ next( $r );
+ $obj = new stdClass;
+ foreach ( $cur as $k => $v ) {
+ if ( !is_numeric( $k ) ) {
+ $obj->$k = $v;
+ }
+ }
+
+ return $obj;
+ }
+
+ return false;
+ }
+
+ /**
+ * @param ResultWrapper|mixed $res
+ * @return array|bool
+ */
+ function fetchRow( $res ) {
+ if ( $res instanceof ResultWrapper ) {
+ $r =& $res->result;
+ } else {
+ $r =& $res;
+ }
+ $cur = current( $r );
+ if ( is_array( $cur ) ) {
+ next( $r );
+
+ return $cur;
+ }
+
+ return false;
+ }
+
+ /**
+ * The PDO::Statement class implements the array interface so count() will work
+ *
+ * @param ResultWrapper|array $res
+ * @return int
+ */
+ function numRows( $res ) {
+ $r = $res instanceof ResultWrapper ? $res->result : $res;
+
+ return count( $r );
+ }
+
+ /**
+ * @param ResultWrapper $res
+ * @return int
+ */
+ function numFields( $res ) {
+ $r = $res instanceof ResultWrapper ? $res->result : $res;
+ if ( is_array( $r ) && count( $r ) > 0 ) {
+ // The size of the result array is twice the number of fields. (Bug: 65578)
+ return count( $r[0] ) / 2;
+ } else {
+ // If the result is empty return 0
+ return 0;
+ }
+ }
+
+ /**
+ * @param ResultWrapper $res
+ * @param int $n
+ * @return bool
+ */
+ function fieldName( $res, $n ) {
+ $r = $res instanceof ResultWrapper ? $res->result : $res;
+ if ( is_array( $r ) ) {
+ $keys = array_keys( $r[0] );
+
+ return $keys[$n];
+ }
+
+ return false;
+ }
+
+ /**
+ * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks
+ *
+ * @param string $name
+ * @param string $format
+ * @return string
+ */
+ 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 ) );
+ }
+
+ /**
+ * Index names have DB scope
+ *
+ * @param string $index
+ * @return string
+ */
+ protected function indexName( $index ) {
+ return $index;
+ }
+
+ /**
+ * This must be called after nextSequenceVal
+ *
+ * @return int
+ */
+ function insertId() {
+ // PDO::lastInsertId yields a string :(
+ return intval( $this->mConn->lastInsertId() );
+ }
+
+ /**
+ * @param ResultWrapper|array $res
+ * @param int $row
+ */
+ function dataSeek( $res, $row ) {
+ if ( $res instanceof ResultWrapper ) {
+ $r =& $res->result;
+ } else {
+ $r =& $res;
+ }
+ reset( $r );
+ if ( $row > 0 ) {
+ for ( $i = 0; $i < $row; $i++ ) {
+ next( $r );
+ }
+ }
+ }
+
+ /**
+ * @return string
+ */
+ function lastError() {
+ if ( !is_object( $this->mConn ) ) {
+ return "Cannot return last error, no db connection";
+ }
+ $e = $this->mConn->errorInfo();
+
+ return isset( $e[2] ) ? $e[2] : '';
+ }
+
+ /**
+ * @return string
+ */
+ function lastErrno() {
+ if ( !is_object( $this->mConn ) ) {
+ return "Cannot return last error, no db connection";
+ } else {
+ $info = $this->mConn->errorInfo();
+
+ return $info[1];
+ }
+ }
+
+ /**
+ * @return int
+ */
+ function affectedRows() {
+ return $this->mAffectedRows;
+ }
+
+ /**
+ * Returns information about an index
+ * Returns false if the index does not exist
+ * - if errors are explicitly ignored, returns NULL on failure
+ *
+ * @param string $table
+ * @param string $index
+ * @param string $fname
+ * @return array
+ */
+ function indexInfo( $table, $index, $fname = __METHOD__ ) {
+ $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
+ $res = $this->query( $sql, $fname );
+ if ( !$res ) {
+ return null;
+ }
+ if ( $res->numRows() == 0 ) {
+ return false;
+ }
+ $info = [];
+ foreach ( $res as $row ) {
+ $info[] = $row->name;
+ }
+
+ return $info;
+ }
+
+ /**
+ * @param string $table
+ * @param string $index
+ * @param string $fname
+ * @return bool|null
+ */
+ 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 );
+ }
+
+ /**
+ * Filter the options used in SELECT statements
+ *
+ * @param array $options
+ * @return array
+ */
+ function makeSelectOptions( $options ) {
+ foreach ( $options as $k => $v ) {
+ if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' || $v == 'LOCK IN SHARE MODE' ) ) {
+ $options[$k] = '';
+ }
+ }
+
+ return parent::makeSelectOptions( $options );
+ }
+
+ /**
+ * @param array $options
+ * @return string
+ */
+ protected function makeUpdateOptionsArray( $options ) {
+ $options = parent::makeUpdateOptionsArray( $options );
+ $options = self::fixIgnore( $options );
+
+ return $options;
+ }
+
+ /**
+ * @param array $options
+ * @return array
+ */
+ 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;
+ }
+
+ /**
+ * @param array $options
+ * @return string
+ */
+ function makeInsertOptions( $options ) {
+ $options = self::fixIgnore( $options );
+
+ return parent::makeInsertOptions( $options );
+ }
+
+ /**
+ * Based on generic method (parent) with some prior SQLite-sepcific adjustments
+ * @param string $table
+ * @param array $a
+ * @param string $fname
+ * @param array $options
+ * @return bool
+ */
+ 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] ) ) {
+ $ret = true;
+ 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 );
+ }
+
+ return $ret;
+ }
+
+ /**
+ * @param string $table
+ * @param array $uniqueIndexes Unused
+ * @param string|array $rows
+ * @param string $fname
+ * @return bool|ResultWrapper
+ */
+ function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) {
+ 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 $v ) {
+ if ( !$this->nativeReplace( $table, $v, "$fname/multi-row" ) ) {
+ $ret = false;
+ }
+ }
+ } else {
+ $ret = $this->nativeReplace( $table, $rows, "$fname/single-row" );
+ }
+
+ return $ret;
+ }
+
+ /**
+ * Returns the size of a text field, or -1 for "unlimited"
+ * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though.
+ *
+ * @param string $table
+ * @param string $field
+ * @return int
+ */
+ function textFieldSize( $table, $field ) {
+ return -1;
+ }
+
+ /**
+ * @return bool
+ */
+ function unionSupportsOrderAndLimit() {
+ return false;
+ }
+
+ /**
+ * @param string $sqls
+ * @param bool $all Whether to "UNION ALL" or not
+ * @return string
+ */
+ function unionQueries( $sqls, $all ) {
+ $glue = $all ? ' UNION ALL ' : ' UNION ';
+
+ return implode( $glue, $sqls );
+ }
+
+ /**
+ * @return bool
+ */
+ function wasDeadlock() {
+ return $this->lastErrno() == 5; // SQLITE_BUSY
+ }
+
+ /**
+ * @return bool
+ */
+ function wasErrorReissuable() {
+ return $this->lastErrno() == 17; // SQLITE_SCHEMA;
+ }
+
+ /**
+ * @return bool
+ */
+ function wasReadOnlyError() {
+ return $this->lastErrno() == 8; // SQLITE_READONLY;
+ }
+
+ /**
+ * @return string Wikitext of a link to the server software's web site
+ */
+ public function getSoftwareLink() {
+ return "[{{int:version-db-sqlite-url}} SQLite]";
+ }
+
+ /**
+ * @return string Version information from the database
+ */
+ function getServerVersion() {
+ $ver = $this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION );
+
+ return $ver;
+ }
+
+ /**
+ * Get information about a given field
+ * Returns false if the field does not exist.
+ *
+ * @param string $table
+ * @param string $field
+ * @return SQLiteField|bool False on failure
+ */
+ function fieldInfo( $table, $field ) {
+ $tableName = $this->tableName( $table );
+ $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
+ $res = $this->query( $sql, __METHOD__ );
+ 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 );
+ }
+ $this->mTrxLevel = 1;
+ }
+
+ /**
+ * @param string $s
+ * @return string
+ */
+ function strencode( $s ) {
+ return substr( $this->addQuotes( $s ), 1, -1 );
+ }
+
+ /**
+ * @param string $b
+ * @return Blob
+ */
+ function encodeBlob( $b ) {
+ return new Blob( $b );
+ }
+
+ /**
+ * @param Blob|string $b
+ * @return string
+ */
+ function decodeBlob( $b ) {
+ if ( $b instanceof Blob ) {
+ $b = $b->fetch();
+ }
+
+ return $b;
+ }
+
+ /**
+ * @param Blob|string $s
+ * @return string
+ */
+ function addQuotes( $s ) {
+ if ( $s instanceof Blob ) {
+ return "x'" . bin2hex( $s->fetch() ) . "'";
+ } elseif ( is_bool( $s ) ) {
+ return (int)$s;
+ } elseif ( strpos( $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( $s ) . "'";
+ } else {
+ return $this->mConn->quote( $s );
+ }
+ }
+
+ /**
+ * @return string
+ */
+ function buildLike() {
+ $params = func_get_args();
+ if ( count( $params ) > 0 && is_array( $params[0] ) ) {
+ $params = $params[0];
+ }
+
+ return parent::buildLike( $params ) . "ESCAPE '\' ";
+ }
+
+ /**
+ * @param string $field Field or column to cast
+ * @return string
+ * @since 1.28
+ */
+ public function buildStringCast( $field ) {
+ return 'CAST ( ' . $field . ' AS TEXT )';
+ }
+
+ /**
+ * @return string
+ */
+ public function getSearchEngine() {
+ return "SearchSqlite";
+ }
+
+ /**
+ * No-op version of deadlockLoop
+ *
+ * @return mixed
+ */
+ public function deadlockLoop( /*...*/ ) {
+ $args = func_get_args();
+ $function = array_shift( $args );
+
+ return call_user_func_array( $function, $args );
+ }
+
+ /**
+ * @param string $s
+ * @return string
+ */
+ 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 ) {
+ if ( !is_dir( "{$this->dbDir}/locks" ) ) { // create dir as needed
+ if ( !is_writable( $this->dbDir ) || !mkdir( "{$this->dbDir}/locks" ) ) {
+ throw new DBError( $this, "Cannot create directory \"{$this->dbDir}/locks\"." );
+ }
+ }
+
+ return $this->lockMgr->lock( [ $lockName ], LockManager::LOCK_EX, $timeout )->isOK();
+ }
+
+ public function unlock( $lockName, $method ) {
+ return $this->lockMgr->unlock( [ $lockName ], LockManager::LOCK_EX )->isOK();
+ }
+
+ /**
+ * Build a concatenation list to feed into a SQL query
+ *
+ * @param string[] $stringList
+ * @return string
+ */
+ 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 ) . ')';
+ }
+
+ /**
+ * @param string $oldName
+ * @param string $newName
+ * @param bool $temporary
+ * @param string $fname
+ * @return bool|ResultWrapper
+ * @throws RuntimeException
+ */
+ 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 );
+
+ // 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;
+ }
+
+ /**
+ * List all tables on the database
+ *
+ * @param string $prefix Only show tables with this prefix, e.g. mw_
+ * @param string $fname Calling function name
+ *
+ * @return array
+ */
+ 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;
+ }
+
+ /**
+ * Override due to no CASCADE support
+ *
+ * @param string $tableName
+ * @param string $fName
+ * @return bool|ResultWrapper
+ * @throws DBReadOnlyError
+ */
+ public function dropTable( $tableName, $fName = __METHOD__ ) {
+ if ( !$this->tableExists( $tableName, $fName ) ) {
+ return false;
+ }
+ $sql = "DROP TABLE " . $this->tableName( $tableName );
+
+ return $this->query( $sql, $fName );
+ }
+
+ /**
+ * @return string
+ */
+ public function __toString() {
+ return 'SQLite ' . (string)$this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION );
+ }
+
+} // end DatabaseSqlite class
/** @var string Estimate time to apply (scanning, applying) */
const ESTIMATE_DB_APPLY = 'apply';
+ /** @var int Combine list with comma delimeters */
+ const LIST_COMMA = 0;
+ /** @var int Combine list with AND clauses */
+ const LIST_AND = 1;
+ /** @var int Convert map into a SET clause */
+ const LIST_SET = 2;
+ /** @var int Treat as field name and do not apply value escaping */
+ const LIST_NAMES = 3;
+ /** @var int Combine list with OR clauses */
+ const LIST_OR = 4;
+
/**
* A string describing the current software version, and possibly
* other details in a user-friendly way. Will be listed on Special:Version, etc.
/**
* Makes an encoded list of strings from an array
*
+ * These can be used to make conjunctions or disjunctions on SQL condition strings
+ * derived from an array (see IDatabase::select() $conds documentation).
+ *
+ * Example usage:
+ * @code
+ * $sql = $db->makeList( [
+ * 'rev_user' => $id,
+ * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
+ * ], $db::LIST_AND );
+ * @endcode
+ * This would set $sql to "rev_user = '$id' AND (rev_minor = '1' OR rev_len < '500')"
+ *
* @param array $a Containing the data
- * @param int $mode Constant
- * - LIST_COMMA: Comma separated, no field names
- * - LIST_AND: ANDed WHERE clause (without the WHERE). See the
- * documentation for $conds in IDatabase::select().
- * - LIST_OR: ORed WHERE clause (without the WHERE)
- * - LIST_SET: Comma separated with field names, like a SET clause
- * - LIST_NAMES: Comma separated field names
+ * @param int $mode IDatabase class constant:
+ * - IDatabase::LIST_COMMA: Comma separated, no field names
+ * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
+ * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
+ * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
+ * - IDatabase::LIST_NAMES: Comma separated field names
* @throws DBError
* @return string
*/
- public function makeList( $a, $mode = LIST_COMMA );
+ public function makeList( $a, $mode = self::LIST_COMMA );
/**
* Build a partial where clause from a 2-d array such as used for LinkBatch.
define( 'DB_REPLICA', -1 ); # Read from a replica (or only server)
define( 'DB_MASTER', -2 ); # Write to master (or only server)
/**@}*/
-
-/**@{
- * Flags for IDatabase::makeList()
- * These are also available as Database class constants
- */
-define( 'LIST_COMMA', 0 );
-define( 'LIST_AND', 1 );
-define( 'LIST_SET', 2 );
-define( 'LIST_NAMES', 3 );
-define( 'LIST_OR', 4 );
-/**@}*/
"htmlform-user-not-exists": "<strong>$1</strong> does not exist.",
"htmlform-user-not-valid": "<strong>$1</strong> isn't a valid username.",
"rawmessage": "$1",
- "sqlite-has-fts": "$1 with full-text search support",
- "sqlite-no-fts": "$1 without full-text search support",
"logentry-delete-delete": "$1 {{GENDER:$2|deleted}} page $3",
"logentry-delete-restore": "$1 {{GENDER:$2|restored}} page $3",
"logentry-delete-event": "$1 {{GENDER:$2|changed}} visibility of {{PLURAL:$5|a log event|$5 log events}} on $3: $4",
"htmlform-user-not-exists": "Error message shown if a user with the name provided by the user does not exist. $1 is the username.",
"htmlform-user-not-valid": "Error message shown if the name provided by the user isn't a valid username. $1 is the username.",
"rawmessage": "{{notranslate}} Used to pass arbitrary text as a message specifier array",
- "sqlite-has-fts": "Shown on [[Special:Version]].\nParameters:\n* $1 - version",
- "sqlite-no-fts": "Shown on [[Special:Version]].\nParameters:\n* $1 - version",
"logentry-delete-delete": "{{Logentry|[[Special:Log/delete]]}}",
"logentry-delete-restore": "{{Logentry|[[Special:Log/delete]]}}",
"logentry-delete-event": "{{Logentry|[[Special:Log/delete]]}}\n{{Logentryparam}}\n* $5 - count of affected log events",
dépôts / lhc / web / wiklou.git / commitdiff