Merge lp:~cando/zeitgeist-datasources/fix_xchat into lp:zeitgeist-datasources/0.8

[Stefano Candori]

In this branch i've improved the XChat dataprovider.
With these mods when the user quits from XChat, the dps sends LEAVE_EVENTS to Zeitgeist, that's very important because i guess that everybody don't use the /part command(that is handled correctly by the dps)for quitting from the channels...

[lp:~cando/zeitgeist-datasources/fix_xchat]

111. By Stefano Candori on 2011-01-14

Xchat dps: change g_slist_append to g_slist_prepend

[Mikkel Kamstrup Erlandsen (kamstrup)]

There's something askew with how you use the channel_list GSList.

 1) You leak the string passed in to the g_slist_append() method. g_strdup() copies the string you pass to it and you need to free it again somehow. When that entry is removed from the list you need to g_free() the string somehow.

 2) You g_slist_remove() call will not match anything in your channel_list. It compares pointer values, not strings, for the lookup. Also - you call g_strdup(channel) which allocates new memory, which doesn't get freed. You need a matching g_free() on the return value of that call somewhere.

 3) The 'text' variable you build with g_strconcat() also needs a g_free() before you return. Otherwise you'll leak it.

 4) in on_quit() don't g_strdup() the data arg. Just cast it to a 'const gchar*'. In this case you also shouldn't g_free() it

 5) in on_quit() you leak the url and text strings. They need a g_free() as you do with 'channel' (unless you do as advised in 4)).

review: Needs Fixing

[Mikkel Kamstrup Erlandsen (kamstrup)]

There's something askew with how you use the channel_list GSList.

 1) You leak the string passed in to the g_slist_append() method. g_strdup() copies the string you pass to it and you need to free it again somehow. When that entry is removed from the list you need to g_free() the string somehow.

 2) You g_slist_remove() call will not match anything in your channel_list. It compares pointer values, not strings, for the lookup. Also - you call g_strdup(channel) which allocates new memory, which doesn't get freed. You need a matching g_free() on the return value of that call somewhere.

 3) The 'text' variable you build with g_strconcat() also needs a g_free() before you return. Otherwise you'll leak it.

 4) in on_quit() don't g_strdup() the data arg. Just cast it to a 'const gchar*'. In this case you also shouldn't g_free() it

 5) in on_quit() you leak the url and text strings. They need a g_free() as you do with 'channel' (unless you do as advised in 4)).

review: Needs Fixing

[lp:~cando/zeitgeist-datasources/fix_xchat]

112. By Stefano Candori on 2011-01-17

Fixed memory leaks

113. By Stefano Candori on 2011-01-17

Removed unuseful variable

[Stefano Candori (cando)]

OK, i should have fixed all these leaks...:)

[Mikkel Kamstrup Erlandsen (kamstrup)]

Just a nitpick :-) Can you change this line:

  channel_list = g_slist_remove(channel_list, tmp->data);

to:

  channel_list = g_slist_delete_link(channel_list, tmp);

The way you do it now you do first a linear search for the data (the while(tmp) loop) and then another linear search to remove it with g_slist_remove(). Since you already have the link you wanna remove, you should use the O(1) function g_slist_delete_link() instead. But this is a nitpick ofcourse since the channels list isn't ever gonna be that big so it matters - but style is style right? :-)

In any case - approved. Nice work Stefano!

review: Approve

[lp:~cando/zeitgeist-datasources/fix_xchat]

114. By Stefano Candori on 2011-01-18

Changing g_slist_remove to g_slist_delete_link

=== added file 'xchat/README'
--- xchat/README	1970-01-01 00:00:00 +0000
+++ xchat/README	2011-01-18 09:25:42 +0000
@@ -0,0 +1,13 @@
+Zeitgeist plugin to the XChat irc client
+****************************************
+
+To use this plugin:
+
+* Install Zeitgeist 0.3 (or greater)
+* Type "make" and "sudo make install" for a system-wide installation; "make" and "make local-install"
+  for a local installation
+  
+*************************************************************************************************************
+  N.B. Please don't install both system-wide and locally! XChat will load both plugins, getting double events
+  on your Zeitgeist.
+*************************************************************************************************************

=== modified file 'xchat/zeitgeist-dataprovider.c'
--- xchat/zeitgeist-dataprovider.c	2011-01-11 00:19:41 +0000
+++ xchat/zeitgeist-dataprovider.c	2011-01-18 09:25:42 +0000
@@ -22,17 +22,16 @@
 #include "xchat-plugin.h"
 #include <zeitgeist.h>
 
-
 #define PNAME "Zeitgeist"
 #define PDESC "Inform Zeitgeist about your activity"
 #define PVERSION "0.1"
 
-static xchat_plugin    *ph       = NULL;   /* plugin handle */
-static ZeitgeistLog    *zg_log   = NULL;   /* Zeitgeist-daemon hanlde*/
+static xchat_plugin    *ph           = NULL;   /* plugin handle */
+static ZeitgeistLog    *zg_log       = NULL;   /* Zeitgeist-daemon hanlde*/
+static GSList          *channel_list = NULL;   /* List of joined channels */
 
 static void send_event_to_zeitgeist(char *url_, char* text_, const char* ev_interpretation)
 {
-  /* type is 0 for PART event, 1 for JOIN event */
   const char *url, *origin, *mimetype, *text;
   const char *interpretation = NULL;
   const char *manifestation = NULL;
@@ -40,7 +39,7 @@
   
   url = url_;
   origin = url;
-  mimetype = "text/plain"; //?
+  mimetype = "text/plain";
   text = text_;
   interpretation = ZEITGEIST_NMO_IMMESSAGE;
   manifestation = ZEITGEIST_NFO_SOFTWARE_SERVICE;
@@ -66,7 +65,7 @@
            text,
            ev_interpretation);*/
            
-  zeitgeist_log_insert_events_no_reply (zg_log, event, NULL);  
+  zeitgeist_log_insert_events_no_reply (zg_log, event, NULL);
 }
 
 static int join_cb(char *word[], void *userdata)
@@ -75,11 +74,16 @@
    const char *channel = word[2];
    char *url, *text;
    
+   channel_list = g_slist_prepend(channel_list, g_strdup(channel));
+   
    url = g_strconcat("irc://", server, "/", channel, NULL);
    text = g_strconcat("You joined ", channel, NULL);
    
    send_event_to_zeitgeist(url, text, ZEITGEIST_ZG_ACCESS_EVENT);
    
+   g_free(url);
+   g_free(text);
+   
    return XCHAT_EAT_NONE;
 }
 
@@ -88,11 +92,26 @@
    const char *server = xchat_get_info(ph, "host");
    const char *channel = word[3];
    char *url, *text;
-   
+   GSList *tmp = channel_list;
+  
    url = g_strconcat("irc://", server, "/", channel, NULL);  
    text = g_strconcat("You parted from ", channel, NULL);
    
    send_event_to_zeitgeist(url, text, ZEITGEIST_ZG_LEAVE_EVENT);
+   
+   while(tmp)
+   {
+      if (g_strcmp0 (tmp->data, channel) == 0)
+      {
+         g_free(tmp->data);
+         channel_list = g_slist_delete_link(channel_list, tmp);
+         break;
+      }     
+      tmp = tmp->next;
+   }
+   
+   g_free(url);
+   g_free(text);
 
    return XCHAT_EAT_NONE;
 }
@@ -104,10 +123,13 @@
    char *url, *text;
    
    url = g_strconcat("irc://", server, "/", channel, NULL);  
-   text = g_strconcat(channel, ": you sent a message: ", word[2], NULL);
+   text = g_strconcat(channel, ": you sent \"", word[2],"\".", NULL);
    
    send_event_to_zeitgeist(url, text, ZEITGEIST_ZG_SEND_EVENT);
 
+   g_free(url);
+   g_free(text);
+   
    return XCHAT_EAT_NONE;
 }
 
@@ -118,13 +140,31 @@
    char *url, *text;
    
    url = g_strconcat("irc://", server, "/", channel, NULL);  
-   text = g_strconcat(channel, ": you received a message from ", word[1],": ", word[2], NULL);
+   text = g_strconcat(channel, ": you received \"", word[2],"\" from ", word[1], NULL);
    
    send_event_to_zeitgeist(url, text, ZEITGEIST_ZG_RECEIVE_EVENT);
-
+   
+   g_free(url);
+   g_free(text);
+   
    return XCHAT_EAT_NONE;
 }
 
+static void on_quit(gpointer data, gpointer userdata)
+{
+   const char *server = xchat_get_info(ph, "host");
+   const char *channel = (const char*) data;
+   char *url, *text;   
+   
+   url = g_strconcat("irc://", server, "/", channel, NULL);  
+   text = g_strconcat("You parted from ", channel, NULL);
+   
+   send_event_to_zeitgeist(url, text, ZEITGEIST_ZG_LEAVE_EVENT);
+   
+   g_free(url);
+   g_free(text);
+}
+
 void xchat_plugin_get_info(char **name, char **desc, char **version, void **reserved)
 {
    *name = PNAME;
@@ -132,6 +172,9 @@
    *version = PVERSION;
 }
 
+static int initialized = 0;
+static int reinit_tried = 0;
+
 int xchat_plugin_init(xchat_plugin *plugin_handle,
                       char **plugin_name,
                       char **plugin_desc,
@@ -139,6 +182,16 @@
                       char *arg)
 {
    ph = plugin_handle;
+   
+   /* Block double initalization. */
+   if (initialized != 0) {
+      xchat_print(ph, "Zeitgeist plugin already loaded");
+      /* deinit is called even when init fails, so keep track
+       * of a reinit failure. */
+      reinit_tried++;
+      return 0;
+   }
+   initialized = 1;
 
    *plugin_name = PNAME;
    *plugin_desc = PDESC;
@@ -155,3 +208,21 @@
 
    return 1;   
 }
+
+int xchat_plugin_deinit()
+{
+   /* A reinitialization was tried. Just give up */
+   if (reinit_tried) {
+      reinit_tried--;
+      return 1;
+   }
+   
+   g_slist_foreach(channel_list, on_quit, NULL);
+   g_slist_foreach(channel_list, (GFunc)g_free, NULL);
+   g_slist_free(channel_list);
+   channel_list = NULL;
+   
+   g_object_unref(zg_log);
+   zg_log = NULL;
+   return 1;
+}