libkdepim

kabcresourcecached.cpp
1 /*
2  This file is part of libkdepim.
3  Copyright (c) 2004 Tobias Koenig <tokoe@kde.org>
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Library General Public
7  License as published by the Free Software Foundation; either
8  version 2 of the License, or (at your option) any later version.
9 
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Library General Public License for more details.
14 
15  You should have received a copy of the GNU Library General Public License
16  along with this library; see the file COPYING.LIB. If not, write to
17  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, USA.
19 */
20 
21 #include <tqfile.h>
22 
23 #include <kabc/vcardconverter.h>
24 #include <kdebug.h>
25 #include <klocale.h>
26 #include <kstandarddirs.h>
27 
28 #include "kabcresourcecached.h"
29 
30 using namespace KABC;
31 
32 ResourceCached::ResourceCached( const KConfig *config )
33  : KABC::Resource( config ), mIdMapper( "kabc/uidmaps/" ),
34  mReloadPolicy( ReloadInterval ), mReloadInterval( 10 ),
35  mKABCReloadTimer( 0, "mKABCReloadTimer" ), mReloaded( false ),
36  mSavePolicy( SaveDelayed ), mSaveInterval( 10 ),
37  mKABCSaveTimer( 0, "mKABCSaveTimer" )
38 {
39  connect( &mKABCReloadTimer, TQT_SIGNAL( timeout() ), TQT_SLOT( slotKABCReload() ) );
40  connect( &mKABCSaveTimer, TQT_SIGNAL( timeout() ), TQT_SLOT( slotKABCSave() ) );
41 
42  if (config)
43  this->readConfig(const_cast<KConfig *>(config));
44 }
45 
46 ResourceCached::~ResourceCached()
47 {
48 }
49 
50 void ResourceCached::setReloadPolicy( int i )
51 {
52  mReloadPolicy = i;
53 
54  setupReloadTimer();
55 }
56 
57 int ResourceCached::reloadPolicy() const
58 {
59  return mReloadPolicy;
60 }
61 
62 void ResourceCached::setReloadInterval( int minutes )
63 {
64  mReloadInterval = minutes;
65 }
66 
67 int ResourceCached::reloadInterval() const
68 {
69  return mReloadInterval;
70 }
71 
72 void ResourceCached::setSavePolicy( int i )
73 {
74  mSavePolicy = i;
75 
76  setupSaveTimer();
77 }
78 
79 int ResourceCached::savePolicy() const
80 {
81  return mSavePolicy;
82 }
83 
84 void ResourceCached::setSaveInterval( int minutes )
85 {
86  mSaveInterval = minutes;
87 }
88 
89 int ResourceCached::saveInterval() const
90 {
91  return mSaveInterval;
92 }
93 
94 void ResourceCached::writeConfig( KConfig *config )
95 {
96  config->writeEntry( "ReloadPolicy", mReloadPolicy );
97  config->writeEntry( "ReloadInterval", mReloadInterval );
98 
99  config->writeEntry( "SavePolicy", mSavePolicy );
100  config->writeEntry( "SaveInterval", mSaveInterval );
101 
102  config->writeEntry( "LastLoad", mLastLoad );
103  config->writeEntry( "LastSave", mLastSave );
104 
105  KABC::Resource::writeConfig( config );
106 }
107 
108 void ResourceCached::readConfig( KConfig *config )
109 {
110  mReloadPolicy = config->readNumEntry( "ReloadPolicy", ReloadNever );
111  mReloadInterval = config->readNumEntry( "ReloadInterval", 10 );
112 
113  mSaveInterval = config->readNumEntry( "SaveInterval", 10 );
114  mSavePolicy = config->readNumEntry( "SavePolicy", SaveNever );
115 
116  mLastLoad = config->readDateTimeEntry( "LastLoad" );
117  mLastSave = config->readDateTimeEntry( "LastSave" );
118 
119  setupSaveTimer();
120  setupReloadTimer();
121 }
122 
123 void ResourceCached::setupSaveTimer()
124 {
125  if ( mSavePolicy == SaveInterval ) {
126  kdDebug(5800) << "ResourceCached::setSavePolicy(): start save timer (interval "
127  << mSaveInterval << " minutes)." << endl;
128  mKABCSaveTimer.start( mSaveInterval * 60 * 1000 ); // n minutes
129  } else {
130  mKABCSaveTimer.stop();
131  }
132 }
133 
134 void ResourceCached::setupReloadTimer()
135 {
136  if ( mReloadPolicy == ReloadInterval ) {
137  kdDebug(5800) << "ResourceCached::setSavePolicy(): start reload timer "
138  "(interval " << mReloadInterval << " minutes)" << endl;
139  mKABCReloadTimer.start( mReloadInterval * 60 * 1000 ); // n minutes
140  } else {
141  mKABCReloadTimer.stop();
142  }
143 }
144 
145 void ResourceCached::slotKABCReload()
146 {
147  if ( !isActive() ) return;
148 
149  kdDebug(5800) << "ResourceCached::slotKABCReload()" << endl;
150 
151  load();
152 }
153 
154 void ResourceCached::slotKABCSave()
155 {
156  if ( !isActive() ) return;
157 
158  kdDebug(5800) << "ResourceCached::slotKABCSave()" << endl;
159 
160  KABC::Ticket *ticket = requestSaveTicket();
161  if ( ticket ) {
162  save( ticket );
163  }
164 }
165 
166 void ResourceCached::insertAddressee( const Addressee &addr )
167 {
168  if ( !mAddrMap.contains( addr.uid() ) ) { // new contact
169  if ( mDeletedAddressees.contains( addr.uid() ) ) {
170  // it was first removed, then added, so it's an update...
171  mDeletedAddressees.remove( addr.uid() );
172 
173  mAddrMap.insert( addr.uid(), addr );
174  mChangedAddressees.insert( addr.uid(), addr );
175  return;
176  }
177 
178  mAddrMap.insert( addr.uid(), addr );
179  mAddedAddressees.insert( addr.uid(), addr );
180  } else {
181  KABC::Addressee oldAddressee = mAddrMap.find( addr.uid() ).data();
182  if ( oldAddressee != addr ) {
183  mAddrMap.remove( addr.uid() );
184  mAddrMap.insert( addr.uid(), addr );
185  mChangedAddressees.insert( addr.uid(), addr );
186  }
187  }
188 }
189 
190 void ResourceCached::removeAddressee( const Addressee &addr )
191 {
192  if ( mAddedAddressees.contains( addr.uid() ) ) {
193  mAddedAddressees.remove( addr.uid() );
194  return;
195  }
196 
197  if ( mDeletedAddressees.find( addr.uid() ) == mDeletedAddressees.end() )
198  mDeletedAddressees.insert( addr.uid(), addr );
199 
200  mAddrMap.remove( addr.uid() );
201 }
202 
203 void ResourceCached::loadCache()
204 {
205  mAddrMap.clear();
206 
207  setIdMapperIdentifier();
208  mIdMapper.load();
209 
210  // load cache
211  TQFile file( cacheFile() );
212  if ( !file.open( IO_ReadOnly ) )
213  return;
214 
215 
216  KABC::VCardConverter converter;
217 #if defined(KABC_VCARD_ENCODING_FIX)
218  KABC::Addressee::List list = converter.parseVCardsRaw( file.readAll().data() );
219 #else
220  KABC::Addressee::List list = converter.parseVCards( TQString::fromUtf8( file.readAll() ) );
221 #endif
222  KABC::Addressee::List::Iterator it;
223 
224  for ( it = list.begin(); it != list.end(); ++it ) {
225  (*it).setResource( this );
226  (*it).setChanged( false );
227  mAddrMap.insert( (*it).uid(), *it );
228  }
229 
230  file.close();
231 }
232 
233 void ResourceCached::saveCache()
234 {
235  setIdMapperIdentifier();
236  mIdMapper.save();
237 
238  // save cache
239  TQFile file( cacheFile() );
240  if ( !file.open( IO_WriteOnly ) )
241  return;
242 
243  KABC::Addressee::List list = mAddrMap.values();
244 
245  KABC::VCardConverter converter;
246 #if defined(KABC_VCARD_ENCODING_FIX)
247  TQCString vCard = converter.createVCardsRaw( list );
248  file.writeBlock( vCard, vCard.length() );
249 #else
250  TQString vCard = converter.createVCards( list );
251  file.writeBlock( vCard.utf8(), vCard.utf8().length() );
252 #endif
253  file.close();
254 }
255 
256 void ResourceCached::clearCache()
257 {
258  // TEST ME
259  mAddrMap.clear();
260 }
261 
262 void ResourceCached::cleanUpCache( const KABC::Addressee::List &addrList )
263 {
264  // load cache
265  TQFile file( cacheFile() );
266  if ( !file.open( IO_ReadOnly ) )
267  return;
268 
269 
270  KABC::VCardConverter converter;
271 #if defined(KABC_VCARD_ENCODING_FIX)
272  KABC::Addressee::List list = converter.parseVCardsRaw( file.readAll().data() );
273 #else
274  KABC::Addressee::List list = converter.parseVCards( TQString::fromUtf8( file.readAll() ) );
275 #endif
276  KABC::Addressee::List::Iterator cacheIt;
277  KABC::Addressee::List::ConstIterator it;
278 
279  for ( cacheIt = list.begin(); cacheIt != list.end(); ++cacheIt ) {
280  bool found = false;
281  for ( it = addrList.begin(); it != addrList.end(); ++it ) {
282  if ( (*it).uid() == (*cacheIt).uid() )
283  found = true;
284  }
285 
286  if ( !found ) {
287  mIdMapper.removeRemoteId( mIdMapper.remoteId( (*cacheIt).uid() ) );
288  mAddrMap.remove( (*cacheIt).uid() );
289  }
290  }
291 
292  file.close();
293 }
294 
295 KPIM::IdMapper& ResourceCached::idMapper()
296 {
297  return mIdMapper;
298 }
299 
300 bool ResourceCached::hasChanges() const
301 {
302  return !( mAddedAddressees.isEmpty() &&
303  mChangedAddressees.isEmpty() &&
304  mDeletedAddressees.isEmpty() );
305 }
306 
307 void ResourceCached::clearChanges()
308 {
309  mAddedAddressees.clear();
310  mChangedAddressees.clear();
311  mDeletedAddressees.clear();
312 }
313 
314 void ResourceCached::clearChange( const KABC::Addressee &addr )
315 {
316  mAddedAddressees.remove( addr.uid() );
317  mChangedAddressees.remove( addr.uid() );
318  mDeletedAddressees.remove( addr.uid() );
319 }
320 
321 void ResourceCached::clearChange( const TQString &uid )
322 {
323  mAddedAddressees.remove( uid );
324  mChangedAddressees.remove( uid );
325  mDeletedAddressees.remove( uid );
326 }
327 
328 KABC::Addressee::List ResourceCached::addedAddressees() const
329 {
330  return mAddedAddressees.values();
331 }
332 
333 KABC::Addressee::List ResourceCached::changedAddressees() const
334 {
335  return mChangedAddressees.values();
336 }
337 
338 KABC::Addressee::List ResourceCached::deletedAddressees() const
339 {
340  return mDeletedAddressees.values();
341 }
342 
343 TQString ResourceCached::cacheFile() const
344 {
345  return locateLocal( "cache", "kabc/kresources/" + identifier() );
346 }
347 
348 TQString ResourceCached::changesCacheFile( const TQString &type ) const
349 {
350  return locateLocal( "cache", "kabc/changescache/" + identifier() + "_" + type );
351 }
352 
353 void ResourceCached::saveChangesCache( const TQMap<TQString, KABC::Addressee> &map, const TQString &type )
354 {
355  TQFile file( changesCacheFile( type ) );
356 
357  const KABC::Addressee::List list = map.values();
358  if ( list.isEmpty() ) {
359  file.remove();
360  } else {
361  if ( !file.open( IO_WriteOnly ) ) {
362  kdError() << "Can't open changes cache file '" << file.name() << "' for saving." << endl;
363  return;
364  }
365 
366  KABC::VCardConverter converter;
367 #if defined(KABC_VCARD_ENCODING_FIX)
368  const TQCString vCards = converter.createVCardsRaw( list );
369  file.writeBlock( vCards, vCards.length() );
370 #else
371  const TQString vCards = converter.createVCards( list );
372  TQCString content = vCards.utf8();
373  file.writeBlock( content, content.length() );
374 #endif
375  }
376 }
377 
378 void ResourceCached::saveChangesCache()
379 {
380  saveChangesCache( mAddedAddressees, "added" );
381  saveChangesCache( mDeletedAddressees, "deleted" );
382  saveChangesCache( mChangedAddressees, "changed" );
383 }
384 
385 void ResourceCached::loadChangesCache( TQMap<TQString, KABC::Addressee> &map, const TQString &type )
386 {
387  TQFile file( changesCacheFile( type ) );
388  if ( !file.open( IO_ReadOnly ) )
389  return;
390 
391  KABC::VCardConverter converter;
392 
393 #if defined(KABC_VCARD_ENCODING_FIX)
394  const KABC::Addressee::List list = converter.parseVCardsRaw( file.readAll().data() );
395 #else
396  const KABC::Addressee::List list = converter.parseVCards( TQString::fromUtf8( file.readAll() ) );
397 #endif
398  KABC::Addressee::List::ConstIterator it;
399  for ( it = list.begin(); it != list.end(); ++it )
400  map.insert( (*it).uid(), *it );
401 
402  file.close();
403 }
404 
405 void ResourceCached::loadChangesCache()
406 {
407  loadChangesCache( mAddedAddressees, "added" );
408  loadChangesCache( mDeletedAddressees, "deleted" );
409  loadChangesCache( mChangedAddressees, "changed" );
410 }
411 
412 void ResourceCached::setIdMapperIdentifier()
413 {
414  mIdMapper.setIdentifier( type() + "_" + identifier() );
415 }
416 
417 #include "kabcresourcecached.moc"