Page MenuHomeWickedGov Phorge
Files F4102733

SchemaMaintenance.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

SchemaMaintenance.php
View Options

<?php
/**
* Base script for schema maintenance
*
* 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
*/
namespace MediaWiki\Maintenance;
use MediaWiki\DB\AbstractSchemaValidationError;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
abstract class SchemaMaintenance extends Maintenance {
public const SUPPORTED_PLATFORMS = [
'mysql',
'sqlite',
'postgres'
];
public function __construct() {
parent::__construct();
$types = implode( ', ', array_map( static function ( string $type ): string {
return "'$type'";
}, self::SUPPORTED_PLATFORMS ) );
$this->addOption(
'json',
'Path to the json file. Default: tables.json',
false,
true
);
$this->addOption(
'sql',
'Path to output. If --type=all is given, ' .
'the output will be placed in a directory named after the dbms. ' .
'For mysql, a directory will only be used if it already exists. Default: tables-generated.sql',
false,
true
);
$this->addOption(
'type',
"Can be either $types, or 'all'. Default: mysql",
false,
true
);
$this->addOption(
'validate',
'Validate the schema instead of generating sql files.'
);
}
public function canExecuteWithoutLocalSettings(): bool {
return true;
}
public function execute() {
$platform = $this->getOption( 'type', 'mysql' );
$jsonPath = $this->getOption( 'json', '../../sql' );
if ( $this->hasOption( 'validate' ) ) {
try {
( new SchemaGenerator() )->validateAndGetSchema( $jsonPath );
} catch ( AbstractSchemaValidationError $e ) {
$this->fatalError( $e->getMessage() );
}
$this->output( "Schema is valid.\n" );
return;
}
// Allow to specify a folder and use a default name
if ( is_dir( $jsonPath ) ) {
$jsonPath .= '/tables.json';
}
if ( in_array( $platform, self::SUPPORTED_PLATFORMS, true ) ) {
$platforms = [ $platform ];
} elseif ( $platform === 'all' ) {
$platforms = self::SUPPORTED_PLATFORMS;
} else {
$this->fatalError( "'$platform' is not a supported platform!" );
}
foreach ( $platforms as $platform ) {
$sqlPath = $this->getOption( 'sql', dirname( $jsonPath ) );
// MediaWiki, and some extensions place mysql .sql files in the directory root, instead of a dedicated
// sub directory. If mysql/ doesn't exist, assume that the .sql files should be in the directory root.
if (
$platform === 'mysql' &&
!is_dir( $sqlPath . '/mysql' ) &&
!( count( $platforms ) > 1 && is_dir( dirname( $sqlPath ) . '/' . $platform ) )
) {
// Allow to specify a folder and build the name from the json filename
if ( is_dir( $sqlPath ) ) {
$sqlPath = $this->getSqlPathWithFileName( $jsonPath, $sqlPath );
}
} else {
// Allow to specify a folder and build the name from the json filename
if ( is_dir( $sqlPath ) ) {
$sqlPath .= '/' . $platform;
$directory = $sqlPath;
$sqlPath = $this->getSqlPathWithFileName( $jsonPath, $sqlPath );
} elseif ( count( $platforms ) > 1 ) {
$directory = dirname( $sqlPath ) . '/' . $platform;
$sqlPath = $directory . '/' . pathinfo( $sqlPath, PATHINFO_FILENAME ) . '.sql';
} else {
$directory = false;
}
// The directory for the platform might not exist.
if ( $directory !== false && !is_dir( $directory )
&& !mkdir( $directory ) && !is_dir( $directory )
) {
$this->error( "Cannot create $directory for $platform" );
continue;
}
}
$this->writeSchema( $platform, $jsonPath, $sqlPath );
}
}
/**
* Determine the name of the generated SQL file when only a directory has been provided to --sql.
* When --json is given tables.json, tables-generates.sql will be the name, otherwise it will be the name of the
* .json file, minus the extension.
*
* @param string $relativeJsonPath
* @param string $sqlPath
* @return string
*/
private function getSqlPathWithFileName( string $relativeJsonPath, string $sqlPath ): string {
$jsonFilename = pathinfo( $relativeJsonPath, PATHINFO_FILENAME );
if ( str_starts_with( $jsonFilename, 'tables' ) ) {
$sqlFileName = $jsonFilename . '-generated.sql';
} else {
$sqlFileName = $jsonFilename . '.sql';
}
return $sqlPath . '/' . $sqlFileName;
}
private function writeSchema(
string $platform,
string $jsonPath,
string $sqlPath
): void {
try {
$sql = $this->generateSchema( $platform, $jsonPath );
} catch ( AbstractSchemaValidationError $e ) {
$this->fatalError( $e->getMessage() );
}
// 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" );
}
/**
* @throws AbstractSchemaValidationError
*/
abstract protected function generateSchema( string $platform, string $jsonPath ): string;
}
/** @deprecated class alias since 1.43 */
class_alias( SchemaMaintenance::class, 'SchemaMaintenance' );

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 17:34 (3 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b8/66/d6bc43b98d84c74a98e6fb8ca2de
Default Alt Text
SchemaMaintenance.php (5 KB)

Event Timeline