fbuf: New data structure for buffered file I/O.
[pspp] / src / data / make-file.c
index f163d5e7737c0b6cf8e591b385d3cbd128edd36e..a5b68051ac4d6a6c431a9bded84e02a707a29bff 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2010 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2010, 2015 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
@@ -17,6 +17,7 @@
 #include <config.h>
 
 #include "data/make-file.h"
+#include "libpspp/i18n.h"
 
 #include <assert.h>
 #include <errno.h>
@@ -28,6 +29,7 @@
 #include <unistd.h>
 
 #include "data/file-name.h"
+#include "data/file-handle-def.h"
 #include "libpspp/ll.h"
 #include "libpspp/message.h"
 
 #include "gl/tempname.h"
 #include "gl/xalloc.h"
 #include "gl/xvasprintf.h"
+#include "gl/localcharset.h"
 
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-/* Non ansi compilers may set this */
-#ifndef P_tmpdir
-#define P_tmpdir "/tmp"
-#endif
 
-/* Creates a temporary file and stores its name in *FILE_NAME and
-   a file descriptor for it in *FD.  Returns success.  Caller is
-   responsible for freeing *FILE_NAME. */
-int
-make_temp_file (int *fd, char **file_name)
-{
-  const char *parent_dir;
+#if defined _WIN32 || defined __WIN32__
+#define WIN32_LEAN_AND_MEAN  /* avoid including junk */
+#include <windows.h>
+#define TS_stat _stat
+#define Tunlink _wunlink
+#define Topen _wopen
+#define Tstat _wstat
 
-  assert (file_name != NULL);
-  assert (fd != NULL);
+/* Shamelessly lifted and modified from the rpl_rename function in Gnulib */
+static int
+Trename (TCHAR const *src, TCHAR const *dst)
+{
+  int error;
+
+  /* MoveFileExW works if SRC is a directory without any flags, but
+     fails with MOVEFILE_REPLACE_EXISTING, so try without flags first.
+     Thankfully, MoveFileExW handles hard links correctly, even though
+     rename() does not.  */
+  if (MoveFileExW (src, dst, 0))
+    return 0;
+
+  /* Retry with MOVEFILE_REPLACE_EXISTING if the move failed
+     due to the destination already existing.  */
+  error = GetLastError ();
+  if (error == ERROR_FILE_EXISTS || error == ERROR_ALREADY_EXISTS)
+    {
+      if (MoveFileExW (src, dst, MOVEFILE_REPLACE_EXISTING))
+        return 0;
 
-  if (getenv ("TMPDIR") != NULL)
-    parent_dir = getenv ("TMPDIR");
-  else
-    parent_dir = P_tmpdir;
+      error = GetLastError ();
+    }
 
-  *file_name = xmalloc (strlen (parent_dir) + 32);
-  sprintf (*file_name, "%s/psppXXXXXX", parent_dir);
-  *fd = mkstemp (*file_name);
-  if (*fd < 0)
+  switch (error)
     {
-      msg (ME, _("%s: Creating temporary file: %s."),
-           *file_name, strerror (errno));
-      free (*file_name);
-      *file_name = NULL;
-      return 0;
+    case ERROR_FILE_NOT_FOUND:
+    case ERROR_PATH_NOT_FOUND:
+    case ERROR_BAD_PATHNAME:
+    case ERROR_DIRECTORY:
+      errno = ENOENT;
+      break;
+
+    case ERROR_ACCESS_DENIED:
+    case ERROR_SHARING_VIOLATION:
+      errno = EACCES;
+      break;
+
+    case ERROR_OUTOFMEMORY:
+      errno = ENOMEM;
+      break;
+
+    case ERROR_CURRENT_DIRECTORY:
+      errno = EBUSY;
+      break;
+
+    case ERROR_NOT_SAME_DEVICE:
+      errno = EXDEV;
+      break;
+
+    case ERROR_WRITE_PROTECT:
+      errno = EROFS;
+      break;
+
+    case ERROR_WRITE_FAULT:
+    case ERROR_READ_FAULT:
+    case ERROR_GEN_FAILURE:
+      errno = EIO;
+      break;
+
+    case ERROR_HANDLE_DISK_FULL:
+    case ERROR_DISK_FULL:
+    case ERROR_DISK_TOO_FRAGMENTED:
+      errno = ENOSPC;
+      break;
+
+    case ERROR_FILE_EXISTS:
+    case ERROR_ALREADY_EXISTS:
+      errno = EEXIST;
+      break;
+
+    case ERROR_BUFFER_OVERFLOW:
+    case ERROR_FILENAME_EXCED_RANGE:
+      errno = ENAMETOOLONG;
+      break;
+
+    case ERROR_INVALID_NAME:
+    case ERROR_DELETE_PENDING:
+      errno = EPERM;        /* ? */
+      break;
+
+# ifndef ERROR_FILE_TOO_LARGE
+/* This value is documented but not defined in all versions of windows.h.  */
+#  define ERROR_FILE_TOO_LARGE 223
+# endif
+    case ERROR_FILE_TOO_LARGE:
+      errno = EFBIG;
+      break;
+
+    default:
+      errno = EINVAL;
+      break;
     }
-  return 1;
-}
 
+  return -1;
+}
 
-/* Creates a temporary file and stores its name in *FILE_NAME and
-   a file stream for it in *FP.  Returns success.  Caller is
-   responsible for freeing *FILE_NAME and for closing *FP */
-int
-make_unique_file_stream (FILE **fp, char **file_name)
+TCHAR *
+convert_to_filename_encoding (const char *s, size_t len, const char *current_encoding)
 {
-  static int serial = 0;
-  const char *parent_dir;
-
-
-  /* FIXME:
-     Need to check for pre-existing file name.
-     Need also to pass in the directory instead of using /tmp
-  */
-
-  assert (file_name != NULL);
-  assert (fp != NULL);
+  const char *enc = current_encoding;
+  if (NULL == enc || 0 == strcmp (enc, "Auto"))
+    enc = locale_charset ();
 
-  if (getenv ("TMPDIR") != NULL)
-    parent_dir = getenv ("TMPDIR");
-  else
-    parent_dir = P_tmpdir;
+  return (TCHAR *) recode_string ("UTF-16LE", enc, s, len);
+}
 
-  *file_name = xmalloc (strlen (parent_dir) + 32);
 
+#else
+#define TS_stat stat
+#define Trename rename
+#define Tunlink unlink
+#define Topen open
+#define Tstat stat
 
-  sprintf (*file_name, "%s/pspp%d.png", parent_dir, serial++);
+TCHAR *
+convert_to_filename_encoding (const char *s, size_t len UNUSED, const char *current_encoding UNUSED)
+{
+  /* Non-windows systems don't care about the encoding.
+     The string is copied here, to be consistent with the w32 case.  */
+  return xstrdup (s);
+}
 
-  *fp = fopen(*file_name, "w");
+#endif
 
-  if (! *fp )
-    {
-      msg (ME, _("%s: Creating file: %s."), *file_name, strerror (errno));
-      free (*file_name);
-      *file_name = NULL;
-      return 0;
-    }
 
-  return 1;
-}
-\f
 struct replace_file
-  {
-    struct ll ll;
-    char *file_name;
-    char *tmp_name;
-  };
+{
+  struct ll ll;
+  TCHAR *file_name;
+  TCHAR *tmp_name;
+
+  char *tmp_name_verbatim;
+  const char *file_name_verbatim;
+};
 
 static struct ll_list all_files = LL_INITIALIZER (all_files);
 
@@ -129,42 +193,36 @@ static void free_replace_file (struct replace_file *);
 static void unlink_replace_files (void);
 
 struct replace_file *
-replace_file_start (const char *file_name, const char *mode,
-                    mode_t permissions, FILE **fp, char **tmp_name)
+replace_file_start_fd (const struct file_handle *fh,
+                       bool binary, mode_t permissions, int *fd)
 {
   static bool registered;
-  struct stat s;
+  struct TS_stat s;
   struct replace_file *rf;
-  int fd;
+  int saved_errno = errno;
+
+  const char *file_name = fh_get_file_name (fh);
+
+  TCHAR * Tfile_name = convert_to_filename_encoding (file_name, strlen (file_name), fh_get_file_name_encoding (fh));
 
   /* If FILE_NAME represents a special file, write to it directly
      instead of trying to replace it. */
-  if (stat (file_name, &s) == 0 && !S_ISREG (s.st_mode))
+  if (Tstat (Tfile_name, &s) == 0 && !S_ISREG (s.st_mode))
     {
       /* Open file descriptor. */
-      fd = open (file_name, O_WRONLY);
-      if (fd < 0)
+      *fd = Topen (Tfile_name, O_WRONLY);
+      if (*fd < 0)
         {
+         saved_errno = errno;
           msg (ME, _("Opening %s for writing: %s."),
-               file_name, strerror (errno));
-          return NULL;
-        }
-
-      /* Open file as stream. */
-      *fp = fdopen (fd, mode);
-      if (*fp == NULL)
-        {
-          msg (ME, _("Opening stream for %s: %s."),
-               file_name, strerror (errno));
-          close (fd);
+               file_name, strerror (saved_errno));
+         free (Tfile_name);
           return NULL;
         }
 
-      rf = xmalloc (sizeof *rf);
+      rf = xzalloc (sizeof *rf);
       rf->file_name = NULL;
-      rf->tmp_name = xstrdup (file_name);
-      if (tmp_name != NULL)
-        *tmp_name = rf->tmp_name;
+      rf->tmp_name = Tfile_name;
       return rf;
     }
 
@@ -175,59 +233,84 @@ replace_file_start (const char *file_name, const char *mode,
     }
   block_fatal_signals ();
 
-  rf = xmalloc (sizeof *rf);
-  rf->file_name = xstrdup (file_name);
+  rf = xzalloc (sizeof *rf);
+  rf->file_name = Tfile_name;
+  rf->file_name_verbatim = file_name;
+
   for (;;)
     {
       /* Generate unique temporary file name. */
-      rf->tmp_name = xasprintf ("%s.tmpXXXXXX", file_name);
-      if (gen_tempname (rf->tmp_name, 0, 0600, GT_NOCREATE) < 0)
+      free (rf->tmp_name_verbatim);
+      rf->tmp_name_verbatim = xasprintf ("%stmpXXXXXX", file_name);
+      if (gen_tempname (rf->tmp_name_verbatim, 0, 0600, GT_NOCREATE) < 0)
         {
+         saved_errno = errno;
           msg (ME, _("Creating temporary file to replace %s: %s."),
-               rf->file_name, strerror (errno));
+               file_name, strerror (saved_errno));
           goto error;
         }
 
+      rf->tmp_name = convert_to_filename_encoding (rf->tmp_name_verbatim, strlen (rf->tmp_name_verbatim), fh_get_file_name_encoding (fh));
+
       /* Create file by that name. */
-      fd = open (rf->tmp_name, O_WRONLY | O_CREAT | O_EXCL | O_BINARY, permissions);
-      if (fd >= 0)
+      int flags = O_WRONLY | O_CREAT | O_EXCL | (binary ? O_BINARY : O_TEXT);
+      *fd = Topen (rf->tmp_name, flags, permissions);
+      if (*fd >= 0)
         break;
       if (errno != EEXIST)
         {
+         saved_errno = errno;
           msg (ME, _("Creating temporary file %s: %s."),
-               rf->tmp_name, strerror (errno));
+               rf->tmp_name_verbatim, strerror (saved_errno));
           goto error;
         }
-      free (rf->tmp_name);
     }
 
 
+  /* Register file for deletion. */
+  ll_push_head (&all_files, &rf->ll);
+  unblock_fatal_signals ();
+
+  return rf;
+
+ error:
+  unblock_fatal_signals ();
+  free_replace_file (rf);
+  *fd = -1;
+  errno = saved_errno;
+  return NULL;
+}
+
+struct replace_file *
+replace_file_start (const struct file_handle *fh, bool binary,
+                    mode_t permissions, FILE **fp)
+{
+  struct replace_file *rf;
+  int fd;
+
+  /* Open fd. */
+  rf = replace_file_start_fd (fh, binary, permissions, &fd);
+  if (!rf)
+    goto error;
+
   /* Open file as stream. */
-  *fp = fdopen (fd, mode);
+  *fp = fdopen (fd, binary ? "wb" : "w");
   if (*fp == NULL)
     {
+      int error = errno;
       msg (ME, _("Opening stream for temporary file %s: %s."),
-           rf->tmp_name, strerror (errno));
+           rf->tmp_name_verbatim, strerror (error));
       close (fd);
-      unlink (rf->tmp_name);
+      replace_file_abort (rf);
+      errno = error;
+
       goto error;
     }
 
-  /* Register file for deletion. */
-  ll_push_head (&all_files, &rf->ll);
-  unblock_fatal_signals ();
-
-  if (tmp_name != NULL)
-    *tmp_name = rf->tmp_name;
-
   return rf;
 
 error:
-  unblock_fatal_signals ();
-  free_replace_file (rf);
   *fp = NULL;
-  if (tmp_name != NULL)
-    *tmp_name = NULL;
   return NULL;
 }
 
@@ -241,14 +324,14 @@ replace_file_commit (struct replace_file *rf)
       int save_errno;
 
       block_fatal_signals ();
-      ok = rename (rf->tmp_name, rf->file_name) == 0;
+      ok = Trename (rf->tmp_name, rf->file_name) == 0;
       save_errno = errno;
       ll_remove (&rf->ll);
       unblock_fatal_signals ();
 
       if (!ok)
         msg (ME, _("Replacing %s by %s: %s."),
-             rf->tmp_name, rf->file_name, strerror (save_errno));
+             rf->file_name_verbatim, rf->tmp_name_verbatim, strerror (save_errno));
     }
   else
     {
@@ -269,13 +352,13 @@ replace_file_abort (struct replace_file *rf)
       int save_errno;
 
       block_fatal_signals ();
-      ok = unlink (rf->tmp_name) == 0;
+      ok = Tunlink (rf->tmp_name) == 0;
       save_errno = errno;
       ll_remove (&rf->ll);
       unblock_fatal_signals ();
 
       if (!ok)
-        msg (ME, _("Removing %s: %s."), rf->tmp_name, strerror (save_errno));
+        msg (ME, _("Removing %s: %s."), rf->tmp_name_verbatim, strerror (save_errno));
     }
   else
     {
@@ -291,6 +374,7 @@ free_replace_file (struct replace_file *rf)
 {
   free (rf->file_name);
   free (rf->tmp_name);
+  free (rf->tmp_name_verbatim);
   free (rf);
 }
 
@@ -304,8 +388,7 @@ unlink_replace_files (void)
     {
       /* We don't free_replace_file(RF) because calling free is unsafe
          from an asynchronous signal handler. */
-      unlink (rf->tmp_name);
-      fflush (stdout);
+      Tunlink (rf->tmp_name);
     }
   unblock_fatal_signals ();
 }