64
|
1 |
/*
|
|
2 |
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: Predictive Search MRU ADapter
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef C_PS_MRU_ADAPTER_H
|
|
20 |
#define C_PS_MRU_ADAPTER_H
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include <CPsDataPlugin.h>
|
|
24 |
//<cmail>
|
|
25 |
#include "mfsmaileventobserver.h"
|
|
26 |
//</cmail>
|
|
27 |
|
|
28 |
// FORWARD DECLARATION
|
|
29 |
class CPsData;
|
|
30 |
class CFSMailClient;
|
|
31 |
class MDesCArray;
|
|
32 |
|
|
33 |
class CDelayMailboxCreationHelper;
|
|
34 |
// CLASS DECLARATION
|
|
35 |
|
|
36 |
/**
|
|
37 |
* MRU Data Store
|
|
38 |
* This class acts as a MRU Data store, which allows access to
|
|
39 |
* FS Email Framework MRU data
|
|
40 |
*
|
|
41 |
* @since S60 v3.2
|
|
42 |
*/
|
|
43 |
class CPsMruAdapter : public CPsDataPlugin, public MFSMailEventObserver
|
|
44 |
{
|
|
45 |
public:
|
|
46 |
|
|
47 |
/**
|
|
48 |
* Two phase construction
|
|
49 |
*/
|
|
50 |
static CPsMruAdapter* NewL(TAny* aPsDataPluginParameters);
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Destructor
|
|
54 |
*/
|
|
55 |
virtual ~CPsMruAdapter();
|
|
56 |
|
|
57 |
/**
|
|
58 |
* Returns the additional data for given item id
|
|
59 |
* Returns NULL (in current implementation)
|
|
60 |
*/
|
|
61 |
TAny* RequestForDataExtensionL( TInt ItemId );
|
|
62 |
|
|
63 |
// from base class CPsDataPlugin
|
|
64 |
|
|
65 |
/**
|
|
66 |
* Requests for data from this store
|
|
67 |
* The adapters need to pass an instance of the observer. The data
|
|
68 |
* to the algorithm is provided via the observer callback
|
|
69 |
*/
|
|
70 |
void RequestForDataL( TDesC& aDataStoreURI );
|
|
71 |
|
|
72 |
/**
|
|
73 |
* Gets the supported data stores URIs
|
|
74 |
*
|
|
75 |
* @param aDataStores supported data stores URIs
|
|
76 |
*/
|
|
77 |
void GetSupportedDataStoresL( RPointerArray<TDesC>& aDataStoresURIs );
|
|
78 |
|
|
79 |
/**
|
|
80 |
* Checks if the given data store is supported.
|
|
81 |
*
|
|
82 |
* @param aDataStoreURI data store
|
|
83 |
* @return True if this store is supported
|
|
84 |
*/
|
|
85 |
TBool IsDataStoresSupportedL( TDesC& aDataStoreURI ) ;
|
|
86 |
|
|
87 |
/**
|
|
88 |
* Gets the supported data fields for specific stores URIs
|
|
89 |
*
|
|
90 |
* @param aDataFields supported data fields for aStoreURI
|
|
91 |
*/
|
|
92 |
void GetSupportedDataFieldsL( RArray<TInt>& aDataFields );
|
|
93 |
|
|
94 |
// from base class MFSMailEventObserver
|
|
95 |
|
|
96 |
/**
|
|
97 |
* Handles mailbox events from plugins.
|
|
98 |
*/
|
|
99 |
void EventL( TFSMailEvent aEvent, TFSMailMsgId aMailbox,
|
|
100 |
TAny* aParam1, TAny* aParam2, TAny* aParam3 );
|
|
101 |
|
|
102 |
/**
|
|
103 |
* If problem with NewMailbox this function will be called
|
|
104 |
* by CDelayMailboxCreationHelper to try it after some delay
|
|
105 |
*/
|
|
106 |
TBool DeleayedMailboxCreationEventL();
|
|
107 |
|
|
108 |
/**
|
|
109 |
* If problem with NewMailbox this function will be called
|
|
110 |
* by CDelayMailboxCreationHelper to try it after some delay
|
|
111 |
*/
|
|
112 |
void DeleayMailboxCreationEventL( TFSMailMsgId &aMailbox );
|
|
113 |
|
|
114 |
private:
|
|
115 |
|
|
116 |
/**
|
|
117 |
* Constructor
|
|
118 |
*/
|
|
119 |
CPsMruAdapter();
|
|
120 |
|
|
121 |
/**
|
|
122 |
* 2nd phase construtor
|
|
123 |
*/
|
|
124 |
void ConstructL(MDataStoreObserver* aObserverForDataStore,
|
|
125 |
MStoreListObserver* aStoreListObserver);
|
|
126 |
|
|
127 |
/**
|
|
128 |
* Updates given data store
|
|
129 |
*/
|
|
130 |
TBool FillDataStoreL( TDesC& aDataStoreURI );
|
|
131 |
|
|
132 |
/**
|
|
133 |
* Updates given data store
|
|
134 |
*/
|
|
135 |
TBool FillDataStoreL( TFSMailMsgId& aId );
|
|
136 |
|
|
137 |
/**
|
|
138 |
* Updates a list of supported data stores
|
|
139 |
*/
|
|
140 |
void UpdateSupportedDataStoresList();
|
|
141 |
|
|
142 |
/**
|
|
143 |
* Starts observing mailbox
|
|
144 |
*/
|
|
145 |
TBool AddMailboxObserverL( TFSMailMsgId& aId );
|
|
146 |
|
|
147 |
/**
|
|
148 |
* Stops observing mailbox
|
|
149 |
*/
|
|
150 |
TBool RemoveMailboxObserver( TFSMailMsgId& aId );
|
|
151 |
|
|
152 |
/**
|
|
153 |
* Stops all mailbox observers
|
|
154 |
*/
|
|
155 |
void RemoveAllMailboxObservers();
|
|
156 |
|
|
157 |
/**
|
|
158 |
* Converts Uri to TFsMailMsgId
|
|
159 |
*/
|
|
160 |
TBool GetMailboxIdentifierFromUri( TDesC& aUri, TFSMailMsgId& aId );
|
|
161 |
|
|
162 |
/**
|
|
163 |
* Converts TFsMailMsgId to Uri
|
|
164 |
*/
|
|
165 |
TBool GetUriFromMailboxIdentifier( TFSMailMsgId& aId, HBufC& aUri );
|
|
166 |
|
|
167 |
/**
|
|
168 |
* Updates given data store
|
|
169 |
*/
|
|
170 |
TBool FillDataStoreL( TFSMailMsgId& aId, TDesC& aDataStoreURI );
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Calls MDataStoreObserver::AddData for every mru email - used for trapping
|
|
174 |
*/
|
|
175 |
void AddMruEmailsL( MDesCArray* aMruList, TDesC& aDataStoreURI );
|
|
176 |
|
|
177 |
private: // data
|
|
178 |
|
|
179 |
/**
|
|
180 |
* Holds the observer object to communicate add/modify/delete of contacts
|
|
181 |
* Not owned.
|
|
182 |
*/
|
|
183 |
MDataStoreObserver* iDataStoreObserver;
|
|
184 |
|
|
185 |
/**
|
|
186 |
* An observer instance used to send the datastore to the adapter
|
|
187 |
*/
|
|
188 |
MStoreListObserver* iStoreListObserver;
|
|
189 |
|
|
190 |
/**
|
|
191 |
* Supported Uris(data stores)
|
|
192 |
*/
|
|
193 |
RPointerArray<HBufC> iSupportedUris;
|
|
194 |
|
|
195 |
/**
|
|
196 |
* List of mailboxes currently being observed
|
|
197 |
*/
|
|
198 |
RArray<TFSMailMsgId> iObservedMailboxes;
|
|
199 |
|
|
200 |
/**
|
|
201 |
* Fs Email framework client
|
|
202 |
*/
|
|
203 |
CFSMailClient* iMailClient;
|
|
204 |
|
|
205 |
/**
|
|
206 |
* Class for postponing the mailbox creation in MRU list - Event may come beforet the mailbox exists
|
|
207 |
*/
|
|
208 |
CDelayMailboxCreationHelper *iDelayMailboxCreationPtr;
|
|
209 |
|
|
210 |
/**
|
|
211 |
* This mailboxes should be handled by CDelayMailboxCreationHelper
|
|
212 |
*/
|
|
213 |
RArray<TFSMailMsgId> iDelayedCreatedMailboxes;
|
|
214 |
|
|
215 |
TFSMailMsgId iPreviousMailboxId;
|
|
216 |
TFSMailMsgId iPreviousParentFolderId; // not owned
|
|
217 |
/* folder type for a mailbox referenced by iPreviousMailbox and iPreviousParentFolderId */
|
|
218 |
TFSFolderType iPreviousParentFolderType;
|
|
219 |
}; // class CPsMruAdapter
|
|
220 |
|
|
221 |
//-----------------------------------------------------------------------------
|
|
222 |
//-----------------------------------------------------------------------------
|
|
223 |
|
|
224 |
|
|
225 |
// Helper class for thread synchronization
|
|
226 |
// used when mailbox is not ready when TFSEventNewMailbox event comes
|
|
227 |
// Waits 30*0.5 sec to try posponed mailbox registration
|
|
228 |
|
|
229 |
// wait 500 ms to try adding the mailbox - because sync problems
|
|
230 |
#define KDelayToRunAddMailbox 500
|
|
231 |
// try it 15 second - 30 times
|
|
232 |
#define KNumberOfDelayedTrials 30
|
|
233 |
|
|
234 |
|
|
235 |
class CDelayMailboxCreationHelper : public CTimer
|
|
236 |
{
|
|
237 |
public:
|
|
238 |
static CDelayMailboxCreationHelper* NewLC( CPsMruAdapter *aPsMruAdapterPtr );
|
|
239 |
static CDelayMailboxCreationHelper* NewL( CPsMruAdapter *aPsMruAdapterPtr );
|
|
240 |
// d-tor
|
|
241 |
virtual ~CDelayMailboxCreationHelper();
|
|
242 |
// Start timer to call CPsMruAdapter::DeleayedMailboxCreationEventL by RunL
|
|
243 |
void StartDelayedCall();
|
|
244 |
protected:
|
|
245 |
// on timer event - calls CPsMruAdapter::DeleayedMailboxCreationEventL
|
|
246 |
virtual void RunL();
|
|
247 |
// when leave from RunL, if err handled return KErrNone
|
|
248 |
TInt RunError( TInt aError );
|
|
249 |
// two phase constr.
|
|
250 |
void ConstructL();
|
|
251 |
private:
|
|
252 |
CDelayMailboxCreationHelper( CPsMruAdapter *aPsMruAdapterPtr ); // EPriorityLow, EPriorityIdle
|
|
253 |
// callback not owning pointer assigned during construction
|
|
254 |
CPsMruAdapter *iPsMruAdapterPtr;
|
|
255 |
// unsuccessful calls still allowed counter
|
|
256 |
TInt iNumberOfDelayedTrials;
|
|
257 |
}; // class CDelayMailboxCreationHelper
|
|
258 |
|
|
259 |
#endif // C_PS_MRU_ADAPTER_H
|