pidgin/plugins/history.c

   1 /* Puts last 4k of log in new conversations a la Everybuddy (and then
   2  * stolen by Trillian "Pro") */
   3
   4 #include "internal.h"
   5 #include "pidgin.h"
   6
   7 #include "conversation.h"
   8 #include "debug.h"
   9 #include "log.h"
  10 #include "notify.h"
  11 #include "prefs.h"
  12 #include "signals.h"
  13 #include "util.h"
  14 #include "version.h"
  15
  16 #include "gtkconv.h"
  17 #include "gtkplugin.h"
  18 #include "gtkwebview.h"
  19
  20 #define HISTORY_PLUGIN_ID "gtk-history"
  21
  22 #define HISTORY_SIZE (4 * 1024)
  23
  24 static gboolean _scroll_webview_to_end(gpointer data)
  25 {
  26         PidginWebView *webview = data;
  27         pidgin_webview_scroll_to_end(PIDGIN_WEBVIEW(webview), FALSE);
  28         g_object_unref(G_OBJECT(webview));
  29         return FALSE;
  30 }
  31
  32 static void historize(PurpleConversation *c)
  33 {
  34         PurpleAccount *account = purple_conversation_get_account(c);
  35         const char *name = purple_conversation_get_name(c);
  36         GList *logs = NULL;
  37         const char *alias = name;
  38         guint flags;
  39         char *history;
  40         PidginConversation *gtkconv;
  41 #if 0
  42         /* FIXME: WebView has no options */
  43         GtkIMHtmlOptions options = GTK_IMHTML_NO_COLOURS;
  44 #endif
  45         char *header;
  46 #if 0
  47         /* FIXME: WebView has no protocol setting */
  48         char *protocol;
  49 #endif
  50         char *escaped_alias;
  51         GDateTime *dt;
  52         gchar *header_date;
  53
  54         gtkconv = PIDGIN_CONVERSATION(c);
  55         g_return_if_fail(gtkconv != NULL);
  56
  57         /* An IM which is the first active conversation. */
  58         g_return_if_fail(gtkconv->convs != NULL);
  59         if (PURPLE_IS_IM_CONVERSATION(c) && !gtkconv->convs->next)
  60         {
  61                 GSList *buddies;
  62                 GSList *cur;
  63
  64                 /* If we're not logging, don't show anything.
  65                  * Otherwise, we might show a very old log. */
  66                 if (!purple_prefs_get_bool("/purple/logging/log_ims"))
  67                         return;
  68
  69                 /* Find buddies for this conversation. */
  70                 buddies = purple_blist_find_buddies(account, name);
  71
  72                 /* If we found at least one buddy, save the first buddy's alias. */
  73                 if (buddies != NULL)
  74                         alias = purple_buddy_get_contact_alias(PURPLE_BUDDY(buddies->data));
  75
  76                 for (cur = buddies; cur != NULL; cur = cur->next)
  77                 {
  78                         PurpleBlistNode *node = cur->data;
  79                         PurpleBlistNode *prev = purple_blist_node_get_sibling_prev(node);
  80                         PurpleBlistNode *next = purple_blist_node_get_sibling_next(node);
  81                         if ((node != NULL) && ((prev != NULL) || (next != NULL)))
  82                         {
  83                                 PurpleBlistNode *node2;
  84                                 PurpleBlistNode *parent = purple_blist_node_get_parent(node);
  85                                 PurpleBlistNode *child = purple_blist_node_get_first_child(parent);
  86
  87                                 alias = purple_buddy_get_contact_alias(PURPLE_BUDDY(node));
  88
  89                                 /* We've found a buddy that matches this conversation.  It's part of a
  90                                  * PurpleContact with more than one PurpleBuddy.  Loop through the PurpleBuddies
  91                                  * in the contact and get all the logs. */
  92                                 for (node2 = child ; node2 != NULL ; node2 = purple_blist_node_get_sibling_next(node2))
  93                                 {
  94                                         logs = g_list_concat(purple_log_get_logs(PURPLE_LOG_IM,
  95                                                         purple_buddy_get_name(PURPLE_BUDDY(node2)),
  96                                                         purple_buddy_get_account(PURPLE_BUDDY(node2))),
  97                                                         logs);
  98                                 }
  99                                 break;
 100                         }
 101                 }
 102                 g_slist_free(buddies);
 103
 104                 if (logs == NULL)
 105                         logs = purple_log_get_logs(PURPLE_LOG_IM, name, account);
 106                 else
 107                         logs = g_list_sort(logs, purple_log_compare);
 108         }
 109         else if (PURPLE_IS_CHAT_CONVERSATION(c))
 110         {
 111                 /* If we're not logging, don't show anything.
 112                  * Otherwise, we might show a very old log. */
 113                 if (!purple_prefs_get_bool("/purple/logging/log_chats"))
 114                         return;
 115
 116                 logs = purple_log_get_logs(PURPLE_LOG_CHAT, name, account);
 117         }
 118
 119         if (logs == NULL)
 120                 return;
 121
 122         history = purple_log_read((PurpleLog*)logs->data, &flags);
 123         gtkconv = PIDGIN_CONVERSATION(c);
 124 #if 0
 125         /* FIXME: WebView has no options */
 126         if (flags & PURPLE_LOG_READ_NO_NEWLINE)
 127                 options |= GTK_IMHTML_NO_NEWLINE;
 128 #endif
 129
 130 #if 0
 131         /* FIXME: WebView has no protocol setting */
 132         protocol = g_strdup(gtk_imhtml_get_protocol_name(GTK_IMHTML(gtkconv->imhtml)));
 133         gtk_imhtml_set_protocol_name(GTK_IMHTML(gtkconv->imhtml),
 134                         purple_account_get_protocol_name(((PurpleLog*)logs->data)->account));
 135 #endif
 136
 137 #if 0
 138         /* TODO WebKit: Do this properly... */
 139         if (!pidgin_webview_is_empty(PIDGIN_WEBVIEW(gtkconv->webview)))
 140                 pidgin_webview_append_html(PIDGIN_WEBVIEW(gtkconv->webview), "<BR>");
 141 #endif
 142
 143         escaped_alias = g_markup_escape_text(alias, -1);
 144
 145         dt = g_date_time_to_local(((PurpleLog *)logs->data)->time);
 146         header_date = g_date_time_format(dt, "%c");
 147         g_date_time_unref(dt);
 148
 149         header = g_strdup_printf(_("<b>Conversation with %s on %s:</b><br>"), escaped_alias, header_date);
 150         pidgin_webview_append_html(PIDGIN_WEBVIEW(gtkconv->webview), header);
 151         g_free(header_date);
 152         g_free(header);
 153         g_free(escaped_alias);
 154
 155         g_strchomp(history);
 156         pidgin_webview_append_html(PIDGIN_WEBVIEW(gtkconv->webview), history);
 157         g_free(history);
 158
 159         pidgin_webview_append_html(PIDGIN_WEBVIEW(gtkconv->webview), "<hr>");
 160
 161 #if 0
 162         /* FIXME: WebView has no protocol setting */
 163         gtk_imhtml_set_protocol_name(GTK_IMHTML(gtkconv->imhtml), protocol);
 164         g_free(protocol);
 165 #endif
 166
 167         g_object_ref(G_OBJECT(gtkconv->webview));
 168         g_idle_add(_scroll_webview_to_end, gtkconv->webview);
 169
 170         g_list_foreach(logs, (GFunc)purple_log_free, NULL);
 171         g_list_free(logs);
 172 }
 173
 174 static void
 175 history_prefs_check(PurplePlugin *plugin)
 176 {
 177         if (!purple_prefs_get_bool("/purple/logging/log_ims") &&
 178             !purple_prefs_get_bool("/purple/logging/log_chats"))
 179         {
 180                 /* Translators: Please maintain the use of ⇦ or ⇨ to represent the menu hierarchy */
 181                 purple_notify_warning(plugin, NULL, _("History Plugin Requires Logging"),
 182                                                         _("Logging can be enabled from Tools ⇨ Preferences ⇨ Logging.\n\n"
 183                                                           "Enabling logs for instant messages and/or chats will activate "
 184                                                           "history for the same conversation type(s)."), NULL);
 185         }
 186 }
 187
 188 static void history_prefs_cb(const char *name, PurplePrefType type,
 189                                                          gconstpointer val, gpointer data)
 190 {
 191         history_prefs_check((PurplePlugin *)data);
 192 }
 193
 194 static PidginPluginInfo *
 195 plugin_query(GError **error)
 196 {
 197         const gchar * const authors[] = {
 198                 "Sean Egan <seanegan@gmail.com>",
 199                 NULL
 200         };
 201
 202         return pidgin_plugin_info_new(
 203                 "id",           HISTORY_PLUGIN_ID,
 204                 "name",         N_("History"),
 205                 "version",      DISPLAY_VERSION,
 206                 "category",     N_("User interface"),
 207                 "summary",      N_("Shows recently logged conversations in new "
 208                                    "conversations."),
 209                 "description",  N_("When a new conversation is opened this plugin will "
 210                                    "insert the last conversation into the current "
 211                                    "conversation."),
 212                 "authors",      authors,
 213                 "website",      PURPLE_WEBSITE,
 214                 "abi-version",  PURPLE_ABI_VERSION,
 215                 NULL
 216         );
 217 }
 218
 219 static gboolean
 220 plugin_load(PurplePlugin *plugin, GError **error)
 221 {
 222         purple_signal_connect(purple_conversations_get_handle(),
 223                                                 "conversation-created",
 224                                                 plugin, PURPLE_CALLBACK(historize), NULL);
 225         /* XXX: Do we want to listen to pidgin's "conversation-displayed" signal? */
 226
 227         purple_prefs_connect_callback(plugin, "/purple/logging/log_ims",
 228                                                                 history_prefs_cb, plugin);
 229         purple_prefs_connect_callback(plugin, "/purple/logging/log_chats",
 230                                                                 history_prefs_cb, plugin);
 231
 232         history_prefs_check(plugin);
 233
 234         return TRUE;
 235 }
 236
 237 static gboolean
 238 plugin_unload(PurplePlugin *plugin, GError **error)
 239 {
 240         return TRUE;
 241 }
 242
 243 PURPLE_PLUGIN_INIT(history, plugin_query, plugin_load, plugin_unload);