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\RevisionStore
;
51 use MediaWiki\Storage\SqlBlobStore
;
52 use Wikimedia\ObjectFactory
;
55 'DBLoadBalancerFactory' => function ( MediaWikiServices
$services ) {
56 $mainConfig = $services->getMainConfig();
58 $lbConf = MWLBFactory
::applyDefaultConfig(
59 $mainConfig->get( 'LBFactoryConf' ),
61 $services->getConfiguredReadOnlyMode()
63 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
65 $instance = new $class( $lbConf );
66 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
71 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
72 // just return the default LB from the DBLoadBalancerFactory service
73 return $services->getDBLoadBalancerFactory()->getMainLB();
76 'SiteStore' => function ( MediaWikiServices
$services ) {
77 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
79 // TODO: replace wfGetCache with a CacheFactory service.
80 // TODO: replace wfIsHHVM with a capabilities service.
81 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
83 return new CachingSiteStore( $rawSiteStore, $cache );
86 'SiteLookup' => function ( MediaWikiServices
$services ) {
87 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
89 if ( $cacheFile !== false ) {
90 return new FileBasedSiteLookup( $cacheFile );
92 // Use the default SiteStore as the SiteLookup implementation for now
93 return $services->getSiteStore();
97 'ConfigFactory' => function ( MediaWikiServices
$services ) {
98 // Use the bootstrap config to initialize the ConfigFactory.
99 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
100 $factory = new ConfigFactory();
102 foreach ( $registry as $name => $callback ) {
103 $factory->register( $name, $callback );
108 'ConfigRepository' => function ( MediaWikiServices
$services ) {
109 return new ConfigRepository( $services->getConfigFactory() );
112 'MainConfig' => function ( MediaWikiServices
$services ) {
113 // Use the 'main' config from the ConfigFactory service.
114 return $services->getConfigFactory()->makeConfig( 'main' );
117 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
118 global $wgContLang; // TODO: manage $wgContLang as a service
119 $config = $services->getMainConfig();
120 return new ClassicInterwikiLookup(
122 $services->getMainWANObjectCache(),
123 $config->get( 'InterwikiExpiry' ),
124 $config->get( 'InterwikiCache' ),
125 $config->get( 'InterwikiScopes' ),
126 $config->get( 'InterwikiFallbackSite' )
130 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
131 return new BufferingStatsdDataFactory(
132 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
136 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices
$services ) {
137 $config = $services->getMainConfig();
138 $wiki = $config->get( 'DBname' );
139 return new BufferingStatsdDataFactory(
140 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . $wiki
144 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
145 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
148 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
149 return new SearchEngineFactory( $services->getSearchEngineConfig() );
152 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
154 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
157 'SkinFactory' => function ( MediaWikiServices
$services ) {
158 $factory = new SkinFactory();
160 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
162 foreach ( $names as $name => $skin ) {
163 $factory->register( $name, $skin, function () use ( $name, $skin ) {
164 $class = "Skin$skin";
165 return new $class( $name );
168 // Register a hidden "fallback" skin
169 $factory->register( 'fallback', 'Fallback', function () {
170 return new SkinFallback
;
172 // Register a hidden skin for api output
173 $factory->register( 'apioutput', 'ApiOutput', function () {
180 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
181 $store = new WatchedItemStore(
182 $services->getDBLoadBalancer(),
183 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
184 $services->getReadOnlyMode(),
185 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
187 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
189 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
190 $store = new NoWriteWatchedItemStore( $store );
196 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
197 return new WatchedItemQueryService(
198 $services->getDBLoadBalancer(),
199 $services->getCommentStore(),
200 $services->getActorMigration()
204 'CryptRand' => function () {
205 return new CryptRand();
208 'CryptHKDF' => function ( MediaWikiServices
$services ) {
209 $config = $services->getMainConfig();
211 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
213 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
216 // In HKDF, the context can be known to the attacker, but this will
217 // keep simultaneous runs from producing the same output.
218 $context = [ microtime(), getmypid(), gethostname() ];
220 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
221 $cache = $services->getLocalServerObjectCache();
222 if ( $cache instanceof EmptyBagOStuff
) {
223 $cache = ObjectCache
::getLocalClusterInstance();
226 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
229 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
230 return new MediaHandlerFactory(
231 $services->getMainConfig()->get( 'MediaHandlers' )
235 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
236 $logger = LoggerFactory
::getInstance( 'Mime' );
237 $mainConfig = $services->getMainConfig();
239 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
240 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
241 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
243 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
245 $deja = new DjVuImage( $file );
246 if ( $deja->isValid() ) {
247 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
248 $mime = 'image/vnd.djvu';
252 // Some strings by reference for performance - assuming well-behaved hooks
254 'MimeMagicGuessFromContent',
255 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
258 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
259 // Media handling extensions can improve the MIME detected
260 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
262 'initCallback' => function ( $mimeAnalyzer ) {
263 // Allow media handling extensions adding MIME-types and MIME-info
264 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
269 if ( $params['infoFile'] === 'includes/mime.info' ) {
270 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
273 if ( $params['typeFile'] === 'includes/mime.types' ) {
274 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
277 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
278 if ( $detectorCmd ) {
279 $factory = $services->getShellCommandFactory();
280 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
281 $result = $factory->create()
282 // $wgMimeDetectorCommand can contain commands with parameters
283 ->unsafeParams( $detectorCmd )
286 return $result->getStdout();
290 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
291 return new MimeMagic( $params );
294 'ProxyLookup' => function ( MediaWikiServices
$services ) {
295 $mainConfig = $services->getMainConfig();
296 return new ProxyLookup(
297 $mainConfig->get( 'SquidServers' ),
298 $mainConfig->get( 'SquidServersNoPurge' )
302 'Parser' => function ( MediaWikiServices
$services ) {
303 $conf = $services->getMainConfig()->get( 'ParserConf' );
304 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
307 'ParserCache' => function ( MediaWikiServices
$services ) {
308 $config = $services->getMainConfig();
309 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
310 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
312 return new ParserCache(
314 $config->get( 'CacheEpoch' )
318 'LinkCache' => function ( MediaWikiServices
$services ) {
319 return new LinkCache(
320 $services->getTitleFormatter(),
321 $services->getMainWANObjectCache()
325 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
326 return new LinkRendererFactory(
327 $services->getTitleFormatter(),
328 $services->getLinkCache()
332 'LinkRenderer' => function ( MediaWikiServices
$services ) {
335 if ( defined( 'MW_NO_SESSION' ) ) {
336 return $services->getLinkRendererFactory()->create();
338 return $services->getLinkRendererFactory()->createForUser( $wgUser );
342 'GenderCache' => function ( MediaWikiServices
$services ) {
343 return new GenderCache();
346 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
349 return new MediaWikiTitleCodec(
351 $services->getGenderCache(),
352 $services->getMainConfig()->get( 'LocalInterwikis' )
356 'TitleFormatter' => function ( MediaWikiServices
$services ) {
357 return $services->getService( '_MediaWikiTitleCodec' );
360 'TitleParser' => function ( MediaWikiServices
$services ) {
361 return $services->getService( '_MediaWikiTitleCodec' );
364 'MainObjectStash' => function ( MediaWikiServices
$services ) {
365 $mainConfig = $services->getMainConfig();
367 $id = $mainConfig->get( 'MainStash' );
368 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
369 throw new UnexpectedValueException(
370 "Cache type \"$id\" is not present in \$wgObjectCaches." );
373 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
376 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
377 $mainConfig = $services->getMainConfig();
379 $id = $mainConfig->get( 'MainWANCache' );
380 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
381 throw new UnexpectedValueException(
382 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
385 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
386 $objectCacheId = $params['cacheId'];
387 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
388 throw new UnexpectedValueException(
389 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
391 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
393 return \ObjectCache
::newWANCacheFromParams( $params );
396 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
397 $cacheId = \ObjectCache
::detectLocalServerCache();
398 return \ObjectCache
::newFromId( $cacheId );
401 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
402 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
404 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
405 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
406 $class = $serviceConfig['class'];
407 // Merge in the global defaults
408 $constructArg = $serviceConfig['options'] ??
[];
409 $constructArg +
= $config['global'];
410 // Make the VRS service available at the mount point
411 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
417 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
418 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
421 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
422 return new ReadOnlyMode(
423 $services->getConfiguredReadOnlyMode(),
424 $services->getDBLoadBalancer()
428 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
429 return new ImportableUploadRevisionImporter(
430 $services->getMainConfig()->get( 'EnableUploads' ),
431 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
435 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
436 return new ImportableOldRevisionImporter(
438 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
439 $services->getDBLoadBalancer()
443 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
444 return new ImportableOldRevisionImporter(
446 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
447 $services->getDBLoadBalancer()
451 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
452 $config = $services->getMainConfig();
455 'time' => $config->get( 'MaxShellTime' ),
456 'walltime' => $config->get( 'MaxShellWallClockTime' ),
457 'memory' => $config->get( 'MaxShellMemory' ),
458 'filesize' => $config->get( 'MaxShellFileSize' ),
460 $cgroup = $config->get( 'ShellCgroup' );
461 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
463 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
464 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
465 $factory->logStderr();
470 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
471 $config = $services->getMainConfig();
473 return new ExternalStoreFactory(
474 $config->get( 'ExternalStores' )
478 'RevisionStore' => function ( MediaWikiServices
$services ) {
479 /** @var SqlBlobStore $blobStore */
480 $blobStore = $services->getService( '_SqlBlobStore' );
482 $store = new RevisionStore(
483 $services->getDBLoadBalancer(),
485 $services->getMainWANObjectCache(),
486 $services->getCommentStore(),
487 $services->getContentModelStore(),
488 $services->getSlotRoleStore(),
489 $services->getMainConfig()->get( 'MultiContentRevisionSchemaMigrationStage' ),
490 $services->getActorMigration()
493 $store->setLogger( LoggerFactory
::getInstance( 'RevisionStore' ) );
495 $config = $services->getMainConfig();
496 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
501 'RevisionLookup' => function ( MediaWikiServices
$services ) {
502 return $services->getRevisionStore();
505 'RevisionFactory' => function ( MediaWikiServices
$services ) {
506 return $services->getRevisionStore();
509 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
511 return new BlobStoreFactory(
512 $services->getDBLoadBalancer(),
513 $services->getMainWANObjectCache(),
514 $services->getMainConfig(),
519 'BlobStore' => function ( MediaWikiServices
$services ) {
520 return $services->getService( '_SqlBlobStore' );
523 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
524 return $services->getBlobStoreFactory()->newSqlBlobStore();
527 'ContentModelStore' => function ( MediaWikiServices
$services ) {
528 return new NameTableStore(
529 $services->getDBLoadBalancer(),
530 $services->getMainWANObjectCache(),
531 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
536 * No strtolower normalization is added to the service as there are examples of
537 * extensions that do not stick to this assumption.
538 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
539 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
544 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
545 return new NameTableStore(
546 $services->getDBLoadBalancer(),
547 $services->getMainWANObjectCache(),
548 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
556 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) {
557 return new NameTableStore(
558 $services->getDBLoadBalancer(),
559 $services->getMainWANObjectCache(),
560 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
566 function ( $insertFields ) {
567 $insertFields['ctd_user_defined'] = 0;
568 $insertFields['ctd_count'] = 0;
569 return $insertFields;
574 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
576 $authManager = AuthManager
::singleton();
577 $linkRenderer = $services->getLinkRendererFactory()->create();
578 $config = $services->getMainConfig();
579 $factory = new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
580 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
585 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
586 return new \MediaWiki\Http\
HttpRequestFactory();
589 'CommentStore' => function ( MediaWikiServices
$services ) {
591 return new CommentStore(
593 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
597 'ActorMigration' => function ( MediaWikiServices
$services ) {
598 return new ActorMigration(
599 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
603 ///////////////////////////////////////////////////////////////////////////
604 // NOTE: When adding a service here, don't forget to add a getter function
605 // in the MediaWikiServices class. The convenience getter should just call
606 // $this->getService( 'FooBarService' ).
607 ///////////////////////////////////////////////////////////////////////////