2 * This module handles shared rooms, inter-Citadel mail, and outbound
3 * mailing list processing.
5 * Copyright (c) 2000-2016 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.
24 * Duration of time (in seconds) after which pending list subscribe/unsubscribe
25 * requests that have not been confirmed will be deleted.
27 #define EXP 259200 /* three days */
39 #include <sys/types.h>
41 #if TIME_WITH_SYS_TIME
42 # include <sys/time.h>
46 # include <sys/time.h>
54 # if HAVE_SYS_SYSCALL_H
55 # include <sys/syscall.h>
62 #include <libcitadel.h>
65 #include "citserver.h"
71 #include "internet_addressing.h"
72 #include "serv_network.h"
73 #include "clientsocket.h"
74 #include "citadel_dirs.h"
77 #include "ctdl_module.h"
81 int NetQDebugEnabled = 0;
82 struct CitContext networker_spool_CC;
84 /* comes from lookup3.c from libcitadel... */
85 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
87 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;
101 * Send the *entire* contents of the current room to one specific network node,
102 * ignoring anything we know about which messages have already undergone
103 * network processing. This can be used to bring a new node into sync.
105 int network_sync_to(char *target_node, long len)
107 struct CitContext *CCC = CC;
108 OneRoomNetCfg OneRNCFG;
109 OneRoomNetCfg *pRNCFG;
110 const RoomNetCfgLine *pCfgLine;
114 /* Load the netconfig for this room */
115 pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
116 if (pRNCFG == NULL) { // no netconfig at all?
119 if (pRNCFG->NetConfigs[ignet_push_share] == NULL) // no ignet push shares?
121 FreeRoomNetworkStruct(&pRNCFG);
125 /* Search for an ignet_oush_share configuration bearing the target node's name */
126 for (pCfgLine = pRNCFG->NetConfigs[ignet_push_share]; pCfgLine != NULL; pCfgLine = pCfgLine->next)
128 if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
132 /* If we aren't sharing with that node, bail out */
133 if (pCfgLine == NULL)
135 FreeRoomNetworkStruct(&pRNCFG);
139 /* If we got here, we're good to go ... make up a dummy spoolconfig and roll with it */
141 begin_critical_section(S_NETCONFIGS);
142 memset(&sc, 0, sizeof(SpoolControl));
143 memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
144 sc.RNCfg = &OneRNCFG;
145 sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
146 sc.Users[ignet_push_share] = NewStrBufPlain(NULL, (StrLength(pCfgLine->Value[0]) + StrLength(pCfgLine->Value[1]) + 10) );
147 StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[0], 0);
148 StrBufAppendBufPlain(sc.Users[ignet_push_share], HKEY(","), 0);
149 StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[1], 0);
151 end_critical_section(S_NETCONFIGS);
153 sc.working_ignetcfg = CtdlLoadIgNetCfg();
154 sc.the_netmap = CtdlReadNetworkMap();
156 /* Send ALL messages */
157 num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, network_spool_msg, &sc);
159 /* Concise cleanup because we know there's only one node in the sc */
160 DeleteGenericCfgLine(NULL, &sc.RNCfg->NetConfigs[ignet_push_share]);
162 DeleteHash(&sc.working_ignetcfg);
163 DeleteHash(&sc.the_netmap);
164 free_spoolcontrol_struct_members(&sc);
166 QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>", num_spooled, target_node);
172 * Implements the NSYN command
174 void cmd_nsyn(char *argbuf) {
177 char target_node[256];
179 if (CtdlAccessCheck(ac_aide)) return;
181 len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
182 num_spooled = network_sync_to(target_node, len);
183 if (num_spooled >= 0) {
184 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
187 cprintf("%d No such room/node share exists.\n", ERROR + ROOM_NOT_FOUND);
191 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
194 struct RoomProcList *ptr;
196 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
201 ptr->namelen = strlen(qrbuf->QRname);
202 if (ptr->namelen > ROOMNAMELEN) {
203 ptr->namelen = ROOMNAMELEN - 1;
206 memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
207 ptr->name[ptr->namelen] = '\0';
208 ptr->QRNum = qrbuf->QRnumber;
210 for (i = 0; i < ptr->namelen; i++)
212 ptr->lcname[i] = tolower(ptr->name[i]);
215 ptr->lcname[ptr->namelen] = '\0';
216 ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
221 * Batch up and send all outbound traffic from the current room
223 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
225 struct RoomProcList *ptr;
226 roomlists *RP = (roomlists*) data;
228 if (!HaveSpoolConfig(OneRNCfg)) {
232 ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
236 ptr->next = RP->rplist;
242 * Batch up and send all outbound traffic from the current room
244 int network_room_handler(struct ctdlroom *qrbuf)
246 struct RoomProcList *ptr;
247 OneRoomNetCfg *RNCfg;
249 if (qrbuf->QRdefaultview == VIEW_QUEUE) {
253 RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
258 if (!HaveSpoolConfig(RNCfg)) {
259 FreeRoomNetworkStruct(&RNCfg);
263 ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
265 FreeRoomNetworkStruct(&RNCfg);
269 begin_critical_section(S_RPLIST);
272 end_critical_section(S_RPLIST);
273 FreeRoomNetworkStruct(&RNCfg);
277 void destroy_network_queue_room(RoomProcList *rplist)
279 struct RoomProcList *cur, *p;
290 void destroy_network_queue_room_locked (void)
292 begin_critical_section(S_RPLIST);
293 destroy_network_queue_room(rplist);
294 end_critical_section(S_RPLIST);
301 * Run through the rooms doing various types of network stuff.
303 void network_do_queue(void)
305 struct CitContext *CCC = CC;
306 static time_t last_run = 0L;
307 int full_processing = 1;
308 HashList *working_ignetcfg;
309 HashList *the_netmap = NULL;
310 int netmap_changed = 0;
312 SpoolControl *sc = NULL;
316 * Run the full set of processing tasks no more frequently
317 * than once every n seconds
319 if ( (time(NULL) - last_run) < CtdlGetConfigLong("c_net_freq") )
322 MARK_syslog(LOG_DEBUG, "Network full processing in %ld seconds.",
323 CtdlGetConfigLong("c_net_freq") - (time(NULL)- last_run)
327 become_session(&networker_spool_CC);
328 begin_critical_section(S_RPLIST);
331 end_critical_section(S_RPLIST);
333 // TODO hm, check whether we have a config at all here?
334 /* Load the IGnet Configuration into memory */
335 working_ignetcfg = CtdlLoadIgNetCfg();
338 * Load the network map and filter list into memory.
340 if (!server_shutting_down) {
341 the_netmap = CtdlReadNetworkMap();
345 * Go ahead and run the queue
347 if (full_processing && !server_shutting_down) {
348 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
349 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL);
352 if ((RL.rplist != NULL) && (!server_shutting_down)) {
353 RoomProcList *ptr, *cmp;
355 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
356 while (ptr != NULL && !server_shutting_down) {
359 /* filter duplicates from the list... */
360 while (cmp != NULL) {
361 if ((cmp->namelen > 0) &&
362 (cmp->key == ptr->key) &&
363 (cmp->namelen == ptr->namelen) &&
364 (strcmp(cmp->lcname, ptr->lcname) == 0))
371 if (ptr->namelen > 0) {
372 InspectQueuedRoom(&sc, ptr, working_ignetcfg, the_netmap);
382 network_spoolout_room(pSC);
390 free_spoolcontrol_struct(&pSC);
393 /* If there is anything in the inbound queue, process it */
394 if (!server_shutting_down) {
395 network_do_spoolin(working_ignetcfg,
400 /* Free the filter list in memory */
401 free_netfilter_list();
403 /* Save the network map back to disk */
404 if (netmap_changed) {
405 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
406 char *pMapStr = SmashStrBuf(&MapStr);
407 CtdlPutSysConfig(IGNETMAP, pMapStr);
411 /* combine single message files into one spool entry per remote node. */
412 network_consolidate_spoolout(working_ignetcfg, the_netmap);
416 DeleteHash(&the_netmap);
418 DeleteHash(&working_ignetcfg);
420 QNM_syslog(LOG_DEBUG, "network: queue run completed");
422 if (full_processing) {
423 last_run = time(NULL);
425 destroy_network_queue_room(RL.rplist);
429 void network_logout_hook(void)
431 CitContext *CCC = MyContext();
434 * If we were talking to a network node, we're not anymore...
436 if (!IsEmptyStr(CCC->net_node)) {
437 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
438 CCC->net_node[0] = '\0';
443 void network_cleanup_function(void)
445 struct CitContext *CCC = CC;
447 if (!IsEmptyStr(CCC->net_node)) {
448 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
449 CCC->net_node[0] = '\0';
454 int ignet_aftersave(struct CtdlMessage *msg, recptypes *recps)
456 /* For IGnet mail, we have to save a new copy into the spooler for
457 * each recipient, with the R and D fields set to the recipient and
458 * destination-node. This has two ugly side effects: all other
459 * recipients end up being unlisted in this recipient's copy of the
460 * message, and it has to deliver multiple messages to the same
461 * node. We'll revisit this again in a year or so when everyone has
462 * a network spool receiver that can handle the new style messages.
464 if ((recps != NULL) && (recps->num_ignet > 0))
469 FILE *network_fp = NULL;
470 char submit_filename[128];
471 static int seqnum = 1;
473 char *hold_R, *hold_D, *RBuf, *DBuf;
474 long hrlen, hdlen, rblen, dblen, count, rlen;
475 CitContext *CCC = MyContext();
477 CM_GetAsField(msg, eRecipient, &hold_R, &hrlen);;
478 CM_GetAsField(msg, eDestination, &hold_D, &hdlen);;
480 count = num_tokens(recps->recp_ignet, '|');
481 rlen = strlen(recps->recp_ignet);
482 recipient = malloc(rlen + 1);
483 RBuf = malloc(rlen + 1);
484 DBuf = malloc(rlen + 1);
485 for (i=0; i<count; ++i) {
486 extract_token(recipient, recps->recp_ignet, i, '|', rlen + 1);
488 rblen = extract_token(RBuf, recipient, 0, '@', rlen + 1);
489 dblen = extract_token(DBuf, recipient, 1, '@', rlen + 1);
491 CM_SetAsField(msg, eRecipient, &RBuf, rblen);;
492 CM_SetAsField(msg, eDestination, &DBuf, dblen);;
493 CtdlSerializeMessage(&smr, msg);
495 snprintf(submit_filename, sizeof submit_filename,
496 "%s/netmail.%04lx.%04x.%04x",
502 network_fp = fopen(submit_filename, "wb+");
503 if (network_fp != NULL) {
504 rv = fwrite(smr.ser, smr.len, 1, network_fp);
506 MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s",
513 CM_GetAsField(msg, eRecipient, &RBuf, &rblen);;
514 CM_GetAsField(msg, eDestination, &DBuf, &dblen);;
519 CM_SetAsField(msg, eRecipient, &hold_R, hrlen);
520 CM_SetAsField(msg, eDestination, &hold_D, hdlen);
531 void SetNetQDebugEnabled(const int n)
533 NetQDebugEnabled = n;
537 CTDL_MODULE_INIT(network)
541 CtdlRegisterMessageHook(ignet_aftersave, EVT_AFTERSAVE);
543 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
544 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
545 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
546 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
547 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
548 CtdlRegisterRoomHook(network_room_handler);
549 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
550 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);