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: // Implementation of the registrar class
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @internalComponent
sl@0:  @file 
sl@0: */
sl@0: 
sl@0: #include <barsc2.h> // CResourceFile
sl@0: #include <barsread2.h> // RResourceReader
sl@0: #include <bautils.h>
sl@0: #include <e32uid.h>
sl@0: #include <startup.hrh> // for EStartupStateNonCritical
sl@0: 
sl@0: #include "ecompanics.h"
sl@0: #include "EComDebug.h"
sl@0: #include <ecom/ecom.h>
sl@0: #include <ecom/ecomerrorcodes.h>
sl@0: #include <ecom/ecomresolverparams.h>
sl@0: #include "TestUtilities.h"	// For __FILE__LINE__
sl@0: #include "Registrar.h"
sl@0: #include "Discoverer.h"
sl@0: #include "BackupNotifier.h"
sl@0: #include "RegistryData.h"
sl@0: #include "EComUidCodes.h"
sl@0: #include "RegistrarObserver.h"
sl@0: #include "DriveInfo.h"
sl@0: #include "ParseImplementationData.h"
sl@0: #include "EComInternalErrorCodes.h"
sl@0: 	
sl@0: const TInt KMinBuffAllocSize = 1;
sl@0: 
sl@0: 
sl@0: #define UNUSED_VAR(a) a = a
sl@0: 
sl@0: 
sl@0: CRegistrar* CRegistrar::NewL(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
sl@0: 	{
sl@0: 	CRegistrar* self = new(ELeave) CRegistrar(aRegistry,aRegistrarObserver,aFs);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: // Default d'tor
sl@0: 
sl@0: CRegistrar::~CRegistrar()
sl@0: 	{
sl@0: 	delete iBackupNotifier;
sl@0: 	delete iDiscoverer;
sl@0: 	delete iCachedDriveInfo;
sl@0: 	}
sl@0: 
sl@0: // Default c'tor
sl@0: 
sl@0: CRegistrar::CRegistrar(CRegistryData& aRegistry, MRegistrarObserver& aRegistrarObserver, RFs& aFs)
sl@0: : CBase(), iRegistry(aRegistry), iRegistrarObserver(aRegistrarObserver), iFs(aFs), iState(EReg_Undefined)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CRegistrar::ConstructL()
sl@0: 	{
sl@0: 	iCachedDriveInfo = CEComCachedDriveInfo::NewL(iFs);
sl@0: 
sl@0: 	// Instantiate the discoverer
sl@0: 	iDiscoverer = CDiscoverer::NewL(*this, iFs);
sl@0: 	InitialiseEvent();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TInt CRegistrar::Disable(TUid aImplementationUid)
sl@0: 	{
sl@0: 	return iRegistry.SetEnabledState(aImplementationUid, EFalse);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TInt CRegistrar::Enable(TUid aImplementationUid)
sl@0: 	{
sl@0: 	return iRegistry.SetEnabledState(aImplementationUid, ETrue);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TInt CRegistrar::Resume()
sl@0: 	{
sl@0: 	return iDiscoverer->Resume();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TInt CRegistrar::Suspend()
sl@0: 	{
sl@0: 	return iDiscoverer->Suspend();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CRegistrar::DriveRemovedL(TDriveUnit aDrive)
sl@0: 	{
sl@0: 	iRegistry.TemporaryUninstallL(aDrive);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CRegistrar::DriveReinstatedL(TDriveUnit aDrive)
sl@0: 	{
sl@0: 	iRegistry.UndoTemporaryUninstallL(aDrive);
sl@0: 	}
sl@0: 	
sl@0: TBool CRegistrar::IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)const
sl@0: 	{
sl@0: 	return iRegistry.IsAnyDllRegisteredWithDriveL(aDrive);
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::RegisterDiscoveryL(const TDriveName& aDrive,CPluginBase*& aDirEntry, TBool aAnyDllDiscovered)
sl@0: 	{
sl@0: 	TBool found = EFalse;
sl@0: 	TBool update = EFalse;
sl@0: 	TInt  registryDriveIndex = KErrNotFound;
sl@0: 
sl@0: 	// Find the appropriate drive entry
sl@0: 	TChar driveLetter = User::UpperCase(aDrive[0]) - 'A';
sl@0: 	TDriveUnit driveUnit = EDriveA + driveLetter;
sl@0: 	CRegistryData::CDriveData* drive =NULL;
sl@0: 	
sl@0: 	// Get the drive data in the registry.
sl@0: 	registryDriveIndex = iRegistry.FindDriveL(driveUnit, drive);
sl@0: 	if(registryDriveIndex == KErrNotFound)
sl@0: 		{
sl@0: 		User::Leave(KEComErrDriveNotFound);
sl@0: 		}
sl@0: 		
sl@0: 
sl@0: 	// Get the registry to return enough data so that the Add and Update routines
sl@0: 	// can be optimised to avoid rescanning the registry data.
sl@0: 	// This means that registryDriveIndex MUST remain valid until after
sl@0: 	// the ParseRegistrationDataL call below.
sl@0: 	
sl@0: 	// IsRegisteredWithDate will be called if the this drive is NOT
sl@0: 	// under its initial discovery. If any Dll is discovered in the drive, then
sl@0: 	// this drive is NOT in its initial discovery.
sl@0: 	
sl@0: 	// In read-only drive with SPI enable, aAnyDllDiscovered will be always false. 
sl@0: 	// If language downgrade path has been changed, IsRegisteredWithDate will be
sl@0: 	// called to check whether current localised file need to be updated. 
sl@0: 	if((aAnyDllDiscovered) || (iRegistry.HasLanguageChanged()))
sl@0: 		{
sl@0: 		found = iRegistry.IsRegisteredWithDate(aDirEntry->iDllThirdUid, aDirEntry->iDllModifiedTime, update, drive);
sl@0: 		}
sl@0: 	
sl@0: 	if(!found || update || iRegistry.HasLanguageChanged())
sl@0: 		{
sl@0: 		if(found && !update && iRegistry.HasLanguageChanged())
sl@0: 			{
sl@0: 			// If we got here because the language has changed
sl@0: 			// ensure the existing registry data is updated rather than a new entry added
sl@0: 			update = ETrue;
sl@0: 			}
sl@0: 		ParseRegistrationDataL(aDirEntry,driveUnit, update, registryDriveIndex, drive);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CRegistrar::DiscoveriesBegin()
sl@0: 	{
sl@0: 	// We are about to receive registrations so inform the registry that its index
sl@0: 	// is about to be invalid
sl@0: 	iRegistry.DiscoveriesBeginning();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CRegistrar::DiscoveriesComplete(TBool aSuccessful, TPluginProcessingTypeIdentifier aProcessingType)
sl@0: 	{
sl@0: 	
sl@0: 	TBool doesRegChanged = EFalse;
sl@0: 
sl@0: 	// Successfully completed, if registry data has been changed, update 
sl@0: 	TRAPD(error,iRegistry.DiscoveriesCompleteL(aSuccessful, aProcessingType,doesRegChanged));
sl@0:     UNUSED_VAR(error);
sl@0: 	// Notify if the registry data has been changed.
sl@0: 	if(doesRegChanged)
sl@0: 		{
sl@0: 	// Notify that we have updated the registry
sl@0: 		iRegistrarObserver.Notification(KErrNone);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::SetDiscoveryFlagL(const TDriveUnit& aDriveUnit)
sl@0: 	{
sl@0: 	//set the drive flag to indicate it has changes.
sl@0: 	iRegistry.SetDiscoveryFlagL(aDriveUnit);
sl@0: 	}
sl@0: 	
sl@0: TBool CRegistrar::NotifiedWithErrorCode(TInt aError)
sl@0: 	{
sl@0: 	// Test the safe error codes
sl@0: 	return (aError == KErrNotReady ||		// Drive removed?
sl@0: 			aError == KErrPathNotFound);	// Directory deleted?
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::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: 	// Ok we intend installing this item so 
sl@0: 	// create the Interface Implementation Collection entry first
sl@0: 	CRegistryData::CDllData* dll = CRegistryData::CDllData::NewLC(*(aEntry->iDllName),aEntry->iDllModifiedTime,aEntry->iDllSecondUid,aEntry->iDllThirdUid,aDriveData);
sl@0: 
sl@0: #ifdef ECOM_TRACE
sl@0: 	static int counter = 0; counter++;
sl@0: 	TFileName fullFileName(aDrive.Name());
sl@0: 	fullFileName.Append(_L("\\sys\\bin\\"));
sl@0: 	fullFileName.Append(*(aEntry->iDllName));
sl@0: 	__ECOM_TRACE2("ECOM: Plugin discovered (%04d) %S", counter, &fullFileName);
sl@0: #endif
sl@0: 
sl@0: 	// update resource ext info
sl@0: 	HBufC* resourceExt = aEntry->RscFileExt();
sl@0: 	if(resourceExt)
sl@0: 		dll->SetResourceExtL(*resourceExt);
sl@0: 	
sl@0: 	// Don't automatically leave during the parse of the implementation
sl@0: 	// collection's registration data.
sl@0: 	// If we did then there would be a cascade of leaves which stop the 
sl@0: 	// entire registration process for all discoveries remaining on the list.
sl@0: 	// Check to see if there is a problem specifically with the registration data
sl@0: 	// OR if its a general problem. In the latter case leave.
sl@0: 	TInt error=KErrNone;
sl@0: 			
sl@0: 	TRAP(error, ParseL(aEntry,*dll));
sl@0: 	if (error==KErrNoMemory)
sl@0: 		User::LeaveNoMemory();
sl@0: 	if(error == KErrNone)
sl@0: 		{
sl@0: 		if(aUpdate)
sl@0: 			{	
sl@0: 			iRegistry.UpdateDllDataL(aDrive, aRegistryDriveIndex, dll);
sl@0: 			}
sl@0: 		else
sl@0: 			{	
sl@0: 			iRegistry.AddDllDataL(aDrive, aRegistryDriveIndex, dll);
sl@0: 			}
sl@0: 		// Remove dll from CleanupStack as ownership has been passed in one of
sl@0: 		// the two functions above
sl@0: 		CleanupStack::Pop(dll);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// This interface implementation collection 
sl@0: 		// cannot be registered correctly.
sl@0: 		CleanupStack::PopAndDestroy(dll);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::GetResourceFormatVersionL(RResourceReader& aReader, TInt& aResourceFormatVersion)
sl@0: 	{
sl@0: 	aResourceFormatVersion = 1;
sl@0: 	TUid dllUid(KNullUid);
sl@0: 	TUid uid = {aReader.ReadInt32L()};
sl@0: 	if(uid==KUidEComResourceFormatV2)
sl@0: 		{
sl@0: 		aResourceFormatVersion = 2;
sl@0: 		dllUid.iUid = aReader.ReadInt32L();
sl@0: 		}
sl@0: 	else if(uid==KUidEComResourceFormatV3)
sl@0: 		{
sl@0: 		aResourceFormatVersion = 3;
sl@0: 		dllUid.iUid = aReader.ReadInt32L();
sl@0: 		}		
sl@0: 	else
sl@0: 		dllUid = uid;
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: void CRegistrar::ParseL(CPluginBase*& aEntry,CRegistryData::CDllData& aDll)
sl@0: 	{
sl@0: // Read the resource file starting at offset:0 section size:0
sl@0: 	CResourceFile* regFile =aEntry->RscFile();
sl@0: //	Note : There may be an issue here with resource reading when the 
sl@0: //  file is not in the ROM. The solution would be to call
sl@0: //	regFile.ConfirmSignatureL(regFile.SignatureL());
sl@0: //	However for 6.2 interface implementation collections will ALL
sl@0: //	be within the ROM. and future development will move to an
sl@0: //	XML parsed solution @ build time.
sl@0: //	IF this situation changes, place the fix here.
sl@0:  	RResourceReader theReader;
sl@0:  	theReader.OpenLC(regFile, KMinBuffAllocSize);
sl@0: 	TInt resourceFormatVersion = 0;
sl@0: 	GetResourceFormatVersionL(theReader,resourceFormatVersion);
sl@0: 	
sl@0: 	TDriveUnit drive(aDll.iParent->iDrive);
sl@0: 	TBool romBased = iCachedDriveInfo->DriveIsReadOnlyInternalL(drive);
sl@0: 	const TInt numInterfaces = theReader.ReadInt16L();
sl@0: 	if (resourceFormatVersion == 3 && numInterfaces > KMaxInterfacesInResV3)
sl@0: 		{
sl@0: 		User::Leave(KErrNotSupported);
sl@0: 		}
sl@0: 	for(TInt iface = 0; iface < numInterfaces; ++iface)
sl@0: 		{
sl@0: 		// Read the interface uid
sl@0: 		const TUid interfaceUid = {theReader.ReadInt32L()};
sl@0: 		CRegistryData::CInterfaceData* interfaceList = CRegistryData::CInterfaceData::NewLC(interfaceUid,&aDll);
sl@0: 		aDll.AddL(interfaceList);
sl@0: 		CleanupStack::Pop(interfaceList);		// Now owned by aDll
sl@0: 		const TInt numImplementations = theReader.ReadInt16L();
sl@0: 		if (resourceFormatVersion == 3 && numImplementations > KMaxImplementationsForEachInterfacesInResV3)
sl@0: 			{
sl@0: 			User::Leave(KErrNotSupported);
sl@0: 			}
sl@0: 		for(TInt index = 0; index < numImplementations; ++index)
sl@0: 			{
sl@0: 			TUid implementationUid;
sl@0: 			TInt versionNo;
sl@0: 			TInt infoFormat;
sl@0: 			TBool romOnly;
sl@0: 			RExtendedInterfacesArray* extendedInterfaces = NULL;
sl@0: 			HBufC* name = NULL;
sl@0: 			HBufC8* defaultData = NULL;
sl@0: 			HBufC8* opaqueData = NULL;
sl@0: 			CParseImplementationData* parseImplementationData = CParseImplementationData::NewLC(resourceFormatVersion);
sl@0: 			parseImplementationData->ParseL(theReader,
sl@0: 											infoFormat,
sl@0: 											implementationUid,
sl@0: 											versionNo,
sl@0: 									   	  	name,
sl@0: 									      	defaultData,
sl@0: 									      	opaqueData,
sl@0: 									      	extendedInterfaces,
sl@0: 									      	romOnly);
sl@0: 			CleanupStack::PopAndDestroy(parseImplementationData);									      	
sl@0: 			
sl@0: 			CleanupStack::PushL(TCleanupItem(CloseAndDeleteArray, extendedInterfaces));
sl@0: 			CleanupStack::PushL(name);
sl@0: 			CleanupStack::PushL(defaultData);
sl@0: 			CleanupStack::PushL(opaqueData);
sl@0: 			if (romOnly && !(romBased))
sl@0: 				{
sl@0: 				// pop and destroy opaquedata, defaultdata,name and extendedInterfaces
sl@0: 				CleanupStack::PopAndDestroy(4,extendedInterfaces); 
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				CRegistryData::CImplementationData* implData = CRegistryData::CImplementationData::NewL(interfaceList,
sl@0: 																										implementationUid, 
sl@0: 																				 						versionNo, 
sl@0: 																				 						name, 
sl@0: 																						 				defaultData,
sl@0: 																										opaqueData,
sl@0: 																					 					drive,
sl@0: 																					 					romOnly,
sl@0: 																				 						romBased,
sl@0: 																				 						extendedInterfaces);
sl@0: 				CleanupStack::Pop(4,extendedInterfaces); // opaqueData,defaultData,name,extendedInterfaces owned by implData
sl@0: 				CleanupStack::PushL(implData);
sl@0: 				interfaceList->AddL(implData);	// Now owned by interfaceList	
sl@0: 				CleanupStack::Pop(implData);
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(&theReader);		
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: CRegistrar::TRegistrarState CRegistrar::State()const
sl@0: 	{
sl@0: 	return iState;
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::ProcessSSAEventL(TStartupStateIdentifier aKnownState)
sl@0: 	{
sl@0: 	iDiscoverer->ProcessSSAEventL(aKnownState); 
sl@0: 	if(aKnownState == EStartupStateNonCritical && iState == EReg_StartupInProgess)
sl@0: 		{
sl@0: 		__ECOM_TRACE("ECOM: CRegistrar::ProcessSSAEventL(): EStartupStateNonCritical is reached.");
sl@0: 
sl@0: 		iState = EReg_StartupComplete;
sl@0: 		iBackupNotifier = CBackupNotifier::NewL(*this);
sl@0: 		}
sl@0: 	}
sl@0: void CRegistrar::InitialiseEvent()
sl@0: 	{
sl@0: 	iState = EReg_StartupInProgess;
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::LanguageChangedL(TBool& aLanguageChanged)
sl@0: 	{
sl@0: 	iRegistry.LanguageChangedL(aLanguageChanged);
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::InstallSwiEventCallBack(const TCallBackWithArg& aCallBack)
sl@0: 	{
sl@0: 	iDiscoverer->SetSwiChangeCallBack(aCallBack);
sl@0: 	}
sl@0: 
sl@0: void CRegistrar::InstallBurEventCallBack(const TCallBackWithArg& aCallBack)
sl@0: 	{
sl@0: 	iDiscoverer->SetBurChangeCallBack(aCallBack);
sl@0: 	}