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"
75 #include "citadel_dirs.h"
78 #include "ctdl_module.h"
82 int NetQDebugEnabled = 0;
83 struct CitContext networker_spool_CC;
85 /* comes from lookup3.c from libcitadel... */
86 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
88 typedef struct __roomlists {
92 * When we do network processing, it's accomplished in two passes; one to
93 * gather a list of rooms and one to actually do them. It's ok that rplist
94 * is global; we have a mutex that keeps it safe.
96 struct RoomProcList *rplist = NULL;
100 * Send the *entire* contents of the current room to one specific network node,
101 * ignoring anything we know about which messages have already undergone
102 * network processing. This can be used to bring a new node into sync.
104 int network_sync_to(char *target_node, long len)
106 struct CitContext *CCC = CC;
107 OneRoomNetCfg OneRNCFG;
108 OneRoomNetCfg *pRNCFG;
109 const RoomNetCfgLine *pCfgLine;
113 /* Grab the configuration line we're looking for */
114 begin_critical_section(S_NETCONFIGS);
115 pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
116 if ((pRNCFG == NULL) ||
117 (pRNCFG->NetConfigs[ignet_push_share] == NULL))
122 pCfgLine = pRNCFG->NetConfigs[ignet_push_share];
123 while (pCfgLine != NULL)
125 if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
127 pCfgLine = pCfgLine->next;
129 if (pCfgLine == NULL)
134 memset(&sc, 0, sizeof(SpoolControl));
135 memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
136 sc.RNCfg = &OneRNCFG;
137 sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
138 sc.Users[ignet_push_share] = NewStrBufPlain(NULL,
139 StrLength(pCfgLine->Value[0]) +
140 StrLength(pCfgLine->Value[1]) + 10);
141 StrBufAppendBuf(sc.Users[ignet_push_share],
144 StrBufAppendBufPlain(sc.Users[ignet_push_share],
148 StrBufAppendBuf(sc.Users[ignet_push_share],
153 end_critical_section(S_NETCONFIGS);
155 sc.working_ignetcfg = CtdlLoadIgNetCfg();
156 sc.the_netmap = CtdlReadNetworkMap();
158 /* Send ALL messages */
159 num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
160 network_spool_msg, &sc);
162 /* Concise cleanup because we know there's only one node in the sc */
163 DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
165 DeleteHash(&sc.working_ignetcfg);
166 DeleteHash(&sc.the_netmap);
167 free_spoolcontrol_struct_members(&sc);
169 QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
170 num_spooled, target_node);
176 * Implements the NSYN command
178 void cmd_nsyn(char *argbuf) {
181 char target_node[256];
183 if (CtdlAccessCheck(ac_aide)) return;
185 len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
186 num_spooled = network_sync_to(target_node, len);
187 if (num_spooled >= 0) {
188 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
191 cprintf("%d No such room/node share exists.\n",
192 ERROR + ROOM_NOT_FOUND);
196 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
199 struct RoomProcList *ptr;
201 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
202 if (ptr == NULL) return NULL;
204 ptr->namelen = strlen(qrbuf->QRname);
205 if (ptr->namelen > ROOMNAMELEN)
206 ptr->namelen = ROOMNAMELEN - 1;
208 memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
209 ptr->name[ptr->namelen] = '\0';
210 ptr->QRNum = qrbuf->QRnumber;
212 for (i = 0; i < ptr->namelen; i++)
214 ptr->lcname[i] = tolower(ptr->name[i]);
217 ptr->lcname[ptr->namelen] = '\0';
218 ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
219 ptr->lastsent = OneRNCFG->lastsent;
220 ptr->OneRNCfg = OneRNCFG;
225 * Batch up and send all outbound traffic from the current room
227 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
229 struct RoomProcList *ptr;
230 roomlists *RP = (roomlists*) data;
232 if (!HaveSpoolConfig(OneRNCfg))
235 ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
239 ptr->next = RP->rplist;
245 * Batch up and send all outbound traffic from the current room
247 int network_room_handler (struct ctdlroom *qrbuf)
249 struct RoomProcList *ptr;
250 OneRoomNetCfg* RNCfg;
252 if (qrbuf->QRdefaultview == VIEW_QUEUE)
255 RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
259 if (!HaveSpoolConfig(RNCfg))
262 ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
266 ptr->OneRNCfg = NULL;
267 begin_critical_section(S_RPLIST);
270 end_critical_section(S_RPLIST);
274 void destroy_network_queue_room(RoomProcList *rplist)
276 struct RoomProcList *cur, *p;
287 void destroy_network_queue_room_locked (void)
289 begin_critical_section(S_RPLIST);
290 destroy_network_queue_room(rplist);
291 end_critical_section(S_RPLIST);
298 * Run through the rooms doing various types of network stuff.
300 void network_do_queue(void)
302 struct CitContext *CCC = CC;
303 static time_t last_run = 0L;
304 int full_processing = 1;
305 HashList *working_ignetcfg;
306 HashList *the_netmap = NULL;
307 int netmap_changed = 0;
309 SpoolControl *sc = NULL;
313 * Run the full set of processing tasks no more frequently
314 * than once every n seconds
316 if ( (time(NULL) - last_run) < config.c_net_freq ) {
318 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
319 config.c_net_freq - (time(NULL)- last_run)
323 become_session(&networker_spool_CC);
324 begin_critical_section(S_RPLIST);
327 end_critical_section(S_RPLIST);
328 ///TODO hm, check whether we have a config at all here?
329 /* Load the IGnet Configuration into memory */
330 working_ignetcfg = CtdlLoadIgNetCfg();
333 * Load the network map and filter list into memory.
335 if (!server_shutting_down)
336 the_netmap = CtdlReadNetworkMap();
338 /* filterlist isn't supported anymore
339 if (!server_shutting_down)
340 load_network_filter_list();
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, maxRoomNetCfg);
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,
385 network_spoolout_room(pSC);
393 free_spoolcontrol_struct(&pSC);
396 /* If there is anything in the inbound queue, process it */
397 if (!server_shutting_down) {
398 network_do_spoolin(working_ignetcfg,
403 /* Free the filter list in memory */
404 free_netfilter_list();
406 /* Save the network map back to disk */
407 if (netmap_changed) {
408 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
409 char *pMapStr = SmashStrBuf(&MapStr);
410 CtdlPutSysConfig(IGNETMAP, pMapStr);
414 /* combine singe message files into one spool entry per remote node. */
415 network_consolidate_spoolout(working_ignetcfg, the_netmap);
419 DeleteHash(&the_netmap);
421 DeleteHash(&working_ignetcfg);
423 QNM_syslog(LOG_DEBUG, "network: queue run completed");
425 if (full_processing) {
426 last_run = time(NULL);
428 destroy_network_queue_room(RL.rplist);
429 SaveChangedConfigs();
440 void network_logout_hook(void)
442 CitContext *CCC = MyContext();
445 * If we were talking to a network node, we're not anymore...
447 if (!IsEmptyStr(CCC->net_node)) {
448 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
449 CCC->net_node[0] = '\0';
452 void network_cleanup_function(void)
454 struct CitContext *CCC = CC;
456 if (!IsEmptyStr(CCC->net_node)) {
457 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
458 CCC->net_node[0] = '\0';
463 int ignet_aftersave(struct CtdlMessage *msg,
464 recptypes *recps) /* recipients (if mail) */
466 /* For IGnet mail, we have to save a new copy into the spooler for
467 * each recipient, with the R and D fields set to the recipient and
468 * destination-node. This has two ugly side effects: all other
469 * recipients end up being unlisted in this recipient's copy of the
470 * message, and it has to deliver multiple messages to the same
471 * node. We'll revisit this again in a year or so when everyone has
472 * a network spool receiver that can handle the new style messages.
474 if ((recps != NULL) && (recps->num_ignet > 0))
479 FILE *network_fp = NULL;
480 char submit_filename[128];
481 static int seqnum = 1;
483 char *hold_R, *hold_D, *RBuf, *DBuf;
484 long hrlen, hdlen, rblen, dblen, count, rlen;
485 CitContext *CCC = MyContext();
487 CM_GetAsField(msg, eRecipient, &hold_R, &hrlen);;
488 CM_GetAsField(msg, eDestination, &hold_D, &hdlen);;
490 count = num_tokens(recps->recp_ignet, '|');
491 rlen = strlen(recps->recp_ignet);
492 recipient = malloc(rlen + 1);
493 RBuf = malloc(rlen + 1);
494 DBuf = malloc(rlen + 1);
495 for (i=0; i<count; ++i) {
496 extract_token(recipient, recps->recp_ignet, i,
499 rblen = extract_token(RBuf, recipient, 0, '@', rlen + 1);
500 dblen = extract_token(DBuf, recipient, 1, '@', rlen + 1);
502 CM_SetAsField(msg, eRecipient, &RBuf, rblen);;
503 CM_SetAsField(msg, eDestination, &DBuf, dblen);;
504 CtdlSerializeMessage(&smr, msg);
506 snprintf(submit_filename, sizeof submit_filename,
507 "%s/netmail.%04lx.%04x.%04x",
513 network_fp = fopen(submit_filename, "wb+");
514 if (network_fp != NULL) {
515 rv = fwrite(smr.ser, smr.len, 1, network_fp);
517 MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s\n",
524 CM_GetAsField(msg, eRecipient, &RBuf, &rblen);;
525 CM_GetAsField(msg, eDestination, &DBuf, &dblen);;
530 CM_SetAsField(msg, eRecipient, &hold_R, hrlen);
531 CM_SetAsField(msg, eDestination, &hold_D, hdlen);
541 void SetNetQDebugEnabled(const int n)
543 NetQDebugEnabled = n;
546 CTDL_MODULE_INIT(network)
550 CtdlRegisterMessageHook(ignet_aftersave, EVT_AFTERSAVE);
552 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
553 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
554 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
555 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
556 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
557 CtdlRegisterRoomHook(network_room_handler);
558 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
559 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);