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\MediaWikiServices;
  43
  44 return [
  45         'DBLoadBalancerFactory' => function( MediaWikiServices $services ) {
  46                 $mainConfig = $services->getMainConfig();
  47
  48                 $lbConf = $mainConfig->get( 'LBFactoryConf' );
  49                 $lbConf += [
  50                         'localDomain' => new DatabaseDomain(
  51                                 $mainConfig->get( 'DBname' ), null, $mainConfig->get( 'DBprefix' ) ),
  52                         // TODO: replace the global wfConfiguredReadOnlyReason() with a service.
  53                         'readOnlyReason' => wfConfiguredReadOnlyReason(),
  54                 ];
  55
  56                 $class = LBFactoryMW::getLBFactoryClass( $lbConf );
  57                 if ( $class === 'LBFactorySimple' ) {
  58                         if ( is_array( $mainConfig->get( 'DBservers' ) ) ) {
  59                                 foreach ( $mainConfig->get( 'DBservers' ) as $i => $server ) {
  60                                         $lbConf['servers'][$i] = $server + [
  61                                                 'schema' => $mainConfig->get( 'DBmwschema' ),
  62                                                 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
  63                                                 'flags' => DBO_DEFAULT,
  64                                                 'sqlMode' => $mainConfig->get( 'SQLMode' ),
  65                                                 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
  66                                         ];
  67                                 }
  68                         } else {
  69                                 $flags = DBO_DEFAULT;
  70                                 $flags |= $mainConfig->get( 'DebugDumpSql' ) ? DBO_DEBUG : 0;
  71                                 $flags |= $mainConfig->get( 'DBssl' ) ? DBO_SSL : 0;
  72                                 $flags |= $mainConfig->get( 'DBcompress' ) ? DBO_COMPRESS : 0;
  73                                 $lbConf['servers'] = [
  74                                         [
  75                                                 'host' => $mainConfig->get( 'DBserver' ),
  76                                                 'user' => $mainConfig->get( 'DBuser' ),
  77                                                 'password' => $mainConfig->get( 'DBpassword' ),
  78                                                 'dbname' => $mainConfig->get( 'DBname' ),
  79                                                 'schema' => $mainConfig->get( 'DBmwschema' ),
  80                                                 'tablePrefix' => $mainConfig->get( 'DBprefix' ),
  81                                                 'type' => $mainConfig->get( 'DBtype' ),
  82                                                 'load' => 1,
  83                                                 'flags' => $flags,
  84                                                 'sqlMode' => $mainConfig->get( 'SQLMode' ),
  85                                                 'utf8Mode' => $mainConfig->get( 'DBmysql5' )
  86                                         ]
  87                                 ];
  88                         }
  89                         $lbConf['externalServers'] = $mainConfig->get( 'ExternalServers' );
  90                 }
  91
  92                 return new $class( LBFactoryMW::applyDefaultConfig( $lbConf ) );
  93         },
  94
  95         'DBLoadBalancer' => function( MediaWikiServices $services ) {
  96                 // just return the default LB from the DBLoadBalancerFactory service
  97                 return $services->getDBLoadBalancerFactory()->getMainLB();
  98         },
  99
 100         'SiteStore' => function( MediaWikiServices $services ) {
 101                 $rawSiteStore = new DBSiteStore( $services->getDBLoadBalancer() );
 102
 103                 // TODO: replace wfGetCache with a CacheFactory service.
 104                 // TODO: replace wfIsHHVM with a capabilities service.
 105                 $cache = wfGetCache( wfIsHHVM() ? CACHE_ACCEL : CACHE_ANYTHING );
 106
 107                 return new CachingSiteStore( $rawSiteStore, $cache );
 108         },
 109
 110         'SiteLookup' => function( MediaWikiServices $services ) {
 111                 // Use the default SiteStore as the SiteLookup implementation for now
 112                 return $services->getSiteStore();
 113         },
 114
 115         'ConfigFactory' => function( MediaWikiServices $services ) {
 116                 // Use the bootstrap config to initialize the ConfigFactory.
 117                 $registry = $services->getBootstrapConfig()->get( 'ConfigRegistry' );
 118                 $factory = new ConfigFactory();
 119
 120                 foreach ( $registry as $name => $callback ) {
 121                         $factory->register( $name, $callback );
 122                 }
 123                 return $factory;
 124         },
 125
 126         'MainConfig' => function( MediaWikiServices $services ) {
 127                 // Use the 'main' config from the ConfigFactory service.
 128                 return $services->getConfigFactory()->makeConfig( 'main' );
 129         },
 130
 131         'InterwikiLookup' => function( MediaWikiServices $services ) {
 132                 global $wgContLang; // TODO: manage $wgContLang as a service
 133                 $config = $services->getMainConfig();
 134                 return new ClassicInterwikiLookup(
 135                         $wgContLang,
 136                         ObjectCache::getMainWANInstance(),
 137                         $config->get( 'InterwikiExpiry' ),
 138                         $config->get( 'InterwikiCache' ),
 139                         $config->get( 'InterwikiScopes' ),
 140                         $config->get( 'InterwikiFallbackSite' )
 141                 );
 142         },
 143
 144         'StatsdDataFactory' => function( MediaWikiServices $services ) {
 145                 return new BufferingStatsdDataFactory(
 146                         rtrim( $services->getMainConfig()->get( 'StatsdMetricPrefix' ), '.' )
 147                 );
 148         },
 149
 150         'EventRelayerGroup' => function( MediaWikiServices $services ) {
 151                 return new EventRelayerGroup( $services->getMainConfig()->get( 'EventRelayerConfig' ) );
 152         },
 153
 154         'SearchEngineFactory' => function( MediaWikiServices $services ) {
 155                 return new SearchEngineFactory( $services->getSearchEngineConfig() );
 156         },
 157
 158         'SearchEngineConfig' => function( MediaWikiServices $services ) {
 159                 global $wgContLang;
 160                 return new SearchEngineConfig( $services->getMainConfig(), $wgContLang );
 161         },
 162
 163         'SkinFactory' => function( MediaWikiServices $services ) {
 164                 $factory = new SkinFactory();
 165
 166                 $names = $services->getMainConfig()->get( 'ValidSkinNames' );
 167
 168                 foreach ( $names as $name => $skin ) {
 169                         $factory->register( $name, $skin, function () use ( $name, $skin ) {
 170                                 $class = "Skin$skin";
 171                                 return new $class( $name );
 172                         } );
 173                 }
 174                 // Register a hidden "fallback" skin
 175                 $factory->register( 'fallback', 'Fallback', function () {
 176                         return new SkinFallback;
 177                 } );
 178                 // Register a hidden skin for api output
 179                 $factory->register( 'apioutput', 'ApiOutput', function () {
 180                         return new SkinApi;
 181                 } );
 182
 183                 return $factory;
 184         },
 185
 186         'WatchedItemStore' => function( MediaWikiServices $services ) {
 187                 $store = new WatchedItemStore(
 188                         $services->getDBLoadBalancer(),
 189                         new HashBagOStuff( [ 'maxKeys' => 100 ] )
 190                 );
 191                 $store->setStatsdDataFactory( $services->getStatsdDataFactory() );
 192                 return $store;
 193         },
 194
 195         'WatchedItemQueryService' => function( MediaWikiServices $services ) {
 196                 return new WatchedItemQueryService( $services->getDBLoadBalancer() );
 197         },
 198
 199         'MediaHandlerFactory' => function( MediaWikiServices $services ) {
 200                 return new MediaHandlerFactory(
 201                         $services->getMainConfig()->get( 'MediaHandlers' )
 202                 );
 203         },
 204
 205         'LinkCache' => function( MediaWikiServices $services ) {
 206                 return new LinkCache(
 207                         $services->getTitleFormatter(),
 208                         ObjectCache::getMainWANInstance()
 209                 );
 210         },
 211
 212         'LinkRendererFactory' => function( MediaWikiServices $services ) {
 213                 return new LinkRendererFactory(
 214                         $services->getTitleFormatter(),
 215                         $services->getLinkCache()
 216                 );
 217         },
 218
 219         'LinkRenderer' => function( MediaWikiServices $services ) {
 220                 global $wgUser;
 221
 222                 if ( defined( 'MW_NO_SESSION' ) ) {
 223                         return $services->getLinkRendererFactory()->create();
 224                 } else {
 225                         return $services->getLinkRendererFactory()->createForUser( $wgUser );
 226                 }
 227         },
 228
 229         'GenderCache' => function( MediaWikiServices $services ) {
 230                 return new GenderCache();
 231         },
 232
 233         '_MediaWikiTitleCodec' => function( MediaWikiServices $services ) {
 234                 global $wgContLang;
 235
 236                 return new MediaWikiTitleCodec(
 237                         $wgContLang,
 238                         $services->getGenderCache(),
 239                         $services->getMainConfig()->get( 'LocalInterwikis' )
 240                 );
 241         },
 242
 243         'TitleFormatter' => function( MediaWikiServices $services ) {
 244                 return $services->getService( '_MediaWikiTitleCodec' );
 245         },
 246
 247         'TitleParser' => function( MediaWikiServices $services ) {
 248                 return $services->getService( '_MediaWikiTitleCodec' );
 249         },
 250
 251         'VirtualRESTServiceClient' => function( MediaWikiServices $services ) {
 252                 $config = $services->getMainConfig()->get( 'VirtualRestConfig' );
 253
 254                 $vrsClient = new VirtualRESTServiceClient( new MultiHttpClient( [] ) );
 255                 foreach ( $config['paths'] as $prefix => $serviceConfig ) {
 256                         $class = $serviceConfig['class'];
 257                         // Merge in the global defaults
 258                         $constructArg = isset( $serviceConfig['options'] )
 259                                 ? $serviceConfig['options']
 260                                 : [];
 261                         $constructArg += $config['global'];
 262                         // Make the VRS service available at the mount point
 263                         $vrsClient->mount( $prefix, [ 'class' => $class, 'config' => $constructArg ] );
 264                 }
 265
 266                 return $vrsClient;
 267         },
 268
 269         ///////////////////////////////////////////////////////////////////////////
 270         // NOTE: When adding a service here, don't forget to add a getter function
 271         // in the MediaWikiServices class. The convenience getter should just call
 272         // $this->getService( 'FooBarService' ).
 273         ///////////////////////////////////////////////////////////////////////////
 274
 275 ];