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.3.7';
37 protected static $notMiniumumVerisonMessage = '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() {
74 $defaults = parent
::getGlobalDefaults();
75 if ( isset( $_SERVER['DOCUMENT_ROOT'] ) ) {
79 dirname( $_SERVER['DOCUMENT_ROOT'] ) . '/data'
82 $defaults['wgSQLiteDataDir'] = $path;
87 public function getConnectForm() {
88 return $this->getTextBox(
90 'config-sqlite-dir', [],
91 $this->parent
->getHelpBox( 'config-sqlite-dir-help' )
97 $this->parent
->getHelpBox( 'config-sqlite-name-help' )
102 * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
104 * @param string $path
108 private static function realpath( $path ) {
109 $result = realpath( $path );
120 public function submitConnectForm() {
121 $this->setVarsFromRequest( [ 'wgSQLiteDataDir', 'wgDBname' ] );
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 );
131 # Table prefix is not used on SQLite, keep it empty
132 $this->setVar( 'wgDBprefix', '' );
139 * @param bool $create
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 ),
153 return Status
::newFatal(
154 'config-sqlite-parent-unwritable-nogroup',
155 $dir, dirname( $dir ), basename( $dir )
160 # Called early on in the installer, later we just want to sanity check
161 # if it's still writable
163 Wikimedia\
suppressWarnings();
164 $ok = wfMkdirParents( $dir, 0700, __METHOD__
);
165 Wikimedia\restoreWarnings
();
167 return Status
::newFatal( 'config-sqlite-mkdir-error', $dir );
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" );
173 if ( !is_writable( $dir ) ) {
174 return Status
::newFatal( 'config-sqlite-dir-unwritable', $dir );
177 # We haven't blown up yet, fall through
178 return Status
::newGood();
184 public function openConnection() {
185 $status = Status
::newGood();
186 $dir = $this->getVar( 'wgSQLiteDataDir' );
187 $dbName = $this->getVar( 'wgDBname' );
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() );
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 ) ) ) {
210 // If the data file exists, look inside it
211 return parent
::needsUpgrade();
217 public function setupDatabase() {
218 $dir = $this->getVar( 'wgSQLiteDataDir' );
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() ) {
227 $db = $this->getVar( 'wgDBname' );
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 if ( !$status->isOK() ) {
238 # Nuke the unused settings for clarity
239 $this->setVar( 'wgDBserver', '' );
240 $this->setVar( 'wgDBuser', '' );
241 $this->setVar( 'wgDBpassword', '' );
242 $this->setupSchemaVars();
244 # Create the global cache DB
246 $conn = Database
::factory(
247 'sqlite', [ 'dbname' => 'wikicache', 'dbDirectory' => $dir ] );
248 # @todo: don't duplicate objectcache definition, though it's very simple
251 CREATE TABLE IF NOT EXISTS objectcache (
252 keyname BLOB NOT NULL default '' PRIMARY KEY,
257 $conn->query( $sql );
258 $conn->query( "CREATE INDEX IF NOT EXISTS exptime ON objectcache (exptime)" );
259 $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
261 } catch ( DBConnectionError
$e ) {
262 return Status
::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
265 # Create the l10n cache DB
267 $conn = Database
::factory(
268 'sqlite', [ 'dbname' => "{$db}_l10n_cache", 'dbDirectory' => $dir ] );
269 # @todo: don't duplicate l10n_cache definition, though it's very simple
272 CREATE TABLE l10n_cache (
273 lc_lang BLOB NOT NULL,
274 lc_key TEXT NOT NULL,
275 lc_value BLOB NOT NULL,
276 PRIMARY KEY (lc_lang, lc_key)
279 $conn->query( $sql );
280 $conn->query( "PRAGMA journal_mode=WAL" ); // this is permanent
282 } catch ( DBConnectionError
$e ) {
283 return Status
::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
287 return $this->getConnection();
295 protected function makeStubDBFile( $dir, $db ) {
296 $file = DatabaseSqlite
::generateFileName( $dir, $db );
297 if ( file_exists( $file ) ) {
298 if ( !is_writable( $file ) ) {
299 return Status
::newFatal( 'config-sqlite-readonly', $file );
302 if ( file_put_contents( $file, '' ) === false ) {
303 return Status
::newFatal( 'config-sqlite-cant-create-db', $file );
307 return Status
::newGood();
313 public function createTables() {
314 $status = parent
::createTables();
316 return $this->setupSearchIndex( $status );
320 * @param Status &$status
323 public function setupSearchIndex( &$status ) {
326 $module = DatabaseSqlite
::getFulltextSearchModule();
327 $fts3tTable = $this->db
->checkForEnabledSearch();
328 if ( $fts3tTable && !$module ) {
329 $status->warning( 'config-sqlite-fts3-downgrade' );
330 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
331 } elseif ( !$fts3tTable && $module == 'FTS3' ) {
332 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
341 public function getLocalSettings() {
342 $dir = LocalSettingsGenerator
::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
344 return "# SQLite-specific settings
345 \$wgSQLiteDataDir = \"{$dir}\";
346 \$wgObjectCaches[CACHE_DB] = [
347 'class' => SqlBagOStuff::class,
348 'loggroup' => 'SQLBagOStuff',
351 'dbname' => 'wikicache',
353 'dbDirectory' => \$wgSQLiteDataDir,
357 \$wgLocalisationCacheConf['storeServer'] = [
359 'dbname' => \"{\$wgDBname}_l10n_cache\",
361 'dbDirectory' => \$wgSQLiteDataDir,