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 as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * ** NOTE ** A word on the S_NETCONFIGS semaphore:
22 * This is a fairly high-level type of critical section. It ensures that no
23 * two threads work on the netconfigs files at the same time. Since we do
24 * so many things inside these, here are the rules:
25 * 1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
26 * 2. Do *not* perform any I/O with the client during these sections.
31 * Duration of time (in seconds) after which pending list subscribe/unsubscribe
32 * requests that have not been confirmed will be deleted.
34 #define EXP 259200 /* three days */
46 #include <sys/types.h>
48 #if TIME_WITH_SYS_TIME
49 # include <sys/time.h>
53 # include <sys/time.h>
61 # if HAVE_SYS_SYSCALL_H
62 # include <sys/syscall.h>
69 #include <libcitadel.h>
72 #include "citserver.h"
78 #include "internet_addressing.h"
79 #include "serv_network.h"
80 #include "clientsocket.h"
82 #include "citadel_dirs.h"
90 #include "netconfig.h"
93 #include "ctdl_module.h"
95 int NetQDebugEnabled = 0;
96 struct CitContext networker_spool_CC;
98 /* comes from lookup3.c from libcitadel... */
99 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
101 typedef struct __roomlists {
102 RoomProcList *rplist;
103 HashList *RoomsInterestedIn;
106 * When we do network processing, it's accomplished in two passes; one to
107 * gather a list of rooms and one to actually do them. It's ok that rplist
108 * is global; we have a mutex that keeps it safe.
110 struct RoomProcList *rplist = NULL;
112 int GetNetworkedRoomNumbers(const char *DirName, HashList *DirList)
116 struct dirent *filedir_entry;
120 filedir = opendir (DirName);
121 if (filedir == NULL) {
125 d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
130 while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
131 (filedir_entry != NULL))
133 RoomNR = atol(filedir_entry->d_name);
136 Put(DirList, LKEY(RoomNR), &Count, reference_free_handler);
148 * Check the use table. This is a list of messages which have recently
149 * arrived on the system. It is maintained and queried to prevent the same
150 * message from being entered into the database multiple times if it happens
151 * to arrive multiple times by accident.
153 int network_usetable(struct CtdlMessage *msg)
155 struct CitContext *CCC = CC;
157 struct cdbdata *cdbut;
160 /* Bail out if we can't generate a message ID */
164 if (msg->cm_fields['I'] == NULL) {
167 if (IsEmptyStr(msg->cm_fields['I'])) {
171 /* Generate the message ID */
172 strcpy(msgid, msg->cm_fields['I']);
173 if (haschar(msgid, '@') == 0) {
175 if (msg->cm_fields['N'] != NULL) {
176 strcat(msgid, msg->cm_fields['N']);
183 cdbut = cdb_fetch(CDB_USETABLE, msgid, strlen(msgid));
186 QN_syslog(LOG_DEBUG, "network_usetable() : we already have %s\n", msgid);
190 /* If we got to this point, it's unique: add it. */
191 strcpy(ut.ut_msgid, msgid);
192 ut.ut_timestamp = time(NULL);
193 cdb_store(CDB_USETABLE, msgid, strlen(msgid), &ut, sizeof(struct UseTable) );
207 * Send the *entire* contents of the current room to one specific network node,
208 * ignoring anything we know about which messages have already undergone
209 * network processing. This can be used to bring a new node into sync.
211 int network_sync_to(char *target_node, long len)
213 struct CitContext *CCC = CC;
221 char filename[PATH_MAX];
224 /* Grab the configuration line we're looking for */
225 assoc_file_name(filename, sizeof filename, &CC->room, ctdl_netcfg_dir);
226 begin_critical_section(S_NETCONFIGS);
227 fp = fopen(filename, "r");
229 end_critical_section(S_NETCONFIGS);
232 while (fgets(buf, sizeof buf, fp) != NULL)
234 buf[strlen(buf)-1] = 0;
236 extract_token(sc_type, buf, 0, '|', sizeof sc_type);
237 if (strcasecmp(sc_type, "ignet_push_share"))
240 extract_token(sc_node, buf, 1, '|', sizeof sc_node);
241 if (strcasecmp(sc_node, target_node))
244 extract_token(sc_room, buf, 2, '|', sizeof sc_room);
247 /* Concise syntax because we don't need a full linked-list */
248 memset(&sc, 0, sizeof(SpoolControl));
249 sc.ignet_push_shares = (maplist *)
250 malloc(sizeof(maplist));
251 sc.ignet_push_shares->next = NULL;
252 safestrncpy(sc.ignet_push_shares->remote_nodename,
254 sizeof sc.ignet_push_shares->remote_nodename);
255 safestrncpy(sc.ignet_push_shares->remote_roomname,
257 sizeof sc.ignet_push_shares->remote_roomname);
260 end_critical_section(S_NETCONFIGS);
263 free(sc.ignet_push_shares);
267 sc.working_ignetcfg = load_ignetcfg();
268 sc.the_netmap = read_network_map();
270 /* Send ALL messages */
271 num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
272 network_spool_msg, &sc);
274 /* Concise cleanup because we know there's only one node in the sc */
275 free(sc.ignet_push_shares);
277 DeleteHash(&sc.working_ignetcfg);
278 DeleteHash(&sc.the_netmap);
280 QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
281 num_spooled, target_node);
287 * Implements the NSYN command
289 void cmd_nsyn(char *argbuf) {
292 char target_node[256];
294 if (CtdlAccessCheck(ac_aide)) return;
296 len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
297 num_spooled = network_sync_to(target_node, len);
298 if (num_spooled >= 0) {
299 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
302 cprintf("%d No such room/node share exists.\n",
303 ERROR + ROOM_NOT_FOUND);
310 * Batch up and send all outbound traffic from the current room
312 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data) {
314 struct RoomProcList *ptr;
315 long QRNum = qrbuf->QRnumber;
317 roomlists *RP = (roomlists*) data;
319 if (!GetHash(RP->RoomsInterestedIn, LKEY(QRNum), &v))
322 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
323 if (ptr == NULL) return;
325 ptr->namelen = strlen(qrbuf->QRname);
326 if (ptr->namelen > ROOMNAMELEN)
327 ptr->namelen = ROOMNAMELEN - 1;
329 memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
330 ptr->name[ptr->namelen] = '\0';
331 ptr->QRNum = qrbuf->QRnumber;
333 for (i = 0; i < ptr->namelen; i++)
335 ptr->lcname[i] = tolower(ptr->name[i]);
338 ptr->lcname[ptr->namelen] = '\0';
339 ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
340 ptr->next = RP->rplist;
345 * Batch up and send all outbound traffic from the current room
347 void network_queue_room(struct ctdlroom *qrbuf, void *data) {
349 struct RoomProcList *ptr;
351 if (qrbuf->QRdefaultview == VIEW_QUEUE)
353 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
354 if (ptr == NULL) return;
356 ptr->namelen = strlen(qrbuf->QRname);
357 if (ptr->namelen > ROOMNAMELEN)
358 ptr->namelen = ROOMNAMELEN - 1;
360 memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
361 ptr->name[ptr->namelen] = '\0';
362 ptr->QRNum = qrbuf->QRnumber;
364 for (i = 0; i < ptr->namelen; i++)
366 ptr->lcname[i] = tolower(ptr->name[i]);
368 ptr->lcname[ptr->namelen] = '\0';
369 ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
371 begin_critical_section(S_RPLIST);
374 end_critical_section(S_RPLIST);
377 void destroy_network_queue_room(RoomProcList *rplist)
379 struct RoomProcList *cur, *p;
390 void destroy_network_queue_room_locked (void)
392 begin_critical_section(S_RPLIST);
393 destroy_network_queue_room(rplist);
394 end_critical_section(S_RPLIST);
400 * Bounce a message back to the sender
402 void network_bounce(struct CtdlMessage *msg, char *reason)
404 struct CitContext *CCC = CC;
405 char *oldpath = NULL;
407 char bouncesource[SIZ];
409 struct recptypes *valid = NULL;
410 char force_room[ROOMNAMELEN];
411 static int serialnum = 0;
414 QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
416 if (msg == NULL) return;
418 snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
421 * Give it a fresh message ID
423 if (msg->cm_fields['I'] != NULL) {
424 free(msg->cm_fields['I']);
426 snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
427 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
428 msg->cm_fields['I'] = strdup(buf);
431 * FIXME ... right now we're just sending a bounce; we really want to
432 * include the text of the bounced message.
434 if (msg->cm_fields['M'] != NULL) {
435 free(msg->cm_fields['M']);
437 msg->cm_fields['M'] = strdup(reason);
438 msg->cm_format_type = 0;
441 * Turn the message around
443 if (msg->cm_fields['R'] == NULL) {
444 free(msg->cm_fields['R']);
447 if (msg->cm_fields['D'] == NULL) {
448 free(msg->cm_fields['D']);
451 snprintf(recipient, sizeof recipient, "%s@%s",
452 msg->cm_fields['A'], msg->cm_fields['N']);
454 if (msg->cm_fields['A'] == NULL) {
455 free(msg->cm_fields['A']);
458 if (msg->cm_fields['N'] == NULL) {
459 free(msg->cm_fields['N']);
462 if (msg->cm_fields['U'] == NULL) {
463 free(msg->cm_fields['U']);
466 msg->cm_fields['A'] = strdup(BOUNCESOURCE);
467 msg->cm_fields['N'] = strdup(config.c_nodename);
468 msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
470 /* prepend our node to the path */
471 if (msg->cm_fields['P'] != NULL) {
472 oldpath = msg->cm_fields['P'];
473 msg->cm_fields['P'] = NULL;
476 oldpath = strdup("unknown_user");
478 size = strlen(oldpath) + SIZ;
479 msg->cm_fields['P'] = malloc(size);
480 snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
483 /* Now submit the message */
484 valid = validate_recipients(recipient, NULL, 0);
485 if (valid != NULL) if (valid->num_error != 0) {
486 free_recipients(valid);
489 if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
490 strcpy(force_room, config.c_aideroom);
493 strcpy(force_room, "");
495 if ( (valid == NULL) && IsEmptyStr(force_room) ) {
496 strcpy(force_room, config.c_aideroom);
498 CtdlSubmitMsg(msg, valid, force_room, 0);
501 if (valid != NULL) free_recipients(valid);
502 CtdlFreeMessage(msg);
503 QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
515 * Run through the rooms doing various types of network stuff.
517 void network_do_queue(void)
519 struct CitContext *CCC = CC;
520 static int doing_queue = 0;
521 static time_t last_run = 0L;
522 int full_processing = 1;
523 HashList *working_ignetcfg;
524 HashList *the_netmap = NULL;
525 int netmap_changed = 0;
529 * Run the full set of processing tasks no more frequently
530 * than once every n seconds
532 if ( (time(NULL) - last_run) < config.c_net_freq ) {
534 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
535 config.c_net_freq - (time(NULL)- last_run)
540 * This is a simple concurrency check to make sure only one queue run
541 * is done at a time. We could do this with a mutex, but since we
542 * don't really require extremely fine granularity here, we'll do it
543 * with a static variable instead.
550 become_session(&networker_spool_CC);
551 begin_critical_section(S_RPLIST);
554 end_critical_section(S_RPLIST);
556 RL.RoomsInterestedIn = NewHash(1, lFlathash);
557 if (full_processing &&
558 (GetNetworkedRoomNumbers(ctdl_netcfg_dir, RL.RoomsInterestedIn)==0))
561 DeleteHash(&RL.RoomsInterestedIn);
562 if (RL.rplist == NULL)
565 /* Load the IGnet Configuration into memory */
566 working_ignetcfg = load_ignetcfg();
569 * Load the network map and filter list into memory.
571 if (!server_shutting_down)
572 the_netmap = read_network_map();
573 if (!server_shutting_down)
574 load_network_filter_list();
577 * Go ahead and run the queue
579 if (full_processing && !server_shutting_down) {
580 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
581 CtdlForEachRoom(network_queue_interesting_rooms, &RL);
584 if ((RL.rplist != NULL) && (!server_shutting_down)) {
585 RoomProcList *ptr, *cmp;
587 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
588 while (ptr != NULL && !server_shutting_down) {
592 while (cmp != NULL) {
593 if ((cmp->namelen > 0) &&
594 (cmp->key == ptr->key) &&
595 (cmp->namelen == ptr->namelen) &&
596 (strcmp(cmp->lcname, ptr->lcname) == 0))
603 if (ptr->namelen > 0) {
604 network_spoolout_room(ptr,
612 /* If there is anything in the inbound queue, process it */
613 if (!server_shutting_down) {
614 network_do_spoolin(working_ignetcfg,
619 /* Free the filter list in memory */
620 free_netfilter_list();
622 /* Save the network map back to disk */
623 if (netmap_changed) {
624 StrBuf *MapStr = SerializeNetworkMap(the_netmap);
625 CtdlPutSysConfig(IGNETMAP, SmashStrBuf(&MapStr));
628 /* combine singe message files into one spool entry per remote node. */
629 network_consolidate_spoolout(working_ignetcfg, the_netmap);
633 DeleteHash(&the_netmap);
635 DeleteHash(&working_ignetcfg);
637 QNM_syslog(LOG_DEBUG, "network: queue run completed");
639 if (full_processing) {
640 last_run = time(NULL);
642 DeleteHash(&RL.RoomsInterestedIn);
643 destroy_network_queue_room(RL.rplist);
650 int network_room_handler (struct ctdlroom *room)
652 network_queue_room(room, NULL);
656 int NTTDebugEnabled = 0;
659 * network_talking_to() -- concurrency checker
661 static HashList *nttlist = NULL;
662 int network_talking_to(const char *nodename, long len, int operation) {
668 begin_critical_section(S_NTTLIST);
674 nttlist = NewHash(1, NULL);
675 Put(nttlist, nodename, len, NewStrBufPlain(nodename, len), HFreeStrBuf);
676 if (NTTDebugEnabled) syslog(LOG_DEBUG, "nttlist: added <%s>\n", nodename);
679 if ((nttlist == NULL) ||
680 (GetCount(nttlist) == 0))
682 Pos = GetNewHashPos(nttlist, 1);
683 if (GetHashPosFromKey (nttlist, nodename, len, Pos))
684 DeleteEntryFromHash(nttlist, Pos);
686 if (NTTDebugEnabled) syslog(LOG_DEBUG, "nttlist: removed <%s>\n", nodename);
691 if ((nttlist == NULL) ||
692 (GetCount(nttlist) == 0))
694 if (GetHash(nttlist, nodename, len, &vdata))
696 if (NTTDebugEnabled) syslog(LOG_DEBUG, "nttlist: have [%d] <%s>\n", retval, nodename);
700 end_critical_section(S_NTTLIST);
704 void cleanup_nttlist(void)
706 begin_critical_section(S_NTTLIST);
707 DeleteHash(&nttlist);
708 end_critical_section(S_NTTLIST);
713 void network_logout_hook(void)
715 CitContext *CCC = MyContext();
718 * If we were talking to a network node, we're not anymore...
720 if (!IsEmptyStr(CCC->net_node)) {
721 network_talking_to(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
722 CCC->net_node[0] = '\0';
725 void network_cleanup_function(void)
727 struct CitContext *CCC = CC;
729 if (!IsEmptyStr(CCC->net_node)) {
730 network_talking_to(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
731 CCC->net_node[0] = '\0';
739 void SetNTTDebugEnabled(const int n)
743 void SetNetQDebugEnabled(const int n)
745 NetQDebugEnabled = n;
748 CTDL_MODULE_INIT(network)
752 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
753 CtdlRegisterDebugFlagHook(HKEY("networktalkingto"), SetNTTDebugEnabled, &NTTDebugEnabled);
754 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
755 CtdlRegisterCleanupHook(cleanup_nttlist);
756 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
757 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
758 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
759 CtdlRegisterRoomHook(network_room_handler);
760 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
761 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);