1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?php
/**
* Convert a JSON abstract schema change to a schema change file in the given DBMS type
*
* 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 Maintenance
*/
use Doctrine\SqlFormatter\NullHighlighter;
use Doctrine\SqlFormatter\SqlFormatter;
use Wikimedia\Rdbms\DoctrineSchemaBuilderFactory;
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script to generate schema from abstract json files.
*
* @ingroup Maintenance
*/
class GenerateSchemaChangeSql extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Build SQL files from abstract JSON files' );
$this->addOption(
'json',
'Path to the json file.',
true,
true
);
$this->addOption(
'sql',
'Path to output.',
true,
true
);
$this->addOption(
'type',
'Can be either \'mysql\', \'sqlite\', or \'postgres\'. Default: mysql',
false,
true
);
}
public function execute() {
global $IP;
$platform = $this->getOption( 'type', 'mysql' );
$jsonPath = $this->getOption( 'json' );
$installPath = $IP;
// For windows
if ( DIRECTORY_SEPARATOR === '\\' ) {
$installPath = strtr( $installPath, '\\', '/' );
$jsonPath = strtr( $jsonPath, '\\', '/' );
}
$relativeJsonPath = str_replace( "$installPath/", '', $jsonPath );
$sqlPath = $this->getOption( 'sql' );
// Allow to specify a folder and build the name from the json filename
if ( is_dir( $sqlPath ) ) {
$sqlPath .= '/' . pathinfo( $relativeJsonPath, PATHINFO_FILENAME ) . '.sql';
}
$abstractSchemaChange = json_decode( file_get_contents( $jsonPath ), true );
if ( $abstractSchemaChange === null ) {
$this->fatalError( "'$jsonPath' seems to be invalid json. Check the syntax and try again!" );
}
$schemaChangeBuilder = ( new DoctrineSchemaBuilderFactory() )->getSchemaChangeBuilder( $platform );
$schemaChangeSqls = $schemaChangeBuilder->getSchemaChangeSql( $abstractSchemaChange );
$sql = "-- This file is automatically generated using maintenance/generateSchemaChangeSql.php.\n" .
"-- Source: $relativeJsonPath\n" .
"-- Do not modify this file directly.\n" .
"-- See https://www.mediawiki.org/wiki/Manual:Schema_changes\n";
if ( $schemaChangeSqls !== [] ) {
// Temporary
$sql .= implode( ";\n\n", $schemaChangeSqls ) . ';';
$sql = ( new SqlFormatter( new NullHighlighter() ) )->format( $sql );
} else {
$this->error( 'No schema changes detected!' );
}
// Postgres hacks
if ( $platform === 'postgres' ) {
// Remove table prefixes from Postgres schema, people should not set it
// but better safe than sorry.
$sql = str_replace( "\n/*_*/\n", ' ', $sql );
// MySQL goes with varbinary for collation reasons, but postgres can't
// properly understand BYTEA type and works just fine with TEXT type
// FIXME: This should be fixed at some point (T257755)
$sql = str_replace( "BYTEA", 'TEXT', $sql );
}
// Until the linting issue is resolved
// https://github.com/doctrine/sql-formatter/issues/53
$sql = str_replace( "\n/*_*/\n", " /*_*/", $sql );
$sql = str_replace( "; ", ";\n", $sql );
$sql = preg_replace( "/\n+? +?/", ' ', $sql );
$sql = str_replace( "/*_*/ ", "/*_*/", $sql );
// Sqlite hacks
if ( $platform === 'sqlite' ) {
// Doctrine prepends __temp__ to the table name and we set the table with the schema prefix causing invalid
// sqlite.
$sql = preg_replace( '/__temp__\s*\/\*_\*\//', '/*_*/__temp__', $sql );
}
// Give a hint, if nothing changed
if ( is_readable( $sqlPath ) ) {
$oldSql = file_get_contents( $sqlPath );
if ( $oldSql === $sql ) {
$this->output( "Schema change is unchanged.\n" );
}
}
file_put_contents( $sqlPath, $sql );
$this->output( 'Schema change generated and written to ' . $sqlPath . "\n" );
}
}
$maintClass = GenerateSchemaChangeSql::class;
require_once RUN_MAINTENANCE_IF_MAIN;
|
