satengine/satserver/SatInternalClient/src/CSatCQueryHandler.cpp
author hgs
Fri, 03 Sep 2010 13:59:20 +0300
changeset 46 2fa1fa551b0b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2008 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 is the handler for various query requests related to
hgs
parents:
diff changeset
    15
*                those SIM Application Toolkit proactive commands that require
hgs
parents:
diff changeset
    16
*                user permissions to complete their actions.
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDE FILES
hgs
parents:
diff changeset
    23
#include    <e32base.h>
hgs
parents:
diff changeset
    24
#include    <e32svr.h>
hgs
parents:
diff changeset
    25
#include    "RSatUiSession.h"
hgs
parents:
diff changeset
    26
#include    "MSatUiObserver.h"
hgs
parents:
diff changeset
    27
#include    "SatSOpcodes.h"
hgs
parents:
diff changeset
    28
#include    "CSatCQueryHandler.h"
hgs
parents:
diff changeset
    29
#include    "SatLog.h"
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// CONSTANTS
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// This will contain the Window Group Id of SAT UI
hgs
parents:
diff changeset
    34
const TInt KSatUiWgId = -1;
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
// ============================ MEMBER FUNCTIONS ===============================
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    39
// CSatCQueryHandler::CSatCQueryHandler
hgs
parents:
diff changeset
    40
// C++ default constructor can NOT contain any code, that
hgs
parents:
diff changeset
    41
// might leave.
hgs
parents:
diff changeset
    42
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    43
//
hgs
parents:
diff changeset
    44
//lint -e{1403, 1769} Can not be initialized, harmless.
hgs
parents:
diff changeset
    45
CSatCQueryHandler::CSatCQueryHandler(
hgs
parents:
diff changeset
    46
    TInt aPriority,
hgs
parents:
diff changeset
    47
    RSatUiSession* aSession ) :
hgs
parents:
diff changeset
    48
    CActive( aPriority ),
hgs
parents:
diff changeset
    49
    iSession( aSession ),
hgs
parents:
diff changeset
    50
    iQueryData(),
hgs
parents:
diff changeset
    51
    iQueryPckg( iQueryData ),
hgs
parents:
diff changeset
    52
    iQueryRsp(),
hgs
parents:
diff changeset
    53
    iQueryRspPckg( iQueryRsp )
hgs
parents:
diff changeset
    54
    {
hgs
parents:
diff changeset
    55
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::CSatCQueryHandler calling" )
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    // Add to active scheduler.
hgs
parents:
diff changeset
    58
    CActiveScheduler::Add( this );
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::CSatCQueryHandler exiting" )
hgs
parents:
diff changeset
    61
    }
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    64
// CSatCQueryHandler::NewL
hgs
parents:
diff changeset
    65
// Two-phased constructor.
hgs
parents:
diff changeset
    66
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    67
//
hgs
parents:
diff changeset
    68
CSatCQueryHandler* CSatCQueryHandler::NewL(
hgs
parents:
diff changeset
    69
    RSatUiSession* aSat )
hgs
parents:
diff changeset
    70
    {
hgs
parents:
diff changeset
    71
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::NewL calling" )
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
    // Perform construction.
hgs
parents:
diff changeset
    74
    CSatCQueryHandler* self =
hgs
parents:
diff changeset
    75
        new ( ELeave ) CSatCQueryHandler( EPriorityLow, aSat );
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::NewL exiting" )
hgs
parents:
diff changeset
    78
    return self;
hgs
parents:
diff changeset
    79
    }
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
// Destructor
hgs
parents:
diff changeset
    82
CSatCQueryHandler::~CSatCQueryHandler()
hgs
parents:
diff changeset
    83
    {
hgs
parents:
diff changeset
    84
    LOG( SIMPLE,
hgs
parents:
diff changeset
    85
        "SATINTERNALCLIENT: CSatCQueryHandler::~CSatCQueryHandler calling" )
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
    // Cancel any outstanding requests.
hgs
parents:
diff changeset
    88
    Cancel();
hgs
parents:
diff changeset
    89
    iSession = NULL;
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
    LOG( SIMPLE,
hgs
parents:
diff changeset
    92
        "SATINTERNALCLIENT: CSatCQueryHandler::~CSatCQueryHandler exiting" )
hgs
parents:
diff changeset
    93
    }
hgs
parents:
diff changeset
    94
hgs
parents:
diff changeset
    95
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    96
// CSatCQueryHandler::Start
hgs
parents:
diff changeset
    97
// Starts the handler.
hgs
parents:
diff changeset
    98
// (other items were commented in a header).
hgs
parents:
diff changeset
    99
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   100
//
hgs
parents:
diff changeset
   101
void CSatCQueryHandler::Start()
hgs
parents:
diff changeset
   102
    {
hgs
parents:
diff changeset
   103
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::Start calling" )
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
    // Empty the IPC data
hgs
parents:
diff changeset
   106
    TSatQueryV1 temp;
hgs
parents:
diff changeset
   107
    iQueryData = temp;
hgs
parents:
diff changeset
   108
    TSatQueryRspV1 temp2;
hgs
parents:
diff changeset
   109
    temp2.iAccepted = EFalse;
hgs
parents:
diff changeset
   110
    temp2.iCommand = ESatSSendSmQuery;
hgs
parents:
diff changeset
   111
    iQueryRsp = temp2;
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
    // Request queries notification.
hgs
parents:
diff changeset
   114
    TIpcArgs arguments( &iQueryPckg );
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
    // Pass the Query IPC package.
hgs
parents:
diff changeset
   117
    iSession->CreateRequest( ESatSProactiveQuery, arguments, iStatus );
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
    // Set this handler to active so that it can receive requests.
hgs
parents:
diff changeset
   120
    SetActive();
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::Start exiting" )
hgs
parents:
diff changeset
   123
    }
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   126
// CSatCQueryHandler::RunL
hgs
parents:
diff changeset
   127
// Handles the command.
hgs
parents:
diff changeset
   128
// (other items were commented in a header).
hgs
parents:
diff changeset
   129
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   130
//
hgs
parents:
diff changeset
   131
void CSatCQueryHandler::RunL()
hgs
parents:
diff changeset
   132
    {
hgs
parents:
diff changeset
   133
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::RunL calling" )
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
    // Check the status of the asnychronous operation
hgs
parents:
diff changeset
   136
    if ( KErrNone != iStatus.Int() )
hgs
parents:
diff changeset
   137
        {
hgs
parents:
diff changeset
   138
        LOG2(
hgs
parents:
diff changeset
   139
            SIMPLE,
hgs
parents:
diff changeset
   140
            "SATINTERNALCLIENT: CSatCQueryHandler::RunL error: %d",
hgs
parents:
diff changeset
   141
            iStatus.Int() )
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
        // Renew the request
hgs
parents:
diff changeset
   144
        Start();
hgs
parents:
diff changeset
   145
        }
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
    else
hgs
parents:
diff changeset
   148
        {
hgs
parents:
diff changeset
   149
        // This will contain the result of the user query.
hgs
parents:
diff changeset
   150
        TBool userQuery( EFalse );
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
        // This will contain EFalse if requested icon is not displayed.
hgs
parents:
diff changeset
   153
        // And if icon is displayed, it contains ETrue.
hgs
parents:
diff changeset
   154
        TBool requestedIconDisplayed( EFalse );
hgs
parents:
diff changeset
   155
hgs
parents:
diff changeset
   156
        // This will contain the result that has the user pressed end key.
hgs
parents:
diff changeset
   157
        TBool terminatedByUser( EFalse );
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
        // Use general configm function
hgs
parents:
diff changeset
   160
        iSession->SatUiObserver()->ConfirmCommand(
hgs
parents:
diff changeset
   161
            iQueryData.iCommand,
hgs
parents:
diff changeset
   162
            iQueryData.iAlphaIdStatus,
hgs
parents:
diff changeset
   163
            iQueryData.iQueryText,
hgs
parents:
diff changeset
   164
            iQueryData.iSimApplicationName,
hgs
parents:
diff changeset
   165
            userQuery,
hgs
parents:
diff changeset
   166
            iQueryData.iIconId,
hgs
parents:
diff changeset
   167
            requestedIconDisplayed,
hgs
parents:
diff changeset
   168
            terminatedByUser );
hgs
parents:
diff changeset
   169
hgs
parents:
diff changeset
   170
        // Return the result of the query to the server.
hgs
parents:
diff changeset
   171
        iQueryRsp.iAccepted = userQuery;
hgs
parents:
diff changeset
   172
        iQueryRsp.iCommand = iQueryData.iCommand;
hgs
parents:
diff changeset
   173
        iQueryRsp.iWgId = KSatUiWgId;
hgs
parents:
diff changeset
   174
        iQueryRsp.iRequestedIconDisplayed = requestedIconDisplayed;
hgs
parents:
diff changeset
   175
        iQueryRsp.iSessionTerminatedByUser = terminatedByUser;
hgs
parents:
diff changeset
   176
hgs
parents:
diff changeset
   177
        // Pass the Query response IPC package.
hgs
parents:
diff changeset
   178
        TIpcArgs arguments( &iQueryRspPckg );
hgs
parents:
diff changeset
   179
hgs
parents:
diff changeset
   180
        // Perform the IPC data transfer.
hgs
parents:
diff changeset
   181
        iSession->CreateRequest( ESatSProactiveQueryResponse, arguments );
hgs
parents:
diff changeset
   182
hgs
parents:
diff changeset
   183
        Start();
hgs
parents:
diff changeset
   184
        }
hgs
parents:
diff changeset
   185
hgs
parents:
diff changeset
   186
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::RunL exiting" )
hgs
parents:
diff changeset
   187
    }
hgs
parents:
diff changeset
   188
hgs
parents:
diff changeset
   189
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   190
// CSatCQueryHandler::DoCancel
hgs
parents:
diff changeset
   191
// Cancels the pending request.
hgs
parents:
diff changeset
   192
// (other items were commented in a header).
hgs
parents:
diff changeset
   193
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   194
//
hgs
parents:
diff changeset
   195
void CSatCQueryHandler::DoCancel()
hgs
parents:
diff changeset
   196
    {
hgs
parents:
diff changeset
   197
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::DoCancel calling" )
hgs
parents:
diff changeset
   198
hgs
parents:
diff changeset
   199
    // Complete the request with cancel code.
hgs
parents:
diff changeset
   200
    TRequestStatus* requestStatus = &iStatus;
hgs
parents:
diff changeset
   201
    User::RequestComplete( requestStatus, KErrCancel );
hgs
parents:
diff changeset
   202
hgs
parents:
diff changeset
   203
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCQueryHandler::DoCancel exiting" )
hgs
parents:
diff changeset
   204
    }
hgs
parents:
diff changeset
   205
hgs
parents:
diff changeset
   206
//  End of File