1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/Discoverer.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,1007 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Contains the implementation of the CDiscoverer class.
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @file
1.23 + @internalComponent
1.24 +*/
1.25 +
1.26 +#include <e32uid.h>
1.27 +#include <startup.hrh> // for EStartupStateNonCritical and EStartupStateCritical
1.28 +#include <bacntf.h>
1.29 +
1.30 +#include <sacls.h>
1.31 +
1.32 +#include "EComDebug.h"
1.33 +#include "TestUtilities.h" // For __FILE__LINE__
1.34 +#include "Discoverer.h"
1.35 +#include "DiscovererObserver.h"
1.36 +#include "EComUidCodes.h"
1.37 +#include "baspi.h"
1.38 +#include "bautils.h"
1.39 +#include "DriveInfo.h"
1.40 +#include <ecom/ecomerrorcodes.h>
1.41 +#include <saclscommon.h>
1.42 +
1.43 +
1.44 +#define UNUSED_VAR(a) a = a
1.45 +
1.46 +
1.47 +/** Interface Implementation Collection resource file search path */
1.48 +_LIT(KEComResourceFileSearch, "\\resource\\plugins\\*");
1.49 +
1.50 +_LIT(KEComResourceFilePathAny, "\\resource\\plugins\\");
1.51 +_LIT(KEComResourceFolderPath, "?:\\resource\\plugins\\");
1.52 +
1.53 +// Relative to the Drive with a fixed path
1.54 +_LIT(KEComSPIFilePath, "\\private\\10009D8F\\");
1.55 +
1.56 +/**
1.57 + Begin directory scanning after a delay of 1 Second
1.58 + Allowing multiple directory changes to be applied before
1.59 + beginning a scan.
1.60 + */
1.61 +static const TInt32 KEComDefaultBeginScanPeriod = 1000000;
1.62 +
1.63 +// __________________________________________________________________________
1.64 +//
1.65 +CDiscoverer::CSwiChangeNotifier* CDiscoverer::CSwiChangeNotifier::NewL(CDiscoverer& aDiscoverer)
1.66 + {
1.67 + CSwiChangeNotifier* self = new(ELeave) CSwiChangeNotifier(aDiscoverer);
1.68 + CleanupStack::PushL(self);
1.69 + self->ConstructL();
1.70 + CleanupStack::Pop(self);
1.71 + return self;
1.72 + }
1.73 +
1.74 +CDiscoverer::CSwiChangeNotifier::CSwiChangeNotifier(CDiscoverer& aDiscoverer)
1.75 +: CActive(CActive::EPriorityHigh), iDiscoverer(aDiscoverer)
1.76 + {
1.77 + // Safe because it cannot fail
1.78 + CActiveScheduler::Add(this);
1.79 + }
1.80 +
1.81 +void CDiscoverer::CSwiChangeNotifier::ConstructL()
1.82 + {
1.83 + // Attach to SWI property
1.84 + User::LeaveIfError(
1.85 + iProperty.Attach(KUidSystemCategory, KSAUidSoftwareInstallKeyValue));
1.86 + }
1.87 +
1.88 +CDiscoverer::CSwiChangeNotifier::~CSwiChangeNotifier()
1.89 + {
1.90 + Cancel();
1.91 + iProperty.Close();
1.92 + }
1.93 +
1.94 +void CDiscoverer::CSwiChangeNotifier::DoCancel()
1.95 + {
1.96 + iProperty.Cancel(); // Cancel SWI change notifications
1.97 + }
1.98 +
1.99 +void CDiscoverer::CSwiChangeNotifier::Subscribe()
1.100 + {
1.101 + if(!IsActive())
1.102 + {
1.103 + iProperty.Subscribe(iStatus);
1.104 + SetActive();
1.105 + }
1.106 + }
1.107 +
1.108 +void CDiscoverer::CSwiChangeNotifier::RunL()
1.109 + {
1.110 + Subscribe();
1.111 +
1.112 + TInt swiProperty;
1.113 + User::LeaveIfError(
1.114 + iProperty.Get(KUidSystemCategory, KSAUidSoftwareInstallKeyValue, swiProperty));
1.115 +
1.116 + // Do a discovery each time an install, uninstall or restore is completed.
1.117 + iDiscoverer.SwiChangeNotificationL(swiProperty);
1.118 + }
1.119 +
1.120 +TInt CDiscoverer::CSwiChangeNotifier::RunError(TInt /*aError*/)
1.121 + {
1.122 + //If unable to read the SWI P&S variable set the
1.123 + //discoverers SWI state to ESASwiNone as this will return
1.124 + //EComs back to its default behaviour
1.125 + TRAP_IGNORE(iDiscoverer.SwiChangeNotificationL(ESASwisNone));
1.126 + return KErrNone; //avoid CActiveScheduler panic
1.127 + }
1.128 +
1.129 +// __________________________________________________________________________
1.130 +//
1.131 +/*
1.132 + The notification object which watches the Interface Implementation
1.133 + Collection directories for any changes on specific drive.
1.134 + When its RunL method is called, it notifies its owning CDiscoverer class
1.135 + object to re-scan of the Interface Implementation Collection directories.
1.136 +*/
1.137 +CDiscoverer::CDirChangeNotifier::CDirChangeNotifier(CDiscoverer& aDiscoverer, RFs& aFs, const TDriveUnit& aDriveUnit)
1.138 +: CActive(CActive::EPriorityHigh), iDiscoverer(aDiscoverer), iFs(aFs),iDriveUnit(aDriveUnit)
1.139 + {
1.140 +
1.141 + iNotificationFilePath.Append(iDriveUnit.Name());
1.142 + iNotificationFilePath.Append(KEComResourceFilePathAny);
1.143 + // Safe because it cannot fail
1.144 + CActiveScheduler::Add(this);
1.145 + }
1.146 +
1.147 +CDiscoverer::CDirChangeNotifier::~CDirChangeNotifier()
1.148 + {
1.149 + Cancel();
1.150 + }
1.151 +
1.152 +void CDiscoverer::CDirChangeNotifier::DoCancel()
1.153 + {
1.154 + iFs.NotifyChangeCancel(iStatus); // Cancel change notifications
1.155 + }
1.156 +
1.157 +void CDiscoverer::CDirChangeNotifier::Activate()
1.158 + {
1.159 + if(!IsActive())
1.160 + {
1.161 + iStatus = KRequestPending;
1.162 + SetActive();
1.163 + iFs.NotifyChange(ENotifyEntry, iStatus, iNotificationFilePath);
1.164 + }
1.165 + }
1.166 +
1.167 +void CDiscoverer::CDirChangeNotifier::RunL()
1.168 + {
1.169 + RECORD_START_NOTIFIER_RUNL_TIMER_RESULT(iDriveUnit)
1.170 + // Signal the notification
1.171 + // If iStatus.Int() is not KErrNone
1.172 + // then reactivation will not occur
1.173 + if(iDiscoverer.NotificationL(iStatus.Int(), iDriveUnit))
1.174 + Activate();
1.175 + RECORD_END_NOTIFIER_RUNL_TIMER_RESULT(iDriveUnit)
1.176 + }
1.177 +
1.178 +TInt CDiscoverer::CDirChangeNotifier::RunError(TInt aError)
1.179 + {
1.180 + // Entered most likely because of an error condition during file system
1.181 + // rescanning and plugin registration that could not be handled locally.
1.182 + // As indexes in the registry are updated after each registration and the
1.183 + // tree of registrations is updated at the end for some scan use-cases there
1.184 + // is a chance that the registration tree and the indexes can get out of
1.185 + // sync when a leave occurs.
1.186 + // The code is not present to handle a recovery so the best policy
1.187 + // is to panic the server and have it restart on next use.
1.188 + // We can't trap leaves in RunL() and continue as we can not be sure the
1.189 + // registry is in sync. The registry and discovery code would need to be
1.190 + // totally reviewed and reworked if panic's were not acceptable. So far they
1.191 + // have allowed error conditions found in the field to be reported as
1.192 + // incidents allowing us to idenitify and resovle the underlying causes.
1.193 + __ECOM_LOG1("ECOM: PANIC in CDiscoverer::CDirChangeNotifier::RunError(), error= %d", aError);
1.194 + User::Panic(KEComServerPanicCategory, EEComPanic_CDiscoverer_CDirChangeNotifier_RunError);
1.195 + return KErrNone; // dummy return to stop warnings on missing return
1.196 + }
1.197 +
1.198 +// __________________________________________________________________________
1.199 +//
1.200 +/*
1.201 + The timer Active object for providing plugin directory scanning on rediscovery events.
1.202 + The processing of notification will be performed only on drive(s) that has notification event(s)
1.203 + triggered on it.
1.204 + It uses data member iPendingDriveList to hold all pending drive nums, and executes only once.
1.205 + It is activated by the CDirChangeNotifier's notification call.
1.206 + The default priority is idle time execution only.
1.207 +*/
1.208 +CDiscoverer::CIdleScanningTimer* CDiscoverer::CIdleScanningTimer::NewL(CDiscoverer& aDiscoverer)
1.209 + {
1.210 + CIdleScanningTimer* self = new(ELeave) CIdleScanningTimer(aDiscoverer);
1.211 + CleanupStack::PushL(self);
1.212 + self->ConstructL();
1.213 + CleanupStack::Pop(self);
1.214 + return self;
1.215 + }
1.216 +CDiscoverer::CIdleScanningTimer::CIdleScanningTimer(CDiscoverer& aDiscoverer)
1.217 +: CTimer(CActive::EPriorityIdle), iDiscoverer(aDiscoverer), iPendingDriveList(2)
1.218 + {
1.219 + // Safe because it cannot fail
1.220 + CActiveScheduler::Add(this);
1.221 + }
1.222 +
1.223 +void CDiscoverer::CIdleScanningTimer::ConstructL()
1.224 + {
1.225 + CTimer::ConstructL();
1.226 + }
1.227 +
1.228 +CDiscoverer::CIdleScanningTimer::~CIdleScanningTimer()
1.229 + {
1.230 + Cancel();
1.231 + iPendingDriveList.Close();
1.232 + }
1.233 +
1.234 +void CDiscoverer::CIdleScanningTimer::DoCancel()
1.235 + {
1.236 + // Call the base class to ensure the timer is cancelled
1.237 + CTimer::DoCancel();
1.238 +
1.239 + iDiscoverer.ScanDirectoryCancel();
1.240 + }
1.241 +
1.242 +void CDiscoverer::CIdleScanningTimer::RunL()
1.243 +// When the object activates on a specfic drive, this is method is called
1.244 +// and delegates to the CDiscoverer to scan the Interface Implementation
1.245 +// Collection directories
1.246 +//
1.247 + {
1.248 + // Only carry out a rediscovery if SWI is not in progress
1.249 + if(!iDiscoverer.SwiOperationInProgress())
1.250 + {
1.251 + RECORD_START_TIMER_RUNL_TIMER_RESULT
1.252 + // Do scan on all pending drives stored in iPendingDriveList array
1.253 + TInt length = iPendingDriveList.Count();
1.254 + for(TInt count = 0; count < length; ++count)
1.255 + {
1.256 + iDiscoverer.RediscoveryScanDirectoryL(TDriveUnit(iPendingDriveList[count]));
1.257 + }
1.258 +
1.259 + // Signal the observer that the scans have been completed successfully.
1.260 + iDiscoverer.iDiscovererObserver.DiscoveriesComplete(ETrue, EPluginProcessingTypeAll);
1.261 + // Reset pending drive list when finishes scan.
1.262 + iPendingDriveList.Reset();
1.263 + // Reset the state of discoverer as all notifications processed.
1.264 + iDiscoverer.CompleteNotificationProcessing();
1.265 + RECORD_END_TIMER_RUNL_TIMER_RESULT
1.266 + }
1.267 + }
1.268 +
1.269 +TInt CDiscoverer::CIdleScanningTimer::RunError(TInt aError)
1.270 + {
1.271 + // Entered most likely because of an error condition during file system
1.272 + // rescanning and plugin registration that could not be handled locally.
1.273 + // As indexes in the registry are updated after each registration and the
1.274 + // tree of registrations is updated at the end for some scan use-cases there
1.275 + // is a chance that the registration tree and the indexes can get out of
1.276 + // sync when a leave occurs.
1.277 + // The code is not present to handle a recovery so the best policy
1.278 + // is to panic the server and have it restart on next use.
1.279 + // We can't trap leaves in RunL() and continue as we can not be sure the
1.280 + // registry is in sync. The registry and discovery code would need to be
1.281 + // totally reviewed and reworked if panic's were not acceptable. So far they
1.282 + // have allowed error conditions found in the field to be reported as
1.283 + // incidents allowing us to idenitify and resovle the underlying causes.
1.284 + __ECOM_LOG1("ECOM: PANIC in CDiscoverer::CIdleScanningTimer::RunError(), error = %d", aError);
1.285 + User::Panic(KEComServerPanicCategory, EEComPanic_CDiscoverer_CIdleScanningTimer_RunError);
1.286 + return KErrNone; // dummy return to stop warnings on mising return
1.287 + }
1.288 +
1.289 +void CDiscoverer::CIdleScanningTimer::RestartScanPeriod()
1.290 + {
1.291 + if (!iSuspended)
1.292 + {
1.293 + Cancel();
1.294 + After(KEComDefaultBeginScanPeriod);
1.295 + }
1.296 + }
1.297 +
1.298 +void CDiscoverer::CIdleScanningTimer::Suspend()
1.299 + {
1.300 + Cancel();
1.301 + iSuspended = ETrue;
1.302 + }
1.303 +
1.304 +void CDiscoverer::CIdleScanningTimer::Resume()
1.305 + {
1.306 + iSuspended = EFalse;
1.307 + if(IsAnyNotificationProcessingPending())
1.308 + {
1.309 + RestartScanPeriod();
1.310 + }
1.311 + }
1.312 +// __________________________________________________________________________
1.313 +//
1.314 +/*
1.315 + CDirScanner implements incremental scanning of the Interface Implementation
1.316 + Collection directory
1.317 + on behalf of the CDiscoverer.
1.318 + It's methods are called in response to the timer task execution,
1.319 + thereby requiring the incremental scheduling.
1.320 +*/
1.321 +CDiscoverer::CDirScanner* CDiscoverer::CDirScanner::NewL(CDiscoverer& aDiscoverer, RFs& aFs)
1.322 + {
1.323 + CDirScanner* self = new(ELeave)CDirScanner(aDiscoverer,aFs);
1.324 + CleanupStack::PushL(self);
1.325 + self->ConstructL();
1.326 + CleanupStack::Pop(self);
1.327 + return self;
1.328 + }
1.329 +
1.330 +void CDiscoverer::CDirScanner::ConstructL()
1.331 + {
1.332 + }
1.333 +
1.334 +CDiscoverer::CDirScanner::CDirScanner(CDiscoverer& aDiscoverer, RFs& aFs)
1.335 +: CBase(), iDiscoverer(aDiscoverer), iFs(aFs)
1.336 + {
1.337 + }
1.338 +
1.339 +CDiscoverer::CDirScanner::~CDirScanner()
1.340 +// D'tor
1.341 + {
1.342 + }
1.343 +
1.344 +
1.345 +void CDiscoverer::CDirScanner::ScanDriveL(const TDriveUnit& aDrive, TBool aIsRO)
1.346 + {
1.347 + RECORD_START_REDISCOVERYSCANDIRECTORY_RESULT(aDrive)
1.348 + TDriveName driveName(aDrive.Name());
1.349 + TBool scanDirectoryForPlugins = ETrue;
1.350 + TBool found = EFalse;
1.351 +
1.352 +
1.353 + // If RO then attempt to discover plugins from SPI file
1.354 + if(aIsRO)
1.355 + {
1.356 + TFileName spiFilePath;
1.357 + spiFilePath.Append(driveName);
1.358 + spiFilePath.Append(KEComSPIFilePath);
1.359 +
1.360 + TEntry entry;
1.361 + //check if the path exists
1.362 + if (iFs.Entry(spiFilePath,entry)==KErrNone)
1.363 + {
1.364 + TParse spiPath;
1.365 + spiPath.Set(spiFilePath, NULL, NULL);
1.366 + // Discover plugins from SPI
1.367 + found = DoScanSpiFileL(spiPath);
1.368 + }
1.369 + scanDirectoryForPlugins = !found;
1.370 + }
1.371 +
1.372 + // scan directory for plugins if not already discovered from SPI file. SPI applies to RO.
1.373 + if(scanDirectoryForPlugins)
1.374 + {
1.375 +
1.376 + // Find plugins via resoure files
1.377 + TUidType rscUidType(KNullUid,KUidInterfaceImplementationCollectionInfo,KNullUid);
1.378 + TBool foundRsc = DoScanDriveL(aDrive, rscUidType, aIsRO);
1.379 + found = found || foundRsc;
1.380 + }
1.381 +
1.382 + if (!found)
1.383 + {
1.384 + iDiscoverer.DriveUnmountedL(aDrive);
1.385 + }
1.386 + RECORD_END_REDISCOVERYSCANDIRECTORY_RESULT(aDrive)
1.387 + }
1.388 +
1.389 +TBool CDiscoverer::CDirScanner::DoScanSpiFileL(const TParse& aSpiPath)
1.390 +{
1.391 + iDiscoverer.DriveMountedL(aSpiPath.Drive());
1.392 +
1.393 + RResourceArchive resourceArchive;
1.394 + //ECom server should continue if OpenL leaves because no spi exists
1.395 + TRAPD(err,resourceArchive.OpenL(iFs, aSpiPath.DriveAndPath(),_L("ecom")));
1.396 + if(err==KErrNotFound || err==KErrPathNotFound)
1.397 + return EFalse;
1.398 + User::LeaveIfError(err);
1.399 + CleanupClosePushL(resourceArchive);
1.400 + // check SPI file type. On failure do not scan archives
1.401 + if(resourceArchive.Type() != KEcomSpiFileTypeUid)
1.402 + {
1.403 + CleanupStack::PopAndDestroy(&resourceArchive);
1.404 + return EFalse;
1.405 + }
1.406 +
1.407 + CPluginBase* entryBase=NULL;
1.408 + TBool resourceExistsIndicator = EFalse;
1.409 + while(!resourceArchive.End())
1.410 + {
1.411 + TRAPD(error,iDiscoverer.ValidateEntryL(resourceArchive,entryBase));
1.412 + CleanupStack::PushL(entryBase);
1.413 + if (error==KErrNoMemory)
1.414 + User::LeaveNoMemory();
1.415 + if (error==KErrNone)
1.416 + {
1.417 + // When SPI is on no DAT file exists,and also RO Internal drive is not rediscovered.
1.418 + //Therefore this RO Internal drive is always at its initial discovery. No Dll
1.419 + // is ever discovered before. Always pass EFalse to ProcessEntryL method.
1.420 + iDiscoverer.ProcessEntryL(aSpiPath.Drive(),entryBase, EFalse);
1.421 + // set to indicate at least 1 resource exists
1.422 + resourceExistsIndicator = ETrue;
1.423 + }
1.424 + else
1.425 + {
1.426 + __ECOM_TRACE1("ECOM: CDiscoverer::DoScanSpiFileL(). Fail Validate: %S\n.",&aSpiPath.FullName());
1.427 + }
1.428 + CleanupStack::PopAndDestroy(entryBase);
1.429 + entryBase=NULL;
1.430 + }
1.431 + CleanupStack::PopAndDestroy(&resourceArchive);
1.432 + return resourceExistsIndicator;
1.433 +}
1.434 +
1.435 +TBool CDiscoverer::CDirScanner::DoScanDriveL(const TDriveUnit& aDrive, const TUidType& aUidType, TBool aIsRO)
1.436 + {
1.437 + RDir dir;
1.438 +
1.439 + TDriveName driveName(aDrive.Name());
1.440 + TParse searchDir;
1.441 + User::LeaveIfError(searchDir.Set(KEComResourceFileSearch,NULL,&driveName));
1.442 +
1.443 + // Match the directory list UID's to a Polymorphic DLL UID and Interface
1.444 + // Implementation Collection UID.
1.445 + // Resource files are sorted by UID. However, since these files have same UID,
1.446 + // they are actually sorted by their names (alphanumerically).
1.447 +
1.448 + TInt error = dir.Open(iFs, searchDir.FullName(), aUidType);
1.449 +
1.450 + if(error == KErrNone)
1.451 + {
1.452 + // Have found the plugin directory
1.453 + CleanupClosePushL(dir);
1.454 +
1.455 + TFileName* lastRscNameBuf = new TFileName;
1.456 +
1.457 + if (!lastRscNameBuf)
1.458 + {
1.459 + CleanupStack::PopAndDestroy(&dir);
1.460 + return EFalse;
1.461 + }
1.462 + CleanupStack::PushL(lastRscNameBuf);
1.463 +
1.464 + TEntryArray *dirEntriesArray = new TEntryArray;
1.465 +
1.466 + if (!dirEntriesArray)
1.467 + {
1.468 + CleanupStack::PopAndDestroy(lastRscNameBuf);
1.469 + CleanupStack::PopAndDestroy(&dir);
1.470 + return EFalse;
1.471 + }
1.472 + CleanupStack::PushL(dirEntriesArray);
1.473 +
1.474 +
1.475 + TPtrC lastRscName(KNullDesC);
1.476 +
1.477 + // Iterate through the directory reading multiple entries at a
1.478 + // time
1.479 + TInt count = 0;
1.480 + TInt readError = KErrNone;
1.481 + CPluginBase* entryBase=NULL;
1.482 +
1.483 + iDiscoverer.DriveMountedL(aDrive);
1.484 + TBool anyDllRegistered = iDiscoverer.IsAnyDllRegisteredWithDriveL(aDrive);
1.485 +
1.486 +
1.487 +
1.488 + while (readError != KErrEof)
1.489 + {
1.490 +
1.491 + // Read the next set of entries
1.492 + readError = dir.Read(*dirEntriesArray);
1.493 +
1.494 + if ((readError != KErrNone) && (readError != KErrEof))
1.495 + {
1.496 + User::Leave(readError);
1.497 + }
1.498 + else
1.499 + {
1.500 + // for KErrEof, dirEntriesArray still has items to process
1.501 + count = dirEntriesArray->Count();
1.502 + // Ok use the entries to populate the file list
1.503 + for(TInt i = 0; i < count; ++i)
1.504 + {
1.505 +
1.506 + // Compare current file name against previous one ignoring extension. If it is same
1.507 + // then there is no need to process it.
1.508 + TPtrC currName = (*dirEntriesArray)[i].iName.Left((*dirEntriesArray)[i].iName.Length()-KExtensionLength);
1.509 + if (lastRscName.Compare(currName) == 0)
1.510 + {
1.511 + continue;
1.512 + }
1.513 + else if (i < (count - 1))
1.514 + {
1.515 + lastRscName.Set(currName);
1.516 + }
1.517 + else
1.518 + {
1.519 + lastRscNameBuf->Copy(currName);
1.520 + lastRscName.Set(*lastRscNameBuf);
1.521 + }
1.522 +
1.523 +
1.524 + // Obtain a copy of the current directory entry
1.525 + TRAP(error,iDiscoverer.ValidateEntryL((*dirEntriesArray)[i], driveName, entryBase, aIsRO));
1.526 + CleanupStack::PushL(entryBase);
1.527 +
1.528 + if (error==KErrNoMemory)
1.529 + User::LeaveNoMemory();
1.530 +
1.531 + if (error==KErrNone)
1.532 + {
1.533 + iDiscoverer.ProcessEntryL(driveName,entryBase,anyDllRegistered);
1.534 + }
1.535 + else
1.536 + {
1.537 + __ECOM_TRACE1("ECOM: CDiscoverer::DoScanDriveL(). Fail Validate entry: %S\n.",&(*dirEntriesArray)[i].iName);
1.538 + }
1.539 + CleanupStack::PopAndDestroy(entryBase);
1.540 + entryBase=NULL;
1.541 + }
1.542 + }
1.543 + }
1.544 + CleanupStack::PopAndDestroy(dirEntriesArray);
1.545 + CleanupStack::PopAndDestroy(lastRscNameBuf);
1.546 + CleanupStack::PopAndDestroy(&dir);
1.547 + return ETrue;
1.548 + }
1.549 +
1.550 + return EFalse;
1.551 + }
1.552 +
1.553 +void CDiscoverer::CDirScanner::DiscoverPluginsL(TBool aDiscoverReadOnlyDrives)
1.554 + {
1.555 + // iterator which returns only the drives need to be scanned.
1.556 + TEComCachedDriveInfoIterator iter(*iDiscoverer.iCachedDriveInfo);
1.557 +
1.558 + // Iterate from highest drive letter (Z:) towards lowest drive letter (A:).
1.559 + for (iter.Last(); iter.InRange(); iter.Prev())
1.560 + {
1.561 + if (iter.DriveIsReadOnlyInternal() == aDiscoverReadOnlyDrives)
1.562 + {
1.563 + ScanDriveL(iter.DriveUnit(), aDiscoverReadOnlyDrives);
1.564 + }
1.565 + }
1.566 + }
1.567 +
1.568 +
1.569 +// __________________________________________________________________________
1.570 +//
1.571 +/*
1.572 + Responsible for identifying new Interface Implementation Collections,
1.573 + installed in the Interface Implementation Collection directories.
1.574 +*/
1.575 +
1.576 +CDiscoverer* CDiscoverer::NewL(MDiscovererObserver& aDiscovererObserver, RFs& aFs)
1.577 + {
1.578 + CDiscoverer* self = new(ELeave) CDiscoverer(aDiscovererObserver, aFs);
1.579 + CleanupStack::PushL(self);
1.580 + self->ConstructL();
1.581 + CleanupStack::Pop(self);
1.582 + return self;
1.583 + }
1.584 +
1.585 +// Default d'tor
1.586 +
1.587 +CDiscoverer::~CDiscoverer()
1.588 + {
1.589 + // Cancel any scanning behaviour or notifications
1.590 + if(iDirScanner != NULL)
1.591 + {
1.592 + // Left in the middle of a scan
1.593 + // So clear up
1.594 + delete iDirScanner;
1.595 + iDirScanner = NULL;
1.596 + // Signal the observer that the scan has
1.597 + // not been completed successfully.
1.598 + iDiscovererObserver.DiscoveriesComplete(EFalse, EPluginProcessingTypeAll);
1.599 + }
1.600 + Suspend();
1.601 + iDrivesDiscovered.Reset();
1.602 + delete iSwiChangeNotifier;
1.603 + delete iScanningTimer;
1.604 + delete iLanguageChangeNotifier;
1.605 + delete iCachedDriveInfo;
1.606 + iRscDirNotifierList.ResetAndDestroy();
1.607 +
1.608 + }
1.609 +
1.610 +// Default c'tor
1.611 +CDiscoverer::CDiscoverer(MDiscovererObserver& aDiscovererObserver, RFs& aFs)
1.612 +: CBase(), iSwiChangeDiscoveryPending(EFalse), iLanguageChangeDiscoveryPending(EFalse),
1.613 + iState(EDisc_Undefined), iDiscovererObserver(aDiscovererObserver), iFs(aFs)
1.614 + {
1.615 + // Do nothing here
1.616 + }
1.617 +
1.618 +void CDiscoverer::ConstructL()
1.619 + {
1.620 + iCachedDriveInfo = CEComCachedDriveInfo::NewL(iFs);
1.621 +
1.622 + // Construct the Interface Implementation Collection
1.623 + // directory change notifier list
1.624 + // and the scan step control object.
1.625 +
1.626 + CDirChangeNotifier *dirChangeNotifierPtr;
1.627 +
1.628 + // iterator which returns only the drives need to be scanned.
1.629 + TEComCachedDriveInfoIterator iter(*iCachedDriveInfo);
1.630 +
1.631 + for (iter.First(); iter.InRange(); iter.Next())
1.632 + {
1.633 + //Don't need to monitor read-only drives. They don't change.
1.634 + if ( !iter.DriveIsReadOnlyInternal() )
1.635 + {
1.636 + dirChangeNotifierPtr = new(ELeave)CDirChangeNotifier(*this,iFs,iter.DriveUnit());
1.637 +
1.638 + CleanupStack::PushL(dirChangeNotifierPtr);
1.639 + iRscDirNotifierList.AppendL(dirChangeNotifierPtr);
1.640 + CleanupStack::Pop();
1.641 + }
1.642 + }
1.643 + iSwiChangeNotifier = CSwiChangeNotifier::NewL(*this);
1.644 +
1.645 + iScanningTimer = CIdleScanningTimer::NewL(*this);
1.646 +
1.647 + //Create the language change notifier and install the callback function
1.648 + const TCallBack myCallBackFunction(&CDiscoverer::LocaleChangedL, this);
1.649 + iLanguageChangeNotifier = CEnvironmentChangeNotifier::NewL(CActive::EPriorityStandard, myCallBackFunction);
1.650 +
1.651 + iDirScanner = CDirScanner::NewL(*this,iFs);
1.652 +
1.653 + InitialiseEvent();
1.654 + }
1.655 +
1.656 +
1.657 +TInt CDiscoverer::Resume()
1.658 + {
1.659 + // Reactivate the scanning timer if not NULL
1.660 + if (iScanningTimer != NULL)
1.661 + {
1.662 + iScanningTimer->Resume();
1.663 + }
1.664 +
1.665 + TCallBackState cbData = ECallBackState_EventEnd;
1.666 + iBurChangeCallBack.CallBack(ECallBackId_BurEvent, &cbData);
1.667 +
1.668 + /*
1.669 + iLanguageChangeNotifier is not activated because it is not cancelled during CDiscoverer::Suspend().
1.670 + It is not suspended because a language change should not occur whilst a backup/restore operation
1.671 + is taking place.
1.672 + */
1.673 +
1.674 + return KErrNone;
1.675 + }
1.676 +
1.677 +
1.678 +TInt CDiscoverer::Suspend()
1.679 + {
1.680 + // Suspend the scanning timer if not NULL
1.681 + if (iScanningTimer != NULL)
1.682 + {
1.683 + iScanningTimer->Suspend();
1.684 + }
1.685 +
1.686 + TCallBackState cbData = ECallBackState_EventStart;
1.687 + iBurChangeCallBack.CallBack(ECallBackId_BurEvent, &cbData);
1.688 +
1.689 + /*
1.690 + iLanguageChangeNotifier is not cancelled because a language change should not occur
1.691 + whilst a backup/restore operation is taking place.
1.692 + */
1.693 +
1.694 + return KErrNone;
1.695 + }
1.696 +
1.697 +
1.698 +TBool CDiscoverer::NotificationL(TInt aStatus, const TDriveUnit& aDriveUnit)
1.699 + {
1.700 +
1.701 + TBool okToContinue = ETrue;
1.702 + if(aStatus != KErrNone)
1.703 + {
1.704 + // Big trouble with the notification
1.705 + // Tell our observer
1.706 + // Notifications will cease if EFalse is returned!!!!
1.707 + okToContinue = iDiscovererObserver.NotifiedWithErrorCode(aStatus);
1.708 + }
1.709 + else
1.710 + {
1.711 + //call ProcessDNEventL() to indicate Plugins have been added or removed on a specfic drive,
1.712 + // then do the state transition and to start a re-discovery .
1.713 + ProcessDNEventL(EPluginsModified,aDriveUnit );
1.714 + ProcessDNEventL(EPluginsRediscover, aDriveUnit);
1.715 + }
1.716 + return okToContinue;
1.717 + }
1.718 +
1.719 +void CDiscoverer::SwiChangeNotificationL(TInt aSwiOperation)
1.720 + {
1.721 + // Store the current SWI operation, ignore operation status
1.722 + iSwiOperation = aSwiOperation & KSASwisOperationMask;
1.723 +
1.724 + TCallBackState cbData = SwiOperationInProgress() ? ECallBackState_EventStart : ECallBackState_EventEnd;
1.725 + iSwiChangeCallBack.CallBack(ECallBackId_SwiEvent, &cbData);
1.726 +
1.727 + // Test no SWI operation in progress
1.728 + if(!SwiOperationInProgress())
1.729 + {
1.730 + TBool rediscoveryPending = EFalse;
1.731 + if(!iSwiChangeDiscoveryPending)
1.732 + {
1.733 + // for each removable drive call ProcessDNEventL() to do the state transition and to start
1.734 + // a re-discovery for that drive.
1.735 + TInt count = iDrivesDiscovered.Count();
1.736 + for(TInt i=0; i < count; i++)
1.737 + {
1.738 + TDriveUnit drvUnit(iDrivesDiscovered[i]);
1.739 + if(iCachedDriveInfo->DriveIsRemovableL(drvUnit))
1.740 + {
1.741 + rediscoveryPending = ETrue;
1.742 + ProcessDNEventL(EPluginsModified, drvUnit );
1.743 + ProcessDNEventL(EPluginsRediscover, drvUnit);
1.744 + iSwiChangeDiscoveryPending = ETrue;
1.745 + }
1.746 + }
1.747 + }
1.748 +
1.749 + //If there are no removable drives to be scanned check if there are any
1.750 + //pending notifications that couldn't be processed during SWI
1.751 + if(!rediscoveryPending && iScanningTimer->IsAnyNotificationProcessingPending())
1.752 + {
1.753 + // Activate timer if there is any notification processing pending
1.754 + iScanningTimer->RestartScanPeriod();
1.755 + }
1.756 + }
1.757 + }
1.758 +
1.759 +TBool CDiscoverer::SwiOperationInProgress()
1.760 + {
1.761 + return (iSwiOperation != ESASwisNone);
1.762 + }
1.763 +
1.764 +void CDiscoverer::LanguageChangeNotificationL()
1.765 + {
1.766 + if (!iLanguageChangeDiscoveryPending)
1.767 + {
1.768 + // for each drive call ProcessDNEventL() to do the state transition and to start
1.769 + // a re-discovery for that drive.
1.770 + TInt count = iDrivesDiscovered.Count();
1.771 + for(TInt i=0; i < count; i++)
1.772 + {
1.773 + ProcessDNEventL(EPluginsModified, iDrivesDiscovered[i] );
1.774 + ProcessDNEventL(EPluginsRediscover, iDrivesDiscovered[i]);
1.775 + }
1.776 + iLanguageChangeDiscoveryPending = ETrue;
1.777 + }
1.778 + }
1.779 +void CDiscoverer::RediscoveryScanDirectoryL(const TDriveUnit& aDriveUnit)
1.780 + {
1.781 + TBool doScan = EFalse;
1.782 + if(iDrivesDiscovered.Find(aDriveUnit) != KErrNotFound)
1.783 + {
1.784 + // If the drive has plugins on it previously, do ScanDriveL on any notifications.
1.785 + doScan = ETrue;
1.786 + }
1.787 + else // Otherwise the drive doesn't contain any plugin before, do further check.
1.788 + {
1.789 + TBuf<KEComPlugRSCPathMaxLen> pluginsDirPath(KEComResourceFolderPath);
1.790 + pluginsDirPath[0] = ('A' + TInt(aDriveUnit));
1.791 + TEntry entry;
1.792 + if(iFs.Entry(pluginsDirPath,entry) == KErrNone)
1.793 + {
1.794 + // Now it has plugins folder on it, do ScanDriveL.
1.795 + doScan = ETrue;
1.796 + }
1.797 + // If it still doesn't have plugins folder on it, skip unnecessary scanning.
1.798 + // NOTE: other returned error code could be KErrPathNotFound, KErrNotReady etc.
1.799 + // As long as no plugin has been found, always skip scanning on this drive.
1.800 + }
1.801 +
1.802 + // Performs scanning according to above checks.
1.803 + if(doScan)
1.804 + {
1.805 + // Signal the observer that a scan has commenced.
1.806 + iDiscovererObserver.DiscoveriesBegin();
1.807 +
1.808 + iDirScanner->ScanDriveL(aDriveUnit, iCachedDriveInfo->DriveIsReadOnlyInternalL(aDriveUnit));
1.809 +
1.810 + // Signal the observer that the scan has
1.811 + // been completed successfully.
1.812 + iDiscovererObserver.SetDiscoveryFlagL(aDriveUnit);
1.813 + }
1.814 + }
1.815 +
1.816 +void CDiscoverer::ScanDirectoryCancel()
1.817 + {
1.818 + if(iDirScanner != NULL)
1.819 + {
1.820 + // Signal the observer that the scan has
1.821 + // been completed un-successfully.
1.822 + iDiscovererObserver.DiscoveriesComplete(EFalse, EPluginProcessingTypeAll);
1.823 + }
1.824 + }
1.825 +
1.826 +
1.827 +void CDiscoverer::CompleteNotificationProcessing()
1.828 + {
1.829 + iState = EDisc_AllPluginsDisc;
1.830 + iSwiChangeDiscoveryPending = EFalse;
1.831 + iLanguageChangeDiscoveryPending = EFalse;
1.832 + }
1.833 +
1.834 +
1.835 +void CDiscoverer::ValidateEntryL(const TEntry& aEntry, const TDriveName& aDriveName, CPluginBase*& aEntryToFill, TBool aIsRO)
1.836 + {
1.837 + aEntryToFill=CSecurePlugin::NewL(iFs,aEntry,aDriveName, aIsRO);
1.838 + }
1.839 +
1.840 +void CDiscoverer::ValidateEntryL(RResourceArchive& aRscArchive,CPluginBase*& aEntryToFill)
1.841 + {
1.842 + aEntryToFill = CSpiPlugin::NewL(aRscArchive);
1.843 + }
1.844 +
1.845 +
1.846 +void CDiscoverer::ProcessEntryL(const TDriveName& aDrive,CPluginBase*& aEntry, TBool aAnyDllDiscovered)
1.847 + {
1.848 + iDiscovererObserver.RegisterDiscoveryL(aDrive,aEntry,aAnyDllDiscovered);
1.849 + }
1.850 +
1.851 +void CDiscoverer::DriveMountedL(TDriveUnit aDrive)
1.852 + {
1.853 + TInt index = iDrivesDiscovered.Find(aDrive);
1.854 + if(index == KErrNotFound)
1.855 + {
1.856 + User::LeaveIfError(iDrivesDiscovered.Append(aDrive));
1.857 + iDiscovererObserver.DriveReinstatedL(aDrive); // Wasn't there before
1.858 + }
1.859 + }
1.860 +
1.861 +TBool CDiscoverer::IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)const
1.862 + {
1.863 + return iDiscovererObserver.IsAnyDllRegisteredWithDriveL(aDrive);
1.864 + }
1.865 +
1.866 +void CDiscoverer::DriveUnmountedL(TDriveUnit aDrive)
1.867 + {
1.868 + TInt index = iDrivesDiscovered.Find(aDrive);
1.869 + if(index != KErrNotFound)
1.870 + {
1.871 + iDrivesDiscovered.Remove(index);
1.872 + iDiscovererObserver.DriveRemovedL(aDrive); // Was there before
1.873 + }
1.874 + }
1.875 +
1.876 +CDiscoverer::TDiscovererState CDiscoverer::State() const
1.877 + {
1.878 + return iState;
1.879 + }
1.880 +
1.881 +
1.882 +void CDiscoverer::ProcessSSAEventL(TStartupStateIdentifier aKnownState)
1.883 + {
1.884 +
1.885 + if(iState == EDisc_NoPluginsDisc && aKnownState == EStartupStateCriticalStatic)
1.886 + {
1.887 + __ECOM_TRACE("ECOM: CDiscoverer::ProcessSSAEventL():EStartupStateCriticalStatic is reached,discover the RO Internal drives only.");
1.888 +
1.889 + // Signal the observer that the scanning is started
1.890 + iDiscovererObserver.DiscoveriesBegin();
1.891 +
1.892 + //scan the RO drives
1.893 + iDirScanner->DiscoverPluginsL(ETrue);
1.894 +
1.895 + //change the state
1.896 + iState = EDisc_CriticalPluginsDisc;
1.897 +
1.898 + // Signal the observer that the scan has
1.899 + // been completed successfully.
1.900 + iDiscovererObserver.DiscoveriesComplete(ETrue, EPluginProcessingTypeCriticalOnly);
1.901 + }
1.902 + else if(iState == EDisc_CriticalPluginsDisc && aKnownState == EStartupStateNonCritical)
1.903 + {
1.904 + __ECOM_TRACE("ECOM: CDiscoverer::ProcessSSAEventL():EStartupStateNonCritical is reached,discover the Non RO Internal drives.");
1.905 +
1.906 + // Signal the observer that the scanning is started
1.907 + iDiscovererObserver.DiscoveriesBegin();
1.908 +
1.909 + //scan the non-ro drives
1.910 + iDirScanner->DiscoverPluginsL(EFalse);
1.911 +
1.912 + //change the state
1.913 + iState = EDisc_AllPluginsDisc;
1.914 +
1.915 + // Signal the observer that the scan has
1.916 + // been completed successfully.
1.917 + iDiscovererObserver.DiscoveriesComplete(ETrue, EPluginProcessingTypeNonCriticalOnly);
1.918 +
1.919 +
1.920 + StartNotifiers();
1.921 + }
1.922 + else if(iState == EDisc_NoPluginsDisc && aKnownState == EStartupStateNonCritical)
1.923 + {
1.924 + __ECOM_TRACE("ECOM: CDiscoverer::ProcessSSAEventL():EStartupStateNonCritical is reached all at once,discover all the drives.");
1.925 +
1.926 + // Signal the observer that the scanning is started
1.927 + iDiscovererObserver.DiscoveriesBegin();
1.928 +
1.929 + //scan a specified the drives
1.930 + iDirScanner->DiscoverPluginsL(ETrue);
1.931 + iDirScanner->DiscoverPluginsL(EFalse);
1.932 +
1.933 + //change the state
1.934 + iState = EDisc_AllPluginsDisc;
1.935 +
1.936 + // Signal the observer that the scan has
1.937 + // been completed successfully.
1.938 + iDiscovererObserver.DiscoveriesComplete(ETrue, EPluginProcessingTypeAll);
1.939 +
1.940 + StartNotifiers();
1.941 + }
1.942 + }
1.943 +
1.944 +void CDiscoverer::StartNotifiers()
1.945 + {
1.946 +
1.947 + for(TInt i = 0; i<iRscDirNotifierList.Count(); i++)
1.948 + {
1.949 + if (iRscDirNotifierList[i] != NULL)
1.950 + iRscDirNotifierList[i]->Activate();
1.951 + }
1.952 + iSwiChangeNotifier->Subscribe();
1.953 + iLanguageChangeNotifier->Start();
1.954 + }
1.955 +
1.956 +void CDiscoverer::ProcessDNEventL(TNotificationFlag aFlag, const TDriveUnit& aDriveUnit)
1.957 + {
1.958 + if(iState == EDisc_AllPluginsDisc && aFlag == EPluginsModified)
1.959 + {
1.960 + iState = EDisc_PluginsDirty;
1.961 + return;
1.962 + }
1.963 + if(iState == EDisc_PluginsDirty && aFlag == EPluginsRediscover)
1.964 + {
1.965 + // Add drive number to the pending drive list and activate timer.
1.966 + iScanningTimer->AddDriveL(aDriveUnit);
1.967 + iScanningTimer->RestartScanPeriod();
1.968 + }
1.969 + }
1.970 +
1.971 +void CDiscoverer::SetSwiChangeCallBack(const TCallBackWithArg& aCallBack)
1.972 + {
1.973 + iSwiChangeCallBack = aCallBack;
1.974 + }
1.975 +
1.976 +void CDiscoverer::SetBurChangeCallBack(const TCallBackWithArg& aCallBack)
1.977 + {
1.978 + iBurChangeCallBack = aCallBack;
1.979 + }
1.980 +
1.981 +void CDiscoverer::InitialiseEvent()
1.982 + {
1.983 + iState = EDisc_NoPluginsDisc;
1.984 + }
1.985 +TInt CDiscoverer::LocaleChangedL(TAny* aPtr)
1.986 + {
1.987 + CDiscoverer* thisLocaleManager = (CDiscoverer *) aPtr ;
1.988 +
1.989 + if(!thisLocaleManager->iLanguageChangeNotifier)
1.990 + {
1.991 + __ECOM_TRACE("ECOM: LocaleChangedL: Bad Change Notification");
1.992 + return KErrGeneral;
1.993 + }
1.994 +
1.995 + TInt stat = thisLocaleManager->iLanguageChangeNotifier->Change();
1.996 + if((stat & EChangesLocale) && (!thisLocaleManager->iLanguageChangeDiscoveryPending))
1.997 + {
1.998 + //
1.999 + // System Locale data has been updated
1.1000 + // if the downgrade path has changed we
1.1001 + // re-scan resource files for all drives and get the right language.
1.1002 + TBool isLanguageChanged;
1.1003 + thisLocaleManager->iDiscovererObserver.LanguageChangedL(isLanguageChanged);
1.1004 + if(isLanguageChanged)
1.1005 + {
1.1006 + thisLocaleManager->LanguageChangeNotificationL();
1.1007 + }
1.1008 + }
1.1009 + return KErrNone;
1.1010 + }