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\Interwiki\ClassicInterwikiLookup
;
42 use MediaWiki\Linker\LinkRendererFactory
;
43 use MediaWiki\Logger\LoggerFactory
;
44 use MediaWiki\MediaWikiServices
;
45 use MediaWiki\Preferences\DefaultPreferencesFactory
;
46 use MediaWiki\Shell\CommandFactory
;
47 use MediaWiki\Storage\BlobStoreFactory
;
48 use MediaWiki\Storage\NameTableStore
;
49 use MediaWiki\Storage\RevisionStoreFactory
;
50 use MediaWiki\Storage\SqlBlobStore
;
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 'MainConfig' => function ( MediaWikiServices
$services ) {
108 // Use the 'main' config from the ConfigFactory service.
109 return $services->getConfigFactory()->makeConfig( 'main' );
112 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
113 global $wgContLang; // TODO: manage $wgContLang as a service
114 $config = $services->getMainConfig();
115 return new ClassicInterwikiLookup(
117 $services->getMainWANObjectCache(),
118 $config->get( 'InterwikiExpiry' ),
119 $config->get( 'InterwikiCache' ),
120 $config->get( 'InterwikiScopes' ),
121 $config->get( 'InterwikiFallbackSite' )
125 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
126 return new BufferingStatsdDataFactory(
127 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
131 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices
$services ) {
132 $config = $services->getMainConfig();
133 $wiki = $config->get( 'DBname' );
134 return new BufferingStatsdDataFactory(
135 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . $wiki
139 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
140 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
143 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
144 return new SearchEngineFactory( $services->getSearchEngineConfig() );
147 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
149 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
152 'SkinFactory' => function ( MediaWikiServices
$services ) {
153 $factory = new SkinFactory();
155 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
157 foreach ( $names as $name => $skin ) {
158 $factory->register( $name, $skin, function () use ( $name, $skin ) {
159 $class = "Skin$skin";
160 return new $class( $name );
163 // Register a hidden "fallback" skin
164 $factory->register( 'fallback', 'Fallback', function () {
165 return new SkinFallback
;
167 // Register a hidden skin for api output
168 $factory->register( 'apioutput', 'ApiOutput', function () {
175 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
176 $store = new WatchedItemStore(
177 $services->getDBLoadBalancer(),
178 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
179 $services->getReadOnlyMode(),
180 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
182 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
184 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
185 $store = new NoWriteWatchedItemStore( $store );
191 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
192 return new WatchedItemQueryService(
193 $services->getDBLoadBalancer(),
194 $services->getCommentStore(),
195 $services->getActorMigration()
199 'CryptRand' => function () {
200 return new CryptRand();
203 'CryptHKDF' => function ( MediaWikiServices
$services ) {
204 $config = $services->getMainConfig();
206 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
208 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
211 // In HKDF, the context can be known to the attacker, but this will
212 // keep simultaneous runs from producing the same output.
213 $context = [ microtime(), getmypid(), gethostname() ];
215 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
216 $cache = $services->getLocalServerObjectCache();
217 if ( $cache instanceof EmptyBagOStuff
) {
218 $cache = ObjectCache
::getLocalClusterInstance();
221 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
224 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
225 return new MediaHandlerFactory(
226 $services->getMainConfig()->get( 'MediaHandlers' )
230 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
231 $logger = LoggerFactory
::getInstance( 'Mime' );
232 $mainConfig = $services->getMainConfig();
234 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
235 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
236 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
238 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
240 $deja = new DjVuImage( $file );
241 if ( $deja->isValid() ) {
242 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
243 $mime = 'image/vnd.djvu';
247 // Some strings by reference for performance - assuming well-behaved hooks
249 'MimeMagicGuessFromContent',
250 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
253 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
254 // Media handling extensions can improve the MIME detected
255 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
257 'initCallback' => function ( $mimeAnalyzer ) {
258 // Allow media handling extensions adding MIME-types and MIME-info
259 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
264 if ( $params['infoFile'] === 'includes/mime.info' ) {
265 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
268 if ( $params['typeFile'] === 'includes/mime.types' ) {
269 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
272 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
273 if ( $detectorCmd ) {
274 $factory = $services->getShellCommandFactory();
275 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
276 $result = $factory->create()
277 // $wgMimeDetectorCommand can contain commands with parameters
278 ->unsafeParams( $detectorCmd )
281 return $result->getStdout();
285 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
286 return new MimeMagic( $params );
289 'ProxyLookup' => function ( MediaWikiServices
$services ) {
290 $mainConfig = $services->getMainConfig();
291 return new ProxyLookup(
292 $mainConfig->get( 'SquidServers' ),
293 $mainConfig->get( 'SquidServersNoPurge' )
297 'Parser' => function ( MediaWikiServices
$services ) {
298 $conf = $services->getMainConfig()->get( 'ParserConf' );
299 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
302 'ParserCache' => function ( MediaWikiServices
$services ) {
303 $config = $services->getMainConfig();
304 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
305 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
307 return new ParserCache(
309 $config->get( 'CacheEpoch' )
313 'LinkCache' => function ( MediaWikiServices
$services ) {
314 return new LinkCache(
315 $services->getTitleFormatter(),
316 $services->getMainWANObjectCache()
320 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
321 return new LinkRendererFactory(
322 $services->getTitleFormatter(),
323 $services->getLinkCache()
327 'LinkRenderer' => function ( MediaWikiServices
$services ) {
330 if ( defined( 'MW_NO_SESSION' ) ) {
331 return $services->getLinkRendererFactory()->create();
333 return $services->getLinkRendererFactory()->createForUser( $wgUser );
337 'GenderCache' => function ( MediaWikiServices
$services ) {
338 return new GenderCache();
341 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
344 return new MediaWikiTitleCodec(
346 $services->getGenderCache(),
347 $services->getMainConfig()->get( 'LocalInterwikis' )
351 'TitleFormatter' => function ( MediaWikiServices
$services ) {
352 return $services->getService( '_MediaWikiTitleCodec' );
355 'TitleParser' => function ( MediaWikiServices
$services ) {
356 return $services->getService( '_MediaWikiTitleCodec' );
359 'MainObjectStash' => function ( MediaWikiServices
$services ) {
360 $mainConfig = $services->getMainConfig();
362 $id = $mainConfig->get( 'MainStash' );
363 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
364 throw new UnexpectedValueException(
365 "Cache type \"$id\" is not present in \$wgObjectCaches." );
368 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
371 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
372 $mainConfig = $services->getMainConfig();
374 $id = $mainConfig->get( 'MainWANCache' );
375 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
376 throw new UnexpectedValueException(
377 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
380 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
381 $objectCacheId = $params['cacheId'];
382 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
383 throw new UnexpectedValueException(
384 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
386 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
388 return \ObjectCache
::newWANCacheFromParams( $params );
391 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
392 $cacheId = \ObjectCache
::detectLocalServerCache();
393 return \ObjectCache
::newFromId( $cacheId );
396 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
397 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
399 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
400 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
401 $class = $serviceConfig['class'];
402 // Merge in the global defaults
403 $constructArg = $serviceConfig['options'] ??
[];
404 $constructArg +
= $config['global'];
405 // Make the VRS service available at the mount point
406 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
412 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
413 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
416 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
417 return new ReadOnlyMode(
418 $services->getConfiguredReadOnlyMode(),
419 $services->getDBLoadBalancer()
423 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
424 return new ImportableUploadRevisionImporter(
425 $services->getMainConfig()->get( 'EnableUploads' ),
426 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
430 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
431 return new ImportableOldRevisionImporter(
433 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
434 $services->getDBLoadBalancer()
438 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
439 return new ImportableOldRevisionImporter(
441 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
442 $services->getDBLoadBalancer()
446 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
447 $config = $services->getMainConfig();
450 'time' => $config->get( 'MaxShellTime' ),
451 'walltime' => $config->get( 'MaxShellWallClockTime' ),
452 'memory' => $config->get( 'MaxShellMemory' ),
453 'filesize' => $config->get( 'MaxShellFileSize' ),
455 $cgroup = $config->get( 'ShellCgroup' );
456 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
458 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
459 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
460 $factory->logStderr();
465 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
466 $config = $services->getMainConfig();
468 return new ExternalStoreFactory(
469 $config->get( 'ExternalStores' )
473 'RevisionStore' => function ( MediaWikiServices
$services ) {
474 return $services->getRevisionStoreFactory()->getRevisionStore();
477 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) {
478 /** @var SqlBlobStore $blobStore */
479 $blobStore = $services->getService( '_SqlBlobStore' );
480 $config = $services->getMainConfig();
482 $store = new RevisionStoreFactory(
483 $services->getDBLoadBalancer(),
485 $services->getMainWANObjectCache(),
486 $services->getCommentStore(),
487 $services->getContentModelStore(),
488 $services->getSlotRoleStore(),
489 $services->getMainConfig()->get( 'MultiContentRevisionSchemaMigrationStage' ),
490 $services->getActorMigration(),
491 LoggerFactory
::getInstance( 'RevisionStore' ),
492 $config->get( 'ContentHandlerUseDB' )
498 'RevisionLookup' => function ( MediaWikiServices
$services ) {
499 return $services->getRevisionStore();
502 'RevisionFactory' => function ( MediaWikiServices
$services ) {
503 return $services->getRevisionStore();
506 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
508 return new BlobStoreFactory(
509 $services->getDBLoadBalancer(),
510 $services->getMainWANObjectCache(),
511 $services->getMainConfig(),
516 'BlobStore' => function ( MediaWikiServices
$services ) {
517 return $services->getService( '_SqlBlobStore' );
520 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
521 return $services->getBlobStoreFactory()->newSqlBlobStore();
524 'ContentModelStore' => function ( MediaWikiServices
$services ) {
525 return new NameTableStore(
526 $services->getDBLoadBalancer(),
527 $services->getMainWANObjectCache(),
528 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
533 * No strtolower normalization is added to the service as there are examples of
534 * extensions that do not stick to this assumption.
535 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
536 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
541 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
542 return new NameTableStore(
543 $services->getDBLoadBalancer(),
544 $services->getMainWANObjectCache(),
545 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
553 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) {
554 return new NameTableStore(
555 $services->getDBLoadBalancer(),
556 $services->getMainWANObjectCache(),
557 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
563 function ( $insertFields ) {
564 $insertFields['ctd_user_defined'] = 0;
565 $insertFields['ctd_count'] = 0;
566 return $insertFields;
571 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
573 $authManager = AuthManager
::singleton();
574 $linkRenderer = $services->getLinkRendererFactory()->create();
575 $config = $services->getMainConfig();
576 $factory = new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
577 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
582 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
583 return new \MediaWiki\Http\
HttpRequestFactory();
586 'CommentStore' => function ( MediaWikiServices
$services ) {
588 return new CommentStore(
590 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
594 'ActorMigration' => function ( MediaWikiServices
$services ) {
595 return new ActorMigration(
596 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
600 ///////////////////////////////////////////////////////////////////////////
601 // NOTE: When adding a service here, don't forget to add a getter function
602 // in the MediaWikiServices class. The convenience getter should just call
603 // $this->getService( 'FooBarService' ).
604 ///////////////////////////////////////////////////////////////////////////