emailservices/emailclientapi/src/emailinterfacefactoryimpl.cpp
author hgs
Mon, 23 Aug 2010 23:32:31 +0300
changeset 62 a8c646b56683
parent 47 f83bd4ae1fe3
permissions -rw-r--r--
201033
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
47
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: This file implements class CEmailInterfaceFactoryImpl.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#include <e32property.h>                // RProperty
hgs
parents:
diff changeset
    19
#include <s32mem.h>                     // RDesRead/WriteStream
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include "emailinterfacefactoryimpl.h"
hgs
parents:
diff changeset
    22
#include "emailcontent.h"
62
hgs
parents: 47
diff changeset
    23
#include "CFSMailClient.h"
47
hgs
parents:
diff changeset
    24
#include "emailclientapiimpldefs.h"
hgs
parents:
diff changeset
    25
#include "emailclientapiimpl.h"
hgs
parents:
diff changeset
    26
#include "emailaddress.h"
hgs
parents:
diff changeset
    27
#include "emailmessagesearch.h"
hgs
parents:
diff changeset
    28
#include "emailshutdownconst.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
_LIT( KEmailImplPanic, "Email client API" );
hgs
parents:
diff changeset
    31
const TInt KEmailUidExtraBuffer = 2 * KEmailPlatformApiUidItemSize;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    34
// Email client API panic wrapper
hgs
parents:
diff changeset
    35
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    36
void Panic( TEmailImplPanic aPanic )
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
    User::Panic( KEmailImplPanic(), aPanic );
hgs
parents:
diff changeset
    39
    }
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
// ======== MEMBER FUNCTIONS ========
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    44
// CEmailInterfaceFactoryImpl::NewL
hgs
parents:
diff changeset
    45
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    46
CEmailInterfaceFactoryImpl* CEmailInterfaceFactoryImpl::NewL()
hgs
parents:
diff changeset
    47
    {
hgs
parents:
diff changeset
    48
    CEmailInterfaceFactoryImpl* self = new (ELeave) CEmailInterfaceFactoryImpl();
hgs
parents:
diff changeset
    49
    CleanupStack::PushL( self );
hgs
parents:
diff changeset
    50
    self->ConstructL();
hgs
parents:
diff changeset
    51
    CleanupStack::Pop( self );
hgs
parents:
diff changeset
    52
    return self;
hgs
parents:
diff changeset
    53
    }
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    56
// CEmailInterfaceFactoryImpl::~CEmailInterfaceFactoryImpl
hgs
parents:
diff changeset
    57
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    58
CEmailInterfaceFactoryImpl::~CEmailInterfaceFactoryImpl()
hgs
parents:
diff changeset
    59
    {
hgs
parents:
diff changeset
    60
    TRAP_IGNORE( AppendOrRemoveUidL( EEmailUidModeRemove ) );
hgs
parents:
diff changeset
    61
    }
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    64
// CEmailInterfaceFactoryImpl::CEmailInterfaceFactoryImpl
hgs
parents:
diff changeset
    65
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    66
CEmailInterfaceFactoryImpl::CEmailInterfaceFactoryImpl() : 
hgs
parents:
diff changeset
    67
    CEmailInterfaceFactory()
hgs
parents:
diff changeset
    68
    {
hgs
parents:
diff changeset
    69
    }
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    72
// CEmailInterfaceFactoryImpl::ConstructL
hgs
parents:
diff changeset
    73
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    74
void CEmailInterfaceFactoryImpl::ConstructL()
hgs
parents:
diff changeset
    75
    {
hgs
parents:
diff changeset
    76
	// This leaves if related P&S keys are not defined by EmailServerMonitor,
hgs
parents:
diff changeset
    77
	// so EmailServerMonitor need to be started before using client API.
hgs
parents:
diff changeset
    78
	// TRAP_IGNORE should be removed after EmailServerMonitor is added to
hgs
parents:
diff changeset
    79
	// starter list.
hgs
parents:
diff changeset
    80
    TRAP_IGNORE( AppendOrRemoveUidL( EEmailUidModeAppend ) );
hgs
parents:
diff changeset
    81
    }
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    84
// CEmailInterfaceFactoryImpl::InterfaceL
hgs
parents:
diff changeset
    85
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
    86
MEmailInterface* CEmailInterfaceFactoryImpl::InterfaceL( const TInt aInterfaceId )
hgs
parents:
diff changeset
    87
    {
hgs
parents:
diff changeset
    88
    MEmailInterface* interface = NULL;
hgs
parents:
diff changeset
    89
    switch ( aInterfaceId )
hgs
parents:
diff changeset
    90
        {
hgs
parents:
diff changeset
    91
        case KEmailClientApiInterface:
hgs
parents:
diff changeset
    92
            interface = CEmailClientApi::NewL();
hgs
parents:
diff changeset
    93
            break;
hgs
parents:
diff changeset
    94
        case KEmailIFUidAddress:
hgs
parents:
diff changeset
    95
            interface = CEmailAddress::NewL( MEmailAddress::EUndefined, EClientOwns );
hgs
parents:
diff changeset
    96
            break;
hgs
parents:
diff changeset
    97
        case KEmailIFUidTextContent:
hgs
parents:
diff changeset
    98
        default:
hgs
parents:
diff changeset
    99
            break;
hgs
parents:
diff changeset
   100
        }
hgs
parents:
diff changeset
   101
    if ( !interface )
hgs
parents:
diff changeset
   102
        {
hgs
parents:
diff changeset
   103
        User::Leave( KErrNotSupported );
hgs
parents:
diff changeset
   104
        }
hgs
parents:
diff changeset
   105
    return interface;
hgs
parents:
diff changeset
   106
    }
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
   109
// CEmailInterfaceFactoryImpl::AppendOrRemoveUidL
hgs
parents:
diff changeset
   110
// ---------------------------------------------------------------------------
hgs
parents:
diff changeset
   111
void CEmailInterfaceFactoryImpl::AppendOrRemoveUidL(
hgs
parents:
diff changeset
   112
        const TEmailUidAppendRemoveMode aMode )
hgs
parents:
diff changeset
   113
    {
hgs
parents:
diff changeset
   114
    // Read buffer length
hgs
parents:
diff changeset
   115
    TInt bufLength( 0 );
hgs
parents:
diff changeset
   116
    User::LeaveIfError( RProperty::Get( KEmailShutdownPsCategory,
hgs
parents:
diff changeset
   117
                                        EEmailPsKeyPlatformApiAppsToCloseLength,
hgs
parents:
diff changeset
   118
                                        bufLength ) );
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
    // Allocate buffer for reading and then read the list of UIDs from P&S.
hgs
parents:
diff changeset
   121
    // Adding some extra buffer just in case the size key and actual list
hgs
parents:
diff changeset
   122
    // are out of sync. This shouldn't happen, but you never know.
hgs
parents:
diff changeset
   123
    HBufC8* readBuf = HBufC8::NewLC( bufLength + KEmailUidExtraBuffer );
hgs
parents:
diff changeset
   124
    TPtr8 readPtr = readBuf->Des();
hgs
parents:
diff changeset
   125
    
hgs
parents:
diff changeset
   126
    User::LeaveIfError( RProperty::Get( KEmailShutdownPsCategory,
hgs
parents:
diff changeset
   127
                                        EEmailPsKeyPlatformApiAppsToClose,
hgs
parents:
diff changeset
   128
                                        readPtr ) );
hgs
parents:
diff changeset
   129
    
hgs
parents:
diff changeset
   130
    // For writing get the size of the original buffer + room for our own UID
hgs
parents:
diff changeset
   131
    // if needed
hgs
parents:
diff changeset
   132
    TInt writeBufSize = readPtr.Length();
hgs
parents:
diff changeset
   133
    if( aMode == EEmailUidModeAppend )
hgs
parents:
diff changeset
   134
        {
hgs
parents:
diff changeset
   135
        writeBufSize += KEmailPlatformApiUidItemSize;
hgs
parents:
diff changeset
   136
        }
hgs
parents:
diff changeset
   137
    
hgs
parents:
diff changeset
   138
    HBufC8* writeBuf = HBufC8::NewLC( writeBufSize );
hgs
parents:
diff changeset
   139
    TPtr8 writePtr = writeBuf->Des();
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
    // Read and write streams used to read/write the UIDs from/to descriptors
hgs
parents:
diff changeset
   142
    RDesReadStream readStream( readPtr );
hgs
parents:
diff changeset
   143
    CleanupClosePushL( readStream );
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
    RDesWriteStream writeStream( writePtr );
hgs
parents:
diff changeset
   146
    CleanupClosePushL( writeStream );
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
    // Get our own process UID
hgs
parents:
diff changeset
   149
    RProcess ownProcess;
hgs
parents:
diff changeset
   150
    TUid ownUid = ownProcess.SecureId();
hgs
parents:
diff changeset
   151
    ownProcess.Close();
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
    TInt itemsCount = readPtr.Length() / KEmailPlatformApiUidItemSize;
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
    TBool ownUidFound = EFalse;
hgs
parents:
diff changeset
   156
    TInt writeLength = 0;
hgs
parents:
diff changeset
   157
    for ( TInt ii = 0;ii < itemsCount; ++ii )
hgs
parents:
diff changeset
   158
        {
hgs
parents:
diff changeset
   159
        // Read next UID from the stream
hgs
parents:
diff changeset
   160
        TUid item = TUid::Uid( readStream.ReadInt32L() );
hgs
parents:
diff changeset
   161
        
hgs
parents:
diff changeset
   162
        // We can skip our own UID. If we are removing, then we don't want
hgs
parents:
diff changeset
   163
        // our UID to be written. If we are adding, we don't need to set
hgs
parents:
diff changeset
   164
        // the new values as our UID already exists in the list.
hgs
parents:
diff changeset
   165
        if( item == ownUid )
hgs
parents:
diff changeset
   166
            {
hgs
parents:
diff changeset
   167
            ownUidFound = ETrue;
hgs
parents:
diff changeset
   168
            if( aMode == EEmailUidModeAppend )
hgs
parents:
diff changeset
   169
                {
hgs
parents:
diff changeset
   170
                // Our own UID is already in the list, so no need to update
hgs
parents:
diff changeset
   171
                // the list. Hence we can quit here.
hgs
parents:
diff changeset
   172
                break;
hgs
parents:
diff changeset
   173
                }
hgs
parents:
diff changeset
   174
            }
hgs
parents:
diff changeset
   175
        else
hgs
parents:
diff changeset
   176
            {
hgs
parents:
diff changeset
   177
            writeStream.WriteInt32L( item.iUid );
hgs
parents:
diff changeset
   178
            writeLength += KEmailPlatformApiUidItemSize;
hgs
parents:
diff changeset
   179
            }
hgs
parents:
diff changeset
   180
        }
hgs
parents:
diff changeset
   181
hgs
parents:
diff changeset
   182
    // If we are appending our UID and it wasn't found from the list,
hgs
parents:
diff changeset
   183
    // write it to the stream
hgs
parents:
diff changeset
   184
    if( aMode == EEmailUidModeAppend && !ownUidFound )
hgs
parents:
diff changeset
   185
        {
hgs
parents:
diff changeset
   186
        writeStream.WriteInt32L( ownUid.iUid );
hgs
parents:
diff changeset
   187
        writeLength += KEmailPlatformApiUidItemSize;
hgs
parents:
diff changeset
   188
        }
hgs
parents:
diff changeset
   189
hgs
parents:
diff changeset
   190
    // Set correct length for the write ptr buffer as it might not be
hgs
parents:
diff changeset
   191
    // updated correctly by the write stream
hgs
parents:
diff changeset
   192
    writePtr.SetLength( writeLength );
hgs
parents:
diff changeset
   193
hgs
parents:
diff changeset
   194
    // Set new values to P&S only if something has changed, so either:
hgs
parents:
diff changeset
   195
    // 1) We are appending our UID and it didn't exist before
hgs
parents:
diff changeset
   196
    // 2) We are removing our UID and it did exist before
hgs
parents:
diff changeset
   197
    if( ( aMode == EEmailUidModeAppend && !ownUidFound ) ||
hgs
parents:
diff changeset
   198
        ( aMode == EEmailUidModeRemove && ownUidFound ) )
hgs
parents:
diff changeset
   199
        {
hgs
parents:
diff changeset
   200
        // Write first the UID list as it is more probable to fail, writing
hgs
parents:
diff changeset
   201
        // plain integer value shouldn't fail in any case. This way these
hgs
parents:
diff changeset
   202
        // values stay in sync also in case of error, as the list length
hgs
parents:
diff changeset
   203
        // gets updated only if the list itself is updated succesfully.
hgs
parents:
diff changeset
   204
        User::LeaveIfError( RProperty::Set( KEmailShutdownPsCategory,
hgs
parents:
diff changeset
   205
                        EEmailPsKeyPlatformApiAppsToClose,
hgs
parents:
diff changeset
   206
                        writePtr ) );
hgs
parents:
diff changeset
   207
hgs
parents:
diff changeset
   208
        User::LeaveIfError( RProperty::Set( KEmailShutdownPsCategory,
hgs
parents:
diff changeset
   209
                        EEmailPsKeyPlatformApiAppsToCloseLength,
hgs
parents:
diff changeset
   210
                        writeLength ) );
hgs
parents:
diff changeset
   211
        }
hgs
parents:
diff changeset
   212
hgs
parents:
diff changeset
   213
    CleanupStack::PopAndDestroy( 4, readBuf );
hgs
parents:
diff changeset
   214
    }
hgs
parents:
diff changeset
   215
hgs
parents:
diff changeset
   216
// End of file