irc: add server option "autojoin_record"

2026-06-29 22:36:38 +02:00 · 2022-03-06 16:34:32 +01:00
parent f81a0dc4d9
commit c1e65e8edd
26 changed files with 1028 additions and 10 deletions
@@ -0,0 +1,360 @@
+/*
+ * test-irc-join.cpp - test IRC join functions
+ *
+ * Copyright (C) 2022 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * This file is part of WeeChat, the extensible chat client.
+ *
+ * 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.
+ *
+ * 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 WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "CppUTest/TestHarness.h"
+
+extern "C"
+{
+#include "tests/tests.h"
+#include "src/core/wee-arraylist.h"
+#include "src/core/wee-config-file.h"
+#include "src/plugins/irc/irc-join.h"
+#include "src/plugins/irc/irc-server.h"
+}
+
+#define WEE_CHECK_ADD_CHANNEL(__result, __join, __channel, __key)       \
+    str = irc_join_add_channel (NULL, __join, __channel, __key);        \
+    if (__result == NULL)                                               \
+    {                                                                   \
+        POINTERS_EQUAL(NULL, str);                                      \
+    }                                                                   \
+    else                                                                \
+    {                                                                   \
+        STRCMP_EQUAL(__result, str);                                    \
+    }                                                                   \
+    if (str)                                                            \
+        free (str);
+
+#define WEE_CHECK_REMOVE_CHANNEL(__result, __join, __channel)           \
+    str = irc_join_remove_channel (NULL, __join, __channel);            \
+    if (__result == NULL)                                               \
+    {                                                                   \
+        POINTERS_EQUAL(NULL, str);                                      \
+    }                                                                   \
+    else                                                                \
+    {                                                                   \
+        STRCMP_EQUAL(__result, str);                                    \
+    }                                                                   \
+    if (str)                                                            \
+        free (str);
+
+TEST_GROUP(IrcJoin)
+{
+};
+
+/*
+ * Tests functions:
+ *   irc_join_compare_cb
+ *   irc_join_free_cb
+ *   irc_join_split
+ *   irc_join_build_string
+ */
+
+TEST(IrcJoin, SplitBuildString)
+{
+    struct t_arraylist *arraylist;
+    struct t_irc_join_channel **channels;
+    struct t_irc_server *server;
+    char *autojoin;
+
+    arraylist = irc_join_split (NULL, NULL);
+    CHECK(arraylist);
+    LONGS_EQUAL(0, arraylist->size);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    autojoin = irc_join_build_string (NULL);
+    STRCMP_EQUAL("", autojoin);
+    free (autojoin);
+
+    arraylist = irc_join_split (NULL, "");
+    CHECK(arraylist);
+    LONGS_EQUAL(0, arraylist->size);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* 1 channel, 2 keys (the second is ignored) */
+    arraylist = irc_join_split (NULL, "#xyz key_xyz,key_abc");
+    CHECK(arraylist);
+    LONGS_EQUAL(1, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#xyz", channels[0]->name);
+    STRCMP_EQUAL("key_xyz", channels[0]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#xyz key_xyz", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* 1 channel */
+    arraylist = irc_join_split (NULL, "#xyz");
+    CHECK(arraylist);
+    LONGS_EQUAL(1, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#xyz", channels[0]->name);
+    POINTERS_EQUAL(NULL, channels[0]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#xyz", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* 2 channels */
+    arraylist = irc_join_split (NULL, "#xyz,#abc");
+    CHECK(arraylist);
+    LONGS_EQUAL(2, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#xyz", channels[0]->name);
+    POINTERS_EQUAL(NULL, channels[0]->key);
+    STRCMP_EQUAL("#abc", channels[1]->name);
+    POINTERS_EQUAL(NULL, channels[1]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#xyz,#abc", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* 2 channels, 2 keys */
+    arraylist = irc_join_split (NULL, "#xyz,#abc key_xyz,key_abc");
+    CHECK(arraylist);
+    LONGS_EQUAL(2, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#xyz", channels[0]->name);
+    STRCMP_EQUAL("key_xyz", channels[0]->key);
+    STRCMP_EQUAL("#abc", channels[1]->name);
+    STRCMP_EQUAL("key_abc", channels[1]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#xyz,#abc key_xyz,key_abc", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* 3 channels, 2 keys */
+    arraylist = irc_join_split (NULL, "#xyz,#abc,#def key_xyz,key_abc");
+    CHECK(arraylist);
+    LONGS_EQUAL(3, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#xyz", channels[0]->name);
+    STRCMP_EQUAL("key_xyz", channels[0]->key);
+    STRCMP_EQUAL("#abc", channels[1]->name);
+    STRCMP_EQUAL("key_abc", channels[1]->key);
+    STRCMP_EQUAL("#def", channels[2]->name);
+    POINTERS_EQUAL(NULL, channels[2]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#xyz,#abc,#def key_xyz,key_abc", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* duplicated channel */
+    arraylist = irc_join_split (NULL, "#xyz,#XYZ");
+    CHECK(arraylist);
+    LONGS_EQUAL(1, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#XYZ", channels[0]->name);
+    POINTERS_EQUAL(NULL, channels[0]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#XYZ", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+
+    /* server with casemapping RFC1459 */
+    server = irc_server_alloc ("my_ircd");
+    CHECK(server);
+    server->casemapping = IRC_SERVER_CASEMAPPING_RFC1459;
+    arraylist = irc_join_split (server, "#chan[a]^,#CHAN{A}~");
+    CHECK(arraylist);
+    LONGS_EQUAL(1, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#CHAN{A}~", channels[0]->name);
+    POINTERS_EQUAL(NULL, channels[0]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#CHAN{A}~", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+    irc_server_free (server);
+
+    /* server with casemapping STRICT_RFC1459 */
+    server = irc_server_alloc ("my_ircd");
+    CHECK(server);
+    server->casemapping = IRC_SERVER_CASEMAPPING_STRICT_RFC1459;
+    arraylist = irc_join_split (server, "#chan[a]^,#CHAN{A}~");
+    CHECK(arraylist);
+    LONGS_EQUAL(2, arraylist->size);
+    channels = (struct t_irc_join_channel **)arraylist->data;
+    CHECK(channels[0]);
+    STRCMP_EQUAL("#chan[a]^", channels[0]->name);
+    POINTERS_EQUAL(NULL, channels[0]->key);
+    STRCMP_EQUAL("#CHAN{A}~", channels[1]->name);
+    POINTERS_EQUAL(NULL, channels[1]->key);
+    autojoin = irc_join_build_string (arraylist);
+    STRCMP_EQUAL("#chan[a]^,#CHAN{A}~", autojoin);
+    free (autojoin);
+    arraylist_free (arraylist);
+    irc_server_free (server);
+}
+
+/*
+ * Tests functions:
+ *   irc_join_add_channel
+ */
+
+TEST(IrcJoin, AddChannel)
+{
+    char *str;
+
+    WEE_CHECK_ADD_CHANNEL(NULL, NULL, NULL, NULL);
+    WEE_CHECK_ADD_CHANNEL(NULL, "", NULL, NULL);
+    WEE_CHECK_ADD_CHANNEL("", "", "", NULL);
+    WEE_CHECK_ADD_CHANNEL("", NULL, "", NULL);
+
+    WEE_CHECK_ADD_CHANNEL("#abc", NULL, "#abc", NULL);
+    WEE_CHECK_ADD_CHANNEL("#abc", "", "#abc", NULL);
+    WEE_CHECK_ADD_CHANNEL("#abc key_abc", NULL, "#abc", "key_abc");
+    WEE_CHECK_ADD_CHANNEL("#ABC key_ABC", NULL, "#ABC", "key_ABC");
+
+    WEE_CHECK_ADD_CHANNEL("#xyz,#abc", "#xyz", "#abc", NULL);
+    WEE_CHECK_ADD_CHANNEL("#abc,#xyz key_abc", "#xyz", "#abc", "key_abc");
+
+    WEE_CHECK_ADD_CHANNEL("#abc,#xyz,#def key_abc", "#xyz,#def", "#abc", "key_abc");
+}
+
+/*
+ * Tests functions:
+ *   irc_join_remove_channel
+ */
+
+TEST(IrcJoin, RemoveChannel)
+{
+    char *str;
+
+    WEE_CHECK_REMOVE_CHANNEL(NULL, NULL, NULL);
+    WEE_CHECK_REMOVE_CHANNEL(NULL, "", NULL);
+    WEE_CHECK_REMOVE_CHANNEL("", "", "");
+    WEE_CHECK_REMOVE_CHANNEL("", NULL, "");
+
+    WEE_CHECK_REMOVE_CHANNEL("", NULL, "#abc");
+    WEE_CHECK_REMOVE_CHANNEL("", "", "#abc");
+
+    WEE_CHECK_REMOVE_CHANNEL("#xyz", "#xyz", "#abc");
+    WEE_CHECK_REMOVE_CHANNEL("", "#xyz", "#xyz");
+    WEE_CHECK_REMOVE_CHANNEL("", "#xyz", "#XYZ");
+    WEE_CHECK_REMOVE_CHANNEL("#xyz", "#abc,#xyz key_abc", "#abc");
+    WEE_CHECK_REMOVE_CHANNEL("#abc key_abc", "#abc,#xyz key_abc", "#xyz");
+    WEE_CHECK_REMOVE_CHANNEL("#abc key_abc", "#abc,#xyz key_abc", "#XYZ");
+
+    WEE_CHECK_REMOVE_CHANNEL("#def,#ghi key_def",
+                             "#abc,#def,#ghi key_abc,key_def", "#abc");
+    WEE_CHECK_REMOVE_CHANNEL("#def,#ghi key_def",
+                             "#abc,#def,#ghi key_abc,key_def", "#ABC");
+
+    WEE_CHECK_REMOVE_CHANNEL("#abc,#ghi key_abc",
+                             "#abc,#def,#ghi key_abc,key_def", "#def");
+
+    WEE_CHECK_REMOVE_CHANNEL("#abc,#def key_abc,key_def",
+                             "#abc,#def,#ghi key_abc,key_def", "#ghi");
+}
+
+/*
+ * Tests functions:
+ *   irc_join_add_channel_to_autojoin
+ *   irc_join_remove_channel_from_autojoin
+ */
+
+TEST(IrcJoin, AddRemoveChannelAutojoin)
+{
+    struct t_irc_server *server;
+
+    server = irc_server_alloc ("my_ircd");
+
+    irc_join_remove_channel_from_autojoin (server, "#xyz");
+    STRCMP_EQUAL(
+        "",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, "#xyz", NULL);
+    STRCMP_EQUAL(
+        "#xyz",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, NULL, NULL);
+    STRCMP_EQUAL(
+        "#xyz",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, "#abc", "key_abc");
+    STRCMP_EQUAL(
+        "#abc,#xyz key_abc",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, "#def", "key_def");
+    STRCMP_EQUAL(
+        "#abc,#def,#xyz key_abc,key_def",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, "#ghi", NULL);
+    STRCMP_EQUAL(
+        "#abc,#def,#xyz,#ghi key_abc,key_def",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_add_channel_to_autojoin (server, "#jkl", "");
+    STRCMP_EQUAL(
+        "#abc,#def,#xyz,#ghi,#jkl key_abc,key_def",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, "#def");
+    STRCMP_EQUAL(
+        "#abc,#xyz,#ghi,#jkl key_abc",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, "#ghi");
+    STRCMP_EQUAL(
+        "#abc,#xyz,#jkl key_abc",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, "#abc");
+    STRCMP_EQUAL(
+        "#xyz,#jkl",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, "#jkl");
+    STRCMP_EQUAL(
+        "#xyz",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, "#xyz");
+    STRCMP_EQUAL(
+        "",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_join_remove_channel_from_autojoin (server, NULL);
+    STRCMP_EQUAL(
+        "",
+        CONFIG_STRING(server->options[IRC_SERVER_OPTION_AUTOJOIN]));
+
+    irc_server_free (server);
+}