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 MediaWiki\Auth\AuthManager
;
41 use MediaWiki\Config\ConfigRepository
;
42 use MediaWiki\Interwiki\ClassicInterwikiLookup
;
43 use MediaWiki\Linker\LinkRendererFactory
;
44 use MediaWiki\Logger\LoggerFactory
;
45 use MediaWiki\MediaWikiServices
;
46 use MediaWiki\Preferences\DefaultPreferencesFactory
;
47 use MediaWiki\Shell\CommandFactory
;
48 use MediaWiki\Storage\BlobStoreFactory
;
49 use MediaWiki\Storage\NameTableStore
;
50 use MediaWiki\Storage\RevisionStoreFactory
;
51 use Wikimedia\ObjectFactory
;
54 'DBLoadBalancerFactory' => function ( MediaWikiServices
$services ) {
55 $mainConfig = $services->getMainConfig();
57 $lbConf = MWLBFactory
::applyDefaultConfig(
58 $mainConfig->get( 'LBFactoryConf' ),
60 $services->getConfiguredReadOnlyMode()
62 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
64 $instance = new $class( $lbConf );
65 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
70 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
71 // just return the default LB from the DBLoadBalancerFactory service
72 return $services->getDBLoadBalancerFactory()->getMainLB();
75 'SiteStore' => function ( MediaWikiServices
$services ) {
76 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
78 // TODO: replace wfGetCache with a CacheFactory service.
79 // TODO: replace wfIsHHVM with a capabilities service.
80 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
82 return new CachingSiteStore( $rawSiteStore, $cache );
85 'SiteLookup' => function ( MediaWikiServices
$services ) {
86 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
88 if ( $cacheFile !== false ) {
89 return new FileBasedSiteLookup( $cacheFile );
91 // Use the default SiteStore as the SiteLookup implementation for now
92 return $services->getSiteStore();
96 'ConfigFactory' => function ( MediaWikiServices
$services ) {
97 // Use the bootstrap config to initialize the ConfigFactory.
98 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
99 $factory = new ConfigFactory();
101 foreach ( $registry as $name => $callback ) {
102 $factory->register( $name, $callback );
107 'ConfigRepository' => function ( MediaWikiServices
$services ) {
108 return new ConfigRepository( $services->getConfigFactory() );
111 'MainConfig' => function ( MediaWikiServices
$services ) {
112 // Use the 'main' config from the ConfigFactory service.
113 return $services->getConfigFactory()->makeConfig( 'main' );
116 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
117 $config = $services->getMainConfig();
118 return new ClassicInterwikiLookup(
119 $services->getContentLanguage(),
120 $services->getMainWANObjectCache(),
121 $config->get( 'InterwikiExpiry' ),
122 $config->get( 'InterwikiCache' ),
123 $config->get( 'InterwikiScopes' ),
124 $config->get( 'InterwikiFallbackSite' )
128 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
129 return new BufferingStatsdDataFactory(
130 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
134 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices
$services ) {
135 $config = $services->getMainConfig();
136 $wiki = $config->get( 'DBname' );
137 return new BufferingStatsdDataFactory(
138 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . '.' . $wiki
142 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
143 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
146 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
147 return new SearchEngineFactory( $services->getSearchEngineConfig() );
150 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
151 return new SearchEngineConfig( $services->getMainConfig(),
152 $services->getContentLanguage() );
155 'SkinFactory' => function ( MediaWikiServices
$services ) {
156 $factory = new SkinFactory();
158 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
160 foreach ( $names as $name => $skin ) {
161 $factory->register( $name, $skin, function () use ( $name, $skin ) {
162 $class = "Skin$skin";
163 return new $class( $name );
166 // Register a hidden "fallback" skin
167 $factory->register( 'fallback', 'Fallback', function () {
168 return new SkinFallback
;
170 // Register a hidden skin for api output
171 $factory->register( 'apioutput', 'ApiOutput', function () {
178 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
179 $store = new WatchedItemStore(
180 $services->getDBLoadBalancer(),
181 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
182 $services->getReadOnlyMode(),
183 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
185 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
187 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
188 $store = new NoWriteWatchedItemStore( $store );
194 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
195 return new WatchedItemQueryService(
196 $services->getDBLoadBalancer(),
197 $services->getCommentStore(),
198 $services->getActorMigration()
202 'CryptRand' => function () {
203 return new CryptRand();
206 'CryptHKDF' => function ( MediaWikiServices
$services ) {
207 $config = $services->getMainConfig();
209 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
211 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
214 // In HKDF, the context can be known to the attacker, but this will
215 // keep simultaneous runs from producing the same output.
216 $context = [ microtime(), getmypid(), gethostname() ];
218 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
219 $cache = $services->getLocalServerObjectCache();
220 if ( $cache instanceof EmptyBagOStuff
) {
221 $cache = ObjectCache
::getLocalClusterInstance();
224 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
227 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
228 return new MediaHandlerFactory(
229 $services->getMainConfig()->get( 'MediaHandlers' )
233 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
234 $logger = LoggerFactory
::getInstance( 'Mime' );
235 $mainConfig = $services->getMainConfig();
237 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
238 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
239 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
241 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
243 $deja = new DjVuImage( $file );
244 if ( $deja->isValid() ) {
245 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
246 $mime = 'image/vnd.djvu';
250 // Some strings by reference for performance - assuming well-behaved hooks
252 'MimeMagicGuessFromContent',
253 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
256 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
257 // Media handling extensions can improve the MIME detected
258 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
260 'initCallback' => function ( $mimeAnalyzer ) {
261 // Allow media handling extensions adding MIME-types and MIME-info
262 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
267 if ( $params['infoFile'] === 'includes/mime.info' ) {
268 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
271 if ( $params['typeFile'] === 'includes/mime.types' ) {
272 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
275 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
276 if ( $detectorCmd ) {
277 $factory = $services->getShellCommandFactory();
278 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
279 $result = $factory->create()
280 // $wgMimeDetectorCommand can contain commands with parameters
281 ->unsafeParams( $detectorCmd )
284 return $result->getStdout();
288 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
289 return new MimeMagic( $params );
292 'ProxyLookup' => function ( MediaWikiServices
$services ) {
293 $mainConfig = $services->getMainConfig();
294 return new ProxyLookup(
295 $mainConfig->get( 'SquidServers' ),
296 $mainConfig->get( 'SquidServersNoPurge' )
300 'Parser' => function ( MediaWikiServices
$services ) {
301 $conf = $services->getMainConfig()->get( 'ParserConf' );
302 return ObjectFactory
::constructClassInstance( $conf['class'],
303 [ $conf, $services->getMagicWordFactory() ] );
306 'ParserCache' => function ( MediaWikiServices
$services ) {
307 $config = $services->getMainConfig();
308 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
309 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
311 return new ParserCache(
313 $config->get( 'CacheEpoch' )
317 'LinkCache' => function ( MediaWikiServices
$services ) {
318 return new LinkCache(
319 $services->getTitleFormatter(),
320 $services->getMainWANObjectCache()
324 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
325 return new LinkRendererFactory(
326 $services->getTitleFormatter(),
327 $services->getLinkCache()
331 'LinkRenderer' => function ( MediaWikiServices
$services ) {
334 if ( defined( 'MW_NO_SESSION' ) ) {
335 return $services->getLinkRendererFactory()->create();
337 return $services->getLinkRendererFactory()->createForUser( $wgUser );
341 'GenderCache' => function ( MediaWikiServices
$services ) {
342 return new GenderCache();
345 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
346 return new MediaWikiTitleCodec(
347 $services->getContentLanguage(),
348 $services->getGenderCache(),
349 $services->getMainConfig()->get( 'LocalInterwikis' )
353 'TitleFormatter' => function ( MediaWikiServices
$services ) {
354 return $services->getService( '_MediaWikiTitleCodec' );
357 'TitleParser' => function ( MediaWikiServices
$services ) {
358 return $services->getService( '_MediaWikiTitleCodec' );
361 'MainObjectStash' => function ( MediaWikiServices
$services ) {
362 $mainConfig = $services->getMainConfig();
364 $id = $mainConfig->get( 'MainStash' );
365 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
366 throw new UnexpectedValueException(
367 "Cache type \"$id\" is not present in \$wgObjectCaches." );
370 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
373 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
374 $mainConfig = $services->getMainConfig();
376 $id = $mainConfig->get( 'MainWANCache' );
377 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
378 throw new UnexpectedValueException(
379 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
382 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
383 $objectCacheId = $params['cacheId'];
384 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
385 throw new UnexpectedValueException(
386 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
388 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
390 return \ObjectCache
::newWANCacheFromParams( $params );
393 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
394 $cacheId = \ObjectCache
::detectLocalServerCache();
395 return \ObjectCache
::newFromId( $cacheId );
398 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
399 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
401 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
402 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
403 $class = $serviceConfig['class'];
404 // Merge in the global defaults
405 $constructArg = $serviceConfig['options'] ??
[];
406 $constructArg +
= $config['global'];
407 // Make the VRS service available at the mount point
408 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
414 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
415 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
418 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
419 return new ReadOnlyMode(
420 $services->getConfiguredReadOnlyMode(),
421 $services->getDBLoadBalancer()
425 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
426 return new ImportableUploadRevisionImporter(
427 $services->getMainConfig()->get( 'EnableUploads' ),
428 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
432 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
433 return new ImportableOldRevisionImporter(
435 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
436 $services->getDBLoadBalancer()
440 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
441 return new ImportableOldRevisionImporter(
443 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
444 $services->getDBLoadBalancer()
448 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
449 $config = $services->getMainConfig();
452 'time' => $config->get( 'MaxShellTime' ),
453 'walltime' => $config->get( 'MaxShellWallClockTime' ),
454 'memory' => $config->get( 'MaxShellMemory' ),
455 'filesize' => $config->get( 'MaxShellFileSize' ),
457 $cgroup = $config->get( 'ShellCgroup' );
458 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
460 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
461 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
462 $factory->logStderr();
467 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
468 $config = $services->getMainConfig();
470 return new ExternalStoreFactory(
471 $config->get( 'ExternalStores' )
475 'RevisionStore' => function ( MediaWikiServices
$services ) {
476 return $services->getRevisionStoreFactory()->getRevisionStore();
479 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) {
480 $config = $services->getMainConfig();
481 $store = new RevisionStoreFactory(
482 $services->getDBLoadBalancerFactory(),
483 $services->getBlobStoreFactory(),
484 $services->getMainWANObjectCache(),
485 $services->getCommentStore(),
486 $services->getActorMigration(),
487 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
488 LoggerFactory
::getProvider(),
489 $config->get( 'ContentHandlerUseDB' )
495 'RevisionLookup' => function ( MediaWikiServices
$services ) {
496 return $services->getRevisionStore();
499 'RevisionFactory' => function ( MediaWikiServices
$services ) {
500 return $services->getRevisionStore();
503 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
504 return new BlobStoreFactory(
505 $services->getDBLoadBalancer(),
506 $services->getMainWANObjectCache(),
507 $services->getMainConfig(),
508 $services->getContentLanguage()
512 'BlobStore' => function ( MediaWikiServices
$services ) {
513 return $services->getService( '_SqlBlobStore' );
516 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
517 return $services->getBlobStoreFactory()->newSqlBlobStore();
520 'ContentModelStore' => function ( MediaWikiServices
$services ) {
521 return new NameTableStore(
522 $services->getDBLoadBalancer(),
523 $services->getMainWANObjectCache(),
524 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
529 * No strtolower normalization is added to the service as there are examples of
530 * extensions that do not stick to this assumption.
531 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
532 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
537 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
538 return new NameTableStore(
539 $services->getDBLoadBalancer(),
540 $services->getMainWANObjectCache(),
541 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
549 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) {
550 return new NameTableStore(
551 $services->getDBLoadBalancer(),
552 $services->getMainWANObjectCache(),
553 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
559 function ( $insertFields ) {
560 $insertFields['ctd_user_defined'] = 0;
561 $insertFields['ctd_count'] = 0;
562 return $insertFields;
567 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
568 $authManager = AuthManager
::singleton();
569 $linkRenderer = $services->getLinkRendererFactory()->create();
570 $config = $services->getMainConfig();
571 $factory = new DefaultPreferencesFactory( $config, $services->getContentLanguage(),
572 $authManager, $linkRenderer );
573 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
578 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
579 return new \MediaWiki\Http\
HttpRequestFactory();
582 'CommentStore' => function ( MediaWikiServices
$services ) {
583 return new CommentStore(
584 $services->getContentLanguage(),
585 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
589 'ActorMigration' => function ( MediaWikiServices
$services ) {
590 return new ActorMigration(
591 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
595 'MagicWordFactory' => function ( MediaWikiServices
$services ) {
596 return new MagicWordFactory( $services->getContentLanguage() );
599 'ContentLanguage' => function ( MediaWikiServices
$services ) {
600 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
603 'PasswordFactory' => function ( MediaWikiServices
$services ) {
604 $config = $services->getMainConfig();
605 return new PasswordFactory(
606 $config->get( 'PasswordConfig' ),
607 $config->get( 'PasswordDefault' )
611 ///////////////////////////////////////////////////////////////////////////
612 // NOTE: When adding a service here, don't forget to add a getter function
613 // in the MediaWikiServices class. The convenience getter should just call
614 // $this->getService( 'FooBarService' ).
615 ///////////////////////////////////////////////////////////////////////////