citadel/include/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
  30 #if TIME_WITH_SYS_TIME
  31 # include <sys/time.h>
  32 # include <time.h>
  33 #else
  34 # if HAVE_SYS_TIME_H
  35 #  include <sys/time.h>
  36 # else
  37 #  include <time.h>
  38 # endif
  39 #endif
  40
  41 #include <sys/wait.h>
  42 #include <string.h>
  43 #ifdef HAVE_STRINGS_H
  44 #include <strings.h>
  45 #endif
  46 #include <limits.h>
  47
  48
  49 #ifndef HAVE_SNPRINTF
  50 #include "snprintf.h"
  51 #endif
  52
  53
  54 #include <libcitadel.h>
  55
  56 #include "server.h"
  57 #include "sysdep_decls.h"
  58 #include "msgbase.h"
  59 #include "threads.h"
  60 #include "citadel_dirs.h"
  61 #include "context.h"
  62
  63 /*
  64  * define macros for module init stuff
  65  */
  66
  67 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
  68
  69 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
  70
  71 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
  72
  73 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
  74
  75 #define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT)
  76 /*
  77  * Hook functions available to modules.
  78  */
  79
  80 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType);
  81 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
  82 void CtdlShutdownServiceHooks(void);
  83
  84 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
  85 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
  86
  87 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
  88 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
  89
  90 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
  91                                                         int EventType);
  92 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
  93                                                         int EventType);
  94
  95 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
  96 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
  97
  98 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
  99 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
 100
 101 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
 102 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
 103
 104 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
 105 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
 106
 107 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
 108
 109 void CtdlRegisterServiceHook(int tcp_port,
 110                              char *sockpath,
 111                              void (*h_greeting_function) (void),
 112                              void (*h_command_function) (void),
 113                              void (*h_async_function) (void),
 114                              const char *ServiceName
 115 );
 116 void CtdlUnregisterServiceHook(int tcp_port,
 117                         char *sockpath,
 118                         void (*h_greeting_function) (void),
 119                         void (*h_command_function) (void),
 120                         void (*h_async_function) (void)
 121 );
 122
 123 void CtdlRegisterFixedOutputHook(char *content_type,
 124                         void (*output_function) (char *supplied_data, int len)
 125 );
 126 void CtdlUnRegisterFixedOutputHook(char *content_type);
 127
 128 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
 129
 130 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
 131
 132
 133 /*
 134  * Directory services hooks for LDAP etc
 135  */
 136
 137 #define DIRECTORY_USER_DEL 1    // Delete a user entry
 138 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
 139 #define DIRECTORY_CREATE_OBJECT 3       // Create a new object for directory entry
 140 #define DIRECTORY_ATTRIB_ADD 4  // Add an attribute to the directory entry object
 141 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
 142 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
 143
 144 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
 145 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
 146
 147 /* TODODRW: This needs to be changed into a hook type interface
 148  * for now we have this horrible hack
 149  */
 150 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
 151
 152 /* return the current context list as an array and do it in a safe manner
 153  * The returned data is a copy so only reading is useful
 154  * The number of contexts is returned in count.
 155  * Beware, this does not copy any of the data pointed to by the context.
 156  * This means that you can not rely on things like the redirect buffer being valid.
 157  * You must free the returned pointer when done.
 158  */
 159 struct CitContext *CtdlGetContextArray (int *count);
 160 void CtdlFillSystemContext(struct CitContext *context, char *name);
 161 void CtdlClearSystemContext(void);
 162 int CtdlTrySingleUser(void);
 163 void CtdlEndSingleUser(void);
 164 int CtdlWantSingleUser(void);
 165 int CtdlIsSingleUser(void);
 166
 167
 168 int CtdlIsUserLoggedIn (char *user_name);
 169 int CtdlIsUserLoggedInByNum (long usernum);
 170 void CtdlBumpNewMailCounter(long which_user);
 171
 172
 173 /*
 174  * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
 175  * This provides a quick way to initialise a variable that might be used to indicate
 176  * messages that should not be processed. EG. a new Sieve script will use this
 177  * to record determine that messages older than this should not be processed.
 178  * This function is defined in control.c
 179  */
 180 long CtdlGetCurrentMessageNumber(void);
 181
 182
 183
 184 /*
 185  * Expose various room operation functions from room_ops.c to the modules API
 186  */
 187
 188 unsigned CtdlCreateRoom(char *new_room_name,
 189                         int new_room_type,
 190                         char *new_room_pass,
 191                         int new_room_floor,
 192                         int really_create,
 193                         int avoid_access,
 194                         int new_room_view);
 195 int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name);
 196 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
 197 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
 198 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
 199                 int *result, int *view);
 200 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
 201 void CtdlForEachRoom(void (*CallBack)(struct ctdlroom *EachRoom, void *out_data),
 202         void *in_data);
 203 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
 204 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
 205 void CtdlUserGoto (char *where, int display_result, int transiently,
 206                         int *msgs, int *new);
 207 struct floor *CtdlGetCachedFloor(int floor_num);
 208 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
 209 void CtdlGetFloor (struct floor *flbuf, int floor_num);
 210 void CtdlPutFloor (struct floor *flbuf, int floor_num);
 211 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
 212 int CtdlGetFloorByName(const char *floor_name);
 213 int CtdlGetFloorByNameLock(const char *floor_name);
 214 int CtdlGetAvailableFloor(void);
 215 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
 216 void CtdlPutRoom(struct ctdlroom *);
 217
 218 /*
 219  * Possible return values for CtdlRenameRoom()
 220  */
 221 enum {
 222         crr_ok,                         /* success */
 223         crr_room_not_found,             /* room not found */
 224         crr_already_exists,             /* new name already exists */
 225         crr_noneditable,                /* cannot edit this room */
 226         crr_invalid_floor,              /* target floor does not exist */
 227         crr_access_denied               /* not allowed to edit this room */
 228 };
 229
 230
 231
 232 /*
 233  * API declarations from citserver.h
 234  */
 235 int CtdlAccessCheck(int);
 236 /* 'required access level' values which may be passed to CtdlAccessCheck()
 237  */
 238 enum {
 239         ac_none,
 240         ac_logged_in_or_guest,
 241         ac_logged_in,
 242         ac_room_aide,
 243         ac_aide,
 244         ac_internal,
 245 };
 246
 247
 248
 249 /*
 250  * API declarations from serv_extensions.h
 251  */
 252 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
 253 /*
 254  * Global system configuration.  Don't change anything here.  It's all in dtds/config-defs.h now.
 255  */
 256 struct config {
 257 #include "datadefinitions.h"
 258 #include "dtds/config-defs.h"
 259 #include "undef_data.h"
 260 };
 261
 262 extern struct config config;
 263
 264
 265
 266 /*
 267  * Expose API calls from user_ops.c
 268  */
 269 int CtdlGetUser(struct ctdluser *usbuf, char *name);
 270 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
 271 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
 272 void CtdlPutUser(struct ctdluser *usbuf);
 273 void CtdlPutUserLock(struct ctdluser *usbuf);
 274 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
 275 void CtdlGetRelationship(visit *vbuf,
 276                         struct ctdluser *rel_user,
 277                         struct ctdlroom *rel_room);
 278 void CtdlSetRelationship(visit *newvisit,
 279                         struct ctdluser *rel_user,
 280                         struct ctdlroom *rel_room);
 281 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
 282
 283 int CtdlLoginExistingUser(char *authname, const char *username);
 284
 285 /*
 286  * Values which may be returned by CtdlLoginExistingUser()
 287  */
 288 enum {
 289         pass_ok,
 290         pass_already_logged_in,
 291         pass_no_user,
 292         pass_internal_error,
 293         pass_wrong_password
 294 };
 295
 296 int CtdlTryPassword(const char *password, long len);
 297 /*
 298  * Values which may be returned by CtdlTryPassword()
 299  */
 300 enum {
 301         login_ok,
 302         login_already_logged_in,
 303         login_too_many_users,
 304         login_not_found
 305 };
 306
 307 void CtdlUserLogout(void);
 308
 309
 310
 311
 312 /*
 313  * Expose API calls from msgbase.c
 314  */
 315 char *CtdlGetSysConfig(char *sysconfname);
 316 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
 317
 318
 319
 320
 321 /*
 322  * Expose API calls from euidindex.c
 323  */
 324 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
 325
 326
 327 #endif /* CTDL_MODULE_H */