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\Revision\MainSlotRoleHandler
;
52 use MediaWiki\Revision\RevisionFactory
;
53 use MediaWiki\Revision\RevisionLookup
;
54 use MediaWiki\Revision\SlotRoleRegistry
;
55 use MediaWiki\Revision\RevisionRenderer
;
56 use MediaWiki\Revision\RevisionStore
;
57 use MediaWiki\Revision\RevisionStoreFactory
;
58 use MediaWiki\Shell\CommandFactory
;
59 use MediaWiki\Special\SpecialPageFactory
;
60 use MediaWiki\Storage\BlobStore
;
61 use MediaWiki\Storage\BlobStoreFactory
;
62 use MediaWiki\Storage\NameTableStoreFactory
;
63 use MediaWiki\Storage\SqlBlobStore
;
66 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
67 return new ActorMigration(
68 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
72 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
73 return $services->getService( '_SqlBlobStore' );
76 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
77 return new BlobStoreFactory(
78 $services->getDBLoadBalancerFactory(),
79 $services->getMainWANObjectCache(),
80 $services->getMainConfig(),
81 $services->getContentLanguage()
85 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
86 return new CommentStore(
87 $services->getContentLanguage(),
92 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
93 // Use the bootstrap config to initialize the ConfigFactory.
94 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
95 $factory = new ConfigFactory();
97 foreach ( $registry as $name => $callback ) {
98 $factory->register( $name, $callback );
103 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
104 return new ConfigRepository( $services->getConfigFactory() );
107 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
108 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
111 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
112 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
115 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
116 $config = $services->getMainConfig();
118 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
120 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
123 // In HKDF, the context can be known to the attacker, but this will
124 // keep simultaneous runs from producing the same output.
125 $context = [ microtime(), getmypid(), gethostname() ];
127 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
128 $cache = $services->getLocalServerObjectCache();
129 if ( $cache instanceof EmptyBagOStuff
) {
130 $cache = ObjectCache
::getLocalClusterInstance();
133 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
136 'CryptRand' => function () : CryptRand
{
137 return new CryptRand();
140 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
141 // just return the default LB from the DBLoadBalancerFactory service
142 return $services->getDBLoadBalancerFactory()->getMainLB();
145 'DBLoadBalancerFactory' =>
146 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
147 $mainConfig = $services->getMainConfig();
149 $lbConf = MWLBFactory
::applyDefaultConfig(
150 $mainConfig->get( 'LBFactoryConf' ),
152 $services->getConfiguredReadOnlyMode(),
153 $services->getLocalServerObjectCache(),
154 $services->getMainObjectStash(),
155 $services->getMainWANObjectCache()
157 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
159 $instance = new $class( $lbConf );
160 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
165 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
166 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
169 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
170 $config = $services->getMainConfig();
172 return new ExternalStoreFactory(
173 $config->get( 'ExternalStores' )
177 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
178 return new GenderCache();
181 'HttpRequestFactory' =>
182 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
183 return new \MediaWiki\Http\
HttpRequestFactory();
186 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
187 $config = $services->getMainConfig();
188 return new ClassicInterwikiLookup(
189 $services->getContentLanguage(),
190 $services->getMainWANObjectCache(),
191 $config->get( 'InterwikiExpiry' ),
192 $config->get( 'InterwikiCache' ),
193 $config->get( 'InterwikiScopes' ),
194 $config->get( 'InterwikiFallbackSite' )
198 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
199 return new LinkCache(
200 $services->getTitleFormatter(),
201 $services->getMainWANObjectCache()
205 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
208 if ( defined( 'MW_NO_SESSION' ) ) {
209 return $services->getLinkRendererFactory()->create();
211 return $services->getLinkRendererFactory()->createForUser( $wgUser );
215 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
216 return new LinkRendererFactory(
217 $services->getTitleFormatter(),
218 $services->getLinkCache()
222 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
223 $cacheId = \ObjectCache
::detectLocalServerCache();
224 return \ObjectCache
::newFromId( $cacheId );
227 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
228 return new MagicWordFactory( $services->getContentLanguage() );
231 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
232 // Use the 'main' config from the ConfigFactory service.
233 return $services->getConfigFactory()->makeConfig( 'main' );
236 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
237 $mainConfig = $services->getMainConfig();
239 $id = $mainConfig->get( 'MainStash' );
240 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
241 throw new UnexpectedValueException(
242 "Cache type \"$id\" is not present in \$wgObjectCaches." );
245 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
248 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
249 $mainConfig = $services->getMainConfig();
251 $id = $mainConfig->get( 'MainWANCache' );
252 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
253 throw new UnexpectedValueException(
254 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
257 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
258 $objectCacheId = $params['cacheId'];
259 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
260 throw new UnexpectedValueException(
261 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
263 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
265 return \ObjectCache
::newWANCacheFromParams( $params );
268 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
269 return new MediaHandlerFactory(
270 $services->getMainConfig()->get( 'MediaHandlers' )
274 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
275 $logger = LoggerFactory
::getInstance( 'Mime' );
276 $mainConfig = $services->getMainConfig();
278 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
279 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
280 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
282 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
284 $deja = new DjVuImage( $file );
285 if ( $deja->isValid() ) {
286 $logger->info( "Detected $file as image/vnd.djvu\n" );
287 $mime = 'image/vnd.djvu';
291 // Some strings by reference for performance - assuming well-behaved hooks
293 'MimeMagicGuessFromContent',
294 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
297 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
298 // Media handling extensions can improve the MIME detected
299 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
301 'initCallback' => function ( $mimeAnalyzer ) {
302 // Allow media handling extensions adding MIME-types and MIME-info
303 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
308 if ( $params['infoFile'] === 'includes/mime.info' ) {
309 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
312 if ( $params['typeFile'] === 'includes/mime.types' ) {
313 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
316 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
317 if ( $detectorCmd ) {
318 $factory = $services->getShellCommandFactory();
319 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
320 $result = $factory->create()
321 // $wgMimeDetectorCommand can contain commands with parameters
322 ->unsafeParams( $detectorCmd )
325 return $result->getStdout();
329 return new MimeAnalyzer( $params );
332 'NameTableStoreFactory' => function ( MediaWikiServices
$services ) : NameTableStoreFactory
{
333 return new NameTableStoreFactory(
334 $services->getDBLoadBalancerFactory(),
335 $services->getMainWANObjectCache(),
336 LoggerFactory
::getInstance( 'NameTableSqlStore' )
340 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
341 return new ImportableOldRevisionImporter(
343 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
344 $services->getDBLoadBalancer()
348 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
349 return $services->getParserFactory()->create();
352 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
353 $config = $services->getMainConfig();
354 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
355 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
357 return new ParserCache(
359 $config->get( 'CacheEpoch' )
363 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
364 return new ParserFactory(
365 $services->getMainConfig()->get( 'ParserConf' ),
366 $services->getMagicWordFactory(),
367 $services->getContentLanguage(),
369 $services->getSpecialPageFactory(),
370 $services->getMainConfig()
374 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
375 $config = $services->getMainConfig();
376 return new PasswordFactory(
377 $config->get( 'PasswordConfig' ),
378 $config->get( 'PasswordDefault' )
382 'PerDbNameStatsdDataFactory' =>
383 function ( MediaWikiServices
$services ) : StatsdDataFactoryInterface
{
384 $config = $services->getMainConfig();
385 $wiki = $config->get( 'DBname' );
386 return new PrefixingStatsdDataFactoryProxy(
387 $services->getStatsdDataFactory(),
392 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
393 $factory = new DefaultPreferencesFactory(
394 $services->getMainConfig(),
395 $services->getContentLanguage(),
396 AuthManager
::singleton(),
397 $services->getLinkRendererFactory()->create()
399 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
404 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
405 $mainConfig = $services->getMainConfig();
406 return new ProxyLookup(
407 $mainConfig->get( 'SquidServers' ),
408 $mainConfig->get( 'SquidServersNoPurge' )
412 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
413 return new ReadOnlyMode(
414 $services->getConfiguredReadOnlyMode(),
415 $services->getDBLoadBalancer()
419 'ResourceLoader' => function ( MediaWikiServices
$services ) : ResourceLoader
{
420 return new ResourceLoader(
421 $services->getMainConfig(),
422 LoggerFactory
::getInstance( 'resourceloader' )
426 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
427 return $services->getRevisionStore();
430 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
431 return $services->getRevisionStore();
434 'RevisionRenderer' => function ( MediaWikiServices
$services ) : RevisionRenderer
{
435 $renderer = new RevisionRenderer(
436 $services->getDBLoadBalancer(),
437 $services->getSlotRoleRegistry()
440 $renderer->setLogger( LoggerFactory
::getInstance( 'SaveParse' ) );
444 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
445 return $services->getRevisionStoreFactory()->getRevisionStore();
448 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
449 $config = $services->getMainConfig();
450 $store = new RevisionStoreFactory(
451 $services->getDBLoadBalancerFactory(),
452 $services->getBlobStoreFactory(),
453 $services->getNameTableStoreFactory(),
454 $services->getSlotRoleRegistry(),
455 $services->getMainWANObjectCache(),
456 $services->getCommentStore(),
457 $services->getActorMigration(),
458 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
459 LoggerFactory
::getProvider(),
460 $config->get( 'ContentHandlerUseDB' )
466 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
467 return new SearchEngineConfig( $services->getMainConfig(),
468 $services->getContentLanguage() );
471 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
472 return new SearchEngineFactory( $services->getSearchEngineConfig() );
475 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
476 $config = $services->getMainConfig();
479 'time' => $config->get( 'MaxShellTime' ),
480 'walltime' => $config->get( 'MaxShellWallClockTime' ),
481 'memory' => $config->get( 'MaxShellMemory' ),
482 'filesize' => $config->get( 'MaxShellFileSize' ),
484 $cgroup = $config->get( 'ShellCgroup' );
485 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
487 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
488 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
489 $factory->logStderr();
494 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
495 // Use SiteStore as the SiteLookup as well. This was originally separated
496 // to allow for a cacheable read-only interface (using FileBasedSiteLookup),
497 // but this was never used. SiteStore has caching (see below).
498 return $services->getSiteStore();
501 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
502 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
504 // TODO: replace wfGetCache with a CacheFactory service.
505 // TODO: replace wfIsHHVM with a capabilities service.
506 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
508 return new CachingSiteStore( $rawSiteStore, $cache );
511 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
512 $factory = new SkinFactory();
514 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
516 foreach ( $names as $name => $skin ) {
517 $factory->register( $name, $skin, function () use ( $name, $skin ) {
518 $class = "Skin$skin";
519 return new $class( $name );
522 // Register a hidden "fallback" skin
523 $factory->register( 'fallback', 'Fallback', function () {
524 return new SkinFallback
;
526 // Register a hidden skin for api output
527 $factory->register( 'apioutput', 'ApiOutput', function () {
534 'SlotRoleRegistry' => function ( MediaWikiServices
$services ) : SlotRoleRegistry
{
535 $config = $services->getMainConfig();
537 $registry = new SlotRoleRegistry(
538 $services->getNameTableStoreFactory()->getSlotRoles()
541 $registry->defineRole( 'main', function () use ( $config ) {
542 return new MainSlotRoleHandler(
543 $config->get( 'NamespaceContentModels' )
550 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
551 return new SpecialPageFactory(
552 $services->getMainConfig(),
553 $services->getContentLanguage()
557 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
558 return new BufferingStatsdDataFactory(
559 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
563 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
564 return $services->getService( '_MediaWikiTitleCodec' );
567 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
568 return $services->getService( '_MediaWikiTitleCodec' );
571 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
572 return new ImportableUploadRevisionImporter(
573 $services->getMainConfig()->get( 'EnableUploads' ),
574 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
578 'VirtualRESTServiceClient' =>
579 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
580 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
582 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
583 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
584 $class = $serviceConfig['class'];
585 // Merge in the global defaults
586 $constructArg = $serviceConfig['options'] ??
[];
587 $constructArg +
= $config['global'];
588 // Make the VRS service available at the mount point
589 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
595 'WatchedItemQueryService' =>
596 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
597 return new WatchedItemQueryService(
598 $services->getDBLoadBalancer(),
599 $services->getCommentStore(),
600 $services->getActorMigration(),
601 $services->getWatchedItemStore()
605 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
606 $store = new WatchedItemStore(
607 $services->getDBLoadBalancerFactory(),
608 JobQueueGroup
::singleton(),
609 $services->getMainObjectStash(),
610 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
611 $services->getReadOnlyMode(),
612 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
614 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
616 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
617 $store = new NoWriteWatchedItemStore( $store );
623 'WikiRevisionOldRevisionImporterNoUpdates' =>
624 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
625 return new ImportableOldRevisionImporter(
627 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
628 $services->getDBLoadBalancer()
632 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
633 return new MediaWikiTitleCodec(
634 $services->getContentLanguage(),
635 $services->getGenderCache(),
636 $services->getMainConfig()->get( 'LocalInterwikis' ),
637 $services->getInterwikiLookup()
641 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
642 return $services->getBlobStoreFactory()->newSqlBlobStore();
645 ///////////////////////////////////////////////////////////////////////////
646 // NOTE: When adding a service here, don't forget to add a getter function
647 // in the MediaWikiServices class. The convenience getter should just call
648 // $this->getService( 'FooBarService' ).
649 ///////////////////////////////////////////////////////////////////////////