9 #define GC_REDIRECT_TO_LOCAL
10 #include <gc/gc_local_alloc.h>
12 #define GC_MALLOC malloc
13 #define GC_MALLOC_ATOMIC malloc
15 #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 ()
75 #define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT)
77 * Hook functions available to modules.
80 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType);
81 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
82 void CtdlShutdownServiceHooks(void);
84 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
85 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
87 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
88 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
90 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
92 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
95 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
96 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
98 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
99 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
101 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
102 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
104 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
105 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
107 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
108 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
110 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
112 void CtdlRegisterServiceHook(int tcp_port,
114 void (*h_greeting_function) (void),
115 void (*h_command_function) (void),
116 void (*h_async_function) (void),
117 const char *ServiceName
119 void CtdlUnregisterServiceHook(int tcp_port,
121 void (*h_greeting_function) (void),
122 void (*h_command_function) (void),
123 void (*h_async_function) (void)
126 void CtdlRegisterFixedOutputHook(char *content_type,
127 void (*output_function) (char *supplied_data, int len)
129 void CtdlUnRegisterFixedOutputHook(char *content_type);
131 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
133 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
137 * Directory services hooks for LDAP etc
140 #define DIRECTORY_USER_DEL 1 // Delete a user entry
141 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
142 #define DIRECTORY_CREATE_OBJECT 3 // Create a new object for directory entry
143 #define DIRECTORY_ATTRIB_ADD 4 // Add an attribute to the directory entry object
144 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
145 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
147 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
148 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
150 /* TODODRW: This needs to be changed into a hook type interface
151 * for now we have this horrible hack
153 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
155 /* return the current context list as an array and do it in a safe manner
156 * The returned data is a copy so only reading is useful
157 * The number of contexts is returned in count.
158 * Beware, this does not copy any of the data pointed to by the context.
159 * This means that you can not rely on things like the redirect buffer being valid.
160 * You must free the returned pointer when done.
162 struct CitContext *CtdlGetContextArray (int *count);
163 void CtdlFillSystemContext(struct CitContext *context, char *name);
164 int CtdlTrySingleUser(void);
165 void CtdlEndSingleUser(void);
166 int CtdlWantSingleUser(void);
167 int CtdlIsSingleUser(void);
170 int CtdlIsUserLoggedIn (char *user_name);
171 int CtdlIsUserLoggedInByNum (long usernum);
172 void CtdlBumpNewMailCounter(long which_user);
176 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
177 * This provides a quick way to initialise a variable that might be used to indicate
178 * messages that should not be processed. EG. a new Sieve script will use this
179 * to record determine that messages older than this should not be processed.
180 * This function is defined in control.c
182 long CtdlGetCurrentMessageNumber(void);
187 * Expose various room operation functions from room_ops.c to the modules API
190 unsigned CtdlCreateRoom(char *new_room_name,
197 int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name);
198 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
199 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
200 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
201 int *result, int *view);
202 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
203 void CtdlForEachRoom(void (*CallBack)(struct ctdlroom *EachRoom, void *out_data),
205 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
206 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
207 void CtdlUserGoto (char *where, int display_result, int transiently,
208 int *msgs, int *new);
209 struct floor *CtdlGetCachedFloor(int floor_num);
210 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
211 void CtdlGetFloor (struct floor *flbuf, int floor_num);
212 void CtdlPutFloor (struct floor *flbuf, int floor_num);
213 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
214 int CtdlGetFloorByName(const char *floor_name);
215 int CtdlGetFloorByNameLock(const char *floor_name);
216 int CtdlGetAvailableFloor(void);
217 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
218 void CtdlPutRoom(struct ctdlroom *);
221 * Possible return values for CtdlRenameRoom()
224 crr_ok, /* success */
225 crr_room_not_found, /* room not found */
226 crr_already_exists, /* new name already exists */
227 crr_noneditable, /* cannot edit this room */
228 crr_invalid_floor, /* target floor does not exist */
229 crr_access_denied /* not allowed to edit this room */
235 * API declarations from citserver.h
237 int CtdlAccessCheck(int);
238 /* 'required access level' values which may be passed to CtdlAccessCheck()
242 ac_logged_in_or_guest,
252 * API declarations from serv_extensions.h
254 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
257 * Global system configuration
260 char c_nodename[16]; /* short name of this node on a Citadel network */
261 char c_fqdn[64]; /* this site's fully qualified domain name */
262 char c_humannode[21]; /* human-readable site name */
263 char c_phonenum[16]; /* telephone number */
264 uid_t c_ctdluid; /* uid of posix account under which Citadel will run */
265 char c_creataide; /* 1 = creating a room auto-grants room aide privileges */
266 int c_sleeping; /* watchdog timer (seconds) */
267 char c_initax; /* initial access level for new users */
268 char c_regiscall; /* after c_regiscall logins user will be asked to register */
269 char c_twitdetect; /* automatically move messages from problem users to trashcan */
270 char c_twitroom[ROOMNAMELEN]; /* name of trashcan */
271 char c_moreprompt[80]; /* paginator prompt */
272 char c_restrict; /* require per-user permission to send Internet mail */
274 char c_site_location[32]; /* geographic location of this Citadel site */
275 char c_sysadm[26]; /* name of system administrator */
278 int c_maxsessions; /* maximum number of concurrent sessions allowed */
279 char c_ip_addr[20]; /* bind address for listening sockets */
280 int c_port_number; /* port number for Citadel protocol (usually 504) */
282 struct ExpirePolicy c_ep; /* default expire policy for the entire site */
283 int c_userpurge; /* user purge time (in days) */
284 int c_roompurge; /* room purge time (in days) */
285 char c_logpages[ROOMNAMELEN];
292 int c_rfc822_strict_from;
297 char c_enable_fulltext;
298 char c_baseroom[ROOMNAMELEN];
299 char c_aideroom[ROOMNAMELEN];
301 struct ExpirePolicy c_mbxep;
302 char c_ldap_host[128];
304 char c_ldap_base_dn[256];
305 char c_ldap_bind_dn[256];
306 char c_ldap_bind_pw[256];
312 char c_instant_expunge;
313 char c_allow_spoofing;
314 char c_journal_email;
315 char c_journal_pubmsgs;
316 char c_journal_dest[128];
317 char c_default_cal_zone[128];
318 int c_pftcpdict_port;
319 int c_managesieve_port;
321 char c_funambol_host[256];
323 char c_funambol_source[256];
324 char c_funambol_auth[256];
325 char c_rbl_at_greeting;
326 char c_master_user[32];
327 char c_master_pass[32];
328 char c_pager_program[256];
329 char c_imap_keep_from;
333 time_t c_pop3_fastest;
334 int c_spam_flag_only;
338 extern struct config config;
343 * Expose API calls from user_ops.c
345 int CtdlGetUser(struct ctdluser *usbuf, char *name);
346 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
347 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
348 void CtdlPutUser(struct ctdluser *usbuf);
349 void CtdlPutUserLock(struct ctdluser *usbuf);
350 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
351 void CtdlGetRelationship(visit *vbuf,
352 struct ctdluser *rel_user,
353 struct ctdlroom *rel_room);
354 void CtdlSetRelationship(visit *newvisit,
355 struct ctdluser *rel_user,
356 struct ctdlroom *rel_room);
357 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
359 int CtdlLoginExistingUser(char *authname, const char *username);
362 * Values which may be returned by CtdlLoginExistingUser()
366 pass_already_logged_in,
372 int CtdlTryPassword(const char *password, long len);
374 * Values which may be returned by CtdlTryPassword()
378 login_already_logged_in,
379 login_too_many_users,
383 void CtdlUserLogout(void);
389 * Expose API calls from msgbase.c
391 char *CtdlGetSysConfig(char *sysconfname);
392 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
398 * Expose API calls from euidindex.c
400 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
403 #endif /* CTDL_MODULE_H */