lib/filemode.c

   1 /* filemode.c -- make a string describing file modes
   2    Copyright (C) 1985, 1990, 1993, 1998 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 #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 /* Look at read, write, and execute bits in BITS and set
  94    flags in CHARS accordingly.  */
  95
  96 static void
  97 rwx (short unsigned int bits, char *chars)
  98 {
  99   chars[0] = (bits & S_IRUSR) ? 'r' : '-';
 100   chars[1] = (bits & S_IWUSR) ? 'w' : '-';
 101   chars[2] = (bits & S_IXUSR) ? 'x' : '-';
 102 }
 103
 104 /* Set the 's' and 't' flags in file attributes string CHARS,
 105    according to the file mode BITS.  */
 106
 107 static void
 108 setst (short unsigned int bits, char *chars)
 109 {
 110 #ifdef S_ISUID
 111   if (bits & S_ISUID)
 112     {
 113       if (chars[3] != 'x')
 114         /* Set-uid, but not executable by owner.  */
 115         chars[3] = 'S';
 116       else
 117         chars[3] = 's';
 118     }
 119 #endif
 120 #ifdef S_ISGID
 121   if (bits & S_ISGID)
 122     {
 123       if (chars[6] != 'x')
 124         /* Set-gid, but not executable by group.  */
 125         chars[6] = 'S';
 126       else
 127         chars[6] = 's';
 128     }
 129 #endif
 130 #ifdef S_ISVTX
 131   if (bits & S_ISVTX)
 132     {
 133       if (chars[9] != 'x')
 134         /* Sticky, but not executable by others.  */
 135         chars[9] = 'T';
 136       else
 137         chars[9] = 't';
 138     }
 139 #endif
 140 }
 141
 142 /* Return a character indicating the type of file described by
 143    file mode BITS:
 144    'd' for directories
 145    'b' for block special files
 146    'c' for character special files
 147    'm' for multiplexor files
 148    'M' for an off-line (regular) file
 149    'l' for symbolic links
 150    's' for sockets
 151    'p' for fifos
 152    '-' for regular files
 153    '?' for any other file type.  */
 154
 155 static char
 156 ftypelet (long int bits)
 157 {
 158 #ifdef S_ISBLK
 159   if (S_ISBLK (bits))
 160     return 'b';
 161 #endif
 162   if (S_ISCHR (bits))
 163     return 'c';
 164   if (S_ISDIR (bits))
 165     return 'd';
 166   if (S_ISREG (bits))
 167     return '-';
 168 #ifdef S_ISFIFO
 169   if (S_ISFIFO (bits))
 170     return 'p';
 171 #endif
 172 #ifdef S_ISLNK
 173   if (S_ISLNK (bits))
 174     return 'l';
 175 #endif
 176 #ifdef S_ISSOCK
 177   if (S_ISSOCK (bits))
 178     return 's';
 179 #endif
 180 #ifdef S_ISMPC
 181   if (S_ISMPC (bits))
 182     return 'm';
 183 #endif
 184 #ifdef S_ISNWK
 185   if (S_ISNWK (bits))
 186     return 'n';
 187 #endif
 188
 189   /* The following two tests are for Cray DMF (Data Migration
 190      Facility), which is a HSM file system.  A migrated file has a
 191      `st_dm_mode' that is different from the normal `st_mode', so any
 192      tests for migrated files should use the former.  */
 193
 194 #ifdef S_ISOFD
 195   if (S_ISOFD (bits))
 196     /* off line, with data  */
 197     return 'M';
 198 #endif
 199 #ifdef S_ISOFL
 200   /* off line, with no data  */
 201   if (S_ISOFL (bits))
 202     return 'M';
 203 #endif
 204   return '?';
 205 }
 206
 207 /* Like filemodestring, but only the relevant part of the `struct stat'
 208    is given as an argument.  */
 209
 210 void
 211 mode_string (short unsigned int mode, char *str)
 212 {
 213   str[0] = ftypelet ((long) mode);
 214   rwx ((mode & 0700) << 0, &str[1]);
 215   rwx ((mode & 0070) << 3, &str[4]);
 216   rwx ((mode & 0007) << 6, &str[7]);
 217   setst (mode, str);
 218 }
 219
 220 /* filemodestring - fill in string STR with an ls-style ASCII
 221    representation of the st_mode field of file stats block STATP.
 222    10 characters are stored in STR; no terminating null is added.
 223    The characters stored in STR are:
 224
 225    0    File type.  'd' for directory, 'c' for character
 226         special, 'b' for block special, 'm' for multiplex,
 227         'l' for symbolic link, 's' for socket, 'p' for fifo,
 228         '-' for regular, '?' for any other file type
 229
 230    1    'r' if the owner may read, '-' otherwise.
 231
 232    2    'w' if the owner may write, '-' otherwise.
 233
 234    3    'x' if the owner may execute, 's' if the file is
 235         set-user-id, '-' otherwise.
 236         'S' if the file is set-user-id, but the execute
 237         bit isn't set.
 238
 239    4    'r' if group members may read, '-' otherwise.
 240
 241    5    'w' if group members may write, '-' otherwise.
 242
 243    6    'x' if group members may execute, 's' if the file is
 244         set-group-id, '-' otherwise.
 245         'S' if it is set-group-id but not executable.
 246
 247    7    'r' if any user may read, '-' otherwise.
 248
 249    8    'w' if any user may write, '-' otherwise.
 250
 251    9    'x' if any user may execute, 't' if the file is "sticky"
 252         (will be retained in swap space after execution), '-'
 253         otherwise.
 254         'T' if the file is sticky but not executable.  */
 255
 256 void
 257 filemodestring (struct stat *statp, char *str)
 258 {
 259   mode_string (statp->st_mode, str);
 260 }