|
sl@0
|
1 |
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#include "clientmessagecmn.h"
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
using namespace BSUL;
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
/**
|
|
sl@0
|
21 |
Base 64 decoding table
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
const TInt8 AsciiToBase64[80]=
|
|
sl@0
|
24 |
{
|
|
sl@0
|
25 |
62, -1, -1, -1, 63, 52, 53, 54, 55, 56,
|
|
sl@0
|
26 |
57, 58, 59, 60, 61, -1, -1, -1, 64, -1,
|
|
sl@0
|
27 |
-1, -1, 0, 1, 2, 3, 4, 5, 6, 7,
|
|
sl@0
|
28 |
8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
|
|
sl@0
|
29 |
18, 19, 20, 21, 22, 23, 24, 25, -1, -1,
|
|
sl@0
|
30 |
-1, -1, -1, -1, 26, 27, 28, 29, 30, 31,
|
|
sl@0
|
31 |
32, 33, 34, 35, 36, 37, 38, 39, 40, 41,
|
|
sl@0
|
32 |
42, 43, 44, 45, 46, 47, 48, 49, 50, 51
|
|
sl@0
|
33 |
};
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
Base 64 encoding table
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
const TInt8 Base64ToAscii[65]=
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
65, 66, 67, 68, 69, 70, 71, 72, 73, 74,
|
|
sl@0
|
41 |
75, 76, 77, 78, 79, 80, 81, 82, 83, 84,
|
|
sl@0
|
42 |
85, 86, 87, 88, 89, 90, 97, 98, 99,100,
|
|
sl@0
|
43 |
101,102,103,104,105,106,107,108,109,110,
|
|
sl@0
|
44 |
111,112,113,114,115,116,117,118,119,120,
|
|
sl@0
|
45 |
121,122, 48, 49, 50, 51, 52, 53, 54, 55,
|
|
sl@0
|
46 |
56, 57, 43, 47, 61
|
|
sl@0
|
47 |
};
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
const TInt8 KImcvLookUpStartOffset = 43;
|
|
sl@0
|
50 |
const TUint8 KImcvConvEquals = '=';
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
The maximum number of US ASCII characters per line that are before the CRLF line
|
|
sl@0
|
53 |
terminator when sending emails. RFC 2822 recommends that each line SHOULD not exceed
|
|
sl@0
|
54 |
80 characters including the CRLF terminator, and MUST not exceed 1000.
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
const TInt KMaxB64EncodedCharsPerLine = 60; // Could be increased to 75 characters for every encoded line if KDecodeLineLength = 675. 60 was chosen to maintain existing behaviour.
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
Parameter factory function lookup table. This is used to instantiate a
|
|
sl@0
|
60 |
CMessageParameterBase derived object based on a TParamType enum value
|
|
sl@0
|
61 |
*/
|
|
sl@0
|
62 |
const TMessageParameterFactoryFn KParameterFactoryFunctions[] = {NULL,
|
|
sl@0
|
63 |
CIntParameter::NewL,
|
|
sl@0
|
64 |
CDes8ReadParameter::NewL,
|
|
sl@0
|
65 |
CDes8Parameter::NewL,
|
|
sl@0
|
66 |
CPckgParameter::NewL,
|
|
sl@0
|
67 |
CDes16ReadParameter::NewL,
|
|
sl@0
|
68 |
CDes16Parameter::NewL,
|
|
sl@0
|
69 |
CPtrParameter::NewL};
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
Panic string for client message framework panic
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
#ifdef _DEBUG
|
|
sl@0
|
75 |
_LIT(KPanicCategory,"BSUL::ClientMsg");
|
|
sl@0
|
76 |
#endif
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
const TInt KMaxServerNameLength = 32;
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
This static function is used to panic the server in case of
|
|
sl@0
|
82 |
incorrect use of CMessageParameterBase APIs or a badly formed
|
|
sl@0
|
83 |
message schema
|
|
sl@0
|
84 |
@param aPanic The Panic value
|
|
sl@0
|
85 |
*/
|
|
sl@0
|
86 |
void PanicServer(TInt aPanic)
|
|
sl@0
|
87 |
{
|
|
sl@0
|
88 |
_LIT(KUnknownServer, "Unknown");
|
|
sl@0
|
89 |
TBuf<KMaxServerNameLength> serverName(KUnknownServer);
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
//Get the TLS data for this thread
|
|
sl@0
|
92 |
TClientMessageServerData* serverData = static_cast<TClientMessageServerData*>(Dll::Tls());
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
if(serverData != NULL)
|
|
sl@0
|
95 |
{
|
|
sl@0
|
96 |
TPtrC8 name(serverData->iServerName);
|
|
sl@0
|
97 |
serverName.Copy(name);
|
|
sl@0
|
98 |
}
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
User::Panic(serverName, aPanic);
|
|
sl@0
|
101 |
}
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
/**
|
|
sl@0
|
104 |
Static initialisation function for ClientMessage Framework
|
|
sl@0
|
105 |
@param aServerData The initialisation data for the server using the library
|
|
sl@0
|
106 |
@leave Any system wide error code
|
|
sl@0
|
107 |
*/
|
|
sl@0
|
108 |
EXPORT_C void CClientMessage::InitialiseFrameworkL(const TClientMessageServerData& aServerData)
|
|
sl@0
|
109 |
{
|
|
sl@0
|
110 |
__ASSERT_DEBUG(User::StringLength(aServerData.iServerName) <= KMaxServerNameLength, User::Invariant());
|
|
sl@0
|
111 |
Dll::SetTls((TAny*)&aServerData);
|
|
sl@0
|
112 |
}
|
|
sl@0
|
113 |
|
|
sl@0
|
114 |
/**
|
|
sl@0
|
115 |
Static factory function for CClientMessage class
|
|
sl@0
|
116 |
@param aMessage The message that this object encapsulates
|
|
sl@0
|
117 |
@return Pointer to a fully constructed CClientMessage object.
|
|
sl@0
|
118 |
@leave KErrNotInitialised if the framework has not been initialised by a
|
|
sl@0
|
119 |
call to InitialiseFrameworkL.
|
|
sl@0
|
120 |
*/
|
|
sl@0
|
121 |
EXPORT_C CClientMessage* CClientMessage::NewL(const RMessage2& aMessage)
|
|
sl@0
|
122 |
{
|
|
sl@0
|
123 |
const TClientMessageServerData* serverData = static_cast<const TClientMessageServerData*>(Dll::Tls());
|
|
sl@0
|
124 |
if(serverData == NULL)
|
|
sl@0
|
125 |
{
|
|
sl@0
|
126 |
User::Leave(KErrNotInitialised);
|
|
sl@0
|
127 |
}
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
CClientMessage* self = new(ELeave) CClientMessage(aMessage,*serverData);
|
|
sl@0
|
130 |
CleanupStack::PushL(self);
|
|
sl@0
|
131 |
self->ConstructL();
|
|
sl@0
|
132 |
CleanupStack::Pop(self);
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
return self;
|
|
sl@0
|
135 |
}
|
|
sl@0
|
136 |
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
/**
|
|
sl@0
|
139 |
Second phase constructor of CClientMessage Object
|
|
sl@0
|
140 |
Finds the schema for this message and checks the caller against the security
|
|
sl@0
|
141 |
policy defined for this message. Traverses the array of message parameters
|
|
sl@0
|
142 |
and instantiates a CMessageParameterBase object for each parameter and adds these
|
|
sl@0
|
143 |
to its internal array.
|
|
sl@0
|
144 |
@leave KErrInvalidFunction If the message function is not found in the message table
|
|
sl@0
|
145 |
@leave KErrBadHandle if the message handle is Null
|
|
sl@0
|
146 |
@leave KErrPermissionDenied if the security policy for this message is not satisfied
|
|
sl@0
|
147 |
*/
|
|
sl@0
|
148 |
void CClientMessage::ConstructL()
|
|
sl@0
|
149 |
{
|
|
sl@0
|
150 |
if(!iMessage.IsNull())
|
|
sl@0
|
151 |
{
|
|
sl@0
|
152 |
|
|
sl@0
|
153 |
//Find the message schema for this message.
|
|
sl@0
|
154 |
const TClientMessageSchema* messageSchema = FindMessageSchema();
|
|
sl@0
|
155 |
|
|
sl@0
|
156 |
if(!messageSchema)
|
|
sl@0
|
157 |
{
|
|
sl@0
|
158 |
LogBadMessageL(KErrInvalidFunction);
|
|
sl@0
|
159 |
User::Leave(KErrInvalidFunction);
|
|
sl@0
|
160 |
}
|
|
sl@0
|
161 |
|
|
sl@0
|
162 |
//Check message against security policy
|
|
sl@0
|
163 |
CheckSecurityPolicyL(messageSchema->iPolicy);
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
//iterate through message parameters and instantiate all parameter objects
|
|
sl@0
|
166 |
for(int index = 0;index < messageSchema->iParamCount;index++)
|
|
sl@0
|
167 |
{
|
|
sl@0
|
168 |
CMessageParameterBase* parameter =
|
|
sl@0
|
169 |
CMessageParameterBase::CreateL(messageSchema->iParams[index], index, iMessage);
|
|
sl@0
|
170 |
|
|
sl@0
|
171 |
//Some parameter types are defined to be ignored. These
|
|
sl@0
|
172 |
//should not be added to the list of parameters
|
|
sl@0
|
173 |
if(parameter != NULL)
|
|
sl@0
|
174 |
{
|
|
sl@0
|
175 |
//AppendL can leave so use cleanupstack to ensure that memory is not
|
|
sl@0
|
176 |
//leaked if AppendL leaves.
|
|
sl@0
|
177 |
CleanupStack::PushL(parameter);
|
|
sl@0
|
178 |
iParameters.AppendL(parameter);
|
|
sl@0
|
179 |
CleanupStack::Pop(parameter);
|
|
sl@0
|
180 |
}
|
|
sl@0
|
181 |
}
|
|
sl@0
|
182 |
}
|
|
sl@0
|
183 |
else
|
|
sl@0
|
184 |
{
|
|
sl@0
|
185 |
LogBadMessageL(KErrBadHandle);
|
|
sl@0
|
186 |
User::Leave(KErrBadHandle);
|
|
sl@0
|
187 |
}
|
|
sl@0
|
188 |
}
|
|
sl@0
|
189 |
|
|
sl@0
|
190 |
/**
|
|
sl@0
|
191 |
Constructor for CClientMessage Object
|
|
sl@0
|
192 |
@param aMessage The RMessage2 to be represented by this object
|
|
sl@0
|
193 |
@param aServerData The Initialisation data for the server creating this object
|
|
sl@0
|
194 |
*/
|
|
sl@0
|
195 |
EXPORT_C CClientMessage::CClientMessage(const RMessage2& aMessage,
|
|
sl@0
|
196 |
const TClientMessageServerData& aServerData)
|
|
sl@0
|
197 |
: iParameters(KMaxParameters), iMessage(aMessage),
|
|
sl@0
|
198 |
iServerData(aServerData),iFlags(aServerData.iFlags & 0xFFFF0000)
|
|
sl@0
|
199 |
|
|
sl@0
|
200 |
{
|
|
sl@0
|
201 |
|
|
sl@0
|
202 |
}
|
|
sl@0
|
203 |
|
|
sl@0
|
204 |
/**
|
|
sl@0
|
205 |
Destructor for CClientMessageObject
|
|
sl@0
|
206 |
*/
|
|
sl@0
|
207 |
EXPORT_C CClientMessage::~CClientMessage()
|
|
sl@0
|
208 |
{
|
|
sl@0
|
209 |
for(int i = 0; i < iParameters.Count();i++)
|
|
sl@0
|
210 |
{
|
|
sl@0
|
211 |
delete iParameters[i];
|
|
sl@0
|
212 |
}
|
|
sl@0
|
213 |
iParameters.Reset();
|
|
sl@0
|
214 |
}
|
|
sl@0
|
215 |
|
|
sl@0
|
216 |
EXPORT_C const RMessage2& CClientMessage::Message()
|
|
sl@0
|
217 |
{
|
|
sl@0
|
218 |
return iMessage;
|
|
sl@0
|
219 |
}
|
|
sl@0
|
220 |
|
|
sl@0
|
221 |
/**
|
|
sl@0
|
222 |
Panics the client through the message object
|
|
sl@0
|
223 |
set an internal flag to indicate that the RMessage reference handle is now NULL
|
|
sl@0
|
224 |
due to the client thread being tidied up.
|
|
sl@0
|
225 |
@param aServer The Panic category
|
|
sl@0
|
226 |
@param aPanic The Panic value
|
|
sl@0
|
227 |
*/
|
|
sl@0
|
228 |
EXPORT_C void CClientMessage::PanicClient(const TDesC& aServer, TInt aPanic)
|
|
sl@0
|
229 |
{
|
|
sl@0
|
230 |
iMessage.Panic(aServer, aPanic);
|
|
sl@0
|
231 |
iFlags.Set(EFlagPanicClient);
|
|
sl@0
|
232 |
}
|
|
sl@0
|
233 |
|
|
sl@0
|
234 |
/**
|
|
sl@0
|
235 |
Checks a message against the security policy defined for the server
|
|
sl@0
|
236 |
@param aPolicy The security policy to check this message against
|
|
sl@0
|
237 |
@leave KErrPermissionDenied if the message does not fulfil the security policy
|
|
sl@0
|
238 |
*/
|
|
sl@0
|
239 |
void CClientMessage::CheckSecurityPolicyL(const TSecurityPolicy& aPolicy)
|
|
sl@0
|
240 |
{
|
|
sl@0
|
241 |
if(!(aPolicy.CheckPolicy(iMessage,
|
|
sl@0
|
242 |
"Client failed security policy check for this server")))
|
|
sl@0
|
243 |
{
|
|
sl@0
|
244 |
User::Leave(KErrPermissionDenied);
|
|
sl@0
|
245 |
}
|
|
sl@0
|
246 |
return;
|
|
sl@0
|
247 |
}
|
|
sl@0
|
248 |
|
|
sl@0
|
249 |
/**
|
|
sl@0
|
250 |
Finds a message schema in the message table for this server.
|
|
sl@0
|
251 |
Does a binary search on the function number to pull the correct
|
|
sl@0
|
252 |
message from the table. Note that this assumes that the table
|
|
sl@0
|
253 |
is sorted.
|
|
sl@0
|
254 |
@return A pointer to a TClientMessageSchema object in the message table, or Null if
|
|
sl@0
|
255 |
the message does not correpsond to a message in the message table
|
|
sl@0
|
256 |
*/
|
|
sl@0
|
257 |
const TClientMessageSchema* CClientMessage::FindMessageSchema()
|
|
sl@0
|
258 |
{
|
|
sl@0
|
259 |
//This should always be less than KNumClientMessages
|
|
sl@0
|
260 |
TInt function = iMessage.Function();
|
|
sl@0
|
261 |
TInt beg = 0;
|
|
sl@0
|
262 |
TInt end = iServerData.iMessageCount - 1;
|
|
sl@0
|
263 |
TInt mid = 0;
|
|
sl@0
|
264 |
TInt midFn = 0;
|
|
sl@0
|
265 |
|
|
sl@0
|
266 |
while(beg <= end)
|
|
sl@0
|
267 |
{
|
|
sl@0
|
268 |
mid = (end + beg)/2;
|
|
sl@0
|
269 |
|
|
sl@0
|
270 |
midFn = iServerData.iMessageSchema[mid].iFunction;
|
|
sl@0
|
271 |
if(midFn > function)
|
|
sl@0
|
272 |
{
|
|
sl@0
|
273 |
end = mid - 1;
|
|
sl@0
|
274 |
}
|
|
sl@0
|
275 |
else if(midFn < function)
|
|
sl@0
|
276 |
{
|
|
sl@0
|
277 |
beg = mid + 1;
|
|
sl@0
|
278 |
}
|
|
sl@0
|
279 |
else
|
|
sl@0
|
280 |
{
|
|
sl@0
|
281 |
return &iServerData.iMessageSchema[mid];
|
|
sl@0
|
282 |
}
|
|
sl@0
|
283 |
}
|
|
sl@0
|
284 |
return NULL;
|
|
sl@0
|
285 |
}
|
|
sl@0
|
286 |
|
|
sl@0
|
287 |
|
|
sl@0
|
288 |
|
|
sl@0
|
289 |
|
|
sl@0
|
290 |
/**
|
|
sl@0
|
291 |
Validates the message parameters against the constraints provided
|
|
sl@0
|
292 |
in the message table
|
|
sl@0
|
293 |
@leave KErrBadMessage if the message fails validation against the criteria supplied in the
|
|
sl@0
|
294 |
message table
|
|
sl@0
|
295 |
@leave Any system-wide error code
|
|
sl@0
|
296 |
*/
|
|
sl@0
|
297 |
EXPORT_C void CClientMessage::ValidateL()
|
|
sl@0
|
298 |
{
|
|
sl@0
|
299 |
|
|
sl@0
|
300 |
for(int i = 0; i < iParameters.Count();i++)
|
|
sl@0
|
301 |
{
|
|
sl@0
|
302 |
iParameters[i]->ValidateL();
|
|
sl@0
|
303 |
iFlags.Set(i);
|
|
sl@0
|
304 |
}
|
|
sl@0
|
305 |
}
|
|
sl@0
|
306 |
|
|
sl@0
|
307 |
/**
|
|
sl@0
|
308 |
Validates a single message argument against the constraints provided
|
|
sl@0
|
309 |
in the message table
|
|
sl@0
|
310 |
@param aParam The index value identifying the argument to validate
|
|
sl@0
|
311 |
@leave KErrBadMessage if the message fails validation against the criteria supplied in the
|
|
sl@0
|
312 |
message table for the requested argument
|
|
sl@0
|
313 |
@leave KErrArgument if aParam is negative or is greater than the number of parameters for
|
|
sl@0
|
314 |
this message
|
|
sl@0
|
315 |
@leave Any system-wide error code
|
|
sl@0
|
316 |
*/
|
|
sl@0
|
317 |
EXPORT_C void CClientMessage::ValidateL(TInt aParam)
|
|
sl@0
|
318 |
{
|
|
sl@0
|
319 |
|
|
sl@0
|
320 |
if(( aParam >= 0) && (aParam < iParameters.Count()))
|
|
sl@0
|
321 |
{
|
|
sl@0
|
322 |
iParameters[aParam]->ValidateL();
|
|
sl@0
|
323 |
iFlags.Set(aParam);
|
|
sl@0
|
324 |
}
|
|
sl@0
|
325 |
else
|
|
sl@0
|
326 |
{
|
|
sl@0
|
327 |
User::Leave(KErrArgument);
|
|
sl@0
|
328 |
}
|
|
sl@0
|
329 |
}
|
|
sl@0
|
330 |
|
|
sl@0
|
331 |
/**
|
|
sl@0
|
332 |
Checks if a given parameter has been validated
|
|
sl@0
|
333 |
@param aParam The index value identifying the paramater to check
|
|
sl@0
|
334 |
@leave KErrArgument if aParam is not a valid parameter value
|
|
sl@0
|
335 |
@leave KErrNotValidated if the parameter has not been validated
|
|
sl@0
|
336 |
*/
|
|
sl@0
|
337 |
void CClientMessage::CheckValidatedL(TInt aParam)
|
|
sl@0
|
338 |
{
|
|
sl@0
|
339 |
if((aParam < EFlagParam0Validated) || (aParam > EFlagParam3Validated))
|
|
sl@0
|
340 |
{
|
|
sl@0
|
341 |
User::Leave(KErrArgument);
|
|
sl@0
|
342 |
}
|
|
sl@0
|
343 |
|
|
sl@0
|
344 |
if(!iFlags.IsSet(aParam))
|
|
sl@0
|
345 |
{
|
|
sl@0
|
346 |
User::Leave(KErrNotValidated);
|
|
sl@0
|
347 |
}
|
|
sl@0
|
348 |
}
|
|
sl@0
|
349 |
|
|
sl@0
|
350 |
|
|
sl@0
|
351 |
/**
|
|
sl@0
|
352 |
Checks if a bad messages should be logged
|
|
sl@0
|
353 |
@return True if bad messages should be logged
|
|
sl@0
|
354 |
*/
|
|
sl@0
|
355 |
TBool CClientMessage::LogBadMessages()
|
|
sl@0
|
356 |
{
|
|
sl@0
|
357 |
return iFlags.IsSet(EFlagLogBadMessages);
|
|
sl@0
|
358 |
}
|
|
sl@0
|
359 |
|
|
sl@0
|
360 |
/**
|
|
sl@0
|
361 |
Checks if a bad messages should be logged
|
|
sl@0
|
362 |
@param aError The error code to log
|
|
sl@0
|
363 |
*/
|
|
sl@0
|
364 |
void CClientMessage::LogBadMessageL(TInt aError)
|
|
sl@0
|
365 |
{
|
|
sl@0
|
366 |
//Check if logging of bad messages is enabled
|
|
sl@0
|
367 |
if(LogBadMessages())
|
|
sl@0
|
368 |
{
|
|
sl@0
|
369 |
|
|
sl@0
|
370 |
TUid sid = TUid(iMessage.SecureId());
|
|
sl@0
|
371 |
TUidName clientSid = sid.Name();
|
|
sl@0
|
372 |
|
|
sl@0
|
373 |
TInt function = Function();
|
|
sl@0
|
374 |
|
|
sl@0
|
375 |
TBuf<KMaxServerNameLength> serverName;
|
|
sl@0
|
376 |
TPtrC8 name(iServerData.iServerName);
|
|
sl@0
|
377 |
serverName.Copy(name);
|
|
sl@0
|
378 |
|
|
sl@0
|
379 |
switch(aError)
|
|
sl@0
|
380 |
{
|
|
sl@0
|
381 |
#ifdef _DEBUG
|
|
sl@0
|
382 |
|
|
sl@0
|
383 |
|
|
sl@0
|
384 |
case KErrInvalidFunction:
|
|
sl@0
|
385 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Unknown function request from client %S.\n"),
|
|
sl@0
|
386 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
387 |
break;
|
|
sl@0
|
388 |
|
|
sl@0
|
389 |
case KErrBadParameter:
|
|
sl@0
|
390 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Bad argument in IPC request from client %S.\n"),
|
|
sl@0
|
391 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
392 |
break;
|
|
sl@0
|
393 |
|
|
sl@0
|
394 |
case KErrBadMessageSchema:
|
|
sl@0
|
395 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Message schema incotrectly defined for this function %S.\n"),
|
|
sl@0
|
396 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
397 |
break;
|
|
sl@0
|
398 |
|
|
sl@0
|
399 |
case KErrBadDescriptor:
|
|
sl@0
|
400 |
case KErrOverflow:
|
|
sl@0
|
401 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Bad descriptor argument in IPC request from client %S.\n"),
|
|
sl@0
|
402 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
403 |
break;
|
|
sl@0
|
404 |
|
|
sl@0
|
405 |
case KErrNotValidated:
|
|
sl@0
|
406 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Message parameter not validated before use %S.\n"),
|
|
sl@0
|
407 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
408 |
break;
|
|
sl@0
|
409 |
|
|
sl@0
|
410 |
default:
|
|
sl@0
|
411 |
RDebug::Print(_L("%S - CClientMessage Error: %d, Function %d. Bad message received from client %S.\n"),
|
|
sl@0
|
412 |
&serverName,aError,function, &clientSid);
|
|
sl@0
|
413 |
break;
|
|
sl@0
|
414 |
#else
|
|
sl@0
|
415 |
default:
|
|
sl@0
|
416 |
break;
|
|
sl@0
|
417 |
#endif
|
|
sl@0
|
418 |
}
|
|
sl@0
|
419 |
}
|
|
sl@0
|
420 |
|
|
sl@0
|
421 |
|
|
sl@0
|
422 |
}
|
|
sl@0
|
423 |
|
|
sl@0
|
424 |
/**
|
|
sl@0
|
425 |
Completes the message request or Panics the client if a
|
|
sl@0
|
426 |
message error has occured.
|
|
sl@0
|
427 |
@param aError The error value to complete the message with
|
|
sl@0
|
428 |
*/
|
|
sl@0
|
429 |
EXPORT_C void CClientMessage::CompleteRequestL(TInt aError)
|
|
sl@0
|
430 |
{
|
|
sl@0
|
431 |
//If server panics client
|
|
sl@0
|
432 |
//then iMessage will be NULL
|
|
sl@0
|
433 |
if(!iFlags.IsSet(EFlagPanicClient))
|
|
sl@0
|
434 |
{
|
|
sl@0
|
435 |
if(aError != KErrNone)
|
|
sl@0
|
436 |
{
|
|
sl@0
|
437 |
LogBadMessageL(aError);
|
|
sl@0
|
438 |
}
|
|
sl@0
|
439 |
|
|
sl@0
|
440 |
switch(aError)
|
|
sl@0
|
441 |
{
|
|
sl@0
|
442 |
case KErrInvalidFunction:
|
|
sl@0
|
443 |
case KErrBadDescriptor:
|
|
sl@0
|
444 |
case KErrOverflow:
|
|
sl@0
|
445 |
{
|
|
sl@0
|
446 |
//Check if Panic is disabled
|
|
sl@0
|
447 |
if( iFlags.IsClear(EFlagDoNotPanicClientOnBadMessageErrors) )
|
|
sl@0
|
448 |
{
|
|
sl@0
|
449 |
TBuf<KMaxServerNameLength> serverName;
|
|
sl@0
|
450 |
TPtrC8 name(iServerData.iServerName);
|
|
sl@0
|
451 |
serverName.Copy(name);
|
|
sl@0
|
452 |
PanicClient(serverName, aError);
|
|
sl@0
|
453 |
break;
|
|
sl@0
|
454 |
}
|
|
sl@0
|
455 |
}
|
|
sl@0
|
456 |
default:
|
|
sl@0
|
457 |
{
|
|
sl@0
|
458 |
iMessage.Complete(aError);
|
|
sl@0
|
459 |
break;
|
|
sl@0
|
460 |
}
|
|
sl@0
|
461 |
}//switch
|
|
sl@0
|
462 |
|
|
sl@0
|
463 |
}//if
|
|
sl@0
|
464 |
}
|
|
sl@0
|
465 |
|
|
sl@0
|
466 |
/**
|
|
sl@0
|
467 |
Gets the function number of this message
|
|
sl@0
|
468 |
@return The function number of this message
|
|
sl@0
|
469 |
*/
|
|
sl@0
|
470 |
EXPORT_C TInt CClientMessage::Function()
|
|
sl@0
|
471 |
{
|
|
sl@0
|
472 |
return iMessage.Function();
|
|
sl@0
|
473 |
}
|
|
sl@0
|
474 |
|
|
sl@0
|
475 |
/**
|
|
sl@0
|
476 |
Gets the requested message argument as an integer value
|
|
sl@0
|
477 |
@param aParam The parameter number to retrieve
|
|
sl@0
|
478 |
@return The Int value for the requested parameter
|
|
sl@0
|
479 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
480 |
KErrWrongParameterType in UREL is the parameter requested is not an integer type
|
|
sl@0
|
481 |
Any other system wide error code
|
|
sl@0
|
482 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
483 |
type that is not CIntParameter.
|
|
sl@0
|
484 |
*/
|
|
sl@0
|
485 |
EXPORT_C TInt CClientMessage::GetIntL(TInt aParam)
|
|
sl@0
|
486 |
{
|
|
sl@0
|
487 |
CheckValidatedL(aParam);
|
|
sl@0
|
488 |
|
|
sl@0
|
489 |
return iParameters[aParam]->GetIntL();
|
|
sl@0
|
490 |
}
|
|
sl@0
|
491 |
|
|
sl@0
|
492 |
/**
|
|
sl@0
|
493 |
Gets the requested message argument as an TAny*
|
|
sl@0
|
494 |
@param aParam The parameter number to retrieve
|
|
sl@0
|
495 |
@return The TAny* for the requested parameter
|
|
sl@0
|
496 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
497 |
KErrWrongParameterType in UREL is the parameter requested is not an Ptr type
|
|
sl@0
|
498 |
Any other system wide error code
|
|
sl@0
|
499 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
500 |
type that is not CPtrParameter.
|
|
sl@0
|
501 |
*/
|
|
sl@0
|
502 |
EXPORT_C const TAny* CClientMessage::GetPtrL(TInt aParam)
|
|
sl@0
|
503 |
{
|
|
sl@0
|
504 |
CheckValidatedL(aParam);
|
|
sl@0
|
505 |
|
|
sl@0
|
506 |
return iParameters[aParam]->GetPtrL();
|
|
sl@0
|
507 |
}
|
|
sl@0
|
508 |
|
|
sl@0
|
509 |
/**
|
|
sl@0
|
510 |
Gets a reference to the local copy of the descriptor read from the message
|
|
sl@0
|
511 |
@param aParam The parameter number of the descriptor to retrieve
|
|
sl@0
|
512 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
513 |
KErrWrongParameterType in UREL is the parameter requested is not a readable
|
|
sl@0
|
514 |
TDes8 type
|
|
sl@0
|
515 |
Any other system wide error code
|
|
sl@0
|
516 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
517 |
type that is not CDes8ReadParameter.
|
|
sl@0
|
518 |
*/
|
|
sl@0
|
519 |
EXPORT_C const TDesC8& CClientMessage::GetDes8L(TInt aParam)
|
|
sl@0
|
520 |
{
|
|
sl@0
|
521 |
CheckValidatedL(aParam);
|
|
sl@0
|
522 |
|
|
sl@0
|
523 |
return iParameters[aParam]->GetDes8L();
|
|
sl@0
|
524 |
}
|
|
sl@0
|
525 |
|
|
sl@0
|
526 |
/**
|
|
sl@0
|
527 |
Gets a reference to the local copy of the descriptor read from the message
|
|
sl@0
|
528 |
@param aParam The parameter number of the descriptor to retrieve
|
|
sl@0
|
529 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
530 |
KErrWrongParameterType in UREL is the parameter requested is not a readable
|
|
sl@0
|
531 |
TDes16 type
|
|
sl@0
|
532 |
Any other system wide error code
|
|
sl@0
|
533 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
534 |
type that is not CDes16ReadParameter.
|
|
sl@0
|
535 |
*/
|
|
sl@0
|
536 |
EXPORT_C const TDesC& CClientMessage::GetDes16L(TInt aParam)
|
|
sl@0
|
537 |
{
|
|
sl@0
|
538 |
CheckValidatedL(aParam);
|
|
sl@0
|
539 |
|
|
sl@0
|
540 |
return iParameters[aParam]->GetDes16L();
|
|
sl@0
|
541 |
}
|
|
sl@0
|
542 |
|
|
sl@0
|
543 |
|
|
sl@0
|
544 |
|
|
sl@0
|
545 |
/**
|
|
sl@0
|
546 |
Gets a descriptor value read from the message
|
|
sl@0
|
547 |
@param aParam The parameter number of the descriptor to retrieve
|
|
sl@0
|
548 |
@param aDes On exit contains the descriptor value requested
|
|
sl@0
|
549 |
@param aOffset The desired offset from which to read the descriptor
|
|
sl@0
|
550 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
551 |
KErrWrongParameterType in UREL is the parameter requested is not a readable
|
|
sl@0
|
552 |
TDes8 type
|
|
sl@0
|
553 |
Any other system wide error code
|
|
sl@0
|
554 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
555 |
type that is not CDes8Parameter or CDes8ReadParameter.
|
|
sl@0
|
556 |
*/
|
|
sl@0
|
557 |
EXPORT_C void CClientMessage::ReadL(TInt aParam, TDes8& aDes, TInt aOffset)
|
|
sl@0
|
558 |
{
|
|
sl@0
|
559 |
CheckValidatedL(aParam);
|
|
sl@0
|
560 |
|
|
sl@0
|
561 |
iParameters[aParam]->ReadL(aDes, aOffset);
|
|
sl@0
|
562 |
}
|
|
sl@0
|
563 |
|
|
sl@0
|
564 |
/**
|
|
sl@0
|
565 |
Gets a descriptor value read from the message
|
|
sl@0
|
566 |
@param aParam The parameter number of the descriptor to retrieve
|
|
sl@0
|
567 |
@param aDes On exit contains the descriptor value requested
|
|
sl@0
|
568 |
@param aOffset The desired offset from which to read the descriptor
|
|
sl@0
|
569 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
570 |
KErrWrongParameterType in UREL is the parameter requested is not a readable
|
|
sl@0
|
571 |
TDes16 type
|
|
sl@0
|
572 |
Any other system wide error code
|
|
sl@0
|
573 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
574 |
type that is not CDes16Parameter or CDes16ReadParameter.
|
|
sl@0
|
575 |
*/
|
|
sl@0
|
576 |
EXPORT_C void CClientMessage::ReadL(TInt aParam, TDes16& aDes, TInt aOffset)
|
|
sl@0
|
577 |
{
|
|
sl@0
|
578 |
CheckValidatedL(aParam);
|
|
sl@0
|
579 |
|
|
sl@0
|
580 |
iParameters[aParam]->ReadL(aDes, aOffset);
|
|
sl@0
|
581 |
}
|
|
sl@0
|
582 |
|
|
sl@0
|
583 |
/**
|
|
sl@0
|
584 |
Writes to a descriptor field in the message
|
|
sl@0
|
585 |
@param aParam The parameter number of the descriptor to write
|
|
sl@0
|
586 |
@param aDes The descriptor to write to the message
|
|
sl@0
|
587 |
@param aOffset The desired offset at which to write the descriptor
|
|
sl@0
|
588 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
589 |
KErrWrongParameterType in UREL is the parameter requested is not a writable
|
|
sl@0
|
590 |
TDes8 type
|
|
sl@0
|
591 |
Any other system wide error code
|
|
sl@0
|
592 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
593 |
type that is not CDes8Parameter
|
|
sl@0
|
594 |
*/
|
|
sl@0
|
595 |
EXPORT_C void CClientMessage::WriteL(TInt aParam, const TDesC8& aDes, TInt aOffset)
|
|
sl@0
|
596 |
{
|
|
sl@0
|
597 |
CheckValidatedL(aParam);
|
|
sl@0
|
598 |
|
|
sl@0
|
599 |
iParameters[aParam]->WriteL(aDes, aOffset);
|
|
sl@0
|
600 |
}
|
|
sl@0
|
601 |
|
|
sl@0
|
602 |
/**
|
|
sl@0
|
603 |
Writes to a descriptor field in the message
|
|
sl@0
|
604 |
@param aParam The parameter number of the descriptor to write
|
|
sl@0
|
605 |
@param aDes The descriptor to write to the message
|
|
sl@0
|
606 |
@param aOffset The desired offset at which to write the descriptor
|
|
sl@0
|
607 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
608 |
KErrWrongParameterType in UREL is the parameter requested is not a writable
|
|
sl@0
|
609 |
TDes16 type
|
|
sl@0
|
610 |
Any other system wide error code
|
|
sl@0
|
611 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
612 |
type that is notCDes16Parameter
|
|
sl@0
|
613 |
*/
|
|
sl@0
|
614 |
EXPORT_C void CClientMessage::WriteL(TInt aParam, const TDesC16& aDes, TInt aOffset)
|
|
sl@0
|
615 |
{
|
|
sl@0
|
616 |
CheckValidatedL(aParam);
|
|
sl@0
|
617 |
|
|
sl@0
|
618 |
iParameters[aParam]->WriteL(aDes, aOffset);
|
|
sl@0
|
619 |
}
|
|
sl@0
|
620 |
|
|
sl@0
|
621 |
/**
|
|
sl@0
|
622 |
Gets the length of the requested descriptor message argument
|
|
sl@0
|
623 |
@param aParam The parameter number to retrieve
|
|
sl@0
|
624 |
@return The Length of the descriptor in the client process
|
|
sl@0
|
625 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
626 |
KErrWrongParameterType in UREL is the parameter requested is not a descriptor type
|
|
sl@0
|
627 |
Any other system wide error code
|
|
sl@0
|
628 |
@panic ECMPanicWrongParameterType If this function is called for a parameter
|
|
sl@0
|
629 |
type that is not a descriptor type.
|
|
sl@0
|
630 |
*/
|
|
sl@0
|
631 |
EXPORT_C TInt CClientMessage::GetDesLengthL(TInt aParam)
|
|
sl@0
|
632 |
{
|
|
sl@0
|
633 |
CheckValidatedL(aParam);
|
|
sl@0
|
634 |
|
|
sl@0
|
635 |
return iParameters[aParam]->GetDesLengthL();
|
|
sl@0
|
636 |
}
|
|
sl@0
|
637 |
|
|
sl@0
|
638 |
/**
|
|
sl@0
|
639 |
Gets the max length of the requested descriptor message argument
|
|
sl@0
|
640 |
@param aParam The parameter number to retrieve
|
|
sl@0
|
641 |
@return The Max length of the descriptor in the client process
|
|
sl@0
|
642 |
@leave KErrNotValidated if the message parameter has not been validated
|
|
sl@0
|
643 |
KErrWrongParameterType in UREL is the parameter requested is not a descriptor type
|
|
sl@0
|
644 |
Any other system wide error code
|
|
sl@0
|
645 |
@panic ECMPanicWrongParameterType If this function is called for a parameter type
|
|
sl@0
|
646 |
that is not a descriptor type.
|
|
sl@0
|
647 |
*/
|
|
sl@0
|
648 |
EXPORT_C TInt CClientMessage::GetDesMaxLengthL(TInt aParam)
|
|
sl@0
|
649 |
{
|
|
sl@0
|
650 |
CheckValidatedL(aParam);
|
|
sl@0
|
651 |
|
|
sl@0
|
652 |
return iParameters[aParam]->GetDesMaxLengthL();
|
|
sl@0
|
653 |
}
|
|
sl@0
|
654 |
|
|
sl@0
|
655 |
/********************************************************************************
|
|
sl@0
|
656 |
* CMessageParameterBase and Derived Class Definitions
|
|
sl@0
|
657 |
*******************************************************************************/
|
|
sl@0
|
658 |
|
|
sl@0
|
659 |
|
|
sl@0
|
660 |
/**
|
|
sl@0
|
661 |
Factory function for instantiating derived Parameter classes.
|
|
sl@0
|
662 |
Uses factory lookup table to instantiate approptiate parameter
|
|
sl@0
|
663 |
object based on parameter details passed in
|
|
sl@0
|
664 |
@param aParam Parameter details object used to instantiate an appropriate
|
|
sl@0
|
665 |
implementation of CMessageParameterBase.
|
|
sl@0
|
666 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
667 |
@param aMessage The RMessage2 object containing the parameter represented by
|
|
sl@0
|
668 |
this object
|
|
sl@0
|
669 |
@return A fully constructed CMessageParameterBase derived object deterimined by
|
|
sl@0
|
670 |
aParam.
|
|
sl@0
|
671 |
@leave KErrBadMessageSchema in UREL if if the schema for this parameter is
|
|
sl@0
|
672 |
incorrectly defined
|
|
sl@0
|
673 |
@leave Any system-wide error code.
|
|
sl@0
|
674 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
675 |
incorrectly defined
|
|
sl@0
|
676 |
*/
|
|
sl@0
|
677 |
CMessageParameterBase* CMessageParameterBase::CreateL(const TParameterDetails& aParam,
|
|
sl@0
|
678 |
TInt aParamIndex, const RMessage2& aMessage)
|
|
sl@0
|
679 |
{
|
|
sl@0
|
680 |
|
|
sl@0
|
681 |
//The parameter type is the bottom 16 bits of the param type
|
|
sl@0
|
682 |
TInt paramType = (aParam.iType & KParamTypeMask);
|
|
sl@0
|
683 |
|
|
sl@0
|
684 |
__ASSERT_DEBUG((paramType > 0), PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
685 |
|
|
sl@0
|
686 |
CMessageParameterBase* newParam = NULL;
|
|
sl@0
|
687 |
|
|
sl@0
|
688 |
switch(paramType)
|
|
sl@0
|
689 |
{
|
|
sl@0
|
690 |
case EParamInt:
|
|
sl@0
|
691 |
case EParamDes8Read:
|
|
sl@0
|
692 |
case EParamDes8:
|
|
sl@0
|
693 |
case EParamDes16Read:
|
|
sl@0
|
694 |
case EParamDes16:
|
|
sl@0
|
695 |
case EParamPtr:
|
|
sl@0
|
696 |
case EParamPckg:
|
|
sl@0
|
697 |
{
|
|
sl@0
|
698 |
//Create the new parameter object
|
|
sl@0
|
699 |
newParam = (KParameterFactoryFunctions[paramType])(aParam, aParamIndex,
|
|
sl@0
|
700 |
aMessage, GetValidationFunctionL(aParam));
|
|
sl@0
|
701 |
break;
|
|
sl@0
|
702 |
}
|
|
sl@0
|
703 |
|
|
sl@0
|
704 |
default:
|
|
sl@0
|
705 |
{
|
|
sl@0
|
706 |
#ifdef _DEBUG
|
|
sl@0
|
707 |
PanicServer(ECMPanicBadMessageSchema);
|
|
sl@0
|
708 |
#else
|
|
sl@0
|
709 |
User::Leave(KErrBadMessageSchema);
|
|
sl@0
|
710 |
#endif
|
|
sl@0
|
711 |
}
|
|
sl@0
|
712 |
}
|
|
sl@0
|
713 |
|
|
sl@0
|
714 |
return newParam;
|
|
sl@0
|
715 |
}
|
|
sl@0
|
716 |
|
|
sl@0
|
717 |
/**
|
|
sl@0
|
718 |
Constructor for CMessageParameterBase object
|
|
sl@0
|
719 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
720 |
@param aMessage The RMessage2 object containing the parameter represented by
|
|
sl@0
|
721 |
this object
|
|
sl@0
|
722 |
*/
|
|
sl@0
|
723 |
CMessageParameterBase::CMessageParameterBase(const TParameterDetails& aParam,
|
|
sl@0
|
724 |
TInt aParamIndex,const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
725 |
: iIndex(aParamIndex), iMessage(aMessage), iParamDetails(aParam), iValidationFn(aValidationFn)
|
|
sl@0
|
726 |
{
|
|
sl@0
|
727 |
|
|
sl@0
|
728 |
}
|
|
sl@0
|
729 |
|
|
sl@0
|
730 |
/**
|
|
sl@0
|
731 |
Gets the validation function for this parameter from the
|
|
sl@0
|
732 |
TClientMessageServerData structure
|
|
sl@0
|
733 |
@param aParam Parameter object used to find the validation function
|
|
sl@0
|
734 |
@return The validation function for this parameter type
|
|
sl@0
|
735 |
@leave KErrBadMessageSchema in UREL if if the schema for this parameter is
|
|
sl@0
|
736 |
incorrectly defined
|
|
sl@0
|
737 |
@leave Any other system wide error code
|
|
sl@0
|
738 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
739 |
incorrectly defined
|
|
sl@0
|
740 |
*/
|
|
sl@0
|
741 |
TCustomValidationFn CMessageParameterBase::GetValidationFunctionL(const TParameterDetails& aParam)
|
|
sl@0
|
742 |
{
|
|
sl@0
|
743 |
//Get the TLS data for this thread - this will never be null at this point
|
|
sl@0
|
744 |
//as it is checked in CClientMessage::NewL
|
|
sl@0
|
745 |
TClientMessageServerData* serverData = static_cast<TClientMessageServerData*>(Dll::Tls());
|
|
sl@0
|
746 |
|
|
sl@0
|
747 |
//The index of the validation function for this parameter is held in
|
|
sl@0
|
748 |
//the upper 16 bits of aParam.iType. Mask this out and shift down to
|
|
sl@0
|
749 |
//get the index.
|
|
sl@0
|
750 |
TInt fnIndex = (aParam.iType & KValidationFnIndexMask) >> KShift16Bit;
|
|
sl@0
|
751 |
|
|
sl@0
|
752 |
|
|
sl@0
|
753 |
if(fnIndex >= serverData->iValidationFnCount)
|
|
sl@0
|
754 |
{
|
|
sl@0
|
755 |
#ifdef _DEBUG
|
|
sl@0
|
756 |
PanicServer(ECMPanicBadMessageSchema);
|
|
sl@0
|
757 |
#else
|
|
sl@0
|
758 |
User::Leave(KErrBadMessageSchema);
|
|
sl@0
|
759 |
#endif
|
|
sl@0
|
760 |
}
|
|
sl@0
|
761 |
|
|
sl@0
|
762 |
//Return the validation function
|
|
sl@0
|
763 |
return serverData->iCustomValidationFns[fnIndex];
|
|
sl@0
|
764 |
}
|
|
sl@0
|
765 |
|
|
sl@0
|
766 |
/**
|
|
sl@0
|
767 |
Default implementation of GetIntL for CMessageParameterBase object.
|
|
sl@0
|
768 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
769 |
@return KErrNone - A Dummy return value
|
|
sl@0
|
770 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
771 |
given parameter type
|
|
sl@0
|
772 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
773 |
given parameter type
|
|
sl@0
|
774 |
*/
|
|
sl@0
|
775 |
TInt CMessageParameterBase::GetIntL()
|
|
sl@0
|
776 |
{
|
|
sl@0
|
777 |
#ifdef _DEBUG
|
|
sl@0
|
778 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
779 |
#else
|
|
sl@0
|
780 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
781 |
#endif
|
|
sl@0
|
782 |
return KErrNone;
|
|
sl@0
|
783 |
}
|
|
sl@0
|
784 |
|
|
sl@0
|
785 |
/**
|
|
sl@0
|
786 |
Default implementation of GetPtrL for CMessageParameterBase object.
|
|
sl@0
|
787 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
788 |
@return NULL - A Dummy return value
|
|
sl@0
|
789 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
790 |
given parameter type
|
|
sl@0
|
791 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
792 |
given parameter type
|
|
sl@0
|
793 |
*/
|
|
sl@0
|
794 |
const TAny* CMessageParameterBase::GetPtrL()
|
|
sl@0
|
795 |
{
|
|
sl@0
|
796 |
#ifdef _DEBUG
|
|
sl@0
|
797 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
798 |
#else
|
|
sl@0
|
799 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
800 |
#endif
|
|
sl@0
|
801 |
return NULL;
|
|
sl@0
|
802 |
}
|
|
sl@0
|
803 |
|
|
sl@0
|
804 |
/**
|
|
sl@0
|
805 |
Default implementation of WriteL for CMessageParameterBase object.
|
|
sl@0
|
806 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
807 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
808 |
given parameter type
|
|
sl@0
|
809 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
810 |
given parameter type
|
|
sl@0
|
811 |
*/
|
|
sl@0
|
812 |
void CMessageParameterBase::WriteL(const TDesC8& /*aDes*/, TInt /*aOffset*/)
|
|
sl@0
|
813 |
{
|
|
sl@0
|
814 |
#ifdef _DEBUG
|
|
sl@0
|
815 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
816 |
#else
|
|
sl@0
|
817 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
818 |
#endif
|
|
sl@0
|
819 |
}
|
|
sl@0
|
820 |
|
|
sl@0
|
821 |
/**
|
|
sl@0
|
822 |
Default implementation of WriteL for CMessageParameterBase object.
|
|
sl@0
|
823 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
824 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
825 |
given parameter type
|
|
sl@0
|
826 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
827 |
given parameter type
|
|
sl@0
|
828 |
*/
|
|
sl@0
|
829 |
void CMessageParameterBase::WriteL(const TDesC& /*aDes*/, TInt /*aOffset*/)
|
|
sl@0
|
830 |
{
|
|
sl@0
|
831 |
#ifdef _DEBUG
|
|
sl@0
|
832 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
833 |
#else
|
|
sl@0
|
834 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
835 |
#endif
|
|
sl@0
|
836 |
}
|
|
sl@0
|
837 |
|
|
sl@0
|
838 |
/**
|
|
sl@0
|
839 |
Default implementation of ReadL for CMessageParameterBase object.
|
|
sl@0
|
840 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
841 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
842 |
given parameter type
|
|
sl@0
|
843 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
844 |
given parameter type
|
|
sl@0
|
845 |
*/
|
|
sl@0
|
846 |
void CMessageParameterBase::ReadL(TDes8& /*aDes*/,TInt /*aOffset*/)
|
|
sl@0
|
847 |
{
|
|
sl@0
|
848 |
#ifdef _DEBUG
|
|
sl@0
|
849 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
850 |
#else
|
|
sl@0
|
851 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
852 |
#endif
|
|
sl@0
|
853 |
}
|
|
sl@0
|
854 |
|
|
sl@0
|
855 |
/**
|
|
sl@0
|
856 |
Default implementation of ReadL for CMessageParameterBase object.
|
|
sl@0
|
857 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
858 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
859 |
given parameter type
|
|
sl@0
|
860 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
861 |
given parameter type
|
|
sl@0
|
862 |
*/
|
|
sl@0
|
863 |
void CMessageParameterBase::ReadL(TDes& /*aDes*/, TInt /*aOffset*/)
|
|
sl@0
|
864 |
{
|
|
sl@0
|
865 |
#ifdef _DEBUG
|
|
sl@0
|
866 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
867 |
#else
|
|
sl@0
|
868 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
869 |
#endif
|
|
sl@0
|
870 |
}
|
|
sl@0
|
871 |
|
|
sl@0
|
872 |
/**
|
|
sl@0
|
873 |
Default implementation of GetDesLengthL for CMessageParameterBase object.
|
|
sl@0
|
874 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
875 |
@return KErrNone - A Dummy return
|
|
sl@0
|
876 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
877 |
given parameter type
|
|
sl@0
|
878 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
879 |
given parameter type
|
|
sl@0
|
880 |
*/
|
|
sl@0
|
881 |
TInt CMessageParameterBase::GetDesLengthL()
|
|
sl@0
|
882 |
{
|
|
sl@0
|
883 |
#ifdef _DEBUG
|
|
sl@0
|
884 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
885 |
#else
|
|
sl@0
|
886 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
887 |
#endif
|
|
sl@0
|
888 |
return KErrNone;
|
|
sl@0
|
889 |
}
|
|
sl@0
|
890 |
|
|
sl@0
|
891 |
/**
|
|
sl@0
|
892 |
Default implementation of GetDesMaxLengthL for CMessageParameterBase object.
|
|
sl@0
|
893 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
894 |
@return KErrNone - A Dummy return
|
|
sl@0
|
895 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
896 |
given parameter type
|
|
sl@0
|
897 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
898 |
given parameter type
|
|
sl@0
|
899 |
*/
|
|
sl@0
|
900 |
TInt CMessageParameterBase::GetDesMaxLengthL()
|
|
sl@0
|
901 |
{
|
|
sl@0
|
902 |
#ifdef _DEBUG
|
|
sl@0
|
903 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
904 |
#else
|
|
sl@0
|
905 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
906 |
#endif
|
|
sl@0
|
907 |
return KErrNone;
|
|
sl@0
|
908 |
}
|
|
sl@0
|
909 |
|
|
sl@0
|
910 |
/**
|
|
sl@0
|
911 |
Default implementation of GetDes8L for CMessageParameterBase object.
|
|
sl@0
|
912 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
913 |
@return KErrNone - A Dummy return
|
|
sl@0
|
914 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
915 |
given parameter type
|
|
sl@0
|
916 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
917 |
given parameter type
|
|
sl@0
|
918 |
*/
|
|
sl@0
|
919 |
|
|
sl@0
|
920 |
const TDesC8& CMessageParameterBase::GetDes8L()
|
|
sl@0
|
921 |
{
|
|
sl@0
|
922 |
#ifdef _DEBUG
|
|
sl@0
|
923 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
924 |
#else
|
|
sl@0
|
925 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
926 |
#endif
|
|
sl@0
|
927 |
_LIT8(KDummy,"");
|
|
sl@0
|
928 |
return KDummy;
|
|
sl@0
|
929 |
}
|
|
sl@0
|
930 |
|
|
sl@0
|
931 |
/**
|
|
sl@0
|
932 |
Default implementation of GetDes16L for CMessageParameterBase object.
|
|
sl@0
|
933 |
This is only called if this API is not defined for the given parameter type.
|
|
sl@0
|
934 |
@return KErrNone - A Dummy return
|
|
sl@0
|
935 |
@leave KErrWrongParameterType in UREL if this function is not defined for the
|
|
sl@0
|
936 |
given parameter type
|
|
sl@0
|
937 |
@panic ECMPanicWrongParameterType in UDEB if this function is not defined for the
|
|
sl@0
|
938 |
given parameter type
|
|
sl@0
|
939 |
*/
|
|
sl@0
|
940 |
const TDesC& CMessageParameterBase::GetDes16L()
|
|
sl@0
|
941 |
{
|
|
sl@0
|
942 |
#ifdef _DEBUG
|
|
sl@0
|
943 |
User::Panic(KPanicCategory,ECMPanicWrongParameterType);
|
|
sl@0
|
944 |
#else
|
|
sl@0
|
945 |
User::Leave(KErrWrongParameterType);
|
|
sl@0
|
946 |
#endif
|
|
sl@0
|
947 |
|
|
sl@0
|
948 |
_LIT(KDummy,"");
|
|
sl@0
|
949 |
return KDummy;
|
|
sl@0
|
950 |
}
|
|
sl@0
|
951 |
|
|
sl@0
|
952 |
/**
|
|
sl@0
|
953 |
Returns the value of iMin defined in the schema for this parameter
|
|
sl@0
|
954 |
@return The Min constraint for this parameter
|
|
sl@0
|
955 |
*/
|
|
sl@0
|
956 |
TInt CMessageParameterBase::Min()
|
|
sl@0
|
957 |
{
|
|
sl@0
|
958 |
return iParamDetails.iMin;
|
|
sl@0
|
959 |
}
|
|
sl@0
|
960 |
|
|
sl@0
|
961 |
/**
|
|
sl@0
|
962 |
Returns the value of iMax defined in the schema for this parameter
|
|
sl@0
|
963 |
@return The max constraint for this parameter
|
|
sl@0
|
964 |
*/
|
|
sl@0
|
965 |
TInt CMessageParameterBase::Max()
|
|
sl@0
|
966 |
{
|
|
sl@0
|
967 |
return iParamDetails.iMax;
|
|
sl@0
|
968 |
}
|
|
sl@0
|
969 |
|
|
sl@0
|
970 |
|
|
sl@0
|
971 |
/**
|
|
sl@0
|
972 |
Factory function for instantiating CIntParameter objects
|
|
sl@0
|
973 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
974 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
975 |
@param aMessage The RMessage2 object containing the parameter represented by
|
|
sl@0
|
976 |
@return A fully constructed CIntParameter object.
|
|
sl@0
|
977 |
@leave Any system-wide error code.
|
|
sl@0
|
978 |
*/
|
|
sl@0
|
979 |
CMessageParameterBase* CIntParameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
980 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
981 |
{
|
|
sl@0
|
982 |
CIntParameter* self = new(ELeave) CIntParameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
983 |
return self;
|
|
sl@0
|
984 |
}
|
|
sl@0
|
985 |
|
|
sl@0
|
986 |
/**
|
|
sl@0
|
987 |
Constructor for CIntParameter class.
|
|
sl@0
|
988 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
989 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
990 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
991 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
992 |
incorrectly defined
|
|
sl@0
|
993 |
*/
|
|
sl@0
|
994 |
CIntParameter::CIntParameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
995 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
996 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
997 |
|
|
sl@0
|
998 |
{
|
|
sl@0
|
999 |
__ASSERT_DEBUG((iParamDetails.iMax >= iParamDetails.iMin),
|
|
sl@0
|
1000 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1001 |
}
|
|
sl@0
|
1002 |
|
|
sl@0
|
1003 |
/**
|
|
sl@0
|
1004 |
Destructor for CIntParameter class.
|
|
sl@0
|
1005 |
*/
|
|
sl@0
|
1006 |
CIntParameter::~CIntParameter()
|
|
sl@0
|
1007 |
{
|
|
sl@0
|
1008 |
|
|
sl@0
|
1009 |
}
|
|
sl@0
|
1010 |
|
|
sl@0
|
1011 |
/**
|
|
sl@0
|
1012 |
Validates given message parameter agains constraints
|
|
sl@0
|
1013 |
represented by this object. Stores the Int value from the message
|
|
sl@0
|
1014 |
to allow for simple retrieval when required.
|
|
sl@0
|
1015 |
@leave KErrBadParameter if the message parameter does not conform
|
|
sl@0
|
1016 |
to the constraints represented by this object
|
|
sl@0
|
1017 |
@leave Any system-wide error code
|
|
sl@0
|
1018 |
*/
|
|
sl@0
|
1019 |
void CIntParameter::ValidateL()
|
|
sl@0
|
1020 |
{
|
|
sl@0
|
1021 |
|
|
sl@0
|
1022 |
switch(iIndex)
|
|
sl@0
|
1023 |
{
|
|
sl@0
|
1024 |
|
|
sl@0
|
1025 |
case 0:
|
|
sl@0
|
1026 |
iValue = iMessage.Int0();
|
|
sl@0
|
1027 |
break;
|
|
sl@0
|
1028 |
|
|
sl@0
|
1029 |
case 1:
|
|
sl@0
|
1030 |
iValue = iMessage.Int1();
|
|
sl@0
|
1031 |
break;
|
|
sl@0
|
1032 |
|
|
sl@0
|
1033 |
case 2:
|
|
sl@0
|
1034 |
iValue = iMessage.Int2();
|
|
sl@0
|
1035 |
break;
|
|
sl@0
|
1036 |
|
|
sl@0
|
1037 |
case 3:
|
|
sl@0
|
1038 |
iValue = iMessage.Int3();
|
|
sl@0
|
1039 |
break;
|
|
sl@0
|
1040 |
|
|
sl@0
|
1041 |
default:
|
|
sl@0
|
1042 |
User::Leave(KErrArgument);
|
|
sl@0
|
1043 |
break;
|
|
sl@0
|
1044 |
}
|
|
sl@0
|
1045 |
|
|
sl@0
|
1046 |
if(iValidationFn != NULL)
|
|
sl@0
|
1047 |
{
|
|
sl@0
|
1048 |
iValidationFn(this);
|
|
sl@0
|
1049 |
}
|
|
sl@0
|
1050 |
|
|
sl@0
|
1051 |
else
|
|
sl@0
|
1052 |
{
|
|
sl@0
|
1053 |
if((iValue < iParamDetails.iMin)||(iValue > iParamDetails.iMax))
|
|
sl@0
|
1054 |
{
|
|
sl@0
|
1055 |
User::Leave(KErrBadParameter);
|
|
sl@0
|
1056 |
}
|
|
sl@0
|
1057 |
}
|
|
sl@0
|
1058 |
}
|
|
sl@0
|
1059 |
|
|
sl@0
|
1060 |
/**
|
|
sl@0
|
1061 |
Retrieves the TInt value read from the clients message during validation
|
|
sl@0
|
1062 |
@return The TInt value read from the client message
|
|
sl@0
|
1063 |
*/
|
|
sl@0
|
1064 |
TInt CIntParameter::GetIntL()
|
|
sl@0
|
1065 |
{
|
|
sl@0
|
1066 |
return iValue;
|
|
sl@0
|
1067 |
}
|
|
sl@0
|
1068 |
|
|
sl@0
|
1069 |
/**
|
|
sl@0
|
1070 |
Factory function for instantiating CDes8ReadParameter objects
|
|
sl@0
|
1071 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1072 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1073 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1074 |
@return A fully constructed CDes8ReadParameter object.
|
|
sl@0
|
1075 |
@leave Any system-wide error code.
|
|
sl@0
|
1076 |
*/
|
|
sl@0
|
1077 |
CMessageParameterBase* CDes8ReadParameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1078 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1079 |
{
|
|
sl@0
|
1080 |
CDes8ReadParameter* self =
|
|
sl@0
|
1081 |
new(ELeave) CDes8ReadParameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1082 |
|
|
sl@0
|
1083 |
return self;
|
|
sl@0
|
1084 |
}
|
|
sl@0
|
1085 |
|
|
sl@0
|
1086 |
/**
|
|
sl@0
|
1087 |
Constructor for CDes8ReadParameter class.
|
|
sl@0
|
1088 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
1089 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1090 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1091 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
1092 |
incorrectly defined
|
|
sl@0
|
1093 |
*/
|
|
sl@0
|
1094 |
CDes8ReadParameter::CDes8ReadParameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1095 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1096 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1097 |
{
|
|
sl@0
|
1098 |
__ASSERT_DEBUG((iParamDetails.iMin >= 0),
|
|
sl@0
|
1099 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1100 |
|
|
sl@0
|
1101 |
__ASSERT_DEBUG((iParamDetails.iMax > 0),
|
|
sl@0
|
1102 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1103 |
|
|
sl@0
|
1104 |
__ASSERT_DEBUG((iParamDetails.iMax >= iParamDetails.iMin),
|
|
sl@0
|
1105 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1106 |
}
|
|
sl@0
|
1107 |
|
|
sl@0
|
1108 |
/**
|
|
sl@0
|
1109 |
Destructor for CDes8ReadParameter class.
|
|
sl@0
|
1110 |
*/
|
|
sl@0
|
1111 |
CDes8ReadParameter::~CDes8ReadParameter()
|
|
sl@0
|
1112 |
{
|
|
sl@0
|
1113 |
delete iValue;
|
|
sl@0
|
1114 |
}
|
|
sl@0
|
1115 |
|
|
sl@0
|
1116 |
/**
|
|
sl@0
|
1117 |
Validates given message argument against constraints
|
|
sl@0
|
1118 |
represented by this object. Reads in the descriptor from the
|
|
sl@0
|
1119 |
clients message to enable simple retrival when required.
|
|
sl@0
|
1120 |
@leave KErrBadDescriptor if the message parameter does not conform
|
|
sl@0
|
1121 |
to the constraints represented by this object
|
|
sl@0
|
1122 |
@leave Any system-wide error code
|
|
sl@0
|
1123 |
*/
|
|
sl@0
|
1124 |
void CDes8ReadParameter::ValidateL()
|
|
sl@0
|
1125 |
{
|
|
sl@0
|
1126 |
TInt length = iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1127 |
|
|
sl@0
|
1128 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1129 |
if(iValidationFn != NULL)
|
|
sl@0
|
1130 |
{
|
|
sl@0
|
1131 |
iValidationFn(this);
|
|
sl@0
|
1132 |
}
|
|
sl@0
|
1133 |
|
|
sl@0
|
1134 |
else
|
|
sl@0
|
1135 |
{
|
|
sl@0
|
1136 |
if((length < iParamDetails.iMin) || (length > iParamDetails.iMax))
|
|
sl@0
|
1137 |
{
|
|
sl@0
|
1138 |
User::Leave(KErrBadDescriptor);
|
|
sl@0
|
1139 |
}
|
|
sl@0
|
1140 |
}
|
|
sl@0
|
1141 |
|
|
sl@0
|
1142 |
iValue = HBufC8::NewL(length);
|
|
sl@0
|
1143 |
TPtr8 ptr = iValue->Des();
|
|
sl@0
|
1144 |
ReadL(ptr,0);
|
|
sl@0
|
1145 |
}
|
|
sl@0
|
1146 |
|
|
sl@0
|
1147 |
/**
|
|
sl@0
|
1148 |
Gets the descriptor read from the clients message during validation
|
|
sl@0
|
1149 |
@return const reference to the local descriptor copy
|
|
sl@0
|
1150 |
*/
|
|
sl@0
|
1151 |
const TDesC8& CDes8ReadParameter::GetDes8L()
|
|
sl@0
|
1152 |
{
|
|
sl@0
|
1153 |
return *iValue;
|
|
sl@0
|
1154 |
}
|
|
sl@0
|
1155 |
|
|
sl@0
|
1156 |
/**
|
|
sl@0
|
1157 |
Gets the length of the descriptor in the client message
|
|
sl@0
|
1158 |
@return The length of the descriptor
|
|
sl@0
|
1159 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1160 |
Any other system wide error code
|
|
sl@0
|
1161 |
*/
|
|
sl@0
|
1162 |
TInt CDes8ReadParameter::GetDesLengthL()
|
|
sl@0
|
1163 |
{
|
|
sl@0
|
1164 |
return iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1165 |
}
|
|
sl@0
|
1166 |
|
|
sl@0
|
1167 |
/**
|
|
sl@0
|
1168 |
Retrieves the descriptor value read from the clients
|
|
sl@0
|
1169 |
message during validation
|
|
sl@0
|
1170 |
@param aDes The target descriptor.
|
|
sl@0
|
1171 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1172 |
@leave KErrArgument if iIndex has a value outside the valid range, or if aOffset is negative.
|
|
sl@0
|
1173 |
@panic ECMPanicBadDescriptor in UDEB if the supplied descriptor is too small.
|
|
sl@0
|
1174 |
if the schema for this parameter is incorrectly defined
|
|
sl@0
|
1175 |
*/
|
|
sl@0
|
1176 |
void CDes8ReadParameter::ReadL(TDes8& aDes, TInt aOffset)
|
|
sl@0
|
1177 |
{
|
|
sl@0
|
1178 |
__ASSERT_DEBUG((aDes.MaxLength() >= (iMessage.GetDesLengthL(iIndex) - aOffset)),
|
|
sl@0
|
1179 |
PanicServer(ECMPanicBadDescriptor));
|
|
sl@0
|
1180 |
|
|
sl@0
|
1181 |
iMessage.ReadL(iIndex,aDes,aOffset);
|
|
sl@0
|
1182 |
}
|
|
sl@0
|
1183 |
|
|
sl@0
|
1184 |
/**
|
|
sl@0
|
1185 |
Factory function for instantiating CDes8WriteParameter objects
|
|
sl@0
|
1186 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1187 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1188 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1189 |
@return A fully constructed CDes8WriteParameter object.
|
|
sl@0
|
1190 |
@leave Any system-wide error code.
|
|
sl@0
|
1191 |
*/
|
|
sl@0
|
1192 |
CMessageParameterBase* CDes8Parameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1193 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1194 |
{
|
|
sl@0
|
1195 |
CDes8Parameter* self =
|
|
sl@0
|
1196 |
new(ELeave) CDes8Parameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1197 |
|
|
sl@0
|
1198 |
return self;
|
|
sl@0
|
1199 |
}
|
|
sl@0
|
1200 |
|
|
sl@0
|
1201 |
/**
|
|
sl@0
|
1202 |
Constructor for CDes8WriteParameter class.
|
|
sl@0
|
1203 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
1204 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1205 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1206 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
1207 |
incorrectly defined
|
|
sl@0
|
1208 |
*/
|
|
sl@0
|
1209 |
CDes8Parameter::CDes8Parameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1210 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1211 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1212 |
|
|
sl@0
|
1213 |
{
|
|
sl@0
|
1214 |
__ASSERT_DEBUG((iParamDetails.iMin >= 0),
|
|
sl@0
|
1215 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1216 |
|
|
sl@0
|
1217 |
__ASSERT_DEBUG((iParamDetails.iMax >= 0),
|
|
sl@0
|
1218 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1219 |
}
|
|
sl@0
|
1220 |
|
|
sl@0
|
1221 |
/**
|
|
sl@0
|
1222 |
Destructor for CDes8WriteParameter class.
|
|
sl@0
|
1223 |
*/
|
|
sl@0
|
1224 |
CDes8Parameter::~CDes8Parameter()
|
|
sl@0
|
1225 |
{
|
|
sl@0
|
1226 |
}
|
|
sl@0
|
1227 |
|
|
sl@0
|
1228 |
/**
|
|
sl@0
|
1229 |
Validates given message argument against constraints
|
|
sl@0
|
1230 |
represented by this object.
|
|
sl@0
|
1231 |
@leave KErrBadDescriptor if the message parameter does not conform
|
|
sl@0
|
1232 |
to the constraints represented by this object
|
|
sl@0
|
1233 |
@leave Any system-wide error code
|
|
sl@0
|
1234 |
*/
|
|
sl@0
|
1235 |
void CDes8Parameter::ValidateL()
|
|
sl@0
|
1236 |
{
|
|
sl@0
|
1237 |
|
|
sl@0
|
1238 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1239 |
if(iValidationFn != NULL)
|
|
sl@0
|
1240 |
{
|
|
sl@0
|
1241 |
iValidationFn(this);
|
|
sl@0
|
1242 |
}
|
|
sl@0
|
1243 |
|
|
sl@0
|
1244 |
else
|
|
sl@0
|
1245 |
{
|
|
sl@0
|
1246 |
TInt length = iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1247 |
TInt maxLength = iMessage.GetDesMaxLengthL(iIndex);
|
|
sl@0
|
1248 |
|
|
sl@0
|
1249 |
if((maxLength < iParamDetails.iMin)||(length > iParamDetails.iMax))
|
|
sl@0
|
1250 |
{
|
|
sl@0
|
1251 |
User::Leave(KErrBadDescriptor);
|
|
sl@0
|
1252 |
}
|
|
sl@0
|
1253 |
}
|
|
sl@0
|
1254 |
}
|
|
sl@0
|
1255 |
|
|
sl@0
|
1256 |
/**
|
|
sl@0
|
1257 |
Gets the length of the descriptor in the client message
|
|
sl@0
|
1258 |
@return The length of the descriptor
|
|
sl@0
|
1259 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1260 |
Any other system wide error code
|
|
sl@0
|
1261 |
*/
|
|
sl@0
|
1262 |
TInt CDes8Parameter::GetDesLengthL()
|
|
sl@0
|
1263 |
{
|
|
sl@0
|
1264 |
return iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1265 |
}
|
|
sl@0
|
1266 |
|
|
sl@0
|
1267 |
/**
|
|
sl@0
|
1268 |
Gets the max length of the descriptor in the client message
|
|
sl@0
|
1269 |
@return The max length of the descriptor
|
|
sl@0
|
1270 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1271 |
Any other system wide error code
|
|
sl@0
|
1272 |
*/
|
|
sl@0
|
1273 |
TInt CDes8Parameter::GetDesMaxLengthL()
|
|
sl@0
|
1274 |
{
|
|
sl@0
|
1275 |
return iMessage.GetDesMaxLengthL(iIndex);
|
|
sl@0
|
1276 |
}
|
|
sl@0
|
1277 |
|
|
sl@0
|
1278 |
|
|
sl@0
|
1279 |
/**
|
|
sl@0
|
1280 |
Reads a descriptor from the requested message argument
|
|
sl@0
|
1281 |
@param aDes The target descriptor.
|
|
sl@0
|
1282 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1283 |
@leave Any system wide error code.
|
|
sl@0
|
1284 |
@panic ECMPanicBadDescriptor in UDEB if the supplied descriptor is too small.
|
|
sl@0
|
1285 |
*/
|
|
sl@0
|
1286 |
void CDes8Parameter::ReadL(TDes8& aDes, TInt aOffset)
|
|
sl@0
|
1287 |
{
|
|
sl@0
|
1288 |
__ASSERT_DEBUG((aDes.MaxLength() >= (iMessage.GetDesLengthL(iIndex) - aOffset)),
|
|
sl@0
|
1289 |
PanicServer(ECMPanicBadDescriptor));
|
|
sl@0
|
1290 |
|
|
sl@0
|
1291 |
iMessage.ReadL(iIndex,aDes,aOffset);
|
|
sl@0
|
1292 |
}
|
|
sl@0
|
1293 |
|
|
sl@0
|
1294 |
/**
|
|
sl@0
|
1295 |
Validates and writes a descriptor to the requested
|
|
sl@0
|
1296 |
message argument
|
|
sl@0
|
1297 |
@param aDes The source descriptor containing the data to be written.
|
|
sl@0
|
1298 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1299 |
@leave Any system wide error code.
|
|
sl@0
|
1300 |
*/
|
|
sl@0
|
1301 |
void CDes8Parameter::WriteL(const TDesC8& aDes, TInt aOffset)
|
|
sl@0
|
1302 |
{
|
|
sl@0
|
1303 |
iMessage.WriteL(iIndex,aDes,aOffset);
|
|
sl@0
|
1304 |
}
|
|
sl@0
|
1305 |
|
|
sl@0
|
1306 |
/**
|
|
sl@0
|
1307 |
Factory function for instantiating CIntParameter objects
|
|
sl@0
|
1308 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1309 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1310 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1311 |
@return A fully constructed CIntParameter object.
|
|
sl@0
|
1312 |
@leave Any system-wide error code.
|
|
sl@0
|
1313 |
*/
|
|
sl@0
|
1314 |
CMessageParameterBase* CDes16ReadParameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1315 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1316 |
{
|
|
sl@0
|
1317 |
CDes16ReadParameter* self =
|
|
sl@0
|
1318 |
new(ELeave) CDes16ReadParameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1319 |
|
|
sl@0
|
1320 |
return self;
|
|
sl@0
|
1321 |
}
|
|
sl@0
|
1322 |
|
|
sl@0
|
1323 |
/**
|
|
sl@0
|
1324 |
Constructor for CDes8ReadParameter class.
|
|
sl@0
|
1325 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
1326 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1327 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1328 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
1329 |
incorrectly defined
|
|
sl@0
|
1330 |
*/
|
|
sl@0
|
1331 |
CDes16ReadParameter::CDes16ReadParameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1332 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1333 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1334 |
{
|
|
sl@0
|
1335 |
__ASSERT_DEBUG((iParamDetails.iMin >= 0),
|
|
sl@0
|
1336 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1337 |
|
|
sl@0
|
1338 |
__ASSERT_DEBUG((iParamDetails.iMax > 0),
|
|
sl@0
|
1339 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1340 |
|
|
sl@0
|
1341 |
__ASSERT_DEBUG((iParamDetails.iMax >= iParamDetails.iMin),
|
|
sl@0
|
1342 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1343 |
}
|
|
sl@0
|
1344 |
|
|
sl@0
|
1345 |
/**
|
|
sl@0
|
1346 |
Destructor for CDes16ReadParameter class.
|
|
sl@0
|
1347 |
*/
|
|
sl@0
|
1348 |
CDes16ReadParameter::~CDes16ReadParameter()
|
|
sl@0
|
1349 |
{
|
|
sl@0
|
1350 |
delete iValue;
|
|
sl@0
|
1351 |
}
|
|
sl@0
|
1352 |
|
|
sl@0
|
1353 |
/**
|
|
sl@0
|
1354 |
Validates given message argument against constraints
|
|
sl@0
|
1355 |
represented by this object. Reads in the descriptor from the
|
|
sl@0
|
1356 |
clients message to enable simple retrival when required.
|
|
sl@0
|
1357 |
@leave KErrBadDescriptor if the message parameter does not conform
|
|
sl@0
|
1358 |
to the constraints represented by this object
|
|
sl@0
|
1359 |
@leave Any system-wide error code
|
|
sl@0
|
1360 |
*/
|
|
sl@0
|
1361 |
void CDes16ReadParameter::ValidateL()
|
|
sl@0
|
1362 |
{
|
|
sl@0
|
1363 |
TInt length = iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1364 |
|
|
sl@0
|
1365 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1366 |
if(iValidationFn != NULL)
|
|
sl@0
|
1367 |
{
|
|
sl@0
|
1368 |
iValidationFn(this);
|
|
sl@0
|
1369 |
}
|
|
sl@0
|
1370 |
|
|
sl@0
|
1371 |
else
|
|
sl@0
|
1372 |
{
|
|
sl@0
|
1373 |
if((length < iParamDetails.iMin) || (length > iParamDetails.iMax))
|
|
sl@0
|
1374 |
{
|
|
sl@0
|
1375 |
User::Leave(KErrBadDescriptor);
|
|
sl@0
|
1376 |
}
|
|
sl@0
|
1377 |
}
|
|
sl@0
|
1378 |
|
|
sl@0
|
1379 |
iValue = HBufC::NewL(length);
|
|
sl@0
|
1380 |
TPtr ptr = iValue->Des();
|
|
sl@0
|
1381 |
ReadL(ptr,0);
|
|
sl@0
|
1382 |
}
|
|
sl@0
|
1383 |
|
|
sl@0
|
1384 |
/**
|
|
sl@0
|
1385 |
Gets the descriptor read from the clients message during validation
|
|
sl@0
|
1386 |
@return const reference to the local descriptor copy
|
|
sl@0
|
1387 |
*/
|
|
sl@0
|
1388 |
const TDesC& CDes16ReadParameter::GetDes16L()
|
|
sl@0
|
1389 |
{
|
|
sl@0
|
1390 |
return *iValue;
|
|
sl@0
|
1391 |
}
|
|
sl@0
|
1392 |
|
|
sl@0
|
1393 |
/**
|
|
sl@0
|
1394 |
Gets the length of the descriptor in the client message
|
|
sl@0
|
1395 |
@return The length of the descriptor
|
|
sl@0
|
1396 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1397 |
Any other system wide error code
|
|
sl@0
|
1398 |
*/
|
|
sl@0
|
1399 |
TInt CDes16ReadParameter::GetDesLengthL()
|
|
sl@0
|
1400 |
{
|
|
sl@0
|
1401 |
return iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1402 |
}
|
|
sl@0
|
1403 |
|
|
sl@0
|
1404 |
/**
|
|
sl@0
|
1405 |
Retrieves the descriptor value read from the clients
|
|
sl@0
|
1406 |
message during validation
|
|
sl@0
|
1407 |
@param aDes The target descriptor.
|
|
sl@0
|
1408 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1409 |
@leave KErrArgument if the suplied descriptor is too small or an invalid
|
|
sl@0
|
1410 |
offset is supplied
|
|
sl@0
|
1411 |
@panic ECMPanicBadDescriptor in UDEB if the supplied descriptor is too small.
|
|
sl@0
|
1412 |
*/
|
|
sl@0
|
1413 |
void CDes16ReadParameter::ReadL(TDes& aDes, TInt aOffset)
|
|
sl@0
|
1414 |
{
|
|
sl@0
|
1415 |
__ASSERT_DEBUG((aDes.MaxLength() >= (iMessage.GetDesLengthL(iIndex) - aOffset)),
|
|
sl@0
|
1416 |
PanicServer(ECMPanicBadDescriptor));
|
|
sl@0
|
1417 |
|
|
sl@0
|
1418 |
iMessage.ReadL(iIndex,aDes,aOffset);
|
|
sl@0
|
1419 |
}
|
|
sl@0
|
1420 |
|
|
sl@0
|
1421 |
/**
|
|
sl@0
|
1422 |
Factory function for instantiating CDes16WriteParameter objects
|
|
sl@0
|
1423 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1424 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1425 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1426 |
@return A fully constructed CDes16WriteParameter object.
|
|
sl@0
|
1427 |
@leave Any system-wide error code.
|
|
sl@0
|
1428 |
*/
|
|
sl@0
|
1429 |
CMessageParameterBase* CDes16Parameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1430 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1431 |
{
|
|
sl@0
|
1432 |
CDes16Parameter* self =
|
|
sl@0
|
1433 |
new(ELeave) CDes16Parameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1434 |
|
|
sl@0
|
1435 |
return self;
|
|
sl@0
|
1436 |
}
|
|
sl@0
|
1437 |
|
|
sl@0
|
1438 |
/**
|
|
sl@0
|
1439 |
Constructor for CDes16WriteParameter class.
|
|
sl@0
|
1440 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
1441 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1442 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1443 |
@panic ECMPanicBadMessageSchema in UDEB if the schema for this parameter is
|
|
sl@0
|
1444 |
incorrectly defined
|
|
sl@0
|
1445 |
*/
|
|
sl@0
|
1446 |
CDes16Parameter::CDes16Parameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1447 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1448 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1449 |
{
|
|
sl@0
|
1450 |
__ASSERT_DEBUG((iParamDetails.iMin >= 0),
|
|
sl@0
|
1451 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1452 |
__ASSERT_DEBUG((iParamDetails.iMax >= 0),
|
|
sl@0
|
1453 |
PanicServer(ECMPanicBadMessageSchema));
|
|
sl@0
|
1454 |
}
|
|
sl@0
|
1455 |
|
|
sl@0
|
1456 |
/**
|
|
sl@0
|
1457 |
Destructor for CDes16WriteParameter class.
|
|
sl@0
|
1458 |
*/
|
|
sl@0
|
1459 |
CDes16Parameter::~CDes16Parameter()
|
|
sl@0
|
1460 |
{
|
|
sl@0
|
1461 |
|
|
sl@0
|
1462 |
}
|
|
sl@0
|
1463 |
|
|
sl@0
|
1464 |
/**
|
|
sl@0
|
1465 |
Validates given message argument against constraints
|
|
sl@0
|
1466 |
represented by this object.
|
|
sl@0
|
1467 |
@leave KErrBadDescriptor if the message parameter does not conform
|
|
sl@0
|
1468 |
to the constraints represented by this object
|
|
sl@0
|
1469 |
@leave Any system-wide error code
|
|
sl@0
|
1470 |
*/
|
|
sl@0
|
1471 |
void CDes16Parameter::ValidateL()
|
|
sl@0
|
1472 |
{
|
|
sl@0
|
1473 |
|
|
sl@0
|
1474 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1475 |
if(iValidationFn != NULL)
|
|
sl@0
|
1476 |
{
|
|
sl@0
|
1477 |
iValidationFn(this);
|
|
sl@0
|
1478 |
}
|
|
sl@0
|
1479 |
else
|
|
sl@0
|
1480 |
{
|
|
sl@0
|
1481 |
TInt length = iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1482 |
TInt maxLength = iMessage.GetDesMaxLengthL(iIndex);
|
|
sl@0
|
1483 |
|
|
sl@0
|
1484 |
if((maxLength < iParamDetails.iMin)||(length > iParamDetails.iMax))
|
|
sl@0
|
1485 |
{
|
|
sl@0
|
1486 |
User::Leave(KErrBadDescriptor);
|
|
sl@0
|
1487 |
}
|
|
sl@0
|
1488 |
}
|
|
sl@0
|
1489 |
}
|
|
sl@0
|
1490 |
|
|
sl@0
|
1491 |
/**
|
|
sl@0
|
1492 |
Gets the length of the descriptor in the client message
|
|
sl@0
|
1493 |
@return The length of the descriptor
|
|
sl@0
|
1494 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1495 |
Any other system wide error code
|
|
sl@0
|
1496 |
*/
|
|
sl@0
|
1497 |
TInt CDes16Parameter::GetDesLengthL()
|
|
sl@0
|
1498 |
{
|
|
sl@0
|
1499 |
return iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1500 |
}
|
|
sl@0
|
1501 |
|
|
sl@0
|
1502 |
/**
|
|
sl@0
|
1503 |
Gets the max length of the descriptor in the client message
|
|
sl@0
|
1504 |
@return The max length of the descriptor
|
|
sl@0
|
1505 |
@leave KErrBadDescriptor if the message argument is not a descriptor type
|
|
sl@0
|
1506 |
Any other system wide error code
|
|
sl@0
|
1507 |
*/
|
|
sl@0
|
1508 |
TInt CDes16Parameter::GetDesMaxLengthL()
|
|
sl@0
|
1509 |
{
|
|
sl@0
|
1510 |
return iMessage.GetDesMaxLengthL(iIndex);
|
|
sl@0
|
1511 |
}
|
|
sl@0
|
1512 |
|
|
sl@0
|
1513 |
/**
|
|
sl@0
|
1514 |
Reads a descriptor from the requested message argument
|
|
sl@0
|
1515 |
@param aDes The target descriptor.
|
|
sl@0
|
1516 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1517 |
@leave Any system wide error code.
|
|
sl@0
|
1518 |
@panic ECMPanicBadDescriptor in UDEB if the supplied descriptor is too small.
|
|
sl@0
|
1519 |
*/
|
|
sl@0
|
1520 |
void CDes16Parameter::ReadL(TDes& aDes, TInt aOffset)
|
|
sl@0
|
1521 |
{
|
|
sl@0
|
1522 |
__ASSERT_DEBUG((aDes.MaxLength() >= (iMessage.GetDesLengthL(iIndex) - aOffset)),
|
|
sl@0
|
1523 |
PanicServer(ECMPanicBadDescriptor));
|
|
sl@0
|
1524 |
|
|
sl@0
|
1525 |
iMessage.ReadL(iIndex,aDes,aOffset);
|
|
sl@0
|
1526 |
}
|
|
sl@0
|
1527 |
|
|
sl@0
|
1528 |
/**
|
|
sl@0
|
1529 |
Writes a descriptor to the requested message argument
|
|
sl@0
|
1530 |
@param aDes The source descriptor containing the data to be written.
|
|
sl@0
|
1531 |
@param aOffset The offset from the start of the clients descriptor
|
|
sl@0
|
1532 |
@leave Any system wide error code.
|
|
sl@0
|
1533 |
*/
|
|
sl@0
|
1534 |
void CDes16Parameter::WriteL(const TDesC& aDes, TInt aOffset)
|
|
sl@0
|
1535 |
{
|
|
sl@0
|
1536 |
iMessage.WriteL(iIndex,aDes,aOffset);
|
|
sl@0
|
1537 |
}
|
|
sl@0
|
1538 |
|
|
sl@0
|
1539 |
/**
|
|
sl@0
|
1540 |
Factory function for instantiating CPckgParameter objects
|
|
sl@0
|
1541 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1542 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1543 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1544 |
@return A fully constructed CPckgParameter object.
|
|
sl@0
|
1545 |
@leave Any system-wide error code.
|
|
sl@0
|
1546 |
*/
|
|
sl@0
|
1547 |
CMessageParameterBase* CPckgParameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1548 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn )
|
|
sl@0
|
1549 |
{
|
|
sl@0
|
1550 |
CPckgParameter* self =
|
|
sl@0
|
1551 |
new(ELeave) CPckgParameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1552 |
|
|
sl@0
|
1553 |
return self;
|
|
sl@0
|
1554 |
}
|
|
sl@0
|
1555 |
|
|
sl@0
|
1556 |
/**
|
|
sl@0
|
1557 |
Constructor for CPckgParameter class.
|
|
sl@0
|
1558 |
@param aParam Parameter details to be encapsulated by object
|
|
sl@0
|
1559 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1560 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1561 |
*/
|
|
sl@0
|
1562 |
CPckgParameter::CPckgParameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1563 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1564 |
: CDes8Parameter(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1565 |
|
|
sl@0
|
1566 |
{
|
|
sl@0
|
1567 |
|
|
sl@0
|
1568 |
}
|
|
sl@0
|
1569 |
|
|
sl@0
|
1570 |
/**
|
|
sl@0
|
1571 |
Destructor for CPckgParameter class.
|
|
sl@0
|
1572 |
*/
|
|
sl@0
|
1573 |
CPckgParameter::~CPckgParameter()
|
|
sl@0
|
1574 |
{
|
|
sl@0
|
1575 |
}
|
|
sl@0
|
1576 |
|
|
sl@0
|
1577 |
/**
|
|
sl@0
|
1578 |
Validates given message argument against constraints
|
|
sl@0
|
1579 |
represented by this object.
|
|
sl@0
|
1580 |
@leave KErrBadDescriptor if the message parameter does not conform
|
|
sl@0
|
1581 |
to the constraints represented by this object
|
|
sl@0
|
1582 |
@leave Any system-wide error code
|
|
sl@0
|
1583 |
*/
|
|
sl@0
|
1584 |
void CPckgParameter::ValidateL()
|
|
sl@0
|
1585 |
{
|
|
sl@0
|
1586 |
|
|
sl@0
|
1587 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1588 |
if(iValidationFn != NULL)
|
|
sl@0
|
1589 |
{
|
|
sl@0
|
1590 |
iValidationFn(this);
|
|
sl@0
|
1591 |
}
|
|
sl@0
|
1592 |
|
|
sl@0
|
1593 |
else
|
|
sl@0
|
1594 |
{
|
|
sl@0
|
1595 |
TInt length = iMessage.GetDesLengthL(iIndex);
|
|
sl@0
|
1596 |
|
|
sl@0
|
1597 |
if((length < iParamDetails.iMin)||(length > iParamDetails.iMax))
|
|
sl@0
|
1598 |
{
|
|
sl@0
|
1599 |
User::Leave(KErrBadDescriptor);
|
|
sl@0
|
1600 |
}
|
|
sl@0
|
1601 |
}
|
|
sl@0
|
1602 |
}
|
|
sl@0
|
1603 |
|
|
sl@0
|
1604 |
/**
|
|
sl@0
|
1605 |
Factory function for instantiating CPtrParameter objects
|
|
sl@0
|
1606 |
@param aParam Parameter details object used to construct object.
|
|
sl@0
|
1607 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1608 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1609 |
@return A fully constructed CPtrParameter object.
|
|
sl@0
|
1610 |
@leave Any system-wide error code.
|
|
sl@0
|
1611 |
*/
|
|
sl@0
|
1612 |
CMessageParameterBase* CPtrParameter::NewL(const TParameterDetails& aParam,
|
|
sl@0
|
1613 |
TInt aParamIndex, const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1614 |
{
|
|
sl@0
|
1615 |
CPtrParameter* self = new(ELeave) CPtrParameter(aParam, aParamIndex, aMessage, aValidationFn);
|
|
sl@0
|
1616 |
return self;
|
|
sl@0
|
1617 |
}
|
|
sl@0
|
1618 |
|
|
sl@0
|
1619 |
/**
|
|
sl@0
|
1620 |
Constructor for CPtrParameter class.
|
|
sl@0
|
1621 |
@param aParamIndex The Index of this parameter within the RMessage2 arguments
|
|
sl@0
|
1622 |
@param aMessage The RMessage2 object containing the parameter to be represented
|
|
sl@0
|
1623 |
*/
|
|
sl@0
|
1624 |
CPtrParameter::CPtrParameter(const TParameterDetails& aParam, TInt aParamIndex,
|
|
sl@0
|
1625 |
const RMessage2& aMessage, TCustomValidationFn aValidationFn)
|
|
sl@0
|
1626 |
: CMessageParameterBase(aParam, aParamIndex, aMessage, aValidationFn)
|
|
sl@0
|
1627 |
{
|
|
sl@0
|
1628 |
|
|
sl@0
|
1629 |
}
|
|
sl@0
|
1630 |
|
|
sl@0
|
1631 |
/**
|
|
sl@0
|
1632 |
Validates given message argument against constraints
|
|
sl@0
|
1633 |
represented by this object. Stores the TAny* from the
|
|
sl@0
|
1634 |
clients message to enable simple retrival when required.
|
|
sl@0
|
1635 |
@leave KErrArgument if the argument index is invalid
|
|
sl@0
|
1636 |
@leave Any system-wide error code
|
|
sl@0
|
1637 |
*/
|
|
sl@0
|
1638 |
void CPtrParameter::ValidateL()
|
|
sl@0
|
1639 |
{
|
|
sl@0
|
1640 |
|
|
sl@0
|
1641 |
switch(iIndex)
|
|
sl@0
|
1642 |
{
|
|
sl@0
|
1643 |
|
|
sl@0
|
1644 |
case 0:
|
|
sl@0
|
1645 |
iValue = iMessage.Ptr0();
|
|
sl@0
|
1646 |
break;
|
|
sl@0
|
1647 |
|
|
sl@0
|
1648 |
case 1:
|
|
sl@0
|
1649 |
iValue = iMessage.Ptr1();
|
|
sl@0
|
1650 |
break;
|
|
sl@0
|
1651 |
|
|
sl@0
|
1652 |
case 2:
|
|
sl@0
|
1653 |
iValue = iMessage.Ptr2();
|
|
sl@0
|
1654 |
break;
|
|
sl@0
|
1655 |
|
|
sl@0
|
1656 |
case 3:
|
|
sl@0
|
1657 |
iValue = iMessage.Ptr3();
|
|
sl@0
|
1658 |
break;
|
|
sl@0
|
1659 |
|
|
sl@0
|
1660 |
default:
|
|
sl@0
|
1661 |
User::Leave(KErrArgument);
|
|
sl@0
|
1662 |
break;
|
|
sl@0
|
1663 |
}
|
|
sl@0
|
1664 |
|
|
sl@0
|
1665 |
//if there is a supplied custom validation function, call that now
|
|
sl@0
|
1666 |
if(iValidationFn != NULL)
|
|
sl@0
|
1667 |
{
|
|
sl@0
|
1668 |
iValidationFn(this);
|
|
sl@0
|
1669 |
}
|
|
sl@0
|
1670 |
}
|
|
sl@0
|
1671 |
|
|
sl@0
|
1672 |
/**
|
|
sl@0
|
1673 |
Retrieves the TAny pointer read from the clients message during validation
|
|
sl@0
|
1674 |
@return The TAny pointer read from the client message
|
|
sl@0
|
1675 |
*/
|
|
sl@0
|
1676 |
const TAny* CPtrParameter::GetPtrL()
|
|
sl@0
|
1677 |
{
|
|
sl@0
|
1678 |
return iValue;
|
|
sl@0
|
1679 |
}
|
|
sl@0
|
1680 |
|
|
sl@0
|
1681 |
/**
|
|
sl@0
|
1682 |
Decode the string
|
|
sl@0
|
1683 |
@param aSrcString Source string
|
|
sl@0
|
1684 |
@param rDestString Destination string
|
|
sl@0
|
1685 |
@return 1 if aSrcString is not long enough to decode fully, resulting in the storage of
|
|
sl@0
|
1686 |
the last character and requiring another aSrcString (poss 0 length) to be passed to it to
|
|
sl@0
|
1687 |
clear this character.
|
|
sl@0
|
1688 |
@return 0 if the line was decoded OK or the end of the encoded file is reached ie "="
|
|
sl@0
|
1689 |
*/
|
|
sl@0
|
1690 |
|
|
sl@0
|
1691 |
EXPORT_C TInt Base64Codec::Decode(const TDesC8& aSrcString, TDes8& rDestString)
|
|
sl@0
|
1692 |
{
|
|
sl@0
|
1693 |
TInt shiftStored = 0;
|
|
sl@0
|
1694 |
TInt maskShiftStored = ESix;
|
|
sl@0
|
1695 |
|
|
sl@0
|
1696 |
TInt decodedInt=0;
|
|
sl@0
|
1697 |
TInt8 offsetChar=0;
|
|
sl@0
|
1698 |
TUint8 decodedChar=0;
|
|
sl@0
|
1699 |
|
|
sl@0
|
1700 |
// Clears the destination string
|
|
sl@0
|
1701 |
rDestString.Zero();
|
|
sl@0
|
1702 |
|
|
sl@0
|
1703 |
// Initialise variables
|
|
sl@0
|
1704 |
const TUint8* srcStringPtr=aSrcString.Ptr();
|
|
sl@0
|
1705 |
const TUint8* srcStringEnd=aSrcString.Length()+srcStringPtr;
|
|
sl@0
|
1706 |
TUint8* destStringPtr=(TUint8*)rDestString.Ptr();
|
|
sl@0
|
1707 |
TUint8* destStringPtrBase=destStringPtr;
|
|
sl@0
|
1708 |
|
|
sl@0
|
1709 |
TInt maskShift=maskShiftStored;
|
|
sl@0
|
1710 |
TInt shiftStorage=shiftStored;
|
|
sl@0
|
1711 |
|
|
sl@0
|
1712 |
// Main character process loop
|
|
sl@0
|
1713 |
while(srcStringPtr<srcStringEnd)
|
|
sl@0
|
1714 |
{
|
|
sl@0
|
1715 |
offsetChar=(TInt8)(*srcStringPtr-KImcvLookUpStartOffset);
|
|
sl@0
|
1716 |
srcStringPtr++;
|
|
sl@0
|
1717 |
|
|
sl@0
|
1718 |
// Check for valid B64 character
|
|
sl@0
|
1719 |
if((offsetChar>=0)&&(offsetChar<80))
|
|
sl@0
|
1720 |
{
|
|
sl@0
|
1721 |
// Read in next character and B64 decode
|
|
sl@0
|
1722 |
decodedInt=AsciiToBase64[offsetChar];
|
|
sl@0
|
1723 |
|
|
sl@0
|
1724 |
// Exits when a PAD char is reached
|
|
sl@0
|
1725 |
if(decodedInt==EPadChar)
|
|
sl@0
|
1726 |
{
|
|
sl@0
|
1727 |
rDestString.SetLength((TInt)(destStringPtr-destStringPtrBase));
|
|
sl@0
|
1728 |
return EFalse;
|
|
sl@0
|
1729 |
}
|
|
sl@0
|
1730 |
|
|
sl@0
|
1731 |
// Ensures the first 2 chars of 4 are received before processing
|
|
sl@0
|
1732 |
if(maskShift==ESix)
|
|
sl@0
|
1733 |
maskShift=EFour;
|
|
sl@0
|
1734 |
else
|
|
sl@0
|
1735 |
{
|
|
sl@0
|
1736 |
shiftStorage=shiftStorage<<ESix;
|
|
sl@0
|
1737 |
shiftStorage=shiftStorage|decodedInt;
|
|
sl@0
|
1738 |
decodedChar=(TUint8)((shiftStorage>>maskShift)&EEightBitMask);
|
|
sl@0
|
1739 |
|
|
sl@0
|
1740 |
if((maskShift-=ETwo)<EZero)
|
|
sl@0
|
1741 |
maskShift=ESix;
|
|
sl@0
|
1742 |
|
|
sl@0
|
1743 |
*destStringPtr++=decodedChar;
|
|
sl@0
|
1744 |
}
|
|
sl@0
|
1745 |
shiftStorage=decodedInt;
|
|
sl@0
|
1746 |
}
|
|
sl@0
|
1747 |
}
|
|
sl@0
|
1748 |
shiftStored=shiftStorage;
|
|
sl@0
|
1749 |
maskShiftStored=maskShift;
|
|
sl@0
|
1750 |
|
|
sl@0
|
1751 |
rDestString.SetLength((TInt)(destStringPtr-destStringPtrBase));
|
|
sl@0
|
1752 |
|
|
sl@0
|
1753 |
return maskShift<ESix;
|
|
sl@0
|
1754 |
}
|
|
sl@0
|
1755 |
|
|
sl@0
|
1756 |
/**
|
|
sl@0
|
1757 |
Encode the string
|
|
sl@0
|
1758 |
@param aSrcString Source string
|
|
sl@0
|
1759 |
@param rDestString Destination string
|
|
sl@0
|
1760 |
@return 1 if aSrcString is not long enough to encode fully
|
|
sl@0
|
1761 |
@return 0 if the line was encoded OK
|
|
sl@0
|
1762 |
*/
|
|
sl@0
|
1763 |
EXPORT_C TInt Base64Codec::Encode(const TDesC8& aSrcString, TDes8& rDestString)
|
|
sl@0
|
1764 |
{
|
|
sl@0
|
1765 |
// Clears the destination string
|
|
sl@0
|
1766 |
rDestString.Zero();
|
|
sl@0
|
1767 |
|
|
sl@0
|
1768 |
// Initialise variables
|
|
sl@0
|
1769 |
const TUint8* srcStringPtr=aSrcString.Ptr();
|
|
sl@0
|
1770 |
const TUint8* srcStringEnd=aSrcString.Length()+srcStringPtr;
|
|
sl@0
|
1771 |
TUint8* destStringPtr=(TUint8*)rDestString.Ptr();
|
|
sl@0
|
1772 |
TUint8* destStringPtrBase=destStringPtr;
|
|
sl@0
|
1773 |
|
|
sl@0
|
1774 |
TInt character=0;
|
|
sl@0
|
1775 |
TUint8 encodedChar=0;
|
|
sl@0
|
1776 |
TInt charStorage=0;
|
|
sl@0
|
1777 |
TInt maskShift=EZero;
|
|
sl@0
|
1778 |
TInt destStringCharNum = 0;
|
|
sl@0
|
1779 |
|
|
sl@0
|
1780 |
while(srcStringPtr<=srcStringEnd)
|
|
sl@0
|
1781 |
{
|
|
sl@0
|
1782 |
// maskShift is used as a char read counter
|
|
sl@0
|
1783 |
if(maskShift==ESix)
|
|
sl@0
|
1784 |
{
|
|
sl@0
|
1785 |
// If the 3rd char read is also the last char then the while loop
|
|
sl@0
|
1786 |
// is broken on the next check.
|
|
sl@0
|
1787 |
if(srcStringPtr==srcStringEnd)
|
|
sl@0
|
1788 |
srcStringPtr++;
|
|
sl@0
|
1789 |
maskShift=EZero;
|
|
sl@0
|
1790 |
character=0;
|
|
sl@0
|
1791 |
}
|
|
sl@0
|
1792 |
else
|
|
sl@0
|
1793 |
{
|
|
sl@0
|
1794 |
if(srcStringPtr==srcStringEnd)
|
|
sl@0
|
1795 |
character=0;
|
|
sl@0
|
1796 |
else
|
|
sl@0
|
1797 |
character=*srcStringPtr;
|
|
sl@0
|
1798 |
|
|
sl@0
|
1799 |
srcStringPtr++;
|
|
sl@0
|
1800 |
// Shifts charStorage ready for the next char
|
|
sl@0
|
1801 |
charStorage=charStorage<<8;
|
|
sl@0
|
1802 |
maskShift+=ETwo;
|
|
sl@0
|
1803 |
}
|
|
sl@0
|
1804 |
charStorage=charStorage|character;
|
|
sl@0
|
1805 |
// Shifts the mask to the correct bit location
|
|
sl@0
|
1806 |
// Masks (AND's) the valid bits from charStorage
|
|
sl@0
|
1807 |
// Shifts the valid bits into the low order 8bits
|
|
sl@0
|
1808 |
// Converts to BASE64 char, Casts the result to an unsigned char (which it should be ?....I hope)
|
|
sl@0
|
1809 |
encodedChar=(TUint8)Base64ToAscii[((charStorage>>maskShift)&ESixBitMask)];
|
|
sl@0
|
1810 |
|
|
sl@0
|
1811 |
*destStringPtr++=encodedChar;
|
|
sl@0
|
1812 |
destStringCharNum++;
|
|
sl@0
|
1813 |
|
|
sl@0
|
1814 |
// Add a CRLF every KMaxB64EncodedCharsPerLine characters so as not to exceed the line length
|
|
sl@0
|
1815 |
// limitation specified in RFC 2822.
|
|
sl@0
|
1816 |
if (destStringCharNum == KMaxB64EncodedCharsPerLine)
|
|
sl@0
|
1817 |
{
|
|
sl@0
|
1818 |
destStringCharNum = 0;
|
|
sl@0
|
1819 |
*destStringPtr++ = '\r';
|
|
sl@0
|
1820 |
*destStringPtr++ = '\n';
|
|
sl@0
|
1821 |
}
|
|
sl@0
|
1822 |
}
|
|
sl@0
|
1823 |
|
|
sl@0
|
1824 |
// Check for not enough chars and pad if required
|
|
sl@0
|
1825 |
if (maskShift==EFour)
|
|
sl@0
|
1826 |
{
|
|
sl@0
|
1827 |
*destStringPtr++=KImcvConvEquals;
|
|
sl@0
|
1828 |
*destStringPtr++=KImcvConvEquals;
|
|
sl@0
|
1829 |
}
|
|
sl@0
|
1830 |
else
|
|
sl@0
|
1831 |
if(maskShift==ESix)
|
|
sl@0
|
1832 |
*destStringPtr++=KImcvConvEquals;
|
|
sl@0
|
1833 |
|
|
sl@0
|
1834 |
rDestString.SetLength((TInt)(destStringPtr-destStringPtrBase));
|
|
sl@0
|
1835 |
return ((TInt)(srcStringPtr-srcStringEnd));
|
|
sl@0
|
1836 |
}
|