Changeset 13a3c1db

Timestamp:

May 30, 2007, 12:05:27 AM (17 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, barnowl_perlaim, debian, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9

Children:

4508e21

Parents:

1fd5e4c1

git-author:

Nelson Elhage <nelhage@mit.edu> (05/30/07 00:05:16)

git-committer:

Nelson Elhage <nelhage@mit.edu> (05/30/07 00:05:27)

Message:

Refactoring message processing: All new messages, incoming or
outgoing, get added to the owl_global_messagequeue by protocol code,
and then passed to owl_proces_message, which serves as a single
central code path for adding messages to the message list.

Files:

• functions.c (modified) (6 diffs)
• global.c (modified) (1 diff)
• owl.c (modified) (4 diffs)
• perl/modules/Jabber/lib/BarnOwl/Module/Jabber.pm (modified) (1 diff)
• perlglue.xs (modified) (1 diff)
• zephyr.c (modified) (2 diffs)

functions.c

@@ -164 +164 @@
 }
 
-
-/* Add the given message to Owl's internal queue.  If displayoutgoing
- * is disabled, the message is NOT added to any internal queue, -1 is
- * returned and THE CALLER IS EXPECTED TO FREE THE GIVEN MESSAGE.
- * Otherwise 0 is returned and the caller need do nothing more
- */
-int owl_function_add_message(owl_message *m)
-{
-  /* if displayoutgoing is disabled, nuke the message and move on */
-  if (! owl_global_is_displayoutgoing(&g)) {
-    return(-1);
-  }
-
-  /* add it to the global list and current view */
-  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
-  owl_view_consider_message(owl_global_get_current_view(&g), m);
-
-  /* do followlast if necessary */
-  if (owl_global_should_followlast(&g)) owl_function_lastmsg_noredisplay();
-
-  /* redisplay etc. */
-  owl_mainwin_redisplay(owl_global_get_mainwin(&g));
-  if (owl_popwin_is_active(owl_global_get_popwin(&g))) {
-    owl_popwin_refresh(owl_global_get_popwin(&g));
-  }
-  wnoutrefresh(owl_global_get_curs_recwin(&g));
-  owl_global_set_needrefresh(&g);
-  return(0);
-}
-
 /* Create an admin message, append it to the global list of messages
  * and redisplay if necessary.
@@ -413 +383 @@
 
     if (m) {
-      /* log it */
-      owl_log_message(m);
-      
-      /* add it or nuke it */
-      if (owl_global_is_displayoutgoing(&g)) {
-        owl_function_add_message(m);
-      } else {
-        owl_message_free(m);
-      }
+      owl_global_messagequeue_addmsg(&g, m);
     } else {
       owl_function_error("Could not create outgoing zephyr message");
@@ -477 +439 @@
     m=owl_function_make_outgoing_zephyr(mymsg, line, owl_zwrite_get_zsig(&z));
     if (m) {
-      /* log it */
-      owl_log_message(m);
-      
-      /* add it or nuke it */
-      if (owl_global_is_displayoutgoing(&g)) {
-        owl_function_add_message(m);
-      } else {
-        owl_message_free(m);
-      }
+      owl_global_messagequeue_addmsg(&g, m);
     } else {
       owl_function_error("Could not create outgoing zephyr message");
@@ -525 +479 @@
 
   if (m) {
-    /* log it */
-    owl_log_message(m);
-    
-    /* display it or nuke it */
-    if (owl_global_is_displayoutgoing(&g)) {
-      owl_function_add_message(m);
-    } else {
-      owl_message_free(m);
-    }
+    owl_global_messagequeue_addmsg(&g, m);
   } else {
     owl_function_error("Could not create outgoing AIM message");
@@ -562 +508 @@
   m=owl_function_make_outgoing_aim(msg, to);
   if (m) {
-    /* log it */
-    owl_log_message(m);
-
-    /* display it or nuke it */
-    if (owl_global_is_displayoutgoing(&g)) {
-      owl_function_add_message(m);
-    } else {
-      owl_message_free(m);
-    }
+    owl_global_messagequeue_addmsg(&g, m);
   } else {
     owl_function_error("Could not create AIM message");
@@ -588 +526 @@
    * an incoming message */
   min=owl_malloc(sizeof(owl_message));
+  mout=owl_function_make_outgoing_loopback(msg);
+
+  if (owl_global_is_displayoutgoing(&g)) {
+    owl_global_messagequeue_addmsg(&g, mout);
+  } else {
+    owl_message_free(mout);
+  }
+
   owl_message_create_loopback(min, msg);
   owl_message_set_direction_in(min);
   owl_global_messagequeue_addmsg(&g, min);
-
-  mout=owl_function_make_outgoing_loopback(msg);
-  owl_log_message(mout);
-  if (owl_global_is_displayoutgoing(&g)) {
-    owl_function_add_message(mout);
-  } else {
-    owl_message_free(mout);
-  }
 
   /* fake a makemsg */

global.c

@@ -779 +779 @@
  * necessary.
  */
-owl_message *owl_global_messageuque_popmsg(owl_global *g)
+owl_message *owl_global_messagequeue_popmsg(owl_global *g)
 {
   owl_message *out;

owl.c

@@ -70 +70 @@
   owl_popwin *pw;
   int j, ret, initialsubs, debug, argcsave, followlast;
-  int newmsgs, zpendcount, nexttimediff;
+  int newmsgs, nexttimediff;
   struct sigaction sigact;
   char *configfile, *tty, *perlout, *perlerr, **argvsave, buff[LINE], startupmsg[LINE];
@@ -79 +79 @@
   char *dir;
   struct termios tio;
-#ifdef HAVE_LIBZEPHYR
-  ZNotice_t notice;
-#endif
+  owl_message *m;
 #if OWL_STDERR_REDIR
   int newstderr;
@@ -453 +451 @@
     }
 
+    owl_zephyr_process_events();
+    
     /* Grab incoming messages. */
     newmsgs=0;
-    zpendcount=0;
-    while(owl_zephyr_zpending() || owl_global_messagequeue_pending(&g)) {
-#ifdef HAVE_LIBZEPHYR
-      struct sockaddr_in from;
-#endif
-      owl_message *m=NULL;
-      owl_filter *f;
-
-      /* grab the new message, stick it in 'm' */
-      if (owl_zephyr_zpending()) {
-#ifdef HAVE_LIBZEPHYR
-        /* grab a zephyr notice, but if we've done 20 without stopping,
-           take a break to process keystrokes etc. */
-        if (zpendcount>20) break;
-        ZReceiveNotice(&notice, &from);
-        zpendcount++;
-        
-        /* is this an ack from a zephyr we sent? */
-        if (owl_zephyr_notice_is_ack(&notice)) {
-          owl_zephyr_handle_ack(&notice);
-          continue;
-        }
-        
-        /* if it's a ping and we're not viewing pings then skip it */
-        if (!owl_global_is_rxping(&g) && !strcasecmp(notice.z_opcode, "ping")) {
-          continue;
-        }
-
-        /* create the new message */
-        m=owl_malloc(sizeof(owl_message));
-        owl_message_create_from_znotice(m, &notice);
-#endif
-      } else if (owl_global_messagequeue_pending(&g)) {
-        /* pick up the non-zephyr message in the message queue */
-        m=owl_global_messageuque_popmsg(&g);
-      } else {
-        /* Not supposed to happen, but we seem to get here on resizes */
-        owl_function_debugmsg("Bottomed out looking for zephyr");
-      }
-
-      /* If we didn't pick up a message for some reason, don't go on */
-      if (m==NULL) {
-        owl_function_debugmsg("m is null in main loop");
-        continue;
-      }
-      
-      /* if this message it on the puntlist, nuke it and continue */
-      if (owl_global_message_is_puntable(&g, m)) {
-        owl_message_free(m);
-        continue;
-      }
-
-      /*  login or logout that should be ignored? */
-      if (owl_global_is_ignorelogins(&g) && owl_message_is_loginout(m)) {
-        owl_message_free(m);
-        continue;
-      }
-
-      /* otherwise add it to the global list */
-      owl_messagelist_append_element(owl_global_get_msglist(&g), m);
-      newmsgs=1;
-
-      /* let the config know the new message has been received */
-      owl_perlconfig_getmsg(m, 0, NULL);
-
-      /* add it to any necessary views; right now there's only the current view */
-      owl_view_consider_message(owl_global_get_current_view(&g), m);
-
-      /* do we need to autoreply? */
-      if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
-        if (owl_message_is_type_zephyr(m)) {
-          owl_zephyr_zaway(m);
-        } else if (owl_message_is_type_aim(m)) {
-          if (owl_message_is_private(m)) {
-            owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
-          }
-        }
-      }
-
-      /* ring the bell if it's a personal */
-      if (!strcmp(owl_global_get_personalbell(&g), "on")) {
-          if (!owl_message_is_loginout(m) &&
-              !owl_message_is_mail(m) &&
-              owl_message_is_personal(m)) {
-            owl_function_beep();
-          }
-      } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
-        /* do nothing */
-      } else {
-        f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
-        if (f && owl_filter_message_match(f, m)) {
-          owl_function_beep();
-        }
-      }
-
-
-      /* if it matches the alert filter, do the alert action */
-      f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
-      if (f && owl_filter_message_match(f, m)) {
-        owl_function_command(owl_global_get_alert_action(&g));
-      }
-
-      /* if it's a zephyr login or logout, update the zbuddylist */
-      if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
-        if (owl_message_is_login(m)) {
-          owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
-        } else if (owl_message_is_logout(m)) {
-          owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
-        } else {
-          owl_function_error("Internal error: received login notice that is neither login nor logout");
-        }
-      }
-
-      /* check for burning ears message */
-      /* this is an unsupported feature */
-      if (owl_global_is_burningears(&g) && owl_message_is_burningears(m)) {
-        char *buff;
-        buff = owl_sprintf("@i(Burning ears message on class %s)", owl_message_get_class(m));
-        owl_function_adminmsg(buff, "");
-        owl_free(buff);
-        owl_function_beep();
-      }
-
-      /* log the message if we need to */
-      owl_log_message(m);
+    while(owl_global_messagequeue_pending(&g)) {
+
+      m = owl_global_messagequeue_popmsg(&g);
+
+      if(owl_process_message(m))
+        newmsgs = 1;
     }
 
@@ -694 +575 @@
 }
 
+/*
+ * Process a new message passed to us on the message queue from some
+ * protocol. This includes adding it to the message list, updating the
+ * view and scrolling if appropriate, logging it, and so on.
+ *
+ * Either a pointer is kept to the message internally, or it is freed
+ * if unneeded. The caller no longer ``owns'' the message's memory.
+ *
+ * Returns 1 if the message was added to the message list, and 0 if it
+ * was ignored due to user settings or otherwise.
+ */
+int owl_process_message(owl_message *m) {
+  owl_filter *f;
+  /* if this message it on the puntlist, nuke it and continue */
+  if (owl_global_message_is_puntable(&g, m)) {
+    owl_message_free(m);
+    return 0;
+  }
+
+  /*  login or logout that should be ignored? */
+  if (owl_global_is_ignorelogins(&g)
+      && owl_message_is_loginout(m)) {
+    owl_message_free(m);
+    return 0;
+  }
+
+  if (!owl_global_is_displayoutgoing(&g)
+      && owl_message_is_direction_out(m)) {
+    owl_message_free(m);
+    return 0;
+  }
+
+  /* add it to the global list */
+  owl_messagelist_append_element(owl_global_get_msglist(&g), m);
+  /* add it to any necessary views; right now there's only the current view */
+  owl_view_consider_message(owl_global_get_current_view(&g), m);
+
+  if(owl_message_is_direction_in(m)) {
+    /* let perl know about it*/
+    owl_perlconfig_getmsg(m, 0, NULL);
+
+    /* do we need to autoreply? */
+    if (owl_global_is_zaway(&g) && !owl_message_get_attribute_value(m, "isauto")) {
+      if (owl_message_is_type_zephyr(m)) {
+        owl_zephyr_zaway(m);
+      } else if (owl_message_is_type_aim(m)) {
+        if (owl_message_is_private(m)) {
+          owl_function_send_aimawymsg(owl_message_get_sender(m), owl_global_get_zaway_msg(&g));
+        }
+      }
+    }
+
+    /* ring the bell if it's a personal */
+    if (!strcmp(owl_global_get_personalbell(&g), "on")) {
+      if (!owl_message_is_loginout(m) &&
+          !owl_message_is_mail(m) &&
+          owl_message_is_personal(m)) {
+        owl_function_beep();
+      }
+    } else if (!strcmp(owl_global_get_personalbell(&g), "off")) {
+      /* do nothing */
+    } else {
+      f=owl_global_get_filter(&g, owl_global_get_personalbell(&g));
+      if (f && owl_filter_message_match(f, m)) {
+        owl_function_beep();
+      }
+    }
+
+    /* if it matches the alert filter, do the alert action */
+    f=owl_global_get_filter(&g, owl_global_get_alert_filter(&g));
+    if (f && owl_filter_message_match(f, m)) {
+      owl_function_command(owl_global_get_alert_action(&g));
+    }
+
+    /* if it's a zephyr login or logout, update the zbuddylist */
+    if (owl_message_is_type_zephyr(m) && owl_message_is_loginout(m)) {
+      if (owl_message_is_login(m)) {
+        owl_zbuddylist_adduser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
+      } else if (owl_message_is_logout(m)) {
+        owl_zbuddylist_deluser(owl_global_get_zephyr_buddylist(&g), owl_message_get_sender(m));
+      } else {
+        owl_function_error("Internal error: received login notice that is neither login nor logout");
+      }
+    }
+
+    /* check for burning ears message */
+    /* this is an unsupported feature */
+    if (owl_global_is_burningears(&g) && owl_message_is_burningears(m)) {
+      char *buff;
+      buff = owl_sprintf("@i(Burning ears message on class %s)", owl_message_get_class(m));
+      owl_function_adminmsg(buff, "");
+      owl_free(buff);
+      owl_function_beep();
+    }
+  }
+
+  /* log the message if we need to */
+  owl_log_message(m);
+
+  return 1;
+}
+
 void sig_handler(int sig, siginfo_t *si, void *data)
 {

perl/modules/Jabber/lib/BarnOwl/Module/Jabber.pm

@@ -860 +860 @@
     my $m = j2o( $j, { direction => 'out' } );
     if ( $vars{jwrite}{type} ne 'groupchat') {
-        BarnOwl::add_and_log_message($m);
+        BarnOwl::queue_message($m);
     }
 

perlglue.xs

@@ -129 +129 @@
         }
 
-void add_message(msg) 
-        SV *msg
-        PREINIT:
-                owl_message *m;
-        CODE:
-        {
-                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
-                        croak("Usage: BarnOwl::add_message($message)");
-                }
-
-                if (owl_global_is_displayoutgoing(&g)) {
-                        m = owl_perlconfig_hashref2message(msg);
-                        owl_function_add_message(m);
-                }
-        }
-
-void log_message(msg) 
-        SV *msg
-        PREINIT:
-                owl_message *m;
-        CODE:
-        {
-                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
-                        croak("Usage: BarnOwl::log_message($message)");
-                }
-
-                m = owl_perlconfig_hashref2message(msg);
-                owl_log_message(m);
-                owl_message_free(m);
-        }
-
-void add_and_log_message(msg) 
-        SV *msg
-        PREINIT:
-                owl_message *m;
-        CODE:
-        {
-                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
-                        croak("Usage: BarnOwl::add_and_log_message($message)");
-                }
-
-                m = owl_perlconfig_hashref2message(msg);
-                owl_log_message(m);
-                if (owl_global_is_displayoutgoing(&g)) {
-                        owl_function_add_message(m);
-                } else {
-                        owl_message_free(m);
-                }
-        }
-
 void admin_message(header, body) 
         char *header

zephyr.c

@@ -638 +638 @@
   /* display the message as an admin message in the receive window */
   mout=owl_function_make_outgoing_zephyr(owl_global_get_zaway_msg(&g), tmpbuff, "Automated reply:");
-  owl_function_add_message(mout);
+  owl_global_messagequeue_addmsg(&g, mout);
   owl_free(tmpbuff);
 #endif
@@ -1054 +1054 @@
 #endif
 }
+
+#ifdef HAVE_LIBZEPHYR
+void owl_zephyr_process_events() {
+  int zpendcount=0;
+  ZNotice_t notice;
+  struct sockaddr_in from;
+  owl_message *m=NULL;
+
+  while(owl_zephyr_zpending() && zpendcount < 20) {
+    if (owl_zephyr_zpending()) {
+      ZReceiveNotice(&notice, &from);
+      zpendcount++;
+
+      /* is this an ack from a zephyr we sent? */
+      if (owl_zephyr_notice_is_ack(&notice)) {
+        owl_zephyr_handle_ack(&notice);
+        continue;
+      }
+
+      /* if it's a ping and we're not viewing pings then skip it */
+      if (!owl_global_is_rxping(&g) && !strcasecmp(notice.z_opcode, "ping")) {
+        continue;
+      }
+
+      /* create the new message */
+      m=owl_malloc(sizeof(owl_message));
+      owl_message_create_from_znotice(m, &notice);
+
+      owl_global_messagequeue_addmsg(&g, m);
+    }
+  }
+}
+
+#else
+void owl_zephyr_process_events() {
+  
+}
+#endif