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
25 * Class for setting up the MediaWiki database using SQLLite.
30 class SqliteInstaller
extends DatabaseInstaller
{
31 const MINIMUM_VERSION
= '3.3.7';
38 protected $globalNames = array(
43 public function getName() {
47 public function isCompiled() {
48 return self
::checkExtension( 'pdo_sqlite' );
55 public function checkPrerequisites() {
56 $result = Status
::newGood();
57 // Bail out if SQLite is too old
58 $db = new DatabaseSqliteStandalone( ':memory:' );
59 if ( version_compare( $db->getServerVersion(), self
::MINIMUM_VERSION
, '<' ) ) {
60 $result->fatal( 'config-outdated-sqlite', $db->getServerVersion(), self
::MINIMUM_VERSION
);
62 // Check for FTS3 full-text search module
63 if ( DatabaseSqlite
::getFulltextSearchModule() != 'FTS3' ) {
64 $result->warning( 'config-no-fts3' );
70 public function getGlobalDefaults() {
71 if ( isset( $_SERVER['DOCUMENT_ROOT'] ) ) {
75 dirname( $_SERVER['DOCUMENT_ROOT'] ) . '/data'
78 return array( 'wgSQLiteDataDir' => $path );
84 public function getConnectForm() {
85 return $this->getTextBox( 'wgSQLiteDataDir', 'config-sqlite-dir', array(), $this->parent
->getHelpBox( 'config-sqlite-dir-help' ) ) .
86 $this->getTextBox( 'wgDBname', 'config-db-name', array(), $this->parent
->getHelpBox( 'config-sqlite-name-help' ) );
90 * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
96 private static function realpath( $path ) {
97 $result = realpath( $path );
108 public function submitConnectForm() {
109 $this->setVarsFromRequest( array( 'wgSQLiteDataDir', 'wgDBname' ) );
111 # Try realpath() if the directory already exists
112 $dir = self
::realpath( $this->getVar( 'wgSQLiteDataDir' ) );
113 $result = self
::dataDirOKmaybeCreate( $dir, true /* create? */ );
114 if ( $result->isOK() ) {
115 # Try expanding again in case we've just created it
116 $dir = self
::realpath( $dir );
117 $this->setVar( 'wgSQLiteDataDir', $dir );
119 # Table prefix is not used on SQLite, keep it empty
120 $this->setVar( 'wgDBprefix', '' );
127 * @param $create bool
130 private static function dataDirOKmaybeCreate( $dir, $create = false ) {
131 if ( !is_dir( $dir ) ) {
132 if ( !is_writable( dirname( $dir ) ) ) {
133 $webserverGroup = Installer
::maybeGetWebserverPrimaryGroup();
134 if ( $webserverGroup !== null ) {
135 return Status
::newFatal( 'config-sqlite-parent-unwritable-group', $dir, dirname( $dir ), basename( $dir ), $webserverGroup );
137 return Status
::newFatal( 'config-sqlite-parent-unwritable-nogroup', $dir, dirname( $dir ), basename( $dir ) );
141 # Called early on in the installer, later we just want to sanity check
142 # if it's still writable
144 wfSuppressWarnings();
145 $ok = wfMkdirParents( $dir, 0700, __METHOD__
);
148 return Status
::newFatal( 'config-sqlite-mkdir-error', $dir );
150 # Put a .htaccess file in in case the user didn't take our advice
151 file_put_contents( "$dir/.htaccess", "Deny from all\n" );
154 if ( !is_writable( $dir ) ) {
155 return Status
::newFatal( 'config-sqlite-dir-unwritable', $dir );
158 # We haven't blown up yet, fall through
159 return Status
::newGood();
165 public function openConnection() {
166 global $wgSQLiteDataDir;
168 $status = Status
::newGood();
169 $dir = $this->getVar( 'wgSQLiteDataDir' );
170 $dbName = $this->getVar( 'wgDBname' );
172 # @todo FIXME: Need more sensible constructor parameters, e.g. single associative array
173 # Setting globals kind of sucks
174 $wgSQLiteDataDir = $dir;
175 $db = new DatabaseSqlite( false, false, false, $dbName );
176 $status->value
= $db;
177 } catch ( DBConnectionError
$e ) {
178 $status->fatal( 'config-sqlite-connection-error', $e->getMessage() );
187 public function needsUpgrade() {
188 $dir = $this->getVar( 'wgSQLiteDataDir' );
189 $dbName = $this->getVar( 'wgDBname' );
190 // Don't create the data file yet
191 if ( !file_exists( DatabaseSqlite
::generateFileName( $dir, $dbName ) ) ) {
195 // If the data file exists, look inside it
196 return parent
::needsUpgrade();
202 public function setupDatabase() {
203 $dir = $this->getVar( 'wgSQLiteDataDir' );
205 # Sanity check. We checked this before but maybe someone deleted the
206 # data dir between then and now
207 $dir_status = self
::dataDirOKmaybeCreate( $dir, false /* create? */ );
208 if ( !$dir_status->isOK() ) {
212 $db = $this->getVar( 'wgDBname' );
213 $file = DatabaseSqlite
::generateFileName( $dir, $db );
214 if ( file_exists( $file ) ) {
215 if ( !is_writable( $file ) ) {
216 return Status
::newFatal( 'config-sqlite-readonly', $file );
219 if ( file_put_contents( $file, '' ) === false ) {
220 return Status
::newFatal( 'config-sqlite-cant-create-db', $file );
223 // nuke the unused settings for clarity
224 $this->setVar( 'wgDBserver', '' );
225 $this->setVar( 'wgDBuser', '' );
226 $this->setVar( 'wgDBpassword', '' );
227 $this->setupSchemaVars();
229 return $this->getConnection();
235 public function createTables() {
236 $status = parent
::createTables();
238 return $this->setupSearchIndex( $status );
242 * @param $status Status
245 public function setupSearchIndex( &$status ) {
248 $module = DatabaseSqlite
::getFulltextSearchModule();
249 $fts3tTable = $this->db
->checkForEnabledSearch();
250 if ( $fts3tTable && !$module ) {
251 $status->warning( 'config-sqlite-fts3-downgrade' );
252 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
253 } elseif ( !$fts3tTable && $module == 'FTS3' ) {
254 $this->db
->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-fts3.sql" );
263 public function getLocalSettings() {
264 $dir = LocalSettingsGenerator
::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
266 return "# SQLite-specific settings
267 \$wgSQLiteDataDir = \"{$dir}\";";