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\Interwiki\ClassicInterwikiLookup
;
41 use MediaWiki\Linker\LinkRendererFactory
;
42 use MediaWiki\Logger\LoggerFactory
;
43 use MediaWiki\MediaWikiServices
;
46 'DBLoadBalancerFactory' => function ( MediaWikiServices
$services ) {
47 $mainConfig = $services->getMainConfig();
49 $lbConf = MWLBFactory
::applyDefaultConfig(
50 $mainConfig->get( 'LBFactoryConf' ),
52 $services->getConfiguredReadOnlyMode()
54 $class = MWLBFactory
::getLBFactoryClass( $lbConf );
56 return new $class( $lbConf );
59 'DBLoadBalancer' => function ( MediaWikiServices
$services ) {
60 // just return the default LB from the DBLoadBalancerFactory service
61 return $services->getDBLoadBalancerFactory()->getMainLB();
64 'SiteStore' => function ( MediaWikiServices
$services ) {
65 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
67 // TODO: replace wfGetCache with a CacheFactory service.
68 // TODO: replace wfIsHHVM with a capabilities service.
69 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL
: CACHE_ANYTHING
);
71 return new CachingSiteStore( $rawSiteStore, $cache );
74 'SiteLookup' => function ( MediaWikiServices
$services ) {
75 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
77 if ( $cacheFile !== false ) {
78 return new FileBasedSiteLookup( $cacheFile );
80 // Use the default SiteStore as the SiteLookup implementation for now
81 return $services->getSiteStore();
85 'ConfigFactory' => function ( MediaWikiServices
$services ) {
86 // Use the bootstrap config to initialize the ConfigFactory.
87 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
88 $factory = new ConfigFactory();
90 foreach ( $registry as $name => $callback ) {
91 $factory->register( $name, $callback );
96 'MainConfig' => function ( MediaWikiServices
$services ) {
97 // Use the 'main' config from the ConfigFactory service.
98 return $services->getConfigFactory()->makeConfig( 'main' );
101 'InterwikiLookup' => function ( MediaWikiServices
$services ) {
102 global $wgContLang; // TODO: manage $wgContLang as a service
103 $config = $services->getMainConfig();
104 return new ClassicInterwikiLookup(
106 $services->getMainWANObjectCache(),
107 $config->get( 'InterwikiExpiry' ),
108 $config->get( 'InterwikiCache' ),
109 $config->get( 'InterwikiScopes' ),
110 $config->get( 'InterwikiFallbackSite' )
114 'StatsdDataFactory' => function ( MediaWikiServices
$services ) {
115 return new BufferingStatsdDataFactory(
116 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
120 'EventRelayerGroup' => function ( MediaWikiServices
$services ) {
121 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
124 'SearchEngineFactory' => function ( MediaWikiServices
$services ) {
125 return new SearchEngineFactory( $services->getSearchEngineConfig() );
128 'SearchEngineConfig' => function ( MediaWikiServices
$services ) {
130 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
133 'SkinFactory' => function ( MediaWikiServices
$services ) {
134 $factory = new SkinFactory();
136 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
138 foreach ( $names as $name => $skin ) {
139 $factory->register( $name, $skin, function () use ( $name, $skin ) {
140 $class = "Skin$skin";
141 return new $class( $name );
144 // Register a hidden "fallback" skin
145 $factory->register( 'fallback', 'Fallback', function () {
146 return new SkinFallback
;
148 // Register a hidden skin for api output
149 $factory->register( 'apioutput', 'ApiOutput', function () {
156 'WatchedItemStore' => function ( MediaWikiServices
$services ) {
157 $store = new WatchedItemStore(
158 $services->getDBLoadBalancer(),
159 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
160 $services->getReadOnlyMode()
162 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
166 'WatchedItemQueryService' => function ( MediaWikiServices
$services ) {
167 return new WatchedItemQueryService( $services->getDBLoadBalancer() );
170 'CryptRand' => function ( MediaWikiServices
$services ) {
171 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
172 return new CryptRand(
174 // To try vary the system information of the state a bit more
175 // by including the system's hostname into the state
177 // It's mostly worthless but throw the wiki's id into the data
178 // for a little more variance
180 // If we have a secret key set then throw it into the state as well
181 function () use ( $secretKey ) {
182 return $secretKey ?
: '';
185 // The config file is likely the most often edited file we know should
186 // be around so include its stat info into the state.
187 // The constant with its location will almost always be defined, as
188 // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
189 // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
190 defined( 'MW_CONFIG_FILE' ) ?
[ MW_CONFIG_FILE
] : [],
191 LoggerFactory
::getInstance( 'CryptRand' )
195 'CryptHKDF' => function ( MediaWikiServices
$services ) {
196 $config = $services->getMainConfig();
198 $secret = $config->get( 'HKDFSecret' ) ?
: $config->get( 'SecretKey' );
200 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
203 // In HKDF, the context can be known to the attacker, but this will
204 // keep simultaneous runs from producing the same output.
205 $context = [ microtime(), getmypid(), gethostname() ];
207 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
208 $cache = $services->getLocalServerObjectCache();
209 if ( $cache instanceof EmptyBagOStuff
) {
210 $cache = ObjectCache
::getLocalClusterInstance();
213 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
214 $cache, $context, $services->getCryptRand()
218 'MediaHandlerFactory' => function ( MediaWikiServices
$services ) {
219 return new MediaHandlerFactory(
220 $services->getMainConfig()->get( 'MediaHandlers' )
224 'MimeAnalyzer' => function ( MediaWikiServices
$services ) {
225 $logger = LoggerFactory
::getInstance( 'Mime' );
226 $mainConfig = $services->getMainConfig();
228 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
229 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
230 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
232 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
234 $deja = new DjVuImage( $file );
235 if ( $deja->isValid() ) {
236 $logger->info( __METHOD__
. ": detected $file as image/vnd.djvu\n" );
237 $mime = 'image/vnd.djvu';
241 // Some strings by reference for performance - assuming well-behaved hooks
243 'MimeMagicGuessFromContent',
244 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
247 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
248 // Media handling extensions can improve the MIME detected
249 Hooks
::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
251 'initCallback' => function ( $mimeAnalyzer ) {
252 // Allow media handling extensions adding MIME-types and MIME-info
253 Hooks
::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
258 if ( $params['infoFile'] === 'includes/mime.info' ) {
259 $params['infoFile'] = __DIR__
. "/libs/mime/mime.info";
262 if ( $params['typeFile'] === 'includes/mime.types' ) {
263 $params['typeFile'] = __DIR__
. "/libs/mime/mime.types";
266 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
267 if ( $detectorCmd ) {
268 $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
269 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
273 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
274 return new MimeMagic( $params );
277 'ProxyLookup' => function ( MediaWikiServices
$services ) {
278 $mainConfig = $services->getMainConfig();
279 return new ProxyLookup(
280 $mainConfig->get( 'SquidServers' ),
281 $mainConfig->get( 'SquidServersNoPurge' )
285 'Parser' => function ( MediaWikiServices
$services ) {
286 $conf = $services->getMainConfig()->get( 'ParserConf' );
287 return ObjectFactory
::constructClassInstance( $conf['class'], [ $conf ] );
290 'LinkCache' => function ( MediaWikiServices
$services ) {
291 return new LinkCache(
292 $services->getTitleFormatter(),
293 $services->getMainWANObjectCache()
297 'LinkRendererFactory' => function ( MediaWikiServices
$services ) {
298 return new LinkRendererFactory(
299 $services->getTitleFormatter(),
300 $services->getLinkCache()
304 'LinkRenderer' => function ( MediaWikiServices
$services ) {
307 if ( defined( 'MW_NO_SESSION' ) ) {
308 return $services->getLinkRendererFactory()->create();
310 return $services->getLinkRendererFactory()->createForUser( $wgUser );
314 'GenderCache' => function ( MediaWikiServices
$services ) {
315 return new GenderCache();
318 '_MediaWikiTitleCodec' => function ( MediaWikiServices
$services ) {
321 return new MediaWikiTitleCodec(
323 $services->getGenderCache(),
324 $services->getMainConfig()->get( 'LocalInterwikis' )
328 'TitleFormatter' => function ( MediaWikiServices
$services ) {
329 return $services->getService( '_MediaWikiTitleCodec' );
332 'TitleParser' => function ( MediaWikiServices
$services ) {
333 return $services->getService( '_MediaWikiTitleCodec' );
336 'MainObjectStash' => function ( MediaWikiServices
$services ) {
337 $mainConfig = $services->getMainConfig();
339 $id = $mainConfig->get( 'MainStash' );
340 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
341 throw new UnexpectedValueException(
342 "Cache type \"$id\" is not present in \$wgObjectCaches." );
345 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
348 'MainWANObjectCache' => function ( MediaWikiServices
$services ) {
349 $mainConfig = $services->getMainConfig();
351 $id = $mainConfig->get( 'MainWANCache' );
352 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
353 throw new UnexpectedValueException(
354 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
357 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
358 $objectCacheId = $params['cacheId'];
359 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
360 throw new UnexpectedValueException(
361 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
363 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
365 return \ObjectCache
::newWANCacheFromParams( $params );
368 'LocalServerObjectCache' => function ( MediaWikiServices
$services ) {
369 $mainConfig = $services->getMainConfig();
371 if ( function_exists( 'apc_fetch' ) ) {
373 } elseif ( function_exists( 'apcu_fetch' ) ) {
375 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
377 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
383 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
384 throw new UnexpectedValueException(
385 "Cache type \"$id\" is not present in \$wgObjectCaches." );
388 return \ObjectCache
::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
391 'VirtualRESTServiceClient' => function ( MediaWikiServices
$services ) {
392 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
394 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
395 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
396 $class = $serviceConfig['class'];
397 // Merge in the global defaults
398 $constructArg = isset( $serviceConfig['options'] )
399 ?
$serviceConfig['options']
401 $constructArg +
= $config['global'];
402 // Make the VRS service available at the mount point
403 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
409 'ConfiguredReadOnlyMode' => function ( MediaWikiServices
$services ) {
410 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
413 'ReadOnlyMode' => function ( MediaWikiServices
$services ) {
414 return new ReadOnlyMode(
415 $services->getConfiguredReadOnlyMode(),
416 $services->getDBLoadBalancer()
420 ///////////////////////////////////////////////////////////////////////////
421 // NOTE: When adding a service here, don't forget to add a getter function
422 // in the MediaWikiServices class. The convenience getter should just call
423 // $this->getService( 'FooBarService' ).
424 ///////////////////////////////////////////////////////////////////////////