3 * Sqlite-specific installer.
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.
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.
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
24 use Wikimedia\Rdbms\Database
;
25 use Wikimedia\Rdbms\DatabaseSqlite
;
26 use Wikimedia\Rdbms\DBConnectionError
;
29 * Class for setting up the MediaWiki database using SQLLite.
34 class SqliteInstaller
extends DatabaseInstaller
{
36 public static $minimumVersion = '3.8.0';
37 protected static $notMinimumVersionMessage = 'config-outdated-sqlite';
44 protected $globalNames = [
49 public function getName() {
53 public function isCompiled() {
54 return self
::checkExtension( 'pdo_sqlite' );
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' );
73 public function getGlobalDefaults() {
75 $defaults = parent
::getGlobalDefaults();
76 if ( !empty( $_SERVER['DOCUMENT_ROOT'] ) ) {
77 $path = dirname( $_SERVER['DOCUMENT_ROOT'] );
79 // We use $IP when unable to get $_SERVER['DOCUMENT_ROOT']
82 $defaults['wgSQLiteDataDir'] = str_replace(
90 public function getConnectForm() {
91 return $this->getTextBox(
93 'config-sqlite-dir', [],
94 $this->parent
->getHelpBox( 'config-sqlite-dir-help' )
100 $this->parent
->getHelpBox( 'config-sqlite-name-help' )
105 * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
107 * @param string $path
111 private static function realpath( $path ) {
112 $result = realpath( $path );
123 public function submitConnectForm() {
124 $this->setVarsFromRequest( [ 'wgSQLiteDataDir', 'wgDBname' ] );
126 # Try realpath() if the directory already exists
127 $dir = self
::realpath( $this->getVar( 'wgSQLiteDataDir' ) );
128 $result = self
::checkDataDir( $dir );
129 if ( $result->isOK() ) {
130 # Try expanding again in case we've just created it
131 $dir = self
::realpath( $dir );
132 $this->setVar( 'wgSQLiteDataDir', $dir );
134 # Table prefix is not used on SQLite, keep it empty
135 $this->setVar( 'wgDBprefix', '' );
141 * Check if the data directory is writable or can be created
142 * @param string $dir Path to the data directory
143 * @return Status Return fatal Status if $dir un-writable or no permission to create a directory
145 private static function checkDataDir( $dir ) : Status
{
146 if ( is_dir( $dir ) ) {
147 if ( !is_readable( $dir ) ) {
148 return Status
::newFatal( 'config-sqlite-dir-unwritable', $dir );
151 // Check the parent directory if $dir not exists
152 if ( !is_writable( dirname( $dir ) ) ) {
153 $webserverGroup = Installer
::maybeGetWebserverPrimaryGroup();
154 if ( $webserverGroup !== null ) {
155 return Status
::newFatal(
156 'config-sqlite-parent-unwritable-group',
157 $dir, dirname( $dir ), basename( $dir ),
161 return Status
::newFatal(
162 'config-sqlite-parent-unwritable-nogroup',
163 $dir, dirname( $dir ), basename( $dir )
168 return Status
::newGood();
172 * @param string $dir Path to the data directory
173 * @return Status Return good Status if without error
175 private static function createDataDir( $dir ) : Status
{
176 if ( !is_dir( $dir ) ) {
177 Wikimedia\
suppressWarnings();
178 $ok = wfMkdirParents( $dir, 0700, __METHOD__
);
179 Wikimedia\restoreWarnings
();
181 return Status
::newFatal( 'config-sqlite-mkdir-error', $dir );
184 # Put a .htaccess file in in case the user didn't take our advice
185 file_put_contents( "$dir/.htaccess", "Deny from all\n" );
186 return Status
::newGood();
192 public function openConnection() {
193 $status = Status
::newGood();
194 $dir = $this->getVar( 'wgSQLiteDataDir' );
195 $dbName = $this->getVar( 'wgDBname' );
197 # @todo FIXME: Need more sensible constructor parameters, e.g. single associative array
198 $db = Database
::factory( 'sqlite', [ 'dbname' => $dbName, 'dbDirectory' => $dir ] );
199 $status->value
= $db;
200 } catch ( DBConnectionError
$e ) {
201 $status->fatal( 'config-sqlite-connection-error', $e->getMessage() );
210 public function needsUpgrade() {
211 $dir = $this->getVar( 'wgSQLiteDataDir' );
212 $dbName = $this->getVar( 'wgDBname' );
213 // Don't create the data file yet
214 if ( !file_exists( DatabaseSqlite
::generateFileName( $dir, $dbName ) ) ) {
218 // If the data file exists, look inside it
219 return parent
::needsUpgrade();
225 public function setupDatabase() {
226 $dir = $this->getVar( 'wgSQLiteDataDir' );
228 # Sanity check (Only available in web installation). We checked this before but maybe someone
229 # deleted the data dir between then and now
230 $dir_status = self
::checkDataDir( $dir );
231 if ( $dir_status->isGood() ) {
232 $res = self
::createDataDir( $dir );
233 if ( !$res->isGood() ) {
240 $db = $this->getVar( 'wgDBname' );
242 # Make the main and cache stub DB files
243 $status = Status
::newGood();
244 $status->merge( $this->makeStubDBFile( $dir, $db ) );
245 $status->merge( $this->makeStubDBFile( $dir, "wikicache" ) );
246 $status->merge( $this->makeStubDBFile( $dir, "{$db}_l10n_cache" ) );
247 $status->merge( $this->makeStubDBFile( $dir, "{$db}_jobqueue" ) );
248 if ( !$status->isOK() ) {
252 # Nuke the unused settings for clarity
253 $this->setVar( 'wgDBserver', '' );
254 $this->setVar( 'wgDBuser', '' );
255 $this->setVar( 'wgDBpassword', '' );
256 $this->setupSchemaVars();
258 # Create the l10n cache DB
260 $conn = Database
::factory(
261 'sqlite', [ 'dbname' => "{$db}_l10n_cache", 'dbDirectory' => $dir ] );
262 # @todo: don't duplicate l10n_cache definition, though it's very simple
265 CREATE TABLE l10n_cache (
266 lc_lang BLOB NOT NULL,
267 lc_key TEXT NOT NULL,
268 lc_value BLOB NOT NULL,
269 PRIMARY KEY (lc_lang, lc_key)
272 $conn->query( $sql );
273 $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
275 } catch ( DBConnectionError
$e ) {
276 return Status
::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
279 # Create the job queue DB
281 $conn = Database
::factory(
282 'sqlite', [ 'dbname' => "{$db}_jobqueue", 'dbDirectory' => $dir ] );
283 # @todo: don't duplicate job definition, though it's very static
287 job_id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
288 job_cmd BLOB NOT NULL default '',
289 job_namespace INTEGER NOT NULL,
290 job_title TEXT NOT NULL,
291 job_timestamp BLOB NULL default NULL,
292 job_params BLOB NOT NULL,
293 job_random integer NOT NULL default 0,
294 job_attempts integer NOT NULL default 0,
295 job_token BLOB NOT NULL default '',
296 job_token_timestamp BLOB NULL default NULL,
297 job_sha1 BLOB NOT NULL default ''
299 CREATE INDEX job_sha1 ON job (job_sha1);
300 CREATE INDEX job_cmd_token ON job (job_cmd,job_token,job_random);
301 CREATE INDEX job_cmd_token_id ON job (job_cmd,job_token,job_id);
302 CREATE INDEX job_cmd ON job (job_cmd, job_namespace, job_title, job_params);
303 CREATE INDEX job_timestamp ON job (job_timestamp);
305 $conn->query( $sql );
306 $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
308 } catch ( DBConnectionError
$e ) {
309 return Status
::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
313 return $this->getConnection();
321 protected function makeStubDBFile( $dir, $db ) {
322 $file = DatabaseSqlite
::generateFileName( $dir, $db );
323 if ( file_exists( $file ) ) {
324 if ( !is_writable( $file ) ) {
325 return Status
::newFatal( 'config-sqlite-readonly', $file );
327 } elseif ( file_put_contents( $file, '' ) === false ) {
328 return Status
::newFatal( 'config-sqlite-cant-create-db', $file );
331 return Status
::newGood();
337 public function createTables() {
338 $status = parent
::createTables();
340 return $this->setupSearchIndex( $status );
344 * @param Status &$status
347 public function setupSearchIndex( &$status ) {
350 $module = DatabaseSqlite
::getFulltextSearchModule();
351 $searchIndexSql = (string)$this->db
->selectField(
352 $this->db
->addIdentifierQuotes( 'sqlite_master' ),
354 [ 'tbl_name' => $this->db
->tableName( 'searchindex', 'raw' ) ],
357 $fts3tTable = ( stristr( $searchIndexSql, 'fts' ) !== false );
359 if ( $fts3tTable && !$module ) {
360 $status->warning( 'config-sqlite-fts3-downgrade' );
361 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
362 } elseif ( !$fts3tTable && $module == 'FTS3' ) {
363 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
372 public function getLocalSettings() {
373 $dir = LocalSettingsGenerator
::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
374 // These tables have frequent writes and are thus split off from the main one.
375 // Since the code using these tables only uses transactions for writes then set
376 // them to using BEGIN IMMEDIATE. This avoids frequent lock errors on first write.
377 return "# SQLite-specific settings
378 \$wgSQLiteDataDir = \"{$dir}\";
379 \$wgObjectCaches[CACHE_DB] = [
380 'class' => SqlBagOStuff::class,
381 'loggroup' => 'SQLBagOStuff',
384 'dbname' => 'wikicache',
386 'variables' => [ 'synchronous' => 'NORMAL' ],
387 'dbDirectory' => \$wgSQLiteDataDir,
388 'trxMode' => 'IMMEDIATE',
392 \$wgLocalisationCacheConf['storeServer'] = [
394 'dbname' => \"{\$wgDBname}_l10n_cache\",
396 'variables' => [ 'synchronous' => 'NORMAL' ],
397 'dbDirectory' => \$wgSQLiteDataDir,
398 'trxMode' => 'IMMEDIATE',
401 \$wgJobTypeConf['default'] = [
402 'class' => 'JobQueueDB',
406 'dbname' => \"{\$wgDBname}_jobqueue\",
408 'variables' => [ 'synchronous' => 'NORMAL' ],
409 'dbDirectory' => \$wgSQLiteDataDir,
410 'trxMode' => 'IMMEDIATE',