Added support for GMCP out-of-band messaging, as a backup handler to MSDP. Starting to rework the oob system to be more straightforward to follow and understand.

evennia/server/portal/portalsessionhandler.py

@@ -179,6 +179,71 @@ class PortalSessionHandler(SessionHandler):
         return [sess for sess in self.get_sessions(include_unloggedin=True)
                 if hasattr(sess, 'suid') and sess.suid == suid]
 
+    def announce_all(self, message):
+        """
+        Send message to all connection sessions
+        """
+        for session in self.sessions.values():
+            session.data_out(message)
+
+    def oobstruct_parser(self, oobstruct):
+        """
+         Helper method for each session to use to parse oob structures
+         (The 'oob' kwarg of the msg() method).
+
+         Allowed input oob structures are:
+                 cmdname
+                ((cmdname,), (cmdname,))
+                (cmdname,(arg, ))
+                (cmdname,(arg1,arg2))
+                (cmdname,{key:val,key2:val2})
+                (cmdname, (args,), {kwargs})
+                ((cmdname, (arg1,arg2)), cmdname, (cmdname, (arg1,)))
+        outputs an ordered structure on the form
+                ((cmdname, (args,), {kwargs}), ...), where the two last
+                                              parts of each tuple may be empty
+        """
+        def _parse(oobstruct):
+            slen = len(oobstruct)
+            if not oobstruct:
+                return tuple(None, (), {})
+            elif not hasattr(oobstruct, "__iter__"):
+                # a singular command name, without arguments or kwargs
+                return (oobstruct, (), {})
+            # regardless of number of args/kwargs, the first element must be
+            # the function name. We will not catch this error if not, but
+            # allow it to propagate.
+            if slen == 1:
+                return (oobstruct[0], (), {})
+            elif slen == 2:
+                if isinstance(oobstruct[1], dict):
+                    # cmdname, {kwargs}
+                    return (oobstruct[0], (), dict(oobstruct[1]))
+                elif isinstance(oobstruct[1], (tuple, list)):
+                    # cmdname, (args,)
+                    return (oobstruct[0], list(oobstruct[1]), {})
+                else:
+                    # cmdname, cmdname
+                    return ((oobstruct[0], (), {}), (oobstruct[1].lower(), (), {}))
+            else:
+                # cmdname, (args,), {kwargs}
+                return (oobstruct[0], list(oobstruct[1]), dict(oobstruct[2]))
+
+        if hasattr(oobstruct, "__iter__"):
+            # differentiate between (cmdname, cmdname),
+            # (cmdname, (args), {kwargs}) and ((cmdname,(args),{kwargs}),
+            # (cmdname,(args),{kwargs}), ...)
+
+            if oobstruct and isinstance(oobstruct[0], basestring):
+                return (list(_parse(oobstruct)),)
+            else:
+                out = []
+                for oobpart in oobstruct:
+                    out.append(_parse(oobpart))
+                return (list(out),)
+        return (_parse(oobstruct),)
+
+
     def data_in(self, session, text="", **kwargs):
         """
         Called by portal sessions for relaying data coming
@@ -189,20 +254,17 @@ class PortalSessionHandler(SessionHandler):
                                                               msg=text,
                                                               data=kwargs)
 
-    def announce_all(self, message):
-        """
-        Send message to all connection sessions
-        """
-        for session in self.sessions.values():
-            session.data_out(message)
-
     def data_out(self, sessid, text=None, **kwargs):
         """
         Called by server for having the portal relay messages and data
-        to the correct session protocol.
+        to the correct session protocol. We also convert oob input to
+        a generic form here.
         """
         session = self.sessions.get(sessid, None)
         if session:
+            # convert oob to the generic format
+            if "oob" in kwargs:
+                kwargs["oob"] = self.oobstruct_parser(kwargs["oob"])
             session.data_out(text=text, **kwargs)
 
 PORTAL_SESSIONS = PortalSessionHandler()