citadel/include/ctdl_module.h

   1
   2 #ifndef CTDL_MODULE_H
   3 #define CTDL_MODULE_H
   4
   5 #include "sysdep.h"
   6
   7 #ifdef HAVE_GC
   8 #define GC_THREADS
   9 #define GC_REDIRECT_TO_LOCAL
  10 #include <gc/gc_local_alloc.h>
  11 #else
  12 #define GC_MALLOC malloc
  13 #define GC_MALLOC_ATOMIC malloc
  14 #define GC_FREE free
  15 #define GC_REALLOC realloc
  16 #endif
  17
  18
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <stdio.h>
  22 #include <fcntl.h>
  23 #include <ctype.h>
  24 #include <signal.h>
  25 #include <pwd.h>
  26 #include <errno.h>
  27 #include <syslog.h>
  28 #include <sys/types.h>
  29 #include <time.h>
  30 #include <sys/wait.h>
  31 #include <string.h>
  32 #ifdef HAVE_STRINGS_H
  33 #include <strings.h>
  34 #endif
  35 #include <limits.h>
  36
  37 #include <libcitadel.h>
  38
  39 #include "server.h"
  40 #include "sysdep_decls.h"
  41 #include "msgbase.h"
  42 #include "threads.h"
  43 #include "citadel_dirs.h"
  44 #include "context.h"
  45
  46 /*
  47  * define macros for module init stuff
  48  */
  49
  50 #define CTDL_MODULE_INIT(module_name) char *ctdl_module_##module_name##_init (int threading)
  51
  52 #define CTDL_INIT_CALL(module_name) ctdl_module_##module_name##_init (threading)
  53
  54 #define CTDL_MODULE_UPGRADE(module_name) char *ctdl_module_##module_name##_upgrade (void)
  55
  56 #define CTDL_UPGRADE_CALL(module_name) ctdl_module_##module_name##_upgrade ()
  57
  58 #define CtdlAideMessage(TEXT, SUBJECT)          \
  59         quickie_message(                        \
  60                 "Citadel",                      \
  61                 NULL,                           \
  62                 NULL,                           \
  63                 AIDEROOM,                       \
  64                 TEXT,                           \
  65                 FMT_CITADEL,                    \
  66                 SUBJECT)
  67
  68 /*
  69  * Hook functions available to modules.
  70  */
  71 /* Priorities for  */
  72 #define PRIO_QUEUE 500
  73 #define PRIO_AGGR 1000
  74 #define PRIO_SEND 1500
  75 #define PRIO_CLEANUP 2000
  76 /* Priorities for EVT_HOUSE */
  77 #define PRIO_HOUSE 3000
  78 /* Priorities for EVT_LOGIN */
  79 #define PRIO_CREATE 10000
  80 /* Priorities for EVT_LOGOUT */
  81 #define PRIO_LOGOUT 15000
  82 /* Priorities for EVT_LOGIN */
  83 #define PRIO_LOGIN 20000
  84 /* Priorities for EVT_START */
  85 #define PRIO_START 25000
  86 /* Priorities for EVT_STOP */
  87 #define PRIO_STOP 30000
  88 /* Priorities for EVT_ASYNC */
  89 #define PRIO_ASYNC 35000
  90 /* Priorities for EVT_SHUTDOWN */
  91 #define PRIO_SHUTDOWN 40000
  92 /* Priorities for EVT_UNSTEALTH */
  93 #define PRIO_UNSTEALTH 45000
  94 /* Priorities for EVT_STEALTH */
  95 #define PRIO_STEALTH 50000
  96 void CtdlRegisterTDAPVetoHook(int (*fcn_ptr)(StrBuf*), int EventType, int Priority);
  97 void CtdlUnregisterTDAPVetoHook(int (*fcn_ptr) (StrBuf*), int EventType);
  98
  99
 100 void CtdlRegisterSessionHook(void (*fcn_ptr)(void), int EventType, int Priority);
 101 void CtdlUnregisterSessionHook(void (*fcn_ptr)(void), int EventType);
 102 void CtdlShutdownServiceHooks(void);
 103
 104 void CtdlRegisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
 105 void CtdlUnregisterUserHook(void (*fcn_ptr)(struct ctdluser *), int EventType);
 106
 107 void CtdlRegisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
 108 void CtdlUnregisterXmsgHook(int (*fcn_ptr)(char *, char *, char *, char *), int order);
 109
 110 void CtdlRegisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes*),
 111                                                         int EventType);
 112 void CtdlUnregisterMessageHook(int (*handler)(struct CtdlMessage *, recptypes *),
 113                                int EventType);
 114
 115 void CtdlRegisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
 116 void CtdlUnregisterNetprocHook(int (*handler)(struct CtdlMessage *, char *) );
 117
 118 void CtdlRegisterRoomHook(int (*fcn_ptr)(struct ctdlroom *) );
 119 void CtdlUnregisterRoomHook(int (*fnc_ptr)(struct ctdlroom *) );
 120
 121 void CtdlRegisterDeleteHook(void (*handler)(char *, long) );
 122 void CtdlUnregisterDeleteHook(void (*handler)(char *, long) );
 123
 124 void CtdlRegisterCleanupHook(void (*fcn_ptr)(void));
 125 void CtdlUnregisterCleanupHook(void (*fcn_ptr)(void));
 126
 127 void CtdlRegisterEVCleanupHook(void (*fcn_ptr)(void));
 128 void CtdlUnregisterEVCleanupHook(void (*fcn_ptr)(void));
 129
 130 void CtdlRegisterProtoHook(void (*handler)(char *), char *cmd, char *desc);
 131
 132 void CtdlRegisterServiceHook(int tcp_port,
 133                              char *sockpath,
 134                              void (*h_greeting_function) (void),
 135                              void (*h_command_function) (void),
 136                              void (*h_async_function) (void),
 137                              const char *ServiceName
 138 );
 139 void CtdlUnregisterServiceHook(int tcp_port,
 140                         char *sockpath,
 141                         void (*h_greeting_function) (void),
 142                         void (*h_command_function) (void),
 143                         void (*h_async_function) (void)
 144 );
 145
 146 void CtdlRegisterFixedOutputHook(char *content_type,
 147                         void (*output_function) (char *supplied_data, int len)
 148 );
 149 void CtdlUnRegisterFixedOutputHook(char *content_type);
 150
 151 void CtdlRegisterMaintenanceThread(char *name, void *(*thread_proc) (void *arg));
 152
 153 void CtdlRegisterSearchFuncHook(void (*fcn_ptr)(int *, long **, const char *), char *name);
 154
 155 /*
 156  * if you say a) (which may take a while)
 157  * don't forget to say b)
 158  */
 159 void CtdlDisableHouseKeeping(void);
 160 void CtdlEnableHouseKeeping(void);
 161
 162 /*
 163  * Directory services hooks for LDAP etc
 164  */
 165
 166 #define DIRECTORY_USER_DEL 1    // Delete a user entry
 167 #define DIRECTORY_CREATE_HOST 2 // Create a host entry if not already there.
 168 #define DIRECTORY_CREATE_OBJECT 3       // Create a new object for directory entry
 169 #define DIRECTORY_ATTRIB_ADD 4  // Add an attribute to the directory entry object
 170 #define DIRECTORY_SAVE_OBJECT 5 // Save the object to the directory service
 171 #define DIRECTORY_FREE_OBJECT 6 // Free the object and its attributes
 172
 173 int CtdlRegisterDirectoryServiceFunc(int (*func)(char *cn, char *ou, void **object), int cmd, char *module);
 174 int CtdlDoDirectoryServiceFunc(char *cn, char *ou, void **object, char *module, int cmd);
 175
 176 /* TODODRW: This needs to be changed into a hook type interface
 177  * for now we have this horrible hack
 178  */
 179 void CtdlModuleStartCryptoMsgs(char *ok_response, char *nosup_response, char *error_response);
 180
 181 /* return the current context list as an array and do it in a safe manner
 182  * The returned data is a copy so only reading is useful
 183  * The number of contexts is returned in count.
 184  * Beware, this does not copy any of the data pointed to by the context.
 185  * This means that you can not rely on things like the redirect buffer being valid.
 186  * You must free the returned pointer when done.
 187  */
 188 struct CitContext *CtdlGetContextArray (int *count);
 189 void CtdlFillSystemContext(struct CitContext *context, char *name);
 190 int CtdlTrySingleUser(void);
 191 void CtdlEndSingleUser(void);
 192 int CtdlWantSingleUser(void);
 193 int CtdlIsSingleUser(void);
 194
 195
 196 int CtdlIsUserLoggedIn (char *user_name);
 197 int CtdlIsUserLoggedInByNum (long usernum);
 198 void CtdlBumpNewMailCounter(long which_user);
 199
 200
 201 /*
 202  * CtdlGetCurrentMessageNumber()  -  Obtain the current highest message number in the system
 203  * This provides a quick way to initialise a variable that might be used to indicate
 204  * messages that should not be processed. EG. a new Sieve script will use this
 205  * to record determine that messages older than this should not be processed.
 206  * This function is defined in control.c
 207  */
 208 long CtdlGetCurrentMessageNumber(void);
 209
 210
 211
 212 /*
 213  * Expose various room operation functions from room_ops.c to the modules API
 214  */
 215 typedef struct CfgLineType CfgLineType;
 216 typedef struct RoomNetCfgLine RoomNetCfgLine;
 217 typedef struct OneRoomNetCfg OneRoomNetCfg;
 218
 219 unsigned CtdlCreateRoom(char *new_room_name,
 220                         int new_room_type,
 221                         char *new_room_pass,
 222                         int new_room_floor,
 223                         int really_create,
 224                         int avoid_access,
 225                         int new_room_view);
 226 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name);
 227 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name);
 228 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr);
 229 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view);
 230 void CtdlPutRoomLock(struct ctdlroom *qrbuf);
 231 typedef void (*ForEachRoomCallBack)(struct ctdlroom *EachRoom, void *out_data);
 232 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data);
 233 typedef void (*ForEachRoomNetCfgCallBack)(struct ctdlroom *EachRoom, void *out_data, OneRoomNetCfg *OneRNCFG);
 234 char *LoadRoomNetConfigFile(long roomnum);
 235 void CtdlForEachNetCfgRoom(ForEachRoomNetCfgCallBack CB, void *in_data);
 236 void SaveChangedConfigs(void);
 237 void CtdlDeleteRoom(struct ctdlroom *qrbuf);
 238 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor);
 239 void CtdlUserGoto (char *where, int display_result, int transiently, int *msgs, int *new, long *oldest, long *newest);
 240 struct floor *CtdlGetCachedFloor(int floor_num);
 241 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf);
 242 void CtdlGetFloor (struct floor *flbuf, int floor_num);
 243 void CtdlPutFloor (struct floor *flbuf, int floor_num);
 244 void CtdlPutFloorLock(struct floor *flbuf, int floor_num);
 245 int CtdlGetFloorByName(const char *floor_name);
 246 int CtdlGetFloorByNameLock(const char *floor_name);
 247 int CtdlGetAvailableFloor(void);
 248 int CtdlIsNonEditable(struct ctdlroom *qrbuf);
 249 void CtdlPutRoom(struct ctdlroom *);
 250
 251 /*
 252  * Possible return values for CtdlRenameRoom()
 253  */
 254 enum {
 255         crr_ok,                         /* success */
 256         crr_room_not_found,             /* room not found */
 257         crr_already_exists,             /* new name already exists */
 258         crr_noneditable,                /* cannot edit this room */
 259         crr_invalid_floor,              /* target floor does not exist */
 260         crr_access_denied               /* not allowed to edit this room */
 261 };
 262
 263
 264
 265 /*
 266  * API declarations from citserver.h
 267  */
 268 int CtdlAccessCheck(int);
 269 /* 'required access level' values which may be passed to CtdlAccessCheck()
 270  */
 271 enum {
 272         ac_none,
 273         ac_logged_in_or_guest,
 274         ac_logged_in,
 275         ac_room_aide,
 276         ac_aide,
 277         ac_internal,
 278 };
 279
 280
 281
 282 /*
 283  * API declarations from serv_extensions.h
 284  */
 285 void CtdlModuleDoSearch(int *num_msgs, long **search_msgs, const char *search_string, const char *func_name);
 286
 287 #define NODENAME                CtdlGetConfigStr("c_nodename")
 288 #define FQDN                    CtdlGetConfigStr("c_fqdn")
 289 #define CTDLUID                 ctdluid
 290 #define CREATAIDE               CtdlGetConfigInt("c_creataide")
 291 #define REGISCALL               CtdlGetConfigInt("c_regiscall")
 292 #define TWITDETECT              CtdlGetConfigInt("c_twitdetect")
 293 #define TWITROOM                CtdlGetConfigStr("c_twitroom")
 294 #define RESTRICT_INTERNET       CtdlGetConfigInt("c_restrict")
 295
 296 typedef void (*CfgLineParser)(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *rncfg);
 297 typedef void (*CfgLineSerializer)(const CfgLineType *ThisOne, StrBuf *OuptputBuffer, OneRoomNetCfg *rncfg, RoomNetCfgLine *data);
 298 typedef void (*CfgLineDeAllocator)(const CfgLineType *ThisOne, RoomNetCfgLine **data);
 299
 300 struct CfgLineType {
 301         RoomNetCfg C;
 302         CfgLineParser Parser;
 303         CfgLineSerializer Serializer;
 304         CfgLineDeAllocator DeAllocator;
 305         ConstStr Str;
 306         int IsSingleLine;
 307         int nSegments;
 308 };
 309
 310 struct RoomNetCfgLine {
 311         RoomNetCfgLine *next;
 312         int nValues;
 313         StrBuf **Value;
 314 };
 315
 316 struct OneRoomNetCfg {
 317         long lastsent;
 318         // long changed;
 319         StrBuf *Sender;
 320         StrBuf *RoomInfo;
 321         RoomNetCfgLine *NetConfigs[maxRoomNetCfg];
 322         StrBuf *misc;
 323 };
 324
 325
 326 #define CtdlREGISTERRoomCfgType(a, p, uniq, nSegs, s, d) RegisterRoomCfgType(#a, sizeof(#a) - 1, a, p, uniq, nSegs, s, d);
 327 void RegisterRoomCfgType(const char* Name, long len, RoomNetCfg eCfg, CfgLineParser p, int uniq, int nSegments, CfgLineSerializer s, CfgLineDeAllocator d);
 328 void ParseGeneric(const CfgLineType *ThisOne, StrBuf *Line, const char *LinePos, OneRoomNetCfg *sc);
 329 void SerializeGeneric(const CfgLineType *ThisOne, StrBuf *OutputBuffer, OneRoomNetCfg *sc, RoomNetCfgLine *data);
 330 void DeleteGenericCfgLine(const CfgLineType *ThisOne, RoomNetCfgLine **data);
 331 RoomNetCfgLine *DuplicateOneGenericCfgLine(const RoomNetCfgLine *data);
 332 void AddRoomCfgLine(OneRoomNetCfg *OneRNCfg, struct ctdlroom *qrbuf, RoomNetCfg LineType, RoomNetCfgLine *Line);
 333
 334 OneRoomNetCfg *CtdlGetNetCfgForRoom(long QRNumber);
 335 void SaveRoomNetConfigFile(OneRoomNetCfg *, long);
 336 void FreeRoomNetworkStruct(OneRoomNetCfg **);
 337
 338 typedef struct _nodeconf {
 339         int DeleteMe;
 340         StrBuf *NodeName;
 341         StrBuf *Secret;
 342         StrBuf *Host;
 343         StrBuf *Port;
 344 }CtdlNodeConf;
 345
 346 HashList* CtdlLoadIgNetCfg(void);
 347
 348
 349 int CtdlNetconfigCheckRoomaccess(char *errmsgbuf,
 350                                  size_t n,
 351                                  const char* RemoteIdentifier);
 352
 353
 354 typedef struct __NetMap {
 355         StrBuf *NodeName;
 356         time_t lastcontact;
 357         StrBuf *NextHop;
 358 }CtdlNetMap;
 359
 360 HashList* CtdlReadNetworkMap(void);
 361 StrBuf *CtdlSerializeNetworkMap(HashList *Map);
 362 void NetworkLearnTopology(char *node, char *path, HashList *the_netmap, int *netmap_changed);
 363 int CtdlIsValidNode(const StrBuf **nexthop,
 364                     const StrBuf **secret,
 365                     StrBuf *node,
 366                     HashList *IgnetCfg,
 367                     HashList *the_netmap);
 368
 369
 370
 371
 372 int CtdlNetworkTalkingTo(const char *nodename, long len, int operation);
 373
 374 /*
 375  * Operations that can be performed by network_talking_to()
 376  */
 377 enum {
 378         NTT_ADD,
 379         NTT_REMOVE,
 380         NTT_CHECK
 381 };
 382
 383 /*
 384  * Expose API calls from user_ops.c
 385  */
 386 int CtdlGetUser(struct ctdluser *usbuf, char *name);
 387 int CtdlGetUserLen(struct ctdluser *usbuf, const char *name, long len);
 388 int CtdlGetUserLock(struct ctdluser *usbuf, char *name);
 389 void CtdlPutUser(struct ctdluser *usbuf);
 390 void CtdlPutUserLock(struct ctdluser *usbuf);
 391
 392 int CtdlLockGetCurrentUser(void);
 393 void CtdlPutCurrentUserLock(void);
 394
 395 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number);
 396 void CtdlGetRelationship(visit *vbuf,
 397                         struct ctdluser *rel_user,
 398                         struct ctdlroom *rel_room);
 399 void CtdlSetRelationship(visit *newvisit,
 400                         struct ctdluser *rel_user,
 401                         struct ctdlroom *rel_room);
 402 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix);
 403
 404 int CtdlLoginExistingUser(char *authname, const char *username);
 405
 406 /*
 407  * Values which may be returned by CtdlLoginExistingUser()
 408  */
 409 enum {
 410         pass_ok,
 411         pass_already_logged_in,
 412         pass_no_user,
 413         pass_internal_error,
 414         pass_wrong_password
 415 };
 416
 417 int CtdlTryPassword(const char *password, long len);
 418 /*
 419  * Values which may be returned by CtdlTryPassword()
 420  */
 421 enum {
 422         login_ok,
 423         login_already_logged_in,
 424         login_too_many_users,
 425         login_not_found
 426 };
 427
 428 void CtdlUserLogout(void);
 429
 430
 431
 432
 433 /*
 434  * Expose API calls from msgbase.c
 435  */
 436
 437
 438
 439 /*
 440  * Expose API calls from euidindex.c
 441  */
 442 long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf);
 443
 444
 445
 446 #endif /* CTDL_MODULE_H */