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