3 * Default wiring for MediaWiki services.
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.
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.
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
22 * This file is loaded by MediaWiki\MediaWikiServices::getInstance() during the
23 * bootstrapping of the dependency injection framework.
25 * This file returns an array that associates service name with instantiator functions
26 * that create the default instances for the services used by MediaWiki core.
27 * For every service that MediaWiki core requires, an instantiator must be defined in
30 * @note As of version 1.27, MediaWiki is only beginning to use dependency injection.
31 * The services defined here do not yet fully represent all services used by core,
32 * much of the code still relies on global state for this accessing services.
36 * @see docs/injection.txt for an overview of using dependency injection in the
37 * MediaWiki code base.
40 use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface
;
41 use MediaWiki\Auth\AuthManager
;
42 use MediaWiki\Config\ConfigRepository
;
43 use MediaWiki\Interwiki\ClassicInterwikiLookup
;
44 use MediaWiki\Interwiki\InterwikiLookup
;
45 use MediaWiki\Linker\LinkRenderer
;
46 use MediaWiki\Linker\LinkRendererFactory
;
47 use MediaWiki\Logger\LoggerFactory
;
48 use MediaWiki\MediaWikiServices
;
49 use MediaWiki\Preferences\PreferencesFactory
;
50 use MediaWiki\Preferences\DefaultPreferencesFactory
;
51 use MediaWiki\Shell\CommandFactory
;
52 use MediaWiki\Special\SpecialPageFactory
;
53 use MediaWiki\Storage\BlobStore
;
54 use MediaWiki\Storage\BlobStoreFactory
;
55 use MediaWiki\Storage\NameTableStore
;
56 use MediaWiki\Storage\RevisionFactory
;
57 use MediaWiki\Storage\RevisionLookup
;
58 use MediaWiki\Storage\RevisionStore
;
59 use MediaWiki\Storage\RevisionStoreFactory
;
60 use MediaWiki\Storage\SqlBlobStore
;
63 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
64 return new ActorMigration(
65 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
69 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
70 return $services->getService( '_SqlBlobStore' );
73 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
74 return new BlobStoreFactory(
75 $services->getDBLoadBalancerFactory(),
76 $services->getMainWANObjectCache(),
77 $services->getMainConfig(),
78 $services->getContentLanguage()
82 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
83 return new NameTableStore(
84 $services->getDBLoadBalancer(),
85 $services->getMainWANObjectCache(),
86 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
92 function ( $insertFields ) {
93 $insertFields['ctd_user_defined'] = 0;
94 $insertFields['ctd_count'] = 0;
100 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
101 return new CommentStore(
102 $services->getContentLanguage(),
103 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
107 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
108 // Use the bootstrap config to initialize the ConfigFactory.
109 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
110 $factory = new ConfigFactory();
112 foreach ( $registry as $name => $callback ) {
113 $factory->register( $name, $callback );
118 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
119 return new ConfigRepository( $services->getConfigFactory() );
122 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
123 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
126 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
127 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
130 'ContentModelStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
131 return new NameTableStore(
132 $services->getDBLoadBalancer(),
133 $services->getMainWANObjectCache(),
134 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
139 * No strtolower normalization is added to the service as there are examples of
140 * extensions that do not stick to this assumption.
141 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
142 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
147 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
148 $config = $services->getMainConfig();
150 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
152 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
155 // In HKDF, the context can be known to the attacker, but this will
156 // keep simultaneous runs from producing the same output.
157 $context = [ microtime(), getmypid(), gethostname() ];
159 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
160 $cache = $services->getLocalServerObjectCache();
161 if ( $cache instanceof EmptyBagOStuff
) {
162 $cache = ObjectCache
::getLocalClusterInstance();
165 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
168 'CryptRand' => function () : CryptRand
{
169 return new CryptRand();
172 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
173 // just return the default LB from the DBLoadBalancerFactory service
174 return $services->getDBLoadBalancerFactory()->getMainLB();
177 'DBLoadBalancerFactory' =>
178 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
179 $mainConfig = $services->getMainConfig();
181 $lbConf = MWLBFactory
::applyDefaultConfig(
182 $mainConfig->get( 'LBFactoryConf' ),
184 $services->getConfiguredReadOnlyMode()
186 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
188 $instance = new $class( $lbConf );
189 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
194 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
195 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
198 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
199 $config = $services->getMainConfig();
201 return new ExternalStoreFactory(
202 $config->get( 'ExternalStores' )
206 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
207 return new GenderCache();
210 'HttpRequestFactory' =>
211 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
212 return new \MediaWiki\Http\
HttpRequestFactory();
215 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
216 $config = $services->getMainConfig();
217 return new ClassicInterwikiLookup(
218 $services->getContentLanguage(),
219 $services->getMainWANObjectCache(),
220 $config->get( 'InterwikiExpiry' ),
221 $config->get( 'InterwikiCache' ),
222 $config->get( 'InterwikiScopes' ),
223 $config->get( 'InterwikiFallbackSite' )
227 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
228 return new LinkCache(
229 $services->getTitleFormatter(),
230 $services->getMainWANObjectCache()
234 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
237 if ( defined( 'MW_NO_SESSION' ) ) {
238 return $services->getLinkRendererFactory()->create();
240 return $services->getLinkRendererFactory()->createForUser( $wgUser );
244 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
245 return new LinkRendererFactory(
246 $services->getTitleFormatter(),
247 $services->getLinkCache()
251 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
252 $cacheId = \ObjectCache
::detectLocalServerCache();
253 return \ObjectCache
::newFromId( $cacheId );
256 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
257 return new MagicWordFactory( $services->getContentLanguage() );
260 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
261 // Use the 'main' config from the ConfigFactory service.
262 return $services->getConfigFactory()->makeConfig( 'main' );
265 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
266 $mainConfig = $services->getMainConfig();
268 $id = $mainConfig->get( 'MainStash' );
269 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
270 throw new UnexpectedValueException(
271 "Cache type \"$id\" is not present in \$wgObjectCaches." );
274 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
277 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
278 $mainConfig = $services->getMainConfig();
280 $id = $mainConfig->get( 'MainWANCache' );
281 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
282 throw new UnexpectedValueException(
283 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
286 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
287 $objectCacheId = $params['cacheId'];
288 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
289 throw new UnexpectedValueException(
290 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
292 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
294 return \ObjectCache
::newWANCacheFromParams( $params );
297 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
298 return new MediaHandlerFactory(
299 $services->getMainConfig()->get( 'MediaHandlers' )
303 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
304 $logger = LoggerFactory
::getInstance( 'Mime' );
305 $mainConfig = $services->getMainConfig();
307 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
308 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
309 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
311 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
313 $deja = new DjVuImage( $file );
314 if ( $deja->isValid() ) {
315 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
316 $mime = 'image/vnd.djvu';
320 // Some strings by reference for performance - assuming well-behaved hooks
322 'MimeMagicGuessFromContent',
323 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
326 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
327 // Media handling extensions can improve the MIME detected
328 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
330 'initCallback' => function ( $mimeAnalyzer ) {
331 // Allow media handling extensions adding MIME-types and MIME-info
332 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
337 if ( $params['infoFile'] === 'includes/mime.info' ) {
338 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
341 if ( $params['typeFile'] === 'includes/mime.types' ) {
342 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
345 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
346 if ( $detectorCmd ) {
347 $factory = $services->getShellCommandFactory();
348 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
349 $result = $factory->create()
350 // $wgMimeDetectorCommand can contain commands with parameters
351 ->unsafeParams( $detectorCmd )
354 return $result->getStdout();
358 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
359 return new MimeMagic( $params );
362 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
363 return new ImportableOldRevisionImporter(
365 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
366 $services->getDBLoadBalancer()
370 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
371 return $services->getParserFactory()->create();
374 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
375 $config = $services->getMainConfig();
376 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
377 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
379 return new ParserCache(
381 $config->get( 'CacheEpoch' )
385 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
386 return new ParserFactory(
387 $services->getMainConfig()->get( 'ParserConf' ),
388 $services->getMagicWordFactory(),
389 $services->getContentLanguage(),
391 $services->getSpecialPageFactory()
395 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
396 $config = $services->getMainConfig();
397 return new PasswordFactory(
398 $config->get( 'PasswordConfig' ),
399 $config->get( 'PasswordDefault' )
403 'PerDbNameStatsdDataFactory' =>
404 function ( MediaWikiServices
$services ) : StatsdDataFactoryInterface
{
405 $config = $services->getMainConfig();
406 $wiki = $config->get( 'DBname' );
407 return new PrefixingStatsdDataFactoryProxy(
408 $services->getStatsdDataFactory(),
413 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
414 $factory = new DefaultPreferencesFactory(
415 $services->getMainConfig(),
416 $services->getContentLanguage(),
417 AuthManager
::singleton(),
418 $services->getLinkRendererFactory()->create()
420 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
425 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
426 $mainConfig = $services->getMainConfig();
427 return new ProxyLookup(
428 $mainConfig->get( 'SquidServers' ),
429 $mainConfig->get( 'SquidServersNoPurge' )
433 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
434 return new ReadOnlyMode(
435 $services->getConfiguredReadOnlyMode(),
436 $services->getDBLoadBalancer()
440 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
441 return $services->getRevisionStore();
444 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
445 return $services->getRevisionStore();
448 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
449 return $services->getRevisionStoreFactory()->getRevisionStore();
452 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
453 $config = $services->getMainConfig();
454 $store = new RevisionStoreFactory(
455 $services->getDBLoadBalancerFactory(),
456 $services->getBlobStoreFactory(),
457 $services->getMainWANObjectCache(),
458 $services->getCommentStore(),
459 $services->getActorMigration(),
460 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
461 LoggerFactory
::getProvider(),
462 $config->get( 'ContentHandlerUseDB' )
468 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
469 return new SearchEngineConfig( $services->getMainConfig(),
470 $services->getContentLanguage() );
473 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
474 return new SearchEngineFactory( $services->getSearchEngineConfig() );
477 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
478 $config = $services->getMainConfig();
481 'time' => $config->get( 'MaxShellTime' ),
482 'walltime' => $config->get( 'MaxShellWallClockTime' ),
483 'memory' => $config->get( 'MaxShellMemory' ),
484 'filesize' => $config->get( 'MaxShellFileSize' ),
486 $cgroup = $config->get( 'ShellCgroup' );
487 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
489 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
490 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
491 $factory->logStderr();
496 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
497 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
499 if ( $cacheFile !== false ) {
500 return new FileBasedSiteLookup( $cacheFile );
502 // Use the default SiteStore as the SiteLookup implementation for now
503 return $services->getSiteStore();
507 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
508 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
510 // TODO: replace wfGetCache with a CacheFactory service.
511 // TODO: replace wfIsHHVM with a capabilities service.
512 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
514 return new CachingSiteStore( $rawSiteStore, $cache );
517 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
518 $factory = new SkinFactory();
520 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
522 foreach ( $names as $name => $skin ) {
523 $factory->register( $name, $skin, function () use ( $name, $skin ) {
524 $class = "Skin$skin";
525 return new $class( $name );
528 // Register a hidden "fallback" skin
529 $factory->register( 'fallback', 'Fallback', function () {
530 return new SkinFallback
;
532 // Register a hidden skin for api output
533 $factory->register( 'apioutput', 'ApiOutput', function () {
540 'SlotRoleStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
541 return new NameTableStore(
542 $services->getDBLoadBalancer(),
543 $services->getMainWANObjectCache(),
544 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
552 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
553 return new SpecialPageFactory(
554 $services->getMainConfig(),
555 $services->getContentLanguage()
559 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
560 return new BufferingStatsdDataFactory(
561 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
565 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
566 return $services->getService( '_MediaWikiTitleCodec' );
569 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
570 return $services->getService( '_MediaWikiTitleCodec' );
573 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
574 return new ImportableUploadRevisionImporter(
575 $services->getMainConfig()->get( 'EnableUploads' ),
576 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
580 'VirtualRESTServiceClient' =>
581 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
582 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
584 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
585 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
586 $class = $serviceConfig['class'];
587 // Merge in the global defaults
588 $constructArg = $serviceConfig['options'] ??
[];
589 $constructArg +
= $config['global'];
590 // Make the VRS service available at the mount point
591 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
597 'WatchedItemQueryService' =>
598 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
599 return new WatchedItemQueryService(
600 $services->getDBLoadBalancer(),
601 $services->getCommentStore(),
602 $services->getActorMigration()
606 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
607 $store = new WatchedItemStore(
608 $services->getDBLoadBalancer(),
609 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
610 $services->getReadOnlyMode(),
611 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
613 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
615 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
616 $store = new NoWriteWatchedItemStore( $store );
622 'WikiRevisionOldRevisionImporterNoUpdates' =>
623 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
624 return new ImportableOldRevisionImporter(
626 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
627 $services->getDBLoadBalancer()
631 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
632 return new MediaWikiTitleCodec(
633 $services->getContentLanguage(),
634 $services->getGenderCache(),
635 $services->getMainConfig()->get( 'LocalInterwikis' ),
636 $services->getInterwikiLookup()
640 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
641 return $services->getBlobStoreFactory()->newSqlBlobStore();
644 ///////////////////////////////////////////////////////////////////////////
645 // NOTE: When adding a service here, don't forget to add a getter function
646 // in the MediaWikiServices class. The convenience getter should just call
647 // $this->getService( 'FooBarService' ).
648 ///////////////////////////////////////////////////////////////////////////