Changeset a33ee0f

Timestamp:

2016-09-20T03:39:05Z (8 years ago)

Author:

jgeboski <jgeboski@…>

Branches:

master

Children:

725f942

Parents:

67ea361

git-author:

jgeboski <jgeboski@…> (22-06-16 18:54:52)

git-committer:

jgeboski <jgeboski@…> (20-09-16 03:39:05)

Message:

Added an interface for the listing of existing chatrooms

Several protocols can provide a list of existing chatrooms that a user
is able join. This is crucial for the usage of several protocols, most
notably Purple and Facebook.

Plugins wishing to support this extended functionality must implement
the new prpl->chat_list() function. This implemented function will in
most cases send a remote request for the list of chatrooms. Once the
list of chatrooms is obtained, a bee_chat_info_t GSList must be created
and assigned to the im_connection->chatlist field. Then a call to the
bee_chat_list_finish() is needed to display the list to the user.

The chat list is maintained entirely by the plugin, so it is important
to ensure all pointers related to the chat list remain valid until the
chat list is set to NULL. This list is used internally by bitlbee to
calculate indexes, which then allows the user to join a chat with an
index, rather than some random identifier. It also important to ensure
the list is properly freed whenever it is updated, or when the account
is disconnect via the prpl->logout() function.

On the user interface side of things, the 'chat list' subcommand was
recommissioned. For a user to list the existing chat rooms:

chat list <account id>

Afterwards a user can join a chatroom in the list with its index. This
extends the functionality of the 'chat add' subcommand by adding in
support for the exclamation point operator to denote an index.

chat add <account id> !<index> [channel]

Files:

• bitlbee.h (modified) (1 diff)
• doc/user-guide/commands.xml (modified) (2 diffs)
• protocols/bee.h (modified) (2 diffs)
• protocols/bee_chat.c (modified) (1 diff)
• protocols/nogaim.h (modified) (2 diffs)
• root_commands.c (modified) (6 diffs)

bitlbee.h

@@ -173 +173 @@
 gboolean root_command_add(const char *command, int params, void (*func)(irc_t *, char **args), int flags);
 gboolean cmd_identify_finish(gpointer data, gint fd, b_input_condition cond);
+void cmd_chat_list_finish(struct im_connection *ic);
 gboolean bitlbee_shutdown(gpointer data, gint fd, b_input_condition cond);
 

doc/user-guide/commands.xml

@@ -264 +264 @@
 
                 <bitlbee-command name="add">
-                        <syntax>chat add &lt;account id&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
+                        <syntax>chat add &lt;account id&gt; &lt;room|!index&gt; [&lt;channel&gt;]</syntax>
 
                         <description>
@@ -280 +280 @@
                         </description>
 
+                </bitlbee-command>
+
+                <bitlbee-command name="list">
+                        <syntax>chat list &lt;account id&gt; [&lt;server&gt;]</syntax>
+
+                        <description>
+                                <para>
+                                        List existing chatrooms provided by an account. BitlBee needs this to propogate an internal list of chats. The existing chat can then be added with <emphasis>chat add</emphasis>.
+                                </para>
+                        </description>
                 </bitlbee-command>
 

protocols/bee.h

@@ -83 +83 @@
         void *data; /* Can be used by the IM module. */
 } bee_user_t;
+
+typedef struct bee_chat_info {
+        char *title;
+        char *topic;
+} bee_chat_info_t;
 
 /* This one's mostly used so save space and make it easier (cheaper) to
@@ -185 +190 @@
 G_MODULE_EXPORT void imcb_chat_invite(struct im_connection *ic, const char *name, const char *who, const char *msg);
 
+G_MODULE_EXPORT void bee_chat_list_finish(struct im_connection *ic);
+
 #endif /* __BEE_H__ */

protocols/bee_chat.c

@@ -274 +274 @@
         }
 }
+
+void bee_chat_list_finish(struct im_connection *ic)
+{
+        cmd_chat_list_finish(ic);
+}

protocols/nogaim.h

@@ -96 +96 @@
 
         GSList *groupchats;
+        GSList *chatlist;
 };
 
@@ -263 +264 @@
         gboolean (* handle_is_self) (struct im_connection *, const char *who);
 
+        /* This sets/updates the im_connection->chatlist field with a
+         * bee_chat_info_t GSList. This function should ensure the
+         * bee_chat_list_finish() function gets called at some point
+         * after the chat list is completely updated.
+         */
+        void (* chat_list) (struct im_connection *, const char *server);
+
         /* Some placeholders so eventually older plugins may cooperate with newer BitlBees. */
         void *resv1;

root_commands.c

@@ -1218 +1218 @@
 
         if (g_strcasecmp(cmd[1], "add") == 0) {
-                char *channel, *s;
+                bee_chat_info_t *ci;
+                char *channel, *room, *s;
                 struct irc_channel *ic;
+                guint i;
 
                 MIN_ARGS(3);
@@ -1231 +1233 @@
                 }
 
+                if (cmd[3][0] == '!') {
+                        if (!acc->prpl->chat_list) {
+                                irc_rootmsg(irc, "Listing chatrooms not supported on that account.");
+                                return;
+                        }
+
+                        i = g_ascii_strtoull(cmd[3] + 1, NULL, 10);
+                        ci = g_slist_nth_data(acc->ic->chatlist, i - 1);
+
+                        if (ci == NULL) {
+                                irc_rootmsg(irc, "Invalid chatroom index");
+                                return;
+                        }
+
+                        room = ci->title;
+                } else {
+                        room = cmd[3];
+                }
+
                 if (cmd[4] == NULL) {
-                        channel = g_strdup(cmd[3]);
+                        channel = g_strdup(room);
                         if ((s = strchr(channel, '@'))) {
                                 *s = 0;
@@ -1252 +1273 @@
                     set_setstr(&ic->set, "chat_type", "room") &&
                     set_setstr(&ic->set, "account", cmd[2]) &&
-                    set_setstr(&ic->set, "room", cmd[3])) {
+                    set_setstr(&ic->set, "room", room)) {
                         irc_rootmsg(irc, "Chatroom successfully added.");
                 } else {
@@ -1262 +1283 @@
                 }
                 g_free(channel);
+        } else if (g_strcasecmp(cmd[1], "list") == 0) {
+                MIN_ARGS(2);
+
+                if (!(acc = account_get(irc->b, cmd[2]))) {
+                        irc_rootmsg(irc, "Invalid account");
+                        return;
+                } else if (!acc->prpl->chat_list) {
+                        irc_rootmsg(irc, "Listing chatrooms not supported on that account.");
+                        return;
+                }
+
+                acc->prpl->chat_list(acc->ic, cmd[3]);
         } else if (g_strcasecmp(cmd[1], "with") == 0) {
                 irc_user_t *iu;
@@ -1276 +1309 @@
                         irc_rootmsg(irc, "Can't open a groupchat with %s.", cmd[2]);
                 }
-        } else if (g_strcasecmp(cmd[1], "list") == 0 ||
-                   g_strcasecmp(cmd[1], "set") == 0 ||
+        } else if (g_strcasecmp(cmd[1], "set") == 0 ||
                    g_strcasecmp(cmd[1], "del") == 0) {
                 irc_rootmsg(irc,
@@ -1287 +1319 @@
                             cmd[1]);
         }
+}
+
+void cmd_chat_list_finish(struct im_connection *ic)
+{
+        account_t *acc = ic->acc;
+        bee_chat_info_t *ci;
+        char *hformat, *iformat, *topic;
+        GSList *l;
+        guint i = 0;
+        irc_t *irc = ic->bee->ui_data;
+
+        if (ic->chatlist == NULL) {
+                irc_rootmsg(irc, "No existing chatrooms");
+                return;
+        }
+
+        if (strchr(irc->umode, 'b') != NULL) {
+                hformat = "%s\t%s\t%s";
+                iformat = "%u\t%s\t%s";
+        } else {
+                hformat = "%s  %-20s  %s";
+                iformat = "%5u  %-20.20s  %s";
+        }
+
+        irc_rootmsg(irc, hformat, "Index", "Title", "Topic");
+
+        for (l = ic->chatlist; l; l = l->next) {
+                ci = l->data;
+                topic = ci->topic ? ci->topic : "";
+                irc_rootmsg(irc, iformat, ++i, ci->title, topic);
+        }
+
+        irc_rootmsg(irc, "%u %s chatrooms", i, acc->tag);
 }