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
|
# Copyright 2010-2011 Florent Le Coz <louiz@louiz.org>
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the zlib license. See the COPYING file.
"""
Defines the Roster and RosterGroup classes
"""
import logging
log = logging.getLogger(__name__)
from config import config
from os import path as p
from contact import Contact
from sleekxmpp.xmlstream.stanzabase import JID
from sleekxmpp.exceptions import IqError
class Roster(object):
def __init__(self):
"""
node: the RosterSingle from SleekXMPP
mucs: the dict from the SleekXMPP MUC plugin containing the joined mucs
"""
self.__node = None
self.__mucs = None
self.jid = None
self.contact_filter = None # A tuple(function, *args)
# function to filter contacts,
# on search, for example
self.folded_groups = config.get(
'folded_roster_groups',
'',
section='var').split(':')
self.groups = {}
self.contacts = {}
def set_node(self, value):
self.__node = value
def set_mucs(self, value):
self.__mucs = value
def set_self_jid(self, value):
self.jid = value
def get_groups(self):
"""Return a list of the RosterGroups"""
return [group for group in self.groups.values() if group]
def __getitem__(self, key):
"""Get a Contact from his bare JID"""
key = JID(key).bare
if key in self.contacts and self.contacts[key] is not None:
return self.contacts[key]
log.debug('JIDS: %s' % self.jids())
if key in self.jids():
contact = Contact(self.__node[key])
self.contacts[key] = contact
return contact
def __setitem__(self, key, value):
"""Set the a Contact value for the bare jid key"""
self.contacts[key] = value
def __delitem__(self, jid):
"""Remove a contact from the roster"""
jid = JID(jid).bare
if jid not in self.contacts:
return log.debug('not in self.contacts')
contact = self[jid]
for group in list(self.groups.values()):
group.remove(contact)
if not group:
del self.groups[group.name]
del self.contacts[contact.bare_jid]
if jid in self.jids():
try:
self.__node[jid].send_presence(ptype='unavailable')
self.__node.remove(jid)
except IqError:
import traceback
log.debug('IqError when removing %s:\n%s', jid, traceback.format_exc())
def __iter__(self):
"""Iterate over the jids of the contacts"""
return iter(self.contacts.values())
def __contains__(self, key):
"""True if the bare jid is in the roster, false otherwise"""
return JID(key).bare in self.jids()
def get_group(self, name):
"""Return a group or create it if not present"""
if name in self.groups:
return self.groups[name]
self.groups[name] = RosterGroup(name, folded=name in self.folded_groups)
def add(self, jid):
"""Subscribe to a jid"""
self.__node.subscribe(jid)
def jids(self):
"""List of the contact JIDS"""
log.debug('%s' % self.__node.keys())
return [key for key in self.__node.keys() if key not in self.__mucs and key != self.jid]
def get_contacts(self):
"""
Return a list of all the contacts
"""
return [self[jid] for jid in self.jids()]
def save_to_config_file(self):
"""
Save various information to the config file
e.g. the folded groups
"""
folded_groups = ':'.join([group.name for group in self.groups.values()\
if group.folded])
log.debug('folded:%s\n' %folded_groups)
config.set_and_save('folded_roster_groups', folded_groups, 'var')
def get_nb_connected_contacts(self):
n = 0
for contact in self:
if contact.resources:
n += 1
return n
def update_contact_groups(self, contact):
"""Regenerate the RosterGroups when receiving a contact update"""
if not isinstance(contact, Contact):
contact = self[contact]
if not contact:
return
for name, group in self.groups.items():
if name in contact.groups and contact not in group:
group.add(contact)
elif contact in group and name not in contact.groups:
group.remove(contact)
for group in contact.groups:
if not group in self.groups:
self.groups[group] = RosterGroup(group, folded=group in self.folded_groups)
self.groups[group].add(contact)
def __len__(self):
"""
Return the number of line that would be printed
for the whole roster
"""
length = 0
show_offline = config.get('roster_show_offline', 'false') == 'true'
for group in self.groups.values():
if not show_offline and group.get_nb_connected_contacts() == 0:
continue
if not group in self.folded_groups:
for contact in group.get_contacts(self.contact_filter):
# We do not count the offline contacts (depending on config)
if not show_offline and\
len(contact) == 0:
continue
length += 1 # One for the contact's line
if not contact.folded:
# One for each resource, if the contact is unfolded
length += len(contact)
length += 1 # One for the group's line itself
return length
def __repr__(self):
ret = '== Roster:\nContacts:\n'
for contact in self.contacts.values():
ret += '%s\n' % (contact,)
ret += 'Groups\n'
for group in self.groups:
ret += '%s\n' % (group,)
return ret + '\n'
def export(self, path):
"""Export a list of bare jids to a given file"""
if p.isfile(path):
return
try:
f = open(path, 'w+')
f.writelines([i + "\n" for i in self.contacts])
f.close()
return True
except IOError:
return
PRESENCE_PRIORITY = {'unavailable': 0,
'xa': 1,
'away': 2,
'dnd': 3,
'': 4,
'available': 4}
class RosterGroup(object):
"""
A RosterGroup is a group containing contacts
It can be Friends/Family etc, but also can be
Online/Offline or whatever
"""
def __init__(self, name, contacts=[], folded=False):
self.contacts = set(contacts)
self.name = name
self.folded = folded # if the group content is to be shown
def __iter__(self):
"""Iterate over the contacts"""
return iter(self.contacts)
def __repr__(self):
return '<Roster_group: %s; %s>' % (self.name, self.contacts)
def __len__(self):
return len(self.contacts)
def __contains__(self, contact):
"""
Return a bool, telling if the contact is in the group
"""
return contact in self.contacts
def add(self, contact):
"""Add a contact to the group"""
self.contacts.add(contact)
def remove(self, contact):
"""Remove a contact from the group if present"""
if contact in self.contacts:
self.contacts.remove(contact)
def get_contacts(self, contact_filter):
"""Return the group contacts, filtered and sorted"""
def compare_contact(a):
if not a.get_highest_priority_resource():
return 0
show = a.get_highest_priority_resource()
if show not in PRESENCE_PRIORITY:
return 5
return PRESENCE_PRIORITY[show]
contact_list = self.contacts if not contact_filter\
else (contact for contact in self.contacts if contact_filter[0](contact, contact_filter[1]))
return sorted(contact_list, key=compare_contact, reverse=True)
def toggle_folded(self):
self.folded = not self.folded
def get_nb_connected_contacts(self):
l = 0
for contact in self.contacts:
if contact.resources:
l += 1
return l
roster = Roster()
|
