pidgin/pidgin

Separate the conversation commands out to their own file

2021-05-06, Gary Kramlich
7c5b89b33e19
Parents e3397381fd35
Children 648527ab9ae3
Separate the conversation commands out to their own file

Testing Done:
Ran pidgin locally verified the commands worked. Ran `ninja pidgin-doc` as well as `ninja pidgin-pot`

Reviewed at https://reviews.imfreedom.org/r/632/
7 files changed, 277 insertions(+), 179 deletions(-)
  • +1 -0
    doc/reference/pidgin/pidgin-docs.xml
  • +0 -178
    pidgin/gtkconv.c
  • +3 -0
    pidgin/libpidgin.c
  • +2 -1
    pidgin/meson.build
  • +214 -0
    pidgin/pidgincommands.c
  • +56 -0
    pidgin/pidginprivate.h
  • +1 -0
    po/POTFILES.in
    • --- a/doc/reference/pidgin/pidgin-docs.xml Fri Apr 30 05:03:39 2021 -0500
    +++ b/doc/reference/pidgin/pidgin-docs.xml Thu May 06 21:32:40 2021 -0500
    @@ -60,6 +60,7 @@
    <xi:include href="xml/pidginavatar.xml" />
    <xi:include href="xml/pidgincellrendererexpander.xml" />
    <xi:include href="xml/pidginclosebutton.xml" />
    + <xi:include href="xml/pidgincommands.xml" />
    <xi:include href="xml/pidgincontactcompletion.xml" />
    <xi:include href="xml/pidgincontactlist.xml" />
    <xi:include href="xml/pidginconversationwindow.xml" />
    --- a/pidgin/gtkconv.c Fri Apr 30 05:03:39 2021 -0500
    +++ b/pidgin/gtkconv.c Thu May 06 21:32:40 2021 -0500
    @@ -287,103 +287,6 @@
    return "/";
    }
    -static PurpleCmdRet
    -say_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - purple_conversation_send(conv, args[0]);
    -
    - return PURPLE_CMD_RET_OK;
    -}
    -
    -static PurpleCmdRet
    -me_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - char *tmp;
    -
    - tmp = g_strdup_printf("/me %s", args[0]);
    - purple_conversation_send(conv, tmp);
    -
    - g_free(tmp);
    - return PURPLE_CMD_RET_OK;
    -}
    -
    -static PurpleCmdRet
    -debug_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - char *tmp, *markup;
    -
    - if (!g_ascii_strcasecmp(args[0], "version")) {
    - tmp = g_strdup_printf("Using Pidgin v%s with libpurple v%s.",
    - DISPLAY_VERSION, purple_core_get_version());
    - } else if (!g_ascii_strcasecmp(args[0], "plugins")) {
    - /* Show all the loaded plugins, including plugins marked internal.
    - * This is intentional, since third party protocols are often sources of bugs, and some
    - * plugin loaders can also be buggy.
    - */
    - GString *str = g_string_new("Loaded Plugins: ");
    - const GList *plugins = purple_plugins_get_loaded();
    - if (plugins) {
    - for (; plugins; plugins = plugins->next) {
    - GPluginPluginInfo *info = GPLUGIN_PLUGIN_INFO(
    - purple_plugin_get_info(
    - PURPLE_PLUGIN(plugins->data)));
    - str = g_string_append(
    - str,
    - gplugin_plugin_info_get_name(info));
    -
    - if (plugins->next)
    - str = g_string_append(str, ", ");
    - }
    - } else {
    - str = g_string_append(str, "(none)");
    - }
    -
    - tmp = g_string_free(str, FALSE);
    - } else if (!g_ascii_strcasecmp(args[0], "unsafe")) {
    - if (purple_debug_is_unsafe()) {
    - purple_debug_set_unsafe(FALSE);
    - purple_conversation_write_system_message(conv,
    - _("Unsafe debugging is now disabled."),
    - PURPLE_MESSAGE_NO_LOG);
    - } else {
    - purple_debug_set_unsafe(TRUE);
    - purple_conversation_write_system_message(conv,
    - _("Unsafe debugging is now enabled."),
    - PURPLE_MESSAGE_NO_LOG);
    - }
    -
    - return PURPLE_CMD_RET_OK;
    - } else if (!g_ascii_strcasecmp(args[0], "verbose")) {
    - if (purple_debug_is_verbose()) {
    - purple_debug_set_verbose(FALSE);
    - purple_conversation_write_system_message(conv,
    - _("Verbose debugging is now disabled."),
    - PURPLE_MESSAGE_NO_LOG);
    - } else {
    - purple_debug_set_verbose(TRUE);
    - purple_conversation_write_system_message(conv,
    - _("Verbose debugging is now enabled."),
    - PURPLE_MESSAGE_NO_LOG);
    - }
    -
    - return PURPLE_CMD_RET_OK;
    - } else {
    - purple_conversation_write_system_message(conv,
    - _("Supported debug options are: plugins, version, unsafe, verbose"),
    - PURPLE_MESSAGE_NO_LOG);
    - return PURPLE_CMD_RET_OK;
    - }
    -
    - markup = g_markup_escape_text(tmp, -1);
    - purple_conversation_send(conv, markup);
    -
    - g_free(tmp);
    - g_free(markup);
    - return PURPLE_CMD_RET_OK;
    -}
    static void clear_conversation_scrollback_cb(PurpleConversation *conv,
    void *data)
    @@ -395,65 +298,6 @@
    }
    }
    -static PurpleCmdRet
    -clear_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - purple_conversation_clear_message_history(conv);
    - return PURPLE_CMD_RET_OK;
    -}
    -
    -static PurpleCmdRet
    -clearall_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - GList *l;
    - for (l = purple_conversations_get_all(); l != NULL; l = l->next)
    - purple_conversation_clear_message_history(PURPLE_CONVERSATION(l->data));
    -
    - return PURPLE_CMD_RET_OK;
    -}
    -
    -static PurpleCmdRet
    -help_command_cb(PurpleConversation *conv,
    - const char *cmd, char **args, char **error, void *data)
    -{
    - GList *l, *text;
    - GString *s;
    -
    - if (args[0] != NULL) {
    - s = g_string_new("");
    - text = purple_cmd_help(conv, args[0]);
    -
    - if (text) {
    - for (l = text; l; l = l->next)
    - if (l->next)
    - g_string_append_printf(s, "%s\n", (char *)l->data);
    - else
    - g_string_append_printf(s, "%s", (char *)l->data);
    - } else {
    - g_string_append(s, _("No such command (in this context)."));
    - }
    - } else {
    - s = g_string_new(_("Use \"/help &lt;command&gt;\" for help with a "
    - "specific command.<br/>The following commands are available "
    - "in this context:<br/>"));
    -
    - text = purple_cmd_list(conv);
    - for (l = text; l; l = l->next)
    - if (l->next)
    - g_string_append_printf(s, "%s, ", (char *)l->data);
    - else
    - g_string_append_printf(s, "%s.", (char *)l->data);
    - g_list_free(text);
    - }
    -
    - purple_conversation_write_system_message(conv, s->str, PURPLE_MESSAGE_NO_LOG);
    - g_string_free(s, TRUE);
    -
    - return PURPLE_CMD_RET_OK;
    -}
    -
    static void
    send_history_add(PidginConversation *gtkconv, const char *message)
    {
    @@ -5109,28 +4953,6 @@
    /**********************************************************************
    - * Register commands
    - **********************************************************************/
    - purple_cmd_register("say", "S", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    - say_command_cb, _("say &lt;message&gt;: Send a message normally as if you weren't using a command."), NULL);
    - purple_cmd_register("me", "S", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    - me_command_cb, _("me &lt;action&gt;: Send an IRC style action to a buddy or chat."), NULL);
    - purple_cmd_register("debug", "w", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    - debug_command_cb, _("debug &lt;option&gt;: Send various debug information to the current conversation."), NULL);
    - purple_cmd_register("clear", "", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    - clear_command_cb, _("clear: Clears the conversation scrollback."), NULL);
    - purple_cmd_register("clearall", "", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    - clearall_command_cb, _("clear: Clears all conversation scrollbacks."), NULL);
    - purple_cmd_register("help", "w", PURPLE_CMD_P_DEFAULT,
    - PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM | PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS, NULL,
    - help_command_cb, _("help &lt;command&gt;: Help on a specific command."), NULL);
    -
    - /**********************************************************************
    * UI operations
    **********************************************************************/
    --- a/pidgin/libpidgin.c Fri Apr 30 05:03:39 2021 -0500
    +++ b/pidgin/libpidgin.c Thu May 06 21:32:40 2021 -0500
    @@ -54,6 +54,7 @@
    #include "pidgindebug.h"
    #include "pidginlog.h"
    #include "pidginplugininfo.h"
    +#include "pidginprivate.h"
    #include "pidginstock.h"
    #ifndef _WIN32
    @@ -189,6 +190,7 @@
    pidgin_blist_init();
    pidgin_status_init();
    pidgin_conversations_init();
    + pidgin_commands_init();
    pidgin_privacy_init();
    pidgin_xfers_init();
    pidgin_roomlist_init();
    @@ -206,6 +208,7 @@
    pidgin_notify_uninit();
    _pidgin_smiley_theme_uninit();
    + pidgin_commands_uninit();
    pidgin_conversations_uninit();
    pidgin_status_uninit();
    pidgin_blist_uninit();
    --- a/pidgin/meson.build Fri Apr 30 05:03:39 2021 -0500
    +++ b/pidgin/meson.build Thu May 06 21:32:40 2021 -0500
    @@ -40,6 +40,7 @@
    'pidginavatar.c',
    'pidgincellrendererexpander.c',
    'pidginclosebutton.c',
    + 'pidgincommands.c',
    'pidgincontactcompletion.c',
    'pidginconversationwindow.c',
    'pidgincontactlist.c',
    @@ -236,7 +237,7 @@
    libpidgin_inc = include_directories('.')
    libpidgin = shared_library('pidgin3',
    - libpidgin_SOURCES + libpidgin_built_sources + libpidgin_built_headers,
    + libpidgin_SOURCES + libpidgin_built_sources + libpidgin_built_headers + ['pidginprivate.h'],
    package_revision,
    c_args : ['-DPIDGIN_COMPILATION', '-DG_LOG_DOMAIN="Pidgin"'],
    include_directories : [toplevel_inc],
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/pidgin/pidgincommands.c Thu May 06 21:32:40 2021 -0500
    @@ -0,0 +1,214 @@
    +/*
    + * Pidgin - Internet Messenger
    + * Copyright (C) Pidgin Developers <devel@pidgin.im>
    + *
    + * Pidgin is the legal property of its developers, whose names are too numerous
    + * to list here. Please refer to the COPYRIGHT file distributed with this
    + * source distribution.
    + *
    + * This program 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 2 of the License, or
    + * (at your option) any later version.
    + *
    + * This program 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 this program; if not, see <https://www.gnu.org/licenses/>.
    + */
    +
    +#include <glib/gi18n-lib.h>
    +
    +#include <pidginprivate.h>
    +
    +/******************************************************************************
    + * Command Implementations
    + *****************************************************************************/
    +static PurpleCmdRet
    +say_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + purple_conversation_send(conv, args[0]);
    +
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +static PurpleCmdRet
    +me_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + char *tmp;
    +
    + tmp = g_strdup_printf("/me %s", args[0]);
    + purple_conversation_send(conv, tmp);
    +
    + g_free(tmp);
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +static PurpleCmdRet
    +debug_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + char *tmp, *markup;
    +
    + if (!g_ascii_strcasecmp(args[0], "version")) {
    + tmp = g_strdup_printf("Using Pidgin v%s with libpurple v%s.",
    + DISPLAY_VERSION, purple_core_get_version());
    + } else if (!g_ascii_strcasecmp(args[0], "plugins")) {
    + /* Show all the loaded plugins, including plugins marked internal.
    + * This is intentional, since third party protocols are often sources of bugs, and some
    + * plugin loaders can also be buggy.
    + */
    + GString *str = g_string_new("Loaded Plugins: ");
    + const GList *plugins = purple_plugins_get_loaded();
    + if (plugins) {
    + for (; plugins; plugins = plugins->next) {
    + GPluginPluginInfo *info = GPLUGIN_PLUGIN_INFO(
    + purple_plugin_get_info(
    + PURPLE_PLUGIN(plugins->data)));
    + str = g_string_append(
    + str,
    + gplugin_plugin_info_get_name(info));
    +
    + if (plugins->next)
    + str = g_string_append(str, ", ");
    + }
    + } else {
    + str = g_string_append(str, "(none)");
    + }
    +
    + tmp = g_string_free(str, FALSE);
    + } else if (!g_ascii_strcasecmp(args[0], "unsafe")) {
    + if (purple_debug_is_unsafe()) {
    + purple_debug_set_unsafe(FALSE);
    + purple_conversation_write_system_message(conv,
    + _("Unsafe debugging is now disabled."),
    + PURPLE_MESSAGE_NO_LOG);
    + } else {
    + purple_debug_set_unsafe(TRUE);
    + purple_conversation_write_system_message(conv,
    + _("Unsafe debugging is now enabled."),
    + PURPLE_MESSAGE_NO_LOG);
    + }
    +
    + return PURPLE_CMD_RET_OK;
    + } else if (!g_ascii_strcasecmp(args[0], "verbose")) {
    + if (purple_debug_is_verbose()) {
    + purple_debug_set_verbose(FALSE);
    + purple_conversation_write_system_message(conv,
    + _("Verbose debugging is now disabled."),
    + PURPLE_MESSAGE_NO_LOG);
    + } else {
    + purple_debug_set_verbose(TRUE);
    + purple_conversation_write_system_message(conv,
    + _("Verbose debugging is now enabled."),
    + PURPLE_MESSAGE_NO_LOG);
    + }
    +
    + return PURPLE_CMD_RET_OK;
    + } else {
    + purple_conversation_write_system_message(conv,
    + _("Supported debug options are: plugins, version, unsafe, verbose"),
    + PURPLE_MESSAGE_NO_LOG);
    + return PURPLE_CMD_RET_OK;
    + }
    +
    + markup = g_markup_escape_text(tmp, -1);
    + purple_conversation_send(conv, markup);
    +
    + g_free(tmp);
    + g_free(markup);
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +static PurpleCmdRet
    +clear_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + purple_conversation_clear_message_history(conv);
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +static PurpleCmdRet
    +clearall_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + GList *l;
    + for (l = purple_conversations_get_all(); l != NULL; l = l->next)
    + purple_conversation_clear_message_history(PURPLE_CONVERSATION(l->data));
    +
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +static PurpleCmdRet
    +help_command_cb(PurpleConversation *conv,
    + const char *cmd, char **args, char **error, void *data)
    +{
    + GList *l, *text;
    + GString *s;
    +
    + if (args[0] != NULL) {
    + s = g_string_new("");
    + text = purple_cmd_help(conv, args[0]);
    +
    + if (text) {
    + for (l = text; l; l = l->next)
    + if (l->next)
    + g_string_append_printf(s, "%s\n", (char *)l->data);
    + else
    + g_string_append_printf(s, "%s", (char *)l->data);
    + } else {
    + g_string_append(s, _("No such command (in this context)."));
    + }
    + } else {
    + s = g_string_new(_("Use \"/help &lt;command&gt;\" for help with a "
    + "specific command.<br/>The following commands are available "
    + "in this context:<br/>"));
    +
    + text = purple_cmd_list(conv);
    + for (l = text; l; l = l->next)
    + if (l->next)
    + g_string_append_printf(s, "%s, ", (char *)l->data);
    + else
    + g_string_append_printf(s, "%s.", (char *)l->data);
    + g_list_free(text);
    + }
    +
    + purple_conversation_write_system_message(conv, s->str, PURPLE_MESSAGE_NO_LOG);
    + g_string_free(s, TRUE);
    +
    + return PURPLE_CMD_RET_OK;
    +}
    +
    +/******************************************************************************
    + * Public API
    + *****************************************************************************/
    +void
    +pidgin_commands_init(void) {
    + purple_cmd_register("say", "S", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    + say_command_cb, _("say &lt;message&gt;: Send a message normally as if you weren't using a command."), NULL);
    + purple_cmd_register("me", "S", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    + me_command_cb, _("me &lt;action&gt;: Send an IRC style action to a buddy or chat."), NULL);
    + purple_cmd_register("debug", "w", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    + debug_command_cb, _("debug &lt;option&gt;: Send various debug information to the current conversation."), NULL);
    + purple_cmd_register("clear", "", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    + clear_command_cb, _("clear: Clears the conversation scrollback."), NULL);
    + purple_cmd_register("clearall", "", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM, NULL,
    + clearall_command_cb, _("clearall: Clears all conversation scrollbacks."), NULL);
    + purple_cmd_register("help", "w", PURPLE_CMD_P_DEFAULT,
    + PURPLE_CMD_FLAG_CHAT | PURPLE_CMD_FLAG_IM | PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS, NULL,
    + help_command_cb, _("help &lt;command&gt;: Help on a specific command."), NULL);
    +}
    +
    +void
    +pidgin_commands_uninit(void) {
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/pidgin/pidginprivate.h Thu May 06 21:32:40 2021 -0500
    @@ -0,0 +1,56 @@
    +/*
    + * Pidgin - Internet Messenger
    + * Copyright (C) Pidgin Developers <devel@pidgin.im>
    + *
    + * Pidgin is the legal property of its developers, whose names are too numerous
    + * to list here. Please refer to the COPYRIGHT file distributed with this
    + * source distribution.
    + *
    + * This program 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 2 of the License, or
    + * (at your option) any later version.
    + *
    + * This program 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 this program; if not, see <https://www.gnu.org/licenses/>.
    + */
    +
    +#ifndef PIDGIN_PRIVATE_H
    +#define PIDGIN_PRIVATE_H
    +
    +#include <glib.h>
    +
    +#include <purple.h>
    +
    +G_BEGIN_DECLS
    +
    +/*
    + * pidgin_commands_init:
    + *
    + * Initializes the default conversation commands for Pidgin.
    + *
    + * This should only be called internally from Pidgin.
    + *
    + * Since: 3.0.0
    + */
    +void pidgin_commands_init(void);
    +
    +/*
    + * pidgin_commands_uninit:
    + *
    + * Uninitializes the default conversation commands for Pidgin.
    + *
    + * This should only be called internally from Pidgin.
    + *
    + * Since: 3.0.0
    + */
    +void pidgin_commands_uninit(void);
    +
    +G_END_DECLS
    +
    +#endif /* PIDGIN_PRIVATE_H */
    --- a/po/POTFILES.in Fri Apr 30 05:03:39 2021 -0500
    +++ b/po/POTFILES.in Thu May 06 21:32:40 2021 -0500
    @@ -349,6 +349,7 @@
    pidgin/pidgin.c
    pidgin/pidgincellrendererexpander.c
    pidgin/pidginclosebutton.c
    +pidgin/pidgincommands.c
    pidgin/pidgincontactcompletion.c
    pidgin/pidgincontactlist.c
    pidgin/pidginconversationwindow.c