2 * This module handles shared rooms, inter-Citadel mail, and outbound
3 * mailing list processing.
5 * Copyright (c) 2000-2012 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * ** NOTE ** A word on the S_NETCONFIGS semaphore:
16 * This is a fairly high-level type of critical section. It ensures that no
17 * two threads work on the netconfigs files at the same time. Since we do
18 * so many things inside these, here are the rules:
19 * 1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
20 * 2. Do *not* perform any I/O with the client during these sections.
25 * Duration of time (in seconds) after which pending list subscribe/unsubscribe
26 * requests that have not been confirmed will be deleted.
28 #define EXP 259200 /* three days */
40 #include <sys/types.h>
42 #if TIME_WITH_SYS_TIME
43 # include <sys/time.h>
47 # include <sys/time.h>
55 # if HAVE_SYS_SYSCALL_H
56 # include <sys/syscall.h>
63 #include <libcitadel.h>
66 #include "citserver.h"
72 #include "internet_addressing.h"
73 #include "serv_network.h"
74 #include "clientsocket.h"
76 #include "citadel_dirs.h"
79 #include "ctdl_module.h"
83 int NetQDebugEnabled = 0;
84 struct CitContext networker_spool_CC;
86 /* comes from lookup3.c from libcitadel... */
87 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
89 typedef struct __roomlists {
93 * When we do network processing, it's accomplished in two passes; one to
94 * gather a list of rooms and one to actually do them. It's ok that rplist
95 * is global; we have a mutex that keeps it safe.
97 struct RoomProcList *rplist = NULL;
102 * Check the use table. This is a list of messages which have recently
103 * arrived on the system. It is maintained and queried to prevent the same
104 * message from being entered into the database multiple times if it happens
105 * to arrive multiple times by accident.
107 int network_usetable(struct CtdlMessage *msg)
110 struct CitContext *CCC = CC;
113 /* Bail out if we can't generate a message ID */
117 if (msg->cm_fields['I'] == NULL) {
120 if (IsEmptyStr(msg->cm_fields['I'])) {
124 /* Generate the message ID */
125 msgid = NewStrBufPlain(msg->cm_fields['I'], -1);
126 if (haschar(ChrPtr(msgid), '@') == 0) {
127 StrBufAppendBufPlain(msgid, HKEY("@"), 0);
128 if (msg->cm_fields['N'] != NULL) {
129 StrBufAppendBufPlain(msgid, msg->cm_fields['N'], -1, 0);
137 if (CheckIfAlreadySeen("Networker Import",
141 CCC->cs_pid, 0) != 0)
154 * Send the *entire* contents of the current room to one specific network node,
155 * ignoring anything we know about which messages have already undergone
156 * network processing. This can be used to bring a new node into sync.
158 int network_sync_to(char *target_node, long len)
160 struct CitContext *CCC = CC;
161 OneRoomNetCfg OneRNCFG;
162 OneRoomNetCfg *pRNCFG;
163 const RoomNetCfgLine *pCfgLine;
167 /* Grab the configuration line we're looking for */
168 begin_critical_section(S_NETCONFIGS);
169 pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
170 if ((pRNCFG == NULL) ||
171 (pRNCFG->NetConfigs[ignet_push_share] == NULL))
176 pCfgLine = pRNCFG->NetConfigs[ignet_push_share];
177 while (pCfgLine != NULL)
179 if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
181 pCfgLine = pCfgLine->next;
183 if (pCfgLine == NULL)
188 memset(&sc, 0, sizeof(SpoolControl));
189 memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
190 sc.RNCfg = &OneRNCFG;
191 sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
192 sc.Users[ignet_push_share] = NewStrBufPlain(NULL,
193 StrLength(pCfgLine->Value[0]) +
194 StrLength(pCfgLine->Value[1]) + 10);
195 StrBufAppendBuf(sc.Users[ignet_push_share],
198 StrBufAppendBufPlain(sc.Users[ignet_push_share],
202 StrBufAppendBuf(sc.Users[ignet_push_share],
207 end_critical_section(S_NETCONFIGS);
209 sc.working_ignetcfg = CtdlLoadIgNetCfg();
210 sc.the_netmap = CtdlReadNetworkMap();
212 /* Send ALL messages */
213 num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
214 network_spool_msg, &sc);
216 /* Concise cleanup because we know there's only one node in the sc */
217 DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
219 DeleteHash(&sc.working_ignetcfg);
220 DeleteHash(&sc.the_netmap);
221 free_spoolcontrol_struct_members(&sc);
223 QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
224 num_spooled, target_node);
230 * Implements the NSYN command
232 void cmd_nsyn(char *argbuf) {
235 char target_node[256];
237 if (CtdlAccessCheck(ac_aide)) return;
239 len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
240 num_spooled = network_sync_to(target_node, len);
241 if (num_spooled >= 0) {
242 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
245 cprintf("%d No such room/node share exists.\n",
246 ERROR + ROOM_NOT_FOUND);
250 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
253 struct RoomProcList *ptr;
255 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
256 if (ptr == NULL) return NULL;
258 ptr->namelen = strlen(qrbuf->QRname);
259 if (ptr->namelen > ROOMNAMELEN)
260 ptr->namelen = ROOMNAMELEN - 1;
262 memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
263 ptr->name[ptr->namelen] = '\0';
264 ptr->QRNum = qrbuf->QRnumber;
266 for (i = 0; i < ptr->namelen; i++)
268 ptr->lcname[i] = tolower(ptr->name[i]);
271 ptr->lcname[ptr->namelen] = '\0';
272 ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
273 ptr->lastsent = OneRNCFG->lastsent;
274 ptr->OneRNCfg = OneRNCFG;
279 * Batch up and send all outbound traffic from the current room
281 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
283 struct RoomProcList *ptr;
284 roomlists *RP = (roomlists*) data;
286 if (!HaveSpoolConfig(OneRNCfg))
289 ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
293 ptr->next = RP->rplist;
299 * Batch up and send all outbound traffic from the current room
301 int network_room_handler (struct ctdlroom *qrbuf)
303 struct RoomProcList *ptr;
304 OneRoomNetCfg* RNCfg;
306 if (qrbuf->QRdefaultview == VIEW_QUEUE)
309 RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
313 if (!HaveSpoolConfig(RNCfg))
316 ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
320 ptr->OneRNCfg = NULL;
321 begin_critical_section(S_RPLIST);
324 end_critical_section(S_RPLIST);
328 void destroy_network_queue_room(RoomProcList *rplist)
330 struct RoomProcList *cur, *p;
341 void destroy_network_queue_room_locked (void)
343 begin_critical_section(S_RPLIST);
344 destroy_network_queue_room(rplist);
345 end_critical_section(S_RPLIST);
351 * Bounce a message back to the sender
353 void network_bounce(struct CtdlMessage *msg, char *reason)
355 struct CitContext *CCC = CC;
356 char *oldpath = NULL;
358 char bouncesource[SIZ];
360 struct recptypes *valid = NULL;
361 char force_room[ROOMNAMELEN];
362 static int serialnum = 0;
365 QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
367 if (msg == NULL) return;
369 snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
372 * Give it a fresh message ID
374 if (msg->cm_fields['I'] != NULL) {
375 free(msg->cm_fields['I']);
377 snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
378 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
379 msg->cm_fields['I'] = strdup(buf);
382 * FIXME ... right now we're just sending a bounce; we really want to
383 * include the text of the bounced message.
385 if (msg->cm_fields['M'] != NULL) {
386 free(msg->cm_fields['M']);
388 msg->cm_fields['M'] = strdup(reason);
389 msg->cm_format_type = 0;
392 * Turn the message around
394 if (msg->cm_fields['R'] == NULL) {
395 free(msg->cm_fields['R']);
398 if (msg->cm_fields['D'] == NULL) {
399 free(msg->cm_fields['D']);
402 snprintf(recipient, sizeof recipient, "%s@%s",
403 msg->cm_fields['A'], msg->cm_fields['N']);
405 if (msg->cm_fields['A'] == NULL) {
406 free(msg->cm_fields['A']);
409 if (msg->cm_fields['N'] == NULL) {
410 free(msg->cm_fields['N']);
413 if (msg->cm_fields['U'] == NULL) {
414 free(msg->cm_fields['U']);
417 msg->cm_fields['A'] = strdup(BOUNCESOURCE);
418 msg->cm_fields['N'] = strdup(config.c_nodename);
419 msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
421 /* prepend our node to the path */
422 if (msg->cm_fields['P'] != NULL) {
423 oldpath = msg->cm_fields['P'];
424 msg->cm_fields['P'] = NULL;
427 oldpath = strdup("unknown_user");
429 size = strlen(oldpath) + SIZ;
430 msg->cm_fields['P'] = malloc(size);
431 snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
434 /* Now submit the message */
435 valid = validate_recipients(recipient, NULL, 0);
436 if (valid != NULL) if (valid->num_error != 0) {
437 free_recipients(valid);
440 if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
441 strcpy(force_room, config.c_aideroom);
444 strcpy(force_room, "");
446 if ( (valid == NULL) && IsEmptyStr(force_room) ) {
447 strcpy(force_room, config.c_aideroom);
449 CtdlSubmitMsg(msg, valid, force_room, 0);
452 if (valid != NULL) free_recipients(valid);
453 CtdlFreeMessage(msg);
454 QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
462 * Run through the rooms doing various types of network stuff.
464 void network_do_queue(void)
466 struct CitContext *CCC = CC;
467 static time_t last_run = 0L;
468 int full_processing = 1;
469 HashList *working_ignetcfg;
470 HashList *the_netmap = NULL;
471 int netmap_changed = 0;
473 SpoolControl *sc = NULL;
477 * Run the full set of processing tasks no more frequently
478 * than once every n seconds
480 if ( (time(NULL) - last_run) < config.c_net_freq ) {
482 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
483 config.c_net_freq - (time(NULL)- last_run)
487 become_session(&networker_spool_CC);
488 begin_critical_section(S_RPLIST);
491 end_critical_section(S_RPLIST);
492 ///TODO hm, check whether we have a config at all here?
493 /* Load the IGnet Configuration into memory */
494 working_ignetcfg = CtdlLoadIgNetCfg();
497 * Load the network map and filter list into memory.
499 if (!server_shutting_down)
500 the_netmap = CtdlReadNetworkMap();
502 /* filterlist isn't supported anymore
503 if (!server_shutting_down)
504 load_network_filter_list();
509 * Go ahead and run the queue
511 if (full_processing && !server_shutting_down) {
512 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
513 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL, maxRoomNetCfg);
516 if ((RL.rplist != NULL) && (!server_shutting_down)) {
517 RoomProcList *ptr, *cmp;
519 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
520 while (ptr != NULL && !server_shutting_down) {
523 /* filter duplicates from the list... */
524 while (cmp != NULL) {
525 if ((cmp->namelen > 0) &&
526 (cmp->key == ptr->key) &&
527 (cmp->namelen == ptr->namelen) &&
528 (strcmp(cmp->lcname, ptr->lcname) == 0))
535 if (ptr->namelen > 0) {
536 InspectQueuedRoom(&sc,
549 network_spoolout_room(pSC);
557 free_spoolcontrol_struct(&pSC);
560 /* If there is anything in the inbound queue, process it */
561 if (!server_shutting_down) {
562 network_do_spoolin(working_ignetcfg,
567 /* Free the filter list in memory */
568 free_netfilter_list();
570 /* Save the network map back to disk */
571 if (netmap_changed) {
572 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
573 char *pMapStr = SmashStrBuf(&MapStr);
574 CtdlPutSysConfig(IGNETMAP, pMapStr);
578 /* combine singe message files into one spool entry per remote node. */
579 network_consolidate_spoolout(working_ignetcfg, the_netmap);
583 DeleteHash(&the_netmap);
585 DeleteHash(&working_ignetcfg);
587 QNM_syslog(LOG_DEBUG, "network: queue run completed");
589 if (full_processing) {
590 last_run = time(NULL);
592 destroy_network_queue_room(RL.rplist);
593 SaveChangedConfigs();
604 void network_logout_hook(void)
606 CitContext *CCC = MyContext();
609 * If we were talking to a network node, we're not anymore...
611 if (!IsEmptyStr(CCC->net_node)) {
612 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
613 CCC->net_node[0] = '\0';
616 void network_cleanup_function(void)
618 struct CitContext *CCC = CC;
620 if (!IsEmptyStr(CCC->net_node)) {
621 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
622 CCC->net_node[0] = '\0';
631 void SetNetQDebugEnabled(const int n)
633 NetQDebugEnabled = n;
636 CTDL_MODULE_INIT(network)
640 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
641 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
642 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
643 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
644 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
645 CtdlRegisterRoomHook(network_room_handler);
646 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
647 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);