Change license from GPLv2+ to GPLv3+.
[pspp-builds.git] / src / data / file-name.c
index 8211e55d5db3a255405d98f16a841b5dc8d0aa2e..2ad3311a2dfb3c2824df8009d18b16f843540bd6 100644 (file)
@@ -1,25 +1,22 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
 
-   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 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 3 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.
+   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., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
 
-#include "file-name.h"
+#include <data/file-name.h>
 
 #include <ctype.h>
 #include <errno.h>
 
 #include "intprops.h"
 #include "minmax.h"
-#include "settings.h"
-#include "xreadlink.h"
+#include "dirname.h"
 
 #include <libpspp/alloc.h>
 #include <libpspp/message.h>
-#include <libpspp/message.h>
+#include <data/settings.h>
 #include <libpspp/str.h>
 #include <libpspp/verbose-msg.h>
 #include <libpspp/version.h>
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-/* PORTME: Everything in this file is system dependent. */
-
-#ifdef unix
-#include <pwd.h>
 #include <unistd.h>
 #include <sys/stat.h>
-#include "stat-macros.h"
-#endif
 
-#ifdef __WIN32__
-#define NOGDI
-#define NOUSER
-#define NONLS
-#include <win32/windows.h>
-#endif
-
-#if __DJGPP__
-#include <sys/stat.h>
+#if defined _WIN32 || defined __WIN32__
+#define WIN32_LEAN_AND_MEAN  /* avoid including junk */
+#include <windows.h>
 #endif
 \f
 /* Initialization. */
@@ -78,7 +62,7 @@ fn_init (void)
    properly handling the case where SRC is a substring of DST.
    Variables are as defined by GETENV. Supports $var and ${var}
    syntaxes; $$ substitutes as $. */
-void 
+void
 fn_interp_vars (struct substring src, const char *(*getenv) (const char *),
                 struct string *dst_)
 {
@@ -86,7 +70,7 @@ fn_interp_vars (struct substring src, const char *(*getenv) (const char *),
   int c;
 
   while ((c = ss_get_char (&src)) != EOF)
-    if (c != '$') 
+    if (c != '$')
       ds_put_char (&dst, c);
     else
       {
@@ -112,84 +96,28 @@ fn_interp_vars (struct substring src, const char *(*getenv) (const char *),
             ds_truncate (&dst, start);
 
             ds_put_cstr (&dst, value);
-          } 
+          }
       }
 
   ds_swap (&dst, dst_);
   ds_destroy (&dst);
 }
 
-#ifdef unix
-/* Expands csh tilde notation from the path INPUT into a malloc()'d
-   returned string. */
-char *
-fn_tilde_expand (const char *input)
-{
-  struct string output = DS_EMPTY_INITIALIZER;
-  if (input[0] == '~')
-    {
-      const char *home = NULL;
-      const char *remainder = NULL;
-      if (input[1] == '/' || input[1] == '\0')
-        {
-          home = fn_getenv ("HOME");
-          remainder = input + 1; 
-        }
-      else
-        {
-          struct string user_name = DS_EMPTY_INITIALIZER;
-          struct passwd *pwd;
-
-          ds_assign_substring (&user_name,
-                               ss_buffer (input + 1,
-                                          strcspn (input + 1, "/")));
-          pwd = getpwnam (ds_cstr (&user_name));
-          if (pwd != NULL && pwd->pw_dir[0] != '\0')
-            {
-              home = pwd->pw_dir;
-              remainder = input + 1 + ds_length (&user_name);
-            }
-          ds_destroy (&user_name);
-        }
-
-      if (home != NULL) 
-        {
-          ds_put_cstr (&output, home);
-          if (*remainder != '\0')
-            ds_put_cstr (&output, remainder);
-        }
-    }
-  if (ds_is_empty (&output))
-    ds_put_cstr (&output, input);
-  return ds_cstr (&output);
-}
-#else /* !unix */
-char *
-fn_tilde_expand (const char *input)
-{
-  return xstrdup (input);
-}
-#endif /* !unix */
-
 /* Searches for a configuration file with name NAME in the path
-   given by PATH, which is tilde- and environment-interpolated.
+   given by PATH, which is environment-interpolated.
    Directories in PATH are delimited by ':'.  Returns the
    malloc'd full name of the first file found, or NULL if none is
-   found.
-
-   If PREFIX is non-NULL, then it is prefixed to each file name;
-   i.e., it looks like PREFIX/PATH_COMPONENT/NAME.  This is not
-   done with absolute directories in the path. */
+   found. */
 char *
-fn_search_path (const char *base_name, const char *path_, const char *prefix)
+fn_search_path (const char *base_name, const char *path_)
 {
   struct string path;
-  struct substring dir_;
+  struct substring dir;
   struct string file = DS_EMPTY_INITIALIZER;
   size_t save_idx = 0;
 
   if (fn_is_absolute (base_name))
-    return fn_tilde_expand (base_name);
+    return xstrdup (base_name);
 
   /* Interpolate environment variables. */
   ds_init_cstr (&path, path_);
@@ -197,31 +125,14 @@ fn_search_path (const char *base_name, const char *path_, const char *prefix)
 
   verbose_msg (2, _("searching for \"%s\" in path \"%s\""),
                base_name, ds_cstr (&path));
-  while (ds_separate (&path, ss_cstr (":"), &save_idx, &dir_))
+  while (ds_separate (&path, ss_cstr (":"), &save_idx, &dir))
     {
-      struct string dir;
-
-      /* Do tilde expansion. */
-      ds_init_substring (&dir, dir_);
-      if (ds_first (&dir) == '~') 
-        {
-          char *tmp_str = fn_tilde_expand (ds_cstr (&dir));
-          ds_assign_cstr (&dir, tmp_str);
-          free (tmp_str); 
-        }
-
       /* Construct file name. */
       ds_clear (&file);
-      if (prefix != NULL && !fn_is_absolute (ds_cstr (&dir)))
-       {
-         ds_put_cstr (&file, prefix);
-         ds_put_char (&file, '/');
-       }
-      ds_put_cstr (&file, ds_cstr (&dir));
-      if (!ds_is_empty (&file) && ds_last (&file) != '/')
+      ds_put_substring (&file, dir);
+      if (!ds_is_empty (&file) && !ISSLASH (ds_last (&file)))
        ds_put_char (&file, '/');
       ds_put_cstr (&file, base_name);
-      ds_destroy (&dir);
 
       /* Check whether file exists. */
       if (fn_exists (ds_cstr (&file)))
@@ -239,214 +150,19 @@ fn_search_path (const char *base_name, const char *path_, const char *prefix)
   return NULL;
 }
 
-/* fn_normalize(): This very OS-dependent routine canonicalizes
-   file name FN1.  The file name should not need to be the name of an
-   existing file.  Returns a malloc()'d copy of the canonical name.
-   This function must always succeed; if it needs to bail out then it
-   should return xstrdup(FN1).  */
-#ifdef unix
-char *
-fn_normalize (const char *file_name)
-{
-  const char *src;
-  char *fn1, *fn2, *dest;
-  int maxlen;
-
-  if (fn_is_special (file_name))
-    return xstrdup (file_name);
-  
-  fn1 = fn_tilde_expand (file_name);
-
-  /* Follow symbolic links. */
-  for (;;)
-    {
-      fn2 = fn1;
-      fn1 = fn_readlink (fn1);
-      if (!fn1)
-       {
-         fn1 = fn2;
-         break;
-       }
-      free (fn2);
-    }
-
-  maxlen = strlen (fn1) * 2;
-  if (maxlen < 31)
-    maxlen = 31;
-  dest = fn2 = xmalloc (maxlen + 1);
-  src = fn1;
-
-  if (*src == '/')
-    *dest++ = *src++;
-  else
-    {
-      errno = 0;
-      while (getcwd (dest, maxlen - (dest - fn2)) == NULL && errno == ERANGE)
-       {
-         maxlen *= 2;
-         dest = fn2 = xrealloc (fn2, maxlen + 1);
-         errno = 0;
-       }
-      if (errno)
-       {
-         free (fn1);
-         free (fn2);
-         return NULL;
-       }
-      dest = strchr (fn2, '\0');
-      if (dest - fn2 >= maxlen)
-       {
-         int ofs = dest - fn2;
-         maxlen *= 2;
-         fn2 = xrealloc (fn2, maxlen + 1);
-         dest = fn2 + ofs;
-       }
-      if (dest[-1] != '/')
-       *dest++ = '/';
-    }
-
-  for (;;)
-    {
-      int c, f;
-
-      c = *src++;
-
-      f = 0;
-      if (c == '/' || c == 0)
-       {
-         /* remove `./', `../' from directory */
-         if (dest[-1] == '.' && dest[-2] == '/')
-           dest--;
-         else if (dest[-1] == '.' && dest[-2] == '.' && dest[-3] == '/')
-           {
-             dest -= 3;
-             if (dest == fn2)
-               dest++;
-             while (dest[-1] != '/')
-               dest--;
-           }
-         else if (dest[-1] != '/')     /* remove extra slashes */
-           f = 1;
-
-         if (c == 0)
-           {
-             if (dest[-1] == '/' && dest > fn2 + 1)
-               dest--;
-             *dest = 0;
-             free (fn1);
-
-             return xrealloc (fn2, strlen (fn2) + 1);
-           }
-       }
-      else
-       f = 1;
-
-      if (f)
-       {
-         if (dest - fn2 >= maxlen)
-           {
-             int ofs = dest - fn2;
-             maxlen *= 2;
-             fn2 = xrealloc (fn2, maxlen + 1);
-             dest = fn2 + ofs;
-           }
-         *dest++ = c;
-       }
-    }
-}
-#elif defined (__WIN32__)
-char *
-fn_normalize (const char *fn1)
-{
-  DWORD len;
-  DWORD success;
-  char *fn2;
-
-  /* Don't change special file names. */
-  if (is_special_file_name (file_name))
-    return xstrdup (file_name);
-
-  /* First find the required buffer length. */
-  len = GetFullPathName (fn1, 0, NULL, NULL);
-  if (!len)
-    {
-      fn2 = xstrdup (fn1);
-      return fn2;
-    }
-
-  /* Then make a buffer that big. */
-  fn2 = xmalloc (len);
-  success = GetFullPathName (fn1, len, fn2, NULL);
-  if (success >= len || success == 0)
-    {
-      free (fn2);
-      fn2 = xstrdup (fn1);
-      return fn2;
-    }
-  return fn2;
-}
-#elif __BORLANDC__
-char *
-fn_normalize (const char *fn1)
-{
-  char *fn2 = _fullpath (NULL, fn1, 0);
-  if (fn2)
-    {
-      char *cp;
-      for (cp = fn2; *cp; cp++)
-       *cp = toupper ((unsigned char) (*cp));
-      return fn2;
-    }
-  return xstrdup (fn1);
-}
-#elif __DJGPP__
-char *
-fn_normalize (const char *fn1)
-{
-  char *fn2 = xmalloc (1024);
-  _fixpath (fn1, fn2);
-  fn2 = xrealloc (fn2, strlen (fn2) + 1);
-  return fn2;
-}
-#else /* not Lose32, Unix, or DJGPP */
-char *
-fn_normalize (const char *fn)
-{
-  return xstrdup (fn);
-}
-#endif /* not Lose32, Unix, or DJGPP */
-
 /* Returns the directory part of FILE_NAME, as a malloc()'d
    string. */
 char *
 fn_dir_name (const char *file_name)
 {
-  const char *p;
-  char *s;
-  size_t len;
-
-  len = strlen (file_name);
-  if (len == 1 && file_name[0] == '/')
-    p = file_name + 1;
-  else if (len && file_name[len - 1] == '/')
-    p = buf_find_reverse (file_name, len - 1, file_name + len - 1, 1);
-  else
-    p = strrchr (file_name, '/');
-  if (p == NULL)
-    p = file_name;
-
-  s = xmalloc (p - file_name + 1);
-  memcpy (s, file_name, p - file_name);
-  s[p - file_name] = 0;
-
-  return s;
+  return dir_name (file_name);
 }
 
 /* Returns the extension part of FILE_NAME as a malloc()'d string.
    If FILE_NAME does not have an extension, returns an empty
    string. */
 char *
-fn_extension (const char *file_name) 
+fn_extension (const char *file_name)
 {
   const char *extension = strrchr (file_name, '.');
   if (extension == NULL)
@@ -454,106 +170,38 @@ fn_extension (const char *file_name)
   return xstrdup (extension);
 }
 \f
-#if unix
-/* Returns the current working directory, as a malloc()'d string.
-   From libc.info. */
-char *
-fn_get_cwd (void)
-{
-  int size = 100;
-  char *buffer = xmalloc (size);
-     
-  for (;;)
-    {
-      char *value = getcwd (buffer, size);
-      if (value != 0)
-       return buffer;
-
-      size *= 2;
-      free (buffer);
-      buffer = xmalloc (size);
-    }
-}
-#else
-char *
-fn_get_cwd (void)
-{
-  int size = 2;
-  char *buffer = xmalloc (size);
-  if ( buffer) 
-    {
-      buffer[0]='.';
-      buffer[1]='\0';
-    }
-
-  return buffer;
-     
-}
-#endif
-\f
 /* Find out information about files. */
 
-/* Returns nonzero iff NAME specifies an absolute file name. */
-int
+/* Returns true iff NAME specifies an absolute file name. */
+bool
 fn_is_absolute (const char *name)
 {
-#ifdef unix
-  if (name[0] == '/'
-      || !strncmp (name, "./", 2)
-      || !strncmp (name, "../", 3)
-      || name[0] == '~')
-    return 1;
-#elif defined (__MSDOS__)
-  if (name[0] == '\\'
-      || !strncmp (name, ".\\", 2)
-      || !strncmp (name, "..\\", 3)
-      || (name[0] && name[1] == ':'))
-    return 1;
-#endif
-  
-  return 0;
+  return IS_ABSOLUTE_FILE_NAME (name);
 }
-  
-/* Returns 1 if FILE_NAME is a virtual file that doesn't
-   really exist on disk, 0 if it's a real file name. */
-int
+
+/* Returns true if FILE_NAME is a virtual file that doesn't
+   really exist on disk, false if it's a real file name. */
+bool
 fn_is_special (const char *file_name)
 {
   if (!strcmp (file_name, "-") || !strcmp (file_name, "stdin")
       || !strcmp (file_name, "stdout") || !strcmp (file_name, "stderr")
-#ifdef unix
+#ifdef HAVE_POPEN
       || file_name[0] == '|'
       || (*file_name && file_name[strlen (file_name) - 1] == '|')
 #endif
       )
-    return 1;
+    return true;
 
-  return 0;
+  return false;
 }
 
-/* Returns nonzero if file with name NAME exists. */
-int
+/* Returns true if file with name NAME exists. */
+bool
 fn_exists (const char *name)
 {
-#ifdef unix
   struct stat temp;
-
   return stat (name, &temp) == 0;
-#else
-  FILE *f = fopen (name, "r");
-  if (!f)
-    return 0;
-  fclose (f);
-  return 1;
-#endif
-}
-
-/* Returns the symbolic link value for FILE_NAME as a dynamically
-   allocated buffer, or a null pointer on failure. */
-char *
-fn_readlink (const char *file_name)
-{
-  return xreadlink (file_name, 32);
 }
 \f
 /* Environment variables. */
@@ -580,6 +228,7 @@ fn_getenv_default (const char *key, const char *def)
 \f
 /* Basic file handling. */
 
+#if HAVE_POPEN
 /* Used for giving an error message on a set_safer security
    violation. */
 static FILE *
@@ -589,6 +238,7 @@ safety_violation (const char *fn)
   errno = EPERM;
   return NULL;
 }
+#endif
 
 /* As a general comment on the following routines, a `sensible value'
    for errno includes 0 if there is no associated system error.  The
@@ -604,14 +254,14 @@ fn_open (const char *fn, const char *mode)
 {
   assert (mode[0] == 'r' || mode[0] == 'w');
 
-  if (mode[0] == 'r' && (!strcmp (fn, "stdin") || !strcmp (fn, "-"))) 
+  if (mode[0] == 'r' && (!strcmp (fn, "stdin") || !strcmp (fn, "-")))
     return stdin;
   else if (mode[0] == 'w' && (!strcmp (fn, "stdout") || !strcmp (fn, "-")))
     return stdout;
   else if (mode[0] == 'w' && !strcmp (fn, "stderr"))
     return stderr;
-  
-#ifdef unix
+
+#if HAVE_POPEN
   if (fn[0] == '|')
     {
       if (get_safer_mode ())
@@ -626,11 +276,11 @@ fn_open (const char *fn, const char *mode)
 
       if (get_safer_mode ())
        return safety_violation (fn);
-      
+
       s = local_alloc (strlen (fn));
       memcpy (s, fn, strlen (fn) - 1);
       s[strlen (fn) - 1] = 0;
-      
+
       f = popen (s, mode);
 
       local_free (s);
@@ -657,7 +307,7 @@ fn_close (const char *fn, FILE *f)
 {
   if (!strcmp (fn, "-"))
     return 0;
-#ifdef unix
+#if HAVE_POPEN
   else if (fn[0] == '|' || (*fn && fn[strlen (fn) - 1] == '|'))
     {
       pclose (f);
@@ -668,9 +318,9 @@ fn_close (const char *fn, FILE *f)
     return fclose (f);
 }
 
-#ifdef unix
+#if !(defined _WIN32 || defined __WIN32__)
 /* A file's identity. */
-struct file_identity 
+struct file_identity
 {
   dev_t device;               /* Device number. */
   ino_t inode;                /* Inode number. */
@@ -681,13 +331,13 @@ struct file_identity
    same file.  Returns a null pointer if no information about the
    file is available, perhaps because it does not exist.  The
    caller is responsible for freeing the structure with
-   fn_free_identity() when finished. */  
+   fn_free_identity() when finished. */
 struct file_identity *
-fn_get_identity (const char *file_name) 
+fn_get_identity (const char *file_name)
 {
   struct stat s;
 
-  if (stat (file_name, &s) == 0) 
+  if (stat (file_name, &s) == 0)
     {
       struct file_identity *identity = xmalloc (sizeof *identity);
       identity->device = s.st_dev;
@@ -700,7 +350,7 @@ fn_get_identity (const char *file_name)
 
 /* Frees IDENTITY obtained from fn_get_identity(). */
 void
-fn_free_identity (struct file_identity *identity) 
+fn_free_identity (struct file_identity *identity)
 {
   free (identity);
 }
@@ -708,7 +358,7 @@ fn_free_identity (struct file_identity *identity)
 /* Compares A and B, returning a strcmp()-type result. */
 int
 fn_compare_file_identities (const struct file_identity *a,
-                            const struct file_identity *b) 
+                            const struct file_identity *b)
 {
   assert (a != NULL);
   assert (b != NULL);
@@ -717,9 +367,9 @@ fn_compare_file_identities (const struct file_identity *a,
   else
     return a->inode < b->inode ? -1 : a->inode > b->inode;
 }
-#else /* not unix */
+#else /* Windows */
 /* A file's identity. */
-struct file_identity 
+struct file_identity
 {
   char *normalized_file_name;  /* File's normalized name. */
 };
@@ -729,20 +379,26 @@ struct file_identity
    same file.  Returns a null pointer if no information about the
    file is available, perhaps because it does not exist.  The
    caller is responsible for freeing the structure with
-   fn_free_identity() when finished. */  
+   fn_free_identity() when finished. */
 struct file_identity *
-fn_get_identity (const char *file_name) 
+fn_get_identity (const char *file_name)
 {
   struct file_identity *identity = xmalloc (sizeof *identity);
-  identity->normalized_file_name = fn_normalize (file_name);
+  char cname[PATH_MAX];
+
+  if (GetFullPathName (file_name, sizeof cname, cname, NULL))
+    identity->normalized_file_name = xstrdup (cname);
+  else
+    identity->normalized_file_name = xstrdup (file_name);
+
   return identity;
 }
 
 /* Frees IDENTITY obtained from fn_get_identity(). */
 void
-fn_free_identity (struct file_identity *identity) 
+fn_free_identity (struct file_identity *identity)
 {
-  if (identity != NULL) 
+  if (identity != NULL)
     {
       free (identity->normalized_file_name);
       free (identity);
@@ -752,8 +408,8 @@ fn_free_identity (struct file_identity *identity)
 /* Compares A and B, returning a strcmp()-type result. */
 int
 fn_compare_file_identities (const struct file_identity *a,
-                            const struct file_identity *b) 
+                            const struct file_identity *b)
 {
-  return strcmp (a->normalized_file_name, b->normalized_file_name);
+  return strcasecmp (a->normalized_file_name, b->normalized_file_name);
 }
-#endif /* not unix */
+#endif /* Windows */