citadel/ctdl_module.h

   1
   2 #ifndef CTDL_MODULE_H
   3 #define CTDL_MODULE_H
   4
   5 #include "sysdep.h"
   6
   7 #ifdef HAVE_GC
   8 #define GC_THREADS
   9 #define GC_REDIRECT_TO_LOCAL
  10 #include <gc/gc_local_alloc.h>
  11 #else
  12 #define GC_MALLOC malloc
  13 #define GC_MALLOC_ATOMIC malloc
  14 #define GC_FREE free
  15 #define GC_REALLOC realloc
  16 #endif
  17
  18
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <stdio.h>
  22 #include <fcntl.h>
  23 #include <ctype.h>
  24 #include <signal.h>
  25 #include <pwd.h>
  26 #include <errno.h>
  27 #include <syslog.h>
  28 #include <sys/types.h>
  29 #include <time.h>
  30 #include <sys/wait.h>
  31 #include <string.h>
  32 #ifdef HAVE_STRINGS_H
  33 #include <strings.h>
  34 #endif
  35 #include <limits.h>
  36
  37 #include <libcitadel.h>
  38
  39 #include "server.h"
  40 #include "sysdep_decls.h"
  41 #include "msgbase.h"
  42 #include "threads.h"
  43 #include "citadel_dirs.h"
  44 #include "context.h"
  45
  46 /*
  47  * define macros for module init stuff
  48  */
  49
  50 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
  51
  52 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
  53
  54 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
  55
  56 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
  57
  58 #define CtdlAideMessage(TEXT, SUBJECT)          \
  59         quickie_message(                        \
  60                 "Citadel",                      \
  61                 NULL,                           \
  62                 NULL,                           \
  63                 AIDEROOM,                       \
  64                 TEXT,                           \
  65                 FMT_CITADEL,                    \
  66                 SUBJECT)
  67
  68 /*
  69  * Hook functions available to modules.
  70  */
  71 /* Priorities for  */
  72 #define PRIO_QUEUE 500
  73 #define PRIO_AGGR 1000
  74 #define PRIO_SEND 1500
  75 #define PRIO_CLEANUP 2000
  76 /* Priorities for EVT_HOUSE */
  77 #define PRIO_HOUSE 3000
  78 /* Priorities for EVT_LOGIN */
  79 #define PRIO_CREATE 10000
  80 /* Priorities for EVT_LOGOUT */
  81 #define PRIO_LOGOUT 15000
  82 /* Priorities for EVT_LOGIN */
  83 #define PRIO_LOGIN 20000
  84 /* Priorities for EVT_START */
  85 #define PRIO_START 25000
  86 /* Priorities for EVT_STOP */
  87 #define PRIO_STOP 30000
  88 /* Priorities for EVT_ASYNC */
  89 #define PRIO_ASYNC 35000
  90 /* Priorities for EVT_SHUTDOWN */
  91 #define PRIO_SHUTDOWN 40000
  92 /* Priorities for EVT_UNSTEALTH */
  93 #define PRIO_UNSTEALTH 45000
  94 /* Priorities for EVT_STEALTH */
  95 #define PRIO_STEALTH 50000
  96
  97
  98 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType, int Priority);
  99 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
 100 void CtdlShutdownServiceHooks(void);
 101
 102 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
 103 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
 104
 105 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
 106 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
 107
 108 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *, struct recptypes *), int EventType);
 109 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *, struct recptypes *), int EventType);
 110
 111 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
 112 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
 113
 114 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
 115 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
 116
 117 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
 118 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
 119
 120 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
 121 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
 122
 123 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
 124
 125 void CtdlRegisterServiceHook(int tcp_port,
 126                              char *sockpath,
 127                              void (*h_greeting_function) (void),
 128                              void (*h_command_function) (void),
 129                              void (*h_async_function) (void),
 130                              const char *ServiceName
 131 );
 132 void CtdlUnregisterServiceHook(int tcp_port,
 133                         char *sockpath,
 134                         void (*h_greeting_function) (void),
 135                         void (*h_command_function) (void),
 136                         void (*h_async_function) (void)
 137 );
 138
 139 void CtdlRegisterFixedOutputHook(char *content_type, void (*output_function) (char *supplied_data, int len));
 140 void CtdlUnRegisterFixedOutputHook(char *content_type);
 141 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
 142 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
 143
 144 /*
 145  * if you say a) (which may take a while)
 146  * don't forget to say b)
 147  */
 148 void CtdlDisableHouseKeeping(void);
 149 void CtdlEnableHouseKeeping(void);
 150
 151 /* TODODRW: This needs to be changed into a hook type interface
 152  * for now we have this horrible hack
 153  */
 154 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
 155
 156 /* return the current context list as an array and do it in a safe manner
 157  * The returned data is a copy so only reading is useful
 158  * The number of contexts is returned in count.
 159  * Beware, this does not copy any of the data pointed to by the context.
 160  * This means that you can not rely on things like the redirect buffer being valid.
 161  * You must free the returned pointer when done.
 162  */
 163 struct CitContext *CtdlGetContextArray (int *count);
 164 void CtdlFillSystemContext(struct CitContext *context, char *name);
 165 int CtdlTrySingleUser(void);
 166 void CtdlEndSingleUser(void);
 167 int CtdlWantSingleUser(void);
 168 int CtdlIsSingleUser(void);
 169
 170
 171 int CtdlIsUserLoggedIn (char *user_name);
 172 int CtdlIsUserLoggedInByNum (long usernum);
 173 void CtdlBumpNewMailCounter(long which_user);
 174
 175
 176 /*
 177  * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
 178  * This provides a quick way to initialise a variable that might be used to indicate
 179  * messages that should not be processed.  For example, a new inbox script will use this
 180  * to record determine that messages older than this should not be processed.
 181  * This function is defined in control.c
 182  */
 183 long CtdlGetCurrentMessageNumber(void);
 184
 185
 186
 187 /*
 188  * Expose various room operation functions from room_ops.c to the modules API
 189  */
 190
 191 unsigned CtdlCreateRoom(char *new_room_name,
 192                         int new_room_type,
 193                         char *new_room_pass,
 194                         int new_room_floor,
 195                         int really_create,
 196                         int avoid_access,
 197                         int new_room_view);
 198 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name);
 199 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name);
 200 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
 201 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view);
 202 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
 203 typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data);
 204 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data);
 205 char *LoadRoomNetConfigFile(long roomnum);
 206 void SaveRoomNetConfigFile(long roomnum, const char *raw_netconfig);
 207 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
 208 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
 209 void CtdlUserGoto (char *where, int display_result, int transiently, int *msgs, int *new, long *oldest, long *newest);
 210 struct floor *CtdlGetCachedFloor(int floor_num);
 211 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
 212 void CtdlGetFloor (struct floor *flbuf, int floor_num);
 213 void CtdlPutFloor (struct floor *flbuf, int floor_num);
 214 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
 215 int CtdlGetFloorByName(const char *floor_name);
 216 int CtdlGetFloorByNameLock(const char *floor_name);
 217 int CtdlGetAvailableFloor(void);
 218 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
 219 void CtdlPutRoom(struct ctdlroom *);
 220
 221 /*
 222  * Possible return values for CtdlRenameRoom()
 223  */
 224 enum {
 225         crr_ok,                         /* success */
 226         crr_room_not_found,             /* room not found */
 227         crr_already_exists,             /* new name already exists */
 228         crr_noneditable,                /* cannot edit this room */
 229         crr_invalid_floor,              /* target floor does not exist */
 230         crr_access_denied               /* not allowed to edit this room */
 231 };
 232
 233
 234
 235 /*
 236  * API declarations from citserver.h
 237  */
 238 int CtdlAccessCheck(int);
 239 /* 'required access level' values which may be passed to CtdlAccessCheck()
 240  */
 241 enum {
 242         ac_none,
 243         ac_logged_in_or_guest,
 244         ac_logged_in,
 245         ac_room_aide,
 246         ac_aide,
 247         ac_internal,
 248 };
 249
 250
 251
 252 /*
 253  * API declarations from serv_extensions.h
 254  */
 255 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
 256
 257 #define NODENAME                CtdlGetConfigStr("c_nodename")
 258 #define FQDN                    CtdlGetConfigStr("c_fqdn")
 259 #define CTDLUID                 ctdluid
 260 #define CREATAIDE               CtdlGetConfigInt("c_creataide")
 261 #define REGISCALL               CtdlGetConfigInt("c_regiscall")
 262 #define TWITDETECT              CtdlGetConfigInt("c_twitdetect")
 263 #define TWITROOM                CtdlGetConfigStr("c_twitroom")
 264 #define RESTRICT_INTERNET       CtdlGetConfigInt("c_restrict")
 265
 266 #define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d);
 267
 268
 269
 270 /*
 271  * Expose API calls from user_ops.c
 272  */
 273 int CtdlGetUser(struct ctdluser *usbuf, char *name);
 274 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
 275 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
 276 void CtdlPutUser(struct ctdluser *usbuf);
 277 void CtdlPutUserLock(struct ctdluser *usbuf);
 278 int CtdlLockGetCurrentUser(void);
 279 void CtdlPutCurrentUserLock(void);
 280 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
 281 void CtdlGetRelationship(visit *vbuf, struct ctdluser *rel_user, struct ctdlroom *rel_room);
 282 void CtdlSetRelationship(visit *newvisit, struct ctdluser *rel_user, struct ctdlroom *rel_room);
 283 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
 284 int CtdlLoginExistingUser(const char *username);
 285
 286 /*
 287  * Values which may be returned by CtdlLoginExistingUser()
 288  */
 289 enum {
 290         pass_ok,
 291         pass_already_logged_in,
 292         pass_no_user,
 293         pass_internal_error,
 294         pass_wrong_password
 295 };
 296
 297 int CtdlTryPassword(const char *password, long len);
 298 /*
 299  * Values which may be returned by CtdlTryPassword()
 300  */
 301 enum {
 302         login_ok,
 303         login_already_logged_in,
 304         login_too_many_users,
 305         login_not_found
 306 };
 307
 308 void CtdlUserLogout(void);
 309
 310 /*
 311  * Expose API calls from msgbase.c
 312  */
 313
 314
 315 /*
 316  * Expose API calls from euidindex.c
 317  */
 318 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
 319
 320
 321 /*
 322  * Expose API calls from modules/openid/serv_openid_rp.c in order to turn it into a generic external authentication driver
 323  */
 324 int attach_extauth(struct ctdluser *who, StrBuf *claimed_id);
 325
 326 #endif /* CTDL_MODULE_H */