libpurple/plugins/joinpart.c

   1 /**
   2  * purple
   3  *
   4  * Purple is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #include "internal.h"
  24 #include "conversation.h"
  25 #include "debug.h"
  26 #include "plugins.h"
  27 #include "version.h"
  28
  29 #define JOINPART_PLUGIN_ID "core-rlaager-joinpart"
  30
  31
  32 /* Preferences */
  33
  34 /* The number of minutes before a person is considered
  35  * to have stopped being part of active conversation. */
  36 #define DELAY_PREF "/plugins/core/joinpart/delay"
  37 #define DELAY_DEFAULT 10
  38
  39 /* The number of people that must be in a room for this
  40  * plugin to have any effect */
  41 #define THRESHOLD_PREF "/plugins/core/joinpart/threshold"
  42 #define THRESHOLD_DEFAULT 20
  43
  44 /* Hide buddies */
  45 #define HIDE_BUDDIES_PREF "/plugins/core/joinpart/hide_buddies"
  46 #define HIDE_BUDDIES_DEFAULT FALSE
  47
  48 struct joinpart_key
  49 {
  50         PurpleConversation *conv;
  51         char *user;
  52 };
  53
  54 static guint joinpart_key_hash(const struct joinpart_key *key)
  55 {
  56         g_return_val_if_fail(key != NULL, 0);
  57
  58         return g_direct_hash(key->conv) + g_str_hash(key->user);
  59 }
  60
  61 static gboolean joinpart_key_equal(const struct joinpart_key *a, const struct joinpart_key *b)
  62 {
  63         if (a == NULL)
  64                 return (b == NULL);
  65         else if (b == NULL)
  66                 return FALSE;
  67
  68         return (a->conv == b->conv) && !strcmp(a->user, b->user);
  69 }
  70
  71 static void joinpart_key_destroy(struct joinpart_key *key)
  72 {
  73         g_return_if_fail(key != NULL);
  74
  75         g_free(key->user);
  76         g_free(key);
  77 }
  78
  79 static gboolean should_hide_notice(PurpleConversation *conv, const char *name,
  80                                    GHashTable *users)
  81 {
  82         PurpleChatConversation *chat;
  83         guint threshold;
  84         struct joinpart_key key;
  85         time_t *last_said;
  86
  87         g_return_val_if_fail(conv != NULL, FALSE);
  88         g_return_val_if_fail(PURPLE_IS_CHAT_CONVERSATION(conv), FALSE);
  89
  90         /* If the room is small, don't bother. */
  91         chat = PURPLE_CHAT_CONVERSATION(conv);
  92         threshold = purple_prefs_get_int(THRESHOLD_PREF);
  93         if (purple_chat_conversation_get_users_count(chat) < threshold)
  94                 return FALSE;
  95
  96         if (!purple_prefs_get_bool(HIDE_BUDDIES_PREF) &&
  97             purple_blist_find_buddy(purple_conversation_get_account(conv), name))
  98                 return FALSE;
  99
 100         /* Only show the notice if the user has spoken recently. */
 101         key.conv = conv;
 102         key.user = (gchar *)name;
 103         last_said = g_hash_table_lookup(users, &key);
 104         if (last_said != NULL)
 105         {
 106                 int delay = purple_prefs_get_int(DELAY_PREF);
 107                 if (delay > 0 && (*last_said + (delay * 60)) >= time(NULL))
 108                         return FALSE;
 109         }
 110
 111         return TRUE;
 112 }
 113
 114 static gboolean chat_user_leaving_cb(PurpleConversation *conv, const char *name,
 115                                const char *reason, GHashTable *users)
 116 {
 117         return should_hide_notice(conv, name, users);
 118 }
 119
 120 static gboolean chat_user_joining_cb(PurpleConversation *conv, const char *name,
 121                                       PurpleChatUserFlags flags,
 122                                       GHashTable *users)
 123 {
 124         return should_hide_notice(conv, name, users);
 125 }
 126
 127 static void received_chat_msg_cb(PurpleAccount *account, char *sender,
 128                                  char *message, PurpleConversation *conv,
 129                                  PurpleMessageFlags flags, GHashTable *users)
 130 {
 131         struct joinpart_key key;
 132         time_t *last_said;
 133
 134         /* Most of the time, we'll already have tracked the user,
 135          * so we avoid memory allocation here. */
 136         key.conv = conv;
 137         key.user = sender;
 138         last_said = g_hash_table_lookup(users, &key);
 139         if (last_said != NULL)
 140         {
 141                 /* They just said something, so update the time. */
 142                 time(last_said);
 143         }
 144         else
 145         {
 146                 struct joinpart_key *key2;
 147
 148                 key2 = g_new(struct joinpart_key, 1);
 149                 key2->conv = conv;
 150                 key2->user = g_strdup(sender);
 151
 152                 last_said = g_new(time_t, 1);
 153                 time(last_said);
 154
 155                 g_hash_table_insert(users, key2, last_said);
 156         }
 157 }
 158
 159 static gboolean check_expire_time(struct joinpart_key *key,
 160                                   time_t *last_said, time_t *limit)
 161 {
 162         purple_debug_info("joinpart", "Removing key for %s\n", key->user);
 163         return (*last_said < *limit);
 164 }
 165
 166 static gboolean clean_users_hash(GHashTable *users)
 167 {
 168         int delay = purple_prefs_get_int(DELAY_PREF);
 169         time_t limit = time(NULL) - (60 * delay);
 170
 171         g_hash_table_foreach_remove(users, (GHRFunc)check_expire_time, &limit);
 172
 173         return TRUE;
 174 }
 175
 176 static PurplePluginPrefFrame *
 177 get_plugin_pref_frame(PurplePlugin *plugin)
 178 {
 179         PurplePluginPrefFrame *frame;
 180         PurplePluginPref *ppref;
 181
 182         g_return_val_if_fail(plugin != NULL, FALSE);
 183
 184         frame = purple_plugin_pref_frame_new();
 185
 186         ppref = purple_plugin_pref_new_with_label(_("Hide Joins/Parts"));
 187         purple_plugin_pref_frame_add(frame, ppref);
 188
 189         ppref = purple_plugin_pref_new_with_name_and_label(THRESHOLD_PREF,
 190                                                          /* Translators: Followed by an input request a number of people */
 191                                                          _("For rooms with more than this many people"));
 192         purple_plugin_pref_set_bounds(ppref, 0, 1000);
 193         purple_plugin_pref_frame_add(frame, ppref);
 194
 195         ppref = purple_plugin_pref_new_with_name_and_label(DELAY_PREF,
 196                                                          _("If user has not spoken in this many minutes"));
 197         purple_plugin_pref_set_bounds(ppref, 0, 8 * 60); /* 8 Hours */
 198         purple_plugin_pref_frame_add(frame, ppref);
 199
 200         ppref = purple_plugin_pref_new_with_name_and_label(HIDE_BUDDIES_PREF,
 201                                                          _("Apply hiding rules to buddies"));
 202         purple_plugin_pref_frame_add(frame, ppref);
 203
 204         return frame;
 205 }
 206
 207 static PurplePluginInfo *
 208 plugin_query(GError **error)
 209 {
 210         const gchar * const authors[] = {
 211                 "Richard Laager <rlaager@pidgin.im>",
 212                 NULL
 213         };
 214
 215         return purple_plugin_info_new(
 216                 "id",             JOINPART_PLUGIN_ID,
 217                 "name",           N_("Join/Part Hiding"),
 218                 "version",        DISPLAY_VERSION,
 219                 "category",       N_("User interface"),
 220                 "summary",        N_("Hides extraneous join/part messages."),
 221                 "description",    N_("This plugin hides join/part messages in "
 222                                      "large rooms, except for those users actively "
 223                                      "taking part in a conversation."),
 224                 "authors",        authors,
 225                 "website",        PURPLE_WEBSITE,
 226                 "abi-version",    PURPLE_ABI_VERSION,
 227                 "pref-frame-cb",  get_plugin_pref_frame,
 228                 NULL
 229         );
 230 }
 231
 232 static gboolean plugin_load(PurplePlugin *plugin, GError **error)
 233 {
 234         void *conv_handle;
 235         GHashTable *users;
 236         guint id;
 237
 238         purple_prefs_add_none("/plugins/core/joinpart");
 239
 240         purple_prefs_add_int(DELAY_PREF, DELAY_DEFAULT);
 241         purple_prefs_add_int(THRESHOLD_PREF, THRESHOLD_DEFAULT);
 242         purple_prefs_add_bool(HIDE_BUDDIES_PREF, HIDE_BUDDIES_DEFAULT);
 243
 244         users = g_hash_table_new_full((GHashFunc)joinpart_key_hash,
 245                                       (GEqualFunc)joinpart_key_equal,
 246                                       (GDestroyNotify)joinpart_key_destroy,
 247                                       g_free);
 248
 249         conv_handle = purple_conversations_get_handle();
 250         purple_signal_connect(conv_handle, "chat-user-joining", plugin,
 251                             PURPLE_CALLBACK(chat_user_joining_cb), users);
 252         purple_signal_connect(conv_handle, "chat-user-leaving", plugin,
 253                             PURPLE_CALLBACK(chat_user_leaving_cb), users);
 254         purple_signal_connect(conv_handle, "received-chat-msg", plugin,
 255                             PURPLE_CALLBACK(received_chat_msg_cb), users);
 256
 257         /* Cleanup every 5 minutes */
 258         id = purple_timeout_add_seconds(60 * 5, (GSourceFunc)clean_users_hash, users);
 259
 260         g_object_set_data(G_OBJECT(plugin), "users", users);
 261         g_object_set_data(G_OBJECT(plugin), "id", GUINT_TO_POINTER(id));
 262
 263         return TRUE;
 264 }
 265
 266 static gboolean plugin_unload(PurplePlugin *plugin, GError **error)
 267 {
 268         /* Destroy the hash table. The core plugin code will
 269          * disconnect the signals, and since Purple is single-threaded,
 270          * we don't have to worry one will be called after this. */
 271         g_hash_table_destroy((GHashTable *)g_object_get_data(G_OBJECT(plugin), "users"));
 272
 273         purple_timeout_remove(GPOINTER_TO_UINT(g_object_get_data(G_OBJECT(plugin), "id")));
 274
 275         return TRUE;
 276 }
 277
 278 PURPLE_PLUGIN_INIT(joinpart, plugin_query, plugin_load, plugin_unload);