|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #ifndef QMTMENGINE_SYMBIAN_H |
|
43 #define QMTMENGINE_SYMBIAN_H |
|
44 |
|
45 #include <QMap> |
|
46 #include <QSet> |
|
47 #include <QList> |
|
48 #include <QHash> |
|
49 |
|
50 #include <e32base.h> |
|
51 #include <msvapi.h> // MMsvSessionObserver |
|
52 #include "qmessagemanager.h" |
|
53 #include "qmessagestore_symbian_p.h" |
|
54 #include "qmessagefilter.h" |
|
55 #include "qmessagefilter_p.h" |
|
56 #include "qmessagefolderfilter.h" |
|
57 #include "qmessageservice.h" |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 class CRichText; |
|
63 class CCharFormatLayer; |
|
64 class CParaFormatLayer; |
|
65 class CMsvSession; |
|
66 class CClientMtmRegistry; |
|
67 class CSmsClientMtm; |
|
68 class CMmsClientMtm; |
|
69 class CSmtpClientMtm; |
|
70 class CImap4ClientMtm; |
|
71 class CPop3ClientMtm; |
|
72 class CMsvFindOperation; |
|
73 |
|
74 |
|
75 QTM_BEGIN_NAMESPACE |
|
76 class CMessagesFindOperation; |
|
77 class QMessageId; |
|
78 class QMessageAccount; |
|
79 |
|
80 struct MessageEvent |
|
81 { |
|
82 QMessageStorePrivate::NotificationType notificationType; |
|
83 TMsvId messageId; |
|
84 QMessageManager::NotificationFilterIdSet matchingFilters; |
|
85 bool unfiltered; |
|
86 }; |
|
87 |
|
88 struct MessageQueryInfo |
|
89 { |
|
90 int operationId; |
|
91 bool isQuery; |
|
92 QString body; |
|
93 QMessageDataComparator::MatchFlags matchFlags; |
|
94 QMessageFilter filter; |
|
95 QMessageSortOrder sortOrder; |
|
96 int offset; |
|
97 int limit; |
|
98 QMessageServicePrivate* privateService; |
|
99 CMessagesFindOperation* findOperation; |
|
100 int currentFilterListIndex; |
|
101 QMessageIdList ids; |
|
102 int count; |
|
103 }; |
|
104 |
|
105 class CMTMEngine : public CActive, public MMsvSessionObserver |
|
106 { |
|
107 public: |
|
108 enum MTMType |
|
109 { |
|
110 MTMTypeSMS, |
|
111 MTMTypeMMS, |
|
112 MTMTypeSMTP, |
|
113 MTMTypeIMAP, |
|
114 MTMTypePOP3 |
|
115 }; |
|
116 |
|
117 static CMTMEngine* instance(); |
|
118 |
|
119 CMTMEngine(); |
|
120 ~CMTMEngine(); |
|
121 |
|
122 QMessageAccountIdList queryAccounts(const QMessageAccountFilter &filter, const QMessageAccountSortOrder &sortOrder, uint limit, uint offset) const; |
|
123 int countAccounts(const QMessageAccountFilter &filter) const; |
|
124 QMessageAccount account(const QMessageAccountId &id) const; |
|
125 QMessageAccountId defaultAccount(QMessage::Type type) const; |
|
126 |
|
127 QMessageFolderIdList queryFolders(const QMessageFolderFilter &filter, const QMessageFolderSortOrder &sortOrder, uint limit, uint offset) const; |
|
128 int countFolders(const QMessageFolderFilter &filter) const; |
|
129 QMessageFolder folder(const QMessageFolderId &id) const; |
|
130 |
|
131 bool addMessage(QMessage *m); |
|
132 bool updateMessage(QMessage *m); |
|
133 bool removeMessage(const QMessageId &id, QMessageManager::RemovalOption option); |
|
134 bool removeMessages(const QMessageFilter &filter, QMessageManager::RemovalOption option); |
|
135 bool queryMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const; |
|
136 bool queryMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const; |
|
137 bool countMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter); |
|
138 bool showMessage(const QMessageId &id); |
|
139 bool composeMessage(const QMessage &message); |
|
140 |
|
141 QMessage message(const QMessageId& id) const; |
|
142 |
|
143 bool storeMMS(QMessage &message); |
|
144 bool sendMMS(QMessage &message); |
|
145 bool storeEmail(QMessage &message); |
|
146 bool sendEmail(QMessage &message); |
|
147 bool storeSMS(QMessage &message); |
|
148 bool sendSMS(QMessage &message); |
|
149 bool retrieve(const QMessageId &messageId, const QMessageContentContainerId& id); |
|
150 bool retrieveBody(const QMessageId& id); |
|
151 bool retrieveHeader(const QMessageId& id); |
|
152 bool exportUpdates(const QMessageAccountId &id); |
|
153 |
|
154 QByteArray attachmentContent(long int messageId, unsigned int attachmentId); |
|
155 QString attachmentTextContent(long int messageId, unsigned int attachmentId, const QByteArray &charset); |
|
156 |
|
157 QMessageManager::NotificationFilterId registerNotificationFilter(QMessageStorePrivate& aPrivateStore, |
|
158 const QMessageFilter& filter); |
|
159 void unregisterNotificationFilter(QMessageManager::NotificationFilterId notificationFilterId); |
|
160 |
|
161 void notification(TMsvSessionEvent aEvent, TUid aMsgType, TMsvId aFolderId, TMsvId aMessageId); |
|
162 void filterAndOrderMessagesReady(bool success, int operationId, QMessageIdList ids, int numberOfHandledFilters, |
|
163 bool resultSetOrdered); |
|
164 |
|
165 inline RFs& FsSession() const { return((RFs&)iFsSession); } |
|
166 private: |
|
167 void updateEmailAccountsL() const; |
|
168 bool switchToMTMRootEntry(MTMType aMTMType); |
|
169 TMsvId mtmServiceEntryIdL(MTMType aMTMType) const; |
|
170 CBaseMtm* mtmByType(MTMType aMTMType); |
|
171 CBaseMtm* mtmByUid(TUid aMTMUid); |
|
172 TUid mtmUidByType(MTMType aMTMType); |
|
173 TMsvId standardFolderId(QMessage::StandardFolder standardFolder); |
|
174 |
|
175 QMessageFolderIdList allFolders() const; |
|
176 QMessageFolderIdList folderIdsByAccountId(const QMessageAccountId& accountId) const; |
|
177 QMessageFolderIdList folderIdsByServiceEntryId(const TMsvId& serviceEntryId, const TMsvId& folderServiceEntryId) const; |
|
178 QMessageFolderId createQMessageFolderId(const TMsvId& serviceEntryId, const TMsvId& folderId) const; |
|
179 TMsvId serviceEntryIdFromQMessageFolderId(const QMessageFolderId& folderId) const; |
|
180 TMsvId folderIdFromQMessageFolderId(const QMessageFolderId& folderId) const; |
|
181 |
|
182 QMessageAccountIdList accountsByType(QMessage::Type type) const; |
|
183 QMessageAccountId accountIdByServiceId(TMsvId serviceId) const; |
|
184 |
|
185 QMessageFolder folderL(const QMessageFolderId &id) const; |
|
186 |
|
187 static bool accountLessThan(const QMessageAccountId accountId1, const QMessageAccountId accountId2); |
|
188 void orderAccounts(QMessageAccountIdList& accountIds, const QMessageAccountSortOrder &sortOrder) const; |
|
189 void applyOffsetAndLimitToAccountIds(QMessageAccountIdList& idList, int offset, int limit) const; |
|
190 static bool folderLessThan(const QMessageFolderId folderId1, const QMessageFolderId folderId2); |
|
191 void orderFolders(QMessageFolderIdList& folderIds, const QMessageFolderSortOrder &sortOrder) const; |
|
192 static bool messageLessThan(const QMessage& message1, const QMessage& message2); |
|
193 void orderMessages(QMessageIdList& messageIds, const QMessageSortOrder &sortOrder) const; |
|
194 |
|
195 void handleNestedFiltersFromFolderFilter(QMessageFolderFilter &filter) const; |
|
196 void handleNestedFiltersFromMessageFilter(QMessageFilter &filter) const; |
|
197 |
|
198 void queryMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const; |
|
199 void queryMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const; |
|
200 void countMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter); |
|
201 void applyOffsetAndLimitToMsgIds(QMessageIdList& idList, int offset, int limit) const; |
|
202 |
|
203 QMessageFolderIdList filterMessageFolders(const QMessageFolderFilter& filter, bool& filterHandled) const; |
|
204 QMessageFolderIdList filterMessageFoldersL(const QMessageFolderFilter& filter, bool& filterHandled) const; |
|
205 void applyOffsetAndLimitToMsgFolderIds(QMessageFolderIdList& idList, int offset, int limit) const; |
|
206 |
|
207 bool removeMessageL(const QMessageId &id, QMessageManager::RemovalOption option); |
|
208 void copyMessageL(TMsvId aMessageId, TMsvId aFolder); |
|
209 QMessage messageL(const QMessageId& id) const; |
|
210 QMessage smsMessageL(CMsvEntry& receivedEntry, long int messageId) const; |
|
211 QMessage mmsMessageL(CMsvEntry& receivedEntry, long int messageId) const; |
|
212 QMessage emailMessageL(CMsvEntry& receivedEntry, long int messageId) const; |
|
213 QMessage pop3MessageL(CMsvEntry& receivedEntry, long int messageId) const; |
|
214 QMessage imap4MessageL(CMsvEntry& receivedEntry, long int messageId) const; |
|
215 bool composeSMSL(const QMessage &message); |
|
216 bool composeMMSL(const QMessage &message); |
|
217 bool composeEmailL(const QMessage &message); |
|
218 void tryToDeliverMessageNotifications(); |
|
219 void updateMMSL(QMessage &message); |
|
220 void updateSMSL(QMessage &message); |
|
221 void updateEmailL(QMessage &message); |
|
222 void showMessageL(const QMessageId &id); |
|
223 |
|
224 void storeMMSL(QMessage &message); |
|
225 void sendMMSL(QMessage &message); |
|
226 void storeEmailL(QMessage &message); |
|
227 void sendEmailL(QMessage &message); |
|
228 void storeSMSL(QMessage &message); |
|
229 void sendSMSL(QMessage &message); |
|
230 void retrieveL(const QMessageId &messageId, const QMessageContentContainerId& id); |
|
231 void retrieveBodyL(const QMessageId& id) const; |
|
232 void retrieveHeaderL(const QMessageId& id) const; |
|
233 void exportUpdatesL(const QMessageAccountId &id) const; |
|
234 void appendAttachmentToMessage(QMessage& message, QMessageContentContainer& attachment) const; |
|
235 QByteArray attachmentContentL(long int messageId, unsigned int attachmentId); |
|
236 |
|
237 QString privateFolderPath(); |
|
238 |
|
239 QDateTime symbianTTimetoQDateTime(const TTime& time) const; |
|
240 TTime qDateTimeToSymbianTTime(const QDateTime& date) const; |
|
241 |
|
242 static void cmsvEntryCleanup(TAny* aCMsvEntry); |
|
243 CMsvEntry* retrieveCMsvEntryAndPushToCleanupStack(TMsvId id = 0) const; |
|
244 void releaseCMsvEntryAndPopFromCleanupStack(CMsvEntry* pEntry) const; |
|
245 |
|
246 private: // from CActive |
|
247 void RunL(); |
|
248 void DoCancel(); |
|
249 |
|
250 private: //from MMsvSessionObserver: |
|
251 void HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1, |
|
252 TAny* aArg2, TAny* aArg3); |
|
253 |
|
254 private: |
|
255 RFs iFsSession; |
|
256 QMessageStorePrivate* ipMessageStorePrivate; |
|
257 |
|
258 bool iSessionReady; |
|
259 bool iListenForNotifications; |
|
260 |
|
261 mutable CRichText* ipRichText; |
|
262 mutable CCharFormatLayer* ipCharFormatLayer; |
|
263 mutable CParaFormatLayer* ipParaFormatLayer; |
|
264 |
|
265 MTMType iMTMType; |
|
266 |
|
267 CMsvSession* ipMsvSession; |
|
268 CClientMtmRegistry* ipClientMtmReg; |
|
269 CSmsClientMtm* ipSmsMtm; |
|
270 CMmsClientMtm* ipMmsMtm; |
|
271 CSmtpClientMtm* ipSmtpMtm; |
|
272 CImap4ClientMtm* ipImap4Mtm; |
|
273 CPop3ClientMtm* ipPop3Mtm; |
|
274 TBuf<KMaxPath> iPath; |
|
275 |
|
276 QString iSMSAccountidAsString; |
|
277 QString iMMSAccountidAsString; |
|
278 |
|
279 mutable RPointerArray<CMsvEntry> iCmsvEntryPoolFree; |
|
280 mutable RPointerArray<CMsvEntry> iCmsvEntryPoolInUse; |
|
281 |
|
282 CMsvFindOperation* ipFindOperation; |
|
283 |
|
284 QMessageManager::NotificationFilterId _filterId; |
|
285 QMap<QMessageManager::NotificationFilterId, QMessageFilter> _filters; |
|
286 |
|
287 mutable QHash<QString, QMessageAccount> iAccounts; |
|
288 mutable QMessageAccountId idefaultEmailAccountId; |
|
289 |
|
290 int iDeliveryTriesCounter; |
|
291 QList<MessageEvent> iUndeliveredMessageEvents; |
|
292 RTimer iTimer; // Timer used for delaying delivering of received |
|
293 // messages until messages are ready to be read |
|
294 |
|
295 mutable int iOperationIds; |
|
296 mutable QList<MessageQueryInfo> iMessageQueries; |
|
297 |
|
298 mutable QMessageAccountSortOrder iCurrentAccountOrdering; |
|
299 mutable QMessageFolderSortOrder iCurrentFolderOrdering; |
|
300 mutable QMessageSortOrder iCurrentMessageOrdering; |
|
301 |
|
302 friend class QMessageService; |
|
303 friend class CMessagesFindOperation; |
|
304 }; |
|
305 |
|
306 class CMessagesFindOperation : public CActive |
|
307 { |
|
308 public: |
|
309 CMessagesFindOperation(CMTMEngine& aOwner, CMsvSession* apMsvSession, int aOperationId); |
|
310 ~CMessagesFindOperation(); |
|
311 |
|
312 void filterAndOrderMessages(const QMessageFilter& filter, |
|
313 const QMessageSortOrder& sortOrder, |
|
314 const QString body = QString(), |
|
315 QMessageDataComparator::MatchFlags matchFlags = 0); |
|
316 void filterAndOrderMessages(const QMessageFilterPrivate::SortedMessageFilterList& filters, |
|
317 const QMessageSortOrder& sortOrder, |
|
318 const QString body = QString(), |
|
319 QMessageDataComparator::MatchFlags matchFlags = 0); |
|
320 |
|
321 protected: // From CActive |
|
322 void RunL(); |
|
323 void DoCancel(); |
|
324 |
|
325 private: |
|
326 void getAllMessagesL(const TMsvSelectionOrdering sortOrder = TMsvSelectionOrdering()); |
|
327 void getAccountSpecificMessagesL(QMessageAccount& messageAccount, const TMsvSelectionOrdering sortOrder, QMessageFilterPrivate* privateFolderFilter = NULL); |
|
328 void getServiceSpecificMessagesL(TMsvId serviceId, const TMsvSelectionOrdering sortOrder, QMessageFilterPrivate* privateFolderFilter = NULL); |
|
329 void getServiceSpecificMessagesFromFolderL(TMsvId serviceId, const TMsvSelectionOrdering sortOrder, TMsvId standardFolderId = NULL); |
|
330 |
|
331 private: // Data |
|
332 CMTMEngine& iOwner; |
|
333 CMsvSession* ipMsvSession; |
|
334 |
|
335 int iNumberOfHandledFilters; |
|
336 int iOperationId; |
|
337 TMsvSelectionOrdering iOrdering; |
|
338 bool iResultCorrectlyOrdered; |
|
339 QMessageIdList iIdList; |
|
340 QMessageFilterPrivate::SortedMessageFilterList iFilterList; |
|
341 |
|
342 CMsvEntrySelection* ipEntrySelection; |
|
343 CMsvFindOperation* ipMsvFindOperation; |
|
344 |
|
345 mutable RTimer iTimer; |
|
346 }; |
|
347 |
|
348 |
|
349 QTM_END_NAMESPACE |
|
350 #endif // QMTMENGINE_SYMBIAN_H |