summaryrefslogtreecommitdiff
path: root/butterfly/capabilities.py
blob: ce893a2dd32eb021671751590ea4c27262bbe0a2 (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
# telepathy-butterfly - an MSN connection manager for Telepathy
#
# Copyright (C) 2009 Collabora Ltd.
#
# 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

import logging
import dbus

import telepathy
import papyon
import papyon.event

from butterfly.util.decorator import async

__all__ = ['ButterflyCapabilities']

logger = logging.getLogger('Butterfly.Capabilities')

class ButterflyCapabilities(
        telepathy.server.ConnectionInterfaceCapabilities,
        telepathy.server.ConnectionInterfaceContactCapabilities,
        papyon.event.ContactEventInterface):

    text_chat_class = \
        ({telepathy.CHANNEL_INTERFACE + '.ChannelType':
              telepathy.CHANNEL_TYPE_TEXT,
          telepathy.CHANNEL_INTERFACE + '.TargetHandleType':
              dbus.UInt32(telepathy.HANDLE_TYPE_CONTACT)},
         [telepathy.CHANNEL_INTERFACE + '.TargetHandle',
          telepathy.CHANNEL_INTERFACE + '.TargetID'])

    audio_chat_class = \
        ({telepathy.CHANNEL_INTERFACE + '.ChannelType':
              telepathy.CHANNEL_TYPE_STREAMED_MEDIA,
          telepathy.CHANNEL_INTERFACE + '.TargetHandleType':
              dbus.UInt32(telepathy.HANDLE_TYPE_CONTACT)},
         [telepathy.CHANNEL_INTERFACE + '.TargetHandle',
          telepathy.CHANNEL_INTERFACE + '.TargetID',
          telepathy.CHANNEL_TYPE_STREAMED_MEDIA + '.InitialAudio'])

    av_chat_class = \
        ({telepathy.CHANNEL_INTERFACE + '.ChannelType':
              telepathy.CHANNEL_TYPE_STREAMED_MEDIA,
          telepathy.CHANNEL_INTERFACE + '.TargetHandleType':
              dbus.UInt32(telepathy.HANDLE_TYPE_CONTACT)},
         [telepathy.CHANNEL_INTERFACE + '.TargetHandle',
          telepathy.CHANNEL_INTERFACE + '.TargetID',
          telepathy.CHANNEL_TYPE_STREAMED_MEDIA + '.InitialAudio',
          telepathy.CHANNEL_TYPE_STREAMED_MEDIA + '.InitialVideo'])

    file_transfer_class = \
        ({telepathy.CHANNEL_INTERFACE + '.ChannelType':
              telepathy.CHANNEL_TYPE_FILE_TRANSFER,
          telepathy.CHANNEL_INTERFACE + '.TargetHandleType':
              dbus.UInt32(telepathy.HANDLE_TYPE_CONTACT)},
         [telepathy.CHANNEL_INTERFACE + '.TargetHandle',
          telepathy.CHANNEL_INTERFACE + '.TargetID',
          telepathy.CHANNEL_TYPE_FILE_TRANSFER + '.Requested',
          telepathy.CHANNEL_TYPE_FILE_TRANSFER + '.Filename',
          telepathy.CHANNEL_TYPE_FILE_TRANSFER + '.Size',
          telepathy.CHANNEL_TYPE_FILE_TRANSFER + '.ContentType'])


    def __init__(self):
        telepathy.server.ConnectionInterfaceCapabilities.__init__(self)
        telepathy.server.ConnectionInterfaceContactCapabilities.__init__(self)
        papyon.event.ContactEventInterface.__init__(self, self.msn_client)

        self._video_clients = []
        self._update_capabilities_calls = []


    ### Events handling ------------------------------------------------------

    # papyon.event.ContactEventInterface
    def on_contact_client_capabilities_changed(self, contact):
        handle = self.ensure_contact_handle(contact)
        if handle == self._self_handle:
            return # don't update our own capabilities using server ones
        self._update_capabilities(handle)
        self._update_contact_capabilities([handle])

    # papyon.event.AddressBookEventInterface
    def on_addressbook_contact_added(self, contact):
        """When we add a contact in our contact list, add the
        default capabilities to the contact"""
        if contact.is_member(papyon.Membership.FORWARD):
            handle = self.ensure_contact_handle(contact)
            self._add_default_capabilities([handle])
            self._update_contact_capabilities([handle])


    ### Capabilities interface -----------------------------------------------

    def _get_capabilities(self, contact):
        gen_caps = 0
        spec_caps = 0
        caps = contact.client_capabilities

        if caps.supports_sip_invite:
            gen_caps |= telepathy.CONNECTION_CAPABILITY_FLAG_CREATE
            gen_caps |= telepathy.CONNECTION_CAPABILITY_FLAG_INVITE
            spec_caps |= telepathy.CHANNEL_MEDIA_CAPABILITY_AUDIO
            spec_caps |= telepathy.CHANNEL_MEDIA_CAPABILITY_NAT_TRAVERSAL_STUN
            if caps.has_webcam:
                spec_caps |= telepathy.CHANNEL_MEDIA_CAPABILITY_VIDEO

        return gen_caps, spec_caps

    def _add_default_capabilities(self, handles):
        """Add the default capabilities to these contacts."""
        ret = []
        for handle in handles:
            new_flag = telepathy.CONNECTION_CAPABILITY_FLAG_CREATE

            ctype = telepathy.CHANNEL_TYPE_TEXT
            diff = self._diff_capabilities(handle, ctype, added_gen=new_flag)
            ret.append(diff)

            ctype = telepathy.CHANNEL_TYPE_FILE_TRANSFER
            diff = self._diff_capabilities(handle, ctype, added_gen=new_flag)
            ret.append(diff)

        self.CapabilitiesChanged(ret)

    def _update_capabilities(self, handle):
        ctype = telepathy.CHANNEL_TYPE_STREAMED_MEDIA

        new_gen, new_spec = self._get_capabilities(handle.contact)
        diff = self._diff_capabilities(handle, ctype, new_gen, new_spec)
        if diff is not None:
            self.CapabilitiesChanged([diff])


    ### ContactCapabilities interface ----------------------------------------

    def AdvertiseCapabilities(self, add, remove):
        for caps, specs in add:
            if caps == telepathy.CHANNEL_TYPE_STREAMED_MEDIA:
                if specs & telepathy.CHANNEL_MEDIA_CAPABILITY_VIDEO:
                    self._msn_client.profile.client_id.has_webcam = True
                    self._msn_client.profile.client_id.supports_rtc_video = True
        for caps in remove:
            if caps == telepathy.CHANNEL_TYPE_STREAMED_MEDIA:
                self._msn_client.profile.client_id.has_webcam = False

        return telepathy.server.ConnectionInterfaceCapabilities.\
            AdvertiseCapabilities(self, add, remove)

    def UpdateCapabilities(self, caps):
        if self._status != telepathy.CONNECTION_STATUS_CONNECTED:
            self._update_capabilities_calls.append(caps)
            return

        # We only care about voip.
        for client, classes, capabilities in caps:
            video = False
            for channel_class in classes:
                # Does this client support video?
                if channel_class[telepathy.CHANNEL_INTERFACE + '.ChannelType'] == \
                        telepathy.CHANNEL_TYPE_STREAMED_MEDIA:
                    video = True
                    break

            if video and client not in self._video_clients:
                self._video_clients.append(client)
            elif not video and client in self._video_clients:
                # *Did* it used to support video?
                self._video_clients.remove(client)

        video = (len(self._video_clients) > 0)
        changed = False

        # We've got no more clients that support video; remove the cap.
        if not video and not self._video_clients:
            self._msn_client.profile.client_id.has_webcam = False
            changed = True

        # We want video.
        if video and (not self._msn_client.profile.client_id.has_webcam or
           not self._msn_client.profile.client_id.supports_rtc_video):
            self._msn_client.profile.client_id.has_webcam = True
            self._msn_client.profile.client_id.supports_rtc_video = True
            changed = True

        # Signal.
        if changed:
            updated = dbus.Dictionary({self._self_handle: self._contact_caps[self._self_handle]},
                signature='ua(a{sv}as)')
            self.ContactCapabilitiesChanged(updated)

    def _get_contact_capabilities(self, contact):
        contact_caps = []
        caps = contact.client_capabilities

        contact_caps.append(self.text_chat_class)
        contact_caps.append(self.file_transfer_class)
        if caps.supports_sip_invite:
            if caps.has_webcam:
                contact_caps.append(self.av_chat_class)
            else:
                contact_caps.append(self.audio_chat_class)

        return contact_caps

    def _update_contact_capabilities(self, handles):
        caps = {}
        for handle in handles:
            caps[handle] = self._get_contact_capabilities(handle.contact)
            self._contact_caps[handle] = caps[handle] # update global dict
        ret = dbus.Dictionary(caps, signature='ua(a{sv}as)')
        self.ContactCapabilitiesChanged(ret)


    ### Initialization -------------------------------------------------------

    @async
    def _populate_capabilities(self):
        """ Add the default capabilities to all contacts in our
        contacts list."""
        handles = set([self._self_handle])
        for contact in self.msn_client.address_book.contacts:
            if contact.is_member(papyon.Membership.FORWARD):
                handle = self.ensure_contact_handle(contact)
                handles.add(handle)
        self._add_default_capabilities(handles)
        self._update_contact_capabilities(handles)

        # These caps were updated before we were online.
        for caps in self._update_capabilities_calls:
            self.UpdateCapabilities(caps)
        self._update_capabilities_calls = []