include/moira.h

   1 /* $Id$
   2  *
   3  * Copyright (C) 1987-1998 by the Massachusetts Institute of Technology
   4  *
   5  */
   6
   7 #ifndef _moira_h_
   8 #define _moira_h_
   9
  10 /* return values from queries (and error codes) */
  11
  12 #include <com_err.h>
  13 #include "mr_et.h"
  14 #include "krb_et.h"
  15 #include "gdss_et.h"
  16 #include "ureg_err.h"
  17 #define MR_SUCCESS 0            /* Query was successful */
  18
  19 #define MR_VERSION_1 1          /* Version in use from 7/87 to 4/88 */
  20 #define MR_VERSION_2 2          /* After 4/88, new query lib */
  21
  22 /* return values for Moira server calls, used by clients */
  23
  24 #define MR_CONT 0               /* Everything okay, continue sending values. */
  25 #define MR_ABORT -1             /* Something went wrong don't send anymore
  26                                    values. */
  27
  28 #define MOIRA_SNAME     "moira" /* Kerberos service key to use */
  29
  30 /* Protocol operations */
  31 #define MR_NOOP 0
  32 #define MR_AUTH 1
  33 #define MR_SHUTDOWN 2
  34 #define MR_QUERY 3
  35 #define MR_ACCESS 4
  36 #define MR_DO_UPDATE 5
  37 #define MR_MOTD 6
  38 #define MR_MAX_PROC 6
  39
  40 /* values used in NFS physical flags */
  41 #define MR_FS_STUDENT   0x0001
  42 #define MR_FS_FACULTY   0x0002
  43 #define MR_FS_STAFF     0x0004
  44 #define MR_FS_MISC      0x0008
  45 #define MR_FS_GROUPQUOTA 0x0010
  46
  47 /* magic values to pass for list and user queries */
  48 #define UNIQUE_GID      "create unique GID"
  49 #define UNIQUE_UID      "create unique UID"
  50 #define UNIQUE_LOGIN    "create unique login ID"
  51
  52 /* Structure used by Save Queue routines (for temporary storage of data) */
  53 struct save_queue
  54 {
  55   struct save_queue *q_next;
  56   struct save_queue *q_prev;
  57   struct save_queue *q_lastget;
  58   void *q_data;
  59 };
  60
  61 /* Hash table declarations */
  62 struct bucket {
  63   struct bucket *next;
  64   int key;
  65   void *data;
  66 };
  67 struct hash {
  68   int size;
  69   struct bucket **data;
  70 };
  71
  72 /* prototypes from critical.c */
  73 void critical_alert(char *instance, char *msg, ...);
  74 void send_zgram(char *inst, char *msg);
  75
  76 /* prototypes from fixhost.c */
  77 char *canonicalize_hostname(char *s);
  78
  79 /* prototypes from fixname.c */
  80 void FixName(char *ilnm, char *ifnm, char *last, char *first, char *middle);
  81 void FixCase(char *p);
  82 void LookForJrAndIII(char *nm, int *pends_jr, int *pends_sr,
  83                      int *pends_ii, int *pends_iii,
  84                      int *pends_iv, int *pends_v);
  85 void LookForSt(char *nm);
  86 void LookForO(char *nm);
  87 void TrimTrailingSpace(char *ip);
  88 void GetMidInit(char *nm, char *mi);
  89 void RemoveHyphens(char *str);
  90
  91 /* prototypes from gdss_convert.c */
  92 int gdss2et(int code);
  93
  94 /* prototypes from hash.c */
  95 struct hash *create_hash(int size);
  96 void *hash_lookup(struct hash *h, int key);
  97 int hash_update(struct hash *h, int key, void *value);
  98 int hash_store(struct hash *h, int key, void *value);
  99 void hash_search(struct hash *h, void *value, void (*callback)(int));
 100 void hash_step(struct hash *h, void (*callback)(int, void *, void *),
 101                void *hint);
 102 void hash_destroy(struct hash *h);
 103
 104 /* prototypes from kname_unparse.c */
 105 char *kname_unparse(char *p, char *i, char *r);
 106
 107 /* prototypes from nfsparttype.c */
 108 char *parse_filesys_type(char *fs_type_name);
 109 char *format_filesys_type(char *fs_status);
 110
 111 /* prototypes from sq.c */
 112 struct save_queue *sq_create(void);
 113 int sq_save_data(struct save_queue *sq, void *data);
 114 int sq_save_args(int argc, char *argv[], struct save_queue *sq);
 115 int sq_save_unique_data(struct save_queue *sq, void *data);
 116 int sq_save_unique_string(struct save_queue *sq, char *data);
 117 /* in sq_get_data and sq_remove_data, the `data' arg should be a
 118    pointer to a pointer */
 119 int sq_get_data(struct save_queue *sq, void *data);
 120 int sq_remove_data(struct save_queue *sq, void *data);
 121 int sq_empty(struct save_queue *sq);
 122 void sq_destroy(struct save_queue *sq);
 123
 124 /* prototypes from strs.c */
 125 char *strtrim(char *s);
 126 char *uppercase(char *s);
 127 char *lowercase(char *s);
 128
 129 /* mr_ functions */
 130 int mr_access(char *handle, int argc, char **argv);
 131 int mr_auth(char *prog);
 132 int mr_connect(char *server);
 133 int mr_disconnect(void);
 134 int mr_do_update(void);
 135 int mr_host(char *host, int size);
 136 int mr_motd(char **motd);
 137 int mr_noop(void);
 138 int mr_query(char *handle, int argc, char **argv,
 139              int (*callback)(int, char **, void *), void *callarg);
 140
 141 /* error-name backward compatibility */
 142 #define MR_INGRES_ERR           MR_DBMS_ERR
 143 #define MR_INGRES_SOFTFAIL      MR_DBMS_SOFTFAIL
 144
 145
 146 #ifdef __GNUC__
 147 #if __GNUC_MINOR__ < 7
 148 #define __attribute__(x)
 149 #endif
 150 #else /* ! __GNUC __ */
 151 #define __attribute__(x)
 152 #endif
 153
 154 #define RCSID(id) static char *rcsid __attribute__ ((__unused__)) = id
 155
 156 #endif /* _moira_h_ */          /* Do Not Add Anything after this line. */