examples/SFExamples/symbian_os_communications_programming_book_v2/chapter8/receivingmessages/CMessageSummaryEngine.cpp

// 
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of the License "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
// 
// Initial Contributors:
// Nokia Corporation - initial contribution.
// 
// Contributors:
// 
// Description:
// 

#include "CMessageSummaryEngine.h"
#include <miutset.h>
#include "summaryscreenlog.h"

const CMessageSummaryGenerator& CMessageSummaryEngine::SmsSummary()
        {
        return *iSmsInboxSummary;
        }
        
const CMessageSummaryGenerator* CMessageSummaryEngine::EmailSummary()
        {
        return iEmailInboxSummary;
        }


CMessageSummaryEngine* CMessageSummaryEngine::NewL(MSummaryEngineObserver& aObserver)
        {
        CMessageSummaryEngine* self = new (ELeave) CMessageSummaryEngine(aObserver);
        CleanupStack::PushL(self);
        self->ConstructL();
        CleanupStack::Pop(self);
        CActiveScheduler::Add(self);
        return self;
        }

// Start the summary operation
void CMessageSummaryEngine::StartL()
        {
        LOG(">> CMessageSummaryEngine::StartL()");
        // Connect to the Message Server asynchronously
        iState = EConnectingToMessageServer;
        iMessagingSession = CMsvSession::OpenAsyncL(*this);
        
        // The message server will call HandleSessionEventL when the session is connected.
        LOG("<< CMessageSummaryEngine::StartL()");
        }

// CActive functions
void CMessageSummaryEngine::DoCancel()
        {
        // Nothing to cancel here
        }


TBool CMessageSummaryEngine::UpdateNextSummary()
        {
        LOG(">> CMessageSummaryEngine::UpdateNextSummary()");
        TBool moreSummaries = ETrue;

        switch (iState)
                {
                case EConnectingToMessageServer:
                        iState = ERefreshing;
                        iStatus = KRequestPending;
                        // Move on to the next state, scan for messages
                case ERefreshing:
                        // If the SMS list needs to be refreshed then refresh it
                        if (iRefreshSms)
                                {
                                iSmsInboxSummary->StartL(iStatus);
                                iRefreshSms = EFalse;
                                }
                        else if (iRefreshEmail)
                                {
                                // If the Email list needs to be refreshed then refresh it                              
                                if (iEmailInboxSummary != NULL)
                                        // Get the email summaries if there is an email account.
                                        {
                                        iEmailInboxSummary->StartL(iStatus);                    
                                        }
                                else
                                        {
                                        moreSummaries = EFalse;
                                        }
                                        
                                iRefreshEmail = EFalse;
                                }
                        else
                                {
                                moreSummaries = EFalse;
                                }
                        break;
                        
                default:
                        break;
                        }
        
        if (moreSummaries)
                SetActive();

        LOG("<< CMessageSummaryEngine::UpdateNextSummary()");

        return moreSummaries;
        }


void CMessageSummaryEngine::RunL()
        {
        LOG(">> CMessageSummaryEngine::RunL()");

        // One of the message summary generators has completed.
        if (!UpdateNextSummary())
                {
                // If UpdateNextSummary returns EFalse then there are no more message
                // types to check. So refresh the UI.
                iObserver.Refresh();            
                }
                
        LOG("<< CMessageSummaryEngine::RunL()");
        }

        
CMessageSummaryEngine::CMessageSummaryEngine(MSummaryEngineObserver& aObserver) : CActive(EPriorityStandard),
                                                                                                iObserver(aObserver),
                                                                                                iRefreshSms(ETrue),
                                                                                                iRefreshEmail(ETrue)
        {       
        }

void CMessageSummaryEngine::ConstructL()
        {
        }

void CMessageSummaryEngine::CreateSummaryGeneratorsL()
        {
        LOG(">> CMessageSummaryEngine::CreateSummaryGeneratorsL()");
        // Select the ordering we wish to use when enumerating through messages.
        // The message summary application is only interested in the most recent
        // messages so EMsvSortByDateReverse is approprate.
        TMsvSelectionOrdering ordering(KMsvNoGrouping, EMsvSortByDateReverse);
        
        // Create the CMsvEntry object that will be shared by all summary generators
        // Note that it is only possible to create the CMsvEntry once the message session
        // is connected.
        iMessagingEntry = CMsvEntry::NewL(*iMessagingSession, KMsvGlobalInBoxIndexEntryId, ordering);
        iSmsInboxSummary = new (ELeave) CMessageSummaryGenerator(KMsvGlobalInBoxIndexEntryId, KUidMsgTypeSMS, *iMessagingEntry);
        iEmailInboxSummary = NULL;
        
        // Find the first POP3 mailbox
        TMsvId pop3MailboxId;
        if (FindPop3ServiceEntryL(pop3MailboxId))
                {
                iEmailInboxSummary = new (ELeave) CMessageSummaryGenerator(pop3MailboxId, KUidMsgTypePOP3, *iMessagingEntry);
                }

        LOG("<< CMessageSummaryEngine::CreateSummaryGeneratorsL()");
        }

TBool CMessageSummaryEngine::FindPop3ServiceEntryL(TMsvId& aPop3MailboxId)
{
        // Search for a POP3 mailbox entry
        TBool pop3MailboxFound = EFalse;

        //      Any entry under the root where iMtm == KUidMsgTypePOP3 is a POP3 service        
        iMessagingEntry->SetEntryL(KMsvRootIndexEntryIdValue);
        CMsvEntrySelection* serviceEntryList = iMessagingEntry->ChildrenWithMtmL(KUidMsgTypePOP3);
        CleanupStack::PushL(serviceEntryList);
        
        // Return the ID of the first entry in the list, if there is one
        if (serviceEntryList->Count() > 0)
                {
                aPop3MailboxId = (*serviceEntryList)[0];
                pop3MailboxFound = ETrue;
                }
        
        CleanupStack::PopAndDestroy(serviceEntryList);
        
        return pop3MailboxFound;
}

void CMessageSummaryEngine::HandleSessionEventL(TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny* /* aArg3 */)
// This function is called by the message server for every message server event,
// e.g. when a new message is recieved or created. */
        {
        LOG(">> CMessageSummaryEngine::HandleSessionEventL");
        
        switch (aEvent)
                {
        case MMsvSessionObserver::EMsvServerReady:
                // The session is now connected to the message server
                LOG(">> MMsvSessionObserver::EMsvServerReady:");
                if (iState == EConnectingToMessageServer)
                        {
                        // Create the summary generators for each message type
                        CreateSummaryGeneratorsL();
                        
                        // If we were waiting for connection to the message server
                        // then move on to the next state, update the message summaries.
                        UpdateNextSummary();
                        }
                LOG("<< MMsvSessionObserver::EMsvServerReady:");
                break;
                
        case MMsvSessionObserver::EMsvEntriesChanged:
                LOG(">> MMsvSessionObserver::EMsvEntriesChanged:");
                // Get the list of the changed messages. Note that there may be more than one.
                CMsvEntrySelection* newMessages = static_cast<CMsvEntrySelection*> (aArg1);

                // Get the ID of the parent entry
                TMsvId* parentMsvId = static_cast<TMsvId*> (aArg2);
                
                // Set the CMsvEntry to point to the parent entry
                iMessagingEntry->SetEntryL(*parentMsvId);
                
                // Add each new message to the appropriate message summary
                TInt index = newMessages->Count() - 1;
                while (index >= 0)
                {
                        // Get the entry details for each new message
                        TMsvEntry tempMessageEntry = iMessagingEntry->ChildDataL(newMessages->At(index));
                        
                        if (tempMessageEntry.Complete())                         // Is the message complete? Do not add incomplete entries.
                                {
                                if (iSmsInboxSummary->MessageOfCorrectType(tempMessageEntry))
                                        {
                                        iRefreshSms = ETrue;
                                        }
                                else if ((iEmailInboxSummary != NULL)
                                                && (iEmailInboxSummary->MessageOfCorrectType(tempMessageEntry)))
                                        {
                                        // If we have a new Email message in the email inbox then update the Email summaries
                                        iRefreshEmail = ETrue;          
                                        }               
                                }
                                
                        index--;
                }

                if ((iRefreshSms) || (iRefreshEmail))
                        // Refresh the SMS and / or email list if there have been any changes
                        // to SMS and / or email messages
                        {
                        iState = ERefreshing;
                        
                        // If this object is not active then update the next summary
                        // If this object is active then the the appropriate summary list will
                        // be refreshed when it reaches the RunL.
                        if (!IsActive())
                                UpdateNextSummary();
                        }

                LOG("<< MMsvSessionObserver::EMsvEntriesChanged:");

                break;
                
        default:
                // Do nothing in the default case.
                // Assume that this event notification is not needed.
                LOG("default:");
                break;  
                }

        LOG("<< CMessageSummaryEngine::HandleSessionEventL");

        }


CMessageSummaryEngine::~CMessageSummaryEngine()
        {
        delete iEmailInboxSummary;
        delete iSmsInboxSummary;
        delete iMessagingEntry; 
        delete iMessagingSession; // This closes the session.
        }

---