Merge "Install cache/integration-tests as require-dev"
[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 global $wgContLang; // TODO: manage $wgContLang as a service
119 $config = $services->getMainConfig();
120 return new ClassicInterwikiLookup(
121 $wgContLang,
122 $services->getMainWANObjectCache(),
123 $config->get( 'InterwikiExpiry' ),
124 $config->get( 'InterwikiCache' ),
125 $config->get( 'InterwikiScopes' ),
126 $config->get( 'InterwikiFallbackSite' )
127 );
128 },
129
130 'StatsdDataFactory' => function ( MediaWikiServices $services ) {
131 return new BufferingStatsdDataFactory(
132 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
133 );
134 },
135
136 'PerDbNameStatsdDataFactory' => function ( MediaWikiServices $services ) {
137 $config = $services->getMainConfig();
138 $wiki = $config->get( 'DBname' );
139 return new BufferingStatsdDataFactory(
140 rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' ) . $wiki
141 );
142 },
143
144 'EventRelayerGroup' => function ( MediaWikiServices $services ) {
145 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
146 },
147
148 'SearchEngineFactory' => function ( MediaWikiServices $services ) {
149 return new SearchEngineFactory( $services->getSearchEngineConfig() );
150 },
151
152 'SearchEngineConfig' => function ( MediaWikiServices $services ) {
153 global $wgContLang;
154 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
155 },
156
157 'SkinFactory' => function ( MediaWikiServices $services ) {
158 $factory = new SkinFactory();
159
160 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
161
162 foreach ( $names as $name => $skin ) {
163 $factory->register( $name, $skin, function () use ( $name, $skin ) {
164 $class = "Skin$skin";
165 return new $class( $name );
166 } );
167 }
168 // Register a hidden "fallback" skin
169 $factory->register( 'fallback', 'Fallback', function () {
170 return new SkinFallback;
171 } );
172 // Register a hidden skin for api output
173 $factory->register( 'apioutput', 'ApiOutput', function () {
174 return new SkinApi;
175 } );
176
177 return $factory;
178 },
179
180 'WatchedItemStore' => function ( MediaWikiServices $services ) {
181 $store = new WatchedItemStore(
182 $services->getDBLoadBalancer(),
183 new HashBagOStuff( [ 'maxKeys' => 100 ] ),
184 $services->getReadOnlyMode(),
185 $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
186 );
187 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
188
189 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
190 $store = new NoWriteWatchedItemStore( $store );
191 }
192
193 return $store;
194 },
195
196 'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
197 return new WatchedItemQueryService(
198 $services->getDBLoadBalancer(),
199 $services->getCommentStore(),
200 $services->getActorMigration()
201 );
202 },
203
204 'CryptRand' => function () {
205 return new CryptRand();
206 },
207
208 'CryptHKDF' => function ( MediaWikiServices $services ) {
209 $config = $services->getMainConfig();
210
211 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
212 if ( !$secret ) {
213 throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
214 }
215
216 // In HKDF, the context can be known to the attacker, but this will
217 // keep simultaneous runs from producing the same output.
218 $context = [ microtime(), getmypid(), gethostname() ];
219
220 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
221 $cache = $services->getLocalServerObjectCache();
222 if ( $cache instanceof EmptyBagOStuff ) {
223 $cache = ObjectCache::getLocalClusterInstance();
224 }
225
226 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ), $cache, $context );
227 },
228
229 'MediaHandlerFactory' => function ( MediaWikiServices $services ) {
230 return new MediaHandlerFactory(
231 $services->getMainConfig()->get( 'MediaHandlers' )
232 );
233 },
234
235 'MimeAnalyzer' => function ( MediaWikiServices $services ) {
236 $logger = LoggerFactory::getInstance( 'Mime' );
237 $mainConfig = $services->getMainConfig();
238 $params = [
239 'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
240 'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
241 'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
242 'guessCallback' =>
243 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
244 // Also test DjVu
245 $deja = new DjVuImage( $file );
246 if ( $deja->isValid() ) {
247 $logger->info( __METHOD__ . ": detected $file as image/vnd.djvu\n" );
248 $mime = 'image/vnd.djvu';
249
250 return;
251 }
252 // Some strings by reference for performance - assuming well-behaved hooks
253 Hooks::run(
254 'MimeMagicGuessFromContent',
255 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
256 );
257 },
258 'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
259 // Media handling extensions can improve the MIME detected
260 Hooks::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
261 },
262 'initCallback' => function ( $mimeAnalyzer ) {
263 // Allow media handling extensions adding MIME-types and MIME-info
264 Hooks::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
265 },
266 'logger' => $logger
267 ];
268
269 if ( $params['infoFile'] === 'includes/mime.info' ) {
270 $params['infoFile'] = __DIR__ . "/libs/mime/mime.info";
271 }
272
273 if ( $params['typeFile'] === 'includes/mime.types' ) {
274 $params['typeFile'] = __DIR__ . "/libs/mime/mime.types";
275 }
276
277 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
278 if ( $detectorCmd ) {
279 $factory = $services->getShellCommandFactory();
280 $params['detectCallback'] = function ( $file ) use ( $detectorCmd, $factory ) {
281 $result = $factory->create()
282 // $wgMimeDetectorCommand can contain commands with parameters
283 ->unsafeParams( $detectorCmd )
284 ->params( $file )
285 ->execute();
286 return $result->getStdout();
287 };
288 }
289
290 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
291 return new MimeMagic( $params );
292 },
293
294 'ProxyLookup' => function ( MediaWikiServices $services ) {
295 $mainConfig = $services->getMainConfig();
296 return new ProxyLookup(
297 $mainConfig->get( 'SquidServers' ),
298 $mainConfig->get( 'SquidServersNoPurge' )
299 );
300 },
301
302 'Parser' => function ( MediaWikiServices $services ) {
303 $conf = $services->getMainConfig()->get( 'ParserConf' );
304 return ObjectFactory::constructClassInstance( $conf['class'], [ $conf ] );
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 global $wgContLang;
348
349 return new MediaWikiTitleCodec(
350 $wgContLang,
351 $services->getGenderCache(),
352 $services->getMainConfig()->get( 'LocalInterwikis' )
353 );
354 },
355
356 'TitleFormatter' => function ( MediaWikiServices $services ) {
357 return $services->getService( '_MediaWikiTitleCodec' );
358 },
359
360 'TitleParser' => function ( MediaWikiServices $services ) {
361 return $services->getService( '_MediaWikiTitleCodec' );
362 },
363
364 'MainObjectStash' => function ( MediaWikiServices $services ) {
365 $mainConfig = $services->getMainConfig();
366
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." );
371 }
372
373 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
374 },
375
376 'MainWANObjectCache' => function ( MediaWikiServices $services ) {
377 $mainConfig = $services->getMainConfig();
378
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." );
383 }
384
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." );
390 }
391 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
392
393 return \ObjectCache::newWANCacheFromParams( $params );
394 },
395
396 'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
397 $cacheId = \ObjectCache::detectLocalServerCache();
398 return \ObjectCache::newFromId( $cacheId );
399 },
400
401 'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
402 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
403
404 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
405 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
406 $class = $serviceConfig['class'];
407 // Merge in the global defaults
408 $constructArg = $serviceConfig['options'] ?? [];
409 $constructArg += $config['global'];
410 // Make the VRS service available at the mount point
411 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
412 }
413
414 return $vrsClient;
415 },
416
417 'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
418 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
419 },
420
421 'ReadOnlyMode' => function ( MediaWikiServices $services ) {
422 return new ReadOnlyMode(
423 $services->getConfiguredReadOnlyMode(),
424 $services->getDBLoadBalancer()
425 );
426 },
427
428 'UploadRevisionImporter' => function ( MediaWikiServices $services ) {
429 return new ImportableUploadRevisionImporter(
430 $services->getMainConfig()->get( 'EnableUploads' ),
431 LoggerFactory::getInstance( 'UploadRevisionImporter' )
432 );
433 },
434
435 'OldRevisionImporter' => function ( MediaWikiServices $services ) {
436 return new ImportableOldRevisionImporter(
437 true,
438 LoggerFactory::getInstance( 'OldRevisionImporter' ),
439 $services->getDBLoadBalancer()
440 );
441 },
442
443 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices $services ) {
444 return new ImportableOldRevisionImporter(
445 false,
446 LoggerFactory::getInstance( 'OldRevisionImporter' ),
447 $services->getDBLoadBalancer()
448 );
449 },
450
451 'ShellCommandFactory' => function ( MediaWikiServices $services ) {
452 $config = $services->getMainConfig();
453
454 $limits = [
455 'time' => $config->get( 'MaxShellTime' ),
456 'walltime' => $config->get( 'MaxShellWallClockTime' ),
457 'memory' => $config->get( 'MaxShellMemory' ),
458 'filesize' => $config->get( 'MaxShellFileSize' ),
459 ];
460 $cgroup = $config->get( 'ShellCgroup' );
461 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
462
463 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
464 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
465 $factory->logStderr();
466
467 return $factory;
468 },
469
470 'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
471 $config = $services->getMainConfig();
472
473 return new ExternalStoreFactory(
474 $config->get( 'ExternalStores' )
475 );
476 },
477
478 'RevisionStore' => function ( MediaWikiServices $services ) {
479 /** @var SqlBlobStore $blobStore */
480 $blobStore = $services->getService( '_SqlBlobStore' );
481
482 $store = new RevisionStore(
483 $services->getDBLoadBalancer(),
484 $blobStore,
485 $services->getMainWANObjectCache(),
486 $services->getCommentStore(),
487 $services->getContentModelStore(),
488 $services->getSlotRoleStore(),
489 $services->getMainConfig()->get( 'MultiContentRevisionSchemaMigrationStage' ),
490 $services->getActorMigration()
491 );
492
493 $store->setLogger( LoggerFactory::getInstance( 'RevisionStore' ) );
494
495 $config = $services->getMainConfig();
496 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
497
498 return $store;
499 },
500
501 'RevisionLookup' => function ( MediaWikiServices $services ) {
502 return $services->getRevisionStore();
503 },
504
505 'RevisionFactory' => function ( MediaWikiServices $services ) {
506 return $services->getRevisionStore();
507 },
508
509 'BlobStoreFactory' => function ( MediaWikiServices $services ) {
510 global $wgContLang;
511 return new BlobStoreFactory(
512 $services->getDBLoadBalancer(),
513 $services->getMainWANObjectCache(),
514 $services->getMainConfig(),
515 $wgContLang
516 );
517 },
518
519 'BlobStore' => function ( MediaWikiServices $services ) {
520 return $services->getService( '_SqlBlobStore' );
521 },
522
523 '_SqlBlobStore' => function ( MediaWikiServices $services ) {
524 return $services->getBlobStoreFactory()->newSqlBlobStore();
525 },
526
527 'ContentModelStore' => function ( MediaWikiServices $services ) {
528 return new NameTableStore(
529 $services->getDBLoadBalancer(),
530 $services->getMainWANObjectCache(),
531 LoggerFactory::getInstance( 'NameTableSqlStore' ),
532 'content_models',
533 'model_id',
534 'model_name'
535 /**
536 * No strtolower normalization is added to the service as there are examples of
537 * extensions that do not stick to this assumption.
538 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
539 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
540 */
541 );
542 },
543
544 'SlotRoleStore' => function ( MediaWikiServices $services ) {
545 return new NameTableStore(
546 $services->getDBLoadBalancer(),
547 $services->getMainWANObjectCache(),
548 LoggerFactory::getInstance( 'NameTableSqlStore' ),
549 'slot_roles',
550 'role_id',
551 'role_name',
552 'strtolower'
553 );
554 },
555
556 'ChangeTagDefStore' => function ( MediaWikiServices $services ) {
557 return new NameTableStore(
558 $services->getDBLoadBalancer(),
559 $services->getMainWANObjectCache(),
560 LoggerFactory::getInstance( 'NameTableSqlStore' ),
561 'change_tag_def',
562 'ctd_id',
563 'ctd_name',
564 null,
565 false,
566 function ( $insertFields ) {
567 $insertFields['ctd_user_defined'] = 0;
568 $insertFields['ctd_count'] = 0;
569 return $insertFields;
570 }
571 );
572 },
573
574 'PreferencesFactory' => function ( MediaWikiServices $services ) {
575 global $wgContLang;
576 $authManager = AuthManager::singleton();
577 $linkRenderer = $services->getLinkRendererFactory()->create();
578 $config = $services->getMainConfig();
579 $factory = new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
580 $factory->setLogger( LoggerFactory::getInstance( 'preferences' ) );
581
582 return $factory;
583 },
584
585 'HttpRequestFactory' => function ( MediaWikiServices $services ) {
586 return new \MediaWiki\Http\HttpRequestFactory();
587 },
588
589 'CommentStore' => function ( MediaWikiServices $services ) {
590 global $wgContLang;
591 return new CommentStore(
592 $wgContLang,
593 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
594 );
595 },
596
597 'ActorMigration' => function ( MediaWikiServices $services ) {
598 return new ActorMigration(
599 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
600 );
601 },
602
603 ///////////////////////////////////////////////////////////////////////////
604 // NOTE: When adding a service here, don't forget to add a getter function
605 // in the MediaWikiServices class. The convenience getter should just call
606 // $this->getService( 'FooBarService' ).
607 ///////////////////////////////////////////////////////////////////////////
608
609 ];