use Config;
use ConfigFactory;
use EventRelayerGroup;
+use GenderCache;
use GlobalVarConfig;
use Hooks;
use LBFactory;
use Liuggio\StatsdClient\Factory\StatsdDataFactory;
use LoadBalancer;
+use MediaWiki\Services\SalvageableService;
use MediaWiki\Services\ServiceContainer;
use MWException;
use ResourceLoader;
use SiteStore;
use WatchedItemStore;
use SkinFactory;
+use TitleFormatter;
+use TitleParser;
/**
* Service locator for MediaWiki core services.
/**
* Returns the global default instance of the top level service locator.
*
+ * @since 1.27
+ *
* The default instance is initialized using the service instantiator functions
* defined in ServiceWiring.php.
*
// even if it's just a file name or database credentials to load
// configuration from.
$bootstrapConfig = new GlobalVarConfig();
- self::$instance = self::newInstance( $bootstrapConfig );
+ self::$instance = self::newInstance( $bootstrapConfig, 'load' );
}
return self::$instance;
/**
* Replaces the global MediaWikiServices instance.
*
+ * @since 1.28
+ *
* @note This is for use in PHPUnit tests only!
*
* @throws MWException if called outside of PHPUnit tests.
/**
* Creates a new instance of MediaWikiServices and sets it as the global default
* instance. getInstance() will return a different MediaWikiServices object
- * after every call to resetGlobalServiceLocator().
+ * after every call to resetGlobalInstance().
+ *
+ * @since 1.28
*
* @warning This should not be used during normal operation. It is intended for use
* when the configuration has changed significantly since bootstrap time, e.g.
* during the installation process or during testing.
*
- * @warning Calling resetGlobalServiceLocator() may leave the application in an inconsistent
+ * @warning Calling resetGlobalInstance() may leave the application in an inconsistent
* state. Calling this is only safe under the ASSUMPTION that NO REFERENCE to
* any of the services managed by MediaWikiServices exist. If any service objects
* managed by the old MediaWikiServices instance remain in use, they may INTERFERE
* was no previous instance, a new GlobalVarConfig object will be used to
* bootstrap the services.
*
+ * @param string $quick Set this to "quick" to allow expensive resources to be re-used.
+ * See SalvageableService for details.
+ *
* @throws MWException If called after MW_SERVICE_BOOTSTRAP_COMPLETE has been defined in
* Setup.php (unless MW_PHPUNIT_TEST or MEDIAWIKI_INSTALL or RUN_MAINTENANCE_IF_MAIN
* is defined).
*/
- public static function resetGlobalInstance( Config $bootstrapConfig = null ) {
+ public static function resetGlobalInstance( Config $bootstrapConfig = null, $quick = '' ) {
if ( self::$instance === null ) {
// no global instance yet, nothing to reset
return;
$bootstrapConfig = self::$instance->getBootstrapConfig();
}
- self::$instance->destroy();
+ $oldInstance = self::$instance;
self::$instance = self::newInstance( $bootstrapConfig );
+ self::$instance->importWiring( $oldInstance, [ 'BootstrapConfig' ] );
+
+ if ( $quick === 'quick' ) {
+ self::$instance->salvage( $oldInstance );
+ } else {
+ $oldInstance->destroy();
+ }
+
+ }
+
+ /**
+ * Salvages the state of any salvageable service instances in $other.
+ *
+ * @note $other will have been destroyed when salvage() returns.
+ *
+ * @param MediaWikiServices $other
+ */
+ private function salvage( self $other ) {
+ foreach ( $this->getServiceNames() as $name ) {
+ $oldService = $other->peekService( $name );
+
+ if ( $oldService instanceof SalvageableService ) {
+ /** @var SalvageableService $newService */
+ $newService = $this->getService( $name );
+ $newService->salvage( $oldService );
+ }
+ }
+
+ $other->destroy();
}
/**
* ServiceWiringFiles setting are loaded, and the MediaWikiServices hook is called.
*
* @param Config|null $bootstrapConfig The Config object to be registered as the
- * 'BootstrapConfig' service. This has to contain at least the information
- * needed to set up the 'ConfigFactory' service. If not provided, any call
- * to getBootstrapConfig(), getConfigFactory, or getMainConfig will fail.
- * A MediaWikiServices instance without access to configuration is called
- * "primordial".
+ * 'BootstrapConfig' service.
+ *
+ * @param string $loadWiring set this to 'load' to load the wiring files specified
+ * in the 'ServiceWiringFiles' setting in $bootstrapConfig.
*
* @return MediaWikiServices
* @throws MWException
+ * @throws \FatalError
*/
- private static function newInstance( Config $bootstrapConfig ) {
+ private static function newInstance( Config $bootstrapConfig, $loadWiring = '' ) {
$instance = new self( $bootstrapConfig );
// Load the default wiring from the specified files.
- $wiringFiles = $bootstrapConfig->get( 'ServiceWiringFiles' );
- $instance->loadWiringFiles( $wiringFiles );
+ if ( $loadWiring === 'load' ) {
+ $wiringFiles = $bootstrapConfig->get( 'ServiceWiringFiles' );
+ $instance->loadWiringFiles( $wiringFiles );
+ }
// Provide a traditional hook point to allow extensions to configure services.
Hooks::run( 'MediaWikiServices', [ $instance ] );
* storage layer will result in an error. Use resetGlobalInstance() to restore normal
* operation.
*
+ * @since 1.28
+ *
* @warning This is intended for extreme situations only and should never be used
* while serving normal web requests. Legitimate use cases for this method include
* the installation process. Test fixtures may also use this, if the fixture relies
* returns from after pcntl_fork(). It's also safe, but generally unnecessary,
* to call this method from the parent process.
*
+ * @since 1.28
+ *
* @note This is intended for use in the context of process forking only!
*
* @see resetGlobalInstance()
/**
* Resets the given service for testing purposes.
*
+ * @since 1.28
+ *
* @warning This is generally unsafe! Other services may still retain references
* to the stale service instance, leading to failures and inconsistencies. Subclasses
* may use this method to reset specific services under specific instances, but
* resetting of global services is allowed. In general, services should not be reset
* individually, since that may introduce inconsistencies.
*
+ * @since 1.28
+ *
* This method will throw an exception if:
*
* - self::$resetInProgress is false (to allow all services to be reset together
* when creating the MainConfig service. Application logic should
* use getMainConfig() to get a Config instances.
*
+ * @since 1.27
* @return Config
*/
public function getBootstrapConfig() {
}
/**
+ * @since 1.27
* @return ConfigFactory
*/
public function getConfigFactory() {
* Returns the Config object that provides configuration for MediaWiki core.
* This may or may not be the same object that is returned by getBootstrapConfig().
*
+ * @since 1.27
* @return Config
*/
public function getMainConfig() {
}
/**
+ * @since 1.27
* @return SiteLookup
*/
public function getSiteLookup() {
}
/**
+ * @since 1.27
* @return SiteStore
*/
public function getSiteStore() {
}
/**
+ * @since 1.27
* @return StatsdDataFactory
*/
public function getStatsdDataFactory() {
}
/**
+ * @since 1.27
* @return EventRelayerGroup
*/
public function getEventRelayerGroup() {
}
/**
+ * @since 1.27
* @return SearchEngine
*/
public function newSearchEngine() {
}
/**
+ * @since 1.27
* @return SearchEngineFactory
*/
public function getSearchEngineFactory() {
}
/**
+ * @since 1.27
* @return SearchEngineConfig
*/
public function getSearchEngineConfig() {
}
/**
+ * @since 1.27
* @return SkinFactory
*/
public function getSkinFactory() {
}
/**
+ * @since 1.28
* @return LBFactory
*/
public function getDBLoadBalancerFactory() {
}
/**
+ * @since 1.28
* @return LoadBalancer The main DB load balancer for the local wiki.
*/
public function getDBLoadBalancer() {
}
/**
+ * @since 1.28
* @return WatchedItemStore
*/
public function getWatchedItemStore() {
return $this->getService( 'WatchedItemStore' );
}
+ /**
+ * @since 1.28
+ * @return GenderCache
+ */
+ public function getGenderCache() {
+ return $this->getService( 'GenderCache' );
+ }
+ /**
+ * @since 1.28
+ * @return TitleFormatter
+ */
+ public function getTitleFormatter() {
+ return $this->getService( 'TitleFormatter' );
+ }
+
+ /**
+ * @since 1.28
+ * @return TitleParser
+ */
+ public function getTitleParser() {
+ return $this->getService( 'TitleParser' );
+ }
+
///////////////////////////////////////////////////////////////////////////
// NOTE: When adding a service getter here, don't forget to add a test
// case for it in MediaWikiServicesTest::provideGetters() and in
dépôts / lhc / web / wiklou.git / blobdiff