63
|
1 |
/*
|
|
2 |
* Copyright (c) 2008 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: Implementation of the class CFscContactActionPluginEngine.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
// INCLUDES
|
|
20 |
#include "emailtrace.h"
|
|
21 |
#include <e32std.h>
|
|
22 |
|
|
23 |
#include "fsccontactactionserviceuids.hrh"
|
|
24 |
#include "cfsccontactactionpluginengine.h"
|
|
25 |
#include "cfscactionutils.h"
|
|
26 |
#include "mfsccontactaction.h"
|
|
27 |
#include "cfsccontactactionplugin.h"
|
|
28 |
#include "tfsccontactactionqueryresult.h"
|
|
29 |
#include "mfsccontactactionpluginengineobserver.h"
|
|
30 |
|
|
31 |
// ======== LOCAL FUNCTIONS ========
|
|
32 |
|
|
33 |
// ======== MEMBER FUNCTIONS ========
|
|
34 |
|
|
35 |
// ---------------------------------------------------------------------------
|
|
36 |
// Two-phased constructor.
|
|
37 |
// ---------------------------------------------------------------------------
|
|
38 |
//
|
|
39 |
CFscContactActionPluginEngine* CFscContactActionPluginEngine::NewL(
|
|
40 |
CVPbkContactManager& aContactManager )
|
|
41 |
{
|
|
42 |
FUNC_LOG;
|
|
43 |
|
|
44 |
CFscContactActionPluginEngine* self =
|
|
45 |
new ( ELeave ) CFscContactActionPluginEngine( aContactManager );
|
|
46 |
CleanupStack::PushL( self );
|
|
47 |
self->ConstructL();
|
|
48 |
CleanupStack::Pop( self );
|
|
49 |
|
|
50 |
return self;
|
|
51 |
}
|
|
52 |
|
|
53 |
// ---------------------------------------------------------------------------
|
|
54 |
// Destructor.
|
|
55 |
// ---------------------------------------------------------------------------
|
|
56 |
//
|
|
57 |
CFscContactActionPluginEngine::~CFscContactActionPluginEngine()
|
|
58 |
{
|
|
59 |
FUNC_LOG;
|
|
60 |
ReleasePlugins();
|
|
61 |
iActionPlugins.Close();
|
|
62 |
delete iActionUtils;
|
|
63 |
}
|
|
64 |
|
|
65 |
// ---------------------------------------------------------------------------
|
|
66 |
// Detect and load plugins.
|
|
67 |
// ---------------------------------------------------------------------------
|
|
68 |
//
|
|
69 |
void CFscContactActionPluginEngine::LoadPluginsL()
|
|
70 |
{
|
|
71 |
FUNC_LOG;
|
|
72 |
|
|
73 |
if ( iPluginsLoaded )
|
|
74 |
{
|
|
75 |
// Realease plugins before reloading
|
|
76 |
ReleasePlugins();
|
|
77 |
}
|
|
78 |
|
|
79 |
RImplInfoPtrArray implArray;
|
|
80 |
TUid pluginIfUid = { KFscContactActionPluginIfUid };
|
|
81 |
REComSession::ListImplementationsL( pluginIfUid, implArray );
|
|
82 |
|
|
83 |
//Create implementations
|
|
84 |
CFscContactActionPlugin* plugin = NULL;
|
|
85 |
TInt implArrayCount = implArray.Count();
|
|
86 |
for ( TInt i = 0; i < implArrayCount; i++ )
|
|
87 |
{
|
|
88 |
TRAPD( error,
|
|
89 |
{
|
|
90 |
plugin = CFscContactActionPlugin::NewL(
|
|
91 |
implArray[i]->ImplementationUid(), iPluginParams );
|
|
92 |
CleanupStack::PushL( plugin );
|
|
93 |
iActionPlugins.AppendL( plugin );
|
|
94 |
CleanupStack::Pop( plugin );
|
|
95 |
});
|
|
96 |
if ( error )
|
|
97 |
{
|
|
98 |
|
|
99 |
// Leave only if no memory. This way unstable plugins can not make
|
|
100 |
// service totaly unusable
|
|
101 |
if ( error == KErrNoMemory )
|
|
102 |
{
|
|
103 |
implArray.ResetAndDestroy();
|
|
104 |
User::Leave( error );
|
|
105 |
}
|
|
106 |
}
|
|
107 |
plugin = NULL;
|
|
108 |
}
|
|
109 |
|
|
110 |
implArray.ResetAndDestroy();
|
|
111 |
iPluginsLoaded = ETrue;
|
|
112 |
|
|
113 |
|
|
114 |
}
|
|
115 |
|
|
116 |
// ---------------------------------------------------------------------------
|
|
117 |
// Release loaded plugins.
|
|
118 |
// ---------------------------------------------------------------------------
|
|
119 |
//
|
|
120 |
void CFscContactActionPluginEngine::ReleasePlugins()
|
|
121 |
{
|
|
122 |
FUNC_LOG;
|
|
123 |
iActionPlugins.ResetAndDestroy();
|
|
124 |
iPluginsLoaded = EFalse;
|
|
125 |
REComSession::FinalClose();
|
|
126 |
}
|
|
127 |
|
|
128 |
// ---------------------------------------------------------------------------
|
|
129 |
// Query state of plugins.
|
|
130 |
// ---------------------------------------------------------------------------
|
|
131 |
//
|
|
132 |
TBool CFscContactActionPluginEngine::PluginsLoaded()
|
|
133 |
{
|
|
134 |
FUNC_LOG;
|
|
135 |
return iPluginsLoaded;
|
|
136 |
}
|
|
137 |
|
|
138 |
// ---------------------------------------------------------------------------
|
|
139 |
// CFscContactActionPluginEngine::AllActionsListL
|
|
140 |
//
|
|
141 |
// Get all actions of all contact action plugins matching provided action type flags
|
|
142 |
// ---------------------------------------------------------------------------
|
|
143 |
//
|
|
144 |
void CFscContactActionPluginEngine::AllActionsListL(
|
|
145 |
CFscContactActionList& aActionList,
|
|
146 |
TUint64 aActionTypeFlags)
|
|
147 |
{
|
|
148 |
// Loop all loaded action plugins
|
|
149 |
TInt i = 0;
|
|
150 |
while ( i < iActionPlugins.Count() )
|
|
151 |
{
|
|
152 |
CFscContactActionPlugin* plugin =
|
|
153 |
iActionPlugins[ i++ ];
|
|
154 |
|
|
155 |
const CArrayFix<TUid>* pluginActionList = plugin->ActionList();
|
|
156 |
TInt pluginActionCount =
|
|
157 |
( pluginActionList != NULL ) ? pluginActionList->Count() : 0;
|
|
158 |
|
|
159 |
// Loop actions of single plugin and add only actions
|
|
160 |
// matching to the filter flags
|
|
161 |
TInt j = 0;
|
|
162 |
while ( j < pluginActionCount )
|
|
163 |
{
|
|
164 |
TUid uid = ( *pluginActionList )[ j++ ];
|
|
165 |
const MFscContactAction& action = plugin->GetActionL( uid );
|
|
166 |
if ( aActionTypeFlags & action.Type() )
|
|
167 |
{
|
|
168 |
TFscContactActionQueryResult contactActionQueryResult;
|
|
169 |
contactActionQueryResult.iAction = &action;
|
|
170 |
// add to full list
|
|
171 |
aActionList.AppendL( contactActionQueryResult );
|
|
172 |
}
|
|
173 |
}
|
|
174 |
}
|
|
175 |
}
|
|
176 |
|
|
177 |
|
|
178 |
// ---------------------------------------------------------------------------
|
|
179 |
// Method for quering actions for contacts and groups.
|
|
180 |
// ---------------------------------------------------------------------------
|
|
181 |
//
|
|
182 |
void CFscContactActionPluginEngine::QueryActionsL(
|
|
183 |
CFscContactActionList& aActionList, MFscContactSet& aContactSet,
|
|
184 |
TBool aStopWhenOneActionFound, TUint64 aActionTypeFlags,
|
|
185 |
TInt aMinPriority, MFscContactActionPluginEngineObserver* aObserver )
|
|
186 |
{
|
|
187 |
FUNC_LOG;
|
|
188 |
switch ( iLastEvent )
|
|
189 |
{
|
|
190 |
case ECasEventIdle:
|
|
191 |
{
|
|
192 |
iActionList = &aActionList;
|
|
193 |
iContactSet = &aContactSet;
|
|
194 |
iStopWhenOneActionFound = aStopWhenOneActionFound;
|
|
195 |
iActionTypeFlags = aActionTypeFlags;
|
|
196 |
iMinPriority = aMinPriority;
|
|
197 |
iObserver = aObserver;
|
|
198 |
iCurrentActionPlugin = 0;
|
|
199 |
iCurrentAction = 0;
|
|
200 |
//iLastEvent = ECasEventBeforePriorityForContactSet;
|
|
201 |
// break; - no break here so we can go further when method
|
|
202 |
// called for 1st time.
|
|
203 |
}
|
|
204 |
|
|
205 |
case ECasEventBeforePriorityForContactSet:
|
|
206 |
{
|
|
207 |
TBool asyncStarted = EFalse;
|
|
208 |
// Loop plugins
|
|
209 |
while ( iCurrentActionPlugin < iActionPlugins.Count()
|
|
210 |
&& !asyncStarted )
|
|
211 |
{
|
|
212 |
//Loop actions of single plugin
|
|
213 |
CFscContactActionPlugin* plugin =
|
|
214 |
iActionPlugins[ iCurrentActionPlugin ];
|
|
215 |
|
|
216 |
const CArrayFix<TUid>* actionList = plugin->ActionList();
|
|
217 |
TInt actionCount =
|
|
218 |
( actionList != NULL ) ? actionList->Count() : 0;
|
|
219 |
|
|
220 |
while ( iCurrentAction < actionCount && !asyncStarted )
|
|
221 |
{
|
|
222 |
TUid uid = ( *actionList )[ iCurrentAction ];
|
|
223 |
|
|
224 |
if ( aActionTypeFlags & plugin->GetActionL( uid ).Type() )
|
|
225 |
{
|
|
226 |
asyncStarted = ETrue;
|
|
227 |
//Check action's priority for given contact set
|
|
228 |
plugin->PriorityForContactSetL( uid, aContactSet,
|
|
229 |
iContactActionQueryResult.iActionMenuVisibility,
|
|
230 |
iContactActionQueryResult.iOptionsMenuVisibility,
|
|
231 |
this );
|
|
232 |
}
|
|
233 |
|
|
234 |
if ( !asyncStarted )
|
|
235 |
{
|
|
236 |
++iCurrentAction;
|
|
237 |
}
|
|
238 |
}
|
|
239 |
|
|
240 |
if ( !asyncStarted )
|
|
241 |
{
|
|
242 |
iCurrentAction = 0;
|
|
243 |
++iCurrentActionPlugin;
|
|
244 |
}
|
|
245 |
}
|
|
246 |
|
|
247 |
if ( !asyncStarted )
|
|
248 |
{
|
|
249 |
// inform observer that method finished
|
|
250 |
iObserver->QueryActionsComplete();
|
|
251 |
iLastEvent = ECasEventIdle;
|
|
252 |
}
|
|
253 |
|
|
254 |
break;
|
|
255 |
}
|
|
256 |
|
|
257 |
case ECasEventAfterPriorityForContactSet:
|
|
258 |
{
|
|
259 |
// here we have to do the same as in
|
|
260 |
// ECasEventBeforePriorityForContactSet event
|
|
261 |
// because GetActionL returns const reference which we can't hold
|
|
262 |
// in class' data.
|
|
263 |
CFscContactActionPlugin* plugin =
|
|
264 |
iActionPlugins[ iCurrentActionPlugin ];
|
|
265 |
|
|
266 |
const CArrayFix<TUid>* actionList = plugin->ActionList();
|
|
267 |
TInt actionCount =
|
|
268 |
( actionList != NULL ) ? actionList->Count() : 0;
|
|
269 |
|
|
270 |
TUid uid = ( *actionList )[ iCurrentAction ];
|
|
271 |
const MFscContactAction& action = plugin->GetActionL( uid );
|
|
272 |
|
|
273 |
// Add action if given minimum priority is exceeded
|
|
274 |
if ( iContactActionQueryResult.iPriority >= aMinPriority &&
|
|
275 |
iContactActionQueryResult.iActionMenuVisibility.iVisibility !=
|
|
276 |
TFscContactActionVisibility::EFscActionHidden )
|
|
277 |
{
|
|
278 |
iContactActionQueryResult.iAction = &action;
|
|
279 |
if( iActionList )
|
|
280 |
{
|
|
281 |
iActionList->AppendL( iContactActionQueryResult );
|
|
282 |
}
|
|
283 |
}
|
|
284 |
|
|
285 |
// if only one action is needed we stop method execution
|
|
286 |
if ( iStopWhenOneActionFound && iActionList && iActionList->Count() )
|
|
287 |
{
|
|
288 |
iLastEvent = ECasEventIdle;
|
|
289 |
iObserver->QueryActionsComplete();
|
|
290 |
}
|
|
291 |
else
|
|
292 |
{
|
|
293 |
// get next action
|
|
294 |
if ( iCurrentAction < actionCount )
|
|
295 |
{
|
|
296 |
iCurrentAction++;
|
|
297 |
}
|
|
298 |
else
|
|
299 |
{
|
|
300 |
// no more actions for current plugin
|
|
301 |
iCurrentAction = 0;
|
|
302 |
iCurrentActionPlugin++;
|
|
303 |
}
|
|
304 |
|
|
305 |
// if needed run for next plugin
|
|
306 |
if ( iCurrentActionPlugin < iActionPlugins.Count() )
|
|
307 |
{
|
|
308 |
iLastEvent = ECasEventBeforePriorityForContactSet;
|
|
309 |
QueryActionsL( *iActionList, *iContactSet,
|
|
310 |
iStopWhenOneActionFound, iActionTypeFlags,
|
|
311 |
iMinPriority, iObserver );
|
|
312 |
}
|
|
313 |
else
|
|
314 |
{
|
|
315 |
// inform observer that method finished
|
|
316 |
iLastEvent = ECasEventIdle;
|
|
317 |
iObserver->QueryActionsComplete();
|
|
318 |
}
|
|
319 |
}
|
|
320 |
|
|
321 |
break;
|
|
322 |
}
|
|
323 |
|
|
324 |
case ECasEventCanceledPriorityForContactSet:
|
|
325 |
{
|
|
326 |
// PriorityforContactSet was cancelled
|
|
327 |
iLastEvent = ECasEventIdle;
|
|
328 |
iCurrentActionPlugin = 0;
|
|
329 |
iCurrentAction = 0;
|
|
330 |
if( iActionList )
|
|
331 |
{
|
|
332 |
iActionList->Reset();
|
|
333 |
}
|
|
334 |
break;
|
|
335 |
}
|
|
336 |
|
|
337 |
default:
|
|
338 |
{
|
|
339 |
// we shouldn't be here
|
|
340 |
iObserver->QueryActionsFailed( KErrArgument );
|
|
341 |
iLastEvent = ECasEventIdle;
|
|
342 |
break;
|
|
343 |
}
|
|
344 |
}
|
|
345 |
}
|
|
346 |
|
|
347 |
// ---------------------------------------------------------------------------
|
|
348 |
// Cancels async method QueryActionsL.
|
|
349 |
// ---------------------------------------------------------------------------
|
|
350 |
//
|
|
351 |
void CFscContactActionPluginEngine::CancelQueryActions()
|
|
352 |
{
|
|
353 |
FUNC_LOG;
|
|
354 |
TInt err = KErrNone;
|
|
355 |
if ( iActionPlugins.Count() > iCurrentActionPlugin )
|
|
356 |
{
|
|
357 |
iActionPlugins[ iCurrentActionPlugin ]->CancelPriorityForContactSet();
|
|
358 |
iLastEvent = ECasEventCanceledPriorityForContactSet;
|
|
359 |
TRAP( err, QueryActionsL( *iActionList, *iContactSet,
|
|
360 |
iStopWhenOneActionFound, iActionTypeFlags, iMinPriority,
|
|
361 |
iObserver ) );
|
|
362 |
}
|
|
363 |
|
|
364 |
if ( err!= KErrNone )
|
|
365 |
{
|
|
366 |
iObserver->QueryActionsFailed( err );
|
|
367 |
iLastEvent = ECasEventIdle;
|
|
368 |
}
|
|
369 |
}
|
|
370 |
|
|
371 |
// ---------------------------------------------------------------------------
|
|
372 |
// Called when PriorityForContactSetL method is complete.
|
|
373 |
// ---------------------------------------------------------------------------
|
|
374 |
//
|
|
375 |
void CFscContactActionPluginEngine::PriorityForContactSetComplete(
|
|
376 |
TInt aPriority )
|
|
377 |
{
|
|
378 |
FUNC_LOG;
|
|
379 |
iContactActionQueryResult.iPriority = aPriority;
|
|
380 |
iLastEvent = ECasEventAfterPriorityForContactSet;
|
|
381 |
TRAPD(err, QueryActionsL( *iActionList, *iContactSet,
|
|
382 |
iStopWhenOneActionFound, iActionTypeFlags, iMinPriority,
|
|
383 |
iObserver ) );
|
|
384 |
if ( err!= KErrNone )
|
|
385 |
{
|
|
386 |
iLastEvent = ECasEventIdle;
|
|
387 |
iObserver->QueryActionsFailed( err );
|
|
388 |
}
|
|
389 |
}
|
|
390 |
|
|
391 |
// ---------------------------------------------------------------------------
|
|
392 |
// Called when PriorityForContactSetL method failed.
|
|
393 |
// ---------------------------------------------------------------------------
|
|
394 |
//
|
|
395 |
void CFscContactActionPluginEngine::PriorityForContactSetFailed(
|
|
396 |
TInt aError )
|
|
397 |
{
|
|
398 |
FUNC_LOG;
|
|
399 |
iLastEvent = ECasEventIdle;
|
|
400 |
iObserver->QueryActionsFailed( aError );
|
|
401 |
}
|
|
402 |
|
|
403 |
// ---------------------------------------------------------------------------
|
|
404 |
// Execute action. Aynchronous method.
|
|
405 |
// ---------------------------------------------------------------------------
|
|
406 |
//
|
|
407 |
void CFscContactActionPluginEngine::ExecuteL(
|
|
408 |
TUid aActionUid, MFscContactSet& aContactSet,
|
|
409 |
MFscContactActionPluginEngineObserver* aObserver )
|
|
410 |
{
|
|
411 |
FUNC_LOG;
|
|
412 |
iObserver = aObserver;
|
|
413 |
|
|
414 |
// Loop plugins
|
|
415 |
TBool found = EFalse;
|
|
416 |
for ( iCurrentActionPlugin = 0;
|
|
417 |
iCurrentActionPlugin < iActionPlugins.Count() && !found;
|
|
418 |
iCurrentActionPlugin++ )
|
|
419 |
{
|
|
420 |
// Loop actions
|
|
421 |
const CArrayFix<TUid>* actionList =
|
|
422 |
iActionPlugins[ iCurrentActionPlugin ]->ActionList();
|
|
423 |
|
|
424 |
TInt actionCount =
|
|
425 |
( actionList != NULL) ? actionList->Count() : 0;
|
|
426 |
for ( TInt j = 0; j < actionCount && !found; j++)
|
|
427 |
{
|
|
428 |
if ( ( *actionList )[j] == aActionUid )
|
|
429 |
{
|
|
430 |
found = ETrue;
|
|
431 |
|
|
432 |
// Action found -> Execute
|
|
433 |
iActionPlugins[ iCurrentActionPlugin ]->ExecuteL(
|
|
434 |
aActionUid, aContactSet, this );
|
|
435 |
|
|
436 |
}
|
|
437 |
}// Loop actions
|
|
438 |
} // Loop plugins
|
|
439 |
|
|
440 |
if ( !found )
|
|
441 |
{
|
|
442 |
ExecuteFailed( KErrNotFound );
|
|
443 |
}
|
|
444 |
|
|
445 |
}
|
|
446 |
|
|
447 |
// ---------------------------------------------------------------------------
|
|
448 |
// Cancels async method ExecuteL.
|
|
449 |
// ---------------------------------------------------------------------------
|
|
450 |
//
|
|
451 |
void CFscContactActionPluginEngine::CancelExecute()
|
|
452 |
{
|
|
453 |
FUNC_LOG;
|
|
454 |
iActionPlugins[ iCurrentActionPlugin ]->CancelExecute();
|
|
455 |
}
|
|
456 |
|
|
457 |
// ---------------------------------------------------------------------------
|
|
458 |
// Called when ExecuteL method is complete.
|
|
459 |
// ---------------------------------------------------------------------------
|
|
460 |
//
|
|
461 |
void CFscContactActionPluginEngine::ExecuteComplete()
|
|
462 |
{
|
|
463 |
FUNC_LOG;
|
|
464 |
iObserver->ExecuteComplete();
|
|
465 |
}
|
|
466 |
|
|
467 |
// ---------------------------------------------------------------------------
|
|
468 |
// Called when ExecuteL method failed.
|
|
469 |
// ---------------------------------------------------------------------------
|
|
470 |
//
|
|
471 |
void CFscContactActionPluginEngine::ExecuteFailed( TInt aError )
|
|
472 |
{
|
|
473 |
FUNC_LOG;
|
|
474 |
iObserver->ExecuteFailed( aError );
|
|
475 |
}
|
|
476 |
|
|
477 |
// ---------------------------------------------------------------------------
|
|
478 |
// Constructor.
|
|
479 |
// ---------------------------------------------------------------------------
|
|
480 |
//
|
|
481 |
CFscContactActionPluginEngine::CFscContactActionPluginEngine(
|
|
482 |
CVPbkContactManager& aContactManager )
|
|
483 |
: iContactManager( aContactManager ),
|
|
484 |
iPluginParams( NULL ),
|
|
485 |
iLastEvent( ECasEventIdle )
|
|
486 |
{
|
|
487 |
FUNC_LOG;
|
|
488 |
}
|
|
489 |
|
|
490 |
// ---------------------------------------------------------------------------
|
|
491 |
// Second phase constructor.
|
|
492 |
// ---------------------------------------------------------------------------
|
|
493 |
//
|
|
494 |
void CFscContactActionPluginEngine::ConstructL()
|
|
495 |
{
|
|
496 |
FUNC_LOG;
|
|
497 |
iActionUtils = CFscActionUtils::NewL( iContactManager );
|
|
498 |
iPluginParams = TFscContactActionPluginParams( iActionUtils );
|
|
499 |
}
|
|
500 |
|