7use Psr\Log\LoggerInterface;
12use Wikimedia\TestingAccessWrapper;
19 use MediaWikiCoversValidator;
20 use PHPUnit4And6Compat;
124 parent::__construct(
$name, $data, $dataName );
126 $this->backupGlobals =
false;
127 $this->backupStaticAttributes =
false;
133 if ( isset( $this->called[
'setUp'] ) && !isset( $this->called[
'tearDown'] ) ) {
134 throw new MWException( static::class .
"::tearDown() must call parent::tearDown()" );
139 parent::setUpBeforeClass();
142 self::$serviceLocator = self::prepareServices(
new GlobalVarConfig() );
154 return TestUserRegistry::getImmutableTestUser( $groups );
166 return TestUserRegistry::getMutableTestUser( __CLASS__, $groups );
178 return self::getTestUser( [
'sysop',
'bureaucrat' ] );
204 $services = self::resetGlobalServices( $bootstrapConfig );
224 $oldServices = MediaWikiServices::getInstance();
225 $oldConfigFactory = $oldServices->getConfigFactory();
226 $oldLoadBalancerFactory = $oldServices->getDBLoadBalancerFactory();
228 $testConfig = self::makeTestConfig( $bootstrapConfig );
230 MediaWikiServices::resetGlobalInstance( $testConfig );
233 self::installTestServices(
235 $oldLoadBalancerFactory,
251 Config $baseConfig =
null,
252 Config $customOverrides =
null
256 if ( !$baseConfig ) {
257 $baseConfig = MediaWikiServices::getInstance()->getBootstrapConfig();
264 $hashCache = [
'class' => HashBagOStuff::class,
'reportDupes' =>
false ];
270 'apcu' => $hashCache,
271 'wincache' => $hashCache,
272 ] + $baseConfig->get(
'ObjectCaches' );
274 $defaultOverrides->set(
'ObjectCaches', $objectCaches );
275 $defaultOverrides->set(
'MainCacheType',
CACHE_NONE );
276 $defaultOverrides->set(
'JobTypeConf', [
'default' => [
'class' => JobQueueMemory::class ] ] );
279 $defaultOverrides->set(
'PasswordDefault',
'A' );
281 $testConfig = $customOverrides
282 ?
new MultiConfig( [ $customOverrides, $defaultOverrides, $baseConfig ] )
283 :
new MultiConfig( [ $defaultOverrides, $baseConfig ] );
306 self::makeTestConfigFactoryInstantiator(
308 [
'main' => $bootstrapConfig ]
313 'DBLoadBalancerFactory',
315 return $oldLoadBalancerFactory;
328 array $configurations
334 $namesToClone = array_diff(
336 array_keys( $configurations )
339 foreach ( $namesToClone
as $name ) {
343 foreach ( $configurations
as $name => $config ) {
344 $factory->register(
$name, $config );
366 ObjectCache::clear();
367 $services = MediaWikiServices::getInstance();
368 $services->resetServiceForTesting(
'MainObjectStash' );
369 $services->resetServiceForTesting(
'LocalServerObjectCache' );
370 $services->getMainWANObjectCache()->clearProcessCache();
375 if ( session_id() !==
'' ) {
376 session_write_close();
381 MediaWiki\Session\SessionManager::resetCache();
384 public function run( PHPUnit_Framework_TestResult
$result =
null ) {
388 $needsResetDB =
false;
390 if ( !self::$dbSetup || $this->
needsDB() ) {
393 self::$useTemporaryTables = !$this->
getCliArg(
'use-normal-tables' );
394 self::$reuseDB = $this->
getCliArg(
'reuse-db' );
400 if ( !self::$dbSetup ) {
404 if ( ( $this->db->getType() ==
'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
405 $this->
resetDB( $this->db, $this->tablesUsed );
418 $needsResetDB =
true;
423 if ( $needsResetDB ) {
424 $this->
resetDB( $this->db, $this->tablesUsed );
435 $class = static::class;
437 $first = !isset( $this->db->_hasDataForTestClass )
438 || $this->db->_hasDataForTestClass !== $class;
440 $this->db->_hasDataForTestClass = $class;
450 return self::$useTemporaryTables;
463 $fileName = tempnam(
wfTempDir(),
'MW_PHPUnit_' . static::class .
'_' );
464 $this->tmpFiles[] = $fileName;
494 $this->called[
'setUp'] =
true;
496 $this->phpErrorLevel = intval( ini_get(
'error_reporting' ) );
499 foreach ( $this->tmpFiles
as $fileName ) {
500 if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
502 } elseif ( is_dir( $fileName ) ) {
507 if ( $this->
needsDB() && $this->db ) {
509 while ( $this->db->trxLevel() > 0 ) {
510 $this->db->rollback( __METHOD__,
'flush' );
513 if ( $this->db->getType() ===
'mysql' ) {
514 $this->db->query(
"SET sql_mode = 'STRICT_ALL_TABLES'" );
518 DeferredUpdates::clearPendingUpdates();
519 ObjectCache::getMainWANInstance()->clearProcessCache();
523 $services = MediaWikiServices::getInstance();
524 $lbFactory =
$services->getDBLoadBalancerFactory();
527 ob_start(
'MediaWikiTestCase::wfResetOutputBuffersBarrier' );
531 $this->tmpFiles = array_merge( $this->tmpFiles, (
array)$files );
538 if ( isset(
$status[
'name'] ) &&
539 $status[
'name'] ===
'MediaWikiTestCase::wfResetOutputBuffersBarrier'
544 $this->called[
'tearDown'] =
true;
546 foreach ( $this->tmpFiles
as $fileName ) {
547 if ( is_file( $fileName ) || ( is_link( $fileName ) ) ) {
549 } elseif ( is_dir( $fileName ) ) {
554 if ( $this->
needsDB() && $this->db ) {
556 while ( $this->db->trxLevel() > 0 ) {
557 $this->db->rollback( __METHOD__,
'flush' );
559 if ( $this->db->getType() ===
'mysql' ) {
560 $this->db->query(
"SET sql_mode = " . $this->db->addQuotes(
$wgSQLMode ) );
565 foreach ( $this->mwGlobals
as $key =>
$value ) {
568 foreach ( $this->mwGlobalsToUnset
as $value ) {
571 $this->mwGlobals = [];
572 $this->mwGlobalsToUnset = [];
575 if ( self::$serviceLocator && MediaWikiServices::getInstance() !== self::$serviceLocator ) {
576 MediaWikiServices::forceGlobalInstance( self::$serviceLocator );
581 if ( session_id() !==
'' ) {
582 session_write_close();
586 MediaWiki\Session\SessionManager::resetCache();
587 MediaWiki\Auth\AuthManager::resetCache();
592 ini_set(
'error_reporting', $this->phpErrorLevel );
594 $oldHex = strtoupper( dechex( $this->phpErrorLevel ) );
596 $message =
"PHP error_reporting setting was left dirty: "
597 .
"was 0x$oldHex before test, 0x$newHex after test!";
599 $this->fail( $message );
614 $this->assertArrayHasKey(
'setUp', $this->called,
615 static::class .
'::setUp() must call parent::setUp()'
630 if ( MediaWikiServices::getInstance() === self::$serviceLocator ) {
634 MediaWikiServices::getInstance()->disableService(
$name );
635 MediaWikiServices::getInstance()->redefineService(
637 function ()
use ( $object ) {
679 if ( is_string( $pairs ) ) {
680 $pairs = [ $pairs =>
$value ];
685 foreach ( $pairs
as $key =>
$value ) {
702 if ( is_array(
$value ) ) {
704 if ( !is_scalar( $subValue ) && $subValue !==
null ) {
731 if ( is_string( $globalKeys ) ) {
732 $globalKeys = [ $globalKeys ];
735 foreach ( $globalKeys
as $globalKey ) {
740 !array_key_exists( $globalKey, $this->mwGlobals ) &&
741 !array_key_exists( $globalKey, $this->mwGlobalsToUnset )
743 if ( !array_key_exists( $globalKey,
$GLOBALS ) ) {
744 $this->mwGlobalsToUnset[$globalKey] = $globalKey;
750 if ( self::canShallowCopy(
$GLOBALS[$globalKey] ) ) {
751 $this->mwGlobals[$globalKey] =
$GLOBALS[$globalKey];
759 $this->mwGlobals[$globalKey] = clone
$GLOBALS[$globalKey];
764 $this->mwGlobals[$globalKey] =
$GLOBALS[$globalKey];
768 }
catch ( Exception
$e ) {
769 $this->mwGlobals[$globalKey] =
$GLOBALS[$globalKey];
783 if ( $var instanceof Closure ) {
786 if ( !is_array( $var ) || $maxDepth === 0 ) {
818 throw new MWException(
"MW global $name is not an array." );
823 foreach ( $values
as $k => $v ) {
846 if ( !$configOverrides ) {
850 $oldInstance = MediaWikiServices::getInstance();
851 $oldConfigFactory = $oldInstance->getConfigFactory();
852 $oldLoadBalancerFactory = $oldInstance->getDBLoadBalancerFactory();
854 $testConfig = self::makeTestConfig(
null, $configOverrides );
859 $wiringFiles = $testConfig->get(
'ServiceWiringFiles' );
860 $newInstance->loadWiringFiles( $wiringFiles );
863 Hooks::run(
'MediaWikiServices', [ $newInstance ] );
866 $newInstance->redefineService(
$name, $callback );
869 self::installTestServices(
871 $oldLoadBalancerFactory,
874 MediaWikiServices::forceGlobalInstance( $newInstance );
894 $langCode =
$lang->getCode();
898 $langObj = Language::factory( $langCode );
901 'wgLanguageCode' => $langCode,
902 'wgContLang' => $langObj,
925 if ( is_string( $newPerms ) ) {
926 $newPerms = [ $newPerms => [ $newKey => $newValue ] ];
929 foreach ( $newPerms
as $group => $permissions ) {
930 foreach ( $permissions
as $key =>
$value ) {
942 protected function setLogger( $channel, LoggerInterface $logger ) {
946 $provider = LoggerFactory::getProvider();
947 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
948 $singletons = $wrappedProvider->singletons;
950 if ( !isset( $this->loggers[$channel] ) ) {
951 $this->loggers[$channel] = isset( $singletons[
'loggers'][$channel] )
952 ? $singletons[
'loggers'][$channel] :
null;
954 $singletons[
'loggers'][$channel] = $logger;
955 } elseif ( $provider instanceof
LegacySpi ) {
956 if ( !isset( $this->loggers[$channel] ) ) {
957 $this->loggers[$channel] = isset( $singletons[$channel] ) ? $singletons[$channel] :
null;
959 $singletons[$channel] = $logger;
961 throw new LogicException( __METHOD__ .
': setting a logger for ' . get_class( $provider )
962 .
' is not implemented' );
964 $wrappedProvider->singletons = $singletons;
972 $provider = LoggerFactory::getProvider();
973 $wrappedProvider = TestingAccessWrapper::newFromObject( $provider );
974 $singletons = $wrappedProvider->singletons;
975 foreach ( $this->loggers
as $channel => $logger ) {
977 if ( $logger ===
null ) {
978 unset( $singletons[
'loggers'][$channel] );
980 $singletons[
'loggers'][$channel] = $logger;
982 } elseif ( $provider instanceof
LegacySpi ) {
983 if ( $logger ===
null ) {
984 unset( $singletons[$channel] );
986 $singletons[$channel] = $logger;
990 $wrappedProvider->singletons = $singletons;
999 return $this->db->getType() ==
'oracle' ? self::ORA_DB_PREFIX : self::DB_PREFIX;
1008 if ( $this->tablesUsed ) {
1014 $rc =
new ReflectionClass( $this );
1015 if ( preg_match(
'/@group +Database/im', $rc->getDocComment() ) ) {
1035 $text =
'Sample page for unit test.',
1038 if ( is_string( $pageName ) ) {
1039 $title = Title::newFromText( $pageName, $namespace );
1044 $user = static::getTestSysop()->getUser();
1045 $comment = __METHOD__ .
': Sample page for unit test.';
1047 $page = WikiPage::factory(
$title );
1048 $page->doEditContent( ContentHandler::makeContent( $text,
$title ), $comment, 0,
false,
$user );
1052 'id' => $page->getId(),
1087 if ( $this->db->getType() ==
'oracle' ) {
1088 # Insert 0 user to prevent FK violations
1090 if ( !$this->db->selectField(
'user',
'1', [
'user_id' => 0 ] ) ) {
1091 $this->db->insert(
'user', [
1093 'user_name' =>
'Anonymous' ], __METHOD__, [
'IGNORE' ] );
1096 # Insert 0 page to prevent FK violations
1098 if ( !$this->db->selectField(
'page',
'1', [
'page_id' => 0 ] ) ) {
1099 $this->db->insert(
'page', [
1101 'page_namespace' => 0,
1102 'page_title' =>
' ',
1103 'page_restrictions' =>
null,
1104 'page_is_redirect' => 0,
1107 'page_touched' => $this->db->timestamp(),
1109 'page_len' => 0 ], __METHOD__, [
'IGNORE' ] );
1118 $user = static::getTestSysop()->getUser();
1121 $page = WikiPage::factory( Title::newFromText(
'UTPage' ) );
1122 if ( $page->getId() == 0 ) {
1123 $page->doEditContent(
1138 if ( session_id() !==
'' ) {
1139 session_write_close();
1155 if ( !self::$dbSetup ) {
1159 Hooks::run(
'UnitTestsBeforeDatabaseTeardown' );
1168 self::$oldTablePrefix =
false;
1169 self::$dbSetup =
false;
1186 $tablesCloned = self::listTables( $db );
1187 $dbClone =
new CloneDatabase( $db, $tablesCloned, $prefix );
1188 $dbClone->useTemporaryTables( self::$useTemporaryTables );
1192 if ( ( $db->
getType() ==
'oracle' || !self::$useTemporaryTables ) && self::$reuseDB ) {
1197 $dbClone->cloneTableStructure();
1213 self::setupTestDB( $this->db, $testPrefix );
1215 if ( self::isUsingExternalStoreDB() ) {
1216 self::setupExternalStoreTestDBs( $testPrefix );
1242 if ( self::$dbSetup ) {
1248 'Cannot run unit tests, the database prefix is already "' . $prefix .
'"' );
1254 self::$dbSetup =
true;
1256 if ( !self::setupDatabaseWithTestPrefix( $db, $prefix ) ) {
1262 if ( $db->
getType() ==
'oracle' ) {
1263 $db->
query(
'BEGIN FILL_WIKI_INFO; END;' );
1266 Hooks::run(
'UnitTestsAfterDatabaseSetup', [ $db, $prefix ] );
1275 $connections = self::getExternalStoreDatabaseConnections();
1276 foreach ( $connections
as $dbw ) {
1284 $dbw->tablePrefix( self::$oldTablePrefix );
1285 self::setupDatabaseWithTestPrefix( $dbw, $testPrefix );
1299 $externalStoreDB = ExternalStore::getStoreObject(
'DB' );
1302 foreach ( $defaultArray
as $url ) {
1303 if ( strpos( $url,
'DB://' ) === 0 ) {
1304 list( $proto, $cluster ) = explode(
'://', $url, 2 );
1307 $dbws[] = $externalStoreDB->getMaster( $cluster );
1326 foreach ( $defaultArray
as $url ) {
1327 if ( strpos( $url,
'DB://' ) === 0 ) {
1341 throw new LogicException(
1342 'Trying to delete mock tables, but table prefix does not indicate a mock database.'
1382 $oldOverrides = $oldOverrides + self::$schemaOverrideDefaults;
1386 $tablesToDrop = array_merge( $oldOverrides[
'create'], $oldOverrides[
'alter'] );
1390 $tablesToRestore = array_merge( $tablesToDrop, $oldOverrides[
'drop'] );
1391 $tablesToRestore = array_intersect( $originalTables, $tablesToRestore );
1393 if ( $tablesToDrop ) {
1397 if ( $tablesToRestore ) {
1409 $oldOverrides = isset( $db->_schemaOverrides ) ? $db->_schemaOverrides
1410 : self::$schemaOverrideDefaults;
1412 if ( $oldOverrides[
'alter'] || $oldOverrides[
'create'] || $oldOverrides[
'drop'] ) {
1419 $extraKeys = array_diff(
1420 array_keys( $overrides ),
1421 array_keys( self::$schemaOverrideDefaults )
1425 throw new InvalidArgumentException(
1426 'Schema override contains extra keys: ' . var_export( $extraKeys,
true )
1430 if ( !$overrides[
'scripts'] ) {
1435 if ( !$overrides[
'create'] && !$overrides[
'drop'] && !$overrides[
'alter'] ) {
1436 throw new InvalidArgumentException(
1437 'Schema override scripts given, but no tables are declared to be '
1438 .
'created, dropped or altered.'
1446 $tablesToDrop = array_intersect( $originalTables, $overrides[
'create'] );
1448 if ( $tablesToDrop ) {
1453 foreach ( $overrides[
'scripts']
as $script ) {
1465 $db->_schemaOverrides = $overrides;
1469 return self::$useTemporaryTables
1470 ? preg_replace(
'/\bCREATE\s+TABLE\b/i',
'CREATE TEMPORARY TABLE', $cmd )
1485 $db->
query(
"DROP TABLE IF EXISTS $tbl", __METHOD__ );
1487 if ( $tbl ===
'page' ) {
1490 LinkCache::singleton()->clear();
1502 if ( !isset( $db->_originalTablePrefix ) ) {
1503 throw new LogicException(
'No original table prefix know, cannot list tables!' );
1506 $originalTables = $db->
listTables( $db->_originalTablePrefix, __METHOD__ );
1507 return $originalTables;
1521 if ( !isset( $db->_originalTablePrefix ) ) {
1522 throw new LogicException(
'No original table prefix know, cannot restore tables!' );
1529 $dbClone->useTemporaryTables( self::$useTemporaryTables );
1531 $dbClone->cloneTableStructure();
1542 $userTables = [
'user',
'user_groups',
'user_properties',
'actor' ];
1543 $pageTables = [
'page',
'revision',
'ip_changes',
'revision_comment_temp',
1544 'revision_actor_temp',
'comment' ];
1545 $coreDBDataTables = array_merge( $userTables, $pageTables );
1548 if ( array_intersect(
$tablesUsed, $userTables ) ) {
1550 TestUserRegistry::clear();
1552 if ( array_intersect(
$tablesUsed, $pageTables ) ) {
1556 $truncate = in_array(
$db->
getType(), [
'oracle',
'mysql' ] );
1559 if ( $tbl ==
'interwiki' ) {
1573 if ( in_array(
$db->
getType(), [
'postgres',
'sqlite' ],
true ) ) {
1575 $db->resetSequenceForTable( $tbl, __METHOD__ );
1578 if ( $tbl ===
'page' ) {
1581 LinkCache::singleton()->clear();
1585 if ( array_intersect(
$tablesUsed, $coreDBDataTables ) ) {
1593 $tableName = substr( $tableName, strlen( $prefix ) );
1597 return strpos( $table, self::DB_PREFIX ) !== 0;
1611 if ( $db->
getType() ===
'mysql' ) {
1612 static $viewListCache =
null;
1613 if ( $viewListCache ===
null ) {
1614 $viewListCache = $db->
listViews(
null, __METHOD__ );
1619 array_walk(
$tables, [ __CLASS__,
'unprefixTable' ], $prefix );
1622 $tables = array_filter(
$tables, [ __CLASS__,
'isNotUnittest' ] );
1624 if ( $db->
getType() ==
'sqlite' ) {
1627 unset(
$tables[
'searchindex_content'] );
1628 unset(
$tables[
'searchindex_segdir'] );
1629 unset(
$tables[
'searchindex_segments'] );
1641 if ( !in_array( $this->db->getType(), $this->supportedDBs ) ) {
1642 throw new MWException( $this->db->getType() .
" is not currently supported for unit testing." );
1676 Wikimedia\suppressWarnings();
1678 Wikimedia\restoreWarnings();
1705 throw new MWException(
'When testing database state, the test cases\'s needDB()' .
1706 ' method should return true. Use @group Database or $this->tablesUsed.' );
1716 $options + [
'ORDER BY' => $fields ],
1723 foreach ( $expectedRows
as $expected ) {
1724 $r =
$res->fetchRow();
1725 self::stripStringKeys( $r );
1728 $this->assertNotEmpty( $r,
"row #$i missing" );
1730 $this->assertEquals( $expected, $r,
"row #$i mismatches" );
1733 $r =
$res->fetchRow();
1734 self::stripStringKeys( $r );
1736 $this->assertFalse( $r,
"found extra row (after #$i)" );
1752 function ( $element ) {
1753 return [ $element ];
1772 $ordered =
false, $named =
false
1780 $expected = array_values( $expected );
1781 $actual = array_values( $actual );
1784 call_user_func_array(
1785 [ $this,
'assertEquals' ],
1786 array_merge( [ $expected, $actual ], array_slice( func_get_args(), 4 ) )
1803 $expected = str_replace(
'>',
">\n", $expected );
1804 $actual = str_replace(
'>',
">\n", $actual );
1806 $this->assertEquals( $expected, $actual, $msg );
1819 function ( $a, $b ) {
1835 if ( !is_array( $r ) ) {
1839 foreach ( $r
as $k => $v ) {
1840 if ( is_string( $k ) ) {
1860 if ( $actual ===
$value ) {
1861 $this->assertTrue(
true, $message );
1879 if ( class_exists(
$type ) || interface_exists(
$type ) ) {
1880 $this->assertInstanceOf(
$type, $actual, $message );
1882 $this->assertInternalType(
$type, $actual, $message );
1915 static $wikitextNS =
null;
1916 if ( $wikitextNS !==
null ) {
1927 MWNamespace::getContentNamespaces(),
1929 MWNamespace::getValidNamespaces()
1936 $talk = array_filter(
$namespaces,
function ( $ns ) {
1937 return MWNamespace::isTalk( $ns );
1958 throw new MWException(
"No namespace defaults to wikitext!" );
1970 # This check may also protect against code injection in
1971 # case of broken installations.
1972 Wikimedia\suppressWarnings();
1974 Wikimedia\restoreWarnings();
1976 if ( !$haveDiff3 ) {
1977 $this->markTestSkipped(
"Skip test, since diff3 is not configured" );
1990 $loaded = extension_loaded( $extName );
1992 $this->markTestSkipped(
"PHP extension '$extName' is not loaded, skipping." );
2030 $createIfMissing =
true,
2033 if ( $createIfMissing ) {
2034 if ( !file_exists( $fileName ) ) {
2035 file_put_contents( $fileName, $actualData );
2036 $this->markTestSkipped(
'Data file $fileName does not exist' );
2039 self::assertFileExists( $fileName );
2041 self::assertEquals( file_get_contents( $fileName ), $actualData, $msg );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
unserialize( $serialized)
$wgDBprefix
Table name prefix.
$wgSQLMode
SQL Mode - default is turning off all modes, including strict, if set.
array $wgDefaultExternalStore
The place to put new revisions, false to put them in the local text table.
$wgDiff3
Path to the GNU diff3 utility.
$wgGroupPermissions
Permission keys given to users in each group.
$wgJobClasses
Maps jobs to their handlers; extensions can add to this to provide custom jobs.
$wgNamespaceContentModels
Associative array mapping namespace IDs to the name of the content model pages in that namespace shou...
wfTempDir()
Tries to get the system directory for temporary files.
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
if(! $wgDBerrorLogTZ) $wgRequest
static changePrefix( $prefix)
Change the table prefix on all open DB connections/.
Factory class to create Config objects.
makeConfig( $name)
Create a given Config using the registered callback for $name.
WebRequest clone which takes values from a provided array.
static destroySingleton()
Destroy the singleton instance.
Accesses configuration settings from $GLOBALS.
A Config instance which stores all settings as a member variable.
static singleton( $domain=false)
static destroySingletons()
Destroy the singleton instances.
Internationalisation code.
static setLBFactoryTriggers(LBFactory $LBFactory, Config $config)
Provides a fallback sequence for Config objects.
static $additionalOptions
static resetMain()
Resets singleton returned by getMain().
static getMain()
Get the RequestContext object associated with the main request.
static doPlaceholderInit()
Insert a dummy row with all zeroes if no row is present.
Wraps the user object, so we can also retain full access to properties like password if we log in via...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static resetIdByNameCache()
Reset the cache used in idFromName().
Content object for wiki text pages.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
when a variable name is used in a it is silently declared as a new local masking the global
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const CONTENT_MODEL_WIKITEXT
the array() calling protocol came about after MediaWiki 1.4rc1.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
namespace and then decline to actually register it & $namespaces
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
namespace and then decline to actually register it file or subcat img or subcat $title
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Allows to change the fields on the form that will be generated $name
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
processing should stop and the error should be shown to the user * false
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
returning false will NOT prevent logging $e
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Interface for configuration instances.
Advanced database interface for IDatabase handles that include maintenance methods.
tableName( $name, $format='quoted')
Format a table name ready for use in constructing an SQL query.
listViews( $prefix=null, $fname=__METHOD__)
Lists all the VIEWs in the database.
listTables( $prefix=null, $fname=__METHOD__)
List all tables on the database.
sourceFile( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
Read and execute SQL commands from a file.
if(!isset( $args[0])) $lang