includes/installer/SqliteInstaller.php

   1 <?php
   2 /**
   3  * Sqlite-specific installer.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 use Wikimedia\Rdbms\Database;
  25 use Wikimedia\Rdbms\DatabaseSqlite;
  26 use Wikimedia\Rdbms\DBConnectionError;
  27
  28 /**
  29  * Class for setting up the MediaWiki database using SQLLite.
  30  *
  31  * @ingroup Deployment
  32  * @since 1.17
  33  */
  34 class SqliteInstaller extends DatabaseInstaller {
  35
  36         public static $minimumVersion = '3.8.0';
  37         protected static $notMiniumumVerisonMessage = 'config-outdated-sqlite';
  38
  39         /**
  40          * @var DatabaseSqlite
  41          */
  42         public $db;
  43
  44         protected $globalNames = [
  45                 'wgDBname',
  46                 'wgSQLiteDataDir',
  47         ];
  48
  49         public function getName() {
  50                 return 'sqlite';
  51         }
  52
  53         public function isCompiled() {
  54                 return self::checkExtension( 'pdo_sqlite' );
  55         }
  56
  57         /**
  58          *
  59          * @return Status
  60          */
  61         public function checkPrerequisites() {
  62                 // Bail out if SQLite is too old
  63                 $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
  64                 $result = static::meetsMinimumRequirement( $db->getServerVersion() );
  65                 // Check for FTS3 full-text search module
  66                 if ( DatabaseSqlite::getFulltextSearchModule() != 'FTS3' ) {
  67                         $result->warning( 'config-no-fts3' );
  68                 }
  69
  70                 return $result;
  71         }
  72
  73         public function getGlobalDefaults() {
  74                 $defaults = parent::getGlobalDefaults();
  75                 if ( isset( $_SERVER['DOCUMENT_ROOT'] ) ) {
  76                         $path = str_replace(
  77                                 [ '/', '\\' ],
  78                                 DIRECTORY_SEPARATOR,
  79                                 dirname( $_SERVER['DOCUMENT_ROOT'] ) . '/data'
  80                         );
  81
  82                         $defaults['wgSQLiteDataDir'] = $path;
  83                 }
  84                 return $defaults;
  85         }
  86
  87         public function getConnectForm() {
  88                 return $this->getTextBox(
  89                         'wgSQLiteDataDir',
  90                         'config-sqlite-dir', [],
  91                         $this->parent->getHelpBox( 'config-sqlite-dir-help' )
  92                 ) .
  93                 $this->getTextBox(
  94                         'wgDBname',
  95                         'config-db-name',
  96                         [],
  97                         $this->parent->getHelpBox( 'config-sqlite-name-help' )
  98                 );
  99         }
 100
 101         /**
 102          * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
 103          *
 104          * @param string $path
 105          *
 106          * @return string
 107          */
 108         private static function realpath( $path ) {
 109                 $result = realpath( $path );
 110                 if ( !$result ) {
 111                         return $path;
 112                 }
 113
 114                 return $result;
 115         }
 116
 117         /**
 118          * @return Status
 119          */
 120         public function submitConnectForm() {
 121                 $this->setVarsFromRequest( [ 'wgSQLiteDataDir', 'wgDBname' ] );
 122
 123                 # Try realpath() if the directory already exists
 124                 $dir = self::realpath( $this->getVar( 'wgSQLiteDataDir' ) );
 125                 $result = self::dataDirOKmaybeCreate( $dir, true /* create? */ );
 126                 if ( $result->isOK() ) {
 127                         # Try expanding again in case we've just created it
 128                         $dir = self::realpath( $dir );
 129                         $this->setVar( 'wgSQLiteDataDir', $dir );
 130                 }
 131                 # Table prefix is not used on SQLite, keep it empty
 132                 $this->setVar( 'wgDBprefix', '' );
 133
 134                 return $result;
 135         }
 136
 137         /**
 138          * @param string $dir
 139          * @param bool $create
 140          * @return Status
 141          */
 142         private static function dataDirOKmaybeCreate( $dir, $create = false ) {
 143                 if ( !is_dir( $dir ) ) {
 144                         if ( !is_writable( dirname( $dir ) ) ) {
 145                                 $webserverGroup = Installer::maybeGetWebserverPrimaryGroup();
 146                                 if ( $webserverGroup !== null ) {
 147                                         return Status::newFatal(
 148                                                 'config-sqlite-parent-unwritable-group',
 149                                                 $dir, dirname( $dir ), basename( $dir ),
 150                                                 $webserverGroup
 151                                         );
 152                                 } else {
 153                                         return Status::newFatal(
 154                                                 'config-sqlite-parent-unwritable-nogroup',
 155                                                 $dir, dirname( $dir ), basename( $dir )
 156                                         );
 157                                 }
 158                         }
 159
 160                         # Called early on in the installer, later we just want to sanity check
 161                         # if it's still writable
 162                         if ( $create ) {
 163                                 Wikimedia\suppressWarnings();
 164                                 $ok = wfMkdirParents( $dir, 0700, __METHOD__ );
 165                                 Wikimedia\restoreWarnings();
 166                                 if ( !$ok ) {
 167                                         return Status::newFatal( 'config-sqlite-mkdir-error', $dir );
 168                                 }
 169                                 # Put a .htaccess file in in case the user didn't take our advice
 170                                 file_put_contents( "$dir/.htaccess", "Deny from all\n" );
 171                         }
 172                 }
 173                 if ( !is_writable( $dir ) ) {
 174                         return Status::newFatal( 'config-sqlite-dir-unwritable', $dir );
 175                 }
 176
 177                 # We haven't blown up yet, fall through
 178                 return Status::newGood();
 179         }
 180
 181         /**
 182          * @return Status
 183          */
 184         public function openConnection() {
 185                 $status = Status::newGood();
 186                 $dir = $this->getVar( 'wgSQLiteDataDir' );
 187                 $dbName = $this->getVar( 'wgDBname' );
 188                 try {
 189                         # @todo FIXME: Need more sensible constructor parameters, e.g. single associative array
 190                         $db = Database::factory( 'sqlite', [ 'dbname' => $dbName, 'dbDirectory' => $dir ] );
 191                         $status->value = $db;
 192                 } catch ( DBConnectionError $e ) {
 193                         $status->fatal( 'config-sqlite-connection-error', $e->getMessage() );
 194                 }
 195
 196                 return $status;
 197         }
 198
 199         /**
 200          * @return bool
 201          */
 202         public function needsUpgrade() {
 203                 $dir = $this->getVar( 'wgSQLiteDataDir' );
 204                 $dbName = $this->getVar( 'wgDBname' );
 205                 // Don't create the data file yet
 206                 if ( !file_exists( DatabaseSqlite::generateFileName( $dir, $dbName ) ) ) {
 207                         return false;
 208                 }
 209
 210                 // If the data file exists, look inside it
 211                 return parent::needsUpgrade();
 212         }
 213
 214         /**
 215          * @return Status
 216          */
 217         public function setupDatabase() {
 218                 $dir = $this->getVar( 'wgSQLiteDataDir' );
 219
 220                 # Sanity check. We checked this before but maybe someone deleted the
 221                 # data dir between then and now
 222                 $dir_status = self::dataDirOKmaybeCreate( $dir, false /* create? */ );
 223                 if ( !$dir_status->isOK() ) {
 224                         return $dir_status;
 225                 }
 226
 227                 $db = $this->getVar( 'wgDBname' );
 228
 229                 # Make the main and cache stub DB files
 230                 $status = Status::newGood();
 231                 $status->merge( $this->makeStubDBFile( $dir, $db ) );
 232                 $status->merge( $this->makeStubDBFile( $dir, "wikicache" ) );
 233                 $status->merge( $this->makeStubDBFile( $dir, "{$db}_l10n_cache" ) );
 234                 $status->merge( $this->makeStubDBFile( $dir, "{$db}_jobqueue" ) );
 235                 if ( !$status->isOK() ) {
 236                         return $status;
 237                 }
 238
 239                 # Nuke the unused settings for clarity
 240                 $this->setVar( 'wgDBserver', '' );
 241                 $this->setVar( 'wgDBuser', '' );
 242                 $this->setVar( 'wgDBpassword', '' );
 243                 $this->setupSchemaVars();
 244
 245                 # Create the global cache DB
 246                 try {
 247                         $conn = Database::factory(
 248                                 'sqlite', [ 'dbname' => 'wikicache', 'dbDirectory' => $dir ] );
 249                         # @todo: don't duplicate objectcache definition, though it's very simple
 250                         $sql =
 251 <<<EOT
 252         CREATE TABLE IF NOT EXISTS objectcache (
 253                 keyname BLOB NOT NULL default '' PRIMARY KEY,
 254                 value BLOB,
 255                 exptime TEXT
 256         )
 257 EOT;
 258                         $conn->query( $sql );
 259                         $conn->query( "CREATE INDEX IF NOT EXISTS exptime ON objectcache (exptime)" );
 260                         $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
 261                         $conn->close();
 262                 } catch ( DBConnectionError $e ) {
 263                         return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
 264                 }
 265
 266                 # Create the l10n cache DB
 267                 try {
 268                         $conn = Database::factory(
 269                                 'sqlite', [ 'dbname' => "{$db}_l10n_cache", 'dbDirectory' => $dir ] );
 270                         # @todo: don't duplicate l10n_cache definition, though it's very simple
 271                         $sql =
 272 <<<EOT
 273         CREATE TABLE l10n_cache (
 274                 lc_lang BLOB NOT NULL,
 275                 lc_key TEXT NOT NULL,
 276                 lc_value BLOB NOT NULL,
 277                 PRIMARY KEY (lc_lang, lc_key)
 278         );
 279 EOT;
 280                         $conn->query( $sql );
 281                         $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
 282                         $conn->close();
 283                 } catch ( DBConnectionError $e ) {
 284                         return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
 285                 }
 286
 287                 # Create the job queue DB
 288                 try {
 289                         $conn = Database::factory(
 290                                 'sqlite', [ 'dbname' => "{$db}_jobqueue", 'dbDirectory' => $dir ] );
 291                         # @todo: don't duplicate job definition, though it's very static
 292                         $sql =
 293 <<<EOT
 294         CREATE TABLE job (
 295                 job_id INTEGER  NOT NULL PRIMARY KEY AUTOINCREMENT,
 296                 job_cmd BLOB NOT NULL default '',
 297                 job_namespace INTEGER NOT NULL,
 298                 job_title TEXT  NOT NULL,
 299                 job_timestamp BLOB NULL default NULL,
 300                 job_params BLOB NOT NULL,
 301                 job_random integer  NOT NULL default 0,
 302                 job_attempts integer  NOT NULL default 0,
 303                 job_token BLOB NOT NULL default '',
 304                 job_token_timestamp BLOB NULL default NULL,
 305                 job_sha1 BLOB NOT NULL default ''
 306         );
 307         CREATE INDEX job_sha1 ON job (job_sha1);
 308         CREATE INDEX job_cmd_token ON job (job_cmd,job_token,job_random);
 309         CREATE INDEX job_cmd_token_id ON job (job_cmd,job_token,job_id);
 310         CREATE INDEX job_cmd ON job (job_cmd, job_namespace, job_title, job_params);
 311         CREATE INDEX job_timestamp ON job (job_timestamp);
 312 EOT;
 313                         $conn->query( $sql );
 314                         $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
 315                         $conn->close();
 316                 } catch ( DBConnectionError $e ) {
 317                         return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
 318                 }
 319
 320                 # Open the main DB
 321                 return $this->getConnection();
 322         }
 323
 324         /**
 325          * @param string $dir
 326          * @param string $db
 327          * @return Status
 328          */
 329         protected function makeStubDBFile( $dir, $db ) {
 330                 $file = DatabaseSqlite::generateFileName( $dir, $db );
 331                 if ( file_exists( $file ) ) {
 332                         if ( !is_writable( $file ) ) {
 333                                 return Status::newFatal( 'config-sqlite-readonly', $file );
 334                         }
 335                 } elseif ( file_put_contents( $file, '' ) === false ) {
 336                         return Status::newFatal( 'config-sqlite-cant-create-db', $file );
 337                 }
 338
 339                 return Status::newGood();
 340         }
 341
 342         /**
 343          * @return Status
 344          */
 345         public function createTables() {
 346                 $status = parent::createTables();
 347
 348                 return $this->setupSearchIndex( $status );
 349         }
 350
 351         /**
 352          * @param Status &$status
 353          * @return Status
 354          */
 355         public function setupSearchIndex( &$status ) {
 356                 global $IP;
 357
 358                 $module = DatabaseSqlite::getFulltextSearchModule();
 359                 $fts3tTable = $this->db->checkForEnabledSearch();
 360                 if ( $fts3tTable && !$module ) {
 361                         $status->warning( 'config-sqlite-fts3-downgrade' );
 362                         $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
 363                 } elseif ( !$fts3tTable && $module == 'FTS3' ) {
 364                         $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
 365                 }
 366
 367                 return $status;
 368         }
 369
 370         /**
 371          * @return string
 372          */
 373         public function getLocalSettings() {
 374                 $dir = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
 375                 // These tables have frequent writes and are thus split off from the main one.
 376                 // Since the code using these tables only uses transactions for writes then set
 377                 // them to using BEGIN IMMEDIATE. This avoids frequent lock errors on first write.
 378                 return "# SQLite-specific settings
 379 \$wgSQLiteDataDir = \"{$dir}\";
 380 \$wgObjectCaches[CACHE_DB] = [
 381         'class' => SqlBagOStuff::class,
 382         'loggroup' => 'SQLBagOStuff',
 383         'server' => [
 384                 'type' => 'sqlite',
 385                 'dbname' => 'wikicache',
 386                 'tablePrefix' => '',
 387                 'variables' => [ 'synchronous' => 'NORMAL' ],
 388                 'dbDirectory' => \$wgSQLiteDataDir,
 389                 'trxMode' => 'IMMEDIATE',
 390                 'flags' => 0
 391         ]
 392 ];
 393 \$wgLocalisationCacheConf['storeServer'] = [
 394         'type' => 'sqlite',
 395         'dbname' => \"{\$wgDBname}_l10n_cache\",
 396         'tablePrefix' => '',
 397         'variables' => [ 'synchronous' => 'NORMAL' ],
 398         'dbDirectory' => \$wgSQLiteDataDir,
 399         'trxMode' => 'IMMEDIATE',
 400         'flags' => 0
 401 ];
 402 \$wgJobTypeConf['default'] = [
 403         'class' => 'JobQueueDB',
 404         'claimTTL' => 3600,
 405         'server' => [
 406                 'type' => 'sqlite',
 407                 'dbname' => \"{\$wgDBname}_jobqueue\",
 408                 'tablePrefix' => '',
 409                 'dbDirectory' => \$wgSQLiteDataDir,
 410                 'trxMode' => 'IMMEDIATE',
 411                 'flags' => 0
 412         ]
 413 ];";
 414         }
 415 }