added support for opie addressbook resources

5 files changed, 683 insertions, 0 deletions

diff --git a/kabc/plugins/opie/kabc_opieE.pro b/kabc/plugins/opie/kabc_opieE.pro
new file mode 100644
index 0000000..7341ca8
--- a/dev/null
+++ b/kabc/plugins/opie/kabc_opieE.pro
@@ -0,0 +1,21 @@
+        TEMPLATE= lib
+CONFIG += qt warn_on release
+#release debug
+
+TARGET = microkabc_opie
+INCLUDEPATH += ../.. ../../../microkde ../../../microkde/kdecore ../../../microkde/kio/kfile ../../../qtcompat
+OBJECTS_DIR = obj/$(PLATFORM)
+MOC_DIR = moc
+DESTDIR = $(QPEDIR)/lib
+LIBS += -lmicrokde -lmicrokabc
+LIBS += -L$(QPEDIR)/lib
+
+INTERFACES = \
+
+HEADERS = \
+ resourceopie.h \
+ resourceopieconfig.h
+ 
+SOURCES = \
+ resourceopie.cpp \
+ resourceopieconfig.cpp
diff --git a/kabc/plugins/opie/resourceopie.cpp b/kabc/plugins/opie/resourceopie.cpp
new file mode 100644
index 0000000..47e22b4
--- a/dev/null
+++ b/kabc/plugins/opie/resourceopie.cpp
@@ -0,0 +1,345 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2001 Cornelius Schumacher <schumacher@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>
+#include <unistd.h>
+
+#include <qfile.h>
+#include <qfileinfo.h>
+#include <qregexp.h>
+#include <qtimer.h>
+
+#include <kapplication.h>
+#include <kconfig.h>
+#include <kdebug.h>
+#include <klocale.h>
+//US #include <ksavefile.h>
+#include <kstandarddirs.h>
+
+//US #include "formatfactory.h"
+
+#include "resource.h"
+#include "resourceopieconfig.h"
+#include "stdaddressbook.h"
+
+#include "resourceopie.h"
+
+using namespace KABC;
+extern "C"
+{
+//US  void *init_kabc_file()
+  void *init_microkabc_opie()
+  {
+    return new KRES::PluginFactory<ResourceOpie,ResourceOpieConfig>();
+  }
+}
+
+ResourceOpie::ResourceOpie( const KConfig *config )
+  : Resource( config )
+{
+  QString fileName;
+
+  KConfig *cfg = (KConfig *)config;
+  if ( cfg ) {
+    fileName = cfg->readEntry( "FileName", StdAddressBook::fileName() );
+//  qDebug("ResourceFile::ResourceFile : 1 %s, %s", fileName.latin1(), formatName.latin1() );
+  } else {
+    fileName = StdAddressBook::fileName();
+//  qDebug("ResourceFile::ResourceFile : 2 %s, %s", fileName.latin1(), formatName.latin1() );
+  }
+
+  init( fileName );
+}
+
+ResourceOpie::ResourceOpie( const QString &fileName )
+  : Resource( 0 )
+{
+//  qDebug("ResourceFile::ResourceFile : 3 %s, %s", fileName.latin1(), formatName.latin1());
+  init( fileName );
+}
+
+void ResourceOpie::init( const QString &fileName )
+{
+
+/*US we have no KDirWatch. SO simulate the signals from inside the apropriate methods
+  connect( &mDirWatch, SIGNAL( dirty(const QString&) ), SLOT( fileChanged() ) );
+  connect( &mDirWatch, SIGNAL( created(const QString&) ), SLOT( fileChanged() ) );
+  connect( &mDirWatch, SIGNAL( deleted(const QString&) ), SLOT( fileChanged() ) );
+*/
+
+  setFileName( fileName );
+}
+
+ResourceOpie::~ResourceOpie()
+{
+}
+
+void ResourceOpie::writeConfig( KConfig *config )
+{
+  Resource::writeConfig( config );
+
+  config->writeEntry( "FileName", mFileName );
+  
+//    qDebug("ResourceFile::writeConfig format %s, %s", mFileName.latin1(), mFormatName.latin1());
+  
+}
+
+Ticket *ResourceOpie::requestSaveTicket()
+{
+  kdDebug(5700) << "ResourceOpie::requestSaveTicket()" << endl;
+
+  if ( !addressBook() ) return 0;
+
+  if ( !lock( mFileName ) ) {
+    kdDebug(5700) << "ResourceOpie::requestSaveTicket(): Unable to lock file '"
+                  << mFileName << "'" << endl;
+    return 0;
+  }
+  return createTicket( this );
+}
+
+
+bool ResourceOpie::doOpen()
+{
+  QFile file( mFileName );
+
+  if ( !file.exists() ) {
+    // try to create the file
+    bool ok = file.open( IO_WriteOnly );
+    if ( ok )
+      file.close();
+
+    return ok;
+  } else {
+    if ( !file.open( IO_ReadWrite ) )
+      return false;
+
+    if ( file.size() == 0 ) {
+      file.close();
+      return true;
+    }
+
+//US    bool ok = mFormat->checkFormat( &file );
+    bool ok = true;
+    
+    file.close();
+
+    return ok;
+  }
+}
+
+void ResourceOpie::doClose()
+{
+}
+
+bool ResourceOpie::load()
+{
+  kdDebug(5700) << "ResourceOpie::load(): '" << mFileName << "'" << endl;
+
+  QFile file( mFileName );
+  if ( !file.open( IO_ReadOnly ) ) {
+    addressBook()->error( i18n( "Unable to open file '%1'." ).arg( mFileName ) );
+    return false;
+  }
+
+//    qDebug("ResourceFile::load format %s, %s", mFileName.latin1(), mFormatName.latin1());
+  
+  //US return mFormat->loadAll( addressBook(), this, &file );
+  return true;
+}
+
+bool ResourceOpie::save( Ticket *ticket )
+{
+//    qDebug("ResourceFile::save format %s, %s", mFileName.latin1(), mFormatName.latin1());
+  kdDebug(5700) << "ResourceOpie::save()" << endl;
+
+  // create backup file
+  QString extension = "_" + QString::number( QDate::currentDate().dayOfWeek() );
+   
+/*US we use a simpler method to create a backupfile
+    
+  (void) KSaveFile::backupFile( mFileName, QString::null
+  ,extension );
+
+  KSaveFile saveFile( mFileName );
+  bool ok = false;
+  if ( saveFile.status() == 0 && saveFile.file() )
+  {
+    mFormat->saveAll( addressBook(), this, saveFile.file() );
+    ok = saveFile.close();
+  }
+*/
+
+//US ToDo: write backupfile  
+  QFile info;
+  info.setName( mFileName );
+  bool ok = info.open( IO_WriteOnly );
+  if ( ok ) {
+//US    mFormat->saveAll( addressBook(), this, &info );
+    
+    info.close();
+    ok = true;
+  }
+  else {
+  
+  }
+  
+  if ( !ok )
+    addressBook()->error( i18n( "Unable to save file '%1'." ).arg( mFileName ) );
+  
+  delete ticket;
+  unlock( mFileName );
+  
+  return ok;
+
+  qDebug("ResourceOpie::save has to be changed");
+  return true;
+}
+
+bool ResourceOpie::lock( const QString &fileName )
+{
+  kdDebug(5700) << "ResourceOpie::lock()" << endl;
+
+  QString fn = fileName;
+
+//US change the implementation how the lockfilename is getting created
+//US  fn.replace( QRegExp("/"), "_" );
+//US  QString lockName = locateLocal( "data", "kabc/lock/" + fn + ".lock" );
+  
+  KURL url(fn);  
+  QString lockName = locateLocal( "data", "kabc/lock/" + url.fileName() + ".lock" );
+  
+  kdDebug(5700) << "-- lock name: " << lockName << endl;
+
+  if (QFile::exists( lockName )) return false;
+
+  QString lockUniqueName;
+  lockUniqueName = fn + 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
+  int result = ::link( QFile::encodeName( mLockUniqueName ),
+                       QFile::encodeName( lockName ) );
+
+  if ( result == 0 ) {
+    addressBook()->emitAddressBookLocked();
+    return true;
+  }
+
+  // TODO: check stat
+
+  return false;
+}
+
+void ResourceOpie::unlock( const QString &fileName )
+{
+  QString fn = fileName;
+//US change the implementation how the lockfilename is getting created
+//US  fn.replace( QRegExp( "/" ), "_" );
+//US  QString lockName = locateLocal( "data", "kabc/lock/" + fn + ".lock" );
+//US  QString lockName = fn + ".lock";
+  KURL url(fn);  
+  QString lockName = locateLocal( "data", "kabc/lock/" + url.fileName() + ".lock" );
+  
+  QFile::remove( lockName );
+  QFile::remove( mLockUniqueName );
+  addressBook()->emitAddressBookUnlocked();
+}
+
+void ResourceOpie::setFileName( const QString &fileName )
+{
+/*US ToDo: no synchronization so far. Has to be changed in the future
+  mDirWatch.stopScan();
+  mDirWatch.removeFile( mFileName );
+*/
+  mFileName = fileName;
+
+  
+/*US ToDo: no synchronization so far. Has to be changed in the future
+  mDirWatch.addFile( mFileName );
+  mDirWatch.startScan();
+*/
+//US simulate KDirWatch event  
+  fileChanged();
+}
+
+QString ResourceOpie::fileName() const
+{
+  return mFileName;
+}
+
+/*US
+void ResourceOpie::setFormat( const QString &format )
+{
+  mFormatName = format;
+  delete mFormat;
+
+  FormatFactory *factory = FormatFactory::self();
+  mFormat = factory->format( mFormatName );
+}
+
+QString ResourceOpie::format() const
+{
+  return mFormatName;
+}
+*/
+
+void ResourceOpie::fileChanged()
+{
+  // There is a small theoretical chance that KDirWatch calls us before
+  // we are fully constructed
+  if (!addressBook())
+    return;
+  load();
+  addressBook()->emitAddressBookChanged();
+}
+
+void ResourceOpie::removeAddressee( const Addressee &addr )
+{
+/*US
+  QFile::remove( QFile::encodeName( locateLocal( "data", "kabc/photos/" ) + addr.uid() ) );
+  QFile::remove( QFile::encodeName( locateLocal( "data", "kabc/logos/" ) + addr.uid() ) );
+  QFile::remove( QFile::encodeName( locateLocal( "data", "kabc/sounds/" ) + addr.uid() ) );
+*/  
+}
+
+void ResourceOpie::cleanUp()
+{
+  unlock( mFileName );
+}
+
+//US #include "resourceopie.moc"
diff --git a/kabc/plugins/opie/resourceopie.h b/kabc/plugins/opie/resourceopie.h
new file mode 100644
index 0000000..d21272a
--- a/dev/null
+++ b/kabc/plugins/opie/resourceopie.h
@@ -0,0 +1,149 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2001 Cornelius Schumacher <schumacher@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_RESOURCEOPIE_H
+#define KABC_RESOURCEOPIE_H
+
+#include <kconfig.h>
+#include <kdirwatch.h>
+
+#include <sys/types.h>
+
+#include "resource.h"
+
+class QTimer;
+class FormatPlugin;
+
+namespace KABC {
+
+//US class FormatPlugin;
+class ResourceConfigWidget;
+
+/**
+  @internal
+*/
+class ResourceOpie : public Resource
+{
+  Q_OBJECT
+
+public:
+
+  /**
+    Constructor.
+
+    @param cfg The config object where custom resource settings are stored.
+  */
+  ResourceOpie( const KConfig *cfg );
+
+  /**
+    Construct file resource on file @arg fileName using format @arg formatName.
+  */
+  ResourceOpie( const QString &fileName );
+
+  /**
+   * Destructor.
+   */
+  ~ResourceOpie();
+
+  /**
+    Writes the config back.
+   */
+  virtual void writeConfig( KConfig *cfg );
+
+  /**
+   * Tries to open the file and checks for the proper format.
+   * This method should be called before @ref load().
+   */
+  virtual bool doOpen();
+
+  /**
+   * Closes the file again.
+   */
+  virtual void doClose();
+  
+  /**
+   * Requests a save ticket, that is used by @ref save()
+   */
+  virtual Ticket *requestSaveTicket();
+
+  /**
+   * Loads all addressees from file to the address book.
+   * Returns true if all addressees could be loaded otherwise false.
+   */
+  virtual bool load();
+
+  /**
+   * Saves all addresses from address book to file.
+   * Returns true if all addressees could be saved otherwise false.
+   *
+   * @param ticket  The ticket returned by @ref requestSaveTicket()
+   */
+  virtual bool save( Ticket *ticket );
+
+  /**
+   * Set name of file to be used for saving.
+   */
+  void setFileName( const QString & );
+
+  /**
+   * Return name of file used for loading and saving the address book.
+   */
+  QString fileName() 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 fileChanged();
+
+protected:
+  void init( const QString &fileName );
+
+  bool lock( const QString &fileName );
+  void unlock( const QString &fileName );
+
+private:
+  QString mFileName;
+
+  QString mLockUniqueName;
+    
+  KDirWatch mDirWatch;
+};
+
+}
+
+#endif
diff --git a/kabc/plugins/opie/resourceopieconfig.cpp b/kabc/plugins/opie/resourceopieconfig.cpp
new file mode 100644
index 0000000..b92cfa1
--- a/dev/null
+++ b/kabc/plugins/opie/resourceopieconfig.cpp
@@ -0,0 +1,107 @@
+/*
+    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>
+
+#include <unistd.h>
+
+#include <qfile.h>
+#include "resourceopie.h"
+#include "stdaddressbook.h"
+
+#include "resourceopieconfig.h"
+
+using namespace KABC;
+
+ResourceOpieConfig::ResourceOpieConfig( QWidget* parent,  const char* name )
+    : ConfigWidget( parent, name )
+{
+//qDebug("ResourceFileConfig::ResourceFileConfig");
+  
+  QGridLayout *mainLayout = new QGridLayout( this, 1, 2, 0,
+      KDialog::spacingHint() );
+
+  QLabel *label = new QLabel( i18n( "Location:" ), this );
+  mFileNameEdit = new KURLRequester( this );
+
+  connect( mFileNameEdit, SIGNAL( textChanged( const QString & ) ),
+           SLOT( checkFilePermissions( const QString & ) ) );
+
+  mainLayout->addWidget( label, 0, 0 );
+  mainLayout->addWidget( mFileNameEdit, 0, 1 );
+
+//US  mInEditMode = false;
+}
+/*US
+void ResourceOpieConfig::setEditMode( bool value )
+{
+  mInEditMode = value;
+}
+*/
+
+void ResourceOpieConfig::loadSettings( KRES::Resource *res  )
+{
+//US  ResourceFile *resource = dynamic_cast<ResourceFile*>( res );
+  ResourceOpie *resource = (ResourceOpie*)( res );
+  
+  if ( !resource ) {
+    kdDebug(5700) << "ResourceOpieConfig::loadSettings(): cast failed" << endl;
+    return;
+  }
+
+  mFileNameEdit->setURL( resource->fileName() );
+  if ( mFileNameEdit->url().isEmpty() )
+    mFileNameEdit->setURL( KABC::StdAddressBook::fileName() );
+}
+
+void ResourceOpieConfig::saveSettings( KRES::Resource *res )
+{
+//US  ResourceFile *resource = dynamic_cast<ResourceFile*>( res );
+  ResourceOpie *resource = (ResourceOpie*)( res );
+  
+  if ( !resource ) {
+    kdDebug(5700) << "ResourceOpieConfig::saveSettings(): cast failed" << endl;
+    return;
+  }
+
+  resource->setFileName( mFileNameEdit->url() );
+}
+
+void ResourceOpieConfig::checkFilePermissions( const QString& fileName )
+{
+  // If file exist but is not writeable...
+  if ( access( QFile::encodeName( fileName ), F_OK ) == 0 )
+      emit setReadOnly( access( QFile::encodeName( fileName ), W_OK ) < 0 );
+}
+
+//US #include "resourceopieconfig.moc"
diff --git a/kabc/plugins/opie/resourceopieconfig.h b/kabc/plugins/opie/resourceopieconfig.h
new file mode 100644
index 0000000..533b7f4
--- a/dev/null
+++ b/kabc/plugins/opie/resourceopieconfig.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 RESOURCEOPIECONFIG_H
+#define RESOURCEOPIECONFIG_H
+
+#include <kurlrequester.h>
+
+#include <kresources/configwidget.h>
+
+namespace KABC {
+
+class ResourceOpieConfig : public KRES::ConfigWidget
+{ 
+  Q_OBJECT
+
+public:
+  ResourceOpieConfig( QWidget* parent = 0, const char* name = 0 );
+
+//US  void setEditMode( bool value );
+
+public slots:
+  void loadSettings( KRES::Resource *resource );
+  void saveSettings( KRES::Resource *resource );
+
+protected slots:
+  void checkFilePermissions( const QString& fileName );
+
+private:
+  KURLRequester* mFileNameEdit;
+//US  bool mInEditMode;
+};
+
+}
+
+#endif