Initial revision

4 files changed, 662 insertions, 0 deletions

diff --git a/kabc/plugins/dir/resourcedir.cpp b/kabc/plugins/dir/resourcedir.cpp
new file mode 100644
index 0000000..f354a9e
--- a/dev/null
+++ b/kabc/plugins/dir/resourcedir.cpp
@@ -0,0 +1,363 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+
+    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., 59 Temple Place - Suite 330,
+    Boston, MA 02111-1307, USA.
+*/
+
+/*
+Enhanced Version of the file for platform independent KDE tools.
+Copyright (c) 2004 Ulf Schenk
+
+$Id$
+*/
+
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#ifndef _WIN32_
+#include <unistd.h>
+#endif
+
+#include <qregexp.h>
+#include <qtimer.h>
+#include <qwidget.h>
+
+#include <kapplication.h>
+#include <kconfig.h>
+#include <kdebug.h>
+//US #include <kgenericfactory.h>
+#include <kglobal.h>
+#include <klocale.h>
+#include <kstandarddirs.h>
+#include <kurlrequester.h>
+
+#include "addressbook.h"
+
+//US #include "formatfactory.h"
+
+#include "resourcedirconfig.h"
+#include "stdaddressbook.h"
+
+//US
+#include <qdir.h>
+#include <formats/vcardformatplugin2.h>
+#include <formats/binaryformat.h>
+
+#include "resourcedir.h"
+
+using namespace KABC;
+
+extern "C"
+{
+  void *init_kabc_dir()
+  {
+  qDebug("resourcedir.cpp : init_kabc_dir  has to be changed");
+//US    return new KRES::PluginFactory<ResourceDir,ResourceDirConfig>();
+  return 0;
+  }
+}
+
+
+ResourceDir::ResourceDir( const KConfig *config )
+    : Resource( config )
+{
+  QString path;
+
+  KConfig *cfg = (KConfig *)config;
+  if ( cfg ) {
+//US     path = config->readEntry( "FilePath" );
+     path = cfg->readEntry( "FilePath", StdAddressBook::directoryName() );
+//US     mFormatName = config->readEntry( "FileFormat" );
+     mFormatName = cfg->readEntry( "FileFormat", "vcard" );
+  } else {
+    path = StdAddressBook::directoryName();
+    mFormatName = "vcard";
+  }
+
+
+/*US  FormatFactory *factory = FormatFactory::self();
+  mFormat = factory->format( mFormatName );
+
+  if ( !mFormat ) {
+    mFormatName = "vcard";
+    mFormat = factory->format( mFormatName );
+  }
+*/
+
+//US  qDebug("ResourceDir::ResourceDir initialized with format %s ", mFormatName.latin1());
+  if (mFormatName == "vcard")
+    mFormat = new VCardFormatPlugin2();
+  else if (mFormatName == "binary")
+    mFormat = new BinaryFormat();
+  else
+    qDebug("ResourceFile::init format unknown !!! %s ", mFormatName.latin1());
+
+  
+/*US we have no KDirWatch. SO simulate the signals from inside the apropriate methods
+  connect( &mDirWatch, SIGNAL( dirty(const QString&) ), SLOT( pathChanged() ) );
+  connect( &mDirWatch, SIGNAL( created(const QString&) ), SLOT( pathChanged() ) );
+  connect( &mDirWatch, SIGNAL( deleted(const QString&) ), SLOT( pathChanged() ) );
+*/
+
+  setPath( path );
+}
+
+ResourceDir::~ResourceDir()
+{
+  delete mFormat;
+  mFormat = 0;
+}
+
+void ResourceDir::writeConfig( KConfig *config )
+{
+  Resource::writeConfig( config );
+
+  config->writeEntry( "FilePath", mPath );
+  config->writeEntry( "FileFormat", mFormatName );
+}
+
+Ticket *ResourceDir::requestSaveTicket()
+{
+  kdDebug(5700) << "ResourceDir::requestSaveTicket()" << endl;
+
+  if ( !addressBook() ) return 0;
+
+  if ( !lock( mPath ) ) {
+    kdDebug(5700) << "ResourceDir::requestSaveTicket(): Unable to lock path '"
+                  << mPath << "'" << endl;
+    return 0;
+  }
+  return createTicket( this );
+}
+
+
+bool ResourceDir::doOpen()
+{
+  QDir dir( mPath );
+  if ( !dir.exists() ) { // no directory available
+    return dir.mkdir( dir.path() );
+  } else {
+    QString testName = dir.entryList( QDir::Files )[0];
+    if ( testName.isNull() || testName.isEmpty() ) // no file in directory
+      return true;
+
+    QFile file( mPath + "/" + testName );
+    if ( file.open( IO_ReadOnly ) )
+      return true;
+
+    if ( file.size() == 0 )
+      return true;
+
+    bool ok = mFormat->checkFormat( &file );
+    file.close();
+    return ok;
+  }
+}
+
+void ResourceDir::doClose()
+{
+}
+
+bool ResourceDir::load()
+{
+  kdDebug(5700) << "ResourceDir::load(): '" << mPath << "'" << endl;
+
+  QDir dir( mPath );
+  QStringList files = dir.entryList( QDir::Files );
+
+  QStringList::Iterator it;
+  bool ok = true;
+  for ( it = files.begin(); it != files.end(); ++it ) {
+    QFile file( mPath + "/" + (*it) );
+
+    if ( !file.open( IO_ReadOnly ) ) {
+      addressBook()->error( i18n( "Unable to open file '%1' for reading" ).arg( file.name() ) );
+      ok = false;
+      continue;
+    }
+
+    if ( !mFormat->loadAll( addressBook(), this, &file ) )
+      ok = false;
+
+    file.close();
+  }
+
+  return ok;
+}
+
+bool ResourceDir::save( Ticket *ticket )
+{
+  kdDebug(5700) << "ResourceDir::save(): '" << mPath << "'" << endl;
+
+  AddressBook::Iterator it;
+  bool ok = true;
+
+  for ( it = addressBook()->begin(); it != addressBook()->end(); ++it ) {
+    if ( (*it).resource() != this || !(*it).changed() )
+      continue;
+
+    QFile file( mPath + "/" + (*it).uid() );
+    if ( !file.open( IO_WriteOnly ) ) {
+      addressBook()->error( i18n( "Unable to open file '%1' for writing" ).arg( file.name() ) );
+      continue;
+    }
+
+    mFormat->save( *it, &file );
+
+    // mark as unchanged
+    (*it).setChanged( false );
+
+    file.close();
+  }
+
+  delete ticket;
+  unlock( mPath );
+
+  return ok;
+}
+
+bool ResourceDir::lock( const QString &path )
+{
+  kdDebug(5700) << "ResourceDir::lock()" << endl;
+
+  QString p = path;
+//US change the implementation how the lockfilename is getting created
+//US  p.replace( QRegExp("/"), "_" );
+//US  QString lockName = locateLocal( "data", "kabc/lock/" + p + ".lock" );
+  KURL url(p);  
+  QString lockName = locateLocal( "data", "kabc/lock/" + url.fileName() + ".lock" );
+  
+  
+  kdDebug(5700) << "-- lock name: " << lockName << endl;
+
+  if ( QFile::exists( lockName ) ) return false;
+
+  QString lockUniqueName;
+  lockUniqueName = p + KApplication::randomString( 8 );
+
+  url = lockUniqueName;  
+//US  mLockUniqueName = locateLocal( "data", "kabc/lock/" + lockUniqueName );
+  mLockUniqueName = locateLocal( "data", "kabc/lock/" + url.fileName() );
+    
+  kdDebug(5700) << "-- lock unique name: " << mLockUniqueName << endl;
+
+  // Create unique file
+  QFile file( mLockUniqueName );
+  file.open( IO_WriteOnly );
+  file.close();
+
+  // Create lock file
+#ifdef _WIN32_
+  int result = 0;
+  qDebug("WARNING: ResourceDir::lock cannot link ");
+#else
+  int result = ::link( QFile::encodeName( mLockUniqueName ),
+                       QFile::encodeName( lockName ) );
+#endif
+  if ( result == 0 ) {
+    addressBook()->emitAddressBookLocked();
+    return true;
+  }
+
+  // TODO: check stat
+
+  return false;
+}
+
+void ResourceDir::unlock( const QString &path )
+{
+  QString p = path;
+//US change the implementation how the lockfilename is getting created
+//US  p.replace( QRegExp( "/" ), "_" );
+//US  QString lockName = locate( "data", "kabc/lock/" + p + ".lock" );
+  KURL url(p);  
+  QString lockName = locate( "data", "kabc/lock/" + url.fileName() + ".lock" );
+
+  ::unlink( QFile::encodeName( lockName ) );
+  QFile::remove( mLockUniqueName );
+  addressBook()->emitAddressBookUnlocked();
+}
+
+void ResourceDir::setPath( const QString &path )
+{
+/*US ToDo: no synchronization so far. Has to be changed in the future
+  mDirWatch.stopScan();
+  mDirWatch.removeDir( mPath );
+*/
+  mPath = path;
+
+/*US ToDo: no synchronization so far. Has to be changed in the future
+  mDirWatch.addDir( mPath, true );
+  mDirWatch.startScan();
+*/  
+
+//US simulate KDirWatch event  
+  pathChanged();
+
+}
+
+QString ResourceDir::path() const
+{
+  return mPath;
+}
+
+void ResourceDir::setFormat( const QString &format )
+{
+  mFormatName = format;
+
+  if ( mFormat )
+    delete mFormat;
+
+//US  FormatFactory *factory = FormatFactory::self();
+//US  mFormat = factory->format( mFormatName );
+
+qDebug("ResourceDir::setFormat initialized with format %s ", format.latin1());
+  if (mFormatName == "vcard")
+    mFormat = new VCardFormatPlugin2();
+  else if (mFormatName == "binary")
+    mFormat = new BinaryFormat();
+  else
+    qDebug("ResourceDir::setFormat format unknown !!! %s ", format.latin1());
+
+
+}
+
+QString ResourceDir::format() const
+{
+  return mFormatName;
+}
+
+void ResourceDir::pathChanged()
+{
+  if ( !addressBook() )
+    return;
+
+  load();
+  addressBook()->emitAddressBookChanged();
+}
+
+void ResourceDir::removeAddressee( const Addressee& addr )
+{
+    QFile::remove( mPath + "/" + addr.uid() );
+}
+
+void ResourceDir::cleanUp()
+{
+  unlock( mPath );
+}
+
+//US #include "resourcedir.moc"
diff --git a/kabc/plugins/dir/resourcedir.h b/kabc/plugins/dir/resourcedir.h
new file mode 100644
index 0000000..6e35695
--- a/dev/null
+++ b/kabc/plugins/dir/resourcedir.h
@@ -0,0 +1,115 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+
+    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., 59 Temple Place - Suite 330,
+    Boston, MA 02111-1307, USA.
+*/
+
+/*
+Enhanced Version of the file for platform independent KDE tools.
+Copyright (c) 2004 Ulf Schenk
+
+$Id$
+*/
+
+#ifndef KABC_RESOURCEDIR_H
+#define KABC_RESOURCEDIR_H
+
+#include <kconfig.h>
+#include <kdirwatch.h>
+
+#include <sys/types.h>
+
+#include "resource.h"
+
+class QTimer;
+
+namespace KABC {
+
+class FormatPlugin;
+
+/**
+  @internal
+*/
+class ResourceDir : public Resource
+{
+  Q_OBJECT
+
+public:
+  ResourceDir( const KConfig* );
+  ~ResourceDir();
+
+  virtual void writeConfig( KConfig* );
+
+  virtual bool doOpen();
+  virtual void doClose();
+  
+  virtual Ticket *requestSaveTicket();
+
+  virtual bool load();
+  virtual bool save( Ticket * );
+
+  /**
+   * Set path to be used for saving.
+   */
+  void setPath( const QString & );
+
+  /**
+   * Return path used for loading and saving the address book.
+   */
+  QString path() const;
+
+  /**
+   * Set the format by name.
+   */
+  void setFormat( const QString &format );
+
+  /**
+   * Returns the format name.
+   */
+  QString format() const;
+  
+  /**
+   * Remove a addressee from its source.
+   * This method is mainly called by KABC::AddressBook.
+   */
+  virtual void removeAddressee( const Addressee& addr );
+
+  /**
+   * This method is called by an error handler if the application
+   * crashed
+   */
+  virtual void cleanUp();
+
+protected slots:
+  void pathChanged();
+
+protected:
+  bool lock( const QString &path );
+  void unlock( const QString &path );
+
+private:
+  FormatPlugin *mFormat;
+
+  KDirWatch mDirWatch;
+
+  QString mPath;
+  QString mFormatName;
+  QString mLockUniqueName;
+};
+
+}
+#endif
diff --git a/kabc/plugins/dir/resourcedirconfig.cpp b/kabc/plugins/dir/resourcedirconfig.cpp
new file mode 100644
index 0000000..98d18fe
--- a/dev/null
+++ b/kabc/plugins/dir/resourcedirconfig.cpp
@@ -0,0 +1,123 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+
+    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., 59 Temple Place - Suite 330,
+    Boston, MA 02111-1307, USA.
+*/
+
+/*
+Enhanced Version of the file for platform independent KDE tools.
+Copyright (c) 2004 Ulf Schenk
+
+$Id$
+*/
+
+#include <qlabel.h>
+#include <qlayout.h>
+
+#include <kdebug.h>
+#include <klocale.h>
+#include <kstandarddirs.h>
+#include <kdialog.h>
+
+//US #include "formatfactory.h"
+#include "resourcedir.h"
+#include "stdaddressbook.h"
+
+#include "resourcedirconfig.h"
+
+using namespace KABC;
+
+ResourceDirConfig::ResourceDirConfig( QWidget* parent,  const char* name )
+    : KRES::ConfigWidget( parent, name )
+{
+  QGridLayout *mainLayout = new QGridLayout( this, 2, 2, 0, 
+      KDialog::spacingHint() );
+
+  QLabel *label = new QLabel( i18n( "Format:" ), this );
+  mFormatBox = new KComboBox( this );
+
+  mainLayout->addWidget( label, 0, 0 );
+  mainLayout->addWidget( mFormatBox, 0, 1 );
+
+  label = new QLabel( i18n( "Location:" ), this );
+  mFileNameEdit = new KURLRequester( this );
+//US  mFileNameEdit->setMode( KFile::Directory );
+
+  mainLayout->addWidget( label, 1, 0 );
+  mainLayout->addWidget( mFileNameEdit, 1, 1 );
+
+/*US lets hardcode the formats instead of using a factory
+  FormatFactory *factory = FormatFactory::self();
+  QStringList formats = factory->formats();
+  QStringList::Iterator it;
+  for ( it = formats.begin(); it != formats.end(); ++it ) {
+    FormatInfo *info = factory->info( *it );
+    if ( info ) {
+      mFormatTypes << (*it);
+      mFormatBox->insertItem( info->nameLabel );
+    }
+  }
+*/
+  mFormatTypes << "vcard";
+  mFormatTypes << "binary";
+  mFormatBox->insertItem( "vcard" );
+  mFormatBox->insertItem( "binary" );
+  
+
+  mInEditMode = false;
+}
+
+void ResourceDirConfig::setEditMode( bool value )
+{
+  mFormatBox->setEnabled( !value );
+  mInEditMode = value;
+}
+
+void ResourceDirConfig::loadSettings( KRES::Resource *res )
+{
+//US  ResourceDir *resource = dynamic_cast<ResourceDir*>( res );
+  ResourceDir *resource = (ResourceDir*)( res );
+  
+  if ( !resource ) {
+    kdDebug(5700) << "ResourceDirConfig::loadSettings(): cast failed" << endl;
+    return;
+  }
+
+  mFormatBox->setCurrentItem( mFormatTypes.findIndex( resource->format() ) );
+
+  mFileNameEdit->setURL( resource->path() );
+  if ( mFileNameEdit->url().isEmpty() )
+    mFileNameEdit->setURL( KABC::StdAddressBook::directoryName() );
+}
+
+void ResourceDirConfig::saveSettings( KRES::Resource *res )
+{
+//US  ResourceDir *resource = dynamic_cast<ResourceDir*>( res );
+  ResourceDir *resource = (ResourceDir*)( res );
+  
+  if ( !resource ) {
+    kdDebug(5700) << "ResourceDirConfig::loadSettings(): cast failed" << endl;
+    return;
+  }
+
+  if ( mInEditMode )
+    resource->setFormat( mFormatTypes[ mFormatBox->currentItem() ] );
+
+  resource->setPath( mFileNameEdit->url() );
+}
+
+//US #include "resourcedirconfig.moc"
diff --git a/kabc/plugins/dir/resourcedirconfig.h b/kabc/plugins/dir/resourcedirconfig.h
new file mode 100644
index 0000000..5af38a5
--- a/dev/null
+++ b/kabc/plugins/dir/resourcedirconfig.h
@@ -0,0 +1,61 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+
+    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., 59 Temple Place - Suite 330,
+    Boston, MA 02111-1307, USA.
+*/
+
+/*
+Enhanced Version of the file for platform independent KDE tools.
+Copyright (c) 2004 Ulf Schenk
+
+$Id$
+*/
+
+#ifndef RESOURCEDIRCONFIG_H
+#define RESOURCEDIRCONFIG_H
+
+#include <kcombobox.h>
+#include <kurlrequester.h>
+
+#include <kresources/configwidget.h>
+
+namespace KABC {
+
+class ResourceDirConfig : public KRES::ConfigWidget
+{ 
+  Q_OBJECT
+
+public:
+  ResourceDirConfig( QWidget* parent = 0, const char* name = 0 );
+
+  void setEditMode( bool value );
+
+public slots:
+  void loadSettings( KRES::Resource* );
+  void saveSettings( KRES::Resource* );
+
+private:
+  KComboBox* mFormatBox;
+  KURLRequester* mFileNameEdit;
+
+  QStringList mFormatTypes;
+
+  bool mInEditMode;
+};
+
+}
+#endif