32e9266d8d
This introduces traits for testing different schema variations. These are not very useful in this patch, but make it much easier to add tests for MCR schema migration in subsequent patches. The code in this patch was previously part of If259b1e1c49ceaa4. Change-Id: I239572f75bebbc9c731a3e3860c4eff179dc15e4
90 lines
2.7 KiB
PHP
90 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* Trait for finding SQL patch files.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
namespace MediaWiki\DB;
|
|
|
|
use RuntimeException;
|
|
use Wikimedia\Rdbms\IDatabase;
|
|
|
|
/**
|
|
* Trait for finding SQL patch files.
|
|
*
|
|
* @since 1.32
|
|
*/
|
|
trait PatchFileLocation {
|
|
|
|
/**
|
|
* Utility function for finding the appropriate SQL patch file for the currently
|
|
* used database type.
|
|
*
|
|
* The file will be searched for in the following locations, in order of preference:
|
|
* "$patchDir/$name.$dbType.sql",
|
|
* "$patchDir/$dbType/$name.sql",
|
|
* "$patchDir/$dbType/archives/$name.sql",
|
|
* "$patchDir/$name.sql",
|
|
* "$patchDir/archives/$name.sql"
|
|
*
|
|
* @param IDatabase $db
|
|
* @param string $name The script name (relative to $patchDir, without the '.sql' suffix)
|
|
* @param string $patchDir The directory to find the script in. Use __DIR__ to search in the
|
|
* directory the calling code is located in. If omitted, the "maintenance"
|
|
* directory will be used, where the scripts used by the updater are located.
|
|
*
|
|
* @return string
|
|
* @throws RuntimeException if no matching patch file could be found.
|
|
*/
|
|
protected function getSqlPatchPath( IDatabase $db, $name, $patchDir = null ) {
|
|
$dbType = $db->getType();
|
|
|
|
if ( $patchDir === null ) {
|
|
$patchDir = $GLOBALS['IP'] . '/maintenance';
|
|
}
|
|
|
|
$paths = [
|
|
|
|
// For a small number of patch files, closely associated with code,
|
|
// e.g. for unit tests:
|
|
"$patchDir/$name.$dbType.sql",
|
|
|
|
// For a large number of patch files, e.g. for schema updates of extensions:
|
|
"$patchDir/$dbType/$name.sql",
|
|
|
|
// For MediaWiki core schema update patches:
|
|
"$patchDir/$dbType/archives/$name.sql",
|
|
|
|
// Database-agnostic fallback:
|
|
"$patchDir/$name.sql",
|
|
|
|
// Database-agnostic fallback for MediaWiki core schema update patches:
|
|
"$patchDir/archives/$name.sql"
|
|
];
|
|
|
|
foreach ( $paths as $p ) {
|
|
if ( file_exists( $p ) ) {
|
|
return $p;
|
|
}
|
|
}
|
|
|
|
throw new RuntimeException( "No SQL script matching $name could be found in $patchDir" );
|
|
}
|
|
|
|
}
|