Changeset 345577b

Timestamp:

2015-10-30T10:27:20Z (9 years ago)

Author:

dequis <dx@…>

Branches:

master

Children:

fb2338d

Parents:

0db6618

git-author:

dequis <dx@…> (13-09-15 04:17:14)

git-committer:

dequis <dx@…> (30-10-15 10:27:20)

Message:

IRC self-message support (messages sent by yourself from other clients)

This adds an OPT_SELFMESSAGE flag that can be passed to imcb_buddy_msg()
or imcb_chat_msg() to indicate that the protocol knows that the message
being sent is a self message.

This needs to be explicit since the old behavior is to silently drop
these messages, which also removed server echoes.

This commit doesn't break API/ABI, the flags parameters that were added
are all internal (between protocols and UI code)

On the irc protocol side, the situation isn't very nice, since some
clients put these messages in the wrong window. Irssi, hexchat and mirc
get this wrong. Irssi 0.8.18 has a fix for it, and the others have
scripts to patch it.

But meanwhile, there's a "self_messages" global setting that lets users
disable this, or get them as normal messages / notices with a "->"
prefix, which loosely imitates the workaround used by the ZNC
"privmsg_prefix" module.

Files:

• doc/user-guide/commands.xml (modified) (1 diff)
• irc.c (modified) (1 diff)
• irc.h (modified) (1 diff)
• irc_im.c (modified) (5 diffs)
• irc_util.c (modified) (1 diff)
• protocols/bee.h (modified) (2 diffs)
• protocols/bee_chat.c (modified) (2 diffs)
• protocols/bee_user.c (modified) (3 diffs)
• protocols/nogaim.h (modified) (2 diffs)

doc/user-guide/commands.xml

@@ -1404 +1404 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="self_messages" type="string" scope="global">
+                <default>true</default>
+                <possible-values>true, false, prefix, prefix_notice</possible-values>
+
+                <description>
+                        <para>
+                                Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
+                        </para>
+
+                        <para>
+                                When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
+                        </para>
+                        
+                        <para>
+                                Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
+                        </para>
+
+                        <para>
+                                You can also set it to "false" to disable these messages completely.
+                        </para>
+
+                        <para>
+                                This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="server" type="string" scope="account">
                 <description>

irc.c

@@ -129 +129 @@
         s = set_add(&b->set, "show_offline", "false", set_eval_bw_compat, irc);
         s->flags |= SET_HIDDEN;
+        s = set_add(&b->set, "self_messages", "true", set_eval_self_messages, irc);
         s = set_add(&b->set, "simulate_netsplit", "true", set_eval_bool, irc);
         s = set_add(&b->set, "timezone", "local", set_eval_timezone, irc);

irc.h

@@ -354 +354 @@
 char *set_eval_timezone(struct set *set, char *value);
 char *irc_format_timestamp(irc_t *irc, time_t msg_ts);
+char *set_eval_self_messages(struct set *set, char *value);
 
 /* irc_im.c */

irc_im.c

@@ -201 +201 @@
 }
 
-static gboolean bee_irc_user_msg(bee_t *bee, bee_user_t *bu, const char *msg_, time_t sent_at)
+static gboolean bee_irc_user_msg(bee_t *bee, bee_user_t *bu, const char *msg_, guint32 flags, time_t sent_at)
 {
         irc_t *irc = bee->ui_data;
         irc_user_t *iu = (irc_user_t *) bu->ui_data;
+        irc_user_t *src_iu = iu;
+        irc_user_t *dst_iu = irc->user;
         const char *dst;
         char *prefix = NULL;
         char *wrapped, *ts = NULL;
         char *msg = g_strdup(msg_);
+        char *message_type = "PRIVMSG";
         GSList *l;
 
@@ -216 +219 @@
 
         dst = irc_user_msgdest(iu);
-        if (dst != irc->user->nick) {
-                /* if not messaging directly, call user by name */
-                prefix = g_strdup_printf("%s%s%s", irc->user->nick, set_getstr(&bee->set, "to_char"), ts ? : "");
+
+        if (flags & OPT_SELFMESSAGE) {
+                char *setting = set_getstr(&irc->b->set, "self_messages");
+
+                if (is_bool(setting)) {
+                        if (bool2int(setting)) {
+                                /* set to true, send it with src/dst flipped */
+                                
+                                dst_iu = iu;
+                                src_iu = irc->user;
+
+                                if (dst == irc->user->nick) {
+                                        dst = dst_iu->nick;
+                                }
+                        } else {
+                                /* set to false, skip the message completely */
+                                goto cleanup;
+                        }
+                } else if (g_strncasecmp(setting, "prefix", 6) == 0) {
+                        /* third state, prefix, loosely imitates the znc privmsg_prefix module */
+
+                        g_free(msg);
+                        if (g_strncasecmp(msg_, "/me ", 4) == 0) {
+                                msg = g_strdup_printf("/me -> %s", msg_ + 4);
+                        } else {
+                                msg = g_strdup_printf("-> %s", msg_);
+                        }
+
+                        if (g_strcasecmp(setting, "prefix_notice") == 0) {
+                                message_type = "NOTICE";
+                        }
+                }
+
+        }
+
+        if (dst != dst_iu->nick) {
+                /* if not messaging directly (control channel), call user by name */
+                prefix = g_strdup_printf("%s%s%s", dst_iu->nick, set_getstr(&bee->set, "to_char"), ts ? : "");
         } else {
                 prefix = ts;
@@ -249 +287 @@
 
         wrapped = word_wrap(msg, 425);
-        irc_send_msg(iu, "PRIVMSG", dst, wrapped, prefix);
+        irc_send_msg(src_iu, message_type, dst, wrapped, prefix);
         g_free(wrapped);
 
@@ -260 +298 @@
 }
 
-static gboolean bee_irc_user_typing(bee_t *bee, bee_user_t *bu, uint32_t flags)
+static gboolean bee_irc_user_typing(bee_t *bee, bee_user_t *bu, guint32 flags)
 {
         irc_t *irc = (irc_t *) bee->ui_data;
@@ -617 +655 @@
 }
 
-static gboolean bee_irc_chat_msg(bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *msg, time_t sent_at)
+static gboolean bee_irc_chat_msg(bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *msg, guint32 flags, time_t sent_at)
 {
         irc_t *irc = bee->ui_data;
-        irc_user_t *iu = bu->ui_data;
+        irc_user_t *iu = flags & OPT_SELFMESSAGE ? irc->user : bu->ui_data;
         irc_channel_t *ic = c->ui_data;
         char *wrapped, *ts = NULL;

irc_util.c

@@ -119 +119 @@
         }
 }
+
+
+char *set_eval_self_messages(set_t *set, char *value)
+{
+        if (is_bool(value) ||
+            g_strcasecmp(value, "prefix") == 0 ||
+            g_strcasecmp(value, "prefix_notice") == 0) {
+                return value;
+        } else {
+                return SET_INVALID;
+        }
+}

protocols/bee.h

@@ -105 +105 @@
         gboolean (*user_status)(bee_t *bee, struct bee_user *bu, struct bee_user *old);
         /* On every incoming message. sent_at = 0 means unknown. */
-        gboolean (*user_msg)(bee_t *bee, bee_user_t *bu, const char *msg, time_t sent_at);
+        gboolean (*user_msg)(bee_t *bee, bee_user_t *bu, const char *msg, guint32 flags, time_t sent_at);
         /* Flags currently defined (OPT_TYPING/THINKING) in nogaim.h. */
         gboolean (*user_typing)(bee_t *bee, bee_user_t *bu, guint32 flags);
@@ -118 +118 @@
         /* System messages of any kind. */
         gboolean (*chat_log)(bee_t *bee, struct groupchat *c, const char *text);
-        gboolean (*chat_msg)(bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *msg, time_t sent_at);
+        gboolean (*chat_msg)(bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *msg, guint32 flags, time_t sent_at);
         gboolean (*chat_add_user)(bee_t *bee, struct groupchat *c, bee_user_t *bu);
         gboolean (*chat_remove_user)(bee_t *bee, struct groupchat *c, bee_user_t *bu, const char *reason);

protocols/bee_chat.c

@@ -95 +95 @@
 }
 
-void imcb_chat_msg(struct groupchat *c, const char *who, char *msg, uint32_t flags, time_t sent_at)
+void imcb_chat_msg(struct groupchat *c, const char *who, char *msg, guint32 flags, time_t sent_at)
 {
         struct im_connection *ic = c->ic;
         bee_t *bee = ic->bee;
         bee_user_t *bu;
-        gboolean temp;
+        gboolean temp = FALSE;
         char *s;
 
-        /* Gaim sends own messages through this too. IRC doesn't want this, so kill them */
-        if (handle_is_self(ic, who)) {
+        if (handle_is_self(ic, who) && !(flags & OPT_SELFMESSAGE)) {
                 return;
         }
@@ -122 +121 @@
 
         if (bee->ui->chat_msg) {
-                bee->ui->chat_msg(bee, c, bu, msg, sent_at);
+                bee->ui->chat_msg(bee, c, bu, msg, flags, sent_at);
         }
 

protocols/bee_user.c

@@ -247 +247 @@
 }
 
-void imcb_buddy_msg(struct im_connection *ic, const char *handle, const char *msg, uint32_t flags, time_t sent_at)
+void imcb_buddy_msg(struct im_connection *ic, const char *handle, const char *msg, guint32 flags, time_t sent_at)
 {
         bee_t *bee = ic->bee;
@@ -265 +265 @@
 
         if (bee->ui->user_msg && bu) {
-                bee->ui->user_msg(bee, bu, msg, sent_at);
+                bee->ui->user_msg(bee, bu, msg, flags, sent_at);
         } else {
                 imcb_log(ic, "Message from unknown handle %s:\n%s", handle, msg);
@@ -297 +297 @@
 }
 
-void imcb_buddy_typing(struct im_connection *ic, const char *handle, uint32_t flags)
+void imcb_buddy_typing(struct im_connection *ic, const char *handle, guint32 flags)
 {
         bee_user_t *bu;

protocols/nogaim.h

@@ -70 +70 @@
 #define OPT_PONGS       0x00010000 /* Service sends us keep-alives */
 #define OPT_PONGED      0x00020000 /* Received a keep-alive during last interval */
+#define OPT_SELFMESSAGE 0x00080000 /* A message sent by self from another location */
 
 /* ok. now the fun begins. first we create a connection structure */
@@ -325 +326 @@
 G_MODULE_EXPORT void imcb_buddy_action_response(bee_user_t *bu, const char *action, char * const args[], void *data);
 
-G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, uint32_t flags);
+G_MODULE_EXPORT void imcb_buddy_typing(struct im_connection *ic, const char *handle, guint32 flags);
 G_MODULE_EXPORT struct bee_user *imcb_buddy_by_handle(struct im_connection *ic, const char *handle);
 G_MODULE_EXPORT void imcb_clean_handle(struct im_connection *ic, char *handle);