Merge commit 'origin/stable'
[pspp-builds.git] / src / data / file-name.c
index 2e8dd76239922edce1d9e2fa49ef6a76df7fecd5..601afd5579e04a2ffff00193166989aedcd8e3b5 100644 (file)
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000, 2006, 2007 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2006, 2007, 2009 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 <ctype.h>
 #include <errno.h>
+#include <fcntl.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <unistd.h>
 
 #include "intprops.h"
 #include "minmax.h"
 #include "dirname.h"
+#include "xmalloca.h"
 
-#include <libpspp/alloc.h>
-#include <libpspp/message.h>
 #include <data/settings.h>
+#include <libpspp/hash.h>
+#include <libpspp/message.h>
 #include <libpspp/str.h>
 #include <libpspp/verbose-msg.h>
 #include <libpspp/version.h>
 
+#include "xalloc.h"
+
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
@@ -64,7 +67,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_)
 {
@@ -72,7 +75,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
       {
@@ -89,7 +92,7 @@ fn_interp_vars (struct substring src, const char *(*getenv) (const char *),
             else if (ss_match_char (&src, '{'))
               ss_get_until (&src, '}', &var_name);
             else
-              ss_get_chars (&src, MIN (1, ss_span (src, ss_cstr (CC_ALNUM))),
+              ss_get_chars (&src, MAX (1, ss_span (src, ss_cstr (CC_ALNUM))),
                             &var_name);
 
             start = ds_length (&dst);
@@ -98,7 +101,7 @@ fn_interp_vars (struct substring src, const char *(*getenv) (const char *),
             ds_truncate (&dst, start);
 
             ds_put_cstr (&dst, value);
-          } 
+          }
       }
 
   ds_swap (&dst, dst_);
@@ -135,6 +138,7 @@ fn_search_path (const char *base_name, const char *path_)
       if (!ds_is_empty (&file) && !ISSLASH (ds_last (&file)))
        ds_put_char (&file, '/');
       ds_put_cstr (&file, base_name);
+      ds_relocate (&file);
 
       /* Check whether file exists. */
       if (fn_exists (ds_cstr (&file)))
@@ -164,7 +168,7 @@ fn_dir_name (const char *file_name)
    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)
@@ -254,38 +258,38 @@ safety_violation (const char *fn)
 FILE *
 fn_open (const char *fn, const char *mode)
 {
-  assert (mode[0] == 'r' || mode[0] == 'w');
+  assert (mode[0] == 'r' || mode[0] == 'w' || mode[0] == 'a');
 
-  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;
-  
+
 #if HAVE_POPEN
   if (fn[0] == '|')
     {
-      if (get_safer_mode ())
+      if (settings_get_safer_mode ())
        return safety_violation (fn);
 
-      return popen (&fn[1], mode);
+      return popen (&fn[1], mode[0] == 'r' ? "r" : "w");
     }
   else if (*fn && fn[strlen (fn) - 1] == '|')
     {
       char *s;
       FILE *f;
 
-      if (get_safer_mode ())
+      if (settings_get_safer_mode ())
        return safety_violation (fn);
-      
-      s = local_alloc (strlen (fn));
+
+      s = xmalloca (strlen (fn));
       memcpy (s, fn, strlen (fn) - 1);
       s[strlen (fn) - 1] = 0;
-      
-      f = popen (s, mode);
 
-      local_free (s);
+      f = popen (s, mode[0] == 'r' ? "r" : "w");
+
+      freea (s);
 
       return f;
     }
@@ -307,7 +311,9 @@ fn_open (const char *fn, const char *mode)
 int
 fn_close (const char *fn, FILE *f)
 {
-  if (!strcmp (fn, "-"))
+  if (fileno (f) == STDIN_FILENO
+      || fileno (f) == STDOUT_FILENO
+      || fileno (f) == STDERR_FILENO)
     return 0;
 #if HAVE_POPEN
   else if (fn[0] == '|' || (*fn && fn[strlen (fn) - 1] == '|'))
@@ -320,12 +326,48 @@ fn_close (const char *fn, FILE *f)
     return fclose (f);
 }
 
-#if !(defined _WIN32 || defined __WIN32__)
-/* A file's identity. */
-struct file_identity 
+/* Creates a new file named FN with the given PERMISSIONS bits,
+   and returns a stream for it or a null pointer on failure.
+   MODE should be "w" or "wb". */
+FILE *
+create_stream (const char *fn, const char *mode, mode_t permissions)
+{
+  int fd;
+  FILE *stream;
+
+  fd = open (fn, O_WRONLY | O_CREAT | O_TRUNC, permissions);
+  if (fd < 0)
+    return NULL;
+
+  stream = fdopen (fd, mode);
+  if (stream == NULL)
+    {
+      int save_errno = errno;
+      close (fd);
+      errno = save_errno;
+    }
+
+  return stream;
+}
+
+/* A file's identity:
+
+   - For a file that exists, this is its device and inode.
+
+   - For a file that does not exist, but which has a directory
+     name that exists, this is the device and inode of the
+     directory, plus the file's base name.
+
+   - For a file that does not exist and has a nonexistent
+     directory, this is the file name.
+
+   Windows doesn't have inode numbers, so we just use the name
+   there. */
+struct file_identity
 {
   dev_t device;               /* Device number. */
   ino_t inode;                /* Inode number. */
+  char *name;                 /* File name, where needed, otherwise NULL. */
 };
 
 /* Returns a pointer to a dynamically allocated structure whose
@@ -333,85 +375,137 @@ 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;
+  struct file_identity *identity = xmalloc (sizeof *identity);
 
-  if (stat (file_name, &s) == 0) 
+#if !(defined _WIN32 || defined __WIN32__)
+  struct stat s;
+  if (lstat (file_name, &s) == 0)
     {
-      struct file_identity *identity = xmalloc (sizeof *identity);
       identity->device = s.st_dev;
       identity->inode = s.st_ino;
-      return identity;
+      identity->name = NULL;
     }
   else
-    return NULL;
+    {
+      char *dir = dir_name (file_name);
+      if (last_component (file_name) != NULL && stat (dir, &s) == 0)
+        {
+          identity->device = s.st_dev;
+          identity->inode = s.st_ino;
+          identity->name = base_name (file_name);
+        }
+      else
+        {
+          identity->device = 0;
+          identity->inode = 0;
+          identity->name = xstrdup (file_name);
+        }
+      free (dir);
+    }
+#else /* Windows */
+  char cname[PATH_MAX];
+  int ok = GetFullPathName (file_name, sizeof cname, cname, NULL);
+  identity->device = 0;
+  identity->inode = 0;
+  identity->name = xstrdup (ok ? cname : file_name);
+  str_lowercase (identity->name);
+#endif /* Windows */
+
+  return identity;
 }
 
 /* Frees IDENTITY obtained from fn_get_identity(). */
 void
-fn_free_identity (struct file_identity *identity) 
+fn_free_identity (struct file_identity *identity)
 {
-  free (identity);
+  if (identity != NULL)
+    {
+      free (identity->name);
+      free (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);
   if (a->device != b->device)
     return a->device < b->device ? -1 : 1;
+  else if (a->inode != b->inode)
+    return a->inode < b->inode ? -1 : 1;
+  else if (a->name != NULL)
+    return b->name != NULL ? strcmp (a->name, b->name) : 1;
   else
-    return a->inode < b->inode ? -1 : a->inode > b->inode;
+    return b->name != NULL ? -1 : 0;
 }
-#else /* Windows */
-/* A file's identity. */
-struct file_identity 
-{
-  char *normalized_file_name;  /* File's normalized name. */
-};
 
-/* Returns a pointer to a dynamically allocated structure whose
-   value can be used to tell whether two files are actually the
-   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. */  
-struct file_identity *
-fn_get_identity (const char *file_name) 
+/* Returns a hash value for IDENTITY. */
+unsigned int
+fn_hash_identity (const struct file_identity *identity)
 {
-  struct file_identity *identity = xmalloc (sizeof *identity);
-  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;
+  unsigned int hash = hash_int (identity->device, identity->inode);
+  if (identity->name != NULL)
+    hash = hash_string (identity->name, hash);
+  return hash;
 }
 
-/* Frees IDENTITY obtained from fn_get_identity(). */
-void
-fn_free_identity (struct file_identity *identity) 
+#ifdef WIN32
+
+/* Apparently windoze users like to see output dumped into their home directory,
+   not the current directory (!) */
+const char *
+default_output_path (void)
 {
-  if (identity != NULL) 
+  static char *path = NULL;
+
+  if ( path == NULL)
     {
-      free (identity->normalized_file_name);
-      free (identity);
+      /* Windows NT defines HOMEDRIVE and HOMEPATH.  But give preference
+        to HOME, because the user can change HOME.  */
+
+      const char *home_dir = getenv ("HOME");
+      int i;
+
+      if (home_dir == NULL)
+       {
+         const char *home_drive = getenv ("HOMEDRIVE");
+         const char *home_path = getenv ("HOMEPATH");
+
+
+         if (home_drive != NULL && home_path != NULL)
+           home_dir = xasprintf ("%s%s",
+                                 home_drive, home_path);
+       }
+
+      if (home_dir == NULL)
+       home_dir = "c:/users/default"; /* poor default */
+
+      path = xasprintf ("%s%c", home_dir, '/');
+
+
+      for(i = 0; i < strlen (path); i++)
+       if (path[i] == '\\') path[i] = '/';
     }
+
+  return path;
 }
 
-/* Compares A and B, returning a strcmp()-type result. */
-int
-fn_compare_file_identities (const struct file_identity *a,
-                            const struct file_identity *b) 
+#else
+
+/* ... whereas the rest of the world just likes it to be
+   put "here" for easy access. */
+const char *
+default_output_path (void)
 {
-  return strcasecmp (a->normalized_file_name, b->normalized_file_name);
+  static char current_dir[]  = "";
+
+  return current_dir;
 }
-#endif /* Windows */
+
+#endif
+