QCop implementation for KOrganizer to access Ka/pi directly

2 files changed, 389 insertions, 4 deletions

diff --git a/libkdepim/externalapphandler.cpp b/libkdepim/externalapphandler.cpp
index 35638b1..64caa7d 100644
--- a/libkdepim/externalapphandler.cpp
+++ b/libkdepim/externalapphandler.cpp
@@ -16,77 +16,313 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
     As a special exception, permission is given to link this program
     with any edition of Qt, and distribute the resulting executable,
     without including the source code for Qt in the source distribution.
 */
 
 /*
 Enhanced Version of the file for platform independent KDE tools.
 Copyright (c) 2004 Ulf Schenk
 
 $Id$
 */
 #include <stdlib.h>
 
 #include <qfile.h>
 #include <qmap.h>
 #include <qregexp.h>
 
 #ifndef DESKTOP_VERSION
 #include <qtopia/qcopenvelope_qws.h>
 #endif
 
 #include <kstaticdeleter.h>
 #include <kmessagebox.h>
 
 
 #include "externalapphandler.h"
 
 #include "kpimglobalprefs.h"
 
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+
+QCopTransferItem::QCopTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage)
+  : _sourceMessage(sourceMessage), _targetChannel(targetChannel), _targetMessage(targetMessage)
+{
+  //sourceMessage passes later three parameters: sourceChannel, uid, param1
+  _sourceMessageParameters = "(QString,QString,QString)";
+}
+
+/*********************************************************************************/
+
+QCopTransferItem::QCopTransferItem()
+{
+}
+
+/*********************************************************************************/
+bool QCopTransferItem::sendMessageToTarget(const QString& uid, const QString& param1)
+{
+
+#ifndef DESKTOP_VERSION
+  //sourceMessage passes two parameters: sourceChannel, uid
+  QString sourceMessage = _sourceMessage + _sourceMessageParameters;
+
+  qDebug("Using QCopEnvelope e(\"%s\",\"%s\")", _targetChannel.latin1(), sourceMessage.latin1());
+  qDebug("passing sourcechannel(%s), uid(%s), param1(%s) as parameter to QCopEnvelope", _sourceChannel.latin1(), uid.latin1(), param1.latin1());
+
+  QCopEnvelope e(_targetChannel.latin1(), sourceMessage.latin1());
+
+  e << _sourceChannel << uid << param1;
+
+  return true;
+
+#else
+  KMessageBox::sorry( 0, i18n( "This version does not support QCop." ) );
+  return false;
+#endif
+
+}
+
+
+/*********************************************************************************/
+void QCopTransferItem::setSourceChannel(const QString& sourceChannel)
+{
+
+  if (_sourceChannel.isEmpty())
+    _sourceChannel = sourceChannel;
+}
+
+
+/*********************************************************************************/
+bool QCopTransferItem::appMessage( const QCString& cmsg, const QByteArray& data )
+{
+/*US
+  // copied from old mail2
+  static int ii = 0;
+
+  // block second call
+  if ( ii < 2 ) {
+    ++ii;
+    if ( ii > 1 ) {
+      qDebug("qcop call blocked ");
+      return true;
+    }
+  }
+*/
+  qDebug("QCopTransferItem- QCOP message received: %s ", cmsg.data()  );
+
+  //we are in the target and get a request from the source
+  if ( (_sourceMessage + _sourceMessageParameters) == cmsg.data())
+  {
+    QDataStream stream( data, IO_ReadOnly );
+
+
+    QString sourceChannel;
+    QString uid;
+    QString param1;
 
+    stream >> sourceChannel >> uid >> param1;
 
+    emit receivedMessageFromSource(sourceChannel, uid, param1);
 
+    return true;
+  }
+
+  return false;
+}
+
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+
+QCopMapTransferItem::QCopMapTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage)
+  : QCopTransferItem(sourceMessage, targetChannel,targetMessage)
+{
+  //targetMessage returns later two parameters: uid, and map<qstring,qstring>
+  _targetMessageParameters = "(QString,QMAP<QString,QString>)";
+}
+
+/*********************************************************************************/
+bool QCopMapTransferItem::sendMessageToSource(const QString& uid, const QMap<QString,QString>& nameEmailMap)
+{
+#ifndef DESKTOP_VERSION
+  //targetMessage passes two parameters: uid, map
+  QString targetMessage = _targetMessage + _targetMessageParameters;
+
+  qDebug("Using QCopEnvelope e(\"%s\",\"%s\")", _sourceChannel.latin1(), targetMessage.latin1());
+  qDebug("passing uid(%s) and map as parameter to QCopEnvelope", uid.latin1());
 
+  QCopEnvelope e(_sourceChannel.latin1(), targetMessage.latin1());
+    //US we need no names in the To field. The emailadresses are enough
+
+  e << uid << nameEmailMap;
+
+  return true;
+
+#else
+  KMessageBox::sorry( 0, i18n( "This version does not support QCop." ) );
+  return false;
+#endif
+
+}
+
+
+/*********************************************************************************/
+bool QCopMapTransferItem::appMessage( const QCString& cmsg, const QByteArray& data )
+{
+  bool res = QCopTransferItem::appMessage( cmsg, data );
+
+  if (res == false)
+  {
+    QDataStream stream( data, IO_ReadOnly );
+
+    qDebug("QCopMapTransferItem- QCOP message received: %s ", cmsg.data()  );
+
+    //we are in the source and get an answer from the target
+    if ((_targetMessage + _targetMessageParameters) == cmsg.data())
+    {
+      QMap<QString,QString> adrMap;
+      QString uid;
+
+      stream >> uid >> adrMap;
+
+      emit receivedMessageFromTarget(uid, adrMap);
+
+
+      return true;
+    }
+  }
+
+  return false;
+}
+
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+
+QCopListTransferItem::QCopListTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage)
+  : QCopTransferItem(sourceMessage, targetChannel,targetMessage)
+{
+  //targetMessage returns later two parameters: uid, and map<qstring,qstring>
+  _targetMessageParameters = "(QString,QStringList,QStringList,QStringList)";
+}
+
+/*********************************************************************************/
+bool QCopListTransferItem::sendMessageToSource(const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3)
+{
+#ifndef DESKTOP_VERSION
+  //targetMessage passes two parameters: uid, map
+  QString targetMessage = _targetMessage + _targetMessageParameters;
+
+  qDebug("Using QCopEnvelope e(\"%s\",\"%s\")", _sourceChannel.latin1(), targetMessage.latin1());
+  qDebug("passing uid(%s) and list1, list2, list3 as parameter to QCopEnvelope", uid.latin1());
+
+  QCopEnvelope e(_sourceChannel.latin1(), targetMessage.latin1());
+    //US we need no names in the To field. The emailadresses are enough
+
+  e << uid << list1 << list2 << list3;
+
+  return true;
+
+#else
+  KMessageBox::sorry( 0, i18n( "This version does not support QCop." ) );
+  return false;
+#endif
+
+}
+
+
+/*********************************************************************************/
+bool QCopListTransferItem::appMessage( const QCString& cmsg, const QByteArray& data )
+{
+  bool res = QCopTransferItem::appMessage( cmsg, data );
+
+  if (res == false)
+  {
+    QDataStream stream( data, IO_ReadOnly );
+
+    qDebug("QCopListTransferItem- QCOP message received: %s ", cmsg.data()  );
+
+    //we are in the source and get an answer from the target
+    if ((_targetMessage + _targetMessageParameters) == cmsg.data())
+    {
+      QStringList list1;
+      QStringList list2;
+      QStringList list3;
+      QString uid;
+
+      stream >> uid >> list1 >> list2 >> list3;
+
+      emit receivedMessageFromTarget(uid, list1, list2, list3);
+
+
+      return true;
+    }
+  }
+
+  return false;
+}
+
+
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
 
 
 ExternalAppHandler *ExternalAppHandler::sInstance = 0;
 static KStaticDeleter<ExternalAppHandler> staticDeleter;
 
-
 ExternalAppHandler::ExternalAppHandler()
 {
   mDefaultItems.setAutoDelete(true);
+
+  mNameEmailUidListFromKAPITransfer = new QCopListTransferItem("requestNameEmailUIDListFromKAPI", "QPE/Application/kapi", "receiveNameEmailUIDList");
+  connect(mNameEmailUidListFromKAPITransfer, SIGNAL (receivedMessageFromSource(const QString&, const QString&, const QString&)), this, SIGNAL (requestForNameEmailUidList(const QString&, const QString&, const QString&)));
+  connect(mNameEmailUidListFromKAPITransfer, SIGNAL (receivedMessageFromTarget(const QString&, const QStringList&, const QStringList&, const QStringList&)), this, SIGNAL (receivedNameEmailUidListEvent(const QString&, const QStringList&, const QStringList&, const QStringList&)));
+
+//US  mFindByEmailFromKAPITransfer = new QCopListTransferItem("requestFindByEmailFromKAPI", "QPE/Application/kapi", "receiveFindByEmailNameEmailUIDList");
+//US  connect(mFindByEmailFromKAPITransfer, SIGNAL (receivedMessageFromSource(const QString&, const QString&, const QString&)), this, SIGNAL (requestForFindByEmail(const QString&, const QString&, const QString&)));
+//US  connect(mFindByEmailFromKAPITransfer, SIGNAL (receivedMessageFromTarget(const QString&, const QStringList&, const QStringList&, const QStringList&)), this, SIGNAL (receivedFindByEmailEvent(const QString&, const QStringList&, const QStringList&, const QStringList&)));
+
+
 }
 
 ExternalAppHandler::~ExternalAppHandler()
 {
 }
 
 void ExternalAppHandler::loadConfig()
 {
 
   mDefaultItems.clear();
 
   mEmailAppAvailable = UNDEFINED;
   mPhoneAppAvailable = UNDEFINED;
   mFaxAppAvailable = UNDEFINED;
   mSMSAppAvailable = UNDEFINED;
   mPagerAppAvailable = UNDEFINED;
 
 
   QString opiepath = QString::fromLatin1( getenv("OPIEDIR") );
   QString qtopiapath = QString::fromLatin1( getenv("QPEDIR") );
 
   if (opiepath.isEmpty())
     opiepath = qtopiapath;
 
   //mailclients
   QString mailmsg1 = "writeMail(QString,QString)";
   QString mailmsg2 = "writeMail(QMap(QString,QString))";
 
   QString undefined = "";
 
   addDefaultAppItem(ExternalAppHandler::EMAIL, KPimGlobalPrefs::NONE_EMC,   "No email client installed",       undefined,                undefined,        undefined, undefined, undefined);
   addDefaultAppItem(ExternalAppHandler::EMAIL, KPimGlobalPrefs::OTHER_EMC,  "Userdefined email client",       undefined,                undefined,        undefined, undefined, undefined);
@@ -362,65 +598,66 @@ bool ExternalAppHandler::mailToOneContact( const QString& name, const QString& e
 
   QCopEnvelope e(channel.latin1(), message.latin1());
     //US we need no names in the To field. The emailadresses are enough
 
   passParameters(&e, parameters, name, emailadress);
 
 
 #else
   KMessageBox::sorry( 0, i18n( "This version does not support the sending of emails." ) );
 #endif
 
 
   return true;
 }
 
 /**************************************************************************
  *
  **************************************************************************/
 
 //calls the emailapplication and creates a mail with parameter as recipients
 // parameters format is
 //  NAME <EMAIL>:SUBJECT
 bool ExternalAppHandler::mailToOneContact( const QString& adressline )
 {
   QString line = adressline;
 
   int first = line.find( "<");
   int last = line.find( ">");
   QString name = line.left(first);
   QString emailadress = line.mid(first+1, last-first-1);
 
   //Subject can not be handled right now.
-  mailToOneContact( name, emailadress );
+  return mailToOneContact( name, emailadress );
+
 }
 
 
 /**************************************************************************
  *
  **************************************************************************/
 
 //calls the phoneapplication with the number
 bool ExternalAppHandler::callByPhone( const QString& phonenumber )
 {
 #ifndef DESKTOP_VERSION
   QString channel;
   QString message;
   QString parameters;
 
 
   int client = KPimGlobalPrefs::instance()->mPhoneClient;
   if (client == KPimGlobalPrefs::OTHER_PHC)
   {
     channel = KPimGlobalPrefs::instance()->mPhoneOtherChannel;
     message = KPimGlobalPrefs::instance()->mPhoneOtherMessage;
     parameters = KPimGlobalPrefs::instance()->mPhoneOtherMessageParameters;
   }
   else
   {
     DefaultAppItem* dai = ExternalAppHandler::getDefaultItem(PHONE, client);
     if (!dai)
     {
       qDebug("could not find configured phone application.");
           return false;
     }
     channel = dai->_channel;
@@ -650,32 +887,73 @@ void ExternalAppHandler::passParameters(QCopEnvelope* e, const QString& paramete
     //if we have keyvalue pairs, we assume that we pass a map to the envelope
     QStringList::Iterator it2 = keyvallist.begin();
     QString key = (*it2);
     key = key.replace( QRegExp("%1"), param1 );
     key = key.replace( QRegExp("%2"), param2 );
     ++it2;
 
     if(it2 != keyvallist.end())
     {
       QString value = (*it2);
       value = value.replace( QRegExp("%1"), param1 );
       value = value.replace( QRegExp("%2"), param2 );
 
           valmap.insert(key, value);
           useValMap = true;
     }
     else
     {
       //      qDebug("pass parameter << %s", key.latin1());
       (*e) << key;
     }
   }
 
   if (useValMap == true)
     (*e) << valmap;
 
 #endif
 
 }
 
 
 
+/**************************************************************************
+ *
+ **************************************************************************/
+
+void ExternalAppHandler::appMessage( const QCString& cmsg, const QByteArray& data )
+{
+  bool res = mNameEmailUidListFromKAPITransfer->appMessage( cmsg, data );
+
+//  if (!res)
+//    res = mNameEmailUidListFromKAPITransfer->appMessage( cmsg, data );
+}
+
+
+
+bool ExternalAppHandler::requestNameEmailUidListFromKAPI(const QString& sourceChannel, const QString& uid)
+{
+  mNameEmailUidListFromKAPITransfer->setSourceChannel(sourceChannel);
+  return mNameEmailUidListFromKAPITransfer->sendMessageToTarget(uid, QString::null);
+}
+
+bool ExternalAppHandler::returnNameEmailUidListFromKAPI(const QString& sourceChannel, const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3)
+{
+  mNameEmailUidListFromKAPITransfer->setSourceChannel(sourceChannel);
+  return mNameEmailUidListFromKAPITransfer->sendMessageToSource(uid, list1, list2, list3);
+}
+
+bool ExternalAppHandler::requestFindByEmailFromKAPI(const QString& sourceChannel, const QString& uid, const QString& email)
+{
+  mFindByEmailFromKAPITransfer->setSourceChannel(sourceChannel);
+  return mFindByEmailFromKAPITransfer->sendMessageToTarget(uid, email);
+}
+
+bool ExternalAppHandler::returnFindByEmailFromKAPI(const QString& sourceChannel, const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3)
+{
+  mFindByEmailFromKAPITransfer->setSourceChannel(sourceChannel);
+  return mFindByEmailFromKAPITransfer->sendMessageToSource(uid, list1, list2, list3);
+}
+
+
+
+
diff --git a/libkdepim/externalapphandler.h b/libkdepim/externalapphandler.h
index 3cf9e06..7c8de4e 100644
--- a/libkdepim/externalapphandler.h
+++ b/libkdepim/externalapphandler.h
@@ -2,144 +2,251 @@
     This file is part of libkdepim.
     Copyright (c) 2004 Ulf Schenk
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
     This program 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 General Public License for more details.
 
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
     As a special exception, permission is given to link this program
     with any edition of Qt, and distribute the resulting executable,
     without including the source code for Qt in the source distribution.
 */
 
 /*
 Enhanced Version of the file for platform independent KDE tools.
 Copyright (c) 2004 Ulf Schenk
 
 $Id$
 */
 
 #ifndef EXTERNALAPPHANDLER_H
 #define EXTERNALAPPHANDLER_H
 
+#include <qobject.h>
 #include <qlist.h>
+#include <qmap.h>
 
 class QCopEnvelope;
 
 
 class ExternalAppHandler;
+class QCopTransferItem  : public QObject
+{
+  Q_OBJECT
+  public:
+    QCopTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage);
+        QCopTransferItem();
+
+    bool sendMessageToTarget(const QString& uid, const QString& param1);
+
+    void setSourceChannel(const QString& sourceChannel);
+
+    virtual bool appMessage( const QCString& msg, const QByteArray& data );
+
+
+ signals:
+    void receivedMessageFromSource(const QString& sourceChannel, const QString& uid, const QString& param1);
+
+
+  public:
+    QString _sourceChannel;
+    QString _sourceMessage;
+    QString _sourceMessageParameters;
+    QString _targetChannel;
+    QString _targetMessage;
+    QString _targetMessageParameters;
+
+};
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+class QCopMapTransferItem : public QCopTransferItem
+{
+  Q_OBJECT
+  public:
+    QCopMapTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage);
+
+    bool sendMessageToSource(const QString& uid, const QMap<QString,QString>& nameEmailMap);
+
+
+    virtual bool appMessage( const QCString& msg, const QByteArray& data );
+
+
+ signals:
+    void receivedMessageFromTarget(const QString& uid, const QMap<QString,QString>& nameEmailMap);
+
+};
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+class QCopListTransferItem : public QCopTransferItem
+{
+  Q_OBJECT
+  public:
+    QCopListTransferItem(const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage);
+
+    bool sendMessageToSource(const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3);
+
+
+    virtual bool appMessage( const QCString& msg, const QByteArray& data );
+
+
+ signals:
+    void receivedMessageFromTarget(const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3);
+
+};
+
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
 
 class DefaultAppItem
 {
   public:
     DefaultAppItem(int type, int id, const QString& label,  const QString& channel, const QString& message, const QString& parameters, const QString& message2, const QString& parameters2)
       : _type(type), _id(id), _label(label), _channel(channel), _message(message), _parameters(parameters), _message2(message2), _parameters2(parameters2)
               {}
 
         DefaultAppItem()
         {  }
 
   public:
     int _type;
     int _id;
     QString _label;
     QString _channel;
     QString _message;
             QString _parameters;// a list of parameters in stringrepresentation. Delimiter is ;
     QString _message2;
     QString _parameters2;  // a list of parameters in stringrepresentation. Delimiter is ;
 
 };
 
-class ExternalAppHandler
+/*********************************************************************************
+ *
+ ********************************************************************************/
+
+class ExternalAppHandler : public QObject
 {
+  Q_OBJECT
   public:
     virtual ~ExternalAppHandler();
 
     static ExternalAppHandler *instance();
 
     enum Types {
                 EMAIL = 0,
                 PHONE = 1,
                 SMS   = 2,
                 FAX   = 3,
                 PAGER = 4
         };
 
     enum Availability {
                 UNDEFINED = -1,
                 UNAVAILABLE   = 0,
                 AVAILABLE = 1
         };
 
     //calls the emailapplication with a number of attachments that need to be send.
     //either parameter can be left empty.
     bool mailToMultipleContacts( const QString& recipients, const QString& attachmenturls );
 
     //calls the emailapplication and creates a mail with parameter emailadress as recipients
     bool mailToOneContact( const QString& name, const QString& emailadress );
 
     //calls the emailapplication and creates a mail with parameter as recipients
     // parameters format is
     //  NAME <EMAIL>:SUBJECT
     bool mailToOneContact( const QString& adressline );
 
     //calls the phoneapplication with the number
     bool callByPhone( const QString& phonenumber );
 
     //calls the smsapplication with the number
     bool callBySMS( const QString& phonenumber );
 
     //calls the pagerapplication with the number
     bool callByPager( const QString& pagernumber );
 
     //calls the faxapplication with the number
     bool callByFax( const QString& faxnumber );
 
     bool isEmailAppAvailable();
     bool isSMSAppAvailable();
     bool isPhoneAppAvailable();
     bool isFaxAppAvailable();
     bool isPagerAppAvailable();
 
 
+    //Call this method on the source when you want to select names from the addressbook by using QCop
+    bool requestNameEmailUidListFromKAPI(const QString& sourceChannel, const QString& uid);
+    //Call this method on the target when you want to return the name/email map to the source (client).
+    bool returnNameEmailUidListFromKAPI(const QString& sourceChannel, const QString& uid, const QStringList& name, const QStringList& email, const QStringList& uid);
+
+    bool requestFindByEmailFromKAPI(const QString& sourceChannel, const QString& uid, const QString& email);
+    bool returnFindByEmailFromKAPI(const QString& sourceChannel, const QString& uid, const QStringList& name, const QStringList& email, const QStringList& uid);
+
 
     //loadConfig clears the cache and checks again if the applications are available or not
     void loadConfig();
 
     QList<DefaultAppItem> getAvailableDefaultItems(Types);
     DefaultAppItem* getDefaultItem(Types, int);
 
+ public  slots:
+    void appMessage( const QCString& msg, const QByteArray& data );
+
+
+ signals:
+    // Emmitted when the target app receives a request from the source app
+    void requestForNameEmailUidList(const QString& sourceChannel, const QString& uid, const QString& param1);
+
+    // Emitted when the source app recieves a list of name/email pairs (=addresses) from another target app. Usually Ka/Pi
+    // The first parameter is a uniqueid. It can be used to identify the event
+    void receivedNameEmailUidListEvent(const QString& uid, const QStringList& nameList, const QStringList& emailList, const QStringList& uidList);
+
+    void requestFindByEmail(const QString& sourceChannel, const QString& uid, const QString& email);
+    void receivedFindBbyEmailEvent(const QString& uid, const QStringList& nameList, const QStringList& emailList, const QStringList& uidList);
+
 
   private:
     ExternalAppHandler();
     QList<DefaultAppItem> mDefaultItems;
 
     Availability mEmailAppAvailable;
     Availability mPhoneAppAvailable;
     Availability mFaxAppAvailable;
     Availability mSMSAppAvailable;
     Availability mPagerAppAvailable;
 
+    QCopListTransferItem* mNameEmailUidListFromKAPITransfer;
+    QCopListTransferItem* mFindByEmailFromKAPITransfer;
+
 
     void addDefaultAppItem(Types type, int id, const QString& label,  const QString& channel, const QString& message, const QString& parameters, const QString& message2, const QString& parameters2);
 
     QString& translateMessage(QString& message, const QString& param1, const QString& param2) const;
         void passParameters(QCopEnvelope* e, const QString& parameters, const QString& param1, const QString& param2) const;
 
 
     static ExternalAppHandler *sInstance;
 
-
 };
 
+
 #endif