epan/filesystem.c

   1 /* filesystem.c
   2  * Filesystem utility routines
   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 /*
  30  * Required with GNU libc to get dladdr().
  31  * We define it here because <dlfcn.h> apparently gets included by
  32  * one of the headers we include below.
  33  */
  34 #define _GNU_SOURCE
  35
  36 #ifdef HAVE_DIRENT_H
  37 #include <dirent.h>
  38 #endif
  39
  40 #include <stdio.h>
  41 #include <ctype.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <errno.h>
  45
  46 #include <glib.h>
  47
  48 #ifdef HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51
  52 #ifdef HAVE_FCNTL_H
  53 #include <fcntl.h>
  54 #endif
  55
  56 #ifdef HAVE_SYS_STAT_H
  57 #include <sys/stat.h>
  58 #endif
  59
  60 #ifdef _WIN32
  61 #include <windows.h>
  62 #include <tchar.h>
  63 #include <shlobj.h>
  64 #include <wsutil/unicode-utils.h>
  65 #else /* _WIN32 */
  66 #ifdef DLADDR_FINDS_EXECUTABLE_PATH
  67 #include <dlfcn.h>
  68 #endif /* DLADDR_FINDS_EXECUTABLE_PATH */
  69 #include <pwd.h>
  70 #endif /* _WIN32 */
  71
  72 #include "filesystem.h"
  73 #include "report_err.h"
  74 #include <wsutil/privileges.h>
  75 #include <wsutil/file_util.h>
  76
  77 #include <wiretap/wtap.h>       /* for WTAP_ERR_SHORT_WRITE */
  78
  79 #define PROFILES_DIR    "profiles"
  80 #define U3_MY_CAPTURES  "\\My Captures"
  81
  82 char *persconffile_dir = NULL;
  83 char *persdatafile_dir = NULL;
  84 char *persconfprofile = NULL;
  85
  86 /*
  87  * Given a pathname, return a pointer to the last pathname separator
  88  * character in the pathname, or NULL if the pathname contains no
  89  * separators.
  90  */
  91 static char *
  92 find_last_pathname_separator(const char *path)
  93 {
  94         char *separator;
  95
  96 #ifdef _WIN32
  97         char c;
  98
  99         /*
 100          * We have to scan for '\' or '/'.
 101          * Get to the end of the string.
 102          */
 103         separator = strchr(path, '\0');         /* points to ending '\0' */
 104         while (separator > path) {
 105                 c = *--separator;
 106                 if (c == '\\' || c == '/')
 107                         return separator;       /* found it */
 108         }
 109
 110         /*
 111          * OK, we didn't find any, so no directories - but there might
 112          * be a drive letter....
 113          */
 114         return strchr(path, ':');
 115 #else
 116         separator = strrchr(path, '/');
 117 #endif
 118         return separator;
 119 }
 120
 121 /*
 122  * Given a pathname, return the last component.
 123  */
 124 const char *
 125 get_basename(const char *path)
 126 {
 127         const char *filename;
 128
 129         g_assert(path != NULL);
 130         filename = find_last_pathname_separator(path);
 131         if (filename == NULL) {
 132                 /*
 133                  * There're no directories, drive letters, etc. in the
 134                  * name; the pathname *is* the file name.
 135                  */
 136                 filename = path;
 137         } else {
 138                 /*
 139                  * Skip past the pathname or drive letter separator.
 140                  */
 141                 filename++;
 142         }
 143         return filename;
 144 }
 145
 146 /*
 147  * Given a pathname, return a string containing everything but the
 148  * last component.  NOTE: this overwrites the pathname handed into
 149  * it....
 150  */
 151 char *
 152 get_dirname(char *path)
 153 {
 154         char *separator;
 155
 156         g_assert(path != NULL);
 157         separator = find_last_pathname_separator(path);
 158         if (separator == NULL) {
 159                 /*
 160                  * There're no directories, drive letters, etc. in the
 161                  * name; there is no directory path to return.
 162                  */
 163                 return NULL;
 164         }
 165
 166         /*
 167          * Get rid of the last pathname separator and the final file
 168          * name following it.
 169          */
 170         *separator = '\0';
 171
 172         /*
 173          * "path" now contains the pathname of the directory containing
 174          * the file/directory to which it referred.
 175          */
 176         return path;
 177 }
 178
 179 /*
 180  * Given a pathname, return:
 181  *
 182  *      the errno, if an attempt to "stat()" the file fails;
 183  *
 184  *      EISDIR, if the attempt succeeded and the file turned out
 185  *      to be a directory;
 186  *
 187  *      0, if the attempt succeeded and the file turned out not
 188  *      to be a directory.
 189  */
 190
 191 /*
 192  * Visual C++ on Win32 systems doesn't define these.  (Old UNIX systems don't
 193  * define them either.)
 194  *
 195  * Visual C++ on Win32 systems doesn't define S_IFIFO, it defines _S_IFIFO.
 196  */
 197 #ifndef S_ISREG
 198 #define S_ISREG(mode)   (((mode) & S_IFMT) == S_IFREG)
 199 #endif
 200 #ifndef S_IFIFO
 201 #define S_IFIFO _S_IFIFO
 202 #endif
 203 #ifndef S_ISFIFO
 204 #define S_ISFIFO(mode)  (((mode) & S_IFMT) == S_IFIFO)
 205 #endif
 206 #ifndef S_ISDIR
 207 #define S_ISDIR(mode)   (((mode) & S_IFMT) == S_IFDIR)
 208 #endif
 209
 210 int
 211 test_for_directory(const char *path)
 212 {
 213         struct stat statb;
 214
 215         if (ws_stat(path, &statb) < 0)
 216                 return errno;
 217
 218         if (S_ISDIR(statb.st_mode))
 219                 return EISDIR;
 220         else
 221                 return 0;
 222 }
 223
 224 int
 225 test_for_fifo(const char *path)
 226 {
 227         struct stat statb;
 228
 229         if (ws_stat(path, &statb) < 0)
 230                 return errno;
 231
 232         if (S_ISFIFO(statb.st_mode))
 233                 return ESPIPE;
 234         else
 235                 return 0;
 236 }
 237
 238 /*
 239  * Directory from which the executable came.
 240  */
 241 static char *progfile_dir;
 242
 243 /*
 244  * TRUE if we're running from the build directory and we aren't running
 245  * with special privileges.
 246  */
 247 static gboolean running_in_build_directory_flag = FALSE;
 248
 249 /*
 250  * Get the pathname of the directory from which the executable came,
 251  * and save it for future use.  Returns NULL on success, and a
 252  * g_mallocated string containing an error on failure.
 253  */
 254 char *
 255 init_progfile_dir(const char *arg0
 256 #ifdef _WIN32
 257         _U_
 258 #endif
 259 , int (*main_addr)(int, char **)
 260 #if defined(_WIN32) || !defined(DLADDR_FINDS_EXECUTABLE_PATH)
 261         _U_
 262 #endif
 263 )
 264 {
 265         char *dir_end;
 266         char *path;
 267 #ifdef _WIN32
 268         TCHAR prog_pathname_w[_MAX_PATH+2];
 269         size_t progfile_dir_len;
 270         char *prog_pathname;
 271         DWORD error;
 272         TCHAR *msg_w;
 273         guchar *msg;
 274         size_t msglen;
 275
 276         /*
 277          * Attempt to get the full pathname of the currently running
 278          * program.
 279          */
 280         if (GetModuleFileName(NULL, prog_pathname_w, sizeof prog_pathname_w) != 0) {
 281                 /*
 282                  * XXX - Should we use g_utf16_to_utf8(), as in
 283                  * getenv_utf8()?
 284                  */
 285                 prog_pathname = utf_16to8(prog_pathname_w);
 286                 /*
 287                  * We got it; strip off the last component, which would be
 288                  * the file name of the executable, giving us the pathname
 289                  * of the directory where the executable resies
 290                  *
 291                  * First, find the last "\" in the directory, as that
 292                  * marks the end of the directory pathname.
 293                  *
 294                  * XXX - Can the pathname be something such as
 295                  * "C:wireshark.exe"?  Or is it always a full pathname
 296                  * beginning with "\" after the drive letter?
 297                  */
 298                 dir_end = strrchr(prog_pathname, '\\');
 299                 if (dir_end != NULL) {
 300                         /*
 301                          * Found it - now figure out how long the program
 302                          * directory pathname will be.
 303                          */
 304                         progfile_dir_len = (dir_end - prog_pathname);
 305
 306                         /*
 307                          * Allocate a buffer for the program directory
 308                          * pathname, and construct it.
 309                          */
 310                         path = g_malloc(progfile_dir_len + 1);
 311                         strncpy(path, prog_pathname, progfile_dir_len);
 312                         path[progfile_dir_len] = '\0';
 313                         progfile_dir = path;
 314
 315                         return NULL;    /* we succeeded */
 316                 } else {
 317                         /*
 318                          * OK, no \ - what do we do now?
 319                          */
 320                         return g_strdup_printf("No \\ in executable pathname \"%s\"",
 321                             prog_pathname);
 322                 }
 323         } else {
 324                 /*
 325                  * Oh, well.  Return an indication of the error.
 326                  */
 327                 error = GetLastError();
 328                 if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
 329                     NULL, error, 0, (LPTSTR) &msg_w, 0, NULL) == 0) {
 330                         /*
 331                          * Gak.  We can't format the message.
 332                          */
 333                         return g_strdup_printf("GetModuleFileName failed: %u (FormatMessage failed: %u)",
 334                             error, GetLastError());
 335                 }
 336                 msg = utf_16to8(msg_w);
 337                 LocalFree(msg_w);
 338                 /*
 339                  * "FormatMessage()" "helpfully" sticks CR/LF at the
 340                  * end of the message.  Get rid of it.
 341                  */
 342                 msglen = strlen(msg);
 343                 if (msglen >= 2) {
 344                         msg[msglen - 1] = '\0';
 345                         msg[msglen - 2] = '\0';
 346                 }
 347                 return g_strdup_printf("GetModuleFileName failed: %s (%u)",
 348                     msg, error);
 349         }
 350 #else
 351 #ifdef DLADDR_FINDS_EXECUTABLE_PATH
 352         Dl_info info;
 353 #endif
 354         char *prog_pathname;
 355         char *curdir;
 356         long path_max;
 357         char *pathstr;
 358         char *path_start, *path_end;
 359         size_t path_component_len;
 360         char *retstr;
 361
 362         /*
 363          * Check whether WIRESHARK_RUN_FROM_BUILD_DIRECTORY is set in the
 364          * environment; if so, set running_in_build_directory_flag if we
 365          * weren't started with special privileges.  (If we were started
 366          * with special privileges, it's not safe to allow the user to point
 367          * us to some other directory; running_in_build_directory_flag, when
 368          * set, causes us to look for plugins and the like in the build
 369          * directory.)
 370          */
 371         if (getenv("WIRESHARK_RUN_FROM_BUILD_DIRECTORY") != NULL
 372             && !started_with_special_privs())
 373                 running_in_build_directory_flag = TRUE;
 374
 375 #ifdef DLADDR_FINDS_EXECUTABLE_PATH
 376         /*
 377          * Try to use dladdr() to find the pathname of the executable.
 378          * dladdr() is not guaranteed to give you anything better than
 379          * argv[0] (i.e., it might not contain a / at all, much less
 380          * being an absolute path), and doesn't appear to do so on
 381          * Linux, but on other platforms it could give you an absolute
 382          * path and obviate the need for us to determine the absolute
 383          * path.
 384          */
 385         if (dladdr((void *)main_addr, &info))
 386                 arg0 = info.dli_fname;
 387 #endif
 388         /*
 389          * Try to figure out the directory in which the currently running
 390          * program resides, given something purporting to be the executable
 391          * name (from dladdr() or from the argv[0] it was started with.
 392          * That might be the absolute path of the program, or a path relative
 393          * to the current directory of the process that started it, or
 394          * just a name for the program if it was started from the command
 395          * line and was searched for in $PATH.  It's not guaranteed to be
 396          * any of those, however, so there are no guarantees....
 397          */
 398         if (arg0[0] == '/') {
 399                 /*
 400                  * It's an absolute path.
 401                  */
 402                 prog_pathname = g_strdup(arg0);
 403         } else if (strchr(arg0, '/') != NULL) {
 404                 /*
 405                  * It's a relative path, with a directory in it.
 406                  * Get the current directory, and combine it
 407                  * with that directory.
 408                  */
 409                 path_max = pathconf(".", _PC_PATH_MAX);
 410                 if (path_max == -1) {
 411                         /*
 412                          * We have no idea how big a buffer to
 413                          * allocate for the current directory.
 414                          */
 415                         return g_strdup_printf("pathconf failed: %s\n",
 416                             strerror(errno));
 417                 }
 418                 curdir = g_malloc(path_max);
 419                 if (getcwd(curdir, path_max) == NULL) {
 420                         /*
 421                          * It failed - give up, and just stick
 422                          * with DATAFILE_DIR.
 423                          */
 424                         g_free(curdir);
 425                         return g_strdup_printf("getcwd failed: %s\n",
 426                             strerror(errno));
 427                 }
 428                 path = g_strdup_printf("%s/%s", curdir, arg0);
 429                 g_free(curdir);
 430                 prog_pathname = path;
 431         } else {
 432                 /*
 433                  * It's just a file name.
 434                  * Search the path for a file with that name
 435                  * that's executable.
 436                  */
 437                 prog_pathname = NULL;   /* haven't found it yet */
 438                 pathstr = getenv("PATH");
 439                 path_start = pathstr;
 440                 if (path_start != NULL) {
 441                         while (*path_start != '\0') {
 442                                 path_end = strchr(path_start, ':');
 443                                 if (path_end == NULL)
 444                                         path_end = path_start + strlen(path_start);
 445                                 path_component_len = path_end - path_start;
 446                                 path = g_malloc(path_component_len + 1
 447                                     + strlen(arg0) + 1);
 448                                 memcpy(path, path_start, path_component_len);
 449                                 path[path_component_len] = '\0';
 450                                 strncat(path, "/", 2);
 451                                 strncat(path, arg0, strlen(arg0) + 1);
 452                                 if (access(path, X_OK) == 0) {
 453                                         /*
 454                                          * Found it!
 455                                          */
 456                                         prog_pathname = path;
 457                                         break;
 458                                 }
 459
 460                                 /*
 461                                  * That's not it.  If there are more
 462                                  * path components to test, try them.
 463                                  */
 464                                 if (*path_end == '\0') {
 465                                         /*
 466                                          * There's nothing more to try.
 467                                          */
 468                                         break;
 469                                 }
 470                                 if (*path_end == ':')
 471                                         path_end++;
 472                                 path_start = path_end;
 473                                 g_free(path);
 474                         }
 475                         if (prog_pathname == NULL) {
 476                                 /*
 477                                  * Program not found in path.
 478                                  */
 479                                 return g_strdup_printf("\"%s\" not found in \"%s\"",
 480                                     arg0, pathstr);
 481                         }
 482                 } else {
 483                         /*
 484                          * PATH isn't set.
 485                          * XXX - should we pick a default?
 486                          */
 487                         return g_strdup("PATH isn't set");
 488                 }
 489         }
 490
 491         /*
 492          * OK, we have what we think is the pathname
 493          * of the program.
 494          *
 495          * First, find the last "/" in the directory,
 496          * as that marks the end of the directory pathname.
 497          */
 498         dir_end = strrchr(prog_pathname, '/');
 499         if (dir_end != NULL) {
 500                 /*
 501                  * Found it.  Strip off the last component,
 502                  * as that's the path of the program.
 503                  */
 504                 *dir_end = '\0';
 505
 506                 /*
 507                  * Is there a "/.libs" at the end?
 508                  */
 509                 dir_end = strrchr(prog_pathname, '/');
 510                 if (dir_end != NULL) {
 511                         if (strcmp(dir_end, "/.libs") == 0) {
 512                                 /*
 513                                  * Yup, it's ".libs".
 514                                  * Strip that off; it's an
 515                                  * artifact of libtool.
 516                                  */
 517                                 *dir_end = '\0';
 518
 519                                 /*
 520                                  * This presumably means we're run from
 521                                  * the libtool wrapper, which probably
 522                                  * means we're being run from the build
 523                                  * directory.  If we weren't started
 524                                  * with special privileges, set
 525                                  * running_in_build_directory_flag.
 526                                  *
 527                                  * XXX - should we check whether what
 528                                  * follows ".libs/" begins with "lt-"?
 529                                  */
 530                                 if (!started_with_special_privs())
 531                                         running_in_build_directory_flag = TRUE;
 532                         }
 533                 }
 534
 535                 /*
 536                  * OK, we have the path we want.
 537                  */
 538                 progfile_dir = prog_pathname;
 539                 return NULL;
 540         } else {
 541                 /*
 542                  * This "shouldn't happen"; we apparently
 543                  * have no "/" in the pathname.
 544                  * Just free up prog_pathname.
 545                  */
 546                 retstr = g_strdup_printf("No / found in \"%s\"", prog_pathname);
 547                 g_free(prog_pathname);
 548                 return retstr;
 549         }
 550 #endif
 551 }
 552
 553 /*
 554  * Get the directory in which the program resides.
 555  */
 556 const char *
 557 get_progfile_dir(void)
 558 {
 559         return progfile_dir;
 560 }
 561
 562 /*
 563  * Get the directory in which the global configuration and data files are
 564  * stored.
 565  *
 566  * On Windows, we use the directory in which the executable for this
 567  * process resides.
 568  *
 569  * On UN*X, we use the DATAFILE_DIR value supplied by the configure
 570  * script, unless we think we're being run from the build directory,
 571  * in which case we use the directory in which the executable for this
 572  * process resides.
 573  *
 574  * XXX - if we ever make libwireshark a real library, used by multiple
 575  * applications (more than just TShark and versions of Wireshark with
 576  * various UIs), should the configuration files belong to the library
 577  * (and be shared by all those applications) or to the applications?
 578  *
 579  * If they belong to the library, that could be done on UNIX by the
 580  * configure script, but it's trickier on Windows, as you can't just
 581  * use the pathname of the executable.
 582  *
 583  * If they belong to the application, that could be done on Windows
 584  * by using the pathname of the executable, but we'd have to have it
 585  * passed in as an argument, in some call, on UNIX.
 586  *
 587  * Note that some of those configuration files might be used by code in
 588  * libwireshark, some of them might be used by dissectors (would they
 589  * belong to libwireshark, the application, or a separate library?),
 590  * and some of them might be used by other code (the Wireshark preferences
 591  * file includes resolver preferences that control the behavior of code
 592  * in libwireshark, dissector preferences, and UI preferences, for
 593  * example).
 594  */
 595 const char *
 596 get_datafile_dir(void)
 597 {
 598 #ifdef _WIN32
 599         char *u3deviceexecpath;
 600 #endif
 601         static char *datafile_dir = NULL;
 602
 603         if (datafile_dir != NULL)
 604                 return datafile_dir;
 605
 606 #ifdef _WIN32
 607         /*
 608          * See if we are running in a U3 environment.
 609          */
 610         u3deviceexecpath = getenv_utf8("U3_DEVICE_EXEC_PATH");
 611
 612         if (u3deviceexecpath != NULL) {
 613                 /*
 614                  * We are; use the U3 device executable path.
 615                  */
 616                 datafile_dir = u3deviceexecpath;
 617         } else {
 618                 /*
 619                  * Do we have the pathname of the program?  If so, assume we're
 620                  * running an installed version of the program.  If we fail,
 621                  * we don't change "datafile_dir", and thus end up using the
 622                  * default.
 623                  *
 624                  * XXX - does NSIS put the installation directory into
 625                  * "\HKEY_LOCAL_MACHINE\SOFTWARE\Wireshark\InstallDir"?
 626                  * If so, perhaps we should read that from the registry,
 627                  * instead.
 628                  */
 629                 if (progfile_dir != NULL) {
 630                         /*
 631                          * Yes, we do; use that.
 632                          */
 633                         datafile_dir = progfile_dir;
 634                 } else {
 635                         /*
 636                          * No, we don't.
 637                          * Fall back on the default installation directory.
 638                          */
 639                         datafile_dir = "C:\\Program Files\\Wireshark\\";
 640                 }
 641         }
 642 #else
 643         if (running_in_build_directory_flag && progfile_dir != NULL) {
 644                 /*
 645                  * We're (probably) being run from the build directory and
 646                  * weren't started with special privileges, and we were
 647                  * able to determine the directory in which the program
 648                  * was found, so use that.
 649                  */
 650                 datafile_dir = progfile_dir;
 651         } else {
 652                 /*
 653                  * Return the directory specified when the build was
 654                  * configured, prepending the run path prefix if it exists.
 655                  */
 656                 if (getenv("WIRESHARK_DATA_DIR") && !started_with_special_privs()) {
 657                         /*
 658                          * The user specified a different directory for data files
 659                          * and we aren't running with special privileges.
 660                          * XXX - We might be able to dispense with the priv check
 661                          */
 662                         datafile_dir = g_strdup(getenv("WIRESHARK_DATA_DIR"));
 663                 } else {
 664                         datafile_dir = DATAFILE_DIR;
 665                 }
 666         }
 667
 668 #endif
 669         return datafile_dir;
 670 }
 671
 672 #ifdef HAVE_PLUGINS
 673 /*
 674  * Find the directory where the plugins are stored.
 675  *
 676  * On Windows, we use the "plugin" subdirectory of the datafile directory.
 677  *
 678  * On UN*X, we use the PLUGIN_DIR value supplied by the configure
 679  * script, unless we think we're being run from the build directory,
 680  * in which case we use the "plugin" subdirectory of the datafile directory.
 681  *
 682  * In both cases, we then use the subdirectory of that directory whose
 683  * name is the version number.
 684  *
 685  * XXX - if we think we're being run from the build directory, perhaps we
 686  * should have the plugin code not look in the version subdirectory
 687  * of the plugin directory, but look in all of the subdirectories
 688  * of the plugin directory, so it can just fetch the plugins built
 689  * as part of the build process.
 690  */
 691 static const char *plugin_dir = NULL;
 692
 693 static void
 694 init_plugin_dir(void)
 695 {
 696 #ifdef _WIN32
 697         /*
 698          * On Windows, the data file directory is the installation
 699          * directory; the plugins are stored under it.
 700          *
 701          * Assume we're running the installed version of Wireshark;
 702          * on Windows, the data file directory is the directory
 703          * in which the Wireshark binary resides.
 704          */
 705         plugin_dir = g_strdup_printf("%s\\plugins\\%s", get_datafile_dir(),
 706             VERSION);
 707
 708         /*
 709          * Make sure that pathname refers to a directory.
 710          */
 711         if (test_for_directory(plugin_dir) != EISDIR) {
 712                 /*
 713                  * Either it doesn't refer to a directory or it
 714                  * refers to something that doesn't exist.
 715                  *
 716                  * Assume that means we're running a version of
 717                  * Wireshark we've built in a build directory,
 718                  * in which case {datafile dir}\plugins is the
 719                  * top-level plugins source directory, and use
 720                  * that directory and set the "we're running in
 721                  * a build directory" flag, so the plugin
 722                  * scanner will check all subdirectories of that
 723                  * directory for plugins.
 724                  */
 725                 g_free( (gpointer) plugin_dir);
 726                 plugin_dir = g_strdup_printf("%s\\plugins", get_datafile_dir());
 727                 running_in_build_directory_flag = TRUE;
 728         }
 729 #else
 730         if (running_in_build_directory_flag) {
 731                 /*
 732                  * We're (probably) being run from the build directory and
 733                  * weren't started with special privileges, so we'll use
 734                  * the "plugins" subdirectory of the datafile directory
 735                  * (the datafile directory is the build directory).
 736                  */
 737                 plugin_dir = g_strdup_printf("%s/plugins", get_datafile_dir());
 738         } else {
 739                 if (getenv("WIRESHARK_PLUGIN_DIR") && !started_with_special_privs()) {
 740                         /*
 741                          * The user specified a different directory for plugins
 742                          * and we aren't running with special privileges.
 743                          */
 744                         plugin_dir = g_strdup(getenv("WIRESHARK_PLUGIN_DIR"));
 745                 } else {
 746                         plugin_dir = PLUGIN_DIR;
 747                 }
 748         }
 749 #endif
 750 }
 751 #endif /* HAVE_PLUGINS */
 752
 753 /*
 754  * Get the directory in which the plugins are stored.
 755  */
 756 const char *
 757 get_plugin_dir(void)
 758 {
 759 #ifdef HAVE_PLUGINS
 760         if (!plugin_dir) init_plugin_dir();
 761         return plugin_dir;
 762 #else
 763         return NULL;
 764 #endif
 765 }
 766
 767 /*
 768  * Get the flag indicating whether we're running from a build
 769  * directory.
 770  */
 771 gboolean
 772 running_in_build_directory(void)
 773 {
 774         return running_in_build_directory_flag;
 775 }
 776
 777 /*
 778  * Get the directory in which files that, at least on UNIX, are
 779  * system files (such as "/etc/ethers") are stored; on Windows,
 780  * there's no "/etc" directory, so we get them from the global
 781  * configuration and data file directory.
 782  */
 783 const char *
 784 get_systemfile_dir(void)
 785 {
 786 #ifdef _WIN32
 787         return get_datafile_dir();
 788 #else
 789         return "/etc";
 790 #endif
 791 }
 792
 793 /*
 794  * Name of directory, under the user's home directory, in which
 795  * personal configuration files are stored.
 796  */
 797 #ifdef _WIN32
 798 #define PF_DIR "Wireshark"
 799 #else
 800 /*
 801  * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
 802  * it ".wireshark" for now.
 803  */
 804 #define PF_DIR ".wireshark"
 805 #endif
 806
 807 #ifdef _WIN32
 808 /* utf8 version of getenv, needed to get win32 filename paths */
 809 char *getenv_utf8(const char *varname)
 810 {
 811         char *envvar;
 812         wchar_t *envvarw;
 813         wchar_t *varnamew;
 814
 815         envvar = getenv(varname);
 816
 817         /* since GLib 2.6 we need an utf8 version of the filename */
 818 #if GLIB_CHECK_VERSION(2,6,0)
 819         /* using the wide char version of getenv should work under all circumstances */
 820
 821         /* convert given varname to utf16, needed by _wgetenv */
 822         varnamew = g_utf8_to_utf16(varname, -1, NULL, NULL, NULL);
 823         if (varnamew == NULL) {
 824                 return envvar;
 825         }
 826
 827         /* use wide char version of getenv */
 828         envvarw = _wgetenv(varnamew);
 829         g_free(varnamew);
 830         if (envvarw == NULL) {
 831                 return envvar;
 832         }
 833
 834         /* convert value to utf8 */
 835         envvar = g_utf16_to_utf8(envvarw, -1, NULL, NULL, NULL);
 836         /* XXX - memleak */
 837 #endif
 838
 839         return envvar;
 840 }
 841 #endif
 842
 843 void
 844 set_profile_name(const gchar *profilename)
 845 {
 846         g_free (persconfprofile);
 847
 848         if (profilename && strlen(profilename) > 0 &&
 849             strcmp(profilename, DEFAULT_PROFILE) != 0) {
 850                 persconfprofile = g_strdup (profilename);
 851         } else {
 852                 /* Default Profile */
 853                 persconfprofile = NULL;
 854         }
 855 }
 856
 857 const char *
 858 get_profile_name(void)
 859 {
 860         if (persconfprofile) {
 861                 return persconfprofile;
 862         } else {
 863                 return DEFAULT_PROFILE;
 864         }
 865 }
 866
 867 /*
 868  * Get the directory in which personal configuration files reside;
 869  * in UNIX-compatible systems, it's ".wireshark", under the user's home
 870  * directory, and on Windows systems, it's "Wireshark", under %APPDATA%
 871  * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
 872  * (which is what %APPDATA% normally is on Windows 2000).
 873  */
 874 static const char *
 875 get_persconffile_dir_no_profile(void)
 876 {
 877 #ifdef _WIN32
 878         char *appdatadir;
 879         char *userprofiledir;
 880         char *u3appdatapath;
 881 #else
 882         const char *homedir;
 883         struct passwd *pwd;
 884 #endif
 885
 886         /* Return the cached value, if available */
 887         if (persconffile_dir != NULL)
 888                 return persconffile_dir;
 889
 890 #ifdef _WIN32
 891         /*
 892          * See if we are running in a U3 environment.
 893          */
 894         u3appdatapath = getenv_utf8("U3_APP_DATA_PATH");
 895         if (u3appdatapath != NULL) {
 896                 /*
 897                  * We are; use the U3 application data path.
 898                  */
 899                 persconffile_dir = u3appdatapath;
 900         } else {
 901                 /*
 902                  * Use %APPDATA% or %USERPROFILE%, so that configuration
 903                  * files are stored in the user profile, rather than in
 904                  * the home directory.  The Windows convention is to store
 905                  * configuration information in the user profile, and doing
 906                  * so means you can use Wireshark even if the home directory
 907                  * is an inaccessible network drive.
 908                  */
 909                 appdatadir = getenv_utf8("APPDATA");
 910                 if (appdatadir != NULL) {
 911                         /*
 912                          * Concatenate %APPDATA% with "\Wireshark".
 913                          */
 914                         persconffile_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
 915                                                            appdatadir, PF_DIR);
 916                 } else {
 917                         /*
 918                          * OK, %APPDATA% wasn't set, so use
 919                          * %USERPROFILE%\Application Data.
 920                          */
 921                         userprofiledir = getenv_utf8("USERPROFILE");
 922                         if (userprofiledir != NULL) {
 923                                 persconffile_dir = g_strdup_printf(
 924                                     "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
 925                                     userprofiledir, PF_DIR);
 926                         } else {
 927                                 /*
 928                                  * Give up and use "C:".
 929                                  */
 930                                 persconffile_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
 931                         }
 932                 }
 933         }
 934 #else
 935         /*
 936          * If $HOME is set, use that.
 937          */
 938         homedir = getenv("HOME");
 939         if (homedir == NULL) {
 940                 /*
 941                  * Get their home directory from the password file.
 942                  * If we can't even find a password file entry for them,
 943                  * use "/tmp".
 944                  */
 945                 pwd = getpwuid(getuid());
 946                 if (pwd != NULL) {
 947                         /*
 948                          * This is cached, so we don't need to worry
 949                          * about allocating multiple ones of them.
 950                          */
 951                         homedir = g_strdup(pwd->pw_dir);
 952                 } else
 953                         homedir = "/tmp";
 954         }
 955         persconffile_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
 956 #endif
 957
 958         return persconffile_dir;
 959 }
 960
 961 const char *
 962 get_profiles_dir(void)
 963 {
 964         static char *profiles_dir = NULL;
 965
 966         g_free (profiles_dir);
 967         profiles_dir = g_strdup_printf ("%s%s%s", get_persconffile_dir_no_profile (),
 968                                         G_DIR_SEPARATOR_S, PROFILES_DIR);
 969
 970         return profiles_dir;
 971 }
 972
 973 static const char *
 974 get_persconffile_dir(const gchar *profilename)
 975 {
 976         static char *persconffile_profile_dir = NULL;
 977
 978         g_free (persconffile_profile_dir);
 979
 980         if (profilename && strlen(profilename) > 0 &&
 981             strcmp(profilename, DEFAULT_PROFILE) != 0) {
 982           persconffile_profile_dir = g_strdup_printf ("%s%s%s", get_profiles_dir (),
 983                                                       G_DIR_SEPARATOR_S, profilename);
 984         } else {
 985           persconffile_profile_dir = g_strdup (get_persconffile_dir_no_profile ());
 986         }
 987
 988         return persconffile_profile_dir;
 989 }
 990
 991 gboolean
 992 profile_exists(const gchar *profilename)
 993 {
 994         if (test_for_directory (get_persconffile_dir (profilename)) == EISDIR) {
 995                 return TRUE;
 996         }
 997
 998         return FALSE;
 999 }
1000
1001 static int
1002 delete_directory (const char *directory, char **pf_dir_path_return)
1003 {
1004         WS_DIR *dir;
1005         WS_DIRENT *file;
1006         gchar *filename;
1007         int ret = 0;
1008
1009         if ((dir = ws_dir_open(directory, 0, NULL)) != NULL) {
1010                 while ((file = ws_dir_read_name(dir)) != NULL) {
1011                         filename = g_strdup_printf ("%s%s%s", directory, G_DIR_SEPARATOR_S,
1012                                                     ws_dir_get_name(file));
1013                         if (test_for_directory(filename) != EISDIR) {
1014                                 ret = ws_remove(filename);
1015 #if 0
1016                         } else {
1017                                 /* The user has manually created a directory in the profile directory */
1018                                 /* I do not want to delete the directory recursively yet */
1019                                 ret = delete_directory (filename, pf_dir_path_return);
1020 #endif
1021                         }
1022                         if (ret != 0) {
1023                                 *pf_dir_path_return = filename;
1024                                 break;
1025                         }
1026                         g_free (filename);
1027                 }
1028                 ws_dir_close(dir);
1029         }
1030
1031         if (ret == 0 && (ret = ws_remove(directory)) != 0) {
1032                 *pf_dir_path_return = g_strdup (directory);
1033         }
1034
1035         return ret;
1036 }
1037
1038 int
1039 delete_persconffile_profile(const char *profilename, char **pf_dir_path_return)
1040 {
1041         const char *profile_dir = get_persconffile_dir(profilename);
1042         int ret = 0;
1043
1044         if (test_for_directory (profile_dir) == EISDIR) {
1045                 ret = delete_directory (profile_dir, pf_dir_path_return);
1046         }
1047
1048         return ret;
1049 }
1050
1051 int
1052 rename_persconffile_profile(const char *fromname, const char *toname,
1053                             char **pf_from_dir_path_return, char **pf_to_dir_path_return)
1054 {
1055         char *from_dir = g_strdup (get_persconffile_dir(fromname));
1056         char *to_dir = g_strdup (get_persconffile_dir(toname));
1057         int ret = 0;
1058
1059         ret = ws_rename (from_dir, to_dir);
1060         if (ret != 0) {
1061                 *pf_from_dir_path_return = g_strdup (from_dir);
1062                 *pf_to_dir_path_return = g_strdup (to_dir);
1063         }
1064
1065         g_free (from_dir);
1066         g_free (to_dir);
1067
1068         return ret;
1069 }
1070
1071 /*
1072  * Create the directory that holds personal configuration files, if
1073  * necessary.  If we attempted to create it, and failed, return -1 and
1074  * set "*pf_dir_path_return" to the pathname of the directory we failed
1075  * to create (it's g_mallocated, so our caller should free it); otherwise,
1076  * return 0.
1077  */
1078 int
1079 create_persconffile_profile(const char *profilename, char **pf_dir_path_return)
1080 {
1081         const char *pf_dir_path;
1082 #ifdef _WIN32
1083         char *pf_dir_path_copy, *pf_dir_parent_path;
1084         size_t pf_dir_parent_path_len;
1085 #endif
1086         struct stat s_buf;
1087         int ret;
1088
1089         if (profilename) {
1090                 /*
1091                  * Check if profiles directory exists.
1092                  * If not then create it.
1093                  */
1094                 pf_dir_path = get_profiles_dir ();
1095                 if (ws_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
1096                         ret = ws_mkdir(pf_dir_path, 0755);
1097                         if (ret == -1) {
1098                                 *pf_dir_path_return = g_strdup(pf_dir_path);
1099                                 return ret;
1100                         }
1101                 }
1102         }
1103
1104         pf_dir_path = get_persconffile_dir(profilename);
1105         if (ws_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
1106 #ifdef _WIN32
1107                 /*
1108                  * Does the parent directory of that directory
1109                  * exist?  %APPDATA% may not exist even though
1110                  * %USERPROFILE% does.
1111                  *
1112                  * We check for the existence of the directory
1113                  * by first checking whether the parent directory
1114                  * is just a drive letter and, if it's not, by
1115                  * doing a "stat()" on it.  If it's a drive letter,
1116                  * or if the "stat()" succeeds, we assume it exists.
1117                  */
1118                 pf_dir_path_copy = g_strdup(pf_dir_path);
1119                 pf_dir_parent_path = get_dirname(pf_dir_path_copy);
1120                 pf_dir_parent_path_len = strlen(pf_dir_parent_path);
1121                 if (pf_dir_parent_path_len > 0
1122                     && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
1123                     && ws_stat(pf_dir_parent_path, &s_buf) != 0) {
1124                         /*
1125                          * No, it doesn't exist - make it first.
1126                          */
1127                         ret = ws_mkdir(pf_dir_parent_path, 0755);
1128                         if (ret == -1) {
1129                                 *pf_dir_path_return = pf_dir_parent_path;
1130                                 return -1;
1131                         }
1132                 }
1133                 g_free(pf_dir_path_copy);
1134                 ret = ws_mkdir(pf_dir_path, 0755);
1135 #else
1136                 ret = ws_mkdir(pf_dir_path, 0755);
1137 #endif
1138         } else {
1139                 /*
1140                  * Something with that pathname exists; if it's not
1141                  * a directory, we'll get an error if we try to put
1142                  * something in it, so we don't fail here, we wait
1143                  * for that attempt fo fail.
1144                  */
1145                 ret = 0;
1146         }
1147         if (ret == -1)
1148                 *pf_dir_path_return = g_strdup(pf_dir_path);
1149         return ret;
1150 }
1151
1152 int
1153 create_persconffile_dir(char **pf_dir_path_return)
1154 {
1155   return create_persconffile_profile(persconfprofile, pf_dir_path_return);
1156 }
1157
1158 /*
1159  * Get the (default) directory in which personal data is stored.
1160  *
1161  * On Win32, this is the "My Documents" folder in the personal profile.
1162  * On UNIX this is simply the current directory.
1163  * On a U3 device this is "$U3_DEVICE_DOCUMENT_PATH\My Captures" folder.
1164  */
1165 /* XXX - should this and the get_home_dir() be merged? */
1166 extern char *
1167 get_persdatafile_dir(void)
1168 {
1169 #ifdef _WIN32
1170         char *u3devicedocumentpath;
1171         TCHAR tszPath[MAX_PATH];
1172         char *szPath;
1173         BOOL bRet;
1174
1175
1176         /* Return the cached value, if available */
1177         if (persdatafile_dir != NULL)
1178                 return persdatafile_dir;
1179
1180         /*
1181          * See if we are running in a U3 environment.
1182          */
1183         u3devicedocumentpath = getenv_utf8("U3_DEVICE_DOCUMENT_PATH");
1184
1185         if (u3devicedocumentpath != NULL) {
1186
1187           /* the "My Captures" sub-directory is created (if it doesn't exist)
1188                  by u3util.exe when the U3 Wireshark is first run */
1189
1190           szPath = g_strdup_printf("%s%s", u3devicedocumentpath, U3_MY_CAPTURES);
1191
1192           persdatafile_dir = szPath;
1193           return szPath;
1194
1195                 } else {
1196         /* Hint: SHGetFolderPath is not available on MSVC 6 - without Platform SDK */
1197         bRet = SHGetSpecialFolderPath(NULL, tszPath, CSIDL_PERSONAL, FALSE);
1198         if(bRet == TRUE) {
1199                 szPath = utf_16to8(tszPath);
1200                 persdatafile_dir = szPath;
1201                 return szPath;
1202         } else {
1203                 return "";
1204         }
1205 }
1206 #else
1207   return "";
1208 #endif
1209 }
1210
1211 #ifdef _WIN32
1212 /*
1213  * Returns the user's home directory on Win32.
1214  */
1215 static const char *
1216 get_home_dir(void)
1217 {
1218         static const char *home = NULL;
1219         char *homedrive, *homepath;
1220         char *homestring;
1221         char *lastsep;
1222
1223         /* Return the cached value, if available */
1224         if (home)
1225                 return home;
1226
1227         /*
1228          * XXX - should we use USERPROFILE anywhere in this process?
1229          * Is there a chance that it might be set but one or more of
1230          * HOMEDRIVE or HOMEPATH isn't set?
1231          */
1232         homedrive = getenv_utf8("HOMEDRIVE");
1233         if (homedrive != NULL) {
1234                 homepath = getenv_utf8("HOMEPATH");
1235                 if (homepath != NULL) {
1236                         /*
1237                          * This is cached, so we don't need to worry about
1238                          * allocating multiple ones of them.
1239                          */
1240                         homestring = g_strdup_printf("%s%s", homedrive, homepath);
1241
1242                         /*
1243                          * Trim off any trailing slash or backslash.
1244                          */
1245                         lastsep = find_last_pathname_separator(homestring);
1246                         if (lastsep != NULL && *(lastsep + 1) == '\0') {
1247                                 /*
1248                                  * Last separator is the last character
1249                                  * in the string.  Nuke it.
1250                                  */
1251                                 *lastsep = '\0';
1252                         }
1253                         home = homestring;
1254                 } else
1255                         home = homedrive;
1256         } else {
1257                 /*
1258                  * Give up and use C:.
1259                  */
1260                 home = "C:";
1261         }
1262
1263         return home;
1264 }
1265 #endif
1266
1267 /*
1268  * Construct the path name of a personal configuration file, given the
1269  * file name.
1270  *
1271  * On Win32, if "for_writing" is FALSE, we check whether the file exists
1272  * and, if not, construct a path name relative to the ".wireshark"
1273  * subdirectory of the user's home directory, and check whether that
1274  * exists; if it does, we return that, so that configuration files
1275  * from earlier versions can be read.
1276  *
1277  * The returned file name was g_malloc()'d so it must be g_free()d when the
1278  * caller is done with it.
1279  */
1280 char *
1281 get_persconffile_path(const char *filename, gboolean from_profile, gboolean for_writing
1282 #ifndef _WIN32
1283         _U_
1284 #endif
1285 )
1286 {
1287         char *path;
1288 #ifdef _WIN32
1289         struct stat s_buf;
1290         char *old_path;
1291 #endif
1292
1293         if (from_profile) {
1294           path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
1295                                  get_persconffile_dir(persconfprofile), filename);
1296         } else {
1297           path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
1298                                  get_persconffile_dir(NULL), filename);
1299         }
1300 #ifdef _WIN32
1301         if (!for_writing) {
1302                 if (ws_stat(path, &s_buf) != 0 && errno == ENOENT) {
1303                         /*
1304                          * OK, it's not in the personal configuration file
1305                          * directory; is it in the ".wireshark" subdirectory
1306                          * of their home directory?
1307                          */
1308                         old_path = g_strdup_printf(
1309                             "%s" G_DIR_SEPARATOR_S ".wireshark" G_DIR_SEPARATOR_S "%s",
1310                             get_home_dir(), filename);
1311                         if (ws_stat(old_path, &s_buf) == 0) {
1312                                 /*
1313                                  * OK, it exists; return it instead.
1314                                  */
1315                                 g_free(path);
1316                                 path = old_path;
1317                         }
1318                 }
1319         }
1320 #endif
1321
1322         return path;
1323 }
1324
1325 /*
1326  * process command line option belonging to the filesystem settings
1327  * (move this e.g. to main.c and have set_persconffile_dir() instead in this file?)
1328  */
1329 int
1330 filesystem_opt(int opt _U_, const char *optstr)
1331 {
1332         gchar *p, *colonp;
1333
1334         colonp = strchr(optstr, ':');
1335         if (colonp == NULL) {
1336                 return 1;
1337         }
1338
1339         p = colonp;
1340         *p++ = '\0';
1341
1342         /*
1343         * Skip over any white space (there probably won't be any, but
1344         * as we allow it in the preferences file, we might as well
1345         * allow it here).
1346         */
1347         while (isspace((guchar)*p))
1348                 p++;
1349         if (*p == '\0') {
1350                 /*
1351                  * Put the colon back, so if our caller uses, in an
1352                  * error message, the string they passed us, the message
1353                  * looks correct.
1354                  */
1355                 *colonp = ':';
1356                 return 1;
1357         }
1358
1359         /* directory should be existing */
1360         /* XXX - is this a requirement? */
1361         if(test_for_directory(p) != EISDIR) {
1362                 /*
1363                  * Put the colon back, so if our caller uses, in an
1364                  * error message, the string they passed us, the message
1365                  * looks correct.
1366                  */
1367                 *colonp = ':';
1368                 return 1;
1369         }
1370
1371         if (strcmp(optstr,"persconf") == 0) {
1372                 persconffile_dir = p;
1373         } else if (strcmp(optstr,"persdata") == 0) {
1374                 persdatafile_dir = p;
1375                 /* XXX - might need to add the temp file path */
1376         } else {
1377                 return 1;
1378         }
1379         *colonp = ':'; /* put the colon back */
1380         return 0;
1381 }
1382
1383 /*
1384  * Construct the path name of a global configuration file, given the
1385  * file name.
1386  *
1387  * The returned file name was g_malloc()'d so it must be g_free()d when the
1388  * caller is done with it.
1389  */
1390 char *
1391 get_datafile_path(const char *filename)
1392 {
1393
1394         return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
1395                 filename);
1396 }
1397
1398 /* Delete a file */
1399 gboolean
1400 deletefile(const char *path)
1401 {
1402         return ws_unlink(path) == 0;
1403 }
1404
1405 /*
1406  * Construct and return the path name of a file in the
1407  * appropriate temporary file directory.
1408  */
1409 char *get_tempfile_path(const char *filename)
1410 {
1411         return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
1412 }
1413
1414 /*
1415  * Return an error message for UNIX-style errno indications on open or
1416  * create operations.
1417  */
1418 const char *
1419 file_open_error_message(int err, gboolean for_writing)
1420 {
1421         const char *errmsg;
1422         static char errmsg_errno[1024+1];
1423
1424         switch (err) {
1425
1426         case ENOENT:
1427                 if (for_writing)
1428                         errmsg = "The path to the file \"%s\" doesn't exist.";
1429                 else
1430                         errmsg = "The file \"%s\" doesn't exist.";
1431                 break;
1432
1433         case EACCES:
1434                 if (for_writing)
1435                         errmsg = "You don't have permission to create or write to the file \"%s\".";
1436                 else
1437                         errmsg = "You don't have permission to read the file \"%s\".";
1438                 break;
1439
1440         case EISDIR:
1441                 errmsg = "\"%s\" is a directory (folder), not a file.";
1442                 break;
1443
1444         case ENOSPC:
1445                 errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
1446                 break;
1447
1448 #ifdef EDQUOT
1449         case EDQUOT:
1450                 errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
1451                 break;
1452 #endif
1453
1454         case EINVAL:
1455                 errmsg = "The file \"%s\" could not be created because an invalid filename was specified.";
1456                 break;
1457
1458         default:
1459                 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
1460                                 "The file \"%%s\" could not be %s: %s.",
1461                                 for_writing ? "created" : "opened",
1462                                 strerror(err));
1463                 errmsg = errmsg_errno;
1464                 break;
1465         }
1466         return errmsg;
1467 }
1468
1469 /*
1470  * Return an error message for UNIX-style errno indications on write
1471  * operations.
1472  */
1473 const char *
1474 file_write_error_message(int err)
1475 {
1476         const char *errmsg;
1477         static char errmsg_errno[1024+1];
1478
1479         switch (err) {
1480
1481         case ENOSPC:
1482                 errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
1483                 break;
1484
1485 #ifdef EDQUOT
1486         case EDQUOT:
1487                 errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
1488                 break;
1489 #endif
1490
1491         default:
1492                 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
1493                     "An error occurred while writing to the file \"%%s\": %s.",
1494                     strerror(err));
1495                 errmsg = errmsg_errno;
1496                 break;
1497         }
1498         return errmsg;
1499 }
1500
1501
1502 gboolean
1503 file_exists(const char *fname)
1504 {
1505         struct stat   file_stat;
1506
1507 #ifdef _WIN32
1508         /*
1509          * This is a bit tricky on win32. The st_ino field is documented as:
1510          * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
1511          * but it *is* set to zero if stat() returns without an error,
1512          * so this is working, but maybe not quite the way expected. ULFL
1513          */
1514         file_stat.st_ino = 1;   /* this will make things work if an error occured */
1515         ws_stat(fname, &file_stat);
1516         if (file_stat.st_ino == 0) {
1517                 return TRUE;
1518         } else {
1519                 return FALSE;
1520         }
1521 #else
1522         if (ws_stat(fname, &file_stat) != 0 && errno == ENOENT) {
1523                 return FALSE;
1524         } else {
1525                 return TRUE;
1526         }
1527 #endif
1528 }
1529
1530 /*
1531  * Check that the from file is not the same as to file
1532  * We do it here so we catch all cases ...
1533  * Unfortunately, the file requester gives us an absolute file
1534  * name and the read file name may be relative (if supplied on
1535  * the command line), so we can't just compare paths. From Joerg Mayer.
1536  */
1537 gboolean
1538 files_identical(const char *fname1, const char *fname2)
1539 {
1540         /* Two different implementations, because:
1541          *
1542          * - _fullpath is not available on UN*X, so we can't get full
1543          *   paths and compare them (which wouldn't work with hard links
1544          *   in any case);
1545          *
1546          * - st_ino isn't filled in with a meaningful value on Windows.
1547          */
1548 #ifdef _WIN32
1549         char full1[MAX_PATH], full2[MAX_PATH];
1550
1551         /*
1552          * Get the absolute full paths of the file and compare them.
1553          * That won't work if you have hard links, but those aren't
1554          * much used on Windows, even though NTFS supports them.
1555          *
1556          * XXX - will _fullpath work with UNC?
1557          */
1558         if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
1559                 return FALSE;
1560         }
1561
1562         if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
1563                 return FALSE;
1564         }
1565
1566         if(strcmp(full1, full2) == 0) {
1567                 return TRUE;
1568         } else {
1569                 return FALSE;
1570         }
1571 #else
1572         struct stat   filestat1, filestat2;
1573
1574         /*
1575          * Compare st_dev and st_ino.
1576          */
1577         if (ws_stat(fname1, &filestat1) == -1)
1578                 return FALSE;   /* can't get info about the first file */
1579         if (ws_stat(fname2, &filestat2) == -1)
1580                 return FALSE;   /* can't get info about the second file */
1581         return (filestat1.st_dev == filestat2.st_dev &&
1582                 filestat1.st_ino == filestat2.st_ino);
1583 #endif
1584 }
1585
1586 /*
1587  * Copy a file in binary mode, for those operating systems that care about
1588  * such things.  This should be OK for all files, even text files, as
1589  * we'll copy the raw bytes, and we don't look at the bytes as we copy
1590  * them.
1591  *
1592  * Returns TRUE on success, FALSE on failure. If a failure, it also
1593  * displays a simple dialog window with the error message.
1594  */
1595 gboolean
1596 copy_file_binary_mode(const char *from_filename, const char *to_filename)
1597 {
1598   int           from_fd, to_fd, nread, nwritten, err;
1599   guint8        pd[65536];
1600
1601   /* Copy the raw bytes of the file. */
1602   from_fd = ws_open(from_filename, O_RDONLY | O_BINARY, 0000 /* no creation so don't matter */);
1603   if (from_fd < 0) {
1604     report_open_failure(from_filename, errno, FALSE);
1605     goto done;
1606   }
1607
1608   /* Use open() instead of creat() so that we can pass the O_BINARY
1609      flag, which is relevant on Win32; it appears that "creat()"
1610      may open the file in text mode, not binary mode, but we want
1611      to copy the raw bytes of the file, so we need the output file
1612      to be open in binary mode. */
1613   to_fd = ws_open(to_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
1614   if (to_fd < 0) {
1615     report_open_failure(to_filename, errno, TRUE);
1616     ws_close(from_fd);
1617     goto done;
1618   }
1619
1620   while ((nread = ws_read(from_fd, pd, sizeof pd)) > 0) {
1621     nwritten = ws_write(to_fd, pd, nread);
1622     if (nwritten < nread) {
1623       if (nwritten < 0)
1624         err = errno;
1625       else
1626         err = WTAP_ERR_SHORT_WRITE;
1627       report_write_failure(to_filename, err);
1628       ws_close(from_fd);
1629       ws_close(to_fd);
1630       goto done;
1631     }
1632   }
1633   if (nread < 0) {
1634     err = errno;
1635     report_read_failure(from_filename, err);
1636     ws_close(from_fd);
1637     ws_close(to_fd);
1638     goto done;
1639   }
1640   ws_close(from_fd);
1641   if (ws_close(to_fd) < 0) {
1642     report_write_failure(to_filename, errno);
1643     goto done;
1644   }
1645
1646   return TRUE;
1647
1648 done:
1649   return FALSE;
1650 }
1651
1652 /*
1653  * Editor modelines
1654  *
1655  * Local Variables:
1656  * c-basic-offset: 4
1657  * tab-width: 4
1658  * indent-tabs-mode: t
1659  * End:
1660  *
1661  * ex: set shiftwidth=4 tabstop=4 noexpandtab
1662  * :indentSize=4:tabSize=4:noTabs=false:
1663  */