lib/canonicalize-lgpl.c

   1 /* Return the canonical absolute name of a given file.
   2    Copyright (C) 1996-2003, 2005-2006 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #include <config.h>
  20
  21 /* Avoid a clash of our rpl_realpath() function with the prototype in
  22    <stdlib.h> on Solaris 2.5.1.  */
  23 #undef realpath
  24
  25 #if !HAVE_CANONICALIZE_FILE_NAME || defined _LIBC
  26
  27 #include <alloca.h>
  28
  29 /* Specification.  */
  30 #include "canonicalize.h"
  31
  32 #include <stddef.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 #if HAVE_UNISTD_H || defined _LIBC
  37 # include <unistd.h>
  38 #endif
  39
  40 #include <limits.h>
  41
  42 #if HAVE_SYS_PARAM_H || defined _LIBC
  43 # include <sys/param.h>
  44 #endif
  45 #ifndef MAXSYMLINKS
  46 # define MAXSYMLINKS 20
  47 #endif
  48
  49 #include <sys/stat.h>
  50
  51 #include <errno.h>
  52 #ifndef _LIBC
  53 # define __set_errno(e) errno = (e)
  54 # ifndef ENAMETOOLONG
  55 #  define ENAMETOOLONG EINVAL
  56 # endif
  57 #endif
  58
  59 #ifdef _LIBC
  60 # include <shlib-compat.h>
  61 #else
  62 # define SHLIB_COMPAT(lib, introduced, obsoleted) 0
  63 # define versioned_symbol(lib, local, symbol, version)
  64 # define compat_symbol(lib, local, symbol, version)
  65 # define weak_alias(local, symbol)
  66 # define __canonicalize_file_name canonicalize_file_name
  67 # define __realpath rpl_realpath
  68 # include "pathmax.h"
  69 # include "allocsa.h"
  70 # if HAVE_GETCWD
  71 #  ifdef VMS
  72     /* We want the directory in Unix syntax, not in VMS syntax.  */
  73 #   define __getcwd(buf, max) getcwd (buf, max, 0)
  74 #  else
  75 #   define __getcwd getcwd
  76 #  endif
  77 # else
  78 #  define __getcwd(buf, max) getwd (buf)
  79 # endif
  80 # define __readlink readlink
  81   /* On systems without symbolic links, call stat() instead of lstat().  */
  82 # if !defined S_ISNLK && !HAVE_READLINK
  83 #  define lstat stat
  84 # endif
  85 #endif
  86
  87 /* Return the canonical absolute name of file NAME.  A canonical name
  88    does not contain any `.', `..' components nor any repeated path
  89    separators ('/') or symlinks.  All path components must exist.  If
  90    RESOLVED is null, the result is malloc'd; otherwise, if the
  91    canonical name is PATH_MAX chars or more, returns null with `errno'
  92    set to ENAMETOOLONG; if the name fits in fewer than PATH_MAX chars,
  93    returns the name in RESOLVED.  If the name cannot be resolved and
  94    RESOLVED is non-NULL, it contains the path of the first component
  95    that cannot be resolved.  If the path can be resolved, RESOLVED
  96    holds the same value as the value returned.  */
  97
  98 char *
  99 __realpath (const char *name, char *resolved)
 100 {
 101   char *rpath, *dest, *extra_buf = NULL;
 102   const char *start, *end, *rpath_limit;
 103   long int path_max;
 104 #if HAVE_READLINK
 105   int num_links = 0;
 106 #endif
 107
 108   if (name == NULL)
 109     {
 110       /* As per Single Unix Specification V2 we must return an error if
 111          either parameter is a null pointer.  We extend this to allow
 112          the RESOLVED parameter to be NULL in case the we are expected to
 113          allocate the room for the return value.  */
 114       __set_errno (EINVAL);
 115       return NULL;
 116     }
 117
 118   if (name[0] == '\0')
 119     {
 120       /* As per Single Unix Specification V2 we must return an error if
 121          the name argument points to an empty string.  */
 122       __set_errno (ENOENT);
 123       return NULL;
 124     }
 125
 126 #ifdef PATH_MAX
 127   path_max = PATH_MAX;
 128 #else
 129   path_max = pathconf (name, _PC_PATH_MAX);
 130   if (path_max <= 0)
 131     path_max = 1024;
 132 #endif
 133
 134   if (resolved == NULL)
 135     {
 136       rpath = malloc (path_max);
 137       if (rpath == NULL)
 138         return NULL;
 139     }
 140   else
 141     rpath = resolved;
 142   rpath_limit = rpath + path_max;
 143
 144   if (name[0] != '/')
 145     {
 146       if (!__getcwd (rpath, path_max))
 147         {
 148           rpath[0] = '\0';
 149           goto error;
 150         }
 151       dest = strchr (rpath, '\0');
 152     }
 153   else
 154     {
 155       rpath[0] = '/';
 156       dest = rpath + 1;
 157     }
 158
 159   for (start = end = name; *start; start = end)
 160     {
 161 #ifdef _LIBC
 162       struct stat64 st;
 163 #else
 164       struct stat st;
 165 #endif
 166
 167       /* Skip sequence of multiple path-separators.  */
 168       while (*start == '/')
 169         ++start;
 170
 171       /* Find end of path component.  */
 172       for (end = start; *end && *end != '/'; ++end)
 173         /* Nothing.  */;
 174
 175       if (end - start == 0)
 176         break;
 177       else if (end - start == 1 && start[0] == '.')
 178         /* nothing */;
 179       else if (end - start == 2 && start[0] == '.' && start[1] == '.')
 180         {
 181           /* Back up to previous component, ignore if at root already.  */
 182           if (dest > rpath + 1)
 183             while ((--dest)[-1] != '/');
 184         }
 185       else
 186         {
 187           size_t new_size;
 188
 189           if (dest[-1] != '/')
 190             *dest++ = '/';
 191
 192           if (dest + (end - start) >= rpath_limit)
 193             {
 194               ptrdiff_t dest_offset = dest - rpath;
 195               char *new_rpath;
 196
 197               if (resolved)
 198                 {
 199                   __set_errno (ENAMETOOLONG);
 200                   if (dest > rpath + 1)
 201                     dest--;
 202                   *dest = '\0';
 203                   goto error;
 204                 }
 205               new_size = rpath_limit - rpath;
 206               if (end - start + 1 > path_max)
 207                 new_size += end - start + 1;
 208               else
 209                 new_size += path_max;
 210               new_rpath = (char *) realloc (rpath, new_size);
 211               if (new_rpath == NULL)
 212                 goto error;
 213               rpath = new_rpath;
 214               rpath_limit = rpath + new_size;
 215
 216               dest = rpath + dest_offset;
 217             }
 218
 219 #ifdef _LIBC
 220           dest = __mempcpy (dest, start, end - start);
 221 #else
 222           memcpy (dest, start, end - start);
 223           dest += end - start;
 224 #endif
 225           *dest = '\0';
 226
 227 #ifdef _LIBC
 228           if (__lxstat64 (_STAT_VER, rpath, &st) < 0)
 229 #else
 230           if (lstat (rpath, &st) < 0)
 231 #endif
 232             goto error;
 233
 234 #if HAVE_READLINK
 235           if (S_ISLNK (st.st_mode))
 236             {
 237               char *buf;
 238               size_t len;
 239               int n;
 240
 241               if (++num_links > MAXSYMLINKS)
 242                 {
 243                   __set_errno (ELOOP);
 244                   goto error;
 245                 }
 246
 247               buf = allocsa (path_max);
 248               if (!buf)
 249                 {
 250                   errno = ENOMEM;
 251                   goto error;
 252                 }
 253
 254               n = __readlink (rpath, buf, path_max);
 255               if (n < 0)
 256                 {
 257                   int saved_errno = errno;
 258                   freesa (buf);
 259                   errno = saved_errno;
 260                   goto error;
 261                 }
 262               buf[n] = '\0';
 263
 264               if (!extra_buf)
 265                 {
 266                   extra_buf = allocsa (path_max);
 267                   if (!extra_buf)
 268                     {
 269                       freesa (buf);
 270                       errno = ENOMEM;
 271                       goto error;
 272                     }
 273                 }
 274
 275               len = strlen (end);
 276               if ((long int) (n + len) >= path_max)
 277                 {
 278                   freesa (buf);
 279                   __set_errno (ENAMETOOLONG);
 280                   goto error;
 281                 }
 282
 283               /* Careful here, end may be a pointer into extra_buf... */
 284               memmove (&extra_buf[n], end, len + 1);
 285               name = end = memcpy (extra_buf, buf, n);
 286
 287               if (buf[0] == '/')
 288                 dest = rpath + 1;       /* It's an absolute symlink */
 289               else
 290                 /* Back up to previous component, ignore if at root already: */
 291                 if (dest > rpath + 1)
 292                   while ((--dest)[-1] != '/');
 293             }
 294 #endif
 295         }
 296     }
 297   if (dest > rpath + 1 && dest[-1] == '/')
 298     --dest;
 299   *dest = '\0';
 300
 301   if (extra_buf)
 302     freesa (extra_buf);
 303
 304   return resolved ? memcpy (resolved, rpath, dest - rpath + 1) : rpath;
 305
 306 error:
 307   {
 308     int saved_errno = errno;
 309     if (extra_buf)
 310       freesa (extra_buf);
 311     if (resolved)
 312       strcpy (resolved, rpath);
 313     else
 314       free (rpath);
 315     errno = saved_errno;
 316   }
 317   return NULL;
 318 }
 319 #ifdef _LIBC
 320 versioned_symbol (libc, __realpath, realpath, GLIBC_2_3);
 321 #endif
 322
 323
 324 #if SHLIB_COMPAT(libc, GLIBC_2_0, GLIBC_2_3)
 325 char *
 326 __old_realpath (const char *name, char *resolved)
 327 {
 328   if (resolved == NULL)
 329     {
 330       __set_errno (EINVAL);
 331       return NULL;
 332     }
 333
 334   return __realpath (name, resolved);
 335 }
 336 compat_symbol (libc, __old_realpath, realpath, GLIBC_2_0);
 337 #endif
 338
 339
 340 char *
 341 __canonicalize_file_name (const char *name)
 342 {
 343   return __realpath (name, NULL);
 344 }
 345 weak_alias (__canonicalize_file_name, canonicalize_file_name)
 346
 347 #else
 348
 349 /* This declaration is solely to ensure that after preprocessing
 350    this file is never empty.  */
 351 typedef int dummy;
 352
 353 #endif