openat: detect Solaris fchownat bug
[pspp] / lib / canonicalize.c
index 9e8947003083032a27884e421f5c8fa2a047db17..65e73a703b286e62af10d1920d5644c77ff0df91 100644 (file)
@@ -1,10 +1,10 @@
 /* Return the canonical absolute name of a given file.
-   Copyright (C) 1996-2005 Free Software Foundation, Inc.
+   Copyright (C) 1996-2009 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or modify
+   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, or (at your option)
-   any later version.
+   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
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.
-   If not, write to the Free Software Foundation,
-   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-#ifdef STDC_HEADERS
-# include <stdlib.h>
-#else
-void free ();
-#endif
-
-#if defined STDC_HEADERS || defined HAVE_STRING_H
-# include <string.h>
-#else
-# include <strings.h>
-#endif
-
-#if HAVE_SYS_PARAM_H
-# include <sys/param.h>
-#endif
-
-#include <sys/stat.h>
+#include <config.h>
 
-#if HAVE_UNISTD_H
-# include <unistd.h>
-#endif
+#include "canonicalize.h"
 
 #include <errno.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <unistd.h>
 
-#include "cycle-check.h"
-#include "path-concat.h"
-#include "stat-macros.h"
+#include "areadlink.h"
+#include "file-set.h"
+#include "hash-triple.h"
+#include "pathmax.h"
 #include "xalloc.h"
 #include "xgetcwd.h"
 
-#ifndef __set_errno
-# define __set_errno(Val) errno = (Val)
-#endif
-
-/* If __PTRDIFF_TYPE__ is
-   defined, as with GNU C, use that; that way we don't pollute the
-   namespace with <stddef.h>'s symbols.  Otherwise, if <stddef.h> is
-   available, include it and use ptrdiff_t.  In traditional C, long is
-   the best that we can do.  */
-
-#ifdef __PTRDIFF_TYPE__
-# define PTR_INT_TYPE __PTRDIFF_TYPE__
-#else
-# ifdef HAVE_STDDEF_H
-#  include <stddef.h>
-#  define PTR_INT_TYPE ptrdiff_t
-# else
-#  define PTR_INT_TYPE long
-# endif
+#ifndef DOUBLE_SLASH_IS_DISTINCT_ROOT
+# define DOUBLE_SLASH_IS_DISTINCT_ROOT 0
 #endif
 
-#include "canonicalize.h"
-#include "pathmax.h"
-#include "xreadlink.h"
-
-#if !HAVE_CANONICALIZE_FILE_NAME
+#if !((HAVE_CANONICALIZE_FILE_NAME && FUNC_REALPATH_WORKS)     \
+      || GNULIB_CANONICALIZE_LGPL)
 /* Return the canonical absolute name of file NAME.  A canonical name
-   does not contain any `.', `..' components nor any repeated path
-   separators ('/') or symlinks.  All path components must exist.
+   does not contain any `.', `..' components nor any repeated file name
+   separators ('/') or symlinks.  All components must exist.
    The result is malloc'd.  */
 
 char *
 canonicalize_file_name (const char *name)
 {
-# if HAVE_RESOLVEPATH
-
-  char *resolved, *extra_buf = NULL;
-  size_t resolved_size;
-  ssize_t resolved_len;
-
-  if (name == NULL)
-    {
-      __set_errno (EINVAL);
-      return NULL;
-    }
-
-  if (name[0] == '\0')
-    {
-      __set_errno (ENOENT);
-      return NULL;
-    }
-
-  /* All known hosts with resolvepath (e.g. Solaris 7) don't turn
-     relative names into absolute ones, so prepend the working
-     directory if the path is not absolute.  */
-  if (name[0] != '/')
-    {
-      char *wd;
-
-      if (!(wd = xgetcwd ()))
-       return NULL;
-
-      extra_buf = path_concat (wd, name, NULL);
-      name = extra_buf;
-      free (wd);
-    }
+  return canonicalize_filename_mode (name, CAN_EXISTING);
+}
+#endif /* !HAVE_CANONICALIZE_FILE_NAME */
 
-  resolved_size = strlen (name);
-  while (1)
+/* Return true if we've already seen the triple, <FILENAME, dev, ino>.
+   If *HT is not initialized, initialize it.  */
+static bool
+seen_triple (Hash_table **ht, char const *filename, struct stat const *st)
+{
+  if (*ht == NULL)
     {
-      resolved_size = 2 * resolved_size + 1;
-      resolved = xmalloc (resolved_size);
-      resolved_len = resolvepath (name, resolved, resolved_size);
-      if (resolved_len < 0)
-       {
-         free (resolved);
-         free (extra_buf);
-         return NULL;
-       }
-      if (resolved_len < resolved_size)
-       break;
-      free (resolved);
+      size_t initial_capacity = 7;
+      *ht = hash_initialize (initial_capacity,
+                           NULL,
+                           triple_hash,
+                           triple_compare_ino_str,
+                           triple_free);
+      if (*ht == NULL)
+       xalloc_die ();
     }
 
-  free (extra_buf);
-
-  /* NUL-terminate the resulting name.  */
-  resolved[resolved_len] = '\0';
-
-  return resolved;
-
-# else
-
-  return canonicalize_filename_mode (name, CAN_EXISTING);
+  if (seen_file (*ht, filename, st))
+    return true;
 
-# endif /* !HAVE_RESOLVEPATH */
+  record_file (*ht, filename, st);
+  return false;
 }
-#endif /* !HAVE_CANONICALIZE_FILE_NAME */
 
-/* Return the canonical absolute name of file NAME.  A canonical name
-   does not contain any `.', `..' components nor any repeated path
-   separators ('/') or symlinks.  Whether path components must exist
+/* Return the canonical absolute name of file NAME, while treating
+   missing elements according to CAN_MODE.  A canonical name
+   does not contain any `.', `..' components nor any repeated file name
+   separators ('/') or symlinks.  Whether components must exist
    or not depends on canonicalize mode.  The result is malloc'd.  */
 
 char *
 canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
 {
-  char *rpath, *dest, *extra_buf = NULL;
-  const char *start, *end, *rpath_limit;
+  char *rname, *dest, *extra_buf = NULL;
+  char const *start;
+  char const *end;
+  char const *rname_limit;
   size_t extra_len = 0;
-  struct cycle_check_state cycle_state;
+  Hash_table *ht = NULL;
+  int saved_errno;
 
   if (name == NULL)
     {
-      __set_errno (EINVAL);
+      errno = EINVAL;
       return NULL;
     }
 
   if (name[0] == '\0')
     {
-      __set_errno (ENOENT);
+      errno = ENOENT;
       return NULL;
     }
 
   if (name[0] != '/')
     {
-      rpath = xgetcwd ();
-      if (!rpath)
+      rname = xgetcwd ();
+      if (!rname)
        return NULL;
-      dest = strchr (rpath, '\0');
-      if (dest - rpath < PATH_MAX)
+      dest = strchr (rname, '\0');
+      if (dest - rname < PATH_MAX)
        {
-         char *p = xrealloc (rpath, PATH_MAX);
-         dest = p + (dest - rpath);
-         rpath = p;
-         rpath_limit = rpath + PATH_MAX;
+         char *p = xrealloc (rname, PATH_MAX);
+         dest = p + (dest - rname);
+         rname = p;
+         rname_limit = rname + PATH_MAX;
        }
       else
        {
-         rpath_limit = dest;
+         rname_limit = dest;
        }
     }
   else
     {
-      rpath = xmalloc (PATH_MAX);
-      rpath_limit = rpath + PATH_MAX;
-      rpath[0] = '/';
-      dest = rpath + 1;
+      rname = xmalloc (PATH_MAX);
+      rname_limit = rname + PATH_MAX;
+      rname[0] = '/';
+      dest = rname + 1;
+      if (DOUBLE_SLASH_IS_DISTINCT_ROOT && name[1] == '/')
+       *dest++ = '/';
     }
 
-  cycle_check_init (&cycle_state);
-  for (start = end = name; *start; start = end)
+  for (start = name; *start; start = end)
     {
-      /* Skip sequence of multiple path-separators.  */
+      /* Skip sequence of multiple file name separators.  */
       while (*start == '/')
        ++start;
 
-      /* Find end of path component.  */
+      /* Find end of component.  */
       for (end = start; *end && *end != '/'; ++end)
        /* Nothing.  */;
 
@@ -218,8 +147,11 @@ canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
       else if (end - start == 2 && start[0] == '.' && start[1] == '.')
        {
          /* Back up to previous component, ignore if at root already.  */
-         if (dest > rpath + 1)
+         if (dest > rname + 1)
            while ((--dest)[-1] != '/');
+         if (DOUBLE_SLASH_IS_DISTINCT_ROOT && dest == rname + 1
+             && *dest == '/')
+           dest++;
        }
       else
        {
@@ -228,31 +160,36 @@ canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
          if (dest[-1] != '/')
            *dest++ = '/';
 
-         if (dest + (end - start) >= rpath_limit)
+         if (dest + (end - start) >= rname_limit)
            {
-             PTR_INT_TYPE dest_offset = dest - rpath;
-             size_t new_size = rpath_limit - rpath;
+             ptrdiff_t dest_offset = dest - rname;
+             size_t new_size = rname_limit - rname;
 
              if (end - start + 1 > PATH_MAX)
                new_size += end - start + 1;
              else
                new_size += PATH_MAX;
-             rpath = xrealloc (rpath, new_size);
-             rpath_limit = rpath + new_size;
+             rname = xrealloc (rname, new_size);
+             rname_limit = rname + new_size;
 
-             dest = rpath + dest_offset;
+             dest = rname + dest_offset;
            }
 
          dest = memcpy (dest, start, end - start);
          dest += end - start;
          *dest = '\0';
 
-         if (lstat (rpath, &st) < 0)
+         if (lstat (rname, &st) != 0)
            {
+             saved_errno = errno;
              if (can_mode == CAN_EXISTING)
                goto error;
-             if (can_mode == CAN_ALL_BUT_LAST && *end)
-               goto error;
+             if (can_mode == CAN_ALL_BUT_LAST)
+               {
+                 if (end[strspn (end, "/")] || saved_errno != ENOENT)
+                   goto error;
+                 continue;
+               }
              st.st_mode = 0;
            }
 
@@ -261,22 +198,25 @@ canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
              char *buf;
              size_t n, len;
 
-             if (cycle_check (&cycle_state, &st))
+             /* Detect loops.  We cannot use the cycle-check module here,
+                since it's actually possible to encounter the same symlink
+                more than once in a given traversal.  However, encountering
+                the same symlink,NAME pair twice does indicate a loop.  */
+             if (seen_triple (&ht, name, &st))
                {
-                 __set_errno (ELOOP);
                  if (can_mode == CAN_MISSING)
                    continue;
-                 else
-                   goto error;
+                 saved_errno = ELOOP;
+                 goto error;
                }
 
-             buf = xreadlink (rpath, st.st_size);
+             buf = areadlink_with_size (rname, st.st_size);
              if (!buf)
                {
-                 if (can_mode == CAN_MISSING)
+                 if (can_mode == CAN_MISSING && errno != ENOMEM)
                    continue;
-                 else
-                   goto error;
+                 saved_errno = errno;
+                 goto error;
                }
 
              n = strlen (buf);
@@ -299,11 +239,21 @@ canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
              name = end = memcpy (extra_buf, buf, n);
 
              if (buf[0] == '/')
-               dest = rpath + 1;       /* It's an absolute symlink */
+               {
+                 dest = rname + 1;     /* It's an absolute symlink */
+                 if (DOUBLE_SLASH_IS_DISTINCT_ROOT && buf[1] == '/')
+                   *dest++ = '/';
+               }
              else
-               /* Back up to previous component, ignore if at root already: */
-               if (dest > rpath + 1)
-                 while ((--dest)[-1] != '/');
+               {
+                 /* Back up to previous component, ignore if at root
+                    already: */
+                 if (dest > rname + 1)
+                   while ((--dest)[-1] != '/');
+                 if (DOUBLE_SLASH_IS_DISTINCT_ROOT && dest == rname + 1
+                     && *dest == '/')
+                   dest++;
+               }
 
              free (buf);
            }
@@ -311,21 +261,28 @@ canonicalize_filename_mode (const char *name, canonicalize_mode_t can_mode)
            {
              if (!S_ISDIR (st.st_mode) && *end && (can_mode != CAN_MISSING))
                {
-                 errno = ENOTDIR;
+                 saved_errno = ENOTDIR;
                  goto error;
                }
            }
        }
     }
-  if (dest > rpath + 1 && dest[-1] == '/')
+  if (dest > rname + 1 && dest[-1] == '/')
     --dest;
+  if (DOUBLE_SLASH_IS_DISTINCT_ROOT && dest == rname + 1 && *dest == '/')
+    dest++;
   *dest = '\0';
 
   free (extra_buf);
-  return rpath;
+  if (ht)
+    hash_free (ht);
+  return rname;
 
 error:
   free (extra_buf);
-  free (rpath);
+  free (rname);
+  if (ht)
+    hash_free (ht);
+  errno = saved_errno;
   return NULL;
 }