MediaWiki  master
SqliteInstaller.php
Go to the documentation of this file.
1 <?php
24 use Wikimedia\AtEase\AtEase;
28 
36 
37  public static $minimumVersion = '3.8.0';
38  protected static $notMinimumVersionMessage = 'config-outdated-sqlite';
39 
43  public $db;
44 
45  protected $globalNames = [
46  'wgDBname',
47  'wgSQLiteDataDir',
48  ];
49 
50  public function getName() {
51  return 'sqlite';
52  }
53 
54  public function isCompiled() {
55  return self::checkExtension( 'pdo_sqlite' );
56  }
57 
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  global $IP;
75  $defaults = parent::getGlobalDefaults();
76  if ( !empty( $_SERVER['DOCUMENT_ROOT'] ) ) {
77  $path = dirname( $_SERVER['DOCUMENT_ROOT'] );
78  } else {
79  // We use $IP when unable to get $_SERVER['DOCUMENT_ROOT']
80  $path = $IP;
81  }
82  $defaults['wgSQLiteDataDir'] = str_replace(
83  [ '/', '\\' ],
84  DIRECTORY_SEPARATOR,
85  $path . '/data'
86  );
87  return $defaults;
88  }
89 
90  public function getConnectForm() {
91  return $this->getTextBox(
92  'wgSQLiteDataDir',
93  'config-sqlite-dir', [],
94  $this->parent->getHelpBox( 'config-sqlite-dir-help' )
95  ) .
96  $this->getTextBox(
97  'wgDBname',
98  'config-db-name',
99  [],
100  $this->parent->getHelpBox( 'config-sqlite-name-help' )
101  );
102  }
103 
111  private static function realpath( $path ) {
112  $result = realpath( $path );
113  if ( !$result ) {
114  return $path;
115  }
116 
117  return $result;
118  }
119 
123  public function submitConnectForm() {
124  $this->setVarsFromRequest( [ 'wgSQLiteDataDir', 'wgDBname' ] );
125 
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 );
133  }
134  # Table prefix is not used on SQLite, keep it empty
135  $this->setVar( 'wgDBprefix', '' );
136 
137  return $result;
138  }
139 
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 );
149  }
150  } else {
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 ),
158  $webserverGroup
159  );
160  } else {
161  return Status::newFatal(
162  'config-sqlite-parent-unwritable-nogroup',
163  $dir, dirname( $dir ), basename( $dir )
164  );
165  }
166  }
167  }
168  return Status::newGood();
169  }
170 
175  private static function createDataDir( $dir ): Status {
176  if ( !is_dir( $dir ) ) {
177  AtEase::suppressWarnings();
178  $ok = wfMkdirParents( $dir, 0700, __METHOD__ );
179  AtEase::restoreWarnings();
180  if ( !$ok ) {
181  return Status::newFatal( 'config-sqlite-mkdir-error', $dir );
182  }
183  }
184  # Put a .htaccess file in case the user didn't take our advice
185  file_put_contents( "$dir/.htaccess", "Deny from all\n" );
186  return Status::newGood();
187  }
188 
192  public function openConnection() {
193  $status = Status::newGood();
194  $dir = $this->getVar( 'wgSQLiteDataDir' );
195  $dbName = $this->getVar( 'wgDBname' );
196  try {
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() );
202  }
203 
204  return $status;
205  }
206 
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 ) ) ) {
215  return false;
216  }
217 
218  // If the data file exists, look inside it
219  return parent::needsUpgrade();
220  }
221 
225  public function setupDatabase() {
226  $dir = $this->getVar( 'wgSQLiteDataDir' );
227 
228  # Double 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() ) {
234  return $res;
235  }
236  } else {
237  return $dir_status;
238  }
239 
240  $db = $this->getVar( 'wgDBname' );
241 
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() ) {
249  return $status;
250  }
251 
252  # Nuke the unused settings for clarity
253  $this->setVar( 'wgDBserver', '' );
254  $this->setVar( 'wgDBuser', '' );
255  $this->setVar( 'wgDBpassword', '' );
256  $this->setupSchemaVars();
257 
258  # Create the l10n cache DB
259  try {
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
263  $sql =
264 <<<EOT
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)
270  );
271 EOT;
272  $conn->query( $sql, __METHOD__ );
273  $conn->query( "PRAGMA journal_mode=WAL", __METHOD__ ); // this is permanent
274  $conn->close( __METHOD__ );
275  } catch ( DBConnectionError $e ) {
276  return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
277  }
278 
279  # Create the job queue DB
280  try {
281  $conn = Database::factory(
282  'sqlite', [ 'dbname' => "{$db}_jobqueue", 'dbDirectory' => $dir ] );
283  # @todo: don't duplicate job definition, though it's very static
284  $sql =
285 <<<EOT
286  CREATE TABLE job (
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 ''
298  );
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);
304 EOT;
305  $conn->query( $sql, __METHOD__ );
306  $conn->query( "PRAGMA journal_mode=WAL", __METHOD__ ); // this is permanent
307  $conn->close( __METHOD__ );
308  } catch ( DBConnectionError $e ) {
309  return Status::newFatal( 'config-sqlite-connection-error', $e->getMessage() );
310  }
311 
312  # Open the main DB
313  return $this->getConnection();
314  }
315 
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 );
326  }
327  } elseif ( file_put_contents( $file, '' ) === false ) {
328  return Status::newFatal( 'config-sqlite-cant-create-db', $file );
329  }
330 
331  return Status::newGood();
332  }
333 
337  public function createTables() {
338  $status = parent::createTables();
339  if ( $status->isGood() ) {
340  $status = parent::createManualTables();
341  }
342 
343  return $this->setupSearchIndex( $status );
344  }
345 
346  public function createManualTables() {
347  // Already handled above. Do nothing.
348  return Status::newGood();
349  }
350 
355  public function setupSearchIndex( &$status ) {
356  global $IP;
357 
358  $module = DatabaseSqlite::getFulltextSearchModule();
359  $searchIndexSql = (string)$this->db->selectField(
360  $this->db->addIdentifierQuotes( 'sqlite_master' ),
361  'sql',
362  [ 'tbl_name' => $this->db->tableName( 'searchindex', 'raw' ) ],
363  __METHOD__
364  );
365  $fts3tTable = ( stristr( $searchIndexSql, 'fts' ) !== false );
366 
367  if ( $fts3tTable && !$module ) {
368  $status->warning( 'config-sqlite-fts3-downgrade' );
369  $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
370  } elseif ( !$fts3tTable && $module == 'FTS3' ) {
371  $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
372  }
373 
374  return $status;
375  }
376 
380  public function getLocalSettings() {
381  $dir = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
382  // These tables have frequent writes and are thus split off from the main one.
383  // Since the code using these tables only uses transactions for writes then set
384  // them to using BEGIN IMMEDIATE. This avoids frequent lock errors on first write.
385  return "# SQLite-specific settings
386 \$wgSQLiteDataDir = \"{$dir}\";
387 \$wgObjectCaches[CACHE_DB] = [
388  'class' => SqlBagOStuff::class,
389  'loggroup' => 'SQLBagOStuff',
390  'server' => [
391  'type' => 'sqlite',
392  'dbname' => 'wikicache',
393  'tablePrefix' => '',
394  'variables' => [ 'synchronous' => 'NORMAL' ],
395  'dbDirectory' => \$wgSQLiteDataDir,
396  'trxMode' => 'IMMEDIATE',
397  'flags' => 0
398  ]
399 ];
400 \$wgObjectCaches['db-replicated'] = [
401  'factory' => 'Wikimedia\ObjectFactory\ObjectFactory::getObjectFromSpec',
402  'args' => [ [ 'factory' => 'ObjectCache::getInstance', 'args' => [ CACHE_DB ] ] ]
403 ];
404 \$wgLocalisationCacheConf['storeServer'] = [
405  'type' => 'sqlite',
406  'dbname' => \"{\$wgDBname}_l10n_cache\",
407  'tablePrefix' => '',
408  'variables' => [ 'synchronous' => 'NORMAL' ],
409  'dbDirectory' => \$wgSQLiteDataDir,
410  'trxMode' => 'IMMEDIATE',
411  'flags' => 0
412 ];
413 \$wgJobTypeConf['default'] = [
414  'class' => 'JobQueueDB',
415  'claimTTL' => 3600,
416  'server' => [
417  'type' => 'sqlite',
418  'dbname' => \"{\$wgDBname}_jobqueue\",
419  'tablePrefix' => '',
420  'variables' => [ 'synchronous' => 'NORMAL' ],
421  'dbDirectory' => \$wgSQLiteDataDir,
422  'trxMode' => 'IMMEDIATE',
423  'flags' => 0
424  ]
425 ];
426 \$wgResourceLoaderUseObjectCacheForDeps = true;";
427  }
428 }
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
if(!defined( 'MEDIAWIKI')) if(ini_get( 'mbstring.func_overload')) if(!defined( 'MW_ENTRY_POINT')) global $IP
Environment checks.
Definition: Setup.php:91
if(!defined('MW_SETUP_CALLBACK'))
The persistent session ID (if any) loaded at startup.
Definition: WebStart.php:82
Base class for DBMS-specific installation helper classes.
static checkExtension( $name)
Convenience function.
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
getVar( $var, $default=null)
Get a variable, taking local defaults into account.
getTextBox( $var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
setVar( $name, $value)
Convenience alias for $this->parent->setVar()
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
Definition: Installer.php:749
static escapePhpString( $string)
Returns the escaped version of a string of php code.
Class for setting up the MediaWiki database using SQLLite.
setupSearchIndex(&$status)
getGlobalDefaults()
Get a name=>value map of MW configuration globals for the default values.
makeStubDBFile( $dir, $db)
getName()
Return the internal name, e.g.
DatabaseSqlite $db
getConnectForm()
Get HTML for a web form that configures this database.
static $notMinimumVersionMessage
createManualTables()
Create database tables from scratch.
static newFatal( $message,... $parameters)
Factory function for fatal errors.
Definition: StatusValue.php:70
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:82
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:44
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42