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
  45 return [
  46         'DBLoadBalancerFactory' => function( MediaWikiServices $services ) {
  47                 $mainConfig = $services->getMainConfig();
  48
  49                 $lbConf = MWLBFactory::applyDefaultConfig(
  50                         $mainConfig->get( 'LBFactoryConf' ),
  51                         $mainConfig
  52                 );
  53                 $class = MWLBFactory::getLBFactoryClass( $lbConf );
  54
  55                 return new $class( $lbConf );
  56         },
  57
  58         'DBLoadBalancer' => function( MediaWikiServices $services ) {
  59                 // just return the default LB from the DBLoadBalancerFactory service
  60                 return $services->getDBLoadBalancerFactory()->getMainLB();
  61         },
  62
  63         'SiteStore' => function( MediaWikiServices $services ) {
  64                 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
  65
  66                 // TODO: replace wfGetCache with a CacheFactory service.
  67                 // TODO: replace wfIsHHVM with a capabilities service.
  68                 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
  69
  70                 return new CachingSiteStore( $rawSiteStore, $cache );
  71         },
  72
  73         'SiteLookup' => function( MediaWikiServices $services ) {
  74                 // Use the default SiteStore as the SiteLookup implementation for now
  75                 return $services->getSiteStore();
  76         },
  77
  78         'ConfigFactory' => function( MediaWikiServices $services ) {
  79                 // Use the bootstrap config to initialize the ConfigFactory.
  80                 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
  81                 $factory = new ConfigFactory();
  82
  83                 foreach ( $registry as $name => $callback ) {
  84                         $factory->register( $name, $callback );
  85                 }
  86                 return $factory;
  87         },
  88
  89         'MainConfig' => function( MediaWikiServices $services ) {
  90                 // Use the 'main' config from the ConfigFactory service.
  91                 return $services->getConfigFactory()->makeConfig( 'main' );
  92         },
  93
  94         'InterwikiLookup' => function( MediaWikiServices $services ) {
  95                 global $wgContLang; // TODO: manage $wgContLang as a service
  96                 $config = $services->getMainConfig();
  97                 return new ClassicInterwikiLookup(
  98                         $wgContLang,
  99                         ObjectCache::getMainWANInstance(),
 100                         $config->get( 'InterwikiExpiry' ),
 101                         $config->get( 'InterwikiCache' ),
 102                         $config->get( 'InterwikiScopes' ),
 103                         $config->get( 'InterwikiFallbackSite' )
 104                 );
 105         },
 106
 107         'StatsdDataFactory' => function( MediaWikiServices $services ) {
 108                 return new BufferingStatsdDataFactory(
 109                         rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
 110                 );
 111         },
 112
 113         'EventRelayerGroup' => function( MediaWikiServices $services ) {
 114                 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
 115         },
 116
 117         'SearchEngineFactory' => function( MediaWikiServices $services ) {
 118                 return new SearchEngineFactory( $services->getSearchEngineConfig() );
 119         },
 120
 121         'SearchEngineConfig' => function( MediaWikiServices $services ) {
 122                 global $wgContLang;
 123                 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
 124         },
 125
 126         'SkinFactory' => function( MediaWikiServices $services ) {
 127                 $factory = new SkinFactory();
 128
 129                 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
 130
 131                 foreach ( $names as $name => $skin ) {
 132                         $factory->register( $name, $skin, function () use ( $name, $skin ) {
 133                                 $class = "Skin$skin";
 134                                 return new $class( $name );
 135                         } );
 136                 }
 137                 // Register a hidden "fallback" skin
 138                 $factory->register( 'fallback', 'Fallback', function () {
 139                         return new SkinFallback;
 140                 } );
 141                 // Register a hidden skin for api output
 142                 $factory->register( 'apioutput', 'ApiOutput', function () {
 143                         return new SkinApi;
 144                 } );
 145
 146                 return $factory;
 147         },
 148
 149         'WatchedItemStore' => function( MediaWikiServices $services ) {
 150                 $store = new WatchedItemStore(
 151                         $services->getDBLoadBalancer(),
 152                         new HashBagOStuff( [ 'maxKeys' => 100 ] )
 153                 );
 154                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 155                 return $store;
 156         },
 157
 158         'WatchedItemQueryService' => function( MediaWikiServices $services ) {
 159                 return new WatchedItemQueryService( $services->getDBLoadBalancer() );
 160         },
 161
 162         'CryptRand' => function( MediaWikiServices $services ) {
 163                 $secretKey = $services->getMainConfig()->get( 'SecretKey' );
 164                 return new CryptRand(
 165                         [
 166                                 // To try vary the system information of the state a bit more
 167                                 // by including the system's hostname into the state
 168                                 'wfHostname',
 169                                 // It's mostly worthless but throw the wiki's id into the data
 170                                 // for a little more variance
 171                                 'wfWikiID',
 172                                 // If we have a secret key set then throw it into the state as well
 173                                 function() use ( $secretKey ) {
 174                                         return $secretKey ?: '';
 175                                 }
 176                         ],
 177                         // The config file is likely the most often edited file we know should
 178                         // be around so include its stat info into the state.
 179                         // The constant with its location will almost always be defined, as
 180                         // WebStart.php defines MW_CONFIG_FILE to $IP/LocalSettings.php unless
 181                         // being configured with MW_CONFIG_CALLBACK (e.g. the installer).
 182                         defined( 'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
 183                         LoggerFactory::getInstance( 'CryptRand' )
 184                 );
 185         },
 186
 187         'MediaHandlerFactory' => function( MediaWikiServices $services ) {
 188                 return new MediaHandlerFactory(
 189                         $services->getMainConfig()->get( 'MediaHandlers' )
 190                 );
 191         },
 192
 193         'MimeAnalyzer' => function( MediaWikiServices $services ) {
 194                 return new MimeMagic(
 195                         MimeMagic::applyDefaultParameters(
 196                                 [],
 197                                 $services->getMainConfig()
 198                         )
 199                 );
 200         },
 201
 202         'ProxyLookup' => function( MediaWikiServices $services ) {
 203                 $mainConfig = $services->getMainConfig();
 204                 return new ProxyLookup(
 205                         $mainConfig->get( 'SquidServers' ),
 206                         $mainConfig->get( 'SquidServersNoPurge' )
 207                 );
 208         },
 209
 210         'LinkCache' => function( MediaWikiServices $services ) {
 211                 return new LinkCache(
 212                         $services->getTitleFormatter(),
 213                         ObjectCache::getMainWANInstance()
 214                 );
 215         },
 216
 217         'LinkRendererFactory' => function( MediaWikiServices $services ) {
 218                 return new LinkRendererFactory(
 219                         $services->getTitleFormatter(),
 220                         $services->getLinkCache()
 221                 );
 222         },
 223
 224         'LinkRenderer' => function( MediaWikiServices $services ) {
 225                 global $wgUser;
 226
 227                 if ( defined( 'MW_NO_SESSION' ) ) {
 228                         return $services->getLinkRendererFactory()->create();
 229                 } else {
 230                         return $services->getLinkRendererFactory()->createForUser( $wgUser );
 231                 }
 232         },
 233
 234         'GenderCache' => function( MediaWikiServices $services ) {
 235                 return new GenderCache();
 236         },
 237
 238         '_MediaWikiTitleCodec' => function( MediaWikiServices $services ) {
 239                 global $wgContLang;
 240
 241                 return new MediaWikiTitleCodec(
 242                         $wgContLang,
 243                         $services->getGenderCache(),
 244                         $services->getMainConfig()->get( 'LocalInterwikis' )
 245                 );
 246         },
 247
 248         'TitleFormatter' => function( MediaWikiServices $services ) {
 249                 return $services->getService( '_MediaWikiTitleCodec' );
 250         },
 251
 252         'TitleParser' => function( MediaWikiServices $services ) {
 253                 return $services->getService( '_MediaWikiTitleCodec' );
 254         },
 255
 256         'MainObjectStash' => function( MediaWikiServices $services ) {
 257                 $mainConfig = $services->getMainConfig();
 258
 259                 $id = $mainConfig->get( 'MainStash' );
 260                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 261                         throw new UnexpectedValueException(
 262                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 263                 }
 264
 265                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 266         },
 267
 268         'MainWANObjectCache' => function( MediaWikiServices $services ) {
 269                 $mainConfig = $services->getMainConfig();
 270
 271                 $id = $mainConfig->get( 'MainWANCache' );
 272                 if ( !isset( $mainConfig->get( 'WANObjectCaches' )[$id] ) ) {
 273                         throw new UnexpectedValueException(
 274                                 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
 275                 }
 276
 277                 $params = $mainConfig->get( 'WANObjectCaches' )[$id];
 278                 $objectCacheId = $params['cacheId'];
 279                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$objectCacheId] ) ) {
 280                         throw new UnexpectedValueException(
 281                                 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
 282                 }
 283                 $params['store'] = $mainConfig->get( 'ObjectCaches' )[$objectCacheId];
 284
 285                 return \ObjectCache::newWANCacheFromParams( $params );
 286         },
 287
 288         'LocalServerObjectCache' => function( MediaWikiServices $services ) {
 289                 $mainConfig = $services->getMainConfig();
 290
 291                 if ( function_exists( 'apc_fetch' ) ) {
 292                         $id = 'apc';
 293                 } elseif ( function_exists( 'apcu_fetch' ) ) {
 294                         $id = 'apcu';
 295                 } elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
 296                         $id = 'xcache';
 297                 } elseif ( function_exists( 'wincache_ucache_get' ) ) {
 298                         $id = 'wincache';
 299                 } else {
 300                         $id = CACHE_NONE;
 301                 }
 302
 303                 if ( !isset( $mainConfig->get( 'ObjectCaches' )[$id] ) ) {
 304                         throw new UnexpectedValueException(
 305                                 "Cache type \"$id\" is not present in \$wgObjectCaches." );
 306                 }
 307
 308                 return \ObjectCache::newFromParams( $mainConfig->get( 'ObjectCaches' )[$id] );
 309         },
 310
 311         'VirtualRESTServiceClient' => function( MediaWikiServices $services ) {
 312                 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
 313
 314                 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
 315                 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
 316                         $class = $serviceConfig['class'];
 317                         // Merge in the global defaults
 318                         $constructArg = isset( $serviceConfig['options'] )
 319                                 ? $serviceConfig['options']
 320                                 : [];
 321                         $constructArg += $config['global'];
 322                         // Make the VRS service available at the mount point
 323                         $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
 324                 }
 325
 326                 return $vrsClient;
 327         },
 328
 329         ///////////////////////////////////////////////////////////////////////////
 330         // NOTE: When adding a service here, don't forget to add a getter function
 331         // in the MediaWikiServices class. The convenience getter should just call
 332         // $this->getService( 'FooBarService' ).
 333         ///////////////////////////////////////////////////////////////////////////
 334
 335 ];