Merge "Add explanation about JS editing changes to permission error"
[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'],
305 [ $conf, $services->getMagicWordFactory() ] );
306 },
307
308 'ParserCache' => function ( MediaWikiServices $services ) {
309 $config = $services->getMainConfig();
310 $cache = ObjectCache::getInstance( $config->get( 'ParserCacheType' ) );
311 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
312
313 return new ParserCache(
314 $cache,
315 $config->get( 'CacheEpoch' )
316 );
317 },
318
319 'LinkCache' => function ( MediaWikiServices $services ) {
320 return new LinkCache(
321 $services->getTitleFormatter(),
322 $services->getMainWANObjectCache()
323 );
324 },
325
326 'LinkRendererFactory' => function ( MediaWikiServices $services ) {
327 return new LinkRendererFactory(
328 $services->getTitleFormatter(),
329 $services->getLinkCache()
330 );
331 },
332
333 'LinkRenderer' => function ( MediaWikiServices $services ) {
334 global $wgUser;
335
336 if ( defined( 'MW_NO_SESSION' ) ) {
337 return $services->getLinkRendererFactory()->create();
338 } else {
339 return $services->getLinkRendererFactory()->createForUser( $wgUser );
340 }
341 },
342
343 'GenderCache' => function ( MediaWikiServices $services ) {
344 return new GenderCache();
345 },
346
347 '_MediaWikiTitleCodec' => function ( MediaWikiServices $services ) {
348 global $wgContLang;
349
350 return new MediaWikiTitleCodec(
351 $wgContLang,
352 $services->getGenderCache(),
353 $services->getMainConfig()->get( 'LocalInterwikis' )
354 );
355 },
356
357 'TitleFormatter' => function ( MediaWikiServices $services ) {
358 return $services->getService( '_MediaWikiTitleCodec' );
359 },
360
361 'TitleParser' => function ( MediaWikiServices $services ) {
362 return $services->getService( '_MediaWikiTitleCodec' );
363 },
364
365 'MainObjectStash' => function ( MediaWikiServices $services ) {
366 $mainConfig = $services->getMainConfig();
367
368 $id = $mainConfig->get( 'MainStash' );
369 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
370 throw new UnexpectedValueException(
371 "Cache type \"$id\" is not present in \$wgObjectCaches." );
372 }
373
374 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
375 },
376
377 'MainWANObjectCache' => function ( MediaWikiServices $services ) {
378 $mainConfig = $services->getMainConfig();
379
380 $id = $mainConfig->get( 'MainWANCache' );
381 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
382 throw new UnexpectedValueException(
383 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
384 }
385
386 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
387 $objectCacheId = $params['cacheId'];
388 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
389 throw new UnexpectedValueException(
390 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
391 }
392 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
393
394 return \ObjectCache::newWANCacheFromParams( $params );
395 },
396
397 'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
398 $cacheId = \ObjectCache::detectLocalServerCache();
399 return \ObjectCache::newFromId( $cacheId );
400 },
401
402 'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
403 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
404
405 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
406 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
407 $class = $serviceConfig['class'];
408 // Merge in the global defaults
409 $constructArg = $serviceConfig['options'] ?? [];
410 $constructArg += $config['global'];
411 // Make the VRS service available at the mount point
412 $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
413 }
414
415 return $vrsClient;
416 },
417
418 'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
419 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
420 },
421
422 'ReadOnlyMode' => function ( MediaWikiServices $services ) {
423 return new ReadOnlyMode(
424 $services->getConfiguredReadOnlyMode(),
425 $services->getDBLoadBalancer()
426 );
427 },
428
429 'UploadRevisionImporter' => function ( MediaWikiServices $services ) {
430 return new ImportableUploadRevisionImporter(
431 $services->getMainConfig()->get( 'EnableUploads' ),
432 LoggerFactory::getInstance( 'UploadRevisionImporter' )
433 );
434 },
435
436 'OldRevisionImporter' => function ( MediaWikiServices $services ) {
437 return new ImportableOldRevisionImporter(
438 true,
439 LoggerFactory::getInstance( 'OldRevisionImporter' ),
440 $services->getDBLoadBalancer()
441 );
442 },
443
444 'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices $services ) {
445 return new ImportableOldRevisionImporter(
446 false,
447 LoggerFactory::getInstance( 'OldRevisionImporter' ),
448 $services->getDBLoadBalancer()
449 );
450 },
451
452 'ShellCommandFactory' => function ( MediaWikiServices $services ) {
453 $config = $services->getMainConfig();
454
455 $limits = [
456 'time' => $config->get( 'MaxShellTime' ),
457 'walltime' => $config->get( 'MaxShellWallClockTime' ),
458 'memory' => $config->get( 'MaxShellMemory' ),
459 'filesize' => $config->get( 'MaxShellFileSize' ),
460 ];
461 $cgroup = $config->get( 'ShellCgroup' );
462 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
463
464 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
465 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
466 $factory->logStderr();
467
468 return $factory;
469 },
470
471 'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
472 $config = $services->getMainConfig();
473
474 return new ExternalStoreFactory(
475 $config->get( 'ExternalStores' )
476 );
477 },
478
479 'RevisionStore' => function ( MediaWikiServices $services ) {
480 /** @var SqlBlobStore $blobStore */
481 $blobStore = $services->getService( '_SqlBlobStore' );
482
483 $store = new RevisionStore(
484 $services->getDBLoadBalancer(),
485 $blobStore,
486 $services->getMainWANObjectCache(),
487 $services->getCommentStore(),
488 $services->getContentModelStore(),
489 $services->getSlotRoleStore(),
490 $services->getMainConfig()->get( 'MultiContentRevisionSchemaMigrationStage' ),
491 $services->getActorMigration()
492 );
493
494 $store->setLogger( LoggerFactory::getInstance( 'RevisionStore' ) );
495
496 $config = $services->getMainConfig();
497 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
498
499 return $store;
500 },
501
502 'RevisionLookup' => function ( MediaWikiServices $services ) {
503 return $services->getRevisionStore();
504 },
505
506 'RevisionFactory' => function ( MediaWikiServices $services ) {
507 return $services->getRevisionStore();
508 },
509
510 'BlobStoreFactory' => function ( MediaWikiServices $services ) {
511 global $wgContLang;
512 return new BlobStoreFactory(
513 $services->getDBLoadBalancer(),
514 $services->getMainWANObjectCache(),
515 $services->getMainConfig(),
516 $wgContLang
517 );
518 },
519
520 'BlobStore' => function ( MediaWikiServices $services ) {
521 return $services->getService( '_SqlBlobStore' );
522 },
523
524 '_SqlBlobStore' => function ( MediaWikiServices $services ) {
525 return $services->getBlobStoreFactory()->newSqlBlobStore();
526 },
527
528 'ContentModelStore' => function ( MediaWikiServices $services ) {
529 return new NameTableStore(
530 $services->getDBLoadBalancer(),
531 $services->getMainWANObjectCache(),
532 LoggerFactory::getInstance( 'NameTableSqlStore' ),
533 'content_models',
534 'model_id',
535 'model_name'
536 /**
537 * No strtolower normalization is added to the service as there are examples of
538 * extensions that do not stick to this assumption.
539 * - extensions/examples/DataPages define( 'CONTENT_MODEL_XML_DATA','XML_DATA' );
540 * - extensions/Scribunto define( 'CONTENT_MODEL_SCRIBUNTO', 'Scribunto' );
541 */
542 );
543 },
544
545 'SlotRoleStore' => function ( MediaWikiServices $services ) {
546 return new NameTableStore(
547 $services->getDBLoadBalancer(),
548 $services->getMainWANObjectCache(),
549 LoggerFactory::getInstance( 'NameTableSqlStore' ),
550 'slot_roles',
551 'role_id',
552 'role_name',
553 'strtolower'
554 );
555 },
556
557 'ChangeTagDefStore' => function ( MediaWikiServices $services ) {
558 return new NameTableStore(
559 $services->getDBLoadBalancer(),
560 $services->getMainWANObjectCache(),
561 LoggerFactory::getInstance( 'NameTableSqlStore' ),
562 'change_tag_def',
563 'ctd_id',
564 'ctd_name',
565 null,
566 false,
567 function ( $insertFields ) {
568 $insertFields['ctd_user_defined'] = 0;
569 $insertFields['ctd_count'] = 0;
570 return $insertFields;
571 }
572 );
573 },
574
575 'PreferencesFactory' => function ( MediaWikiServices $services ) {
576 global $wgContLang;
577 $authManager = AuthManager::singleton();
578 $linkRenderer = $services->getLinkRendererFactory()->create();
579 $config = $services->getMainConfig();
580 $factory = new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
581 $factory->setLogger( LoggerFactory::getInstance( 'preferences' ) );
582
583 return $factory;
584 },
585
586 'HttpRequestFactory' => function ( MediaWikiServices $services ) {
587 return new \MediaWiki\Http\HttpRequestFactory();
588 },
589
590 'CommentStore' => function ( MediaWikiServices $services ) {
591 global $wgContLang;
592 return new CommentStore(
593 $wgContLang,
594 $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
595 );
596 },
597
598 'ActorMigration' => function ( MediaWikiServices $services ) {
599 return new ActorMigration(
600 $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
601 );
602 },
603
604 'MagicWordFactory' => function ( MediaWikiServices $services ) {
605 global $wgContLang;
606 return new MagicWordFactory( $wgContLang );
607 },
608
609 ///////////////////////////////////////////////////////////////////////////
610 // NOTE: When adding a service here, don't forget to add a getter function
611 // in the MediaWikiServices class. The convenience getter should just call
612 // $this->getService( 'FooBarService' ).
613 ///////////////////////////////////////////////////////////////////////////
614
615 ];