summaryrefslogtreecommitdiffabout
path: root/libkdepim/externalapphandler.h
blob: b899ad7635be967dd8b1b2a7c7f959126a658b4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*
    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(int usedSourceParameters, const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage);
	QCopTransferItem();

    bool sendMessageToTarget(const QString& uid, const QString& param1 = QString::null, const QString& param2 = QString::null, const QString& param3 = QString::null);

    void setSourceChannel(const QString& sourceChannel);

    virtual bool appMessage( const QCString& msg, const QByteArray& data );


 signals:
    void receivedMessageFromSource(const QString& sourceChannel, const QString& uid);
    void receivedMessageFromSource(const QString& sourceChannel, const QString& uid, const QString& param1);
    void receivedMessageFromSource(const QString& sourceChannel, const QString& uid, const QString& param1, const QString& param2);
    void receivedMessageFromSource(const QString& sourceChannel, const QString& uid, const QString& param1, const QString& param2, const QString& param3);

  public:
    int _usedSourceParameters;
    QString _sourceChannel;
    QString _sourceMessage;
    QString _sourceMessageParameters;
    QString _targetChannel;
    QString _targetMessage;
    QString _targetMessageParameters;

};

/*********************************************************************************
 *
 ********************************************************************************/

class QCopMapTransferItem : public QCopTransferItem
{
  Q_OBJECT
  public:
    QCopMapTransferItem(int usedSourceParameters, 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(int usedSourceParameters, const QString& sourceMessage, const QString& targetChannel, const QString& targetMessage);
    ~QCopListTransferItem();
    bool sendMessageToSource(const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3, const QStringList& list4, const QStringList& list5,  const QStringList& list6);


    virtual bool appMessage( const QCString& msg, const QByteArray& data );


 signals:
    void receivedMessageFromTarget(const QString& uid, const QStringList& list1, const QStringList& list2, const QStringList& list3, const QStringList& list4 , const QStringList& list5,  const QStringList& list6);

};

/*********************************************************************************
 *
 ********************************************************************************/


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 : public QObject
{
  Q_OBJECT
  public:
    virtual ~ExternalAppHandler();

    static ExternalAppHandler *instance();

    enum Types {
		EMAIL = 0,
		PHONE = 1,
		SMS   = 2,
		FAX   = 3,
		PAGER = 4,
		SIP   = 5
	};

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

    //calls the sipapplication with the number
    bool callBySIP( const QString& sipnumber );

    bool isEmailAppAvailable();
    bool isSMSAppAvailable();
    bool isPhoneAppAvailable();
    bool isFaxAppAvailable();
    bool isPagerAppAvailable();
    bool isSIPAppAvailable();


    //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& sessionuid);
    //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& sessionuid, const QStringList& name, const QStringList& email, const QStringList& uid);



    bool requestFindByEmailFromKAPI(const QString& sourceChannel, const QString& sessionuid, const QString& email);
    bool returnFindByEmailFromKAPI(const QString& sourceChannel, const QString& sessionuid, const QStringList& name, const QStringList& email, const QStringList& uid);

    bool requestDetailsFromKAPI(const QString& name, const QString& email, const QString& uid);



    bool requestBirthdayListFromKAPI(const QString& sourceChannel, const QString& sessionuid);
    bool returnBirthdayListFromKAPI(const QString& sourceChannel, const QString& sessionuid,
				    const QStringList& birthdayList, const QStringList& anniversaryList,
				    const QStringList& realNameList, const QStringList& emailList,
				    const QStringList& assembledNameList, const QStringList& uidList);


    //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:
    void callContactdialog();
    void nextView();
    void doRingSync();
    // Emmitted when the target app receives a request from the source app
    void requestForNameEmailUidList(const QString& sourceChannel, const QString& uid);

    // 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 receivedFindByEmailEvent(const QString& uid, const QStringList& nameList, const QStringList& emailList, const QStringList& uidList);

    void requestForDetails(const QString& sourceChannel, const QString& sessionuid, const QString& name, const QString& email, const QString& uid);


    // Emmitted when the target app receives a request from the source app
    void requestForBirthdayList(const QString& sourceChannel, const QString& uid);

    // 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 receivedBirthdayListEvent(const QString& uid, const QStringList& birthdayList,
				   const QStringList& anniversaryList, const QStringList& realNameList,
				   const QStringList& emailList, const QStringList& assembledNameList,
				   const QStringList& uidList);


  private:
    ExternalAppHandler();
    QList<DefaultAppItem> mDefaultItems;

    Availability mEmailAppAvailable;
    Availability mPhoneAppAvailable;
    Availability mFaxAppAvailable;
    Availability mSMSAppAvailable;
    Availability mPagerAppAvailable;
    Availability mSIPAppAvailable;

    QCopListTransferItem* mNameEmailUidListFromKAPITransfer;
    QCopListTransferItem* mFindByEmailFromKAPITransfer;
    QCopTransferItem* mDisplayDetails;
    QCopListTransferItem* mBirthdayListFromKAPITransfer;


    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;

  private slots:
    void receivedNameEmailUidList_Slot(const QString& uid, const QStringList& nameList, const QStringList& emailList, const QStringList& uidList, const QStringList&, const QStringList&, const QStringList& );

};


#endif