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()
154 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
156 $instance = new $class( $lbConf );
157 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
162 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
163 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
166 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
167 $config = $services->getMainConfig();
169 return new ExternalStoreFactory(
170 $config->get( 'ExternalStores' )
174 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
175 return new GenderCache();
178 'HttpRequestFactory' =>
179 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
180 return new \MediaWiki\Http\
HttpRequestFactory();
183 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
184 $config = $services->getMainConfig();
185 return new ClassicInterwikiLookup(
186 $services->getContentLanguage(),
187 $services->getMainWANObjectCache(),
188 $config->get( 'InterwikiExpiry' ),
189 $config->get( 'InterwikiCache' ),
190 $config->get( 'InterwikiScopes' ),
191 $config->get( 'InterwikiFallbackSite' )
195 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
196 return new LinkCache(
197 $services->getTitleFormatter(),
198 $services->getMainWANObjectCache()
202 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
205 if ( defined( 'MW_NO_SESSION' ) ) {
206 return $services->getLinkRendererFactory()->create();
208 return $services->getLinkRendererFactory()->createForUser( $wgUser );
212 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
213 return new LinkRendererFactory(
214 $services->getTitleFormatter(),
215 $services->getLinkCache()
219 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
220 $cacheId = \ObjectCache
::detectLocalServerCache();
221 return \ObjectCache
::newFromId( $cacheId );
224 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
225 return new MagicWordFactory( $services->getContentLanguage() );
228 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
229 // Use the 'main' config from the ConfigFactory service.
230 return $services->getConfigFactory()->makeConfig( 'main' );
233 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
234 $mainConfig = $services->getMainConfig();
236 $id = $mainConfig->get( 'MainStash' );
237 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
238 throw new UnexpectedValueException(
239 "Cache type \"$id\" is not present in \$wgObjectCaches." );
242 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
245 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
246 $mainConfig = $services->getMainConfig();
248 $id = $mainConfig->get( 'MainWANCache' );
249 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
250 throw new UnexpectedValueException(
251 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
254 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
255 $objectCacheId = $params['cacheId'];
256 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
257 throw new UnexpectedValueException(
258 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
260 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
262 return \ObjectCache
::newWANCacheFromParams( $params );
265 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
266 return new MediaHandlerFactory(
267 $services->getMainConfig()->get( 'MediaHandlers' )
271 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
272 $logger = LoggerFactory
::getInstance( 'Mime' );
273 $mainConfig = $services->getMainConfig();
275 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
276 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
277 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
279 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
281 $deja = new DjVuImage( $file );
282 if ( $deja->isValid() ) {
283 $logger->info( "Detected $file as image/vnd.djvu\n" );
284 $mime = 'image/vnd.djvu';
288 // Some strings by reference for performance - assuming well-behaved hooks
290 'MimeMagicGuessFromContent',
291 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
294 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
295 // Media handling extensions can improve the MIME detected
296 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
298 'initCallback' => function ( $mimeAnalyzer ) {
299 // Allow media handling extensions adding MIME-types and MIME-info
300 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
305 if ( $params['infoFile'] === 'includes/mime.info' ) {
306 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
309 if ( $params['typeFile'] === 'includes/mime.types' ) {
310 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
313 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
314 if ( $detectorCmd ) {
315 $factory = $services->getShellCommandFactory();
316 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
317 $result = $factory->create()
318 // $wgMimeDetectorCommand can contain commands with parameters
319 ->unsafeParams( $detectorCmd )
322 return $result->getStdout();
326 return new MimeAnalyzer( $params );
329 'NameTableStoreFactory' => function ( MediaWikiServices
$services ) : NameTableStoreFactory
{
330 return new NameTableStoreFactory(
331 $services->getDBLoadBalancerFactory(),
332 $services->getMainWANObjectCache(),
333 LoggerFactory
::getInstance( 'NameTableSqlStore' )
337 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
338 return new ImportableOldRevisionImporter(
340 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
341 $services->getDBLoadBalancer()
345 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
346 return $services->getParserFactory()->create();
349 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
350 $config = $services->getMainConfig();
351 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
352 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
354 return new ParserCache(
356 $config->get( 'CacheEpoch' )
360 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
361 return new ParserFactory(
362 $services->getMainConfig()->get( 'ParserConf' ),
363 $services->getMagicWordFactory(),
364 $services->getContentLanguage(),
366 $services->getSpecialPageFactory(),
367 $services->getMainConfig()
371 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
372 $config = $services->getMainConfig();
373 return new PasswordFactory(
374 $config->get( 'PasswordConfig' ),
375 $config->get( 'PasswordDefault' )
379 'PerDbNameStatsdDataFactory' =>
380 function ( MediaWikiServices
$services ) : StatsdDataFactoryInterface
{
381 $config = $services->getMainConfig();
382 $wiki = $config->get( 'DBname' );
383 return new PrefixingStatsdDataFactoryProxy(
384 $services->getStatsdDataFactory(),
389 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
390 $factory = new DefaultPreferencesFactory(
391 $services->getMainConfig(),
392 $services->getContentLanguage(),
393 AuthManager
::singleton(),
394 $services->getLinkRendererFactory()->create()
396 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
401 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
402 $mainConfig = $services->getMainConfig();
403 return new ProxyLookup(
404 $mainConfig->get( 'SquidServers' ),
405 $mainConfig->get( 'SquidServersNoPurge' )
409 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
410 return new ReadOnlyMode(
411 $services->getConfiguredReadOnlyMode(),
412 $services->getDBLoadBalancer()
416 'ResourceLoader' => function ( MediaWikiServices
$services ) : ResourceLoader
{
417 return new ResourceLoader(
418 $services->getMainConfig(),
419 LoggerFactory
::getInstance( 'resourceloader' )
423 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
424 return $services->getRevisionStore();
427 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
428 return $services->getRevisionStore();
431 'RevisionRenderer' => function ( MediaWikiServices
$services ) : RevisionRenderer
{
432 $renderer = new RevisionRenderer(
433 $services->getDBLoadBalancer(),
434 $services->getSlotRoleRegistry()
437 $renderer->setLogger( LoggerFactory
::getInstance( 'SaveParse' ) );
441 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
442 return $services->getRevisionStoreFactory()->getRevisionStore();
445 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
446 $config = $services->getMainConfig();
447 $store = new RevisionStoreFactory(
448 $services->getDBLoadBalancerFactory(),
449 $services->getBlobStoreFactory(),
450 $services->getNameTableStoreFactory(),
451 $services->getSlotRoleRegistry(),
452 $services->getMainWANObjectCache(),
453 $services->getCommentStore(),
454 $services->getActorMigration(),
455 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
456 LoggerFactory
::getProvider(),
457 $config->get( 'ContentHandlerUseDB' )
463 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
464 return new SearchEngineConfig( $services->getMainConfig(),
465 $services->getContentLanguage() );
468 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
469 return new SearchEngineFactory( $services->getSearchEngineConfig() );
472 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
473 $config = $services->getMainConfig();
476 'time' => $config->get( 'MaxShellTime' ),
477 'walltime' => $config->get( 'MaxShellWallClockTime' ),
478 'memory' => $config->get( 'MaxShellMemory' ),
479 'filesize' => $config->get( 'MaxShellFileSize' ),
481 $cgroup = $config->get( 'ShellCgroup' );
482 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
484 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
485 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
486 $factory->logStderr();
491 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
492 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
494 if ( $cacheFile !== false ) {
495 return new FileBasedSiteLookup( $cacheFile );
497 // Use the default SiteStore as the SiteLookup implementation for now
498 return $services->getSiteStore();
502 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
503 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
505 // TODO: replace wfGetCache with a CacheFactory service.
506 // TODO: replace wfIsHHVM with a capabilities service.
507 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
509 return new CachingSiteStore( $rawSiteStore, $cache );
512 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
513 $factory = new SkinFactory();
515 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
517 foreach ( $names as $name => $skin ) {
518 $factory->register( $name, $skin, function () use ( $name, $skin ) {
519 $class = "Skin$skin";
520 return new $class( $name );
523 // Register a hidden "fallback" skin
524 $factory->register( 'fallback', 'Fallback', function () {
525 return new SkinFallback
;
527 // Register a hidden skin for api output
528 $factory->register( 'apioutput', 'ApiOutput', function () {
535 'SlotRoleRegistry' => function ( MediaWikiServices
$services ) : SlotRoleRegistry
{
536 $config = $services->getMainConfig();
538 $registry = new SlotRoleRegistry(
539 $services->getNameTableStoreFactory()->getSlotRoles()
542 $registry->defineRole( 'main', function () use ( $config ) {
543 return new MainSlotRoleHandler(
544 $config->get( 'NamespaceContentModels' )
551 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
552 return new SpecialPageFactory(
553 $services->getMainConfig(),
554 $services->getContentLanguage()
558 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
559 return new BufferingStatsdDataFactory(
560 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
564 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
565 return $services->getService( '_MediaWikiTitleCodec' );
568 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
569 return $services->getService( '_MediaWikiTitleCodec' );
572 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
573 return new ImportableUploadRevisionImporter(
574 $services->getMainConfig()->get( 'EnableUploads' ),
575 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
579 'VirtualRESTServiceClient' =>
580 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
581 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
583 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
584 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
585 $class = $serviceConfig['class'];
586 // Merge in the global defaults
587 $constructArg = $serviceConfig['options'] ??
[];
588 $constructArg +
= $config['global'];
589 // Make the VRS service available at the mount point
590 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
596 'WatchedItemQueryService' =>
597 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
598 return new WatchedItemQueryService(
599 $services->getDBLoadBalancer(),
600 $services->getCommentStore(),
601 $services->getActorMigration()
605 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
606 $store = new WatchedItemStore(
607 $services->getDBLoadBalancerFactory(),
608 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
609 $services->getReadOnlyMode(),
610 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
612 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
614 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
615 $store = new NoWriteWatchedItemStore( $store );
621 'WikiRevisionOldRevisionImporterNoUpdates' =>
622 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
623 return new ImportableOldRevisionImporter(
625 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
626 $services->getDBLoadBalancer()
630 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
631 return new MediaWikiTitleCodec(
632 $services->getContentLanguage(),
633 $services->getGenderCache(),
634 $services->getMainConfig()->get( 'LocalInterwikis' ),
635 $services->getInterwikiLookup()
639 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
640 return $services->getBlobStoreFactory()->newSqlBlobStore();
643 ///////////////////////////////////////////////////////////////////////////
644 // NOTE: When adding a service here, don't forget to add a getter function
645 // in the MediaWikiServices class. The convenience getter should just call
646 // $this->getService( 'FooBarService' ).
647 ///////////////////////////////////////////////////////////////////////////