kde-playground/kdepim-runtime/agents/invitations/invitationsagent.cpp

/*
    Copyright 2009 Sebastian Sauer <sebsauer@kdab.net>

    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 "invitationsagent.h"

#include "incidenceattribute.h"

#include <Akonadi/AgentInstance>
#include <Akonadi/AgentInstanceCreateJob>
#include <Akonadi/AgentManager>
#include <Akonadi/ChangeRecorder>
#include <Akonadi/Collection>
#include <Akonadi/CollectionCreateJob>
#include <Akonadi/CollectionFetchJob>
#include <Akonadi/CollectionFetchScope>
#include <Akonadi/ItemFetchJob>
#include <Akonadi/ItemFetchScope>
#include <Akonadi/ItemModifyJob>
#include <akonadi/kmime/messageflags.h>
#include <akonadi/resourcesynchronizationjob.h>
#include <akonadi/specialcollections.h>
#include <akonadi/specialcollectionsrequestjob.h>

#include <kcalcore/event.h>
#include <kcalcore/icalformat.h>
#include <kcalcore/incidence.h>
#include <kcalcore/journal.h>
#include <kcalcore/todo.h>
#include <KConfig>
#include <KConfigSkeleton>
#include <KDebug>
#include <KJob>
#include <KLocalizedString>
#include <KMime/Content>
#include <KMime/Message>
#include <kpimidentities/identitymanager.h>
#include <KSystemTimeZones>
#include <KStandardDirs>

#include <QtCore/QFileInfo>
#include <QtCore/QTimer>
#include <QtDBus/QDBusInterface>
#include <QtDBus/QDBusReply>

using namespace Akonadi;

class InvitationsCollectionRequestJob : public SpecialCollectionsRequestJob
{
  public:
    InvitationsCollectionRequestJob( SpecialCollections* collection, InvitationsAgent *agent )
      : SpecialCollectionsRequestJob( collection, agent )
    {
      setDefaultResourceType( QLatin1String( "akonadi_ical_resource" ) );

      QVariantMap options;
      options.insert( QLatin1String( "Path" ), QString( KGlobal::dirs()->localxdgdatadir() + QLatin1String( "akonadi_invitations" ) ) );
      options.insert( QLatin1String( "Name" ), i18n( "Invitations" ) );
      setDefaultResourceOptions( options );

      QMap<QByteArray, QString> displayNameMap;
      displayNameMap.insert( "invitations", i18n( "Invitations" ) );
      setTypes( displayNameMap.keys() );
      setNameForTypeMap( displayNameMap );

      QMap<QByteArray, QString> iconNameMap;
      iconNameMap.insert( "invitations", QLatin1String( "folder" ) );
      setIconForTypeMap( iconNameMap );
    }

    virtual ~InvitationsCollectionRequestJob()
    {
    }
};

class  InvitationsCollection : public SpecialCollections
{
  public:

    class Settings : public KCoreConfigSkeleton
    {
      public:
        Settings()
        {
          setCurrentGroup( QLatin1String("Invitations") );
          addItemString( QLatin1String("DefaultResourceId"), m_id, QString() );
        }

        virtual ~Settings()
        {
        }

      private:
        QString m_id;
    };

    InvitationsCollection( InvitationsAgent *agent )
      : Akonadi::SpecialCollections( new Settings ), m_agent( agent ), sInvitationsType( "invitations" )
    {
    }

    virtual ~InvitationsCollection()
    {
    }

    void clear()
    {
      m_collection = Collection();
    }

    bool hasDefaultCollection() const
    {
      return SpecialCollections::hasDefaultCollection( sInvitationsType );
    }

    Collection defaultCollection() const
    {
      if ( !m_collection.isValid() )
        m_collection = SpecialCollections::defaultCollection( sInvitationsType );

      return m_collection;
    }

    void registerDefaultCollection()
    {
      defaultCollection();
      registerCollection( sInvitationsType, m_collection );
    }

    SpecialCollectionsRequestJob* reguestJob() const
    {
      InvitationsCollectionRequestJob *job = new InvitationsCollectionRequestJob( const_cast<InvitationsCollection*>( this ),
                                                                                  m_agent );
      job->requestDefaultCollection( sInvitationsType );

      return job;
    }

  private:
    InvitationsAgent *m_agent;
    const QByteArray sInvitationsType;
    mutable Collection m_collection;
};

InvitationsAgentItem::InvitationsAgentItem( InvitationsAgent *agent, const Item &originalItem )
  : QObject( agent ), m_agent( agent ), m_originalItem( originalItem )
{
}

InvitationsAgentItem::~InvitationsAgentItem()
{
}

void InvitationsAgentItem::add( const Item &item )
{
  kDebug();
  const Collection collection = m_agent->collection();
  Q_ASSERT( collection.isValid() );

  ItemCreateJob *job = new ItemCreateJob( item, collection, this );
  connect( job, SIGNAL(result(KJob*)), this, SLOT(createItemResult(KJob*)) );

  m_jobs << job;

  job->start();
}

void InvitationsAgentItem::createItemResult( KJob *job )
{
  ItemCreateJob *createJob = qobject_cast<ItemCreateJob*>( job );
  m_jobs.removeAll( createJob );
  if ( createJob->error() ) {
    kWarning() << "Failed to create new Item in invitations collection." << createJob->errorText();
    return;
  }

  if ( !m_jobs.isEmpty() )
    return;

  ItemFetchJob *fetchJob = new ItemFetchJob( m_originalItem, this );
  connect( fetchJob, SIGNAL(result(KJob*)), this, SLOT(fetchItemDone(KJob*)) );
  fetchJob->start();
}

void InvitationsAgentItem::fetchItemDone( KJob *job )
{
  if ( job->error() ) {
    kWarning() << "Failed to fetch Item in invitations collection." << job->errorText();
    return;
  }

  ItemFetchJob *fetchJob = qobject_cast<ItemFetchJob*>( job );
  Q_ASSERT( fetchJob->items().count() == 1 );

  Item modifiedItem = fetchJob->items().first();
  Q_ASSERT( modifiedItem.isValid() );

  modifiedItem.setFlag( Akonadi::MessageFlags::HasInvitation );
  ItemModifyJob *modifyJob = new ItemModifyJob( modifiedItem, this );
  connect( modifyJob, SIGNAL(result(KJob*)), this, SLOT(modifyItemDone(KJob*)) );
  modifyJob->start();
}

void InvitationsAgentItem::modifyItemDone( KJob *job )
{
  if ( job->error() ) {
    kWarning() << "Failed to modify Item in invitations collection." << job->errorText();
    return;
  }

  //ItemModifyJob *mj = qobject_cast<ItemModifyJob*>( job );
  //kDebug()<<"Job successful done.";
}

InvitationsAgent::InvitationsAgent( const QString &id )
  : AgentBase( id ), AgentBase::ObserverV2()
  , m_invitationsCollection( new InvitationsCollection( this ) )
{
  kDebug();

  changeRecorder()->setChangeRecordingEnabled( false ); // behave like Monitor
  changeRecorder()->itemFetchScope().fetchFullPayload();
  changeRecorder()->setMimeTypeMonitored( QLatin1String("message/rfc822"), true );
  //changeRecorder()->setCollectionMonitored( Collection::root(), true );

  connect( this, SIGNAL(reloadConfiguration()), this, SLOT(initStart()) );
  QTimer::singleShot( 0, this, SLOT(initStart()) );
}

InvitationsAgent::~InvitationsAgent()
{
  delete m_invitationsCollection;
}

void InvitationsAgent::initStart()
{
  kDebug();

  m_invitationsCollection->clear();
  if ( m_invitationsCollection->hasDefaultCollection() ) {
    initDone();
  } else {
    SpecialCollectionsRequestJob *job = m_invitationsCollection->reguestJob();
    connect( job, SIGNAL(result(KJob*)), this, SLOT(initDone(KJob*)) );
    job->start();
  }

  /*
  KConfig config( "akonadi_invitations_agent" );
  KConfigGroup group = config.group( "General" );
  m_resourceId = group.readEntry( "DefaultCalendarAgent", "default_ical_resource" );
  newAgentCreated = false;
  m_invitations = Akonadi::Collection();
  AgentInstance resource = AgentManager::self()->instance( m_resourceId );
  if ( resource.isValid() ) {
    emit status( AgentBase::Running, i18n( "Reading..." ) );
    QMetaObject::invokeMethod( this, "createAgentResult", Qt::QueuedConnection );
  } else {
    emit status( AgentBase::Running, i18n( "Creating..." ) );
    AgentType type = AgentManager::self()->type( QLatin1String( "akonadi_ical_resource" ) );
    AgentInstanceCreateJob *job = new AgentInstanceCreateJob( type, this );
    connect( job, SIGNAL(result(KJob*)), this, SLOT(createAgentResult(KJob*)) );
    job->start();
  }
  */
}

void InvitationsAgent::initDone( KJob *job )
{
  if ( job ) {
    if ( job->error() ) {
      kWarning() << "Failed to request default collection:" << job->errorText();
      return;
    }

    m_invitationsCollection->registerDefaultCollection();
  }

  Q_ASSERT( m_invitationsCollection->defaultCollection().isValid() );
  emit status( AgentBase::Idle, i18n( "Ready to dispatch invitations" ) );
}

Collection InvitationsAgent::collection()
{
  return m_invitationsCollection->defaultCollection();
}

#if 0
KPIMIdentities::IdentityManager* InvitationsAgent::identityManager()
{
  if ( !m_IdentityManager )
    m_IdentityManager = new KPIMIdentities::IdentityManager( true /* readonly */, this );
  return m_IdentityManager;
}
#endif

void InvitationsAgent::configure( WId windowId )
{
  kDebug() << windowId;
  /*
  QWidget *parent = QWidget::find( windowId );
  KDialog *dialog = new KDialog( parent );
  QVBoxLayout *layout = new QVBoxLayout( dialog->mainWidget() );
  //layout->addWidget(  );
  dialog->mainWidget()->setLayout( layout );
  */
  initStart(); //reload
}

#if 0
void InvitationsAgent::createAgentResult( KJob *job )
{
  kDebug();
  AgentInstance agent;
  if ( job ) {
    if ( job->error() ) {
      kWarning() << job->errorString();
      emit status( AgentBase::Broken, i18n( "Failed to create resource: %1", job->errorString() ) );
      return;
    }

    AgentInstanceCreateJob *j = static_cast<AgentInstanceCreateJob*>( job );
    agent = j->instance();
    agent.setName( i18n( "Invitations" ) );
    m_resourceId = agent.identifier();

    QDBusInterface conf( QString::fromLatin1( "org.freedesktop.Akonadi.Resource." ) + m_resourceId,
                         QString::fromLatin1( "/Settings" ),
                         QString::fromLatin1( "org.kde.Akonadi.ICal.Settings" ) );
    QDBusReply<void> reply = conf.call( QString::fromLatin1( "setPath" ),
                                        KGlobal::dirs()->localxdgdatadir() + "akonadi_ical_resource" );

    if ( !reply.isValid() ) {
      kWarning() << "dbus call failed, m_resourceId=" << m_resourceId;
      emit status( AgentBase::Broken, i18n( "Failed to set the directory for invitations via D-Bus" ) );
      AgentManager::self()->removeInstance( agent );
      return;
    }

    KConfig config( "akonadi_invitations_agent" );
    KConfigGroup group = config.group( "General" );
    group.writeEntry( "DefaultCalendarAgent", m_resourceId );

    newAgentCreated = true;
    agent.reconfigure();
  } else {
    agent = AgentManager::self()->instance( m_resourceId );
    Q_ASSERT( agent.isValid() );
  }

  ResourceSynchronizationJob *j = new ResourceSynchronizationJob( agent, this );
  connect( j, SIGNAL(result(KJob*)), this, SLOT(resourceSyncResult(KJob*)) );
  j->start();
}

void InvitationsAgent::resourceSyncResult( KJob *job )
{
  kDebug();
  if ( job->error() ) {
    kWarning() << job->errorString();
    emit status( AgentBase::Broken, i18n( "Failed to synchronize collection: %1", job->errorString() ) );
    if ( newAgentCreated )
      AgentManager::self()->removeInstance( AgentManager::self()->instance( m_resourceId ) );
    return;
  }
  CollectionFetchJob *fjob = new CollectionFetchJob( Collection::root(), CollectionFetchJob::Recursive, this );
  fjob->fetchScope().setContentMimeTypes( QStringList() << "text/calendar" );
  fjob->fetchScope().setResource( m_resourceId );
  connect( fjob, SIGNAL(result(KJob*)), this, SLOT(collectionFetchResult(KJob*)) );
  fjob->start();
}

void InvitationsAgent::collectionFetchResult( KJob *job )
{
  kDebug();

  if ( job->error() ) {
    kWarning() << job->errorString();
    emit status( AgentBase::Broken, i18n( "Failed to fetch collection: %1", job->errorString() ) );
    if ( newAgentCreated )
      AgentManager::self()->removeInstance( AgentManager::self()->instance( m_resourceId ) );
    return;
  }

  CollectionFetchJob *fj = static_cast<CollectionFetchJob *>( job );

  if ( newAgentCreated ) {
    // if the agent was just created then there is exactly one collection already
    // and we just use that one.
    Q_ASSERT( fj->collections().count() == 1 );
    m_invitations = fj->collections().first();
    initDone();
    return;
  }

  KConfig config( "akonadi_invitations_agent" );
  KConfigGroup group = config.group( "General" );
  const QString collectionId = group.readEntry( "DefaultCalendarCollection", QString() );
  if ( !collectionId.isEmpty() ) {
    // look if the collection is still there. It may the case that there exists such
    // a collection with the defined collectionId but that this is not a valid one
    // and therefore not in the resultset.
    const int id = collectionId.toInt();
    foreach ( const Collection &c, fj->collections() ) {
      if ( c.id() == id ) {
        m_invitations = c;
        initDone();
        return;
      }
    }
  }

  // we need to create a new collection and use that one...
  Collection c;
  c.setName( "invitations" );
  c.setParent( Collection::root() );
  Q_ASSERT( !m_resourceId.isNull() );
  c.setResource( m_resourceId );
  c.setContentMimeTypes( QStringList()
            << "text/calendar"
            << "application/x-vnd.akonadi.calendar.event"
            << "application/x-vnd.akonadi.calendar.todo"
            << "application/x-vnd.akonadi.calendar.journal"
            << "application/x-vnd.akonadi.calendar.freebusy" );
  CollectionCreateJob *cj = new CollectionCreateJob( c, this );
  connect( cj, SIGNAL(result(KJob*)), this, SLOT(collectionCreateResult(KJob*)) );
  cj->start();
}

void InvitationsAgent::collectionCreateResult( KJob *job )
{
  kDebug();
  if ( job->error() ) {
    kWarning() << job->errorString();
    emit status( AgentBase::Broken, i18n( "Failed to create collection: %1", job->errorString() ) );
    if ( newAgentCreated )
      AgentManager::self()->removeInstance( AgentManager::self()->instance( m_resourceId ) );
    return;
  }
  CollectionCreateJob *j = static_cast<CollectionCreateJob*>( job );
  m_invitations = j->collection();
  initDone();
}
#endif

Item InvitationsAgent::handleContent( const QString &vcal,
                                      const KCalCore::MemoryCalendar::Ptr &calendar,
                                      const Item &item )
{
  KCalCore::ICalFormat format;
  KCalCore::ScheduleMessage::Ptr message = format.parseScheduleMessage( calendar, vcal );
  if ( !message ) {
    kWarning() << "Invalid invitation:" << vcal;
    return Item();
  }

  kDebug() << "id=" << item.id() << "remoteId=" << item.remoteId() << "vcal=" << vcal;

  KCalCore::Incidence::Ptr incidence = message->event().staticCast<KCalCore::Incidence>();
  Q_ASSERT( incidence );

  IncidenceAttribute *attr = new IncidenceAttribute;
  attr->setStatus( QLatin1String("new") ); //TODO
  //attr->setFrom( message->from()->asUnicodeString() );
  attr->setReference( item.id() );

  Item newItem;
  newItem.setMimeType( incidence->mimeType() );
  newItem.addAttribute( attr );
  newItem.setPayload<KCalCore::Incidence::Ptr>( KCalCore::Incidence::Ptr( incidence->clone() ) );
  return newItem;
}

void InvitationsAgent::itemAdded( const Item &item, const Collection &collection )
{
  kDebug() << item.id() << collection;
  Q_UNUSED( collection );

  if ( !m_invitationsCollection->defaultCollection().isValid() ) {
    kDebug() << "No default collection found";
    return;
  }

  if ( collection.isVirtual() )
    return;

  if ( !item.hasPayload<KMime::Message::Ptr>() ) {
    kDebug() << "Item has no payload";
    return;
  }

  KMime::Message::Ptr message = item.payload<KMime::Message::Ptr>();

  //TODO check if we are the sender and need to ignore the message...
  //const QString sender = message->sender()->asUnicodeString();
  //if ( identityManager()->thatIsMe( sender ) ) return;

  KCalCore::MemoryCalendar::Ptr calendar( new KCalCore::MemoryCalendar( KSystemTimeZones::local() ) );
  if ( message->contentType()->isMultipart() ) {
    kDebug() << "message is multipart:" << message->attachments().size();

    InvitationsAgentItem *it = 0;
    foreach ( KMime::Content *content, message->contents() ) {

      KMime::Headers::ContentType *ct = content->contentType();
      Q_ASSERT( ct );
      kDebug() << "Mimetype of the body part is " << ct->mimeType();
      if ( ct->mimeType() != "text/calendar" )
        continue;

      Item newItem = handleContent( QLatin1String(content->body()), calendar, item );
      if ( !newItem.hasPayload() ) {
        kDebug() << "new item has no payload";
        continue;
      }

      if ( !it )
        it = new InvitationsAgentItem( this, item );

      it->add( newItem );
    }
  } else {
    kDebug() << "message is not multipart";

    KMime::Headers::ContentType *ct = message->contentType();
    Q_ASSERT( ct );
    kDebug() << "Mimetype of the body is " << ct->mimeType();
    if ( ct->mimeType() != "text/calendar" )
      return;

    kDebug() << "Message has an invitation in the body, processing";

    Item newItem = handleContent( QLatin1String(message->body()), calendar, item );
    if ( !newItem.hasPayload() ) {
      kDebug() << "new item has no payload";
      return;
    }

    InvitationsAgentItem *it = new InvitationsAgentItem( this, item );
    it->add( newItem );
  }
}

AKONADI_AGENT_MAIN( InvitationsAgent )