This repository has been archived by the owner on Jun 27, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PresencePublisher.py
510 lines (433 loc) · 22.8 KB
/
PresencePublisher.py
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
# Copyright (C) 2012 AG Projects. See LICENSE for details.
#
from AppKit import NSEventTrackingRunLoopMode
from Foundation import (NSBundle,
NSRunLoop,
NSRunLoopCommonModes,
NSTimer)
import cjson
import hashlib
import objc
import socket
import uuid
import urlparse
from application.notification import NotificationCenter, IObserver
from application.python import Null
from eventlib.green import urllib2
from sipsimple.account import AccountManager, Account, BonjourAccount
from sipsimple.account.bonjour import BonjourPresenceState
from sipsimple.account.xcap import Icon, OfflineStatus
from sipsimple.configuration.settings import SIPSimpleSettings
from sipsimple.payloads import pidf, rpid, cipid, caps, IterateItems
from sipsimple.payloads.addressbook import Contact
from sipsimple.util import ISOTimestamp
from sipsimple.threading import run_in_twisted_thread
from sipsimple.threading.green import run_in_green_thread, Command
from twisted.internet import reactor
from zope.interface import implements
from util import allocate_autorelease_pool, run_in_gui_thread, BLINK_URL_TOKEN
from BlinkLogger import BlinkLogger
bundle = NSBundle.bundleWithPath_(objc.pathForFramework('ApplicationServices.framework'))
objc.loadBundleFunctions(bundle, globals(), [('CGEventSourceSecondsSinceLastEventType', 'diI')])
on_the_phone_activity = {'title': 'Busy', 'note': 'I am on the phone'}
PresenceActivityList = (
{
'title': u"Available",
'type': 'menu_item',
'action': 'presenceActivityChanged:',
'represented_object': {
'title': u"Available",
'basic_status': 'open',
'extended_status': 'available',
'image': 'available',
'note': ''
}
},
{
'title': u"Away",
'type': 'menu_item',
'action': 'presenceActivityChanged:',
'represented_object': {
'title': u"Away",
'basic_status': 'open',
'extended_status': 'away',
'image': 'away',
'note': ''
}
},
{
'title': u"Busy",
'type': 'menu_item',
'action': 'presenceActivityChanged:',
'represented_object': {
'title': u"Busy",
'basic_status': 'open',
'extended_status': 'busy',
'image': 'busy',
'note': ''
}
},
{
'title': u"Invisible",
'type': 'menu_item',
'action': 'presenceActivityChanged:',
'represented_object': {
'title': u"Invisible",
'basic_status': 'closed',
'extended_status': 'offline',
'image': 'offline',
'note': ''
}
},
{
'type': 'delimiter'
},
{'title': u"Offline Note...",
'type': 'menu_item',
'action': 'setPresenceOfflineNote:',
'represented_object': None
},
{
'title': u"Empty",
'type': 'menu_item',
'action': 'setPresenceOfflineNote:',
'indentation': 2,
'represented_object': None
}
)
class PresencePublisher(object):
implements(IObserver)
user_input = {'state': 'active', 'last_input': None}
idle_mode = False
last_input = ISOTimestamp.now()
last_time_offset = int(pidf.TimeOffset())
hostname = socket.gethostname().split(".")[0]
presenceStateBeforeIdle = None
wakeup_timer = None
location = None
last_service_timestamp = {}
last_logged_status = None
first_start_logged = False
application_ended = False
# Cleanup old base64 encoded icons
_cleanedup_accounts = set()
def __init__(self, owner):
self.owner = owner
BlinkLogger().log_debug('Starting Presence Publisher')
NotificationCenter().add_observer(self, name="SIPApplicationWillStart")
NotificationCenter().add_observer(self, name="SIPApplicationDidStart")
NotificationCenter().add_observer(self, name="SIPApplicationDidEnd")
@allocate_autorelease_pool
@run_in_gui_thread
def handle_notification(self, notification):
handler = getattr(self, '_NH_%s' % notification.name, Null)
handler(notification)
def _NH_SIPApplicationWillStart(self, notification):
nc = NotificationCenter()
nc.add_observer(self, name="CFGSettingsObjectDidChange")
nc.add_observer(self, name="SIPAccountDidDiscoverXCAPSupport")
nc.add_observer(self, name="SystemDidWakeUpFromSleep")
nc.add_observer(self, name="SystemWillSleep")
nc.add_observer(self, name="XCAPManagerDidReloadData")
nc.add_observer(self, name="XCAPManagerDidDiscoverServerCapabilities")
def _NH_SIPApplicationDidEnd(self, notification):
self.application_ended = True
def _NH_SIPApplicationDidStart(self, notification):
settings = SIPSimpleSettings()
if settings.presence_state.timestamp is None:
settings.presence_state.timestamp = ISOTimestamp.now()
settings.save()
self.get_location([account for account in AccountManager().iter_accounts() if account is not BonjourAccount()])
self.publish()
idle_timer = NSTimer.timerWithTimeInterval_target_selector_userInfo_repeats_(1.0, self, "updateIdleTimer:", None, True)
NSRunLoop.currentRunLoop().addTimer_forMode_(idle_timer, NSRunLoopCommonModes)
NSRunLoop.currentRunLoop().addTimer_forMode_(idle_timer, NSEventTrackingRunLoopMode)
def _NH_SIPAccountDidDiscoverXCAPSupport(self, notification):
account = notification.sender
offline_pidf = self.build_offline_pidf(account)
offline_status = OfflineStatus(offline_pidf) if offline_pidf is not None else None
account.xcap_manager.set_offline_status(offline_status)
def _NH_SystemDidWakeUpFromSleep(self, notification):
if self.wakeup_timer is None:
@run_in_gui_thread
def wakeup_action():
self.get_location([account for account in AccountManager().iter_accounts() if account is not BonjourAccount()])
self.publish()
self.wakeup_timer = None
self.wakeup_timer = reactor.callLater(5, wakeup_action) # wait for system to stabilize
def _NH_SystemWillSleep(self, notification):
self.unpublish()
def _NH_CFGSettingsObjectDidChange(self, notification):
if isinstance(notification.sender, Account):
account = notification.sender
if set(['display_name', 'presence.disable_location', 'presence.disable_timezone', 'presence.homepage']).intersection(notification.data.modified):
if account.enabled and account.presence.enabled:
account.presence_state = self.build_pidf(account)
if 'presence.disable_location' in notification.data.modified and not account.presence.disable_location:
self.get_location([account])
if set(['xcap.enabled', 'xcap.xcap_root']).intersection(notification.data.modified):
if account.xcap.enabled and account.xcap.discovered:
if account.xcap_manager is not None:
offline_pidf = self.build_offline_pidf(account)
offline_status = OfflineStatus(offline_pidf) if offline_pidf is not None else None
account.xcap_manager.set_offline_status(offline_status)
status_icon = self.build_status_icon()
icon = Icon(status_icon, 'image/png') if status_icon is not None else None
account.xcap_manager.set_status_icon(icon)
if notification.sender is SIPSimpleSettings():
if set(['chat.disabled', 'screen_sharing_server.disabled', 'file_transfer.disabled', 'presence_state.icon', 'presence_state.status', 'presence_state.note']).intersection(notification.data.modified):
self.publish()
if 'presence_state.offline_note' in notification.data.modified:
self.set_offline_status()
if 'presence_state.icon' in notification.data.modified:
self.set_status_icon()
def _NH_XCAPManagerDidDiscoverServerCapabilities(self, notification):
account = notification.sender.account
if account.enabled and account.presence.enabled:
account.presence_state = self.build_pidf(account)
def _NH_XCAPManagerDidReloadData(self, notification):
account = notification.sender.account
settings = SIPSimpleSettings()
offline_status = notification.data.offline_status
status_icon = notification.data.status_icon
try:
offline_note = next(note for service in offline_status.pidf.services for note in service.notes)
except (AttributeError, StopIteration):
offline_note = None
settings.presence_state.offline_note = offline_note
settings.save()
if status_icon:
icon_hash = hashlib.sha512(status_icon.data).hexdigest()
if not settings.presence_state.icon or settings.presence_state.icon.hash != icon_hash:
# TODO: convert icon to PNG before saving it
self.owner.saveUserIcon(status_icon.data)
else:
if settings.presence_state.icon:
self.set_status_icon(account)
# Cleanup old base64 encoded icons from payload
if account.id not in self._cleanedup_accounts:
self._cleanup_icons(account)
@run_in_twisted_thread
def _cleanup_icons(self, account):
self._cleanedup_accounts.add(account.id)
with account.xcap_manager.transaction():
address_book = account.xcap_manager.resource_lists.content['sipsimple_addressbook']
for contact in address_book[Contact, IterateItems]:
if contact.attributes and contact.attributes.get('icon') is not None:
contact.attributes['icon'] = None
account.xcap_manager.command_channel.send(Command('update'))
def updateIdleTimer_(self, timer):
must_publish = False
hostname = socket.gethostname().split(".")[0]
if hostname != self.hostname:
must_publish = True
self.hostname = hostname
last_time_offset = int(pidf.TimeOffset())
if last_time_offset != self.last_time_offset:
must_publish = True
self.last_time_offset = last_time_offset
# secret sausage after taking the red pill = indigestion
last_idle_counter = CGEventSourceSecondsSinceLastEventType(0, int(4294967295))
self.previous_idle_counter = last_idle_counter
if self.previous_idle_counter > last_idle_counter:
self.last_input = ISOTimestamp.now()
selected_item = self.owner.presenceActivityPopUp.selectedItem()
if selected_item is None:
return
activity_object = selected_item.representedObject()
if activity_object is None:
return
if activity_object['title'] not in ('Available', 'Away'):
if must_publish:
self.publish()
return
settings = SIPSimpleSettings()
if last_idle_counter > settings.gui.idle_threshold:
if not self.idle_mode:
self.user_input = {'state': 'idle', 'last_input': self.last_input}
if activity_object['title'] != "Away":
i = self.owner.presenceActivityPopUp.indexOfItemWithTitle_('Away')
self.owner.presenceActivityPopUp.selectItemAtIndex_(i)
self.presenceStateBeforeIdle = activity_object
self.presenceStateBeforeIdle['note'] = unicode(self.owner.presenceNoteText.stringValue())
self.idle_mode = True
must_publish = True
else:
if self.idle_mode:
self.user_input = {'state': 'active', 'last_input': None}
if activity_object['title'] == "Away":
if self.presenceStateBeforeIdle:
i = self.owner.presenceActivityPopUp.indexOfItemWithRepresentedObject_(self.presenceStateBeforeIdle)
self.owner.presenceActivityPopUp.selectItemAtIndex_(i)
self.owner.presenceNoteText.setStringValue_(self.presenceStateBeforeIdle['note'])
self.presenceStateBeforeIdle = None
self.idle_mode = False
must_publish = True
if must_publish:
self.publish()
def build_pidf(self, account):
if account is None or not account.enabled or not account.presence.enabled:
return None
selected_item = self.owner.presenceActivityPopUp.selectedItem()
if selected_item is None:
return None
activity_object = selected_item.representedObject()
if activity_object is None:
return None
offline = activity_object['basic_status'] == 'closed' and activity_object['extended_status'] == 'offline'
settings = SIPSimpleSettings()
instance_id = str(uuid.UUID(settings.instance_id))
pidf_doc = pidf.PIDF(str(account.uri))
person = pidf.Person("PID-%s" % hashlib.md5(account.id).hexdigest())
person.timestamp = pidf.PersonTimestamp(settings.presence_state.timestamp)
if not account.presence.disable_timezone and not offline:
person.time_offset = rpid.TimeOffset()
pidf_doc.add(person)
status = pidf.Status(activity_object['basic_status'])
status.extended = activity_object['extended_status']
person.activities = rpid.Activities()
person.activities.add(unicode(status.extended))
service = pidf.Service("SID-%s" % instance_id, status=status)
service.timestamp = pidf.ServiceTimestamp(settings.presence_state.timestamp)
if offline:
note = settings.presence_state.offline_note
if note:
service.notes.add(unicode(note))
pidf_doc.add(service)
return pidf_doc
service.contact = pidf.Contact(str(account.contact.public_gruu or account.uri))
if account.display_name:
service.display_name = cipid.DisplayName(account.display_name)
if self.location and not account.presence.disable_location:
if self.location['city']:
location = '%s/%s' % (self.location['country'], self.location['city'])
service.map = cipid.Map(location)
elif self.location['country']:
service.map = cipid.Map(self.location['country'])
if (account.xcap.discovered and account.xcap_manager is not None and account.xcap_manager.status_icon is not None and account.xcap_manager.status_icon.content is not None):
icon = account.xcap_manager.status_icon
if icon:
service.icon = cipid.Icon("%s#%s%s" % (icon.url, BLINK_URL_TOKEN, icon.etag))
if account.presence.homepage is not None:
service.homepage = cipid.Homepage(account.presence.homepage)
service.notes.add(unicode(self.owner.presenceNoteText.stringValue()))
service.device_info = pidf.DeviceInfo(instance_id, description=unicode(self.hostname), user_agent=settings.user_agent)
if not account.presence.disable_timezone:
service.device_info.time_offset = pidf.TimeOffset()
service.capabilities = caps.ServiceCapabilities(audio=True, text=True)
service.capabilities.message = not settings.chat.disabled
service.capabilities.file_transfer = not settings.file_transfer.disabled
service.capabilities.screen_sharing_server = not settings.screen_sharing_server.disabled
service.capabilities.screen_sharing_client = True
service.user_input = rpid.UserInput()
service.user_input.value = self.user_input['state']
service.user_input.last_input = self.user_input['last_input']
service.user_input.idle_threshold = settings.gui.idle_threshold
service.add(pidf.DeviceID(instance_id))
pidf_doc.add(service)
device = pidf.Device("DID-%s" % instance_id, device_id=pidf.DeviceID(instance_id))
device.timestamp = pidf.DeviceTimestamp(settings.presence_state.timestamp)
device.notes.add(u'%s at %s' % (settings.user_agent, self.hostname))
pidf_doc.add(device)
self.last_service_timestamp[account.id] = service.timestamp
return pidf_doc
def build_offline_pidf(self, account):
settings = SIPSimpleSettings()
note = settings.presence_state.offline_note
if not note:
return None
pidf_doc = pidf.PIDF(account.id)
account_hash = hashlib.md5(account.id).hexdigest()
person = pidf.Person("PID-%s" % account_hash)
person.activities = rpid.Activities()
person.activities.add('offline')
person.notes.add(unicode(note))
pidf_doc.add(person)
service = pidf.Service("SID-%s" % account_hash)
service.status = pidf.Status(basic='closed')
service.status.extended = 'offline'
service.contact = pidf.Contact(str(account.uri))
service.capabilities = caps.ServiceCapabilities()
service.notes.add(unicode(note))
pidf_doc.add(service)
return pidf_doc
def build_status_icon(self):
settings = SIPSimpleSettings()
if not settings.presence_state.icon:
return None
try:
return open(settings.presence_state.icon.path, 'r').read()
except OSError:
return None
def publish(self):
if self.application_ended:
return
selected_item = self.owner.presenceActivityPopUp.selectedItem()
if selected_item is None:
return None
activity_object = selected_item.representedObject()
if activity_object is None:
return None
if not self.first_start_logged:
BlinkLogger().log_info('My device has started and is active')
self.first_start_logged = True
if self.last_logged_status != activity_object['extended_status']:
BlinkLogger().log_info(u"My availability changed to %s" % activity_object['extended_status'])
self.last_logged_status = activity_object['extended_status']
for account in (account for account in AccountManager().iter_accounts() if account is not BonjourAccount()):
account.presence_state = self.build_pidf(account)
self.updateBonjourPresenceState()
def updateBonjourPresenceState(self):
bonjour_account = BonjourAccount()
if not bonjour_account.enabled:
return
status = None
note = self.owner.presenceNoteText.stringValue()
selected_item = self.owner.presenceActivityPopUp.selectedItem()
if selected_item is not None:
activity_object = selected_item.representedObject()
if activity_object is not None:
status = activity_object['extended_status']
if status in (None, 'offline'):
bonjour_account.presence_state = None
else:
bonjour_account.presence_state = BonjourPresenceState(status, note)
NotificationCenter().post_notification('BonjourAccountPresenceStateDidChange', sender=bonjour_account)
def unpublish(self):
for account in (account for account in AccountManager().iter_accounts() if account is not BonjourAccount()):
account.presence_state = None
def set_offline_status(self):
for account in (account for account in AccountManager().iter_accounts() if account is not BonjourAccount() and account.xcap.enabled and account.xcap.discovered):
if account.xcap_manager is not None:
offline_pidf = self.build_offline_pidf(account)
offline_status = OfflineStatus(offline_pidf) if offline_pidf is not None else None
account.xcap_manager.set_offline_status(offline_status)
def set_status_icon(self, account=None):
status_icon = self.build_status_icon()
icon = Icon(status_icon, 'image/png') if status_icon is not None else None
if account is not None:
account.xcap_manager.set_status_icon(icon)
else:
for account in (account for account in AccountManager().iter_accounts() if account is not BonjourAccount() and account.xcap.enabled and account.xcap.discovered):
if account.xcap_manager is not None:
account.xcap_manager.set_status_icon(icon)
@run_in_green_thread
def get_location(self, accounts):
for account in accounts:
if not account.server.settings_url or account.presence.disable_location:
continue
query_string = "action=get_location"
url = urlparse.urlunparse(account.server.settings_url[:4] + (query_string,) + account.server.settings_url[5:])
req = urllib2.Request(url)
try:
data = urllib2.urlopen(req).read()
except Exception:
continue
try:
response = cjson.decode(data.replace('\\/', '/'))
except TypeError:
continue
if response and self.location != response:
self.location = response
self.publish()
break