gtk/drag_and_drop.c

   1 /* dnd.c
   2  * Drag and Drop
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #ifdef HAVE_SYS_TYPES_H
  30 #include <sys/types.h>
  31 #endif
  32 #include <string.h>
  33 #include <stdio.h>
  34
  35 #include <gtk/gtk.h>
  36
  37 #include <epan/prefs.h>
  38
  39 #include "../globals.h"
  40 #include "../util.h"
  41 #include "../file.h"
  42 #include "../simple_dialog.h"
  43 #ifdef HAVE_LIBPCAP
  44 #include "../capture.h"
  45 #endif
  46
  47 #include "gtk/gtkglobals.h"
  48 #include "gtk/capture_file_dlg.h"
  49 #include "gtk/drag_and_drop.h"
  50 #include "gtk/main.h"
  51 #include "gtk/main_menu.h"
  52
  53
  54 enum { DND_TARGET_STRING, DND_TARGET_ROOTWIN, DND_TARGET_URL };
  55
  56 /* convert drag and drop URI to a local filename */
  57 static gchar *
  58 dnd_uri2filename(gchar *cf_name)
  59 {
  60     gchar     *src, *dest;
  61     gint      ret;
  62     guint     i;
  63     gchar     esc[3];
  64
  65
  66     /* Remove URI header.
  67      * we have to remove the prefix to get a valid filename. */
  68 #ifdef _WIN32
  69     /*
  70      * On win32 (at least WinXP), this prefix looks like (UNC):
  71      * file:////servername/sharename/dir1/dir2/capture-file.cap
  72      * or (local filename):
  73      * file:///d:/dir1/dir2/capture-file.cap
  74      */
  75     if (strncmp("file:////", cf_name, 9) == 0) {
  76         /* win32 UNC: now becoming: //servername/sharename/dir1/dir2/capture-file.cap */
  77         cf_name += 7;
  78     } else if (strncmp("file:///", cf_name, 8) == 0) {
  79         /* win32 local: now becoming: d:/dir1/dir2/capture-file.cap */
  80         cf_name += 8;
  81     }
  82 #else
  83     /*
  84      * On UNIX (at least KDE 3.0 Konqueror), this prefix looks like:
  85      * file:/dir1/dir2/capture-file.cap
  86      *
  87      * On UNIX (at least GNOME Nautilus 2.8.2), this prefix looks like:
  88      * file:///dir1/dir2/capture-file.cap
  89      */
  90     if (strncmp("file:", cf_name, 5) == 0) {
  91         /* now becoming: /dir1/dir2/capture-file.cap or ///dir1/dir2/capture-file.cap */
  92         cf_name += 5;
  93         /* shorten //////thing to /thing */
  94         for(; cf_name[1] == '/'; ++cf_name);
  95     }
  96 #endif
  97
  98     /*
  99      * unescape the escaped URI characters (spaces, ...)
 100      *
 101      * we have to replace escaped chars to their equivalents,
 102      * e.g. %20 (always a two digit hexstring) -> ' '
 103      * the percent character '%' is escaped be a double one "%%"
 104      *
 105      * we do this conversation "in place" as the result is always
 106      * equal or smaller in size.
 107      */
 108     src = cf_name;
 109     dest = cf_name;
 110     while (*src) {
 111         if (*src == '%') {
 112             src++;
 113             if (*src == '%') {
 114                 /* this is an escaped '%' char (was: "%%") */
 115                 *dest = *src;
 116                 src++;
 117                 dest++;
 118             } else {
 119                 /* convert escaped hexnumber to unscaped character */
 120                 esc[0] = src[0];
 121                 esc[1] = src[1];
 122                 esc[2] = '\0';
 123                 ret = sscanf(esc, "%x", &i);
 124                 if (ret == 1) {
 125                     src+=2;
 126                     *dest = (gchar) i;
 127                     dest++;
 128                 } else {
 129                     /* somethings wrong, just jump over that char
 130                      * this will result in a wrong string, but we might get
 131                      * user feedback and can fix it later ;-) */
 132                     src++;
 133                 }
 134             }
 135         } else {
 136             *dest = *src;
 137             src++;
 138             dest++;
 139         }
 140     }
 141     *dest = '\0';
 142
 143     return cf_name;
 144 }
 145
 146 static void
 147 dnd_merge_files(int in_file_count, char **in_filenames)
 148 {
 149     char *tmpname;
 150     cf_status_t merge_status;
 151     int err;
 152
 153     /* merge the files in chonological order */
 154     tmpname = NULL;
 155     merge_status = cf_merge_files(&tmpname, in_file_count, in_filenames,
 156                               WTAP_FILE_PCAP, FALSE);
 157
 158     if (merge_status != CF_OK) {
 159         /* merge failed */
 160         g_free(tmpname);
 161         return;
 162     }
 163
 164     cf_close(&cfile);
 165
 166     /* Try to open the merged capture file. */
 167     if (cf_open(&cfile, tmpname, TRUE /* temporary file */, &err) != CF_OK) {
 168         /* We couldn't open it; don't dismiss the open dialog box,
 169            just leave it around so that the user can, after they
 170            dismiss the alert box popped up for the open error,
 171            try again. */
 172         g_free(tmpname);
 173         return;
 174     }
 175     g_free(tmpname);
 176
 177     switch (cf_read(&cfile)) {
 178
 179     case CF_READ_OK:
 180     case CF_READ_ERROR:
 181         /* Just because we got an error, that doesn't mean we were unable
 182            to read any of the file; we handle what we could get from the
 183            file. */
 184         break;
 185
 186     case CF_READ_ABORTED:
 187         /* The user bailed out of re-reading the capture file; the
 188            capture file has been closed - just free the capture file name
 189            string and return (without changing the last containing
 190            directory). */
 191         return;
 192     }
 193
 194     gtk_widget_grab_focus(packet_list);
 195 }
 196
 197 /* open/merge the dnd file */
 198 void
 199 dnd_open_file_cmd(gchar *cf_names_freeme)
 200 {
 201     int       err;
 202     gchar     *cf_name;
 203     int       in_files;
 204     gpointer  dialog;
 205     GString   *dialog_text;
 206     int       files_work;
 207     char      **in_filenames;
 208
 209
 210     /* DND_TARGET_URL on Win32:
 211      * The cf_name_freeme is a single string, containing one or more URI's,
 212      * seperated by CR/NL chars. The length of the whole field can be found
 213      * in the selection_data->length field. If it contains one file, simply open it,
 214      * If it contains more than one file, ask to merge these files. */
 215
 216     /* count the number of input files */
 217     cf_name = cf_names_freeme;
 218     for(in_files = 0; (cf_name = strstr(cf_name, "\r\n")) != NULL; ) {
 219         cf_name += 2;
 220         in_files++;
 221     }
 222
 223     in_filenames = g_malloc(sizeof(char*) * in_files);
 224
 225     /* store the starts of the file entries in a gchar array */
 226     cf_name = cf_names_freeme;
 227     in_filenames[0] = cf_name;
 228     for(files_work = 1; (cf_name = strstr(cf_name, "\r\n")) != NULL && files_work < in_files; ) {
 229         cf_name += 2;
 230         in_filenames[files_work] = cf_name;
 231         files_work++;
 232     }
 233
 234     /* replace trailing CR NL simply with zeroes (in place), so we get valid terminated strings */
 235     cf_name = cf_names_freeme;
 236     g_strdelimit(cf_name, "\r\n", '\0');
 237
 238     /* convert all filenames from URI to local filename (in place) */
 239     for(files_work = 0; files_work < in_files; files_work++) {
 240         in_filenames[files_work] = dnd_uri2filename(in_filenames[files_work]);
 241     }
 242
 243     switch(in_files) {
 244     case(0):
 245         /* shouldn't happen */
 246         break;
 247     case(1):
 248         /* open and read the capture file (this will close an existing file) */
 249         if (cf_open(&cfile, in_filenames[0], FALSE, &err) == CF_OK) {
 250           /* XXX - add this to the menu if the read fails? */
 251           cf_read(&cfile);
 252           add_menu_recent_capture_file(in_filenames[0]);
 253         } else {
 254           /* the capture file couldn't be read (doesn't exist, file format unknown, ...) */
 255         }
 256         break;
 257     default:
 258         /* build and show the info dialog */
 259         dialog_text = g_string_sized_new(200);
 260         g_string_printf(dialog_text,
 261             "%sMerging the following files:%s\n\n",
 262             simple_dialog_primary_start(), simple_dialog_primary_end());
 263         for(files_work = 0; files_work < in_files; files_work++) {
 264             g_string_append(dialog_text, in_filenames[files_work]);
 265             g_string_append(dialog_text, "\n");
 266         }
 267         g_string_append(dialog_text, "\nThe packets in these files will be merged chronologically into a new temporary file.");
 268         dialog = simple_dialog(ESD_TYPE_CONFIRMATION,
 269                     ESD_BTN_OK,
 270                     dialog_text->str);
 271         g_string_free(dialog_text, TRUE);
 272
 273         /* actually merge the files now */
 274         dnd_merge_files(in_files, in_filenames);
 275     }
 276
 277     g_free(in_filenames);
 278     g_free(cf_names_freeme);
 279 }
 280
 281 /* ask the user to save current unsaved file, before opening the dnd file */
 282 static void
 283 dnd_save_file_answered_cb(gpointer dialog _U_, gint btn, gpointer data)
 284 {
 285     switch(btn) {
 286     case(ESD_BTN_SAVE):
 287         /* save file first */
 288         file_save_as_cmd(after_save_open_dnd_file, data);
 289         break;
 290     case(ESD_BTN_DONT_SAVE):
 291         cf_close(&cfile);
 292         dnd_open_file_cmd(data);
 293         break;
 294     case(ESD_BTN_CANCEL):
 295         break;
 296     default:
 297         g_assert_not_reached();
 298     }
 299 }
 300
 301
 302 /* we have received some drag and drop data */
 303 /* (as we only registered to "text/uri-list", we will only get a file list here) */
 304 static void
 305 dnd_data_received(GtkWidget *widget _U_, GdkDragContext *dc _U_, gint x _U_, gint y _U_,
 306 GtkSelectionData *selection_data, guint info, guint t _U_, gpointer data _U_)
 307 {
 308     gpointer  dialog;
 309         gchar *cf_names_freeme;
 310
 311     if (info == DND_TARGET_URL) {
 312         /* Usually we block incoming events by disabling the corresponding menu/toolbar items.
 313          * This is the only place where an incoming event won't be blocked in such a way,
 314          * so we have to take care of NOT loading a new file while a different process
 315          * (e.g. capture/load/...) is still in progress. */
 316
 317 #ifdef HAVE_LIBPCAP
 318         /* if a capture is running, do nothing but warn the user */
 319         if((capture_opts->state != CAPTURE_STOPPED)) {
 320             dialog = simple_dialog(ESD_TYPE_CONFIRMATION,
 321                         ESD_BTN_OK,
 322                         "%sDrag and Drop currently not possible!%s\n\n"
 323                         "Dropping a file isn't possible while a capture is in progress.",
 324                         simple_dialog_primary_start(), simple_dialog_primary_end());
 325             return;
 326         }
 327 #endif
 328
 329         /* if another file read is still in progress, do nothing but warn the user */
 330         if((cfile.state == FILE_READ_IN_PROGRESS)) {
 331             dialog = simple_dialog(ESD_TYPE_CONFIRMATION,
 332                         ESD_BTN_OK,
 333                         "%sDrag and Drop currently not possible!%s\n\n"
 334                         "Dropping a file isn't possible while loading another capture file.",
 335                         simple_dialog_primary_start(), simple_dialog_primary_end());
 336             return;
 337         }
 338
 339                 /* the selection_data will soon be gone, make a copy first */
 340                 /* the data string is not zero terminated -> make a zero terminated "copy" of it */
 341                 cf_names_freeme = g_malloc(selection_data->length + 1);
 342                 memcpy(cf_names_freeme, selection_data->data, selection_data->length);
 343                 cf_names_freeme[selection_data->length] = '\0';
 344
 345         /* ask the user to save it's current capture file first */
 346         if((cfile.state != FILE_CLOSED) && !cfile.user_saved && prefs.gui_ask_unsaved) {
 347             /* user didn't saved his current file, ask him */
 348             dialog = simple_dialog(ESD_TYPE_CONFIRMATION,
 349                         ESD_BTNS_SAVE_DONTSAVE_CANCEL,
 350                         "%sSave capture file before opening a new one?%s\n\n"
 351                         "If you open a new capture file without saving, your current capture data will be discarded.",
 352                         simple_dialog_primary_start(), simple_dialog_primary_end());
 353             simple_dialog_set_cb(dialog, dnd_save_file_answered_cb, cf_names_freeme );
 354         } else {
 355             /* unchanged file */
 356             dnd_open_file_cmd( cf_names_freeme );
 357         }
 358     }
 359 }
 360
 361 /* init the drag and drop functionality */
 362 void
 363 dnd_init(GtkWidget *w)
 364 {
 365     /* we are only interested in the URI list containing filenames */
 366     static GtkTargetEntry target_entry[] = {
 367          /*{"STRING", 0, DND_TARGET_STRING},*/
 368          /*{"text/plain", 0, DND_TARGET_STRING},*/
 369          {"text/uri-list", 0, DND_TARGET_URL}
 370     };
 371
 372     /* set this window as a dnd destination */
 373     gtk_drag_dest_set(
 374          w, GTK_DEST_DEFAULT_ALL, target_entry,
 375          sizeof(target_entry) / sizeof(GtkTargetEntry),
 376          (GdkDragAction)(GDK_ACTION_MOVE | GDK_ACTION_COPY) );
 377
 378     /* get notified, if some dnd coming in */
 379     gtk_signal_connect(GTK_OBJECT(w), "drag_data_received",
 380         GTK_SIGNAL_FUNC(dnd_data_received), NULL);
 381 }
 382
 383