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
  51 return [
  52         'DBLoadBalancerFactory' => function ( MediaWikiServices $services ) {
  53                 $mainConfig = $services->getMainConfig();
  54
  55                 $lbConf = MWLBFactory::applyDefaultConfig(
  56                         $mainConfig->get( 'LBFactoryConf' ),
  57                         $mainConfig,
  58                         $services->getConfiguredReadOnlyMode()
  59                 );
  60                 $class = MWLBFactory::getLBFactoryClass( $lbConf );
  61
  62                 return new $class( $lbConf );
  63         },
  64
  65         'DBLoadBalancer' => function ( MediaWikiServices $services ) {
  66                 // just return the default LB from the DBLoadBalancerFactory service
  67                 return $services->getDBLoadBalancerFactory()->getMainLB();
  68         },
  69
  70         'SiteStore' => function ( MediaWikiServices $services ) {
  71                 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
  72
  73                 // TODO: replace wfGetCache with a CacheFactory service.
  74                 // TODO: replace wfIsHHVM with a capabilities service.
  75                 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
  76
  77                 return new CachingSiteStore( $rawSiteStore, $cache );
  78         },
  79
  80         'SiteLookup' => function ( MediaWikiServices $services ) {
  81                 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
  82
  83                 if ( $cacheFile !== false ) {
  84                         return new FileBasedSiteLookup( $cacheFile );
  85                 } else {
  86                         // Use the default SiteStore as the SiteLookup implementation for now
  87                         return $services->getSiteStore();
  88                 }
  89         },
  90
  91         'ConfigFactory' => function ( MediaWikiServices $services ) {
  92                 // Use the bootstrap config to initialize the ConfigFactory.
  93                 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
  94                 $factory = new ConfigFactory();
  95
  96                 foreach ( $registry as $name => $callback ) {
  97                         $factory->register( $name, $callback );
  98                 }
  99                 return $factory;
 100         },
 101
 102         'MainConfig' => function ( MediaWikiServices $services ) {
 103                 // Use the 'main' config from the ConfigFactory service.
 104                 return $services->getConfigFactory()->makeConfig( 'main' );
 105         },
 106
 107         'InterwikiLookup' => function ( MediaWikiServices $services ) {
 108                 global $wgContLang; // TODO: manage $wgContLang as a service
 109                 $config = $services->getMainConfig();
 110                 return new ClassicInterwikiLookup(
 111                         $wgContLang,
 112                         $services->getMainWANObjectCache(),
 113                         $config->get( 'InterwikiExpiry' ),
 114                         $config->get( 'InterwikiCache' ),
 115                         $config->get( 'InterwikiScopes' ),
 116                         $config->get( 'InterwikiFallbackSite' )
 117                 );
 118         },
 119
 120         'StatsdDataFactory' => function ( MediaWikiServices $services ) {
 121                 return new BufferingStatsdDataFactory(
 122                         rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
 123                 );
 124         },
 125
 126         'EventRelayerGroup' => function ( MediaWikiServices $services ) {
 127                 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
 128         },
 129
 130         'SearchEngineFactory' => function ( MediaWikiServices $services ) {
 131                 return new SearchEngineFactory( $services->getSearchEngineConfig() );
 132         },
 133
 134         'SearchEngineConfig' => function ( MediaWikiServices $services ) {
 135                 global $wgContLang;
 136                 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
 137         },
 138
 139         'SkinFactory' => function ( MediaWikiServices $services ) {
 140                 $factory = new SkinFactory();
 141
 142                 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
 143
 144                 foreach ( $names as $name => $skin ) {
 145                         $factory->register( $name, $skin, function () use ( $name, $skin ) {
 146                                 $class = "Skin$skin";
 147                                 return new $class( $name );
 148                         } );
 149                 }
 150                 // Register a hidden "fallback" skin
 151                 $factory->register( 'fallback', 'Fallback', function () {
 152                         return new SkinFallback;
 153                 } );
 154                 // Register a hidden skin for api output
 155                 $factory->register( 'apioutput', 'ApiOutput', function () {
 156                         return new SkinApi;
 157                 } );
 158
 159                 return $factory;
 160         },
 161
 162         'WatchedItemStore' => function ( MediaWikiServices $services ) {
 163                 $store = new WatchedItemStore(
 164                         $services->getDBLoadBalancer(),
 165                         new HashBagOStuff( [ 'maxKeys' => 100 ] ),
 166                         $services->getReadOnlyMode()
 167                 );
 168                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 169
 170                 if ( $services->getMainConfig()->get( 'ReadOnlyWatchedItemStore' ) ) {
 171                         $store = new NoWriteWatchedItemStore( $store );
 172                 }
 173
 174                 return $store;
 175         },
 176
 177         'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
 178                 return new WatchedItemQueryService( $services->getDBLoadBalancer() );
 179         },
 180
 181         'CryptRand' => function ( MediaWikiServices $services ) {
 182                 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
 183                 return new CryptRand(
 184                         [
 185                                 // To try vary the system information of the state a bit more
 186                                 // by including the system's hostname into the state
 187                                 'wfHostname',
 188                                 // It's mostly worthless but throw the wiki's id into the data
 189                                 // for a little more variance
 190                                 'wfWikiID',
 191                                 // If we have a secret key set then throw it into the state as well
 192                                 function () use ( $secretKey ) {
 193                                         return $secretKey ?: '';
 194                                 }
 195                         ],
 196                         // The config file is likely the most often edited file we know should
 197                         // be around so include its stat info into the state.
 198                         // The constant with its location will almost always be defined, as
 199                         // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
 200                         // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
 201                         defined( 'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
 202                         LoggerFactory::getInstance( 'CryptRand' )
 203                 );
 204         },
 205
 206         'CryptHKDF' => function ( MediaWikiServices $services ) {
 207                 $config = $services->getMainConfig();
 208
 209                 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
 210                 if ( !$secret ) {
 211                         throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
 212                 }
 213
 214                 // In HKDF, the context can be known to the attacker, but this will
 215                 // keep simultaneous runs from producing the same output.
 216                 $context = [ microtime(), getmypid(), gethostname() ];
 217
 218                 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
 219                 $cache = $services->getLocalServerObjectCache();
 220                 if ( $cache instanceof EmptyBagOStuff ) {
 221                         $cache = ObjectCache::getLocalClusterInstance();
 222                 }
 223
 224                 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
 225                         $cache, $context, $services->getCryptRand()
 226                 );
 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                         $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
 280                                 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
 281                         };
 282                 }
 283
 284                 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
 285                 return new MimeMagic( $params );
 286         },
 287
 288         'ProxyLookup' => function ( MediaWikiServices $services ) {
 289                 $mainConfig = $services->getMainConfig();
 290                 return new ProxyLookup(
 291                         $mainConfig->get( 'SquidServers' ),
 292                         $mainConfig->get( 'SquidServersNoPurge' )
 293                 );
 294         },
 295
 296         'Parser' => function ( MediaWikiServices $services ) {
 297                 $conf = $services->getMainConfig()->get( 'ParserConf' );
 298                 return ObjectFactory::constructClassInstance( $conf['class'], [ $conf ] );
 299         },
 300
 301         'ParserCache' => function ( MediaWikiServices $services ) {
 302                 $config = $services->getMainConfig();
 303                 $cache = ObjectCache::getInstance( $config->get( 'ParserCacheType' ) );
 304                 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
 305
 306                 return new ParserCache(
 307                         $cache,
 308                         $config->get( 'CacheEpoch' )
 309                 );
 310         },
 311
 312         'LinkCache' => function ( MediaWikiServices $services ) {
 313                 return new LinkCache(
 314                         $services->getTitleFormatter(),
 315                         $services->getMainWANObjectCache()
 316                 );
 317         },
 318
 319         'LinkRendererFactory' => function ( MediaWikiServices $services ) {
 320                 return new LinkRendererFactory(
 321                         $services->getTitleFormatter(),
 322                         $services->getLinkCache()
 323                 );
 324         },
 325
 326         'LinkRenderer' => function ( MediaWikiServices $services ) {
 327                 global $wgUser;
 328
 329                 if ( defined( 'MW_NO_SESSION' ) ) {
 330                         return $services->getLinkRendererFactory()->create();
 331                 } else {
 332                         return $services->getLinkRendererFactory()->createForUser( $wgUser );
 333                 }
 334         },
 335
 336         'GenderCache' => function ( MediaWikiServices $services ) {
 337                 return new GenderCache();
 338         },
 339
 340         '_MediaWikiTitleCodec' => function ( MediaWikiServices $services ) {
 341                 global $wgContLang;
 342
 343                 return new MediaWikiTitleCodec(
 344                         $wgContLang,
 345                         $services->getGenderCache(),
 346                         $services->getMainConfig()->get( 'LocalInterwikis' )
 347                 );
 348         },
 349
 350         'TitleFormatter' => function ( MediaWikiServices $services ) {
 351                 return $services->getService( '_MediaWikiTitleCodec' );
 352         },
 353
 354         'TitleParser' => function ( MediaWikiServices $services ) {
 355                 return $services->getService( '_MediaWikiTitleCodec' );
 356         },
 357
 358         'MainObjectStash' => function ( MediaWikiServices $services ) {
 359                 $mainConfig = $services->getMainConfig();
 360
 361                 $id = $mainConfig->get( 'MainStash' );
 362                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 363                         throw new UnexpectedValueException(
 364                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 365                 }
 366
 367                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 368         },
 369
 370         'MainWANObjectCache' => function ( MediaWikiServices $services ) {
 371                 $mainConfig = $services->getMainConfig();
 372
 373                 $id = $mainConfig->get( 'MainWANCache' );
 374                 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
 375                         throw new UnexpectedValueException(
 376                                 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
 377                 }
 378
 379                 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
 380                 $objectCacheId = $params['cacheId'];
 381                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
 382                         throw new UnexpectedValueException(
 383                                 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
 384                 }
 385                 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
 386
 387                 return \ObjectCache::newWANCacheFromParams( $params );
 388         },
 389
 390         'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
 391                 $mainConfig = $services->getMainConfig();
 392
 393                 if ( function_exists( 'apc_fetch' ) ) {
 394                         $id = 'apc';
 395                 } elseif ( function_exists( 'apcu_fetch' ) ) {
 396                         $id = 'apcu';
 397                 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
 398                         $id = 'xcache';
 399                 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
 400                         $id = 'wincache';
 401                 } else {
 402                         $id = CACHE_NONE;
 403                 }
 404
 405                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 406                         throw new UnexpectedValueException(
 407                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 408                 }
 409
 410                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 411         },
 412
 413         'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
 414                 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
 415
 416                 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
 417                 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
 418                         $class = $serviceConfig['class'];
 419                         // Merge in the global defaults
 420                         $constructArg = isset( $serviceConfig['options'] )
 421                                 ? $serviceConfig['options']
 422                                 : [];
 423                         $constructArg += $config['global'];
 424                         // Make the VRS service available at the mount point
 425                         $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
 426                 }
 427
 428                 return $vrsClient;
 429         },
 430
 431         'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
 432                 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
 433         },
 434
 435         'ReadOnlyMode' => function ( MediaWikiServices $services ) {
 436                 return new ReadOnlyMode(
 437                         $services->getConfiguredReadOnlyMode(),
 438                         $services->getDBLoadBalancer()
 439                 );
 440         },
 441
 442         'ShellCommandFactory' => function ( MediaWikiServices $services ) {
 443                 $config = $services->getMainConfig();
 444
 445                 $limits = [
 446                         'time' => $config->get( 'MaxShellTime' ),
 447                         'walltime' => $config->get( 'MaxShellWallClockTime' ),
 448                         'memory' => $config->get( 'MaxShellMemory' ),
 449                         'filesize' => $config->get( 'MaxShellFileSize' ),
 450                 ];
 451                 $cgroup = $config->get( 'ShellCgroup' );
 452                 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
 453
 454                 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
 455                 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
 456                 $factory->logStderr();
 457
 458                 return $factory;
 459         },
 460
 461         'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
 462                 $config = $services->getMainConfig();
 463
 464                 return new ExternalStoreFactory(
 465                         $config->get( 'ExternalStores' )
 466                 );
 467         },
 468
 469         'RevisionStore' => function ( MediaWikiServices $services ) {
 470                 /** @var SqlBlobStore $blobStore */
 471                 $blobStore = $services->getService( '_SqlBlobStore' );
 472
 473                 $store = new RevisionStore(
 474                         $services->getDBLoadBalancer(),
 475                         $blobStore,
 476                         $services->getMainWANObjectCache()
 477                 );
 478
 479                 $config = $services->getMainConfig();
 480                 $store->setContentHandlerUseDB( $config->get( 'ContentHandlerUseDB' ) );
 481
 482                 return $store;
 483         },
 484
 485         'BlobStoreFactory' => function ( MediaWikiServices $services ) {
 486                 global $wgContLang;
 487                 return new BlobStoreFactory(
 488                         $services->getDBLoadBalancer(),
 489                         $services->getMainWANObjectCache(),
 490                         $services->getMainConfig(),
 491                         $wgContLang
 492                 );
 493         },
 494
 495         'BlobStore' => function ( MediaWikiServices $services ) {
 496                 return $services->getService( '_SqlBlobStore' );
 497         },
 498
 499         '_SqlBlobStore' => function ( MediaWikiServices $services ) {
 500                 return $services->getBlobStoreFactory()->newSqlBlobStore();
 501         },
 502
 503         'PreferencesFactory' => function ( MediaWikiServices $services ) {
 504                 global $wgContLang;
 505                 $authManager = AuthManager::singleton();
 506                 $linkRenderer = $services->getLinkRendererFactory()->create();
 507                 $config = $services->getMainConfig();
 508                 return new DefaultPreferencesFactory( $config, $wgContLang, $authManager, $linkRenderer );
 509         },
 510
 511         ///////////////////////////////////////////////////////////////////////////
 512         // NOTE: When adding a service here, don't forget to add a getter function
 513         // in the MediaWikiServices class. The convenience getter should just call
 514         // $this->getService( 'FooBarService' ).
 515         ///////////////////////////////////////////////////////////////////////////
 516
 517 ];