ODF

Version 13 (Adrian Georgescu, 11/04/2014 01:31 pm)

1 1 Adrian Georgescu
h1. ODF integration
2 1 Adrian Georgescu
3 5 Adrian Georgescu
This documents layout the changes required to support a new type of stream for collaborative editing.
4 1 Adrian Georgescu
5 6 Adrian Georgescu
h2. SDK changes
6 1 Adrian Georgescu
7 6 Adrian Georgescu
h3. Signaling
8 6 Adrian Georgescu
9 12 Adrian Georgescu
There is no need to alter anything related to SIP signalling. The SIP call id, which is unique for each session can be used as an identifier to group data related to same session inside the media streams. 
10 1 Adrian Georgescu
11 6 Adrian Georgescu
h3. Media
12 1 Adrian Georgescu
13 11 Adrian Georgescu
Media requires reliable transport which can only be MSRP. This provides reliable end-to-end transmission, TLS encryption and NAT traversal. Optional, OTR end-to-end encryption can be used too.
14 11 Adrian Georgescu
15 7 Adrian Georgescu
h4. Variant 1
16 7 Adrian Georgescu
17 10 Adrian Georgescu
This by far the simplest way. Establish a standard chat stream and add _'application/odf+xml'_ to the lists of supported payloads by subclassing the standard Chat stream from the SDK. 
18 8 Adrian Georgescu
19 1 Adrian Georgescu
<pre>
20 10 Adrian Georgescu
class ODFChatStream(ChatStream):
21 10 Adrian Georgescu
    accept_types = ['message/cpim', 'text/*', 'application/im-iscomposing+xml', 'application/odf+xml']
22 1 Adrian Georgescu
</pre>
23 10 Adrian Georgescu
24 11 Adrian Georgescu
Then during the session, send the data over the stream using:
25 10 Adrian Georgescu
26 10 Adrian Georgescu
<pre>
27 10 Adrian Georgescu
self.stream.send_message(data, content_type='application/odf+xml', timestamp=ISOTimestamp.now())
28 10 Adrian Georgescu
</pre>
29 10 Adrian Georgescu
30 10 Adrian Georgescu
Optionally add an attribute to the MSRP stream to signal the support for this feature:
31 10 Adrian Georgescu
32 10 Adrian Georgescu
<pre>
33 10 Adrian Georgescu
class ODFChatStream(ChatStream):
34 10 Adrian Georgescu
    accept_types = ['message/cpim', 'text/*', 'application/im-iscomposing+xml', 'application/odf+xml']
35 8 Adrian Georgescu
    def _create_local_media(self, uri_path):
36 1 Adrian Georgescu
        local_media = super(BlinkChatStream, self)._create_local_media(uri_path)
37 12 Adrian Georgescu
        local_media.attributes.append(SDPAttribute('features', 'odf-editor'))
38 1 Adrian Georgescu
        return local_media
39 9 Adrian Georgescu
</pre>
40 1 Adrian Georgescu
41 12 Adrian Georgescu
After session negotiation, the clients can invoke their corespondent GUI elements related to the collaborative editing when detecting _odf-editor_ feature in the remote stream. This approach will work with any MSRP chat implementation, the data will piggy-back on top of an existent chat stream in a non-disruptive way, which makes development of other end-points easy as no internal mechanisms of SIP session session initiation must be done.
42 7 Adrian Georgescu
43 1 Adrian Georgescu
h4. Variant 2
44 7 Adrian Georgescu
45 10 Adrian Georgescu
Create a complete new media type based on MSRP protocol similar to file-transfer or screen sharing. See SIP SIMPLE Client SDK MSRP streams definition:
46 1 Adrian Georgescu
47 1 Adrian Georgescu
<pre>
48 1 Adrian Georgescu
sipsimple/streams/msrp.py
49 1 Adrian Georgescu
</pre>
50 7 Adrian Georgescu
51 3 Adrian Georgescu
Example of a new type of stream
52 3 Adrian Georgescu
53 3 Adrian Georgescu
<pre>
54 3 Adrian Georgescu
class ODFStream(MSRPStreamBase):
55 3 Adrian Georgescu
    type = 'odf'
56 1 Adrian Georgescu
57 3 Adrian Georgescu
    media_type = 'odf'
58 3 Adrian Georgescu
    accept_types = ['application/odf+xml']
59 3 Adrian Georgescu
    accept_wrapped_types = ['*']
60 3 Adrian Georgescu
</pre>
61 1 Adrian Georgescu
62 1 Adrian Georgescu
Once established, the MSRP stream can cary back and forth payloads of the types specified in the stream definition. Is up to the end-points to handle the actual payloads and match various files shared through this mechanism over the same session. The SIP session id can be used to group together various flows within the same stream.
63 7 Adrian Georgescu
64 13 Adrian Georgescu
This mechanism will require similar changes in other clients that wish to implement this feature, it is more complex but have the advantage that it can be negotiated by the use of a SIP Invite where the remote party can accept or reject the session request.
65 1 Adrian Georgescu
66 6 Adrian Georgescu
h3. Presence
67 1 Adrian Georgescu
68 13 Adrian Georgescu
Optionally, SIP end-points supporting this feature can advertise this capability by publishing it using the SIP SIMPLE Presence payload. For this, the end-point capabilities must be extended to support odf as a different media type.
69 1 Adrian Georgescu
70 1 Adrian Georgescu
<pre>
71 4 Adrian Georgescu
sipsimple/payloads/caps.py
72 1 Adrian Georgescu
</pre>
73 6 Adrian Georgescu
74 6 Adrian Georgescu
h2. GUI changes
75 6 Adrian Georgescu
76 12 Adrian Georgescu
The GUI must handle sessions for incoming and outgoing media stream defined above by creating its own controller that it is invoked either when negotiating the session, when a proper payload arrives over the chat channel or when user clicks in the GUI to start editing.