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