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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
|
# Copyright (C) 2007, Red Hat, Inc.
# Copyright (C) 2007, 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
import gobject
import dbus
import dbus.service
from dbus.gobject_service import ExportedGObject
from sugar import util
import logging
from telepathy.client import Channel
from telepathy.constants import (CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES,
PROPERTY_FLAG_WRITE, HANDLE_TYPE_ROOM)
from telepathy.interfaces import (CHANNEL_INTERFACE, CHANNEL_INTERFACE_GROUP,
CHANNEL_TYPE_TEXT, CONN_INTERFACE,
PROPERTIES_INTERFACE)
from psutils import (NotFoundError, NotJoinedError, WrongConnectionError,
throw_into_callback)
CONN_INTERFACE_ACTIVITY_PROPERTIES = 'org.laptop.Telepathy.ActivityProperties'
_ACTIVITY_PATH = "/org/laptop/Sugar/Presence/Activities/"
_ACTIVITY_INTERFACE = "org.laptop.Sugar.Presence.Activity"
_PROP_ID = "id"
_PROP_NAME = "name"
_PROP_COLOR = "color"
_PROP_TYPE = "type"
_PROP_TAGS = "tags"
_PROP_VALID = "valid"
_PROP_LOCAL = "local"
_PROP_JOINED = "joined"
_PROP_PRIVATE = "private"
_PROP_CUSTOM_PROPS = "custom-props"
_logger = logging.getLogger('s-p-s.activity')
class Activity(ExportedGObject):
"""Represents a shared activity seen on the network, or a local activity
that has been, or will be, shared onto the network.
The activity might be public, restricted to a group, or invite-only.
"""
__gtype_name__ = "Activity"
__gsignals__ = {
'validity-changed':
# The activity's validity has changed.
# An activity is valid if its name, color, type and ID have been
# set.
# Arguments:
# validity: bool
(gobject.SIGNAL_RUN_FIRST, None, [bool]),
'disappeared':
# Nobody is in this activity any more.
# No arguments.
(gobject.SIGNAL_RUN_FIRST, None, []),
}
__gproperties__ = {
_PROP_ID : (str, None, None, None,
gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY),
_PROP_NAME : (object, None, None, gobject.PARAM_READWRITE),
_PROP_TAGS : (object, None, None, gobject.PARAM_READWRITE),
_PROP_COLOR : (str, None, None, None, gobject.PARAM_READWRITE),
_PROP_TYPE : (str, None, None, None, gobject.PARAM_READWRITE),
_PROP_PRIVATE : (bool, None, None, True, gobject.PARAM_READWRITE),
_PROP_VALID : (bool, None, None, False, gobject.PARAM_READABLE),
_PROP_LOCAL : (bool, None, None, False,
gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY),
_PROP_JOINED : (bool, None, None, False, gobject.PARAM_READABLE),
_PROP_CUSTOM_PROPS : (object, None, None,
gobject.PARAM_READWRITE |
gobject.PARAM_CONSTRUCT_ONLY)
}
_RESERVED_PROPNAMES = __gproperties__.keys()
def __init__(self, bus, object_id, ps, tp, room, **kwargs):
"""Initializes the activity and sets its properties to default values.
:Parameters:
`bus` : dbus.bus.BusConnection
A connection to the D-Bus session bus
`object_id` : int
PS ID for this activity, used to construct the object-path
`ps` : presenceservice.PresenceService
The presence service
`tp` : server plugin
The server plugin object (stands for "telepathy plugin")
`room` : int or long
The handle (of type HANDLE_TYPE_ROOM) of the activity on
the server plugin
:Keywords:
`id` : str
The globally unique activity ID (required)
`name` : unicode
Human-readable title for the activity
`tags` : unicode
Tags for this activity
`color` : str
Activity color in #RRGGBB,#RRGGBB (stroke,fill) format
`type` : str
D-Bus service name representing the activity type
`local : bool
If True, this activity was initiated locally and is not
(yet) advertised on the network
(FIXME: is this description right?)
`private` : bool
If True, this activity is not advertised to everyone
`custom-props` : dict
Activity-specific properties
"""
if not object_id or not isinstance(object_id, int):
raise ValueError("object id must be a valid number")
if not tp:
raise ValueError("telepathy CM must be valid")
self._ps = ps
self._object_id = object_id
self._object_path = dbus.ObjectPath(_ACTIVITY_PATH +
str(self._object_id))
# The buddies really in the channel, which we can see directly because
# we've joined. If _joined is False, this will be incomplete.
# { member handle, possibly channel-specific => Buddy }
self._handle_to_buddy = {}
# The buddies the PS thinks are in the channel. If _joined is True
# this is kept in sync with reality. If _joined is False this is
# based on buddies' claimed activities.
self._buddies = set()
# Equal to (self._self_handle in self._handle_to_buddy.keys())
self._joined = False
self._join_cb = None
self._join_err_cb = None
self._join_is_sharing = False
self._private = True
self._leave_cb = None
self._leave_err_cb = None
# the telepathy client
self._tp = tp
self._room = room
self._self_handle = None
self._text_channel = None
self._text_channel_group_flags = 0
#: list of SignalMatch associated with the text channel, or None
self._text_channel_matches = None
self._valid = False
self._id = None
self._actname = None
self._color = None
self._private = True
self._tags = u''
self._local = False
self._type = None
self._custom_props = {}
# ensure no reserved property names are in custom properties
cprops = kwargs.get(_PROP_CUSTOM_PROPS)
if cprops is not None:
(rprops, cprops) = self._split_properties(cprops)
if len(rprops.keys()) > 0:
raise ValueError("Cannot use reserved property names '%s'"
% ", ".join(rprops.keys()))
if not kwargs.get(_PROP_ID):
raise ValueError("activity id is required")
if not util.validate_activity_id(kwargs[_PROP_ID]):
raise ValueError("Invalid activity id '%s'" % kwargs[_PROP_ID])
ExportedGObject.__init__(self, bus, self._object_path,
gobject_properties=kwargs)
if self._local and not self._valid:
raise RuntimeError("local activities require color, type, and "
"name")
# If not yet valid, query activity properties
if not self._valid:
assert self._room, self._room
conn = self._tp.get_connection()
if CONN_INTERFACE_ACTIVITY_PROPERTIES not in conn:
# we should already have warned about this somewhere -
# certainly, don't emit a warning per activity!
return
def got_properties_err(e):
_logger.warning('Failed to get initial activity properties '
'for %s: %s', self._id, e)
conn[CONN_INTERFACE_ACTIVITY_PROPERTIES].GetProperties(self._room,
reply_handler=self.set_properties,
error_handler=got_properties_err)
@property
def room_details(self):
"""Return the Telepathy plugin on which this Activity can be joined
and the handle of the room representing it.
"""
return (self._tp, self._room)
def do_get_property(self, pspec):
"""Gets the value of a property associated with this activity.
pspec -- Property specifier
returns The value of the given property.
"""
if pspec.name == _PROP_ID:
return self._id
elif pspec.name == _PROP_NAME:
return self._actname
elif pspec.name == _PROP_TAGS:
return self._tags
elif pspec.name == _PROP_COLOR:
return self._color
elif pspec.name == _PROP_TYPE:
return self._type
elif pspec.name == _PROP_PRIVATE:
return self._private
elif pspec.name == _PROP_VALID:
return self._valid
elif pspec.name == _PROP_JOINED:
return self._joined
elif pspec.name == _PROP_LOCAL:
return self._local
def do_set_property(self, pspec, value):
"""Sets the value of a property associated with this activity.
pspec -- Property specifier
value -- Desired value
Note that the "type" property can be set only once; attempting to set
it to something different later will raise a RuntimeError.
"""
if pspec.name == _PROP_ID:
if self._id:
raise RuntimeError("activity ID is already set")
self._id = value
elif pspec.name == _PROP_NAME:
self._actname = unicode(value)
elif pspec.name == _PROP_COLOR:
self._color = value
elif pspec.name == _PROP_PRIVATE:
self._private = value
elif pspec.name == _PROP_TAGS:
self._tags = unicode(value)
elif pspec.name == _PROP_TYPE:
if self._type:
raise RuntimeError("activity type is already set")
self._type = value
elif pspec.name == _PROP_JOINED:
self._joined = value
elif pspec.name == _PROP_LOCAL:
self._local = value
elif pspec.name == _PROP_CUSTOM_PROPS:
if not value:
value = {}
(rprops, cprops) = self._split_properties(value)
self._custom_props = {}
for (key, dvalue) in cprops.items():
self._custom_props[str(key)] = str(dvalue)
self._update_validity()
def _update_validity(self):
"""Sends a "validity-changed" signal if this activity's validity has
changed.
Determines whether this activity's status has changed from valid to
invalid, or invalid to valid, and emits a "validity-changed" signal
if either is true. "Valid" means that the object's type, ID, name,
colour and type properties have all been set to something valid
(i.e., not "None").
"""
try:
old_valid = self._valid
if (self._color is not None and self._actname is not None
and self._id is not None and self._type is not None):
self._valid = True
else:
self._valid = False
if old_valid != self._valid:
self.emit("validity-changed", self._valid)
if self._valid:
# Pretend everyone joined
for buddy in self._buddies:
self.BuddyJoined(buddy.object_path())
else:
# Pretend everyone left
for buddy in self._buddies:
self.BuddyLeft(buddy.object_path())
except AttributeError:
self._valid = False
# dbus signals
@dbus.service.signal(_ACTIVITY_INTERFACE,
signature="o")
def BuddyJoined(self, buddy_path):
"""Generates DBUS signal when a buddy joins this activity.
buddy_path -- DBUS path to buddy object
"""
_logger.debug('BuddyJoined: %s', buddy_path)
@dbus.service.signal(_ACTIVITY_INTERFACE,
signature="o")
def BuddyLeft(self, buddy_path):
"""Generates DBUS signal when a buddy leaves this activity.
buddy_path -- DBUS path to buddy object
"""
_logger.debug('BuddyLeft: %s', buddy_path)
@dbus.service.signal(_ACTIVITY_INTERFACE,
signature="a{sv}")
def PropertiesChanged(self, properties):
"""Emits D-Bus signal when properties of this activity change.
The properties dict is the same as for GetProperties, but omits
properties that have not actually changed.
"""
_logger.debug('Emitting PropertiesChanged: %r', properties)
@dbus.service.signal(_ACTIVITY_INTERFACE,
signature="o")
def NewChannel(self, channel_path):
"""Generates DBUS signal when a new channel is created for this
activity.
channel_path -- Object path of the new Telepathy channel
"""
_logger.debug('Emitting NewChannel(%r)', channel_path)
# dbus methods
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="a{sv}")
def GetProperties(self):
"""D-Bus method to get this activity's properties.
The keys of the dict are defined by Presence Service. Currently
the possible keys are:
`private` : bool
If False, the activity is advertised to everyone
`name` : unicode
The name of the activity - '' if not known yet
`tags` : unicode
The activity's tags (initially '')
`color` : string of the form #112233,#456789
The activity's icon color - '' if not known yet
`type` : string in the same format as a D-Bus well-known name
The activity type (cannot change) - '' if not known yet
`id` : string
The activity ID (cannot change) - '' if not known yet
"""
ret = {_PROP_PRIVATE: self._private,
_PROP_NAME: self._actname or u'',
_PROP_TAGS: self._tags,
_PROP_COLOR: self._color or '',
_PROP_TYPE: self._type or '',
_PROP_ID: self._id or '',
}
_logger.debug('%r', ret)
return ret
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="s")
def GetId(self):
"""DBUS method to get this activity's (randomly generated) unique ID
:Returns: Activity ID as a string
"""
return self._id or ''
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="s")
def GetColor(self):
"""DBUS method to get this activity's colour
:Returns: Activity colour as a string in the format #RRGGBB,#RRGGBB
"""
return self._color or ''
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="s")
def GetType(self):
"""DBUS method to get this activity's type
:Returns: Activity type as a string, in the same form as a D-Bus
well-known name
"""
return self._type or ''
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature='os', out_signature='',
async_callbacks=('async_cb', 'async_err_cb'))
def Invite(self, buddy_path, message, async_cb, async_err_cb):
"""Invite a buddy to join this activity if they are not already in it.
:Parameters:
`buddy` : dbus.ObjectPath
The buddy to be invited
`message` : dbus.String
A message to send to the buddy
:Raises NotJoinedError: if we're not in the activity ourselves
:Raises NotFoundError: if there is no such buddy
:Raises WrongConnectionError: if the buddy is not visible on that
Telepathy connection
:Raises telepathy.errors.PermissionDenied: if we can't invite the buddy
"""
if not self._joined:
_logger.debug('Not inviting %s into %s: I am not a member',
buddy_path, self._id)
throw_into_callback(async_err_cb,
NotJoinedError("Can't invite buddies into an "
"activity you haven't yourself "
"joined"))
return
assert self._tp is not None
assert self._text_channel is not None
buddy = self._ps.get_buddy_by_path(buddy_path)
if buddy is None:
_logger.debug('Not inviting nonexistent buddy %s', buddy_path)
throw_into_callback(async_err_cb,
NotFoundError('Buddy not found: %s' % buddy_path))
return
if buddy in self._buddies:
# nothing to do
_logger.debug('Not inviting %s into %s: already a member',
buddy_path, self._id)
async_cb()
return
# actually invite them
buddy_ident = buddy.get_identifier_by_plugin(self._tp)
if buddy_ident is None:
conn_path = self._tp.get_connection().object_path
_logger.debug('Activity %s is on connection %s but buddy %s is '
'not', self._id, conn_path, buddy_path)
throw_into_callback(async_err_cb,
WrongConnectionError('Buddy %s cannot be '
'invited to activity %s: the buddy is not on the '
'Telepathy connection %s'
% (buddy_path, self._id, conn_path)))
else:
_logger.debug('Inviting buddy %s to activity %s via handle #%d '
'<%s>', buddy_path, self._id, buddy_ident[0],
buddy_ident[1])
self._text_channel.AddMembers([buddy_ident[0]], message,
dbus_interface=CHANNEL_INTERFACE_GROUP,
reply_handler=async_cb,
error_handler=lambda e:
throw_into_callback(async_err_cb, e))
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="",
async_callbacks=('async_cb', 'async_err_cb'))
def Join(self, async_cb, async_err_cb):
"""DBUS method for the local user to attempt to join the activity
async_cb -- Callback method to be called if join attempt is successful
async_err_cb -- Callback method to be called if join attempt is
unsuccessful
"""
self.join(async_cb, async_err_cb, False)
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="",
async_callbacks=('async_cb', 'async_err_cb'))
def Leave(self, async_cb, async_err_cb):
"""DBUS method to for the local user to leave the shared activity
async_cb -- Callback method to be called if join attempt is successful
async_err_cb -- Callback method to be called if join attempt is
unsuccessful
"""
self.leave(async_cb, async_err_cb)
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="ao")
def GetJoinedBuddies(self):
"""DBUS method to return a list of valid buddies who are joined in
this activity
:Returns:
A list of buddy object paths corresponding to those buddies
in this activity who are 'valid' (i.e. for whom we have complete
information)
"""
ret = []
for buddy in self._buddies:
if buddy.props.valid:
ret.append(buddy.object_path())
return ret
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="soao")
def GetChannels(self):
"""DBUS method to get the list of channels associated with this
activity
:Returns:
a tuple containing:
- the D-Bus well-known service name of the connection
(FIXME: this is redundant; in Telepathy it can be derived
from that of the connection)
- the D-Bus object path of the connection
- a list of D-Bus object paths representing the channels
associated with this activity
"""
return self.get_channels()
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature='a{sv}', out_signature='')
def SetProperties(self, new_props):
"""D-Bus method to update the activity's properties.
The parameter has the same keys as for GetProperties(); missing
keys are treated as unchanged.
"""
if not self._joined:
raise NotJoinedError('Not in activity %s' % self._id)
changed = set()
val = new_props.pop(_PROP_TYPE, None)
if val is not None:
if self._type != val:
raise ValueError('"type" property may not change')
val = new_props.pop(_PROP_ID, None)
if val is not None:
if self._id != val:
raise ValueError('"id" property may not change')
val = new_props.pop(_PROP_PRIVATE, None)
if val is not None:
if not isinstance(val, (bool, dbus.Boolean)):
raise ValueError('"private" property must be boolean')
if self._private != val:
self._private = val
changed.add(_PROP_PRIVATE)
val = new_props.pop(_PROP_NAME, None)
if val is not None:
if not isinstance(val, unicode):
raise ValueError('"name" property must be unicode string')
if self._actname != val:
self._actname = val
changed.add(_PROP_NAME)
val = new_props.pop(_PROP_TAGS, None)
if val is not None:
if not isinstance(val, unicode):
raise ValueError('"tags" property must be unicode string')
if self._tags != val:
self._tags = val
changed.add(_PROP_TAGS)
val = new_props.pop(_PROP_COLOR, None)
if val is not None:
if not isinstance(val, unicode):
raise ValueError('"color" property must be string')
val = val.decode('ascii')
if self._color != val:
self._color = val
changed.add(_PROP_COLOR)
if changed:
# FIXME: pass SetProperties errors back to caller too
self.send_properties(changed)
if new_props:
raise ValueError('Unknown properties: %s' % new_props.keys())
@dbus.service.method(_ACTIVITY_INTERFACE,
in_signature="", out_signature="s")
def GetName(self):
"""DBUS method to get this activity's name
returns Activity name
"""
return self._actname or u''
# methods
def object_path(self):
"""Retrieves our dbus.ObjectPath object
returns DBUS ObjectPath object
"""
return self._object_path
def get_joined_buddies(self):
"""Local method to return a list of valid buddies who are joined in
this activity
This method is called by the PresenceService on the local machine.
returns A list of buddy objects
"""
ret = []
for buddy in self._buddies:
if buddy.props.valid:
ret.append(buddy)
return ret
def buddy_apparently_joined(self, buddy):
"""Adds a buddy to this activity and sends a BuddyJoined signal,
unless we can already see who's in the activity by being in it
ourselves.
buddy -- Buddy object representing the buddy being added
Adds a buddy to this activity if the buddy is not already in the
buddy list.
If this activity is "valid", a BuddyJoined signal is also sent.
This method is called by the PresenceService on the local machine.
"""
if self._joined:
_logger.debug("Ignoring alleged join to activity %s that I'm in: "
"I can already see who's there", self._id)
else:
_logger.debug("%s says they joined activity %s that I'm not in",
buddy.props.objid, self._id)
self._add_buddies((buddy,))
def _add_buddies(self, buddies):
buddies = set(buddies)
_logger.debug("Adding buddies: %r", buddies)
# disregard any who are already there
buddies -= self._buddies
self._buddies |= buddies
for buddy in buddies:
buddy.add_activity(self)
if self._valid:
self.BuddyJoined(buddy.object_path())
else:
_logger.debug('Suppressing BuddyJoined: activity not "valid"')
def _remove_buddies(self, buddies):
buddies = set(buddies)
_logger.debug("Removing buddies: %r", buddies)
# disregard any who are not already there
buddies &= self._buddies
self._buddies -= buddies
for buddy in buddies:
buddy.remove_activity(self)
if self._valid:
self.BuddyLeft(buddy.object_path())
else:
_logger.debug('Suppressing BuddyLeft: activity not "valid"')
if not self._buddies:
self.emit('disappeared')
def buddy_apparently_left(self, buddy):
"""Removes a buddy from this activity and sends a BuddyLeft signal,
unless we can already see who's in the activity by being in it
ourselves.
buddy -- Buddy object representing the buddy being removed
Removes a buddy from this activity if the buddy is in the buddy list.
If this activity is "valid", a BuddyLeft signal is also sent.
This method is called by the PresenceService on the local machine.
"""
if not self._joined:
self._remove_buddies((buddy,))
def _text_channel_group_flags_changed_cb(self, added, removed):
self._text_channel_group_flags |= added
self._text_channel_group_flags &= ~removed
def _clean_up_matches(self):
matches = self._text_channel_matches
self._text_channel_matches = []
if matches is not None:
for match in matches:
match.remove()
def _joined_cb(self):
"""XXX - not documented yet
"""
self._ps.owner.add_owner_activity(self._tp, self._id, self._room)
verb = self._join_is_sharing and 'Share' or 'Join'
try:
if self._join_is_sharing:
self.send_properties()
self._ps.owner.add_activity(self)
self._ps.owner.set_properties({'current-activity': self.props.id})
self._join_cb()
_logger.debug("%s of activity %s succeeded" % (verb, self._id))
except Exception, e:
self._join_failed_cb(e)
self._join_cb = None
self._join_err_cb = None
def _join_failed_cb(self, e):
verb = self._join_is_sharing and 'Share' or 'Join'
_logger.debug("%s of activity %s failed: %s" % (verb, self._id, e))
throw_into_callback(self._join_err_cb, e)
self._join_cb = None
self._join_err_cb = None
def _join_activity_channel_props_listed_cb(self, prop_specs):
# FIXME: invite-only ought to be set on private activities; but
# since only the owner can change invite-only, that would break
# activity scope changes.
props = {
'anonymous': False, # otherwise buddy resolution breaks
'invite-only': False, # anyone who knows about the channel can join
'invite-restricted': False, # so non-owners can invite others
'persistent': False, # vanish when there are no members
'private': True, # don't appear in server room lists
}
props_to_set = []
for ident, name, sig, flags in prop_specs:
value = props.pop(name, None)
if value is not None:
if flags & PROPERTY_FLAG_WRITE:
props_to_set.append((ident, value))
# FIXME: else error, but only if we're creating the room?
# FIXME: if props is nonempty, then we want to set props that aren't
# supported here - raise an error?
if props_to_set:
self._text_channel[PROPERTIES_INTERFACE].SetProperties(
props_to_set, reply_handler=self._joined_cb,
error_handler=self._join_failed_cb)
else:
self._joined_cb()
def _join_activity_create_channel_cb(self, chan_path):
text_channel = Channel(self._tp.get_connection().service_name,
chan_path)
self_ident = self._ps.owner.get_identifier_by_plugin(self._tp)
assert self_ident is not None
self._text_channel = text_channel
self._handle_to_buddy = {}
self.NewChannel(text_channel.object_path)
self._clean_up_matches()
m = self._text_channel[CHANNEL_INTERFACE].connect_to_signal('Closed',
self._text_channel_closed_cb)
self._text_channel_matches.append(m)
# FIXME: cope with non-Group channels here if we want to support
# non-OLPC-compatible IMs
group = text_channel[CHANNEL_INTERFACE_GROUP]
def got_all_members(members, local_pending, remote_pending):
if members:
self._text_channel_members_changed_cb('', members, (),
(), (), 0, 0)
if self_ident[0] in local_pending:
_logger.debug('I am local pending - entering room')
group.AddMembers([self_ident[0]], '',
reply_handler=lambda: None,
error_handler=self._join_failed_cb)
elif self._self_handle in local_pending:
_logger.debug('I am local pending with channel-specific '
'handle - entering room')
group.AddMembers([self._self_handle], '',
reply_handler=lambda: None,
error_handler=self._join_failed_cb)
elif self._self_handle in members:
_logger.debug('I am already in the room')
assert self._joined # set by _text_channel_members_changed_cb
def got_group_flags(flags):
self._text_channel_group_flags = flags
# by the time we hook this, we need to know the group flags
m = group.connect_to_signal('MembersChanged',
self._text_channel_members_changed_cb)
self._text_channel_matches.append(m)
# bootstrap by getting the current state. This is where we find
# out whether anyone was lying to us in their PEP info
group.GetAllMembers(reply_handler=got_all_members,
error_handler=self._join_failed_cb)
def got_self_handle(self_handle):
self._self_handle = self_handle
self._text_channel_group_flags = 0
m = group.connect_to_signal('GroupFlagsChanged',
self._text_channel_group_flags_changed_cb)
self._text_channel_matches.append(m)
group.GetGroupFlags(reply_handler=got_group_flags,
error_handler=self._join_failed_cb)
group.GetSelfHandle(reply_handler=got_self_handle,
error_handler=self._join_failed_cb)
def _join_activity_got_handles_cb(self, handles):
assert len(handles) == 1
self._room = handles[0]
conn = self._tp.get_connection()
conn[CONN_INTERFACE].RequestChannel(CHANNEL_TYPE_TEXT,
HANDLE_TYPE_ROOM, self._room, True,
reply_handler=self._join_activity_create_channel_cb,
error_handler=self._join_failed_cb)
def join(self, async_cb, async_err_cb, sharing, private=True):
"""Local method for the local user to attempt to join the activity.
async_cb -- Callback method to be called with no parameters
if join attempt is successful
async_err_cb -- Callback method to be called with an Exception
parameter if join attempt is unsuccessful
sharing -- bool: True if sharing, False if joining
private -- bool: True if by invitation, False if Advertising
The two callbacks are passed to the server_plugin ("tp") object,
which in turn passes them back as parameters in a callback to the
_joined_cb method; this callback is set up within this method.
"""
_logger.debug("Starting share/join of activity %s", self._id)
if self._joined:
throw_into_callback(async_err_cb,
RuntimeError("Already joined activity %s" % self._id))
return
if self._join_cb is not None:
# FIXME: or should we trigger all the attempts?
throw_into_callback(async_err_cb,
RuntimeError('Already trying to join activity %s'
% self._id))
return
self._join_cb = async_cb
self._join_err_cb = async_err_cb
self._join_is_sharing = sharing
self._private = private
if self._room:
# we already know what the room is => we must be joining someone
# else's activity?
self._join_activity_got_handles_cb((self._room,))
elif self._local:
# we need to create a room
conn = self._tp.get_connection()
conn[CONN_INTERFACE].RequestHandles(HANDLE_TYPE_ROOM,
[self._tp.suggest_room_for_activity(self._id)],
reply_handler=self._join_activity_got_handles_cb,
error_handler=self._join_failed_cb)
else:
throw_into_callback(async_err_cb,
RuntimeError("Don't know what room to join for "
"non-local activity %s" % self._id))
_logger.debug("triggered share/join attempt on activity %s", self._id)
def get_channels(self):
"""Local method to get the list of channels associated with this
activity
returns XXX - expected a list of channels, instead returning a tuple?
"""
conn = self._tp.get_connection()
# FIXME add tubes and others channels
channels = []
if self._text_channel is not None:
channels.append(self._text_channel.object_path)
return (str(conn.service_name), conn.object_path, channels)
def leave(self, async_cb, async_err_cb):
"""Local method for the local user to leave the shared activity.
async_cb -- Callback method to be called with no parameters
if join attempt is successful
async_err_cb -- Callback method to be called with an Exception
parameter if join attempt is unsuccessful
The two callbacks are passed to the server_plugin ("tp") object,
which in turn passes them back as parameters in a callback to the
_left_cb method; this callback is set up within this method.
"""
_logger.debug("Leaving shared activity %s", self._id)
if not self._joined:
_logger.debug("Error: Had not joined activity %s" % self._id)
throw_into_callback(async_err_cb,
RuntimeError("Had not joined activity %s" % self._id))
return
if self._leave_cb is not None:
throw_into_callback(async_err_cb,
RuntimeError('Already trying to leave activity %s'
% self._id))
return
self._leave_cb = async_cb
self._leave_err_cb = async_err_cb
self._ps.owner.remove_owner_activity(self._tp, self._id)
self._text_channel[CHANNEL_INTERFACE].Close()
def _text_channel_members_changed_cb(self, message, added, removed,
local_pending, remote_pending,
actor, reason):
_logger.debug('Activity %s text channel %u currently has %r',
self._id, self._room, self._handle_to_buddy)
_logger.debug('Text channel %u members changed: + %r, - %r, LP %r, '
'RP %r, message %r, actor %r, reason %r', self._room,
added, removed, local_pending, remote_pending,
message, actor, reason)
# Note: D-Bus calls this with list arguments, but after GetMembers()
# we call it with set and tuple arguments; we cope with any iterable.
if (self._text_channel_group_flags &
CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES):
_logger.debug('This channel has channel-specific handles')
map_chan = self._text_channel
else:
# we have global handles here
_logger.debug('This channel has global handles')
map_chan = None
# Disregard any who are already there - however, if we're joining
# the channel, this will still consider everyone to have been added,
# because _handle_to_buddy was cleared. That's necessary, so we get
# the handle-to-buddy mapping for everyone.
added = set(added)
added -= frozenset(self._handle_to_buddy.iterkeys())
_logger.debug('After filtering for no-ops, we want to add %r', added)
added_buddies = self._ps.map_handles_to_buddies(self._tp,
map_chan,
added)
for handle, buddy in added_buddies.iteritems():
self._handle_to_buddy[handle] = buddy
self._add_buddies(added_buddies.itervalues())
# we treat all pending members as if they weren't there
removed = set(removed)
removed |= set(local_pending)
removed |= set(remote_pending)
# disregard any who aren't already there
removed &= frozenset(self._handle_to_buddy.iterkeys())
_logger.debug('After filtering for no-ops, we want to remove %r',
removed)
removed_buddies = set()
for handle in removed:
buddy = self._handle_to_buddy.pop(handle, None)
removed_buddies.add(buddy)
# If we're not in the room yet, the "removal" may be spurious -
# Gabble removes the inviter from members at the same time it adds
# us to local-pending. We'll catch up anyway when we join the room and
# do the apparent<->reality sync, so just don't remove anyone until
# we've joined.
if self._joined:
self._remove_buddies(removed_buddies)
# if we were among those removed, we'll have to start believing
# the spoofable PEP-based activity tracking again.
if self._self_handle not in self._handle_to_buddy and self._joined:
self._text_channel_closed_cb()
if self._self_handle in self._handle_to_buddy and not self._joined:
# We've just joined
self._joined = True
_logger.debug('Syncing activity %s buddy list %r with reality %r',
self._id, self._buddies, self._handle_to_buddy)
real_buddies = set(self._handle_to_buddy.itervalues())
added_buddies = real_buddies - self._buddies
if added_buddies:
_logger.debug('... %r are here although they claimed not',
added_buddies)
removed_buddies = self._buddies - real_buddies
_logger.debug('... %r claimed to be here but are not',
removed_buddies)
self._add_buddies(added_buddies)
self._remove_buddies(removed_buddies)
# Finish the Join process
if PROPERTIES_INTERFACE not in self._text_channel:
self._join_activity_channel_props_listed_cb(())
else:
self._text_channel[PROPERTIES_INTERFACE].ListProperties(
reply_handler=self._join_activity_channel_props_listed_cb,
error_handler=self._join_failed_cb)
def _text_channel_closed_cb(self):
"""Callback method called when the text channel is closed.
This callback is set up in the _handle_share_join method.
"""
self._joined = False
self._handle_to_buddy = {}
self._self_handle = None
self._text_channel = None
_logger.debug('Text channel closed')
try:
self._remove_buddies([self._ps.owner])
except Exception, e:
_logger.debug(
"Failed to remove you from %s: %s" % (self._id, e))
if self._leave_cb and self._leave_err_cb:
try:
self._leave_cb()
_logger.debug("Leaving of activity %s succeeded" % self._id)
except Exception, e:
_logger.debug("Leaving of activity %s failed: %s" % (self._id, e))
self._leave_err_cb(e)
self._clean_up_matches()
self._leave_cb = None
self._leave_err_cb = None
def send_properties(self, changed=()):
"""Tells the Telepathy server what the properties of this activity are.
"""
props = {}
props['name'] = self._actname or u''
props['color'] = self._color or ''
props['type'] = self._type or ''
props['private'] = self._private
props['tags'] = self._tags
conn = self._tp.get_connection()
if CONN_INTERFACE_ACTIVITY_PROPERTIES not in conn:
# we should already have warned about this somewhere
return
def properties_set(e=None):
if e is None:
_logger.debug('Successfully set activity properties for %s',
self._id)
# signal it back to local processes too
# FIXME: if we stopped ignoring Telepathy
# ActivityPropertiesChanged signals from ourselves, we could
# just use that...
self.set_properties(props, changed)
else:
_logger.debug('Failed to set activity properties for %s: %s',
self._id, e)
conn[CONN_INTERFACE_ACTIVITY_PROPERTIES].SetProperties(self._room,
props, reply_handler=properties_set,
error_handler=properties_set)
def set_properties(self, properties, changed=()):
"""Sets properties for this activity from a Telepathy
ActivityPropertiesChanged signal or the return from the Telepathy
GetProperties method.
properties - Dictionary object containing properties keyed by
property names
changed - iterable over properties that have definitely changed
Note that if any of the name, colour and/or type property values is
changed from what it originally was, the update_validity method will
be called, resulting in a "validity-changed" signal being generated.
Called by the PresenceService on the local machine.
"""
changed_properties = {}
validity_maybe_changed = False
# split reserved properties from activity-custom properties
(rprops, cprops) = self._split_properties(properties)
val = rprops.get(_PROP_NAME, self._actname)
if isinstance(val, unicode) and (_PROP_NAME in changed or
val != self._actname):
self._actname = val
changed_properties[_PROP_NAME] = val
validity_maybe_changed = True
val = bool(rprops.get(_PROP_PRIVATE, self._private))
if _PROP_PRIVATE in changed or val != self._private:
changed_properties[_PROP_PRIVATE] = val
self._private = val
val = rprops.get(_PROP_TAGS, self._tags)
if isinstance(val, unicode) and val != self._tags:
changed_properties[_PROP_TAGS] = val
self._tags = val
val = rprops.get(_PROP_COLOR, self._color)
if isinstance(val, unicode):
try:
val = val.encode('ascii')
except UnicodeError:
_logger.debug('Invalid color %s', val)
else:
if _PROP_COLOR in changed or val != self._color:
self._color = val
changed_properties[_PROP_COLOR] = val
validity_maybe_changed = True
val = rprops.get(_PROP_TYPE, self._type)
if isinstance(val, unicode):
try:
val = val.encode('ascii')
except UnicodeError:
_logger.debug('Invalid activity type %s', val)
else:
if _PROP_TYPE in changed or val != self._type:
if self._type:
_logger.debug('Peer attempted to change activity '
'type from %s to %s: ignoring',
self._type, val)
else:
self._type = val
changed_properties[_PROP_TYPE] = val
validity_maybe_changed = True
# Set custom properties
# FIXME: is this actually required? If so, it needs to go into
# the PropertiesChanged dict somehow
if len(cprops.keys()) > 0:
self._custom_props = cprops
if changed_properties:
self.PropertiesChanged(changed_properties)
if validity_maybe_changed:
self._update_validity()
def _split_properties(self, properties):
"""Extracts reserved properties.
properties - Dictionary object containing properties keyed by
property names
returns a tuple of 2 dictionaries, reserved properties and custom
properties
"""
rprops = {}
cprops = {}
for (key, value) in properties.items():
if key in self._RESERVED_PROPNAMES:
rprops[key] = value
else:
cprops[key] = value
return (rprops, cprops)
|