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\Interwiki\InterwikiLookup
;
44 use MediaWiki\Linker\LinkRenderer
;
45 use MediaWiki\Linker\LinkRendererFactory
;
46 use MediaWiki\Logger\LoggerFactory
;
47 use MediaWiki\MediaWikiServices
;
48 use MediaWiki\Preferences\PreferencesFactory
;
49 use MediaWiki\Preferences\DefaultPreferencesFactory
;
50 use MediaWiki\Shell\CommandFactory
;
51 use MediaWiki\Storage\BlobStore
;
52 use MediaWiki\Storage\BlobStoreFactory
;
53 use MediaWiki\Storage\NameTableStore
;
54 use MediaWiki\Storage\RevisionFactory
;
55 use MediaWiki\Storage\RevisionLookup
;
56 use MediaWiki\Storage\RevisionStore
;
57 use MediaWiki\Storage\RevisionStoreFactory
;
58 use MediaWiki\Storage\SqlBlobStore
;
61 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
62 return new ActorMigration(
63 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
67 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
68 return $services->getService( '_SqlBlobStore' );
71 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
72 return new BlobStoreFactory(
73 $services->getDBLoadBalancer(),
74 $services->getMainWANObjectCache(),
75 $services->getMainConfig(),
76 $services->getContentLanguage()
80 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
81 return new NameTableStore(
82 $services->getDBLoadBalancer(),
83 $services->getMainWANObjectCache(),
84 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
90 function ( $insertFields ) {
91 $insertFields['ctd_user_defined'] = 0;
92 $insertFields['ctd_count'] = 0;
98 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
99 return new CommentStore(
100 $services->getContentLanguage(),
101 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
105 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
106 // Use the bootstrap config to initialize the ConfigFactory.
107 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
108 $factory = new ConfigFactory();
110 foreach ( $registry as $name => $callback ) {
111 $factory->register( $name, $callback );
116 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
117 return new ConfigRepository( $services->getConfigFactory() );
120 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
121 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
124 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
125 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
128 'ContentModelStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
129 return new NameTableStore(
130 $services->getDBLoadBalancer(),
131 $services->getMainWANObjectCache(),
132 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
137 * No strtolower normalization is added to the service as there are examples of
138 * extensions that do not stick to this assumption.
139 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
140 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
145 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
146 $config = $services->getMainConfig();
148 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
150 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
153 // In HKDF, the context can be known to the attacker, but this will
154 // keep simultaneous runs from producing the same output.
155 $context = [ microtime(), getmypid(), gethostname() ];
157 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
158 $cache = $services->getLocalServerObjectCache();
159 if ( $cache instanceof EmptyBagOStuff
) {
160 $cache = ObjectCache
::getLocalClusterInstance();
163 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
166 'CryptRand' => function () : CryptRand
{
167 return new CryptRand();
170 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
171 // just return the default LB from the DBLoadBalancerFactory service
172 return $services->getDBLoadBalancerFactory()->getMainLB();
175 'DBLoadBalancerFactory' =>
176 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
177 $mainConfig = $services->getMainConfig();
179 $lbConf = MWLBFactory
::applyDefaultConfig(
180 $mainConfig->get( 'LBFactoryConf' ),
182 $services->getConfiguredReadOnlyMode()
184 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
186 $instance = new $class( $lbConf );
187 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
192 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
193 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
196 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
197 $config = $services->getMainConfig();
199 return new ExternalStoreFactory(
200 $config->get( 'ExternalStores' )
204 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
205 return new GenderCache();
208 'HttpRequestFactory' =>
209 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
210 return new \MediaWiki\Http\
HttpRequestFactory();
213 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
214 $config = $services->getMainConfig();
215 return new ClassicInterwikiLookup(
216 $services->getContentLanguage(),
217 $services->getMainWANObjectCache(),
218 $config->get( 'InterwikiExpiry' ),
219 $config->get( 'InterwikiCache' ),
220 $config->get( 'InterwikiScopes' ),
221 $config->get( 'InterwikiFallbackSite' )
225 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
226 return new LinkCache(
227 $services->getTitleFormatter(),
228 $services->getMainWANObjectCache()
232 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
235 if ( defined( 'MW_NO_SESSION' ) ) {
236 return $services->getLinkRendererFactory()->create();
238 return $services->getLinkRendererFactory()->createForUser( $wgUser );
242 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
243 return new LinkRendererFactory(
244 $services->getTitleFormatter(),
245 $services->getLinkCache()
249 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
250 $cacheId = \ObjectCache
::detectLocalServerCache();
251 return \ObjectCache
::newFromId( $cacheId );
254 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
255 return new MagicWordFactory( $services->getContentLanguage() );
258 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
259 // Use the 'main' config from the ConfigFactory service.
260 return $services->getConfigFactory()->makeConfig( 'main' );
263 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
264 $mainConfig = $services->getMainConfig();
266 $id = $mainConfig->get( 'MainStash' );
267 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
268 throw new UnexpectedValueException(
269 "Cache type \"$id\" is not present in \$wgObjectCaches." );
272 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
275 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
276 $mainConfig = $services->getMainConfig();
278 $id = $mainConfig->get( 'MainWANCache' );
279 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
280 throw new UnexpectedValueException(
281 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
284 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
285 $objectCacheId = $params['cacheId'];
286 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
287 throw new UnexpectedValueException(
288 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
290 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
292 return \ObjectCache
::newWANCacheFromParams( $params );
295 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
296 return new MediaHandlerFactory(
297 $services->getMainConfig()->get( 'MediaHandlers' )
301 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
302 $logger = LoggerFactory
::getInstance( 'Mime' );
303 $mainConfig = $services->getMainConfig();
305 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
306 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
307 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
309 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
311 $deja = new DjVuImage( $file );
312 if ( $deja->isValid() ) {
313 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
314 $mime = 'image/vnd.djvu';
318 // Some strings by reference for performance - assuming well-behaved hooks
320 'MimeMagicGuessFromContent',
321 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
324 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
325 // Media handling extensions can improve the MIME detected
326 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
328 'initCallback' => function ( $mimeAnalyzer ) {
329 // Allow media handling extensions adding MIME-types and MIME-info
330 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
335 if ( $params['infoFile'] === 'includes/mime.info' ) {
336 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
339 if ( $params['typeFile'] === 'includes/mime.types' ) {
340 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
343 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
344 if ( $detectorCmd ) {
345 $factory = $services->getShellCommandFactory();
346 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
347 $result = $factory->create()
348 // $wgMimeDetectorCommand can contain commands with parameters
349 ->unsafeParams( $detectorCmd )
352 return $result->getStdout();
356 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
357 return new MimeMagic( $params );
360 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
361 return new ImportableOldRevisionImporter(
363 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
364 $services->getDBLoadBalancer()
368 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
369 return $services->getParserFactory()->create();
372 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
373 $config = $services->getMainConfig();
374 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
375 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
377 return new ParserCache(
379 $config->get( 'CacheEpoch' )
383 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
384 return new ParserFactory(
385 $services->getMainConfig()->get( 'ParserConf' ),
386 $services->getMagicWordFactory(),
387 $services->getContentLanguage(),
392 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
393 $config = $services->getMainConfig();
394 return new PasswordFactory(
395 $config->get( 'PasswordConfig' ),
396 $config->get( 'PasswordDefault' )
400 'PerDbNameStatsdDataFactory' =>
401 function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
402 $config = $services->getMainConfig();
403 $wiki = $config->get( 'DBname' );
404 return new BufferingStatsdDataFactory(
405 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . '.' . $wiki
409 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
410 $factory = new DefaultPreferencesFactory(
411 $services->getMainConfig(),
412 $services->getContentLanguage(),
413 AuthManager
::singleton(),
414 $services->getLinkRendererFactory()->create()
416 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
421 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
422 $mainConfig = $services->getMainConfig();
423 return new ProxyLookup(
424 $mainConfig->get( 'SquidServers' ),
425 $mainConfig->get( 'SquidServersNoPurge' )
429 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
430 return new ReadOnlyMode(
431 $services->getConfiguredReadOnlyMode(),
432 $services->getDBLoadBalancer()
436 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
437 return $services->getRevisionStore();
440 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
441 return $services->getRevisionStore();
444 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
445 return $services->getRevisionStoreFactory()->getRevisionStore();
448 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
449 $config = $services->getMainConfig();
450 $store = new RevisionStoreFactory(
451 $services->getDBLoadBalancerFactory(),
452 $services->getBlobStoreFactory(),
453 $services->getMainWANObjectCache(),
454 $services->getCommentStore(),
455 $services->getActorMigration(),
456 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
457 LoggerFactory
::getProvider(),
458 $config->get( 'ContentHandlerUseDB' )
464 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
465 return new SearchEngineConfig( $services->getMainConfig(),
466 $services->getContentLanguage() );
469 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
470 return new SearchEngineFactory( $services->getSearchEngineConfig() );
473 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
474 $config = $services->getMainConfig();
477 'time' => $config->get( 'MaxShellTime' ),
478 'walltime' => $config->get( 'MaxShellWallClockTime' ),
479 'memory' => $config->get( 'MaxShellMemory' ),
480 'filesize' => $config->get( 'MaxShellFileSize' ),
482 $cgroup = $config->get( 'ShellCgroup' );
483 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
485 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
486 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
487 $factory->logStderr();
492 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
493 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
495 if ( $cacheFile !== false ) {
496 return new FileBasedSiteLookup( $cacheFile );
498 // Use the default SiteStore as the SiteLookup implementation for now
499 return $services->getSiteStore();
503 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
504 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
506 // TODO: replace wfGetCache with a CacheFactory service.
507 // TODO: replace wfIsHHVM with a capabilities service.
508 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
510 return new CachingSiteStore( $rawSiteStore, $cache );
513 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
514 $factory = new SkinFactory();
516 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
518 foreach ( $names as $name => $skin ) {
519 $factory->register( $name, $skin, function () use ( $name, $skin ) {
520 $class = "Skin$skin";
521 return new $class( $name );
524 // Register a hidden "fallback" skin
525 $factory->register( 'fallback', 'Fallback', function () {
526 return new SkinFallback
;
528 // Register a hidden skin for api output
529 $factory->register( 'apioutput', 'ApiOutput', function () {
536 'SlotRoleStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
537 return new NameTableStore(
538 $services->getDBLoadBalancer(),
539 $services->getMainWANObjectCache(),
540 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
548 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
549 return new BufferingStatsdDataFactory(
550 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
554 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
555 return $services->getService( '_MediaWikiTitleCodec' );
558 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
559 return $services->getService( '_MediaWikiTitleCodec' );
562 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
563 return new ImportableUploadRevisionImporter(
564 $services->getMainConfig()->get( 'EnableUploads' ),
565 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
569 'VirtualRESTServiceClient' =>
570 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
571 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
573 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
574 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
575 $class = $serviceConfig['class'];
576 // Merge in the global defaults
577 $constructArg = $serviceConfig['options'] ??
[];
578 $constructArg +
= $config['global'];
579 // Make the VRS service available at the mount point
580 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
586 'WatchedItemQueryService' =>
587 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
588 return new WatchedItemQueryService(
589 $services->getDBLoadBalancer(),
590 $services->getCommentStore(),
591 $services->getActorMigration()
595 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
596 $store = new WatchedItemStore(
597 $services->getDBLoadBalancer(),
598 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
599 $services->getReadOnlyMode(),
600 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
602 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
604 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
605 $store = new NoWriteWatchedItemStore( $store );
611 'WikiRevisionOldRevisionImporterNoUpdates' =>
612 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
613 return new ImportableOldRevisionImporter(
615 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
616 $services->getDBLoadBalancer()
620 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
621 return new MediaWikiTitleCodec(
622 $services->getContentLanguage(),
623 $services->getGenderCache(),
624 $services->getMainConfig()->get( 'LocalInterwikis' ),
625 $services->getInterwikiLookup()
629 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
630 return $services->getBlobStoreFactory()->newSqlBlobStore();
633 ///////////////////////////////////////////////////////////////////////////
634 // NOTE: When adding a service here, don't forget to add a getter function
635 // in the MediaWikiServices class. The convenience getter should just call
636 // $this->getService( 'FooBarService' ).
637 ///////////////////////////////////////////////////////////////////////////