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
|
From e68c539c727c7275665a198fc7a217a3c1ad3be2 Mon Sep 17 00:00:00 2001
From: Birger Schacht <1143280+bisco2@users.noreply.github.com>
Date: Sat, 11 Jul 2020 11:20:53 +0000
Subject: [PATCH] Replace sleekxmpp with slixmpp (#1430)
* Start moving to slixmpp
* Pass a default value for ssl_version to the XMPPConnection
---
.../plugin_development/backend_specifics.rst | 6 +--
errbot/backends/xmpp.py | 49 +++++++++----------
setup.py | 4 +-
diff --git a/errbot/backends/xmpp.py b/errbot/backends/xmpp.py
index 08f49340..e27c2893 100644
--- a/errbot/backends/xmpp.py
+++ b/errbot/backends/xmpp.py
@@ -2,7 +2,6 @@
import sys
from functools import lru_cache
-from threading import Thread
from time import sleep
from errbot.backends.base import Message, Room, Presence, RoomNotJoinedError, Identifier, RoomOccupant, Person
@@ -13,10 +12,10 @@
log = logging.getLogger(__name__)
try:
- from sleekxmpp import ClientXMPP
- from sleekxmpp.xmlstream import resolver, cert
- from sleekxmpp import JID
- from sleekxmpp.exceptions import IqError
+ from slixmpp import ClientXMPP
+ from slixmpp.xmlstream import resolver, cert
+ from slixmpp import JID
+ from slixmpp.exceptions import IqError
except ImportError:
log.exception("Could not start the XMPP backend")
@@ -114,15 +113,10 @@ def join(self, username=None, password=None):
:meth:`create` on it first.
"""
room = str(self)
- self.xep0045.joinMUC(room, username, password=password, wait=True)
+ self.xep0045.join_muc(room, username, password=password, wait=True)
self._bot.conn.add_event_handler(f'muc::{room}::got_online', self._bot.user_joined_chat)
self._bot.conn.add_event_handler(f'muc::{room}::got_offline', self._bot.user_left_chat)
- # Room configuration can only be done once a MUC presence stanza
- # has been received from the server. This HAS to take place in a
- # separate thread because of how SleekXMPP processes these stanzas.
- t = Thread(target=self.configure)
- t.setDaemon(True)
- t.start()
+ self.configure()
self._bot.callback_room_joined(self)
log.info('Joined room %s.', room)
@@ -137,7 +131,7 @@ def leave(self, reason=None):
reason = ""
room = str(self)
try:
- self.xep0045.leaveMUC(room=room, nick=self.xep0045.ourNicks[room], msg=reason)
+ self.xep0045.leave_muc(room=room, nick=self.xep0045.ourNicks[room], msg=reason)
self._bot.conn.del_event_handler(f'muc::{room}::got_online', self._bot.user_joined_chat)
self._bot.conn.del_event_handler(f'muc::{room}::got_offline', self._bot.user_left_chat)
@@ -148,7 +142,7 @@ def leave(self, reason=None):
def create(self):
"""
- Not supported on this back-end (SleekXMPP doesn't support it).
+ Not supported on this back-end (Slixmpp doesn't support it).
Will join the room to ensure it exists, instead.
"""
logging.warning(
@@ -186,7 +180,7 @@ def joined(self):
:getter:
Returns `True` if the room has been joined, `False` otherwise.
"""
- return str(self) in self.xep0045.getJoinedRooms()
+ return str(self) in self.xep0045.get_joined_rooms()
@property
def topic(self):
@@ -214,7 +208,7 @@ def topic(self, topic):
:param topic:
The topic to set.
"""
- # Not supported by SleekXMPP at the moment :(
+ # Not supported by Slixmpp at the moment :(
raise NotImplementedError("Setting the topic is not supported on this back-end.")
@property
@@ -261,16 +255,16 @@ def configure(self):
affiliation = None
while affiliation is None:
sleep(0.5)
- affiliation = self.xep0045.getJidProperty(
+ affiliation = self.xep0045.get_jid_property(
room=room,
- nick=self.xep0045.ourNicks[room],
- jidProperty='affiliation'
+ nick=self.xep0045.our_nicks[room],
+ jid_property='affiliation'
)
if affiliation == "owner":
log.debug('Configuring room %s: we have owner affiliation.', room)
- form = self.xep0045.getRoomConfig(room)
- self.xep0045.configureRoom(room, form)
+ form = yield from self.xep0045.get_room_config(room)
+ self.xep0045.configure_room(room, form)
else:
log.debug("Not configuring room %s: we don't have owner affiliation (affiliation=%s)", room, affiliation)
@@ -291,7 +285,7 @@ def real_jid(self):
Will only work if the errbot is moderator in the MUC or it is not anonymous.
"""
room_jid = self._node + '@' + self._domain
- jid = JID(self._room.xep0045.getJidProperty(room_jid, self.resource, 'jid'))
+ jid = JID(self._room.xep0045.get_jid_property(room_jid, self.resource, 'jid'))
return jid.bare
@property
@@ -303,7 +297,8 @@ def room(self):
class XMPPConnection(object):
def __init__(self, jid, password, feature=None, keepalive=None,
- ca_cert=None, server=None, use_ipv6=None, bot=None):
+ ca_cert=None, server=None, use_ipv6=None, bot=None,
+ ssl_version=None):
if feature is None:
feature = {}
self._bot = bot
@@ -317,7 +312,7 @@ def __init__(self, jid, password, feature=None, keepalive=None,
self.client.register_plugin('xep_0249') # XMPP direct MUC invites
if keepalive is not None:
- self.client.whitespace_keepalive = True # Just in case SleekXMPP's default changes to False in the future
+ self.client.whitespace_keepalive = True # Just in case Slixmpp's default changes to False in the future
self.client.whitespace_keepalive_interval = keepalive
if use_ipv6 is not None:
@@ -348,7 +343,7 @@ def disconnect(self):
self.connected = False
def serve_forever(self):
- self.client.process(block=True)
+ self.client.process()
def add_event_handler(self, name, cb):
self.client.add_event_handler(name, cb)
@@ -447,7 +442,7 @@ def incoming_message(self, xmppmsg):
msg.to = self._build_person(xmppmsg['to'].full)
msg.nick = xmppmsg['mucnick']
- msg.delayed = bool(xmppmsg['delay']._get_attr('stamp')) # this is a bug in sleekxmpp it should be ['from']
+ msg.delayed = bool(xmppmsg['delay']._get_attr('stamp')) # this is a bug in slixmpp it should be ['from']
self.callback_message(msg)
def _idd_from_event(self, event):
@@ -582,7 +577,7 @@ def rooms(self):
A list of :class:`~errbot.backends.base.XMPPMUCRoom` instances.
"""
xep0045 = self.conn.client.plugin['xep_0045']
- return [XMPPRoom(room, self) for room in xep0045.getJoinedRooms()]
+ return [XMPPRoom(room, self) for room in xep0045.get_joined_rooms()]
def query_room(self, room):
"""
diff --git a/setup.py b/setup.py
index 3d0c09f8..4a3c1ea1 100755
--- a/setup.py
+++ b/setup.py
@@ -105,12 +105,12 @@ def read(fname, encoding='ascii'):
},
extras_require={
'graphic': ['PySide', ],
- 'hipchat': ['hypchat', 'sleekxmpp', 'pyasn1', 'pyasn1-modules'],
+ 'hipchat': ['hypchat', 'slixmpp', 'pyasn1', 'pyasn1-modules'],
'IRC': ['irc', ],
'slack': ['slackclient>=1.0.5,<2.0', ],
'slack-rtm': ['slackclient>=2.0', ],
'telegram': ['python-telegram-bot', ],
- 'XMPP': ['sleekxmpp', 'pyasn1', 'pyasn1-modules'],
+ 'XMPP': ['slixmpp', 'pyasn1', 'pyasn1-modules'],
':python_version<"3.7"': ['dataclasses'], # backward compatibility for 3.3->3.6 for dataclasses
':sys_platform!="win32"': ['daemonize'],
},
|
