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