etc/afpd/directory.h

   1 /*
   2  * $Id: directory.h,v 1.17 2003-06-06 20:36:59 srittau 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     struct dir  *dir;               /* */
  67     int         st_valid;           /* does st_errno and st set */
  68     int         st_errno;
  69     struct stat st;
  70 };
  71
  72 #define path_isadir(o_path) \
  73         ((o_path)->dir != NULL)
  74 #if 0
  75         ((o_path)->m_name == '\0' || /* we are in a it */ \
  76          !(o_path)->st_valid ||      /* in cache but we can't chdir in it */ \
  77          (!(o_path)->st_errno && S_ISDIR((o_path)->st.st_mode)) /* not in cache an can't chdir */ \
  78         )
  79 #endif
  80
  81 /* child addition/removal macros */
  82 #define dirchildadd(a, b) do { \
  83         if (!(a)->d_child) \
  84                 (a)->d_child = (b); \
  85         else { \
  86                 (b)->d_next = (a)->d_child; \
  87                 (b)->d_prev = (b)->d_next->d_prev; \
  88                 (b)->d_next->d_prev = (b); \
  89                 (b)->d_prev->d_next = (b); \
  90         } \
  91 } while (0)
  92
  93 #define dirchildremove(a,b) do { \
  94         if ((a)->d_child == (b)) \
  95                 (a)->d_child = ((b) == (b)->d_next) ? NULL : (b)->d_next; \
  96         (b)->d_next->d_prev = (b)->d_prev; \
  97         (b)->d_prev->d_next = (b)->d_next; \
  98         (b)->d_next = (b)->d_prev = (b); \
  99 } while (0)
 100
 101 #define DIRTREE_COLOR_RED    0
 102 #define DIRTREE_COLOR_BLACK  1
 103
 104 /* setgid directories */
 105 #ifndef DIRBITS
 106 # ifdef AFS
 107 #  define DIRBITS 0
 108 # else /* AFS */
 109 #  define DIRBITS S_ISGID
 110 # endif /* AFS */
 111 #endif /* DIRBITS */
 112
 113 #define DIRF_FSMASK     (3<<0)
 114 #define DIRF_NOFS       (0<<0)
 115 #define DIRF_AFS        (1<<0)
 116 #define DIRF_UFS        (2<<0)
 117
 118 #define AFPDIR_READ     (1<<0)
 119
 120 /* directory bits */
 121 #define DIRPBIT_ATTR    0
 122 #define DIRPBIT_PDID    1
 123 #define DIRPBIT_CDATE   2
 124 #define DIRPBIT_MDATE   3
 125 #define DIRPBIT_BDATE   4
 126 #define DIRPBIT_FINFO   5
 127 #define DIRPBIT_LNAME   6
 128 #define DIRPBIT_SNAME   7
 129 #define DIRPBIT_DID     8
 130 #define DIRPBIT_OFFCNT  9
 131 #define DIRPBIT_UID     10
 132 #define DIRPBIT_GID     11
 133 #define DIRPBIT_ACCESS  12
 134 #define DIRPBIT_PDINFO  13         /* ProDOS Info */
 135 #define DIRPBIT_UNIXPR  15
 136
 137 /* directory attribute bits (see file.h for other bits) */
 138 #define ATTRBIT_EXPFOLDER   (1 << 1) /* shared point */
 139 #define ATTRBIT_MOUNTED     (1 << 3) /* mounted share point by non-admin */
 140 #define ATTRBIT_INEXPFOLDER (1 << 4) /* folder in a shared area */
 141
 142 #define FILDIRBIT_ISDIR        (1 << 7) /* is a directory */
 143 #define FILDIRBIT_ISFILE       (0)      /* is a file */
 144
 145 /* reserved directory id's */
 146 #define DIRDID_ROOT_PARENT    htonl(1)  /* parent directory of root */
 147 #define DIRDID_ROOT           htonl(2)  /* root directory */
 148
 149 /* file/directory ids. what a mess. we scramble things in a vain attempt
 150  * to get something meaningful */
 151 #ifndef AFS
 152 #define CNID_XOR(a)  (((a) >> 16) ^ (a))
 153 #define CNID_DEV(a)   ((((CNID_XOR(major((a)->st_dev)) & 0xf) << 3) | \
 154         (CNID_XOR(minor((a)->st_dev)) & 0x7)) << 24)
 155 #define CNID_INODE(a) (((a)->st_ino ^ (((a)->st_ino & 0xff000000) >> 8)) \
 156                                        & 0x00ffffff)
 157 #define CNID_FILE(a)  (((a) & 0x1) << 31)
 158 #define CNID(a,b)     (CNID_DEV(a) | CNID_INODE(a) | CNID_FILE(b))
 159 #else /* AFS */
 160 #define CNID(a,b)     (((a)->st_ino & 0x7fffffff) | CNID_FILE(b))
 161 #endif /* AFS */
 162
 163
 164 struct maccess {
 165     u_char      ma_user;
 166     u_char      ma_world;
 167     u_char      ma_group;
 168     u_char      ma_owner;
 169 };
 170
 171 #define AR_USEARCH      (1<<0)
 172 #define AR_UREAD        (1<<1)
 173 #define AR_UWRITE       (1<<2)
 174 #define AR_UOWN         (1<<7)
 175
 176 extern struct dir       *dirnew __P((const char *, const char *));
 177 extern void             dirfreename __P((struct dir *));
 178 extern void             dirfree __P((struct dir *));
 179 extern struct dir       *dirsearch __P((const struct vol *, u_int32_t));
 180 extern struct dir       *dirlookup __P((const struct vol *, u_int32_t));
 181 extern struct dir       *dirsearch_byname __P((struct dir *,const char *));
 182
 183 extern struct dir       *adddir __P((struct vol *, struct dir *,
 184                                                struct path *));
 185
 186 extern struct dir       *dirinsert __P((struct vol *, struct dir *));
 187 extern int              movecwd __P((const struct vol *, struct dir *));
 188 extern int              deletecurdir __P((const struct vol *, char *, int));
 189 extern struct path      *cname __P((const struct vol *, struct dir *,
 190                              char **));
 191 extern mode_t           mtoumode __P((struct maccess *));
 192 extern void             utommode __P((struct stat *, struct maccess *));
 193 extern int getdirparams __P((const struct vol *, u_int16_t, struct path *,
 194                                  struct dir *, char *, int *));
 195 extern int setdirparams __P((const struct vol *, struct path *, u_int16_t, char *));
 196 extern int renamedir __P((char *, char *, struct dir *,
 197                               struct dir *, char *, const int));
 198 extern int path_error __P((struct path *, int error));
 199
 200 typedef int (*dir_loop)(struct dirent *, char *, void *);
 201
 202 extern int  for_each_dirent __P((const struct vol *, char *, dir_loop , void *));
 203
 204 extern int  check_access __P((char *name , int mode));
 205 extern int file_access   __P((struct path *path, int mode));
 206
 207 extern int netatalk_unlink __P((const char *name));
 208
 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
 220 /* from enumerate.c */
 221 extern int      afp_enumerate __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 222 extern int      afp_enumerate_ext __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 223 extern int      afp_enumerate_ext2 __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
 224
 225 /* from catsearch.c */
 226 extern int      afp_catsearch __P((AFPObj *, char *, int, char *, int *));
 227 extern int      afp_catsearch_ext __P((AFPObj *, char *, int, char *, int *));
 228
 229 #endif