maintenance/sqlite.inc

   1 <?php
   2 /**
   3  * Helper class for sqlite-specific scripts
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 /**
  25  * This class contains code common to different SQLite-related maintenance scripts
  26  *
  27  * @ingroup Maintenance
  28  */
  29 class Sqlite {
  30
  31         /**
  32          * Checks whether PHP has SQLite support
  33          * @return bool
  34          */
  35         public static function isPresent() {
  36                 return extension_loaded( 'pdo_sqlite' );
  37         }
  38
  39         /**
  40          * Checks given files for correctness of SQL syntax. MySQL DDL will be converted to
  41          * SQLite-compatible during processing.
  42          * Will throw exceptions on SQL errors
  43          * @param array|string $files
  44          * @throws MWException
  45          * @return bool True if no error or error string in case of errors
  46          */
  47         public static function checkSqlSyntax( $files ) {
  48                 if ( !Sqlite::isPresent() ) {
  49                         throw new MWException( "Can't check SQL syntax: SQLite not found" );
  50                 }
  51                 if ( !is_array( $files ) ) {
  52                         $files = [ $files ];
  53                 }
  54
  55                 $allowedTypes = array_flip( [
  56                         'integer',
  57                         'real',
  58                         'text',
  59                         'blob', // NULL type is omitted intentionally
  60                 ] );
  61
  62                 $db = DatabaseSqlite::newStandaloneInstance( ':memory:' );
  63                 try {
  64                         foreach ( $files as $file ) {
  65                                 $err = $db->sourceFile( $file );
  66                                 if ( $err != true ) {
  67                                         return $err;
  68                                 }
  69                         }
  70
  71                         $tables = $db->query( "SELECT name FROM sqlite_master WHERE type='table'", __METHOD__ );
  72                         foreach ( $tables as $table ) {
  73                                 if ( strpos( $table->name, 'sqlite_' ) === 0 ) {
  74                                         continue;
  75                                 }
  76
  77                                 $columns = $db->query( "PRAGMA table_info({$table->name})", __METHOD__ );
  78                                 foreach ( $columns as $col ) {
  79                                         if ( !isset( $allowedTypes[strtolower( $col->type )] ) ) {
  80                                                 $db->close();
  81
  82                                                 return "Table {$table->name} has column {$col->name} with non-native type '{$col->type}'";
  83                                         }
  84                                 }
  85                         }
  86                 } catch ( DBError $e ) {
  87                         return $e->getMessage();
  88                 }
  89                 $db->close();
  90
  91                 return true;
  92         }
  93 }