X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Finclude%2Fctdl_module.h;h=71fa155340686ef1876aabcbf5f01f78f2edfa77;hb=db96f0d5e16098e0087d5c179cc5fd90453581f9;hp=90932ca82e3c3b701a5689ef8a9d645aa04b51e4;hpb=cbc2a603ed4c3995836e45fd400e44e12868f5f8;p=citadel.git diff --git a/citadel/include/ctdl_module.h b/citadel/include/ctdl_module.h index 90932ca82..71fa15534 100644 --- a/citadel/include/ctdl_module.h +++ b/citadel/include/ctdl_module.h @@ -3,11 +3,48 @@ #ifndef CTDL_MODULE_H #define CTDL_MODULE_H +#include "sysdep.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if TIME_WITH_SYS_TIME +# include +# include +#else +# if HAVE_SYS_TIME_H +# include +# else +# include +# endif +#endif + +#include +#include +#ifdef HAVE_STRINGS_H +#include +#endif +#include + + +#ifndef HAVE_SNPRINTF +#include "snprintf.h" +#endif + + #include + #include "server.h" #include "sysdep_decls.h" #include "msgbase.h" #include "threads.h" +#include "citadel_dirs.h" /* * define macros for module init stuff */ @@ -27,11 +64,7 @@ void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...); -/* - * Fix the interface to aide_message so that it complies with the Coding style - */ - -#define CtdlAideMessage(TEXT, SUBJECT) aide_message(TEXT, SUBJECT) +#define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT) /* * Hook functions available to modules. @@ -64,7 +97,6 @@ void CtdlRegisterCleanupHook(void (*fcn_ptr)(void)); void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void)); void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc); -void CtdlUnregisterProtoHook(void (*handler)(char *), char *cmd); void CtdlRegisterServiceHook(int tcp_port, char *sockpath, @@ -149,6 +181,10 @@ void CtdlThreadAllocTSD(void); struct CitContext *CtdlGetContextArray (int *count); void CtdlFillSystemContext(struct CitContext *context, char *name); +int CtdlTrySingleUser(void); +void CtdlEndSingleUser(void); +int CtdlWantSingleUser(void); +int CtdlIsSingleUser(void); /* @@ -160,4 +196,110 @@ void CtdlFillSystemContext(struct CitContext *context, char *name); */ long CtdlGetCurrentMessageNumber(void); + + +/* + * Expose various room operation functions from room_ops.c to the modules API + */ + +unsigned CtdlCreateRoom(char *new_room_name, + int new_room_type, + char *new_room_pass, + int new_room_floor, + int really_create, + int avoid_access, + int new_room_view); +int CtdlGetRoom(struct ctdlroom *qrbuf, char *room_name); +int CtdlGetRoomLock(struct ctdlroom *qrbuf, char *room_name); +int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr); +void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, + int *result, int *view); +void CtdlPutRoomLock(struct ctdlroom *qrbuf); +void CtdlForEachRoom(void (*CallBack)(struct ctdlroom *EachRoom, void *out_data), + void *in_data); +void CtdlDeleteRoom(struct ctdlroom *qrbuf); +int CtdlRenameRoom(char *old_name, char *new_name, int new_floor); +void CtdlUserGoto (char *where, int display_result, int transiently, + int *msgs, int *new); +struct floor *CtdlGetCachedFloor(int floor_num); +void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf); +void CtdlGetFloor (struct floor *flbuf, int floor_num); +void CtdlPutFloor (struct floor *flbuf, int floor_num); +void CtdlPutFloorLock(struct floor *flbuf, int floor_num); +int CtdlGetFloorByName(const char *floor_name); +int CtdlGetFloorByNameLock(const char *floor_name); +int CtdlGetAvailableFloor(void); +int CtdlIsNonEditable(struct ctdlroom *qrbuf); +void CtdlPutRoom(struct ctdlroom *); + +/* + * Possible return values for CtdlRenameRoom() + */ +enum { + crr_ok, /* success */ + crr_room_not_found, /* room not found */ + crr_already_exists, /* new name already exists */ + crr_noneditable, /* cannot edit this room */ + crr_invalid_floor, /* target floor does not exist */ + crr_access_denied /* not allowed to edit this room */ +}; + + + +/* + * API declarations from citserver.h + */ +int CtdlAccessCheck(int); +/* 'required access level' values which may be passed to CtdlAccessCheck() + */ +enum { + ac_none, + ac_logged_in, + ac_room_aide, + ac_aide, + ac_internal +}; + + + +/* + * API declarations from serv_extensions.h + */ +void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, char *search_string, char *func_name); +/* + * Global system configuration. Don't change anything here. It's all in dtds/config-defs.h now. + */ +struct config { +#include "datadefinitions.h" +#include "dtds/config-defs.h" +#include "undef_data.h" +}; + +extern struct config config; + + + +/* + * Expose API calls from user_ops.c + */ +int CtdlGetUser(struct ctdluser *usbuf, char name[]); +int CtdlGetUserLock(struct ctdluser *usbuf, char *name); +void CtdlPutUser(struct ctdluser *usbuf); +void CtdlPutUserLock(struct ctdluser *usbuf); +int CtdlGetUserByNumber(struct ctdluser *usbuf, long number); +void CtdlGetRelationship(struct visit *vbuf, + struct ctdluser *rel_user, + struct ctdlroom *rel_room); +void CtdlSetRelationship(struct visit *newvisit, + struct ctdluser *rel_user, + struct ctdlroom *rel_room); +void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix); + + +/* + * Expose API calls from msgbase.c + */ +char *CtdlGetSysConfig(char *sysconfname); +void CtdlPutSysConfig(char *sysconfname, char *sysconfdata); + #endif /* CTDL_MODULE_H */