path: root/kabc/plugins/opie/resourceopie.cpp

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

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

//US #include "formatfactory.h"
//US #include <qpe/qpeapplication.h>

#include <opie/ocontactaccess.h>
#include <opie/ocontactaccessbackend_xml.h>

#include "resourceopieconfig.h"
#include "stdaddressbook.h"

#include "opieconverter.h"

#include "resourceopie.h"

using namespace KABC;
extern "C"
{
  void *init_microkabc_opie()
  {
    return new KRES::PluginFactory<ResourceOpie,ResourceOpieConfig>();
  }
}

ResourceOpie::ResourceOpie( const KConfig *config )
  : Resource( config ), mConverter (0)
{
  QString fileName = QDir::homeDirPath() + "/Applications/addressbook/addressbook.xml";

  KConfig *cfg = (KConfig *)config;
  if ( cfg ) {
    fileName = cfg->readEntry( "FileName", fileName );
 
  }

//  qDebug("ResourceOpie::ResourceOpie : %s", fileName.latin1() );
  
  init( fileName );
}

ResourceOpie::ResourceOpie( const QString &fileName )
  : Resource( 0 )
{
//  qDebug("ResourceOpie::ResourceOpie : 3 %s", fileName.latin1());
  init( fileName );
}

void ResourceOpie::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 );
 
}

ResourceOpie::~ResourceOpie()
{
  if (mConverter != 0)
    delete mConverter;
}

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()
{
//  qDebug("ResourceOpie::doOpen() %s", mFileName.latin1());
/*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;
  }
*/
  qDebug("ResourceOpie::doOpen() has to be fixed - %s", mFileName.latin1());
  return true;  
}

void ResourceOpie::doClose()
{
//  qDebug("ResourceOpie::doClose() %s", mFileName.latin1());
}

bool ResourceOpie::load()
{
//  qDebug("ResourceOpie::load() %s", mFileName.latin1());
  kdDebug(5700) << "ResourceOpie::load(): '" << mFileName << "'" << endl;

  qDebug("ResourceOpie::load: Try to load file() %s", mFileName.latin1());
    
  OContactAccessBackend_XML* backend = new OContactAccessBackend_XML( "KDEPim/Pi", mFileName );
  OContactAccess* access = new OContactAccess("KDEPim/Pi", 0l, backend, false);
	
  if ( !access ) {
    qDebug("Unable to load file() %s", mFileName.latin1());
    addressBook()->error( i18n( "Unable to load file '%1'." ).arg( mFileName ) );
    return false;
  }
  
  access -> setReadAhead( 32 ); // Use ReadAhead-Cache if available

  bool res = false;
  if (mConverter == 0)
  {
    mConverter = new OpieConverter();
    res = mConverter->init();
    if ( !res )
    {
      qDebug("Unable to initialize opie converter. Most likely a problem with the category file");
      addressBook()->error( i18n( "Unable to initialize opie converter. Most likely a problem with the category file" ) );
      delete access;
      return false;
    }
  }


	OContactAccess::List::Iterator it;
  OContactAccess::List allList = access->allRecords();
  for ( it = allList.begin(); it != allList.end(); ++it )
  {
    const OContact c = (*it);
    
    KABC::Addressee addressee;
    
    res = mConverter->opieToAddressee( c, addressee );    
    
    if ( !addressee.isEmpty() && res )
    {
      addressee.setResource( this );
      addressBook()->insertAddressee( addressee );
    }
    
//    qDebug("found %s", c.fullName().latin1());
  }
  
  delete access;
  // it seems so, that deletion of access deletes backend as well
  //delete backend;
  
  return true;
}

bool ResourceOpie::save( Ticket *ticket )
{
  qDebug("ResourceOpie::save() has to be fixed - %s", mFileName.latin1());
/*US  
  
  qDebug("ResourceOpie::save %s", mFileName.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
//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 )
{
//  qDebug("ResourceOpie::lock() %s", fileName.latin1());
  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 = 0;
#ifndef _WIN32_
  result = ::link( QFile::encodeName( mLockUniqueName ),
                       QFile::encodeName( lockName ) );
#endif
  if ( result == 0 ) {
    addressBook()->emitAddressBookLocked();
    return true;
  }

  // TODO: check stat

  return false;
}

void ResourceOpie::unlock( const QString &fileName )
{
//  qDebug("ResourceOpie::unlock() %s", fileName.latin1());
  
  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 )
{
  mDirWatch.stopScan();
  mDirWatch.removeFile( mFileName );
  
  mFileName = fileName;
  
  mDirWatch.addFile( mFileName );
  mDirWatch.startScan();

//US simulate KDirWatch event  
//US  fileChanged();
}

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

void ResourceOpie::fileChanged()
{
  // There is a small theoretical chance that KDirWatch calls us before
  // we are fully constructed
  if (!addressBook())
    return;
  
  QString text( i18n( "Opie 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();
  }
  
  load();
  addressBook()->emitAddressBookChanged();
}

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

void ResourceOpie::cleanUp()
{
//  qDebug("ResourceOpie::cleanup() %s", mFileName.latin1());

  unlock( mFileName );
}

//US #include "resourceopie.moc"