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()
186 'CryptRand' => function ( MediaWikiServices
$services ) {
187 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
188 return new CryptRand(
190 // To try vary the system information of the state a bit more
191 // by including the system's hostname into the state
193 // It's mostly worthless but throw the wiki's id into the data
194 // for a little more variance
196 // If we have a secret key set then throw it into the state as well
197 function () use ( $secretKey ) {
198 return $secretKey ?
: '';
201 // The config file is likely the most often edited file we know should
202 // be around so include its stat info into the state.
203 // The constant with its location will almost always be defined, as
204 // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
205 // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
206 defined( 'MW_CONFIG_FILE' ) ?
[ MW_CONFIG_FILE
] : [],
207 LoggerFactory
::getInstance( 'CryptRand' )
211 'CryptHKDF' => function ( MediaWikiServices
$services ) {
212 $config = $services->getMainConfig();
214 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
216 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
219 // In HKDF, the context can be known to the attacker, but this will
220 // keep simultaneous runs from producing the same output.
221 $context = [ microtime(), getmypid(), gethostname() ];
223 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
224 $cache = $services->getLocalServerObjectCache();
225 if ( $cache instanceof EmptyBagOStuff
) {
226 $cache = ObjectCache
::getLocalClusterInstance();
229 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
230 $cache, $context, $services->getCryptRand()
234 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
235 return new MediaHandlerFactory(
236 $services->getMainConfig()->get( 'MediaHandlers' )
240 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
241 $logger = LoggerFactory
::getInstance( 'Mime' );
242 $mainConfig = $services->getMainConfig();
244 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
245 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
246 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
248 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
250 $deja = new DjVuImage( $file );
251 if ( $deja->isValid() ) {
252 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
253 $mime = 'image/vnd.djvu';
257 // Some strings by reference for performance - assuming well-behaved hooks
259 'MimeMagicGuessFromContent',
260 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
263 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
264 // Media handling extensions can improve the MIME detected
265 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
267 'initCallback' => function ( $mimeAnalyzer ) {
268 // Allow media handling extensions adding MIME-types and MIME-info
269 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
274 if ( $params['infoFile'] === 'includes/mime.info' ) {
275 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
278 if ( $params['typeFile'] === 'includes/mime.types' ) {
279 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
282 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
283 if ( $detectorCmd ) {
284 $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
285 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
289 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
290 return new MimeMagic( $params );
293 'ProxyLookup' => function ( MediaWikiServices
$services ) {
294 $mainConfig = $services->getMainConfig();
295 return new ProxyLookup(
296 $mainConfig->get( 'SquidServers' ),
297 $mainConfig->get( 'SquidServersNoPurge' )
301 'Parser' => function ( MediaWikiServices
$services ) {
302 $conf = $services->getMainConfig()->get( 'ParserConf' );
303 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
306 'ParserCache' => function ( MediaWikiServices
$services ) {
307 $config = $services->getMainConfig();
308 $cache = ObjectCache
::getInstance( $config->get( 'ParserCacheType' ) );
309 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
311 return new ParserCache(
313 $config->get( 'CacheEpoch' )
317 'LinkCache' => function ( MediaWikiServices
$services ) {
318 return new LinkCache(
319 $services->getTitleFormatter(),
320 $services->getMainWANObjectCache()
324 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
325 return new LinkRendererFactory(
326 $services->getTitleFormatter(),
327 $services->getLinkCache()
331 'LinkRenderer' => function ( MediaWikiServices
$services ) {
334 if ( defined( 'MW_NO_SESSION' ) ) {
335 return $services->getLinkRendererFactory()->create();
337 return $services->getLinkRendererFactory()->createForUser( $wgUser );
341 'GenderCache' => function ( MediaWikiServices
$services ) {
342 return new GenderCache();
345 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
348 return new MediaWikiTitleCodec(
350 $services->getGenderCache(),
351 $services->getMainConfig()->get( 'LocalInterwikis' )
355 'TitleFormatter' => function ( MediaWikiServices
$services ) {
356 return $services->getService( '_MediaWikiTitleCodec' );
359 'TitleParser' => function ( MediaWikiServices
$services ) {
360 return $services->getService( '_MediaWikiTitleCodec' );
363 'MainObjectStash' => function ( MediaWikiServices
$services ) {
364 $mainConfig = $services->getMainConfig();
366 $id = $mainConfig->get( 'MainStash' );
367 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
368 throw new UnexpectedValueException(
369 "Cache type \"$id\" is not present in \$wgObjectCaches." );
372 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
375 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
376 $mainConfig = $services->getMainConfig();
378 $id = $mainConfig->get( 'MainWANCache' );
379 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
380 throw new UnexpectedValueException(
381 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
384 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
385 $objectCacheId = $params['cacheId'];
386 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
387 throw new UnexpectedValueException(
388 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
390 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
392 return \ObjectCache
::newWANCacheFromParams( $params );
395 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
396 $mainConfig = $services->getMainConfig();
398 if ( function_exists( 'apc_fetch' ) ) {
400 } elseif ( function_exists( 'apcu_fetch' ) ) {
402 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
408 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
409 throw new UnexpectedValueException(
410 "Cache type \"$id\" is not present in \$wgObjectCaches." );
413 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
416 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
417 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
419 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
420 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
421 $class = $serviceConfig['class'];
422 // Merge in the global defaults
423 $constructArg = isset( $serviceConfig['options'] )
424 ?
$serviceConfig['options']
426 $constructArg +
= $config['global'];
427 // Make the VRS service available at the mount point
428 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
434 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
435 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
438 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
439 return new ReadOnlyMode(
440 $services->getConfiguredReadOnlyMode(),
441 $services->getDBLoadBalancer()
445 'UploadRevisionImporter' => function ( MediaWikiServices
$services ) {
446 return new ImportableUploadRevisionImporter(
447 $services->getMainConfig()->get( 'EnableUploads' ),
448 LoggerFactory
::getInstance( 'UploadRevisionImporter' )
452 'ShellCommandFactory' => function ( MediaWikiServices
$services ) {
453 $config = $services->getMainConfig();
456 'time' => $config->get( 'MaxShellTime' ),
457 'walltime' => $config->get( 'MaxShellWallClockTime' ),
458 'memory' => $config->get( 'MaxShellMemory' ),
459 'filesize' => $config->get( 'MaxShellFileSize' ),
461 $cgroup = $config->get( 'ShellCgroup' );
462 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
464 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
465 $factory->setLogger( LoggerFactory
::getInstance( 'exec' ) );
466 $factory->logStderr();
471 'ExternalStoreFactory' => function ( MediaWikiServices
$services ) {
472 $config = $services->getMainConfig();
474 return new ExternalStoreFactory(
475 $config->get( 'ExternalStores' )
479 'RevisionStore' => function ( MediaWikiServices
$services ) {
480 /** @var SqlBlobStore $blobStore */
481 $blobStore = $services->getService( '_SqlBlobStore' );
483 $store = new RevisionStore(
484 $services->getDBLoadBalancer(),
486 $services->getMainWANObjectCache(),
487 $services->getCommentStore()
490 $store->setLogger( LoggerFactory
::getInstance( 'RevisionStore' ) );
492 $config = $services->getMainConfig();
493 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
498 'RevisionLookup' => function ( MediaWikiServices
$services ) {
499 return $services->getRevisionStore();
502 'RevisionFactory' => function ( MediaWikiServices
$services ) {
503 return $services->getRevisionStore();
506 'BlobStoreFactory' => function ( MediaWikiServices
$services ) {
508 return new BlobStoreFactory(
509 $services->getDBLoadBalancer(),
510 $services->getMainWANObjectCache(),
511 $services->getMainConfig(),
516 'BlobStore' => function ( MediaWikiServices
$services ) {
517 return $services->getService( '_SqlBlobStore' );
520 '_SqlBlobStore' => function ( MediaWikiServices
$services ) {
521 return $services->getBlobStoreFactory()->newSqlBlobStore();
524 'PreferencesFactory' => function ( MediaWikiServices
$services ) {
526 $authManager = AuthManager
::singleton();
527 $linkRenderer = $services->getLinkRendererFactory()->create();
528 $config = $services->getMainConfig();
529 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
532 'HttpRequestFactory' => function ( MediaWikiServices
$services ) {
533 return new \MediaWiki\Http\
HttpRequestFactory();
536 'CommentStore' => function ( MediaWikiServices
$services ) {
538 return new CommentStore(
540 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
544 ///////////////////////////////////////////////////////////////////////////
545 // NOTE: When adding a service here, don't forget to add a getter function
546 // in the MediaWikiServices class. The convenience getter should just call
547 // $this->getService( 'FooBarService' ).
548 ///////////////////////////////////////////////////////////////////////////