* lib/stdint_.h (uintmax_t): Fix typo: int64_t -> uint64_t.
[gnulib.git] / lib / clean-temp.c
index 12b9b6c..aa82974 100644 (file)
@@ -23,6 +23,7 @@
 #include "clean-temp.h"
 
 #include <errno.h>
+#include <fcntl.h>
 #include <limits.h>
 #include <stdbool.h>
 #include <stdlib.h>
 #include "xallocsa.h"
 #include "gl_linkedhash_list.h"
 #include "gettext.h"
+#if GNULIB_FWRITEERROR
+# include "fwriteerror.h"
+#endif
+#if GNULIB_CLOSE_STREAM
+# include "close-stream.h"
+#endif
+#if GNULIB_FCNTL_SAFER
+# include "fcntl--.h"
+#endif
+#if GNULIB_FOPEN_SAFER
+# include "stdio--.h"
+#endif
 
 #define _(str) gettext (str)
 
@@ -141,8 +154,8 @@ static gl_list_t /* <int> */ volatile descriptors;
 static bool
 string_equals (const void *x1, const void *x2)
 {
-  const char *s1 = x1;
-  const char *s2 = x2;
+  const char *s1 = (const char *) x1;
+  const char *s2 = (const char *) x2;
   return strcmp (s1, s2) == 0;
 }
 
@@ -154,7 +167,7 @@ string_equals (const void *x1, const void *x2)
 static size_t
 string_hash (const void *x)
 {
-  const char *s = x;
+  const char *s = (const char *) x;
   size_t h = 0;
 
   for (; *s; s++)
@@ -238,7 +251,7 @@ create_temp_dir (const char *prefix, const char *parentdir,
   struct tempdir * volatile *tmpdirp = NULL;
   struct tempdir *tmpdir;
   size_t i;
-  char *template;
+  char *xtemplate;
   char *tmpdirname;
 
   /* See whether it can take the slot of an earlier temporary directory
@@ -260,8 +273,7 @@ create_temp_dir (const char *prefix, const char *parentdir,
          size_t old_allocated = cleanup_list.tempdir_allocated;
          size_t new_allocated = 2 * cleanup_list.tempdir_allocated + 1;
          struct tempdir * volatile *new_array =
-           (struct tempdir * volatile *)
-           xmalloc (new_allocated * sizeof (struct tempdir * volatile));
+           XNMALLOC (new_allocated, struct tempdir * volatile);
 
          if (old_allocated == 0)
            /* First use of this facility.  Register the cleanup handler.  */
@@ -293,7 +305,7 @@ create_temp_dir (const char *prefix, const char *parentdir,
     }
 
   /* Initialize a 'struct tempdir'.  */
-  tmpdir = (struct tempdir *) xmalloc (sizeof (struct tempdir));
+  tmpdir = XMALLOC (struct tempdir);
   tmpdir->dirname = NULL;
   tmpdir->cleanup_verbose = cleanup_verbose;
   tmpdir->subdirs = gl_list_create_empty (GL_LINKEDHASH_LIST,
@@ -302,15 +314,15 @@ create_temp_dir (const char *prefix, const char *parentdir,
                                        string_equals, string_hash, false);
 
   /* Create the temporary directory.  */
-  template = (char *) xallocsa (PATH_MAX);
-  if (path_search (template, PATH_MAX, parentdir, prefix, parentdir == NULL))
+  xtemplate = (char *) xallocsa (PATH_MAX);
+  if (path_search (xtemplate, PATH_MAX, parentdir, prefix, parentdir == NULL))
     {
       error (0, errno,
             _("cannot find a temporary directory, try setting $TMPDIR"));
       goto quit;
     }
   block_fatal_signals ();
-  tmpdirname = mkdtemp (template);
+  tmpdirname = mkdtemp (xtemplate);
   if (tmpdirname != NULL)
     {
       tmpdir->dirname = tmpdirname;
@@ -321,7 +333,7 @@ create_temp_dir (const char *prefix, const char *parentdir,
     {
       error (0, errno,
             _("cannot create a temporary directory using template \"%s\""),
-            template);
+            xtemplate);
       goto quit;
     }
   /* Replace tmpdir->dirname with a copy that has indefinite extent.
@@ -329,11 +341,11 @@ create_temp_dir (const char *prefix, const char *parentdir,
      block because then the cleanup handler would not remove the directory
      if xstrdup fails.  */
   tmpdir->dirname = xstrdup (tmpdirname);
-  freesa (template);
+  freesa (xtemplate);
   return (struct temp_dir *) tmpdir;
 
  quit:
-  freesa (template);
+  freesa (xtemplate);
   return NULL;
 }
 
@@ -408,48 +420,70 @@ unregister_temp_subdir (struct temp_dir *dir,
     }
 }
 
-/* Remove a file, with optional error message.  */
-static void
+/* Remove a file, with optional error message.
+   Return 0 upon success, or -1 if there was some problem.  */
+static int
 do_unlink (struct temp_dir *dir, const char *absolute_file_name)
 {
   if (unlink (absolute_file_name) < 0 && dir->cleanup_verbose
       && errno != ENOENT)
-    error (0, errno, _("cannot remove temporary file %s"), absolute_file_name);
+    {
+      error (0, errno, _("cannot remove temporary file %s"), absolute_file_name);
+      return -1;
+    }
+  return 0;
 }
 
-/* Remove a directory, with optional error message.  */
-static void
+/* Remove a directory, with optional error message.
+   Return 0 upon success, or -1 if there was some problem.  */
+static int
 do_rmdir (struct temp_dir *dir, const char *absolute_dir_name)
 {
   if (rmdir (absolute_dir_name) < 0 && dir->cleanup_verbose
       && errno != ENOENT)
-    error (0, errno,
-          _("cannot remove temporary directory %s"), absolute_dir_name);
+    {
+      error (0, errno,
+            _("cannot remove temporary directory %s"), absolute_dir_name);
+      return -1;
+    }
+  return 0;
 }
 
-/* Remove the given ABSOLUTE_FILE_NAME and unregister it.  */
-void
+/* Remove the given ABSOLUTE_FILE_NAME and unregister it.
+   Return 0 upon success, or -1 if there was some problem.  */
+int
 cleanup_temp_file (struct temp_dir *dir,
                   const char *absolute_file_name)
 {
-  do_unlink (dir, absolute_file_name);
+  int err;
+
+  err = do_unlink (dir, absolute_file_name);
   unregister_temp_file (dir, absolute_file_name);
+
+  return err;
 }
 
-/* Remove the given ABSOLUTE_DIR_NAME and unregister it.  */
-void
+/* Remove the given ABSOLUTE_DIR_NAME and unregister it.
+   Return 0 upon success, or -1 if there was some problem.  */
+int
 cleanup_temp_subdir (struct temp_dir *dir,
                     const char *absolute_dir_name)
 {
-  do_rmdir (dir, absolute_dir_name);
+  int err;
+
+  err = do_rmdir (dir, absolute_dir_name);
   unregister_temp_subdir (dir, absolute_dir_name);
+
+  return err;
 }
 
-/* Remove all registered files and subdirectories inside DIR.  */
-void
+/* Remove all registered files and subdirectories inside DIR.
+   Return 0 upon success, or -1 if there was some problem.  */
+int
 cleanup_temp_dir_contents (struct temp_dir *dir)
 {
   struct tempdir *tmpdir = (struct tempdir *)dir;
+  int err = 0;
   gl_list_t list;
   gl_list_iterator_t iter;
   const void *element;
@@ -462,7 +496,7 @@ cleanup_temp_dir_contents (struct temp_dir *dir)
     {
       char *file = (char *) element;
 
-      do_unlink (dir, file);
+      err |= do_unlink (dir, file);
       gl_list_remove_node (list, node);
       /* Now only we can free file.  */
       free (file);
@@ -476,24 +510,28 @@ cleanup_temp_dir_contents (struct temp_dir *dir)
     {
       char *subdir = (char *) element;
 
-      do_rmdir (dir, subdir);
+      err |= do_rmdir (dir, subdir);
       gl_list_remove_node (list, node);
       /* Now only we can free subdir.  */
       free (subdir);
     }
   gl_list_iterator_free (&iter);
+
+  return err;
 }
 
 /* Remove all registered files and subdirectories inside DIR and DIR itself.
-   DIR cannot be used any more after this call.  */
-void
+   DIR cannot be used any more after this call.
+   Return 0 upon success, or -1 if there was some problem.  */
+int
 cleanup_temp_dir (struct temp_dir *dir)
 {
   struct tempdir *tmpdir = (struct tempdir *)dir;
+  int err = 0;
   size_t i;
 
-  cleanup_temp_dir_contents (dir);
-  do_rmdir (dir, tmpdir->dirname);
+  err |= cleanup_temp_dir_contents (dir);
+  err |= do_rmdir (dir, tmpdir->dirname);
 
   for (i = 0; i < cleanup_list.tempdir_count; i++)
     if (cleanup_list.tempdir_list[i] == tmpdir)
@@ -510,7 +548,7 @@ cleanup_temp_dir (struct temp_dir *dir)
        /* Now only we can free the tmpdir->dirname and tmpdir itself.  */
        free (tmpdir->dirname);
        free (tmpdir);
-       return;
+       return err;
       }
 
   /* The user passed an invalid DIR argument.  */
@@ -553,7 +591,7 @@ open_temp (const char *file_name, int flags, mode_t mode)
   int saved_errno;
 
   block_fatal_signals ();
-  fd = open (file_name, flags, mode);
+  fd = open (file_name, flags, mode); /* actually open or open_safer */
   saved_errno = errno;
   if (fd >= 0)
     register_fd (fd);
@@ -571,7 +609,7 @@ fopen_temp (const char *file_name, const char *mode)
   int saved_errno;
 
   block_fatal_signals ();
-  fp = fopen (file_name, mode);
+  fp = fopen (file_name, mode); /* actually fopen or fopen_safer */
   saved_errno = errno;
   if (fp != NULL)
     {
@@ -653,3 +691,25 @@ fwriteerror_temp (FILE *fp)
   return result;
 }
 #endif
+
+#if GNULIB_CLOSE_STREAM
+/* Like close_stream.
+   Unregisters the previously registered file descriptor.  */
+int
+close_stream_temp (FILE *fp)
+{
+  int fd = fileno (fp);
+  /* No blocking of signals is needed here, since a double close of a
+     file descriptor is harmless.  */
+  int result = close_stream (fp);
+  int saved_errno = errno;
+
+  /* No race condition here: we assume a single-threaded program, hence
+     fd cannot be re-opened here.  */
+
+  unregister_fd (fd);
+
+  errno = saved_errno;
+  return result;
+}
+#endif