Move the file utility functions from wiretap to libwsutil so that

libwireshark (and the plugins using those functions) do not depend on
wiretap on Windows.

While doing that, rename the eth_* functions to ws_*.

svn path=/trunk/; revision=25354

5 files changed, 627 insertions, 12 deletions

diff --git a/wsutil/Makefile.am b/wsutil/Makefile.am
index f99671e773..07a0b5acac 100644
--- a/wsutil/Makefile.am
+++ b/wsutil/Makefile.am
@@ -27,13 +27,7 @@ endif
 
 lib_LTLIBRARIES = libwsutil.la
 
-CLEANFILES = \
-	libwsutil.a	\
-	libwsutil.la	\
-	*~
-
-MAINTAINERCLEANFILES = \
-	Makefile.in
+INCLUDES = -I$(srcdir)/..
 
 libwsutil_la_SOURCES =	\
 	mpeg-audio.c	\
@@ -42,5 +36,14 @@ libwsutil_la_SOURCES =	\
 libwsutil_la_LIBADD = @GLIB_LIBS@
 
 EXTRA_DIST = \
-	Makefile.nmake
+	Makefile.nmake	\
+	file_util.c
+
+CLEANFILES = \
+	libwsutil.a	\
+	libwsutil.la	\
+	*~
+
+MAINTAINERCLEANFILES = \
+	Makefile.in
 
diff --git a/wsutil/Makefile.nmake b/wsutil/Makefile.nmake
index 1a275bfd64..b061490a00 100644
--- a/wsutil/Makefile.nmake
+++ b/wsutil/Makefile.nmake
@@ -12,16 +12,17 @@ include ..\Makefile.nmake.inc
 CFLAGS=-WX -DHAVE_CONFIG_H /I. /I.. $(GLIB_CFLAGS) \
 	/I$(PCAP_DIR)\include -D_U_="" $(LOCAL_CFLAGS)
 
-CVARSDLL=-DWIN32 -DNULL=0 -D_MT -D_DLL 
+CVARSDLL=-DWIN32 -DNULL=0 -D_MT -D_DLL
 
 .c.obj::
    $(CC) $(CVARSDLL) $(CFLAGS) -Fd.\ -c $<
 
 
-libwsutil_LIBS = 
+libwsutil_LIBS = $(GLIB_LIBS)
 
 OBJECTS = \
-	mpeg-audio.obj
+	mpeg-audio.obj	\
+	file_util.obj
 
 
 libwsutil.lib: libwsutil.dll
@@ -34,7 +35,7 @@ libwsutil.dll : $(OBJECTS) libwsutil.def ..\image\libwsutil.res
 		/IMPLIB:libwsutil.lib \
 		..\image\libwsutil.res \
 		$(OBJECTS) $(libwsutil_LIBS)
-!IF "$(MSVC_VARIANT)" == "MSVC2005" || "$(MSVC_VARIANT)" == "MSVC2005EE" || "$(MSVC_VARIANT)" == "DOTNET20" 
+!IF "$(MSVC_VARIANT)" == "MSVC2005" || "$(MSVC_VARIANT)" == "MSVC2005EE" || "$(MSVC_VARIANT)" == "DOTNET20"
 	mt.exe -nologo -manifest "libwsutil.dll.manifest" -outputresource:libwsutil.dll;2
 !ENDIF
 
diff --git a/wsutil/file_util.c b/wsutil/file_util.c
new file mode 100644
index 0000000000..fb30b6f18a
--- /dev/null
+++ b/wsutil/file_util.c
@@ -0,0 +1,476 @@
+/* file_util.c
+ *
+ * $Id$
+ *
+ * (Originally part of the Wiretap Library, now part of the Wireshark
+ *  utility library)
+ * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ */
+
+/* file wrapper functions to prevent the file functions from GLib like g_open(),
+ * as code compiled with MSVC 7 and above will collide with libs linked with msvcrt.dll (MSVC 6), lib GLib is
+ *
+ * DO NOT USE THESE FUNCTIONS DIRECTLY, USE ws_open() AND ALIKE FUNCTIONS FROM file_util.h INSTEAD!!!
+ *
+ * the following code is stripped down code copied from the GLib file glib/gstdio.h
+ * stipped down, because this is used on _WIN32 only and we use only wide char functions */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <glib.h>
+
+#ifdef _WIN32
+#include <windows.h>
+#include <errno.h>
+#include <wchar.h>
+/*#include <direct.h>*/
+#include <io.h>
+#endif
+
+#include "file_util.h"
+
+
+
+
+/**
+ * g_open:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @flags: as in open()
+ * @mode: as in open()
+ *
+ * A wrapper for the POSIX open() function. The open() function is
+ * used to convert a pathname into a file descriptor. Note that on
+ * POSIX systems file descriptors are implemented by the operating
+ * system. On Windows, it's the C library that implements open() and
+ * file descriptors. The actual Windows API for opening files is
+ * something different.
+ *
+ * See the C library manual for more details about open().
+ *
+ * Returns: a new file descriptor, or -1 if an error occurred. The
+ * return value can be used exactly like the return value from open().
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_open (const gchar *filename,
+	int          flags,
+	int          mode)
+{
+#ifdef _WIN32
+    {
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      int retval;
+      int save_errno;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      retval = _wopen (wfilename, flags, mode);
+      save_errno = errno;
+
+      g_free (wfilename);
+
+      errno = save_errno;
+      return retval;
+    }
+#else
+  return open (filename, flags, mode);
+#endif
+}
+
+
+/**
+ * g_rename:
+ * @oldfilename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @newfilename: a pathname in the GLib file name encoding
+ *
+ * A wrapper for the POSIX rename() function. The rename() function
+ * renames a file, moving it between directories if required.
+ *
+ * See your C library manual for more details about how rename() works
+ * on your system. Note in particular that on Win9x it is not possible
+ * to rename a file if a file with the new name already exists. Also
+ * it is not possible in general on Windows to rename an open file.
+ *
+ * Returns: 0 if the renaming succeeded, -1 if an error occurred
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_rename (const gchar *oldfilename,
+	  const gchar *newfilename)
+{
+#ifdef _WIN32
+      wchar_t *woldfilename = g_utf8_to_utf16 (oldfilename, -1, NULL, NULL, NULL);
+      wchar_t *wnewfilename;
+      int retval;
+      int save_errno = 0;
+
+      if (woldfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      wnewfilename = g_utf8_to_utf16 (newfilename, -1, NULL, NULL, NULL);
+
+      if (wnewfilename == NULL)
+	{
+	  g_free (woldfilename);
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      if (MoveFileExW (woldfilename, wnewfilename, MOVEFILE_REPLACE_EXISTING))
+	retval = 0;
+      else
+	{
+	  retval = -1;
+	  switch (GetLastError ())
+	    {
+#define CASE(a,b) case ERROR_##a: save_errno = b; break
+	    CASE (FILE_NOT_FOUND, ENOENT);
+	    CASE (PATH_NOT_FOUND, ENOENT);
+	    CASE (ACCESS_DENIED, EACCES);
+	    CASE (NOT_SAME_DEVICE, EXDEV);
+	    CASE (LOCK_VIOLATION, EACCES);
+	    CASE (SHARING_VIOLATION, EACCES);
+	    CASE (FILE_EXISTS, EEXIST);
+	    CASE (ALREADY_EXISTS, EEXIST);
+#undef CASE
+	    default: save_errno = EIO;
+	    }
+	}
+
+      g_free (woldfilename);
+      g_free (wnewfilename);
+
+      errno = save_errno;
+      return retval;
+#else
+  return rename (oldfilename, newfilename);
+#endif
+}
+
+/**
+ * g_mkdir:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @mode: permissions to use for the newly created directory
+ *
+ * A wrapper for the POSIX mkdir() function. The mkdir() function
+ * attempts to create a directory with the given name and permissions.
+ *
+ * See the C library manual for more details about mkdir().
+ *
+ * Returns: 0 if the directory was successfully created, -1 if an error
+ *    occurred
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_mkdir (const gchar *filename,
+	 int          mode)
+{
+#ifdef _WIN32
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      int retval;
+      int save_errno;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      retval = _wmkdir (wfilename);
+      save_errno = errno;
+
+      g_free (wfilename);
+
+      errno = save_errno;
+      return retval;
+#else
+  return mkdir (filename, mode);
+#endif
+}
+
+/**
+ * g_stat:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @buf: a pointer to a <structname>stat</structname> struct, which
+ *    will be filled with the file information
+ *
+ * A wrapper for the POSIX stat() function. The stat() function
+ * returns information about a file.
+ *
+ * See the C library manual for more details about stat().
+ *
+ * Returns: 0 if the information was successfully retrieved, -1 if an error
+ *    occurred
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_stat (const gchar *filename,
+	struct stat *buf)
+{
+#ifdef _WIN32
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      int retval;
+      int save_errno;
+      int len;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      len = wcslen (wfilename);
+      while (len > 0 && G_IS_DIR_SEPARATOR (wfilename[len-1]))
+	len--;
+      if (len > 0 &&
+	  (!g_path_is_absolute (filename) || len > g_path_skip_root (filename) - filename))
+	wfilename[len] = '\0';
+
+      retval = _wstat (wfilename, (struct _stat *) buf);
+      save_errno = errno;
+
+      g_free (wfilename);
+
+      errno = save_errno;
+      return retval;
+#else
+  return stat (filename, buf);
+#endif
+}
+
+/**
+ * g_unlink:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ *
+ * A wrapper for the POSIX unlink() function. The unlink() function
+ * deletes a name from the filesystem. If this was the last link to the
+ * file and no processes have it opened, the diskspace occupied by the
+ * file is freed.
+ *
+ * See your C library manual for more details about unlink(). Note
+ * that on Windows, it is in general not possible to delete files that
+ * are open to some process, or mapped into memory.
+ *
+ * Returns: 0 if the name was successfully deleted, -1 if an error
+ *    occurred
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_unlink (const gchar *filename)
+{
+#ifdef _WIN32
+      gchar *cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
+      int retval;
+      int save_errno;
+
+      if (cp_filename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      retval = unlink (cp_filename);
+      save_errno = errno;
+
+      g_free (cp_filename);
+
+      errno = save_errno;
+      return retval;
+#else
+  return unlink (filename);
+#endif
+}
+
+/**
+ * g_remove:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ *
+ * A wrapper for the POSIX remove() function. The remove() function
+ * deletes a name from the filesystem.
+ *
+ * See your C library manual for more details about how remove() works
+ * on your system. On Unix, remove() removes also directories, as it
+ * calls unlink() for files and rmdir() for directories. On Windows,
+ * although remove() in the C library only works for files, this
+ * function tries first remove() and then if that fails rmdir(), and
+ * thus works for both files and directories. Note however, that on
+ * Windows, it is in general not possible to remove a file that is
+ * open to some process, or mapped into memory.
+ *
+ * If this function fails on Windows you can't infer too much from the
+ * errno value. rmdir() is tried regardless of what caused remove() to
+ * fail. Any errno value set by remove() will be overwritten by that
+ * set by rmdir().
+ *
+ * Returns: 0 if the file was successfully removed, -1 if an error
+ *    occurred
+ *
+ * Since: 2.6
+ */
+int
+ws_stdio_remove (const gchar *filename)
+{
+#ifdef _WIN32
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      int retval;
+      int save_errno;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return -1;
+	}
+
+      retval = _wremove (wfilename);
+      if (retval == -1)
+	retval = _wrmdir (wfilename);
+      save_errno = errno;
+
+      g_free (wfilename);
+
+      errno = save_errno;
+      return retval;
+#else
+  return remove (filename);
+#endif
+}
+
+/**
+ * g_fopen:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @mode: a string describing the mode in which the file should be
+ *   opened
+ *
+ * A wrapper for the POSIX fopen() function. The fopen() function opens
+ * a file and associates a new stream with it.
+ *
+ * See the C library manual for more details about fopen().
+ *
+ * Returns: A <type>FILE</type> pointer if the file was successfully
+ *    opened, or %NULL if an error occurred
+ *
+ * Since: 2.6
+ */
+FILE *
+ws_stdio_fopen (const gchar *filename,
+	 const gchar *mode)
+{
+#ifdef _WIN32
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      wchar_t *wmode;
+      FILE *retval;
+      int save_errno;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return NULL;
+	}
+
+      wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
+
+      if (wmode == NULL)
+	{
+	  g_free (wfilename);
+	  errno = EINVAL;
+	  return NULL;
+	}
+
+      retval = _wfopen (wfilename, wmode);
+      save_errno = errno;
+
+      g_free (wfilename);
+      g_free (wmode);
+
+      errno = save_errno;
+      return retval;
+#else
+  return fopen (filename, mode);
+#endif
+}
+
+/**
+ * g_freopen:
+ * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
+ * @mode: a string describing the mode in which the file should be
+ *   opened
+ * @stream: an existing stream which will be reused, or %NULL
+ *
+ * A wrapper for the POSIX freopen() function. The freopen() function
+ * opens a file and associates it with an existing stream.
+ *
+ * See the C library manual for more details about freopen().
+ *
+ * Returns: A <type>FILE</type> pointer if the file was successfully
+ *    opened, or %NULL if an error occurred.
+ *
+ * Since: 2.6
+ */
+FILE *
+ws_stdio_freopen (const gchar *filename,
+	   const gchar *mode,
+	   FILE        *stream)
+{
+#ifdef _WIN32
+      wchar_t *wfilename = g_utf8_to_utf16 (filename, -1, NULL, NULL, NULL);
+      wchar_t *wmode;
+      FILE *retval;
+      int save_errno;
+
+      if (wfilename == NULL)
+	{
+	  errno = EINVAL;
+	  return NULL;
+	}
+
+      wmode = g_utf8_to_utf16 (mode, -1, NULL, NULL, NULL);
+
+      if (wmode == NULL)
+	{
+	  g_free (wfilename);
+	  errno = EINVAL;
+	  return NULL;
+	}
+
+      retval = _wfreopen (wfilename, wmode, stream);
+      save_errno = errno;
+
+      g_free (wfilename);
+      g_free (wmode);
+
+      errno = save_errno;
+      return retval;
+#else
+  return freopen (filename, mode, stream);
+#endif
+}
+
diff --git a/wsutil/file_util.h b/wsutil/file_util.h
new file mode 100644
index 0000000000..1508ede555
--- /dev/null
+++ b/wsutil/file_util.h
@@ -0,0 +1,126 @@
+/* file_util.h
+ * File utility definitions
+ *
+ * $Id$
+ *
+ * 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
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ */
+
+#ifndef __FILE_UTIL_H__
+#define __FILE_UTIL_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+#include <glib.h>
+
+#ifdef _WIN32
+#include <io.h>
+#endif
+
+#ifdef HAVE_SYS_STAT_H
+#include <sys/stat.h>
+#endif
+
+
+/*  Win32: Since GLib2.6, we use UTF8 throughout the code, so file functions
+ *  must tweak a given filename from UTF8 to UTF16 as we use NT Unicode (Win9x
+ *  - now unsupported - used locale based encoding here).
+ */
+#if defined _WIN32 && GLIB_CHECK_VERSION(2,6,0)
+#include <stdio.h>
+
+extern int ws_stdio_open (const gchar *filename, int flags, int mode);
+extern int ws_stdio_rename (const gchar *oldfilename, const gchar *newfilename);
+extern int ws_stdio_mkdir (const gchar *filename, int mode);
+extern int ws_stdio_stat (const gchar *filename, struct stat *buf);
+extern int ws_stdio_unlink (const gchar *filename);
+extern int ws_stdio_remove (const gchar *filename);
+extern FILE * ws_stdio_fopen (const gchar *filename, const gchar *mode);
+extern FILE * ws_stdio_freopen (const gchar *filename, const gchar *mode, FILE *stream);
+
+#define ws_open	ws_stdio_open
+#define ws_rename	ws_stdio_rename
+#define ws_mkdir	ws_stdio_mkdir
+#define ws_stat	ws_stdio_stat
+#define ws_unlink	ws_stdio_unlink
+#define ws_remove	ws_stdio_remove
+#define ws_fopen	ws_stdio_fopen
+#define ws_freopen	ws_stdio_freopen
+
+#else	/* _WIN32 && GLIB_CHECK_VERSION */
+
+/* GLib 2.4 or below, using "old school" functions */
+#ifdef _WIN32
+#define ws_open		_open
+#define ws_stat		_stat
+#define ws_unlink	_unlink
+#define ws_mkdir(dir,mode)	_mkdir(dir)
+#else
+#define ws_open		open
+#define ws_stat		stat
+#define ws_unlink	unlink
+#define ws_mkdir(dir,mode)	mkdir(dir,mode)
+#endif /* _WIN32 */
+
+#define ws_rename	rename
+#define ws_remove	remove
+#define ws_fopen	fopen
+#define ws_freopen	freopen
+
+#endif	/* _WIN32 && GLIB_CHECK_VERSION */
+
+
+/* some common file function differences between UNIX and WIN32 */
+#ifdef _WIN32
+/* the Win32 API prepends underscores for whatever reasons */
+#define ws_read  _read
+#define ws_write _write
+#define ws_close _close
+#define ws_dup   _dup
+#define ws_lseek _lseek
+#else
+#define ws_read  read
+#define ws_write write
+#define ws_close close
+#define ws_dup   dup
+#define ws_lseek lseek
+#define O_BINARY	0		/* Win32 needs the O_BINARY flag for open() */
+#endif /* _WIN32 */
+
+/* directory handling */
+#define ETH_DIR				GDir
+#define ETH_DIRENT			const char
+#define ws_dir_open			g_dir_open
+#define ws_dir_read_name		g_dir_read_name
+#define ws_dir_get_name(dirent)	dirent
+#define ws_dir_rewind			g_dir_rewind
+#define ws_dir_close			g_dir_close
+
+/* XXX - remove include "dirent.h" */
+/* XXX - remove include "direct.h" */
+/* XXX - remove include "sys/stat.h" */
+/* XXX - update docs (e.g. README.developer) */
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __FILE_UTIL_H__ */
diff --git a/wsutil/libwsutil.def b/wsutil/libwsutil.def
index be1cd2822d..f7735888bb 100644
--- a/wsutil/libwsutil.def
+++ b/wsutil/libwsutil.def
@@ -15,3 +15,12 @@ mpa_layer
 mpa_padding
 mpa_samples
 mpa_version
+
+ws_stdio_open
+ws_stdio_rename
+ws_stdio_mkdir
+ws_stdio_stat
+ws_stdio_unlink
+ws_stdio_remove
+ws_stdio_fopen
+ws_stdio_freopen