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                 );
 169                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 170
 171                 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
 172                         $store = new NoWriteWatchedItemStore( $store );
 173                 }
 174
 175                 return $store;
 176         },
 177
 178         'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
 179                 return new WatchedItemQueryService(
 180                         $services->getDBLoadBalancer(),
 181                         $services->getCommentStore()
 182                 );
 183         },
 184
 185         'CryptRand' => function ( MediaWikiServices $services ) {
 186                 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
 187                 return new CryptRand(
 188                         [
 189                                 // To try vary the system information of the state a bit more
 190                                 // by including the system's hostname into the state
 191                                 'wfHostname',
 192                                 // It's mostly worthless but throw the wiki's id into the data
 193                                 // for a little more variance
 194                                 'wfWikiID',
 195                                 // If we have a secret key set then throw it into the state as well
 196                                 function () use ( $secretKey ) {
 197                                         return $secretKey ?: '';
 198                                 }
 199                         ],
 200                         // The config file is likely the most often edited file we know should
 201                         // be around so include its stat info into the state.
 202                         // The constant with its location will almost always be defined, as
 203                         // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
 204                         // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
 205                         defined( 'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
 206                         LoggerFactory::getInstance( 'CryptRand' )
 207                 );
 208         },
 209
 210         'CryptHKDF' => function ( MediaWikiServices $services ) {
 211                 $config = $services->getMainConfig();
 212
 213                 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
 214                 if ( !$secret ) {
 215                         throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
 216                 }
 217
 218                 // In HKDF, the context can be known to the attacker, but this will
 219                 // keep simultaneous runs from producing the same output.
 220                 $context = [ microtime(), getmypid(), gethostname() ];
 221
 222                 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
 223                 $cache = $services->getLocalServerObjectCache();
 224                 if ( $cache instanceof EmptyBagOStuff ) {
 225                         $cache = ObjectCache::getLocalClusterInstance();
 226                 }
 227
 228                 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
 229                         $cache, $context, $services->getCryptRand()
 230                 );
 231         },
 232
 233         'MediaHandlerFactory' => function ( MediaWikiServices $services ) {
 234                 return new MediaHandlerFactory(
 235                         $services->getMainConfig()->get( 'MediaHandlers' )
 236                 );
 237         },
 238
 239         'MimeAnalyzer' => function ( MediaWikiServices $services ) {
 240                 $logger = LoggerFactory::getInstance( 'Mime' );
 241                 $mainConfig = $services->getMainConfig();
 242                 $params = [
 243                         'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
 244                         'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
 245                         'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
 246                         'guessCallback' =>
 247                                 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
 248                                         // Also test DjVu
 249                                         $deja = new DjVuImage( $file );
 250                                         if ( $deja->isValid() ) {
 251                                                 $logger->info( __METHOD__ . ": detected $file as image/vnd.djvu\n" );
 252                                                 $mime = 'image/vnd.djvu';
 253
 254                                                 return;
 255                                         }
 256                                         // Some strings by reference for performance - assuming well-behaved hooks
 257                                         Hooks::run(
 258                                                 'MimeMagicGuessFromContent',
 259                                                 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
 260                                         );
 261                                 },
 262                         'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
 263                                 // Media handling extensions can improve the MIME detected
 264                                 Hooks::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
 265                         },
 266                         'initCallback' => function ( $mimeAnalyzer ) {
 267                                 // Allow media handling extensions adding MIME-types and MIME-info
 268                                 Hooks::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
 269                         },
 270                         'logger' => $logger
 271                 ];
 272
 273                 if ( $params['infoFile'] === 'includes/mime.info' ) {
 274                         $params['infoFile'] = __DIR__ . "/libs/mime/mime.info";
 275                 }
 276
 277                 if ( $params['typeFile'] === 'includes/mime.types' ) {
 278                         $params['typeFile'] = __DIR__ . "/libs/mime/mime.types";
 279                 }
 280
 281                 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
 282                 if ( $detectorCmd ) {
 283                         $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
 284                                 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
 285                         };
 286                 }
 287
 288                 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
 289                 return new MimeMagic( $params );
 290         },
 291
 292         'ProxyLookup' => function ( MediaWikiServices $services ) {
 293                 $mainConfig = $services->getMainConfig();
 294                 return new ProxyLookup(
 295                         $mainConfig->get( 'SquidServers' ),
 296                         $mainConfig->get( 'SquidServersNoPurge' )
 297                 );
 298         },
 299
 300         'Parser' => function ( MediaWikiServices $services ) {
 301                 $conf = $services->getMainConfig()->get( 'ParserConf' );
 302                 return ObjectFactory::constructClassInstance( $conf['class'], [ $conf ] );
 303         },
 304
 305         'ParserCache' => function ( MediaWikiServices $services ) {
 306                 $config = $services->getMainConfig();
 307                 $cache = ObjectCache::getInstance( $config->get( 'ParserCacheType' ) );
 308                 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
 309
 310                 return new ParserCache(
 311                         $cache,
 312                         $config->get( 'CacheEpoch' )
 313                 );
 314         },
 315
 316         'LinkCache' => function ( MediaWikiServices $services ) {
 317                 return new LinkCache(
 318                         $services->getTitleFormatter(),
 319                         $services->getMainWANObjectCache()
 320                 );
 321         },
 322
 323         'LinkRendererFactory' => function ( MediaWikiServices $services ) {
 324                 return new LinkRendererFactory(
 325                         $services->getTitleFormatter(),
 326                         $services->getLinkCache()
 327                 );
 328         },
 329
 330         'LinkRenderer' => function ( MediaWikiServices $services ) {
 331                 global $wgUser;
 332
 333                 if ( defined( 'MW_NO_SESSION' ) ) {
 334                         return $services->getLinkRendererFactory()->create();
 335                 } else {
 336                         return $services->getLinkRendererFactory()->createForUser( $wgUser );
 337                 }
 338         },
 339
 340         'GenderCache' => function ( MediaWikiServices $services ) {
 341                 return new GenderCache();
 342         },
 343
 344         '_MediaWikiTitleCodec' => function ( MediaWikiServices $services ) {
 345                 global $wgContLang;
 346
 347                 return new MediaWikiTitleCodec(
 348                         $wgContLang,
 349                         $services->getGenderCache(),
 350                         $services->getMainConfig()->get( 'LocalInterwikis' )
 351                 );
 352         },
 353
 354         'TitleFormatter' => function ( MediaWikiServices $services ) {
 355                 return $services->getService( '_MediaWikiTitleCodec' );
 356         },
 357
 358         'TitleParser' => function ( MediaWikiServices $services ) {
 359                 return $services->getService( '_MediaWikiTitleCodec' );
 360         },
 361
 362         'MainObjectStash' => function ( MediaWikiServices $services ) {
 363                 $mainConfig = $services->getMainConfig();
 364
 365                 $id = $mainConfig->get( 'MainStash' );
 366                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 367                         throw new UnexpectedValueException(
 368                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 369                 }
 370
 371                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 372         },
 373
 374         'MainWANObjectCache' => function ( MediaWikiServices $services ) {
 375                 $mainConfig = $services->getMainConfig();
 376
 377                 $id = $mainConfig->get( 'MainWANCache' );
 378                 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
 379                         throw new UnexpectedValueException(
 380                                 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
 381                 }
 382
 383                 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
 384                 $objectCacheId = $params['cacheId'];
 385                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
 386                         throw new UnexpectedValueException(
 387                                 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
 388                 }
 389                 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
 390
 391                 return \ObjectCache::newWANCacheFromParams( $params );
 392         },
 393
 394         'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
 395                 $mainConfig = $services->getMainConfig();
 396
 397                 if ( function_exists( 'apc_fetch' ) ) {
 398                         $id = 'apc';
 399                 } elseif ( function_exists( 'apcu_fetch' ) ) {
 400                         $id = 'apcu';
 401                 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
 402                         $id = 'xcache';
 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         'ShellCommandFactory' => function ( MediaWikiServices $services ) {
 447                 $config = $services->getMainConfig();
 448
 449                 $limits = [
 450                         'time' => $config->get( 'MaxShellTime' ),
 451                         'walltime' => $config->get( 'MaxShellWallClockTime' ),
 452                         'memory' => $config->get( 'MaxShellMemory' ),
 453                         'filesize' => $config->get( 'MaxShellFileSize' ),
 454                 ];
 455                 $cgroup = $config->get( 'ShellCgroup' );
 456                 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
 457
 458                 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
 459                 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
 460                 $factory->logStderr();
 461
 462                 return $factory;
 463         },
 464
 465         'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
 466                 $config = $services->getMainConfig();
 467
 468                 return new ExternalStoreFactory(
 469                         $config->get( 'ExternalStores' )
 470                 );
 471         },
 472
 473         'RevisionStore' => function ( MediaWikiServices $services ) {
 474                 /** @var SqlBlobStore $blobStore */
 475                 $blobStore = $services->getService( '_SqlBlobStore' );
 476
 477                 $store = new RevisionStore(
 478                         $services->getDBLoadBalancer(),
 479                         $blobStore,
 480                         $services->getMainWANObjectCache()
 481                 );
 482
 483                 $store->setLogger( LoggerFactory::getInstance( 'RevisionStore' ) );
 484
 485                 $config = $services->getMainConfig();
 486                 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
 487
 488                 return $store;
 489         },
 490
 491         'RevisionLookup' => function ( MediaWikiServices $services ) {
 492                 return $services->getRevisionStore();
 493         },
 494
 495         'RevisionFactory' => function ( MediaWikiServices $services ) {
 496                 return $services->getRevisionStore();
 497         },
 498
 499         'BlobStoreFactory' => function ( MediaWikiServices $services ) {
 500                 global $wgContLang;
 501                 return new BlobStoreFactory(
 502                         $services->getDBLoadBalancer(),
 503                         $services->getMainWANObjectCache(),
 504                         $services->getMainConfig(),
 505                         $wgContLang
 506                 );
 507         },
 508
 509         'BlobStore' => function ( MediaWikiServices $services ) {
 510                 return $services->getService( '_SqlBlobStore' );
 511         },
 512
 513         '_SqlBlobStore' => function ( MediaWikiServices $services ) {
 514                 return $services->getBlobStoreFactory()->newSqlBlobStore();
 515         },
 516
 517         'PreferencesFactory' => function ( MediaWikiServices $services ) {
 518                 global $wgContLang;
 519                 $authManager = AuthManager::singleton();
 520                 $linkRenderer = $services->getLinkRendererFactory()->create();
 521                 $config = $services->getMainConfig();
 522                 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
 523         },
 524
 525         'HttpRequestFactory' => function ( MediaWikiServices $services ) {
 526                 return new \MediaWiki\Http\HttpRequestFactory();
 527         },
 528
 529         'CommentStore' => function ( MediaWikiServices $services ) {
 530                 global $wgContLang;
 531                 return new CommentStore(
 532                         $wgContLang,
 533                         $services->getMainConfig()->get( 'CommentTableSchemaMigrationStage' )
 534                 );
 535         }
 536
 537         ///////////////////////////////////////////////////////////////////////////
 538         // NOTE: When adding a service here, don't forget to add a getter function
 539         // in the MediaWikiServices class. The convenience getter should just call
 540         // $this->getService( 'FooBarService' ).
 541         ///////////////////////////////////////////////////////////////////////////
 542
 543 ];