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