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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
/**
* Whiteboard session manager
*
* Authors:
* David Yip <yipdw@rose-hulman.edu>
* Bob Jamison (Pedro port)
*
* Copyright (c) 2005 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include <functional>
#include <algorithm>
#include <iostream>
#include <gtkmm.h>
#include <glibmm/i18n.h>
#include "xml/node-observer.h"
#include "pedro/pedrodom.h"
#include "document.h"
#include "desktop.h"
#include "desktop-handles.h"
#include "jabber_whiteboard/message-verifier.h"
#include "jabber_whiteboard/session-manager.h"
#include "jabber_whiteboard/inkboard-document.h"
#include "jabber_whiteboard/new-inkboard-document.h"
#include "jabber_whiteboard/defines.h"
#include "jabber_whiteboard/dialog/choose-desktop.h"
#define INKBOARD_XMLNS "http://inkscape.org/inkboard"
namespace Inkscape {
namespace Whiteboard {
//#########################################################################
//# S E S S I O N M A N A G E R
//#########################################################################
SessionManager *sessionManagerInstance = NULL;
void SessionManager::showClient()
{
SessionManager::instance().gui.show();
}
SessionManager&
SessionManager::instance()
{
if (!sessionManagerInstance)
sessionManagerInstance = new SessionManager();
return *sessionManagerInstance;
}
SessionManager::SessionManager()
{
sequenceNumber = 0L;
getClient().addXmppEventListener(*this);
this->_check_pending_invitations = Glib::signal_timeout().connect(sigc::mem_fun(*this, &SessionManager::_checkInvitationQueue), 50);
this->_check_invitation_responses = Glib::signal_timeout().connect(sigc::mem_fun(*this, &SessionManager::_checkInvitationResponseQueue), 50);
}
SessionManager::~SessionManager()
{
getClient().removeXmppEventListener(*this);
getClient().disconnect();
}
unsigned long SessionManager::getSequenceNumber()
{
return sequenceNumber++;
}
bool
SessionManager::send(const Glib::ustring &destJid,
const Message::Wrapper type,
const Glib::ustring &data)
{
Pedro::DOMString xmlData = Pedro::Parser::encode(data);
char *fmt=
"<message type='chat' from='%s' to='%s' id='ink_%d'>"
"<w xmlns='%s' "
"protocol='%d' type='%d' seq='%d'><x:inkboard-data>%s</x:inkboard-data></inkboard>"
"<body></body>"
"</message>";
if (!getClient().write(fmt,
getClient().getJid().c_str(),
destJid.c_str(),
getClient().getMsgId(),
INKBOARD_XMLNS,
2,
(MessageType)type,
getSequenceNumber(),
xmlData.c_str()
))
{
return false;
}
return true;
}
bool
SessionManager::sendGroup(const Glib::ustring &groupJid,
const Message::Wrapper type,
const Glib::ustring &data)
{
Pedro::DOMString xmlData = Pedro::Parser::encode(data);
char *fmt=
"<message type='groupchat' from='%s' to='%s' id='ink_%d'>"
"<inkboard xmlns='%s' "
"protocol='%d' type='%d' seq='%d'><x:inkboard-data>%s</x:inkboard-data></inkboard>"
"<body></body>"
"</message>";
if (!getClient().write(fmt,
getClient().getJid().c_str(),
groupJid.c_str(),
getClient().getMsgId(),
INKBOARD_XMLNS,
2,
type,
getSequenceNumber(),
xmlData.c_str()
))
{
return false;
}
return true;
}
void
SessionManager::processXmppEvent(const Pedro::XmppEvent &event)
{
int type = event.getType();
switch (type) {
case Pedro::XmppEvent::EVENT_STATUS:
{
break;
}
case Pedro::XmppEvent::EVENT_ERROR:
{
break;
}
case Pedro::XmppEvent::EVENT_CONNECTED:
{
break;
}
case Pedro::XmppEvent::EVENT_DISCONNECTED:
{
break;
}
case Pedro::XmppEvent::EVENT_MESSAGE:
{
printf("## SM message:%s\n", event.getFrom().c_str());
Pedro::Element *root = event.getDOM();
if (root)
{
if (root->getTagAttribute("inkboard", "xmlns") ==
INKBOARD_XMLNS)
{
_processInkboardEvent(event);
}
}
break;
}
case Pedro::XmppEvent::EVENT_PRESENCE:
{
break;
}
case Pedro::XmppEvent::EVENT_MUC_MESSAGE:
{
printf("## SM MUC message:%s\n", event.getFrom().c_str());
Pedro::Element *root = event.getDOM();
if (root)
{
if (root->getTagAttribute("inkboard", "xmlns") ==
INKBOARD_XMLNS)
{
_processInkboardEvent(event);
}
}
break;
}
case Pedro::XmppEvent::EVENT_MUC_JOIN:
{
break;
}
case Pedro::XmppEvent::EVENT_MUC_LEAVE:
{
break;
}
case Pedro::XmppEvent::EVENT_MUC_PRESENCE:
{
break;
}
default:
{
break;
}
}
}
/**
* Initiates a shared session with a user or conference room.
*
* \param to The recipient to which this desktop will be linked, specified as a JID.
* \param type Type of the session; i.e. private message or group chat.
*/
void
SessionManager::doShare(Glib::ustring const& to, State::SessionType type)
{
InkboardDocument* doc;
SPDesktop* dt;
// Just create a new blank canvas for MUC sessions
if(type == State::WHITEBOARD_MUC)
{
dt = createInkboardDesktop(to, type);
if (dt != NULL)
{
doc = dynamic_cast< InkboardDocument* >(sp_desktop_document(dt)->rdoc);
if (doc != NULL)
{
doc->startSessionNegotiation();
}
}
// Let the user pick the document which to start a peer ro peer session
// with, or a blank one, then create a blank document, copy over the contents
// and initialise session
} else if (type== State::WHITEBOARD_PEER) {
ChooseDesktop dialog;
int result = dialog.run();
if(result == Gtk::RESPONSE_OK)
{
SPDesktop *desktop = dialog.getDesktop();
dt = createInkboardDesktop(to, type);
if (dt != NULL)
{
doc = dynamic_cast< InkboardDocument* >(sp_desktop_document(dt)->rdoc);
if (doc != NULL)
{
if(desktop != NULL)
{
Inkscape::XML::Document *old_doc =
sp_desktop_document(desktop)->rdoc;
doc->root()->mergeFrom(old_doc->root(),"id");
}
doc->startSessionNegotiation();
}
}
}
}
}
/**
* Clone of sp_file_new and all related subroutines and functions,
* with appropriate modifications to use the Inkboard document class.
*
* \param to The JID to which this Inkboard document will be connected.
* \return A pointer to the created desktop, or NULL if a new desktop could not be created.
*/
SPDesktop*
SessionManager::createInkboardDesktop(Glib::ustring const& to, State::SessionType type)
{
// Create document (sp_repr_document_new clone)
SPDocument* doc = makeInkboardDocument(g_quark_from_static_string("xml"), "svg:svg", type, to);
g_return_val_if_fail(doc != NULL, NULL);
InkboardDocument* inkdoc = dynamic_cast< InkboardDocument* >(doc->rdoc);
if (inkdoc == NULL) { // this shouldn't ever happen...
return NULL;
}
// Create desktop and attach document
SPDesktop *dt = makeInkboardDesktop(doc);
_inkboards.push_back(Inkboard_record_type(to, inkdoc));
return dt;
}
void
SessionManager::terminateInkboardSession(Glib::ustring const& to)
{
std::cout << "Terminating Inkboard session to " << to << std::endl;
Inkboards_type::iterator i = _inkboards.begin();
for(; i != _inkboards.end(); ++i) {
if ((*i).first == to) {
break;
}
}
if (i != _inkboards.end()) {
std::cout << "Erasing Inkboard session to " << to << std::endl;
(*i).second->terminateSession();
_inkboards.erase(i);
}
}
InkboardDocument*
SessionManager::getInkboardSession(Glib::ustring const& to)
{
Inkboards_type::iterator i = _inkboards.begin();
for(; i != _inkboards.end(); ++i) {
if ((*i).first == to) {
return (*i).second;
}
}
return NULL;
}
void
SessionManager::_processInkboardEvent(Pedro::XmppEvent const& event)
{
Pedro::Element* root = event.getDOM();
if (root == NULL) {
g_warning("Received null DOM; ignoring message.");
return;
}
Pedro::DOMString type = root->getTagAttribute("inkboard", "type");
Pedro::DOMString seq = root->getTagAttribute("inkboard", "seq");
Pedro::DOMString protover = root->getTagAttribute("inkboard", "protocol");
if (type.empty() || seq.empty() || protover.empty()) {
g_warning("Received incomplete Inkboard message (missing type, protocol, or sequence number); ignoring message.");
return;
}
MessageType mtype = static_cast< MessageType >(atoi(type.c_str()));
// Messages that deal with the creation and destruction of sessions should be handled
// here in the SessionManager.
//
// These events are listed below, along with rationale.
//
// - CONNECT_REQUEST_USER: when we begin to process this message, we will not have an
// Inkboard session available to send the message to. Therefore, this message needs
// to be handled by the SessionManager.
//
// - CONNECT_REQUEST_REFUSED_BY_PEER: this message means that the recipient of a
// private invitation refused the invitation. In this case, we need to destroy the
// Inkboard desktop, document, and session associated with that invitation.
// Destruction of these components seems to be more naturally done in the SessionManager
// than in the Inkboard document itself (especially since the document may be associated
// with multiple desktops).
//
// - UNSUPPORTED_PROTOCOL_VERSION: this message means that the recipient of an invitation
// does not support the version of the Inkboard protocol we are using. In this case,
// we have to destroy the Inkboard desktop, document, and session associated with that
// invitation. The rationale for doing it in the SessionManager is the same as that
// given above.
//
// - ALREADY_IN_SESSION: similar rationale to above.
//
// - DISCONNECTED_FROM_USER_SIGNAL: similar rationale to above.
//
//
// All other events can be handled inside an Inkboard session.
// The message we are handling will have come from some Jabber ID. We need to verify
// that the Inkboard session associated with that JID is in the correct state for the
// incoming message (or, in some cases, that the session correctly exists / does not
// exist).
InkboardDocument* doc = getInkboardSession(event.getFrom());
// NOTE: This line refers to a class that hasn't been written yet
// MessageValidityTestResult res = MessageVerifier::verifyMessageValidity(event, mtype, doc);
MessageValidityTestResult res = RESULT_INVALID;
/*
switch (res) {
case RESULT_VALID:
{
switch (mtype) {
case CONNECT_REQUEST:
default:
if (doc != NULL) {
unsigned int seqnum = atoi(seq.c_str());
doc->processInkboardEvent(mtype, seqnum, event.getData());
}
break;
}
break;
}
case RESULT_INVALID:
default:
// FIXME: better warning message
g_warning("Received message in invalid context.");
break;
}
*/
}
void
SessionManager::_handleSessionEvent(Message::Wrapper mtype, Pedro::XmppEvent const& event)
{
/*
switch (mtype) {
case CONNECT_REQUEST:
_handleIncomingInvitation(event.getFrom());
break;
case INVITATION_DECLINE:
_handleInvitationResponse(event.getFrom(), DECLINE_INVITATION);
break;
default:
break;
}
*/
}
void
SessionManager::_handleIncomingInvitation(Glib::ustring const& from)
{
// don't insert duplicate invitations
if (std::find(_pending_invitations.begin(), _pending_invitations.end(), from) != _pending_invitations.end()) {
return;
}
// We need to do the invitation confirm/deny dialog elsewhere --
// when this method is called, we're still executing in Pedro's context,
// which causes issues when we run a dialog main loop.
//
// The invitation handling is done in a poller timeout that executes approximately
// every 50ms. It calls _checkInvitationQueue.
_pending_invitations.push_back(from);
}
void
SessionManager::_handleInvitationResponse(Glib::ustring const& from, InvitationResponses resp)
{
// only handle one response per invitation sender
//
// TODO: this could have one huge bug: say that Alice sends an invite to Bob, but
// Bob is doing something else at the moment and doesn't want to get in an Inkboard
// session. Eve intercepts Bob's "reject invitation" message and passes a
// "accept invitation" message to Alice that comes before Bob's "reject invitation"
// message.
//
// Does XMPP prevent this sort of attack? Need to investigate that.
if (std::find_if(_invitation_responses.begin(), _invitation_responses.end(), CheckInvitationSender(from)) != _invitation_responses.end()) {
return;
}
// We need to do the invitation confirm/deny dialog elsewhere --
// when this method is called, we're still executing in Pedro's context,
// which causes issues when we run a dialog main loop.
//
// The invitation handling is done in a poller timeout that executes approximately
// every 50ms. It calls _checkInvitationResponseQueue.
_invitation_responses.push_back(Invitation_response_type(from, resp));
}
} // namespace Whiteboard
} // namespace Inkscape
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :
|
