include/atalk/volume.h

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