1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*
This file is part of libtdepim.
Copyright (c) 2004 Tobias Koenig <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KABC_RESOURCECACHED_H
#define KABC_RESOURCECACHED_H
#include <kabc/resource.h>
#include <tdepimmacros.h>
#include <tqdatetime.h>
#include <tqtimer.h>
#include "libemailfunctions/idmapper.h"
namespace KABC {
class KDE_EXPORT ResourceCached : public Resource
{
Q_OBJECT
public:
/**
Reload policy.
@see setReloadPolicy(), reloadPolicy()
*/
enum { ReloadNever, ReloadOnStartup, ReloadInterval };
/**
Save policy.
@see setSavePolicy(), savePolicy()
*/
enum { SaveNever, SaveOnExit, SaveInterval, SaveDelayed, SaveAlways };
ResourceCached( const KConfig* );
~ResourceCached();
/**
Set reload policy. This controls when the cache is refreshed.
ReloadNever never reload
ReloadOnStartup reload when resource is started
ReloadInterval reload regularly after given interval
*/
void setReloadPolicy( int policy );
/**
Return reload policy.
@see setReloadPolicy()
*/
int reloadPolicy() const;
/**
Set reload interval in minutes which is used when reload policy is
ReloadInterval.
*/
void setReloadInterval( int minutes );
/**
Return reload interval in minutes.
*/
int reloadInterval() const;
/**
Set save policy. This controls when the cache is refreshed.
SaveNever never save
SaveOnExit save when resource is exited
SaveInterval save regularly after given interval
SaveDelayed save after small delay
SaveAlways save on every change
*/
void setSavePolicy( int policy );
/**
Return save policy.
@see setsavePolicy()
*/
int savePolicy() const;
/**
Set save interval in minutes which is used when save policy is
SaveInterval.
*/
void setSaveInterval( int minutes );
/**
Return save interval in minutes.
*/
int saveInterval() const;
void setupSaveTimer();
void setupReloadTimer();
/**
Reads the resource specific config from disk.
*/
virtual void readConfig( KConfig *config );
/**
Writes the resource specific config to disk.
*/
virtual void writeConfig( KConfig *config );
/**
Insert an addressee into the resource.
*/
virtual void insertAddressee( const Addressee& );
/**
Removes an addressee from resource.
*/
virtual void removeAddressee( const Addressee& addr );
void loadCache();
void saveCache();
void clearCache();
void cleanUpCache( const KABC::Addressee::List &list );
/**
Returns a reference to the id mapper.
*/
KPIM::IdMapper& idMapper();
bool hasChanges() const;
void clearChanges();
void clearChange( const KABC::Addressee& );
void clearChange( const TQString& );
KABC::Addressee::List addedAddressees() const;
KABC::Addressee::List changedAddressees() const;
KABC::Addressee::List deletedAddressees() const;
protected:
virtual TQString cacheFile() const;
/**
Functions for keeping the changes persistent.
*/
virtual TQString changesCacheFile( const TQString& ) const;
void loadChangesCache( TQMap<TQString, KABC::Addressee>&, const TQString& );
void loadChangesCache();
void saveChangesCache( const TQMap<TQString, KABC::Addressee>&, const TQString& );
void saveChangesCache();
void setIdMapperIdentifier();
private:
TQMap<TQString, KABC::Addressee> mAddedAddressees;
TQMap<TQString, KABC::Addressee> mChangedAddressees;
TQMap<TQString, KABC::Addressee> mDeletedAddressees;
KPIM::IdMapper mIdMapper;
class ResourceCachedPrivate;
ResourceCachedPrivate *d;
int mReloadPolicy;
int mReloadInterval;
TQTimer mKABCReloadTimer;
bool mReloaded;
int mSavePolicy;
int mSaveInterval;
TQTimer mKABCSaveTimer;
TQDateTime mLastLoad;
TQDateTime mLastSave;
protected slots:
void slotKABCReload();
void slotKABCSave();
};
}
#endif
|
