Boolean fields are just like other fields - if you use the field name
[obnox/wireshark/wip.git] / packet-pop.c
index 8b8af7836df56832d5ce5279ddfb441146334a91..bf07f700e2424203749a3114d20377cdfa75c451 100644 (file)
@@ -2,10 +2,10 @@
  * Routines for pop packet dissection
  * Copyright 1999, Richard Sharpe <rsharpe@ns.aus.com>
  *
- * $Id: packet-pop.c,v 1.3 1999/05/13 01:05:11 sharpe Exp $
+ * $Id: packet-pop.c,v 1.24 2001/01/22 08:03:45 guy Exp $
  *
  * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@unicom.net>
+ * By Gerald Combs <gerald@zing.org>
  * Copyright 1998 Gerald Combs
  *
  * Copied from packet-tftp.c
 #include <string.h>
 #include <glib.h>
 #include "packet.h"
-#include "etypes.h"
+#include "strutil.h"
 
-extern packet_info pi;
+static int proto_pop = -1;
+static int hf_pop_response = -1;
+static int hf_pop_request = -1;
 
-void
-dissect_pop(const u_char *pd, int offset, frame_data *fd, proto_tree *tree, int max_data)
-{
-        proto_tree      *pop_tree, *ti;
-       gchar          rr[50], rd[1500];
-       int i1 = (u_char *)strchr(pd + offset, ' ') - (pd + offset); /* Where is that space */
-       int i2;
+static gint ett_pop = -1;
 
-       memset(rr, '\0', sizeof(rr));
-       memset(rd, '\0', sizeof(rd));
-
-       if ((i1 > max_data) || (i1 <= 0)) {
-         
-         i1 = max_data;
-         strncpy(rr, pd + offset, MIN(max_data - 2, sizeof(rr) - 1));
+#define TCP_PORT_POP                   110
 
+static gboolean response_is_continuation(const u_char *data);
+       
+static void
+dissect_pop(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+        gboolean        is_request;
+        gboolean       is_continuation;
+        proto_tree      *pop_tree;
+       proto_item      *ti;
+       gint            offset = 0;
+       const u_char    *line;
+       gint            next_offset;
+       int             linelen;
+       int             tokenlen;
+       const u_char    *next_token;
+
+       if (check_col(pinfo->fd, COL_PROTOCOL))
+               col_set_str(pinfo->fd, COL_PROTOCOL, "POP");
+
+       /*
+        * Find the end of the first line.
+        *
+        * Note that "tvb_find_line_end()" will return a value that is
+        * not longer than what's in the buffer, so the "tvb_get_ptr()"
+        * call won't throw an exception.
+        */
+       linelen = tvb_find_line_end(tvb, offset, -1, &next_offset);
+       line = tvb_get_ptr(tvb, offset, linelen);
+
+       if (pinfo->match_port == pinfo->destport) {
+               is_request = TRUE;
+               is_continuation = FALSE;
+       } else {
+               is_request = FALSE;
+               is_continuation = response_is_continuation(line);
        }
-       else {
-
-         strncpy(rr, pd + offset, MIN(i1, sizeof(rr) - 1));
-         i2 = ((u_char *)strchr(pd + offset + i1 + 1, '\r') - (pd + offset)) - i1 - 1;
-         strncpy(rd, pd + offset + i1 + 1, MIN(i2, sizeof(rd) - 1));
-       }
-
-       if (check_col(fd, COL_PROTOCOL))
-               col_add_str(fd, COL_PROTOCOL, "POP");
-
-       if (check_col(fd, COL_INFO)) {
-
-         col_add_fstr(fd, COL_INFO, "%s: %s %s", (pi.match_port == pi.destport)? "Request" : "Response", rr, rd);
 
+       if (check_col(pinfo->fd, COL_INFO)) {
+               /*
+                * Put the first line from the buffer into the summary
+                * if it's a POP request or reply (but leave out the
+                * line terminator).
+                * Otherwise, just call it a continuation.
+                */
+               if (is_continuation)
+                       col_set_str(pinfo->fd, COL_INFO, "Continuation");
+               else
+                       col_add_fstr(pinfo->fd, COL_INFO, "%s: %s",
+                           is_request ? "Request" : "Response",
+                           format_text(line, linelen));
        }
 
        if (tree) {
-
-         ti = proto_tree_add_item(tree, offset, END_OF_FRAME,
-                               "Post Office Protocol");
-         pop_tree = proto_tree_new();
-         proto_item_add_subtree(ti, pop_tree, ETT_POP);
-
-         if (pi.match_port == pi.destport) { /* Request */
-
-           proto_tree_add_item(pop_tree, offset, i1, "Request: %s", rr);
-
-           proto_tree_add_item(pop_tree, offset + i1 + 1, END_OF_FRAME, "Request Arg: %s", rd);
-
-         }
-         else {
-
-           proto_tree_add_item(pop_tree, offset, i1, "Response: %s", rr);
-
-           proto_tree_add_item(pop_tree, offset + i1 + 1, END_OF_FRAME, "Response Arg: %s", rd);
-         }
-
+               ti = proto_tree_add_item(tree, proto_pop, tvb, offset,
+                   tvb_length_remaining(tvb, offset), FALSE);
+               pop_tree = proto_item_add_subtree(ti, ett_pop);
+
+               if (is_continuation) {
+                       /*
+                        * Put the whole packet into the tree as data.
+                        */
+                       dissect_data(tvb, 0, pinfo, pop_tree);
+                       return;
+               }
+
+               if (is_request) {
+                       proto_tree_add_boolean_hidden(pop_tree,
+                           hf_pop_request, tvb, 0, 0, TRUE);
+               } else {
+                       proto_tree_add_boolean_hidden(pop_tree,
+                           hf_pop_response, tvb, 0, 0, TRUE);
+               }
+
+               /*
+                * Extract the first token, and, if there is a first
+                * token, add it as the request or reply code.
+                */
+               tokenlen = get_token_len(line, line + linelen, &next_token);
+               if (tokenlen != 0) {
+                       if (is_request) {
+                               proto_tree_add_text(pop_tree, tvb, offset,
+                                   tokenlen, "Request: %s",
+                                   format_text(line, tokenlen));
+                       } else {
+                               proto_tree_add_text(pop_tree, tvb, offset,
+                                   tokenlen, "Response: %s",
+                                   format_text(line, tokenlen));
+                       }
+                       offset += next_token - line;
+                       linelen -= next_token - line;
+                       line = next_token;
+               }
+
+               /*
+                * Add the rest of the first line as request or
+                * reply data.
+                */
+               if (linelen != 0) {
+                       if (is_request) {
+                               proto_tree_add_text(pop_tree, tvb, offset,
+                                   linelen, "Request Arg: %s",
+                                   format_text(line, linelen));
+                       } else {
+                               proto_tree_add_text(pop_tree, tvb, offset,
+                                   linelen, "Response Arg: %s",
+                                   format_text(line, linelen));
+                       }
+               }
+               offset = next_offset;
+
+               /*
+                * Show the rest of the request or response as text,
+                * a line at a time.
+                */
+               while (tvb_offset_exists(tvb, offset)) {
+                       /*
+                        * Find the end of the line.
+                        */
+                       linelen = tvb_find_line_end(tvb, offset, -1,
+                           &next_offset);
+
+                       /*
+                        * Put this line.
+                        */
+                       proto_tree_add_text(pop_tree, tvb, offset,
+                           next_offset - offset, "%s",
+                           tvb_format_text(tvb, offset, next_offset - offset));
+                       offset = next_offset;
+               }
        }
 }
 
+static gboolean response_is_continuation(const u_char *data)
+{
+  if (strncmp(data, "+OK", strlen("+OK")) == 0)
+    return FALSE;
 
+  if (strncmp(data, "-ERR", strlen("-ERR")) == 0)
+    return FALSE;
 
+  return TRUE;
+}
 
+void
+proto_register_pop(void)
+{
 
+  static hf_register_info hf[] = {
+    { &hf_pop_response,
+      { "Response",           "pop.response",
+       FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+       "TRUE if POP response" }},
+
+    { &hf_pop_request,
+      { "Request",            "pop.request",
+       FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+       "TRUE if POP request" }}
+  };
+  static gint *ett[] = {
+    &ett_pop,
+  };
+
+  proto_pop = proto_register_protocol("Post Office Protocol", "POP", "pop");
+  proto_register_field_array(proto_pop, hf, array_length(hf));
+  proto_register_subtree_array(ett, array_length(ett));
+}
 
+void
+proto_reg_handoff_pop(void)
+{
+  dissector_add("tcp.port", TCP_PORT_POP, dissect_pop, proto_pop);
+}