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 Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface
;
41 use MediaWiki\Auth\AuthManager
;
42 use MediaWiki\Config\ConfigRepository
;
43 use MediaWiki\Interwiki\ClassicInterwikiLookup
;
44 use MediaWiki\Interwiki\InterwikiLookup
;
45 use MediaWiki\Linker\LinkRenderer
;
46 use MediaWiki\Linker\LinkRendererFactory
;
47 use MediaWiki\Logger\LoggerFactory
;
48 use MediaWiki\MediaWikiServices
;
49 use MediaWiki\Preferences\PreferencesFactory
;
50 use MediaWiki\Preferences\DefaultPreferencesFactory
;
51 use MediaWiki\Shell\CommandFactory
;
52 use MediaWiki\Special\SpecialPageFactory
;
53 use MediaWiki\Storage\BlobStore
;
54 use MediaWiki\Revision\RevisionRenderer
;
55 use MediaWiki\Storage\BlobStoreFactory
;
56 use MediaWiki\Storage\NameTableStoreFactory
;
57 use MediaWiki\Storage\RevisionFactory
;
58 use MediaWiki\Storage\RevisionLookup
;
59 use MediaWiki\Storage\RevisionStore
;
60 use MediaWiki\Storage\RevisionStoreFactory
;
61 use MediaWiki\Storage\SqlBlobStore
;
64 'ActorMigration' => function ( MediaWikiServices
$services ) : ActorMigration
{
65 return new ActorMigration(
66 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
70 'BlobStore' => function ( MediaWikiServices
$services ) : BlobStore
{
71 return $services->getService( '_SqlBlobStore' );
74 'BlobStoreFactory' => function ( MediaWikiServices
$services ) : BlobStoreFactory
{
75 return new BlobStoreFactory(
76 $services->getDBLoadBalancerFactory(),
77 $services->getMainWANObjectCache(),
78 $services->getMainConfig(),
79 $services->getContentLanguage()
83 'CommentStore' => function ( MediaWikiServices
$services ) : CommentStore
{
84 return new CommentStore(
85 $services->getContentLanguage(),
86 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
90 'ConfigFactory' => function ( MediaWikiServices
$services ) : ConfigFactory
{
91 // Use the bootstrap config to initialize the ConfigFactory.
92 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
93 $factory = new ConfigFactory();
95 foreach ( $registry as $name => $callback ) {
96 $factory->register( $name, $callback );
101 'ConfigRepository' => function ( MediaWikiServices
$services ) : ConfigRepository
{
102 return new ConfigRepository( $services->getConfigFactory() );
105 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) : ConfiguredReadOnlyMode
{
106 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
109 'ContentLanguage' => function ( MediaWikiServices
$services ) : Language
{
110 return Language
::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
113 'CryptHKDF' => function ( MediaWikiServices
$services ) : CryptHKDF
{
114 $config = $services->getMainConfig();
116 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
118 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
121 // In HKDF, the context can be known to the attacker, but this will
122 // keep simultaneous runs from producing the same output.
123 $context = [ microtime(), getmypid(), gethostname() ];
125 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
126 $cache = $services->getLocalServerObjectCache();
127 if ( $cache instanceof EmptyBagOStuff
) {
128 $cache = ObjectCache
::getLocalClusterInstance();
131 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
134 'CryptRand' => function () : CryptRand
{
135 return new CryptRand();
138 'DBLoadBalancer' => function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LoadBalancer
{
139 // just return the default LB from the DBLoadBalancerFactory service
140 return $services->getDBLoadBalancerFactory()->getMainLB();
143 'DBLoadBalancerFactory' =>
144 function ( MediaWikiServices
$services ) : Wikimedia\Rdbms\LBFactory
{
145 $mainConfig = $services->getMainConfig();
147 $lbConf = MWLBFactory
::applyDefaultConfig(
148 $mainConfig->get( 'LBFactoryConf' ),
150 $services->getConfiguredReadOnlyMode()
152 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
154 $instance = new $class( $lbConf );
155 MWLBFactory
::setSchemaAliases( $instance, $mainConfig );
160 'EventRelayerGroup' => function ( MediaWikiServices
$services ) : EventRelayerGroup
{
161 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
164 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) : ExternalStoreFactory
{
165 $config = $services->getMainConfig();
167 return new ExternalStoreFactory(
168 $config->get( 'ExternalStores' )
172 'GenderCache' => function ( MediaWikiServices
$services ) : GenderCache
{
173 return new GenderCache();
176 'HttpRequestFactory' =>
177 function ( MediaWikiServices
$services ) : \MediaWiki\Http\HttpRequestFactory
{
178 return new \MediaWiki\Http\
HttpRequestFactory();
181 'InterwikiLookup' => function ( MediaWikiServices
$services ) : InterwikiLookup
{
182 $config = $services->getMainConfig();
183 return new ClassicInterwikiLookup(
184 $services->getContentLanguage(),
185 $services->getMainWANObjectCache(),
186 $config->get( 'InterwikiExpiry' ),
187 $config->get( 'InterwikiCache' ),
188 $config->get( 'InterwikiScopes' ),
189 $config->get( 'InterwikiFallbackSite' )
193 'LinkCache' => function ( MediaWikiServices
$services ) : LinkCache
{
194 return new LinkCache(
195 $services->getTitleFormatter(),
196 $services->getMainWANObjectCache()
200 'LinkRenderer' => function ( MediaWikiServices
$services ) : LinkRenderer
{
203 if ( defined( 'MW_NO_SESSION' ) ) {
204 return $services->getLinkRendererFactory()->create();
206 return $services->getLinkRendererFactory()->createForUser( $wgUser );
210 'LinkRendererFactory' => function ( MediaWikiServices
$services ) : LinkRendererFactory
{
211 return new LinkRendererFactory(
212 $services->getTitleFormatter(),
213 $services->getLinkCache()
217 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) : BagOStuff
{
218 $cacheId = \ObjectCache
::detectLocalServerCache();
219 return \ObjectCache
::newFromId( $cacheId );
222 'MagicWordFactory' => function ( MediaWikiServices
$services ) : MagicWordFactory
{
223 return new MagicWordFactory( $services->getContentLanguage() );
226 'MainConfig' => function ( MediaWikiServices
$services ) : Config
{
227 // Use the 'main' config from the ConfigFactory service.
228 return $services->getConfigFactory()->makeConfig( 'main' );
231 'MainObjectStash' => function ( MediaWikiServices
$services ) : BagOStuff
{
232 $mainConfig = $services->getMainConfig();
234 $id = $mainConfig->get( 'MainStash' );
235 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
236 throw new UnexpectedValueException(
237 "Cache type \"$id\" is not present in \$wgObjectCaches." );
240 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
243 'MainWANObjectCache' => function ( MediaWikiServices
$services ) : WANObjectCache
{
244 $mainConfig = $services->getMainConfig();
246 $id = $mainConfig->get( 'MainWANCache' );
247 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
248 throw new UnexpectedValueException(
249 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
252 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
253 $objectCacheId = $params['cacheId'];
254 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
255 throw new UnexpectedValueException(
256 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
258 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
260 return \ObjectCache
::newWANCacheFromParams( $params );
263 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) : MediaHandlerFactory
{
264 return new MediaHandlerFactory(
265 $services->getMainConfig()->get( 'MediaHandlers' )
269 'MimeAnalyzer' => function ( MediaWikiServices
$services ) : MimeAnalyzer
{
270 $logger = LoggerFactory
::getInstance( 'Mime' );
271 $mainConfig = $services->getMainConfig();
273 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
274 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
275 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
277 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
279 $deja = new DjVuImage( $file );
280 if ( $deja->isValid() ) {
281 $logger->info( "Detected $file as image/vnd.djvu\n" );
282 $mime = 'image/vnd.djvu';
286 // Some strings by reference for performance - assuming well-behaved hooks
288 'MimeMagicGuessFromContent',
289 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
292 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
293 // Media handling extensions can improve the MIME detected
294 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
296 'initCallback' => function ( $mimeAnalyzer ) {
297 // Allow media handling extensions adding MIME-types and MIME-info
298 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
303 if ( $params['infoFile'] === 'includes/mime.info' ) {
304 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
307 if ( $params['typeFile'] === 'includes/mime.types' ) {
308 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
311 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
312 if ( $detectorCmd ) {
313 $factory = $services->getShellCommandFactory();
314 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
315 $result = $factory->create()
316 // $wgMimeDetectorCommand can contain commands with parameters
317 ->unsafeParams( $detectorCmd )
320 return $result->getStdout();
324 return new MimeAnalyzer( $params );
327 'NameTableStoreFactory' => function ( MediaWikiServices
$services ) : NameTableStoreFactory
{
328 return new NameTableStoreFactory(
329 $services->getDBLoadBalancerFactory(),
330 $services->getMainWANObjectCache(),
331 LoggerFactory
::getInstance( 'NameTableSqlStore' )
335 'OldRevisionImporter' => function ( MediaWikiServices
$services ) : OldRevisionImporter
{
336 return new ImportableOldRevisionImporter(
338 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
339 $services->getDBLoadBalancer()
343 'Parser' => function ( MediaWikiServices
$services ) : Parser
{
344 return $services->getParserFactory()->create();
347 'ParserCache' => function ( MediaWikiServices
$services ) : ParserCache
{
348 $config = $services->getMainConfig();
349 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
350 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
352 return new ParserCache(
354 $config->get( 'CacheEpoch' )
358 'ParserFactory' => function ( MediaWikiServices
$services ) : ParserFactory
{
359 return new ParserFactory(
360 $services->getMainConfig()->get( 'ParserConf' ),
361 $services->getMagicWordFactory(),
362 $services->getContentLanguage(),
364 $services->getSpecialPageFactory()
368 'PasswordFactory' => function ( MediaWikiServices
$services ) : PasswordFactory
{
369 $config = $services->getMainConfig();
370 return new PasswordFactory(
371 $config->get( 'PasswordConfig' ),
372 $config->get( 'PasswordDefault' )
376 'PerDbNameStatsdDataFactory' =>
377 function ( MediaWikiServices
$services ) : StatsdDataFactoryInterface
{
378 $config = $services->getMainConfig();
379 $wiki = $config->get( 'DBname' );
380 return new PrefixingStatsdDataFactoryProxy(
381 $services->getStatsdDataFactory(),
386 'PreferencesFactory' => function ( MediaWikiServices
$services ) : PreferencesFactory
{
387 $factory = new DefaultPreferencesFactory(
388 $services->getMainConfig(),
389 $services->getContentLanguage(),
390 AuthManager
::singleton(),
391 $services->getLinkRendererFactory()->create()
393 $factory->setLogger( LoggerFactory
::getInstance( 'preferences' ) );
398 'ProxyLookup' => function ( MediaWikiServices
$services ) : ProxyLookup
{
399 $mainConfig = $services->getMainConfig();
400 return new ProxyLookup(
401 $mainConfig->get( 'SquidServers' ),
402 $mainConfig->get( 'SquidServersNoPurge' )
406 'ReadOnlyMode' => function ( MediaWikiServices
$services ) : ReadOnlyMode
{
407 return new ReadOnlyMode(
408 $services->getConfiguredReadOnlyMode(),
409 $services->getDBLoadBalancer()
413 'RevisionFactory' => function ( MediaWikiServices
$services ) : RevisionFactory
{
414 return $services->getRevisionStore();
417 'RevisionLookup' => function ( MediaWikiServices
$services ) : RevisionLookup
{
418 return $services->getRevisionStore();
421 'RevisionRenderer' => function ( MediaWikiServices
$services ) : RevisionRenderer
{
422 return new RevisionRenderer( $services->getDBLoadBalancer() );
425 'RevisionStore' => function ( MediaWikiServices
$services ) : RevisionStore
{
426 return $services->getRevisionStoreFactory()->getRevisionStore();
429 'RevisionStoreFactory' => function ( MediaWikiServices
$services ) : RevisionStoreFactory
{
430 $config = $services->getMainConfig();
431 $store = new RevisionStoreFactory(
432 $services->getDBLoadBalancerFactory(),
433 $services->getBlobStoreFactory(),
434 $services->getNameTableStoreFactory(),
435 $services->getMainWANObjectCache(),
436 $services->getCommentStore(),
437 $services->getActorMigration(),
438 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
439 LoggerFactory
::getProvider(),
440 $config->get( 'ContentHandlerUseDB' )
446 'SearchEngineConfig' => function ( MediaWikiServices
$services ) : SearchEngineConfig
{
447 return new SearchEngineConfig( $services->getMainConfig(),
448 $services->getContentLanguage() );
451 'SearchEngineFactory' => function ( MediaWikiServices
$services ) : SearchEngineFactory
{
452 return new SearchEngineFactory( $services->getSearchEngineConfig() );
455 'ShellCommandFactory' => function ( MediaWikiServices
$services ) : CommandFactory
{
456 $config = $services->getMainConfig();
459 'time' => $config->get( 'MaxShellTime' ),
460 'walltime' => $config->get( 'MaxShellWallClockTime' ),
461 'memory' => $config->get( 'MaxShellMemory' ),
462 'filesize' => $config->get( 'MaxShellFileSize' ),
464 $cgroup = $config->get( 'ShellCgroup' );
465 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
467 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
468 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
469 $factory->logStderr();
474 'SiteLookup' => function ( MediaWikiServices
$services ) : SiteLookup
{
475 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
477 if ( $cacheFile !== false ) {
478 return new FileBasedSiteLookup( $cacheFile );
480 // Use the default SiteStore as the SiteLookup implementation for now
481 return $services->getSiteStore();
485 'SiteStore' => function ( MediaWikiServices
$services ) : SiteStore
{
486 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
488 // TODO: replace wfGetCache with a CacheFactory service.
489 // TODO: replace wfIsHHVM with a capabilities service.
490 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
492 return new CachingSiteStore( $rawSiteStore, $cache );
495 'SkinFactory' => function ( MediaWikiServices
$services ) : SkinFactory
{
496 $factory = new SkinFactory();
498 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
500 foreach ( $names as $name => $skin ) {
501 $factory->register( $name, $skin, function () use ( $name, $skin ) {
502 $class = "Skin$skin";
503 return new $class( $name );
506 // Register a hidden "fallback" skin
507 $factory->register( 'fallback', 'Fallback', function () {
508 return new SkinFallback
;
510 // Register a hidden skin for api output
511 $factory->register( 'apioutput', 'ApiOutput', function () {
518 'SpecialPageFactory' => function ( MediaWikiServices
$services ) : SpecialPageFactory
{
519 return new SpecialPageFactory(
520 $services->getMainConfig(),
521 $services->getContentLanguage()
525 'StatsdDataFactory' => function ( MediaWikiServices
$services ) : IBufferingStatsdDataFactory
{
526 return new BufferingStatsdDataFactory(
527 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
531 'TitleFormatter' => function ( MediaWikiServices
$services ) : TitleFormatter
{
532 return $services->getService( '_MediaWikiTitleCodec' );
535 'TitleParser' => function ( MediaWikiServices
$services ) : TitleParser
{
536 return $services->getService( '_MediaWikiTitleCodec' );
539 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) : UploadRevisionImporter
{
540 return new ImportableUploadRevisionImporter(
541 $services->getMainConfig()->get( 'EnableUploads' ),
542 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
546 'VirtualRESTServiceClient' =>
547 function ( MediaWikiServices
$services ) : VirtualRESTServiceClient
{
548 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
550 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
551 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
552 $class = $serviceConfig['class'];
553 // Merge in the global defaults
554 $constructArg = $serviceConfig['options'] ??
[];
555 $constructArg +
= $config['global'];
556 // Make the VRS service available at the mount point
557 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
563 'WatchedItemQueryService' =>
564 function ( MediaWikiServices
$services ) : WatchedItemQueryService
{
565 return new WatchedItemQueryService(
566 $services->getDBLoadBalancer(),
567 $services->getCommentStore(),
568 $services->getActorMigration()
572 'WatchedItemStore' => function ( MediaWikiServices
$services ) : WatchedItemStore
{
573 $store = new WatchedItemStore(
574 $services->getDBLoadBalancer(),
575 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
576 $services->getReadOnlyMode(),
577 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
579 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
581 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
582 $store = new NoWriteWatchedItemStore( $store );
588 'WikiRevisionOldRevisionImporterNoUpdates' =>
589 function ( MediaWikiServices
$services ) : ImportableOldRevisionImporter
{
590 return new ImportableOldRevisionImporter(
592 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
593 $services->getDBLoadBalancer()
597 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) : MediaWikiTitleCodec
{
598 return new MediaWikiTitleCodec(
599 $services->getContentLanguage(),
600 $services->getGenderCache(),
601 $services->getMainConfig()->get( 'LocalInterwikis' ),
602 $services->getInterwikiLookup()
606 '_SqlBlobStore' => function ( MediaWikiServices
$services ) : SqlBlobStore
{
607 return $services->getBlobStoreFactory()->newSqlBlobStore();
610 ///////////////////////////////////////////////////////////////////////////
611 // NOTE: When adding a service here, don't forget to add a getter function
612 // in the MediaWikiServices class. The convenience getter should just call
613 // $this->getService( 'FooBarService' ).
614 ///////////////////////////////////////////////////////////////////////////