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: // Implements Registry data handling. sl@0: // Registry structure... sl@0: // iRegistrations sl@0: // -> CDriveData (Drive number 1) sl@0: // -> CDllData (Dll number 1) sl@0: // | -> CInterfaceData (Interface number 1) sl@0: // | | -> CImplementationData -> CImplementationInformation (Implementation 1) sl@0: // | | -> CImplementationData -> CImplementationInformation (Implementation 2) sl@0: // | -> CInterfaceData sl@0: // -> CDllData (Dll number 2) sl@0: // -> CInterfaceData (Interface number 1) sl@0: // -> CImplementationData -> CImplementationInformation (Implementation 1) sl@0: // sl@0: // sl@0: sl@0: /** sl@0: @code sl@0: @endcode sl@0: */ sl@0: sl@0: #ifndef __REGISTRYDATA_H__ sl@0: #define __REGISTRYDATA_H__ sl@0: sl@0: #include sl@0: #include sl@0: #include // RResourceReader sl@0: #include sl@0: #include sl@0: #include sl@0: #include "clientrequest.h" sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: #include "EComEntry.h" sl@0: #include "DiscovererObserver.h" sl@0: #include "EComPerformance.h" sl@0: #include "callback.h" sl@0: sl@0: /** sl@0: The index of the uid which is used for matching dlls sl@0: @internalComponent sl@0: */ sl@0: const TInt KTEntryDllUniqueIdIndex = 2; sl@0: sl@0: /** sl@0: Default path to Interface Implementation Collection resource files. sl@0: @internalComponent sl@0: */ sl@0: _LIT(KEComResourceFilePath,"\\resource\\plugins\\"); sl@0: sl@0: /** The granularities of two arrays, iInterfaceImplIndex and sl@0: iImplIndex, have huge impact on sl@0: discovery time on boot up. Larger granularity does not sl@0: always shorten discovery time. The two default granularities sl@0: below are chosen empirically to optimize discovery time sl@0: while as much as possible, not to waste too much memory. sl@0: sl@0: @internalComponent sl@0: */ sl@0: const TInt KDefaultInterfaceImplIndexGranularity = 23; sl@0: sl@0: /** @internalComponent */ sl@0: const TInt KDefaultImplIndexGranularity = 29; sl@0: sl@0: // Forward declaration sl@0: class CEComCachedDriveInfo; sl@0: sl@0: // sl@0: // CRegistryData class sl@0: sl@0: /** sl@0: @internalComponent sl@0: class CRegistryData. sl@0: This class manages the entire data of the registry. sl@0: */ sl@0: class CRegistryData : public CBase sl@0: { sl@0: public: sl@0: // Make the test State Accessor a friend sl@0: friend class TRegistryData_StateAccessor; sl@0: friend class CRegistrar; sl@0: sl@0: class CDriveData; sl@0: class CDllData; sl@0: class CInterfaceData; sl@0: class CImplementationData; sl@0: sl@0: // The implemented structure for the registry data sl@0: typedef CRegistryData::CImplementationData* CImplementationDataPtr; sl@0: sl@0: typedef RArray RImplDataArray; sl@0: /** whether the implementation to be added to the registry data sl@0: is a newcomer, or upgrade of an existing implementation, or sl@0: downgrade of an existing implementation. sl@0: */ sl@0: enum TInsertImplMode sl@0: { sl@0: EInsertImplUndefinedMode, sl@0: EInsertImplAsNewcomerOfInterface, sl@0: EInsertImplAsUpgradeOfExistingImpl, sl@0: EInsertImplAsUnusedImpl sl@0: }; sl@0: sl@0: public: sl@0: static CRegistryData* NewL(RFs& aFs); sl@0: sl@0: /** This overload is provided for ECom performance test to find sl@0: the optimum granularity settings. sl@0: @see CEComImplIndexPerfTest sl@0: */ sl@0: static CRegistryData* NewL(RFs& aFs, sl@0: TInt aInterfaceImplIndexGranularity, TInt aImplIndexGranularity); sl@0: sl@0: virtual ~CRegistryData(); sl@0: void ListImplementationsL(TUid aInterfaceUid, sl@0: RImplDataArray& aImplementationData) const; sl@0: TInt SetEnabledState(TUid aImplementationUid, TBool aState); sl@0: void TemporaryUninstallL(const TDriveUnit& aDrive); sl@0: void UndoTemporaryUninstallL(const TDriveUnit& aDrive); sl@0: TBool IsRegisteredWithDate(TUid aDllUid, sl@0: const TTime& aModified, sl@0: TBool& aUpdate, sl@0: CDriveData* aDriveData); sl@0: void AddDllDataL(const TDriveUnit& aDrive, TInt aFoundDriveIndex, CDllData* aDllData); sl@0: void UpdateDllDataL(const TDriveUnit& aDrive,TInt aFoundDriveIndex, CDllData* aDllData); sl@0: void DiscoveriesBeginning() const; sl@0: void DiscoveriesCompleteL(TBool aSuccessful, TPluginProcessingTypeIdentifier aProcessingType, TBool& aHasRegistryChanged); sl@0: TBool IndexValid() const; sl@0: TInt GetImplementationDllInfoForServer( const TCapabilitySet& aCapabilitySet, sl@0: const TUid aImplUid, sl@0: const TUid aInterfaceUid, sl@0: TEntry& aEntry, sl@0: CImplementationInformation*& aImplInfo, sl@0: TBool& aIsOnRWDrive) const; sl@0: TInt GetImplementationDllInfoForClientL(const TClientRequest& aClientRequest, sl@0: const TUid aImplUid, sl@0: const TUid aInterfaceUid, sl@0: TEntry& aEntry, sl@0: CImplementationInformation*& aImplInfo, sl@0: TBool aSecurityCheckNeeded)const; sl@0: TBool HasLanguageChanged() const; sl@0: TBool InsertIntoIndexL(CImplementationData* aImplPtr, TBool aCheckIsNeeded); sl@0: void RemoveFromIndexL(CDllData* aDllData) const; sl@0: TBool IsAnyDllRegisteredWithDriveL(const TDriveUnit& aDrive)const; sl@0: TInt FindDriveL(const TDriveUnit& aDrive, CDriveData*& aDriveData)const; sl@0: void SetDiscoveryFlagL(const TDriveUnit& aDriveUnit); sl@0: void LanguageChangedL(TBool& aLanguageChanged); sl@0: void SetImplUpgradeCallBack(const TCallBackWithArg& aCallBack); sl@0: sl@0: #ifdef __ECOM_SERVER_PERFORMANCE__ sl@0: void GetRegistryCountsL(TInt aType, RegistryCounts::TRegistryCounts& aCounts) const; sl@0: #endif // __ECOM_SERVER_PERFORMANCE__ sl@0: sl@0: private: sl@0: typedef RPointerArray TRegistration; sl@0: sl@0: /** sl@0: Implementation structure containing the current in use implementation and sl@0: a list of unused implementations with the same uid held in the registry tree. sl@0: The unused list is used to allow efficient rollback to previous impl in the event sl@0: that the current impl is removed. sl@0: */ sl@0: typedef struct TImplStruct sl@0: { sl@0: /** Constructor */ sl@0: TImplStruct(); sl@0: /** Resets iUnusedImpls*/ sl@0: inline void Reset(); sl@0: /** Comparer*/ sl@0: static TInt CompareImplStructUid(const TImplStruct& aEntry1,const TImplStruct& aEntry2); sl@0: /** Comparer to search TImplStruct with just the Impl. UID */ sl@0: static TInt CompareUidAgainstImplStruct(const TUid* aUid, const TImplStruct& aEntry); sl@0: /** sl@0: Current Impl. This is not held in an array with the unused implementations because the array is not sl@0: sorted. See comment for iUnusedImpls. sl@0: */ sl@0: CImplementationDataPtr iCurrentImpl; sl@0: /** sl@0: List of additional unused implementations. This list is not ordered as the processing required to sort sl@0: the list when adding is more than that required to determine which should be used on rollback. sl@0: Also this additional processing is not wanted during startup. sl@0: */ sl@0: RImplDataArray iUnusedImpls; sl@0: }TImplContainer; sl@0: sl@0: typedef RArray TImplContainerArray; sl@0: sl@0: /** sl@0: Interface used by all implementation index sl@0: */ sl@0: typedef struct TInterfaceStruct sl@0: { sl@0: /** Constructor */ sl@0: TInterfaceStruct(); sl@0: /** Resets iImplementationInfo */ sl@0: inline void Reset(); sl@0: /** Comparer*/ sl@0: static TInt CompareInfUid(const TInterfaceStruct& aIndexEntry1,const TInterfaceStruct& aIndexEntry2); sl@0: /** Unique Id of this interface */ sl@0: TUid iInterfaceUid; sl@0: /** List of the implementations of this interface */ sl@0: TImplContainerArray iImpData; sl@0: }TInterfaceIndex; sl@0: sl@0: private: sl@0: explicit CRegistryData(RFs& aFs, TInt aInterfaceImplIndexGranularity, TInt aImplIndexGranularity); sl@0: void ConstructL(); sl@0: sl@0: TInt IndexedFind(TUid aInterfaceUid) const; sl@0: static TBool MatchOnDrive(const CRegistryData::CDriveData& aIndexOne, sl@0: const CRegistryData::CDriveData& aIndexTwo); sl@0: sl@0: TInt FindImplementation(const TUid aImplUid, const TUid aInterfaceUid, CImplementationData*& aImplData) const; sl@0: CImplementationData* SelectDuplicatedImpl(const CImplementationData* aImpl1, const CImplementationData* aImpl2) const; sl@0: sl@0: void ValidateRegistryL(); sl@0: sl@0: CImplementationData* SelectPreferredImplL(CImplementationData* aOldImpl, sl@0: CImplementationData* aNewImpl, sl@0: TBool& aLigitimateImpl, sl@0: TBool aCheckIsNeeded) const; sl@0: sl@0: void FilterForLatestLegitimateImplL(TImplContainerArray& aIdxArray, sl@0: CImplementationData* aNewImpl, sl@0: TInsertImplMode& aInsertMode, sl@0: TInt& aPosOfImplInArray, sl@0: TBool& aLigitimateImpl, sl@0: TBool aCheckIsNeeded); sl@0: void DeleteDllL(CDllData* aDllData) const; sl@0: void AddImplDataL(CDriveData* aDriveData); sl@0: sl@0: void InsertImplInIndexesL(TInsertImplMode aInsertMode, sl@0: TInt aIfPosInInterfaceImplIndex, sl@0: TInterfaceIndex& aNewIfIndexEl, sl@0: TInt aImplPosInContainerArray, sl@0: CImplementationData* aNewImpl, sl@0: TBool aLegitimateImpl); sl@0: static void ResetTInterfaceIndex(TAny* aObject); sl@0: sl@0: /** Remove the pointer from iImplIndex based on the impl address*/ sl@0: TBool RemoveImplByAddrFromImplIndex(CImplementationData* aPtr) const; sl@0: sl@0: /** Used to restore the impIndex sanity in case of a leave */ sl@0: static void RemoveImplFromImplIndexCleanUp(TAny* aPtr); sl@0: sl@0: /** Insert aNewImpl into iImplIndex. */ sl@0: TInt InsertImplIntoImplIndex(CImplementationData* aNewImpl) const; sl@0: /** Store change in drive state - addition or removal*/ sl@0: void DriveChanged(const TDriveUnit& aDrive, TBool aDriveRemoved); sl@0: sl@0: // Attributes / Properties sl@0: private: sl@0: /** A reference to a connected file server instance */ sl@0: RFs& iFs; sl@0: /** The flag to indicate that we are in the middle of discoveries and therefore sl@0: the index list is probably out of date */ sl@0: mutable TBool iCurrentlyDiscovering; sl@0: /** A boolean, indicating if the language downgrade path has changed */ sl@0: TBool iLanguageChanged; sl@0: /** The entire registration data */ sl@0: TRegistration* iRegistrations; sl@0: /** The index of all registered implementations sorted by interface UID.*/ sl@0: mutable RArray iInterfaceImplIndex; sl@0: /** Index of all implementations available to clients sorted by sl@0: Implementation UID. sl@0: Majority of clients do not specify the interface UID in sl@0: their create requests. Thus ECOM needs this auxiliary index. sl@0: Note that if multiple entries have the same Impl. UID, they are sl@0: ordered by the interface UID. sl@0: */ sl@0: mutable RPointerArray iImplIndex; sl@0: /**Bitmap indicating any drives removed */ sl@0: TInt iRemovedDrives; sl@0: sl@0: TCallBackWithArg iImplUpgradeCallBack; sl@0: sl@0: public: sl@0: /** System Drive cache to allow access by CEComServer*/ sl@0: TDriveNumber iSystemDrive; sl@0: sl@0: /** cached info on drivelist */ sl@0: CEComCachedDriveInfo* iCachedDriveInfo; sl@0: }; // End of CRegistryData definition sl@0: sl@0: sl@0: // sl@0: // CRegistryData::CImplementationData class sl@0: /** sl@0: This wrapper class is needed, to create a 2 way relationship between CInterfaceData and the public sl@0: CImplementationInformation objects. It holds a reference to an implementation and a reference to its sl@0: parent interface data. sl@0: @internalComponent sl@0: */ sl@0: class CRegistryData::CImplementationData : public CBase sl@0: { sl@0: public: sl@0: static CImplementationData* NewLC(CInterfaceData* aParent); sl@0: static CImplementationData* NewL(CInterfaceData* aParent, sl@0: TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased); sl@0: static CImplementationData* NewL(CInterfaceData* aParent, sl@0: TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased, sl@0: RExtendedInterfacesArray* aExtendedInterfaces); sl@0: ~CImplementationData(); sl@0: void ExternalizeL(RWriteStream& aStore) const; sl@0: void InternalizeL(RReadStream& aStore); sl@0: static TInt CompareImplUid(const CImplementationData& aImpl1,const CImplementationData& aImpl2); sl@0: static TInt CompareImplUidIgnoreIfUid(const CImplementationData& aImpl1,const CImplementationData& aImpl2); sl@0: static TInt CompareUidAgainstImplData(const CImplementationData& aUid, const CImplementationData& aImplData); sl@0: private: sl@0: CImplementationData(CInterfaceData* aParent); sl@0: void ConstructL(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased); sl@0: void ConstructL(TUid aUid, sl@0: TInt aVersion, sl@0: HBufC* aName, sl@0: HBufC8* aDataType, sl@0: HBufC8* aOpaqueData, sl@0: TDriveUnit aDrive, sl@0: TBool aRomOnly, sl@0: TBool aRomBased, sl@0: RExtendedInterfacesArray* aExtendedInterfaces); sl@0: public: sl@0: /** A pointer to the implementation */ sl@0: CImplementationInformation* iImplInfo; sl@0: /**Pointer to the parent CInterfaceData */ sl@0: CInterfaceData* iParent; sl@0: }; sl@0: sl@0: // sl@0: // CRegistryData::CInterfaceData class sl@0: sl@0: /** sl@0: This class manages the entire data for an interface of a dll. sl@0: @internalComponent sl@0: */ sl@0: class CRegistryData::CInterfaceData : public CBase sl@0: { sl@0: public: sl@0: static CInterfaceData* NewLC(CDllData* aParent); sl@0: static CInterfaceData* NewLC(TUid aInterfaceUid, CDllData* aParent); sl@0: ~CInterfaceData(); sl@0: void AddL(const CImplementationData* aImplementation); sl@0: void SetInterfaceUid(TUid aInterfaceUid); sl@0: void ExternalizeL(RWriteStream& aStore) const; sl@0: void InternalizeL(RReadStream& aStore); sl@0: private: sl@0: CInterfaceData(CDllData* aParent); sl@0: CInterfaceData(TUid aInterfaceUid,CDllData* aParent); sl@0: void ConstructL(); sl@0: public: sl@0: /** The interface UID */ sl@0: TUid iInterfaceUid; sl@0: /** The implementations related to this interface */ sl@0: RPointerArray* iImplementations; sl@0: /** Pointer to the parent DLL data */ sl@0: CDllData* iParent; sl@0: }; // End CRegistryData::CInterfaceData sl@0: sl@0: /** sl@0: @internalComponent sl@0: */ sl@0: typedef RPointerArray RInterfaceList ; sl@0: sl@0: // sl@0: // CRegistryData::CDllData class sl@0: sl@0: /** sl@0: This class manages the entire data of a registered dll. sl@0: @internalComponent sl@0: */ sl@0: class CRegistryData::CDllData : public CBase sl@0: { sl@0: public: sl@0: static CDllData* NewLC( CDriveData* iParent);// sl@0: static CDllData* NewLC(const TDesC& aDllName,const TTime& aDllModTime,const TUid& aSecondUid,const TUid& aThirdUid, CDriveData* iParent); sl@0: ~CDllData(); sl@0: void AddL(const CInterfaceData* aInterface); sl@0: void ExternalizeL(RWriteStream& aStore) const; sl@0: void InternalizeL(RReadStream& aStore); sl@0: void PopulateAnEntry(TEntry& aEntry) const; sl@0: TBool ProcessSecurityCheckL(); sl@0: TBool SaveSecurityInfoL(); sl@0: void SetResourceExtL(const TDesC& aExt); sl@0: private: sl@0: CDllData( CDriveData* iParent);// sl@0: void ConstructL();// sl@0: /** See CDllData* NewLC */ sl@0: void ConstructL(const TDesC& aDllName,const TTime& aDllModTime,const TUid& aSecondUid,const TUid& aThirdUid); sl@0: sl@0: public: sl@0: /** Information on the DLL */ sl@0: CEComEntry* iDllEntry; sl@0: /** The list of interfaces within the dll */ sl@0: RInterfaceList* iIfList; sl@0: /** Capability set of this dll */ sl@0: TCapabilitySet iCapSet; sl@0: /** A flag to tell if the DLL's security has been previously checked or not.*/ sl@0: TBool iSecurityChecked; sl@0: /** A pointer to the parent drive data. */ sl@0: CDriveData* iParent; sl@0: /** The VendorId of the DLL. */ sl@0: TVendorId iVid; sl@0: /** The plugin resource file extension - not set for plugins residing on RO Internal drives*/ sl@0: HBufC* iRscFileExtension; sl@0: }; // End CRegistryData::CDllData sl@0: sl@0: /** sl@0: @internalComponent sl@0: */ sl@0: typedef RPointerArray TDll ; sl@0: sl@0: // sl@0: // CRegistryData::CDriveData class sl@0: sl@0: /** sl@0: This class manages the entire data of a registered dll. sl@0: */ sl@0: class CRegistryData::CDriveData : public CBase sl@0: { sl@0: public: sl@0: static CDriveData* NewLC(TDriveUnit aDrive,CRegistryData* aParent); sl@0: ~CDriveData(); sl@0: void AddL(const CDllData* aDll); sl@0: void ExternalizeL(RFs& aFs,const TDesC& aDatFileName); sl@0: void InternalizeL(RFs& aFs,const TDesC& aDatFileName); sl@0: TInt FindDllIndex(const TUid aDllUid) const; sl@0: private: sl@0: void DoInternalizeL(RFs& aFs, const TDesC& aFileName); sl@0: CDriveData(TDriveUnit aDrive,CRegistryData* aParent); sl@0: void ConstructL(); sl@0: sl@0: public: sl@0: /** A reference to the drive. */ sl@0: TDriveUnit iDrive; sl@0: /** The list of Interface Implementation Collections upon the drive */ sl@0: TDll* iDllList; sl@0: /** The registry data. */ sl@0: CRegistryData* iParent; sl@0: /**indicate the drive has change */ sl@0: TBool iDriveChanged; sl@0: /**indiacate the registry data on the drive has changed */ sl@0: TBool iRegistryChanged; sl@0: sl@0: }; // End CRegistryData::CDriveData sl@0: sl@0: void CRegistryData::TInterfaceIndex::Reset() sl@0: { sl@0: TInt count = iImpData.Count(); sl@0: while(count > 0) sl@0: { sl@0: --count; sl@0: iImpData[count].Reset(); sl@0: } sl@0: iImpData.Reset(); sl@0: } sl@0: sl@0: void CRegistryData::TImplContainer::Reset() sl@0: { sl@0: iUnusedImpls.Reset(); sl@0: } sl@0: sl@0: sl@0: class TCleanupImplIndexEntry sl@0: { sl@0: public: sl@0: TCleanupImplIndexEntry(CRegistryData* aRegData, CRegistryData::CImplementationData* aImpl) sl@0: : iRegistryData(aRegData), iImplEntry(aImpl) sl@0: {} sl@0: CRegistryData* iRegistryData; sl@0: CRegistryData::CImplementationData* iImplEntry; sl@0: }; sl@0: #endif //__REGISTRYDATA_H__