etc/afpd/volume.h

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