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\Special\SpecialPageFactory
;
52 use MediaWiki\Storage\BlobStore
;
53 use MediaWiki\Storage\BlobStoreFactory
;
54 use MediaWiki\Storage\NameTableStore
;
55 use MediaWiki\Storage\RevisionFactory
;
56 use MediaWiki\Storage\RevisionLookup
;
57 use MediaWiki\Storage\RevisionStore
;
58 use MediaWiki\Storage\RevisionStoreFactory
;
59 use MediaWiki\Storage\SqlBlobStore
;
62 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
63 return new ActorMigration(
64 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
68 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
69 return $services->getService( '_SqlBlobStore' );
72 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
73 return new BlobStoreFactory(
74 $services->getDBLoadBalancer(),
75 $services->getMainWANObjectCache(),
76 $services->getMainConfig(),
77 $services->getContentLanguage()
81 'ChangeTagDefStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
82 return new NameTableStore(
83 $services->getDBLoadBalancer(),
84 $services->getMainWANObjectCache(),
85 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
91 function ( $insertFields ) {
92 $insertFields['ctd_user_defined'] = 0;
93 $insertFields['ctd_count'] = 0;
99 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
100 return new CommentStore(
101 $services->getContentLanguage(),
102 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
106 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
107 // Use the bootstrap config to initialize the ConfigFactory.
108 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
109 $factory = new ConfigFactory();
111 foreach ( $registry as $name => $callback ) {
112 $factory->register( $name, $callback );
117 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
118 return new ConfigRepository( $services->getConfigFactory() );
121 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
122 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
125 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
126 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
129 'ContentModelStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
130 return new NameTableStore(
131 $services->getDBLoadBalancer(),
132 $services->getMainWANObjectCache(),
133 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
138 * No strtolower normalization is added to the service as there are examples of
139 * extensions that do not stick to this assumption.
140 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
141 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
146 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
147 $config = $services->getMainConfig();
149 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
151 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
154 // In HKDF, the context can be known to the attacker, but this will
155 // keep simultaneous runs from producing the same output.
156 $context = [ microtime(), getmypid(), gethostname() ];
158 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
159 $cache = $services->getLocalServerObjectCache();
160 if ( $cache instanceof EmptyBagOStuff
) {
161 $cache = ObjectCache
::getLocalClusterInstance();
164 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
167 'CryptRand' => function () : CryptRand
{
168 return new CryptRand();
171 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
172 // just return the default LB from the DBLoadBalancerFactory service
173 return $services->getDBLoadBalancerFactory()->getMainLB();
176 'DBLoadBalancerFactory' =>
177 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
178 $mainConfig = $services->getMainConfig();
180 $lbConf = MWLBFactory
::applyDefaultConfig(
181 $mainConfig->get( 'LBFactoryConf' ),
183 $services->getConfiguredReadOnlyMode()
185 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
187 $instance = new $class( $lbConf );
188 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
193 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
194 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
197 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
198 $config = $services->getMainConfig();
200 return new ExternalStoreFactory(
201 $config->get( 'ExternalStores' )
205 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
206 return new GenderCache();
209 'HttpRequestFactory' =>
210 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
211 return new \MediaWiki\Http\
HttpRequestFactory();
214 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
215 $config = $services->getMainConfig();
216 return new ClassicInterwikiLookup(
217 $services->getContentLanguage(),
218 $services->getMainWANObjectCache(),
219 $config->get( 'InterwikiExpiry' ),
220 $config->get( 'InterwikiCache' ),
221 $config->get( 'InterwikiScopes' ),
222 $config->get( 'InterwikiFallbackSite' )
226 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
227 return new LinkCache(
228 $services->getTitleFormatter(),
229 $services->getMainWANObjectCache()
233 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
236 if ( defined( 'MW_NO_SESSION' ) ) {
237 return $services->getLinkRendererFactory()->create();
239 return $services->getLinkRendererFactory()->createForUser( $wgUser );
243 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
244 return new LinkRendererFactory(
245 $services->getTitleFormatter(),
246 $services->getLinkCache()
250 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
251 $cacheId = \ObjectCache
::detectLocalServerCache();
252 return \ObjectCache
::newFromId( $cacheId );
255 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
256 return new MagicWordFactory( $services->getContentLanguage() );
259 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
260 // Use the 'main' config from the ConfigFactory service.
261 return $services->getConfigFactory()->makeConfig( 'main' );
264 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
265 $mainConfig = $services->getMainConfig();
267 $id = $mainConfig->get( 'MainStash' );
268 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
269 throw new UnexpectedValueException(
270 "Cache type \"$id\" is not present in \$wgObjectCaches." );
273 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
276 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
277 $mainConfig = $services->getMainConfig();
279 $id = $mainConfig->get( 'MainWANCache' );
280 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
281 throw new UnexpectedValueException(
282 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
285 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
286 $objectCacheId = $params['cacheId'];
287 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
288 throw new UnexpectedValueException(
289 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
291 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
293 return \ObjectCache
::newWANCacheFromParams( $params );
296 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
297 return new MediaHandlerFactory(
298 $services->getMainConfig()->get( 'MediaHandlers' )
302 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
303 $logger = LoggerFactory
::getInstance( 'Mime' );
304 $mainConfig = $services->getMainConfig();
306 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
307 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
308 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
310 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
312 $deja = new DjVuImage( $file );
313 if ( $deja->isValid() ) {
314 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
315 $mime = 'image/vnd.djvu';
319 // Some strings by reference for performance - assuming well-behaved hooks
321 'MimeMagicGuessFromContent',
322 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
325 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
326 // Media handling extensions can improve the MIME detected
327 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
329 'initCallback' => function ( $mimeAnalyzer ) {
330 // Allow media handling extensions adding MIME-types and MIME-info
331 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
336 if ( $params['infoFile'] === 'includes/mime.info' ) {
337 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
340 if ( $params['typeFile'] === 'includes/mime.types' ) {
341 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
344 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
345 if ( $detectorCmd ) {
346 $factory = $services->getShellCommandFactory();
347 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
348 $result = $factory->create()
349 // $wgMimeDetectorCommand can contain commands with parameters
350 ->unsafeParams( $detectorCmd )
353 return $result->getStdout();
357 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
358 return new MimeMagic( $params );
361 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
362 return new ImportableOldRevisionImporter(
364 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
365 $services->getDBLoadBalancer()
369 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
370 return $services->getParserFactory()->create();
373 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
374 $config = $services->getMainConfig();
375 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
376 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
378 return new ParserCache(
380 $config->get( 'CacheEpoch' )
384 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
385 return new ParserFactory(
386 $services->getMainConfig()->get( 'ParserConf' ),
387 $services->getMagicWordFactory(),
388 $services->getContentLanguage(),
393 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
394 $config = $services->getMainConfig();
395 return new PasswordFactory(
396 $config->get( 'PasswordConfig' ),
397 $config->get( 'PasswordDefault' )
401 'PerDbNameStatsdDataFactory' =>
402 function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
403 $config = $services->getMainConfig();
404 $wiki = $config->get( 'DBname' );
405 return new BufferingStatsdDataFactory(
406 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . '.' . $wiki
410 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
411 $factory = new DefaultPreferencesFactory(
412 $services->getMainConfig(),
413 $services->getContentLanguage(),
414 AuthManager
::singleton(),
415 $services->getLinkRendererFactory()->create()
417 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
422 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
423 $mainConfig = $services->getMainConfig();
424 return new ProxyLookup(
425 $mainConfig->get( 'SquidServers' ),
426 $mainConfig->get( 'SquidServersNoPurge' )
430 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
431 return new ReadOnlyMode(
432 $services->getConfiguredReadOnlyMode(),
433 $services->getDBLoadBalancer()
437 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
438 return $services->getRevisionStore();
441 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
442 return $services->getRevisionStore();
445 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
446 return $services->getRevisionStoreFactory()->getRevisionStore();
449 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
450 $config = $services->getMainConfig();
451 $store = new RevisionStoreFactory(
452 $services->getDBLoadBalancerFactory(),
453 $services->getBlobStoreFactory(),
454 $services->getMainWANObjectCache(),
455 $services->getCommentStore(),
456 $services->getActorMigration(),
457 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
458 LoggerFactory
::getProvider(),
459 $config->get( 'ContentHandlerUseDB' )
465 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
466 return new SearchEngineConfig( $services->getMainConfig(),
467 $services->getContentLanguage() );
470 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
471 return new SearchEngineFactory( $services->getSearchEngineConfig() );
474 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
475 $config = $services->getMainConfig();
478 'time' => $config->get( 'MaxShellTime' ),
479 'walltime' => $config->get( 'MaxShellWallClockTime' ),
480 'memory' => $config->get( 'MaxShellMemory' ),
481 'filesize' => $config->get( 'MaxShellFileSize' ),
483 $cgroup = $config->get( 'ShellCgroup' );
484 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
486 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
487 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
488 $factory->logStderr();
493 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
494 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
496 if ( $cacheFile !== false ) {
497 return new FileBasedSiteLookup( $cacheFile );
499 // Use the default SiteStore as the SiteLookup implementation for now
500 return $services->getSiteStore();
504 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
505 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
507 // TODO: replace wfGetCache with a CacheFactory service.
508 // TODO: replace wfIsHHVM with a capabilities service.
509 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
511 return new CachingSiteStore( $rawSiteStore, $cache );
514 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
515 $factory = new SkinFactory();
517 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
519 foreach ( $names as $name => $skin ) {
520 $factory->register( $name, $skin, function () use ( $name, $skin ) {
521 $class = "Skin$skin";
522 return new $class( $name );
525 // Register a hidden "fallback" skin
526 $factory->register( 'fallback', 'Fallback', function () {
527 return new SkinFallback
;
529 // Register a hidden skin for api output
530 $factory->register( 'apioutput', 'ApiOutput', function () {
537 'SlotRoleStore' => function ( MediaWikiServices
$services ) : NameTableStore
{
538 return new NameTableStore(
539 $services->getDBLoadBalancer(),
540 $services->getMainWANObjectCache(),
541 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
549 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
550 return new SpecialPageFactory(
551 $services->getMainConfig(),
552 $services->getContentLanguage()
556 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
557 return new BufferingStatsdDataFactory(
558 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
562 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
563 return $services->getService( '_MediaWikiTitleCodec' );
566 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
567 return $services->getService( '_MediaWikiTitleCodec' );
570 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
571 return new ImportableUploadRevisionImporter(
572 $services->getMainConfig()->get( 'EnableUploads' ),
573 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
577 'VirtualRESTServiceClient' =>
578 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
579 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
581 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
582 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
583 $class = $serviceConfig['class'];
584 // Merge in the global defaults
585 $constructArg = $serviceConfig['options'] ??
[];
586 $constructArg +
= $config['global'];
587 // Make the VRS service available at the mount point
588 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
594 'WatchedItemQueryService' =>
595 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
596 return new WatchedItemQueryService(
597 $services->getDBLoadBalancer(),
598 $services->getCommentStore(),
599 $services->getActorMigration()
603 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
604 $store = new WatchedItemStore(
605 $services->getDBLoadBalancer(),
606 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
607 $services->getReadOnlyMode(),
608 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
610 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
612 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
613 $store = new NoWriteWatchedItemStore( $store );
619 'WikiRevisionOldRevisionImporterNoUpdates' =>
620 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
621 return new ImportableOldRevisionImporter(
623 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
624 $services->getDBLoadBalancer()
628 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
629 return new MediaWikiTitleCodec(
630 $services->getContentLanguage(),
631 $services->getGenderCache(),
632 $services->getMainConfig()->get( 'LocalInterwikis' ),
633 $services->getInterwikiLookup()
637 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
638 return $services->getBlobStoreFactory()->newSqlBlobStore();
641 ///////////////////////////////////////////////////////////////////////////
642 // NOTE: When adding a service here, don't forget to add a getter function
643 // in the MediaWikiServices class. The convenience getter should just call
644 // $this->getService( 'FooBarService' ).
645 ///////////////////////////////////////////////////////////////////////////