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\RevisionStore
;
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 return new $class( $lbConf );
67 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
68 // just return the default LB from the DBLoadBalancerFactory service
69 return $services->getDBLoadBalancerFactory()->getMainLB();
72 'SiteStore' => function ( MediaWikiServices
$services ) {
73 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
75 // TODO: replace wfGetCache with a CacheFactory service.
76 // TODO: replace wfIsHHVM with a capabilities service.
77 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
79 return new CachingSiteStore( $rawSiteStore, $cache );
82 'SiteLookup' => function ( MediaWikiServices
$services ) {
83 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
85 if ( $cacheFile !== false ) {
86 return new FileBasedSiteLookup( $cacheFile );
88 // Use the default SiteStore as the SiteLookup implementation for now
89 return $services->getSiteStore();
93 'ConfigFactory' => function ( MediaWikiServices
$services ) {
94 // Use the bootstrap config to initialize the ConfigFactory.
95 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
96 $factory = new ConfigFactory();
98 foreach ( $registry as $name => $callback ) {
99 $factory->register( $name, $callback );
104 'MainConfig' => function ( MediaWikiServices
$services ) {
105 // Use the 'main' config from the ConfigFactory service.
106 return $services->getConfigFactory()->makeConfig( 'main' );
109 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
110 global $wgContLang; // TODO: manage $wgContLang as a service
111 $config = $services->getMainConfig();
112 return new ClassicInterwikiLookup(
114 $services->getMainWANObjectCache(),
115 $config->get( 'InterwikiExpiry' ),
116 $config->get( 'InterwikiCache' ),
117 $config->get( 'InterwikiScopes' ),
118 $config->get( 'InterwikiFallbackSite' )
122 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
123 return new BufferingStatsdDataFactory(
124 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
128 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
129 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
132 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
133 return new SearchEngineFactory( $services->getSearchEngineConfig() );
136 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
138 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
141 'SkinFactory' => function ( MediaWikiServices
$services ) {
142 $factory = new SkinFactory();
144 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
146 foreach ( $names as $name => $skin ) {
147 $factory->register( $name, $skin, function () use ( $name, $skin ) {
148 $class = "Skin$skin";
149 return new $class( $name );
152 // Register a hidden "fallback" skin
153 $factory->register( 'fallback', 'Fallback', function () {
154 return new SkinFallback
;
156 // Register a hidden skin for api output
157 $factory->register( 'apioutput', 'ApiOutput', function () {
164 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
165 $store = new WatchedItemStore(
166 $services->getDBLoadBalancer(),
167 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
168 $services->getReadOnlyMode(),
169 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
171 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
173 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
174 $store = new NoWriteWatchedItemStore( $store );
180 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
181 return new WatchedItemQueryService(
182 $services->getDBLoadBalancer(),
183 $services->getCommentStore(),
184 $services->getActorMigration()
188 'CryptRand' => function ( MediaWikiServices
$services ) {
189 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
190 return new CryptRand(
192 // To try vary the system information of the state a bit more
193 // by including the system's hostname into the state
195 // It's mostly worthless but throw the wiki's id into the data
196 // for a little more variance
198 // If we have a secret key set then throw it into the state as well
199 function () use ( $secretKey ) {
200 return $secretKey ?
: '';
203 // The config file is likely the most often edited file we know should
204 // be around so include its stat info into the state.
205 // The constant with its location will almost always be defined, as
206 // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
207 // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
208 defined( 'MW_CONFIG_FILE' ) ?
[ MW_CONFIG_FILE
] : [],
209 LoggerFactory
::getInstance( 'CryptRand' )
213 'CryptHKDF' => function ( MediaWikiServices
$services ) {
214 $config = $services->getMainConfig();
216 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
218 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
221 // In HKDF, the context can be known to the attacker, but this will
222 // keep simultaneous runs from producing the same output.
223 $context = [ microtime(), getmypid(), gethostname() ];
225 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
226 $cache = $services->getLocalServerObjectCache();
227 if ( $cache instanceof EmptyBagOStuff
) {
228 $cache = ObjectCache
::getLocalClusterInstance();
231 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
232 $cache, $context, $services->getCryptRand()
236 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
237 return new MediaHandlerFactory(
238 $services->getMainConfig()->get( 'MediaHandlers' )
242 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
243 $logger = LoggerFactory
::getInstance( 'Mime' );
244 $mainConfig = $services->getMainConfig();
246 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
247 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
248 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
250 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
252 $deja = new DjVuImage( $file );
253 if ( $deja->isValid() ) {
254 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
255 $mime = 'image/vnd.djvu';
259 // Some strings by reference for performance - assuming well-behaved hooks
261 'MimeMagicGuessFromContent',
262 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
265 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
266 // Media handling extensions can improve the MIME detected
267 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
269 'initCallback' => function ( $mimeAnalyzer ) {
270 // Allow media handling extensions adding MIME-types and MIME-info
271 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
276 if ( $params['infoFile'] === 'includes/mime.info' ) {
277 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
280 if ( $params['typeFile'] === 'includes/mime.types' ) {
281 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
284 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
285 if ( $detectorCmd ) {
286 $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
287 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
291 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
292 return new MimeMagic( $params );
295 'ProxyLookup' => function ( MediaWikiServices
$services ) {
296 $mainConfig = $services->getMainConfig();
297 return new ProxyLookup(
298 $mainConfig->get( 'SquidServers' ),
299 $mainConfig->get( 'SquidServersNoPurge' )
303 'Parser' => function ( MediaWikiServices
$services ) {
304 $conf = $services->getMainConfig()->get( 'ParserConf' );
305 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
308 'ParserCache' => function ( MediaWikiServices
$services ) {
309 $config = $services->getMainConfig();
310 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
311 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
313 return new ParserCache(
315 $config->get( 'CacheEpoch' )
319 'LinkCache' => function ( MediaWikiServices
$services ) {
320 return new LinkCache(
321 $services->getTitleFormatter(),
322 $services->getMainWANObjectCache()
326 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
327 return new LinkRendererFactory(
328 $services->getTitleFormatter(),
329 $services->getLinkCache()
333 'LinkRenderer' => function ( MediaWikiServices
$services ) {
336 if ( defined( 'MW_NO_SESSION' ) ) {
337 return $services->getLinkRendererFactory()->create();
339 return $services->getLinkRendererFactory()->createForUser( $wgUser );
343 'GenderCache' => function ( MediaWikiServices
$services ) {
344 return new GenderCache();
347 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
350 return new MediaWikiTitleCodec(
352 $services->getGenderCache(),
353 $services->getMainConfig()->get( 'LocalInterwikis' )
357 'TitleFormatter' => function ( MediaWikiServices
$services ) {
358 return $services->getService( '_MediaWikiTitleCodec' );
361 'TitleParser' => function ( MediaWikiServices
$services ) {
362 return $services->getService( '_MediaWikiTitleCodec' );
365 'MainObjectStash' => function ( MediaWikiServices
$services ) {
366 $mainConfig = $services->getMainConfig();
368 $id = $mainConfig->get( 'MainStash' );
369 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
370 throw new UnexpectedValueException(
371 "Cache type \"$id\" is not present in \$wgObjectCaches." );
374 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
377 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
378 $mainConfig = $services->getMainConfig();
380 $id = $mainConfig->get( 'MainWANCache' );
381 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
382 throw new UnexpectedValueException(
383 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
386 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
387 $objectCacheId = $params['cacheId'];
388 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
389 throw new UnexpectedValueException(
390 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
392 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
394 return \ObjectCache
::newWANCacheFromParams( $params );
397 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
398 $mainConfig = $services->getMainConfig();
400 if ( function_exists( 'apc_fetch' ) ) {
402 } elseif ( function_exists( 'apcu_fetch' ) ) {
404 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
410 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
411 throw new UnexpectedValueException(
412 "Cache type \"$id\" is not present in \$wgObjectCaches." );
415 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
418 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
419 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
421 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
422 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
423 $class = $serviceConfig['class'];
424 // Merge in the global defaults
425 $constructArg = isset( $serviceConfig['options'] )
426 ?
$serviceConfig['options']
428 $constructArg +
= $config['global'];
429 // Make the VRS service available at the mount point
430 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
436 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
437 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
440 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
441 return new ReadOnlyMode(
442 $services->getConfiguredReadOnlyMode(),
443 $services->getDBLoadBalancer()
447 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
448 return new ImportableUploadRevisionImporter(
449 $services->getMainConfig()->get( 'EnableUploads' ),
450 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
454 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
455 return new ImportableOldRevisionImporter(
457 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
458 $services->getDBLoadBalancer()
462 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
463 return new ImportableOldRevisionImporter(
465 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
466 $services->getDBLoadBalancer()
470 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
471 $config = $services->getMainConfig();
474 'time' => $config->get( 'MaxShellTime' ),
475 'walltime' => $config->get( 'MaxShellWallClockTime' ),
476 'memory' => $config->get( 'MaxShellMemory' ),
477 'filesize' => $config->get( 'MaxShellFileSize' ),
479 $cgroup = $config->get( 'ShellCgroup' );
480 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
482 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
483 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
484 $factory->logStderr();
489 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
490 $config = $services->getMainConfig();
492 return new ExternalStoreFactory(
493 $config->get( 'ExternalStores' )
497 'RevisionStore' => function ( MediaWikiServices
$services ) {
498 /** @var SqlBlobStore $blobStore */
499 $blobStore = $services->getService( '_SqlBlobStore' );
501 $store = new RevisionStore(
502 $services->getDBLoadBalancer(),
504 $services->getMainWANObjectCache(),
505 $services->getCommentStore(),
506 $services->getActorMigration()
509 $store->setLogger( LoggerFactory
::getInstance( 'RevisionStore' ) );
511 $config = $services->getMainConfig();
512 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
517 'RevisionLookup' => function ( MediaWikiServices
$services ) {
518 return $services->getRevisionStore();
521 'RevisionFactory' => function ( MediaWikiServices
$services ) {
522 return $services->getRevisionStore();
525 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
527 return new BlobStoreFactory(
528 $services->getDBLoadBalancer(),
529 $services->getMainWANObjectCache(),
530 $services->getMainConfig(),
535 'BlobStore' => function ( MediaWikiServices
$services ) {
536 return $services->getService( '_SqlBlobStore' );
539 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
540 return $services->getBlobStoreFactory()->newSqlBlobStore();
543 'ContentModelStore' => function ( MediaWikiServices
$services ) {
544 return new NameTableStore(
545 $services->getDBLoadBalancer(),
546 $services->getMainWANObjectCache(),
547 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
552 * No strtolower normalization is added to the service as there are examples of
553 * extensions that do not stick to this assumption.
554 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
555 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
560 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
561 return new NameTableStore(
562 $services->getDBLoadBalancer(),
563 $services->getMainWANObjectCache(),
564 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
572 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
574 $authManager = AuthManager
::singleton();
575 $linkRenderer = $services->getLinkRendererFactory()->create();
576 $config = $services->getMainConfig();
577 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
580 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
581 return new \MediaWiki\Http\
HttpRequestFactory();
584 'CommentStore' => function ( MediaWikiServices
$services ) {
586 return new CommentStore(
588 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
592 'ActorMigration' => function ( MediaWikiServices
$services ) {
593 return new ActorMigration(
594 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
598 ///////////////////////////////////////////////////////////////////////////
599 // NOTE: When adding a service here, don't forget to add a getter function
600 // in the MediaWikiServices class. The convenience getter should just call
601 // $this->getService( 'FooBarService' ).
602 ///////////////////////////////////////////////////////////////////////////