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
|
# telepathy-python - Base classes defining the interfaces of the Telepathy framework
#
# Copyright (C) 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 dbus
import dbus.service
from telepathy.constants import (CONN_MGR_PARAM_FLAG_REQUIRED,
CONN_MGR_PARAM_FLAG_SECRET,
CONN_MGR_PARAM_FLAG_HAS_DEFAULT)
from telepathy.errors import InvalidArgument, NotImplemented
from telepathy.interfaces import PROTOCOL
from telepathy.server.properties import DBusProperties
from telepathy._generated.Protocol import Protocol as _Protocol
class Protocol(_Protocol, DBusProperties):
""" Class members to override in CM implementations : """
_english_name = ""
_icon = ""
_vcard_field = ""
# List of Requestable_Channel_Class struct
_requestable_channel_classe = []
_optional_parameters = {}
_mandatory_parameters = {}
_secret_parameters = {}
_parameter_defaults = {}
def __init__(self, connection_manager, proto):
escaped_name = proto.replace("-", "_")
bus_name = connection_manager._name
object_path = connection_manager._object_path + "/" + escaped_name
_Protocol.__init__(self, bus_name, object_path)
self._proto = proto
self._interfaces = set()
DBusProperties.__init__(self)
self._implement_property_get(PROTOCOL, {
'EnglishName': lambda: self.english_name,
'Icon': lambda: self.icon,
'VCardField': lambda: self.vcard_field,
'Interfaces': lambda: self.interfaces,
'ConnectionInterfaces': lambda: self.connection_interfaces,
'RequestableChannelClasses': lambda: self.requestable_channels,
'Parameters': lambda: self.parameters
})
@property
def english_name(self):
return dbus.String(self._english_name)
@property
def icon(self):
return dbus.String(self._icon)
@property
def vcard_field(self):
return dbus.String(self._vcard_field)
@property
def interfaces(self):
return dbus.Array(self._interfaces, signature='s')
@property
def connection_interfaces(self):
return dbus.Array(self._supported_interfaces, signature='s')
@property
def requestable_channels(self):
return dbus.Array(self._requestable_channel_classes,
signature='(a{sv}as)')
@property
def parameters(self):
parameters = []
secret_parameters = self._secret_parameters
mandatory_parameters = self._mandatory_parameters
optional_parameters = self._optional_parameters
default_parameters = self._parameter_defaults
for parameter_name, parameter_type in mandatory_parameters.iteritems():
flags = CONN_MGR_PARAM_FLAG_REQUIRED
if parameter_name in secret_parameters:
flags |= CONN_MGR_PARAM_FLAG_SECRET
param = (parameter_name, flags, parameter_type, '')
parameters.append(param)
for parameter_name, parameter_type in optional_parameters.iteritems():
flags = 0
default = ''
if parameter_name in secret_parameters:
flags |= CONN_MGR_PARAM_FLAG_SECRET
if parameter_name in default_parameters:
flags |= CONN_MGR_PARAM_FLAG_HAS_DEFAULT
default = default_parameters[parameter_name]
param = (parameter_name, flags, parameter_type, default)
parameters.append(param)
return dbus.Array(parameters, signature='(susv)')
def check_parameters(self, parameters):
"""
Validate and type check all of the provided parameters, and
check all mandatory parameters are present before creating a
new connection.
Sets defaults according to the defaults if the client has not
provided any.
"""
for (parm, value) in parameters.iteritems():
if parm in self._mandatory_parameters.keys():
sig = self._mandatory_parameters[parm]
elif parm in self._optional_parameters.keys():
sig = self._optional_parameters[parm]
else:
raise InvalidArgument('unknown parameter name %s' % parm)
# we currently support strings, (u)int16/32 and booleans
if sig == 's':
if not isinstance(value, unicode):
raise InvalidArgument('incorrect type to %s parameter, got %s, expected a string' % (parm, type(value)))
elif sig in 'iunq':
if not isinstance(value, (int, long)):
raise InvalidArgument('incorrect type to %s parameter, got %s, expected an int' % (parm, type(value)))
elif sig == 'b':
if not isinstance(value, (bool, dbus.Boolean)):
raise InvalidArgument('incorrect type to %s parameter, got %s, expected an boolean' % (parm, type(value)))
else:
raise TypeError('unknown type signature %s in protocol parameters' % type)
for (parm, value) in self._parameter_defaults.iteritems():
if parm not in parameters:
parameters[parm] = value
missing = set(self._mandatory_parameters.keys()).difference(parameters.keys())
if missing:
raise InvalidArgument('required parameters %s not given' % missing)
def create_connection(self, connection_manager, parameters):
raise NotImplemented('no create_connection for %s' % self._proto)
|
