path: root/kabc/plugins/sharpdtm/resourcesharpdtm.cpp

/*
    This file is part of libkabc.
    Copyright (c) 2004 Ulf Schenk

    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 <qdir.h>
#include <qfile.h>
#include <qfileinfo.h>
#include <qregexp.h>
//US #include <qtimer.h>

#include <kapplication.h>
#include <kconfig.h>
#include <kdebug.h>
#include <klocale.h>
//US #include <ksavefile.h>
#include <kstandarddirs.h>
#include <kmessagebox.h>

#include <sl/slzdb.h>


#include "resourcesharpdtmconfig.h"
#include "resourcesharpdtm.h"

#include "stdaddressbook.h"

#include "sharpdtmconverter.h"

using namespace KABC;
extern "C"
{
  void *init_microkabc_sharpdtm()
  {
    return new KRES::PluginFactory<ResourceSharpDTM,ResourceSharpDTMConfig>();
  }
}

ResourceSharpDTM::ResourceSharpDTM( const KConfig *config, bool syncable  )
  : Resource( config, syncable ), mConverter (0)
{
  // we can not choose the filename. Therefore use the default to display

  QString fileName = SlZDataBase::addressbookFileName();
  init( fileName );
}

ResourceSharpDTM::ResourceSharpDTM( const QString &fileName, bool syncable  )
  : Resource( 0, syncable )
{
//  qDebug("ResourceFile::ResourceSharpDTM : 3 %s, %s", fileName.latin1(), formatName.latin1());
  init( fileName );
}

void ResourceSharpDTM::init( const QString &fileName )
{

  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 );
}

ResourceSharpDTM::~ResourceSharpDTM()
{
//  if (mConverter != 0)
//    delete mConverter;

}

void ResourceSharpDTM::writeConfig( KConfig *config )
{
  Resource::writeConfig( config );
}

Ticket *ResourceSharpDTM::requestSaveTicket()
{
  kdDebug(5700) << "ResourceQtopia::requestSaveTicket()" << endl;

  if ( !addressBook() ) return 0;

  if ( !lock( mFileName ) ) {
    kdDebug(5700) << "ResourceQtopia::requestSaveTicket(): Unable to lock file '"
                  << mFileName << "'" << endl;
    return 0;
  }
  return createTicket( this );
}


bool ResourceSharpDTM::doOpen()
{
/*US
  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;
  }
*/
  return true;
}

void ResourceSharpDTM::doClose()
{
}

bool ResourceSharpDTM::load()
{
  kdDebug(5700) << "ResourcSharpDTM::load(): '" << mFileName << "'" << endl;

//  qDebug("ResourceSharpDTM::load: Try to load file() %s", mFileName.latin1());

  // the last parameter in the SlZDataBase constructor means "readonly"
  SlZDataBase* access = new SlZDataBase(mFileName,
                        SlZDataBase::addressbookItems(),
                        NULL, true);
  if ( !access ) {
    qDebug("Unable to load file() %s", mFileName.latin1());
    addressBook()->error( i18n( "Unable to load file '%1'." ).arg( mFileName ) );
    return false;
  }

  bool res = false;
  if (mConverter == 0)
  {
    mConverter = new SharpDTMConverter();
    res = mConverter->init();
    if ( !res )
    {
	  QString msg("Unable to initialize sharp converter. Most likely a problem with the category file");

      qDebug(msg);
      addressBook()->error( i18n( msg ) );
      delete access;
      return false;
    }
  }

  { //create a new scope
    CardId id;

    for (bool res=access->first(); res == true; res=access->next()) {
      id = access->cardId();

      KABC::Addressee addressee;

      res = mConverter->sharpToAddressee( id, access, addressee );

      if ( !addressee.isEmpty() && res )
      {
        addressee.setResource( this );
        addressBook()->insertAddressee( addressee );
      }
    }
  }

  delete access;
  return true;
}

bool ResourceSharpDTM::save( Ticket *ticket )
{
/*US
//    qDebug("ResourceFile::save format %s, %s", mFileName.latin1(), mFormatName.latin1());
  kdDebug(5700) << "ResourceQtopia::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
//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("ResourceQtopia::save has to be changed");
*/
  return true;
}

bool ResourceSharpDTM::lock( const QString &fileName )
{
  kdDebug(5700) << "ResourceSharpDTM::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 ResourceSharpDTM::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 ResourceSharpDTM::setFileName( const QString &fileName )
{
  mDirWatch.stopScan();
  mDirWatch.removeFile( mFileName );

  mFileName = fileName;

  mDirWatch.addFile( mFileName );
  mDirWatch.startScan();

}

QString ResourceSharpDTM::fileName() const
{
  return mFileName;
}

void ResourceSharpDTM::fileChanged()
{
  // There is a small theoretical chance that KDirWatch calls us before
  // we are fully constructed
  if (!addressBook())
    return;

  QString text( i18n( "Sharp DTM resource '%1'<br> has been changed by third party.<br>Do you want to reload?").arg( mFileName ) );
  if ( readOnly() || KMessageBox::questionYesNo( 0, text ) == KMessageBox::Yes ) {
    load();
    addressBook()->emitAddressBookChanged();
  }
}

void ResourceSharpDTM::removeAddressee( const Addressee &addr )
{
}

void ResourceSharpDTM::cleanUp()
{
  unlock( mFileName );
}

/**
 * This method returns the number of elements that are currently in the resource.
 */
int ResourceSharpDTM::count() const
{
  if (mAccess != 0)
	return mAccess->count();
  else
    return 0;
}


/**
 * This method removes all elements from the resource!! (Not from the addressbook)
 */
bool ResourceSharpDTM::clear()
{
  if (mAccess != 0)
    return mAccess->deleteCard(0, SlZDataBase::AllCard );
  else
	return false;
}