-
Notifications
You must be signed in to change notification settings - Fork 2
/
pypurple.py
1690 lines (1449 loc) · 57.4 KB
/
pypurple.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
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
"""Libpurple to Python translation layer.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without any warranty.
"""
import gobject
import logging
import os
import random
import re
import sys
import threading
import time
from heliotrope import purple
log = logging.getLogger()
PIDGIN = 'c:/atomdep/pidgin/2.7.10'
LIBPURPLE_PLUGIN_DIR = PIDGIN + '/win32-install-dir/plugins'
CA_CERT_DIRS = [PIDGIN + '/share/ca-certs']
CONFIG_DIR = 'config'
AVATAR_DIR = 'config/icons'
gobject.threads_init()
class Client(threading.Thread):
def __init__(self):
"""Initialize purple environment."""
threading.Thread.__init__(self)
# Register this application with libpurple
self.appname = 'purplexmpp'
# Exception handler can be installed only once
self.exception_handler_installed = False
# Start GTK mainloop
self.loop = gobject.MainLoop()
self.loop.quit()
# Callback functions to invoke when receiving Pidgin signals
# Refer to http://developer.pidgin.im/doxygen/dev/html/pages.html
# for a comprehensive list of signals.
self.callbacks = {
'buddy-typing': [],
'buddy-typing-stopped': [],
'buddy-typed': [],
'buddy-signed-off': [],
'buddy-signed-on': [],
'buddy-status-changed': [],
'blist-node-aliased': [],
'received-im-msg': [],
'received-chat-msg': [],
'request-authorization': [],
'signed-on': [],
'signed-off': [],
'signing-on': [],
'signing-off': [],
'connection-error': [],
'buddy-icon-changed': [],
'buddy-added': [],
'displaying-userinfo': [],
'file-recv-request': [],
'file-recv-accept': [],
'file-recv-start': [],
'file-recv-cancel': [],
'file-recv-complete': [],
'file-send-accept': [],
'file-send-start': [],
'file-send-cancel': [],
'file-send-complete': [],
'room-list-progress': [],
'chat-buddy-joined': [],
'chat-buddy-left': [],
}
# Keep track of all pending authorizations
# key is (PurpleAccount, remote_user)
self.pending_authorizations = {}
# Account connection status (has to match PurpleClient)
# TODO(koyao): Merge these values into a common base class.
self.CONNECTING = 0
self.CONNECTED = 1
self.DISCONNECTING = 2
self.DISCONNECTED = 3
self.ERROR = 4
# Keep track of account connection status
self.account_status = {}
self.account_errmsg = {}
# Keep track of rooms associated with accounts
self.account_rooms = {}
self.account_roomlist = {}
# Allow user to override various directories
self.config_dir = CONFIG_DIR
self.plugin_dir = LIBPURPLE_PLUGIN_DIR
self.ca_cert_dirs = CA_CERT_DIRS
self.avatar_dir = AVATAR_DIR
# Disable logging by default
purple.set_heliotrope_print_debug_cb(self.null)
purple.purple_debug_set_ui_ops(purple.heliotrope_debug_get_ui_ops())
purple.purple_debug_set_enabled(False)
# Set notification ui ops
purple.purple_notify_set_ui_ops(purple.heliotrope_get_notify_ui_ops())
# Set blist ui ops
purple.purple_blist_set_ui_ops(purple.heliotrope_get_blist_ui_ops())
def enable_debug(self, enable):
"""Whether to enable debug logging
Arguments:
enable: Boolean
"""
if enable:
purple.set_heliotrope_print_debug_cb(log.debug)
if not self.exception_handler_installed:
self.exception_handler_installed = True
purple.setup_exception_handler()
else:
purple.set_heliotrope_print_debug_cb(self.null)
def null(self, message):
"""Helper function to silence libpurple logging"""
pass
def set_config_dir(self, directory):
"""Set libpurple config dir:
Arguments:
directory: String, config dir to add
"""
directory = directory.encode('utf-8')
self.config_dir = directory
purple.purple_util_set_user_dir(self.config_dir)
def set_plugin_dir(self, directory):
"""Set libpurple plugin dir:
Arguments:
directory: String, dir to add
"""
directory = directory.encode('utf-8')
self.plugin_dir = directory
def set_ca_cert_dirs(self, directories):
"""Set libpurple ca cert dir:
Arguments:
directories: List of directories to search for certs
"""
directories = [x.encode('utf-8') for x in directories]
self.ca_cert_dirs = directories
def set_avatar_dir(self, directory):
"""Set avatar dir:
Arguments:
directory: String, dir to add
"""
directory = directory.encode('utf-8')
self.avatar_dir = directory
def register_callback(self, callback, func):
"""Register function callbacks
Arguments:
callback: String, Pidgin signal
func: Python function
"""
if callback not in self.callbacks:
log.warn('Invalid callback: %s' % callback)
return
if func not in self.callbacks[callback]:
self.callbacks[callback].append(func)
def received_im_msg_cb(self, p_account, sender, message, p_conv, flags):
"""Received IM message:
Arguments:
p_account: pointer to PurpleAccount object
sender: String, sender
message: String, message
p_conv: pointer to PurpleConversation object
flags: int, IM conversation flags
"""
acct = purple.to_account(p_account)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(sender),
'message': message.decode('utf-8')}
for func in self.callbacks['received-im-msg']:
func(msg)
def received_chat_msg_cb(self, p_account, sender, message, p_conv, flags):
"""Received chat (eg. IRC) message:
Arguments:
p_account: pointer to PurpleAccount object
sender: String, sender
message: String, message
p_conv: pointer to PurpleConversation object
flags: int, IM conversation flags
"""
acct = purple.to_account(p_account)
conv = purple.to_conv(p_conv)
msg = {
'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'room_name': conv.name,
'from': str_normalize(sender),
'message': message.decode('utf-8')
}
for func in self.callbacks['received-chat-msg']:
func(msg)
def received_buddy_typing_cb(self, p_account, sender):
"""Received typing notification:
Arguments:
p_account: pointer to PurpleAccount object
sender: String, sender
"""
acct = purple.to_account(p_account)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(sender)}
for func in self.callbacks['buddy-typing']:
func(msg)
def received_buddy_typing_stopped_cb(self, p_account, sender):
"""Received typing notification:
Arguments:
p_account: pointer to PurpleAccount object
sender: String, sender
"""
acct = purple.to_account(p_account)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(sender)}
for func in self.callbacks['buddy-typing-stopped']:
func(msg)
def received_buddy_typed_cb(self, p_account, sender):
"""Received typing notification:
Arguments:
p_account: pointer to PurpleAccount object
sender: String, sender
"""
acct = purple.to_account(p_account)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(sender)}
for func in self.callbacks['buddy-typed']:
func(msg)
def received_buddy_signed_off_cb(self, p_buddy):
"""Received buddy signed off notification:
Arguments:
p_buddy: pointer to PurpleBuddy object
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(purple.purple_buddy_get_name(b))}
for func in self.callbacks['buddy-signed-off']:
func(msg)
def received_buddy_signed_on_cb(self, p_buddy):
"""Received buddy signed on notification:
Arguments:
p_buddy: pointer to PurpleBuddy object
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
status_id, status_msg = self.get_buddy_status(
'%s|%s' % (acct.protocol_id, acct.username.lower()),
str_normalize(purple.purple_buddy_get_name(b)))
if status_id == 'offline':
return
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(purple.purple_buddy_get_name(b)),
'status_id': status_id,
'status_msg': status_msg,
}
for func in self.callbacks['buddy-signed-on']:
func(msg)
if acct.protocol_id == 'prpl-xfire':
log.debug("Fetching avatar for: %s" %
str_normalize(purple.purple_buddy_get_name(b)))
delay_ms = random.randint(0, 30000)
gobject.timeout_add(delay_ms, purple.heliotrope_xfire_tooltip_text, b)
def buddy_added_cb(self, p_buddy):
"""Received buddy added notification
Arguments:
p_buddy: pointer to PurpleBuddy object
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
# In case of a very large buddy list, it could take quite some time
# for the 'signed-on' signal to arrive. Thus, we set account to CONNECTED
# as soon as we received the first buddy.
account = '%s|%s' % (acct.protocol_id, acct.username.lower())
if not self.account_status.has_key(account):
return
if self.account_status[account] == self.CONNECTING:
self.account_status[account] = self.CONNECTED
alias = purple.purple_buddy_get_alias(b).decode('utf-8')
group = purple.purple_buddy_get_group(b)
name = str_normalize(purple.purple_buddy_get_name(b).decode('utf-8'))
if name.startswith('msn/'):
# MSN buddy on Yahoo network
sender = name
alias = alias.replace('msn/', '')
else:
# Remove Jabber resource from the sender
sender = re.sub('/.*', '', name)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': sender,
'alias': alias,
'group': group.name,
}
for func in self.callbacks['buddy-added']:
func(msg)
def received_buddy_status_changed_cb(self, p_buddy, p_old_status, p_status):
"""Received buddy status changed notification:
Arguments:
p_buddy: pointer to PurpleBuddy object
p_old_status: pointer to PurpleStatus object
p_status: pointer to PurpleStatus object
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
status = purple.to_status(p_status)
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(purple.purple_buddy_get_name(b)),
'status_id': purple.purple_status_get_id(status),
'status_msg': purple.purple_status_get_attr_string(status, 'message')
}
for func in self.callbacks['buddy-status-changed']:
func(msg)
def blist_node_aliased_cb(self, p_buddy, old_alias):
"""Received blist alias changed notification:
Arguments:
p_buddy: pointer to PurpleBuddy object
old_alias: String, old alias
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
sender = str_normalize(purple.purple_buddy_get_name(b).decode('utf-8'))
alias = purple.purple_buddy_get_alias(b).decode('utf-8')
if sender.startswith('msn/'):
# MSN buddy on Yahoo network
alias = alias.replace('msn/', '')
group = purple.purple_buddy_get_group(b)
group_name = None
if group:
group_name = group.name
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': sender,
'old_alias': old_alias,
'alias': alias,
'group': group_name,
}
for func in self.callbacks['blist-node-aliased']:
func(msg)
def request_authorize_cb(self, p_account, remote_user, id, alias, message,
on_list, request_auth_cb, request_deny_cb, user_data):
"""Store the authorization request and invoke the callback.
Arguments:
p_account: pointer to PurpleAccount
remote_user: String, remote user requesting authorization
id: String, not used
message: String, invitation mesage
on_list: Boolean, whether the remote user is already on the buddylist
request_auth_cb: Pointer to the authorized callback.
request_deny_cb: Pointer to the denied callback.
user_data: Pointer to the data to be passed to callback func.
"""
acct = purple.to_account(p_account)
account = '%s|%s' % (acct.protocol_id, acct.username.lower())
sender = str_normalize(remote_user)
if not sender.startswith('msn/'):
# Remove Jabber resource from the sender
sender = re.sub('/.*', '', sender)
key = (account, sender)
if self.pending_authorizations.has_key(key):
# We could get duplicate authorization requests from other sources.
# Just discard it silently.
log.debug('In Client::request_authorize_cb(): Ignoring duplicate auth')
return
# Record the callback functions and user_data so that we can act upon it
# when user makes a decision to accept/deny this auth request.
self.pending_authorizations[key] = \
(request_auth_cb, request_deny_cb, user_data)
msg = {'account': account,
'from': sender,
'id': id,
'alias': alias,
'message': message,
'on_list': on_list,
}
for func in self.callbacks['request-authorization']:
func(msg)
def signed_on_cb(self, p_connection):
"""Callback function when an account has signed on
Arguments:
p_connection: pointer to PurpleConnection
"""
gc = purple.to_connection(p_connection)
acct = purple.purple_connection_get_account(gc)
account = '%s|%s' % (acct.protocol_id, acct.username.lower().rstrip('/'))
self.account_status[account] = self.CONNECTED
self.account_errmsg[account] = ''
msg = {'account': account}
for func in self.callbacks['signed-on']:
func(msg)
def signed_off_cb(self, p_connection):
"""Callback function when an account has signed off
Arguments:
p_connection: pointer to PurpleConnection
"""
gc = purple.to_connection(p_connection)
acct = purple.purple_connection_get_account(gc)
account = '%s|%s' % (acct.protocol_id, acct.username.lower().rstrip('/'))
self.account_status[account] = self.DISCONNECTED
# Remove any pending authorizations that belong to the account going offline.
for t_account, t_buddy in self.pending_authorizations.keys():
if t_account == account:
del self.pending_authorizations[(t_account, t_buddy)]
msg = {'account': account}
for func in self.callbacks['signed-off']:
func(msg)
def signing_on_cb(self, p_connection):
"""Callback function when an account is about to sign on
Arguments:
p_connection: pointer to PurpleConnection
"""
gc = purple.to_connection(p_connection)
acct = purple.purple_connection_get_account(gc)
account = '%s|%s' % (acct.protocol_id, acct.username.lower().rstrip('/'))
self.account_status[account] = self.CONNECTING
msg = {'account': account}
for func in self.callbacks['signing-on']:
func(msg)
def signing_off_cb(self, p_connection):
"""Callback function when an account is about to sign off
Arguments:
p_connection: pointer to PurpleConnection
"""
gc = purple.to_connection(p_connection)
acct = purple.purple_connection_get_account(gc)
account = '%s|%s' % (acct.protocol_id, acct.username.lower().rstrip('/'))
self.account_status[account] = self.DISCONNECTING
msg = {'account': account}
for func in self.callbacks['signing-off']:
func(msg)
def connection_error_cb(self, p_connection, p_connection_error, desc):
"""Callback function when an account goes into connection error.
Arguments:
p_connection: pointer to PurpleConnection
p_connection_error: pointer to PurpleConnectionError
desc: String, a description of the error
"""
gc = purple.to_connection(p_connection)
acct = purple.purple_connection_get_account(gc)
account = '%s|%s' % (acct.protocol_id, acct.username.lower().rstrip('/'))
self.account_status[account] = self.ERROR
self.account_errmsg[account] = desc
msg = {'account': account, 'error': desc}
for func in self.callbacks['connection-error']:
func(msg)
def buddy_icon_changed_cb(self, p_buddy):
"""Callback function when an buddy icon got updated
Arguments:
p_buddy: pointer to PurpleBuddy
"""
b = purple.to_buddy(p_buddy)
acct = purple.purple_buddy_get_account(b)
buddy = purple.purple_buddy_get_name(b)
buddy_icon = purple.purple_buddy_icons_find(acct, buddy)
if buddy_icon:
avatar = purple.purple_buddy_icon_get_full_path(buddy_icon)
else:
avatar = None
msg = {'account': '%s|%s' % (acct.protocol_id, acct.username.lower()),
'from': str_normalize(buddy),
'avatar': avatar,
}
for func in self.callbacks['buddy-icon-changed']:
func(msg)
def run(self):
"""Start purple main loop in a separate thread."""
# Setup eventloop
eventloop_ops = purple._PurpleEventLoopUiOps()
eventloop_ops.timeout_add = purple.g_timeout_add_cb
eventloop_ops.timeout_remove = purple.g_source_remove_cb
eventloop_ops.input_add = purple.gnt_input_add_cb
eventloop_ops.input_remove = purple.g_source_remove_cb
eventloop_ops.timeout_add_seconds = purple.g_timeout_add_seconds_cb
purple.purple_eventloop_set_ui_ops(eventloop_ops)
# Setup PurpleAccountUiOps
account_ops = purple._PurpleAccountUiOps()
purple.set_request_authorize_cb(self.request_authorize_cb)
account_ops.request_authorize = purple.request_authorize_cb
purple.purple_accounts_set_ui_ops(account_ops)
# Set roomlist ui ops
purple.set_heliotrope_add_room_cb(self.add_room_cb)
purple.set_heliotrope_room_refresh_in_progress_cb(
self.room_refresh_in_progress_cb)
purple.purple_roomlist_set_ui_ops(purple.heliotrope_get_roomlist_ui_ops())
# Setup a bunch of paths:
purple.purple_plugins_add_search_path(self.plugin_dir)
for dir in self.ca_cert_dirs:
purple.purple_certificate_add_ca_search_path(dir)
purple.purple_buddy_icons_set_cache_dir(self.avatar_dir)
log.debug("plugin_dir=%s" % self.plugin_dir)
log.debug("config_dir=%s" % self.config_dir)
log.debug("ca_cert_dirs=%s" % self.ca_cert_dirs)
log.debug("avatar_dir=%s" % self.avatar_dir)
r = purple.purple_core_init(self.appname)
# Disable libpurple chat/im logging
purple.purple_prefs_set_bool("/purple/logging/log_ims", False)
purple.purple_prefs_set_bool("/purple/logging/log_chats", False)
# Disable libpurple idle reporting
purple.purple_prefs_set_string("/purple/away/idle_reporting", "")
purple.purple_prefs_set_bool("/purple/away/away_when_idle", False)
# Initialize buddy list
purple.purple_set_blist(purple.purple_blist_new())
# Register callbacks
handle = purple.purple_plugin_new(True, None)
purple.set_received_im_msg(handle, self.received_im_msg_cb)
purple.set_received_chat_msg(handle, self.received_chat_msg_cb)
purple.set_buddy_typing(handle, self.received_buddy_typing_cb)
purple.set_buddy_typing_stopped(handle,
self.received_buddy_typing_stopped_cb)
purple.set_buddy_typed(handle, self.received_buddy_typed_cb)
purple.set_buddy_signed_off(handle, self.received_buddy_signed_off_cb)
purple.set_buddy_signed_on(handle, self.received_buddy_signed_on_cb)
purple.set_buddy_status_changed(handle,
self.received_buddy_status_changed_cb)
purple.set_blist_node_aliased(handle, self.blist_node_aliased_cb)
purple.set_signed_on(handle, self.signed_on_cb)
purple.set_signed_off(handle, self.signed_off_cb)
purple.set_signing_on(handle, self.signing_on_cb)
purple.set_signing_off(handle, self.signing_off_cb)
purple.set_connection_error(handle, self.connection_error_cb)
purple.set_buddy_icon_changed(handle, self.buddy_icon_changed_cb)
purple.set_buddy_added(handle, self.buddy_added_cb)
purple.set_displaying_userinfo(handle, self.displaying_userinfo_cb)
purple.set_file_recv_request(handle, self.file_recv_request_cb)
purple.set_file_recv_accept(handle, self.file_recv_accept_cb)
purple.set_file_recv_start(handle, self.file_recv_start_cb)
purple.set_file_recv_cancel(handle, self.file_recv_cancel_cb)
purple.set_file_recv_complete(handle, self.file_recv_complete_cb)
purple.set_file_send_accept(handle, self.file_send_accept_cb)
purple.set_file_send_start(handle, self.file_send_start_cb)
purple.set_file_send_cancel(handle, self.file_send_cancel_cb)
purple.set_file_send_complete(handle, self.file_send_complete_cb)
purple.set_chat_buddy_joined(handle, self.chat_buddy_joined_cb)
purple.set_chat_buddy_left(handle, self.chat_buddy_left_cb)
# Start the main loop
self.loop.run()
def is_connecting(self, account):
"""Convenience routine: is the specified account in the CONNECTING state?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists and is CONNECTING, False otherwise
"""
return (account in self.account_status and \
self.account_status[account] == self.CONNECTING)
def is_connected(self, account):
"""Convenience routine: is the specified account in the CONNECTED state?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists and is CONNECTED, False otherwise
"""
return (account in self.account_status and \
self.account_status[account] == self.CONNECTED)
def is_disconnecting(self, account):
"""Convenience routine: is the specified account in the DISCONNECTING
state?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists and is DISCONNECTING, False otherwise
"""
return (account in self.account_status and \
self.account_status[account] == self.DISCONNECTING)
def is_disconnected(self, account):
"""Convenience routine: is the specified account in the DISCONNECTED state?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists and is DISCONNECTED, False otherwise
"""
return (account in self.account_status and \
self.account_status[account] == self.DISCONNECTED)
def has_error(self, account):
"""Convenience routine: is the specified account in the ERROR state?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists and is ERROR, False otherwise
"""
return (account in self.account_status and \
self.account_status[account] == self.ERROR)
def has_status(self, account):
"""Convenience routine: does the specified account exist?
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
True if the account-status exists
"""
return (account in self.account_status)
def get_accounts(self):
"""Return list of accounts"""
return self.account_status.keys()
def get_errmsg(self, account):
"""Return error message of the specified account
Arguments:
account: String, protocol and username (e.g. "prpl-jabber|you@example.com")
Returns:
String, if the error message exists
False, if the error message doesn't exist
"""
if account not in self.account_errmsg:
return ''
else:
return self.account_errmsg[account]
def disconnect(self):
"""Disable all accounts."""
for acct in purple.purple_accounts_get_all_active():
account = '%s|%s' % (acct.protocol_id, acct.username.lower())
log.info("Client::disconnect(): Disconnecting account: %s" % account)
gobject.timeout_add(0,
purple.purple_account_set_enabled,
acct, self.appname, False)
def reset_buddy_list(self):
"""Remove everybody in the buddy list"""
for buddy in purple.purple_blist_get_buddies():
purple.purple_blist_remove_buddy(buddy)
def purple_blist_load(self):
"""Load the buddy list from disk"""
gobject.timeout_add(0, purple.purple_blist_load)
def login(self, account, password, server=None, int_keys={}):
"""Login to an IM account using libpurple.
Arguments:
account: String, full IM account (eg. 'prpl-jabber|username@domain)
password: String, password
server: String, if specified, use that server instead of the domain
in username.
int_keys: Dictionary, a key/value pair of integer values
"""
log.info("PyPurple::login(): account=%s, server=%s" % (account, server))
if not account:
log.warn('Client::login(): Missing account')
return
if not password and not account.startswith('prpl-irc'):
log.warn('PyPurple::login(): Missing password')
return
account = account.encode('utf-8')
password = password.encode('utf-8')
if server:
server = server.encode('utf-8')
protocol, username = account.split('|')
protocol = protocol.encode('utf-8')
username = username.encode('utf-8')
if protocol == 'prpl-irc':
if username.find(':') >= 0:
username, port = username.split(':', 1)
port = int(port)
else:
port = 6667
# Create the account
acct = purple.purple_account_new(username, protocol)
if server:
gobject.timeout_add(0,
purple.purple_account_set_string,
acct, 'connect_server', server)
else:
gobject.timeout_add(0,
purple.purple_account_remove_setting,
acct, 'connect_server')
for k, v in int_keys.items():
gobject.timeout_add(0,
purple.purple_account_set_int,
acct, k, v)
gobject.timeout_add(0,
purple.purple_account_set_bool,
acct, 'auth_plain_in_clear', True)
gobject.timeout_add(0,
purple.purple_account_set_bool,
acct, 'require_tls', False)
gobject.timeout_add(0,
purple.purple_account_set_remember_password,
acct, False)
gobject.timeout_add(0,
purple.purple_account_set_password,
acct, password)
if protocol == 'prpl-xfire':
gobject.timeout_add(0,
purple.purple_account_set_bool,
acct, 'ingamedetectionnorm', False)
if protocol in ['prpl-aim', 'prpl-icq']:
gobject.timeout_add(0,
purple.purple_account_set_bool,
acct, 'use_clientlogin', True)
gobject.timeout_add(0,
purple.purple_account_set_string,
acct, 'encryption', 'opportunistic_encryption')
gobject.timeout_add(0,
purple.purple_account_remove_setting,
acct, 'use_ssl')
if protocol in ['prpl-aim']:
gobject.timeout_add(0,
purple.purple_account_set_string,
acct, 'server', 'slogin.oscar.aol.com')
if protocol in ['prpl-icq']:
gobject.timeout_add(0,
purple.purple_account_set_string,
acct, 'server', 'slogin.icq.com')
if protocol in ['prpl-irc']:
gobject.timeout_add(0,
purple.purple_account_set_int,
acct, 'port', port)
gobject.timeout_add(0,
purple.purple_accounts_add,
acct)
# Login
gobject.timeout_add(0,
purple.purple_savedstatus_activate_for_account,
purple.purple_savedstatus_get_default(), acct)
gobject.timeout_add(0,
purple.purple_account_set_enabled,
acct, self.appname, True)
def set_custom_status(self, new_status_id=None, new_status_message=None):
"""Broadcast custom status to all IM accounts.
Arguments:
new_status_message: String, custom status message.
If not set, keep the current status.
new_status_id: String, (see status_primitive_map in status.c)
"""
status_id = new_status_id
if isinstance(new_status_message, unicode):
new_status_message = new_status_message.encode('utf-8')
status_message = new_status_message
for acct in purple.purple_accounts_get_all_active():
status = purple.purple_account_get_active_status(acct)
if new_status_id is None:
status_id = purple.purple_status_get_id(status)
if new_status_message is None:
status_message = purple.purple_status_get_attr_string(status, 'message')
purple.heliotrope_account_set_status(acct, status_id, True, status_message)
def offline(self, account):
"""Go offline on an IM account
Arguments:
account: String, full account (eg. prpl-jaber|username@domain)
"""
if not account:
log.warn('Client::offline(): Missing account')
return
protocol, username = account.split('|')
protocol = protocol.encode('utf-8')
username = username.encode('utf-8')
acct = purple.purple_accounts_find(username, protocol)
if not acct:
log.warn('Client::offline(): Cannot find account: %s' % account)
return
# Don't attempt to logout if the account is about to be disconnected,
# or if we're already disconnected.
if self.account_status.has_key(account) and \
self.account_status[account] in [self.DISCONNECTING, self.DISCONNECTED]:
return
log.info("Client::offline(): Disabling account: %s" % account)
gobject.timeout_add(0,
purple.purple_account_set_enabled,
acct, self.appname, False)
def send_message(self, account, recipient, message):
"""Send an IM to recipient
Arguments:
account: String, full account (eg. prpl-jaber|username@domain)
recipient: String, recipient's username
message: String, message to send
"""
if not account or not recipient or not message:
log.warn('Missing parameters for Client::send_message()')
return
account = account.encode('utf-8')
recipient = recipient.encode('utf-8')
message = message.encode('utf-8')
protocol, username = account.split('|')
acct = purple.purple_accounts_find(username, protocol)
if not acct:
log.warn('Cannot find account: %s' % account)
return
conv = purple.purple_find_conversation_with_account(
purple.PURPLE_CONV_TYPE_IM, recipient, acct)
if not conv:
conv = purple.purple_conversation_new(purple.PURPLE_CONV_TYPE_IM,
acct, recipient)
conv_im = purple.purple_conversation_get_im_data(conv)
gobject.timeout_add(0,
purple.purple_conv_im_send,
conv_im, message)
def send_typing_notification(self, account, recipient, first):
"""Send typing notification to recipient
Arguments:
account: String, full account (eg. prpl-jaber|username@domain)
recipient: String, recipient's username
first: Boolean, whether this is the first character of the sentence
"""
if not account or not recipient:
log.warn('Missing parameters for Client::send_typing_notification()')
return
account = account.encode('utf-8')
recipient = recipient.encode('utf-8')
protocol, username = account.split('|')
acct = purple.purple_accounts_find(username, protocol)
if not acct:
log.warn('Cannot find account: %s' % account)
return
conv = purple.purple_find_conversation_with_account(
purple.PURPLE_CONV_TYPE_IM, recipient, acct)
if not conv:
conv = purple.purple_conversation_new(purple.PURPLE_CONV_TYPE_IM,
acct, recipient)
conv_im = purple.purple_conversation_get_im_data(conv)
gobject.timeout_add(0,
purple.purple_conv_im_stop_send_typed_timeout,
conv_im)
gobject.timeout_add(0,
purple.purple_conv_im_start_send_typed_timeout,
conv_im)
# Check if we need to send another PURPLE_TYPING message
type_again_ts = purple.purple_conv_im_get_type_again(conv_im)
if first or (type_again_ts > 0 and time.time() > type_again_ts):
# TODO(koyao): Figure out how to wrap this logic around
# gobject.timeout_add(0, ...)
timeout = purple.serv_send_typing(
purple.purple_conversation_get_gc(conv),
purple.purple_conversation_get_name(conv),
purple.PURPLE_TYPING)
purple.purple_conv_im_set_type_again(conv_im, timeout)
def send_typing_stopped_notification(self, account, recipient):
"""Send stop typing notification
Arguments:
account: String, full account (eg. prpl-jaber|username@domain)
recipient: String, recipient's username
"""
if not account or not recipient:
log.warn('PyPurple::send_typing_stopped_notification(): ' +
'Missing required parameters')
return
account = account.encode('utf-8')
recipient = recipient.encode('utf-8')
protocol, username = account.split('|')
acct = purple.purple_accounts_find(username, protocol)
if not acct:
log.warn('PyPurple::send_typing_stopped_notification(): ' +
'Cannot find account: %s' % account)
return
conv = purple.purple_find_conversation_with_account(
purple.PURPLE_CONV_TYPE_IM, recipient, acct)
if not conv:
conv = purple.purple_conversation_new(purple.PURPLE_CONV_TYPE_IM,
acct, recipient)
conv_im = purple.purple_conversation_get_im_data(conv)
gobject.timeout_add(0,
purple.purple_conv_im_stop_send_typed_timeout,
conv_im)
gobject.timeout_add(0,
purple.serv_send_typing,
purple.purple_conversation_get_gc(conv),
purple.purple_conversation_get_name(conv),
purple.PURPLE_NOT_TYPING)
def avatar(self, account, buddy):
"""Return the avatar path of a given account:
Arguments:
account: String, full account (eg. prpl-jaber|username@domain)
buddy: String, username of the owner of the avatar
Returns:
icon_path: String, absolute path to the icon
"""
if not account:
log.warn('Client::avatar(): Missing account')
return
if not buddy:
log.warn('Missing buddy')
return
protocol, username = account.split('|')
protocol = protocol.encode('utf-8')