messagingapp/msgappfw/plugins/previewplugin/inc/ccspreviewpluginhandler.h
author hgs
Sun, 25 Jul 2010 18:59:19 +0530
changeset 48 4f501b74aeb1
parent 37 518b245aa84c
permissions -rw-r--r--
201029_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2007 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:  Message Preview Handler
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef _C_CS_PREVIEW_PLUGIN_HANDLER_H_
hgs
parents:
diff changeset
    19
#define _C_CS_PREVIEW_PLUGIN_HANDLER_H_
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
//SYSTEM INCLUDES
hgs
parents:
diff changeset
    22
#include <msvapi.h>
hgs
parents:
diff changeset
    23
#include <f32file.h>
hgs
parents:
diff changeset
    24
#include <thumbnailmanager.h>
hgs
parents:
diff changeset
    25
#include <thumbnailmanagerobserver.h>
hgs
parents:
diff changeset
    26
#include <thumbnaildata.h>
hgs
parents:
diff changeset
    27
#include <sqldb.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
//USER INCLUDES
hgs
parents:
diff changeset
    30
#include <ccsdefs.h>
hgs
parents:
diff changeset
    31
#include "ccspreviewplugin.h"
hgs
parents:
diff changeset
    32
#include "UniDataModel.h"
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
// FORWARD DECLARATION
hgs
parents:
diff changeset
    35
class CCsPlugin;
hgs
parents:
diff changeset
    36
class CMsvSession;
hgs
parents:
diff changeset
    37
class MCsPluginEventObserver;
hgs
parents:
diff changeset
    38
class MMsvSessionObserver;
hgs
parents:
diff changeset
    39
class CCsConversationEntry;
hgs
parents:
diff changeset
    40
class CCsPreviewPlugin;
hgs
parents:
diff changeset
    41
class CClientMtmRegistry;
hgs
parents:
diff changeset
    42
class CMmsClientMtm;
48
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
    43
class CBIOClientMtm;
37
hgs
parents:
diff changeset
    44
class CUniDataModel;
hgs
parents:
diff changeset
    45
class MMsvAttachmentManager;
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
enum MmsConformanceCheckErrors
hgs
parents:
diff changeset
    48
{
hgs
parents:
diff changeset
    49
    EInsertSuccess = 0, EInsertQueryAbort, EInsertNotSupported
hgs
parents:
diff changeset
    50
};
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
/*
hgs
parents:
diff changeset
    53
 * Thumbnail Request Data
hgs
parents:
diff changeset
    54
 */
hgs
parents:
diff changeset
    55
struct ThumbnailRequestData
hgs
parents:
diff changeset
    56
    {
hgs
parents:
diff changeset
    57
    /*
hgs
parents:
diff changeset
    58
     * Request Id
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
    TThumbnailRequestId iRequestId;
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    /*
hgs
parents:
diff changeset
    63
     * Message Id
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    TMsvId iMsgId;
hgs
parents:
diff changeset
    66
    };
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
/**
hgs
parents:
diff changeset
    69
 *  This class interacts with MsvServer to fetch message data
hgs
parents:
diff changeset
    70
 */
hgs
parents:
diff changeset
    71
class CCsPreviewPluginHandler : public CBase,
hgs
parents:
diff changeset
    72
        public MMsvSessionObserver,
hgs
parents:
diff changeset
    73
        public MUniDataModelObserver,
hgs
parents:
diff changeset
    74
        public MThumbnailManagerObserver
hgs
parents:
diff changeset
    75
    {
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
public:
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
     * Two phase construction
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    static CCsPreviewPluginHandler* NewL(CCsPreviewPlugin *aMsgObserver);
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * Destructor
hgs
parents:
diff changeset
    86
     */
hgs
parents:
diff changeset
    87
    virtual ~CCsPreviewPluginHandler();
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
public:
hgs
parents:
diff changeset
    90
    //MMsvSessionObserver
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * Handles the MsvServer updates. Implemented for MMsvSessionObserver
hgs
parents:
diff changeset
    93
     */
hgs
parents:
diff changeset
    94
    void HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1,
hgs
parents:
diff changeset
    95
            TAny* aArg2, TAny* aArg3);
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
public:
hgs
parents:
diff changeset
    98
    //MUniDataModelObserver
hgs
parents:
diff changeset
    99
    /**
hgs
parents:
diff changeset
   100
     */
hgs
parents:
diff changeset
   101
    void RestoreReady(TInt aParseResult, TInt aError);
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
public:
hgs
parents:
diff changeset
   104
    // Callbacks from MThumbnailManagerObserver for getting thumbnails
hgs
parents:
diff changeset
   105
    void ThumbnailPreviewReady(MThumbnailData& aThumbnail,
hgs
parents:
diff changeset
   106
            TThumbnailRequestId aId);
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
    void ThumbnailReady(TInt aError, MThumbnailData& aThumbnail,
hgs
parents:
diff changeset
   109
            TThumbnailRequestId aId);
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
public:
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
    /*
hgs
parents:
diff changeset
   114
     * Compare by request Id.
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    static TBool CompareByRequestId(const ThumbnailRequestData& aFirst,
hgs
parents:
diff changeset
   117
            const ThumbnailRequestData& aSecond);
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
private:
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
    /**
hgs
parents:
diff changeset
   122
     * Constructor   
hgs
parents:
diff changeset
   123
     */
hgs
parents:
diff changeset
   124
    CCsPreviewPluginHandler();
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
    /**
hgs
parents:
diff changeset
   127
     * 2nd phase construtor
hgs
parents:
diff changeset
   128
     */
hgs
parents:
diff changeset
   129
    void ConstructL(CCsPreviewPlugin *aMsgPlugin);
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
    /**
hgs
parents:
diff changeset
   132
     * Process each entry
hgs
parents:
diff changeset
   133
     *@param aSelection, CMsvEntrySelections
hgs
parents:
diff changeset
   134
     */
hgs
parents:
diff changeset
   135
    void HandleEventL(CMsvEntrySelection* aSelection);
48
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   136
    
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   137
    /**
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   138
     * Process MMS entry
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   139
     *@param aEntry, TMsvEntry
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   140
     */
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   141
    void HandleMMSEntryL(const TMsvEntry& aEntry);
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   142
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   143
    /**
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   144
     * Process VCard enry
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   145
     *@param aEntry, TMsvEntry
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   146
     */
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   147
    void HandleVCardEntryL(const TMsvEntry& aEntry);
37
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
    /**
hgs
parents:
diff changeset
   150
     * Bind bodytext to sql statement.
hgs
parents:
diff changeset
   151
     *@param sqlStmt, RSqlStatement
hgs
parents:
diff changeset
   152
     *@param attachmentId, TMsvAttachmentId
hgs
parents:
diff changeset
   153
     */
hgs
parents:
diff changeset
   154
    void BindBodyText(RSqlStatement& sqlStmt, TMsvAttachmentId attachmentId);
hgs
parents:
diff changeset
   155
hgs
parents:
diff changeset
   156
    /**
hgs
parents:
diff changeset
   157
     * Get Thumbnail data from attachment
hgs
parents:
diff changeset
   158
     *@param attachmentId, TMsvAttachmentId
hgs
parents:
diff changeset
   159
     *@param mimeType, 
hgs
parents:
diff changeset
   160
     *@param msgId, message id
hgs
parents:
diff changeset
   161
     */
hgs
parents:
diff changeset
   162
    void GetThumbNailL(TMsvAttachmentId attachmentId, TDesC8& mimeType,
hgs
parents:
diff changeset
   163
            TMsvId msgId);
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
    /*
hgs
parents:
diff changeset
   166
     * Process Thumbnail data
hgs
parents:
diff changeset
   167
     * @param aThumbnail MThumbnailData
hgs
parents:
diff changeset
   168
     * @param aId TThumbnailRequestId
hgs
parents:
diff changeset
   169
     */
hgs
parents:
diff changeset
   170
    void HandleThumbnailReadyL(MThumbnailData& aThumbnail,
hgs
parents:
diff changeset
   171
            TThumbnailRequestId aId);
hgs
parents:
diff changeset
   172
hgs
parents:
diff changeset
   173
    /**
hgs
parents:
diff changeset
   174
     * Validates if message can be forwarded
hgs
parents:
diff changeset
   175
     * The validation checks include slide count check,MMS size check and
hgs
parents:
diff changeset
   176
     * media conformance checks and this fucntion should be called only for mms
hgs
parents:
diff changeset
   177
     * @param aUniDataModel, instance of unidatamodel
hgs
parents:
diff changeset
   178
     * @return true if message can be forwarded
hgs
parents:
diff changeset
   179
     *         false if message cant be forwarded
hgs
parents:
diff changeset
   180
     */
hgs
parents:
diff changeset
   181
    TBool ValidateMsgForForward(CUniDataModel* aUniDataModel);
hgs
parents:
diff changeset
   182
hgs
parents:
diff changeset
   183
    /**
hgs
parents:
diff changeset
   184
     * This shall return the particular slide attachments ids
hgs
parents:
diff changeset
   185
     * @param aSlideNum slide count
hgs
parents:
diff changeset
   186
     * @param aUniDataModel instance of unidatamodel
hgs
parents:
diff changeset
   187
     * @return array of attachment id's
hgs
parents:
diff changeset
   188
     */
hgs
parents:
diff changeset
   189
    RArray<TMsvAttachmentId>* GetSlideAttachmentIds(
hgs
parents:
diff changeset
   190
            TInt aSlideNum,
hgs
parents:
diff changeset
   191
            CUniDataModel* aUniDataModel);
hgs
parents:
diff changeset
   192
hgs
parents:
diff changeset
   193
    /**
hgs
parents:
diff changeset
   194
     * This shall return list of attachment id's
hgs
parents:
diff changeset
   195
     * @param aUniDataModel instance of unidatamodel
hgs
parents:
diff changeset
   196
     * @return array of attachment id's
hgs
parents:
diff changeset
   197
     */
hgs
parents:
diff changeset
   198
    RArray<TMsvAttachmentId>* GetAttachmentIdList(
hgs
parents:
diff changeset
   199
            CUniDataModel* aUniDataModel);
hgs
parents:
diff changeset
   200
hgs
parents:
diff changeset
   201
    /**
hgs
parents:
diff changeset
   202
     * This shall check the insert mode for the attachment file
hgs
parents:
diff changeset
   203
     * @param aFileHandle instance of file handle
hgs
parents:
diff changeset
   204
     * @return enum MmsConformanceCheckErrors
hgs
parents:
diff changeset
   205
     */
hgs
parents:
diff changeset
   206
    TInt CheckModeForInsertL(RFile aFileHandle);
hgs
parents:
diff changeset
   207
    
hgs
parents:
diff changeset
   208
    /**
hgs
parents:
diff changeset
   209
     * Finds the message's processing state
hgs
parents:
diff changeset
   210
     * @param aMsgId, message id
hgs
parents:
diff changeset
   211
     * @return, TInt from TCsPreviewMsgProcessingState enum
hgs
parents:
diff changeset
   212
     */
hgs
parents:
diff changeset
   213
    TInt msgProcessingState(TMsvId aMsgId);
hgs
parents:
diff changeset
   214
    
hgs
parents:
diff changeset
   215
    /**
hgs
parents:
diff changeset
   216
     * Sets message under processing to true
hgs
parents:
diff changeset
   217
     * @param aMsgId, message id
hgs
parents:
diff changeset
   218
     * @param aState, TInt from TCsPreviewMsgProcessingState enum
hgs
parents:
diff changeset
   219
     */
hgs
parents:
diff changeset
   220
    void setMsgProcessingState(TMsvId aMsgId, TInt aState);
hgs
parents:
diff changeset
   221
hgs
parents:
diff changeset
   222
private:
hgs
parents:
diff changeset
   223
    //Data
hgs
parents:
diff changeset
   224
hgs
parents:
diff changeset
   225
    /**
hgs
parents:
diff changeset
   226
     * MsvServer session object
hgs
parents:
diff changeset
   227
     * Own
hgs
parents:
diff changeset
   228
     */
hgs
parents:
diff changeset
   229
    CMsvSession* iSession;
hgs
parents:
diff changeset
   230
hgs
parents:
diff changeset
   231
    /**
hgs
parents:
diff changeset
   232
     * iMsgObserver
hgs
parents:
diff changeset
   233
     * The Observer interface
hgs
parents:
diff changeset
   234
     * Not Own.
hgs
parents:
diff changeset
   235
     */
hgs
parents:
diff changeset
   236
    CCsPreviewPlugin *iMsgObserver;
hgs
parents:
diff changeset
   237
hgs
parents:
diff changeset
   238
    /**
hgs
parents:
diff changeset
   239
     * Mtm registry object
hgs
parents:
diff changeset
   240
     * Own
hgs
parents:
diff changeset
   241
     */
hgs
parents:
diff changeset
   242
    CClientMtmRegistry* iMtmRegistry;
hgs
parents:
diff changeset
   243
hgs
parents:
diff changeset
   244
    /**
hgs
parents:
diff changeset
   245
     * Mms client mtm object
hgs
parents:
diff changeset
   246
     * Own.
hgs
parents:
diff changeset
   247
     */
hgs
parents:
diff changeset
   248
    CMmsClientMtm* iMmsMtm;
48
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   249
    
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   250
    /**
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   251
     * BioMsg client mtm object
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   252
     * Own.
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   253
     */
4f501b74aeb1 201029_02
hgs
parents: 37
diff changeset
   254
    CBIOClientMtm* iBioClientMtm;
37
hgs
parents:
diff changeset
   255
hgs
parents:
diff changeset
   256
    /*
hgs
parents:
diff changeset
   257
     * File session
hgs
parents:
diff changeset
   258
     */
hgs
parents:
diff changeset
   259
    RFs ifsSession;
hgs
parents:
diff changeset
   260
hgs
parents:
diff changeset
   261
    /*
hgs
parents:
diff changeset
   262
     * Thumbnail request array.
hgs
parents:
diff changeset
   263
     * Own
hgs
parents:
diff changeset
   264
     */
hgs
parents:
diff changeset
   265
    RArray<ThumbnailRequestData> iThumbnailRequestArray;
hgs
parents:
diff changeset
   266
hgs
parents:
diff changeset
   267
    /*
hgs
parents:
diff changeset
   268
     * Thumbnail manager.
hgs
parents:
diff changeset
   269
     * Own
hgs
parents:
diff changeset
   270
     */
hgs
parents:
diff changeset
   271
    CThumbnailManager* iThumbnailManager;
hgs
parents:
diff changeset
   272
hgs
parents:
diff changeset
   273
    /*
hgs
parents:
diff changeset
   274
     * Sqlite DB Handle
hgs
parents:
diff changeset
   275
     */
hgs
parents:
diff changeset
   276
    RSqlDatabase iSqlDb;
hgs
parents:
diff changeset
   277
hgs
parents:
diff changeset
   278
    /**
hgs
parents:
diff changeset
   279
     * Max MMS Size
hgs
parents:
diff changeset
   280
    */
hgs
parents:
diff changeset
   281
    TInt iMaxMmsSize;
hgs
parents:
diff changeset
   282
hgs
parents:
diff changeset
   283
    /*
hgs
parents:
diff changeset
   284
     * Mms creation mode
hgs
parents:
diff changeset
   285
     */
hgs
parents:
diff changeset
   286
    TInt iCreationMode;
hgs
parents:
diff changeset
   287
hgs
parents:
diff changeset
   288
    /**
hgs
parents:
diff changeset
   289
     * Conformance status
hgs
parents:
diff changeset
   290
     */
hgs
parents:
diff changeset
   291
    TUint32 iConfStatus;
hgs
parents:
diff changeset
   292
hgs
parents:
diff changeset
   293
};
hgs
parents:
diff changeset
   294
hgs
parents:
diff changeset
   295
#endif // _C_CS_PREVIEW_PLUGIN_HANDLER_H_