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\Interwiki\ClassicInterwikiLookup;
  41 use MediaWiki\Linker\LinkRendererFactory;
  42 use MediaWiki\Logger\LoggerFactory;
  43 use MediaWiki\MediaWikiServices;
  44 use MediaWiki\Shell\CommandFactory;
  45
  46 return [
  47         'DBLoadBalancerFactory' => function ( MediaWikiServices $services ) {
  48                 $mainConfig = $services->getMainConfig();
  49
  50                 $lbConf = MWLBFactory::applyDefaultConfig(
  51                         $mainConfig->get( 'LBFactoryConf' ),
  52                         $mainConfig,
  53                         $services->getConfiguredReadOnlyMode()
  54                 );
  55                 $class = MWLBFactory::getLBFactoryClass( $lbConf );
  56
  57                 return new $class( $lbConf );
  58         },
  59
  60         'DBLoadBalancer' => function ( MediaWikiServices $services ) {
  61                 // just return the default LB from the DBLoadBalancerFactory service
  62                 return $services->getDBLoadBalancerFactory()->getMainLB();
  63         },
  64
  65         'SiteStore' => function ( MediaWikiServices $services ) {
  66                 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
  67
  68                 // TODO: replace wfGetCache with a CacheFactory service.
  69                 // TODO: replace wfIsHHVM with a capabilities service.
  70                 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
  71
  72                 return new CachingSiteStore( $rawSiteStore, $cache );
  73         },
  74
  75         'SiteLookup' => function ( MediaWikiServices $services ) {
  76                 $cacheFile = $services->getMainConfig()->get( 'SitesCacheFile' );
  77
  78                 if ( $cacheFile !== false ) {
  79                         return new FileBasedSiteLookup( $cacheFile );
  80                 } else {
  81                         // Use the default SiteStore as the SiteLookup implementation for now
  82                         return $services->getSiteStore();
  83                 }
  84         },
  85
  86         'ConfigFactory' => function ( MediaWikiServices $services ) {
  87                 // Use the bootstrap config to initialize the ConfigFactory.
  88                 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
  89                 $factory = new ConfigFactory();
  90
  91                 foreach ( $registry as $name => $callback ) {
  92                         $factory->register( $name, $callback );
  93                 }
  94                 return $factory;
  95         },
  96
  97         'MainConfig' => function ( MediaWikiServices $services ) {
  98                 // Use the 'main' config from the ConfigFactory service.
  99                 return $services->getConfigFactory()->makeConfig( 'main' );
 100         },
 101
 102         'InterwikiLookup' => function ( MediaWikiServices $services ) {
 103                 global $wgContLang; // TODO: manage $wgContLang as a service
 104                 $config = $services->getMainConfig();
 105                 return new ClassicInterwikiLookup(
 106                         $wgContLang,
 107                         $services->getMainWANObjectCache(),
 108                         $config->get( 'InterwikiExpiry' ),
 109                         $config->get( 'InterwikiCache' ),
 110                         $config->get( 'InterwikiScopes' ),
 111                         $config->get( 'InterwikiFallbackSite' )
 112                 );
 113         },
 114
 115         'StatsdDataFactory' => function ( MediaWikiServices $services ) {
 116                 return new BufferingStatsdDataFactory(
 117                         rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
 118                 );
 119         },
 120
 121         'EventRelayerGroup' => function ( MediaWikiServices $services ) {
 122                 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
 123         },
 124
 125         'SearchEngineFactory' => function ( MediaWikiServices $services ) {
 126                 return new SearchEngineFactory( $services->getSearchEngineConfig() );
 127         },
 128
 129         'SearchEngineConfig' => function ( MediaWikiServices $services ) {
 130                 global $wgContLang;
 131                 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
 132         },
 133
 134         'SkinFactory' => function ( MediaWikiServices $services ) {
 135                 $factory = new SkinFactory();
 136
 137                 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
 138
 139                 foreach ( $names as $name => $skin ) {
 140                         $factory->register( $name, $skin, function () use ( $name, $skin ) {
 141                                 $class = "Skin$skin";
 142                                 return new $class( $name );
 143                         } );
 144                 }
 145                 // Register a hidden "fallback" skin
 146                 $factory->register( 'fallback', 'Fallback', function () {
 147                         return new SkinFallback;
 148                 } );
 149                 // Register a hidden skin for api output
 150                 $factory->register( 'apioutput', 'ApiOutput', function () {
 151                         return new SkinApi;
 152                 } );
 153
 154                 return $factory;
 155         },
 156
 157         'WatchedItemStore' => function ( MediaWikiServices $services ) {
 158                 $store = new WatchedItemStore(
 159                         $services->getDBLoadBalancer(),
 160                         new HashBagOStuff( [ 'maxKeys' => 100 ] ),
 161                         $services->getReadOnlyMode()
 162                 );
 163                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 164                 return $store;
 165         },
 166
 167         'WatchedItemQueryService' => function ( MediaWikiServices $services ) {
 168                 return new WatchedItemQueryService( $services->getDBLoadBalancer() );
 169         },
 170
 171         'CryptRand' => function ( MediaWikiServices $services ) {
 172                 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
 173                 return new CryptRand(
 174                         [
 175                                 // To try vary the system information of the state a bit more
 176                                 // by including the system's hostname into the state
 177                                 'wfHostname',
 178                                 // It's mostly worthless but throw the wiki's id into the data
 179                                 // for a little more variance
 180                                 'wfWikiID',
 181                                 // If we have a secret key set then throw it into the state as well
 182                                 function () use ( $secretKey ) {
 183                                         return $secretKey ?: '';
 184                                 }
 185                         ],
 186                         // The config file is likely the most often edited file we know should
 187                         // be around so include its stat info into the state.
 188                         // The constant with its location will almost always be defined, as
 189                         // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
 190                         // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
 191                         defined( 'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
 192                         LoggerFactory::getInstance( 'CryptRand' )
 193                 );
 194         },
 195
 196         'CryptHKDF' => function ( MediaWikiServices $services ) {
 197                 $config = $services->getMainConfig();
 198
 199                 $secret = $config->get( 'HKDFSecret' ) ?: $config->get( 'SecretKey' );
 200                 if ( !$secret ) {
 201                         throw new RuntimeException( "Cannot use MWCryptHKDF without a secret." );
 202                 }
 203
 204                 // In HKDF, the context can be known to the attacker, but this will
 205                 // keep simultaneous runs from producing the same output.
 206                 $context = [ microtime(), getmypid(), gethostname() ];
 207
 208                 // Setup salt cache. Use APC, or fallback to the main cache if it isn't setup
 209                 $cache = $services->getLocalServerObjectCache();
 210                 if ( $cache instanceof EmptyBagOStuff ) {
 211                         $cache = ObjectCache::getLocalClusterInstance();
 212                 }
 213
 214                 return new CryptHKDF( $secret, $config->get( 'HKDFAlgorithm' ),
 215                         $cache, $context, $services->getCryptRand()
 216                 );
 217         },
 218
 219         'MediaHandlerFactory' => function ( MediaWikiServices $services ) {
 220                 return new MediaHandlerFactory(
 221                         $services->getMainConfig()->get( 'MediaHandlers' )
 222                 );
 223         },
 224
 225         'MimeAnalyzer' => function ( MediaWikiServices $services ) {
 226                 $logger = LoggerFactory::getInstance( 'Mime' );
 227                 $mainConfig = $services->getMainConfig();
 228                 $params = [
 229                         'typeFile' => $mainConfig->get( 'MimeTypeFile' ),
 230                         'infoFile' => $mainConfig->get( 'MimeInfoFile' ),
 231                         'xmlTypes' => $mainConfig->get( 'XMLMimeTypes' ),
 232                         'guessCallback' =>
 233                                 function ( $mimeAnalyzer, &$head, &$tail, $file, &$mime ) use ( $logger ) {
 234                                         // Also test DjVu
 235                                         $deja = new DjVuImage( $file );
 236                                         if ( $deja->isValid() ) {
 237                                                 $logger->info( __METHOD__ . ": detected $file as image/vnd.djvu\n" );
 238                                                 $mime = 'image/vnd.djvu';
 239
 240                                                 return;
 241                                         }
 242                                         // Some strings by reference for performance - assuming well-behaved hooks
 243                                         Hooks::run(
 244                                                 'MimeMagicGuessFromContent',
 245                                                 [ $mimeAnalyzer, &$head, &$tail, $file, &$mime ]
 246                                         );
 247                                 },
 248                         'extCallback' => function ( $mimeAnalyzer, $ext, &$mime ) {
 249                                 // Media handling extensions can improve the MIME detected
 250                                 Hooks::run( 'MimeMagicImproveFromExtension', [ $mimeAnalyzer, $ext, &$mime ] );
 251                         },
 252                         'initCallback' => function ( $mimeAnalyzer ) {
 253                                 // Allow media handling extensions adding MIME-types and MIME-info
 254                                 Hooks::run( 'MimeMagicInit', [ $mimeAnalyzer ] );
 255                         },
 256                         'logger' => $logger
 257                 ];
 258
 259                 if ( $params['infoFile'] === 'includes/mime.info' ) {
 260                         $params['infoFile'] = __DIR__ . "/libs/mime/mime.info";
 261                 }
 262
 263                 if ( $params['typeFile'] === 'includes/mime.types' ) {
 264                         $params['typeFile'] = __DIR__ . "/libs/mime/mime.types";
 265                 }
 266
 267                 $detectorCmd = $mainConfig->get( 'MimeDetectorCommand' );
 268                 if ( $detectorCmd ) {
 269                         $params['detectCallback'] = function ( $file ) use ( $detectorCmd ) {
 270                                 return wfShellExec( "$detectorCmd " . wfEscapeShellArg( $file ) );
 271                         };
 272                 }
 273
 274                 // XXX: MimeMagic::singleton currently requires this service to return an instance of MimeMagic
 275                 return new MimeMagic( $params );
 276         },
 277
 278         'ProxyLookup' => function ( MediaWikiServices $services ) {
 279                 $mainConfig = $services->getMainConfig();
 280                 return new ProxyLookup(
 281                         $mainConfig->get( 'SquidServers' ),
 282                         $mainConfig->get( 'SquidServersNoPurge' )
 283                 );
 284         },
 285
 286         'Parser' => function ( MediaWikiServices $services ) {
 287                 $conf = $services->getMainConfig()->get( 'ParserConf' );
 288                 return ObjectFactory::constructClassInstance( $conf['class'], [ $conf ] );
 289         },
 290
 291         'ParserCache' => function ( MediaWikiServices $services ) {
 292                 $config = $services->getMainConfig();
 293                 $cache = ObjectCache::getInstance( $config->get( 'ParserCacheType' ) );
 294                 wfDebugLog( 'caches', 'parser: ' . get_class( $cache ) );
 295
 296                 return new ParserCache(
 297                         $cache,
 298                         $config->get( 'CacheEpoch' )
 299                 );
 300         },
 301
 302         'LinkCache' => function ( MediaWikiServices $services ) {
 303                 return new LinkCache(
 304                         $services->getTitleFormatter(),
 305                         $services->getMainWANObjectCache()
 306                 );
 307         },
 308
 309         'LinkRendererFactory' => function ( MediaWikiServices $services ) {
 310                 return new LinkRendererFactory(
 311                         $services->getTitleFormatter(),
 312                         $services->getLinkCache()
 313                 );
 314         },
 315
 316         'LinkRenderer' => function ( MediaWikiServices $services ) {
 317                 global $wgUser;
 318
 319                 if ( defined( 'MW_NO_SESSION' ) ) {
 320                         return $services->getLinkRendererFactory()->create();
 321                 } else {
 322                         return $services->getLinkRendererFactory()->createForUser( $wgUser );
 323                 }
 324         },
 325
 326         'GenderCache' => function ( MediaWikiServices $services ) {
 327                 return new GenderCache();
 328         },
 329
 330         '_MediaWikiTitleCodec' => function ( MediaWikiServices $services ) {
 331                 global $wgContLang;
 332
 333                 return new MediaWikiTitleCodec(
 334                         $wgContLang,
 335                         $services->getGenderCache(),
 336                         $services->getMainConfig()->get( 'LocalInterwikis' )
 337                 );
 338         },
 339
 340         'TitleFormatter' => function ( MediaWikiServices $services ) {
 341                 return $services->getService( '_MediaWikiTitleCodec' );
 342         },
 343
 344         'TitleParser' => function ( MediaWikiServices $services ) {
 345                 return $services->getService( '_MediaWikiTitleCodec' );
 346         },
 347
 348         'MainObjectStash' => function ( MediaWikiServices $services ) {
 349                 $mainConfig = $services->getMainConfig();
 350
 351                 $id = $mainConfig->get( 'MainStash' );
 352                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 353                         throw new UnexpectedValueException(
 354                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 355                 }
 356
 357                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 358         },
 359
 360         'MainWANObjectCache' => function ( MediaWikiServices $services ) {
 361                 $mainConfig = $services->getMainConfig();
 362
 363                 $id = $mainConfig->get( 'MainWANCache' );
 364                 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
 365                         throw new UnexpectedValueException(
 366                                 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
 367                 }
 368
 369                 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
 370                 $objectCacheId = $params['cacheId'];
 371                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
 372                         throw new UnexpectedValueException(
 373                                 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
 374                 }
 375                 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
 376
 377                 return \ObjectCache::newWANCacheFromParams( $params );
 378         },
 379
 380         'LocalServerObjectCache' => function ( MediaWikiServices $services ) {
 381                 $mainConfig = $services->getMainConfig();
 382
 383                 if ( function_exists( 'apc_fetch' ) ) {
 384                         $id = 'apc';
 385                 } elseif ( function_exists( 'apcu_fetch' ) ) {
 386                         $id = 'apcu';
 387                 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
 388                         $id = 'xcache';
 389                 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
 390                         $id = 'wincache';
 391                 } else {
 392                         $id = CACHE_NONE;
 393                 }
 394
 395                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 396                         throw new UnexpectedValueException(
 397                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 398                 }
 399
 400                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 401         },
 402
 403         'VirtualRESTServiceClient' => function ( MediaWikiServices $services ) {
 404                 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
 405
 406                 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
 407                 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
 408                         $class = $serviceConfig['class'];
 409                         // Merge in the global defaults
 410                         $constructArg = isset( $serviceConfig['options'] )
 411                                 ? $serviceConfig['options']
 412                                 : [];
 413                         $constructArg += $config['global'];
 414                         // Make the VRS service available at the mount point
 415                         $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
 416                 }
 417
 418                 return $vrsClient;
 419         },
 420
 421         'ConfiguredReadOnlyMode' => function ( MediaWikiServices $services ) {
 422                 return new ConfiguredReadOnlyMode( $services->getMainConfig() );
 423         },
 424
 425         'ReadOnlyMode' => function ( MediaWikiServices $services ) {
 426                 return new ReadOnlyMode(
 427                         $services->getConfiguredReadOnlyMode(),
 428                         $services->getDBLoadBalancer()
 429                 );
 430         },
 431
 432         'ShellCommandFactory' => function ( MediaWikiServices $services ) {
 433                 $config = $services->getMainConfig();
 434
 435                 $limits = [
 436                         'time' => $config->get( 'MaxShellTime' ),
 437                         'walltime' => $config->get( 'MaxShellWallClockTime' ),
 438                         'memory' => $config->get( 'MaxShellMemory' ),
 439                         'filesize' => $config->get( 'MaxShellFileSize' ),
 440                 ];
 441                 $cgroup = $config->get( 'ShellCgroup' );
 442                 $restrictionMethod = $config->get( 'ShellRestrictionMethod' );
 443
 444                 $factory = new CommandFactory( $limits, $cgroup, $restrictionMethod );
 445                 $factory->setLogger( LoggerFactory::getInstance( 'exec' ) );
 446                 $factory->logStderr();
 447
 448                 return $factory;
 449         },
 450
 451         'ExternalStoreFactory' => function ( MediaWikiServices $services ) {
 452                 $config = $services->getMainConfig();
 453
 454                 return new ExternalStoreFactory(
 455                         $config->get( 'ExternalStores' )
 456                 );
 457         },
 458
 459         ///////////////////////////////////////////////////////////////////////////
 460         // NOTE: When adding a service here, don't forget to add a getter function
 461         // in the MediaWikiServices class. The convenience getter should just call
 462         // $this->getService( 'FooBarService' ).
 463         ///////////////////////////////////////////////////////////////////////////
 464
 465 ];