resourcedir.cpp
/*
This file is part of libkabc.
Copyright (c) 2002 - 2003 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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include <errno.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <qregexp.h>
#include <qtimer.h>
#include <qwidget.h>
#include <kapplication.h>
#include <kconfig.h>
#include <kdebug.h>
#include <kgenericfactory.h>
#include <kglobal.h>
#include <klocale.h>
#include <kstandarddirs.h>
#include <kurlrequester.h>
#include "addressbook.h"
#include "formatfactory.h"
#include "resourcedirconfig.h"
#include "stdaddressbook.h"
#include "lock.h"
#include "resourcedir.h"
using namespace KABC;
extern "C"
{
void *init_kabc_dir()
{
return new KRES::PluginFactory<ResourceDir,ResourceDirConfig>();
}
}
ResourceDir::ResourceDir( const KConfig *config )
: Resource( config ), mAsynchronous( false )
{
if ( config ) {
init( config->readPathEntry( "FilePath", StdAddressBook::directoryName() ),
config->readEntry( "FileFormat", "vcard" ) );
} else {
init( StdAddressBook::directoryName(), "vcard" );
}
}
ResourceDir::ResourceDir( const QString &path, const QString &format )
: Resource( 0 ), mAsynchronous( false )
{
init( path, format );
}
void ResourceDir::init( const QString &path, const QString &format )
{
mFormatName = format;
FormatFactory *factory = FormatFactory::self();
mFormat = factory->format( mFormatName );
if ( !mFormat ) {
mFormatName = "vcard";
mFormat = factory->format( mFormatName );
}
mLock = 0;
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 );
if ( mPath == StdAddressBook::directoryName() )
config->deleteEntry( "FilePath" );
else
config->writePathEntry( "FilePath", mPath );
config->writeEntry( "FileFormat", mFormatName );
}
Ticket *ResourceDir::requestSaveTicket()
{
kdDebug(5700) << "ResourceDir::requestSaveTicket()" << endl;
if ( !addressBook() ) return 0;
delete mLock;
mLock = new Lock( mPath );
if ( mLock->lock() ) {
addressBook()->emitAddressBookLocked();
} else {
addressBook()->error( mLock->error() );
kdDebug(5700) << "ResourceFile::requestSaveTicket(): Unable to lock path '"
<< mPath << "': " << mLock->error() << endl;
return 0;
}
return createTicket( this );
}
void ResourceDir::releaseSaveTicket( Ticket *ticket )
{
delete ticket;
delete mLock;
mLock = 0;
}
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;
mAsynchronous = false;
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::asyncLoad()
{
mAsynchronous = true;
bool ok = load();
if ( !ok )
emit loadingError( this, i18n( "Loading resource '%1' failed!" )
.arg( resourceName() ) );
else
emit loadingFinished( this );
return ok;
}
bool ResourceDir::save( Ticket * )
{
kdDebug(5700) << "ResourceDir::save(): '" << mPath << "'" << endl;
Addressee::Map::Iterator it;
bool ok = true;
mDirWatch.stopScan();
for ( it = mAddrMap.begin(); it != mAddrMap.end(); ++it ) {
if ( !it.data().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();
}
mDirWatch.startScan();
return ok;
}
bool ResourceDir::asyncSave( Ticket *ticket )
{
bool ok = save( ticket );
if ( !ok )
emit savingError( this, i18n( "Saving resource '%1' failed!" )
.arg( resourceName() ) );
else
emit savingFinished( this );
return ok;
}
void ResourceDir::setPath( const QString &path )
{
mDirWatch.stopScan();
if ( mDirWatch.contains( mPath ) )
mDirWatch.removeDir( mPath );
mPath = path;
mDirWatch.addDir( mPath, true );
mDirWatch.startScan();
}
QString ResourceDir::path() const
{
return mPath;
}
void ResourceDir::setFormat( const QString &format )
{
mFormatName = format;
if ( mFormat )
delete mFormat;
FormatFactory *factory = FormatFactory::self();
mFormat = factory->format( mFormatName );
}
QString ResourceDir::format() const
{
return mFormatName;
}
void ResourceDir::pathChanged()
{
if ( !addressBook() )
return;
clear();
if ( mAsynchronous )
asyncLoad();
else {
load();
addressBook()->emitAddressBookChanged();
}
}
void ResourceDir::removeAddressee( const Addressee& addr )
{
QFile::remove( mPath + "/" + addr.uid() );
mAddrMap.erase( addr.uid() );
}
#include "resourcedir.moc"
KABC::FormatFactory
Class for loading format plugins.
Definition: formatfactory.h:57
KABC::FormatFactory::self
static FormatFactory * self()
Returns the global format factory.
Definition: formatfactory.cpp:38
KABC::Lock
This class provides locking functionality for a file, directory or an arbitrary string-represented re...
Definition: lock.h:35
kdDebug
kdbgstream kdDebug(int area=0)
klocale.h
KABC::Ticket
Helper class for handling coordinated save of address books.
Definition: resource.h:37
KConfig::readPathEntry
QString readPathEntry(const QString &pKey, const QString &aDefault=QString::null) const
KStdAccel::save
const KShortcut & save()
KABC::StdAddressBook::directoryName
static QString directoryName()
Returns the default directory name for vcard-based addressbook.
Definition: stdaddressbook.cpp:48
KStdAction::clear
KAction * clear(const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KABC::FormatFactory::format
FormatPlugin * format(const QString &type)
Returns a pointer to a format object or a null pointer if format type doesn't exist.
Definition: formatfactory.cpp:109
KConfig::writePathEntry
void writePathEntry(const QString &pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
KConfig::deleteEntry
void deleteEntry(const QString &pKey, bool bNLS=false, bool bGlobal=false)
KABC::Addressee
address book entry
Definition: addressee.src.h:74
KConfig
KConfig::readEntry
QString readEntry(const QString &pKey, const QString &aDefault=QString::null) const
KABC::Addressee::uid
QString uid() const
Return unique identifier.
Definition: addressee.src.cpp:173
endl
kndbgstream & endl(kndbgstream &s)
KConfig::writeEntry
void writeEntry(const QString &pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)

KDE Home | KDE Accessibility Home | Description of Access Keys