summaryrefslogtreecommitdiffabout
path: root/kabc/plugins/file
Side-by-side diff
Diffstat (limited to 'kabc/plugins/file') (more/less context) (ignore whitespace changes)
-rw-r--r--kabc/plugins/file/resourcefile.cpp389
-rw-r--r--kabc/plugins/file/resourcefile.h162
-rw-r--r--kabc/plugins/file/resourcefileconfig.cpp144
-rw-r--r--kabc/plugins/file/resourcefileconfig.h65
4 files changed, 760 insertions, 0 deletions
diff --git a/kabc/plugins/file/resourcefile.cpp b/kabc/plugins/file/resourcefile.cpp
new file mode 100644
index 0000000..d30ed2f
--- a/dev/null
+++ b/kabc/plugins/file/resourcefile.cpp
@@ -0,0 +1,389 @@
+/*
+ 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>
+#ifndef _WIN32_
+#include <unistd.h>
+#endif
+
+#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 "resourcefileconfig.h"
+#include "stdaddressbook.h"
+
+#include <formats/vcardformatplugin2.h>
+#include <formats/binaryformat.h>
+
+
+#include "resourcefile.h"
+
+using namespace KABC;
+
+extern "C"
+{
+ void *init_kabc_file()
+ {
+ qDebug("!!!resourcefile.cpp : init_kabc_file has to be changed");
+//US return new KRES::PluginFactory<ResourceFile,ResourceFileConfig>();
+ return 0;
+ }
+}
+
+
+ResourceFile::ResourceFile( const KConfig *config )
+ : Resource( config ) , mFormat( 0 )
+{
+ QString fileName, formatName;
+
+ KConfig *cfg = (KConfig *)config;
+ if ( cfg ) {
+ fileName = cfg->readEntry( "FileName", StdAddressBook::fileName() );
+ formatName = cfg->readEntry( "FileFormat", "vcard" );
+// qDebug("ResourceFile::ResourceFile : 1 %s, %s", fileName.latin1(), formatName.latin1() );
+ } else {
+ fileName = StdAddressBook::fileName();
+ formatName = "vcard";
+// qDebug("ResourceFile::ResourceFile : 2 %s, %s", fileName.latin1(), formatName.latin1() );
+ }
+
+ init( fileName, formatName );
+}
+
+ResourceFile::ResourceFile( const QString &fileName,
+ const QString &formatName )
+ : Resource( 0 )
+{
+// qDebug("ResourceFile::ResourceFile : 3 %s, %s", fileName.latin1(), formatName.latin1());
+ init( fileName, formatName );
+}
+
+void ResourceFile::init( const QString &fileName, const QString &formatName )
+{
+ mFormatName = formatName;
+
+/*US FormatFactory *factory = FormatFactory::self();
+ mFormat = factory->format( mFormatName );
+
+ if ( !mFormat ) {
+ mFormatName = "vcard";
+ mFormat = factory->format( mFormatName );
+ }
+*/
+
+//US qDebug("ResourceFile::init initialized with format %s ", formatName.latin1());
+ if (mFormatName == "vcard") {
+ mFormat = new VCardFormatPlugin2();
+// qDebug("ResourceFile::init format VCardFormatPlugin2");
+ }
+ else if (mFormatName == "binary") {
+ mFormat = new BinaryFormat();
+// qDebug("ResourceFile::init format BinaryFormat");
+ }
+ else
+ qDebug("ResourceFile::init format unknown !!! %s ", formatName.latin1());
+
+/*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 );
+}
+
+ResourceFile::~ResourceFile()
+{
+ delete mFormat;
+ mFormat = 0;
+}
+
+void ResourceFile::writeConfig( KConfig *config )
+{
+ Resource::writeConfig( config );
+
+ config->writeEntry( "FileName", mFileName );
+ config->writeEntry( "FileFormat", mFormatName );
+
+// qDebug("ResourceFile::writeConfig format %s, %s", mFileName.latin1(), mFormatName.latin1());
+
+}
+
+Ticket *ResourceFile::requestSaveTicket()
+{
+ kdDebug(5700) << "ResourceFile::requestSaveTicket()" << endl;
+
+ if ( !addressBook() ) return 0;
+
+ if ( !lock( mFileName ) ) {
+ kdDebug(5700) << "ResourceFile::requestSaveTicket(): Unable to lock file '"
+ << mFileName << "'" << endl;
+ return 0;
+ }
+ return createTicket( this );
+}
+
+
+bool ResourceFile::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;
+ }
+
+ bool ok = mFormat->checkFormat( &file );
+ file.close();
+
+ return ok;
+ }
+}
+
+void ResourceFile::doClose()
+{
+}
+
+bool ResourceFile::load()
+{
+ kdDebug(5700) << "ResourceFile::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());
+
+ return mFormat->loadAll( addressBook(), this, &file );
+}
+
+bool ResourceFile::save( Ticket *ticket )
+{
+// qDebug("ResourceFile::save format %s, %s", mFileName.latin1(), mFormatName.latin1());
+ kdDebug(5700) << "ResourceFile::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 /*directory*/
+/*US ,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 ) {
+ 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("ResourceFile::save has to be changed");
+ return true;
+}
+
+bool ResourceFile::lock( const QString &fileName )
+{
+ kdDebug(5700) << "ResourceFile::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 = 0;//::link( QFile::encodeName( mLockUniqueName ),
+ // QFile::encodeName( lockName ) );
+ qDebug("lock files %s, %s needs to be fixed", mLockUniqueName.latin1(), lockName.latin1() );
+
+ if ( result == 0 ) {
+ addressBook()->emitAddressBookLocked();
+ return true;
+ }
+
+ // TODO: check stat
+
+ return false;
+}
+
+void ResourceFile::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 ResourceFile::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 ResourceFile::fileName() const
+{
+ return mFileName;
+}
+
+void ResourceFile::setFormat( const QString &format )
+{
+ mFormatName = format;
+ delete mFormat;
+
+//US FormatFactory *factory = FormatFactory::self();
+//US mFormat = factory->format( mFormatName );
+
+//qDebug("ResourceFile::setFormat initialized with format %s ", format.latin1());
+ if (mFormatName == "vcard") {
+ mFormat = new VCardFormatPlugin2();
+// qDebug("ResourceFile::setFormat format %s", mFormatName.latin1());
+ }
+ else if (mFormatName == "binary") {
+ mFormat = new BinaryFormat();
+// qDebug("ResourceFile::setFormat format %s", mFormatName.latin1());
+ }
+ else
+ qDebug("ResourceFile::setFormat format unknown !!! %s ", format.latin1());
+
+}
+
+QString ResourceFile::format() const
+{
+ return mFormatName;
+}
+
+void ResourceFile::fileChanged()
+{
+ // There is a small theoretical chance that KDirWatch calls us before
+ // we are fully constructed
+ if (!addressBook())
+ return;
+ load();
+ addressBook()->emitAddressBookChanged();
+}
+
+void ResourceFile::removeAddressee( const Addressee &addr )
+{
+ 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 ResourceFile::cleanUp()
+{
+ unlock( mFileName );
+}
+
+//US #include "resourcefile.moc"
diff --git a/kabc/plugins/file/resourcefile.h b/kabc/plugins/file/resourcefile.h
new file mode 100644
index 0000000..4522d78
--- a/dev/null
+++ b/kabc/plugins/file/resourcefile.h
@@ -0,0 +1,162 @@
+/*
+ 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_RESOURCEFILE_H
+#define KABC_RESOURCEFILE_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 ResourceFile : public Resource
+{
+ Q_OBJECT
+
+public:
+
+ /**
+ Constructor.
+
+ @param cfg The config object where custom resource settings are stored.
+ */
+ ResourceFile( const KConfig *cfg );
+
+ /**
+ Construct file resource on file @arg fileName using format @arg formatName.
+ */
+ ResourceFile( const QString &fileName, const QString &formatName = "vcard" );
+
+ /**
+ * Destructor.
+ */
+ ~ResourceFile();
+
+ /**
+ 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;
+
+ /**
+ Sets a new format by name.
+ */
+ void setFormat( const QString &name );
+
+ /**
+ 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 fileChanged();
+
+protected:
+ void init( const QString &fileName, const QString &format );
+
+ bool lock( const QString &fileName );
+ void unlock( const QString &fileName );
+
+private:
+ QString mFileName;
+ QString mFormatName;
+
+ FormatPlugin *mFormat;
+
+ QString mLockUniqueName;
+
+ KDirWatch mDirWatch;
+};
+
+}
+
+#endif
diff --git a/kabc/plugins/file/resourcefileconfig.cpp b/kabc/plugins/file/resourcefileconfig.cpp
new file mode 100644
index 0000000..b63775d
--- a/dev/null
+++ b/kabc/plugins/file/resourcefileconfig.cpp
@@ -0,0 +1,144 @@
+/*
+ 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 <qfileinfo.h>
+
+#include <kdebug.h>
+#include <klocale.h>
+#include <kstandarddirs.h>
+#include <kdialog.h>
+#ifndef _WIN32_
+#include <unistd.h>
+#endif
+//US #include "formatfactory.h"
+#include <qfile.h>
+#include "resourcefile.h"
+#include "stdaddressbook.h"
+
+#include "resourcefileconfig.h"
+
+using namespace KABC;
+
+ResourceFileConfig::ResourceFileConfig( QWidget* parent, const char* name )
+ : ConfigWidget( parent, name )
+{
+//qDebug("ResourceFileConfig::ResourceFileConfig");
+
+ 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 );
+
+ connect( mFileNameEdit, SIGNAL( textChanged( const QString & ) ),
+ SLOT( checkFilePermissions( const QString & ) ) );
+
+ 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 ResourceFileConfig::setEditMode( bool value )
+{
+ mFormatBox->setEnabled( !value );
+ mInEditMode = value;
+}
+
+void ResourceFileConfig::loadSettings( KRES::Resource *res )
+{
+//US ResourceFile *resource = dynamic_cast<ResourceFile*>( res );
+ ResourceFile *resource = (ResourceFile*)( res );
+
+ if ( !resource ) {
+ kdDebug(5700) << "ResourceFileConfig::loadSettings(): cast failed" << endl;
+ return;
+ }
+
+ mFormatBox->setCurrentItem( mFormatTypes.findIndex( resource->format() ) );
+
+ mFileNameEdit->setURL( resource->fileName() );
+ if ( mFileNameEdit->url().isEmpty() )
+ mFileNameEdit->setURL( KABC::StdAddressBook::fileName() );
+}
+
+void ResourceFileConfig::saveSettings( KRES::Resource *res )
+{
+//US ResourceFile *resource = dynamic_cast<ResourceFile*>( res );
+ ResourceFile *resource = (ResourceFile*)( res );
+
+ if ( !resource ) {
+ kdDebug(5700) << "ResourceFileConfig::saveSettings(): cast failed" << endl;
+ return;
+ }
+
+ if ( !mInEditMode )
+ resource->setFormat( mFormatTypes[ mFormatBox->currentItem() ] );
+
+ resource->setFileName( mFileNameEdit->url() );
+}
+void ResourceFileConfig::checkFilePermissions( const QString& fileName )
+{
+ // If file exist but is not writeable...
+#ifdef _WIN32_
+ QFileInfo fi ( QFile::encodeName( fileName ) );
+ if ( fi.exists() )
+ emit setReadOnly(!fi.isReadable() );
+#else
+ if ( access( QFile::encodeName( fileName ), F_OK ) == 0 )
+ emit setReadOnly( access( QFile::encodeName( fileName ), W_OK ) < 0 );
+#endif
+}
+
+//US #include "resourcefileconfig.moc"
diff --git a/kabc/plugins/file/resourcefileconfig.h b/kabc/plugins/file/resourcefileconfig.h
new file mode 100644
index 0000000..31ccaaf
--- a/dev/null
+++ b/kabc/plugins/file/resourcefileconfig.h
@@ -0,0 +1,65 @@
+/*
+ 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 RESOURCEFILECONFIG_H
+#define RESOURCEFILECONFIG_H
+
+#include <kcombobox.h>
+#include <kurlrequester.h>
+
+#include <kresources/configwidget.h>
+
+namespace KABC {
+
+class ResourceFileConfig : public KRES::ConfigWidget
+{
+ Q_OBJECT
+
+public:
+ ResourceFileConfig( QWidget* parent = 0, const char* name = 0 );
+
+ void setEditMode( bool value );
+
+public slots:
+ void loadSettings( KRES::Resource *resource );
+ void saveSettings( KRES::Resource *resource );
+
+protected slots:
+ void checkFilePermissions( const QString& fileName );
+
+private:
+ KComboBox* mFormatBox;
+ KURLRequester* mFileNameEdit;
+ bool mInEditMode;
+
+ QStringList mFormatTypes;
+};
+
+}
+
+#endif