fix some spacing
[lhc/web/wiklou.git] / includes / installer / SqliteInstaller.php
index 4dccdd1..68df6ab 100644 (file)
@@ -2,18 +2,39 @@
 /**
  * Sqlite-specific installer.
  *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup Deployment
  */
+
 /**
  * Class for setting up the MediaWiki database using SQLLite.
- * 
+ *
  * @ingroup Deployment
  * @since 1.17
  */
 class SqliteInstaller extends DatabaseInstaller {
-       
+       const MINIMUM_VERSION = '3.3.7';
+
+       /**
+        * @var DatabaseSqlite
+        */
+       public $db;
+
        protected $globalNames = array(
                'wgDBname',
                'wgSQLiteDataDir',
@@ -27,6 +48,24 @@ class SqliteInstaller extends DatabaseInstaller {
                return self::checkExtension( 'pdo_sqlite' );
        }
 
+       /**
+        *
+        * @return Status:
+        */
+       public function checkPrerequisites() {
+               $result = Status::newGood();
+               // Bail out if SQLite is too old
+               $db = new DatabaseSqliteStandalone( ':memory:' );
+               if ( version_compare( $db->getServerVersion(), self::MINIMUM_VERSION, '<' ) ) {
+                       $result->fatal( 'config-outdated-sqlite', $db->getServerVersion(), self::MINIMUM_VERSION );
+               }
+               // Check for FTS3 full-text search module
+               if( DatabaseSqlite::getFulltextSearchModule() != 'FTS3' ) {
+                       $result->warning( 'config-no-fts3' );
+               }
+               return $result;
+       }
+
        public function getGlobalDefaults() {
                if ( isset( $_SERVER['DOCUMENT_ROOT'] ) ) {
                        $path = str_replace(
@@ -41,24 +80,49 @@ class SqliteInstaller extends DatabaseInstaller {
        }
 
        public function getConnectForm() {
-               return $this->getTextBox( 'wgSQLiteDataDir', 'config-sqlite-dir' ) .
-                       $this->parent->getHelpBox( 'config-sqlite-dir-help' ) .
-                       $this->getTextBox( 'wgDBname', 'config-db-name' ) .
-                       $this->parent->getHelpBox( 'config-sqlite-name-help' );
+               return $this->getTextBox( 'wgSQLiteDataDir', 'config-sqlite-dir', array(), $this->parent->getHelpBox( 'config-sqlite-dir-help' ) ) .
+                       $this->getTextBox( 'wgDBname', 'config-db-name', array(), $this->parent->getHelpBox( 'config-sqlite-name-help' ) );
        }
 
+       /**
+        * Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.
+        *
+        * @param $path string
+        *
+        * @return string
+        */
+       private static function realpath( $path ) {
+               $result = realpath( $path );
+               if ( !$result ) {
+                       return $path;
+               }
+               return $result;
+       }
+
+       /**
+        * @return Status
+        */
        public function submitConnectForm() {
                $this->setVarsFromRequest( array( 'wgSQLiteDataDir', 'wgDBname' ) );
 
-               $dir = realpath( $this->getVar( 'wgSQLiteDataDir' ) );
-               if ( !$dir ) {
-                       // realpath() sometimes fails, especially on Windows
-                       $dir = $this->getVar( 'wgSQLiteDataDir' );
+               # Try realpath() if the directory already exists
+               $dir = self::realpath( $this->getVar( 'wgSQLiteDataDir' ) );
+               $result = self::dataDirOKmaybeCreate( $dir, true /* create? */ );
+               if ( $result->isOK() ) {
+                       # Try expanding again in case we've just created it
+                       $dir = self::realpath( $dir );
+                       $this->setVar( 'wgSQLiteDataDir', $dir );
                }
-               $this->setVar( 'wgSQLiteDataDir', $dir );
-               return self::dataDirOKmaybeCreate( $dir, true /* create? */ );
+               # Table prefix is not used on SQLite, keep it empty
+               $this->setVar( 'wgDBprefix', '' );
+               return $result;
        }
 
+       /**
+        * @param $dir
+        * @param $create bool
+        * @return Status
+        */
        private static function dataDirOKmaybeCreate( $dir, $create = false ) {
                if ( !is_dir( $dir ) ) {
                        if ( !is_writable( dirname( $dir ) ) ) {
@@ -74,7 +138,7 @@ class SqliteInstaller extends DatabaseInstaller {
                        # if it's still writable
                        if ( $create ) {
                                wfSuppressWarnings();
-                               $ok = wfMkdirParents( $dir, 0700 );
+                               $ok = wfMkdirParents( $dir, 0700, __METHOD__ );
                                wfRestoreWarnings();
                                if ( !$ok ) {
                                        return Status::newFatal( 'config-sqlite-mkdir-error', $dir );
@@ -91,25 +155,30 @@ class SqliteInstaller extends DatabaseInstaller {
                return Status::newGood();
        }
 
-       public function getConnection() {
+       /**
+        * @return Status
+        */
+       public function openConnection() {
                global $wgSQLiteDataDir;
 
                $status = Status::newGood();
                $dir = $this->getVar( 'wgSQLiteDataDir' );
                $dbName = $this->getVar( 'wgDBname' );
-
                try {
-                       # FIXME: need more sensible constructor parameters, e.g. single associative array
+                       # @todo FIXME: Need more sensible constructor parameters, e.g. single associative array
                        # Setting globals kind of sucks
                        $wgSQLiteDataDir = $dir;
-                       $this->db = new DatabaseSqlite( false, false, false, $dbName );
-                       $status->value = $this->db;
+                       $db = new DatabaseSqlite( false, false, false, $dbName );
+                       $status->value = $db;
                } catch ( DBConnectionError $e ) {
                        $status->fatal( 'config-sqlite-connection-error', $e->getMessage() );
                }
                return $status;
        }
 
+       /**
+        * @return bool
+        */
        public function needsUpgrade() {
                $dir = $this->getVar( 'wgSQLiteDataDir' );
                $dbName = $this->getVar( 'wgDBname' );
@@ -122,6 +191,9 @@ class SqliteInstaller extends DatabaseInstaller {
                return parent::needsUpgrade();
        }
 
+       /**
+        * @return Status
+        */
        public function setupDatabase() {
                $dir = $this->getVar( 'wgSQLiteDataDir' );
 
@@ -147,20 +219,28 @@ class SqliteInstaller extends DatabaseInstaller {
                $this->setVar( 'wgDBserver', '' );
                $this->setVar( 'wgDBuser', '' );
                $this->setVar( 'wgDBpassword', '' );
+               $this->setupSchemaVars();
                return $this->getConnection();
        }
 
+       /**
+        * @return Status
+        */
        public function createTables() {
                $status = parent::createTables();
                return $this->setupSearchIndex( $status );
        }
 
+       /**
+        * @param $status Status
+        * @return Status
+        */
        public function setupSearchIndex( &$status ) {
                global $IP;
 
-               $module = $this->db->getFulltextSearchModule();
+               $module = DatabaseSqlite::getFulltextSearchModule();
                $fts3tTable = $this->db->checkForEnabledSearch();
-               if ( $fts3tTable &&  !$module ) {
+               if ( $fts3tTable && !$module ) {
                        $status->warning( 'config-sqlite-fts3-downgrade' );
                        $this->db->sourceFile( "$IP/maintenance/sqlite/archives/searchindex-no-fts.sql" );
                } elseif ( !$fts3tTable && $module == 'FTS3' ) {
@@ -169,10 +249,13 @@ class SqliteInstaller extends DatabaseInstaller {
                return $status;
        }
 
+       /**
+        * @return string
+        */
        public function getLocalSettings() {
                $dir = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgSQLiteDataDir' ) );
                return
 "# SQLite-specific settings
-\$wgSQLiteDataDir    = \"{$dir}\";";
+\$wgSQLiteDataDir = \"{$dir}\";";
        }
-}
\ No newline at end of file
+}