Add some programs to 'see also'
[obnox/wireshark/wip.git] / capture.c
index f9f6788af8864a0220b12f51816daa31139c0e7e..f412e6c866a6478ea709995529c8ae95d2c0a488 100644 (file)
--- a/capture.c
+++ b/capture.c
@@ -3,8 +3,8 @@
  *
  * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
  * This program is free software; you can redistribute it and/or
 
 #ifdef HAVE_LIBPCAP
 
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 #include <fcntl.h>
 #endif
 
-#ifdef HAVE_IO_H
-# include <io.h>
-#endif
-
 #include <signal.h>
 #include <errno.h>
 
-#include <pcap.h>
-
 #include <glib.h>
 
 #include <epan/packet.h>
 #include "file.h"
 #include "capture.h"
 #include "capture_sync.h"
+#include "capture_info.h"
 #include "capture_ui_utils.h"
 #include "util.h"
-#include "pcap-util.h"
+#include "capture-pcap-util.h"
 #include "alert_box.h"
 #include "simple_dialog.h"
 #include <epan/prefs.h>
@@ -65,6 +64,8 @@
 #include "capture-wpcap.h"
 #endif
 #include "ui_util.h"
+#include "file_util.h"
+#include "log.h"
 
 
 
@@ -82,13 +83,31 @@ capture_start(capture_options *capture_opts)
   /* close the currently loaded capture file */
   cf_close(capture_opts->cf);
 
+  g_assert(capture_opts->state == CAPTURE_STOPPED);
+  capture_opts->state = CAPTURE_PREPARING;
+
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Start ...");
+
   /* try to start the capture child process */
-  ret = sync_pipe_start(capture_opts, capture_opts->save_file == NULL);
+  ret = sync_pipe_start(capture_opts);
   if(!ret) {
       if(capture_opts->save_file != NULL) {
           g_free(capture_opts->save_file);
           capture_opts->save_file = NULL;
       }
+
+      g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Start failed!");
+      capture_opts->state = CAPTURE_STOPPED;
+  } else {
+      /* the capture child might not respond shortly after bringing it up */
+      /* (especially it will block, if no input coming from an input capture pipe (e.g. mkfifo) is coming in) */
+
+      /* to prevent problems, bring the main GUI into "capture mode" right after successfully */
+      /* spawn/exec the capture child, without waiting for any response from it */
+      cf_callback_invoke(cf_cb_live_capture_prepared, capture_opts);
+
+      if(capture_opts->show_info)
+        capture_info_open(capture_opts->iface);
   }
 
   return ret;
@@ -98,6 +117,10 @@ capture_start(capture_options *capture_opts)
 void
 capture_stop(capture_options *capture_opts)
 {
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Stop ...");
+
+  cf_callback_invoke(cf_cb_live_capture_stopping, capture_opts);
+
   /* stop the capture child gracefully */
   sync_pipe_stop(capture_opts);
 }
@@ -106,6 +129,8 @@ capture_stop(capture_options *capture_opts)
 void
 capture_restart(capture_options *capture_opts)
 {
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Restart");
+
     capture_opts->restart = TRUE;
     capture_stop(capture_opts);
 }
@@ -114,6 +139,8 @@ capture_restart(capture_options *capture_opts)
 void
 capture_kill_child(capture_options *capture_opts)
 {
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "Capture Kill");
+
   /* kill the capture child */
   sync_pipe_kill(capture_opts);
 }
@@ -189,10 +216,22 @@ guint32 drops)
   }
 
   /* if we didn't captured even a single packet, close the file again */
-  if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
+  if(cf_get_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
     simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
-    "%sNo packets captured!%s\n\n"
-    "As no data was captured, closing the %scapture file!",
+"%sNo packets captured!%s\n"
+"\n"
+"As no data was captured, closing the %scapture file!\n"
+"\n"
+"\n"
+"Help about capturing can be found at:\n"
+"\n"
+"       http://wiki.wireshark.org/CaptureSetup"
+#ifdef _WIN32
+"\n\n"
+"Wireless (Wi-Fi/WLAN):\n"
+"Try to switch off promiscuous mode in the Capture Options!"
+#endif
+"",
     simple_dialog_primary_start(), simple_dialog_primary_end(),
     (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
     cf_close(capture_opts->cf);
@@ -201,7 +240,7 @@ guint32 drops)
 }
 
 
-/* capture child tells us, we have a new (or the first) capture file */
+/* capture child tells us we have a new (or the first) capture file */
 gboolean
 capture_input_new_file(capture_options *capture_opts, gchar *new_file)
 {
@@ -209,11 +248,17 @@ capture_input_new_file(capture_options *capture_opts, gchar *new_file)
   int  err;
 
 
-  /*g_warning("New capture file: %s", new_file);*/
+  if(capture_opts->state == CAPTURE_PREPARING) {
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture started!");
+  }
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "File: \"%s\"", new_file);
+
+  g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
 
   /* free the old filename */
   if(capture_opts->save_file != NULL) {
     /* we start a new capture file, close the old one (if we had one before) */
+    /* (we can only have an open capture file in real_time_mode!) */
     if( ((capture_file *) capture_opts->cf)->state != FILE_CLOSED) {
         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
         cf_finish_tail(capture_opts->cf, &err);
@@ -234,7 +279,7 @@ capture_input_new_file(capture_options *capture_opts, gchar *new_file)
   /* if we are in real-time mode, open the new file now */
   if(capture_opts->real_time_mode) {
     /* Attempt to open the capture file and set up to read from it. */
-       switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
+    switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
     case CF_OK:
       break;
     case CF_ERROR:
@@ -245,18 +290,25 @@ capture_input_new_file(capture_options *capture_opts, gchar *new_file)
       return FALSE;
       break;
     }
+  }
+
+  if(capture_opts->show_info) {
+    if (!capture_info_new_file(new_file))
+      return FALSE;
+  }
 
+  if(capture_opts->real_time_mode) {
     cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
   } else {
     cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
   }
-
+  capture_opts->state = CAPTURE_RUNNING;
 
   return TRUE;
 }
 
     
-/* capture child tells us, we have new packets to read */
+/* capture child tells us we have new packets to read */
 void
 capture_input_new_packets(capture_options *capture_opts, int to_read)
 {
@@ -266,9 +318,7 @@ capture_input_new_packets(capture_options *capture_opts, int to_read)
   g_assert(capture_opts->save_file);
 
   if(capture_opts->real_time_mode) {
-    /* Read from the capture file the number of records the child told us
-       it added.
-       XXX - do something if this fails? */
+    /* Read from the capture file the number of records the child told us it added. */
     switch (cf_continue_tail(capture_opts->cf, to_read, &err)) {
 
     case CF_READ_OK:
@@ -279,7 +329,6 @@ capture_input_new_packets(capture_options *capture_opts, int to_read)
 
          XXX - abort on a read error? */
          cf_callback_invoke(cf_cb_live_capture_update_continue, capture_opts->cf);
-         main_window_update();
       break;
 
     case CF_READ_ABORTED:
@@ -288,19 +337,132 @@ capture_input_new_packets(capture_options *capture_opts, int to_read)
       capture_kill_child(capture_opts);
       break;
     }
+  } else {
+    /* increase capture file packet counter by the number or incoming packets */
+    cf_set_packet_count(capture_opts->cf, 
+        cf_get_packet_count(capture_opts->cf) + to_read);
+
+    cf_callback_invoke(cf_cb_live_capture_fixed_continue, capture_opts->cf);
   }
+
+  /* update the main window, so we get events (e.g. from the stop toolbar button) */
+  main_window_update();
+
+  if(capture_opts->show_info)
+    capture_info_new_packets(to_read);
 }
 
 
-/* capture child closed it's side ot the pipe, do the required cleanup */
+/* Capture child told us how many dropped packets it counted.
+ */
+void
+capture_input_drops(capture_options *capture_opts, int dropped)
+{
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "%d packet%s dropped", dropped, plurality(dropped, "", "s"));
+
+  g_assert(capture_opts->state == CAPTURE_RUNNING);
+
+  cf_set_drops_known(capture_opts->cf, TRUE);
+  cf_set_drops(capture_opts->cf, dropped);
+}
+
+
+/* Capture child told us that an error has occurred while starting/running
+   the capture.
+   The buffer we're handed has *two* null-terminated strings in it - a
+   primary message and a secondary message, one right after the other.
+   The secondary message might be a null string.
+ */
+void
+capture_input_error_message(capture_options *capture_opts, char *error_msg, char *secondary_error_msg)
+{
+  gchar *safe_error_msg;
+  gchar *safe_secondary_error_msg;
+
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Error message from child: \"%s\", \"%s\"",
+        error_msg, secondary_error_msg);
+
+  g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
+
+  safe_error_msg = simple_dialog_format_message(error_msg);
+  if (*secondary_error_msg != '\0') {
+    /* We have both primary and secondary messages. */
+    safe_secondary_error_msg = simple_dialog_format_message(secondary_error_msg);
+    simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s%s%s\n\n%s",
+                  simple_dialog_primary_start(), safe_error_msg,
+                  simple_dialog_primary_end(), safe_secondary_error_msg);
+    g_free(safe_secondary_error_msg);
+  } else {
+    /* We have only a primary message. */
+    simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s%s%s",
+                  simple_dialog_primary_start(), safe_error_msg,
+                  simple_dialog_primary_end());
+  }
+  g_free(safe_error_msg);
+
+  /* the capture child will close the sync_pipe if required, nothing to do for now */
+}
+
+
+
+/* Capture child told us that an error has occurred while parsing a
+   capture filter when starting/running the capture.
+ */
+void
+capture_input_cfilter_error_message(capture_options *capture_opts, char *error_message)
+{
+  dfilter_t   *rfcode = NULL;
+  gchar *safe_cfilter = simple_dialog_format_message(capture_opts->cfilter);
+  gchar *safe_cfilter_error_msg = simple_dialog_format_message(error_message);
+
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture filter error message from child: \"%s\"", error_message);
+
+  g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
+
+  /* Did the user try a display filter? */
+  if (dfilter_compile(capture_opts->cfilter, &rfcode) && rfcode != NULL) {
+    simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
+      "%sInvalid capture filter: \"%s\"!%s\n"
+      "\n"
+      "That string looks like a valid display filter; however, it isn't a valid\n"
+      "capture filter (%s).\n"
+      "\n"
+      "Note that display filters and capture filters don't have the same syntax,\n"
+      "so you can't use most display filter expressions as capture filters.\n"
+      "\n"
+      "See the User's Guide for a description of the capture filter syntax.",
+      simple_dialog_primary_start(), safe_cfilter,
+      simple_dialog_primary_end(), safe_cfilter_error_msg);
+      dfilter_free(rfcode);
+  } else {
+    simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
+      "%sInvalid capture filter: \"%s\"!%s\n"
+      "\n"
+      "That string isn't a valid capture filter (%s).\n"
+      "See the User's Guide for a description of the capture filter syntax.",
+      simple_dialog_primary_start(), safe_cfilter,
+      simple_dialog_primary_end(), safe_cfilter_error_msg);
+  }
+  g_free(safe_cfilter_error_msg);
+  g_free(safe_cfilter);
+
+  /* the capture child will close the sync_pipe if required, nothing to do for now */
+}
+
+
+/* capture child closed its side of the pipe, do the required cleanup */
 void
 capture_input_closed(capture_options *capture_opts)
 {
     int  err;
 
 
-    /* if we have no file (happens if an error occured), do a fake start */
-    if(capture_opts->save_file == NULL) {
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture stopped!");
+    g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
+
+    /* if we didn't started the capture, do a fake start */
+    /* (happens if we got an error message - we won't get a filename then) */
+    if(capture_opts->state == CAPTURE_PREPARING) {
         if(capture_opts->real_time_mode) {
             cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
         } else {
@@ -309,18 +471,36 @@ capture_input_closed(capture_options *capture_opts)
     }
 
     if(capture_opts->real_time_mode) {
-        /* first of all, we are not doing a capture any more */
+               cf_read_status_t status;
+
+        /* Read what remains of the capture file. */
+        status = cf_finish_tail(capture_opts->cf, &err);
+
+        /* Tell the GUI, we are not doing a capture any more.
+                  Must be done after the cf_finish_tail(), so file lengths are displayed 
+                  correct. */
         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
 
-        /* Read what remains of the capture file, and finish the capture.
-           XXX - do something if this fails? */
-        switch (cf_finish_tail(capture_opts->cf, &err)) {
+        /* Finish the capture. */
+        switch (status) {
 
         case CF_READ_OK:
-            if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
-              simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
-              "%sNo packets captured!%s\n\n"
-              "As no data was captured, closing the %scapture file!",
+            if(cf_get_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
+                simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
+"%sNo packets captured!%s\n"
+"\n"
+"As no data was captured, closing the %scapture file!\n"
+"\n"
+"\n"
+"Help about capturing can be found at:\n"
+"\n"
+"       http://wiki.wireshark.org/CaptureSetup"
+#ifdef _WIN32
+"\n\n"
+"Wireless (Wi-Fi/WLAN):\n"
+"Try to switch off promiscuous mode in the Capture Options!"
+#endif
+"",
               simple_dialog_primary_start(), simple_dialog_primary_end(),
               cf_is_tempfile(capture_opts->cf) ? "temporary " : "");
               cf_close(capture_opts->cf);
@@ -349,6 +529,11 @@ capture_input_closed(capture_options *capture_opts)
         }
     }
 
+    if(capture_opts->show_info)
+      capture_info_close();
+
+    capture_opts->state = CAPTURE_STOPPED;
+
     /* if we couldn't open a capture file, there's nothing more for us to do */
     if(capture_opts->save_file == NULL) {
         cf_close(capture_opts->cf);
@@ -359,7 +544,7 @@ capture_input_closed(capture_options *capture_opts)
     if(capture_opts->restart) {
         capture_opts->restart = FALSE;
 
-        unlink(capture_opts->save_file);
+        eth_unlink(capture_opts->save_file);
 
         /* if it was a tempfile, throw away the old filename (so it will become a tempfile again) */
         if(cf_is_tempfile(capture_opts->cf)) {