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\Permissions\PermissionManager
;
50 use MediaWiki\Preferences\PreferencesFactory
;
51 use MediaWiki\Preferences\DefaultPreferencesFactory
;
52 use MediaWiki\Revision\MainSlotRoleHandler
;
53 use MediaWiki\Revision\RevisionFactory
;
54 use MediaWiki\Revision\RevisionLookup
;
55 use MediaWiki\Revision\SlotRoleRegistry
;
56 use MediaWiki\Revision\RevisionRenderer
;
57 use MediaWiki\Revision\RevisionStore
;
58 use MediaWiki\Revision\RevisionStoreFactory
;
59 use MediaWiki\Shell\CommandFactory
;
60 use MediaWiki\Special\SpecialPageFactory
;
61 use MediaWiki\Storage\BlobStore
;
62 use MediaWiki\Storage\BlobStoreFactory
;
63 use MediaWiki\Storage\NameTableStoreFactory
;
64 use MediaWiki\Storage\SqlBlobStore
;
67 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
68 return new ActorMigration(
69 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
73 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
74 return $services->getService( '_SqlBlobStore' );
77 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
78 return new BlobStoreFactory(
79 $services->getDBLoadBalancerFactory(),
80 $services->getMainWANObjectCache(),
81 $services->getMainConfig(),
82 $services->getContentLanguage()
86 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
87 return new CommentStore(
88 $services->getContentLanguage(),
93 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
94 // Use the bootstrap config to initialize the ConfigFactory.
95 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
96 $factory = new ConfigFactory();
98 foreach ( $registry as $name => $callback ) {
99 $factory->register( $name, $callback );
104 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
105 return new ConfigRepository( $services->getConfigFactory() );
108 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
109 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
112 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
113 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
116 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
117 $config = $services->getMainConfig();
119 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
121 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
124 // In HKDF, the context can be known to the attacker, but this will
125 // keep simultaneous runs from producing the same output.
126 $context = [ microtime(), getmypid(), gethostname() ];
128 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
129 $cache = $services->getLocalServerObjectCache();
130 if ( $cache instanceof EmptyBagOStuff
) {
131 $cache = ObjectCache
::getLocalClusterInstance();
134 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
137 'CryptRand' => function () : CryptRand
{
138 return new CryptRand();
141 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
142 // just return the default LB from the DBLoadBalancerFactory service
143 return $services->getDBLoadBalancerFactory()->getMainLB();
146 'DBLoadBalancerFactory' =>
147 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
148 $mainConfig = $services->getMainConfig();
150 $lbConf = MWLBFactory
::applyDefaultConfig(
151 $mainConfig->get( 'LBFactoryConf' ),
153 $services->getConfiguredReadOnlyMode(),
154 $services->getLocalServerObjectCache(),
155 $services->getMainObjectStash(),
156 $services->getMainWANObjectCache()
158 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
160 $instance = new $class( $lbConf );
161 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
166 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
167 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
170 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
171 $config = $services->getMainConfig();
173 return new ExternalStoreFactory(
174 $config->get( 'ExternalStores' )
178 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
179 return new GenderCache();
182 'HttpRequestFactory' =>
183 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
184 return new \MediaWiki\Http\
HttpRequestFactory();
187 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
188 $config = $services->getMainConfig();
189 return new ClassicInterwikiLookup(
190 $services->getContentLanguage(),
191 $services->getMainWANObjectCache(),
192 $config->get( 'InterwikiExpiry' ),
193 $config->get( 'InterwikiCache' ),
194 $config->get( 'InterwikiScopes' ),
195 $config->get( 'InterwikiFallbackSite' )
199 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
200 return new LinkCache(
201 $services->getTitleFormatter(),
202 $services->getMainWANObjectCache()
206 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
207 if ( defined( 'MW_NO_SESSION' ) ) {
208 return $services->getLinkRendererFactory()->create();
210 return $services->getLinkRendererFactory()->createForUser(
211 RequestContext
::getMain()->getUser()
216 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
217 return new LinkRendererFactory(
218 $services->getTitleFormatter(),
219 $services->getLinkCache()
223 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
224 $cacheId = \ObjectCache
::detectLocalServerCache();
225 return \ObjectCache
::newFromId( $cacheId );
228 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
229 return new MagicWordFactory( $services->getContentLanguage() );
232 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
233 // Use the 'main' config from the ConfigFactory service.
234 return $services->getConfigFactory()->makeConfig( 'main' );
237 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
238 $mainConfig = $services->getMainConfig();
240 $id = $mainConfig->get( 'MainStash' );
241 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
242 throw new UnexpectedValueException(
243 "Cache type \"$id\" is not present in \$wgObjectCaches." );
246 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
249 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
250 $mainConfig = $services->getMainConfig();
252 $id = $mainConfig->get( 'MainWANCache' );
253 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
254 throw new UnexpectedValueException(
255 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
258 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
259 $objectCacheId = $params['cacheId'];
260 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
261 throw new UnexpectedValueException(
262 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
264 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
266 return \ObjectCache
::newWANCacheFromParams( $params );
269 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
270 return new MediaHandlerFactory(
271 $services->getMainConfig()->get( 'MediaHandlers' )
275 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
276 $logger = LoggerFactory
::getInstance( 'Mime' );
277 $mainConfig = $services->getMainConfig();
279 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
280 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
281 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
283 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
285 $deja = new DjVuImage( $file );
286 if ( $deja->isValid() ) {
287 $logger->info( "Detected $file as image/vnd.djvu\n" );
288 $mime = 'image/vnd.djvu';
292 // Some strings by reference for performance - assuming well-behaved hooks
294 'MimeMagicGuessFromContent',
295 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
298 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
299 // Media handling extensions can improve the MIME detected
300 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
302 'initCallback' => function ( $mimeAnalyzer ) {
303 // Allow media handling extensions adding MIME-types and MIME-info
304 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
309 if ( $params['infoFile'] === 'includes/mime.info' ) {
310 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
313 if ( $params['typeFile'] === 'includes/mime.types' ) {
314 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
317 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
318 if ( $detectorCmd ) {
319 $factory = $services->getShellCommandFactory();
320 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
321 $result = $factory->create()
322 // $wgMimeDetectorCommand can contain commands with parameters
323 ->unsafeParams( $detectorCmd )
326 return $result->getStdout();
330 return new MimeAnalyzer( $params );
333 'NameTableStoreFactory' => function ( MediaWikiServices
$services ) : NameTableStoreFactory
{
334 return new NameTableStoreFactory(
335 $services->getDBLoadBalancerFactory(),
336 $services->getMainWANObjectCache(),
337 LoggerFactory
::getInstance( 'NameTableSqlStore' )
341 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
342 return new ImportableOldRevisionImporter(
344 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
345 $services->getDBLoadBalancer()
349 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
350 return $services->getParserFactory()->create();
353 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
354 $config = $services->getMainConfig();
355 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
356 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
358 return new ParserCache(
360 $config->get( 'CacheEpoch' )
364 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
365 return new ParserFactory(
366 $services->getMainConfig()->get( 'ParserConf' ),
367 $services->getMagicWordFactory(),
368 $services->getContentLanguage(),
370 $services->getSpecialPageFactory(),
371 $services->getMainConfig()
375 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
376 $config = $services->getMainConfig();
377 return new PasswordFactory(
378 $config->get( 'PasswordConfig' ),
379 $config->get( 'PasswordDefault' )
383 'PerDbNameStatsdDataFactory' =>
384 function ( MediaWikiServices
$services ) : StatsdDataFactoryInterface
{
385 $config = $services->getMainConfig();
386 $wiki = $config->get( 'DBname' );
387 return new PrefixingStatsdDataFactoryProxy(
388 $services->getStatsdDataFactory(),
393 'PermissionManager' => function ( MediaWikiServices
$services ) : PermissionManager
{
394 $config = $services->getMainConfig();
395 return new PermissionManager(
396 $services->getSpecialPageFactory(),
397 $config->get( 'WhitelistRead' ),
398 $config->get( 'WhitelistReadRegexp' ),
399 $config->get( 'EmailConfirmToEdit' ),
400 $config->get( 'BlockDisablesLogin' ) );
403 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
404 $factory = new DefaultPreferencesFactory(
405 $services->getMainConfig(),
406 $services->getContentLanguage(),
407 AuthManager
::singleton(),
408 $services->getLinkRendererFactory()->create()
410 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
415 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
416 $mainConfig = $services->getMainConfig();
417 return new ProxyLookup(
418 $mainConfig->get( 'SquidServers' ),
419 $mainConfig->get( 'SquidServersNoPurge' )
423 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
424 return new ReadOnlyMode(
425 $services->getConfiguredReadOnlyMode(),
426 $services->getDBLoadBalancer()
430 'ResourceLoader' => function ( MediaWikiServices
$services ) : ResourceLoader
{
431 $config = $services->getMainConfig();
433 $rl = new ResourceLoader(
435 LoggerFactory
::getInstance( 'resourceloader' )
437 $rl->addSource( $config->get( 'ResourceLoaderSources' ) );
442 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
443 return $services->getRevisionStore();
446 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
447 return $services->getRevisionStore();
450 'RevisionRenderer' => function ( MediaWikiServices
$services ) : RevisionRenderer
{
451 $renderer = new RevisionRenderer(
452 $services->getDBLoadBalancer(),
453 $services->getSlotRoleRegistry()
456 $renderer->setLogger( LoggerFactory
::getInstance( 'SaveParse' ) );
460 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
461 return $services->getRevisionStoreFactory()->getRevisionStore();
464 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
465 $config = $services->getMainConfig();
466 $store = new RevisionStoreFactory(
467 $services->getDBLoadBalancerFactory(),
468 $services->getBlobStoreFactory(),
469 $services->getNameTableStoreFactory(),
470 $services->getSlotRoleRegistry(),
471 $services->getMainWANObjectCache(),
472 $services->getCommentStore(),
473 $services->getActorMigration(),
474 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
475 LoggerFactory
::getProvider(),
476 $config->get( 'ContentHandlerUseDB' )
482 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
483 return new SearchEngineConfig( $services->getMainConfig(),
484 $services->getContentLanguage() );
487 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
488 return new SearchEngineFactory( $services->getSearchEngineConfig() );
491 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
492 $config = $services->getMainConfig();
495 'time' => $config->get( 'MaxShellTime' ),
496 'walltime' => $config->get( 'MaxShellWallClockTime' ),
497 'memory' => $config->get( 'MaxShellMemory' ),
498 'filesize' => $config->get( 'MaxShellFileSize' ),
500 $cgroup = $config->get( 'ShellCgroup' );
501 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
503 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
504 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
505 $factory->logStderr();
510 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
511 // Use SiteStore as the SiteLookup as well. This was originally separated
512 // to allow for a cacheable read-only interface (using FileBasedSiteLookup),
513 // but this was never used. SiteStore has caching (see below).
514 return $services->getSiteStore();
517 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
518 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
520 // TODO: replace wfGetCache with a CacheFactory service.
521 // TODO: replace wfIsHHVM with a capabilities service.
522 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
524 return new CachingSiteStore( $rawSiteStore, $cache );
527 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
528 $factory = new SkinFactory();
530 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
532 foreach ( $names as $name => $skin ) {
533 $factory->register( $name, $skin, function () use ( $name, $skin ) {
534 $class = "Skin$skin";
535 return new $class( $name );
538 // Register a hidden "fallback" skin
539 $factory->register( 'fallback', 'Fallback', function () {
540 return new SkinFallback
;
542 // Register a hidden skin for api output
543 $factory->register( 'apioutput', 'ApiOutput', function () {
550 'SlotRoleRegistry' => function ( MediaWikiServices
$services ) : SlotRoleRegistry
{
551 $config = $services->getMainConfig();
553 $registry = new SlotRoleRegistry(
554 $services->getNameTableStoreFactory()->getSlotRoles()
557 $registry->defineRole( 'main', function () use ( $config ) {
558 return new MainSlotRoleHandler(
559 $config->get( 'NamespaceContentModels' )
566 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
567 return new SpecialPageFactory(
568 $services->getMainConfig(),
569 $services->getContentLanguage()
573 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
574 return new BufferingStatsdDataFactory(
575 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
579 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
580 return $services->getService( '_MediaWikiTitleCodec' );
583 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
584 return $services->getService( '_MediaWikiTitleCodec' );
587 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
588 return new ImportableUploadRevisionImporter(
589 $services->getMainConfig()->get( 'EnableUploads' ),
590 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
594 'VirtualRESTServiceClient' =>
595 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
596 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
598 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
599 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
600 $class = $serviceConfig['class'];
601 // Merge in the global defaults
602 $constructArg = $serviceConfig['options'] ??
[];
603 $constructArg +
= $config['global'];
604 // Make the VRS service available at the mount point
605 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
611 'WatchedItemQueryService' =>
612 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
613 return new WatchedItemQueryService(
614 $services->getDBLoadBalancer(),
615 $services->getCommentStore(),
616 $services->getActorMigration(),
617 $services->getWatchedItemStore()
621 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
622 $store = new WatchedItemStore(
623 $services->getDBLoadBalancerFactory(),
624 JobQueueGroup
::singleton(),
625 $services->getMainObjectStash(),
626 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
627 $services->getReadOnlyMode(),
628 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
630 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
632 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
633 $store = new NoWriteWatchedItemStore( $store );
639 'WikiRevisionOldRevisionImporterNoUpdates' =>
640 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
641 return new ImportableOldRevisionImporter(
643 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
644 $services->getDBLoadBalancer()
648 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
649 return new MediaWikiTitleCodec(
650 $services->getContentLanguage(),
651 $services->getGenderCache(),
652 $services->getMainConfig()->get( 'LocalInterwikis' ),
653 $services->getInterwikiLookup()
657 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
658 return $services->getBlobStoreFactory()->newSqlBlobStore();
661 ///////////////////////////////////////////////////////////////////////////
662 // NOTE: When adding a service here, don't forget to add a getter function
663 // in the MediaWikiServices class. The convenience getter should just call
664 // $this->getService( 'FooBarService' ).
665 ///////////////////////////////////////////////////////////////////////////