include/atalk/volume.h

   1 /*
   2  * $Id: volume.h,v 1.1 2009-10-02 09:32:41 franklahm Exp $
   3  *
   4  * Copyright (c) 1990,1994 Regents of The University of Michigan.
   5  * All Rights Reserved.  See COPYRIGHT.
   6  */
   7
   8 #ifndef ATALK_VOLUME_H
   9 #define ATALK_VOLUME_H 1
  10
  11 #include <sys/cdefs.h>
  12 #include <sys/types.h>
  13 #include <netatalk/endian.h>
  14
  15 #include <atalk/unicode.h>
  16 #include <atalk/cnid.h>
  17 #include <atalk/hash.h>
  18
  19 #define AFPVOL_U8MNAMELEN   255 /* AFP3 sepc */
  20 #define AFPVOL_MACNAMELEN    27 /* AFP2 spec */
  21
  22 struct vol {
  23     struct vol          *v_next;
  24     char        *v_localname;   /* as defined in AppleVolumes.default */
  25     ucs2_t              *v_u8mname;     /* converted to utf8-mac in ucs2 */
  26     ucs2_t              *v_macname;     /* mangled to legacy longname in ucs2 */
  27     ucs2_t              *v_name;        /* either v_u8mname or v_macname */
  28     char                *v_path;
  29
  30     struct dir          *v_dir, *v_root;
  31     hash_t              *v_hash;
  32     int                 v_flags;
  33 #ifdef __svr4__
  34     int                 v_qfd;
  35 #endif /*__svr4__*/
  36     char                *v_gvs;
  37     time_t              v_mtime;
  38     time_t              v_ctime;  /* volume creation date, not unix ctime */
  39
  40     u_int16_t           v_vid;
  41     void                *v_nfsclient;
  42     int                 v_nfs;
  43
  44     int                 v_casefold;
  45     size_t              max_filename;
  46
  47     char                *v_password;
  48     char                *v_veto;
  49
  50     char                *v_cnidscheme;
  51     char                *v_dbpath;
  52     dev_t               v_dev;              /* Unix volume device */
  53     struct _cnid_db     *v_cdb;
  54     char                v_stamp[ADEDLEN_PRIVSYN];
  55     mode_t              v_umask;
  56     mode_t              v_perm;             /* default permission value OR with requested perm*/
  57     mode_t              v_dperm;             /* default directories permission value OR with requested perm*/
  58     mode_t              v_fperm;             /* default files permission value OR with requested perm*/
  59
  60 #ifdef FORCE_UIDGID
  61     char                *v_forceuid;
  62     char                *v_forcegid;
  63 #endif
  64
  65     char                *v_volcodepage;
  66     charset_t           v_volcharset;
  67     struct charset_functions    *v_vol;
  68     char                *v_maccodepage;
  69     charset_t           v_maccharset;
  70     struct charset_functions    *v_mac;
  71
  72     int                 v_deleted;    /* volume open but deleted in new config file */
  73     int                 v_hide;       /* new volume wait until old volume is closed */
  74     int                 v_new;        /* volume deleted but there's a new one with the same name */
  75     int                 v_adouble;    /* default adouble format */
  76     int                 v_ad_options; /* adouble option NODEV, NOCACHE, etc.. */
  77
  78     char                *v_root_preexec;
  79     char                *v_preexec;
  80
  81     char                *v_root_postexec;
  82     char                *v_postexec;
  83
  84     int                 v_root_preexec_close;
  85     int                 v_preexec_close;
  86
  87     /* adouble indirection */
  88     struct vfs_ops      *vfs;
  89     int                 v_vfs_ea;       /* The AFPVOL_EA_xx flag */
  90     int                 (*validupath)(const struct vol *, const char *);
  91     char                *(*ad_path)(const char *, int);
  92 };
  93
  94 #ifdef NO_LARGE_VOL_SUPPORT
  95 typedef u_int32_t VolSpace;
  96 #else /* NO_LARGE_VOL_SUPPORT */
  97 typedef u_int64_t VolSpace;
  98 #endif /* NO_LARGE_VOL_SUPPORT */
  99
 100 #define AFPVOL_OPEN     (1<<0)
 101
 102 /* flags  for AFS and quota 0xxx0 */
 103 #define AFPVOL_GVSMASK  (7<<2)
 104 #define AFPVOL_NONE     (0<<2)
 105 #define AFPVOL_AFSGVS   (1<<2)
 106 #define AFPVOL_USTATFS  (2<<2)
 107 #define AFPVOL_UQUOTA   (4<<2)
 108
 109 /*
 110    Flags that alter volume behaviour.
 111    Keep in sync with include/atalk/volinfo.h and libatalk/util/volinfo.c
 112 */
 113 #define AFPVOL_A2VOL     (1 << 5)   /* prodos volume */
 114 #define AFPVOL_CRLF      (1 << 6)   /* cr/lf translation */
 115 #define AFPVOL_NOADOUBLE (1 << 7)   /* don't create .AppleDouble by default */
 116 #define AFPVOL_RO        (1 << 8)   /* read-only volume */
 117 #define AFPVOL_MSWINDOWS (1 << 9)   /* deal with ms-windows yuckiness.
 118 this is going away. */
 119 #define AFPVOL_NOHEX     (1 << 10)  /* don't do :hex translation */
 120 #define AFPVOL_USEDOTS   (1 << 11)  /* use real dots */
 121 #define AFPVOL_LIMITSIZE (1 << 12)  /* limit size for older macs */
 122 #define AFPVOL_MAPASCII  (1 << 13)  /* map the ascii range as well */
 123 #define AFPVOL_DROPBOX   (1 << 14)  /* dropkludge dropbox support */
 124 #define AFPVOL_NOFILEID  (1 << 15)  /* don't advertise createid resolveid and deleteid calls */
 125 #define AFPVOL_NOSTAT    (1 << 16)  /* advertise the volume even if we can't stat() it
 126                                      * maybe because it will be mounted later in preexec */
 127 #define AFPVOL_UNIX_PRIV (1 << 17)  /* support unix privileges */
 128 #define AFPVOL_NODEV     (1 << 18)  /* always use 0 for device number in cnid calls
 129                                      * help if device number is notconsistent across reboot
 130                                      * NOTE symlink to a different device will return an ACCESS error
 131                                      */
 132 #define AFPVOL_CASEINSEN (1 << 19)  /* volume is case insensitive */
 133 #define AFPVOL_EILSEQ    (1 << 20)  /* encode illegal sequence 'asis' UCS2, ex "\217-", which is not
 134                                        a valid SHIFT-JIS char, is encoded  as U\217 -*/
 135
 136 #define AFPVOL_CACHE     (1 << 21)   /* Use adouble v2 CNID caching. Default: yes */
 137 #define AFPVOL_INV_DOTS  (1 << 22)   /* dots files are invisible */
 138 #define AFPVOL_TM        (1 << 24)   /* Supports TimeMachine */
 139 #define AFPVOL_ACLS      (1 << 25)   /* Volume supports ACLS */
 140
 141 /* Extended Attributes vfs indirection  */
 142 #define AFPVOL_EA_AD             0   /* Store them in adouble files. Default. */
 143 #define AFPVOL_EA_SOLARIS        1   /* Store them in native Solaris EAs */
 144
 145 /* FPGetSrvrParms options */
 146 #define AFPSRVR_CONFIGINFO     (1 << 0)
 147 #define AFPSRVR_PASSWD         (1 << 7)
 148
 149 /* handle casefolding */
 150 #define AFPVOL_MTOUUPPER       (1 << 0)
 151 #define AFPVOL_MTOULOWER       (1 << 1)
 152 #define AFPVOL_UTOMUPPER       (1 << 2)
 153 #define AFPVOL_UTOMLOWER       (1 << 3)
 154 #define AFPVOL_UMLOWER         (AFPVOL_MTOULOWER | AFPVOL_UTOMLOWER)
 155 #define AFPVOL_UMUPPER         (AFPVOL_MTOUUPPER | AFPVOL_UTOMUPPER)
 156 #define AFPVOL_UUPPERMLOWER    (AFPVOL_MTOUUPPER | AFPVOL_UTOMLOWER)
 157 #define AFPVOL_ULOWERMUPPER    (AFPVOL_MTOULOWER | AFPVOL_UTOMUPPER)
 158
 159 #define MSWINDOWS_BADCHARS ":\t\\/<>*?|\""
 160
 161 int wincheck(const struct vol *vol, const char *path);
 162
 163 #define AFPVOLSIG_FLAT          0x0001 /* flat fs */
 164 #define AFPVOLSIG_FIX           0x0002 /* fixed ids */
 165 #define AFPVOLSIG_VAR           0x0003 /* variable ids */
 166 #define AFPVOLSIG_DEFAULT       AFPVOLSIG_FIX
 167
 168 /* volume attributes */
 169 #define VOLPBIT_ATTR_RO           (1 << 0)
 170 #define VOLPBIT_ATTR_PASSWD       (1 << 1)
 171 #define VOLPBIT_ATTR_FILEID       (1 << 2)
 172 #define VOLPBIT_ATTR_CATSEARCH    (1 << 3)
 173 #define VOLPBIT_ATTR_BLANKACCESS  (1 << 4)
 174 #define VOLPBIT_ATTR_UNIXPRIV     (1 << 5)
 175 #define VOLPBIT_ATTR_UTF8         (1 << 6)
 176 #define VOLPBIT_ATTR_NONETUID     (1 << 7)
 177 #define VOLPBIT_ATTR_EXT_ATTRS    (1 << 10)
 178 #define VOLPBIT_ATTR_ACLS         (1 << 11)
 179 #define VOLPBIT_ATTR_TM           (1 << 13)
 180
 181 #define VOLPBIT_ATTR    0
 182 #define VOLPBIT_SIG     1
 183 #define VOLPBIT_CDATE   2
 184 #define VOLPBIT_MDATE   3
 185 #define VOLPBIT_BDATE   4
 186 #define VOLPBIT_VID     5
 187 #define VOLPBIT_BFREE   6
 188 #define VOLPBIT_BTOTAL  7
 189 #define VOLPBIT_NAME    8
 190 /* handle > 4GB volumes */
 191 #define VOLPBIT_XBFREE  9
 192 #define VOLPBIT_XBTOTAL 10
 193 #define VOLPBIT_BSIZE   11        /* block size */
 194
 195
 196 #define vol_noadouble(vol) (((vol)->v_flags & AFPVOL_NOADOUBLE) ? \
 197                             ADFLAGS_NOADOUBLE : 0)
 198 #ifdef AFP3x
 199 #define utf8_encoding() (afp_version >= 30)
 200 #else
 201 #define utf8_encoding() (0)
 202 #endif
 203
 204 #define vol_nodev(vol) (((vol)->v_flags & AFPVOL_NODEV) ? 1 : 0)
 205 #define vol_unix_priv(vol) (afp_version >= 30 && ((vol)->v_flags & AFPVOL_UNIX_PRIV))
 206 #define vol_inv_dots(vol) (((vol)->v_flags & AFPVOL_INV_DOTS) ? 1 : 0)
 207
 208
 209 #endif