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>
48 #include <libcitadel.h>
51 #include "sysdep_decls.h"
54 #include "citadel_dirs.h"
58 * define macros for module init stuff
61 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
63 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
65 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
67 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
69 #define CtdlAideMessage(TEXT, SUBJECT) \
80 #define CtdlAideFPMessage(TEXT, SUBJECT, N, STR, STRLEN) \
81 flood_protect_quickie_message( \
93 * Hook functions available to modules.
96 #define PRIO_QUEUE 500
97 #define PRIO_AGGR 1000
98 #define PRIO_SEND 1500
99 #define PRIO_CLEANUP 2000
100 /* Priorities for EVT_HOUSE */
101 #define PRIO_HOUSE 3000
102 /* Priorities for EVT_LOGIN */
103 #define PRIO_CREATE 10000
104 /* Priorities for EVT_LOGOUT */
105 #define PRIO_LOGOUT 15000
106 /* Priorities for EVT_LOGIN */
107 #define PRIO_LOGIN 20000
108 /* Priorities for EVT_START */
109 #define PRIO_START 25000
110 /* Priorities for EVT_STOP */
111 #define PRIO_STOP 30000
112 /* Priorities for EVT_ASYNC */
113 #define PRIO_ASYNC 35000
114 /* Priorities for EVT_SHUTDOWN */
115 #define PRIO_SHUTDOWN 40000
116 /* Priorities for EVT_UNSTEALTH */
117 #define PRIO_UNSTEALTH 45000
118 /* Priorities for EVT_STEALTH */
119 #define PRIO_STEALTH 50000
120 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType, int Priority);
121 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
122 void CtdlShutdownServiceHooks(void);
124 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
125 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
127 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
128 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
130 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *),
132 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *),
135 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
136 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
138 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
139 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
141 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
142 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
144 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
145 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
147 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
148 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
150 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
152 void CtdlRegisterServiceHook(int tcp_port,
154 void (*h_greeting_function) (void),
155 void (*h_command_function) (void),
156 void (*h_async_function) (void),
157 const char *ServiceName
159 void CtdlUnregisterServiceHook(int tcp_port,
161 void (*h_greeting_function) (void),
162 void (*h_command_function) (void),
163 void (*h_async_function) (void)
166 void CtdlRegisterFixedOutputHook(char *content_type,
167 void (*output_function) (char *supplied_data, int len)
169 void CtdlUnRegisterFixedOutputHook(char *content_type);
171 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
173 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
177 * Directory services hooks for LDAP etc
180 #define DIRECTORY_USER_DEL 1 // Delete a user entry
181 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
182 #define DIRECTORY_CREATE_OBJECT 3 // Create a new object for directory entry
183 #define DIRECTORY_ATTRIB_ADD 4 // Add an attribute to the directory entry object
184 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
185 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
187 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
188 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
190 /* TODODRW: This needs to be changed into a hook type interface
191 * for now we have this horrible hack
193 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
195 /* return the current context list as an array and do it in a safe manner
196 * The returned data is a copy so only reading is useful
197 * The number of contexts is returned in count.
198 * Beware, this does not copy any of the data pointed to by the context.
199 * This means that you can not rely on things like the redirect buffer being valid.
200 * You must free the returned pointer when done.
202 struct CitContext *CtdlGetContextArray (int *count);
203 void CtdlFillSystemContext(struct CitContext *context, char *name);
204 int CtdlTrySingleUser(void);
205 void CtdlEndSingleUser(void);
206 int CtdlWantSingleUser(void);
207 int CtdlIsSingleUser(void);
210 int CtdlIsUserLoggedIn (char *user_name);
211 int CtdlIsUserLoggedInByNum (long usernum);
212 void CtdlBumpNewMailCounter(long which_user);
216 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
217 * This provides a quick way to initialise a variable that might be used to indicate
218 * messages that should not be processed. EG. a new Sieve script will use this
219 * to record determine that messages older than this should not be processed.
220 * This function is defined in control.c
222 long CtdlGetCurrentMessageNumber(void);
227 * Expose various room operation functions from room_ops.c to the modules API
229 typedef struct CfgLineType CfgLineType;
230 typedef struct RoomNetCfgLine RoomNetCfgLine;
231 typedef struct OneRoomNetCfg OneRoomNetCfg;
233 unsigned CtdlCreateRoom(char *new_room_name,
240 int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name);
241 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
242 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
243 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
244 int *result, int *view);
245 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
246 typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data);
247 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data);
248 typedef void (*ForEachRoomNetCfgCallBack)(struct ctdlroom *EachRoom, void *out_data, const OneRoomNetCfg *OneRNCFG);
249 void CtdlForEachNetCfgRoom(ForEachRoomNetCfgCallBack CB,
253 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
254 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
255 void CtdlUserGoto (char *where, int display_result, int transiently,
256 int *msgs, int *new);
257 struct floor *CtdlGetCachedFloor(int floor_num);
258 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
259 void CtdlGetFloor (struct floor *flbuf, int floor_num);
260 void CtdlPutFloor (struct floor *flbuf, int floor_num);
261 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
262 int CtdlGetFloorByName(const char *floor_name);
263 int CtdlGetFloorByNameLock(const char *floor_name);
264 int CtdlGetAvailableFloor(void);
265 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
266 void CtdlPutRoom(struct ctdlroom *);
269 * Possible return values for CtdlRenameRoom()
272 crr_ok, /* success */
273 crr_room_not_found, /* room not found */
274 crr_already_exists, /* new name already exists */
275 crr_noneditable, /* cannot edit this room */
276 crr_invalid_floor, /* target floor does not exist */
277 crr_access_denied /* not allowed to edit this room */
283 * API declarations from citserver.h
285 int CtdlAccessCheck(int);
286 /* 'required access level' values which may be passed to CtdlAccessCheck()
290 ac_logged_in_or_guest,
300 * API declarations from serv_extensions.h
302 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
305 * Global system configuration
308 char c_nodename[16]; /* short name of this node on a Citadel network */
309 char c_fqdn[64]; /* this site's fully qualified domain name */
310 char c_humannode[21]; /* human-readable site name */
311 char c_phonenum[16]; /* telephone number */
312 uid_t c_ctdluid; /* uid of posix account under which Citadel will run */
313 char c_creataide; /* 1 = creating a room auto-grants room aide privileges */
314 int c_sleeping; /* watchdog timer (seconds) */
315 char c_initax; /* initial access level for new users */
316 char c_regiscall; /* after c_regiscall logins user will be asked to register */
317 char c_twitdetect; /* automatically move messages from problem users to trashcan */
318 char c_twitroom[ROOMNAMELEN]; /* name of trashcan */
319 char c_moreprompt[80]; /* paginator prompt */
320 char c_restrict; /* require per-user permission to send Internet mail */
322 char c_site_location[32]; /* geographic location of this Citadel site */
323 char c_sysadm[26]; /* name of system administrator */
326 int c_maxsessions; /* maximum number of concurrent sessions allowed */
327 char c_ip_addr[20]; /* bind address for listening sockets */
328 int c_port_number; /* port number for Citadel protocol (usually 504) */
330 struct ExpirePolicy c_ep; /* default expire policy for the entire site */
331 int c_userpurge; /* user purge time (in days) */
332 int c_roompurge; /* room purge time (in days) */
333 char c_logpages[ROOMNAMELEN];
340 int c_rfc822_strict_from;
345 char c_enable_fulltext;
346 char c_baseroom[ROOMNAMELEN];
347 char c_aideroom[ROOMNAMELEN];
349 struct ExpirePolicy c_mbxep;
350 char c_ldap_host[128];
352 char c_ldap_base_dn[256];
353 char c_ldap_bind_dn[256];
354 char c_ldap_bind_pw[256];
360 char c_instant_expunge;
361 char c_allow_spoofing;
362 char c_journal_email;
363 char c_journal_pubmsgs;
364 char c_journal_dest[128];
365 char c_default_cal_zone[128];
366 int c_pftcpdict_port;
367 int c_managesieve_port;
369 char c_funambol_host[256];
371 char c_funambol_source[256];
372 char c_funambol_auth[256];
373 char c_rbl_at_greeting;
374 char c_master_user[32];
375 char c_master_pass[32];
376 char c_pager_program[256];
377 char c_imap_keep_from;
381 time_t c_pop3_fastest;
382 int c_spam_flag_only;
386 extern struct config config;
389 typedef void (*CfgLineParser)(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *rncfg);
390 typedef void (*CfgLineSerializer)(const CfgLineType *ThisOne, StrBuf *OuptputBuffer, OneRoomNetCfg *rncfg, RoomNetCfgLine *data);
391 typedef void (*CfgLineDeAllocator)(const CfgLineType *ThisOne, RoomNetCfgLine **data);
395 CfgLineParser Parser;
396 CfgLineSerializer Serializer;
397 CfgLineDeAllocator DeAllocator;
403 struct RoomNetCfgLine {
404 RoomNetCfgLine *next;
409 struct OneRoomNetCfg {
413 RoomNetCfgLine *NetConfigs[maxRoomNetCfg];
418 #define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d);
419 void RegisterRoomCfgType(const char* Name, long len, RoomNetCfg eCfg, CfgLineParser p, int uniq, int nSegments, CfgLineSerializer s, CfgLineDeAllocator d);
420 void ParseGeneric(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *sc);
421 void SerializeGeneric(const CfgLineType *ThisOne, StrBuf *OutputBuffer, OneRoomNetCfg *sc, RoomNetCfgLine *data);
422 void DeleteGenericCfgLine(const CfgLineType *ThisOne, RoomNetCfgLine **data);
424 const OneRoomNetCfg* CtdlGetNetCfgForRoom(long QRNumber);
426 typedef struct _nodeconf {
434 HashList* CtdlLoadIgNetCfg(void);
437 int CtdlNetconfigCheckRoomaccess(char *errmsgbuf,
439 const char* RemoteIdentifier);
442 typedef struct __NetMap {
448 HashList* CtdlReadNetworkMap(void);
449 StrBuf *CtdlSerializeNetworkMap(HashList *Map);
450 void NetworkLearnTopology(char *node, char *path, HashList *the_netmap, int *netmap_changed);
451 int CtdlIsValidNode(const StrBuf **nexthop,
452 const StrBuf **secret,
455 HashList *the_netmap);
460 int CtdlNetworkTalkingTo(const char *nodename, long len, int operation);
463 * Operations that can be performed by network_talking_to()
472 * Expose API calls from user_ops.c
474 int CtdlGetUser(struct ctdluser *usbuf, char *name);
475 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
476 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
477 void CtdlPutUser(struct ctdluser *usbuf);
478 void CtdlPutUserLock(struct ctdluser *usbuf);
479 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
480 void CtdlGetRelationship(visit *vbuf,
481 struct ctdluser *rel_user,
482 struct ctdlroom *rel_room);
483 void CtdlSetRelationship(visit *newvisit,
484 struct ctdluser *rel_user,
485 struct ctdlroom *rel_room);
486 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
488 int CtdlLoginExistingUser(char *authname, const char *username);
491 * Values which may be returned by CtdlLoginExistingUser()
495 pass_already_logged_in,
501 int CtdlTryPassword(const char *password, long len);
503 * Values which may be returned by CtdlTryPassword()
507 login_already_logged_in,
508 login_too_many_users,
512 void CtdlUserLogout(void);
518 * Expose API calls from msgbase.c
520 char *CtdlGetSysConfig(char *sysconfname);
521 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata);
527 * Expose API calls from euidindex.c
529 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
532 #endif /* CTDL_MODULE_H */