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 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
132 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
135 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
136 return new SearchEngineFactory( $services->getSearchEngineConfig() );
139 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
141 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
144 'SkinFactory' => function ( MediaWikiServices
$services ) {
145 $factory = new SkinFactory();
147 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
149 foreach ( $names as $name => $skin ) {
150 $factory->register( $name, $skin, function () use ( $name, $skin ) {
151 $class = "Skin$skin";
152 return new $class( $name );
155 // Register a hidden "fallback" skin
156 $factory->register( 'fallback', 'Fallback', function () {
157 return new SkinFallback
;
159 // Register a hidden skin for api output
160 $factory->register( 'apioutput', 'ApiOutput', function () {
167 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
168 $store = new WatchedItemStore(
169 $services->getDBLoadBalancer(),
170 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
171 $services->getReadOnlyMode(),
172 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
174 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
176 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
177 $store = new NoWriteWatchedItemStore( $store );
183 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
184 return new WatchedItemQueryService(
185 $services->getDBLoadBalancer(),
186 $services->getCommentStore(),
187 $services->getActorMigration()
191 'CryptRand' => function () {
192 return new CryptRand();
195 'CryptHKDF' => function ( MediaWikiServices
$services ) {
196 $config = $services->getMainConfig();
198 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
200 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
203 // In HKDF, the context can be known to the attacker, but this will
204 // keep simultaneous runs from producing the same output.
205 $context = [ microtime(), getmypid(), gethostname() ];
207 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
208 $cache = $services->getLocalServerObjectCache();
209 if ( $cache instanceof EmptyBagOStuff
) {
210 $cache = ObjectCache
::getLocalClusterInstance();
213 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
216 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
217 return new MediaHandlerFactory(
218 $services->getMainConfig()->get( 'MediaHandlers' )
222 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
223 $logger = LoggerFactory
::getInstance( 'Mime' );
224 $mainConfig = $services->getMainConfig();
226 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
227 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
228 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
230 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
232 $deja = new DjVuImage( $file );
233 if ( $deja->isValid() ) {
234 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
235 $mime = 'image/vnd.djvu';
239 // Some strings by reference for performance - assuming well-behaved hooks
241 'MimeMagicGuessFromContent',
242 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
245 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
246 // Media handling extensions can improve the MIME detected
247 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
249 'initCallback' => function ( $mimeAnalyzer ) {
250 // Allow media handling extensions adding MIME-types and MIME-info
251 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
256 if ( $params['infoFile'] === 'includes/mime.info' ) {
257 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
260 if ( $params['typeFile'] === 'includes/mime.types' ) {
261 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
264 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
265 if ( $detectorCmd ) {
266 $factory = $services->getShellCommandFactory();
267 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
268 $result = $factory->create()
269 // $wgMimeDetectorCommand can contain commands with parameters
270 ->unsafeParams( $detectorCmd )
273 return $result->getStdout();
277 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
278 return new MimeMagic( $params );
281 'ProxyLookup' => function ( MediaWikiServices
$services ) {
282 $mainConfig = $services->getMainConfig();
283 return new ProxyLookup(
284 $mainConfig->get( 'SquidServers' ),
285 $mainConfig->get( 'SquidServersNoPurge' )
289 'Parser' => function ( MediaWikiServices
$services ) {
290 $conf = $services->getMainConfig()->get( 'ParserConf' );
291 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
294 'ParserCache' => function ( MediaWikiServices
$services ) {
295 $config = $services->getMainConfig();
296 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
297 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
299 return new ParserCache(
301 $config->get( 'CacheEpoch' )
305 'LinkCache' => function ( MediaWikiServices
$services ) {
306 return new LinkCache(
307 $services->getTitleFormatter(),
308 $services->getMainWANObjectCache()
312 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
313 return new LinkRendererFactory(
314 $services->getTitleFormatter(),
315 $services->getLinkCache()
319 'LinkRenderer' => function ( MediaWikiServices
$services ) {
322 if ( defined( 'MW_NO_SESSION' ) ) {
323 return $services->getLinkRendererFactory()->create();
325 return $services->getLinkRendererFactory()->createForUser( $wgUser );
329 'GenderCache' => function ( MediaWikiServices
$services ) {
330 return new GenderCache();
333 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
336 return new MediaWikiTitleCodec(
338 $services->getGenderCache(),
339 $services->getMainConfig()->get( 'LocalInterwikis' )
343 'TitleFormatter' => function ( MediaWikiServices
$services ) {
344 return $services->getService( '_MediaWikiTitleCodec' );
347 'TitleParser' => function ( MediaWikiServices
$services ) {
348 return $services->getService( '_MediaWikiTitleCodec' );
351 'MainObjectStash' => function ( MediaWikiServices
$services ) {
352 $mainConfig = $services->getMainConfig();
354 $id = $mainConfig->get( 'MainStash' );
355 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
356 throw new UnexpectedValueException(
357 "Cache type \"$id\" is not present in \$wgObjectCaches." );
360 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
363 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
364 $mainConfig = $services->getMainConfig();
366 $id = $mainConfig->get( 'MainWANCache' );
367 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
368 throw new UnexpectedValueException(
369 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
372 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
373 $objectCacheId = $params['cacheId'];
374 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
375 throw new UnexpectedValueException(
376 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
378 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
380 return \ObjectCache
::newWANCacheFromParams( $params );
383 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
384 $cacheId = \ObjectCache
::detectLocalServerCache();
385 return \ObjectCache
::newFromId( $cacheId );
388 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
389 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
391 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
392 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
393 $class = $serviceConfig['class'];
394 // Merge in the global defaults
395 $constructArg = $serviceConfig['options'] ??
[];
396 $constructArg +
= $config['global'];
397 // Make the VRS service available at the mount point
398 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
404 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
405 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
408 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
409 return new ReadOnlyMode(
410 $services->getConfiguredReadOnlyMode(),
411 $services->getDBLoadBalancer()
415 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
416 return new ImportableUploadRevisionImporter(
417 $services->getMainConfig()->get( 'EnableUploads' ),
418 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
422 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
423 return new ImportableOldRevisionImporter(
425 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
426 $services->getDBLoadBalancer()
430 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
431 return new ImportableOldRevisionImporter(
433 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
434 $services->getDBLoadBalancer()
438 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
439 $config = $services->getMainConfig();
442 'time' => $config->get( 'MaxShellTime' ),
443 'walltime' => $config->get( 'MaxShellWallClockTime' ),
444 'memory' => $config->get( 'MaxShellMemory' ),
445 'filesize' => $config->get( 'MaxShellFileSize' ),
447 $cgroup = $config->get( 'ShellCgroup' );
448 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
450 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
451 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
452 $factory->logStderr();
457 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
458 $config = $services->getMainConfig();
460 return new ExternalStoreFactory(
461 $config->get( 'ExternalStores' )
465 'RevisionStore' => function ( MediaWikiServices
$services ) {
466 return $services->getRevisionStoreFactory()->getRevisionStore();
469 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) {
470 /** @var SqlBlobStore $blobStore */
471 $blobStore = $services->getService( '_SqlBlobStore' );
472 $config = $services->getMainConfig();
474 $store = new RevisionStoreFactory(
475 $services->getDBLoadBalancer(),
477 $services->getMainWANObjectCache(),
478 $services->getCommentStore(),
479 $services->getContentModelStore(),
480 $services->getSlotRoleStore(),
481 $services->getMainConfig()->get( 'MultiContentRevisionSchemaMigrationStage' ),
482 $services->getActorMigration(),
483 LoggerFactory
::getInstance( 'RevisionStore' ),
484 $config->get( 'ContentHandlerUseDB' )
490 'RevisionLookup' => function ( MediaWikiServices
$services ) {
491 return $services->getRevisionStore();
494 'RevisionFactory' => function ( MediaWikiServices
$services ) {
495 return $services->getRevisionStore();
498 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
500 return new BlobStoreFactory(
501 $services->getDBLoadBalancer(),
502 $services->getMainWANObjectCache(),
503 $services->getMainConfig(),
508 'BlobStore' => function ( MediaWikiServices
$services ) {
509 return $services->getService( '_SqlBlobStore' );
512 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
513 return $services->getBlobStoreFactory()->newSqlBlobStore();
516 'ContentModelStore' => function ( MediaWikiServices
$services ) {
517 return new NameTableStore(
518 $services->getDBLoadBalancer(),
519 $services->getMainWANObjectCache(),
520 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
525 * No strtolower normalization is added to the service as there are examples of
526 * extensions that do not stick to this assumption.
527 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
528 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
533 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
534 return new NameTableStore(
535 $services->getDBLoadBalancer(),
536 $services->getMainWANObjectCache(),
537 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
545 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) {
546 return new NameTableStore(
547 $services->getDBLoadBalancer(),
548 $services->getMainWANObjectCache(),
549 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
555 function ( $insertFields ) {
556 $insertFields['ctd_user_defined'] = 0;
557 $insertFields['ctd_count'] = 0;
558 return $insertFields;
563 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
565 $authManager = AuthManager
::singleton();
566 $linkRenderer = $services->getLinkRendererFactory()->create();
567 $config = $services->getMainConfig();
568 $factory = new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
569 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
574 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
575 return new \MediaWiki\Http\
HttpRequestFactory();
578 'CommentStore' => function ( MediaWikiServices
$services ) {
580 return new CommentStore(
582 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
586 'ActorMigration' => function ( MediaWikiServices
$services ) {
587 return new ActorMigration(
588 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
592 ///////////////////////////////////////////////////////////////////////////
593 // NOTE: When adding a service here, don't forget to add a getter function
594 // in the MediaWikiServices class. The convenience getter should just call
595 // $this->getService( 'FooBarService' ).
596 ///////////////////////////////////////////////////////////////////////////