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