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 MMailboxContentObserver, public MMailboxSyncObserver, public MEmailFetchObserver

   106 #else

   107 class CFSEngine : public MMailboxSyncObserver, public MEmailFetchObserver

   108 #endif

   109 {

   110 public: 

   111     

   112     static CFSEngine* instance();

   113 

   114     CFSEngine();

   115     ~CFSEngine();

   116     

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

   118     int countAccounts(const QMessageAccountFilter &filter) const;

   119     QMessageAccount account(const QMessageAccountId &id) const;

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

   121     

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

   123     int countFolders(const QMessageFolderFilter &filter) const;

   124     QMessageFolder folder(const QMessageFolderId &id) const;

   125     

   126     bool addMessage(QMessage *m);

   127     bool updateMessage(QMessage *m);

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

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

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

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

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

   133     bool showMessage(const QMessageId &id);

   134     bool composeMessage(const QMessage &message);   

   135     QMessage message(const QMessageId& id) const;

   136     bool sendEmail(QMessage &message);

   137    

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

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

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

   141     bool exportUpdates(const QMessageAccountId &id);

   142     

   143     QMessageManager::NotificationFilterId registerNotificationFilter(QMessageStorePrivate& aPrivateStore,

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

   145     void unregisterNotificationFilter(QMessageManager::NotificationFilterId notificationFilterId);

   146 

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

   148                                      bool resultSetOrdered);

   149     

   150     void setMtmAccountIdList(QMessageAccountIdList accountList);

   151     

   152 public: // from MMailboxSyncObserver

   153     void MailboxSynchronisedL(TInt aResult);

   154     

   155 #ifdef FREESTYLEMAILBOXOBSERVERUSED

   156     void setPluginObserversL();

   157     

   158 public:

   159         // from MMailboxContentObserver

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

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

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

   163 #endif

   164     

   165 public: // From MEmailFetchObserver

   166     virtual void DataFetchedL(const TInt aResult);

   167         

   168 private:

   169 

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

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

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

   173     

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

   175     void updateEmailAccountsL() const;

   176     void updateMessageL(QMessage* message);

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

   178     QMessageFolderIdList folderIdsByAccountId(const QMessageAccountId& accountId) const;

   179     QMessageFolderIdList folderIdsByAccountIdL(const QMessageAccountId& accountId) const;

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

   181     QMessageFolderIdList allFolders() const;

   182     QMessageFolder folderL(const QMessageFolderId &id) const;

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

   184     TFolderType standardFolderId(QMessage::StandardFolder standardFolder);

   185     

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

   187     QMessage CreateQMessageL(MEmailMessage* aMessage) const; 

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

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

   190     QDateTime symbianTTimetoQDateTime(const TTime& time) const;

   191     TTime qDateTimeToSymbianTTime(const QDateTime& date) const;

   192     

   193     QMessage messageL(const QMessageId& id) const;

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

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

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

   197     

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

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

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

   201     void handleNestedFiltersFromFolderFilter(QMessageFolderFilter &filter) const;

   202 

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

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

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

   206 

   207     void handleNestedFiltersFromMessageFilter(QMessageFilter &filter) const;

   208     void exportUpdatesL(const QMessageAccountId &id);

   209     

   210     void retrieveTotalBodyL(MEmailMessageContent* aContent);

   211     void retrieveAttachmentsL(MEmailMessage* aMessage);

   212 

   213 #ifdef FREESTYLEMAILBOXOBSERVERUSED

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

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

   216 #endif

   217     

   218     friend class QMessageService;

   219     friend class CMessagesFindOperation;

   220     

   221 private:

   222 

   223     CEmailInterfaceFactory* m_factory;

   224     mutable MEmailInterface* m_ifPtr;

   225     mutable MEmailClientApi* m_clientApi;

   226     mutable QHash<QString, QMessageAccount> m_accounts;

   227     mutable int m_operationIds;

   228     mutable QList<FSMessageQueryInfo> m_messageQueries;

   229     QMessageAccountIdList m_mtmAccountList;

   230     TMailboxId m_mailboxId;

   231     QMessageStorePrivate* ipMessageStorePrivate;

   232     bool iListenForNotifications;

   233     QMessageManager::NotificationFilterId m_filterId;

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

   235     QMessageAccount m_account;

   236     RMailboxPtrArray m_mailboxes;

   237     REmailAttachmentArray m_attachments;

   238     QMessageServicePrivate* m_privateService;

   239     friend class QMessageService;

   240     friend class CFSMessagesFindOperation;

   241     

   242     mutable QMessageAccountSortOrder m_currentAccountOrdering;

   243     mutable QMessageFolderSortOrder m_currentFolderOrdering;

   244     mutable QMessageSortOrder m_currentMessageOrdering;

   245 

   246 

   247 };

   248 

   249 class CFSMessagesFindOperation : public QObject, MEmailSearchObserver

   250 {

   251     Q_OBJECT

   252     

   253 public:

   254     CFSMessagesFindOperation(CFSEngine& aOwner, int aOperationId); 

   255     ~CFSMessagesFindOperation();

   256 

   257     void filterAndOrderMessages(const QMessageFilter& filter,

   258                                 const QMessageSortOrder& sortOrder,

   259                                 const QString body = QString(),

   260                                 QMessageDataComparator::MatchFlags matchFlags = 0);

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

   262                                 const QMessageSortOrder& sortOrder,

   263                                 const QString body = QString(),

   264                                 QMessageDataComparator::MatchFlags matchFlags = 0);

   265 

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

   267 

   268     

   269 public slots:

   270     void SearchCompleted();

   271 

   272 private:

   273     // from memailmessagesearch

   274     virtual void HandleResultL(MEmailMessage* aMessage);

   275     virtual void SearchCompletedL();

   276 

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

   278                                 const QMessageSortOrder& sortOrder,

   279                                 const QString body = QString(),

   280                                 QMessageDataComparator::MatchFlags matchFlags = 0);

   281     

   282     void getAllMessagesL(TEmailSortCriteria& sortCriteria);

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

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

   285     

   286     bool fillsSearchKeyCriteria(QMessageId& messageId);

   287 

   288     

   289 private: // Data

   290     CFSEngine& m_owner;

   291     

   292     int m_numberOfHandledFilters;

   293     int m_operationId;

   294     int m_activeSearchCount;

   295     //TMsvSelectionOrdering iOrdering;

   296     bool m_resultCorrectlyOrdered;

   297     QMessageIdList m_idList;

   298     QMessageFilterPrivate::SortedMessageFilterList m_filterList;

   299     QMessageIdList m_excludeIdList;

   300 

   301     MEmailClientApi* m_clientApi;

   302     

   303     CEmailInterfaceFactory* m_factory; 

   304     MEmailInterface* m_interfacePtr; 

   305     bool m_receiveNewMessages;

   306     QList<FSSearchOperation> m_searchOperations;

   307     

   308     Field m_searchField;

   309     QMessageDataComparator::MatchFlags m_matchFlags;

   310     QString m_searchKey;

   311 };

   312 

   313 

   314 QTM_END_NAMESPACE

   315 

   316 #endif // QFSENGINE_SYMBIAN_H