Added new plugins functions: set_config, get_plugin_config, set_plugin_config.

New file is used to store plugin variables (~/.weechat/plugins.rc)

src/plugins/plugins-interface.c

@@ -0,0 +1,665 @@
+/*
+ * Copyright (c) 2003-2005 by FlashCode <flashcode@flashtux.org>
+ * See README for License detail, AUTHORS for developers list.
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+/* plugins-interface.c: WeeChat plugins interface */
+
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <errno.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <stdarg.h>
+#include <string.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include "../common/weechat.h"
+#include "plugins.h"
+#include "plugins-config.h"
+#include "../common/command.h"
+#include "../common/weeconfig.h"
+#include "../irc/irc.h"
+
+
+/*
+ * weechat_ascii_strcasecmp: locale and case independent string comparison
+ */
+
+int
+weechat_ascii_strcasecmp (t_weechat_plugin *plugin,
+                          char *string1, char *string2)
+{
+    /* make gcc happy */
+    (void) plugin;
+    
+    return ascii_strcasecmp (string1, string2);
+}
+
+/*
+ * weechat_ascii_strncasecmp: locale and case independent string comparison
+ *                            with max length
+ */
+
+int
+weechat_ascii_strncasecmp (t_weechat_plugin *plugin,
+                          char *string1, char *string2, int max)
+{
+    /* make gcc happy */
+    (void) plugin;
+    
+    return ascii_strncasecmp (string1, string2, max);
+}
+
+/*
+ * weechat_explode_string: explode a string
+ */
+
+char **
+weechat_explode_string (t_weechat_plugin *plugin, char *string,
+                        char *separators, int num_items_max,
+                        int *num_items)
+{
+    /* make gcc happy */
+    (void) plugin;
+    
+    if (!plugin || !string || !separators || !num_items)
+        return NULL;
+    
+    return explode_string (string, separators, num_items_max, num_items);
+}
+
+/*
+ * weechat_free_exploded_string: free exploded string
+ */
+
+void
+weechat_free_exploded_string (t_weechat_plugin *plugin, char **exploded_string)
+{
+    /* make gcc happy */
+    (void) plugin;
+    
+    free_exploded_string (exploded_string);
+}
+
+/*
+ * weechat_plugin_mkdir_home: create a directory for script in WeeChat home
+ */
+
+int
+weechat_plugin_mkdir_home (t_weechat_plugin *plugin, char *path)
+{
+    char *dir_name;
+    int dir_length;
+    
+    /* make gcc happy */
+    (void) plugin;
+    
+    if (!path)
+        return 0;
+    
+    /* build directory, adding WeeChat home */
+    dir_length = strlen (weechat_home) + strlen (path) + 2;
+    dir_name =
+        (char *) malloc (dir_length * sizeof (char));
+    if (!dir_name)
+        return 0;
+    
+    snprintf (dir_name, dir_length, "%s/%s", weechat_home, path);
+    
+    if (mkdir (dir_name, 0755) < 0)
+    {
+        if (errno != EEXIST)
+        {
+            free (dir_name);
+            return 0;
+        }
+    }
+    
+    free (dir_name);
+    return 1;
+}
+
+/*
+ * weechat_plugin_exec_on_files: find files in a directory and execute a
+ *                               function on each file
+ */
+
+void
+weechat_plugin_exec_on_files (t_weechat_plugin *plugin, char *directory,
+                              int (*callback)(t_weechat_plugin *, char *))
+{
+    if (directory && callback)
+        plugin_exec_on_files (plugin, directory, callback);
+}
+
+/*
+ * weechat_plugin_printf: print a message on a server or channel buffer
+ */
+
+void
+weechat_plugin_printf (t_weechat_plugin *plugin,
+                       char *server, char *channel, char *message, ...)
+{
+    t_gui_buffer *ptr_buffer;
+    va_list argptr;
+    static char buf[8192];
+    
+    if (!plugin || !message)
+        return;
+    
+    ptr_buffer = plugin_find_buffer (server, channel);
+    va_start (argptr, message);
+    vsnprintf (buf, sizeof (buf) - 1, message, argptr);
+    va_end (argptr);
+    irc_display_prefix (ptr_buffer, PREFIX_PLUGIN);
+    gui_printf (ptr_buffer, "%s\n", buf);
+}
+
+/*
+ * weechat_plugin_printf_server: print a message on server buffer
+ */
+
+void
+weechat_plugin_printf_server (t_weechat_plugin *plugin, char *message, ...)
+{
+    va_list argptr;
+    static char buf[8192];
+    
+    if (!plugin || !message)
+        return;
+    
+    va_start (argptr, message);
+    vsnprintf (buf, sizeof (buf) - 1, message, argptr);
+    va_end (argptr);
+    irc_display_prefix (NULL, PREFIX_PLUGIN);
+    gui_printf (NULL, "%s\n", buf);
+}
+
+/*
+ * weechat_plugin_infobar_printf: print a message in infobar
+ */
+
+void
+weechat_plugin_infobar_printf (t_weechat_plugin *plugin, int time_displayed, char *message, ...)
+{
+    va_list argptr;
+    static char buf[1024];
+    
+    if (!plugin || (time_displayed < 0) || !message)
+        return;
+    
+    va_start (argptr, message);
+    vsnprintf (buf, sizeof (buf) - 1, message, argptr);
+    va_end (argptr);
+    gui_infobar_printf (time_displayed, COLOR_WIN_INFOBAR, buf);
+}
+
+/*
+ * weechat_plugin_msg_handler_add: add a message handler
+ */
+
+t_plugin_msg_handler *
+weechat_plugin_msg_handler_add (t_weechat_plugin *plugin, char *message,
+                                t_plugin_handler_func *handler_func,
+                                char *handler_args, void *handler_pointer)
+{
+    if (plugin && message && handler_func)
+        return plugin_msg_handler_add (plugin, message, handler_func,
+                                       handler_args, handler_pointer);
+    
+    return NULL;
+}
+
+/*
+ * weechat_plugin_msg_handler_remove: remove a WeeChat message handler
+ */
+
+void
+weechat_plugin_msg_handler_remove (t_weechat_plugin *plugin,
+                                   t_plugin_msg_handler *msg_handler)
+{
+    if (plugin && msg_handler)
+        plugin_msg_handler_remove (plugin, msg_handler);
+}
+
+/*
+ * weechat_plugin_msg_handler_remove_all: remove all WeeChat message handlers
+ */
+
+void
+weechat_plugin_msg_handler_remove_all (t_weechat_plugin *plugin)
+{
+    if (plugin)
+        plugin_msg_handler_remove_all (plugin);
+}
+
+/*
+ * weechat_plugin_cmd_handler_add: add a command handler
+ */
+
+t_plugin_cmd_handler *
+weechat_plugin_cmd_handler_add (t_weechat_plugin *plugin, char *command,
+                                char *description, char *arguments,
+                                char *arguments_description,
+                                t_plugin_handler_func *handler_func,
+                                char *handler_args, void *handler_pointer)
+{
+    if (plugin && command && handler_func)
+        return plugin_cmd_handler_add (plugin, command, description, arguments,
+                                       arguments_description,
+                                       handler_func,
+                                       handler_args, handler_pointer);
+    
+    return NULL;
+}
+
+/*
+ * weechat_cmd_plugin_handler_remove: remove a WeeChat command handler
+ */
+
+void
+weechat_plugin_cmd_handler_remove (t_weechat_plugin *plugin,
+                                   t_plugin_cmd_handler *cmd_handler)
+{
+    if (plugin && cmd_handler)
+        plugin_cmd_handler_remove (plugin, cmd_handler);
+}
+
+/*
+ * weechat_plugin_cmd_handler_remove_all: remove all WeeChat command handlers
+ */
+
+void
+weechat_plugin_cmd_handler_remove_all (t_weechat_plugin *plugin)
+{
+    if (plugin)
+        plugin_cmd_handler_remove_all (plugin);
+}
+
+/*
+ * weechat_plugin_exec_command: execute a command (simulate user entry)
+ */
+
+void
+weechat_plugin_exec_command (t_weechat_plugin *plugin,
+                             char *server, char *channel, char *command)
+{
+    t_gui_buffer *ptr_buffer;
+    
+    if (!plugin || !command)
+        return;
+    
+    ptr_buffer = plugin_find_buffer (server, channel);
+    if (ptr_buffer)
+        user_command (SERVER(ptr_buffer), ptr_buffer, command);
+}
+
+/*
+ * weechat_plugin_get_info: get info about WeeChat
+ *                          WARNING: caller should free string returned
+ *                          by this function after use
+ */
+
+char *
+weechat_plugin_get_info (t_weechat_plugin *plugin, char *info, char *server, char *channel)
+{
+    t_gui_buffer *ptr_buffer;
+    
+    if (!plugin || !info)
+        return NULL;
+    
+    ptr_buffer = plugin_find_buffer (server, channel);
+    if (!ptr_buffer)
+        return NULL;
+    
+    if (ascii_strcasecmp (info, "version") == 0)
+    {
+        return strdup (PACKAGE_VERSION);
+    }
+    else if (ascii_strcasecmp (info, "nick") == 0)
+    {
+        if (SERVER(ptr_buffer) && (SERVER(ptr_buffer)->is_connected)
+            && (SERVER(ptr_buffer)->nick))
+            return strdup (SERVER(ptr_buffer)->nick);
+    }
+    else if (ascii_strcasecmp (info, "channel") == 0)
+    {
+        if (BUFFER_IS_CHANNEL(ptr_buffer))
+            return strdup (CHANNEL(gui_current_window->buffer)->name);
+    }
+    else if (ascii_strcasecmp (info, "server") == 0)
+    {
+        if (SERVER(ptr_buffer) && (SERVER(ptr_buffer)->is_connected)
+            && (SERVER(ptr_buffer)->name))
+            return strdup (SERVER(ptr_buffer)->name);
+    }
+    else if (ascii_strcasecmp (info, "away") == 0)
+    {
+        if (SERVER(ptr_buffer) && (SERVER(ptr_buffer)->is_connected))
+        {
+            if (SERVER(ptr_buffer)->is_away)
+                return strdup ("1");
+            else
+                return strdup ("0");
+        }
+    }
+    else if (ascii_strcasecmp (info, "weechatdir") == 0)
+    {
+        /* WARNING: deprecated info, you should use weechat_dir */
+        /* will be removed in a future version */
+        return strdup (weechat_home);
+    }
+    else if (ascii_strcasecmp (info, "weechat_dir") == 0)
+    {
+        return strdup (weechat_home);
+    }
+    else if (ascii_strcasecmp (info, "weechat_libdir") == 0)
+    {
+        return strdup (WEECHAT_LIBDIR);
+    }
+    else if (ascii_strcasecmp (info, "weechat_sharedir") == 0)
+    {
+        return strdup (WEECHAT_SHAREDIR);
+    }
+    
+    /* info not found */
+    return NULL;
+}
+
+/*
+ * weechat_plugin_get_dcc_info: get list of DCC files/chats info
+ */
+
+t_plugin_dcc_info *
+weechat_plugin_get_dcc_info (t_weechat_plugin *plugin)
+{
+    t_plugin_dcc_info *dcc_info, *last_dcc_info, *new_dcc_info;
+    t_irc_dcc *ptr_dcc;
+    
+    if (!plugin)
+        return NULL;
+    
+    if (dcc_list)
+    {
+        dcc_info = NULL;
+        last_dcc_info = NULL;
+        for (ptr_dcc = dcc_list; ptr_dcc; ptr_dcc = ptr_dcc->next_dcc)
+        {
+            new_dcc_info = (t_plugin_dcc_info *)malloc (sizeof (t_plugin_dcc_info));
+            if (new_dcc_info)
+            {
+                new_dcc_info->server = (ptr_dcc->server) ? strdup (ptr_dcc->server->name) : strdup ("");
+                new_dcc_info->channel = (ptr_dcc->channel) ? strdup (ptr_dcc->channel->name) : strdup ("");
+                new_dcc_info->type = ptr_dcc->type;
+                new_dcc_info->status = ptr_dcc->status;
+                new_dcc_info->start_time = ptr_dcc->start_time;
+                new_dcc_info->start_transfer = ptr_dcc->start_transfer;
+                new_dcc_info->addr = ptr_dcc->addr;
+                new_dcc_info->port = ptr_dcc->port;
+                new_dcc_info->nick = (ptr_dcc->nick) ? strdup (ptr_dcc->nick) : strdup ("");
+                new_dcc_info->filename = (ptr_dcc->filename) ? strdup (ptr_dcc->filename) : strdup ("");
+                new_dcc_info->local_filename = (ptr_dcc->local_filename) ? strdup (ptr_dcc->local_filename) : strdup ("");
+                new_dcc_info->filename_suffix = ptr_dcc->filename_suffix;
+                new_dcc_info->size = ptr_dcc->size;
+                new_dcc_info->pos = ptr_dcc->pos;
+                new_dcc_info->start_resume = ptr_dcc->start_resume;
+                new_dcc_info->bytes_per_sec = ptr_dcc->bytes_per_sec;
+                
+                new_dcc_info->prev_dcc = last_dcc_info;
+                new_dcc_info->next_dcc = NULL;
+                if (!dcc_info)
+                {
+                    dcc_info = new_dcc_info;
+                    last_dcc_info = new_dcc_info;
+                }
+                else
+                    last_dcc_info->next_dcc = new_dcc_info;
+            }
+        }
+        
+        return dcc_info;
+    }
+    
+    return NULL;
+}
+
+/*
+ * weechat_plugin_free_dcc_info: free dcc info struct list
+ */
+
+void
+weechat_plugin_free_dcc_info (t_weechat_plugin *plugin, t_plugin_dcc_info *dcc_info)
+{
+    t_plugin_dcc_info *new_dcc_info;
+    
+    if (!plugin || !dcc_info)
+        return;
+    
+    while (dcc_info)
+    {
+        if (dcc_info->server)
+            free (dcc_info->server);
+        if (dcc_info->channel)
+            free (dcc_info->channel);
+        if (dcc_info->nick)
+            free (dcc_info->nick);
+        if (dcc_info->filename)
+            free (dcc_info->filename);
+        if (dcc_info->local_filename)
+            free (dcc_info->local_filename);
+        new_dcc_info = dcc_info->next_dcc;
+        free (dcc_info);
+        dcc_info = new_dcc_info;
+    }
+}
+
+/*
+ * weechat_plugin_get_config_str_value: return string value for any option
+ *                                      This function should never be called directly
+ *                                      (only used by weechat_get_config)
+ */
+
+char *
+weechat_plugin_get_config_str_value (t_config_option *option, void *value)
+{
+    char buf_temp[1024], *color_name;
+    
+    if (!value)
+    {
+        if (option->option_type == OPTION_TYPE_STRING)
+            value = option->ptr_string;
+        else
+            value = option->ptr_int;
+    }
+    
+    switch (option->option_type)
+    {
+        case OPTION_TYPE_BOOLEAN:
+            return (*((int *)value)) ?
+                strdup ("on") : strdup ("off");
+            break;
+        case OPTION_TYPE_INT:
+            snprintf (buf_temp, sizeof (buf_temp), "%d",
+                      *((int *)value));
+            return strdup (buf_temp);
+            break;
+        case OPTION_TYPE_INT_WITH_STRING:
+            return option->array_values[*((int *)value)];
+            break;
+        case OPTION_TYPE_COLOR:
+            color_name = gui_get_color_by_value (*((int *)value));
+            return (color_name) ? strdup (color_name) : strdup ("");
+            break;
+        case OPTION_TYPE_STRING:
+            return (*((char **)value)) ? strdup (*((char **)value)) : strdup ("");
+            break;
+    }
+    
+    /* should never be executed! */
+    return NULL;
+}
+
+/*
+ * weechat_plugin_get_config: get value of a config option
+ */
+
+char *
+weechat_plugin_get_config (t_weechat_plugin *plugin, char *option)
+{
+    int i, j;
+    t_irc_server *ptr_server;
+    char option_name[256];
+    void *ptr_option_value;
+    
+    /* make gcc happy */
+    (void) plugin;
+    
+    for (i = 0; i < CONFIG_NUMBER_SECTIONS; i++)
+    {
+        if ((i != CONFIG_SECTION_KEYS) && (i != CONFIG_SECTION_ALIAS)
+            && (i != CONFIG_SECTION_IGNORE) && (i != CONFIG_SECTION_SERVER))
+        {
+            for (j = 0; weechat_options[i][j].option_name; j++)
+            {
+                if ((!option) ||
+                    ((option) && (option[0])
+                     && (strstr (weechat_options[i][j].option_name, option) != NULL)))
+                {
+                    return weechat_plugin_get_config_str_value (&weechat_options[i][j], NULL);
+                }
+            }
+        }
+    }
+    for (ptr_server = irc_servers; ptr_server;
+         ptr_server = ptr_server->next_server)
+    {
+        for (i = 0; weechat_options[CONFIG_SECTION_SERVER][i].option_name; i++)
+        {
+            snprintf (option_name, sizeof (option_name), "%s.%s",
+                      ptr_server->name, 
+                      weechat_options[CONFIG_SECTION_SERVER][i].option_name);
+            if ((!option) ||
+                ((option) && (option[0])
+                 && (strstr (option_name, option) != NULL)))
+            {
+                ptr_option_value = config_get_server_option_ptr (ptr_server,
+                                                                 weechat_options[CONFIG_SECTION_SERVER][i].option_name);
+                if (ptr_option_value)
+                {
+                    return weechat_plugin_get_config_str_value (&weechat_options[CONFIG_SECTION_SERVER][i],
+                                                                ptr_option_value);
+                }
+            }
+        }
+    }
+    
+    /* option not found */
+    return NULL;
+}
+
+/*
+ * weechat_plugin_set_config: set value of a config option
+ */
+
+int
+weechat_plugin_set_config (t_weechat_plugin *plugin, char *option, char *value)
+{
+    char *pos, *server_name;
+    t_irc_server *ptr_server;
+    t_config_option *ptr_option;
+    
+    /* make gcc happy */
+    (void) plugin;
+    
+    if (!option || !value)
+        return 0;
+    
+    pos = strchr (option, '.');
+    if (pos)
+    {
+        /* server config option modification */
+        server_name = (char *)malloc (pos - option + 1);
+        strncpy (server_name, option, pos - option);
+        if (server_name)
+        {
+            ptr_server = server_search (server_name);
+            free (server_name);
+            if (ptr_server)
+                return (config_set_server_value (ptr_server, pos + 1, value) == 0);
+        }
+    }
+    else
+    {
+        ptr_option = config_option_search (option);
+        if (ptr_option)
+        {
+            if (ptr_option->handler_change)
+            {
+                if (config_option_set_value (ptr_option, value) == 0)
+                {
+                    (void) (ptr_option->handler_change());
+                    return 1;
+                }
+            }
+        }
+    }
+    
+    /* failed to set config option */
+    return 0;
+}
+
+/*
+ * weechat_plugin_get_plugin_config: get value of a plugin config option
+ */
+
+char *
+weechat_plugin_get_plugin_config (t_weechat_plugin *plugin, char *option)
+{
+    t_plugin_option *ptr_plugin_option;
+    
+    if (!option)
+        return NULL;
+    
+    ptr_plugin_option = plugin_config_search (plugin, option);
+    if (ptr_plugin_option)
+        return (ptr_plugin_option->value) ? strdup (ptr_plugin_option->value) : NULL;
+    
+    /* option not found */
+    return NULL;
+}
+
+/*
+ * weechat_plugin_set_plugin_config: set value of a plugin config option
+ */
+
+int
+weechat_plugin_set_plugin_config (t_weechat_plugin *plugin, char *option, char *value)
+{
+    if (!option)
+        return 0;
+    
+    if (plugin_config_set (plugin, option, value))
+    {
+        plugin_config_write ();
+        return 1;
+    }
+    return 0;
+}