31
|
1 |
/*
|
|
2 |
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef BTNOTIFPAIRNOTIFIER_H
|
|
19 |
#define BTNOTIFPAIRNOTIFIER_H
|
|
20 |
|
|
21 |
#include <e32base.h>
|
|
22 |
#include <btmanclient.h>
|
42
|
23 |
#include <hb/hbcore/hbsymbianvariant.h>
|
31
|
24 |
#include "bluetoothdevicedialogs.h"
|
|
25 |
#include "btnotificationresult.h"
|
|
26 |
#include "bluetoothtrace.h"
|
|
27 |
|
42
|
28 |
class CBTNotifSecurityManager;
|
31
|
29 |
class CBTNotifConnectionTracker;
|
|
30 |
class CBluetoothNotification;
|
|
31 |
|
|
32 |
/**
|
42
|
33 |
* Helper class for performing user prompt for pairing.
|
31
|
34 |
*
|
|
35 |
* The design of this class is focussed on structure and maintainability first.
|
|
36 |
* Duplicate (state) information is kept to a minimum. And memory usage comes
|
|
37 |
* before processing. Pairing is an infrequent operation, and this class is
|
|
38 |
* only instantiated when there is pairing-related processing, so extreme
|
|
39 |
* focus on memory or processing efficiency would have relatively little effect.
|
|
40 |
*
|
|
41 |
* @since Symbian^4
|
|
42 |
*/
|
|
43 |
NONSHARABLE_CLASS( CBTNotifPairNotifier ) : public CBase,
|
|
44 |
public MBTNotificationResult
|
|
45 |
{
|
|
46 |
|
|
47 |
public:
|
|
48 |
|
|
49 |
/**
|
|
50 |
* Two-phased constructor.
|
|
51 |
* @param aConnection Pointer to the parent.
|
|
52 |
* @param aDevice Pointer to information of the remote device.
|
|
53 |
* aParam The owner of this object
|
|
54 |
*/
|
42
|
55 |
static CBTNotifPairNotifier* NewL( CBTNotifSecurityManager& aParent );
|
31
|
56 |
|
|
57 |
/**
|
|
58 |
* Destructor.
|
|
59 |
*/
|
|
60 |
virtual ~CBTNotifPairNotifier();
|
|
61 |
|
|
62 |
/**
|
|
63 |
* Handle a notifier request for pairing with the remote device
|
|
64 |
* of this connection.
|
|
65 |
*
|
|
66 |
* @since Symbian^4
|
|
67 |
* @param aMessage The client of this request.
|
|
68 |
*/
|
|
69 |
void StartPairingNotifierL( const RMessage2& aMessage );
|
|
70 |
|
|
71 |
/**
|
|
72 |
* Update an outstanding request for this connection.
|
|
73 |
*
|
|
74 |
* @since Symbian^4
|
57
|
75 |
* @param aMessage.
|
31
|
76 |
*/
|
57
|
77 |
void CBTNotifPairNotifier::UpdatePairingNotifierL( const RMessage2& aMessage);
|
31
|
78 |
|
|
79 |
/**
|
|
80 |
* Cancel an outstanding request for this connection.
|
|
81 |
*
|
|
82 |
* @since Symbian^4
|
|
83 |
* @param aUid The UID of the notifier for this pairing request.
|
|
84 |
*/
|
|
85 |
void CancelPairingNotifierL( TInt aUid );
|
|
86 |
|
|
87 |
// from base class MBTNotificationResult
|
|
88 |
|
|
89 |
/**
|
|
90 |
* From MBTNotificationResult.
|
|
91 |
* Handle an intermediate result from a user query.
|
|
92 |
* This function is called if the user query passes information
|
|
93 |
* back before it has finished i.e. is dismissed. The final acceptance/
|
|
94 |
* denial of a query is passed back in MBRNotificationClosed.
|
|
95 |
*
|
|
96 |
* @since Symbian^4
|
|
97 |
* @param aData the returned data. The actual format
|
|
98 |
* is dependent on the actual notifier.
|
|
99 |
*/
|
|
100 |
virtual void MBRDataReceived( CHbSymbianVariantMap& aData );
|
|
101 |
|
|
102 |
/**
|
|
103 |
* From MBTNotificationResult.
|
|
104 |
* The notification is finished. The resulting data (e.g. user input or
|
|
105 |
* acceptance/denial of the query) is passed back here.
|
|
106 |
*
|
|
107 |
* @since Symbian^4
|
|
108 |
* @param aErr KErrNone or one of the system-wide error codes.
|
|
109 |
* @param aData the returned data. The actual format
|
|
110 |
* is dependent on the actual notifier.
|
|
111 |
*/
|
|
112 |
virtual void MBRNotificationClosed( TInt aError, const TDesC8& aData );
|
|
113 |
|
|
114 |
private:
|
|
115 |
|
|
116 |
/**
|
|
117 |
* C++ default constructor.
|
|
118 |
*/
|
42
|
119 |
CBTNotifPairNotifier( CBTNotifSecurityManager& aParent );
|
31
|
120 |
|
|
121 |
/**
|
|
122 |
* Symbian 2nd-phase constructor.
|
|
123 |
*/
|
|
124 |
void ConstructL();
|
|
125 |
|
|
126 |
void StartPairingUserInputL();
|
|
127 |
|
|
128 |
/**
|
|
129 |
* Process the user input and complete the outstanding pairing request.
|
|
130 |
*
|
|
131 |
* @since Symbian^4
|
|
132 |
* @param aError The result off the notification.
|
|
133 |
* @param aResult The user response; ETrue if the user accepted the query,
|
|
134 |
* otherwise EFalse.
|
|
135 |
* @param aData The data returned from the notification dialog.
|
|
136 |
*/
|
|
137 |
void CompletePairingNotifierL( TInt aError, TBool aResult, const TDesC8& aData );
|
|
138 |
|
|
139 |
/**
|
|
140 |
* Ask the user to allow incoming pairing.
|
|
141 |
*
|
|
142 |
* @since Symbian^4
|
|
143 |
*/
|
|
144 |
void StartAcceptPairingQueryL();
|
|
145 |
|
|
146 |
/**
|
|
147 |
* Process the user input and for accepting an incoming pairing and
|
|
148 |
* continue with the outstanding pairing request.
|
|
149 |
*
|
|
150 |
* @since Symbian^4
|
|
151 |
* @param aError The result of the notification.
|
|
152 |
* @param aResult The user response; ETrue if the user accepted the query,
|
|
153 |
* otherwise EFalse.
|
|
154 |
*/
|
42
|
155 |
void CompleteAcceptPairingQueryL( TInt aError);
|
31
|
156 |
|
|
157 |
/**
|
|
158 |
* Parse the parameters of a request for pairing.
|
|
159 |
* This function also returns values to use for dialog config, and sets
|
|
160 |
* the operation state member variable (iOperation).
|
|
161 |
*
|
|
162 |
* @since Symbian^4
|
|
163 |
*/
|
|
164 |
void ParseNotifierReqParamsL();
|
|
165 |
|
|
166 |
/**
|
|
167 |
* Parse the parameters of a request for pairing using pin query.
|
|
168 |
*
|
|
169 |
* @since Symbian^4
|
|
170 |
* @param aLocallyInitiated On return, will be set to ETrue if the pairing
|
|
171 |
* was initiated by us.
|
|
172 |
* @param aMinPinLength On return, this will contain the minimum passcode length.
|
|
173 |
*/
|
|
174 |
void ParseLegacyPinCodeReqParamsL( TBool& aLocallyInitiated,
|
|
175 |
TInt& aMinPinLength, TBTDevAddr& aAddr );
|
|
176 |
|
|
177 |
/**
|
|
178 |
* Parse the parameters of a request for pairing using pin query.
|
|
179 |
*
|
|
180 |
* @since Symbian^4
|
|
181 |
* @param aLocallyInitiated On return, will be set to ETrue if the pairing
|
|
182 |
* was initiated by us.
|
|
183 |
* @param aMinPinLength On return, this will contain the minimum passcode length.
|
|
184 |
*/
|
|
185 |
void ParsePinCodeReqParamsL( TBool& aLocallyInitiated, TInt& aMinPinLength,
|
|
186 |
TBTDevAddr& aAddr);
|
|
187 |
|
|
188 |
/**
|
|
189 |
* Parse the parameters of a request for pairing using numeric comparison.
|
|
190 |
*
|
|
191 |
* @since Symbian^4
|
|
192 |
* @param aLocallyInitiated On return, will be set to ETrue if the pairing
|
|
193 |
* was initiated by us.
|
|
194 |
* @param aNumVal On return, this descriptor will contain the passkey to
|
|
195 |
* show to the user.
|
|
196 |
*/
|
|
197 |
void ParseNumericCompReqParamsL( TBool& aLocallyInitiated, TDes& aNumVal,
|
|
198 |
TBTDevAddr& aAddr);
|
|
199 |
|
|
200 |
/**
|
|
201 |
* Parse the parameters of a request for pairing using passkey display.
|
|
202 |
*
|
|
203 |
* @since Symbian^4
|
|
204 |
* @param aLocallyInitiated On return, will be set to ETrue if the pairing
|
|
205 |
* was initiated by us.
|
|
206 |
* @param aNumVal On return, this descriptor will contain the passkey to
|
|
207 |
* show to the user.
|
|
208 |
*/
|
|
209 |
void ParsePasskeyDisplayReqParamsL( TBool& aLocallyInitiated, TDes& aNumVal,
|
|
210 |
TBTDevAddr& aAddr );
|
|
211 |
|
|
212 |
/**
|
|
213 |
* Get a notification and configure it according to the current operation.
|
|
214 |
*
|
|
215 |
* @since Symbian^4
|
|
216 |
* @param aType The notification type.
|
|
217 |
* @param aResourceId Identifier for the resource to display.
|
|
218 |
*/
|
|
219 |
void PrepareNotificationL( TBluetoothDialogParams::TBTDialogType aType,
|
|
220 |
TBTDialogResourceId aResourceId );
|
|
221 |
|
|
222 |
/**
|
|
223 |
* Handle the result from a notification that is finished.
|
|
224 |
*
|
|
225 |
* @since Symbian^4
|
|
226 |
* @param aErr KErrNone or one of the system-wide error codes.
|
|
227 |
* @param aData The returned data. The actual format
|
|
228 |
* is dependent on the actual notifier.
|
|
229 |
*/
|
|
230 |
void NotificationClosedL( TInt aError, const TDesC8& aData );
|
|
231 |
|
|
232 |
private: // data
|
|
233 |
|
|
234 |
enum TNotifierState
|
|
235 |
{
|
|
236 |
EIncomingPairingAcceptconfirm,
|
|
237 |
EPairingInputConfirm,
|
|
238 |
};
|
|
239 |
|
42
|
240 |
CBTNotifSecurityManager& iParent;
|
31
|
241 |
|
|
242 |
/**
|
|
243 |
* The client request.
|
|
244 |
*/
|
|
245 |
RMessage2 iNotifierMessage;
|
|
246 |
|
|
247 |
/**
|
|
248 |
* Buffer containing the parameters of the client message.
|
|
249 |
* Own.
|
|
250 |
*/
|
|
251 |
RBuf8 iParams;
|
|
252 |
|
|
253 |
/**
|
|
254 |
* Pointer to an outstanding user interaction.
|
|
255 |
* Not own.
|
|
256 |
*/
|
|
257 |
CBluetoothNotification* iNotification;
|
|
258 |
|
|
259 |
// will be set to ETrue if the pairing
|
|
260 |
// was initiated by us.
|
|
261 |
TBool iLocallyInitiated;
|
|
262 |
|
|
263 |
// contain a number to use in the pairing dialog.
|
|
264 |
TBuf<8> iDialogNumeric;
|
|
265 |
|
|
266 |
// the dialog type.
|
|
267 |
TBluetoothDialogParams::TBTDialogType iDialog;
|
|
268 |
|
|
269 |
// the resource id to be loaded to the dialog
|
|
270 |
TBTDialogResourceId iDialogResource;
|
|
271 |
|
|
272 |
// the address of the device with which the pairing is performed.
|
|
273 |
TBTDevAddr iRemote;
|
|
274 |
|
|
275 |
// contains the minimum requirements for pin
|
|
276 |
// code length. -1 indicates this is not PIn code pairing.
|
|
277 |
TInt iMinPinLength;
|
|
278 |
|
|
279 |
// Contains the device name provided in params
|
|
280 |
TBTDeviceName iCurrentDeviceName;
|
|
281 |
|
|
282 |
TNotifierState iState;
|
|
283 |
|
42
|
284 |
// Defines if the check box in the dialog is checked or not.
|
|
285 |
TBool iCheckBoxState;
|
|
286 |
|
|
287 |
TBool iAcceptPairingResult;
|
|
288 |
|
31
|
289 |
BTUNITTESTHOOK
|
|
290 |
|
|
291 |
};
|
|
292 |
|
|
293 |
#endif // BTNOTIFPAIRNOTIFIER_H
|