source: wokkel/muc.py @ 114:a2a47e4df6d5

wokkel-muc-client-support-24
Last change on this file since 114:a2a47e4df6d5 was 114:a2a47e4df6d5, checked in by Christopher Zorn <tofu@…>, 14 years ago

add event for user leaving a room

File size: 19.6 KB
Line 
1# -*- test-case-name: wokkel.test.test_muc -*-
2#
3# Copyright (c) 2003-2008 Ralph Meijer
4# See LICENSE for details.
5
6"""
7XMPP Multi-User Chat protocol.
8
9This protocol is specified in
10U{XEP-0045<http://www.xmpp.org/extensions/xep-0045.html>}.
11"""
12import datetime
13
14from zope.interface import implements
15
16from twisted.internet import defer
17from twisted.words.protocols.jabber import jid, error, xmlstream
18from twisted.words.xish import domish
19
20from wokkel import disco, data_form, shim, xmppim
21from wokkel.subprotocols import IQHandlerMixin, XMPPHandler
22from wokkel.iwokkel import IMUCClient
23
24# Multi User Chat namespaces
25NS          = 'http://jabber.org/protocol/muc'
26NS_USER     = NS + '#user'
27NS_ADMIN    = NS + '#admin'
28NS_OWNER    = NS + '#owner'
29NS_ROOMINFO = NS + '#roominfo'
30NS_CONFIG   = NS + '#roomconfig'
31NS_REQUEST  = NS + '#request'
32NS_REGISTER = NS + '#register'
33
34NS_DELAY    = 'urn:xmpp:delay'
35NS_REQUEST  = 'jabber:iq:register'
36
37# ad hoc commands
38NS_AD_HOC       = "http://jabber.org/protocol/commands"
39
40
41# Iq get and set XPath queries
42IQ     = '/iq'
43IQ_GET = IQ+'[@type="get"]'
44IQ_SET = IQ+'[@type="set"]'
45
46IQ_RESULT = IQ+'[@type="result"]'
47IQ_ERROR  = IQ+'[@type="error"]'
48
49IQ_QUERY     = IQ+'/query'
50IQ_GET_QUERY = IQ_GET + '/query'
51IQ_SET_QUERY = IQ_SET + '/query'
52
53IQ_COMMAND   = IQ+'/command'
54
55MUC_ADMIN = IQ_QUERY+'[@xmlns="' + NS_ADMIN + '"]'
56MUC_OWNER = IQ_QUERY+'[@xmlns="' + NS_OWNER + '"]'
57
58MUC_AO = MUC_ADMIN + '|' + MUC_OWNER
59
60
61MESSAGE  = '/message'
62PRESENCE = '/presence'
63
64CHAT_BODY = MESSAGE +'[@type="chat"]/body'
65CHAT      = MESSAGE +'[@type="chat"]'
66
67GROUPCHAT     = MESSAGE +'[@type="groupchat"]/body'
68SUBJECT       = MESSAGE +'[@type="groupchat"]/subject'
69MESSAGE_ERROR = MESSAGE +'[@type="error"]'
70
71STATUS_CODES = { # see http://www.xmpp.org/extensions/xep-0045.html#registrar-statuscodes
72    100:
73        {'name':'fulljid',
74         'stanza':'presence',
75         
76         },
77    201: 
78        {'name':'created', 
79         'stanza': 'presence',
80         'context':'Entering a room',
81         'purpose':'Inform user that a new room has been created'
82         },   
83}
84
85STATUS_CODE_CREATED = 201
86
87
88class MUCError(error.StanzaError):
89    """
90    Exception with muc specific condition.
91    """
92    def __init__(self, condition, mucCondition, feature=None, text=None):
93        appCondition = domish.Element((NS, mucCondition))
94        if feature:
95            appCondition['feature'] = feature
96        error.StanzaError.__init__(self, condition,
97                                         text=text,
98                                         appCondition=appCondition)
99
100
101class BadRequest(MUCError):
102    """
103    Bad request stanza error.
104    """
105    def __init__(self, mucCondition=None, text=None):
106        MUCError.__init__(self, 'bad-request', mucCondition, text)
107
108
109
110class Unsupported(MUCError):
111    def __init__(self, feature, text=None):
112        MUCError.__init__(self, 'feature-not-implemented',
113                          'unsupported',
114                          feature,
115                          text)
116
117
118
119class ConfigureRequest(xmlstream.IQ):
120    """
121    Configure MUC room request.
122
123    http://xmpp.org/extensions/xep-0045.html#roomconfig
124
125    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
126    @type method: C{str}
127    """
128
129    def __init__(self, xs, method='get', fields=[]):
130        xmlstream.IQ.__init__(self, xs, method)
131        q = self.addElement((NS_OWNER, 'query'))
132        if method == 'set':
133            # build data form
134            form = data_form.Form('submit', formNamespace=NS_CONFIG)
135            q.addChild(form.toElement())
136           
137            for f in fields:
138                # create a field
139                form.addField(f)
140
141
142class RegisterRequest(xmlstream.IQ):
143    """
144    Register room request.
145
146    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
147    @type method: C{str}
148
149    """
150
151    def __init__(self, xs, method='get', fields=[]):
152        xmlstream.IQ.__init__(self, xs, method)
153        q = self.addElement((NS_REQUEST, 'query'))
154        if method == 'set':
155            # build data form
156            form_type = 'submit'       
157            form = data_form.Form(form_type, formNamespace=NS_REGISTER)
158            q.addChild(form.toElement())       
159           
160            for f in fields:
161                # create a field
162                form.addField(f)
163
164
165class AffiliationRequest(xmlstream.IQ):
166    """
167    Register room request.
168
169    @ivar method: Type attribute of the IQ request. Either C{'set'} or C{'get'}
170    @type method: C{str}
171
172    @ivar affiliation: The affiliation type to send to room.
173    @type affiliation: C{str}
174
175    """
176
177    def __init__(self, xs, method='get', affiliation='none', a_jid=None, reason=None):
178        xmlstream.IQ.__init__(self, xs, method)
179       
180        q = self.addElement((NS_ADMIN, 'query'))
181        i = q.addElement('item')
182
183        i['affiliation'] = affiliation
184        if a_jid:
185            i['jid'] = a_jid.full()
186           
187        if reason:
188            i.addElement('reason', None, reason)
189
190           
191       
192
193class GroupChat(domish.Element):
194    """
195    """
196    def __init__(self, to, body=None, subject=None, frm=None):
197        """To needs to be a string
198        """
199        domish.Element.__init__(self, (None, 'message'))
200        self['type'] = 'groupchat'
201        self['to']   = to
202        if frm:
203            self['from'] = frm
204        if body:
205            self.addElement('body',None, body)
206        if subject:
207            self.addElement('subject',None, subject)
208
209
210class PrivateChat(domish.Element):
211    """
212    """
213    def __init__(self, to, body=None, frm=None):
214        """To needs to be a string
215        """
216        domish.Element.__init__(self, (None, 'message'))
217        self['type'] = 'chat'
218        self['to']   = to
219        if frm:
220            self['from'] = frm
221        if body:
222            self.addElement('body',None, body)
223           
224class InviteMessage(PrivateChat):
225    def __init__(self, to, reason=None, full_jid=None, body=None, frm=None, password=None):
226        PrivateChat.__init__(self, to, body=body, frm=frm)
227        del self['type'] # remove type
228        x = self.addElement('x', NS_USER)
229        invite = x.addElement('invite')
230        if full_jid:
231            invite['to'] = full_jid
232        if reason:
233            invite.addElement('reason', None, reason)
234        if password:
235            invite.addElement('password', None, password)
236
237class HistoryMessage(GroupChat):
238    """
239    """
240    def __init__(self, to, stamp, body=None, subject=None, frm=None, h_frm=None):
241        GroupChat.__init__(self, to, body=body, subject=subject, frm=frm)
242        d = self.addElement('delay', NS_DELAY)
243        d['stamp'] = stamp
244        if h_frm:
245            d['from'] = h_frm
246
247class User(object):
248    """
249    A user/entity in a multi-user chat room.
250    """
251   
252    def __init__(self, nick, user_jid=None):
253        self.nick = nick
254        self.user_jid = user_jid
255        self.affiliation = 'none'
256        self.role = 'none'
257       
258        self.status = None
259        self.show   = None
260
261
262class Room(object):
263    """
264    A Multi User Chat Room
265    """
266
267   
268    def __init__(self, name, server, nick, state=None):
269        """
270        """
271        self.state  = state
272        self.name   = name
273        self.server = server
274        self.nick   = nick
275        self.status = 0
276
277        self.entity_id = jid.internJID(name+'@'+server+'/'+nick)
278               
279        self.roster = {}
280
281       
282
283    def addUser(self, user):
284        """
285        """
286        self.roster[user.nick.lower()] = user
287
288    def inRoster(self, user):
289        """
290        """
291
292        return self.roster.has_key(user.nick.lower())
293
294    def getUser(self, nick):
295        """
296        """
297        return self.roster.get(nick.lower())
298
299    def removeUser(self, user):
300        if self.inRoster(user):
301            del self.roster[user.nick.lower()]
302       
303
304class BasicPresence(xmppim.AvailablePresence):
305    """
306    This behaves like an object providing L{domish.IElement}.
307
308    """
309
310    def __init__(self, to=None, show=None, statuses=None):
311        xmppim.AvailablePresence.__init__(self, to=to, show=show, statuses=statuses)
312        # add muc elements
313        x = self.addElement('x', NS)
314
315
316class UserPresence(xmppim.Presence):
317    """
318    This behaves like an object providing L{domish.IElement}.
319
320    """
321
322    def __init__(self, to=None, type=None, frm=None, affiliation=None, role=None):
323        xmppim.Presence.__init__(self, to, type)
324        if frm:
325            self['from'] = frm
326        # add muc elements
327        x = self.addElement('x', NS_USER)
328        if affiliation:
329            x['affiliation'] = affiliation
330        if role:
331            x['role'] = role
332
333
334class PasswordPresence(BasicPresence):
335    """
336    """
337    def __init__(self, to, password):
338        BasicPresence.__init__(self, to)
339       
340        self.x.addElement('password', None, password)
341
342
343class MessageVoice(GroupChat):
344    """
345    """
346    def __init__(self, to=None, frm=None):
347        GroupChat.__init__(self, to=to, frm=frm)
348        # build data form
349        form = data_form.Form('submit', formNamespace=NS_REQUEST)
350        form.addField(data_form.Field(var='muc#role',
351                                      value='participant', 
352                                      label='Requested role'))
353        self.addChild(form.toElement())           
354
355class PresenceError(xmppim.Presence):
356    """
357    This behaves like an object providing L{domish.IElement}.
358
359    """
360
361    def __init__(self, error, to=None, frm=None):
362        xmppim.Presence.__init__(self, to, type='error')
363        if frm:
364            self['from'] = frm
365        # add muc elements
366        x = self.addElement('x', NS)
367        # add error
368        self.addChild(error)
369       
370
371class MUCClient(XMPPHandler):
372    """
373    Multi-User chat client protocol.
374    """
375
376    implements(IMUCClient)
377
378    rooms = {}
379
380    def connectionInitialized(self):
381        self.xmlstream.addObserver(PRESENCE+"[not(@type) or @type='available']/x", self._onXPresence)
382        self.xmlstream.addObserver(PRESENCE+"[@type='unavailable']", self._onUnavailablePresence)
383        self.xmlstream.addObserver(PRESENCE+"[@type='error']", self._onPresenceError)
384        self.xmlstream.addObserver(GROUPCHAT, self._onGroupChat)
385        self.xmlstream.addObserver(SUBJECT, self._onSubject)
386        # add history
387
388
389    def _setRoom(self, room):
390        self.rooms[room.entity_id.userhost().lower()] = room
391
392    def _getRoom(self, room_jid):
393        return self.rooms.get(room_jid.userhost().lower())
394
395    def _removeRoom(self, room_jid):
396        if self.rooms.has_key(room_jid.userhost().lower()):
397            del self.rooms[room_jid.userhost().lower()]
398
399
400    def _onUnavailablePresence(self, prs):
401        """
402        """
403        if not prs.hasAttribute('from'):
404            return
405        room_jid = jid.internJID(prs.getAttribute('from', ''))
406        self._userLeavesRoom(room_jid)
407
408    def _onPresenceError(self, prs):
409        """
410        """
411        if not prs.hasAttribute('from'):
412            return
413        room_jid = jid.internJID(prs.getAttribute('from', ''))
414        # add an error hook here?
415        self._userLeavesRoom(room_jid)
416
417    def _userLeavesRoom(self, room_jid):
418        room = self._getRoom(room_jid)
419        if room is None:
420            # not in the room yet
421            return
422        # check if user is in roster
423        user = room.getUser(room_jid.resource)
424        if user is None:
425            return
426        if room.inRoster(user):
427            room.removeUser(user)
428            self.userLeftRoom(room, user)
429       
430    def _onXPresence(self, prs):
431        """
432        """
433        if not prs.hasAttribute('from'):
434            return
435        room_jid = jid.internJID(prs.getAttribute('from', ''))
436           
437        status = getattr(prs, 'status', None)
438        show   = getattr(prs, 'show', None)
439       
440        # grab room
441        room = self._getRoom(room_jid)
442        if room is None:
443            # not in the room yet
444            return
445
446        # check if user is in roster
447        user = room.getUser(room_jid.resource)
448        if user is None: # create a user that does not exist
449            user = User(room_jid.resource)
450           
451       
452        if room.inRoster(user):
453            # we changed status or nick
454            muc_status = getattr(prs.x, 'status', None)
455            if muc_status:
456                code = muc_status.getAttribute('code', 0)
457            else:
458                self.userUpdatedStatus(room, user, show, status)
459        else:           
460            room.addUser(user)
461            self.userJoinedRoom(room, user)
462           
463
464    def _onGroupChat(self, msg):
465        """
466        """
467        if not msg.hasAttribute('from'):
468            # need to return an error here
469            return
470        room_jid = jid.internJID(msg.getAttribute('from', ''))
471
472        room = self._getRoom(room_jid)
473        if room is None:
474            # not in the room yet
475            return
476        user = room.getUser(room_jid.resource)
477
478        delay = getattr(msg, 'delay', None)
479        body  = unicode(msg.body)
480        # grab room
481        if delay is None:
482            self.receivedGroupChat(room, user, body)
483        else:
484            self.receivedHistory(room, user, body, delay['stamp'], frm=delay.getAttribute('from',None))
485
486
487    def _onSubject(self, msg):
488        """
489        """
490        if not msg.hasAttribute('from'):
491            return
492        room_jid = jid.internJID(msg['from'])
493
494        # grab room
495        room = self._getRoom(room_jid)
496        if room is None:
497            # not in the room yet
498            return
499
500        self.receivedSubject(room_jid, unicode(msg.subject))
501
502
503    def _makeTimeStamp(self, stamp=None):
504        if stamp is None:
505            stamp = datetime.datetime.now()
506           
507        return stamp.strftime('%Y%m%dT%H:%M:%S')
508
509
510    def _joinedRoom(self, d, prs):
511        """We have presence that says we joined a room.
512        """
513        room_jid = jid.internJID(prs['from'])
514       
515        # check for errors
516        if prs.hasAttribute('type') and prs['type'] == 'error':           
517            d.errback(prs)
518        else:   
519            # change the state of the room
520            r = self._getRoom(room_jid)
521            if r is None:
522                raise Exception, 'Room Not Found' 
523            r.state = 'joined'
524           
525            # grab status
526            status = getattr(prs.x,'status',None)
527            if status:
528                r.status = status.getAttribute('code', None)
529
530            d.callback(r)
531
532
533    def _leftRoom(self, d, prs):
534        """We have presence that says we joined a room.
535        """
536        room_jid = jid.internJID(prs['from'])
537       
538        # check for errors
539        if prs.hasAttribute('type') and prs['type'] == 'error':           
540            d.errback(prs)
541        else:   
542            # change the state of the room
543            r = self._getRoom(room_jid)
544            if r is None:
545                raise Exception, 'Room Not Found' 
546            self._removeRoom(room_jid)
547           
548            d.callback(True)
549
550    def userJoinedRoom(self, room, user):
551        """User has joined a room
552        """
553        pass
554
555    def userLeftRoom(self, room, user):
556        """User has left a room
557        """
558        pass
559
560
561    def userUserUpdatedStatus(self, room, user, show, status):
562        """User Presence has been received
563        """
564        pass
565       
566
567    def receivedSubject(self, room, subject):
568        """
569        """
570        pass
571
572
573    def receivedHistory(self, room, user, message, history, frm=None):
574        """
575        """
576        pass
577
578
579    def _cbDisco(self, iq):
580        # grab query
581       
582        return getattr(iq,'query', None)
583       
584    def disco(self, entity, type='info'):
585        """Send disco queries to a XMPP entity
586        """
587
588        iq = disco.DiscoRequest(self.xmlstream, disco.NS_INFO, 'get')
589        iq['to'] = entity
590
591        return iq.send().addBoth(self._cbDisco)
592       
593
594    def configure(self, room_jid, fields=[]):
595        """Configure a room
596        """
597        request = ConfigureRequest(self.xmlstream, method='set', fields=fields)
598        request['to'] = room_jid
599       
600        return request.send()
601
602    def getConfigureForm(self, room_jid):
603        request = ConfigureRequest(self.xmlstream)
604        request['to'] = room_jid
605        return request.send()
606
607
608    def join(self, server, room, nick):
609        """
610        """
611        d = defer.Deferred()
612        r = Room(room, server, nick, state='joining')
613        self._setRoom(r)
614 
615        p = BasicPresence(to=r.entity_id)
616        # p['from'] = self.jid.full()
617        self.xmlstream.send(p)
618
619        # add observer for joining the room
620        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s']" % (r.entity_id.full()), 
621                                          self._joinedRoom, 1, d)
622
623        return d
624   
625
626   
627    def leave(self, room_jid):
628        """
629        """
630        d = defer.Deferred()
631
632        r = self._getRoom(room_jid)
633 
634        p = xmppim.UnavailablePresence(to=r.entity_id)
635        # p['from'] = self.jid.full()
636        self.xmlstream.send(p)
637
638        # add observer for joining the room
639        self.xmlstream.addOnetimeObserver(PRESENCE+"[@from='%s' and @type='unavailable']" % (r.entity_id.full()), 
640                                          self._leftRoom, 1, d)
641
642        return d
643   
644
645   
646
647    def _sendMessage(self, msg, children=None):
648
649        if children:
650            for c in children:
651                msg.addChild(c)
652       
653        self.xmlstream.send(msg)
654
655    def groupChat(self, to, message, children=None):
656        """Send a groupchat message
657        """
658        msg = GroupChat(to, body=message)
659       
660        self._sendMessage(msg, children=children)
661
662    def chat(self, to, message, children=None):
663        msg = PrivateChat(to, body=message)
664
665        self._sendMessage(msg, children=children)
666       
667    def invite(self, to, reason=None, full_jid=None):
668        """
669        """
670        msg = InviteMessage(to, reason=reason, full_jid=full_jid)
671        self._sendMessage(msg)
672
673
674    def password(self, to, password):
675        p = PasswordPresence(to, password)
676
677        self.xmlstream.send(p)
678   
679    def register(self, to, fields=[]):
680        iq = RegisterRequest(self.xmlstream, method='set', fields=fields)
681        iq['to'] = to
682        return iq.send()
683
684    def getRegisterForm(self, room):
685        """
686        """
687        iq = RegisterRequest(self.xmlstream)
688        iq['to'] = room.userhost()
689        return iq.send()
690
691    def subject(self, to, subject):
692        """
693        """
694        msg = GroupChat(to, subject=subject)
695        self.xmlstream.send(msg)
696
697    def voice(self, to):
698        """
699        """
700        msg = MessageVoice(to=to)
701        self.xmlstream.send(msg)
702
703
704    def history(self, to, message_list):
705        """
706        """
707       
708        for m in message_list:
709            m['type'] = 'groupchat'
710            mto = m['to']
711            frm = m.getAttribute('from', None)
712            m['to'] = to
713
714            d = m.addElement('delay', NS_DELAY)
715            d['stamp'] = self._makeTimeStamp()
716            d['from'] = mto
717
718            self.xmlstream.send(m)
719
720    def ban(self, to, ban_jid, frm, reason=None):
721       
722        iq = AffiliationRequest(self.xmlstream,
723                                method='set',
724                                affiliation='outcast', 
725                                a_jid=ban_jid, 
726                                reason=reason)
727        iq['to'] = to.userhost() # this is a room jid, only send to room
728        iq['from'] = frm.full()
729        return iq.send()
730
731
732    def kick(self, to, kick_jid, frm, reason=None):
733       
734        iq = AffiliationRequest(self.xmlstream,
735                                method='set',
736                                a_jid=kick_jid, 
737                                reason=reason)
738        iq['to'] = to.userhost() # this is a room jid, only send to room
739        iq['from'] = frm.full()
740        return iq.send()
Note: See TracBrowser for help on using the repository browser.