globals.h

Go to the documentation of this file.

/*
 * Copyright (c) 1990,1993 Regents of The University of Michigan.
 * All Rights Reserved.  See COPYRIGHT.
 */
 
#ifndef AFPD_GLOBALS_H
#define AFPD_GLOBALS_H 1
 
#include <grp.h>
#ifdef HAVE_INIPARSER_INIPARSER_H
#include <iniparser/iniparser.h>
#else
#include <iniparser.h>
#endif
#include <netdb.h>
#include <stdbool.h>
#include <sys/param.h>
#include <sys/types.h>
 
#include <netatalk/at.h>
#include <atalk/afp.h>
#include <atalk/compat.h>
#include <atalk/uam.h>
#include <atalk/unicode.h>
 
#ifdef WITH_DTRACE
#include <atalk/afp_dtrace.h>
#else
/* List of empty dtrace macros */
#define AFP_AFPFUNC_START(a,b)
#define AFP_AFPFUNC_DONE(a, b)
#define AFP_CNID_START(a)
#define AFP_CNID_DONE()
#define AFP_READ_START(a)
#define AFP_READ_DONE()
#define AFP_WRITE_START(a)
#define AFP_WRITE_DONE()
#endif
 
/* #define DOSFILELEN 12 */             /* Type1, DOS-compat*/
#define MACFILELEN 31                   
#define UTF8FILELEN_EARLY 255           
/* #define UTF8FILELEN_NAME_MAX 765 */  /* Type3, 10.4.?- , getconf NAME_MAX */
/* #define UTF8FILELEN_SPEC 0xFFFF */   /* Type3, spec on document */
/* #define HFSPLUSFILELEN 510 */        /* HFS+ spec, 510byte = 255codepoint */
 
#define MAXUSERLEN 256
#define MAXOPTLEN 256
 
#define CNID_PATH_OVERHEAD 12  /* CNID protocol header size for path resolution */
#define CNID_MAX_PATH_LEN (CNID_PATH_OVERHEAD + MAXPATHLEN + 1)  /* Maximum path length for CNID operations */
 
#define DEFAULT_DIRCACHE_SIZE 65536    
 
/* Directory cache validation settings */
#define DEFAULT_DIRCACHE_VALIDATION_FREQ    100   
#define DIRCACHE_VALIDATION_FREQ_MIN        1     
#define DIRCACHE_VALIDATION_FREQ_MAX        100   
 
#define OPTION_DEBUG         (1 << 0)
#define OPTION_CLOSEVOL      (1 << 1)
#define OPTION_SERVERNOTIF   (1 << 2)
#define OPTION_NOSENDFILE    (1 << 3)
#define OPTION_VETOMSG       (1 << 4) 
#define OPTION_STRICT_LOCKING (1 << 5)  
#define OPTION_ANNOUNCESSH   (1 << 6)
#define OPTION_UUID          (1 << 7)
#define OPTION_ACL2MACCESS   (1 << 8)
#define OPTION_NOZEROCONF    (1 << 9)
#define OPTION_ACL2MODE      (1 << 10)
#define OPTION_SHARE_RESERV  (1 << 11) 
#define OPTION_AFPSTATS      (1 << 12) 
#define OPTION_SPOTLIGHT     (1 << 13) 
#define OPTION_SPOTLIGHT_VOL (1 << 14) 
#define OPTION_RECVFILE      (1 << 15)
#define OPTION_SPOTLIGHT_EXPR (1 << 16) 
#define OPTION_DDP     (1 << 17) 
#define OPTION_VALID_SHELLCHECK (1 << 18) 
 
#define PASSWD_NONE     0
#define PASSWD_SET     (1 << 0)
#define PASSWD_NOSAVE  (1 << 1)
#define PASSWD_ALL     (PASSWD_SET | PASSWD_NOSAVE)
 
#define IS_AFP_SESSION(obj) (((obj)->dsi && (obj)->dsi->serversock == -1) || ((obj)->Type))
 
struct DSI;
 
#define AFPOBJ_TMPSIZ (MAXPATHLEN)
 
struct afp_volume_name {
    time_t     mtime;
    int        loaded;
};
 
/* Tier 2: Resource Fork data cache hard caps (in KB) */
#define RFORK_BUDGET_MAX_KB   (10 * 1024 * 1024)   
#define RFORK_ENTRY_MAX_KB    (10 * 1024)           
 
/*
 * Default 'spotlight results limit': the number of results any search
 * backend returns for one query when the option is unset. 0 removes the
 * limit for every backend.
 *
 * A nonzero value below the minimum is raised to it: the CNID search
 * pagination batch is 100 entries, so a smaller limit buys nothing and
 * costs a search that cannot fill one batch per term.
 */
#define SPOTLIGHT_RESULTS_LIMIT_DEFAULT 10000
#define SPOTLIGHT_RESULTS_LIMIT_MIN     100
 
/*
 * Upper bound on a nonzero limit. Keeps the value clear of the 32-bit
 * match counts the Xapian API uses, and bounds what one CNID query can
 * allocate: 16M CNIDs is 64 MB. Use 0 for unlimited instead.
 */
#define SPOTLIGHT_RESULTS_LIMIT_MAX     16000000
 
struct afp_options {
    int connections;            
    int tickleval;
    int timeout;
    int flags;
    int dircachesize;
    int dircache_mode;          
    int dircache_validation_freq;    
    int dircache_rfork_budget;   
    int dircache_rfork_maxentry; 
    int strict_locking_explicit; 
    int dircache_validation_freq_explicit; 
    int dircache_rfork_budget_explicit;    
    int sleep;                  
    int disconnected;           
#ifdef WITH_FCE
    int fce_fmodwait;           
    int fce_sendwait;           
#endif /* WITH_FCE */
    unsigned int tcp_sndbuf, tcp_rcvbuf;
    unsigned char passwdbits, passwdminlen;
    uint32_t server_quantum;
    int dsireadbuf; 
    char *hostname;
    char *zone;
#ifndef NO_DDP
    struct at_addr ddpaddr;
#endif
    char *listen, *interfaces, *port;
    char *Cnid_srv, *Cnid_port;
    char *configfile;
    char *uampath, *fqdn;
    char *sigconffile;
    char *uuidconf;
    char *guest, *loginmesg, *keyfile, *passwdfile, *srpverifierpath, *extmapfile;
    char *uamlist;
    char *signatureopt;
    unsigned char signature[16];
    char *k5service, *k5realm, *k5keytab;
    size_t k5principal_buflen;
    char *k5principal;
    char *unixcodepage, *maccodepage, *volcodepage;
    charset_t maccharset, unixcharset;
    mode_t umask;
    mode_t save_mask;
    gid_t admingid;
    bool afpstats_group;
    gid_t afpstats_gid;
    bool force_user;
    uid_t force_uid;
    bool force_group;
    gid_t force_gid;
    int    volnamelen;
    /* default value for winbind authentication */
    char *ntdomain, *ntseparator, *addomain;
    char *logconfig;
    char *logfile;
    bool log_us_timestamp;
    char *legacyicon;
    char *mimicmodel;
    char *servername;
    char *ignored_attr;
    int  splice_size;
    char *cnid_mysql_host;
    char *cnid_mysql_user;
    char *cnid_mysql_pw;
    char *cnid_mysql_db;
    struct afp_volume_name volfile;
    uint64_t spotlight_results_limit;
};
 
typedef struct AFPObj {
    char *cmdlineconfigfile;
    int cmdlineflags;
    int proto;
    const void *signature;
    struct DSI *dsi;
    void *handle;
#ifndef NO_DDP
    int fd;
    int statuslen;
    char aspstatus[1400];
#endif /* NO_DDP */
    struct afp_options options;
    char *Obj, *Type, *Zone;
    dictionary *iniconfig;
    char username[MAXUSERLEN];
    /* to prevent confusion, only use these in afp_* calls */
    char oldtmp[AFPOBJ_TMPSIZ + 1], newtmp[AFPOBJ_TMPSIZ + 1];
    void *uam_cookie; 
    struct session_info  sinfo;
    uid_t uid;  
    uid_t euid; 
    pid_t pid;  
    int ipc_fd; 
    int hint_fd; 
    gid_t *groups;
    int ngroups;
    int afp_version;
    int cnx_cnt, cnx_max;
    /* Functions */
    void (*logout)(void);
    void (*exit)(int);
    int (*reply)(void *, int);
    int (*attention)(void *, AFPUserBytes);
#ifdef WITH_FCE
    int fce_version;
    char *fce_ign_names;
    char *fce_ign_directories;
    char *fce_notify_script;
#endif /* WITH_FCE */
    void *sl_ctx; 
} AFPObj;

typedef int (*AFPCmd)(AFPObj *obj, char *ibuf, size_t ibuflen, char *rbuf,
                      size_t *rbuflen);
 
/* Global variables */
extern AFPObj             *AFPobj;
extern int                afp_version;
extern int                afp_errno;
extern unsigned char      nologin;
extern struct dir         *curdir;
extern char               getwdbuf[];
extern struct afp_options default_options;
extern const char         *Cnid_srv;
extern const char         *Cnid_port;
 
extern int  get_afp_errno(const int param);
extern void afp_options_init(struct afp_options *);
extern void afp_options_parse_cmdline(AFPObj *obj, int ac, char **av);
extern int setmessage(const char *);
extern void readmessage(AFPObj *);
 
#ifndef NO_DDP
extern void afp_over_asp(AFPObj *);
#endif /* NO_DDP */
extern void afp_over_dsi(AFPObj *);
extern void afp_over_dsi_sighandlers(AFPObj *obj);
#endif /* globals.h */