--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/emailservices/emailserver/cmailhandlerplugin/inc/cmailcpssettings.h Wed Sep 01 12:28:57 2010 +0100
@@ -0,0 +1,323 @@
+/*
+* Copyright (c) 2008 - 20010 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: handles interface to CenRep settings
+*
+*/
+
+
+#ifndef CMAILCPSSETTINGS_H_
+#define CMAILCPSSETTINGS_H_
+
+#include "PSSubscriber.h"
+#include "PSSubscribeHandler.h"
+
+class CRepository;
+class CMailExternalAccount;
+
+/*
+ * Callback interface for observer
+ *
+ * @lib fsmailserver.exe
+ * @since S60 v5.1
+ */
+class MMailCpsSettingsCallback
+ {
+public:
+ /**
+ * Callback from CMailCpsSettings class
+ * Informs that settings have changed
+ *
+ * @since S60 v5.1
+ */
+ virtual void SettingsChangedCallback() = 0;
+ };
+
+/**
+ * CMail ContentPublishingService Settings Handler class
+ * Class implementing interface towards cenrep and email widget settings
+ *
+ * @lib fsmailserver.exe
+ * @since S60 v5.1
+ */
+NONSHARABLE_CLASS( CMailCpsSettings ) : public CActive,
+ public MPSSubscribeHandler
+ {
+public:
+ /**
+ * Two-phased constructor.
+ * @param aMailClient reference to CFSMailClient class. Mailserver offers
+ * this for all handlers in order to prevent parallel instantiation
+ */
+ static CMailCpsSettings* NewL( CFSMailClient& aMailClient );
+
+ /**
+ * Destructor.
+ */
+ virtual ~CMailCpsSettings();
+
+ /**
+ * Starts observing CenRep changes
+ * @param aObserver will be callbacked once changes occur
+ */
+ void StartObservingL( MMailCpsSettingsCallback* aObserver );
+
+ /**
+ * Stops observing CenRep changes
+ */
+ void StopObserving();
+
+ /**
+ * Gets array of mailboxes that should be published to widget
+ * @return array of mailboxes
+ */
+ RArray<TFSMailMsgId>& Mailboxes();
+
+ /**
+ * Gets array of external mailboxes from widget settings
+ * @param aAccounts on completion, contains the necessary information of
+ * external mailboxes that currently should have a widget
+ * transfers ownership of accounts to caller
+ */
+ void GetExtMailboxesL( RPointerArray<CMailExternalAccount>& aAccounts );
+
+ /**
+ * Adds mailbox to widget settings
+ * Method ensures that same mailbox is not added again, if it happens
+ * to exist already in the settings. If already exists, method simply returns without
+ * doing nothing.
+ * @param aMailbox Id of the mailbox to add to settings
+ */
+ void AddMailboxL( const TFSMailMsgId aMailbox );
+
+ /**
+ * Removes mailbox from widget settings
+ * @param aMailbox Id of the mailbox to remove from settings
+ */
+ void RemoveMailboxL( const TFSMailMsgId aMailbox );
+
+ /**
+ * Gets maximum row count
+ * @return maximum row count
+ */
+ TInt MaxRowCount();
+
+ /**
+ * Gets maximum mailbox count
+ * @return maximum mailbox count
+ */
+ TInt MaxMailboxCount();
+
+ /**
+ *
+ * @return
+ */
+ void AssociateWidgetToSetting( const TDesC& aContentId,
+ const TFSMailMsgId aMailbox );
+
+ /**
+ *
+ */
+ void DissociateWidgetFromSettingL( const TDesC& aContentId );
+
+ /**
+ *
+ */
+ void GetContentId( TInt aMailboxId, TInt aNext, TDes16& aValue );
+
+ /**
+ *
+ */
+ TInt WidgetCountByMailbox( TInt aMailboxId );
+
+ /**
+ *
+ */
+ TBool IsSelected( TInt aId );
+
+ /**
+ *
+ */
+ TUint GetMailboxUidByContentId( const TDesC& aContentId );
+
+ /**
+ *
+ */
+ TUint GetPluginUidByContentId( const TDesC& aContentId );
+
+ /**
+ * Gets a bitmasked configuration value (see cmailwidgetcenrepkeysinternal.h)
+ * @return bitmasked configuration value
+ */
+ TInt32 Configuration();
+
+ /**
+ * Return total number of all native mailboxes in the system
+ */
+ TInt TotalIntMailboxCount();
+
+
+ /**
+ *
+ */
+ TBool FindFromContentIdListL( const TDesC& aContentId );
+
+ /**
+ *
+ */
+ void AddToContentIdListL( const TDesC& aContentId );
+
+ /**
+ *
+ */
+ void RemoveFromContentIdListL( const TDesC& aContentId );
+
+ /**
+ *
+ */
+ void ToggleWidgetNewMailIconL( TBool aIconOn, const TFSMailMsgId& aMailBox );
+
+ /**
+ *
+ */
+ TBool GetNewMailStateL( const TFSMailMsgId& aMailBox, TInt aUnreadCount );
+
+ /**
+ * Find next free CenRep key to store setting.
+ * @param aContentId Id of widget instance
+ * @return true if account is associated to content id, false if not
+ */
+ TBool Associated( const TDesC& aContentId );
+
+ /**
+ * Callback from PSSubscriber about a PS key event
+ * @param aCategory defines the key category
+ * @param aKey defines the changed key
+ */
+ void HandlePropertyChangedL( const TUid& aCategory, TInt aKey );
+
+ /**
+ *
+ */
+ TBool BackupOrRestoreMode();
+
+protected:
+ /**
+ * From CActive
+ * Cancellation logic for the asynchronous request
+ *
+ * @since S60 v5.0
+ */
+ virtual void DoCancel();
+
+ /**
+ * From CActive
+ *
+ * @since S60 v5.0
+ */
+ virtual void RunL();
+
+private:
+ /**
+ * Constructor
+ * @param aMailClient reference to CFSMailClient class. Mailserver offers
+ * this for all handlers in order to prevent parallel instantiation
+ */
+ CMailCpsSettings( CFSMailClient& aMailClient );
+
+ void ConstructL();
+
+ /**
+ * Restarts observing after previous notification request was triggered
+ */
+ void StartObservingL();
+
+ /**
+ * Loads settings from CenRep
+ */
+ void LoadSettingsL();
+
+ /**
+ * Loads configuration data from CenRep
+ * (This data contains internal configuration data for publishing logic
+ * and should not be mixed with user modifiable settings)
+ */
+ void LoadConfigurationL();
+
+ /**
+ * Resolves mailbox based on mailbox id
+ * (mailbox id is stored in CenRep as integer)
+ *
+ * @param aMailboxId mailboxId from CenRep
+ * @param aMsg on completion, contains the mailbox Id in TFSMailMsgId format
+ * @return KErrNone if mailbox exists
+ * @return KErrNotFound if aValue points to non-existent mailbox
+ */
+ TInt ResolveMailbox( const TInt aMailboxId, TFSMailMsgId& aMsg );
+
+ /**
+ * Finds mailbox if plugin id is set - more efficient than Resolve mailbox
+ *
+ * @param aMsg mailbox both PluginId and Id is checked
+ * @return KErrNone if mailbox exists
+ * @return KErrNotFound aMsg.Id() points to non-existent mailbox
+ **/
+ TInt CheckMailboxExistence( TFSMailMsgId& aMsg );
+
+ /**
+ * Gets array of CenRep keys representing mailboxes configured to widget
+ * @param aKeys array of keys
+ */
+ void GetMailboxNonZeroKeysL( RArray<TUint32>& aKeys );
+
+ /**
+ * Gets all the external mailbox identifiers
+ * @param on completion, contains an array of cenrep keys that have an external
+ * account specified (i.e. not empty)
+ */
+ void GetExtMailboxNonZeroKeysL( RArray<TUint32>& aKeys );
+
+ /**
+ * Find next free CenRep key to store setting.
+ * @param aContentId Id of widget instance
+ */
+ TInt GetSettingToAssociate( const TDesC& aContentId );
+
+ /**
+ * Returns CMailExternalAccount::NewL() according to cenrep key aKey
+ * @param aKey
+ */
+ CMailExternalAccount* GetExtMailboxL( TInt aKey );
+
+private: // data
+ // reference to mailclient
+ CFSMailClient& iMailClient;
+ // pointer to central repository
+ CRepository* iCenRep;
+ // callback interface
+ MMailCpsSettingsCallback* iObserver;
+ // array of mailboxes
+ RArray<TFSMailMsgId> iMailboxArray;
+ // Internal configuration data
+ TInt32 iConfigData;
+ // large buffer for reading cenrep data
+ TBuf<KMaxFileName> iCenrepText;
+ // PubSub subsriber for notifying restore operation
+ CPSSubscriber* iBackupRestoreSubscriber;
+ // Indicates if restore operation is started
+ TBool iRestoreStarted;
+ // Indicates if backup operation is ongoing
+ TBool iBackupOngoing;
+ };
+
+#endif /*CMAILCPSSETTINGS_H_*/