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>
37 #include <libcitadel.h>
40 #include "sysdep_decls.h"
43 #include "citadel_dirs.h"
47 * define macros for module init stuff
50 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
52 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
54 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
56 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
58 #define CtdlAideMessage(TEXT, SUBJECT) \
69 #define CtdlAideFPMessage(TEXT, SUBJECT, N, STR, STRLEN, ccid, ioid, TIME) \
70 flood_protect_quickie_message( \
85 * Hook functions available to modules.
88 #define PRIO_QUEUE 500
89 #define PRIO_AGGR 1000
90 #define PRIO_SEND 1500
91 #define PRIO_CLEANUP 2000
92 /* Priorities for EVT_HOUSE */
93 #define PRIO_HOUSE 3000
94 /* Priorities for EVT_LOGIN */
95 #define PRIO_CREATE 10000
96 /* Priorities for EVT_LOGOUT */
97 #define PRIO_LOGOUT 15000
98 /* Priorities for EVT_LOGIN */
99 #define PRIO_LOGIN 20000
100 /* Priorities for EVT_START */
101 #define PRIO_START 25000
102 /* Priorities for EVT_STOP */
103 #define PRIO_STOP 30000
104 /* Priorities for EVT_ASYNC */
105 #define PRIO_ASYNC 35000
106 /* Priorities for EVT_SHUTDOWN */
107 #define PRIO_SHUTDOWN 40000
108 /* Priorities for EVT_UNSTEALTH */
109 #define PRIO_UNSTEALTH 45000
110 /* Priorities for EVT_STEALTH */
111 #define PRIO_STEALTH 50000
112 void CtdlRegisterTDAPVetoHook(int (*fcn_ptr)(StrBuf*), int EventType, int Priority);
113 void CtdlUnregisterTDAPVetoHook(int (*fcn_ptr) (StrBuf*), int EventType);
116 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType, int Priority);
117 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
118 void CtdlShutdownServiceHooks(void);
120 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
121 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
123 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
124 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
126 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes*),
128 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes *),
131 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
132 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
134 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
135 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
137 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
138 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
140 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
141 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
143 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
144 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
146 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
148 void CtdlRegisterServiceHook(int tcp_port,
150 void (*h_greeting_function) (void),
151 void (*h_command_function) (void),
152 void (*h_async_function) (void),
153 const char *ServiceName
155 void CtdlUnregisterServiceHook(int tcp_port,
157 void (*h_greeting_function) (void),
158 void (*h_command_function) (void),
159 void (*h_async_function) (void)
162 void CtdlRegisterFixedOutputHook(char *content_type,
163 void (*output_function) (char *supplied_data, int len)
165 void CtdlUnRegisterFixedOutputHook(char *content_type);
167 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
169 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
173 * Directory services hooks for LDAP etc
176 #define DIRECTORY_USER_DEL 1 // Delete a user entry
177 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
178 #define DIRECTORY_CREATE_OBJECT 3 // Create a new object for directory entry
179 #define DIRECTORY_ATTRIB_ADD 4 // Add an attribute to the directory entry object
180 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
181 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
183 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
184 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
186 /* TODODRW: This needs to be changed into a hook type interface
187 * for now we have this horrible hack
189 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
191 /* return the current context list as an array and do it in a safe manner
192 * The returned data is a copy so only reading is useful
193 * The number of contexts is returned in count.
194 * Beware, this does not copy any of the data pointed to by the context.
195 * This means that you can not rely on things like the redirect buffer being valid.
196 * You must free the returned pointer when done.
198 struct CitContext *CtdlGetContextArray (int *count);
199 void CtdlFillSystemContext(struct CitContext *context, char *name);
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
225 typedef struct CfgLineType CfgLineType;
226 typedef struct RoomNetCfgLine RoomNetCfgLine;
227 typedef struct OneRoomNetCfg OneRoomNetCfg;
229 unsigned CtdlCreateRoom(char *new_room_name,
236 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name);
237 int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name);
238 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
239 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view);
240 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
241 typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data);
242 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data);
243 typedef void (*ForEachRoomNetCfgCallBack)(struct ctdlroom *EachRoom, void *out_data, OneRoomNetCfg *OneRNCFG);
244 void CtdlForEachNetCfgRoom(ForEachRoomNetCfgCallBack CB, void *in_data, RoomNetCfg filter);
245 void SaveChangedConfigs(void);
246 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
247 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
248 void CtdlUserGoto (char *where, int display_result, int transiently, int *msgs, int *new, long *oldest, long *newest);
249 struct floor *CtdlGetCachedFloor(int floor_num);
250 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
251 void CtdlGetFloor (struct floor *flbuf, int floor_num);
252 void CtdlPutFloor (struct floor *flbuf, int floor_num);
253 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
254 int CtdlGetFloorByName(const char *floor_name);
255 int CtdlGetFloorByNameLock(const char *floor_name);
256 int CtdlGetAvailableFloor(void);
257 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
258 void CtdlPutRoom(struct ctdlroom *);
261 * Possible return values for CtdlRenameRoom()
264 crr_ok, /* success */
265 crr_room_not_found, /* room not found */
266 crr_already_exists, /* new name already exists */
267 crr_noneditable, /* cannot edit this room */
268 crr_invalid_floor, /* target floor does not exist */
269 crr_access_denied /* not allowed to edit this room */
275 * API declarations from citserver.h
277 int CtdlAccessCheck(int);
278 /* 'required access level' values which may be passed to CtdlAccessCheck()
282 ac_logged_in_or_guest,
292 * API declarations from serv_extensions.h
294 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
297 #define SET_CFGSTRBUF(which, buffer) safestrncpy(config.which, ChrPtr(buffer), sizeof(config.which))
298 #define SET_CFGSTR(which, buffer) safestrncpy(config.which, buffer, sizeof(config.which))
300 extern struct config config;
303 #define NODENAME config.c_nodename
304 #define FQDN config.c_fqdn
305 #define CTDLUID ctdluid
306 #define CREATAIDE config.c_creataide
307 #define REGISCALL config.c_regiscall
308 #define TWITDETECT config.c_twitdetect
309 #define TWITROOM config.c_twitroom
310 #define RESTRICT_INTERNET config.c_restrict
312 #define CFG_KEY(which) config.which, strlen(config.which)
314 typedef void (*CfgLineParser)(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *rncfg);
315 typedef void (*CfgLineSerializer)(const CfgLineType *ThisOne, StrBuf *OuptputBuffer, OneRoomNetCfg *rncfg, RoomNetCfgLine *data);
316 typedef void (*CfgLineDeAllocator)(const CfgLineType *ThisOne, RoomNetCfgLine **data);
320 CfgLineParser Parser;
321 CfgLineSerializer Serializer;
322 CfgLineDeAllocator DeAllocator;
328 struct RoomNetCfgLine {
329 RoomNetCfgLine *next;
334 struct OneRoomNetCfg {
339 RoomNetCfgLine *NetConfigs[maxRoomNetCfg];
344 #define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d);
345 void RegisterRoomCfgType(const char* Name, long len, RoomNetCfg eCfg, CfgLineParser p, int uniq, int nSegments, CfgLineSerializer s, CfgLineDeAllocator d);
346 void ParseGeneric(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *sc);
347 void SerializeGeneric(const CfgLineType *ThisOne, StrBuf *OutputBuffer, OneRoomNetCfg *sc, RoomNetCfgLine *data);
348 void DeleteGenericCfgLine(const CfgLineType *ThisOne, RoomNetCfgLine **data);
349 RoomNetCfgLine *DuplicateOneGenericCfgLine(const RoomNetCfgLine *data);
350 void AddRoomCfgLine(OneRoomNetCfg *OneRNCfg, struct ctdlroom *qrbuf, RoomNetCfg LineType, RoomNetCfgLine *Line);
352 OneRoomNetCfg* CtdlGetNetCfgForRoom(long QRNumber);
354 typedef struct _nodeconf {
362 HashList* CtdlLoadIgNetCfg(void);
365 int CtdlNetconfigCheckRoomaccess(char *errmsgbuf,
367 const char* RemoteIdentifier);
370 typedef struct __NetMap {
376 HashList* CtdlReadNetworkMap(void);
377 StrBuf *CtdlSerializeNetworkMap(HashList *Map);
378 void NetworkLearnTopology(char *node, char *path, HashList *the_netmap, int *netmap_changed);
379 int CtdlIsValidNode(const StrBuf **nexthop,
380 const StrBuf **secret,
383 HashList *the_netmap);
388 int CtdlNetworkTalkingTo(const char *nodename, long len, int operation);
391 * Operations that can be performed by network_talking_to()
400 * Expose API calls from user_ops.c
402 int CtdlGetUser(struct ctdluser *usbuf, char *name);
403 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
404 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
405 void CtdlPutUser(struct ctdluser *usbuf);
406 void CtdlPutUserLock(struct ctdluser *usbuf);
408 int CtdlLockGetCurrentUser(void);
409 void CtdlPutCurrentUserLock(void);
411 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
412 void CtdlGetRelationship(visit *vbuf,
413 struct ctdluser *rel_user,
414 struct ctdlroom *rel_room);
415 void CtdlSetRelationship(visit *newvisit,
416 struct ctdluser *rel_user,
417 struct ctdlroom *rel_room);
418 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
420 int CtdlLoginExistingUser(char *authname, const char *username);
423 * Values which may be returned by CtdlLoginExistingUser()
427 pass_already_logged_in,
433 int CtdlTryPassword(const char *password, long len);
435 * Values which may be returned by CtdlTryPassword()
439 login_already_logged_in,
440 login_too_many_users,
444 void CtdlUserLogout(void);
450 * Expose API calls from msgbase.c
456 * Expose API calls from euidindex.c
458 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
462 #endif /* CTDL_MODULE_H */