30
|
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: Used by sessions for handling data related requests
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef C_CPDATA_MANAGER_H
|
|
20 |
#define C_CPDATA_MANAGER_H
|
|
21 |
|
|
22 |
#include <e32base.h>
|
|
23 |
#include "cpstorage.h"
|
|
24 |
#include "cpactiondatacache.h"
|
|
25 |
|
|
26 |
// FORWARD DECLARATIONS
|
|
27 |
#ifdef CONTENT_PUBLISHER_DEBUG
|
|
28 |
class CCPDebug;
|
|
29 |
#endif
|
|
30 |
class CLiwMap;
|
|
31 |
class CCPLiwMap;
|
|
32 |
class CCpStorage;
|
|
33 |
class CCPServerSession;
|
|
34 |
class CCPNotificationHandler;
|
|
35 |
class TLiwVariant;
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Content publisher data manager.
|
|
39 |
*
|
|
40 |
* Used to add, modify and remove data and actions.
|
|
41 |
* @since S60 v5.0
|
|
42 |
*/
|
|
43 |
class CCPDataManager : public CBase, MCPChangeNotifier
|
|
44 |
{
|
|
45 |
public:
|
|
46 |
// exported
|
|
47 |
|
|
48 |
/**
|
|
49 |
* C++ destructor
|
|
50 |
*/
|
|
51 |
~CCPDataManager();
|
|
52 |
|
|
53 |
/**
|
|
54 |
* Two-phased constructor.
|
|
55 |
*/
|
|
56 |
static CCPDataManager* NewL(TLiwVariant& aDataMapCache, TBool aTBool =
|
|
57 |
EFalse);
|
|
58 |
|
|
59 |
/**
|
|
60 |
* Two-phased constructor.
|
|
61 |
*/
|
|
62 |
static CCPDataManager* NewLC(TLiwVariant& aDataMapCache, TBool aTBool =
|
|
63 |
EFalse);
|
|
64 |
|
|
65 |
/**
|
|
66 |
* Add a new data to database
|
|
67 |
*
|
|
68 |
* @param aData Data to be added.
|
|
69 |
* @return Id of a newly created data item
|
|
70 |
*/
|
|
71 |
TUint AddDataL( CCPLiwMap& aMap );
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Data is not added to database. Only notification is send to observers.
|
|
75 |
*
|
|
76 |
* @param aData Data to be added.
|
|
77 |
* @return Id of a newly created data item
|
|
78 |
*/
|
|
79 |
void AddNonPersistentDataL( const CCPLiwMap* aMap );
|
|
80 |
|
|
81 |
/**
|
|
82 |
* Fetches data from database
|
|
83 |
* @param aInParamList filter and sorting criteria
|
|
84 |
* @param aOutParamList results
|
|
85 |
*/
|
|
86 |
void GetListL( const CCPLiwMap& aMa, CLiwGenericParamList& aOutParamList );
|
|
87 |
/**
|
|
88 |
* Fetches action from database
|
|
89 |
* @param aInParamList filter and sorting criteria
|
|
90 |
* @param aEnableCache flag indicating if action data should be cached
|
|
91 |
* @param aOutParamList results
|
|
92 |
* @param aNotificationList change info list (for notifications)
|
|
93 |
* @return KErrNotFound if data was not found
|
|
94 |
*/
|
|
95 |
TInt GetActionsL( const CCPLiwMap& aMap,
|
|
96 |
TBool aEnableCache,
|
|
97 |
CLiwGenericParamList& aOutParamList,
|
|
98 |
CLiwDefaultList* aNotificationList = NULL );
|
|
99 |
|
|
100 |
/**
|
|
101 |
* Fetches all activated publishers
|
|
102 |
* @param aInParamList filter and sorting criteria
|
|
103 |
* @param aOutParamList results
|
|
104 |
*/
|
|
105 |
void GetActivePublishersL( CLiwGenericParamList* aResultList );
|
|
106 |
|
|
107 |
/**
|
|
108 |
* Removes data from database
|
|
109 |
* @param aInParamList filter criteria
|
|
110 |
*/
|
|
111 |
void RemoveDataL( const CCPLiwMap& aMa );
|
|
112 |
|
|
113 |
/**
|
|
114 |
* Adds observer to database
|
|
115 |
* @param new observer
|
|
116 |
*/
|
|
117 |
void AddObserverL( CCPNotificationHandler* aNotificationHandler );
|
|
118 |
|
|
119 |
/**
|
|
120 |
* Removes observer from database
|
|
121 |
* @param aNotificationHandler observer to remove
|
|
122 |
*/
|
|
123 |
void RemoveObserver( CCPNotificationHandler* aNotificationHandler );
|
|
124 |
|
|
125 |
// from MCPChangeNotifier
|
|
126 |
/**
|
|
127 |
* @param Map containing change information
|
|
128 |
* @return
|
|
129 |
*/
|
|
130 |
void HandleChangeL( CLiwDefaultList* aListOfMaps );
|
|
131 |
|
|
132 |
/**
|
|
133 |
* Close database
|
|
134 |
* @return
|
|
135 |
*/
|
|
136 |
void CloseDatabase();
|
|
137 |
/**
|
|
138 |
* Open database
|
|
139 |
* @return
|
|
140 |
*/
|
|
141 |
void OpenDatabaseL(TLiwVariant& aDataMapCache);
|
|
142 |
|
|
143 |
private:
|
|
144 |
// methods
|
|
145 |
|
|
146 |
/**
|
|
147 |
* Standard C++ constructor.
|
|
148 |
*/
|
|
149 |
CCPDataManager();
|
|
150 |
|
|
151 |
/**
|
|
152 |
* Standard 2nd phase constructor.
|
|
153 |
*/
|
|
154 |
void ConstructL( TLiwVariant& aDataMapCache, TBool aTBool );
|
|
155 |
|
|
156 |
/**
|
|
157 |
* Fetches action bound to provided trigger.
|
|
158 |
*
|
|
159 |
* @param aOutParamList of all actions
|
|
160 |
* @param aMap for found action
|
|
161 |
* @param aTrigger
|
|
162 |
*/
|
|
163 |
void ExtractTriggerL( CLiwGenericParamList& aOutParamList,
|
|
164 |
const CLiwDefaultMap* aMap, const TDesC8& aTrigger );
|
|
165 |
/**
|
|
166 |
* Sends notifications to observers stored in iNotificationsArray
|
|
167 |
*
|
|
168 |
* @param List of change information
|
|
169 |
* @param index od data item
|
|
170 |
*/
|
|
171 |
void SendNotificationL( CLiwDefaultList* aListOfMaps, TInt aIndex );
|
|
172 |
|
|
173 |
/**
|
|
174 |
* Exctracts action from input parameters
|
|
175 |
*
|
|
176 |
* @param aParam for data
|
|
177 |
* @param aAction for action
|
|
178 |
*/
|
|
179 |
void ExtractActionL( const TLiwGenericParam* aParam, RBuf8& aAction );
|
|
180 |
|
|
181 |
/**
|
|
182 |
* Fills aOutParamList with parameters for action.
|
|
183 |
*
|
|
184 |
* @param aOutParamList parsed list of items
|
|
185 |
* @param aActionMap action map from the database
|
|
186 |
* @param aActionTrigger action trigger
|
|
187 |
*/
|
|
188 |
void FillActionParamListL(
|
|
189 |
CLiwGenericParamList & aOutParamList,
|
|
190 |
const CLiwDefaultMap* aActionMap,
|
|
191 |
const CLiwDefaultList* aActionTriggers);
|
|
192 |
|
|
193 |
/**
|
|
194 |
* Creates map for GetList request - publisher, content_type
|
|
195 |
* and content_id are copied from aMap to returned map
|
|
196 |
* @param aMap - input map
|
|
197 |
* @return input map for GetList request
|
|
198 |
*/
|
|
199 |
CCPLiwMap* CreateMapForGetlistLC( const CCPLiwMap& aMap );
|
|
200 |
|
|
201 |
|
|
202 |
/**
|
|
203 |
* Gets Flag for specified item from DB and returns activate
|
|
204 |
* info
|
|
205 |
* @param aMap - input map
|
|
206 |
* @return activate flag
|
|
207 |
*/
|
|
208 |
TBool GetActivateInfoL( const CCPLiwMap* aMap );
|
|
209 |
|
|
210 |
/**
|
|
211 |
* Builds change info list based on query result to database
|
|
212 |
* @param aMap - map containing parameters needed to build change info list
|
|
213 |
* @param aParam - param from getlist result
|
|
214 |
* @param aActionMap - action map from a database
|
|
215 |
* @param aChangeInfoList - output list containing change info list sent
|
|
216 |
* as notification
|
|
217 |
*/
|
|
218 |
void BuildChangeInfoL(
|
|
219 |
const CCPLiwMap* aMap,
|
|
220 |
const CLiwDefaultList* aActionTriggers,
|
|
221 |
const TLiwGenericParam* aParam,
|
|
222 |
const CLiwDefaultMap* aActionMap,
|
|
223 |
CLiwDefaultList* aChangeInfoList );
|
|
224 |
|
|
225 |
/**
|
|
226 |
* Builds change info list when query to database returned nothing
|
|
227 |
* @param aMap - map containing parameters needed to build change info list
|
|
228 |
* @param aChangeInfoList - output list containing change info list sent
|
|
229 |
* as notification
|
|
230 |
*/
|
|
231 |
void BuildDefaultChangeInfoL(
|
|
232 |
const CCPLiwMap* aMap,
|
|
233 |
const CLiwDefaultList* aActionTriggers,
|
|
234 |
CLiwDefaultList* aChangeInfoList );
|
|
235 |
/**
|
|
236 |
* Builds change info list when query to database returned nothing
|
|
237 |
* @param aMap - map containing parameters needed to build change info list
|
|
238 |
* @param aChangeInfoList - output list containing change info list sent
|
|
239 |
* as notification
|
|
240 |
*/
|
|
241 |
void BuildChangeInfoForAddL(
|
|
242 |
const CCPLiwMap* aMap,
|
|
243 |
CLiwDefaultList* aChangeInfoList );
|
|
244 |
|
|
245 |
/**
|
|
246 |
* Copies variant from in to out map if entry with provided key exists
|
|
247 |
* @param aKey a key
|
|
248 |
* @param aInMap input map
|
|
249 |
* @param aOutMap output map
|
|
250 |
*/
|
|
251 |
void CopyVariantL(const TDesC8& aKey, const CLiwMap* aInMap,
|
|
252 |
CLiwDefaultMap* aOutMap );
|
|
253 |
|
|
254 |
/**
|
|
255 |
* Copies variant from in map for key KActionTrigger to out map with key KActionTrigger16
|
|
256 |
* and formated type(from TDesC8 to TDesC)
|
|
257 |
* @param aInMap input map
|
|
258 |
* @param aOutMap output map
|
|
259 |
*/
|
|
260 |
void CopyActionTrigger16L( const CLiwMap* aInMap,
|
|
261 |
CLiwDefaultMap* aOutMap );
|
|
262 |
|
|
263 |
/**
|
|
264 |
* Converts variant type from TDesC8 to TDesC
|
|
265 |
* @param aVariant variant to convert
|
|
266 |
*/
|
|
267 |
void CopyActionTrigger16L( const TLiwVariant& aVariant,
|
|
268 |
CLiwDefaultMap* aOutMap );
|
|
269 |
|
|
270 |
private:
|
|
271 |
// data
|
|
272 |
|
|
273 |
/*
|
|
274 |
* Storage database
|
|
275 |
* Own.
|
|
276 |
*/
|
|
277 |
CCpStorage* iStorage;
|
|
278 |
|
|
279 |
/*
|
|
280 |
* Array of registered notification handlers.
|
|
281 |
* Own.
|
|
282 |
*/
|
|
283 |
RPointerArray<CCPNotificationHandler> iNotificationsArray;
|
|
284 |
|
|
285 |
/*
|
|
286 |
* Action data cache
|
|
287 |
* Own.
|
|
288 |
*/
|
|
289 |
CCPActionDataCache* iActionDataCache;
|
|
290 |
|
|
291 |
#ifdef CONTENT_PUBLISHER_DEBUG
|
|
292 |
CCPDebug* iDebug;
|
|
293 |
#endif
|
|
294 |
};
|
|
295 |
|
|
296 |
#endif // C_CPDATA_MANAGER_H
|
|
297 |
// end of file
|