X-Git-Url: https://code.citadel.org/?p=citadel.git;a=blobdiff_plain;f=citadel%2Finclude%2Fctdl_module.h;h=5fae2e0c89d3480711a7e62c59a754c22d7fceb9;hp=5ec05ab08ee91c9ee2f1357bee9a68b6636f0703;hb=58f686487cf5f14d5da5357c67f2e6624dbde027;hpb=c2c1aa8b94024803f623575c5f9ea89d9317f1e0 diff --git a/citadel/include/ctdl_module.h b/citadel/include/ctdl_module.h index 5ec05ab08..5fae2e0c8 100644 --- a/citadel/include/ctdl_module.h +++ b/citadel/include/ctdl_module.h @@ -1,9 +1,21 @@ -/* $Id$ */ #ifndef CTDL_MODULE_H #define CTDL_MODULE_H #include "sysdep.h" + +#ifdef HAVE_GC +#define GC_THREADS +#define GC_REDIRECT_TO_LOCAL +#include +#else +#define GC_MALLOC malloc +#define GC_MALLOC_ATOMIC malloc +#define GC_FREE free +#define GC_REALLOC realloc +#endif + + #include #include #include @@ -12,19 +24,9 @@ #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 #include #ifdef HAVE_STRINGS_H @@ -32,12 +34,6 @@ #endif #include - -#ifndef HAVE_SNPRINTF -#include "snprintf.h" -#endif - - #include #include "server.h" @@ -59,21 +55,67 @@ #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade () - -/* - * Prototype for making log entries in Citadel. - */ - -void CtdlLogPrintf(enum LogLevel loglevel, const char *format, ...); - -#define CtdlAideMessage(TEXT, SUBJECT) quickie_message("Citadel",NULL,NULL,AIDEROOM,TEXT,FMT_CITADEL,SUBJECT) - +#define CtdlAideMessage(TEXT, SUBJECT) \ + quickie_message( \ + "Citadel", \ + NULL, \ + NULL, \ + AIDEROOM, \ + TEXT, \ + FMT_CITADEL, \ + SUBJECT) + + +#define CtdlAideFPMessage(TEXT, SUBJECT, N, STR, STRLEN, ccid, ioid, TIME) \ + flood_protect_quickie_message( \ + "Citadel", \ + NULL, \ + NULL, \ + AIDEROOM, \ + TEXT, \ + FMT_CITADEL, \ + SUBJECT, \ + N, \ + STR, \ + STRLEN, \ + ccid, \ + ioid, \ + TIME) /* * Hook functions available to modules. */ - -void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType); +/* Priorities for */ +#define PRIO_QUEUE 500 +#define PRIO_AGGR 1000 +#define PRIO_SEND 1500 +#define PRIO_CLEANUP 2000 +/* Priorities for EVT_HOUSE */ +#define PRIO_HOUSE 3000 +/* Priorities for EVT_LOGIN */ +#define PRIO_CREATE 10000 +/* Priorities for EVT_LOGOUT */ +#define PRIO_LOGOUT 15000 +/* Priorities for EVT_LOGIN */ +#define PRIO_LOGIN 20000 +/* Priorities for EVT_START */ +#define PRIO_START 25000 +/* Priorities for EVT_STOP */ +#define PRIO_STOP 30000 +/* Priorities for EVT_ASYNC */ +#define PRIO_ASYNC 35000 +/* Priorities for EVT_SHUTDOWN */ +#define PRIO_SHUTDOWN 40000 +/* Priorities for EVT_UNSTEALTH */ +#define PRIO_UNSTEALTH 45000 +/* Priorities for EVT_STEALTH */ +#define PRIO_STEALTH 50000 +void CtdlRegisterTDAPVetoHook(int (*fcn_ptr)(StrBuf*), int EventType, int Priority); +void CtdlUnregisterTDAPVetoHook(int (*fcn_ptr) (StrBuf*), int EventType); + + +void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType, int Priority); void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType); +void CtdlShutdownServiceHooks(void); void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType); void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType); @@ -81,10 +123,10 @@ void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType); void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order); void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order); -void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *), - int EventType); -void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *), +void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes*), int EventType); +void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes *), + int EventType); void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) ); void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) ); @@ -98,6 +140,9 @@ void CtdlUnregisterDeleteHook(void (*handler)(char *, long) ); void CtdlRegisterCleanupHook(void (*fcn_ptr)(void)); void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void)); +void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void)); +void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void)); + void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc); void CtdlRegisterServiceHook(int tcp_port, @@ -121,8 +166,14 @@ void CtdlUnRegisterFixedOutputHook(char *content_type); void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg)); -void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, char *), char *name); +void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name); +/* + * if you say a) (which may take a while) + * don't forget to say b) + */ +void CtdlDisableHouseKeeping(void); +void CtdlEnableHouseKeeping(void); /* * Directory services hooks for LDAP etc @@ -143,37 +194,7 @@ int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, */ void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response); - -/* - * Citadel Threads API - */ -struct CtdlThreadNode *CtdlThreadCreate(char *name, long flags, void *(*thread_func) (void *arg), void *args); -struct CtdlThreadNode *CtdlThreadSchedule(char *name, long flags, void *(*thread_func) (void *arg), void *args, time_t when); -void CtdlThreadSleep(int secs); -void CtdlThreadStop(struct CtdlThreadNode *thread); -int CtdlThreadCheckStop(void); -/* void CtdlThreadCancel2(struct CtdlThreadNode *thread); Leave this out, it should never be needed */ -const char *CtdlThreadName(const char *name); -struct CtdlThreadNode *CtdlThreadSelf(void); -int CtdlThreadGetCount(void); -int CtdlThreadGetWorkers(void); -double CtdlThreadGetWorkerAvg(void); -double CtdlThreadGetLoadAvg(void); -void CtdlThreadGC(void); -void CtdlThreadStopAll(void); -int CtdlThreadSelect(int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout); -void CtdlThreadAllocTSD(void); - -#define CTDLTHREAD_BIGSTACK 0x0001 -#define CTDLTHREAD_WORKER 0x0002 - -/* Macros to speed up getting outr thread */ - -#define MYCURSORS (((ThreadTSD*)pthread_getspecific(ThreadKey))->cursors) -#define MYTID (((ThreadTSD*)pthread_getspecific(ThreadKey))->tid) -#define CT (((ThreadTSD*)pthread_getspecific(ThreadKey))->self) - -/** return the current context list as an array and do it in a safe manner +/* return the current context list as an array and do it in a safe manner * The returned data is a copy so only reading is useful * The number of contexts is returned in count. * Beware, this does not copy any of the data pointed to by the context. @@ -182,7 +203,6 @@ void CtdlThreadAllocTSD(void); */ struct CitContext *CtdlGetContextArray (int *count); void CtdlFillSystemContext(struct CitContext *context, char *name); - int CtdlTrySingleUser(void); void CtdlEndSingleUser(void); int CtdlWantSingleUser(void); @@ -190,7 +210,8 @@ int CtdlIsSingleUser(void); int CtdlIsUserLoggedIn (char *user_name); -int CtdlIsUserLoggedInByNum (int usernum); +int CtdlIsUserLoggedInByNum (long usernum); +void CtdlBumpNewMailCounter(long which_user); /* @@ -207,6 +228,9 @@ long CtdlGetCurrentMessageNumber(void); /* * Expose various room operation functions from room_ops.c to the modules API */ +typedef struct CfgLineType CfgLineType; +typedef struct RoomNetCfgLine RoomNetCfgLine; +typedef struct OneRoomNetCfg OneRoomNetCfg; unsigned CtdlCreateRoom(char *new_room_name, int new_room_type, @@ -215,18 +239,20 @@ unsigned CtdlCreateRoom(char *new_room_name, 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 CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name); +int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name); int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr); -void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, - int *result, int *view); +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); +typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data); +void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data); +typedef void (*ForEachRoomNetCfgCallBack)(struct ctdlroom *EachRoom, void *out_data, OneRoomNetCfg *OneRNCFG); +char *LoadRoomNetConfigFile(long roomnum); +void CtdlForEachNetCfgRoom(ForEachRoomNetCfgCallBack CB, void *in_data); +void SaveChangedConfigs(void); 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); +void CtdlUserGoto (char *where, int display_result, int transiently, int *msgs, int *new, long *oldest, long *newest); struct floor *CtdlGetCachedFloor(int floor_num); void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf); void CtdlGetFloor (struct floor *flbuf, int floor_num); @@ -260,10 +286,11 @@ int CtdlAccessCheck(int); */ enum { ac_none, + ac_logged_in_or_guest, ac_logged_in, ac_room_aide, ac_aide, - ac_internal + ac_internal, }; @@ -271,37 +298,126 @@ enum { /* * 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" +void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name); + +#define NODENAME CtdlGetConfigStr("c_nodename") +#define FQDN CtdlGetConfigStr("c_fqdn") +#define CTDLUID ctdluid +#define CREATAIDE CtdlGetConfigInt("c_creataide") +#define REGISCALL CtdlGetConfigInt("c_regiscall") +#define TWITDETECT CtdlGetConfigInt("c_twitdetect") +#define TWITROOM CtdlGetConfigStr("c_twitroom") +#define RESTRICT_INTERNET CtdlGetConfigInt("c_restrict") + +typedef void (*CfgLineParser)(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *rncfg); +typedef void (*CfgLineSerializer)(const CfgLineType *ThisOne, StrBuf *OuptputBuffer, OneRoomNetCfg *rncfg, RoomNetCfgLine *data); +typedef void (*CfgLineDeAllocator)(const CfgLineType *ThisOne, RoomNetCfgLine **data); + +struct CfgLineType { + RoomNetCfg C; + CfgLineParser Parser; + CfgLineSerializer Serializer; + CfgLineDeAllocator DeAllocator; + ConstStr Str; + int IsSingleLine; + int nSegments; +}; + +struct RoomNetCfgLine { + RoomNetCfgLine *next; + int nValues; + StrBuf **Value; }; -extern struct config config; +struct OneRoomNetCfg { + long lastsent; + // long changed; + StrBuf *Sender; + StrBuf *RoomInfo; + RoomNetCfgLine *NetConfigs[maxRoomNetCfg]; + StrBuf *misc; +}; + + +#define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d); +void RegisterRoomCfgType(const char* Name, long len, RoomNetCfg eCfg, CfgLineParser p, int uniq, int nSegments, CfgLineSerializer s, CfgLineDeAllocator d); +void ParseGeneric(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *sc); +void SerializeGeneric(const CfgLineType *ThisOne, StrBuf *OutputBuffer, OneRoomNetCfg *sc, RoomNetCfgLine *data); +void DeleteGenericCfgLine(const CfgLineType *ThisOne, RoomNetCfgLine **data); +RoomNetCfgLine *DuplicateOneGenericCfgLine(const RoomNetCfgLine *data); +void AddRoomCfgLine(OneRoomNetCfg *OneRNCfg, struct ctdlroom *qrbuf, RoomNetCfg LineType, RoomNetCfgLine *Line); + +OneRoomNetCfg *CtdlGetNetCfgForRoom(long QRNumber); +void SaveRoomNetConfigFile(OneRoomNetCfg *, long); +void FreeRoomNetworkStruct(OneRoomNetCfg **); + +typedef struct _nodeconf { + int DeleteMe; + StrBuf *NodeName; + StrBuf *Secret; + StrBuf *Host; + StrBuf *Port; +}CtdlNodeConf; + +HashList* CtdlLoadIgNetCfg(void); + + +int CtdlNetconfigCheckRoomaccess(char *errmsgbuf, + size_t n, + const char* RemoteIdentifier); + +typedef struct __NetMap { + StrBuf *NodeName; + time_t lastcontact; + StrBuf *NextHop; +}CtdlNetMap; +HashList* CtdlReadNetworkMap(void); +StrBuf *CtdlSerializeNetworkMap(HashList *Map); +void NetworkLearnTopology(char *node, char *path, HashList *the_netmap, int *netmap_changed); +int CtdlIsValidNode(const StrBuf **nexthop, + const StrBuf **secret, + StrBuf *node, + HashList *IgnetCfg, + HashList *the_netmap); + + + + +int CtdlNetworkTalkingTo(const char *nodename, long len, int operation); + +/* + * Operations that can be performed by network_talking_to() + */ +enum { + NTT_ADD, + NTT_REMOVE, + NTT_CHECK +}; /* * Expose API calls from user_ops.c */ -int CtdlGetUser(struct ctdluser *usbuf, char name[]); +int CtdlGetUser(struct ctdluser *usbuf, char *name); +int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len); int CtdlGetUserLock(struct ctdluser *usbuf, char *name); void CtdlPutUser(struct ctdluser *usbuf); void CtdlPutUserLock(struct ctdluser *usbuf); + +int CtdlLockGetCurrentUser(void); +void CtdlPutCurrentUserLock(void); + int CtdlGetUserByNumber(struct ctdluser *usbuf, long number); -void CtdlGetRelationship(struct visit *vbuf, +void CtdlGetRelationship(visit *vbuf, struct ctdluser *rel_user, struct ctdlroom *rel_room); -void CtdlSetRelationship(struct visit *newvisit, +void CtdlSetRelationship(visit *newvisit, struct ctdluser *rel_user, struct ctdlroom *rel_room); void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix); -int CtdlLoginExistingUser(char *authname, char *username); +int CtdlLoginExistingUser(char *authname, const char *username); /* * Values which may be returned by CtdlLoginExistingUser() @@ -314,7 +430,7 @@ enum { pass_wrong_password }; -int CtdlTryPassword(char *password); +int CtdlTryPassword(const char *password, long len); /* * Values which may be returned by CtdlTryPassword() */ @@ -333,9 +449,6 @@ void CtdlUserLogout(void); /* * Expose API calls from msgbase.c */ -char *CtdlGetSysConfig(char *sysconfname); -void CtdlPutSysConfig(char *sysconfname, char *sysconfdata); - @@ -345,4 +458,5 @@ void CtdlPutSysConfig(char *sysconfname, char *sysconfdata); long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf); + #endif /* CTDL_MODULE_H */