66
|
1 |
/*
|
|
2 |
* Copyright (c) 2006 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: Notifies observers of external changes to the calendar database
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
//debug
|
|
21 |
#include "calendarui_debug.h"
|
|
22 |
|
|
23 |
// INCLUDE FILES
|
|
24 |
#include "CleanupResetAndDestroy.h"
|
|
25 |
#include "calendbchangenotifier.h" // CCalenDbChangeNotifier
|
|
26 |
#include "calenglobaldata.h" // Calendar global data
|
|
27 |
#include <calsession.h> // CalSession
|
|
28 |
#include <missedalarm.h>
|
|
29 |
#include <missedalarmstore.h>
|
|
30 |
#include <missedalarmstorecrkeys.h>
|
|
31 |
#include <calcalendarinfo.h>
|
|
32 |
|
|
33 |
// -----------------------------------------------------------------------------
|
|
34 |
// KTimerResolution limits the number of notifications sent to registered
|
|
35 |
// MCalenDBChangeObserver instances. Notifications may come from
|
|
36 |
// MCalChangeCallBack2 at a very high rate which could impact performance,
|
|
37 |
// for example by causing constant view refreshes.
|
|
38 |
// CCalenDbChangeNotifier notifies observers when KTimerResolution has elapsed
|
|
39 |
// since the last notification was received from MCalChangeCallBack2
|
|
40 |
// -----------------------------------------------------------------------------
|
|
41 |
const TInt KTimerResolution = 1000000; // 1 Second
|
|
42 |
|
|
43 |
// ============================ MEMBER FUNCTIONS ===============================
|
|
44 |
|
|
45 |
// -----------------------------------------------------------------------------
|
|
46 |
// CCalenDbChangeNotifier::CCalenDbChangeNotifier
|
|
47 |
// C++ default constructor can NOT contain any code, that might leave.
|
|
48 |
// (other items were commented in a header).
|
|
49 |
// -----------------------------------------------------------------------------
|
|
50 |
CCalenDbChangeNotifier::CCalenDbChangeNotifier( CCalSession& aSession )
|
|
51 |
: CActive( EPriorityNormal ),
|
|
52 |
iSession( aSession )
|
|
53 |
{
|
|
54 |
TRACE_ENTRY_POINT;
|
|
55 |
|
|
56 |
iRestartTimer = EFalse;
|
|
57 |
|
|
58 |
TRACE_EXIT_POINT;
|
|
59 |
}
|
|
60 |
|
|
61 |
// -----------------------------------------------------------------------------
|
|
62 |
// CCalenDbChangeNotifier::NewL
|
|
63 |
// Two-phased constructor.
|
|
64 |
// (other items were commented in a header).
|
|
65 |
// -----------------------------------------------------------------------------
|
|
66 |
CCalenDbChangeNotifier* CCalenDbChangeNotifier::NewL( CCalSession& aSession )
|
|
67 |
{
|
|
68 |
TRACE_ENTRY_POINT;
|
|
69 |
|
|
70 |
CCalenDbChangeNotifier* self = new( ELeave ) CCalenDbChangeNotifier( aSession );
|
|
71 |
CleanupStack::PushL( self );
|
|
72 |
self->ConstructL();
|
|
73 |
CleanupStack::Pop( self );
|
|
74 |
|
|
75 |
TRACE_EXIT_POINT;
|
|
76 |
return self;
|
|
77 |
}
|
|
78 |
|
|
79 |
// -----------------------------------------------------------------------------
|
|
80 |
// CCalenDbChangeNotifier::ConstructL
|
|
81 |
// Symbian 2nd phase constructor can leave.
|
|
82 |
// (other items were commented in a header).
|
|
83 |
// -----------------------------------------------------------------------------
|
|
84 |
void CCalenDbChangeNotifier::ConstructL()
|
|
85 |
{
|
|
86 |
TRACE_ENTRY_POINT;
|
|
87 |
|
|
88 |
// We want to receive notifications for the full agenda date range
|
|
89 |
TCalTime start, end;
|
|
90 |
start.SetTimeUtcL( TCalTime::MinTime() );
|
|
91 |
end.SetTimeUtcL( TCalTime::MaxTime() );
|
|
92 |
CalCommon::TCalTimeRange range( start, end );
|
|
93 |
|
|
94 |
// Create a notification filter
|
|
95 |
iCalChangeFilter = CCalChangeNotificationFilter::NewL(
|
|
96 |
MCalChangeCallBack2::EChangeEntryAll,
|
|
97 |
ETrue,
|
|
98 |
range );
|
|
99 |
|
|
100 |
// Enable database change notifications on current global data session
|
|
101 |
iSession.StartChangeNotification( *this, *iCalChangeFilter );
|
|
102 |
|
|
103 |
// Create a timer to limit the number of notifications broadcast
|
|
104 |
iNotificationTimer.CreateLocal();
|
|
105 |
|
|
106 |
// Active object, add to active scheduler
|
|
107 |
CActiveScheduler::Add( this );
|
|
108 |
|
|
109 |
TRACE_EXIT_POINT;
|
|
110 |
}
|
|
111 |
|
|
112 |
// -----------------------------------------------------------------------------
|
|
113 |
// CCalenDbChangeNotifier::~CCalenDbChangeNotifier
|
|
114 |
// Destructor
|
|
115 |
// (other items were commented in a header).
|
|
116 |
// -----------------------------------------------------------------------------
|
|
117 |
CCalenDbChangeNotifier::~CCalenDbChangeNotifier()
|
|
118 |
{
|
|
119 |
TRACE_ENTRY_POINT;
|
|
120 |
|
|
121 |
Cancel();
|
|
122 |
// Reset the observer array. Array contents are NOT owned by this class
|
|
123 |
iDBObservers.Reset();
|
|
124 |
|
|
125 |
iNotificationTimer.Close();
|
|
126 |
|
|
127 |
// Disable database change notifications on current global data session
|
|
128 |
PIM_TRAPD_HANDLE( iSession.StopChangeNotification() );
|
|
129 |
|
|
130 |
// Destroy the notification filter
|
|
131 |
delete iCalChangeFilter;
|
|
132 |
|
|
133 |
TRACE_EXIT_POINT;
|
|
134 |
}
|
|
135 |
|
|
136 |
// -----------------------------------------------------------------------------
|
|
137 |
// CCalenDbChangeNotifier::LastDBModificationTime
|
|
138 |
// Returns the time of the last database change notification. This may not be
|
|
139 |
// the time of the last notification sent to MCalenDBChangeObservers.
|
|
140 |
// (other items were commented in a header).
|
|
141 |
// -----------------------------------------------------------------------------
|
|
142 |
TTime CCalenDbChangeNotifier::LastDBModificationTime() const
|
|
143 |
{
|
|
144 |
TRACE_ENTRY_POINT;
|
|
145 |
|
|
146 |
TRACE_EXIT_POINT;
|
|
147 |
return iLastDbChangeNotification;
|
|
148 |
}
|
|
149 |
|
|
150 |
// -----------------------------------------------------------------------------
|
|
151 |
// CCalenDbChangeNotifier::CalChangeNotification
|
|
152 |
// Called when a change to the agenda database occurs from a different session
|
|
153 |
// to the one we are currently using.
|
|
154 |
// (other items were commented in a header).
|
|
155 |
// -----------------------------------------------------------------------------
|
|
156 |
void CCalenDbChangeNotifier::CalChangeNotification( RArray<TCalChangeEntry>& aChangeItems )
|
|
157 |
{
|
|
158 |
TRACE_ENTRY_POINT;
|
|
159 |
|
|
160 |
TRAP_IGNORE(HandleMissedAlarmsL(aChangeItems));
|
|
161 |
// Always update the last notification time, even if we don't notify
|
|
162 |
// our observers
|
|
163 |
iLastDbChangeNotification.UniversalTime();
|
|
164 |
if( !IsActive() )
|
|
165 |
{
|
|
166 |
iNotificationTimer.After( iStatus, KTimerResolution );
|
|
167 |
SetActive();
|
|
168 |
}
|
|
169 |
else
|
|
170 |
{
|
|
171 |
iRestartTimer = ETrue;
|
|
172 |
iNotificationTimer.Cancel();
|
|
173 |
}
|
|
174 |
|
|
175 |
TRACE_EXIT_POINT;
|
|
176 |
}
|
|
177 |
|
|
178 |
// -----------------------------------------------------------------------------
|
|
179 |
// CCalenDbChangeNotifier::HandleMissedAlarmsL
|
|
180 |
// Delete missed alarms when externally the entries are getting deleted.
|
|
181 |
// -----------------------------------------------------------------------------
|
|
182 |
void CCalenDbChangeNotifier::HandleMissedAlarmsL(const RArray<TCalChangeEntry>& aChangeItems)
|
|
183 |
{
|
|
184 |
TRACE_ENTRY_POINT
|
|
185 |
CRepository* missedAlarmStoreRepository = CRepository::NewL(
|
|
186 |
KCRUidMissedAlarmStore);
|
|
187 |
// Create missed alarm store
|
|
188 |
CMissedAlarmStore* missedAlarmStore = CMissedAlarmStore::NewL(
|
|
189 |
*missedAlarmStoreRepository);
|
|
190 |
CleanupStack::PushL(missedAlarmStore);
|
|
191 |
|
|
192 |
RPointerArray<CMissedAlarm> missedAlarmStorelist;
|
|
193 |
CleanupResetAndDestroyPushL(missedAlarmStorelist);
|
|
194 |
|
|
195 |
missedAlarmStore->GetL(missedAlarmStorelist);
|
|
196 |
|
|
197 |
CCalCalendarInfo* calendarInfo = iSession.CalendarInfoL();
|
|
198 |
CleanupStack::PushL(calendarInfo);
|
|
199 |
|
|
200 |
CCalenDbChangeNotifier::TCalLuidFilename calLuidFilename;
|
|
201 |
calLuidFilename.iFilename = calendarInfo->FileNameL();
|
|
202 |
|
|
203 |
if (missedAlarmStorelist.Count())
|
|
204 |
{
|
|
205 |
for (TInt idx = 0; idx < aChangeItems.Count(); idx++)
|
|
206 |
{
|
|
207 |
if (aChangeItems[idx].iChangeType == EChangeDelete)
|
|
208 |
{
|
|
209 |
calLuidFilename.iLuid = aChangeItems[idx].iEntryId;
|
|
210 |
TInt index = missedAlarmStorelist.Find(calLuidFilename,
|
|
211 |
CCalenDbChangeNotifier::DoFindEntryByLuid);
|
|
212 |
if (index != KErrNotFound)
|
|
213 |
{
|
|
214 |
CMissedAlarm* missedAlarm = missedAlarmStorelist[index];
|
|
215 |
missedAlarmStore->RemoveL(*missedAlarm);
|
|
216 |
}
|
|
217 |
}
|
|
218 |
}
|
|
219 |
}
|
|
220 |
|
|
221 |
CleanupStack::PopAndDestroy(calendarInfo);
|
|
222 |
CleanupStack::PopAndDestroy(&missedAlarmStorelist);
|
|
223 |
CleanupStack::PopAndDestroy(missedAlarmStore);
|
|
224 |
|
|
225 |
TRACE_EXIT_POINT
|
|
226 |
}
|
|
227 |
|
|
228 |
// -----------------------------------------------------------------------------
|
|
229 |
// CCalenDbChangeNotifier::DoFindEntryByLuid
|
|
230 |
// -----------------------------------------------------------------------------
|
|
231 |
TBool CCalenDbChangeNotifier::DoFindEntryByLuid(
|
|
232 |
const TCalLuidFilename* aLuidFilename,const CMissedAlarm& aMissedAlarm)
|
|
233 |
{
|
|
234 |
TRACE_ENTRY_POINT
|
|
235 |
TRACE_EXIT_POINT
|
|
236 |
return (aLuidFilename->iLuid == aMissedAlarm.iLuid
|
|
237 |
&& !aLuidFilename->iFilename.CompareF(aMissedAlarm.iCalFileName));
|
|
238 |
}
|
|
239 |
|
|
240 |
// -----------------------------------------------------------------------------
|
|
241 |
// CCalenDbChangeNotifier::RegisterObserverL
|
|
242 |
// Adds the passed observer to the observer array. All observers in the array
|
|
243 |
// will be notified of changes to the agenda database.
|
|
244 |
// (other items were commented in a header).
|
|
245 |
// -----------------------------------------------------------------------------
|
|
246 |
void CCalenDbChangeNotifier::RegisterObserverL( MCalenDBChangeObserver& aDBObserver )
|
|
247 |
{
|
|
248 |
TRACE_ENTRY_POINT;
|
|
249 |
|
|
250 |
iDBObservers.Append( &aDBObserver );
|
|
251 |
|
|
252 |
TRACE_EXIT_POINT;
|
|
253 |
}
|
|
254 |
|
|
255 |
// -----------------------------------------------------------------------------
|
|
256 |
// CCalenDbChangeNotifier::DeRegisterObserverL
|
|
257 |
// Removes the passed observer to the observer array. All observers in the array
|
|
258 |
// will be notified of changes to the agenda database.
|
|
259 |
// -----------------------------------------------------------------------------
|
|
260 |
void CCalenDbChangeNotifier::DeRegisterObserverL( MCalenDBChangeObserver& aDBObserver )
|
|
261 |
{
|
|
262 |
TRACE_ENTRY_POINT;
|
|
263 |
|
|
264 |
for( TInt x = 0; x < iDBObservers.Count(); ++x )
|
|
265 |
{
|
|
266 |
if( iDBObservers[x] == &aDBObserver )
|
|
267 |
{
|
|
268 |
iDBObservers.Remove( x );
|
|
269 |
return;
|
|
270 |
}
|
|
271 |
}
|
|
272 |
User::Leave( KErrNotFound );
|
|
273 |
|
|
274 |
TRACE_EXIT_POINT;
|
|
275 |
}
|
|
276 |
|
|
277 |
// -----------------------------------------------------------------------------
|
|
278 |
// CCalenDbChangeNotifier::RunL
|
|
279 |
// From CActive::RunL
|
|
280 |
// Called when notification timer expires
|
|
281 |
// (other items were commented in a header).
|
|
282 |
// -----------------------------------------------------------------------------
|
|
283 |
void CCalenDbChangeNotifier::RunL()
|
|
284 |
{
|
|
285 |
TRACE_ENTRY_POINT;
|
|
286 |
|
|
287 |
switch( iStatus.Int() )
|
|
288 |
{
|
|
289 |
case KErrCancel:
|
|
290 |
{
|
|
291 |
// The normal reason for the timer being cancelled is another
|
|
292 |
// database change. Restart the timer.
|
|
293 |
if( iRestartTimer )
|
|
294 |
{
|
|
295 |
iRestartTimer = EFalse;
|
|
296 |
iNotificationTimer.After( iStatus, KTimerResolution );
|
|
297 |
SetActive();
|
|
298 |
}
|
|
299 |
}
|
|
300 |
break;
|
|
301 |
|
|
302 |
case KErrNone:
|
|
303 |
{
|
|
304 |
//Timer completion, notify observers
|
|
305 |
for( TInt x = 0; x < iDBObservers.Count(); ++x )
|
|
306 |
{
|
|
307 |
iDBObservers[x]->HandleDBChangeL();
|
|
308 |
}
|
|
309 |
}
|
|
310 |
break;
|
|
311 |
|
|
312 |
default:
|
|
313 |
{
|
|
314 |
User::Leave( KErrArgument );
|
|
315 |
}
|
|
316 |
break;
|
|
317 |
}
|
|
318 |
|
|
319 |
TRACE_EXIT_POINT;
|
|
320 |
}
|
|
321 |
|
|
322 |
// -----------------------------------------------------------------------------
|
|
323 |
// CCalenDbChangeNotifier::RunError
|
|
324 |
// From CActive::RunError
|
|
325 |
// (other items were commented in a header).
|
|
326 |
// -----------------------------------------------------------------------------
|
|
327 |
TInt CCalenDbChangeNotifier::RunError( TInt aError )
|
|
328 |
{
|
|
329 |
TRACE_ENTRY_POINT;
|
|
330 |
|
|
331 |
//RunL leaving means that the view could not be refreshed.
|
|
332 |
//Theres not much we can do except be ready for the next database event.
|
|
333 |
iRestartTimer = EFalse;
|
|
334 |
|
|
335 |
TRACE_EXIT_POINT;
|
|
336 |
return aError;
|
|
337 |
}
|
|
338 |
|
|
339 |
// -----------------------------------------------------------------------------
|
|
340 |
// CCalenDbChangeNotifier::DoCancel
|
|
341 |
// From CActive::DoCancel
|
|
342 |
// (other items were commented in a header).
|
|
343 |
// -----------------------------------------------------------------------------
|
|
344 |
void CCalenDbChangeNotifier::DoCancel()
|
|
345 |
{
|
|
346 |
TRACE_ENTRY_POINT;
|
|
347 |
|
|
348 |
// Stop the notification timer
|
|
349 |
iRestartTimer = EFalse;
|
|
350 |
iNotificationTimer.Cancel();
|
|
351 |
|
|
352 |
TRACE_EXIT_POINT;
|
|
353 |
}
|
|
354 |
|
|
355 |
// End of File
|