yong-purple_ruby 0.4.1 → 0.5.3

data/README.txt

@@ -1,17 +1,26 @@
 == OVERVIEW
 
-purple_ruby is a ruby gem to write servers that send and recive IM messages. It uses libpurple (http://developer.pidgin.im/wiki/WhatIsLibpurple) and therforce supports all protocols that Pidgin/Adium supports (MSN/Gtalk/Yahoo/AIM/ICQ etc).
+purple_ruby is a ruby gem to write servers that send and recive IM messages. It uses libpurple ( http://developer.pidgin.im/wiki/WhatIsLibpurple ) and therforce supports all protocols that Pidgin/Adium supports (MSN/Gtalk/Yahoo/AIM/ICQ etc).
+
+For MSN, we recommend msn-pecan ( http://code.google.com/p/msn-pecan/ ), which is more more stable than official MSN plugin.
 
 Please check examples/purplegw_example.rb for details. Bascially you just tell it what to do when an IM was received, and there is an embedded tcp 'proxy' which allows you send IM messages.
 
-Why not "ruburple"? I have used ruburple (http://rubyforge.org/projects/ruburple), but found it blocks a lot. libpurple needs to run its own event loop which interferes with ruby's green thread model. Ruburple's author has done lots of hard work to workaround the problem (http://rubyforge.org/pipermail/ruburple-development/2007-June/000005.html), but it does not work well.
+Why not "ruburple"? I have used ruburple ( http://rubyforge.org/projects/ruburple ), but found it blocks a lot. libpurple needs to run its own event loop which interferes with ruby's green thread model. Ruburple's author has done lots of hard work to workaround the problem ( http://rubyforge.org/pipermail/ruburple-development/2007-June/000005.html ), but it does not work well.
 
 == INSTALLATION
 
-Linux (Ubuntu):
+Ubuntu:
 ---------------
-apt-get install libpurple0 libpurple-dev
-gem install yong-purple_ruby
+sudo apt-get install libpurple0 libpurple-dev
+gem sources -a http://gems.github.com (you only have to do this once)
+sudo gem install yong-purple_ruby
+
+Redhat/Centos
+---------------
+Follow instructions here: http://www.pidgin.im/download/centos_rhel/
+gem sources -a http://gems.github.com (you only have to do this once)
+sudo gem install yong-purple_ruby
 
 OSX:
 ----
@@ -20,9 +29,9 @@ sudo port install gnutls
 		(wait forever....)
 sudo port install nss
 		(wait forever....)
-wget http://downloads.sourceforge.net/pidgin/pidgin-2.5.5.tar.bz2
-tar xvjf pidgin-2.5.5.tar.bz2
-cd pidgin-2.5.5
+wget http://downloads.sourceforge.net/pidgin/pidgin-2.5.7.tar.bz2
+tar xvjf pidgin-2.5.7.tar.bz2
+cd pidgin-2.5.7
 ./configure --disable-gtkui --disable-screensaver --disable-consoleui --disable-sm --disable-perl --disable-tk --disable-tcl --disable-gstreamer --disable-schemas-install --disable-gestures --disable-cap --disable-gevolution --disable-gtkspell --disable-startup-notification --disable-avahi --disable-nm --disable-dbus --disable-meanwhile
 make
 		(wait forever...)
@@ -31,8 +40,13 @@ sudo make install
 edit your ~/.bash_profile and add this line
 export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig
 
+gem sources -a http://gems.github.com (you only have to do this once)
 sudo gem install yong-purple_ruby
 
+== Copyright
+
+purple_ruby is Copyright (c) 2009 Xue Yong Zhi and Intridea, Inc., released under the GPL License.
+
 
 
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'hoe'
 
 EXT = "ext/ruburple_ext.#{Hoe::DLEXT}"
 
-Hoe.new('purple_ruby', '0.4.1') do |p|
+Hoe.new('purple_ruby', '0.5.3') do |p|
   p.author = 'yong'
   p.email = 'yong@intridea.com'
   p.url = 'http://www.intridea.com'

data/examples/purplegw_example.rb

@@ -16,7 +16,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '../ext/purple_ruby')
 
 class PurpleGWExample
   SERVER_IP = "127.0.0.1"
-  SERVER_PORT = 9876
+  SERVER_PORT = 9877
 
   def start configs
     PurpleRuby.init false #use 'true' if you want to see the debug messages
@@ -25,15 +25,16 @@ class PurpleGWExample
     
     accounts = {}
     configs.each {|config|
+      puts "logging in #{config[:username]} (#{config[:protocol]})..."
       account = PurpleRuby.login(config[:protocol], config[:username], config[:password])
       accounts[config[:protocol]] = account
     }
     
     #handle incoming im messages
-    PurpleRuby.watch_incoming_im do |receiver, sender, message|
+    PurpleRuby.watch_incoming_im do |acc, sender, message|
       sender = sender[0...sender.index('/')] if sender.index('/') #discard anything after '/'
       text = (Hpricot(message)).to_plain_text
-      puts "recv: #{receiver}, #{sender}, #{text}"
+      puts "recv: #{acc.username}, #{sender}, #{text}"
     end
     
     PurpleRuby.watch_signed_on_event do |acc| 

data/ext/account.c

@@ -49,6 +49,8 @@ extern ID CALL;
 extern VALUE cAccount;
 extern VALUE new_buddy_handler;
 
+extern VALUE check_callback(VALUE, const char*);
+
 static char *
 make_info(PurpleAccount *account, PurpleConnection *gc, const char *remote_user,
           const char *id, const char *alias, const char *msg)
@@ -93,11 +95,12 @@ request_add(PurpleAccount *account, const char *remote_user,
 		  const char *message)
 {
 	if (new_buddy_handler != Qnil) {
-    VALUE *args = g_new(VALUE, 3);
+    VALUE args[3];
     args[0] = Data_Wrap_Struct(cAccount, NULL, NULL, account);
     args[1] = rb_str_new2(NULL == remote_user ? "" : remote_user);
     args[2] = rb_str_new2(NULL == message ? "" : message);
-    VALUE v = rb_funcall2((VALUE)new_buddy_handler, CALL, 3, args);
+    check_callback(new_buddy_handler, "new_buddy_handler");
+    VALUE v = rb_funcall2(new_buddy_handler, CALL, 3, args);
     
     if (v != Qnil && v != Qfalse) {
       PurpleConnection *gc = purple_account_get_connection(account);
@@ -107,8 +110,6 @@ request_add(PurpleAccount *account, const char *remote_user,
 									     NULL, alias);
 	    }
     }
-    
-    g_free(args);
   }
 }
 
@@ -123,7 +124,7 @@ static void *request_authorize(PurpleAccount *account,
                         void *user_data)
 {
   if (new_buddy_handler != Qnil) {
-    VALUE *args = g_new(VALUE, 3);
+    VALUE args[3];
     args[0] = Data_Wrap_Struct(cAccount, NULL, NULL, account);
     args[1] = rb_str_new2(NULL == remote_user ? "" : remote_user);
     args[2] = rb_str_new2(NULL == message ? "" : message);
@@ -135,8 +136,6 @@ static void *request_authorize(PurpleAccount *account,
     } else {
       deny_cb(user_data);
     }
-    
-    g_free(args);
   }
   
   return NULL;

data/ext/purple_ruby.c

@@ -123,16 +123,18 @@ static VALUE cPurpleRuby;
 VALUE cAccount;
 const char* UI_ID = "purplegw";
 static GMainLoop *main_loop = NULL;
+static GHashTable* data_hash_table = NULL;
+static GHashTable* fd_hash_table = NULL;
+ID CALL;
+extern PurpleAccountUiOps account_ops;
+
 static VALUE im_handler = Qnil;
 static VALUE signed_on_handler = Qnil;
 static VALUE connection_error_handler = Qnil;
 static VALUE notify_message_handler = Qnil;
 static VALUE request_handler = Qnil;
+static VALUE ipc_handler = Qnil;
 VALUE new_buddy_handler = Qnil;
-static GHashTable* data_hash_table = NULL;
-static GHashTable* fd_hash_table = NULL;
-ID CALL;
-extern PurpleAccountUiOps account_ops;
 
 extern void
 finch_connection_report_disconnect(PurpleConnection *gc, PurpleConnectionError reason,
@@ -140,42 +142,100 @@ finch_connection_report_disconnect(PurpleConnection *gc, PurpleConnectionError r
 		
 extern void finch_connections_init();
 
+VALUE inspect_rb_obj(VALUE obj)
+{
+  return rb_funcall(obj, rb_intern("inspect"), 0, 0);
+}
+
+void set_callback(VALUE* handler, const char* handler_name)
+{
+  if (!rb_block_given_p()) {
+    rb_raise(rb_eArgError, "%s: no block", handler_name);
+  }
+  
+  if (Qnil != *handler) {
+    rb_raise(rb_eArgError, "%s should only be assigned once", handler_name);
+  }
+  
+  *handler = rb_block_proc();
+  /*
+  * If you create a Ruby object from C and store it in a C global variable without 
+  * exporting it to Ruby, you must at least tell the garbage collector about it, 
+  * lest ye be reaped inadvertently:
+  */
+  rb_global_variable(handler);
+  
+  if (rb_obj_class(*handler) != rb_cProc) {
+    rb_raise(rb_eTypeError, "%s got unexpected value: %s", handler_name, 
+       RSTRING(inspect_rb_obj(*handler))->ptr);
+  }
+}
+
+void check_callback(VALUE handler, const char* handler_name){
+  if (rb_obj_class(handler) != rb_cProc) {
+    rb_raise(rb_eTypeError, "%s has unexpected value: %s",
+      handler_name,
+      RSTRING(inspect_rb_obj(handler))->ptr);
+  }
+}
+
 void report_disconnect(PurpleConnection *gc, PurpleConnectionError reason, const char *text)
 {
   if (Qnil != connection_error_handler) {
-    VALUE *args = g_new(VALUE, 3);
+    VALUE args[3];
     args[0] = Data_Wrap_Struct(cAccount, NULL, NULL, purple_connection_get_account(gc));
     args[1] = INT2FIX(reason);
     args[2] = rb_str_new2(text);
-    VALUE v = rb_funcall2((VALUE)connection_error_handler, CALL, 3, args);
+    check_callback(connection_error_handler, "connection_error_handler");
+    VALUE v = rb_funcall2(connection_error_handler, CALL, 3, args);
     
     if (v != Qnil && v != Qfalse) {
       finch_connection_report_disconnect(gc, reason, text);
     }
-    
-    g_free(args);
   }
 }
 
+static void* notify_message(PurpleNotifyMsgType type, 
+	const char *title,
+	const char *primary, 
+	const char *secondary)
+{
+  if (notify_message_handler != Qnil) {
+    VALUE args[4];
+    args[0] = INT2FIX(type);
+    args[1] = rb_str_new2(NULL == title ? "" : title);
+    args[2] = rb_str_new2(NULL == primary ? "" : primary);
+    args[3] = rb_str_new2(NULL == secondary ? "" : secondary);
+    check_callback(notify_message_handler, "notify_message_handler");
+    rb_funcall2(notify_message_handler, CALL, 4, args);
+  }
+  
+  return NULL;
+}
+
 static void write_conv(PurpleConversation *conv, const char *who, const char *alias,
 			const char *message, PurpleMessageFlags flags, time_t mtime)
 {	
   if (im_handler != Qnil) {
     PurpleAccount* account = purple_conversation_get_account(conv);
     if (strcmp(purple_account_get_protocol_id(account), "prpl-msn") == 0 &&
-        strstr(message, "Message could not be sent") != NULL) {
+         (strstr(message, "Message could not be sent") != NULL ||
+          strstr(message, "Message was not sent") != NULL ||
+          strstr(message, "Message may have not been sent") != NULL
+         )
+        ) {
       /* I have seen error like 'msn: Connection error from Switchboard server'.
        * In that case, libpurple will notify user with two regular im message.
        * The first message is an error message, the second one is the original message that failed to send.
        */
-      report_disconnect(purple_account_get_connection(account), PURPLE_CONNECTION_ERROR_NETWORK_ERROR, message);
+      notify_message(PURPLE_CONNECTION_ERROR_NETWORK_ERROR, message, purple_account_get_protocol_id(account), who);
     } else {
-      VALUE *args = g_new(VALUE, 3);
-      args[0] = rb_str_new2(purple_account_get_username(account));
+      VALUE args[3];
+      args[0] = Data_Wrap_Struct(cAccount, NULL, NULL, account);
       args[1] = rb_str_new2(who);
       args[2] = rb_str_new2(message);
+      check_callback(im_handler, "im_handler");
       rb_funcall2(im_handler, CALL, 3, args);
-      g_free(args);
     }
   }
 }
@@ -218,24 +278,6 @@ static PurpleConnectionUiOps connection_ops =
 	NULL
 };
 
-static void* notify_message(PurpleNotifyMsgType type, 
-	const char *title,
-	const char *primary, 
-	const char *secondary)
-{
-  if (notify_message_handler != Qnil) {
-    VALUE *args = g_new(VALUE, 4);
-    args[0] = INT2FIX(type);
-    args[1] = rb_str_new2(NULL == title ? "" : title);
-    args[2] = rb_str_new2(NULL == primary ? "" : primary);
-    args[3] = rb_str_new2(NULL == secondary ? "" : secondary);
-    rb_funcall2(notify_message_handler, CALL, 4, args);
-    g_free(args);
-  }
-  
-  return NULL;
-}
-
 static void* request_action(const char *title, const char *primary, const char *secondary,
                             int default_action,
                             PurpleAccount *account, 
@@ -246,11 +288,12 @@ static void* request_action(const char *title, const char *primary, const char *
                             va_list actions)
 {
   if (request_handler != Qnil) {
-	  VALUE *args = g_new(VALUE, 4);
+	  VALUE args[4];
     args[0] = rb_str_new2(NULL == title ? "" : title);
     args[1] = rb_str_new2(NULL == primary ? "" : primary);
     args[2] = rb_str_new2(NULL == secondary ? "" : secondary);
     args[3] = rb_str_new2(NULL == who ? "" : who);
+    check_callback(request_handler, "request_handler");
     VALUE v = rb_funcall2(request_handler, CALL, 4, args);
 	  
 	  if (v != Qnil && v != Qfalse) {
@@ -258,8 +301,6 @@ static void* request_action(const char *title, const char *primary, const char *
 	    GCallback ok_cb = va_arg(actions, GCallback);
       ((PurpleRequestActionCb)ok_cb)(user_data, default_action);
     }
-    
-    g_free(args);
   }
   
   return NULL;
@@ -356,42 +397,42 @@ static VALUE init(VALUE self, VALUE debug)
 static VALUE watch_incoming_im(VALUE self)
 {
   purple_conversations_set_ui_ops(&conv_uiops);
-  im_handler = rb_block_proc();
+  set_callback(&im_handler, "im_handler");
   return im_handler;
 }
 
 static VALUE watch_notify_message(VALUE self)
 {
   purple_notify_set_ui_ops(&notify_ops);
-  notify_message_handler = rb_block_proc();
+  set_callback(&notify_message_handler, "notify_message_handler");
   return notify_message_handler;
 }
 
 static VALUE watch_request(VALUE self)
 {
   purple_request_set_ui_ops(&request_ops);
-  request_handler = rb_block_proc();
+  set_callback(&request_handler, "request_handler");
   return request_handler;
 }
 
 static VALUE watch_new_buddy(VALUE self)
 {
   purple_accounts_set_ui_ops(&account_ops);
-  new_buddy_handler = rb_block_proc();
+  set_callback(&new_buddy_handler, "new_buddy_handler");
   return new_buddy_handler;
 }
 
 static void signed_on(PurpleConnection* connection)
 {
-  VALUE *args = g_new(VALUE, 1);
+  VALUE args[1];
   args[0] = Data_Wrap_Struct(cAccount, NULL, NULL, purple_connection_get_account(connection));
-  rb_funcall2((VALUE)signed_on_handler, CALL, 1, args);
-  g_free(args);
+  check_callback(signed_on_handler, "signed_on_handler");
+  rb_funcall2(signed_on_handler, CALL, 1, args);
 }
 
 static VALUE watch_signed_on_event(VALUE self)
 {
-  signed_on_handler = rb_block_proc();
+  set_callback(&signed_on_handler, "signed_on_handler");
   int handle;
 	purple_signal_connect(purple_connections_get_handle(), "signed-on", &handle,
 				PURPLE_CALLBACK(signed_on), NULL);
@@ -403,14 +444,15 @@ static VALUE watch_connection_error(VALUE self)
   finch_connections_init();
   purple_connections_set_ui_ops(&connection_ops);
   
-  connection_error_handler = rb_block_proc();
+  set_callback(&connection_error_handler, "connection_error_handler");
+  
   /*int handle;
 	purple_signal_connect(purple_connections_get_handle(), "connection-error", &handle,
 				PURPLE_CALLBACK(connection_error), NULL);*/
   return connection_error_handler;
 }
 
-static void _read_socket_handler(gpointer data, int socket, PurpleInputCondition condition)
+static void _read_socket_handler(gpointer notused, int socket, PurpleInputCondition condition)
 {
   char message[4096] = {0};
   int i = recv(socket, message, sizeof(message) - 1, 0);
@@ -440,14 +482,14 @@ static void _read_socket_handler(gpointer data, int socket, PurpleInputCondition
     purple_input_remove((guint)purple_fd);
     close(socket);
     
-    VALUE *args = g_new(VALUE, 1);
+    VALUE args[1];
     args[0] = (VALUE)str;
-    rb_funcall2((VALUE)data, CALL, 1, args);
-    g_free(args);
+    check_callback(ipc_handler, "ipc_handler");
+    rb_funcall2(ipc_handler, CALL, 1, args);
   }
 }
 
-static void _accept_socket_handler(gpointer data, int server_socket, PurpleInputCondition condition)
+static void _accept_socket_handler(gpointer notused, int server_socket, PurpleInputCondition condition)
 {
   /* Check that it is a read condition */
 	if (condition != PURPLE_INPUT_READ)
@@ -469,7 +511,7 @@ static void _accept_socket_handler(gpointer data, int server_socket, PurpleInput
 
   purple_debug_info("purple_ruby", "new connection: %d\n", client_socket);
 	
-	guint purple_fd = purple_input_add(client_socket, PURPLE_INPUT_READ, _read_socket_handler, data);
+	guint purple_fd = purple_input_add(client_socket, PURPLE_INPUT_READ, _read_socket_handler, NULL);
 	
 	g_hash_table_insert(data_hash_table, (gpointer)client_socket, (gpointer)rb_str_new2(""));
 	g_hash_table_insert(fd_hash_table, (gpointer)client_socket, (gpointer)purple_fd);
@@ -504,10 +546,10 @@ static VALUE watch_incoming_ipc(VALUE self, VALUE serverip, VALUE port)
 		return Qnil;
 	}
 
-  VALUE proc = rb_block_proc();
+  set_callback(&ipc_handler, "ipc_handler");
   
 	/* Open a watcher in the socket we have just opened */
-	purple_input_add(soc, PURPLE_INPUT_READ, _accept_socket_handler, (gpointer)proc);
+	purple_input_add(soc, PURPLE_INPUT_READ, _accept_socket_handler, NULL);
 	
 	return port;
 }
@@ -530,6 +572,20 @@ static VALUE main_loop_run(VALUE self)
 {
   main_loop = g_main_loop_new(NULL, FALSE);
   g_main_loop_run(main_loop);
+  
+#ifdef DEBUG_MEM_LEAK
+  printf("QUIT!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n");
+  purple_core_quit();
+  if (im_handler == Qnil) rb_gc_unregister_address(&im_handler);
+  if (signed_on_handler == Qnil) rb_gc_unregister_address(&signed_on_handler);
+  if (connection_error_handler == Qnil) rb_gc_unregister_address(&connection_error_handler);
+  if (notify_message_handler == Qnil) rb_gc_unregister_address(&notify_message_handler);
+  if (request_handler == Qnil) rb_gc_unregister_address(&request_handler);
+  if (ipc_handler == Qnil) rb_gc_unregister_address(&ipc_handler);
+  if (new_buddy_handler == Qnil) rb_gc_unregister_address(&new_buddy_handler);
+  rb_gc_start();
+#endif
+  
   return Qnil;
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yong-purple_ruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.5.3
 platform: ruby
 authors: 
 - yong