FCL/sf/app/commonemail: comparison emailservices/nmailagent/src/nmmailagent.cpp

equal deleted inserted replaced

-:139d4b7b2938
+:99bcbff212ad
 *
 * Description:
 *
 */
+#include <xqservicerequest.h>
+#include <email_services_api.h>
+#include "emailtrace.h"
 #include "nmmailagentheaders.h"
 #include "nmmailagent.h"
+#include <xqsystemtoneservice.h>
 // CONSTS
 const int NmAgentIndicatorNotSet = -1;
 const int NmAgentAlertToneTimer = 60000; // 60s
+static const QString NmMailboxIndicatorType = "com.nokia.nmail.indicatorplugin_%1/1.0";
+static const QString NmSendIndicatorName = "com.nokia.nmail.indicatorplugin.send/1.0";
+static const QString NmUnreadIndicatorName = "com.nokia.nmail.indicatorplugin.unread/1.0";
 /*!
 \class NmMailAgent
 \brief Main class for receiving email events and passing them to the HbIndicator
 */
 NmMailboxInfo::NmMailboxInfo()
 {
+NM_FUNCTION;
 mId = 0;
 mIndicatorIndex = NmAgentIndicatorNotSet;
 mSyncState = SyncComplete;
 mConnectState = Disconnected;
 mOutboxMails = 0;
 mInboxDeletedMessages = 0;
 mActive = false;
 }
 NmMailAgent::NmMailAgent() :
+mIndicator(NULL),
+mSystemTone(NULL),
 mPluginFactory(NULL),
-mSendingState(false),
+mAlertToneAllowed(true),
-mAlertToneAllowed(true)
+mLastOutboxCount(0),
-{
+mUnreadIndicatorActive(false)
-NMLOG("NmMailAgent::NmMailAgent");
+{
+NM_FUNCTION;
 }
 /*!
 Delayed start
 */
 void NmMailAgent::delayedStart()
 {
-	NMLOG("NmMailAgent::delayedStart");
+NM_FUNCTION;
 	if (!init()) {
 		// Initialisation failed. Quit the agent.
 		QCoreApplication::exit(1);
 	}
 }
 /*!
 Initialise the agent. \return true if succesfully started.
 */
 bool NmMailAgent::init()
 {
-	NMLOG("NmMailAgent::init");
+NM_FUNCTION;
 mPluginFactory = NmDataPluginFactory::instance();
 if (!mPluginFactory) {
-NMLOG("NmMailAgent::init PluginFactory not created");
+NM_ERROR(1,"NmMailAgent::init(): PluginFactory not created");
 return false;
 }
+//mSystemTone = new XQSystemToneService();
+mIndicator = new HbIndicator();
+connect(mIndicator,SIGNAL(userActivated(const QString &, const QVariantMap&)),
+this, SLOT(indicatorActivated(const QString&, const QVariantMap&)));
 QList<QObject*> *plugins = mPluginFactory->pluginInstances();
 foreach (QObject *plugin, *plugins) {
 	if (plugin) {
 return true;
 }
 NmMailAgent::~NmMailAgent()
 {
+NM_FUNCTION;
 qDeleteAll(mMailboxes);
+//delete mSystemTone;
 NmDataPluginFactory::releaseInstance(mPluginFactory);
 }
 /*!
 Initialize the mailbox list with the current state
 */
 void NmMailAgent::initMailboxStatus()
 {
-NMLOG("NmMailAgent::initMailboxStatus");
+NM_FUNCTION;
 QList<NmMailbox*> mailboxes;
 QList<QObject*> *plugins = mPluginFactory->pluginInstances();
 foreach(QObject* pluginObject, *plugins) {
 NmDataPluginInterface *plugin =
 }
 }
 }
 qDeleteAll(mailboxes);
 }
+updateSendIndicator();
 }
 /*!
 Get mailbox unread count in inbox folder
 \param mailboxId id of the mailbox
 \param mailboxInfo contains the list of unread messages
 \return true if new unread mails was found
 */
 bool NmMailAgent::updateUnreadCount(const NmId &mailboxId, NmMailboxInfo &mailboxInfo)
 {
-NMLOG("NmMailAgent::getUnreadCount");
+NM_FUNCTION;
 int newUnreadMessages(0);
 NmDataPluginInterface *plugin = mPluginFactory->interfaceInstance(mailboxId);
 if (plugin) {
 		qDeleteAll(messageList);
 		// Save updated list of unread message IDs
 mailboxInfo.mUnreadMailIdList = newUnreadMessageIdList;
 }
-	NMLOG(QString("NmMailAgent::getUnreadCount count=%1 new=%2").
+NM_COMMENT(QString("NmMailAgent::getUnreadCount(): count=%1, new=%2").
-	    arg(mailboxInfo.mUnreadMailIdList.count()).arg(newUnreadMessages));
+arg(mailboxInfo.mUnreadMailIdList.count()).arg(newUnreadMessages));
 return (newUnreadMessages > 0);
 }
 /*!
 \param maxCount max number of outbox mails that is needed
 \return number of mails in the outbox
 */
 int NmMailAgent::getOutboxCount(const NmId &mailboxId)
 {
-NMLOG("NmMailAgent::getOutboxCount");
+NM_FUNCTION;
 int count(0);
 NmDataPluginInterface *plugin = mPluginFactory->interfaceInstance(mailboxId);
 if (plugin) {
 		QList<NmMessageEnvelope*> messageList;
 		plugin->listMessages(mailboxId, outboxId, messageList);
 		count = messageList.count();
 		qDeleteAll(messageList);
 }
-NMLOG(QString("NmMailAgent::getOutboxCount count=%1").arg(count));
+NM_COMMENT(QString("NmMailAgent::getOutboxCount(): count=%1").arg(count));
 return count;
+}
+/*!
+Get list of unread counts in active mailboxes
+	\returns total number of unread mails
+*/
+int NmMailAgent::getTotalUnreadCount() const
+{
+int unreads = 0;
+foreach (const NmMailboxInfo *mailbox, mMailboxes) {
+if (mailbox->mActive) {
+unreads += mailbox->mUnreadMailIdList.count();
+}
+}
+return unreads;
+}
+/*!
+Update the "@" indicator state according to unread state
+\return true if the indicator was activated
+*/
+bool NmMailAgent::updateUnreadIndicator()
+{
+int unreads = getTotalUnreadCount();
+return updateUnreadIndicator(unreads>0);
 }
 /*!
 Update the mailbox visibility and status
 \param mailboxId id of the mailbox
 \return true if the mailbox state was changed
 */
 bool NmMailAgent::updateMailboxState(const NmId &mailboxId,
 bool active, bool refreshAlways)
 {
-// Update the global sending state
+NM_FUNCTION;
-mSendingState = false;
-foreach (NmMailboxInfo *mailboxInfo, mMailboxes) {
-if (mailboxInfo->mOutboxMails>0) {
-mSendingState = true;
-break;
-}
-}
 NmMailboxInfo *mailboxInfo = getMailboxInfo(mailboxId);
 bool changed = false;
 if (mailboxInfo->mActive != active ||
 refreshAlways) {
 mailboxInfo->mActive = active;
 changed = true;
 if (active) {
 // Mailbox is not yet assigned to any indicator
 if (mailboxInfo->mIndicatorIndex < 0) {
-mailboxInfo->mIndicatorIndex = getIndicatorIndex();
+mailboxInfo->mIndicatorIndex = getFreeIndicatorIndex();
 }
 updateIndicator(true,*mailboxInfo);
 }
 else {
 \return true if indicator was updated with no errors
 */
 bool NmMailAgent::updateIndicator(bool active,
 const NmMailboxInfo& mailboxInfo)
 {
-NMLOG(QString("NmMailAgent::updateIndicator index=%1 active=%2").
+NM_FUNCTION;
+NM_COMMENT(QString("NmMailAgent::updateIndicator(): index=%1, active=%2").
 arg(mailboxInfo.mIndicatorIndex).arg(active));
 bool ok = false;
-QString name = QString("com.nokia.nmail.indicatorplugin_%1/1.0").
+QString name = QString(NmMailboxIndicatorType).
 arg(mailboxInfo.mIndicatorIndex);
 QList<QVariant> list;
 list.append(mailboxInfo.mId.id());
 list.append(mailboxInfo.mName);
 list.append(mailboxInfo.mUnreadMailIdList.count());
 list.append(mailboxInfo.mSyncState);
 list.append(mailboxInfo.mConnectState);
 list.append(mailboxInfo.mOutboxMails);
 list.append(mailboxInfo.mIconName);
-list.append(mSendingState);
+list.append(mLastOutboxCount);
-HbIndicator indicator;
 if (active) {
-ok = indicator.activate(name,list);
+ok = mIndicator->activate(name,list);
 }
 else {
-ok = indicator.deactivate(name,list);
+ok = mIndicator->deactivate(name,list);
 }
+updateUnreadIndicator();
+return ok;
+}
+/*!
+update the unread indicator state
+\return true if the indicator was activated
+*/
+bool NmMailAgent::updateUnreadIndicator(bool active)
+{
+NM_FUNCTION;
+bool activated = false;
+if (active) {
+mIndicator->activate(NmUnreadIndicatorName);
+if (!mUnreadIndicatorActive) {
+activated = true;
+}
+}
+else {
+mIndicator->deactivate(NmUnreadIndicatorName);
+}
+mUnreadIndicatorActive = active;
+return activated;
+}
+/*!
+Opens inbox view to specific mailbox
+\return true if inbox is succesfully opened
+*/
+bool NmMailAgent::launchMailbox(quint64 mailboxId)
+{
+NM_FUNCTION;
+XQServiceRequest request(
+emailFullServiceNameMailbox,
+emailOperationViewInbox,
+true);
+QList<QVariant> list;
+list.append(QVariant(mailboxId));
+request.setArguments(list);
+bool ok = request.send();
+NM_COMMENT(QString("Launch ok=%1 error=%2").arg(ok).arg(request.latestError()));
 return ok;
 }
 /*!
 Get next free indicator index, starting from 0
 @return index of the indicator that is available
 */
-int NmMailAgent::getIndicatorIndex()
+int NmMailAgent::getFreeIndicatorIndex()
 {
+NM_FUNCTION;
 int index = 0;
 bool found(false);
 do {
 found = false;
 foreach (NmMailboxInfo *mailbox, mMailboxes) {
 Received from NmFrameworkAdapter mailboxEvent signal
 \sa NmFrameworkAdapter
 */
 void NmMailAgent::handleMailboxEvent(NmMailboxEvent event, const QList<NmId> &mailboxIds)
 {
-NMLOG(QString("NmMailAgent::handleMailboxEvent %1").arg(event));
+NM_FUNCTION;
+NM_COMMENT(QString("NmMailAgent::handleMailboxEvent(): event=%1").arg(event));
 switch(event) {
 case NmMailboxCreated:
 foreach (NmId mailboxId, mailboxIds) {
 getMailboxInfo(mailboxId); // create a new mailbox if needed
 case NmMailboxDeleted:
 foreach (NmId mailboxId, mailboxIds) {
 // Will hide also the indicator
 removeMailboxInfo(mailboxId);
 }
+updateUnreadIndicator();
 break;
 default:
 break;
+}
+}
+/*!
+Map the type name to mailbox info
+\return NULL if no mailbox match the type
+*/
+NmMailboxInfo *NmMailAgent::getMailboxByType(const QString &type)
+{
+foreach (NmMailboxInfo *mailbox, mMailboxes) {
+// mailbox is shown in indicators
+if (mailbox->mIndicatorIndex >= 0 && mailbox->mActive) {
+QString typeName = QString(NmMailboxIndicatorType).arg(mailbox->mIndicatorIndex);
+// type names match(!)
+if(type==typeName) {
+return mailbox;
+}
+}
+}
+return NULL;
+}
+/*!
+Called when indicator is clicked from the indicator menu
+- indicator will be hide from the menu
+- mailbox will be launched
+*/
+void NmMailAgent::indicatorActivated(const QString &type, const QVariantMap &data)
+{
+NM_FUNCTION;
+Q_UNUSED(data);
+// map the indicator type to mailbox
+NmMailboxInfo *info = getMailboxByType(type);
+if (info) {
+info->mLastSeenTime = QDateTime::currentDateTime();
+info->mActive = false; // indicator is no longer active
+updateUnreadIndicator();
+launchMailbox(info->mId.id());
 }
 }
 /*!
 Received from NmFrameworkAdapter messageEvent signal
 NmMessageEvent event,
 const NmId &folderId,
 const QList<NmId> &messageIds,
 const NmId& mailboxId)
 {
-NMLOG(QString("NmMailAgent::handleMessageEvent %1 %2").arg(event).arg(mailboxId.id()));
+NM_FUNCTION;
+NM_COMMENT(QString("NmMailAgent::handleMessageEvent(): event=%1, id=%2").
+arg(event).arg(mailboxId.id()));
 bool updateNeeded = false;
 bool activate = false;
 switch (event) {
 case NmMessageCreated: {
 foreach (NmId messageId, messageIds) {
 if (getMessageUnreadInfo(folderId, messageId, mailboxId, messageUnread)) {
 if (messageUnread) {
 mailboxInfo->mUnreadMailIdList.append(messageId);
 updateMailboxState(mailboxId, true, false);
+// make the "@" appear immediatelly
+updateUnreadIndicator(true);
+// Play the tone as well
+playAlertTone();
 }
 }
 }
 }
 }
 // When created a new mail in the outbox, we are in sending state
 if (mailboxInfo->mOutboxFolderId == folderId) {
 // The first mail created in the outbox
 if (mailboxInfo->mOutboxMails <= 0) {
-					NMLOG("NmMailAgent: first mail in outbox");
+					NM_COMMENT("NmMailAgent: first mail in outbox");
 					activate = true;
 updateNeeded = true;
 }
 mailboxInfo->mOutboxMails += messageIds.count();
+				updateSendIndicator();
 }
 break;
 }
 case NmMessageChanged: {
 NmMailboxInfo *mailboxInfo = getMailboxInfo(mailboxId);
 if (mailboxInfo && mailboxInfo->mSyncState==SyncComplete) {
 // check the unread status again
 int oldCount = mailboxInfo->mUnreadMailIdList.count();
 activate = updateUnreadCount(mailboxId, *mailboxInfo);
-// new unread mails found or no more unread mails in the mailbox
+// new unread mails found or no more unread mails in the inbox
-if (activate || (oldCount>0 && mailboxInfo->mUnreadMailIdList.count()==0)) {
+if (oldCount>0 && mailboxInfo->mUnreadMailIdList.count()==0) {
 updateNeeded = true;
 }
 }
 			break;
 		}
 mailboxInfo->mOutboxMails = 0;
 }
 // The last mail was now deleted
 if (mailboxInfo->mOutboxMails == 0) {
-					NMLOG("NmMailAgent: last mail deleted from outbox");
+					NM_COMMENT("NmMailAgent: last mail deleted from outbox");
 // Keep it active if there is unread mails
 activate = mailboxInfo->mUnreadMailIdList.count() > 0;
 updateNeeded = true;
 }
+				updateSendIndicator();
 }
 break;
 }
 default:
 break;
 }
 if (updateNeeded) {
+updateUnreadIndicator();
 NmMailboxInfo *mailboxInfo = getMailboxInfo(mailboxId);
 updateMailboxState(mailboxId,
 activate, true /* force refresh */);
 }
 }
 */
 void NmMailAgent::handleSyncStateEvent(
 NmSyncState state,
 const NmOperationCompletionEvent &event)
 {
-NMLOG(QString("NmMailAgent::handleSyncStateEvent %1 %2").arg(state).arg(event.mMailboxId.id()));
+NM_FUNCTION;
+NM_COMMENT(QString("NmMailAgent::handleSyncStateEvent(): state=%1, id=%2").
+arg(state).arg(event.mMailboxId.id()));
 NmMailboxInfo *info = getMailboxInfo(event.mMailboxId);
 if (info) {
 info->mSyncState = state;
 if (state==Synchronizing) {
 }
 bool active = info->mUnreadMailIdList.count() ||
 info->mOutboxMails;
 // Refresh the indicator if messages created or changed
-NMLOG(QString(" created=%1, changed=%2, deleted=%3").
+NM_COMMENT(QString("NmMailAgent::handleSyncStateEvent(): "
+"created=%1, changed=%2, deleted=%3").
 arg(info->mInboxCreatedMessages).
 arg(info->mInboxChangedMessages).
 arg(info->mInboxDeletedMessages));
 bool refresh = (info->mInboxCreatedMessages > 0) || (info->mInboxChangedMessages > 0);
+updateUnreadIndicator();
 if (activate) {
 updateMailboxState(event.mMailboxId, active, refresh);
 }
 }
 }
 Received from NmFrameworkAdapter connectionState signal
 \sa NmFrameworkAdapter
 */
 void NmMailAgent::handleConnectionEvent(NmConnectState state, const NmId mailboxId, int errorcode)
 {
-	Q_UNUSED(errorcode);
+NM_FUNCTION;
-NMLOG(QString("NmMailAgent::handleConnectionEvent %1 %2 %3").arg(state).arg(mailboxId.id()).arg(errorcode));
+NM_COMMENT(QString("NmMailAgent::handleConnectionEvent(): state=%1, id=%2").
+arg(state).arg(mailboxId.id()));
+Q_UNUSED(errorcode);
 NmMailboxInfo *mailboxInfo = getMailboxInfo(mailboxId);
 if (mailboxInfo) {
 // Connecting, Connected, Disconnecting, Disconnected
 mailboxInfo->mConnectState = state;
 }
 Remove a mailbox info entry
 \return true if mailbox info was found
 */
 bool NmMailAgent::removeMailboxInfo(const NmId &id)
 {
+NM_FUNCTION;
 bool found = false;
 foreach (NmMailboxInfo *mailbox, mMailboxes) {
 if (mailbox->mId == id) {
 // Hide the indicator too
 if(mailbox->mIndicatorIndex>=0) {
 Create a new mailbox info entry
 \return new mailbox info object
 */
 NmMailboxInfo *NmMailAgent::createMailboxInfo(const NmId &id)
 {
+NM_FUNCTION;
 // get information of the mailbox
 NmMailbox *mailbox = NULL;
 NmMailboxInfo *info = NULL;
 NmDataPluginInterface *plugin = mPluginFactory->interfaceInstance(id);
 if (plugin) {
 Create a new mailbox info with given parameters
 \return new mailbox info object
 */
 NmMailboxInfo *NmMailAgent::createMailboxInfo(const NmMailbox &mailbox, NmDataPluginInterface *plugin)
 {
+NM_FUNCTION;
 NmMailboxInfo *mailboxInfo = new NmMailboxInfo();
 mailboxInfo->mId = mailbox.id();
 mailboxInfo->mName = mailbox.name();
 mMailboxes.append(mailboxInfo);
 Return mailbox info class with mailbox id. If no class is found, create a new instance with given id.
 \return mailbox info object
 */
 NmMailboxInfo *NmMailAgent::getMailboxInfo(const NmId &id)
 {
+NM_FUNCTION;
 foreach (NmMailboxInfo *mailbox, mMailboxes) {
 if (mailbox->mId == id) {
 return mailbox;
 }
 }
 \return true if info fetching was successful
 */
 bool NmMailAgent::getMessageUnreadInfo(const NmId &folderId,
 const NmId &messageId, const NmId &mailboxId, bool &unreadMessage)
 {
-NMLOG("NmMailAgent::messageInfo");
+NM_FUNCTION;
 NmDataPluginInterface *plugin = mPluginFactory->interfaceInstance(mailboxId);
 bool ok = false;
 if (plugin) {
 }
 return ok;
 }
 /*!
-Plays email alert tune when new messages arrive
+Plays email alert tone when new messages arrive
-*/
+	\returns true if the tone was played
-void NmMailAgent::playAlertTone()
+*/
-{
+bool NmMailAgent::playAlertTone()
+{
+NM_FUNCTION;
+	bool played = false;
 if (mAlertToneAllowed) {
-// play alert
+//mSystemTone->playTone(XQSystemToneService::EmailAlertTone);
+// play alert only once per minute
 mAlertToneAllowed = false;
 QTimer::singleShot(NmAgentAlertToneTimer, this, SLOT(enableAlertTone()));
-}
+		played = true;
+}
+	return played;
 }
 /*!
 Allows alert tune to be played again
 */
 void NmMailAgent::enableAlertTone()
 {
+NM_FUNCTION;
 mAlertToneAllowed = true;
 }
+/*!
+update send indicator according to outbox state
+*/
+void NmMailAgent::updateSendIndicator()
+{
+// Get number of mails in outboxes
+int outboxMails = 0;
+foreach (NmMailboxInfo *mailboxInfo, mMailboxes) {
+outboxMails += mailboxInfo->mOutboxMails;
+}
+if( outboxMails == 0 ) {
+mIndicator->deactivate(NmSendIndicatorName);
+}
+else if (outboxMails > mLastOutboxCount) {
+// New mails detected in outbox
+	// indicator will disappear automatically after a delay
+mIndicator->activate(NmSendIndicatorName);
+	}
+	mLastOutboxCount = outboxMails;
+}
 // End of file

changeset 43	99bcbff212ad
parent 40	2c62ef3caffd
child 44	c2d07d913565