sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Contains the definition of the CRegistrar class.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @internalComponent
sl@0:  @file 
sl@0: */
sl@0: 
sl@0: #ifndef __REGISTRAR_H__
sl@0: #define __REGISTRAR_H__
sl@0: 
sl@0: #include <f32file.h>
sl@0: #include <barsread2.h> // RResourceReader
sl@0: #include "DiscovererObserver.h"
sl@0: #include "BackupNotifierObserver.h"
sl@0: #include "RegistryData.h"
sl@0: #include "StartupStateObserver.h"
sl@0: #include "callback.h"
sl@0: class CDiscoverer;
sl@0: class CBackupNotifier;
sl@0: class MRegistrarObserver;
sl@0: class CEComCachedDriveInfo;
sl@0: 
sl@0: /**
sl@0: 	@internalComponent
sl@0: 	@since 7.0
sl@0: 	Responsible for managing Interface Implementaion Collection registration
sl@0: 	(adding and removing entries).
sl@0:  */
sl@0: 
sl@0: class CRegistrar : public CBase, public MStartupStateObserver, private MDiscovererObserver, private MBackupNotifierObserver
sl@0: {
sl@0: public:
sl@0: 
sl@0: /** State declaration for CRegistrar */	
sl@0: 	enum TRegistrarState
sl@0: 	{
sl@0: 	/** Undefined state*/
sl@0: 	EReg_Undefined,
sl@0: 	/** Internalization/Externalization and Discovery in progress */
sl@0: 	EReg_StartupInProgess,
sl@0: 	/** Internalization/Externalization and Discovery complete */
sl@0: 	EReg_StartupComplete
sl@0: 	};
sl@0: 	
sl@0: /**
sl@0: 	@fn				static CRegistrar* NewL(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
sl@0: 	Intended Usage	: Standardised safe construction which leaves nothing 
sl@0: 					on the cleanup stack.
sl@0: 	Error Condition	: Cannot fully construct because of memory limitations.	
sl@0: 	@leave			KErrNoMemory
sl@0: 	@since			7.0
sl@0: 	@param			aRegistry A reference to the registry data management class.
sl@0: 	@param			aRegistrarObserver A reference to the registrar observer class.
sl@0: 	@param			aFs A reference to an connected file server session.
sl@0: 	@return			CRegistrar* A pointer to the new class
sl@0: 	@pre 			None
sl@0: 	@post			CRegistrar is fully constructed, 
sl@0: 					and initialised.
sl@0:  */
sl@0: 	
sl@0: 	static CRegistrar* NewL(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs);
sl@0: 
sl@0: /**
sl@0: 	@fn				~CRegistrar()
sl@0: 	Intended Usage	: Standard default d'tor
sl@0: 	Error Condition	: None
sl@0: 	@since			7.0
sl@0: 	@pre 			None
sl@0: 	@post			CRegistrar is totally destroyed
sl@0:  */
sl@0: 	
sl@0: 	~CRegistrar();
sl@0: 
sl@0: /**
sl@0: 	@fn				Enable(TUid aImplementationUid)
sl@0: 	Intended Usage	:Allow the specified Interface Implementation to be used.
sl@0: 	Error Condition	: KErrEnableFailed The enable call failed.
sl@0: 	@since			7.0	:
sl@0: 	@param			aImplementationUid The Interface Implementation to enable.
sl@0: 	@return			KErrNone on success, KErrEnableFailed otherwise.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			The interface implementation identified by 
sl@0: 					the UID	is made available for use.
sl@0:  */
sl@0: 	
sl@0: 	TInt Enable(TUid aImplementationUid);
sl@0: 
sl@0: /**
sl@0: 	@fn				Disable(TUid aImplementationUid)
sl@0: 	Intended Usage	:Stop the specified interface implementation 
sl@0: 					from being used.
sl@0: 	Error Condition	: KErrDisableFailed The disable call failed.
sl@0: 	@since			7.0	:
sl@0: 	@param			aImplementationUid The Interface Implementation to disable.
sl@0: 	@return			KErrNone on success, KErrDisableFailed otherwise.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			The interface implementation identified by 
sl@0: 					the UID	is no longer available for use.
sl@0:  */	
sl@0: 	
sl@0: 	TInt Disable(TUid aImplementationUid);
sl@0: 
sl@0: /**
sl@0: 	@fn				Resume()
sl@0: 	Intended Usage	: Overload of the MBackupNotifierObserver method.
sl@0: 					Allow registration of new Interface Implementation Collections
sl@0: 					to begin again.
sl@0: 	Error Condition	: KErrResumeFailed The registration resume failed.
sl@0: 	@since			7.0	:
sl@0: 	@return			KErrNone on success, KErrResumeFailed otherwise.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			Registration suspension is cancelled.
sl@0:  */	
sl@0: 	
sl@0: 	TInt Resume();
sl@0: 
sl@0: /**
sl@0: 	@fn				Suspend()
sl@0: 	Intended Usage	: Overload of the MBackupNotifierObserver method.
sl@0: 					Suspend registration of new Interface Implementation Collections.
sl@0: 	Error Condition	: KErrSuspendFailed The registration suspension failed.
sl@0: 	@since			7.0	:
sl@0: 	@return			KErrNone on success, KErrSuspendFailed otherwise.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			Registration is suspended.
sl@0:  */	
sl@0: 	
sl@0: 	TInt Suspend();
sl@0: 	
sl@0: /** 
sl@0: 	@fn				ProcessSSAEventL()
sl@0: 	Intended Usage	:Overload of MStartupStateObserver method.
sl@0: 					Used by CServerStratupMgr to notify the objects 
sl@0: 					of the start-up state changes.
sl@0: 	@param 			aKnownState the startup state passing into the CRegistar.
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post 			CRegistrar is notified of the start-up state changes.
sl@0: */
sl@0: 	void ProcessSSAEventL(TStartupStateIdentifier aKnownState);
sl@0: 
sl@0: /** Install a callback function to receive notification of SWI status
sl@0: changes. Note that the callback is passed along to CDsicoverer which
sl@0: does the SWI monitoring.
sl@0: @param aCallBack the callback function to install.
sl@0: */
sl@0: 	void InstallSwiEventCallBack(const TCallBackWithArg& aCallBack);
sl@0: 
sl@0: /** Install a callback function to receive notification of BUR status
sl@0: changes. Note that the callback is passed along to CDsicoverer which
sl@0: does the BUR monitoring.
sl@0: @param aCallBack the callback function to install.
sl@0: */
sl@0: 	void InstallBurEventCallBack(const TCallBackWithArg& aCallBack);
sl@0: 
sl@0: private:
sl@0: // MDiscovererObserver method implementations
sl@0: /**
sl@0: 	@fn				DiscoveriesBegin()
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					The cue that a registry update is about to occur.
sl@0: 	Error Condition	: None.
sl@0: 	@since			7.0	:
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			The Registry data manager has been informed that its internal
sl@0: 					data is out of date.
sl@0:  */
sl@0: 	
sl@0: 	void DiscoveriesBegin();
sl@0: 
sl@0: /**
sl@0: 	@fn				RegisterDiscoveryL(const TDriveName& aDrive,CPluginBase*& aDirEntry,TBool aAnyDllDiscovered)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					Adds the specified Interface Implementation Collection to the 
sl@0: 					registry.
sl@0: 	Error Condition	: Leaves with an error code.
sl@0: 	@leave  		KErrNoMemory, KErrRegistrationFailed.
sl@0: 	@since			9.1	:
sl@0: 	@param			aDrive, the drive containing this entry
sl@0: 	@param			aDirEntry The directory entry to register.
sl@0: 	@param			aAnyDllDiscovered A flag to tell if any DLL is discovered in the drive.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			The Interface Implementation Collection identified by the directory entry 
sl@0: 					is registered.
sl@0:  */
sl@0: 	
sl@0: 	void RegisterDiscoveryL(const TDriveName& aDrive,CPluginBase*& aDirEntry, TBool aAnyDllDiscovered);
sl@0: 
sl@0: /**
sl@0: 	@fn				UpdateRegistryL(TDriveUnit& driveUnit, TUid aDllUid, const TTime& aModified, TInt& aRegistryDriveIndex)
sl@0: 	Intended Usage	:Checks if the Registry must be updated or not.
sl@0: 	Error Condition	: Leaves with an error code.
sl@0: 	@leave			KErrNoMemory, KErrRegistrationFailed.
sl@0: 	@since			9.0	:
sl@0: 	@param			aDrive The drive the registry data has been found on
sl@0: 	@param			aDllUid The interface implementation collection data to add. 
sl@0: 					CRegistryData takes ownership of this object
sl@0: 					so it should not be on the CleanupStack.
sl@0: 	@param			aModified The date of the last modification of the Interface 
sl@0: 					Implementation Collection. 
sl@0: 	@param			aRegistryDriveIndex An output providing index within the registry data 
sl@0: 					for the branch that the registry entry was found within. 
sl@0: 	@return			ETrue if the Interface Implementation Collection already has a registry entry and
sl@0: 					must be updated.
sl@0: 					EFalse otherwise.
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			No change to object..
sl@0:  */
sl@0: 	TBool UpdateRegistryL(TDriveUnit& driveUnit, TUid aDllUid, const TTime& aModified, TInt& aRegistryDriveIndex);
sl@0: 
sl@0: /**
sl@0: 	@fn				DiscoveriesComplete(TBool aSuccessful,TPluginProcessingTypeIdentifier aProcessingType)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 	Error Condition	: None.
sl@0: 	@since			7.0	:
sl@0: 	@param			aSuccessful ETrue indicates the scan completed successfully,
sl@0: 					EFalse, that the scan was only partial.
sl@0: 	@param			aProcessingType indicates the type of processing for plugins
sl@0: 					for ensuring that plugins are not processed multiple times
sl@0: 					during start-up phase
sl@0: 	@pre 			CRegistrar is fully constructed
sl@0: 	@post			The current registry data and the 
sl@0: 					internal access indexes have been rebuilt.
sl@0:  */
sl@0: 	
sl@0: 	void DiscoveriesComplete(TBool aSuccessful, TPluginProcessingTypeIdentifier aProcessingType);
sl@0: /**
sl@0: 	@fn 			SetDiscoveryFlagL(const TDriveUnit aDrive)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method
sl@0: 					to notify the observer to find the drive has changed.
sl@0: 	Error Condition	: None.
sl@0: 	@param 			aDrive The identifier of the drive changed.
sl@0: 	@pre 			The MDiscovererObserver must be fully constructed
sl@0: 	@post			The flag is set.				 
sl@0: */	
sl@0: 	void SetDiscoveryFlagL(const TDriveUnit& aDriveUnit);
sl@0: /**
sl@0: 	@fn				DriveRemovedL(TDriveUnit aDrive)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					The cue to signal the registry that 
sl@0: 					the registered Interface Implementation Collections
sl@0: 					stored upon the specified drive should no 
sl@0: 					longer available for use.
sl@0: 	Error Condition	: Leaves with an error code.
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			7.0	:
sl@0: 	@param			aDrive	The drive identifier.
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			The registered Interface Implementation Collections
sl@0: 					stored upon the specified drive are no 
sl@0: 					longer available for use.
sl@0:  */
sl@0: 	
sl@0: 	void DriveRemovedL(TDriveUnit aDrive);
sl@0: 
sl@0: /**
sl@0: 	@fn				DriveReinstatedL(TDriveUnit aDrive)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					The cue to signal the registry that 
sl@0: 					the registered Interface Implementation Collections
sl@0: 					stored upon the specified drive are again
sl@0: 					available for use.
sl@0: 	Error Condition	: Leaves with an error code.
sl@0: 	@leave  		KErrNoMemory, KErrRegistrationFailed.
sl@0: 	@since			7.0	:
sl@0: 	@param			aDrive	The drive identifier.
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			The registered Interface Implementation Collections
sl@0: 					stored upon the specified drive are again 
sl@0: 					made available for use.
sl@0:  */
sl@0: 	
sl@0: 	void DriveReinstatedL(TDriveUnit aDrive);
sl@0: 
sl@0: /**
sl@0: 	@fn				NotifiedWithErrorCode(TInt aError)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					The notification that the notifier has been activated
sl@0: 					with an error status code. The observer should instruct
sl@0: 					the notification object how to proceed.
sl@0: 	Error Condition	: None.	
sl@0: 	@since			7.0	:
sl@0: 	@param			aError	The error value recieved by the notifier.
sl@0: 	@return			ETrue for ignore error, EFalse otherwise. 
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			The status code should be used by the observer to instruct 
sl@0: 					the notifier to cease recieving notifications or not.
sl@0:  */
sl@0: 	
sl@0: 	TBool NotifiedWithErrorCode(TInt aError);
sl@0: 	
sl@0: /*	
sl@0: 	@fn				LanguageChangedL(TBool& aLanguageChanged)
sl@0: 	Intended Usage	:Overload of the MDiscovererObserver callback method.
sl@0: 					It is used to notify the observer that the language switch notifier has been activated.
sl@0: 					The observer should instruct the notification object how to proceed.
sl@0: 	Error Condition	: Leaves with an error code.
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			9.3	:
sl@0: 	@param			aLanguageChanged the flag returned to indicate whether language downgrade path is changed.
sl@0: 	@pre 			The MDiscovererObserver must be fully constructed, and
sl@0: 					capable of accepting discoveries for registration.
sl@0: 	@post			The CRegistryData will have its iLanguageChanged 
sl@0: 					flag set to True when language switch happens.
sl@0: 
sl@0: */
sl@0: 	void LanguageChangedL(TBool& aLanguageChanged);
sl@0: 
sl@0: // Internal methods
sl@0: /**
sl@0: 	@internalComponent
sl@0: 	@fn				CRegistrar(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
sl@0: 	Intended Usage	: Standardised default c'tor
sl@0: 	Error Condition	: None
sl@0: 	@since			7.0
sl@0: 	@param			aRegistry A reference to the registry data management class.
sl@0: 	@param			aRegistrarObserver A reference to the registrar observer class.
sl@0: 	@param			aFs A reference to an connected file server session.
sl@0: 	@pre 			None
sl@0: 	@post			CRegistrar is fully constructed
sl@0:  */
sl@0: 	
sl@0: 	CRegistrar(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs);
sl@0: 
sl@0: /**
sl@0: 	@fn				void ConstructL()
sl@0: 	Intended Usage	: Standardised 2nd, (Initialisation) phase of two phase construction.
sl@0: 	Error Condition	: None
sl@0: 	@leave			None
sl@0: 	@since			7.0
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			CRegistrar is fully initialised.
sl@0:  */
sl@0: 	
sl@0: 	void ConstructL();
sl@0: 
sl@0: /**
sl@0: 	@fn				ParseRegistrationDataL(CPluginBase*& aEntry, 
sl@0: 										   const TDriveUnit& aDrive, 
sl@0: 										   TBool aUpdate, 
sl@0: 										   TInt aRegistryDriveIndex)
sl@0: 	Intended Usage	: To determine if the directory entry for an Interface Implementation 
sl@0: 					Collection entry requires registration.
sl@0: 					Parsing the associated resource file information where necessary.
sl@0: 	Error Condition	: Parsing fails due to a lack of memory, or a parsing error.
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			9.1
sl@0: 	@param			aEntry The directory entry data for the Interface Impplementation Collection.
sl@0: 	@param			aDrive The drive the registry data has been found on 
sl@0: 	@param			aUpdate A flag indicating if this is an update, or new entry.
sl@0: 	@param			aRegistryDriveIndex The index within the registry data 
sl@0: 					for the branch that the registry entry was found within. 
sl@0: 	@param			aDriveData Output value, which delivers the CDriveData object, needed for the
sl@0: 					CDllData object construction.
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			The Interface Implementation Collection entry has been processed appropriately.
sl@0: */
sl@0: 	
sl@0: 	void ParseRegistrationDataL(CPluginBase*& aEntry,
sl@0: 								const TDriveUnit& aDrive, 
sl@0: 								TBool aUpdate, 
sl@0: 								TInt aRegistryDriveIndex, 
sl@0: 								CRegistryData::CDriveData* aDriveData);
sl@0: 
sl@0: /**
sl@0: 	@fn				ParseL(CPluginBase*& aEntry, CRegistryData::CDllData& aDll)
sl@0: 	Intended Usage	: Parsing the resource file information associated with an
sl@0: 					Interface Implementation Collection for entry into the registry
sl@0: 					information.	
sl@0: 	Error Condition	: Parsing fails due to a lack of memory, or a parsing error.
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			9.1
sl@0: 	@param			aEntry The directory entry data for the Interface Impplementation Collection.
sl@0: 	@param			aDll The CDllData information to fill
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0: 	@post			The resource file has been parsed and the data added to 'aDll'.
sl@0:  */
sl@0: 	
sl@0: 	void ParseL(CPluginBase*& aEntry,CRegistryData::CDllData& aDll);
sl@0: /**
sl@0: 	Intended Usage	: Get resource format version from the resource file
sl@0: 	@param			aReader The resource file reader.
sl@0: 	@param			aResourceFormatVersion The resource file format version 
sl@0: 	@pre 			CRegistrar is fully constructed.
sl@0:  */
sl@0: 	void GetResourceFormatVersionL(RResourceReader& aReader, TInt& aResourceFormatVersion);
sl@0: /**
sl@0: 	@fn 			State()
sl@0: 	Intended Usage	:Retrieve the object's current state.
sl@0: 	@return 		TCRegistarState the CRegistrar's current state.
sl@0: 	@pre			CRegistrar is fully constructed.
sl@0: 	@post 			the CRegistrar's current state has been returned.
sl@0: */
sl@0: 	TRegistrarState State() const;
sl@0: 	
sl@0: /**
sl@0: 	@fn 			InitialiseEvent()
sl@0: 	Intended Usage	: change the state during the CRegistrar's construction.
sl@0: 	@post			: state is changed to EReg_StartupInProgess.
sl@0: */
sl@0: 	void InitialiseEvent();
sl@0: 	
sl@0: /** 
sl@0: 	@fn				IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)
sl@0: 	Intended Usage	Find if any Dll is registered in the drive unit.
sl@0: 	@param 			aDrive the identifier of the drive to find if any Dll is registered.
sl@0: 	@return			ETrue if any Dll is registered in the drive, otherwise EFalse.
sl@0: 	@pre			CRegistrar is fully constructed.
sl@0: 	@post			If any Dll registered in the drive is returned.
sl@0: */
sl@0: 	TBool IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive) const;
sl@0: 	
sl@0: 
sl@0: 	
sl@0: //Attributes
sl@0: private:
sl@0: 
sl@0: 	/** The reference to the registry data manager class */
sl@0: 	
sl@0: 	CRegistryData&		iRegistry;
sl@0: 	/** The owned discovery notification handling class */
sl@0: 	
sl@0: 	CDiscoverer*		iDiscoverer;
sl@0: 	/** The owned backup/restore notification handling class */
sl@0: 	
sl@0: 	CBackupNotifier*	iBackupNotifier;
sl@0: 	/** 
sl@0: 		The reference to the observer of the 
sl@0: 		Registrar for change notification. 
sl@0: 	*/
sl@0: 	
sl@0: 	MRegistrarObserver& iRegistrarObserver;
sl@0: 	/** A reference to a conncted file session */
sl@0: 	
sl@0: 	RFs&			iFs;
sl@0: 	
sl@0: 	/** The current state of this object */
sl@0: 	TRegistrarState iState;
sl@0: 
sl@0: 	/** cached info on drivelist */
sl@0: 	CEComCachedDriveInfo*  iCachedDriveInfo;
sl@0: 
sl@0: 	// Declare the test accessor as a friend
sl@0: 	friend class TRegistrar_StateAccessor;
sl@0: };
sl@0: 
sl@0: #endif /* __REGISTRAR_H__ */
sl@0: