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 const char *ad_path_osx(const char *path, int adflags);
111 static int ad_mkrf_osx(const char *path);
114 static struct adouble_fops ad_adouble = {
117 &ad_rebuild_adouble_header,
122 static struct adouble_fops ad_adouble_ea = {
130 &ad_rebuild_adouble_header,
132 &ad_header_upgrade_ea,
135 static struct adouble_fops ad_osx = {
138 &ad_rebuild_adouble_header,
143 static const struct entry entry_order2[ADEID_NUM_V2 + 1] = {
144 {ADEID_NAME, ADEDOFF_NAME_V2, ADEDLEN_INIT},
145 {ADEID_COMMENT, ADEDOFF_COMMENT_V2, ADEDLEN_INIT},
146 {ADEID_FILEDATESI, ADEDOFF_FILEDATESI, ADEDLEN_FILEDATESI},
147 {ADEID_FINDERI, ADEDOFF_FINDERI_V2, ADEDLEN_FINDERI},
148 {ADEID_DID, ADEDOFF_DID, ADEDLEN_DID},
149 {ADEID_AFPFILEI, ADEDOFF_AFPFILEI, ADEDLEN_AFPFILEI},
150 {ADEID_SHORTNAME, ADEDOFF_SHORTNAME, ADEDLEN_INIT},
151 {ADEID_PRODOSFILEI, ADEDOFF_PRODOSFILEI, ADEDLEN_PRODOSFILEI},
152 {ADEID_PRIVDEV, ADEDOFF_PRIVDEV, ADEDLEN_INIT},
153 {ADEID_PRIVINO, ADEDOFF_PRIVINO, ADEDLEN_INIT},
154 {ADEID_PRIVSYN, ADEDOFF_PRIVSYN, ADEDLEN_INIT},
155 {ADEID_PRIVID, ADEDOFF_PRIVID, ADEDLEN_INIT},
156 {ADEID_RFORK, ADEDOFF_RFORK_V2, ADEDLEN_INIT},
160 /* Using Extended Attributes */
161 static const struct entry entry_order_ea[ADEID_NUM_EA + 1] = {
162 {ADEID_FINDERI, ADEDOFF_FINDERI_EA, ADEDLEN_FINDERI},
163 {ADEID_COMMENT, ADEDOFF_COMMENT_EA, ADEDLEN_INIT},
164 {ADEID_FILEDATESI, ADEDOFF_FILEDATESI_EA, ADEDLEN_FILEDATESI},
165 {ADEID_AFPFILEI, ADEDOFF_AFPFILEI_EA, ADEDLEN_AFPFILEI},
166 {ADEID_PRIVID, ADEDOFF_PRIVID, ADEDLEN_INIT},
170 /* fallback for EAs */
171 static const struct entry entry_order_osx[ADEID_NUM_OSX +1] = {
172 {ADEID_FINDERI, ADEDOFF_FINDERI_OSX, ADEDLEN_FINDERI},
173 {ADEID_RFORK, ADEDOFF_RFORK_OSX, ADEDLEN_INIT},
177 #define ADFLAGS2LOGSTRBUFSIZ 128
178 const char *adflags2logstr(int adflags)
181 static char buf[ADFLAGS2LOGSTRBUFSIZ];
185 if (adflags & ADFLAGS_DF) {
186 strlcat(buf, "DF", ADFLAGS2LOGSTRBUFSIZ);
189 if (adflags & ADFLAGS_RF) {
191 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
192 strlcat(buf, "RF", ADFLAGS2LOGSTRBUFSIZ);
195 if (adflags & ADFLAGS_HF) {
197 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
198 strlcat(buf, "HF", ADFLAGS2LOGSTRBUFSIZ);
201 if (adflags & ADFLAGS_NOHF) {
203 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
204 strlcat(buf, "NOHF", ADFLAGS2LOGSTRBUFSIZ);
207 if (adflags & ADFLAGS_DIR) {
209 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
210 strlcat(buf, "DIR", ADFLAGS2LOGSTRBUFSIZ);
213 if (adflags & ADFLAGS_CHECK_OF) {
215 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
216 strlcat(buf, "OF", ADFLAGS2LOGSTRBUFSIZ);
219 if (adflags & ADFLAGS_RDWR) {
221 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
222 strlcat(buf, "O_RDWR", ADFLAGS2LOGSTRBUFSIZ);
225 if (adflags & ADFLAGS_RDONLY) {
227 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
228 strlcat(buf, "O_RDONLY", ADFLAGS2LOGSTRBUFSIZ);
231 if (adflags & ADFLAGS_CREATE) {
233 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
234 strlcat(buf, "O_CREAT", ADFLAGS2LOGSTRBUFSIZ);
237 if (adflags & ADFLAGS_EXCL) {
239 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
240 strlcat(buf, "O_EXCL", ADFLAGS2LOGSTRBUFSIZ);
243 if (adflags & ADFLAGS_TRUNC) {
245 strlcat(buf, "|", ADFLAGS2LOGSTRBUFSIZ);
246 strlcat(buf, "O_TRUNC", ADFLAGS2LOGSTRBUFSIZ);
253 static uint32_t get_eid(uint32_t eid)
258 return ADEID_PRIVDEV;
260 return ADEID_PRIVINO;
262 return ADEID_PRIVSYN;
269 /* ----------------------------------- */
270 static int new_ad_header(struct adouble *ad, const char *path, struct stat *stp, int adflags)
272 const struct entry *eid;
276 LOG(log_debug, logtype_default, "new_ad_header(\"%s\")", path);
280 if (lstat(path, &st) != 0)
284 ad->ad_magic = AD_MAGIC;
285 ad->ad_version = ad->ad_vers & 0x0f0000;
286 if (!ad->ad_version) {
287 ad->ad_version = AD_VERSION;
290 memset(ad->ad_data, 0, sizeof(ad->ad_data));
292 if (ad->ad_vers == AD_VERSION2)
294 else if (ad->ad_vers == AD_VERSION_EA)
295 eid = entry_order_ea;
296 else if (ad->ad_vers == AD_VERSION2_OSX)
297 eid = entry_order_osx;
303 ad->ad_eid[eid->id].ade_off = eid->offset;
304 ad->ad_eid[eid->id].ade_len = eid->len;
308 /* put something sane in the directory finderinfo */
309 if (ad->ad_vers != AD_VERSION2_OSX) {
310 if ((adflags & ADFLAGS_DIR)) {
311 /* set default view */
312 ashort = htons(FINDERINFO_CLOSEDVIEW);
313 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRVIEWOFF, &ashort, sizeof(ashort));
315 /* set default creator/type fields */
316 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRTYPEOFF,"\0\0\0\0", 4);
317 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRCREATOFF,"\0\0\0\0", 4);
320 /* make things invisible */
321 if ((ad->ad_options & ADVOL_INVDOTS)
323 && !((adflags & ADFLAGS_DIR) && (path[1] == 0))
325 ashort = htons(ATTRBIT_INVISIBLE);
326 ad_setattr(ad, ashort);
327 ashort = htons(FINDERINFO_INVISIBLE);
328 memcpy(ad_entry(ad, ADEID_FINDERI) + FINDERINFO_FRFLAGOFF, &ashort, sizeof(ashort));
331 /* put something sane in the date fields */
332 ad_setdate(ad, AD_DATE_CREATE | AD_DATE_UNIX, stp->st_mtime);
333 ad_setdate(ad, AD_DATE_MODIFY | AD_DATE_UNIX, stp->st_mtime);
334 ad_setdate(ad, AD_DATE_ACCESS | AD_DATE_UNIX, stp->st_mtime);
335 ad_setdate(ad, AD_DATE_BACKUP, AD_DATE_START);
340 /* -------------------------------------
343 static void parse_entries(struct adouble *ad, char *buf, uint16_t nentries)
345 uint32_t eid, len, off;
348 /* now, read in the entry bits */
349 for (; nentries > 0; nentries-- ) {
350 memcpy(&eid, buf, sizeof( eid ));
351 eid = get_eid(ntohl(eid));
352 buf += sizeof( eid );
353 memcpy(&off, buf, sizeof( off ));
355 buf += sizeof( off );
356 memcpy(&len, buf, sizeof( len ));
358 buf += sizeof( len );
362 && off < sizeof(ad->ad_data)
363 && (off + len <= sizeof(ad->ad_data) || eid == ADEID_RFORK)) {
364 ad->ad_eid[ eid ].ade_off = off;
365 ad->ad_eid[ eid ].ade_len = len;
366 } else if (!warning) {
368 LOG(log_warning, logtype_default, "parse_entries: bogus eid: %d", eid);
373 /* this reads enough of the header so that we can figure out all of
374 * the entry lengths and offsets. once that's done, we just read/mmap
375 * the rest of the header in.
377 * NOTE: we're assuming that the resource fork is kept at the end of
378 * the file. also, mmapping won't work for the hfs fs until it
379 * understands how to mmap header files. */
380 static int ad_header_read(const char *path _U_, struct adouble *ad, struct stat *hst)
382 char *buf = ad->ad_data;
388 /* read the header */
389 if ((header_len = adf_pread( ad->ad_mdp, buf, AD_DATASZ, 0)) < 0) {
392 if (header_len < AD_HEADER_LEN) {
397 memcpy(&ad->ad_magic, buf, sizeof( ad->ad_magic ));
398 memcpy(&ad->ad_version, buf + ADEDOFF_VERSION, sizeof( ad->ad_version ));
399 ad->ad_magic = ntohl( ad->ad_magic );
400 ad->ad_version = ntohl( ad->ad_version );
402 if ((ad->ad_magic != AD_MAGIC) || (ad->ad_version != AD_VERSION2)) {
403 LOG(log_error, logtype_default, "ad_open: can't parse AppleDouble header.");
408 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
409 nentries = ntohs( nentries );
411 /* read in all the entry headers. if we have more than the
412 * maximum, just hope that the rfork is specified early on. */
413 len = nentries*AD_ENTRY_LEN;
415 if (len + AD_HEADER_LEN > sizeof(ad->ad_data))
416 len = sizeof(ad->ad_data) - AD_HEADER_LEN;
418 buf += AD_HEADER_LEN;
419 if (len > header_len - AD_HEADER_LEN) {
420 LOG(log_error, logtype_default, "ad_header_read: can't read entry info.");
425 /* figure out all of the entry offsets and lengths. if we aren't
426 * able to read a resource fork entry, bail. */
427 nentries = len / AD_ENTRY_LEN;
428 parse_entries(ad, buf, nentries);
429 if (!ad_getentryoff(ad, ADEID_RFORK)
430 || (ad_getentryoff(ad, ADEID_RFORK) > sizeof(ad->ad_data))
432 LOG(log_error, logtype_default, "ad_header_read: problem with rfork entry offset.");
437 if (ad_getentryoff(ad, ADEID_RFORK) > header_len) {
438 LOG(log_error, logtype_default, "ad_header_read: can't read in entries.");
445 if (fstat(ad->ad_mdp->adf_fd, &st) < 0) {
446 return 1; /* fail silently */
450 ad->ad_rlen = hst->st_size - ad_getentryoff(ad, ADEID_RFORK);
455 /* Read an ._ file, only uses the resofork, finderinfo is taken from EA */
456 static int ad_header_read_osx(const char *path _U_, struct adouble *ad, struct stat *hst)
459 struct adouble adosx;
460 char *buf = &adosx.ad_data[0];
466 memset(buf, 0, sizeof(adosx.ad_data));
468 /* read the header */
469 EC_NEG1( header_len = adf_pread(ad->ad_rfp, buf, AD_DATASZ_OSX, 0) );
471 if (header_len < AD_HEADER_LEN) {
476 memcpy(&adosx.ad_magic, buf, sizeof(adosx.ad_magic));
477 memcpy(&adosx.ad_version, buf + ADEDOFF_VERSION, sizeof(adosx.ad_version));
478 adosx.ad_magic = ntohl(adosx.ad_magic);
479 adosx.ad_version = ntohl(adosx.ad_version);
481 if ((adosx.ad_magic != AD_MAGIC) || (adosx.ad_version != AD_VERSION2)) {
482 LOG(log_error, logtype_afpd, "ad_header_read_osx: can't parse AppleDouble header");
487 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
488 nentries = ntohs(nentries);
489 len = nentries * AD_ENTRY_LEN;
491 if (len + AD_HEADER_LEN > sizeof(adosx.ad_data))
492 len = sizeof(adosx.ad_data) - AD_HEADER_LEN;
494 buf += AD_HEADER_LEN;
495 if (len > header_len - AD_HEADER_LEN) {
496 LOG(log_error, logtype_afpd, "ad_header_read_osx: can't read entry info.");
501 nentries = len / AD_ENTRY_LEN;
502 parse_entries(&adosx, buf, nentries);
504 if (ad_getentryoff(&adosx, ADEID_RFORK) == 0
505 || ad_getentryoff(&adosx, ADEID_RFORK) > sizeof(ad->ad_data)
506 || ad_getentryoff(&adosx, ADEID_RFORK) > header_len
508 LOG(log_error, logtype_afpd, "ad_header_read_osx: problem with rfork entry offset.");
515 EC_NEG1( fstat(ad_reso_fileno(ad), &st) );
518 ad_setentryoff(ad, ADEID_RFORK, ad_getentryoff(&adosx, ADEID_RFORK));
519 ad->ad_rlen = hst->st_size - ad_getentryoff(ad, ADEID_RFORK);
525 static int ad_header_read_ea(const char *path, struct adouble *ad, struct stat *hst _U_)
530 char *buf = ad->ad_data;
532 /* read the header */
533 if ((ad_meta_fileno(ad) == -1)
534 && (ad->ad_adflags & ADFLAGS_RDWR)) {
535 LOG(log_error, logtype_default, "ad_header_read_ea: need filedescriptor for rw access");
539 if (ad_meta_fileno(ad) != -1)
540 header_len = sys_fgetxattr(ad_meta_fileno(ad), AD_EA_META, ad->ad_data, AD_DATASZ_EA);
542 header_len = sys_lgetxattr(path, AD_EA_META, ad->ad_data, AD_DATASZ_EA);
543 if (header_len < 1) {
544 LOG(log_debug, logtype_default, "ad_header_read_ea: %s", strerror(errno));
548 if (header_len < AD_HEADER_LEN) {
549 LOG(log_error, logtype_default, "ad_header_read_ea: bogus AppleDouble header.");
554 memcpy(&ad->ad_magic, buf, sizeof( ad->ad_magic ));
555 memcpy(&ad->ad_version, buf + ADEDOFF_VERSION, sizeof( ad->ad_version ));
557 ad->ad_magic = ntohl( ad->ad_magic );
558 ad->ad_version = ntohl( ad->ad_version );
560 if ((ad->ad_magic != AD_MAGIC) || (ad->ad_version != AD_VERSION2)) {
561 LOG(log_error, logtype_default, "ad_header_read_ea: wrong magic or version");
566 memcpy(&nentries, buf + ADEDOFF_NENTRIES, sizeof( nentries ));
567 nentries = ntohs( nentries );
569 /* Protect against bogus nentries */
570 len = nentries * AD_ENTRY_LEN;
571 if (len + AD_HEADER_LEN > sizeof(ad->ad_data))
572 len = sizeof(ad->ad_data) - AD_HEADER_LEN;
573 if (len > header_len - AD_HEADER_LEN) {
574 LOG(log_error, logtype_default, "ad_header_read_ea: can't read entry info.");
578 nentries = len / AD_ENTRY_LEN;
580 /* Now parse entries */
581 parse_entries(ad, buf + AD_HEADER_LEN, nentries);
587 * Takes a path to an AppleDouble file and creates the parrent .AppleDouble directory
590 * path: "/path/.AppleDouble/file"
591 * => mkdir("/path/.AppleDouble/") (in ad_mkdir())
593 static int ad_mkrf(const char *path)
597 * Probably .AppleDouble doesn't exist, try to mkdir it.
599 if (NULL == ( slash = strrchr( path, '/' )) ) {
604 if ( ad_mkdir( path, 0777 ) < 0 ) {
611 static int ad_mkrf_ea(const char *path _U_)
613 AFP_PANIC("ad_mkrf_ea: dont use");
617 static int ad_mkrf_osx(const char *path _U_)
623 if we are root change path user/ group
624 It can be a native function for BSD cf. FAQ.Q10
625 path: pathname to chown
626 stbuf: parent directory inode
628 use fstat and fchown or lchown with linux?
630 #define EMULATE_SUIDDIR
632 static int ad_chown(const char *path, struct stat *stbuf)
635 #ifdef EMULATE_SUIDDIR
638 if (default_uid != (uid_t)-1) {
639 /* we are root (admin) */
640 id = (default_uid)?default_uid:stbuf->st_uid;
641 ret = lchown( path, id, stbuf->st_gid );
647 #define DEFMASK 07700 /* be conservative */
650 return access right and inode of path parent directory
652 static int ad_mode_st(const char *path, mode_t *mode, struct stat *stbuf)
657 if (ad_stat(path, stbuf) != 0) {
661 *mode &= stbuf->st_mode;
665 /* --------------------------- */
666 static int ad_header_upgrade(struct adouble *ad _U_, const char *name _U_)
671 static int ad_header_upgrade_ea(struct adouble *ad _U_, const char *name _U_)
673 AFP_PANIC("ad_header_upgrade_ea: dont use");
678 * Error handling for adouble header(=metadata) file open error
680 * We're called because opening ADFLAGS_HF caused an error.
681 * 1. In case ad_open is called with ADFLAGS_NOHF the error is suppressed.
682 * 2. If ad_open was called with ADFLAGS_DF we may have opened the datafork and thus
683 * ought to close it before returning with an error condition.
685 static int ad_error(struct adouble *ad, int adflags)
688 if (adflags & ADFLAGS_NOHF) { /* 1 */
689 ad->ad_adflags &= ~ADFLAGS_HF;
692 if (adflags & ADFLAGS_DF) { /* 2 */
693 ad_close( ad, ADFLAGS_DF );
699 /* Map ADFLAGS to open() flags */
700 static int ad2openflags(int adflags)
704 if (adflags & ADFLAGS_RDWR)
706 if (adflags & ADFLAGS_RDONLY) {
707 if (adflags & ADFLAGS_SETSHRMD)
712 if (adflags & ADFLAGS_CREATE)
714 if (adflags & ADFLAGS_EXCL)
716 if (adflags & ADFLAGS_TRUNC)
722 static int ad_open_df(const char *path, int adflags, mode_t mode, struct adouble *ad)
730 LOG(log_debug, logtype_default, "ad_open_df(\"%s\", %04o)",
731 fullpathname(path), mode);
733 if (ad_data_fileno(ad) != -1) {
734 /* the file is already open, but we want write access: */
735 if ((adflags & ADFLAGS_RDWR)
736 /* and it was denied the first time: */
737 && (ad->ad_data_fork.adf_flags & O_RDONLY)) {
741 /* it's not new anymore */
742 ad->ad_data_fork.adf_flags &= ~( O_TRUNC | O_CREAT );
743 ad->ad_data_fork.adf_refcount++;
747 oflags = O_NOFOLLOW | ad2openflags(adflags);
750 if ((adflags & ADFLAGS_CREATE)) {
751 st_invalid = ad_mode_st(path, &admode, &st_dir);
752 if ((ad->ad_options & ADVOL_UNIXPRIV))
756 ad->ad_data_fork.adf_fd = open(path, oflags, admode);
758 if (ad->ad_data_fork.adf_fd == -1) {
763 if ((adflags & ADFLAGS_SETSHRMD) && (adflags & ADFLAGS_RDONLY)) {
766 if ((ad->ad_data_fork.adf_fd = open(path, oflags, admode)) == -1)
771 case OPEN_NOFOLLOW_ERRNO:
772 ad->ad_data_fork.adf_syml = malloc(MAXPATHLEN+1);
773 if ((lsz = readlink(path, ad->ad_data_fork.adf_syml, MAXPATHLEN)) <= 0) {
774 free(ad->ad_data_fork.adf_syml);
777 ad->ad_data_fork.adf_syml[lsz] = 0;
778 ad->ad_data_fork.adf_fd = -2; /* -2 means its a symlink */
786 ad_chown(path, &st_dir); /* just created, set owner if admin (root) */
788 ad->ad_data_fork.adf_flags = oflags;
789 adf_lock_init(&ad->ad_data_fork);
790 ad->ad_data_fork.adf_refcount++;
795 /* TODO: error handling */
796 static int ad_open_hf_v2(const char *path, int adflags, mode_t mode, struct adouble *ad)
800 struct stat *pst = NULL;
802 int oflags, nocreatflags;
806 if (ad_meta_fileno(ad) != -1) {
807 /* the file is already open, but we want write access: */
808 if ((adflags & ADFLAGS_RDWR) &&
809 /* and it was already denied: */
810 (ad->ad_mdp->adf_flags & O_RDONLY)) {
814 ad_refresh(path, ad);
815 /* it's not new anymore */
816 ad->ad_mdp->adf_flags &= ~( O_TRUNC | O_CREAT );
817 ad->ad_mdp->adf_refcount++;
821 ad_p = ad->ad_ops->ad_path(path, adflags);
822 oflags = O_NOFOLLOW | ad2openflags(adflags);
823 nocreatflags = oflags & ~(O_CREAT | O_EXCL);
825 ad->ad_mdp->adf_fd = open(ad_p, nocreatflags);
827 if (ad->ad_mdp->adf_fd != -1) {
828 ad->ad_mdp->adf_flags = nocreatflags;
834 if ((adflags & ADFLAGS_RDONLY) && (adflags & ADFLAGS_SETSHRMD)) {
835 nocreatflags &= ~O_RDWR;
836 nocreatflags |= O_RDONLY;
837 if ((ad->ad_mdp->adf_fd = open(ad_p, nocreatflags)) == -1)
839 ad->ad_mdp->adf_flags = nocreatflags;
844 if (!(oflags & O_CREAT))
845 return ad_error(ad, adflags);
847 * We're expecting to create a new adouble header file here
849 LOG(log_debug, logtype_default, "ad_open(\"%s\"): creating adouble file",
853 st_invalid = ad_mode_st(ad_p, &admode, &st_dir);
854 if ((ad->ad_options & ADVOL_UNIXPRIV))
856 admode = ad_hf_mode(admode);
857 if ((errno == ENOENT) && (ad->ad_vers != AD_VERSION2_OSX)) {
858 if (ad->ad_ops->ad_mkrf( ad_p) < 0) {
859 return ad_error(ad, adflags);
862 st_invalid = ad_mode_st(ad_p, &admode, &st_dir);
863 if ((ad->ad_options & ADVOL_UNIXPRIV))
865 admode = ad_hf_mode(admode);
868 /* retry with O_CREAT */
869 ad->ad_mdp->adf_fd = open(ad_p, oflags, admode);
870 if ( ad->ad_mdp->adf_fd < 0 )
871 return ad_error(ad, adflags);
873 ad->ad_mdp->adf_flags = oflags;
874 /* just created, set owner if admin owner (root) */
876 ad_chown(ad_p, &st_dir);
883 if (!(ad->ad_mdp->adf_flags & O_CREAT)) {
884 /* check for 0 length files, treat them as new. */
885 if (fstat(ad->ad_mdp->adf_fd, &st_meta) == 0) {
886 if (st_meta.st_size == 0)
887 ad->ad_mdp->adf_flags |= O_TRUNC;
889 /* we have valid data in st_meta stat structure, reused it in ad_header_read */
894 adf_lock_init(ad->ad_mdp);
895 ad->ad_mdp->adf_refcount = 1;
897 if ((ad->ad_mdp->adf_flags & ( O_TRUNC | O_CREAT ))) {
898 /* This is a new adouble header file, create it */
899 if (new_ad_header(ad, path, pst, adflags) < 0) {
901 /* the file is already deleted, perm, whatever, so return an error */
902 ad_close(ad, adflags);
908 /* Read the adouble header in and parse it.*/
909 if (ad->ad_ops->ad_header_read(path, ad, pst) < 0
910 || ad->ad_ops->ad_header_upgrade(ad, ad_p) < 0) {
912 ad_close(ad, adflags);
921 /* TODO: error handling */
922 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)
954 ad->ad_mdp->adf_flags = oflags;
956 ad->ad_mdp->adf_refcount = 1;
959 /* Read the adouble header in and parse it.*/
960 if (ad->ad_ops->ad_header_read(path, ad, NULL) != 0) {
961 LOG(log_error, logtype_default, "ad_open_hf_ea: no EA adouble");
963 if (!(adflags & ADFLAGS_CREATE)) {
968 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\"): creating metadata EA", path);
970 /* It doesnt exist, EPERM or another error */
971 if (!(errno == ENOATTR || errno == ENOENT)) {
972 LOG(log_error, logtype_default, "ad_open_hf_ea: unexpected: %s", strerror(errno));
977 if (new_ad_header(ad, path, NULL, adflags) < 0) {
978 LOG(log_error, logtype_default, "ad_open_hf_ea: can't create new header: %s",
982 ad->ad_mdp->adf_flags |= O_CREAT; /* mark as just created */
984 LOG(log_debug, logtype_default, "ad_open_hf_ea(\"%s\"): created metadata EA", path);
987 (void)ad_reso_size(path, adflags, ad);
992 if (ad_meta_fileno(ad) != -1) {
993 close(ad_meta_fileno(ad));
994 ad_meta_fileno(ad) = -1;
995 ad->ad_mdp->adf_refcount = 0;
997 return ad_error(ad, adflags);
1000 static int ad_open_hf(const char *path, int adflags, int mode, struct adouble *ad)
1004 LOG(log_debug, logtype_default, "ad_open_hf(\"%s\", %04o)", path, mode);
1006 memset(ad->ad_eid, 0, sizeof( ad->ad_eid ));
1009 switch (ad->ad_vers) {
1011 ret = ad_open_hf_v2(path, adflags, mode, ad);
1014 ret = ad_open_hf_ea(path, adflags, mode, ad);
1022 return ad_error(ad, adflags);
1028 * Get resofork length for adouble:ea
1030 static int ad_reso_size(const char *path, int adflags, struct adouble *ad)
1035 LOG(log_debug, logtype_default, "ad_reso_size(\"%s\")", path);
1039 int eafd = ad_reso_fileno(ad);
1041 EC_NEG1( eafd = sys_getxattrfd(path, O_RDONLY) );
1044 EC_NEG1( rlen = fstat(eafd, &st) );
1045 ad->ad_rlen = st.st_size;
1048 EC_NULL_LOG( rfpath = ad->ad_ops->ad_path(path, adflags));
1049 EC_ZERO( lstat(rfpath, &st));
1050 if (st.st_size > ADEDOFF_RFORK_OSX)
1051 ad->ad_rlen = st.st_size - ADEDOFF_RFORK_OSX;
1056 LOG(log_debug, logtype_default, "ad_reso_size(\"%s\"): size: %zd", path, ad->ad_rlen);
1069 * Open ressource fork
1071 * Only for adouble:ea, a nullop otherwise because adouble:v2 has the ressource fork as part
1072 * of the adouble file which is openend by ADFLAGS_HF.
1074 static int ad_open_rf(const char *path, int adflags, int mode, struct adouble *ad)
1078 int closeflags = adflags & (ADFLAGS_DF | ADFLAGS_HF);
1085 if (ad->ad_vers != AD_VERSION_EA)
1088 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\", %04o)", path, mode);
1090 oflags = O_NOFOLLOW | (ad2openflags(adflags) & ~O_CREAT);
1092 if (ad_reso_fileno(ad) != -1) {
1093 /* the file is already open, but we want write access: */
1094 if ((adflags & ADFLAGS_RDWR)
1095 /* and it was already denied: */
1096 && (ad->ad_rfp->adf_flags & O_RDONLY)) {
1100 ad->ad_rfp->adf_flags &= ~( O_TRUNC | O_CREAT );
1101 ad->ad_rfp->adf_refcount++;
1102 EC_NEG1_LOG( ad_reso_size(path, adflags, ad));
1106 if ((ad_reso_fileno(ad) = sys_getxattrfd(path, oflags)) == -1) {
1107 if (!(adflags & ADFLAGS_CREATE))
1110 EC_NEG1_LOG( ad_reso_fileno(ad) = sys_getxattrfd(path, oflags, 0666) );
1113 EC_NULL_LOG( rfpath = ad->ad_ops->ad_path(path, adflags) );
1114 if ((ad_reso_fileno(ad) = open(rfpath, oflags)) == -1) {
1115 if (!(adflags & ADFLAGS_CREATE))
1118 EC_NEG1_LOG( ad_reso_fileno(ad) = open(rfpath, oflags, mode) );
1119 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork: \"%s\"",
1124 ad->ad_rfp->adf_refcount = 1;
1125 ad->ad_rfp->adf_flags = oflags;
1128 EC_ZERO_LOG( fstat(ad_reso_fileno(ad), &st) );
1129 if (ad->ad_rfp->adf_flags & O_CREAT) {
1130 /* This is a new adouble header file, create it */
1131 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork, initializing: \"%s\"",
1133 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): created adouble rfork, flushing: \"%s\"",
1137 /* Read the adouble header */
1138 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): reading adouble rfork: \"%s\"",
1140 EC_NEG1_LOG( ad_header_read_osx(NULL, ad, &st) );
1144 EC_NEG1_LOG( ad_reso_size(path, adflags, ad));
1148 if (ad_reso_fileno(ad) != -1) {
1149 close(ad_reso_fileno(ad));
1150 ad_reso_fileno(ad) = -1;
1151 ad->ad_rfp->adf_refcount = 0;
1154 (void)ad_close(ad, closeflags);
1159 LOG(log_debug, logtype_default, "ad_open_rf(\"%s\"): END", path);
1164 /***********************************************************************************
1166 ********************************************************************************* */
1168 const char *ad_path_ea( const char *path, int adflags _U_)
1173 const char *ad_path_osx(const char *path, int adflags _U_)
1175 static char pathbuf[ MAXPATHLEN + 1];
1176 char c, *slash, buf[MAXPATHLEN + 1];
1178 if (!strcmp(path,".")) {
1180 getcwd(buf, MAXPATHLEN);
1183 strlcpy(buf, path, MAXPATHLEN +1);
1185 if (NULL != ( slash = strrchr( buf, '/' )) ) {
1188 strlcpy( pathbuf, buf, MAXPATHLEN +1);
1191 pathbuf[ 0 ] = '\0';
1194 strlcat( pathbuf, "._", MAXPATHLEN +1);
1195 strlcat( pathbuf, slash, MAXPATHLEN +1);
1200 * Put the .AppleDouble where it needs to be:
1202 * / a/.AppleDouble/b
1204 * \ b/.AppleDouble/.Parent
1206 * FIXME: should do something for pathname > MAXPATHLEN
1208 const char *ad_path( const char *path, int adflags)
1210 static char pathbuf[ MAXPATHLEN + 1];
1214 if ( adflags & ADFLAGS_DIR ) {
1215 l = strlcpy( pathbuf, path, sizeof(pathbuf));
1217 if ( l && l < MAXPATHLEN) {
1220 strlcpy(pathbuf +l, ".AppleDouble/.Parent", sizeof(pathbuf) -l);
1222 if (NULL != ( slash = strrchr( path, '/' )) ) {
1225 /* XXX we must return NULL here and test in the caller */
1228 memcpy( pathbuf, path, l);
1233 l += strlcpy( pathbuf +l, ".AppleDouble/", sizeof(pathbuf) -l);
1234 strlcpy( pathbuf + l, slash, sizeof(pathbuf) -l);
1240 /* -------------------------
1241 * Support inherited protection modes for AppleDouble files. The supplied
1242 * mode is ANDed with the parent directory's mask value in lieu of "umask",
1243 * and that value is returned.
1245 char *ad_dir(const char *path)
1247 static char modebuf[ MAXPATHLEN + 1];
1250 * For a path with directories in it, remove the final component
1251 * (path or subdirectory name) to get the name we want to stat.
1252 * For a path which is just a filename, use "." instead.
1254 slash = strrchr( path, '/' );
1259 if (len >= MAXPATHLEN) {
1260 errno = ENAMETOOLONG;
1261 return NULL; /* can't do it */
1263 memcpy( modebuf, path, len );
1264 modebuf[len] = '\0';
1265 /* is last char a '/' ? */
1266 if (slash[1] == 0) {
1267 slash = modebuf+ len;
1269 while (modebuf < slash && slash[-1] == '/') {
1272 if (modebuf == slash) {
1276 while (modebuf < slash && *slash != '/') {
1279 if (modebuf == slash) {
1282 *slash = '\0'; /* remove pathname component */
1287 modebuf[0] = '.'; /* use current directory */
1292 int ad_setfuid(const uid_t id)
1298 /* ---------------- */
1299 uid_t ad_getfuid(void)
1305 stat path parent directory
1307 int ad_stat(const char *path, struct stat *stbuf)
1314 return lstat( p, stbuf );
1318 return access right of path parent directory
1320 int ad_mode( const char *path, mode_t mode)
1323 ad_mode_st(path, &mode, &stbuf);
1328 * Use mkdir() with mode bits taken from ad_mode().
1330 int ad_mkdir( const char *path, mode_t mode)
1336 LOG(log_debug, logtype_default, "ad_mkdir(\"%s\", %04o) {cwd: \"%s\"}",
1337 path, mode, getcwdpath());
1339 st_invalid = ad_mode_st(path, &mode, &stbuf);
1340 ret = mkdir( path, mode );
1341 if (ret || st_invalid)
1343 ad_chown(path, &stbuf);
1348 static void ad_init_func(struct adouble *ad)
1350 switch (ad->ad_vers) {
1352 ad->ad_ops = &ad_adouble;
1353 ad->ad_rfp = &ad->ad_resource_fork;
1354 ad->ad_mdp = &ad->ad_resource_fork;
1357 ad->ad_ops = &ad_adouble_ea;
1358 ad->ad_rfp = &ad->ad_resource_fork;
1359 ad->ad_mdp = &ad->ad_data_fork;
1362 AFP_PANIC("ad_init: unknown AD version");
1366 ad_data_fileno(ad) = -1;
1367 ad_reso_fileno(ad) = -1;
1368 ad_meta_fileno(ad) = -1;
1369 ad->ad_refcount = 1;
1373 void ad_init_old(struct adouble *ad, int flags, int options)
1375 memset(ad, 0, sizeof(struct adouble));
1376 ad->ad_vers = flags;
1377 ad->ad_options = options;
1381 void ad_init(struct adouble *ad, const struct vol * restrict vol)
1383 memset(ad, 0, sizeof(struct adouble));
1384 ad->ad_vers = vol->v_adouble;
1385 ad->ad_options = vol->v_ad_options;
1390 * Open data-, metadata(header)- or ressource fork
1392 * ad_open(struct adouble *ad, const char *path, int adflags, int flags)
1393 * ad_open(struct adouble *ad, const char *path, int adflags, int flags, mode_t mode)
1395 * You must call ad_init() before ad_open, usually you'll just call it like this: \n
1398 * ad_init(&ad, vol->v_adouble, vol->v_ad_options);
1401 * Open a files data fork, metadata fork or ressource fork.
1403 * @param ad (rw) pointer to struct adouble
1404 * @param path (r) Path to file or directory
1405 * @param adflags (r) Flags specifying which fork to open, can be or'd:
1406 * ADFLAGS_DF: open data fork
1407 * ADFLAGS_RF: open ressource fork
1408 * ADFLAGS_HF: open header (metadata) file
1409 * ADFLAGS_NOHF: it's not an error if header file couldn't be created
1410 * ADFLAGS_DIR: if path is a directory you MUST or ADFLAGS_DIR to adflags
1412 * Access mode for the forks:
1413 * ADFLAGS_RDONLY: open read only
1414 * ADFLAGS_RDWR: open read write
1417 * ADFLAGS_CREATE: create if not existing
1418 * ADFLAGS_TRUNC: truncate
1421 * ADFLAGS_CHECK_OF: check for open forks from us and other afpd's
1422 * ADFLAGS_SETSHRMD: this adouble struct will be used to set sharemode locks.
1423 * This basically results in the files being opened RW instead of RDONLY.
1424 * @param mode (r) mode used with O_CREATE
1426 * The open mode flags (rw vs ro) have to take into account all the following requirements:
1427 * - we remember open fds for files because me must avoid a single close releasing fcntl locks for other
1428 * fds of the same file
1430 * @returns 0 on success, any other value indicates an error
1432 int ad_open(struct adouble *ad, const char *path, int adflags, ...)
1438 LOG(log_debug, logtype_default, "ad_open(\"%s\", %s)",
1439 fullpathname(path), adflags2logstr(adflags));
1441 if (adflags & ADFLAGS_CHECK_OF)
1442 /* Checking for open forks requires sharemode lock support (ie RDWR instead of RDONLY) */
1443 adflags |= ADFLAGS_SETSHRMD;
1445 if ((ad->ad_vers == AD_VERSION_EA) && (adflags & ADFLAGS_SETSHRMD))
1446 /* adouble:ea sets sharemode locks on the datafork */
1447 adflags |= ADFLAGS_DF;
1449 if (ad->ad_inited != AD_INITED) {
1450 ad->ad_adflags = adflags;
1451 ad->ad_inited = AD_INITED;
1453 ad->ad_open_forks = ((ad->ad_data_fork.adf_refcount > 0) ? ATTRBIT_DOPEN : 0);
1454 if (ad->ad_resource_fork.adf_refcount > 0)
1455 ad->ad_open_forks |= ATTRBIT_ROPEN;
1458 va_start(args, adflags);
1459 if (adflags & ADFLAGS_CREATE)
1460 mode = va_arg(args, mode_t);
1463 if (adflags & ADFLAGS_DF) {
1464 EC_ZERO( ad_open_df(path, adflags, mode, ad) );
1465 ad->ad_adflags |= ADFLAGS_DF;
1468 if (adflags & ADFLAGS_HF) {
1469 EC_ZERO( ad_open_hf(path, adflags, mode, ad) );
1470 ad->ad_adflags |= ADFLAGS_HF;
1473 if (adflags & ADFLAGS_RF) {
1474 EC_ZERO( ad_open_rf(path, adflags, mode, ad) );
1475 ad->ad_adflags |= ADFLAGS_RF;
1478 if (adflags & ADFLAGS_CHECK_OF) {
1479 ad->ad_open_forks |= ad_openforks(ad, ad->ad_open_forks);
1487 * @brief open metadata, possibly as root
1489 * Return only metadata but try very hard ie at first try as user, then try as root.
1491 * @param name name of file/dir
1492 * @param flags ADFLAGS_DIR: name is a directory \n
1493 * ADFLAGS_CHECK_OF: test if name is open by us or another afpd process
1495 * @param adp pointer to struct adouble
1497 int ad_metadata(const char *name, int flags, struct adouble *adp)
1500 int ret, err, oflags;
1502 /* Sanitize flags */
1503 oflags = (flags & (ADFLAGS_CHECK_OF | ADFLAGS_DIR)) | ADFLAGS_HF | ADFLAGS_RDONLY;
1505 if ((ret = ad_open(adp, name, oflags)) < 0 && errno == EACCES) {
1508 LOG(log_error, logtype_default, "ad_metadata(%s): seteuid failed %s", name, strerror(errno));
1512 /* we are root open read only */
1513 ret = ad_open(adp, name, oflags);
1515 if ( seteuid(uid) < 0) {
1516 LOG(log_error, logtype_default, "ad_metadata: can't seteuid back");
1526 * @brief openat like wrapper for ad_metadata
1528 int ad_metadataat(int dirfd, const char *name, int flags, struct adouble *adp)
1534 if ((cwdfd = open(".", O_RDONLY) == -1) || (fchdir(dirfd) != 0)) {
1540 if (ad_metadata(name, flags, adp) < 0) {
1547 if (fchdir(cwdfd) != 0) {
1548 LOG(log_error, logtype_afpd, "ad_openat: cant chdir back, exiting");
1561 int ad_refresh(const char *path, struct adouble *ad)
1563 switch (ad->ad_vers) {
1565 if (ad_meta_fileno(ad) == -1)
1567 return ad->ad_ops->ad_header_read(NULL, ad, NULL);
1571 if (AD_META_OPEN(ad)) {
1572 if (ad_data_fileno(ad) == -1)
1574 // TODO: read meta EA
1577 if (AD_RSRC_OPEN(ad)) {
1578 if (ad_reso_fileno(ad) == -1)
1581 if ((len = fstat(ad_reso_fileno(ad))) == -1)
1586 if (AD_META_OPEN(ad)) {
1587 if (ad_data_fileno(ad) == -1)
1589 // TODO: read meta EA
1591 if (AD_RSRC_OPEN(ad)) {
1592 if (ad_reso_fileno(ad) == -1)
1594 if (ad_header_read_osx(path, ad, NULL) < 0)
1598 return ad->ad_ops->ad_header_read(path, ad, NULL);
1607 int ad_openat(struct adouble *ad,
1608 int dirfd, /* dir fd openat like */
1618 if ((cwdfd = open(".", O_RDONLY) == -1) || (fchdir(dirfd) != 0))
1622 va_start(args, adflags);
1623 if (adflags & ADFLAGS_CREATE)
1624 mode = va_arg(args, mode_t);
1627 EC_NEG1( ad_open(ad, path, adflags, mode) );
1630 if (fchdir(cwdfd) != 0) {
1631 AFP_PANIC("ad_openat: cant chdir back");