Changeset 160:33ef849a77d8 for wokkel/muc.py

Timestamp:

Jan 8, 2012, 9:26:02 AM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Use symbolic constants instead of integers MUC status code.

Instead of using normal constant values for representing MUC status codes,
UserPresence now uses twisted.python.constants to define these. This
makes code better to understand and helps debugging.

If a user presence includes one or more status codes, they are stored in the
mucStatuses attribute, as an instance of Statuses. This replaces the
former statusCodes attribute.

File:

• wokkel/muc.py (modified) (7 diffs)

wokkel/muc.py

@@ -8 +8 @@
 
 This protocol is specified in
-U{XEP-0045<http://www.xmpp.org/extensions/xep-0045.html>}.
+U{XEP-0045<http://xmpp.org/extensions/xep-0045.html>}.
 """
 from dateutil.tz import tzutc
@@ -18 +18 @@
 from twisted.words.xish import domish
 
-from wokkel import data_form, generic, xmppim
+from wokkel import data_form, generic, iwokkel, xmppim
+from wokkel.compat import Values, ValueConstant
 from wokkel.delay import Delay, DelayMixin
 from wokkel.subprotocols import XMPPHandler
@@ -41 +42 @@
 
 DEFER_TIMEOUT = 30 # basic timeout is 30 seconds
+
+class STATUS_CODE(Values):
+    REALJID_PUBLIC = ValueConstant(100)
+    AFFILIATION_CHANGED = ValueConstant(101)
+    UNAVAILABLE_SHOWN = ValueConstant(102)
+    UNAVAILABLE_NOT_SHOWN = ValueConstant(103)
+    CONFIGURATION_CHANGED = ValueConstant(104)
+    SELF_PRESENCE = ValueConstant(110)
+    LOGGING_ENABLED = ValueConstant(170)
+    LOGGING_DISABLED = ValueConstant(171)
+    NON_ANONYMOUS = ValueConstant(172)
+    SEMI_ANONYMOUS = ValueConstant(173)
+    FULLY_ANONYMOUS = ValueConstant(174)
+    ROOM_CREATED = ValueConstant(201)
+    NICK_ASSIGNED = ValueConstant(210)
+    BANNED = ValueConstant(301)
+    NEW_NICK = ValueConstant(303)
+    KICKED = ValueConstant(307)
+    REMOVED_AFFILIATION = ValueConstant(321)
+    REMOVED_MEMBERSHIP = ValueConstant(322)
+    REMOVED_SHUTDOWN = ValueConstant(332)
+
+
+class Statuses(set):
+    """
+    Container of MUC status conditions.
+
+    This is currently implemented as a set of constant values from
+    L{STATUS_CODE}. Instances of this class provide L{IMUCStatuses}, that
+    defines the supported operations. Even though this class currently derives
+    from C{set}, future versions might not. This provides an upgrade path to
+    cater for extensible status conditions, as defined in
+    U{XEP-0306<http://xmpp.org/extensions/xep-0306.html>}.
+    """
+    implements(iwokkel.IMUCStatuses)
 
 
@@ -354 +390 @@
     """
     Availability presence sent from MUC service to client.
+
+    @ivar affiliation: Affiliation of the entity to the room.
+    @type affiliation: C{unicode}
+
+    @ivar role: Role of the entity in the room.
+    @type role: C{unicode}
+
+    @ivar entity: The real JID of the entity this presence is from.
+    @type entity: L{jid.JID}
+
+    @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.
+        See L{Statuses} for usage notes.
+    @type mucStatuses: L{Statuses}
+
+    @ivar nick: The nick name of the entity in the room.
+    @type nick: C{unicode}
     """
 
@@ -361 +413 @@
     nick = None
 
-    statusCodes = None
+    mucStatuses = None
 
     childParsers = {(NS_MUC_USER, 'x'): '_childParser_mucUser'}
 
+    def __init__(self, *args, **kwargs):
+        self.mucStatuses = Statuses()
+        xmppim.AvailabilityPresence.__init__(self, *args, **kwargs)
+
+
     def _childParser_mucUser(self, element):
-        statusCodes = set()
-
+        """
+        Parse the MUC user extension element.
+        """
         for child in element.elements():
             if child.uri != NS_MUC_USER:
@@ -374 +432 @@
             elif child.name == 'status':
                 try:
-                    statusCode = int(child.getAttribute('code'))
+                    value = int(child.getAttribute('code'))
+                    statusCode = STATUS_CODE.lookupByValue(value)
                 except (TypeError, ValueError):
                     continue
 
-                statusCodes.add(statusCode)
+                self.mucStatuses.add(statusCode)
 
             elif child.name == 'item':
@@ -393 +452 @@
             # TODO: destroy
 
-        if statusCodes:
-            self.statusCodes = statusCodes