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 'ActorMigration' => function ( MediaWikiServices
$services ) {
55 return new ActorMigration(
56 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
60 'BlobStore' => function ( MediaWikiServices
$services ) {
61 return $services->getService( '_SqlBlobStore' );
64 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
65 return new BlobStoreFactory(
66 $services->getDBLoadBalancer(),
67 $services->getMainWANObjectCache(),
68 $services->getMainConfig(),
69 $services->getContentLanguage()
73 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) {
74 return new NameTableStore(
75 $services->getDBLoadBalancer(),
76 $services->getMainWANObjectCache(),
77 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
83 function ( $insertFields ) {
84 $insertFields['ctd_user_defined'] = 0;
85 $insertFields['ctd_count'] = 0;
91 'CommentStore' => function ( MediaWikiServices
$services ) {
92 return new CommentStore(
93 $services->getContentLanguage(),
94 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
98 'ConfigFactory' => function ( MediaWikiServices
$services ) {
99 // Use the bootstrap config to initialize the ConfigFactory.
100 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
101 $factory = new ConfigFactory();
103 foreach ( $registry as $name => $callback ) {
104 $factory->register( $name, $callback );
109 'ConfigRepository' => function ( MediaWikiServices
$services ) {
110 return new ConfigRepository( $services->getConfigFactory() );
113 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
114 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
117 'ContentLanguage' => function ( MediaWikiServices
$services ) {
118 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
121 'ContentModelStore' => function ( MediaWikiServices
$services ) {
122 return new NameTableStore(
123 $services->getDBLoadBalancer(),
124 $services->getMainWANObjectCache(),
125 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
130 * No strtolower normalization is added to the service as there are examples of
131 * extensions that do not stick to this assumption.
132 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
133 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
138 'CryptHKDF' => function ( MediaWikiServices
$services ) {
139 $config = $services->getMainConfig();
141 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
143 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
146 // In HKDF, the context can be known to the attacker, but this will
147 // keep simultaneous runs from producing the same output.
148 $context = [ microtime(), getmypid(), gethostname() ];
150 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
151 $cache = $services->getLocalServerObjectCache();
152 if ( $cache instanceof EmptyBagOStuff
) {
153 $cache = ObjectCache
::getLocalClusterInstance();
156 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
159 'CryptRand' => function () {
160 return new CryptRand();
163 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
164 // just return the default LB from the DBLoadBalancerFactory service
165 return $services->getDBLoadBalancerFactory()->getMainLB();
168 'DBLoadBalancerFactory' => function ( MediaWikiServices
$services ) {
169 $mainConfig = $services->getMainConfig();
171 $lbConf = MWLBFactory
::applyDefaultConfig(
172 $mainConfig->get( 'LBFactoryConf' ),
174 $services->getConfiguredReadOnlyMode()
176 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
178 $instance = new $class( $lbConf );
179 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
184 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
185 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
188 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
189 $config = $services->getMainConfig();
191 return new ExternalStoreFactory(
192 $config->get( 'ExternalStores' )
196 'GenderCache' => function ( MediaWikiServices
$services ) {
197 return new GenderCache();
200 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
201 return new \MediaWiki\Http\
HttpRequestFactory();
204 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
205 $config = $services->getMainConfig();
206 return new ClassicInterwikiLookup(
207 $services->getContentLanguage(),
208 $services->getMainWANObjectCache(),
209 $config->get( 'InterwikiExpiry' ),
210 $config->get( 'InterwikiCache' ),
211 $config->get( 'InterwikiScopes' ),
212 $config->get( 'InterwikiFallbackSite' )
216 'LinkCache' => function ( MediaWikiServices
$services ) {
217 return new LinkCache(
218 $services->getTitleFormatter(),
219 $services->getMainWANObjectCache()
223 'LinkRenderer' => function ( MediaWikiServices
$services ) {
226 if ( defined( 'MW_NO_SESSION' ) ) {
227 return $services->getLinkRendererFactory()->create();
229 return $services->getLinkRendererFactory()->createForUser( $wgUser );
233 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
234 return new LinkRendererFactory(
235 $services->getTitleFormatter(),
236 $services->getLinkCache()
240 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
241 $cacheId = \ObjectCache
::detectLocalServerCache();
242 return \ObjectCache
::newFromId( $cacheId );
245 'MagicWordFactory' => function ( MediaWikiServices
$services ) {
246 return new MagicWordFactory( $services->getContentLanguage() );
249 'MainConfig' => function ( MediaWikiServices
$services ) {
250 // Use the 'main' config from the ConfigFactory service.
251 return $services->getConfigFactory()->makeConfig( 'main' );
254 'MainObjectStash' => function ( MediaWikiServices
$services ) {
255 $mainConfig = $services->getMainConfig();
257 $id = $mainConfig->get( 'MainStash' );
258 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
259 throw new UnexpectedValueException(
260 "Cache type \"$id\" is not present in \$wgObjectCaches." );
263 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
266 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
267 $mainConfig = $services->getMainConfig();
269 $id = $mainConfig->get( 'MainWANCache' );
270 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
271 throw new UnexpectedValueException(
272 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
275 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
276 $objectCacheId = $params['cacheId'];
277 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
278 throw new UnexpectedValueException(
279 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
281 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
283 return \ObjectCache
::newWANCacheFromParams( $params );
286 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
287 return new MediaHandlerFactory(
288 $services->getMainConfig()->get( 'MediaHandlers' )
292 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
293 $logger = LoggerFactory
::getInstance( 'Mime' );
294 $mainConfig = $services->getMainConfig();
296 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
297 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
298 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
300 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
302 $deja = new DjVuImage( $file );
303 if ( $deja->isValid() ) {
304 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
305 $mime = 'image/vnd.djvu';
309 // Some strings by reference for performance - assuming well-behaved hooks
311 'MimeMagicGuessFromContent',
312 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
315 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
316 // Media handling extensions can improve the MIME detected
317 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
319 'initCallback' => function ( $mimeAnalyzer ) {
320 // Allow media handling extensions adding MIME-types and MIME-info
321 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
326 if ( $params['infoFile'] === 'includes/mime.info' ) {
327 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
330 if ( $params['typeFile'] === 'includes/mime.types' ) {
331 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
334 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
335 if ( $detectorCmd ) {
336 $factory = $services->getShellCommandFactory();
337 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
338 $result = $factory->create()
339 // $wgMimeDetectorCommand can contain commands with parameters
340 ->unsafeParams( $detectorCmd )
343 return $result->getStdout();
347 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
348 return new MimeMagic( $params );
351 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
352 return new ImportableOldRevisionImporter(
354 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
355 $services->getDBLoadBalancer()
359 'Parser' => function ( MediaWikiServices
$services ) {
360 $conf = $services->getMainConfig()->get( 'ParserConf' );
361 return ObjectFactory
::constructClassInstance( $conf['class'],
362 [ $conf, $services->getMagicWordFactory() ] );
365 'ParserCache' => function ( MediaWikiServices
$services ) {
366 $config = $services->getMainConfig();
367 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
368 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
370 return new ParserCache(
372 $config->get( 'CacheEpoch' )
376 'PasswordFactory' => function ( MediaWikiServices
$services ) {
377 $config = $services->getMainConfig();
378 return new PasswordFactory(
379 $config->get( 'PasswordConfig' ),
380 $config->get( 'PasswordDefault' )
384 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices
$services ) {
385 $config = $services->getMainConfig();
386 $wiki = $config->get( 'DBname' );
387 return new BufferingStatsdDataFactory(
388 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . '.' . $wiki
392 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
393 $authManager = AuthManager
::singleton();
394 $linkRenderer = $services->getLinkRendererFactory()->create();
395 $config = $services->getMainConfig();
396 $factory = new DefaultPreferencesFactory( $config, $services->getContentLanguage(),
397 $authManager, $linkRenderer );
398 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
403 'ProxyLookup' => function ( MediaWikiServices
$services ) {
404 $mainConfig = $services->getMainConfig();
405 return new ProxyLookup(
406 $mainConfig->get( 'SquidServers' ),
407 $mainConfig->get( 'SquidServersNoPurge' )
411 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
412 return new ReadOnlyMode(
413 $services->getConfiguredReadOnlyMode(),
414 $services->getDBLoadBalancer()
418 'RevisionFactory' => function ( MediaWikiServices
$services ) {
419 return $services->getRevisionStore();
422 'RevisionLookup' => function ( MediaWikiServices
$services ) {
423 return $services->getRevisionStore();
426 'RevisionStore' => function ( MediaWikiServices
$services ) {
427 return $services->getRevisionStoreFactory()->getRevisionStore();
430 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) {
431 $config = $services->getMainConfig();
432 $store = new RevisionStoreFactory(
433 $services->getDBLoadBalancerFactory(),
434 $services->getBlobStoreFactory(),
435 $services->getMainWANObjectCache(),
436 $services->getCommentStore(),
437 $services->getActorMigration(),
438 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
439 LoggerFactory
::getProvider(),
440 $config->get( 'ContentHandlerUseDB' )
446 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
447 return new SearchEngineConfig( $services->getMainConfig(),
448 $services->getContentLanguage() );
451 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
452 return new SearchEngineFactory( $services->getSearchEngineConfig() );
455 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
456 $config = $services->getMainConfig();
459 'time' => $config->get( 'MaxShellTime' ),
460 'walltime' => $config->get( 'MaxShellWallClockTime' ),
461 'memory' => $config->get( 'MaxShellMemory' ),
462 'filesize' => $config->get( 'MaxShellFileSize' ),
464 $cgroup = $config->get( 'ShellCgroup' );
465 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
467 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
468 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
469 $factory->logStderr();
474 'SiteLookup' => function ( MediaWikiServices
$services ) {
475 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
477 if ( $cacheFile !== false ) {
478 return new FileBasedSiteLookup( $cacheFile );
480 // Use the default SiteStore as the SiteLookup implementation for now
481 return $services->getSiteStore();
485 'SiteStore' => function ( MediaWikiServices
$services ) {
486 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
488 // TODO: replace wfGetCache with a CacheFactory service.
489 // TODO: replace wfIsHHVM with a capabilities service.
490 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
492 return new CachingSiteStore( $rawSiteStore, $cache );
495 'SkinFactory' => function ( MediaWikiServices
$services ) {
496 $factory = new SkinFactory();
498 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
500 foreach ( $names as $name => $skin ) {
501 $factory->register( $name, $skin, function () use ( $name, $skin ) {
502 $class = "Skin$skin";
503 return new $class( $name );
506 // Register a hidden "fallback" skin
507 $factory->register( 'fallback', 'Fallback', function () {
508 return new SkinFallback
;
510 // Register a hidden skin for api output
511 $factory->register( 'apioutput', 'ApiOutput', function () {
518 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
519 return new NameTableStore(
520 $services->getDBLoadBalancer(),
521 $services->getMainWANObjectCache(),
522 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
530 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
531 return new BufferingStatsdDataFactory(
532 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
536 'TitleFormatter' => function ( MediaWikiServices
$services ) {
537 return $services->getService( '_MediaWikiTitleCodec' );
540 'TitleParser' => function ( MediaWikiServices
$services ) {
541 return $services->getService( '_MediaWikiTitleCodec' );
544 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
545 return new ImportableUploadRevisionImporter(
546 $services->getMainConfig()->get( 'EnableUploads' ),
547 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
551 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
552 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
554 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
555 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
556 $class = $serviceConfig['class'];
557 // Merge in the global defaults
558 $constructArg = $serviceConfig['options'] ??
[];
559 $constructArg +
= $config['global'];
560 // Make the VRS service available at the mount point
561 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
567 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
568 return new WatchedItemQueryService(
569 $services->getDBLoadBalancer(),
570 $services->getCommentStore(),
571 $services->getActorMigration()
575 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
576 $store = new WatchedItemStore(
577 $services->getDBLoadBalancer(),
578 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
579 $services->getReadOnlyMode(),
580 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
582 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
584 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
585 $store = new NoWriteWatchedItemStore( $store );
591 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
592 return new ImportableOldRevisionImporter(
594 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
595 $services->getDBLoadBalancer()
599 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
600 return new MediaWikiTitleCodec(
601 $services->getContentLanguage(),
602 $services->getGenderCache(),
603 $services->getMainConfig()->get( 'LocalInterwikis' )
607 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
608 return $services->getBlobStoreFactory()->newSqlBlobStore();
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 ///////////////////////////////////////////////////////////////////////////