Add /ignore feature

Author: nogaems

CMakeLists.txt

@@ -30,6 +30,7 @@ add_library(tox MODULE
     src/twc-friend-request.c
     src/twc-gui.c
     src/twc-group-invite.c
+    src/twc-ignore.c
     src/twc-list.c
     src/twc-message-queue.c
     src/twc-profile.c
@@ -64,4 +65,3 @@ endif()
 set(PLUGIN_PATH "lib/weechat/plugins" CACHE PATH
     "Path to install the plugin binary to.")
 install(TARGETS tox DESTINATION "${PLUGIN_PATH}")
-

src/twc-chat.c

@@ -273,6 +273,32 @@ twc_chat_search_buffer(struct t_gui_buffer *buffer)
     return NULL;
 }
 
+/**
+ * Set a prefix to a nickname in the nicklist of a chat.
+ */
+void
+twc_chat_update_prefix(struct t_twc_chat *chat, const char *name, const char *prefix, const char *prefix_color)
+{
+    struct t_gui_nick_group *ptr_group = NULL;
+    struct t_gui_nick *ptr_nick = NULL;
+
+    weechat_nicklist_get_next_item(chat->buffer, &ptr_group, &ptr_nick);
+    while(ptr_group || ptr_nick)
+    {
+        if (ptr_nick)
+        {
+            const char *name_field = weechat_nicklist_nick_get_string(chat->buffer, ptr_nick, "name");
+            if (!strncmp(name, name_field , TOX_MAX_NAME_LENGTH))
+            {
+                weechat_nicklist_nick_set(chat->buffer, ptr_nick, "prefix", prefix);
+                weechat_nicklist_nick_set(chat->buffer, ptr_nick, "prefix_color", prefix_color);
+                weechat_nicklist_nick_set(chat->buffer, ptr_nick, "color", "default");
+            }
+        }
+        weechat_nicklist_get_next_item(chat->buffer, &ptr_group, &ptr_nick);
+    }
+}
+
 /**
  * Print a chat message to a chat's buffer.
  */

src/twc-chat.h

@@ -52,6 +52,9 @@ twc_chat_search_group(struct t_twc_profile *profile, int32_t group_number,
 struct t_twc_chat *
 twc_chat_search_buffer(struct t_gui_buffer *target_buffer);
 
+void
+twc_chat_update_prefix(struct t_twc_chat *chat, const char *name, const char *prefix, const char *prefix_color);
+
 enum t_twc_rc
 twc_chat_set_logging(struct t_twc_chat const *const chat, bool logging);
 

src/twc-commands.c

@@ -28,6 +28,7 @@
 
 #include "twc-bootstrap.h"
 #include "twc-tfer.h"
+#include "twc-ignore.h"
 #include "twc-chat.h"
 #include "twc-config.h"
 #include "twc-friend-request.h"
@@ -973,6 +974,10 @@ twc_cmd_save(const void *pointer, void *data, struct t_gui_buffer *buffer,
                            weechat_prefix("error"), weechat_plugin->name,
                            item->profile->name);
         }
+        twc_ignore_dump(item->profile);
+        weechat_printf(NULL, "%s: ignore list for profile '%s' saved",
+                       weechat_plugin->name,
+                       item->profile->name);
     }
 
     weechat_printf(NULL, "%s: profile data saved", weechat_plugin->name);
@@ -1238,7 +1243,7 @@ twc_cmd_send(const void *pointer, void *data, struct t_gui_buffer *buffer,
     /* /send <number>|<name>|<Tox ID> <file> */
     if (argc >= 3)
     {
-        /* do a shell split in case a friend has spaces in his name 
+        /* do a shell split in case a friend has spaces in his name
          * and join the name */
         int shell_argc;
         char **shell_argv = weechat_string_split_shell(argv_eol[1], &shell_argc);
@@ -1314,6 +1319,81 @@ twc_cmd_send(const void *pointer, void *data, struct t_gui_buffer *buffer,
     return WEECHAT_RC_OK;
 }
 
+void
+twc_name_prefix_in_groupchats(struct t_twc_profile *profile,
+                              const char *name, const char *prefix, const char *prefix_color)
+{
+    struct t_twc_list_item *item;
+    struct t_twc_chat *chat;
+    size_t index;
+    twc_list_foreach(profile->chats , index, item)
+    {
+        chat = (struct t_twc_chat *)(item->chat);
+        if ((chat->group_number) >= 0)
+        {
+            twc_chat_update_prefix(chat, name, prefix, prefix_color);
+        }
+     }
+}
+/**
+ * Command /ignore callback.
+ */
+int
+twc_cmd_ignore(const void *pointer, void *data, struct t_gui_buffer *buffer,
+               int argc, char **argv, char **argv_eol)
+{
+    struct t_twc_profile *profile = twc_profile_search_buffer(buffer);
+    TWC_CHECK_PROFILE(profile);
+    TWC_CHECK_PROFILE_LOADED(profile);
+
+    /* list ignores */
+    if ((argc == 1)
+        || ((argc == 2) && (weechat_strcasecmp (argv[1], "list") == 0)))
+    {
+        twc_ignore_print(profile);
+        return WEECHAT_RC_OK;
+    }
+
+    const char *nick = argv_eol[2];
+    struct t_weelist_item *item;
+    item = weechat_list_search(profile->ignore_list, nick);
+
+    /* add ignore */
+    if (weechat_strcasecmp (argv[1], "add") == 0)
+    {
+        WEECHAT_COMMAND_MIN_ARGS(3, "add");
+        if (!item)
+        {
+            weechat_list_add(profile->ignore_list, nick, WEECHAT_LIST_POS_SORT, NULL);
+            weechat_printf(profile->buffer, "%snickname '%s' has been added to the ignore list",
+                           weechat_prefix("action"), nick);
+            twc_name_prefix_in_groupchats(profile, nick, "-", "yellow");
+        }
+        else
+            weechat_printf(profile->buffer, "%snickname '%s' is already in the ignore list",
+                           weechat_prefix("error"), nick);
+        return WEECHAT_RC_OK;
+    }
+
+    /* delete ignore */
+    if (weechat_strcasecmp (argv[1], "del") == 0)
+    {
+        WEECHAT_COMMAND_MIN_ARGS(3, "del");
+        if (item)
+        {
+            weechat_list_remove(profile->ignore_list, item);
+            weechat_printf(profile->buffer, "%snickname '%s' has been deleted from the ignore list",
+                           weechat_prefix("action"), nick);
+            twc_name_prefix_in_groupchats(profile, nick, " ", "default");
+        }
+        else
+            weechat_printf(profile->buffer, "%sthere's no nickname '%s' in the ignore list",
+                           weechat_prefix("error"), nick);
+        return WEECHAT_RC_OK;
+    }
+    WEECHAT_COMMAND_ERROR
+}
+
 /**
  * Register Tox-WeeChat commands.
  */
@@ -1445,4 +1525,15 @@ twc_commands_init()
                          "%(filename)"
                          " || %(tox_friend_name)|%(tox_friend_tox_id) %(filename)",
                          twc_cmd_send, NULL, NULL);
+    weechat_hook_command("ignore", "ommit messages from people with certain nicks",
+                         "list"
+                         " || add <name>"
+                         " || del <name>",
+                         "list: show the list of ignores\n"
+                         "add: add a nick to the list\n"
+                         "del: delete a nick from the list\n",
+                         "list"
+                         " || add %*"
+                         " || del %*",
+                         twc_cmd_ignore, NULL, NULL);
 }

src/twc-config.c

@@ -27,6 +27,7 @@
 #include "twc-list.h"
 #include "twc-profile.h"
 #include "twc-tfer.h"
+#include "twc-ignore.h"
 #include "twc.h"
 
 #include "twc-config.h"
@@ -42,7 +43,7 @@ struct t_config_option *twc_config_short_id_size;
 char *twc_profile_option_names[TWC_PROFILE_NUM_OPTIONS] = {
     "save_file", "autoload", "autojoin", "autojoin_delay",
     "max_friend_requests", "proxy_address", "proxy_port", "proxy_type",
-    "udp", "ipv6", "passphrase", "logging", "downloading_path",
+    "udp", "ipv6", "passphrase", "logging", "downloading_path", "ignore_file"
 };
 
 /**
@@ -191,6 +192,8 @@ twc_config_profile_change_callback(const void *pointer, void *data,
         case TWC_PROFILE_OPTION_DOWNLOADING_PATH:
             twc_tfer_update_downloading_path(profile);
             break;
+        case TWC_PROFILE_OPTION_IGNORE_FILE:
+            twc_ignore_reload(profile);
         default:
             break;
     }
@@ -295,6 +298,11 @@ twc_config_init_option(struct t_twc_profile *profile,
                           "WeeChat home folder and \"%p\" by profile name";
             default_value = "%h/tfer/%p/";
             break;
+        case TWC_PROFILE_OPTION_IGNORE_FILE:
+            type = "string";
+            description = "path to ignore file (new line separated list of nicknames)";
+            default_value = "%h/tox/%p.ignore.list";
+            break;
         default:
             return NULL;
     }

src/twc-ignore.c

@@ -0,0 +1,137 @@
+/*
+ * This file is part of Tox-WeeChat.
+ *
+ * Tox-WeeChat is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Tox-WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tox-WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <string.h>
+#include <stdbool.h>
+#include <stdio.h>
+
+#include <weechat/weechat-plugin.h>
+
+#include "twc-ignore.h"
+#include "twc-list.h"
+#include "twc-chat.h"
+#include "twc.h"
+
+/**
+ * Get a profile's expanded ignore list path, replacing:
+ *  - %h with WeeChat home
+ *  - %p with profile name
+ *
+ * Returned string must be freed.
+ */
+char *
+twc_ignore_expanded_path(struct t_twc_profile *profile)
+{
+    const char *weechat_dir = weechat_info_get("weechat_dir", NULL);
+    const char *base_path =
+        TWC_PROFILE_OPTION_STRING(profile, TWC_PROFILE_OPTION_IGNORE_FILE);
+    char *home_expanded = weechat_string_replace(base_path, "%h", weechat_dir);
+    char *full_path =
+        weechat_string_replace(home_expanded, "%p", profile->name);
+    free(home_expanded);
+
+    return full_path;
+}
+
+
+/**
+ * Load ignore list from the file.
+ */
+void
+twc_ignore_load(struct t_twc_profile *profile)
+{
+    char *full_path = twc_ignore_expanded_path(profile);
+    FILE *fp;
+    fp = fopen(full_path, "r");
+    if (fp)
+    {
+        size_t len, max_len = TOX_MAX_NAME_LENGTH + 2; /* for \0 and \n */
+        char line[max_len];
+        while(fgets(line, max_len, fp))
+        {
+            len = strlen(line);
+            if (len > 0 && line[len-1] == '\n')
+                line[--len] = '\0';
+            weechat_list_add(profile->ignore_list, line, WEECHAT_LIST_POS_SORT, NULL);
+        }
+    }
+    free(full_path);
+}
+
+/**
+ * Reload ignore list from the file. Called when "ignore_file"  option is changing.
+ */
+void
+twc_ignore_reload(struct t_twc_profile *profile)
+{
+    weechat_list_free(profile->ignore_list);
+    profile->ignore_list = weechat_list_new();
+    twc_ignore_load(profile);
+}
+
+/**
+ *  Write ignore list to the file.
+ */
+void
+twc_ignore_dump(struct t_twc_profile *profile)
+{
+    char *full_path = twc_ignore_expanded_path(profile);
+    FILE *fp;
+    fp = fopen(full_path, "w");
+    if (fp)
+    {
+        size_t index, size = weechat_list_size(profile->ignore_list);
+        for (index = 0; index < size; index++)
+        {
+            fprintf(fp, "%s\n", weechat_list_string(weechat_list_get(profile->ignore_list, index)));
+        }
+        fclose(fp);
+    }
+    free(full_path);
+}
+
+/**
+ * Print ignore list to its profile buffer.
+ */
+void
+twc_ignore_print(struct t_twc_profile *profile)
+{
+    size_t index, count = (size_t)weechat_list_size(profile->ignore_list);
+    if (!count)
+    {
+        weechat_printf(profile->buffer, "ignore list is empty!");
+        return;
+    }
+
+    /* 2 characters for quote symbols before and after a nick and 2 for ", " separator */
+    size_t length = count*(TOX_MAX_NAME_LENGTH + 4);
+
+    char *formatted_list = malloc(length * sizeof(char) + 1);
+    memset(formatted_list, 0, length * sizeof(char));
+
+    for (index = 0; index < count; index++)
+    {
+        strcat(formatted_list, "'");
+        strcat(formatted_list, weechat_list_string(weechat_list_get(profile->ignore_list, index)));
+        strcat(formatted_list, "'");
+        if (index + 1 < count)
+            strcat(formatted_list, ", ");
+
+    }
+    weechat_printf(profile->buffer, "%slist of ignores: %s",
+                   weechat_prefix("action"), formatted_list);
+    free(formatted_list);
+}

src/twc-ignore.h

@@ -0,0 +1,36 @@
+/*
+ * This file is part of Tox-WeeChat.
+ *
+ * Tox-WeeChat is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Tox-WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tox-WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef TOX_WEECHAT_IGNORE_H
+#define TOX_WEECHAT_IGNORE_H
+
+#include <stdbool.h>
+
+#include "twc-profile.h"
+
+void
+twc_ignore_load(struct t_twc_profile *profile);
+
+void
+twc_ignore_reload(struct t_twc_profile *profile);
+
+void
+twc_ignore_dump(struct t_twc_profile *profile);
+
+void
+twc_ignore_print(struct t_twc_profile *profile);
+
+#endif  /* TOX_WEECHAT_IGNORE_H */