citadel/server.h

   1 /* $Id$ */
   2 typedef pthread_t THREAD;
   3
   4 /* Uncomment this if you want to track memory leaks.
   5  * This incurs some overhead, so don't use it unless you're debugging the code!
   6  */
   7 /* #define DEBUG_MEMORY_LEAKS */
   8
   9
  10 /*
  11  * Here's the big one... the Citadel context structure.
  12  *
  13  * This structure keeps track of all information relating to a running
  14  * session on the server.  We keep one of these for each session thread.
  15  *
  16  * Note that the first element is "*next" so that it may be used without
  17  * modification in a linked list.
  18  */
  19 struct CitContext {
  20         struct CitContext *next;        /* Link to next session in the list */
  21
  22         struct usersupp usersupp;       /* Database record buffers */
  23         struct quickroom quickroom;
  24
  25         long *msglist;
  26         int num_msgs;
  27
  28         char curr_user[32];             /* name of current user */
  29         int logged_in;                  /* logged in */
  30         int internal_pgm;               /* authenticated as internal program */
  31         char temp[32];                  /* temp file name */
  32         int nologin;                    /* not allowed to log in */
  33
  34         char net_node[32];
  35         THREAD mythread;
  36         int client_socket;
  37         char *ExpressMessages;
  38         int cs_pid;                     /* session ID */
  39         char cs_room[20];               /* current room */
  40         time_t cs_lastupdt;             /* time of last update */
  41         time_t lastcmd;                 /* time of last command executed */
  42         time_t lastidle;                /* For computing idle time */
  43         char lastcmdname[5];            /* name of last command executed */
  44         unsigned cs_flags;              /* miscellaneous flags */
  45
  46                                         /* feeping creaturisms... */
  47         int cs_clientdev;               /* client developer ID */
  48         int cs_clienttyp;               /* client type code */
  49         int cs_clientver;               /* client version number */
  50         char cs_clientname[32];         /* name of client software */
  51         char cs_host[25];               /* host logged in from */
  52
  53         FILE *download_fp;              /* Fields relating to file transfer */
  54         FILE *upload_fp;
  55         char upl_file[256];
  56         char upl_path[256];
  57         char upl_comment[256];
  58         char upl_filedir[256];
  59         char chat_room[20];             /* The chat room */
  60         char dl_is_net;
  61         char upload_type;
  62
  63         char fake_username[32];         /* Fake username <bc>                */
  64         char fake_postname[32];         /* Fake postname <bc>                */
  65         char fake_hostname[25];         /* Name of the fake hostname <bc>    */
  66         char fake_roomname[ROOMNAMELEN];/* Name of the fake room <bc>        */
  67         char last_pager[32];            /* The username of the last pager    */
  68
  69         int FloorBeingSearched;         /* This is used by cmd_lrms() etc.   */
  70         };
  71
  72 typedef struct CitContext t_context;
  73
  74 #define CS_STEALTH      1               /* stealth mode */
  75 #define CS_CHAT         2               /* chat mode */
  76 #define CS_POSTING      4               /* Posting */
  77
  78 struct CitContext *MyContext(void);
  79 #define CC ((struct CitContext *)MyContext())
  80
  81 extern struct CitContext *ContextList;
  82 extern int ScheduledShutdown;
  83 extern struct CitControl CitControl;
  84
  85 struct ChatLine {
  86         struct ChatLine *next;
  87         int chat_seq;
  88         time_t chat_time;
  89         char chat_text[256];
  90         char chat_room[20];
  91         char chat_username[32];
  92         };
  93
  94 /*
  95  * Various things we need to lock and unlock
  96  */
  97 #define S_USERSUPP      0
  98 #define S_USER_TRANS    1
  99 #define S_QUICKROOM     2
 100 #define S_MSGMAIN       3
 101 #define S_CALLLOG       4
 102 #define S_SESSION_TABLE 5
 103 #define S_FLOORTAB      6
 104 #define S_CHATQUEUE     7
 105 #define S_CONTROL       8
 106 #define S_HOUSEKEEPING  9
 107 #define S_DATABASE      10
 108 #define MAX_SEMAPHORES  11
 109
 110
 111 /*
 112  * Upload types
 113  */
 114 #define UPL_FILE        0
 115 #define UPL_NET         1
 116 #define UPL_IMAGE       2
 117
 118
 119 /*
 120  * message transfer formats
 121  */
 122 #define MT_CITADEL      0               /* Citadel proprietary */
 123 #define MT_DATE         1               /* We're only looking for the date */
 124 #define MT_RFC822       2               /* RFC822 */
 125 #define MT_RAW          3               /* IGnet raw format */
 126 #define MT_MIME         4               /* MIME-formatted message */
 127
 128
 129 /*
 130  * Citadel DataBases (define one for each cdb we need to open)
 131  */
 132 #define CDB_MSGMAIN     0       /* message base                  */
 133 #define CDB_USERSUPP    1       /* user file                     */
 134 #define CDB_QUICKROOM   2       /* room index                    */
 135 #define CDB_FLOORTAB    3       /* floor index                   */
 136 #define CDB_MSGLISTS    4       /* room message lists            */
 137 #define CDB_VISIT       5       /* user/room relationships       */
 138 #define MAXCDB          6       /* total number of CDB's defined */
 139
 140 struct cdbdata {
 141         size_t len;
 142         char *ptr;
 143         };
 144
 145
 146 /* Structures and declarations for function hooks of various types */
 147
 148 struct LogFunctionHook {
 149         struct LogFunctionHook *next;
 150         int loglevel;
 151         void (*h_function_pointer) (char *);
 152         };
 153 extern struct LogFunctionHook *LogHookTable;
 154
 155 struct CleanupFunctionHook {
 156         struct CleanupFunctionHook *next;
 157         void (*h_function_pointer) (void);
 158         };
 159 extern struct CleanupFunctionHook *CleanupHookTable;
 160
 161
 162 /*
 163  * SessionFunctionHook extensions are used for any type of hook for which
 164  * the context in which it's being called (which is determined by the event
 165  * type) will make it obvious for the hook function to know where to look for
 166  * pertinent data.
 167  */
 168 struct SessionFunctionHook {
 169         struct SessionFunctionHook *next;
 170         void (*h_function_pointer) (void);
 171         int eventtype;
 172         };
 173 extern struct SessionFunctionHook *SessionHookTable;
 174
 175 #define EVT_STOP        0       /* Session is terminating */
 176 #define EVT_START       1       /* Session is starting */
 177 #define EVT_LOGIN       2       /* A user is logging in */
 178 #define EVT_NEWROOM     3       /* Changing rooms */
 179 #define EVT_LOGOUT      4       /* A user is logging out */
 180 #define EVT_SETPASS     5       /* Setting or changing password */
 181
 182
 183 /*
 184  * UserFunctionHook extensions are used for any type of hook which implements
 185  * an operation on a user or username (potentially) other than the one
 186  * operating the current session.
 187  */
 188 struct UserFunctionHook {
 189         struct UserFunctionHook *next;
 190         void (*h_function_pointer) (char *username, long usernum);
 191         int eventtype;
 192         };
 193 extern struct UserFunctionHook *UserHookTable;
 194
 195 #define EVT_PURGEUSER   100     /* Deleting a user */
 196 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 197
 198
 199 /* Defines the relationship of a user to a particular room */
 200 struct visit {
 201         long v_roomnum;
 202         long v_roomgen;
 203         long v_usernum;
 204         long v_lastseen;
 205         unsigned int v_flags;
 206         };
 207
 208 #define V_FORGET        1               /* User has zapped this room        */
 209 #define V_LOCKOUT       2               /* User is locked out of this room  */
 210 #define V_ACCESS        4               /* Access is granted to this room   */
 211
 212 #define UA_KNOWN                2
 213 #define UA_GOTOALLOWED          4
 214 #define UA_HASNEWMSGS           8
 215 #define UA_ZAPPED               16
 216
 217
 218
 219 /* Built-in debuggable stuff for checking for memory leaks */
 220 #ifdef DEBUG_MEMORY_LEAKS
 221
 222 #define mallok(howbig)  tracked_malloc(howbig, __FILE__, __LINE__)
 223 #define phree(whichptr) tracked_free(whichptr)
 224 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 225
 226 void *tracked_malloc(size_t, char *, int);
 227 void tracked_free(void *);
 228 void *tracked_realloc(void *, size_t);
 229 void dump_tracked(void);
 230
 231 struct TheHeap {
 232         struct TheHeap *next;
 233         char h_file[32];
 234         int h_line;
 235         void *h_ptr;
 236         };
 237
 238 extern struct TheHeap *heap;
 239
 240 #else
 241
 242 #define mallok(howbig)  malloc(howbig)
 243 #define phree(whichptr) free(whichptr)
 244 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 245
 246 #endif