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 QFSENGINE_SYMBIAN_H

    43 #define QFSENGINE_SYMBIAN_H

    44 

    45 #include <qmessageglobal.h>

    46 #include <QObject>

    47 #include <QMap>

    48 #include <QSet>

    49 #include <QList>

    50 #include <QHash>

    51 

    52 #include <e32base.h>

    53 

    54 #include "qmessagemanager.h"

    55 #include "qmessagestore_symbian_p.h"

    56 #include "qmessagefilter.h"

    57 #include "qmessagefilter_p.h"

    58 #include "qmessagefolderfilter.h"

    59 #include "qmessageservice.h"

    60 #include <emailinterfacefactory.h>

    61 #include <memailclientapi.h>

    62 #include <memailmessagesearch.h>

    63 #include <memailmessage.h>

    64 #include <emailinterfacefactory.h>

    65 #include <emailsorting.h>

    66 #include <memailmessagesearch.h>

    67 #include <memailfolder.h>

    68 #include <mmailboxsyncobserver.h>

    69 #ifdef FREESTYLEMAILBOXOBSERVERUSED

    70 #include <mmailboxcontentobserver.h>

    71 #endif

    72 

    73 using namespace EmailInterface;

    74 

    75 QTM_BEGIN_NAMESPACE

    76 

    77 class CFSMessagesFindOperation;

    78 class QMessageId;

    79 class QMessageAccount;

    80 

    81 struct FSMessageQueryInfo

    82 {

    83     int operationId;

    84     bool isQuery;

    85     QString body;

    86     QMessageDataComparator::MatchFlags matchFlags;

    87     QMessageFilter filter;

    88     QMessageSortOrder sortOrder;

    89     int offset;

    90     int limit;

    91     QMessageServicePrivate* privateService;

    92     CFSMessagesFindOperation* findOperation;

    93     int currentFilterListIndex;

    94     QMessageIdList ids;

    95     int count;

    96 };

    97 

    98 struct FSSearchOperation

    99 {

   100     MEmailMailbox* m_mailbox;

   101     MEmailMessageSearchAsync* m_search;

   102 };

   103 

   104 #ifdef FREESTYLEMAILBOXOBSERVERUSED

   105 class CFSEngine : public QObject, public MMailboxContentObserver, public MMailboxSyncObserver, public MEmailFetchObserver

   106 #else

   107 class CFSEngine : public QObject, public MMailboxSyncObserver, public MEmailFetchObserver

   108 #endif

   109 {

   110     Q_OBJECT

   111 

   112 public: 

   113     

   114     static CFSEngine* instance();

   115 

   116     CFSEngine();

   117     ~CFSEngine();

   118     

   119     QMessageAccountIdList queryAccounts(const QMessageAccountFilter &filter, const QMessageAccountSortOrder &sortOrder, uint limit, uint offset) const;

   120     int countAccounts(const QMessageAccountFilter &filter) const;

   121     QMessageAccount account(const QMessageAccountId &id) const;

   122     QMessageAccountId defaultAccount(QMessage::Type type) const;

   123     

   124     QMessageFolderIdList queryFolders(const QMessageFolderFilter &filter, const QMessageFolderSortOrder &sortOrder, uint limit, uint offset) const;

   125     int countFolders(const QMessageFolderFilter &filter) const;

   126     QMessageFolder folder(const QMessageFolderId &id) const;

   127     

   128     bool addMessage(QMessage *m);

   129     bool updateMessage(QMessage *m);

   130     bool removeMessage(const QMessageId &id, QMessageManager::RemovalOption option);

   131     bool removeMessages(const QMessageFilter &filter, QMessageManager::RemovalOption option);

   132     bool queryMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const;

   133     bool queryMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const;

   134     bool countMessages(QMessageServicePrivate& privateService, const QMessageFilter &filter);

   135     bool showMessage(const QMessageId &id);

   136     bool composeMessage(const QMessage &message);   

   137     QMessage message(const QMessageId& id) const;

   138     bool sendEmail(QMessage &message);

   139    

   140     bool retrieve(QMessageServicePrivate& privateService, const QMessageId &messageId, const QMessageContentContainerId& id);

   141     bool retrieveBody(QMessageServicePrivate& privateService, const QMessageId& id);

   142     bool retrieveHeader(QMessageServicePrivate& privateService, const QMessageId& id);

   143     bool exportUpdates(const QMessageAccountId &id);

   144     

   145     QMessageManager::NotificationFilterId registerNotificationFilter(QMessageStorePrivate& aPrivateStore,

   146                                         const QMessageFilter& filter, QMessageManager::NotificationFilterId aId);

   147     void unregisterNotificationFilter(QMessageManager::NotificationFilterId notificationFilterId);

   148 

   149     void filterAndOrderMessagesReady(bool success, int operationId, QMessageIdList ids, int numberOfHandledFilters,

   150                                      bool resultSetOrdered);

   151     

   152     void setMtmAccountIdList(QMessageAccountIdList accountList);

   153     

   154 public: // from MMailboxSyncObserver

   155     void MailboxSynchronisedL(TInt aResult);

   156     

   157 #ifdef FREESTYLEMAILBOXOBSERVERUSED

   158     void setPluginObserversL();

   159     

   160 public:

   161         // from MMailboxContentObserver

   162     void NewMessageEventL(const TMailboxId& aMailbox, const REmailMessageIdArray aNewMessages, const TFolderId& aParentFolderId);

   163     void MessageChangedEventL(const TMailboxId& aMailbox, const REmailMessageIdArray aChangedMessages, const TFolderId& aParentFolderId);

   164     void MessageDeletedEventL(const TMailboxId& aMailbox, const REmailMessageIdArray aDeletedMessages, const TFolderId& aParentFolderId);       

   165 #endif

   166     

   167 public: // From MEmailFetchObserver

   168     virtual void DataFetchedL(const TInt aResult);

   169 

   170 public slots:

   171     void cleanupFSBackend();

   172 

   173 private:

   174 

   175     void queryMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const;

   176     void queryMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const;

   177     void countMessagesL(QMessageServicePrivate& privateService, const QMessageFilter &filter);

   178     

   179     QMessageAccountIdList accountsByType(QMessage::Type type) const;

   180     void updateEmailAccountsL() const;

   181     void updateMessageL(QMessage* message);

   182     MEmailMessage* createFSMessageL(const QMessage &message, const MEmailMailbox* mailbox);

   183     QMessageFolderIdList folderIdsByAccountId(const QMessageAccountId& accountId) const;

   184     QMessageFolderIdList folderIdsByAccountIdL(const QMessageAccountId& accountId) const;

   185     QMessageFolderIdList filterMessageFoldersL(const QMessageFolderFilter& filter, bool& filterHandled) const;

   186     QMessageFolderIdList allFolders() const;

   187     QMessageFolder folderL(const QMessageFolderId &id) const;

   188     bool fsFolderL(const QMessageFolderId& id, MEmailMailbox* mailbox, MEmailFolder* folder) const;

   189     TFolderType standardFolderId(QMessage::StandardFolder standardFolder);

   190     

   191     QMessageFolderIdList filterMessageFolders(const QMessageFolderFilter& filter, bool& filterHandled) const;

   192     QMessage CreateQMessageL(MEmailMessage* aMessage) const; 

   193     void AddContentToMessage(MEmailMessageContent* aContent, QMessage* aMessage) const;

   194     void addAttachmentToMessage(QMessage& message, QMessageContentContainer& attachment) const;

   195     QDateTime symbianTTimetoQDateTime(const TTime& time) const;

   196     TTime qDateTimeToSymbianTTime(const QDateTime& date) const;

   197     

   198     QMessage messageL(const QMessageId& id) const;

   199     static bool accountLessThan(const QMessageAccountId accountId1, const QMessageAccountId accountId2);

   200     void orderAccounts(QMessageAccountIdList& accountIds,  const QMessageAccountSortOrder &sortOrder) const;

   201     void applyOffsetAndLimitToAccountIds(QMessageAccountIdList& idList, int offset, int limit) const;

   202     

   203     static bool folderLessThan(const QMessageFolderId folderId1, const QMessageFolderId folderId2);

   204     void orderFolders(QMessageFolderIdList& folderIds,  const QMessageFolderSortOrder &sortOrder) const;

   205     void applyOffsetAndLimitToMsgFolderIds(QMessageFolderIdList& idList, int offset, int limit) const;

   206     void handleNestedFiltersFromFolderFilter(QMessageFolderFilter &filter) const;

   207 

   208     static bool messageLessThan(const QMessage& message1, const QMessage& message2);

   209     void orderMessages(QMessageIdList& messageIds,  const QMessageSortOrder &sortOrder) const;

   210     void applyOffsetAndLimitToMsgIds(QMessageIdList& idList, int offset, int limit) const;

   211 

   212     void handleNestedFiltersFromMessageFilter(QMessageFilter &filter) const;

   213     void exportUpdatesL(const QMessageAccountId &id);

   214     

   215     void retrieveTotalBodyL(MEmailMessageContent* aContent);

   216     void retrieveAttachmentsL(MEmailMessage* aMessage);

   217 

   218 #ifdef FREESTYLEMAILBOXOBSERVERUSED

   219     void notificationL(const TMailboxId& aMailbox, const TMessageId& aMessageId, 

   220                         const TFolderId& aParentFolderId, QMessageStorePrivate::NotificationType aNotificationType);

   221 #endif

   222     

   223     friend class QMessageService;

   224     friend class CMessagesFindOperation;

   225     

   226 private:

   227 

   228     CEmailInterfaceFactory* m_factory;

   229     mutable MEmailInterface* m_ifPtr;

   230     mutable MEmailClientApi* m_clientApi;

   231     mutable QHash<QString, QMessageAccount> m_accounts;

   232     mutable int m_operationIds;

   233     mutable QList<FSMessageQueryInfo> m_messageQueries;

   234     QMessageAccountIdList m_mtmAccountList;

   235     TMailboxId m_mailboxId;

   236     QMessageStorePrivate* ipMessageStorePrivate;

   237     bool iListenForNotifications;

   238     QMessageManager::NotificationFilterId m_filterId;

   239     QMap<QMessageManager::NotificationFilterId, QMessageFilter> m_filters;

   240     QMessageAccount m_account;

   241     RMailboxPtrArray m_mailboxes;

   242     REmailAttachmentArray m_attachments;

   243     QMessageServicePrivate* m_privateService;

   244     friend class QMessageService;

   245     friend class CFSMessagesFindOperation;

   246     

   247     mutable QMessageAccountSortOrder m_currentAccountOrdering;

   248     mutable QMessageFolderSortOrder m_currentFolderOrdering;

   249     mutable QMessageSortOrder m_currentMessageOrdering;

   250 

   251 

   252 };

   253 

   254 class CFSMessagesFindOperation : public QObject, MEmailSearchObserver

   255 {

   256     Q_OBJECT

   257     

   258 public:

   259     CFSMessagesFindOperation(CFSEngine& aOwner, int aOperationId); 

   260     ~CFSMessagesFindOperation();

   261 

   262     void filterAndOrderMessages(const QMessageFilter& filter,

   263                                 const QMessageSortOrder& sortOrder,

   264                                 const QString body = QString(),

   265                                 QMessageDataComparator::MatchFlags matchFlags = 0);

   266     void filterAndOrderMessages(const QMessageFilterPrivate::SortedMessageFilterList& filters,

   267                                 const QMessageSortOrder& sortOrder,

   268                                 const QString body = QString(),

   269                                 QMessageDataComparator::MatchFlags matchFlags = 0);

   270 

   271     enum Field {None = 0, Sender, Recipients, Subject, Body};

   272 

   273     

   274 public slots:

   275     void SearchCompleted();

   276 

   277 private:

   278     // from memailmessagesearch

   279     virtual void HandleResultL(MEmailMessage* aMessage);

   280     virtual void SearchCompletedL();

   281 

   282     void filterAndOrderMessagesL(const QMessageFilterPrivate::SortedMessageFilterList& filters,

   283                                 const QMessageSortOrder& sortOrder,

   284                                 const QString body = QString(),

   285                                 QMessageDataComparator::MatchFlags matchFlags = 0);

   286     

   287     void getAllMessagesL(TEmailSortCriteria& sortCriteria);

   288     void getAccountSpecificMessagesL(QMessageAccount& messageAccount, TEmailSortCriteria& sortCriteria);

   289     void getFolderSpecificMessagesL(QMessageFolder& messageFolder, TEmailSortCriteria sortCriteria);

   290     

   291     bool fillsSearchKeyCriteria(QMessageId& messageId);

   292 

   293     

   294 private: // Data

   295     CFSEngine& m_owner;

   296     

   297     int m_numberOfHandledFilters;

   298     int m_operationId;

   299     int m_activeSearchCount;

   300     //TMsvSelectionOrdering iOrdering;

   301     bool m_resultCorrectlyOrdered;

   302     QMessageIdList m_idList;

   303     QMessageFilterPrivate::SortedMessageFilterList m_filterList;

   304     QMessageIdList m_excludeIdList;

   305 

   306     MEmailClientApi* m_clientApi;

   307     

   308     CEmailInterfaceFactory* m_factory; 

   309     MEmailInterface* m_interfacePtr; 

   310     bool m_receiveNewMessages;

   311     QList<FSSearchOperation> m_searchOperations;

   312     

   313     Field m_searchField;

   314     QMessageDataComparator::MatchFlags m_matchFlags;

   315     QString m_searchKey;

   316 };

   317 

   318 

   319 QTM_END_NAMESPACE

   320 

   321 #endif // QFSENGINE_SYMBIAN_H