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\RevisionStore
;
49 use MediaWiki\Storage\SqlBlobStore
;
50 use Wikimedia\ObjectFactory
;
53 'DBLoadBalancerFactory' => function ( MediaWikiServices
$services ) {
54 $mainConfig = $services->getMainConfig();
56 $lbConf = MWLBFactory
::applyDefaultConfig(
57 $mainConfig->get( 'LBFactoryConf' ),
59 $services->getConfiguredReadOnlyMode()
61 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
63 return new $class( $lbConf );
66 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
67 // just return the default LB from the DBLoadBalancerFactory service
68 return $services->getDBLoadBalancerFactory()->getMainLB();
71 'SiteStore' => function ( MediaWikiServices
$services ) {
72 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
74 // TODO: replace wfGetCache with a CacheFactory service.
75 // TODO: replace wfIsHHVM with a capabilities service.
76 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
78 return new CachingSiteStore( $rawSiteStore, $cache );
81 'SiteLookup' => function ( MediaWikiServices
$services ) {
82 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
84 if ( $cacheFile !== false ) {
85 return new FileBasedSiteLookup( $cacheFile );
87 // Use the default SiteStore as the SiteLookup implementation for now
88 return $services->getSiteStore();
92 'ConfigFactory' => function ( MediaWikiServices
$services ) {
93 // Use the bootstrap config to initialize the ConfigFactory.
94 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
95 $factory = new ConfigFactory();
97 foreach ( $registry as $name => $callback ) {
98 $factory->register( $name, $callback );
103 'MainConfig' => function ( MediaWikiServices
$services ) {
104 // Use the 'main' config from the ConfigFactory service.
105 return $services->getConfigFactory()->makeConfig( 'main' );
108 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
109 global $wgContLang; // TODO: manage $wgContLang as a service
110 $config = $services->getMainConfig();
111 return new ClassicInterwikiLookup(
113 $services->getMainWANObjectCache(),
114 $config->get( 'InterwikiExpiry' ),
115 $config->get( 'InterwikiCache' ),
116 $config->get( 'InterwikiScopes' ),
117 $config->get( 'InterwikiFallbackSite' )
121 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
122 return new BufferingStatsdDataFactory(
123 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
127 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
128 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
131 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
132 return new SearchEngineFactory( $services->getSearchEngineConfig() );
135 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
137 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
140 'SkinFactory' => function ( MediaWikiServices
$services ) {
141 $factory = new SkinFactory();
143 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
145 foreach ( $names as $name => $skin ) {
146 $factory->register( $name, $skin, function () use ( $name, $skin ) {
147 $class = "Skin$skin";
148 return new $class( $name );
151 // Register a hidden "fallback" skin
152 $factory->register( 'fallback', 'Fallback', function () {
153 return new SkinFallback
;
155 // Register a hidden skin for api output
156 $factory->register( 'apioutput', 'ApiOutput', function () {
163 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
164 $store = new WatchedItemStore(
165 $services->getDBLoadBalancer(),
166 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
167 $services->getReadOnlyMode(),
168 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
170 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
172 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
173 $store = new NoWriteWatchedItemStore( $store );
179 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
180 return new WatchedItemQueryService(
181 $services->getDBLoadBalancer(),
182 $services->getCommentStore(),
183 $services->getActorMigration()
187 'CryptRand' => function ( MediaWikiServices
$services ) {
188 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
189 return new CryptRand(
191 // To try vary the system information of the state a bit more
192 // by including the system's hostname into the state
194 // It's mostly worthless but throw the wiki's id into the data
195 // for a little more variance
197 // If we have a secret key set then throw it into the state as well
198 function () use ( $secretKey ) {
199 return $secretKey ?
: '';
202 // The config file is likely the most often edited file we know should
203 // be around so include its stat info into the state.
204 // The constant with its location will almost always be defined, as
205 // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
206 // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
207 defined( 'MW_CONFIG_FILE' ) ?
[ MW_CONFIG_FILE
] : [],
208 LoggerFactory
::getInstance( 'CryptRand' )
212 'CryptHKDF' => function ( MediaWikiServices
$services ) {
213 $config = $services->getMainConfig();
215 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
217 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
220 // In HKDF, the context can be known to the attacker, but this will
221 // keep simultaneous runs from producing the same output.
222 $context = [ microtime(), getmypid(), gethostname() ];
224 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
225 $cache = $services->getLocalServerObjectCache();
226 if ( $cache instanceof EmptyBagOStuff
) {
227 $cache = ObjectCache
::getLocalClusterInstance();
230 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
231 $cache, $context, $services->getCryptRand()
235 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
236 return new MediaHandlerFactory(
237 $services->getMainConfig()->get( 'MediaHandlers' )
241 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
242 $logger = LoggerFactory
::getInstance( 'Mime' );
243 $mainConfig = $services->getMainConfig();
245 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
246 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
247 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
249 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
251 $deja = new DjVuImage( $file );
252 if ( $deja->isValid() ) {
253 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
254 $mime = 'image/vnd.djvu';
258 // Some strings by reference for performance - assuming well-behaved hooks
260 'MimeMagicGuessFromContent',
261 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
264 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
265 // Media handling extensions can improve the MIME detected
266 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
268 'initCallback' => function ( $mimeAnalyzer ) {
269 // Allow media handling extensions adding MIME-types and MIME-info
270 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
275 if ( $params['infoFile'] === 'includes/mime.info' ) {
276 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
279 if ( $params['typeFile'] === 'includes/mime.types' ) {
280 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
283 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
284 if ( $detectorCmd ) {
285 $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
286 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
290 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
291 return new MimeMagic( $params );
294 'ProxyLookup' => function ( MediaWikiServices
$services ) {
295 $mainConfig = $services->getMainConfig();
296 return new ProxyLookup(
297 $mainConfig->get( 'SquidServers' ),
298 $mainConfig->get( 'SquidServersNoPurge' )
302 'Parser' => function ( MediaWikiServices
$services ) {
303 $conf = $services->getMainConfig()->get( 'ParserConf' );
304 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
307 'ParserCache' => function ( MediaWikiServices
$services ) {
308 $config = $services->getMainConfig();
309 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
310 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
312 return new ParserCache(
314 $config->get( 'CacheEpoch' )
318 'LinkCache' => function ( MediaWikiServices
$services ) {
319 return new LinkCache(
320 $services->getTitleFormatter(),
321 $services->getMainWANObjectCache()
325 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
326 return new LinkRendererFactory(
327 $services->getTitleFormatter(),
328 $services->getLinkCache()
332 'LinkRenderer' => function ( MediaWikiServices
$services ) {
335 if ( defined( 'MW_NO_SESSION' ) ) {
336 return $services->getLinkRendererFactory()->create();
338 return $services->getLinkRendererFactory()->createForUser( $wgUser );
342 'GenderCache' => function ( MediaWikiServices
$services ) {
343 return new GenderCache();
346 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
349 return new MediaWikiTitleCodec(
351 $services->getGenderCache(),
352 $services->getMainConfig()->get( 'LocalInterwikis' )
356 'TitleFormatter' => function ( MediaWikiServices
$services ) {
357 return $services->getService( '_MediaWikiTitleCodec' );
360 'TitleParser' => function ( MediaWikiServices
$services ) {
361 return $services->getService( '_MediaWikiTitleCodec' );
364 'MainObjectStash' => function ( MediaWikiServices
$services ) {
365 $mainConfig = $services->getMainConfig();
367 $id = $mainConfig->get( 'MainStash' );
368 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
369 throw new UnexpectedValueException(
370 "Cache type \"$id\" is not present in \$wgObjectCaches." );
373 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
376 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
377 $mainConfig = $services->getMainConfig();
379 $id = $mainConfig->get( 'MainWANCache' );
380 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
381 throw new UnexpectedValueException(
382 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
385 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
386 $objectCacheId = $params['cacheId'];
387 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
388 throw new UnexpectedValueException(
389 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
391 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
393 return \ObjectCache
::newWANCacheFromParams( $params );
396 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
397 $mainConfig = $services->getMainConfig();
399 if ( function_exists( 'apc_fetch' ) ) {
401 } elseif ( function_exists( 'apcu_fetch' ) ) {
403 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
409 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
410 throw new UnexpectedValueException(
411 "Cache type \"$id\" is not present in \$wgObjectCaches." );
414 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
417 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
418 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
420 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
421 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
422 $class = $serviceConfig['class'];
423 // Merge in the global defaults
424 $constructArg = isset( $serviceConfig['options'] )
425 ?
$serviceConfig['options']
427 $constructArg +
= $config['global'];
428 // Make the VRS service available at the mount point
429 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
435 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
436 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
439 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
440 return new ReadOnlyMode(
441 $services->getConfiguredReadOnlyMode(),
442 $services->getDBLoadBalancer()
446 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
447 return new ImportableUploadRevisionImporter(
448 $services->getMainConfig()->get( 'EnableUploads' ),
449 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
453 'OldRevisionImporter' => function ( MediaWikiServices
$services ) {
454 return new ImportableOldRevisionImporter(
456 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
457 $services->getDBLoadBalancer()
461 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices
$services ) {
462 return new ImportableOldRevisionImporter(
464 LoggerFactory
::getInstance( 'OldRevisionImporter' ),
465 $services->getDBLoadBalancer()
469 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
470 $config = $services->getMainConfig();
473 'time' => $config->get( 'MaxShellTime' ),
474 'walltime' => $config->get( 'MaxShellWallClockTime' ),
475 'memory' => $config->get( 'MaxShellMemory' ),
476 'filesize' => $config->get( 'MaxShellFileSize' ),
478 $cgroup = $config->get( 'ShellCgroup' );
479 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
481 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
482 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
483 $factory->logStderr();
488 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
489 $config = $services->getMainConfig();
491 return new ExternalStoreFactory(
492 $config->get( 'ExternalStores' )
496 'RevisionStore' => function ( MediaWikiServices
$services ) {
497 /** @var SqlBlobStore $blobStore */
498 $blobStore = $services->getService( '_SqlBlobStore' );
500 $store = new RevisionStore(
501 $services->getDBLoadBalancer(),
503 $services->getMainWANObjectCache(),
504 $services->getCommentStore(),
505 $services->getActorMigration()
508 $store->setLogger( LoggerFactory
::getInstance( 'RevisionStore' ) );
510 $config = $services->getMainConfig();
511 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
516 'RevisionLookup' => function ( MediaWikiServices
$services ) {
517 return $services->getRevisionStore();
520 'RevisionFactory' => function ( MediaWikiServices
$services ) {
521 return $services->getRevisionStore();
524 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
526 return new BlobStoreFactory(
527 $services->getDBLoadBalancer(),
528 $services->getMainWANObjectCache(),
529 $services->getMainConfig(),
534 'BlobStore' => function ( MediaWikiServices
$services ) {
535 return $services->getService( '_SqlBlobStore' );
538 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
539 return $services->getBlobStoreFactory()->newSqlBlobStore();
542 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
544 $authManager = AuthManager
::singleton();
545 $linkRenderer = $services->getLinkRendererFactory()->create();
546 $config = $services->getMainConfig();
547 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
550 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
551 return new \MediaWiki\Http\
HttpRequestFactory();
554 'CommentStore' => function ( MediaWikiServices
$services ) {
556 return new CommentStore(
558 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
562 'ActorMigration' => function ( MediaWikiServices
$services ) {
563 return new ActorMigration(
564 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
568 ///////////////////////////////////////////////////////////////////////////
569 // NOTE: When adding a service here, don't forget to add a getter function
570 // in the MediaWikiServices class. The convenience getter should just call
571 // $this->getService( 'FooBarService' ).
572 ///////////////////////////////////////////////////////////////////////////