src/filemode.c

   1 /* filemode.c -- make a string describing file modes
   2    Copyright (C) 1985, 1990, 1993, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   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 3, 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
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  18    USA.  */
  19 \f
  20 #ifdef HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26
  27 #if !S_IRUSR
  28 # if S_IREAD
  29 #  define S_IRUSR S_IREAD
  30 # else
  31 #  define S_IRUSR 00400
  32 # endif
  33 #endif
  34
  35 #if !S_IWUSR
  36 # if S_IWRITE
  37 #  define S_IWUSR S_IWRITE
  38 # else
  39 #  define S_IWUSR 00200
  40 # endif
  41 #endif
  42
  43 #if !S_IXUSR
  44 # if S_IEXEC
  45 #  define S_IXUSR S_IEXEC
  46 # else
  47 #  define S_IXUSR 00100
  48 # endif
  49 #endif
  50
  51 #ifdef STAT_MACROS_BROKEN
  52 #undef S_ISBLK
  53 #undef S_ISCHR
  54 #undef S_ISDIR
  55 #undef S_ISFIFO
  56 #undef S_ISLNK
  57 #undef S_ISMPB
  58 #undef S_ISMPC
  59 #undef S_ISNWK
  60 #undef S_ISREG
  61 #undef S_ISSOCK
  62 #endif /* STAT_MACROS_BROKEN.  */
  63
  64 #if !defined(S_ISBLK) && defined(S_IFBLK)
  65 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
  66 #endif
  67 #if !defined(S_ISCHR) && defined(S_IFCHR)
  68 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
  69 #endif
  70 #if !defined(S_ISDIR) && defined(S_IFDIR)
  71 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  72 #endif
  73 #if !defined(S_ISREG) && defined(S_IFREG)
  74 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
  75 #endif
  76 #if !defined(S_ISFIFO) && defined(S_IFIFO)
  77 #define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
  78 #endif
  79 #if !defined(S_ISLNK) && defined(S_IFLNK)
  80 #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
  81 #endif
  82 #if !defined(S_ISSOCK) && defined(S_IFSOCK)
  83 #define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
  84 #endif
  85 #if !defined(S_ISMPB) && defined(S_IFMPB) /* V7 */
  86 #define S_ISMPB(m) (((m) & S_IFMT) == S_IFMPB)
  87 #define S_ISMPC(m) (((m) & S_IFMT) == S_IFMPC)
  88 #endif
  89 #if !defined(S_ISNWK) && defined(S_IFNWK) /* HP/UX */
  90 #define S_ISNWK(m) (((m) & S_IFMT) == S_IFNWK)
  91 #endif
  92
  93 void mode_string (short unsigned int mode, char *str);
  94 static char ftypelet (long int bits);
  95 static void rwx (short unsigned int bits, char *chars);
  96 static void setst (short unsigned int bits, char *chars);
  97
  98 /* filemodestring - fill in string STR with an ls-style ASCII
  99    representation of the st_mode field of file stats block STATP.
 100    10 characters are stored in STR; no terminating null is added.
 101    The characters stored in STR are:
 102
 103    0    File type.  'd' for directory, 'c' for character
 104         special, 'b' for block special, 'm' for multiplex,
 105         'l' for symbolic link, 's' for socket, 'p' for fifo,
 106         '-' for regular, '?' for any other file type
 107
 108    1    'r' if the owner may read, '-' otherwise.
 109
 110    2    'w' if the owner may write, '-' otherwise.
 111
 112    3    'x' if the owner may execute, 's' if the file is
 113         set-user-id, '-' otherwise.
 114         'S' if the file is set-user-id, but the execute
 115         bit isn't set.
 116
 117    4    'r' if group members may read, '-' otherwise.
 118
 119    5    'w' if group members may write, '-' otherwise.
 120
 121    6    'x' if group members may execute, 's' if the file is
 122         set-group-id, '-' otherwise.
 123         'S' if it is set-group-id but not executable.
 124
 125    7    'r' if any user may read, '-' otherwise.
 126
 127    8    'w' if any user may write, '-' otherwise.
 128
 129    9    'x' if any user may execute, 't' if the file is "sticky"
 130         (will be retained in swap space after execution), '-'
 131         otherwise.
 132         'T' if the file is sticky but not executable.  */
 133
 134 void
 135 filemodestring (struct stat *statp, char *str)
 136 {
 137   mode_string (statp->st_mode, str);
 138 }
 139
 140 /* Like filemodestring, but only the relevant part of the `struct stat'
 141    is given as an argument.  */
 142
 143 void
 144 mode_string (short unsigned int mode, char *str)
 145 {
 146   str[0] = ftypelet ((long) mode);
 147   rwx ((mode & 0700) << 0, &str[1]);
 148   rwx ((mode & 0070) << 3, &str[4]);
 149   rwx ((mode & 0007) << 6, &str[7]);
 150   setst (mode, str);
 151 }
 152
 153 /* Return a character indicating the type of file described by
 154    file mode BITS:
 155    'd' for directories
 156    'b' for block special files
 157    'c' for character special files
 158    'm' for multiplexor files
 159    'l' for symbolic links
 160    's' for sockets
 161    'p' for fifos
 162    '-' for regular files
 163    '?' for any other file type.  */
 164
 165 static char
 166 ftypelet (long int bits)
 167 {
 168 #ifdef S_ISBLK
 169   if (S_ISBLK (bits))
 170     return 'b';
 171 #endif
 172   if (S_ISCHR (bits))
 173     return 'c';
 174   if (S_ISDIR (bits))
 175     return 'd';
 176   if (S_ISREG (bits))
 177     return '-';
 178 #ifdef S_ISFIFO
 179   if (S_ISFIFO (bits))
 180     return 'p';
 181 #endif
 182 #ifdef S_ISLNK
 183   if (S_ISLNK (bits))
 184     return 'l';
 185 #endif
 186 #ifdef S_ISSOCK
 187   if (S_ISSOCK (bits))
 188     return 's';
 189 #endif
 190 #ifdef S_ISMPC
 191   if (S_ISMPC (bits))
 192     return 'm';
 193 #endif
 194 #ifdef S_ISNWK
 195   if (S_ISNWK (bits))
 196     return 'n';
 197 #endif
 198   return '?';
 199 }
 200
 201 /* Look at read, write, and execute bits in BITS and set
 202    flags in CHARS accordingly.  */
 203
 204 static void
 205 rwx (short unsigned int bits, char *chars)
 206 {
 207   chars[0] = (bits & S_IRUSR) ? 'r' : '-';
 208   chars[1] = (bits & S_IWUSR) ? 'w' : '-';
 209   chars[2] = (bits & S_IXUSR) ? 'x' : '-';
 210 }
 211
 212 /* Set the 's' and 't' flags in file attributes string CHARS,
 213    according to the file mode BITS.  */
 214
 215 static void
 216 setst (short unsigned int bits, char *chars)
 217 {
 218 #ifdef S_ISUID
 219   if (bits & S_ISUID)
 220     {
 221       if (chars[3] != 'x')
 222         /* Set-uid, but not executable by owner.  */
 223         chars[3] = 'S';
 224       else
 225         chars[3] = 's';
 226     }
 227 #endif
 228 #ifdef S_ISGID
 229   if (bits & S_ISGID)
 230     {
 231       if (chars[6] != 'x')
 232         /* Set-gid, but not executable by group.  */
 233         chars[6] = 'S';
 234       else
 235         chars[6] = 's';
 236     }
 237 #endif
 238 #ifdef S_ISVTX
 239   if (bits & S_ISVTX)
 240     {
 241       if (chars[9] != 'x')
 242         /* Sticky, but not executable by others.  */
 243         chars[9] = 'T';
 244       else
 245         chars[9] = 't';
 246     }
 247 #endif
 248 }
 249
 250 /* arch-tag: 4340830c-15a5-47d2-b45f-1d43c45a91bb
 251    (do not change this comment) */