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\RevisionStore;
  49 use MediaWiki\Storage\SqlBlobStore;
  50 use Wikimedia\ObjectFactory;
  51
  52 return [
  53         'DBLoadBalancerFactory' => function ( MediaWikiServices $services ) {
  54                 $mainConfig = $services->getMainConfig();
  55
  56                 $lbConf = MWLBFactory::applyDefaultConfig(
  57                         $mainConfig->get( 'LBFactoryConf' ),
  58                         $mainConfig,
  59                         $services->getConfiguredReadOnlyMode()
  60                 );
  61                 $class = MWLBFactory::getLBFactoryClass( $lbConf );
  62
  63                 return new $class( $lbConf );
  64         },
  65
  66         'DBLoadBalancer' => function ( MediaWikiServices $services ) {
  67                 // just return the default LB from the DBLoadBalancerFactory service
  68                 return $services->getDBLoadBalancerFactory()->getMainLB();
  69         },
  70
  71         'SiteStore' => function ( MediaWikiServices $services ) {
  72                 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
  73
  74                 // TODO: replace wfGetCache with a CacheFactory service.
  75                 // TODO: replace wfIsHHVM with a capabilities service.
  76                 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
  77
  78                 return new CachingSiteStore( $rawSiteStore, $cache );
  79         },
  80
  81         'SiteLookup' => function ( MediaWikiServices $services ) {
  82                 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
  83
  84                 if ( $cacheFile !== false ) {
  85                         return new FileBasedSiteLookup( $cacheFile );
  86                 } else {
  87                         // Use the default SiteStore as the SiteLookup implementation for now
  88                         return $services->getSiteStore();
  89                 }
  90         },
  91
  92         'ConfigFactory' => function ( MediaWikiServices $services ) {
  93                 // Use the bootstrap config to initialize the ConfigFactory.
  94                 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
  95                 $factory = new ConfigFactory();
  96
  97                 foreach ( $registry as $name => $callback ) {
  98                         $factory->register( $name, $callback );
  99                 }
 100                 return $factory;
 101         },
 102
 103         'MainConfig' => function ( MediaWikiServices $services ) {
 104                 // Use the 'main' config from the ConfigFactory service.
 105                 return $services->getConfigFactory()->makeConfig( 'main' );
 106         },
 107
 108         'InterwikiLookup' => function ( MediaWikiServices $services ) {
 109                 global $wgContLang; // TODO: manage $wgContLang as a service
 110                 $config = $services->getMainConfig();
 111                 return new ClassicInterwikiLookup(
 112                         $wgContLang,
 113                         $services->getMainWANObjectCache(),
 114                         $config->get( 'InterwikiExpiry' ),
 115                         $config->get( 'InterwikiCache' ),
 116                         $config->get( 'InterwikiScopes' ),
 117                         $config->get( 'InterwikiFallbackSite' )
 118                 );
 119         },
 120
 121         'StatsdDataFactory' => function ( MediaWikiServices $services ) {
 122                 return new BufferingStatsdDataFactory(
 123                         rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
 124                 );
 125         },
 126
 127         'EventRelayerGroup' => function ( MediaWikiServices $services ) {
 128                 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
 129         },
 130
 131         'SearchEngineFactory' => function ( MediaWikiServices $services ) {
 132                 return new SearchEngineFactory( $services->getSearchEngineConfig() );
 133         },
 134
 135         'SearchEngineConfig' => function ( MediaWikiServices $services ) {
 136                 global $wgContLang;
 137                 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
 138         },
 139
 140         'SkinFactory' => function ( MediaWikiServices $services ) {
 141                 $factory = new SkinFactory();
 142
 143                 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
 144
 145                 foreach ( $names as $name => $skin ) {
 146                         $factory->register( $name, $skin, function () use ( $name, $skin ) {
 147                                 $class = "Skin$skin";
 148                                 return new $class( $name );
 149                         } );
 150                 }
 151                 // Register a hidden "fallback" skin
 152                 $factory->register( 'fallback', 'Fallback', function () {
 153                         return new SkinFallback;
 154                 } );
 155                 // Register a hidden skin for api output
 156                 $factory->register( 'apioutput', 'ApiOutput', function () {
 157                         return new SkinApi;
 158                 } );
 159
 160                 return $factory;
 161         },
 162
 163         'WatchedItemStore' => function ( MediaWikiServices $services ) {
 164                 $store = new WatchedItemStore(
 165                         $services->getDBLoadBalancer(),
 166                         new HashBagOStuff( [ 'maxKeys' => 100 ] ),
 167                         $services->getReadOnlyMode(),
 168                         $services->getMainConfig()->get( 'UpdateRowsPerQuery' )
 169                 );
 170                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 171
 172                 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
 173                         $store = new NoWriteWatchedItemStore( $store );
 174                 }
 175
 176                 return $store;
 177         },
 178
 179         'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
 180                 return new WatchedItemQueryService(
 181                         $services->getDBLoadBalancer(),
 182                         $services->getCommentStore(),
 183                         $services->getActorMigration()
 184                 );
 185         },
 186
 187         'CryptRand' => function ( MediaWikiServices $services ) {
 188                 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
 189                 return new CryptRand(
 190                         [
 191                                 // To try vary the system information of the state a bit more
 192                                 // by including the system's hostname into the state
 193                                 'wfHostname',
 194                                 // It's mostly worthless but throw the wiki's id into the data
 195                                 // for a little more variance
 196                                 'wfWikiID',
 197                                 // If we have a secret key set then throw it into the state as well
 198                                 function () use ( $secretKey ) {
 199                                         return $secretKey ?: '';
 200                                 }
 201                         ],
 202                         // The config file is likely the most often edited file we know should
 203                         // be around so include its stat info into the state.
 204                         // The constant with its location will almost always be defined, as
 205                         // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
 206                         // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
 207                         defined( 'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
 208                         LoggerFactory::getInstance( 'CryptRand' )
 209                 );
 210         },
 211
 212         'CryptHKDF' => function ( MediaWikiServices $services ) {
 213                 $config = $services->getMainConfig();
 214
 215                 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
 216                 if ( !$secret ) {
 217                         throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
 218                 }
 219
 220                 // In HKDF, the context can be known to the attacker, but this will
 221                 // keep simultaneous runs from producing the same output.
 222                 $context = [ microtime(), getmypid(), gethostname() ];
 223
 224                 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
 225                 $cache = $services->getLocalServerObjectCache();
 226                 if ( $cache instanceof EmptyBagOStuff ) {
 227                         $cache = ObjectCache::getLocalClusterInstance();
 228                 }
 229
 230                 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
 231                         $cache, $context, $services->getCryptRand()
 232                 );
 233         },
 234
 235         'MediaHandlerFactory' => function ( MediaWikiServices $services ) {
 236                 return new MediaHandlerFactory(
 237                         $services->getMainConfig()->get( 'MediaHandlers' )
 238                 );
 239         },
 240
 241         'MimeAnalyzer' => function ( MediaWikiServices $services ) {
 242                 $logger = LoggerFactory::getInstance( 'Mime' );
 243                 $mainConfig = $services->getMainConfig();
 244                 $params = [
 245                         'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
 246                         'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
 247                         'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
 248                         'guessCallback' =>
 249                                 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
 250                                         // Also test DjVu
 251                                         $deja = new DjVuImage( $file );
 252                                         if ( $deja->isValid() ) {
 253                                                 $logger->info( __METHOD__ . ": detected $file as image/vnd.djvu\n" );
 254                                                 $mime = 'image/vnd.djvu';
 255
 256                                                 return;
 257                                         }
 258                                         // Some strings by reference for performance - assuming well-behaved hooks
 259                                         Hooks::run(
 260                                                 'MimeMagicGuessFromContent',
 261                                                 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
 262                                         );
 263                                 },
 264                         'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
 265                                 // Media handling extensions can improve the MIME detected
 266                                 Hooks::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
 267                         },
 268                         'initCallback' => function ( $mimeAnalyzer ) {
 269                                 // Allow media handling extensions adding MIME-types and MIME-info
 270                                 Hooks::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
 271                         },
 272                         'logger' => $logger
 273                 ];
 274
 275                 if ( $params['infoFile'] === 'includes/mime.info' ) {
 276                         $params['infoFile'] = __DIR__ . "/libs/mime/mime.info";
 277                 }
 278
 279                 if ( $params['typeFile'] === 'includes/mime.types' ) {
 280                         $params['typeFile'] = __DIR__ . "/libs/mime/mime.types";
 281                 }
 282
 283                 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
 284                 if ( $detectorCmd ) {
 285                         $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
 286                                 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
 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                 $mainConfig = $services->getMainConfig();
 398
 399                 if ( function_exists( 'apc_fetch' ) ) {
 400                         $id = 'apc';
 401                 } elseif ( function_exists( 'apcu_fetch' ) ) {
 402                         $id = 'apcu';
 403                 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
 404                         $id = 'wincache';
 405                 } else {
 406                         $id = CACHE_NONE;
 407                 }
 408
 409                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 410                         throw new UnexpectedValueException(
 411                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 412                 }
 413
 414                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 415         },
 416
 417         'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
 418                 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
 419
 420                 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
 421                 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
 422                         $class = $serviceConfig['class'];
 423                         // Merge in the global defaults
 424                         $constructArg = isset( $serviceConfig['options'] )
 425                                 ? $serviceConfig['options']
 426                                 : [];
 427                         $constructArg += $config['global'];
 428                         // Make the VRS service available at the mount point
 429                         $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
 430                 }
 431
 432                 return $vrsClient;
 433         },
 434
 435         'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
 436                 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
 437         },
 438
 439         'ReadOnlyMode' => function ( MediaWikiServices $services ) {
 440                 return new ReadOnlyMode(
 441                         $services->getConfiguredReadOnlyMode(),
 442                         $services->getDBLoadBalancer()
 443                 );
 444         },
 445
 446         'UploadRevisionImporter' => function ( MediaWikiServices $services ) {
 447                 return new ImportableUploadRevisionImporter(
 448                         $services->getMainConfig()->get( 'EnableUploads' ),
 449                         LoggerFactory::getInstance( 'UploadRevisionImporter' )
 450                 );
 451         },
 452
 453         'OldRevisionImporter' => function ( MediaWikiServices $services ) {
 454                 return new ImportableOldRevisionImporter(
 455                         true,
 456                         LoggerFactory::getInstance( 'OldRevisionImporter' ),
 457                         $services->getDBLoadBalancer()
 458                 );
 459         },
 460
 461         'WikiRevisionOldRevisionImporterNoUpdates' => function ( MediaWikiServices $services ) {
 462                 return new ImportableOldRevisionImporter(
 463                         false,
 464                         LoggerFactory::getInstance( 'OldRevisionImporter' ),
 465                         $services->getDBLoadBalancer()
 466                 );
 467         },
 468
 469         'ShellCommandFactory' => function ( MediaWikiServices $services ) {
 470                 $config = $services->getMainConfig();
 471
 472                 $limits = [
 473                         'time' => $config->get( 'MaxShellTime' ),
 474                         'walltime' => $config->get( 'MaxShellWallClockTime' ),
 475                         'memory' => $config->get( 'MaxShellMemory' ),
 476                         'filesize' => $config->get( 'MaxShellFileSize' ),
 477                 ];
 478                 $cgroup = $config->get( 'ShellCgroup' );
 479                 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
 480
 481                 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
 482                 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
 483                 $factory->logStderr();
 484
 485                 return $factory;
 486         },
 487
 488         'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
 489                 $config = $services->getMainConfig();
 490
 491                 return new ExternalStoreFactory(
 492                         $config->get( 'ExternalStores' )
 493                 );
 494         },
 495
 496         'RevisionStore' => function ( MediaWikiServices $services ) {
 497                 /** @var SqlBlobStore $blobStore */
 498                 $blobStore = $services->getService( '_SqlBlobStore' );
 499
 500                 $store = new RevisionStore(
 501                         $services->getDBLoadBalancer(),
 502                         $blobStore,
 503                         $services->getMainWANObjectCache(),
 504                         $services->getCommentStore(),
 505                         $services->getActorMigration()
 506                 );
 507
 508                 $store->setLogger( LoggerFactory::getInstance( 'RevisionStore' ) );
 509
 510                 $config = $services->getMainConfig();
 511                 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
 512
 513                 return $store;
 514         },
 515
 516         'RevisionLookup' => function ( MediaWikiServices $services ) {
 517                 return $services->getRevisionStore();
 518         },
 519
 520         'RevisionFactory' => function ( MediaWikiServices $services ) {
 521                 return $services->getRevisionStore();
 522         },
 523
 524         'BlobStoreFactory' => function ( MediaWikiServices $services ) {
 525                 global $wgContLang;
 526                 return new BlobStoreFactory(
 527                         $services->getDBLoadBalancer(),
 528                         $services->getMainWANObjectCache(),
 529                         $services->getMainConfig(),
 530                         $wgContLang
 531                 );
 532         },
 533
 534         'BlobStore' => function ( MediaWikiServices $services ) {
 535                 return $services->getService( '_SqlBlobStore' );
 536         },
 537
 538         '_SqlBlobStore' => function ( MediaWikiServices $services ) {
 539                 return $services->getBlobStoreFactory()->newSqlBlobStore();
 540         },
 541
 542         'PreferencesFactory' => function ( MediaWikiServices $services ) {
 543                 global $wgContLang;
 544                 $authManager = AuthManager::singleton();
 545                 $linkRenderer = $services->getLinkRendererFactory()->create();
 546                 $config = $services->getMainConfig();
 547                 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
 548         },
 549
 550         'HttpRequestFactory' => function ( MediaWikiServices $services ) {
 551                 return new \MediaWiki\Http\HttpRequestFactory();
 552         },
 553
 554         'CommentStore' => function ( MediaWikiServices $services ) {
 555                 global $wgContLang;
 556                 return new CommentStore(
 557                         $wgContLang,
 558                         $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
 559                 );
 560         },
 561
 562         'ActorMigration' => function ( MediaWikiServices $services ) {
 563                 return new ActorMigration(
 564                         $services->getMainConfig()->get( 'ActorTableSchemaMigrationStage' )
 565                 );
 566         },
 567
 568         ///////////////////////////////////////////////////////////////////////////
 569         // NOTE: When adding a service here, don't forget to add a getter function
 570         // in the MediaWikiServices class. The convenience getter should just call
 571         // $this->getService( 'FooBarService' ).
 572         ///////////////////////////////////////////////////////////////////////////
 573
 574 ];