2 * Copyright (c) 1999 Adrian Sun (asun@u.washington.edu)
3 * Copyright (c) 1990,1991 Regents of The University of Michigan.
4 * Copyright (c) 2010 Frank Lahm
8 * Permission to use, copy, modify, and distribute this software and
9 * its documentation for any purpose and without fee is hereby granted,
10 * provided that the above copyright notice appears in all copies and
11 * that both that copyright notice and this permission notice appear
12 * in supporting documentation, and that the name of The University
13 * of Michigan not be used in advertising or publicity pertaining to
14 * distribution of the software without specific, written prior
15 * permission. This software is supplied as is without expressed or
16 * implied warranties of any kind.
18 * Research Systems Unix Group
19 * The University of Michigan
21 * 535 W. William Street
24 * netatalk@itd.umich.edu
30 * Part of Netatalk's AppleDouble implementatation
31 * @sa include/atalk/adouble.h
36 #endif /* HAVE_CONFIG_H */
39 #include <sys/param.h>
43 #include <arpa/inet.h>
45 #include <atalk/logger.h>
46 #include <atalk/adouble.h>
47 #include <atalk/util.h>
49 #include <atalk/bstrlib.h>
50 #include <atalk/bstradd.h>
51 #include <atalk/compat.h>
52 #include <atalk/errchk.h>
53 #include <atalk/volume.h>
57 #define ADEDOFF_MAGIC (0)
58 #define ADEDOFF_VERSION (ADEDOFF_MAGIC + ADEDLEN_MAGIC)
59 #define ADEDOFF_FILLER (ADEDOFF_VERSION + ADEDLEN_VERSION)
60 #define ADEDOFF_NENTRIES (ADEDOFF_FILLER + ADEDLEN_FILLER)
62 /* initial lengths of some of the fields */
63 #define ADEDLEN_INIT 0
65 /* i stick things in a slightly different order than their eid order in
66 * case i ever want to separate RootInfo behaviour from the rest of the
70 #define ADEDOFF_NAME_V2 (AD_HEADER_LEN + ADEID_NUM_V2*AD_ENTRY_LEN)
71 #define ADEDOFF_COMMENT_V2 (ADEDOFF_NAME_V2 + ADEDLEN_NAME)
72 #define ADEDOFF_FILEDATESI (ADEDOFF_COMMENT_V2 + ADEDLEN_COMMENT)
73 #define ADEDOFF_FINDERI_V2 (ADEDOFF_FILEDATESI + ADEDLEN_FILEDATESI)
74 #define ADEDOFF_DID (ADEDOFF_FINDERI_V2 + ADEDLEN_FINDERI)
75 #define ADEDOFF_AFPFILEI (ADEDOFF_DID + ADEDLEN_DID)
76 #define ADEDOFF_SHORTNAME (ADEDOFF_AFPFILEI + ADEDLEN_AFPFILEI)
77 #define ADEDOFF_PRODOSFILEI (ADEDOFF_SHORTNAME + ADEDLEN_SHORTNAME)
78 #define ADEDOFF_PRIVDEV (ADEDOFF_PRODOSFILEI + ADEDLEN_PRODOSFILEI)
79 #define ADEDOFF_PRIVINO (ADEDOFF_PRIVDEV + ADEDLEN_PRIVDEV)
80 #define ADEDOFF_PRIVSYN (ADEDOFF_PRIVINO + ADEDLEN_PRIVINO)
81 #define ADEDOFF_PRIVID (ADEDOFF_PRIVSYN + ADEDLEN_PRIVSYN)
82 #define ADEDOFF_RFORK_V2 (ADEDOFF_PRIVID + ADEDLEN_PRIVID)
85 #define ADEDOFF_FINDERI_EA (AD_HEADER_LEN + ADEID_NUM_EA * AD_ENTRY_LEN)
86 #define ADEDOFF_COMMENT_EA (ADEDOFF_FINDERI_EA + ADEDLEN_FINDERI)
87 #define ADEDOFF_FILEDATESI_EA (ADEDOFF_COMMENT_EA + ADEDLEN_COMMENT)
88 #define ADEDOFF_AFPFILEI_EA (ADEDOFF_FILEDATESI_EA + ADEDLEN_FILEDATESI)
90 /* this is to prevent changing timezones from causing problems with
91 localtime volumes. the screw-up is 30 years. we use a delta of 5 years */
92 #define TIMEWARP_DELTA 157680000
95 uint32_t id, offset, len;
98 /* --------------------------- */
99 static uid_t default_uid = -1;
101 /* Forward declarations */
102 static int ad_mkrf(const char *path);
103 static int ad_header_read(const char *path, struct adouble *ad, struct stat *hst);
104 static int ad_header_upgrade(struct adouble *ad, const char *name);
106 static int ad_mkrf_ea(const char *path);
107 static int ad_header_read_ea(const char *path, struct adouble *ad, struct stat *hst);
108 static int ad_header_upgrade_ea(struct adouble *ad, const char *name);
109 static int ad_reso_size(const char *path, int adflags, struct adouble *ad);
110 static int ad_mkrf_osx(const char *path);
113 static struct adouble_fops ad_adouble = {
116 &ad_rebuild_adouble_header,
121 static struct adouble_fops ad_adouble_ea = {
129 &ad_rebuild_adouble_header,
131 &ad_header_upgrade_ea,
134 static struct adouble_fops ad_osx = {
137 &ad_rebuild_adouble_header,
142 static const struct entry entry_order2[ADEID_NUM_V2 + 1] = {
143 {ADEID_NAME, ADEDOFF_NAME_V2, ADEDLEN_INIT},
144 {ADEID_COMMENT, ADEDOFF_COMMENT_V2, ADEDLEN_INIT},
145 {ADEID_FILEDATESI, ADEDOFF_FILEDATESI, ADEDLEN_FILEDATESI},
146 {ADEID_FINDERI, ADEDOFF_FINDERI_V2, ADEDLEN_FINDERI},
147 {ADEID_DID, ADEDOFF_DID, ADEDLEN_DID},
148 {ADEID_AFPFILEI, ADEDOFF_AFPFILEI, ADEDLEN_AFPFILEI},
149 {ADEID_SHORTNAME, ADEDOFF_SHORTNAME, ADEDLEN_INIT},
150 {ADEID_PRODOSFILEI, ADEDOFF_PRODOSFILEI, ADEDLEN_PRODOSFILEI},
151 {ADEID_PRIVDEV, ADEDOFF_PRIVDEV, ADEDLEN_INIT},
152 {ADEID_PRIVINO, ADEDOFF_PRIVINO, ADEDLEN_INIT},
153 {ADEID_PRIVSYN, ADEDOFF_PRIVSYN, ADEDLEN_INIT},
154 {ADEID_PRIVID, ADEDOFF_PRIVID, ADEDLEN_INIT},
155 {ADEID_RFORK, ADEDOFF_RFORK_V2, ADEDLEN_INIT},
159 /* Using Extended Attributes */
160 static const struct entry entry_order_ea[ADEID_NUM_EA + 1] = {
161 {ADEID_FINDERI, ADEDOFF_FINDERI_EA, ADEDLEN_FINDERI},
162 {ADEID_COMMENT, ADEDOFF_COMMENT_EA, ADEDLEN_INIT},
163 {ADEID_FILEDATESI, ADEDOFF_FILEDATESI_EA, ADEDLEN_FILEDATESI},
164 {ADEID_AFPFILEI, ADEDOFF_AFPFILEI_EA, ADEDLEN_AFPFILEI},
165 {ADEID_PRIVID, ADEDOFF_PRIVID, ADEDLEN_INIT},
169 /* fallback for EAs */
170 static const struct entry entry_order_osx[ADEID_NUM_OSX +1] = {
171 {ADEID_FINDERI, ADEDOFF_FINDERI_OSX, ADEDLEN_FINDERI},
172 {ADEID_RFORK, ADEDOFF_RFORK_OSX, ADEDLEN_INIT},
176 #define ADFLAGS2LOGSTRBUFSIZ 128
177 const char *adflags2logstr(int adflags)
180 static char buf[ADFLAGS2LOGSTRBUFSIZ];
184 if (adflags & ADFLAGS_DF) {
185 strlcat(buf, "DF", ADFLAGS2LOGSTRBUFSIZ);
188 if (adflags & ADFLAGS_RF) {
190 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
191 strlcat(buf, "RF", ADFLAGS2LOGSTRBUFSIZ);
194 if (adflags & ADFLAGS_HF) {
196 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
197 strlcat(buf, "HF", ADFLAGS2LOGSTRBUFSIZ);
200 if (adflags & ADFLAGS_NOHF) {
202 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
203 strlcat(buf, "NOHF", ADFLAGS2LOGSTRBUFSIZ);
206 if (adflags & ADFLAGS_DIR) {
208 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
209 strlcat(buf, "DIR", ADFLAGS2LOGSTRBUFSIZ);
212 if (adflags & ADFLAGS_CHECK_OF) {
214 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
215 strlcat(buf, "OF", ADFLAGS2LOGSTRBUFSIZ);
218 if (adflags & ADFLAGS_RDWR) {
220 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
221 strlcat(buf, "O_RDWR", ADFLAGS2LOGSTRBUFSIZ);
224 if (adflags & ADFLAGS_RDONLY) {
226 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
227 strlcat(buf, "O_RDONLY", ADFLAGS2LOGSTRBUFSIZ);
230 if (adflags & ADFLAGS_CREATE) {
232 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
233 strlcat(buf, "O_CREAT", ADFLAGS2LOGSTRBUFSIZ);
236 if (adflags & ADFLAGS_EXCL) {
238 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
239 strlcat(buf, "O_EXCL", ADFLAGS2LOGSTRBUFSIZ);
242 if (adflags & ADFLAGS_TRUNC) {
244 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
245 strlcat(buf, "O_TRUNC", ADFLAGS2LOGSTRBUFSIZ);
252 static uint32_t get_eid(uint32_t eid)
257 return ADEID_PRIVDEV;
259 return ADEID_PRIVINO;
261 return ADEID_PRIVSYN;
268 /* ----------------------------------- */
269 static int new_ad_header(struct adouble *ad, const char *path, struct stat *stp, int adflags)
271 const struct entry *eid;
275 LOG(log_debug, logtype_default, "new_ad_header(\"%s\")", path);
279 if (lstat(path, &st) != 0)
283 ad->ad_magic = AD_MAGIC;
284 ad->ad_version = ad->ad_vers & 0x0f0000;
285 if (!ad->ad_version) {
286 ad->ad_version = AD_VERSION;
289 memset(ad->ad_data, 0, sizeof(ad->ad_data));
291 if (ad->ad_vers == AD_VERSION2)
293 else if (ad->ad_vers == AD_VERSION_EA)
294 eid = entry_order_ea;
295 else if (ad->ad_vers == AD_VERSION2_OSX)
296 eid = entry_order_osx;
302 ad->ad_eid[eid->id].ade_off = eid->offset;
303 ad->ad_eid[eid->id].ade_len = eid->len;
307 /* put something sane in the directory finderinfo */
308 if (ad->ad_vers != AD_VERSION2_OSX) {
309 if ((adflags & ADFLAGS_DIR)) {
310 /* set default view */
311 ashort = htons(FINDERINFO_CLOSEDVIEW);
312 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRVIEWOFF, &ashort, sizeof(ashort));
314 /* set default creator/type fields */
315 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRTYPEOFF,"\0\0\0\0", 4);
316 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRCREATOFF,"\0\0\0\0", 4);
319 /* make things invisible */
320 if ((ad->ad_options & ADVOL_INVDOTS)
322 && !((adflags & ADFLAGS_DIR) && (path[1] == 0))
324 ashort = htons(ATTRBIT_INVISIBLE);
325 ad_setattr(ad, ashort);
326 ashort = htons(FINDERINFO_INVISIBLE);
327 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRFLAGOFF, &ashort, sizeof(ashort));
330 /* put something sane in the date fields */
331 ad_setdate(ad, AD_DATE_CREATE | AD_DATE_UNIX, stp->st_mtime);
332 ad_setdate(ad, AD_DATE_MODIFY | AD_DATE_UNIX, stp->st_mtime);
333 ad_setdate(ad, AD_DATE_ACCESS | AD_DATE_UNIX, stp->st_mtime);
334 ad_setdate(ad, AD_DATE_BACKUP, AD_DATE_START);
339 /* -------------------------------------
342 static void parse_entries(struct adouble *ad, char *buf, uint16_t nentries)
344 uint32_t eid, len, off;
347 /* now, read in the entry bits */
348 for (; nentries > 0; nentries-- ) {
349 memcpy(&eid, buf, sizeof( eid ));
350 eid = get_eid(ntohl(eid));
351 buf += sizeof( eid );
352 memcpy(&off, buf, sizeof( off ));
354 buf += sizeof( off );
355 memcpy(&len, buf, sizeof( len ));
357 buf += sizeof( len );
361 && off < sizeof(ad->ad_data)
362 && (off + len <= sizeof(ad->ad_data) || eid == ADEID_RFORK)) {
363 ad->ad_eid[ eid ].ade_off = off;
364 ad->ad_eid[ eid ].ade_len = len;
365 } else if (!warning) {
367 LOG(log_warning, logtype_default, "parse_entries: bogus eid: %d", eid);
372 /* this reads enough of the header so that we can figure out all of
373 * the entry lengths and offsets. once that's done, we just read/mmap
374 * the rest of the header in.
376 * NOTE: we're assuming that the resource fork is kept at the end of
377 * the file. also, mmapping won't work for the hfs fs until it
378 * understands how to mmap header files. */
379 static int ad_header_read(const char *path _U_, struct adouble *ad, struct stat *hst)
381 char *buf = ad->ad_data;
387 /* read the header */
388 if ((header_len = adf_pread( ad->ad_mdp, buf, AD_DATASZ, 0)) < 0) {
391 if (header_len < AD_HEADER_LEN) {
396 memcpy(&ad->ad_magic, buf, sizeof( ad->ad_magic ));
397 memcpy(&ad->ad_version, buf + ADEDOFF_VERSION, sizeof( ad->ad_version ));
398 ad->ad_magic = ntohl( ad->ad_magic );
399 ad->ad_version = ntohl( ad->ad_version );
401 if ((ad->ad_magic != AD_MAGIC) || (ad->ad_version != AD_VERSION2)) {
402 LOG(log_error, logtype_default, "ad_open: can't parse AppleDouble header.");
407 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
408 nentries = ntohs( nentries );
410 /* read in all the entry headers. if we have more than the
411 * maximum, just hope that the rfork is specified early on. */
412 len = nentries*AD_ENTRY_LEN;
414 if (len + AD_HEADER_LEN > sizeof(ad->ad_data))
415 len = sizeof(ad->ad_data) - AD_HEADER_LEN;
417 buf += AD_HEADER_LEN;
418 if (len > header_len - AD_HEADER_LEN) {
419 LOG(log_error, logtype_default, "ad_header_read: can't read entry info.");
424 /* figure out all of the entry offsets and lengths. if we aren't
425 * able to read a resource fork entry, bail. */
426 nentries = len / AD_ENTRY_LEN;
427 parse_entries(ad, buf, nentries);
428 if (!ad_getentryoff(ad, ADEID_RFORK)
429 || (ad_getentryoff(ad, ADEID_RFORK) > sizeof(ad->ad_data))
431 LOG(log_error, logtype_default, "ad_header_read: problem with rfork entry offset.");
436 if (ad_getentryoff(ad, ADEID_RFORK) > header_len) {
437 LOG(log_error, logtype_default, "ad_header_read: can't read in entries.");
444 if (fstat(ad->ad_mdp->adf_fd, &st) < 0) {
445 return 1; /* fail silently */
449 ad->ad_rlen = hst->st_size - ad_getentryoff(ad, ADEID_RFORK);
454 /* Read an ._ file, only uses the resofork, finderinfo is taken from EA */
455 static int ad_header_read_osx(const char *path _U_, struct adouble *ad, struct stat *hst)
458 struct adouble adosx;
459 char *buf = &adosx.ad_data[0];
465 memset(buf, 0, sizeof(adosx.ad_data));
467 /* read the header */
468 EC_NEG1( header_len = adf_pread(ad->ad_rfp, buf, AD_DATASZ_OSX, 0) );
470 if (header_len < AD_HEADER_LEN) {
475 memcpy(&adosx.ad_magic, buf, sizeof(adosx.ad_magic));
476 memcpy(&adosx.ad_version, buf + ADEDOFF_VERSION, sizeof(adosx.ad_version));
477 adosx.ad_magic = ntohl(adosx.ad_magic);
478 adosx.ad_version = ntohl(adosx.ad_version);
480 if ((adosx.ad_magic != AD_MAGIC) || (adosx.ad_version != AD_VERSION2)) {
481 LOG(log_error, logtype_afpd, "ad_header_read_osx: can't parse AppleDouble header");
486 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
487 nentries = ntohs(nentries);
488 len = nentries * AD_ENTRY_LEN;
490 if (len + AD_HEADER_LEN > sizeof(adosx.ad_data))
491 len = sizeof(adosx.ad_data) - AD_HEADER_LEN;
493 buf += AD_HEADER_LEN;
494 if (len > header_len - AD_HEADER_LEN) {
495 LOG(log_error, logtype_afpd, "ad_header_read_osx: can't read entry info.");
500 nentries = len / AD_ENTRY_LEN;
501 parse_entries(&adosx, buf, nentries);
503 if (ad_getentryoff(&adosx, ADEID_RFORK) == 0
504 || ad_getentryoff(&adosx, ADEID_RFORK) > sizeof(ad->ad_data)
505 || ad_getentryoff(&adosx, ADEID_RFORK) > header_len
507 LOG(log_error, logtype_afpd, "ad_header_read_osx: problem with rfork entry offset.");
514 EC_NEG1( fstat(ad_reso_fileno(ad), &st) );
517 ad_setentryoff(ad, ADEID_RFORK, ad_getentryoff(&adosx, ADEID_RFORK));
518 ad->ad_rlen = hst->st_size - ad_getentryoff(ad, ADEID_RFORK);
524 static int ad_header_read_ea(const char *path, struct adouble *ad, struct stat *hst _U_)
529 char *buf = ad->ad_data;
531 /* read the header */
532 if ((ad_meta_fileno(ad) == -1)
533 && (ad->ad_adflags & ADFLAGS_RDWR)) {
534 LOG(log_error, logtype_default, "ad_header_read_ea: need filedescriptor for rw access");
538 if (ad_meta_fileno(ad) != -1)
539 header_len = sys_fgetxattr(ad_meta_fileno(ad), AD_EA_META, ad->ad_data, AD_DATASZ_EA);
541 header_len = sys_lgetxattr(path, AD_EA_META, ad->ad_data, AD_DATASZ_EA);
542 if (header_len < 1) {
543 LOG(log_debug, logtype_default, "ad_header_read_ea: %s", strerror(errno));
547 if (header_len < AD_HEADER_LEN) {
548 LOG(log_error, logtype_default, "ad_header_read_ea: bogus AppleDouble header.");
553 memcpy(&ad->ad_magic, buf, sizeof( ad->ad_magic ));
554 memcpy(&ad->ad_version, buf + ADEDOFF_VERSION, sizeof( ad->ad_version ));
556 ad->ad_magic = ntohl( ad->ad_magic );
557 ad->ad_version = ntohl( ad->ad_version );
559 if ((ad->ad_magic != AD_MAGIC) || (ad->ad_version != AD_VERSION2)) {
560 LOG(log_error, logtype_default, "ad_header_read_ea: wrong magic or version");
565 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
566 nentries = ntohs( nentries );
568 /* Protect against bogus nentries */
569 len = nentries * AD_ENTRY_LEN;
570 if (len + AD_HEADER_LEN > sizeof(ad->ad_data))
571 len = sizeof(ad->ad_data) - AD_HEADER_LEN;
572 if (len > header_len - AD_HEADER_LEN) {
573 LOG(log_error, logtype_default, "ad_header_read_ea: can't read entry info.");
577 nentries = len / AD_ENTRY_LEN;
579 /* Now parse entries */
580 parse_entries(ad, buf + AD_HEADER_LEN, nentries);
586 * Takes a path to an AppleDouble file and creates the parrent .AppleDouble directory
589 * path: "/path/.AppleDouble/file"
590 * => mkdir("/path/.AppleDouble/") (in ad_mkdir())
592 static int ad_mkrf(const char *path)
596 * Probably .AppleDouble doesn't exist, try to mkdir it.
598 if (NULL == ( slash = strrchr( path, '/' )) ) {
603 if ( ad_mkdir( path, 0777 ) < 0 ) {
610 static int ad_mkrf_ea(const char *path _U_)
612 AFP_PANIC("ad_mkrf_ea: dont use");
616 static int ad_mkrf_osx(const char *path _U_)
622 if we are root change path user/ group
623 It can be a native function for BSD cf. FAQ.Q10
624 path: pathname to chown
625 stbuf: parent directory inode
627 use fstat and fchown or lchown with linux?
629 #define EMULATE_SUIDDIR
631 static int ad_chown(const char *path, struct stat *stbuf)
634 #ifdef EMULATE_SUIDDIR
637 if (default_uid != (uid_t)-1) {
638 /* we are root (admin) */
639 id = (default_uid)?default_uid:stbuf->st_uid;
640 ret = lchown( path, id, stbuf->st_gid );
646 #define DEFMASK 07700 /* be conservative */
649 return access right and inode of path parent directory
651 static int ad_mode_st(const char *path, mode_t *mode, struct stat *stbuf)
656 if (ad_stat(path, stbuf) != 0) {
660 *mode &= stbuf->st_mode;
664 /* --------------------------- */
665 static int ad_header_upgrade(struct adouble *ad _U_, const char *name _U_)
670 static int ad_header_upgrade_ea(struct adouble *ad _U_, const char *name _U_)
672 AFP_PANIC("ad_header_upgrade_ea: dont use");
677 * Error handling for adouble header(=metadata) file open error
679 * We're called because opening ADFLAGS_HF caused an error.
680 * 1. In case ad_open is called with ADFLAGS_NOHF the error is suppressed.
681 * 2. If ad_open was called with ADFLAGS_DF we may have opened the datafork and thus
682 * ought to close it before returning with an error condition.
684 static int ad_error(struct adouble *ad, int adflags)
687 if (adflags & ADFLAGS_NOHF) { /* 1 */
688 ad->ad_adflags &= ~ADFLAGS_HF;
691 if (adflags & ADFLAGS_DF) { /* 2 */
692 ad_close( ad, ADFLAGS_DF );
698 /* Map ADFLAGS to open() flags */
699 static int ad2openflags(int adflags)
703 if (adflags & ADFLAGS_RDWR)
705 if (adflags & ADFLAGS_RDONLY) {
706 if (adflags & ADFLAGS_SETSHRMD)
711 if (adflags & ADFLAGS_CREATE)
713 if (adflags & ADFLAGS_EXCL)
715 if (adflags & ADFLAGS_TRUNC)
721 static int ad_open_df(const char *path, int adflags, mode_t mode, struct adouble *ad)
729 LOG(log_debug, logtype_default, "ad_open_df(\"%s\", %04o)",
730 fullpathname(path), mode);
732 if (ad_data_fileno(ad) != -1) {
733 /* the file is already open, but we want write access: */
734 if ((adflags & ADFLAGS_RDWR)
735 /* and it was denied the first time: */
736 && (ad->ad_data_fork.adf_flags & O_RDONLY)) {
740 /* it's not new anymore */
741 ad->ad_data_fork.adf_flags &= ~( O_TRUNC | O_CREAT );
742 ad->ad_data_fork.adf_refcount++;
746 oflags = O_NOFOLLOW | ad2openflags(adflags);
749 if ((adflags & ADFLAGS_CREATE)) {
750 st_invalid = ad_mode_st(path, &admode, &st_dir);
751 if ((ad->ad_options & ADVOL_UNIXPRIV))
755 ad->ad_data_fork.adf_fd = open(path, oflags, admode);
757 if (ad->ad_data_fork.adf_fd == -1) {
762 if ((adflags & ADFLAGS_SETSHRMD) && (adflags & ADFLAGS_RDONLY)) {
765 if ((ad->ad_data_fork.adf_fd = open(path, oflags, admode)) == -1)
770 case OPEN_NOFOLLOW_ERRNO:
771 ad->ad_data_fork.adf_syml = malloc(MAXPATHLEN+1);
772 if ((lsz = readlink(path, ad->ad_data_fork.adf_syml, MAXPATHLEN)) <= 0) {
773 free(ad->ad_data_fork.adf_syml);
776 ad->ad_data_fork.adf_syml[lsz] = 0;
777 ad->ad_data_fork.adf_fd = -2; /* -2 means its a symlink */
785 ad_chown(path, &st_dir); /* just created, set owner if admin (root) */
787 ad->ad_data_fork.adf_flags = oflags;
788 adf_lock_init(&ad->ad_data_fork);
789 ad->ad_data_fork.adf_refcount++;
794 /* TODO: error handling */
795 static int ad_open_hf_v2(const char *path, int adflags, mode_t mode, struct adouble *ad)
799 struct stat *pst = NULL;
801 int oflags, nocreatflags;
805 if (ad_meta_fileno(ad) != -1) {
806 /* the file is already open, but we want write access: */
807 if ((adflags & ADFLAGS_RDWR) &&
808 /* and it was already denied: */
809 (ad->ad_mdp->adf_flags & O_RDONLY)) {
813 ad_refresh(path, ad);
814 /* it's not new anymore */
815 ad->ad_mdp->adf_flags &= ~( O_TRUNC | O_CREAT );
816 ad->ad_mdp->adf_refcount++;
820 ad_p = ad->ad_ops->ad_path(path, adflags);
821 oflags = O_NOFOLLOW | ad2openflags(adflags);
822 nocreatflags = oflags & ~(O_CREAT | O_EXCL);
824 ad->ad_mdp->adf_fd = open(ad_p, nocreatflags);
826 if (ad->ad_mdp->adf_fd != -1) {
827 ad->ad_mdp->adf_flags = nocreatflags;
833 if ((adflags & ADFLAGS_RDONLY) && (adflags & ADFLAGS_SETSHRMD)) {
834 nocreatflags &= ~O_RDWR;
835 nocreatflags |= O_RDONLY;
836 if ((ad->ad_mdp->adf_fd = open(ad_p, nocreatflags)) == -1)
838 ad->ad_mdp->adf_flags = nocreatflags;
843 if (!(oflags & O_CREAT))
844 return ad_error(ad, adflags);
846 * We're expecting to create a new adouble header file here
848 LOG(log_debug, logtype_default, "ad_open(\"%s\"): creating adouble file",
852 st_invalid = ad_mode_st(ad_p, &admode, &st_dir);
853 if ((ad->ad_options & ADVOL_UNIXPRIV))
855 admode = ad_hf_mode(admode);
856 if ((errno == ENOENT) && (ad->ad_vers != AD_VERSION2_OSX)) {
857 if (ad->ad_ops->ad_mkrf( ad_p) < 0) {
858 return ad_error(ad, adflags);
861 st_invalid = ad_mode_st(ad_p, &admode, &st_dir);
862 if ((ad->ad_options & ADVOL_UNIXPRIV))
864 admode = ad_hf_mode(admode);
867 /* retry with O_CREAT */
868 ad->ad_mdp->adf_fd = open(ad_p, oflags, admode);
869 if ( ad->ad_mdp->adf_fd < 0 )
870 return ad_error(ad, adflags);
872 ad->ad_mdp->adf_flags = oflags;
873 /* just created, set owner if admin owner (root) */
875 ad_chown(ad_p, &st_dir);
882 if (!(ad->ad_mdp->adf_flags & O_CREAT)) {
883 /* check for 0 length files, treat them as new. */
884 if (fstat(ad->ad_mdp->adf_fd, &st_meta) == 0) {
885 if (st_meta.st_size == 0)
886 ad->ad_mdp->adf_flags |= O_TRUNC;
888 /* we have valid data in st_meta stat structure, reused it in ad_header_read */
893 adf_lock_init(ad->ad_mdp);
894 ad->ad_mdp->adf_refcount = 1;
896 if ((ad->ad_mdp->adf_flags & ( O_TRUNC | O_CREAT ))) {
897 /* This is a new adouble header file, create it */
898 if (new_ad_header(ad, path, pst, adflags) < 0) {
900 /* the file is already deleted, perm, whatever, so return an error */
901 ad_close(ad, adflags);
907 /* Read the adouble header in and parse it.*/
908 if (ad->ad_ops->ad_header_read(path, ad, pst) < 0
909 || ad->ad_ops->ad_header_upgrade(ad, ad_p) < 0) {
911 ad_close(ad, adflags);
920 /* TODO: error handling */
921 static int ad_open_hf_ea(const char *path, int adflags, int mode, struct adouble *ad)
927 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\", %s, %04o)",
928 path, adflags2logstr(adflags), mode);
930 oflags = O_NOFOLLOW | (ad2openflags(adflags) & ~(O_CREAT | O_TRUNC));
932 if (ad_meta_fileno(ad) != -1) {
933 /* the file is already open, but we want write access: */
934 if ((adflags & ADFLAGS_RDWR) &&
935 /* and it was already denied: */
936 (ad->ad_mdp->adf_flags & O_RDONLY)) {
937 LOG(log_error, logtype_default, "ad_open_hf_ea(%s): rw request for ro file: %s",
938 fullpathname(path), strerror(errno));
942 /* it's not new anymore */
943 ad->ad_mdp->adf_flags &= ~( O_TRUNC | O_CREAT );
944 ad->ad_mdp->adf_refcount++;
946 if (adflags & ADFLAGS_RDWR) {
947 /* Fo a RDONLY adouble we just use sys_lgetxattr instead if sys_fgetxattr */
948 if (adflags & ADFLAGS_DIR)
949 /* For directories we open the directory RDONYL so we can later fchdir() */
950 oflags = (oflags & ~O_RDWR) | O_RDONLY;
951 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\"): opening base file for meta adouble EA", path);
952 if ((ad_meta_fileno(ad) = open(path, oflags)) == -1)
955 ad->ad_mdp->adf_flags = oflags;
957 ad->ad_mdp->adf_refcount = 1;
960 /* Read the adouble header in and parse it.*/
961 if (ad->ad_ops->ad_header_read(path, ad, NULL) != 0) {
962 LOG(log_error, logtype_default, "ad_open_hf_ea: no EA adouble");
964 if (!(adflags & ADFLAGS_CREATE)) {
969 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\"): creating metadata EA", path);
971 /* It doesnt exist, EPERM or another error */
972 if (!(errno == ENOATTR || errno == ENOENT)) {
973 LOG(log_error, logtype_default, "ad_open_hf_ea: unexpected: %s", strerror(errno));
978 if (new_ad_header(ad, path, NULL, adflags) < 0) {
979 LOG(log_error, logtype_default, "ad_open_hf_ea: can't create new header: %s",
983 ad->ad_mdp->adf_flags |= O_CREAT; /* mark as just created */
985 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\"): created metadata EA", path);
988 (void)ad_reso_size(path, adflags, ad);
993 if (opened && ad_meta_fileno(ad) != -1) {
994 close(ad_meta_fileno(ad));
995 ad_meta_fileno(ad) = -1;
996 ad->ad_mdp->adf_refcount = 0;
998 (void)ad_reso_size(path, adflags, ad);
1002 static int ad_open_hf(const char *path, int adflags, int mode, struct adouble *ad)
1006 LOG(log_debug, logtype_default, "ad_open_hf(\"%s\", %04o)", path, mode);
1008 memset(ad->ad_eid, 0, sizeof( ad->ad_eid ));
1011 switch (ad->ad_vers) {
1013 ret = ad_open_hf_v2(path, adflags, mode, ad);
1016 ret = ad_open_hf_ea(path, adflags, mode, ad);
1024 return ad_error(ad, adflags);
1030 * Get resofork length for adouble:ea
1032 static int ad_reso_size(const char *path, int adflags, struct adouble *ad)
1037 LOG(log_debug, logtype_default, "ad_reso_size(\"%s\")", path);
1041 int eafd = ad_reso_fileno(ad);
1043 EC_NEG1( eafd = sys_getxattrfd(path, O_RDONLY) );
1046 EC_NEG1( rlen = fstat(eafd, &st) );
1047 ad->ad_rlen = st.st_size;
1050 EC_NULL_LOG( rfpath = ad->ad_ops->ad_path(path, adflags));
1051 EC_ZERO( lstat(rfpath, &st));
1052 if (st.st_size > ADEDOFF_RFORK_OSX)
1053 ad->ad_rlen = st.st_size - ADEDOFF_RFORK_OSX;
1058 LOG(log_debug, logtype_default, "ad_reso_size(\"%s\"): size: %zd", path, ad->ad_rlen);
1071 * Open ressource fork
1073 * Only for adouble:ea, a nullop otherwise because adouble:v2 has the ressource fork as part
1074 * of the adouble file which is openend by ADFLAGS_HF.
1076 static int ad_open_rf(const char *path, int adflags, int mode, struct adouble *ad)
1080 int closeflags = adflags & (ADFLAGS_DF | ADFLAGS_HF);
1087 if (ad->ad_vers != AD_VERSION_EA)
1090 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\", %04o)", path, mode);
1092 oflags = O_NOFOLLOW | (ad2openflags(adflags) & ~O_CREAT);
1094 if (ad_reso_fileno(ad) != -1) {
1095 /* the file is already open, but we want write access: */
1096 if ((adflags & ADFLAGS_RDWR)
1097 /* and it was already denied: */
1098 && (ad->ad_rfp->adf_flags & O_RDONLY)) {
1102 ad->ad_rfp->adf_flags &= ~( O_TRUNC | O_CREAT );
1103 ad->ad_rfp->adf_refcount++;
1104 EC_NEG1_LOG( ad_reso_size(path, adflags, ad));
1108 if ((ad_reso_fileno(ad) = sys_getxattrfd(path, oflags)) == -1) {
1109 if (!(adflags & ADFLAGS_CREATE))
1112 EC_NEG1_LOG( ad_reso_fileno(ad) = sys_getxattrfd(path, oflags, 0666) );
1115 EC_NULL_LOG( rfpath = ad->ad_ops->ad_path(path, adflags) );
1116 if ((ad_reso_fileno(ad) = open(rfpath, oflags)) == -1) {
1117 if (!(adflags & ADFLAGS_CREATE))
1120 EC_NEG1_LOG( ad_reso_fileno(ad) = open(rfpath, oflags, mode) );
1121 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork: \"%s\"",
1126 ad->ad_rfp->adf_refcount = 1;
1127 ad->ad_rfp->adf_flags = oflags;
1130 EC_ZERO_LOG( fstat(ad_reso_fileno(ad), &st) );
1131 if (ad->ad_rfp->adf_flags & O_CREAT) {
1132 /* This is a new adouble header file, create it */
1133 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork, initializing: \"%s\"",
1135 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork, flushing: \"%s\"",
1139 /* Read the adouble header */
1140 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): reading adouble rfork: \"%s\"",
1142 EC_NEG1_LOG( ad_header_read_osx(NULL, ad, &st) );
1146 (void)ad_reso_size(path, adflags, ad);
1150 if (ad_reso_fileno(ad) != -1) {
1151 close(ad_reso_fileno(ad));
1152 ad_reso_fileno(ad) = -1;
1153 ad->ad_rfp->adf_refcount = 0;
1156 (void)ad_close(ad, closeflags);
1161 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): END", path);
1166 /***********************************************************************************
1168 ********************************************************************************* */
1170 const char *ad_path_ea( const char *path, int adflags _U_)
1175 const char *ad_path_osx(const char *path, int adflags _U_)
1177 static char pathbuf[ MAXPATHLEN + 1];
1178 char c, *slash, buf[MAXPATHLEN + 1];
1180 if (!strcmp(path,".")) {
1182 getcwd(buf, MAXPATHLEN);
1185 strlcpy(buf, path, MAXPATHLEN +1);
1187 if (NULL != ( slash = strrchr( buf, '/' )) ) {
1190 strlcpy( pathbuf, buf, MAXPATHLEN +1);
1193 pathbuf[ 0 ] = '\0';
1196 strlcat( pathbuf, "._", MAXPATHLEN +1);
1197 strlcat( pathbuf, slash, MAXPATHLEN +1);
1202 * Put the .AppleDouble where it needs to be:
1204 * / a/.AppleDouble/b
1206 * \ b/.AppleDouble/.Parent
1208 * FIXME: should do something for pathname > MAXPATHLEN
1210 const char *ad_path( const char *path, int adflags)
1212 static char pathbuf[ MAXPATHLEN + 1];
1216 if ( adflags & ADFLAGS_DIR ) {
1217 l = strlcpy( pathbuf, path, sizeof(pathbuf));
1219 if ( l && l < MAXPATHLEN) {
1222 strlcpy(pathbuf +l, ".AppleDouble/.Parent", sizeof(pathbuf) -l);
1224 if (NULL != ( slash = strrchr( path, '/' )) ) {
1227 /* XXX we must return NULL here and test in the caller */
1230 memcpy( pathbuf, path, l);
1235 l += strlcpy( pathbuf +l, ".AppleDouble/", sizeof(pathbuf) -l);
1236 strlcpy( pathbuf + l, slash, sizeof(pathbuf) -l);
1242 /* -------------------------
1243 * Support inherited protection modes for AppleDouble files. The supplied
1244 * mode is ANDed with the parent directory's mask value in lieu of "umask",
1245 * and that value is returned.
1247 char *ad_dir(const char *path)
1249 static char modebuf[ MAXPATHLEN + 1];
1252 * For a path with directories in it, remove the final component
1253 * (path or subdirectory name) to get the name we want to stat.
1254 * For a path which is just a filename, use "." instead.
1256 slash = strrchr( path, '/' );
1261 if (len >= MAXPATHLEN) {
1262 errno = ENAMETOOLONG;
1263 return NULL; /* can't do it */
1265 memcpy( modebuf, path, len );
1266 modebuf[len] = '\0';
1267 /* is last char a '/' ? */
1268 if (slash[1] == 0) {
1269 slash = modebuf+ len;
1271 while (modebuf < slash && slash[-1] == '/') {
1274 if (modebuf == slash) {
1278 while (modebuf < slash && *slash != '/') {
1281 if (modebuf == slash) {
1284 *slash = '\0'; /* remove pathname component */
1289 modebuf[0] = '.'; /* use current directory */
1294 int ad_setfuid(const uid_t id)
1300 /* ---------------- */
1301 uid_t ad_getfuid(void)
1307 stat path parent directory
1309 int ad_stat(const char *path, struct stat *stbuf)
1316 return lstat( p, stbuf );
1320 return access right of path parent directory
1322 int ad_mode( const char *path, mode_t mode)
1325 ad_mode_st(path, &mode, &stbuf);
1330 * Use mkdir() with mode bits taken from ad_mode().
1332 int ad_mkdir( const char *path, mode_t mode)
1338 LOG(log_debug, logtype_default, "ad_mkdir(\"%s\", %04o) {cwd: \"%s\"}",
1339 path, mode, getcwdpath());
1341 st_invalid = ad_mode_st(path, &mode, &stbuf);
1342 ret = mkdir( path, mode );
1343 if (ret || st_invalid)
1345 ad_chown(path, &stbuf);
1350 static void ad_init_func(struct adouble *ad)
1352 switch (ad->ad_vers) {
1354 ad->ad_ops = &ad_adouble;
1355 ad->ad_rfp = &ad->ad_resource_fork;
1356 ad->ad_mdp = &ad->ad_resource_fork;
1359 ad->ad_ops = &ad_adouble_ea;
1360 ad->ad_rfp = &ad->ad_resource_fork;
1361 ad->ad_mdp = &ad->ad_data_fork;
1364 AFP_PANIC("ad_init: unknown AD version");
1368 ad_data_fileno(ad) = -1;
1369 ad_reso_fileno(ad) = -1;
1370 ad_meta_fileno(ad) = -1;
1371 ad->ad_refcount = 1;
1375 void ad_init_old(struct adouble *ad, int flags, int options)
1377 memset(ad, 0, sizeof(struct adouble));
1378 ad->ad_vers = flags;
1379 ad->ad_options = options;
1383 void ad_init(struct adouble *ad, const struct vol * restrict vol)
1385 memset(ad, 0, sizeof(struct adouble));
1386 ad->ad_vers = vol->v_adouble;
1387 ad->ad_options = vol->v_ad_options;
1392 * Open data-, metadata(header)- or ressource fork
1394 * ad_open(struct adouble *ad, const char *path, int adflags, int flags)
1395 * ad_open(struct adouble *ad, const char *path, int adflags, int flags, mode_t mode)
1397 * You must call ad_init() before ad_open, usually you'll just call it like this: \n
1400 * ad_init(&ad, vol->v_adouble, vol->v_ad_options);
1403 * Open a files data fork, metadata fork or ressource fork.
1405 * @param ad (rw) pointer to struct adouble
1406 * @param path (r) Path to file or directory
1407 * @param adflags (r) Flags specifying which fork to open, can be or'd:
1408 * ADFLAGS_DF: open data fork
1409 * ADFLAGS_RF: open ressource fork
1410 * ADFLAGS_HF: open header (metadata) file
1411 * ADFLAGS_NOHF: it's not an error if header file couldn't be created
1412 * ADFLAGS_DIR: if path is a directory you MUST or ADFLAGS_DIR to adflags
1414 * Access mode for the forks:
1415 * ADFLAGS_RDONLY: open read only
1416 * ADFLAGS_RDWR: open read write
1419 * ADFLAGS_CREATE: create if not existing
1420 * ADFLAGS_TRUNC: truncate
1423 * ADFLAGS_CHECK_OF: check for open forks from us and other afpd's
1424 * ADFLAGS_SETSHRMD: this adouble struct will be used to set sharemode locks.
1425 * This basically results in the files being opened RW instead of RDONLY.
1426 * @param mode (r) mode used with O_CREATE
1428 * The open mode flags (rw vs ro) have to take into account all the following requirements:
1429 * - we remember open fds for files because me must avoid a single close releasing fcntl locks for other
1430 * fds of the same file
1432 * @returns 0 on success, any other value indicates an error
1434 int ad_open(struct adouble *ad, const char *path, int adflags, ...)
1440 LOG(log_debug, logtype_default, "ad_open(\"%s\", %s)",
1441 fullpathname(path), adflags2logstr(adflags));
1443 if (adflags & ADFLAGS_CHECK_OF)
1444 /* Checking for open forks requires sharemode lock support (ie RDWR instead of RDONLY) */
1445 adflags |= ADFLAGS_SETSHRMD;
1447 if ((ad->ad_vers == AD_VERSION_EA) && (adflags & ADFLAGS_SETSHRMD))
1448 /* adouble:ea sets sharemode locks on the datafork */
1449 adflags |= ADFLAGS_DF;
1451 if (ad->ad_inited != AD_INITED) {
1452 ad->ad_adflags = (adflags & ~(ADFLAGS_DF | ADFLAGS_HF | ADFLAGS_RF));
1453 ad->ad_inited = AD_INITED;
1455 ad->ad_open_forks = ((ad->ad_data_fork.adf_refcount > 0) ? ATTRBIT_DOPEN : 0);
1456 if (ad->ad_resource_fork.adf_refcount > 0)
1457 ad->ad_open_forks |= ATTRBIT_ROPEN;
1460 va_start(args, adflags);
1461 if (adflags & ADFLAGS_CREATE)
1462 mode = va_arg(args, mode_t);
1465 if (adflags & ADFLAGS_DF) {
1466 EC_ZERO( ad_open_df(path, adflags, mode, ad) );
1467 ad->ad_adflags |= ADFLAGS_DF;
1470 if (adflags & ADFLAGS_HF) {
1471 EC_ZERO( ad_open_hf(path, adflags, mode, ad) );
1472 ad->ad_adflags |= ADFLAGS_HF;
1475 if (adflags & ADFLAGS_RF) {
1476 EC_ZERO( ad_open_rf(path, adflags, mode, ad) );
1477 ad->ad_adflags |= ADFLAGS_RF;
1480 if (adflags & ADFLAGS_CHECK_OF) {
1481 ad->ad_open_forks |= ad_openforks(ad, ad->ad_open_forks);
1485 LOG(log_debug, logtype_default, "ad_open(\"%s\", %s): result: %d",
1486 fullpathname(path), adflags2logstr(ad->ad_adflags), ret);
1492 * @brief open metadata, possibly as root
1494 * Return only metadata but try very hard ie at first try as user, then try as root.
1496 * @param name name of file/dir
1497 * @param flags ADFLAGS_DIR: name is a directory \n
1498 * ADFLAGS_CHECK_OF: test if name is open by us or another afpd process
1500 * @param adp pointer to struct adouble
1502 int ad_metadata(const char *name, int flags, struct adouble *adp)
1505 int ret, err, oflags;
1507 /* Sanitize flags */
1508 oflags = (flags & (ADFLAGS_CHECK_OF | ADFLAGS_DIR)) | ADFLAGS_HF | ADFLAGS_RDONLY;
1510 if ((ret = ad_open(adp, name, oflags)) < 0 && errno == EACCES) {
1513 LOG(log_error, logtype_default, "ad_metadata(%s): seteuid failed %s", name, strerror(errno));
1517 /* we are root open read only */
1518 ret = ad_open(adp, name, oflags);
1520 if ( seteuid(uid) < 0) {
1521 LOG(log_error, logtype_default, "ad_metadata: can't seteuid back");
1531 * @brief openat like wrapper for ad_metadata
1533 int ad_metadataat(int dirfd, const char *name, int flags, struct adouble *adp)
1539 if ((cwdfd = open(".", O_RDONLY) == -1) || (fchdir(dirfd) != 0)) {
1545 if (ad_metadata(name, flags, adp) < 0) {
1552 if (fchdir(cwdfd) != 0) {
1553 LOG(log_error, logtype_afpd, "ad_openat: cant chdir back, exiting");
1566 int ad_refresh(const char *path, struct adouble *ad)
1568 switch (ad->ad_vers) {
1570 if (ad_meta_fileno(ad) == -1)
1572 return ad->ad_ops->ad_header_read(NULL, ad, NULL);
1576 if (AD_META_OPEN(ad)) {
1577 if (ad_data_fileno(ad) == -1)
1579 // TODO: read meta EA
1582 if (AD_RSRC_OPEN(ad)) {
1583 if (ad_reso_fileno(ad) == -1)
1586 if ((len = fstat(ad_reso_fileno(ad))) == -1)
1591 if (AD_META_OPEN(ad)) {
1592 if (ad_data_fileno(ad) == -1)
1594 // TODO: read meta EA
1596 if (AD_RSRC_OPEN(ad)) {
1597 if (ad_reso_fileno(ad) == -1)
1599 if (ad_header_read_osx(path, ad, NULL) < 0)
1603 return ad->ad_ops->ad_header_read(path, ad, NULL);
1612 int ad_openat(struct adouble *ad,
1613 int dirfd, /* dir fd openat like */
1623 if ((cwdfd = open(".", O_RDONLY) == -1) || (fchdir(dirfd) != 0))
1627 va_start(args, adflags);
1628 if (adflags & ADFLAGS_CREATE)
1629 mode = va_arg(args, mode_t);
1632 EC_NEG1( ad_open(ad, path, adflags, mode) );
1635 if (fchdir(cwdfd) != 0) {
1636 AFP_PANIC("ad_openat: cant chdir back");