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
|
# telepathy-python - Base classes defining the interfaces of the Telepathy framework
#
# Copyright (C) 2009-2010 Collabora Limited
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
import warnings
from telepathy.errors import NotImplemented
from telepathy.interfaces import (CHANNEL_INTERFACE,
CHANNEL_TYPE_CONTACT_LIST)
from telepathy.constants import HANDLE_TYPE_NONE
from telepathy.server.handle import NoneHandle
class ChannelManager(object):
def __init__(self, connection):
self._conn = connection
self._requestable_channels = dict()
self._channels = dict()
self._fixed_properties = dict()
self._available_properties = dict()
self._requestables = dict()
def close(self):
"""Close channel manager and all the existing channels."""
for channel_type in self._requestable_channels:
for channels in self._channels[channel_type].values():
for channel in channels:
if channel._type == CHANNEL_TYPE_CONTACT_LIST:
channel.remove_from_connection()
else:
channel.Close()
def remove_channel(self, channel):
"Remove channel from the channel manager"
for channel_type in self._requestable_channels:
for handle, channels in self._channels[channel_type].items():
if channel in channels :
channels.remove(channel)
def _get_type_requested_handle(self, props):
"""Return the type, request and target handle from the requested
properties"""
type = props[CHANNEL_INTERFACE + '.ChannelType']
requested = props[CHANNEL_INTERFACE + '.Requested']
target_handle_type = \
props.get(CHANNEL_INTERFACE + '.TargetHandleType', HANDLE_TYPE_NONE)
if target_handle_type == HANDLE_TYPE_NONE:
handle = NoneHandle()
else:
target_handle = props[CHANNEL_INTERFACE + '.TargetHandle']
handle = self._conn._handles[target_handle_type, target_handle]
return (type, requested, handle)
def existing_channel(self, props):
""" Return a channel corresponding to theses properties if such
one exists, otherwhise return None. Default implementation will
return the last created channel of the same kind identified by
handle and type.
Connection Manager should subclass this function
to implement more appropriate behaviour. """
type, _, handle = self._get_type_requested_handle(props)
if type in self._channels:
if handle in self._channels[type]:
if len(self._channels[type][handle]) > 0:
return self._channels[type][handle][-1]
return None
def channel_exists(self, props):
""" Return True if channel exist with theses props, False otherwhise"""
return self.existing_channel(props) != None
def create_channel_for_props(self, props, signal=True, **args):
"""Create a new channel with theses properties"""
type, _, handle = self._get_type_requested_handle(props)
if type not in self._requestable_channels:
raise NotImplemented('Unknown channel type "%s"' % type)
channel = self._requestable_channels[type](
props, **args)
self._conn.add_channels([channel], signal=signal)
if handle.get_type() != HANDLE_TYPE_NONE and type in self._channels:
self._channels[type].setdefault(handle, []).append(channel)
return channel
def channel_for_props(self, props, signal=True, **args):
channel = self.existing_channel(props)
"""Return an existing channel with theses properties if it already
exists, otherwhise return a new one"""
if channel:
return channel
else:
return self.create_channel_for_props(props, signal, **args)
# Should use implement_channel_classes instead.
def _implement_channel_class(self, type, make_channel, fixed, available):
"""Implement channel types in the channel manager, and add one channel
class that is retrieved in RequestableChannelClasses.
self.implement_channel_classes should be used instead, as it allows
implementing multiple channel classes."""
warnings.warn('deprecated in favour of implement_channel_classes',
DeprecationWarning)
self._requestable_channels[type] = make_channel
self._channels.setdefault(type, {})
self._fixed_properties[type] = fixed
self._available_properties[type] = available
# Use this function instead of _implement_channel_class.
def implement_channel_classes(self, type, make_channel, classes):
"""Implement channel types in the channel manager, and add channel
classes that are retrieved in RequestableChannelClasses.
@type: the channel type
@make_channel: a function to call which returns a Channel object
@classes: a list of channel classes. E.g.
[ ( { '...ChannelType': '...Text', '...TargetHandleType': HANDLE_TYPE_CONTACT },
['...TargetHandle'] )
]
See the spec for more documentation on the
Requestable_Channel_Class struct.
"""
self._requestable_channels[type] = make_channel
self._channels.setdefault(type, {})
self._requestables[type] = classes
def get_requestable_channel_classes(self):
"""Return all the channel types that can be created"""
retval = []
for channel_type in self._requestable_channels:
retval.extend(self._requestables.get(channel_type, []))
# _implement_channel_class was used.
if channel_type in self._fixed_properties:
retval.append((self._fixed_properties[channel_type],
self._available_properties.get(channel_type, [])))
return retval
|
