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 *, recptypes*),
 109                                                         int EventType);
 110 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes *),
 111                                int EventType);
 112
 113 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
 114 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
 115
 116 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
 117 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
 118
 119 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
 120 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
 121
 122 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
 123 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
 124
 125 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
 126
 127 void CtdlRegisterServiceHook(int tcp_port,
 128                              char *sockpath,
 129                              void (*h_greeting_function) (void),
 130                              void (*h_command_function) (void),
 131                              void (*h_async_function) (void),
 132                              const char *ServiceName
 133 );
 134 void CtdlUnregisterServiceHook(int tcp_port,
 135                         char *sockpath,
 136                         void (*h_greeting_function) (void),
 137                         void (*h_command_function) (void),
 138                         void (*h_async_function) (void)
 139 );
 140
 141 void CtdlRegisterFixedOutputHook(char *content_type,
 142                         void (*output_function) (char *supplied_data, int len)
 143 );
 144 void CtdlUnRegisterFixedOutputHook(char *content_type);
 145
 146 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
 147
 148 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
 149
 150 /*
 151  * if you say a) (which may take a while)
 152  * don't forget to say b)
 153  */
 154 void CtdlDisableHouseKeeping(void);
 155 void CtdlEnableHouseKeeping(void);
 156
 157 /*
 158  * Directory services hooks for LDAP etc
 159  */
 160
 161 #define DIRECTORY_USER_DEL 1    // Delete a user entry
 162 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
 163 #define DIRECTORY_CREATE_OBJECT 3       // Create a new object for directory entry
 164 #define DIRECTORY_ATTRIB_ADD 4  // Add an attribute to the directory entry object
 165 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
 166 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
 167
 168 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
 169 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
 170
 171 /* TODODRW: This needs to be changed into a hook type interface
 172  * for now we have this horrible hack
 173  */
 174 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
 175
 176 /* return the current context list as an array and do it in a safe manner
 177  * The returned data is a copy so only reading is useful
 178  * The number of contexts is returned in count.
 179  * Beware, this does not copy any of the data pointed to by the context.
 180  * This means that you can not rely on things like the redirect buffer being valid.
 181  * You must free the returned pointer when done.
 182  */
 183 struct CitContext *CtdlGetContextArray (int *count);
 184 void CtdlFillSystemContext(struct CitContext *context, char *name);
 185 int CtdlTrySingleUser(void);
 186 void CtdlEndSingleUser(void);
 187 int CtdlWantSingleUser(void);
 188 int CtdlIsSingleUser(void);
 189
 190
 191 int CtdlIsUserLoggedIn (char *user_name);
 192 int CtdlIsUserLoggedInByNum (long usernum);
 193 void CtdlBumpNewMailCounter(long which_user);
 194
 195
 196 /*
 197  * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
 198  * This provides a quick way to initialise a variable that might be used to indicate
 199  * messages that should not be processed.  For example, a new inbox script will use this
 200  * to record determine that messages older than this should not be processed.
 201  * This function is defined in control.c
 202  */
 203 long CtdlGetCurrentMessageNumber(void);
 204
 205
 206
 207 /*
 208  * Expose various room operation functions from room_ops.c to the modules API
 209  */
 210
 211 unsigned CtdlCreateRoom(char *new_room_name,
 212                         int new_room_type,
 213                         char *new_room_pass,
 214                         int new_room_floor,
 215                         int really_create,
 216                         int avoid_access,
 217                         int new_room_view);
 218 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name);
 219 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name);
 220 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
 221 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view);
 222 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
 223 typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data);
 224 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data);
 225 typedef void (*ForEachRoomNetCfgCallBack)(struct ctdlroom *EachRoom, void *out_data, char *cfg);
 226 char *LoadRoomNetConfigFile(long roomnum);
 227 void SaveChangedConfigs(void);
 228 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
 229 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
 230 void CtdlUserGoto (char *where, int display_result, int transiently, int *msgs, int *new, long *oldest, long *newest);
 231 struct floor *CtdlGetCachedFloor(int floor_num);
 232 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
 233 void CtdlGetFloor (struct floor *flbuf, int floor_num);
 234 void CtdlPutFloor (struct floor *flbuf, int floor_num);
 235 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
 236 int CtdlGetFloorByName(const char *floor_name);
 237 int CtdlGetFloorByNameLock(const char *floor_name);
 238 int CtdlGetAvailableFloor(void);
 239 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
 240 void CtdlPutRoom(struct ctdlroom *);
 241
 242 /*
 243  * Possible return values for CtdlRenameRoom()
 244  */
 245 enum {
 246         crr_ok,                         /* success */
 247         crr_room_not_found,             /* room not found */
 248         crr_already_exists,             /* new name already exists */
 249         crr_noneditable,                /* cannot edit this room */
 250         crr_invalid_floor,              /* target floor does not exist */
 251         crr_access_denied               /* not allowed to edit this room */
 252 };
 253
 254
 255
 256 /*
 257  * API declarations from citserver.h
 258  */
 259 int CtdlAccessCheck(int);
 260 /* 'required access level' values which may be passed to CtdlAccessCheck()
 261  */
 262 enum {
 263         ac_none,
 264         ac_logged_in_or_guest,
 265         ac_logged_in,
 266         ac_room_aide,
 267         ac_aide,
 268         ac_internal,
 269 };
 270
 271
 272
 273 /*
 274  * API declarations from serv_extensions.h
 275  */
 276 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
 277
 278 #define NODENAME                CtdlGetConfigStr("c_nodename")
 279 #define FQDN                    CtdlGetConfigStr("c_fqdn")
 280 #define CTDLUID                 ctdluid
 281 #define CREATAIDE               CtdlGetConfigInt("c_creataide")
 282 #define REGISCALL               CtdlGetConfigInt("c_regiscall")
 283 #define TWITDETECT              CtdlGetConfigInt("c_twitdetect")
 284 #define TWITROOM                CtdlGetConfigStr("c_twitroom")
 285 #define RESTRICT_INTERNET       CtdlGetConfigInt("c_restrict")
 286
 287 #define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d);
 288
 289
 290
 291 /*
 292  * Expose API calls from user_ops.c
 293  */
 294 int CtdlGetUser(struct ctdluser *usbuf, char *name);
 295 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
 296 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
 297 void CtdlPutUser(struct ctdluser *usbuf);
 298 void CtdlPutUserLock(struct ctdluser *usbuf);
 299 int CtdlLockGetCurrentUser(void);
 300 void CtdlPutCurrentUserLock(void);
 301 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
 302 void CtdlGetRelationship(visit *vbuf, struct ctdluser *rel_user, struct ctdlroom *rel_room);
 303 void CtdlSetRelationship(visit *newvisit, struct ctdluser *rel_user, struct ctdlroom *rel_room);
 304 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
 305 int CtdlLoginExistingUser(const char *username);
 306
 307 /*
 308  * Values which may be returned by CtdlLoginExistingUser()
 309  */
 310 enum {
 311         pass_ok,
 312         pass_already_logged_in,
 313         pass_no_user,
 314         pass_internal_error,
 315         pass_wrong_password
 316 };
 317
 318 int CtdlTryPassword(const char *password, long len);
 319 /*
 320  * Values which may be returned by CtdlTryPassword()
 321  */
 322 enum {
 323         login_ok,
 324         login_already_logged_in,
 325         login_too_many_users,
 326         login_not_found
 327 };
 328
 329 void CtdlUserLogout(void);
 330
 331 /*
 332  * Expose API calls from msgbase.c
 333  */
 334
 335
 336 /*
 337  * Expose API calls from euidindex.c
 338  */
 339 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
 340
 341
 342 /*
 343  * Expose API calls from modules/openid/serv_openid_rp.c in order to turn it into a generic external authentication driver
 344  */
 345 int attach_extauth(struct ctdluser *who, StrBuf *claimed_id);
 346
 347 #endif /* CTDL_MODULE_H */