etc/afpd/directory.h

   1 /*
   2  * $Id: directory.h,v 1.22 2008-09-01 15:18:37 didg Exp $
   3  *
   4  * Copyright (c) 1990,1991 Regents of The University of Michigan.
   5  * All Rights Reserved.
   6  *
   7  * Permission to use, copy, modify, and distribute this software and
   8  * its documentation for any purpose and without fee is hereby granted,
   9  * provided that the above copyright notice appears in all copies and
  10  * that both that copyright notice and this permission notice appear
  11  * in supporting documentation, and that the name of The University
  12  * of Michigan not be used in advertising or publicity pertaining to
  13  * distribution of the software without specific, written prior
  14  * permission. This software is supplied as is without expressed or
  15  * implied warranties of any kind.
  16  *
  17  *      Research Systems Unix Group
  18  *      The University of Michigan
  19  *      c/o Mike Clark
  20  *      535 W. William Street
  21  *      Ann Arbor, Michigan
  22  *      +1-313-763-0525
  23  *      netatalk@itd.umich.edu
  24  */
  25
  26 #ifndef AFPD_DIRECTORY_H
  27 #define AFPD_DIRECTORY_H 1
  28
  29 #include <sys/cdefs.h>
  30 #include <sys/types.h>
  31 /*#include <sys/stat.h>*/ /* including it here causes some confusion */
  32 #include <netatalk/endian.h>
  33 #include <dirent.h>
  34
  35 /* sys/types.h usually snarfs in major/minor macros. if they don't
  36  * try this file. */
  37 #ifndef major
  38 #include <sys/sysmacros.h>
  39 #endif
  40
  41 #include "globals.h"
  42 #include "volume.h"
  43
  44 /* the did tree is now a red-black tree while the parent/child
  45  * tree is a circular doubly-linked list. how exciting. */
  46 struct dir {
  47     struct dir  *d_left, *d_right, *d_back; /* for red-black tree */
  48     int         d_color;
  49     struct dir  *d_parent, *d_child; /* parent-child */
  50     struct dir  *d_prev, *d_next;    /* siblings */
  51     void        *d_ofork;            /* oforks using this directory. */
  52     u_int32_t   d_did;
  53     int         d_flags;
  54
  55     time_t      ctime;                /* inode ctime */
  56     u_int32_t   offcnt;               /* offspring count */
  57
  58     char        *d_m_name;            /* mac name */
  59     char        *d_u_name;            /* unix name */
  60 };
  61
  62 struct path {
  63     int         m_type;             /* mac name type (long name, unicode */
  64     char        *m_name;            /* mac name */
  65     char        *u_name;            /* unix name */
  66     cnid_t      id;                 /* file id (only for getmetadata) */
  67     struct dir  *d_dir;             /* */
  68     int         st_valid;           /* does st_errno and st set */
  69     int         st_errno;
  70     struct stat st;
  71 };
  72
  73 #ifndef ATACC
  74 static __inline__ int path_isadir(struct path *o_path)
  75 {
  76     return o_path->d_dir != NULL;
  77 #if 0
  78     return o_path->m_name == '\0' || /* we are in a it */
  79            !o_path->st_valid ||      /* in cache but we can't chdir in it */
  80            (!o_path->st_errno && S_ISDIR(o_path->st.st_mode)); /* not in cache an can't chdir */
  81 #endif
  82 }
  83 #else
  84 extern int path_isadir(struct path *o_path);
  85 #endif
  86
  87 #define DIRTREE_COLOR_RED    0
  88 #define DIRTREE_COLOR_BLACK  1
  89
  90 /* setgid directories */
  91 #ifndef DIRBITS
  92 # ifdef AFS
  93 #  define DIRBITS 0
  94 # else /* AFS */
  95 #  define DIRBITS S_ISGID
  96 # endif /* AFS */
  97 #endif /* DIRBITS */
  98
  99 #define DIRF_FSMASK     (3<<0)
 100 #define DIRF_NOFS       (0<<0)
 101 #define DIRF_AFS        (1<<0)
 102 #define DIRF_UFS        (2<<0)
 103
 104 #define DIRF_OFFCNT     (1<<4)  /* offsprings count is valid */
 105 #define DIRF_CNID       (1<<5)  /* renumerate id */
 106
 107
 108 #define AFPDIR_READ     (1<<0)
 109
 110 /* directory bits */
 111 #define DIRPBIT_ATTR    0
 112 #define DIRPBIT_PDID    1
 113 #define DIRPBIT_CDATE   2
 114 #define DIRPBIT_MDATE   3
 115 #define DIRPBIT_BDATE   4
 116 #define DIRPBIT_FINFO   5
 117 #define DIRPBIT_LNAME   6
 118 #define DIRPBIT_SNAME   7
 119 #define DIRPBIT_DID     8
 120 #define DIRPBIT_OFFCNT  9
 121 #define DIRPBIT_UID     10
 122 #define DIRPBIT_GID     11
 123 #define DIRPBIT_ACCESS  12
 124 #define DIRPBIT_PDINFO  13         /* ProDOS Info */
 125 #define DIRPBIT_UNIXPR  15
 126
 127 /* directory attribute bits (see file.h for other bits) */
 128 #define ATTRBIT_EXPFOLDER   (1 << 1) /* shared point */
 129 #define ATTRBIT_MOUNTED     (1 << 3) /* mounted share point by non-admin */
 130 #define ATTRBIT_INEXPFOLDER (1 << 4) /* folder in a shared area */
 131
 132 #define FILDIRBIT_ISDIR        (1 << 7) /* is a directory */
 133 #define FILDIRBIT_ISFILE       (0)      /* is a file */
 134
 135 /* reserved directory id's */
 136 #define DIRDID_ROOT_PARENT    htonl(1)  /* parent directory of root */
 137 #define DIRDID_ROOT           htonl(2)  /* root directory */
 138
 139 /* file/directory ids. what a mess. we scramble things in a vain attempt
 140  * to get something meaningful */
 141 #ifndef AFS
 142
 143 #if 0
 144 #define CNID_XOR(a)  (((a) >> 16) ^ (a))
 145 #define CNID_DEV(a)   ((((CNID_XOR(major((a)->st_dev)) & 0xf) << 3) | \
 146         (CNID_XOR(minor((a)->st_dev)) & 0x7)) << 24)
 147 #define CNID_INODE(a) (((a)->st_ino ^ (((a)->st_ino & 0xff000000) >> 8)) \
 148                                        & 0x00ffffff)
 149 #define CNID_FILE(a)  (((a) & 0x1) << 31)
 150 #define CNID(a,b)     (CNID_DEV(a) | CNID_INODE(a) | CNID_FILE(b))
 151 #endif
 152
 153 #define CNID(a,b)     ((a)->st_ino & 0xffffffff)
 154
 155 #else /* AFS */
 156 #define CNID(a,b)     (((a)->st_ino & 0x7fffffff) | CNID_FILE(b))
 157 #endif /* AFS */
 158
 159
 160 struct maccess {
 161     u_char      ma_user;
 162     u_char      ma_world;
 163     u_char      ma_group;
 164     u_char      ma_owner;
 165 };
 166
 167 #define AR_USEARCH      (1<<0)
 168 #define AR_UREAD        (1<<1)
 169 #define AR_UWRITE       (1<<2)
 170 #define AR_UOWN         (1<<7)
 171
 172 extern struct dir       *dirnew __P((const char *, const char *));
 173 extern void             dirfreename __P((struct dir *));
 174 extern void             dirfree __P((struct dir *));
 175 extern struct dir       *dirsearch __P((const struct vol *, u_int32_t));
 176 extern struct dir       *dirlookup __P((const struct vol *, u_int32_t));
 177 extern struct dir       *dirsearch_byname __P((const struct vol *, struct dir *,char *));
 178
 179 extern struct dir       *adddir __P((struct vol *, struct dir *,
 180                                                struct path *));
 181
 182 extern int              movecwd __P((const struct vol *, struct dir *));
 183 extern int              deletecurdir __P((const struct vol *));
 184 extern struct path      *cname __P((const struct vol *, struct dir *,
 185                              char **));
 186 extern mode_t           mtoumode __P((struct maccess *));
 187 extern void             utommode __P((struct stat *, struct maccess *));
 188 extern int getdirparams __P((const struct vol *, u_int16_t, struct path *,
 189                                  struct dir *, char *, int *));
 190 extern int setdirparams __P((const struct vol *, struct path *, u_int16_t, char *));
 191 extern int renamedir __P((const struct vol *, char *, char *, struct dir *,
 192                               struct dir *, char *));
 193 extern int path_error __P((struct path *, int error));
 194
 195 extern void setdiroffcnt __P((struct dir *dir, struct stat *st,  u_int32_t count));
 196 extern int dirreenumerate __P((struct dir *dir, struct stat *st));
 197
 198 typedef int (*dir_loop)(struct dirent *, char *, void *);
 199
 200 extern int  for_each_dirent __P((const struct vol *, char *, dir_loop , void *));
 201
 202 extern int  check_access __P((char *name , int mode));
 203 extern int file_access   __P((struct path *path, int mode));
 204
 205 extern int netatalk_rmdir __P((const char *name));
 206 extern int netatalk_unlink __P((const char *name));
 207
 208 extern hash_t *dirhash __P((void));
 209 /* from enumerate.c */
 210 extern char *check_dirent __P((const struct vol *, char *));
 211
 212 /* FP functions */
 213 extern int      afp_createdir __P((AFPObj *, char *, int, char *, int *));
 214 extern int      afp_opendir __P((AFPObj *, char *, int, char *, int *));
 215 extern int      afp_setdirparams __P((AFPObj *, char *, int, char *, int *));
 216 extern int      afp_closedir __P((AFPObj *, char *, int, char *, int *));
 217 extern int      afp_mapid __P((AFPObj *, char *, int, char *, int *));
 218 extern int      afp_mapname __P((AFPObj *, char *, int, char *, int *));
 219 extern int      afp_syncdir __P((AFPObj *, char *, int, char *, int *));
 220
 221 /* from enumerate.c */
 222 extern int      afp_enumerate __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 223 extern int      afp_enumerate_ext __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 224 extern int      afp_enumerate_ext2 __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 225
 226 /* from catsearch.c */
 227 extern int      afp_catsearch __P((AFPObj *, char *, int, char *, int *));
 228 extern int      afp_catsearch_ext __P((AFPObj *, char *, int, char *, int *));
 229
 230 #endif