10 #define GC_REDIRECT_TO_LOCAL
11 #include <gc/gc_local_alloc.h>
13 #define GC_MALLOC malloc
14 #define GC_MALLOC_ATOMIC malloc
16 #define GC_REALLOC realloc
28 #include <sys/types.h>
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
54 #include <libcitadel.h>
57 #include "sysdep_decls.h"
60 #include "citadel_dirs.h"
64 * define macros for module init stuff
67 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
69 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
71 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
73 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
77 * Prototype for making log entries in Citadel.
80 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...);
82 #define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT)
85 * Hook functions available to modules.
88 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType);
89 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
91 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
92 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
94 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
95 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
97 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
99 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
102 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
103 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
105 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
106 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
108 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
109 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
111 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
112 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
114 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
116 void CtdlRegisterServiceHook(int tcp_port,
118 void (*h_greeting_function) (void),
119 void (*h_command_function) (void),
120 void (*h_async_function) (void),
121 const char *ServiceName
123 void CtdlUnregisterServiceHook(int tcp_port,
125 void (*h_greeting_function) (void),
126 void (*h_command_function) (void),
127 void (*h_async_function) (void)
130 void CtdlRegisterFixedOutputHook(char *content_type,
131 void (*output_function) (char *supplied_data, int len)
133 void CtdlUnRegisterFixedOutputHook(char *content_type);
135 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
137 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
141 * Directory services hooks for LDAP etc
144 #define DIRECTORY_USER_DEL 1 // Delete a user entry
145 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
146 #define DIRECTORY_CREATE_OBJECT 3 // Create a new object for directory entry
147 #define DIRECTORY_ATTRIB_ADD 4 // Add an attribute to the directory entry object
148 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
149 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
151 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
152 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
154 /* TODODRW: This needs to be changed into a hook type interface
155 * for now we have this horrible hack
157 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
161 * Citadel Threads API
163 struct CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args);
164 struct CtdlThreadNode *CtdlThreadSchedule(char *name, long flags, void *(*thread_func) (void *arg), void *args, time_t when);
165 void CtdlThreadSleep(int secs);
166 void CtdlThreadStop(struct CtdlThreadNode *thread);
167 int CtdlThreadCheckStop(void);
168 /* void CtdlThreadCancel2(struct CtdlThreadNode *thread); Leave this out, it should never be needed */
169 const char *CtdlThreadName(const char *name);
170 struct CtdlThreadNode *CtdlThreadSelf(void);
171 int CtdlThreadGetCount(void);
172 int CtdlThreadGetWorkers(void);
173 double CtdlThreadGetWorkerAvg(void);
174 double CtdlThreadGetLoadAvg(void);
175 void CtdlThreadGC(void);
176 void CtdlThreadStopAll(void);
177 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
178 void CtdlThreadAllocTSD(void);
180 #define CTDLTHREAD_BIGSTACK 0x0001
181 #define CTDLTHREAD_WORKER 0x0002
183 /* Macros to speed up getting outr thread */
185 #define MYCURSORS (((ThreadTSD*)pthread_getspecific(ThreadKey))->cursors)
186 #define MYTID (((ThreadTSD*)pthread_getspecific(ThreadKey))->tid)
187 #define CT (((ThreadTSD*)pthread_getspecific(ThreadKey))->self)
188 #define CTP ((ThreadTSD*)pthread_getspecific(ThreadKey))
190 /** return the current context list as an array and do it in a safe manner
191 * The returned data is a copy so only reading is useful
192 * The number of contexts is returned in count.
193 * Beware, this does not copy any of the data pointed to by the context.
194 * This means that you can not rely on things like the redirect buffer being valid.
195 * You must free the returned pointer when done.
197 struct CitContext *CtdlGetContextArray (int *count);
198 void CtdlFillSystemContext(struct CitContext *context, char *name);
199 void CtdlClearSystemContext(void);
200 int CtdlTrySingleUser(void);
201 void CtdlEndSingleUser(void);
202 int CtdlWantSingleUser(void);
203 int CtdlIsSingleUser(void);
206 int CtdlIsUserLoggedIn (char *user_name);
207 int CtdlIsUserLoggedInByNum (long usernum);
208 void CtdlBumpNewMailCounter(long which_user);
212 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
213 * This provides a quick way to initialise a variable that might be used to indicate
214 * messages that should not be processed. EG. a new Sieve script will use this
215 * to record determine that messages older than this should not be processed.
216 * This function is defined in control.c
218 long CtdlGetCurrentMessageNumber(void);
223 * Expose various room operation functions from room_ops.c to the modules API
226 unsigned CtdlCreateRoom(char *new_room_name,
233 int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name);
234 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
235 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
236 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
237 int *result, int *view);
238 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
239 void CtdlForEachRoom(void (*CallBack)(struct ctdlroom *EachRoom, void *out_data),
241 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
242 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
243 void CtdlUserGoto (char *where, int display_result, int transiently,
244 int *msgs, int *new);
245 struct floor *CtdlGetCachedFloor(int floor_num);
246 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
247 void CtdlGetFloor (struct floor *flbuf, int floor_num);
248 void CtdlPutFloor (struct floor *flbuf, int floor_num);
249 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
250 int CtdlGetFloorByName(const char *floor_name);
251 int CtdlGetFloorByNameLock(const char *floor_name);
252 int CtdlGetAvailableFloor(void);
253 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
254 void CtdlPutRoom(struct ctdlroom *);
257 * Possible return values for CtdlRenameRoom()
260 crr_ok, /* success */
261 crr_room_not_found, /* room not found */
262 crr_already_exists, /* new name already exists */
263 crr_noneditable, /* cannot edit this room */
264 crr_invalid_floor, /* target floor does not exist */
265 crr_access_denied /* not allowed to edit this room */
271 * API declarations from citserver.h
273 int CtdlAccessCheck(int);
274 /* 'required access level' values which may be passed to CtdlAccessCheck()
287 * API declarations from serv_extensions.h
289 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
291 * Global system configuration. Don't change anything here. It's all in dtds/config-defs.h now.
294 #include "datadefinitions.h"
295 #include "dtds/config-defs.h"
296 #include "undef_data.h"
299 extern struct config config;
304 * Expose API calls from user_ops.c
306 int CtdlGetUser(struct ctdluser *usbuf, char *name);
307 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
308 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
309 void CtdlPutUser(struct ctdluser *usbuf);
310 void CtdlPutUserLock(struct ctdluser *usbuf);
311 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
312 void CtdlGetRelationship(visit *vbuf,
313 struct ctdluser *rel_user,
314 struct ctdlroom *rel_room);
315 void CtdlSetRelationship(visit *newvisit,
316 struct ctdluser *rel_user,
317 struct ctdlroom *rel_room);
318 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
320 int CtdlLoginExistingUser(char *authname, const char *username);
323 * Values which may be returned by CtdlLoginExistingUser()
327 pass_already_logged_in,
333 int CtdlTryPassword(const char *password, long len);
335 * Values which may be returned by CtdlTryPassword()
339 login_already_logged_in,
340 login_too_many_users,
344 void CtdlUserLogout(void);
350 * Expose API calls from msgbase.c
352 char *CtdlGetSysConfig(char *sysconfname);
353 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
359 * Expose API calls from euidindex.c
361 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
364 #endif /* CTDL_MODULE_H */