'get-online-users-list' ad-hoc command implementation

darcs-hash:20070812200958-86b55-af938c4e80728d7c4fcba2e03518a361e4e8794c.gz

src/jcl/jabber/command.py

@@ -255,7 +255,7 @@ class JCLCommandManager(CommandManager):
                               "http://jabber.org/protocol/admin#get-online-users-num",
                               "http://jabber.org/protocol/admin#get-registered-users-list",
                               "http://jabber.org/protocol/admin#get-disabled-users-list",
-                              "http://jabber.org/protocol/admin#get-online-users",
+                              "http://jabber.org/protocol/admin#get-online-users-lists",
                               "http://jabber.org/protocol/admin#announce",
                               "http://jabber.org/protocol/admin#set-motd",
                               "http://jabber.org/protocol/admin#edit-motd",
@@ -353,6 +353,25 @@ class JCLCommandManager(CommandManager):
         result_form.as_xml(command_node)
         return (result_form, [])
 
+    def add_form_list_accounts(self, command_node, lang_class,
+                               var_name, var_label,
+                               filter=None, limit=None):
+        result_form = Form(xmlnode_or_type="result")
+        result_form.add_field(field_type="hidden",
+                              name="FORM_TYPE",
+                              value="http://jabber.org/protocol/admin")
+        accounts = account.get_all_accounts(filter=filter, limit=limit)
+        accounts_labels = []
+        for _account in accounts:
+            accounts_labels += [_account.user_jid + " (" + _account.name
+                                + " " + str(_account.__class__.__name__) + ")"]
+        result_form.fields.append(FieldNoType(name=var_name,
+                                              label=var_label,
+                                              values=accounts_labels))
+        result_form.as_xml(command_node)
+        command_node.setProp("status", STATUS_COMPLETED)
+        return (result_form, [])
+
     def select_user_jids_step_1(self, info_query, session_context,
                                 command_node, lang_class):
         self.__logger.debug("Executing select_user_jids step 1")
@@ -669,29 +688,12 @@ class JCLCommandManager(CommandManager):
         command_node.setProp("status", STATUS_COMPLETED)
         return (result_form, [])
 
-    def add_form_list_accounts(self, command_node, lang_class,
-                               filter=None, limit=None):
-        result_form = Form(xmlnode_or_type="result")
-        result_form.add_field(field_type="hidden",
-                              name="FORM_TYPE",
-                              value="http://jabber.org/protocol/admin")
-        accounts = account.get_all_accounts(filter=filter, limit=limit)
-        accounts_labels = []
-        for _account in accounts:
-            accounts_labels += [_account.user_jid + " (" + _account.name
-                                + " " + str(_account.__class__.__name__) + ")"]
-        result_form.fields.append(FieldNoType(name="registeredusers",
-                                              label="TODO",
-                                              values=accounts_labels))
-        result_form.as_xml(command_node)
-        command_node.setProp("status", STATUS_COMPLETED)
-        return (result_form, [])
-
     def execute_get_registered_users_list_1(self, info_query, session_context,
                                             command_node, lang_class):
         num_accounts = account.get_all_accounts_count()
         if num_accounts < 25:
-            return self.add_form_list_accounts(command_node, lang_class)
+            return self.add_form_list_accounts(command_node, lang_class,
+                                               "registeredusers", "TODO")
         else:
             return self.add_form_select_max(command_node, lang_class)
 
@@ -699,6 +701,7 @@ class JCLCommandManager(CommandManager):
                                             command_node, lang_class):
         limit = int(session_context["max_items"][0])
         return self.add_form_list_accounts(command_node, lang_class,
+                                           "registeredusers", "TODO",
                                            limit=limit)
 
     def execute_get_disabled_users_list_1(self, info_query, session_context,
@@ -706,6 +709,7 @@ class JCLCommandManager(CommandManager):
         num_accounts = account.get_all_accounts_count()
         if num_accounts < 25:
             return self.add_form_list_accounts(command_node, lang_class,
+                                               "disabledusers", "TODO",
                                                filter=(Account.q.enabled == False))
         else:
             return self.add_form_select_max(command_node, lang_class)
@@ -714,11 +718,29 @@ class JCLCommandManager(CommandManager):
                                           command_node, lang_class):
         limit = int(session_context["max_items"][0])
         return self.add_form_list_accounts(command_node, lang_class,
+                                           "disabledusers", "TODO",
                                            limit=limit,
                                            filter=(Account.q.enabled == False))
 
-    def execute_get_online_users(self, info_query):
+    def execute_get_online_users_list_1(self, info_query, session_context,
-        return []
+                                        command_node, lang_class):
+        num_accounts = account.get_all_accounts_count()
+        if num_accounts < 25:
+            return self.add_form_list_accounts(\
+                command_node, lang_class,
+                "onlineusers", "TODO",
+                filter=(Account.q._status != account.OFFLINE))
+        else:
+            return self.add_form_select_max(command_node, lang_class)
+
+    def execute_get_online_users_list_2(self, info_query, session_context,
+                                        command_node, lang_class):
+        limit = int(session_context["max_items"][0])
+        return self.add_form_list_accounts(\
+            command_node, lang_class,
+            "onlineusers", "TODO",
+            limit=limit,
+            filter=(Account.q._status != account.OFFLINE))
 
     def execute_get_active_users(self, info_query):
         return []

src/jcl/jabber/tests/command.py

@@ -1835,7 +1835,7 @@ class JCLCommandManager_TestCase(JCLTestCase):
                                       {"c": "http://jabber.org/protocol/commands",
                                        "data": "jabber:x:data"})
         self.assertEquals(len(fields), 2)
-        self.assertEquals(fields[1].prop("var"), "registeredusers")
+        self.assertEquals(fields[1].prop("var"), "disabledusers")
         values = result[0].xpath_eval("c:command/data:x/data:field[2]/data:value",
                                       {"c": "http://jabber.org/protocol/commands",
                                        "data": "jabber:x:data"})
@@ -1944,7 +1944,174 @@ class JCLCommandManager_TestCase(JCLTestCase):
         self.assertEquals(fields[0].children.name, "value")
         self.assertEquals(fields[0].children.content,
                           "http://jabber.org/protocol/admin")
-        self.assertEquals(fields[1].prop("var"), "registeredusers")
+        self.assertEquals(fields[1].prop("var"), "disabledusers")
+        values = result[0].xpath_eval("c:command/data:x/data:field[2]/data:value",
+                                      {"c": "http://jabber.org/protocol/commands",
+                                       "data": "jabber:x:data"})
+        self.assertEquals(len(values), 25)
+        i = 0
+        while i < 12:
+            self.assertEquals(values[i * 2].content,
+                              "test1@test.com (account11" + str(i)
+                              + " ExampleAccount)")
+            self.assertEquals(values[i * 2 + 1].content,
+                              "test2@test.com (account2" + str(i)
+                              + " ExampleAccount)")
+            i += 1
+        self.assertEquals(values[24].content,
+                          "test1@test.com (account1112 ExampleAccount)")
+
+    def test_execute_get_online_users_list(self):
+        self.comp.account_manager.account_classes = (ExampleAccount,
+                                                     Example2Account)
+        model.db_connect()
+        account11 = ExampleAccount(user_jid="test1@test.com",
+                                   name="account11",
+                                   jid="account11@jcl.test.com")
+        account11.status = account.ONLINE
+        account12 = Example2Account(user_jid="test1@test.com",
+                                    name="account12",
+                                    jid="account12@jcl.test.com")
+        account12.status = "away"
+        account21 = ExampleAccount(user_jid="test2@test.com",
+                                   name="account21",
+                                   jid="account21@jcl.test.com")
+        account22 = ExampleAccount(user_jid="test2@test.com",
+                                   name="account11",
+                                   jid="account11@jcl.test.com")
+        account22.status = "xa"
+        model.db_disconnect()
+        info_query = Iq(stanza_type="set",
+                        from_jid="user1@test.com",
+                        to_jid="jcl.test.com")
+        command_node = info_query.set_new_content(command.COMMAND_NS, "command")
+        command_node.setProp("node",
+                             "http://jabber.org/protocol/admin#get-online-users-list")
+        result = self.command_manager.apply_command_action(\
+            info_query,
+            "http://jabber.org/protocol/admin#get-online-users-list",
+            "execute")
+        self.assertNotEquals(result, None)
+        self.assertEquals(len(result), 1)
+        xml_command = result[0].xpath_eval("c:command",
+                                           {"c": "http://jabber.org/protocol/commands"})[0]
+        self.assertEquals(xml_command.prop("status"), "completed")
+        self.assertNotEquals(xml_command.prop("sessionid"), None)
+        self.__check_actions(result[0])
+        fields = result[0].xpath_eval("c:command/data:x/data:field",
+                                      {"c": "http://jabber.org/protocol/commands",
+                                       "data": "jabber:x:data"})
+        self.assertEquals(len(fields), 2)
+        self.assertEquals(fields[1].prop("var"), "onlineusers")
+        values = result[0].xpath_eval("c:command/data:x/data:field[2]/data:value",
+                                      {"c": "http://jabber.org/protocol/commands",
+                                       "data": "jabber:x:data"})
+        self.assertEquals(len(values), 3)
+        self.assertEquals(values[0].content,
+                          "test1@test.com (account11 ExampleAccount)")
+        self.assertEquals(values[1].content,
+                          "test1@test.com (account12 Example2Account)")
+        self.assertEquals(values[2].content,
+                          "test2@test.com (account11 ExampleAccount)")
+
+    def test_execute_get_online_users_list_max(self):
+        self.comp.account_manager.account_classes = (ExampleAccount,
+                                                     Example2Account)
+        model.db_connect()
+        for i in xrange(20):
+            _account = ExampleAccount(user_jid="test1@test.com",
+                                      name="account11" + str(i),
+                                      jid="account11" + str(i)
+                                      + "@jcl.test.com")
+            _account.status = account.ONLINE
+            Example2Account(user_jid="test1@test.com",
+                            name="account12" + str(i),
+                            jid="account12" + str(i) + "@jcl.test.com")
+            _account = ExampleAccount(user_jid="test2@test.com",
+                                      name="account2" + str(i),
+                                      jid="account2" + str(i)
+                                      + "@jcl.test.com")
+            _account.status = "away"
+        model.db_disconnect()
+        info_query = Iq(stanza_type="set",
+                        from_jid="user1@test.com",
+                        to_jid="jcl.test.com")
+        command_node = info_query.set_new_content(command.COMMAND_NS, "command")
+        command_node.setProp("node",
+                             "http://jabber.org/protocol/admin#get-online-users-list")
+        result = self.command_manager.apply_command_action(\
+            info_query,
+            "http://jabber.org/protocol/admin#get-online-users-list",
+            "execute")
+        self.assertNotEquals(result, None)
+        self.assertEquals(len(result), 1)
+        xml_command = result[0].xpath_eval("c:command",
+                                           {"c": "http://jabber.org/protocol/commands"})[0]
+        self.assertEquals(xml_command.prop("status"), "executing")
+        self.assertNotEquals(xml_command.prop("sessionid"), None)
+        self.__check_actions(result[0], ["next"])
+        fields = result[0].xpath_eval("c:command/data:x/data:field",
+                                      {"c": "http://jabber.org/protocol/commands",
+                                       "data": "jabber:x:data"})
+        self.assertEquals(len(fields), 2)
+        self.assertEquals(fields[1].prop("var"), "max_items")
+        self.assertEquals(fields[1].prop("type"), "list-single")
+        options = result[0].xpath_eval("c:command/data:x/data:field[2]/data:option",
+                                       {"c": "http://jabber.org/protocol/commands",
+                                        "data": "jabber:x:data"})
+        self.assertEquals(len(options), 6)
+        self.assertEquals(options[0].prop("label"), "25")
+        self.assertEquals(options[0].content, "25")
+        self.assertEquals(options[1].prop("label"), "50")
+        self.assertEquals(options[1].content, "50")
+        self.assertEquals(options[2].prop("label"), "75")
+        self.assertEquals(options[2].content, "75")
+        self.assertEquals(options[3].prop("label"), "100")
+        self.assertEquals(options[3].content, "100")
+        self.assertEquals(options[4].prop("label"), "150")
+        self.assertEquals(options[4].content, "150")
+        self.assertEquals(options[5].prop("label"), "200")
+        self.assertEquals(options[5].content, "200")
+
+        # Second step
+        info_query = Iq(stanza_type="set",
+                        from_jid="user1@test.com",
+                        to_jid="jcl.test.com")
+        command_node = info_query.set_new_content(command.COMMAND_NS, "command")
+        command_node.setProp("node",
+                             "http://jabber.org/protocol/admin#get-online-users-list")
+        session_id = xml_command.prop("sessionid")
+        command_node.setProp("sessionid", session_id)
+        command_node.setProp("action", "next")
+        submit_form = Form(xmlnode_or_type="submit")
+        submit_form.add_field(field_type="list-single",
+                              name="max_items",
+                              value="25")
+        submit_form.as_xml(command_node)
+        result = self.command_manager.apply_command_action(\
+            info_query,
+            "http://jabber.org/protocol/admin#get-online-users-list",
+            "execute")
+        self.assertNotEquals(result, None)
+        self.assertEquals(len(result), 1)
+        xml_command = result[0].xpath_eval("c:command",
+                                           {"c": "http://jabber.org/protocol/commands"})[0]
+        self.assertEquals(xml_command.prop("status"), "completed")
+        self.assertEquals(xml_command.prop("sessionid"), session_id)
+        self.__check_actions(result[0])
+        context_session = self.command_manager.sessions[session_id][1]
+        self.assertEquals(context_session["max_items"],
+                          ["25"])
+        fields = result[0].xpath_eval("c:command/data:x/data:field",
+                                      {"c": "http://jabber.org/protocol/commands",
+                                       "data": "jabber:x:data"})
+        self.assertEquals(len(fields), 2)
+        self.assertEquals(fields[0].prop("var"), "FORM_TYPE")
+        self.assertEquals(fields[0].prop("type"), "hidden")
+        self.assertEquals(fields[0].children.name, "value")
+        self.assertEquals(fields[0].children.content,
+                          "http://jabber.org/protocol/admin")
+        self.assertEquals(fields[1].prop("var"), "onlineusers")
         values = result[0].xpath_eval("c:command/data:x/data:field[2]/data:value",
                                       {"c": "http://jabber.org/protocol/commands",
                                        "data": "jabber:x:data"})