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