15 #include <sys/types.h>
17 #if TIME_WITH_SYS_TIME
18 # include <sys/time.h>
22 # include <sys/time.h>
41 #include <libcitadel.h>
44 #include "sysdep_decls.h"
47 #include "citadel_dirs.h"
51 * define macros for module init stuff
54 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
56 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
58 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
60 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
64 * Prototype for making log entries in Citadel.
67 void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...);
69 #define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT)
72 * Hook functions available to modules.
75 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType);
76 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
78 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
79 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
81 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
82 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
84 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
86 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
89 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
90 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
92 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
93 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
95 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
96 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
98 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
99 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
101 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
103 void CtdlRegisterServiceHook(int tcp_port,
105 void (*h_greeting_function) (void),
106 void (*h_command_function) (void),
107 void (*h_async_function) (void),
108 const char *ServiceName
110 void CtdlUnregisterServiceHook(int tcp_port,
112 void (*h_greeting_function) (void),
113 void (*h_command_function) (void),
114 void (*h_async_function) (void)
117 void CtdlRegisterFixedOutputHook(char *content_type,
118 void (*output_function) (char *supplied_data, int len)
120 void CtdlUnRegisterFixedOutputHook(char *content_type);
122 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
124 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, char *), char *name);
128 * Directory services hooks for LDAP etc
131 #define DIRECTORY_USER_DEL 1 // Delete a user entry
132 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
133 #define DIRECTORY_CREATE_OBJECT 3 // Create a new object for directory entry
134 #define DIRECTORY_ATTRIB_ADD 4 // Add an attribute to the directory entry object
135 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
136 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
138 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
139 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
141 /* TODODRW: This needs to be changed into a hook type interface
142 * for now we have this horrible hack
144 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
148 * Citadel Threads API
150 struct CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args);
151 struct CtdlThreadNode *CtdlThreadSchedule(char *name, long flags, void *(*thread_func) (void *arg), void *args, time_t when);
152 void CtdlThreadSleep(int secs);
153 void CtdlThreadStop(struct CtdlThreadNode *thread);
154 int CtdlThreadCheckStop(void);
155 /* void CtdlThreadCancel2(struct CtdlThreadNode *thread); Leave this out, it should never be needed */
156 const char *CtdlThreadName(const char *name);
157 struct CtdlThreadNode *CtdlThreadSelf(void);
158 int CtdlThreadGetCount(void);
159 int CtdlThreadGetWorkers(void);
160 double CtdlThreadGetWorkerAvg(void);
161 double CtdlThreadGetLoadAvg(void);
162 void CtdlThreadGC(void);
163 void CtdlThreadStopAll(void);
164 int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
165 void CtdlThreadAllocTSD(void);
167 #define CTDLTHREAD_BIGSTACK 0x0001
168 #define CTDLTHREAD_WORKER 0x0002
170 /* Macros to speed up getting outr thread */
172 #define MYCURSORS (((ThreadTSD*)pthread_getspecific(ThreadKey))->cursors)
173 #define MYTID (((ThreadTSD*)pthread_getspecific(ThreadKey))->tid)
174 #define CT (((ThreadTSD*)pthread_getspecific(ThreadKey))->self)
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.
183 struct CitContext *CtdlGetContextArray (int *count);
184 void CtdlFillSystemContext(struct CitContext *context, char *name);
186 int CtdlTrySingleUser(void);
187 void CtdlEndSingleUser(void);
188 int CtdlWantSingleUser(void);
189 int CtdlIsSingleUser(void);
192 int CtdlIsUserLoggedIn (char *user_name);
193 int CtdlIsUserLoggedInByNum (long usernum);
194 void CtdlBumpNewMailCounter(long which_user);
198 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
199 * This provides a quick way to initialise a variable that might be used to indicate
200 * messages that should not be processed. EG. a new Sieve script will use this
201 * to record determine that messages older than this should not be processed.
202 * This function is defined in control.c
204 long CtdlGetCurrentMessageNumber(void);
209 * Expose various room operation functions from room_ops.c to the modules API
212 unsigned CtdlCreateRoom(char *new_room_name,
219 int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name);
220 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
221 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
222 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
223 int *result, int *view);
224 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
225 void CtdlForEachRoom(void (*CallBack)(struct ctdlroom *EachRoom, void *out_data),
227 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
228 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
229 void CtdlUserGoto (char *where, int display_result, int transiently,
230 int *msgs, int *new);
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 *);
243 * Possible return values for CtdlRenameRoom()
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 */
257 * API declarations from citserver.h
259 int CtdlAccessCheck(int);
260 /* 'required access level' values which may be passed to CtdlAccessCheck()
273 * API declarations from serv_extensions.h
275 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, char *search_string, char *func_name);
277 * Global system configuration. Don't change anything here. It's all in dtds/config-defs.h now.
280 #include "datadefinitions.h"
281 #include "dtds/config-defs.h"
282 #include "undef_data.h"
285 extern struct config config;
290 * Expose API calls from user_ops.c
292 int CtdlGetUser(struct ctdluser *usbuf, char name[]);
293 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
294 void CtdlPutUser(struct ctdluser *usbuf);
295 void CtdlPutUserLock(struct ctdluser *usbuf);
296 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
297 void CtdlGetRelationship(struct visit *vbuf,
298 struct ctdluser *rel_user,
299 struct ctdlroom *rel_room);
300 void CtdlSetRelationship(struct visit *newvisit,
301 struct ctdluser *rel_user,
302 struct ctdlroom *rel_room);
303 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
305 int CtdlLoginExistingUser(char *authname, char *username);
308 * Values which may be returned by CtdlLoginExistingUser()
312 pass_already_logged_in,
318 int CtdlTryPassword(char *password);
320 * Values which may be returned by CtdlTryPassword()
324 login_already_logged_in,
325 login_too_many_users,
329 void CtdlUserLogout(void);
335 * Expose API calls from msgbase.c
337 char *CtdlGetSysConfig(char *sysconfname);
338 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
344 * Expose API calls from euidindex.c
346 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
349 #endif /* CTDL_MODULE_H */