Alphabetize service lists
[lhc/web/wiklou.git] / includes / ServiceWiring.php
1 <?php
2 /**
3 * Default wiring for MediaWiki services.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 *
22 * This file is loaded by MediaWiki\MediaWikiServices::getInstance() during the
23 * bootstrapping of the dependency injection framework.
24 *
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
28 * this file.
29 *
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.
33 *
34 * @since 1.27
35 *
36 * @see docs/injection.txt for an overview of using dependency injection in the
37 * MediaWiki code base.
38 */
39
40 use MediaWiki\Auth\AuthManager;
41 use MediaWiki\Config\ConfigRepository;
42 use MediaWiki\Interwiki\ClassicInterwikiLookup;
43 use MediaWiki\Linker\LinkRendererFactory;
44 use MediaWiki\Logger\LoggerFactory;
45 use MediaWiki\MediaWikiServices;
46 use MediaWiki\Preferences\DefaultPreferencesFactory;
47 use MediaWiki\Shell\CommandFactory;
48 use MediaWiki\Storage\BlobStoreFactory;
49 use MediaWiki\Storage\NameTableStore;
50 use MediaWiki\Storage\RevisionStoreFactory;
51 use Wikimedia\ObjectFactory;
52
53 return [
54 'ActorMigration' => function ( MediaWikiServices $services ) {
55 return new ActorMigration(
56 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
57 );
58 },
59
60 'BlobStore' => function ( MediaWikiServices $services ) {
61 return $services->getService( '_SqlBlobStore' );
62 },
63
64 'BlobStoreFactory' => function ( MediaWikiServices $services ) {
65 return new BlobStoreFactory(
66 $services->getDBLoadBalancer(),
67 $services->getMainWANObjectCache(),
68 $services->getMainConfig(),
69 $services->getContentLanguage()
70 );
71 },
72
73 'ChangeTagDefStore' => function ( MediaWikiServices $services ) {
74 return new NameTableStore(
75 $services->getDBLoadBalancer(),
76 $services->getMainWANObjectCache(),
77 LoggerFactory::getInstance( 'NameTableSqlStore' ),
78 'change_tag_def',
79 'ctd_id',
80 'ctd_name',
81 null,
82 false,
83 function ( $insertFields ) {
84 $insertFields['ctd_user_defined'] = 0;
85 $insertFields['ctd_count'] = 0;
86 return $insertFields;
87 }
88 );
89 },
90
91 'CommentStore' => function ( MediaWikiServices $services ) {
92 return new CommentStore(
93 $services->getContentLanguage(),
94 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
95 );
96 },
97
98 'ConfigFactory' => function ( MediaWikiServices $services ) {
99 // Use the bootstrap config to initialize the ConfigFactory.
100 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
101 $factory = new ConfigFactory();
102
103 foreach ( $registry as $name => $callback ) {
104 $factory->register( $name, $callback );
105 }
106 return $factory;
107 },
108
109 'ConfigRepository' => function ( MediaWikiServices $services ) {
110 return new ConfigRepository( $services->getConfigFactory() );
111 },
112
113 'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
114 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
115 },
116
117 'ContentLanguage' => function ( MediaWikiServices $services ) {
118 return Language::factory( $services->getMainConfig()->get( 'LanguageCode' ) );
119 },
120
121 'ContentModelStore' => function ( MediaWikiServices $services ) {
122 return new NameTableStore(
123 $services->getDBLoadBalancer(),
124 $services->getMainWANObjectCache(),
125 LoggerFactory::getInstance( 'NameTableSqlStore' ),
126 'content_models',
127 'model_id',
128 'model_name'
129 /**
130 * No strtolower normalization is added to the service as there are examples of
131 * extensions that do not stick to this assumption.
132 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
133 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
134 */
135 );
136 },
137
138 'CryptHKDF' => function ( MediaWikiServices $services ) {
139 $config = $services->getMainConfig();
140
141 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
142 if ( !$secret ) {
143 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
144 }
145
146 // In HKDF, the context can be known to the attacker, but this will
147 // keep simultaneous runs from producing the same output.
148 $context = [ microtime(), getmypid(), gethostname() ];
149
150 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
151 $cache = $services->getLocalServerObjectCache();
152 if ( $cache instanceof EmptyBagOStuff ) {
153 $cache = ObjectCache::getLocalClusterInstance();
154 }
155
156 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
157 },
158
159 'CryptRand' => function () {
160 return new CryptRand();
161 },
162
163 'DBLoadBalancer' => function ( MediaWikiServices $services ) {
164 // just return the default LB from the DBLoadBalancerFactory service
165 return $services->getDBLoadBalancerFactory()->getMainLB();
166 },
167
168 'DBLoadBalancerFactory' => function ( MediaWikiServices $services ) {
169 $mainConfig = $services->getMainConfig();
170
171 $lbConf = MWLBFactory::applyDefaultConfig(
172 $mainConfig->get( 'LBFactoryConf' ),
173 $mainConfig,
174 $services->getConfiguredReadOnlyMode()
175 );
176 $class = MWLBFactory::getLBFactoryClass( $lbConf );
177
178 $instance = new $class( $lbConf );
179 MWLBFactory::setSchemaAliases( $instance, $mainConfig );
180
181 return $instance;
182 },
183
184 'EventRelayerGroup' => function ( MediaWikiServices $services ) {
185 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
186 },
187
188 'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
189 $config = $services->getMainConfig();
190
191 return new ExternalStoreFactory(
192 $config->get( 'ExternalStores' )
193 );
194 },
195
196 'GenderCache' => function ( MediaWikiServices $services ) {
197 return new GenderCache();
198 },
199
200 'HttpRequestFactory' => function ( MediaWikiServices $services ) {
201 return new \MediaWiki\Http\HttpRequestFactory();
202 },
203
204 'InterwikiLookup' => function ( MediaWikiServices $services ) {
205 $config = $services->getMainConfig();
206 return new ClassicInterwikiLookup(
207 $services->getContentLanguage(),
208 $services->getMainWANObjectCache(),
209 $config->get( 'InterwikiExpiry' ),
210 $config->get( 'InterwikiCache' ),
211 $config->get( 'InterwikiScopes' ),
212 $config->get( 'InterwikiFallbackSite' )
213 );
214 },
215
216 'LinkCache' => function ( MediaWikiServices $services ) {
217 return new LinkCache(
218 $services->getTitleFormatter(),
219 $services->getMainWANObjectCache()
220 );
221 },
222
223 'LinkRenderer' => function ( MediaWikiServices $services ) {
224 global $wgUser;
225
226 if ( defined( 'MW_NO_SESSION' ) ) {
227 return $services->getLinkRendererFactory()->create();
228 } else {
229 return $services->getLinkRendererFactory()->createForUser( $wgUser );
230 }
231 },
232
233 'LinkRendererFactory' => function ( MediaWikiServices $services ) {
234 return new LinkRendererFactory(
235 $services->getTitleFormatter(),
236 $services->getLinkCache()
237 );
238 },
239
240 'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
241 $cacheId = \ObjectCache::detectLocalServerCache();
242 return \ObjectCache::newFromId( $cacheId );
243 },
244
245 'MagicWordFactory' => function ( MediaWikiServices $services ) {
246 return new MagicWordFactory( $services->getContentLanguage() );
247 },
248
249 'MainConfig' => function ( MediaWikiServices $services ) {
250 // Use the 'main' config from the ConfigFactory service.
251 return $services->getConfigFactory()->makeConfig( 'main' );
252 },
253
254 'MainObjectStash' => function ( MediaWikiServices $services ) {
255 $mainConfig = $services->getMainConfig();
256
257 $id = $mainConfig->get( 'MainStash' );
258 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
259 throw new UnexpectedValueException(
260 "Cache type \"$id\" is not present in \$wgObjectCaches." );
261 }
262
263 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
264 },
265
266 'MainWANObjectCache' => function ( MediaWikiServices $services ) {
267 $mainConfig = $services->getMainConfig();
268
269 $id = $mainConfig->get( 'MainWANCache' );
270 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
271 throw new UnexpectedValueException(
272 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
273 }
274
275 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
276 $objectCacheId = $params['cacheId'];
277 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
278 throw new UnexpectedValueException(
279 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
280 }
281 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
282
283 return \ObjectCache::newWANCacheFromParams( $params );
284 },
285
286 'MediaHandlerFactory' => function ( MediaWikiServices $services ) {
287 return new MediaHandlerFactory(
288 $services->getMainConfig()->get( 'MediaHandlers' )
289 );
290 },
291
292 'MimeAnalyzer' => function ( MediaWikiServices $services ) {
293 $logger = LoggerFactory::getInstance( 'Mime' );
294 $mainConfig = $services->getMainConfig();
295 $params = [
296 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
297 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
298 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
299 'guessCallback' =>
300 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
301 // Also test DjVu
302 $deja = new DjVuImage( $file );
303 if ( $deja->isValid() ) {
304 $logger->info( __METHOD__ . ": detected $file as image/vnd.djvu\n" );
305 $mime = 'image/vnd.djvu';
306
307 return;
308 }
309 // Some strings by reference for performance - assuming well-behaved hooks
310 Hooks::run(
311 'MimeMagicGuessFromContent',
312 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
313 );
314 },
315 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
316 // Media handling extensions can improve the MIME detected
317 Hooks::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
318 },
319 'initCallback' => function ( $mimeAnalyzer ) {
320 // Allow media handling extensions adding MIME-types and MIME-info
321 Hooks::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
322 },
323 'logger' => $logger
324 ];
325
326 if ( $params['infoFile'] === 'includes/mime.info' ) {
327 $params['infoFile'] = __DIR__ . "/libs/mime/mime.info";
328 }
329
330 if ( $params['typeFile'] === 'includes/mime.types' ) {
331 $params['typeFile'] = __DIR__ . "/libs/mime/mime.types";
332 }
333
334 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
335 if ( $detectorCmd ) {
336 $factory = $services->getShellCommandFactory();
337 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
338 $result = $factory->create()
339 // $wgMimeDetectorCommand can contain commands with parameters
340 ->unsafeParams( $detectorCmd )
341 ->params( $file )
342 ->execute();
343 return $result->getStdout();
344 };
345 }
346
347 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
348 return new MimeMagic( $params );
349 },
350
351 'OldRevisionImporter' => function ( MediaWikiServices $services ) {
352 return new ImportableOldRevisionImporter(
353 true,
354 LoggerFactory::getInstance( 'OldRevisionImporter' ),
355 $services->getDBLoadBalancer()
356 );
357 },
358
359 'Parser' => function ( MediaWikiServices $services ) {
360 $conf = $services->getMainConfig()->get( 'ParserConf' );
361 return ObjectFactory::constructClassInstance( $conf['class'],
362 [ $conf, $services->getMagicWordFactory() ] );
363 },
364
365 'ParserCache' => function ( MediaWikiServices $services ) {
366 $config = $services->getMainConfig();
367 $cache = ObjectCache::getInstance( $config->get( 'ParserCacheType' ) );
368 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
369
370 return new ParserCache(
371 $cache,
372 $config->get( 'CacheEpoch' )
373 );
374 },
375
376 'PasswordFactory' => function ( MediaWikiServices $services ) {
377 $config = $services->getMainConfig();
378 return new PasswordFactory(
379 $config->get( 'PasswordConfig' ),
380 $config->get( 'PasswordDefault' )
381 );
382 },
383
384 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices $services ) {
385 $config = $services->getMainConfig();
386 $wiki = $config->get( 'DBname' );
387 return new BufferingStatsdDataFactory(
388 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . '.' . $wiki
389 );
390 },
391
392 'PreferencesFactory' => function ( MediaWikiServices $services ) {
393 $authManager = AuthManager::singleton();
394 $linkRenderer = $services->getLinkRendererFactory()->create();
395 $config = $services->getMainConfig();
396 $factory = new DefaultPreferencesFactory( $config, $services->getContentLanguage(),
397 $authManager, $linkRenderer );
398 $factory->setLogger( LoggerFactory::getInstance( 'preferences' ) );
399
400 return $factory;
401 },
402
403 'ProxyLookup' => function ( MediaWikiServices $services ) {
404 $mainConfig = $services->getMainConfig();
405 return new ProxyLookup(
406 $mainConfig->get( 'SquidServers' ),
407 $mainConfig->get( 'SquidServersNoPurge' )
408 );
409 },
410
411 'ReadOnlyMode' => function ( MediaWikiServices $services ) {
412 return new ReadOnlyMode(
413 $services->getConfiguredReadOnlyMode(),
414 $services->getDBLoadBalancer()
415 );
416 },
417
418 'RevisionFactory' => function ( MediaWikiServices $services ) {
419 return $services->getRevisionStore();
420 },
421
422 'RevisionLookup' => function ( MediaWikiServices $services ) {
423 return $services->getRevisionStore();
424 },
425
426 'RevisionStore' => function ( MediaWikiServices $services ) {
427 return $services->getRevisionStoreFactory()->getRevisionStore();
428 },
429
430 'RevisionStoreFactory' => function ( MediaWikiServices $services ) {
431 $config = $services->getMainConfig();
432 $store = new RevisionStoreFactory(
433 $services->getDBLoadBalancerFactory(),
434 $services->getBlobStoreFactory(),
435 $services->getMainWANObjectCache(),
436 $services->getCommentStore(),
437 $services->getActorMigration(),
438 $config->get( 'MultiContentRevisionSchemaMigrationStage' ),
439 LoggerFactory::getProvider(),
440 $config->get( 'ContentHandlerUseDB' )
441 );
442
443 return $store;
444 },
445
446 'SearchEngineConfig' => function ( MediaWikiServices $services ) {
447 return new SearchEngineConfig( $services->getMainConfig(),
448 $services->getContentLanguage() );
449 },
450
451 'SearchEngineFactory' => function ( MediaWikiServices $services ) {
452 return new SearchEngineFactory( $services->getSearchEngineConfig() );
453 },
454
455 'ShellCommandFactory' => function ( MediaWikiServices $services ) {
456 $config = $services->getMainConfig();
457
458 $limits = [
459 'time' => $config->get( 'MaxShellTime' ),
460 'walltime' => $config->get( 'MaxShellWallClockTime' ),
461 'memory' => $config->get( 'MaxShellMemory' ),
462 'filesize' => $config->get( 'MaxShellFileSize' ),
463 ];
464 $cgroup = $config->get( 'ShellCgroup' );
465 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
466
467 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
468 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
469 $factory->logStderr();
470
471 return $factory;
472 },
473
474 'SiteLookup' => function ( MediaWikiServices $services ) {
475 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
476
477 if ( $cacheFile !== false ) {
478 return new FileBasedSiteLookup( $cacheFile );
479 } else {
480 // Use the default SiteStore as the SiteLookup implementation for now
481 return $services->getSiteStore();
482 }
483 },
484
485 'SiteStore' => function ( MediaWikiServices $services ) {
486 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
487
488 // TODO: replace wfGetCache with a CacheFactory service.
489 // TODO: replace wfIsHHVM with a capabilities service.
490 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
491
492 return new CachingSiteStore( $rawSiteStore, $cache );
493 },
494
495 'SkinFactory' => function ( MediaWikiServices $services ) {
496 $factory = new SkinFactory();
497
498 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
499
500 foreach ( $names as $name => $skin ) {
501 $factory->register( $name, $skin, function () use ( $name, $skin ) {
502 $class = "Skin$skin";
503 return new $class( $name );
504 } );
505 }
506 // Register a hidden "fallback" skin
507 $factory->register( 'fallback', 'Fallback', function () {
508 return new SkinFallback;
509 } );
510 // Register a hidden skin for api output
511 $factory->register( 'apioutput', 'ApiOutput', function () {
512 return new SkinApi;
513 } );
514
515 return $factory;
516 },
517
518 'SlotRoleStore' => function ( MediaWikiServices $services ) {
519 return new NameTableStore(
520 $services->getDBLoadBalancer(),
521 $services->getMainWANObjectCache(),
522 LoggerFactory::getInstance( 'NameTableSqlStore' ),
523 'slot_roles',
524 'role_id',
525 'role_name',
526 'strtolower'
527 );
528 },
529
530 'StatsdDataFactory' => function ( MediaWikiServices $services ) {
531 return new BufferingStatsdDataFactory(
532 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
533 );
534 },
535
536 'TitleFormatter' => function ( MediaWikiServices $services ) {
537 return $services->getService( '_MediaWikiTitleCodec' );
538 },
539
540 'TitleParser' => function ( MediaWikiServices $services ) {
541 return $services->getService( '_MediaWikiTitleCodec' );
542 },
543
544 'UploadRevisionImporter' => function ( MediaWikiServices $services ) {
545 return new ImportableUploadRevisionImporter(
546 $services->getMainConfig()->get( 'EnableUploads' ),
547 LoggerFactory::getInstance( 'UploadRevisionImporter' )
548 );
549 },
550
551 'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
552 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
553
554 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
555 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
556 $class = $serviceConfig['class'];
557 // Merge in the global defaults
558 $constructArg = $serviceConfig['options'] ?? [];
559 $constructArg += $config['global'];
560 // Make the VRS service available at the mount point
561 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
562 }
563
564 return $vrsClient;
565 },
566
567 'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
568 return new WatchedItemQueryService(
569 $services->getDBLoadBalancer(),
570 $services->getCommentStore(),
571 $services->getActorMigration()
572 );
573 },
574
575 'WatchedItemStore' => function ( MediaWikiServices $services ) {
576 $store = new WatchedItemStore(
577 $services->getDBLoadBalancer(),
578 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
579 $services->getReadOnlyMode(),
580 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
581 );
582 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
583
584 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
585 $store = new NoWriteWatchedItemStore( $store );
586 }
587
588 return $store;
589 },
590
591 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices $services ) {
592 return new ImportableOldRevisionImporter(
593 false,
594 LoggerFactory::getInstance( 'OldRevisionImporter' ),
595 $services->getDBLoadBalancer()
596 );
597 },
598
599 '_MediaWikiTitleCodec' => function ( MediaWikiServices $services ) {
600 return new MediaWikiTitleCodec(
601 $services->getContentLanguage(),
602 $services->getGenderCache(),
603 $services->getMainConfig()->get( 'LocalInterwikis' )
604 );
605 },
606
607 '_SqlBlobStore' => function ( MediaWikiServices $services ) {
608 return $services->getBlobStoreFactory()->newSqlBlobStore();
609 },
610
611 ///////////////////////////////////////////////////////////////////////////
612 // NOTE: When adding a service here, don't forget to add a getter function
613 // in the MediaWikiServices class. The convenience getter should just call
614 // $this->getService( 'FooBarService' ).
615 ///////////////////////////////////////////////////////////////////////////
616
617 ];