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 $instance = new $class( $lbConf );
65 MWLBFactory
::setSchemaAliases( $instance );
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 ( MediaWikiServices
$services ) {
192 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
193 return new CryptRand(
195 // To try vary the system information of the state a bit more
196 // by including the system's hostname into the state
198 // It's mostly worthless but throw the wiki's id into the data
199 // for a little more variance
201 // If we have a secret key set then throw it into the state as well
202 function () use ( $secretKey ) {
203 return $secretKey ?
: '';
206 // The config file is likely the most often edited file we know should
207 // be around so include its stat info into the state.
208 // The constant with its location will almost always be defined, as
209 // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
210 // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
211 defined( 'MW_CONFIG_FILE' ) ?
[ MW_CONFIG_FILE
] : [],
212 LoggerFactory
::getInstance( 'CryptRand' )
216 'CryptHKDF' => function ( MediaWikiServices
$services ) {
217 $config = $services->getMainConfig();
219 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
221 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
224 // In HKDF, the context can be known to the attacker, but this will
225 // keep simultaneous runs from producing the same output.
226 $context = [ microtime(), getmypid(), gethostname() ];
228 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
229 $cache = $services->getLocalServerObjectCache();
230 if ( $cache instanceof EmptyBagOStuff
) {
231 $cache = ObjectCache
::getLocalClusterInstance();
234 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
235 $cache, $context, $services->getCryptRand()
239 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
240 return new MediaHandlerFactory(
241 $services->getMainConfig()->get( 'MediaHandlers' )
245 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
246 $logger = LoggerFactory
::getInstance( 'Mime' );
247 $mainConfig = $services->getMainConfig();
249 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
250 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
251 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
253 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
255 $deja = new DjVuImage( $file );
256 if ( $deja->isValid() ) {
257 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
258 $mime = 'image/vnd.djvu';
262 // Some strings by reference for performance - assuming well-behaved hooks
264 'MimeMagicGuessFromContent',
265 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
268 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
269 // Media handling extensions can improve the MIME detected
270 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
272 'initCallback' => function ( $mimeAnalyzer ) {
273 // Allow media handling extensions adding MIME-types and MIME-info
274 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
279 if ( $params['infoFile'] === 'includes/mime.info' ) {
280 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
283 if ( $params['typeFile'] === 'includes/mime.types' ) {
284 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
287 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
288 if ( $detectorCmd ) {
289 $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
290 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
294 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
295 return new MimeMagic( $params );
298 'ProxyLookup' => function ( MediaWikiServices
$services ) {
299 $mainConfig = $services->getMainConfig();
300 return new ProxyLookup(
301 $mainConfig->get( 'SquidServers' ),
302 $mainConfig->get( 'SquidServersNoPurge' )
306 'Parser' => function ( MediaWikiServices
$services ) {
307 $conf = $services->getMainConfig()->get( 'ParserConf' );
308 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
311 'ParserCache' => function ( MediaWikiServices
$services ) {
312 $config = $services->getMainConfig();
313 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
314 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
316 return new ParserCache(
318 $config->get( 'CacheEpoch' )
322 'LinkCache' => function ( MediaWikiServices
$services ) {
323 return new LinkCache(
324 $services->getTitleFormatter(),
325 $services->getMainWANObjectCache()
329 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
330 return new LinkRendererFactory(
331 $services->getTitleFormatter(),
332 $services->getLinkCache()
336 'LinkRenderer' => function ( MediaWikiServices
$services ) {
339 if ( defined( 'MW_NO_SESSION' ) ) {
340 return $services->getLinkRendererFactory()->create();
342 return $services->getLinkRendererFactory()->createForUser( $wgUser );
346 'GenderCache' => function ( MediaWikiServices
$services ) {
347 return new GenderCache();
350 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
353 return new MediaWikiTitleCodec(
355 $services->getGenderCache(),
356 $services->getMainConfig()->get( 'LocalInterwikis' )
360 'TitleFormatter' => function ( MediaWikiServices
$services ) {
361 return $services->getService( '_MediaWikiTitleCodec' );
364 'TitleParser' => function ( MediaWikiServices
$services ) {
365 return $services->getService( '_MediaWikiTitleCodec' );
368 'MainObjectStash' => function ( MediaWikiServices
$services ) {
369 $mainConfig = $services->getMainConfig();
371 $id = $mainConfig->get( 'MainStash' );
372 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
373 throw new UnexpectedValueException(
374 "Cache type \"$id\" is not present in \$wgObjectCaches." );
377 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
380 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
381 $mainConfig = $services->getMainConfig();
383 $id = $mainConfig->get( 'MainWANCache' );
384 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
385 throw new UnexpectedValueException(
386 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
389 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
390 $objectCacheId = $params['cacheId'];
391 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
392 throw new UnexpectedValueException(
393 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
395 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
397 return \ObjectCache
::newWANCacheFromParams( $params );
400 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
401 $mainConfig = $services->getMainConfig();
403 if ( function_exists( 'apc_fetch' ) ) {
405 } elseif ( function_exists( 'apcu_fetch' ) ) {
407 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
413 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
414 throw new UnexpectedValueException(
415 "Cache type \"$id\" is not present in \$wgObjectCaches." );
418 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
421 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
422 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
424 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
425 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
426 $class = $serviceConfig['class'];
427 // Merge in the global defaults
428 $constructArg = isset( $serviceConfig['options'] )
429 ?
$serviceConfig['options']
431 $constructArg +
= $config['global'];
432 // Make the VRS service available at the mount point
433 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
439 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
440 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
443 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
444 return new ReadOnlyMode(
445 $services->getConfiguredReadOnlyMode(),
446 $services->getDBLoadBalancer()
450 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
451 return new ImportableUploadRevisionImporter(
452 $services->getMainConfig()->get( 'EnableUploads' ),
453 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
457 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
458 return new ImportableOldRevisionImporter(
460 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
461 $services->getDBLoadBalancer()
465 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
466 return new ImportableOldRevisionImporter(
468 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
469 $services->getDBLoadBalancer()
473 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
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 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
493 $config = $services->getMainConfig();
495 return new ExternalStoreFactory(
496 $config->get( 'ExternalStores' )
500 'RevisionStore' => function ( MediaWikiServices
$services ) {
501 /** @var SqlBlobStore $blobStore */
502 $blobStore = $services->getService( '_SqlBlobStore' );
504 $store = new RevisionStore(
505 $services->getDBLoadBalancer(),
507 $services->getMainWANObjectCache(),
508 $services->getCommentStore(),
509 $services->getActorMigration()
512 $store->setLogger( LoggerFactory
::getInstance( 'RevisionStore' ) );
514 $config = $services->getMainConfig();
515 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
520 'RevisionLookup' => function ( MediaWikiServices
$services ) {
521 return $services->getRevisionStore();
524 'RevisionFactory' => function ( MediaWikiServices
$services ) {
525 return $services->getRevisionStore();
528 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
530 return new BlobStoreFactory(
531 $services->getDBLoadBalancer(),
532 $services->getMainWANObjectCache(),
533 $services->getMainConfig(),
538 'BlobStore' => function ( MediaWikiServices
$services ) {
539 return $services->getService( '_SqlBlobStore' );
542 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
543 return $services->getBlobStoreFactory()->newSqlBlobStore();
546 'ContentModelStore' => function ( MediaWikiServices
$services ) {
547 return new NameTableStore(
548 $services->getDBLoadBalancer(),
549 $services->getMainWANObjectCache(),
550 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
555 * No strtolower normalization is added to the service as there are examples of
556 * extensions that do not stick to this assumption.
557 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
558 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
563 'SlotRoleStore' => function ( MediaWikiServices
$services ) {
564 return new NameTableStore(
565 $services->getDBLoadBalancer(),
566 $services->getMainWANObjectCache(),
567 LoggerFactory
::getInstance( 'NameTableSqlStore' ),
575 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
577 $authManager = AuthManager
::singleton();
578 $linkRenderer = $services->getLinkRendererFactory()->create();
579 $config = $services->getMainConfig();
580 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
583 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
584 return new \MediaWiki\Http\
HttpRequestFactory();
587 'CommentStore' => function ( MediaWikiServices
$services ) {
589 return new CommentStore(
591 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
595 'ActorMigration' => function ( MediaWikiServices
$services ) {
596 return new ActorMigration(
597 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
601 ///////////////////////////////////////////////////////////////////////////
602 // NOTE: When adding a service here, don't forget to add a getter function
603 // in the MediaWikiServices class. The convenience getter should just call
604 // $this->getService( 'FooBarService' ).
605 ///////////////////////////////////////////////////////////////////////////