1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/frame/Discoverer.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,1050 @@
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 +// Definition of the CDiscoverer class
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @file
1.23 + @internalComponent
1.24 +*/
1.25 +
1.26 +#ifndef __DISCOVERER_H__
1.27 +#define __DISCOVERER_H__
1.28 +
1.29 +#include <e32base.h>
1.30 +#include <f32file.h>
1.31 +#include <e32property.h> // for RProperty
1.32 +#include <domaindefs.h> // for TDmDomainState
1.33 +
1.34 +#include "DiscovererObserver.h" // The MDiscovererObserver class
1.35 +#include "EComEntry.h"
1.36 +#include "EComEntryBase.h"
1.37 +#include "callback.h"
1.38 +
1.39 +// Platsec path to binaries
1.40 +_LIT(KSysBin,"\\sys\\bin\\");
1.41 +// Platsec path to resources
1.42 +_LIT(KResourcePlugins,"\\resource\\plugins\\");
1.43 +_LIT(KDllExtension,".dll");
1.44 +
1.45 +_LIT(KRscExtension,".rsc");
1.46 +
1.47 +// Length of extension of file name.
1.48 +//The language extension length including the "." is assumed to be 4
1.49 +const TInt KExtensionLength=4;
1.50 +
1.51 +//Max lenth for plugin resource path
1.52 +const TInt32 KEComPlugRSCPathMaxLen = 50;
1.53 +
1.54 +//class forward declare
1.55 +class CEnvironmentChangeNotifier;
1.56 +/**
1.57 + @internalComponent
1.58 + @since 7.0
1.59 + Responsible for Interface Implementation Collections,
1.60 + installed in the Interface Implementation Collection directories.
1.61 + */
1.62 +
1.63 +class CDiscoverer : public CBase
1.64 +{
1.65 +public:
1.66 +
1.67 +/** Transition flag for Notification*/
1.68 + enum TNotificationFlag
1.69 + {
1.70 + /** A new plugin added or removed*/
1.71 + EPluginsModified,
1.72 +
1.73 + /**should do a rediscovery */
1.74 + EPluginsRediscover
1.75 + };
1.76 +
1.77 +/** State declaration for CDiscoverer */
1.78 +
1.79 + enum TDiscovererState
1.80 + {
1.81 + /** Undefined state */
1.82 + EDisc_Undefined,
1.83 +
1.84 + /** Initialize state */
1.85 + EDisc_NoPluginsDisc,
1.86 +
1.87 + /** Discover plugins on Ro Internal drive units */
1.88 + EDisc_CriticalPluginsDisc,
1.89 +
1.90 + /** All plugins are discovered.*/
1.91 + EDisc_AllPluginsDisc,
1.92 +
1.93 + /** Plugins added or removed, going to rediscover all plugins */
1.94 + EDisc_PluginsDirty
1.95 +
1.96 + };
1.97 +
1.98 +/**
1.99 + @fn NewL(MDiscovererObserver& aDiscovererObserver, RFs& aFs)
1.100 + Intended Usage : Standardised safe construction which leaves nothing
1.101 + on the cleanup stack.
1.102 + Error Condition : Not enough memory available.
1.103 + @leave KErrNoMemory
1.104 + @since 7.0
1.105 + @param aDiscovererObserver A reference to the owning client
1.106 + of the CDiscoverer
1.107 + @param aFs A reference to a connected file server instance.
1.108 + @return CDiscoverer* a pointer to the new class
1.109 + @pre None
1.110 + @post CDiscoverer is fully constructed, and initialised.
1.111 + */
1.112 +
1.113 + static CDiscoverer* NewL(MDiscovererObserver& aDiscovererObserver, RFs& aFs);
1.114 +
1.115 +/**
1.116 + @fn ~CDiscoverer()
1.117 + Intended Usage : Standard default d'tor
1.118 + Error Condition : None
1.119 + @since 7.0
1.120 + @pre CDiscoverer is fully constructed.
1.121 + @post CDiscoverer is totally destroyed.
1.122 + */
1.123 +
1.124 + ~CDiscoverer();
1.125 +
1.126 +/**
1.127 + @fn Resume()
1.128 + Intended Usage : Re-enable the Discoverer to continue checking for new
1.129 + interface implementations.
1.130 + Error Condition : Where resume of the discoverer fails. KErrResumeFailed.
1.131 + @since 7.0
1.132 + @return TInt The status of the operation. KErrNone or KErrResumeFailed.
1.133 + @pre CDiscoverer is fully constructed.
1.134 + @post The operation of the discoverer has been resumed. Or where
1.135 + resumption failed, no change.
1.136 + */
1.137 +
1.138 + TInt Resume();
1.139 +
1.140 +/**
1.141 + @fn Suspend()
1.142 + Intended Usage : Temporarily stop looking for new interface implementations.
1.143 + Error Condition : Where suspension of the discoverer fails. KErrSuspendFailed.
1.144 + @since 7.0
1.145 + @return TInt The status of the operation. KErrNone or KErrSuspendFailed.
1.146 + @pre CDiscoverer is fully constructed.
1.147 + @post The operation of the discoverer has been suspended. Or where
1.148 + suspend failed, no change.
1.149 + */
1.150 +
1.151 + TInt Suspend();
1.152 +
1.153 +
1.154 +/**
1.155 + @fn ProcessSSAEventL()
1.156 + Intended Usage : It discovers the plugins on different Drive Units according to
1.157 + the passing state. It will be used by CRegistrar to notify the
1.158 + object of the system start-up state changes.
1.159 + @param aKnownState the start-up state passing in to CDiscoverer
1.160 + @pre CDiscoverer is fully constructed
1.161 + @post CDiscoverer is notified of the start-up state change
1.162 +*/
1.163 + void ProcessSSAEventL(TStartupStateIdentifier aKnownState);
1.164 +
1.165 +/**
1.166 + @fn ProcessDNEventL()
1.167 + Intended Usage :It will be used by one iRscDirNotifier in iRscDirNotifierList
1.168 + to indicate that plugins have been removed or added(state is
1.169 + EDisc_PluginsDirty) and to start a
1.170 + re-discovery(when done, state is EDisc_AllPluginsDisc).
1.171 + @leave KErrNoMemory
1.172 + @param :aFlag the notification transition flag.
1.173 + @param :aDriveUnit a drive which on the plugins has been changed and need to re-discovery
1.174 + @pre :CDiscoverer is fully constructed.
1.175 + @post : state will be changed, and a re-discovery will happen
1.176 + if the current state is EDisc_PluginsDirty.
1.177 +*/
1.178 + void ProcessDNEventL(TNotificationFlag aFlag, const TDriveUnit& aDriveUnit);
1.179 +
1.180 +/**
1.181 + @fn State()
1.182 + Intended Usage :Retrieve the object's current state.
1.183 + @return TDiscovererState the CDiscoverer's current state.
1.184 + @pre CDiscoverer is fully constructed.
1.185 + @post the CDiscoverer's current state has been returned.
1.186 +*/
1.187 + TDiscovererState State() const;
1.188 +
1.189 +/** Set the iSwiChangeCallBack member
1.190 +@param aCallBack new value for iSwiChangeCallBack
1.191 +*/
1.192 + void SetSwiChangeCallBack(const TCallBackWithArg& aCallBack);
1.193 +
1.194 +/** Set the iBurChangeCallBack member
1.195 +@param aCallBack new value for iBurChangeCallBack
1.196 +*/
1.197 + void SetBurChangeCallBack(const TCallBackWithArg& aCallBack);
1.198 +
1.199 +private:
1.200 +/**
1.201 + @internalComponent
1.202 + @fn CDiscoverer(MDiscovererObserver& aDiscovererObserver, RFs& aFs)
1.203 + Intended Usage : Standardised default c'tor
1.204 + Error Condition : None
1.205 + @since 7.0
1.206 + @param aDiscovererObserver A reference to the owning client
1.207 + of the CDiscoverer
1.208 + @param aFs A reference to an connected file server instance.
1.209 + @pre None
1.210 + @post CDiscoverer is fully constructed
1.211 + */
1.212 +
1.213 + CDiscoverer(MDiscovererObserver& aDiscovererObserver, RFs& aFs);
1.214 +
1.215 +/**
1.216 + @fn ConstructL()
1.217 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.218 + Error Condition : Leaves with error code : usually KErrNoMemory.
1.219 + @leave KErrNoMemory.
1.220 + @since 7.0
1.221 + @return void
1.222 + @pre CDiscoverer is fully constructed.
1.223 + @post CDiscoverer is fully initialised.
1.224 + */
1.225 +
1.226 + void ConstructL();
1.227 +
1.228 +/**
1.229 + @fn NotificationL(TInt aStatus)
1.230 + Intended Usage : Called by the one object of iRscDirNotifierList when the
1.231 + contents of the Interface Implementation directories
1.232 + has changed on a specified drive.
1.233 + Error Condition : None
1.234 + @leave KErrNoMemory
1.235 + @since 7.0
1.236 + @param aDriveUnit a drive which has changes.
1.237 + @return ETrue to indicate the notifier should re-activate.
1.238 + @pre CDiscoverer is fully constructed.
1.239 + @post CDiscoverer has been notified that a re-scan of the
1.240 + plugin directories is required.
1.241 + */
1.242 +
1.243 + TBool NotificationL(TInt aStatus, const TDriveUnit& aDriveUnit);
1.244 +
1.245 +/**
1.246 + @fn SwiChangeNotificationL(TInt aSwiOperation)
1.247 + Intended Usage : Called by iSwiChangeNotifier when it is notified of a
1.248 + SWI changed.
1.249 + Error Condition : None
1.250 + @since 9.2
1.251 + @param aSwiOperation the SWI operation that is currently taking place
1.252 + @pre CDiscoverer is fully constructed.
1.253 + @post CDiscoverer has been notified that a re-scan of the
1.254 + removable plugin directories is required and has stored current
1.255 + SWI operation.
1.256 + */
1.257 +
1.258 + void SwiChangeNotificationL(TInt aSwiOperation);
1.259 +
1.260 +/**
1.261 + @fn LanguageChangeNotificationL()
1.262 + Intended Usage : Called by iLanguageChangeNotifier when it is notified of language
1.263 + downgrade path changed.
1.264 + Error Condition : None
1.265 + @since 9.3
1.266 + @pre CDiscoverer is fully constructed.
1.267 + @post CDiscoverer has been notified that a rescan may be required
1.268 + */
1.269 +
1.270 + void LanguageChangeNotificationL();
1.271 +
1.272 + // Methods used by the Incremental Directory Scanning mechanism
1.273 +
1.274 +/**
1.275 + @fn void RediscoveryScanDirectoryL()
1.276 + Intended Usage : Perform a scan on the Interface Implementation
1.277 + Collection directories on a specified drive.
1.278 + Error Condition : Not enough memory available
1.279 + @leave KErrNoMemory
1.280 + @since 7.0
1.281 + @param :A drive on which the directory is scanned.
1.282 + @return void
1.283 + @pre CDiscoverer is fully constructed.
1.284 + @post The scan of the Interface Implementation Collection
1.285 + directories has processed on a specified drive.
1.286 + */
1.287 +
1.288 + void RediscoveryScanDirectoryL(const TDriveUnit& aDriveUnit);
1.289 +
1.290 +/**
1.291 + @fn void ScanDirectoryCancel()
1.292 + Intended Usage : Cancel any scan of the Interface Implementation Collection
1.293 + directories in progress.
1.294 + Error Condition : None
1.295 + @since 7.0
1.296 + @return void
1.297 + @pre CDiscoverer is fully constructed.
1.298 + @post The re-scan of the Interface Implementation
1.299 + Collection directories has beed aborted.
1.300 + */
1.301 +
1.302 + void ScanDirectoryCancel();
1.303 +
1.304 +/**
1.305 + @fn CompleteNotificationProcessing()
1.306 + Intended Usage : Signal that the directory change notification has
1.307 + been fully processed on all drives.
1.308 + Error Condition : None
1.309 + @since 7.0
1.310 + @pre CDiscoverer is fully constructed.
1.311 + @post An asynchronous re-scan of the Interface Implementation
1.312 + Collection directories is complete.
1.313 + */
1.314 +
1.315 + void CompleteNotificationProcessing();
1.316 +
1.317 +/**
1.318 + @fn ValidateEntryL(const TEntry& aEntry, const TDriveName& aDriveName, CPluginBase*& aEntryToFill,TBool aIsRO)
1.319 + Intended Usage : Verify that a Interface Implementation Collection directories entry is valid
1.320 + discovery.
1.321 + Error Condition : No memory
1.322 + @leave KErrNoMemory
1.323 + @since 9.1
1.324 + @param aEntry A directory entry for an Interface Implementation Collection.
1.325 + @param aDriveName The drive containing this entry
1.326 + @param aEntryToFill A newly created directory entry with the
1.327 + filename updated to include the full path.
1.328 + @param aIsRO Indicates whether current drive is Read Only
1.329 + @pre CDiscoverer is fully constructed,
1.330 + aEntry, aPath and aEntryToFill are all valid references.
1.331 + @post aEntryToFill is created and valid, with the full path and filename as its name entry.
1.332 + */
1.333 +
1.334 + void ValidateEntryL(const TEntry& aEntry, const TDriveName& aDriveName, CPluginBase*& aEntryToFill, TBool aIsRO);
1.335 +
1.336 +/**
1.337 + @fn ValidateEntryL(RResourceArchive& aRscArchive,CPluginBase*& aEntryToFill);
1.338 + Intended Usage : Verify that a Interface Implementation Collection directories entry is valid
1.339 + discovery.
1.340 + Error Condition : No memory
1.341 + @leave KErrNoMemory
1.342 + @since 9.1
1.343 + @param aRscArchive A referernce to the resource archive
1.344 + @param aEntryToFill A newly created directory entry with the
1.345 + filename updated to include the full path.
1.346 + @pre CDiscoverer is fully constructed,
1.347 + @post aEntryToFill is created and valid, with the full path and filename as its name entry.
1.348 + */
1.349 +
1.350 + void ValidateEntryL(RResourceArchive& aRscArchive, CPluginBase*& aEntryToFill);
1.351 +/**
1.352 + @fn ProcessEntryL(const TDriveName& aDrive,CPluginBase*& aEntry, TBool aAnyDllDiscovered)
1.353 + Intended Usage : Verify that a Interface Implementation Collection directories entry is valid
1.354 + discovery.
1.355 + Error Condition : Depends on the observer implementation.
1.356 + @leave Depends on the observer implementation. (@see CRegistrar).
1.357 + @since 9.1
1.358 + @param aDrive the drive name containing this entry
1.359 + @param aEntry A directory entry for an Interface Implementation Collection.
1.360 + @param aAnyDllDiscovered a flag to tell if any Dll is discovered in the drive.
1.361 + @pre CDiscoverer is fully constructed.
1.362 + @post The directory entry has been processed by the observer.
1.363 + */
1.364 +
1.365 + void ProcessEntryL(const TDriveName& aDrive, CPluginBase*& aEntry, TBool aAnyDllDiscovered);
1.366 +
1.367 +/**
1.368 + @fn DriveMountedL(TDriveUnit aDrive)
1.369 + Intended Usage : Signal a drive is available.
1.370 + Error Condition : Depends on the observer implementation.
1.371 + @leave Depends on the observer implementation. @see CRegistrar.
1.372 + @since 7.0
1.373 + @param aDrive The drive to be noted as available.
1.374 + @return void.
1.375 + @pre CDiscoverer is fully constructed.
1.376 + @post The drive mount has been signalled to the observer.
1.377 + */
1.378 +
1.379 + void DriveMountedL(TDriveUnit aDrive);
1.380 +
1.381 +/**
1.382 + @fn DriveUnmountedL(TDriveUnit aDrive)
1.383 + Intended Usage : Signal a drive is unavailable.
1.384 + Error Condition : Leaves with an error code
1.385 + @leave KErrNoMemory
1.386 + @since 7.0
1.387 + @param aDrive The drive to be noted as unavailable.
1.388 + @pre CDiscoverer is fully constructed.
1.389 + @post The drive dismount has been signalled to the observer.
1.390 + */
1.391 +
1.392 + void DriveUnmountedL(TDriveUnit aDrive);
1.393 +
1.394 +
1.395 +
1.396 +/**
1.397 + @fn StartNotifiers()
1.398 + Intended Usage : start the iRscDirNotifierList and iSwiChangeNotifier when EDisc_AllPlugins
1.399 + state is reached.
1.400 + @pre : CDiscoverer is fully constructed. and iRscDirNotifierList and iSwiChangeNotifier
1.401 + are fully constructed.
1.402 + @post : iRscDirNotifierList Activate and iSwiChangeNotifier Subscribe methods are called.
1.403 +*/
1.404 + void StartNotifiers();
1.405 +
1.406 +
1.407 +/**
1.408 + @fn InitialiseEvent()
1.409 + Intended Usage : called during the CDiscoverer's construction
1.410 + to change the state.
1.411 + @pre : non
1.412 + @post : State is changed from EDisc_Undefined to EDisc_NoPluginsDisc.
1.413 +*/
1.414 + void InitialiseEvent();
1.415 +
1.416 +/**
1.417 + @fn IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)
1.418 + Intended Usage : Find if any Dll is registered in the drive.
1.419 + @param : aDrive the identifier of the drive to find if any Dll is registered.
1.420 + @return : ETrue if any Dll is registered in the drive unit, otherwise EFalse.
1.421 + @pre : CDiscoverer is fully constructed.
1.422 + @post : If any Dll registered info will be returned.
1.423 +*/
1.424 + TBool IsAnyDllRegisteredWithDriveL(const TDriveUnit aDrive)const ;
1.425 +
1.426 +/**
1.427 + @fn SwiOperationInProgress()
1.428 + Intended Usage : Determine if any SWI operation is currently in progress
1.429 + @return : ETrue if any SWI operation is in progress otherwise EFalse.
1.430 + @pre : CDiscoverer is fully constructed.
1.431 + @post : None
1.432 +*/
1.433 + TBool SwiOperationInProgress() ;
1.434 +
1.435 +/**
1.436 + @fn LocaleChangedL(TAny*)
1.437 + Intended Usage : Callback function to be attached to an instance of CEnvironmentChangeNotifier to
1.438 + rebuild registry data. Note that this has to be a static member function.
1.439 + @param : A parameter to be passed usually with a "this" pointer so that while the function
1.440 + remaining a static function it can access all the member data anyway.
1.441 + @return : ETrue if language downgrade path is changed, otherwise EFalse.
1.442 + @pre : CDiscoverer is fully constructed.
1.443 + @post : Call LanguageChangeNotificationL method to rescan resource files.
1.444 +*/
1.445 + static TInt LocaleChangedL(TAny*) ;
1.446 +
1.447 +// Attributes
1.448 +private:
1.449 +
1.450 + // Define the helper classes which handle the
1.451 + // notification processing.
1.452 + class CDirChangeNotifier;
1.453 +
1.454 +
1.455 + typedef RPointerArray<CDirChangeNotifier> RDirChangeNotifierPointerArray;
1.456 + // Handles notifications of changes to plugin resources directory on list of drives.
1.457 + RDirChangeNotifierPointerArray iRscDirNotifierList;
1.458 +
1.459 + class CSwiChangeNotifier;
1.460 +
1.461 + // Handles notifications of changes to SWI
1.462 + CSwiChangeNotifier* iSwiChangeNotifier;
1.463 +
1.464 + // Indicates whether a discovery due to SWI changes is pending
1.465 + TBool iSwiChangeDiscoveryPending;
1.466 +
1.467 + //Handle notifications of changes to environment (including language switch)
1.468 + CEnvironmentChangeNotifier* iLanguageChangeNotifier ;
1.469 +
1.470 + // Stores the current SWI operation
1.471 + TInt iSwiOperation;
1.472 +
1.473 + // Indicates whether a discovery due to language changes is pending
1.474 + TBool iLanguageChangeDiscoveryPending;
1.475 +
1.476 + // the current state of CDiscoverer
1.477 + TDiscovererState iState;
1.478 +
1.479 + class CIdleScanningTimer;
1.480 +
1.481 + // A single timer, processes all pending notifications.
1.482 + CIdleScanningTimer* iScanningTimer;
1.483 +
1.484 + class CDirScanner;
1.485 +
1.486 + /**
1.487 + The internal Interface Implementation Collection
1.488 + identifier and registration handler
1.489 + */
1.490 +
1.491 + CDirScanner* iDirScanner;
1.492 +
1.493 + /** A reference to the owning client of the CDiscoverer */
1.494 +
1.495 + MDiscovererObserver& iDiscovererObserver;
1.496 +
1.497 + /** A reference to the connected file server instance */
1.498 +
1.499 + RFs& iFs;
1.500 +
1.501 + /** The list of existing drives */
1.502 +
1.503 + RArray<TUint> iDrivesDiscovered;
1.504 +
1.505 + /** cached info of drives A to Z */
1.506 + CEComCachedDriveInfo* iCachedDriveInfo;
1.507 +
1.508 + TCallBackWithArg iSwiChangeCallBack;
1.509 + TCallBackWithArg iBurChangeCallBack;
1.510 +
1.511 + // List the internal classes as friends
1.512 + friend class CSwiChangeNotifier;
1.513 + friend class CDirChangeNotifier;
1.514 + friend class CIdleScanningTimer;
1.515 + friend class CDirScanner;
1.516 + // And the Test bed state accessor
1.517 + friend class TDiscoverer_StateAccessor;
1.518 +
1.519 +
1.520 +};
1.521 +// __________________________________________________________________________
1.522 +//
1.523 +/**
1.524 +The notification object which uses P&S to monitor SWI KSAUidSoftwareInstallKey
1.525 +for changes. When SWI is present in the device/ROM this attribute publishes the
1.526 +current state of a software install or uninstall.
1.527 +When its RunL method is called and depending on the install/uninstall state it
1.528 +notifies its owning CDiscoverer class object to re-scan removable drives.
1.529 +
1.530 +@internalComponent
1.531 +*/
1.532 +class CDiscoverer::CSwiChangeNotifier : public CActive
1.533 + {
1.534 +public:
1.535 +
1.536 + /**
1.537 + @fn NewL(CDiscoverer& aDiscoverer)
1.538 + Intended Usage : Standardised safe construction which leaves nothing
1.539 + on the cleanup stack.
1.540 + Error Condition : Not enough memory available.
1.541 + @leave KErrNoMemory
1.542 + @since 9.2
1.543 + @param aDiscoverer A reference to the owning CDiscoverer
1.544 + @return CSwiChangeNotifier* a pointer to the new class
1.545 + @pre None
1.546 + @post CSwiChangeNotifier is fully constructed, and initialised.
1.547 + */
1.548 + static CSwiChangeNotifier* NewL(CDiscoverer& aDiscoverer);
1.549 +
1.550 + /**
1.551 + @fn virtual ~CSwiChangeNotifier()
1.552 + Intended Usage : Standard default d'tor
1.553 + Error Condition : None
1.554 + @since 9.2
1.555 + @pre CSwiChangeNotifier is fully constructed.
1.556 + @post CSwiChangeNotifier is totally destroyed
1.557 + */
1.558 + virtual ~CSwiChangeNotifier();
1.559 +
1.560 + /**
1.561 + @fn Subscribe()
1.562 + Intended Usage : Subscribes with P&S for change notifications for the
1.563 + SWI KSAUidSoftwareInstallKey property
1.564 + Error Condition : None
1.565 + @since 9.2
1.566 + @pre CSwiChangeNotifier is fully constructed.
1.567 + @post CSwiChangeNotifier is active on the current scheduler.
1.568 + */
1.569 + void Subscribe();
1.570 +
1.571 +private:
1.572 + /**
1.573 + @fn CSwiChangeNotifier(CDiscoverer& aDiscoverer)
1.574 + Intended Usage : Standardised default c'tor
1.575 + Error Condition : None
1.576 + @since 9.2
1.577 + @param aDiscoverer A reference to its owning class instance.
1.578 + @pre None
1.579 + @post CSwiChangeNotifier is fully constructed
1.580 + */
1.581 + CSwiChangeNotifier(CDiscoverer& aDiscoverer);
1.582 +
1.583 + /**
1.584 + @fn RunL()
1.585 + Intended Usage : When the object activates, this is method is called
1.586 + and notifies the CDiscoverer to re-scan the
1.587 + removable drives..
1.588 + Error Condition : Not enough memory available to complete the scan.
1.589 + @leave KErrNoMemory
1.590 + @since 9.2
1.591 + @pre CSwiChangeNotifier is fully constructed.
1.592 + @post CSwiChangeNotifier notifications are subscribed and plugins on
1.593 + removable drives have been rediscovered..
1.594 + */
1.595 + void RunL();
1.596 +
1.597 + /**
1.598 + @fn void ConstructL()
1.599 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.600 + Error Condition : Leaves with error code : usually KErrNoMemory.
1.601 + @leave KErrNoMemory.
1.602 + @since 9.2
1.603 + @return void
1.604 + @pre CSwiChangeNotifier is fully constructed.
1.605 + @post CSwiChangeNotifier is fully initialised.
1.606 + */
1.607 + void ConstructL();
1.608 +
1.609 + /**
1.610 + @fn DoCancel()
1.611 + Intended Usage : The cancel action called by CActive::Cancel().
1.612 + Error Condition : None
1.613 + @since 9.2
1.614 + @pre CSwiChangeNotifier is fully constructed.
1.615 + @post CSwiChangeNotifier notifications are cancelled and
1.616 + it is no longer active on the current scheduler.
1.617 + */
1.618 + void DoCancel();
1.619 +
1.620 + /**
1.621 + @fn RunError(TInt aError)
1.622 + Intended Usage : Called by the notifier RunL leaving.
1.623 + @since 9.2
1.624 + @param aError The error code that the RunL left with.
1.625 + @return TInt KErrNone.
1.626 + @pre CSwiChangeNotifier is fully constructed.
1.627 + @post CSwiChangeNotifier is returned to a
1.628 + sensible active state.
1.629 + */
1.630 + TInt RunError(TInt aError);
1.631 +
1.632 +private:
1.633 + /** A reference to its owning class instance */
1.634 + CDiscoverer& iDiscoverer;
1.635 + /** Handle allowing access to P&S properties */
1.636 + RProperty iProperty;
1.637 + /** Friend class to enable access to private members for testing. */
1.638 + friend class TDiscoverer_StateAccessor;
1.639 + };
1.640 +
1.641 +// __________________________________________________________________________
1.642 +//
1.643 +/**
1.644 + @internalComponent
1.645 + @since 7.0
1.646 + The notification object which watches the Interface Implementation Collection directories for
1.647 + any changes.
1.648 + When its RunL method is called, it notifies its owning CDiscoverer class
1.649 + object to re-scan the Interface Implementation Collection directories.
1.650 + */
1.651 +class CDiscoverer::CDirChangeNotifier : public CActive
1.652 + {
1.653 +public:
1.654 + /**
1.655 + @fn CDirChangeNotifier(CDiscoverer& aDiscoverer, RFs& aFs, const TDesC& aNotificationFilePath)
1.656 + Intended Usage : Standardised default c'tor
1.657 + Error Condition : None
1.658 + @since 7.0
1.659 + @param aDiscoverer A reference to its owning class instance.
1.660 + @param aFs A reference to a connected file server instance.
1.661 + @param aNotificationFilePath A reference to the file path that is to be watched.
1.662 + @param aDriveUnit A drive which the notification object watches for.
1.663 + @pre None
1.664 + @post CDirChangeNotifier is fully constructed
1.665 + */
1.666 + CDirChangeNotifier(CDiscoverer& aDiscoverer, RFs& aFs,const TDriveUnit& aDriveUnit);
1.667 + /**
1.668 + @fn virtual ~CDirChangeNotifier()
1.669 + Intended Usage : Standard default d'tor
1.670 + Error Condition : None
1.671 + @since 7.0
1.672 + @pre CDirChangeNotifier is fully constructed.
1.673 + @post CDirChangeNotifier is totally destroyed
1.674 + */
1.675 + virtual ~CDirChangeNotifier();
1.676 + /**
1.677 + @fn Activate()
1.678 + Intended Usage : Activate the notifier and attach it to the File
1.679 + session to watch the appropriate Interface Implementation Collection directories.
1.680 + Error Condition : None
1.681 + @since 7.0
1.682 + @pre CDirChangeNotifier is fully constructed.
1.683 + @post CDirChangeNotifier is active on the current scheduler.
1.684 + */
1.685 + void Activate();
1.686 +
1.687 +private:
1.688 + /**
1.689 + @fn RunL()
1.690 + Intended Usage : When the object activates, this is method is called
1.691 + and notifies the CDiscoverer to re-scan the
1.692 + Interface Implementation Collection directories.
1.693 + Error Condition : Not enough memory available to complete the scan.
1.694 + @leave KErrNoMemory
1.695 + @since 7.0
1.696 + @pre CDirChangeNotifier is fully constructed.
1.697 + @post CDirChangeNotifier notifications are cancelled and
1.698 + it is no longer active on the current scheduler.
1.699 + */
1.700 + void RunL();
1.701 + /**
1.702 + @fn DoCancel()
1.703 + Intended Usage : The cancel action called by CActive::Cancel().
1.704 + Error Condition : None
1.705 + @since 7.0
1.706 + @pre CDirChangeNotifier is fully constructed.
1.707 + @post CDirChangeNotifier notifications are cancelled and
1.708 + it is no longer active on the current scheduler.
1.709 + */
1.710 + void DoCancel();
1.711 +
1.712 + /**
1.713 + @fn RunError(TInt aError)
1.714 + Intended Usage : Called by the notifier RunL leaving.
1.715 + @since 7.0
1.716 + @param aError The error code that the RunL left with.
1.717 + @return TInt KErrNone.
1.718 + @pre CDirChangeNotifier is fully constructed.
1.719 + @post CDirChangeNotifier is returned to a
1.720 + sensible active state.
1.721 + */
1.722 + TInt RunError(TInt aError);
1.723 +
1.724 +private:
1.725 + /** A reference to its owning class instance */
1.726 + CDiscoverer& iDiscoverer;
1.727 + /** A reference to a connected file server instance */
1.728 + RFs& iFs;
1.729 + /** The file path for a specific drivethat we are interested in.*/
1.730 + //const TDesC& iNotificationFilePath;
1.731 + typedef TBuf<KEComPlugRSCPathMaxLen> TResourcePathName;
1.732 + TResourcePathName iNotificationFilePath;
1.733 +
1.734 + /** A drive which the notification object watches for.*/
1.735 + TDriveUnit iDriveUnit;
1.736 + /** Friend class to enable access to private members for testing. */
1.737 + friend class TDiscoverer_StateAccessor;
1.738 + };
1.739 +
1.740 +/**
1.741 + @since 7.0
1.742 + The timer Active object for providing incremental plugin directory scanning.
1.743 + Note that task execution is dependant upon the task priority
1.744 + The default priority is idle time execution only.
1.745 + This object controls the yielding of time to other processes by having a low priority
1.746 + but requesting immediate reactivation, after each incremental part of the directory scan.
1.747 + It is launched by the CDirChangeNotifier's notification call.
1.748 + */
1.749 +class CDiscoverer::CIdleScanningTimer : public CTimer
1.750 + {
1.751 +public:
1.752 + /**
1.753 + @fn NewL(CDiscoverer& aDiscoverer)
1.754 + Intended Usage : Standardised safe construction which leaves nothing
1.755 + on the cleanup stack.
1.756 + Error Condition : Not enough memory available.
1.757 + @leave KErrNoMemory
1.758 + @since 7.0
1.759 + @param aDiscoverer A reference to the owning CDiscoverer
1.760 + @return CIdleScanningTimer* a pointer to the new class
1.761 + @pre None
1.762 + @post CIdleScanningTimer is fully constructed, and initialised.
1.763 + */
1.764 + static CIdleScanningTimer* NewL(CDiscoverer& aDiscoverer);
1.765 + /**
1.766 + @fn virtual ~CIdleScanningTimer()
1.767 + Intended Usage : Standard default d'tor
1.768 + Error Condition : None
1.769 + @since 7.0
1.770 + @pre CIdleScanningTimer is fully constructed.
1.771 + @post CIdleScanningTimer is totally destroyed
1.772 + */
1.773 + virtual ~CIdleScanningTimer();
1.774 +
1.775 + /**
1.776 + @fn AddDriveL(TDriveUnit aDrive)
1.777 + Intended Usage : Add a drive for processing notification
1.778 + Error Condition : None
1.779 + @leave System wide error codes.
1.780 + @param aDrive The drive to be added.
1.781 + @post The drive number added into pending list only if it has not been added before
1.782 + */
1.783 + inline void AddDriveL(const TDriveUnit aDrive)
1.784 + {
1.785 + if(iPendingDriveList.Find(aDrive) == KErrNotFound)
1.786 + {
1.787 + iPendingDriveList.AppendL(aDrive);
1.788 + }
1.789 + }
1.790 +
1.791 + /**
1.792 + @fn IsAnyNotificationProcessingPending()
1.793 + Intended Usage : To check if there is any notification waiting to be processed.
1.794 + @return TBool A flag indicating if there is any pending notification to be processed
1.795 + */
1.796 + inline TBool IsAnyNotificationProcessingPending()
1.797 + {
1.798 + if(iPendingDriveList.Count())
1.799 + return ETrue;
1.800 + return EFalse;
1.801 + }
1.802 +
1.803 + /**
1.804 + @fn RestartScanPeriod()
1.805 + Intended Usage : Called to restart the scanning period.
1.806 + Error Condition : None
1.807 + @pre CIdleScanningTimer is fully constructed.
1.808 + @post CIdleScanningTimer is activated and will process pending drives list, if the timer has not been suspended
1.809 + */
1.810 + void RestartScanPeriod();
1.811 +
1.812 + /**
1.813 + @fn Suspend()
1.814 + Intended Usage : Called to suspend the scanning timer, disabling the scanning from being restarted.
1.815 + Error Condition : None
1.816 + @pre CIdleScanningTimer is fully constructed.
1.817 + @post CIdleScanningTimer is set as suspended. No re-discovery will take place.
1.818 + */
1.819 + void Suspend();
1.820 +
1.821 + /**
1.822 + @fn Resume()
1.823 + Intended Usage : Called to resume the scanning timer, and enable scanning to be restarted.
1.824 + Error Condition : None
1.825 + @pre CIdleScanningTimer is fully constructed.
1.826 + @post CIdleScanningTimer is set as resumed. Re-discovery will take place.
1.827 + */
1.828 + void Resume();
1.829 +
1.830 +private:
1.831 + /**
1.832 + @fn CIdleScanningTimer(CDiscoverer& aDiscoverer)
1.833 + Intended Usage : Standardised default c'tor made explicit to avoid unintentional
1.834 + conversion construction by the compiler.
1.835 + Error Condition : None
1.836 + @since 7.0
1.837 + @param aDiscoverer A reference to its owning class instance.
1.838 + @pre None
1.839 + @post CIdleScanningTimer is fully constructed
1.840 + */
1.841 + explicit CIdleScanningTimer(CDiscoverer& aDiscoverer);
1.842 + /**
1.843 + @fn void ConstructL()
1.844 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.845 + Error Condition : Leaves with error code : usually KErrNoMemory.
1.846 + @leave KErrNoMemory.
1.847 + @since 7.0
1.848 + @return void
1.849 + @pre CIdleScanningTimer is fully constructed.
1.850 + @post CIdleScanningTimer is fully initialised.
1.851 + */
1.852 + void ConstructL();
1.853 +
1.854 + /**
1.855 + @fn DoCancel()
1.856 + Intended Usage : The cancel action called by CActive::Cancel().
1.857 + Error Condition : None
1.858 + @since 7.0
1.859 + @pre CIdleScanningTimer is fully constructed.
1.860 + @post CIdleScanningTimer is no longer active on the current scheduler.
1.861 + */
1.862 + void DoCancel();
1.863 +
1.864 + /**
1.865 + @fn RunL()
1.866 + Intended Usage : When the object activates, this method calls
1.867 + the CDiscoverer to continue the incremental scan
1.868 + of the Interface Implementation Collection directories.
1.869 + Error Condition : Not enough memory available to add to complete the scan.
1.870 + @leave KErrNoMemory
1.871 + @since 7.0
1.872 + @pre CIdleScanningTimer is fully constructed.
1.873 + @post The Interface Implementation Collection directories Scan has completed another step and the
1.874 + CIdleScanningTimer has been re-activated for the next step
1.875 + OR The Interface Implementation Collection directories Scan is complete and the
1.876 + CDirChangeNotifier has been re-activated.
1.877 + */
1.878 + void RunL();
1.879 +
1.880 + /**
1.881 + @fn RunError(TInt aError)
1.882 + Intended Usage : Called when the directory change
1.883 + notification processing failed by leaving.
1.884 + @since 7.0
1.885 + @param aError The error code that the RunL left with.
1.886 + @return TInt KErrNone.
1.887 + @pre CIdleScanningTimer is fully constructed.
1.888 + @post CIdleScanningTimer is non-active.
1.889 + */
1.890 + TInt RunError(TInt aError);
1.891 +
1.892 +private:
1.893 + /** A reference to its owning class instance */
1.894 + CDiscoverer& iDiscoverer;
1.895 +
1.896 + /**
1.897 + An array of drives to be processed.
1.898 + */
1.899 + RArray<TUint> iPendingDriveList;
1.900 +
1.901 + /**
1.902 + A flag to indicate if the timer is suspended or not.
1.903 + */
1.904 + TBool iSuspended;
1.905 +
1.906 + // List the internal classes as friends
1.907 + // the Test bed state accessor
1.908 + friend class TDiscoverer_StateAccessor;
1.909 + };
1.910 +
1.911 +
1.912 +
1.913 +/**
1.914 + CDirScanner implements incremental scanning of the Interface Implementation
1.915 + Collection directories on behalf of the CDiscoverer.
1.916 + Its methods are called in response to the timer task execution,
1.917 + thereby requiring the incremental scheduling.
1.918 + */
1.919 +class CDiscoverer::CDirScanner : public CBase
1.920 + {
1.921 +// Methods
1.922 +public:
1.923 + /**
1.924 + @fn CDirScanner(CDiscoverer& aDiscoverer, RFs& aFs)
1.925 + Intended Usage : Standardised safe construction which leaves nothing
1.926 + on the cleanup stack.
1.927 + Error Condition : Not enough memory available.
1.928 + @leave KErrNoMemory
1.929 + @since 7.0
1.930 + @param aDiscoverer A reference to its owning class instance.
1.931 + @param aFs A reference to a connected file server instance.
1.932 + @return CDirScanner* a pointer to the new class
1.933 + @pre None
1.934 + @post CDirScanner is fully constructed, and initialised.
1.935 + */
1.936 + static CDirScanner* NewL(CDiscoverer& aDiscoverer, RFs& aFs);
1.937 +
1.938 + /**
1.939 + @fn virtual ~CDirScanner()
1.940 + Intended Usage : Standard default d'tor
1.941 + Error Condition : None
1.942 + @since 7.0
1.943 + @pre CDirScanner is fully constructed.
1.944 + @post CDirScanner is totally destroyed
1.945 + */
1.946 + virtual ~CDirScanner();
1.947 +
1.948 +
1.949 + /**
1.950 + @fn DiscoverPluginsL()
1.951 + Intended Usage : Discover the plugins the specific drive units.
1.952 + @param : aIsRO a flag to show if the Drive Units list is RO Internal or not.
1.953 + @pre : CDiscoverer is fully constructed.iDirScanner is fully constructed.
1.954 + @pre : CDirScanner is fully constructed.
1.955 + @post : the plugins on the specific Drive Units have been discovered.
1.956 + */
1.957 + void DiscoverPluginsL(TBool aDiscoverReadOnlyDrives);
1.958 +
1.959 + /**
1.960 + @fn ScanDriveL(TDriveUnit aDrive)
1.961 + Intended Usage : Helper method for StartScanL.
1.962 + Scan a drive for the Interface Implementation Collection directories
1.963 + and identify any Interface Implementation
1.964 + Collections within that directory
1.965 + for addition to the registry.
1.966 + Error Condition : None
1.967 + @leave KErrNoMemory
1.968 + @since 7.0
1.969 + @param aDrive The drive to scan.
1.970 + @param aIsRO A flag to tell if the drive unit is RO or Non-RO
1.971 + @pre CDirScanner is fully constructed.
1.972 + @post Another drive's Interface Implementation Collection directories has been scanned,
1.973 + */
1.974 + void ScanDriveL(const TDriveUnit& aDrive, TBool aIsRO);
1.975 +
1.976 +private:
1.977 + /**
1.978 + @fn CDirScanner(CDiscoverer& aDiscoverer, RFs& aFs)
1.979 + Intended Usage : Standardised default c'tor.
1.980 + Error Condition : None
1.981 + @since 7.0
1.982 + @param aDiscoverer A reference to its owning class instance.
1.983 + @param aFs A reference to a connected file server instance.
1.984 + @pre None
1.985 + @post CDirScanner is fully constructed
1.986 + */
1.987 + CDirScanner(CDiscoverer& aDiscoverer, RFs& aFs);
1.988 +
1.989 + /**
1.990 + @fn void ConstructL()
1.991 + Intended Usage : Standardised 2nd, (Initialisation) phase of two phase construction.
1.992 + Error Condition : Leaves with error code : usually KErrNoMemory.
1.993 + @leave KErrNoMemory.
1.994 + @since 7.0
1.995 + @return void
1.996 + @pre CDirScanner is fully constructed.
1.997 + @post CDirScanner is fully initialised.
1.998 + */
1.999 + void ConstructL();
1.1000 +
1.1001 +
1.1002 +
1.1003 + /**
1.1004 + @fn DoScanDriveL(const TDriveUnit aDrive, const TUidType aUidType)
1.1005 + Intended Usage : Helper method for StartScanL.
1.1006 + Scan a drive for the Interface Implementation Collection directories
1.1007 + and identify any Interface Implementation
1.1008 + Collections within that directory
1.1009 + for addition to the registry.
1.1010 + Error Condition : None
1.1011 + @leave KErrNoMemory
1.1012 + @since 9.0
1.1013 + @param aDrive The drive to scan.
1.1014 + @param aUidType The uid type to be searched for.
1.1015 + @param aIsRO Indicates whether the current drive is read Only.
1.1016 + @pre CDirScanner is fully constructed.
1.1017 + @post Another drive's Interface Implementation Collection directories has been scanned,
1.1018 + */
1.1019 + TBool DoScanDriveL(const TDriveUnit& aDrive, const TUidType& aUidType, TBool aIsRO);
1.1020 +
1.1021 + /**
1.1022 + @fn DoScanSpiFileL(const TParse aSpiPath)
1.1023 + Intended Usage : Helper method for StartScanL.
1.1024 + Scan a SPI file for the Interface Implementation Collection directories
1.1025 + and identify any Interface Implementation Collections within that directory
1.1026 + for addition to the registry.
1.1027 + Error Condition : None
1.1028 + @leave KErrNoMemory
1.1029 + @since 9.0
1.1030 + @param aSpiPath The SPI file to scan.
1.1031 + @pre CDirScanner is fully constructed.
1.1032 + @post Another drive's Interface Implementation Collection has been scanned from an SPI file.
1.1033 + */
1.1034 + TBool DoScanSpiFileL(const TParse& aSpiPath);
1.1035 +
1.1036 +
1.1037 +// Attributes / Properties
1.1038 +private:
1.1039 + /** A reference to its owning class instance */
1.1040 + CDiscoverer& iDiscoverer;
1.1041 + /** A reference to a connected file server instance */
1.1042 + RFs& iFs;
1.1043 + /** The Full Interface Implementation Collection Directory path */
1.1044 +
1.1045 + // List the internal classes as friends
1.1046 + // the Test bed state accessor
1.1047 + friend class TDiscoverer_StateAccessor;
1.1048 +
1.1049 +
1.1050 +}; // CDirScanner
1.1051 +
1.1052 +#endif // __DISCOVERER_H__
1.1053 +