lib/filemode.c

   1 /* filemode.c -- make a string describing file modes
   2    Copyright (C) 1985, 1990, 1993, 1998, 1999 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17 \f
  18 #if HAVE_CONFIG_H
  19 # include <config.h>
  20 #endif
  21
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24
  25 #include "filemode.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 #if !S_IRGRP
  52 # define S_IRGRP (S_IRUSR >> 3)
  53 #endif
  54 #if !S_IWGRP
  55 # define S_IWGRP (S_IWUSR >> 3)
  56 #endif
  57 #if !S_IXGRP
  58 # define S_IXGRP (S_IXUSR >> 3)
  59 #endif
  60 #if !S_IROTH
  61 # define S_IROTH (S_IRUSR >> 6)
  62 #endif
  63 #if !S_IWOTH
  64 # define S_IWOTH (S_IWUSR >> 6)
  65 #endif
  66 #if !S_IXOTH
  67 # define S_IXOTH (S_IXUSR >> 6)
  68 #endif
  69
  70 #ifdef STAT_MACROS_BROKEN
  71 # undef S_ISBLK
  72 # undef S_ISCHR
  73 # undef S_ISDIR
  74 # undef S_ISFIFO
  75 # undef S_ISLNK
  76 # undef S_ISMPB
  77 # undef S_ISMPC
  78 # undef S_ISNWK
  79 # undef S_ISREG
  80 # undef S_ISSOCK
  81 #endif /* STAT_MACROS_BROKEN.  */
  82
  83 #if !defined(S_ISBLK) && defined(S_IFBLK)
  84 # define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
  85 #endif
  86 #if !defined(S_ISCHR) && defined(S_IFCHR)
  87 # define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
  88 #endif
  89 #if !defined(S_ISDIR) && defined(S_IFDIR)
  90 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  91 #endif
  92 #if !defined(S_ISREG) && defined(S_IFREG)
  93 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
  94 #endif
  95 #if !defined(S_ISFIFO) && defined(S_IFIFO)
  96 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
  97 #endif
  98 #if !defined(S_ISLNK) && defined(S_IFLNK)
  99 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
 100 #endif
 101 #if !defined(S_ISSOCK) && defined(S_IFSOCK)
 102 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 103 #endif
 104 #if !defined(S_ISMPB) && defined(S_IFMPB) /* V7 */
 105 # define S_ISMPB(m) (((m) & S_IFMT) == S_IFMPB)
 106 # define S_ISMPC(m) (((m) & S_IFMT) == S_IFMPC)
 107 #endif
 108 #if !defined(S_ISNWK) && defined(S_IFNWK) /* HP/UX */
 109 # define S_ISNWK(m) (((m) & S_IFMT) == S_IFNWK)
 110 #endif
 111 #if !defined(S_ISDOOR) && defined(S_IFDOOR) /* Solaris 2.5 and up */
 112 # define S_ISDOOR(m) (((m) & S_IFMT) == S_IFDOOR)
 113 #endif
 114
 115 /* Set the 's' and 't' flags in file attributes string CHARS,
 116    according to the file mode BITS.  */
 117
 118 static void
 119 setst (mode_t bits, char *chars)
 120 {
 121 #ifdef S_ISUID
 122   if (bits & S_ISUID)
 123     {
 124       if (chars[3] != 'x')
 125         /* Set-uid, but not executable by owner.  */
 126         chars[3] = 'S';
 127       else
 128         chars[3] = 's';
 129     }
 130 #endif
 131 #ifdef S_ISGID
 132   if (bits & S_ISGID)
 133     {
 134       if (chars[6] != 'x')
 135         /* Set-gid, but not executable by group.  */
 136         chars[6] = 'S';
 137       else
 138         chars[6] = 's';
 139     }
 140 #endif
 141 #ifdef S_ISVTX
 142   if (bits & S_ISVTX)
 143     {
 144       if (chars[9] != 'x')
 145         /* Sticky, but not executable by others.  */
 146         chars[9] = 'T';
 147       else
 148         chars[9] = 't';
 149     }
 150 #endif
 151 }
 152
 153 /* Return a character indicating the type of file described by
 154    file mode BITS:
 155    'd' for directories
 156    'D' for doors
 157    'b' for block special files
 158    'c' for character special files
 159    'm' for multiplexor files
 160    'M' for an off-line (regular) file
 161    'l' for symbolic links
 162    's' for sockets
 163    'p' for fifos
 164    '-' for regular files
 165    '?' for any other file type.  */
 166
 167 static char
 168 ftypelet (mode_t bits)
 169 {
 170 #ifdef S_ISBLK
 171   if (S_ISBLK (bits))
 172     return 'b';
 173 #endif
 174   if (S_ISCHR (bits))
 175     return 'c';
 176   if (S_ISDIR (bits))
 177     return 'd';
 178   if (S_ISREG (bits))
 179     return '-';
 180 #ifdef S_ISFIFO
 181   if (S_ISFIFO (bits))
 182     return 'p';
 183 #endif
 184 #ifdef S_ISLNK
 185   if (S_ISLNK (bits))
 186     return 'l';
 187 #endif
 188 #ifdef S_ISSOCK
 189   if (S_ISSOCK (bits))
 190     return 's';
 191 #endif
 192 #ifdef S_ISMPC
 193   if (S_ISMPC (bits))
 194     return 'm';
 195 #endif
 196 #ifdef S_ISNWK
 197   if (S_ISNWK (bits))
 198     return 'n';
 199 #endif
 200 #ifdef S_ISDOOR
 201   if (S_ISDOOR (bits))
 202     return 'D';
 203 #endif
 204
 205   /* The following two tests are for Cray DMF (Data Migration
 206      Facility), which is a HSM file system.  A migrated file has a
 207      `st_dm_mode' that is different from the normal `st_mode', so any
 208      tests for migrated files should use the former.  */
 209
 210 #ifdef S_ISOFD
 211   if (S_ISOFD (bits))
 212     /* off line, with data  */
 213     return 'M';
 214 #endif
 215 #ifdef S_ISOFL
 216   /* off line, with no data  */
 217   if (S_ISOFL (bits))
 218     return 'M';
 219 #endif
 220   return '?';
 221 }
 222
 223 /* Like filemodestring, but only the relevant part of the `struct stat'
 224    is given as an argument.  */
 225
 226 void
 227 mode_string (mode_t mode, char *str)
 228 {
 229   str[0] = ftypelet (mode);
 230   str[1] = mode & S_IRUSR ? 'r' : '-';
 231   str[2] = mode & S_IWUSR ? 'w' : '-';
 232   str[3] = mode & S_IXUSR ? 'x' : '-';
 233   str[4] = mode & S_IRGRP ? 'r' : '-';
 234   str[5] = mode & S_IWGRP ? 'w' : '-';
 235   str[6] = mode & S_IXGRP ? 'x' : '-';
 236   str[7] = mode & S_IROTH ? 'r' : '-';
 237   str[8] = mode & S_IWOTH ? 'w' : '-';
 238   str[9] = mode & S_IXOTH ? 'x' : '-';
 239   setst (mode, str);
 240 }
 241
 242 /* filemodestring - fill in string STR with an ls-style ASCII
 243    representation of the st_mode field of file stats block STATP.
 244    10 characters are stored in STR; no terminating null is added.
 245    The characters stored in STR are:
 246
 247    0    File type.  'd' for directory, 'c' for character
 248         special, 'b' for block special, 'm' for multiplex,
 249         'l' for symbolic link, 's' for socket, 'p' for fifo,
 250         '-' for regular, '?' for any other file type
 251
 252    1    'r' if the owner may read, '-' otherwise.
 253
 254    2    'w' if the owner may write, '-' otherwise.
 255
 256    3    'x' if the owner may execute, 's' if the file is
 257         set-user-id, '-' otherwise.
 258         'S' if the file is set-user-id, but the execute
 259         bit isn't set.
 260
 261    4    'r' if group members may read, '-' otherwise.
 262
 263    5    'w' if group members may write, '-' otherwise.
 264
 265    6    'x' if group members may execute, 's' if the file is
 266         set-group-id, '-' otherwise.
 267         'S' if it is set-group-id but not executable.
 268
 269    7    'r' if any user may read, '-' otherwise.
 270
 271    8    'w' if any user may write, '-' otherwise.
 272
 273    9    'x' if any user may execute, 't' if the file is "sticky"
 274         (will be retained in swap space after execution), '-'
 275         otherwise.
 276         'T' if the file is sticky but not executable.  */
 277
 278 void
 279 filemodestring (struct stat *statp, char *str)
 280 {
 281   mode_string (statp->st_mode, str);
 282 }