4 * This module handles shared rooms, inter-Citadel mail, and outbound
5 * mailing list processing.
7 * Copyright (C) 2000-2002 by Art Cancro and others.
8 * This code is released under the terms of the GNU General Public License.
10 * ** NOTE ** A word on the S_NETCONFIGS semaphore:
11 * This is a fairly high-level type of critical section. It ensures that no
12 * two threads work on the netconfigs files at the same time. Since we do
13 * so many things inside these, here are the rules:
14 * 1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
15 * 2. Do *not* perform any I/O with the client during these sections.
20 * Duration of time (in seconds) after which pending list subscribe/unsubscribe
21 * requests that have not been confirmed will be deleted.
23 #define EXP 259200 /* three days */
34 #include <sys/types.h>
36 #if TIME_WITH_SYS_TIME
37 # include <sys/time.h>
41 # include <sys/time.h>
52 #include "sysdep_decls.h"
53 #include "citserver.h"
56 #include "serv_extensions.h"
63 #include "internet_addressing.h"
64 #include "serv_network.h"
65 #include "clientsocket.h"
72 /* Nonzero while we are doing outbound network processing */
73 static int doing_queue = 0;
76 * When we do network processing, it's accomplished in two passes; one to
77 * gather a list of rooms and one to actually do them. It's ok that rplist
78 * is global; this process *only* runs as part of the housekeeping loop and
79 * therefore only one will run at a time.
81 struct RoomProcList *rplist = NULL;
84 * We build a map of network nodes during processing.
86 struct NetMap *the_netmap = NULL;
87 char *working_ignetcfg = NULL;
90 * Load or refresh the Citadel network (IGnet) configuration for this node.
92 void load_working_ignetcfg(void) {
95 cfg = CtdlGetSysConfig(IGNETCFG);
100 working_ignetcfg = realloc(working_ignetcfg, strlen(cfg) + 1 );
101 strcpy(working_ignetcfg, cfg);
109 * Keep track of what messages to reject
111 struct FilterList *load_filter_list(void) {
112 char *serialized_list = NULL;
115 struct FilterList *newlist = NULL;
116 struct FilterList *nptr;
118 serialized_list = CtdlGetSysConfig(FILTERLIST);
119 if (serialized_list == NULL) return(NULL); /* if null, no entries */
121 /* Use the string tokenizer to grab one line at a time */
122 for (i=0; i<num_tokens(serialized_list, '\n'); ++i) {
123 extract_token(buf, serialized_list, i, '\n');
124 nptr = (struct FilterList *) malloc(sizeof(struct FilterList));
125 extract(nptr->fl_user, buf, 0);
126 striplt(nptr->fl_user);
127 extract(nptr->fl_room, buf, 1);
128 striplt(nptr->fl_room);
129 extract(nptr->fl_node, buf, 2);
130 striplt(nptr->fl_node);
132 /* Cowardly refuse to add an any/any/any entry that would
133 * end up filtering every single message.
135 if (strlen(nptr->fl_user) + strlen(nptr->fl_room)
136 + strlen(nptr->fl_node) == 0) {
140 nptr->next = newlist;
145 free(serialized_list);
150 void free_filter_list(struct FilterList *fl) {
151 if (fl == NULL) return;
152 free_filter_list(fl->next);
159 * Check the use table. This is a list of messages which have recently
160 * arrived on the system. It is maintained and queried to prevent the same
161 * message from being entered into the database multiple times if it happens
162 * to arrive multiple times by accident.
164 int network_usetable(struct CtdlMessage *msg) {
167 struct cdbdata *cdbut;
170 /* Bail out if we can't generate a message ID */
174 if (msg->cm_fields['I'] == NULL) {
177 if (strlen(msg->cm_fields['I']) == 0) {
181 /* Generate the message ID */
182 strcpy(msgid, msg->cm_fields['I']);
183 if (haschar(msgid, '@') == 0) {
185 if (msg->cm_fields['N'] != NULL) {
186 strcat(msgid, msg->cm_fields['N']);
193 cdbut = cdb_fetch(CDB_USETABLE, msgid, strlen(msgid));
199 /* If we got to this point, it's unique: add it. */
200 strcpy(ut.ut_msgid, msgid);
201 ut.ut_timestamp = time(NULL);
202 cdb_store(CDB_USETABLE, msgid, strlen(msgid),
203 &ut, sizeof(struct UseTable) );
209 * Read the network map from its configuration file into memory.
211 void read_network_map(void) {
212 char *serialized_map = NULL;
215 struct NetMap *nmptr;
217 serialized_map = CtdlGetSysConfig(IGNETMAP);
218 if (serialized_map == NULL) return; /* if null, no entries */
220 /* Use the string tokenizer to grab one line at a time */
221 for (i=0; i<num_tokens(serialized_map, '\n'); ++i) {
222 extract_token(buf, serialized_map, i, '\n');
223 nmptr = (struct NetMap *) malloc(sizeof(struct NetMap));
224 extract(nmptr->nodename, buf, 0);
225 nmptr->lastcontact = extract_long(buf, 1);
226 extract(nmptr->nexthop, buf, 2);
227 nmptr->next = the_netmap;
231 free(serialized_map);
236 * Write the network map from memory back to the configuration file.
238 void write_network_map(void) {
239 char *serialized_map = NULL;
240 struct NetMap *nmptr;
242 serialized_map = strdup("");
244 if (the_netmap != NULL) {
245 for (nmptr = the_netmap; nmptr != NULL; nmptr = nmptr->next) {
246 serialized_map = realloc(serialized_map,
247 (strlen(serialized_map)+SIZ) );
248 if (strlen(nmptr->nodename) > 0) {
249 snprintf(&serialized_map[strlen(serialized_map)],
253 (long)nmptr->lastcontact,
259 CtdlPutSysConfig(IGNETMAP, serialized_map);
260 free(serialized_map);
262 /* Now free the list */
263 while (the_netmap != NULL) {
264 nmptr = the_netmap->next;
273 * Check the network map and determine whether the supplied node name is
274 * valid. If it is not a neighbor node, supply the name of a neighbor node
275 * which is the next hop. If it *is* a neighbor node, we also fill in the
278 int is_valid_node(char *nexthop, char *secret, char *node) {
283 struct NetMap *nmptr;
290 * First try the neighbor nodes
292 if (working_ignetcfg == NULL) {
293 lprintf(CTDL_ERR, "working_ignetcfg is NULL!\n");
294 if (nexthop != NULL) {
301 if (nexthop != NULL) {
305 /* Use the string tokenizer to grab one line at a time */
306 for (i=0; i<num_tokens(working_ignetcfg, '\n'); ++i) {
307 extract_token(linebuf, working_ignetcfg, i, '\n');
308 extract(buf, linebuf, 0);
309 if (!strcasecmp(buf, node)) {
310 if (nexthop != NULL) {
313 if (secret != NULL) {
314 extract(secret, linebuf, 1);
321 return(retval); /* yup, it's a direct neighbor */
325 * If we get to this point we have to see if we know the next hop
327 if (the_netmap != NULL) {
328 for (nmptr = the_netmap; nmptr != NULL; nmptr = nmptr->next) {
329 if (!strcasecmp(nmptr->nodename, node)) {
330 if (nexthop != NULL) {
331 strcpy(nexthop, nmptr->nexthop);
339 * If we get to this point, the supplied node name is bogus.
341 lprintf(CTDL_ERR, "Invalid node name <%s>\n", node);
349 void cmd_gnet(char *argbuf) {
354 if (CtdlAccessCheck(ac_room_aide)) return;
355 assoc_file_name(filename, sizeof filename, &CC->room, "netconfigs");
356 cprintf("%d Network settings for room #%ld <%s>\n",
358 CC->room.QRnumber, CC->room.QRname);
360 fp = fopen(filename, "r");
362 while (fgets(buf, sizeof buf, fp) != NULL) {
363 buf[strlen(buf)-1] = 0;
364 cprintf("%s\n", buf);
373 void cmd_snet(char *argbuf) {
374 char tempfilename[SIZ];
381 if (CtdlAccessCheck(ac_room_aide)) return;
382 safestrncpy(tempfilename, tmpnam(NULL), sizeof tempfilename);
383 assoc_file_name(filename, sizeof filename, &CC->room, "netconfigs");
385 fp = fopen(tempfilename, "w");
387 cprintf("%d Cannot open %s: %s\n",
388 ERROR + INTERNAL_ERROR,
393 cprintf("%d %s\n", SEND_LISTING, tempfilename);
394 while (client_gets(buf), strcmp(buf, "000")) {
395 fprintf(fp, "%s\n", buf);
399 /* Now copy the temp file to its permanent location
400 * (We use /bin/mv instead of link() because they may be on
401 * different filesystems)
404 snprintf(buf, sizeof buf, "/bin/mv %s %s", tempfilename, filename);
405 begin_critical_section(S_NETCONFIGS);
407 end_critical_section(S_NETCONFIGS);
412 * Spools out one message from the list.
414 void network_spool_msg(long msgnum, void *userdata) {
415 struct SpoolControl *sc;
418 char *newpath = NULL;
420 size_t instr_len = SIZ;
421 struct CtdlMessage *msg = NULL;
422 struct CtdlMessage *imsg;
423 struct namelist *nptr;
424 struct maplist *mptr;
425 struct ser_ret sermsg;
431 int delete_after_send = 0; /* Set to 1 to delete after spooling */
433 sc = (struct SpoolControl *)userdata;
436 * Process mailing list recipients
438 if (sc->listrecps != NULL) {
440 /* First, copy it to the spoolout room */
441 err = CtdlSaveMsgPointerInRoom(SMTP_SPOOLOUT_ROOM, msgnum, 0);
442 if (err != 0) return;
445 * Figure out how big a buffer we need to allocate
447 for (nptr = sc->listrecps; nptr != NULL; nptr = nptr->next) {
448 instr_len = instr_len + strlen(nptr->name);
454 lprintf(CTDL_DEBUG, "Generating delivery instructions\n");
455 instr = malloc(instr_len);
457 lprintf(CTDL_EMERG, "Cannot allocate %ld bytes for instr...\n",
461 snprintf(instr, instr_len,
462 "Content-type: %s\n\nmsgid|%ld\nsubmitted|%ld\n"
463 "bounceto|postmaster@%s\n" ,
464 SPOOLMIME, msgnum, (long)time(NULL), config.c_fqdn );
466 /* Generate delivery instructions for each recipient */
467 for (nptr = sc->listrecps; nptr != NULL; nptr = nptr->next) {
468 size_t tmp = strlen(instr);
469 snprintf(&instr[tmp], instr_len - tmp,
470 "remote|%s|0||\n", nptr->name);
474 * Generate a message from the instructions
476 imsg = malloc(sizeof(struct CtdlMessage));
477 memset(imsg, 0, sizeof(struct CtdlMessage));
478 imsg->cm_magic = CTDLMESSAGE_MAGIC;
479 imsg->cm_anon_type = MES_NORMAL;
480 imsg->cm_format_type = FMT_RFC822;
481 imsg->cm_fields['A'] = strdup("Citadel");
482 imsg->cm_fields['M'] = instr;
484 /* Save delivery instructions in spoolout room */
485 CtdlSubmitMsg(imsg, NULL, SMTP_SPOOLOUT_ROOM);
486 CtdlFreeMessage(imsg);
490 * Process digest recipients
492 if ((sc->digestrecps != NULL) && (sc->digestfp != NULL)) {
493 fprintf(sc->digestfp, " -----------------------------------"
494 "------------------------------------"
496 CtdlRedirectOutput(sc->digestfp, -1);
497 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 0);
498 CtdlRedirectOutput(NULL, -1);
499 sc->num_msgs_spooled += 1;
503 * Process IGnet push shares
505 if (sc->ignet_push_shares != NULL) {
507 msg = CtdlFetchMessage(msgnum, 1);
511 /* Prepend our node name to the Path field whenever
512 * sending a message to another IGnet node
514 if (msg->cm_fields['P'] == NULL) {
515 msg->cm_fields['P'] = strdup("username");
517 newpath_len = strlen(msg->cm_fields['P']) +
518 strlen(config.c_nodename) + 2;
519 newpath = malloc(newpath_len);
520 snprintf(newpath, newpath_len, "%s!%s",
521 config.c_nodename, msg->cm_fields['P']);
522 free(msg->cm_fields['P']);
523 msg->cm_fields['P'] = newpath;
526 * Determine if this message is set to be deleted
527 * after sending out on the network
529 if (msg->cm_fields['S'] != NULL) {
530 if (!strcasecmp(msg->cm_fields['S'],
532 delete_after_send = 1;
536 /* Now send it to every node */
537 for (mptr = sc->ignet_push_shares; mptr != NULL;
542 /* Check for valid node name */
543 if (is_valid_node(NULL, NULL, mptr->remote_nodename) != 0) {
544 lprintf(CTDL_ERR, "Invalid node <%s>\n",
545 mptr->remote_nodename);
549 /* Check for split horizon */
550 lprintf(CTDL_DEBUG, "Path is %s\n", msg->cm_fields['P']);
551 bang = num_tokens(msg->cm_fields['P'], '!');
552 if (bang > 1) for (i=0; i<(bang-1); ++i) {
553 extract_token(buf, msg->cm_fields['P'],
555 if (!strcasecmp(buf, mptr->remote_nodename)) {
560 /* Send the message */
564 * Force the message to appear in the correct room
565 * on the far end by setting the C field correctly
567 if (msg->cm_fields['C'] != NULL) {
568 free(msg->cm_fields['C']);
570 if (strlen(mptr->remote_roomname) > 0) {
571 msg->cm_fields['C'] = strdup(mptr->remote_roomname);
574 msg->cm_fields['C'] = strdup(CC->room.QRname);
577 /* serialize it for transmission */
578 serialize_message(&sermsg, msg);
580 /* write it to the spool file */
581 snprintf(filename, sizeof filename,
582 "./network/spoolout/%s",
583 mptr->remote_nodename);
584 fp = fopen(filename, "ab");
591 /* free the serialized version */
595 CtdlFreeMessage(msg);
599 /* update lastsent */
600 sc->lastsent = msgnum;
602 /* Delete this message if delete-after-send is set */
603 if (delete_after_send) {
604 CtdlDeleteMessages(CC->room.QRname, msgnum, "");
611 * Deliver digest messages
613 void network_deliver_digest(struct SpoolControl *sc) {
616 struct CtdlMessage *msg;
620 size_t instr_len = SIZ;
621 struct CtdlMessage *imsg;
622 struct namelist *nptr;
624 if (sc->num_msgs_spooled < 1) {
625 fclose(sc->digestfp);
630 msg = malloc(sizeof(struct CtdlMessage));
631 memset(msg, 0, sizeof(struct CtdlMessage));
632 msg->cm_magic = CTDLMESSAGE_MAGIC;
633 msg->cm_format_type = FMT_RFC822;
634 msg->cm_anon_type = MES_NORMAL;
636 sprintf(buf, "%ld", time(NULL));
637 msg->cm_fields['T'] = strdup(buf);
638 msg->cm_fields['A'] = strdup(CC->room.QRname);
639 msg->cm_fields['U'] = strdup(CC->room.QRname);
640 sprintf(buf, "room_%s@%s", CC->room.QRname, config.c_fqdn);
641 for (i=0; i<strlen(buf); ++i) {
642 if (isspace(buf[i])) buf[i]='_';
643 buf[i] = tolower(buf[i]);
645 msg->cm_fields['F'] = strdup(buf);
647 fseek(sc->digestfp, 0L, SEEK_END);
648 msglen = ftell(sc->digestfp);
650 msg->cm_fields['M'] = malloc(msglen + 1);
651 fseek(sc->digestfp, 0L, SEEK_SET);
652 fread(msg->cm_fields['M'], (size_t)msglen, 1, sc->digestfp);
653 msg->cm_fields['M'][msglen] = 0;
655 fclose(sc->digestfp);
658 msgnum = CtdlSubmitMsg(msg, NULL, SMTP_SPOOLOUT_ROOM);
659 CtdlFreeMessage(msg);
661 /* Now generate the delivery instructions */
664 * Figure out how big a buffer we need to allocate
666 for (nptr = sc->digestrecps; nptr != NULL; nptr = nptr->next) {
667 instr_len = instr_len + strlen(nptr->name);
673 lprintf(CTDL_DEBUG, "Generating delivery instructions\n");
674 instr = malloc(instr_len);
676 lprintf(CTDL_EMERG, "Cannot allocate %ld bytes for instr...\n",
680 snprintf(instr, instr_len,
681 "Content-type: %s\n\nmsgid|%ld\nsubmitted|%ld\n"
682 "bounceto|postmaster@%s\n" ,
683 SPOOLMIME, msgnum, (long)time(NULL), config.c_fqdn );
685 /* Generate delivery instructions for each recipient */
686 for (nptr = sc->digestrecps; nptr != NULL; nptr = nptr->next) {
687 size_t tmp = strlen(instr);
688 snprintf(&instr[tmp], instr_len - tmp,
689 "remote|%s|0||\n", nptr->name);
693 * Generate a message from the instructions
695 imsg = malloc(sizeof(struct CtdlMessage));
696 memset(imsg, 0, sizeof(struct CtdlMessage));
697 imsg->cm_magic = CTDLMESSAGE_MAGIC;
698 imsg->cm_anon_type = MES_NORMAL;
699 imsg->cm_format_type = FMT_RFC822;
700 imsg->cm_fields['A'] = strdup("Citadel");
701 imsg->cm_fields['M'] = instr;
703 /* Save delivery instructions in spoolout room */
704 CtdlSubmitMsg(imsg, NULL, SMTP_SPOOLOUT_ROOM);
705 CtdlFreeMessage(imsg);
710 * Batch up and send all outbound traffic from the current room
712 void network_spoolout_room(char *room_to_spool) {
720 struct SpoolControl sc;
721 struct namelist *nptr = NULL;
722 struct maplist *mptr = NULL;
725 int skipthisline = 0;
728 if (getroom(&CC->room, room_to_spool) != 0) {
729 lprintf(CTDL_CRIT, "ERROR: cannot load <%s>\n", room_to_spool);
733 memset(&sc, 0, sizeof(struct SpoolControl));
734 assoc_file_name(filename, sizeof filename, &CC->room, "netconfigs");
736 begin_critical_section(S_NETCONFIGS);
738 fp = fopen(filename, "r");
740 end_critical_section(S_NETCONFIGS);
744 lprintf(CTDL_INFO, "Networking started for <%s>\n", CC->room.QRname);
746 while (fgets(buf, sizeof buf, fp) != NULL) {
747 buf[strlen(buf)-1] = 0;
749 extract(instr, buf, 0);
750 if (!strcasecmp(instr, "lastsent")) {
751 sc.lastsent = extract_long(buf, 1);
753 else if (!strcasecmp(instr, "listrecp")) {
754 nptr = (struct namelist *)
755 malloc(sizeof(struct namelist));
756 nptr->next = sc.listrecps;
757 extract(nptr->name, buf, 1);
760 else if (!strcasecmp(instr, "digestrecp")) {
761 nptr = (struct namelist *)
762 malloc(sizeof(struct namelist));
763 nptr->next = sc.digestrecps;
764 extract(nptr->name, buf, 1);
765 sc.digestrecps = nptr;
767 else if (!strcasecmp(instr, "ignet_push_share")) {
768 /* by checking each node's validity, we automatically
769 * purge nodes which do not exist from room network
770 * configurations at this time.
772 extract(nodename, buf, 1);
773 extract(roomname, buf, 2);
774 strcpy(nexthop, "xxx");
775 if (is_valid_node(nexthop, NULL, nodename) == 0) {
776 if (strlen(nexthop) == 0) {
777 mptr = (struct maplist *)
778 malloc(sizeof(struct maplist));
779 mptr->next = sc.ignet_push_shares;
780 strcpy(mptr->remote_nodename, nodename);
781 strcpy(mptr->remote_roomname, roomname);
782 sc.ignet_push_shares = mptr;
787 /* Preserve 'other' lines ... *unless* they happen to
788 * be subscribe/unsubscribe pendings with expired
792 if (!strncasecmp(buf, "subpending|", 11)) {
793 if (time(NULL) - extract_long(buf, 4) > EXP) {
797 if (!strncasecmp(buf, "unsubpending|", 13)) {
798 if (time(NULL) - extract_long(buf, 3) > EXP) {
803 if (skipthisline == 0) {
804 linesize = strlen(buf);
805 sc.misc = realloc(sc.misc,
806 (miscsize + linesize + 2) );
807 sprintf(&sc.misc[miscsize], "%s\n", buf);
808 miscsize = miscsize + linesize + 1;
816 /* If there are digest recipients, we have to build a digest */
817 if (sc.digestrecps != NULL) {
818 sc.digestfp = tmpfile();
819 fprintf(sc.digestfp, "Content-type: text/plain\n\n");
822 /* Do something useful */
823 CtdlForEachMessage(MSGS_GT, sc.lastsent, NULL, NULL,
824 network_spool_msg, &sc);
826 /* If we wrote a digest, deliver it and then close it */
827 snprintf(buf, sizeof buf, "room_%s@%s",
828 CC->room.QRname, config.c_fqdn);
829 for (i=0; i<strlen(buf); ++i) {
830 buf[i] = tolower(buf[i]);
831 if (isspace(buf[i])) buf[i] = '_';
833 if (sc.digestfp != NULL) {
834 fprintf(sc.digestfp, " -----------------------------------"
835 "------------------------------------"
837 "You are subscribed to the '%s' "
839 "To post to the list: %s\n",
842 network_deliver_digest(&sc); /* deliver and close */
845 /* Now rewrite the config file */
846 fp = fopen(filename, "w");
848 lprintf(CTDL_CRIT, "ERROR: cannot open %s: %s\n",
849 filename, strerror(errno));
852 fprintf(fp, "lastsent|%ld\n", sc.lastsent);
854 /* Write out the listrecps while freeing from memory at the
855 * same time. Am I clever or what? :)
857 while (sc.listrecps != NULL) {
858 fprintf(fp, "listrecp|%s\n", sc.listrecps->name);
859 nptr = sc.listrecps->next;
863 /* Do the same for digestrecps */
864 while (sc.digestrecps != NULL) {
865 fprintf(fp, "digestrecp|%s\n", sc.digestrecps->name);
866 nptr = sc.digestrecps->next;
867 free(sc.digestrecps);
868 sc.digestrecps = nptr;
870 while (sc.ignet_push_shares != NULL) {
871 /* by checking each node's validity, we automatically
872 * purge nodes which do not exist from room network
873 * configurations at this time.
875 if (is_valid_node(NULL, NULL, sc.ignet_push_shares->remote_nodename) == 0) {
877 fprintf(fp, "ignet_push_share|%s",
878 sc.ignet_push_shares->remote_nodename);
879 if (strlen(sc.ignet_push_shares->remote_roomname) > 0) {
880 fprintf(fp, "|%s", sc.ignet_push_shares->remote_roomname);
883 mptr = sc.ignet_push_shares->next;
884 free(sc.ignet_push_shares);
885 sc.ignet_push_shares = mptr;
887 if (sc.misc != NULL) {
888 fwrite(sc.misc, strlen(sc.misc), 1, fp);
894 end_critical_section(S_NETCONFIGS);
900 * Send the *entire* contents of the current room to one specific network node,
901 * ignoring anything we know about which messages have already undergone
902 * network processing. This can be used to bring a new node into sync.
904 int network_sync_to(char *target_node) {
905 struct SpoolControl sc;
915 /* Grab the configuration line we're looking for */
916 assoc_file_name(filename, sizeof filename, &CC->room, "netconfigs");
917 begin_critical_section(S_NETCONFIGS);
918 fp = fopen(filename, "r");
920 end_critical_section(S_NETCONFIGS);
923 while (fgets(buf, sizeof buf, fp) != NULL) {
924 buf[strlen(buf)-1] = 0;
925 extract(sc_type, buf, 0);
926 extract(sc_node, buf, 1);
927 extract(sc_room, buf, 2);
928 if ( (!strcasecmp(sc_type, "ignet_push_share"))
929 && (!strcasecmp(sc_node, target_node)) ) {
932 /* Concise syntax because we don't need a full linked-list */
933 memset(&sc, 0, sizeof(struct SpoolControl));
934 sc.ignet_push_shares = (struct maplist *)
935 malloc(sizeof(struct maplist));
936 sc.ignet_push_shares->next = NULL;
937 safestrncpy(sc.ignet_push_shares->remote_nodename,
939 sizeof sc.ignet_push_shares->remote_nodename);
940 safestrncpy(sc.ignet_push_shares->remote_roomname,
942 sizeof sc.ignet_push_shares->remote_roomname);
946 end_critical_section(S_NETCONFIGS);
948 if (!found_node) return(-1);
950 /* Send ALL messages */
951 num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
952 network_spool_msg, &sc);
954 /* Concise cleanup because we know there's only one node in the sc */
955 free(sc.ignet_push_shares);
957 lprintf(CTDL_NOTICE, "Synchronized %d messages to <%s>\n",
958 num_spooled, target_node);
964 * Implements the NSYN command
966 void cmd_nsyn(char *argbuf) {
968 char target_node[SIZ];
970 if (CtdlAccessCheck(ac_aide)) return;
972 extract(target_node, argbuf, 0);
973 num_spooled = network_sync_to(target_node);
974 if (num_spooled >= 0) {
975 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
978 cprintf("%d No such room/node share exists.\n",
979 ERROR + ROOM_NOT_FOUND);
986 * Batch up and send all outbound traffic from the current room
988 void network_queue_room(struct ctdlroom *qrbuf, void *data) {
989 struct RoomProcList *ptr;
991 ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
992 if (ptr == NULL) return;
994 safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
1001 * Learn topology from path fields
1003 void network_learn_topology(char *node, char *path) {
1005 struct NetMap *nmptr;
1007 strcpy(nexthop, "");
1009 if (num_tokens(path, '!') < 3) return;
1010 for (nmptr = the_netmap; nmptr != NULL; nmptr = nmptr->next) {
1011 if (!strcasecmp(nmptr->nodename, node)) {
1012 extract_token(nmptr->nexthop, path, 0, '!');
1013 nmptr->lastcontact = time(NULL);
1018 /* If we got here then it's not in the map, so add it. */
1019 nmptr = (struct NetMap *) malloc(sizeof (struct NetMap));
1020 strcpy(nmptr->nodename, node);
1021 nmptr->lastcontact = time(NULL);
1022 extract_token(nmptr->nexthop, path, 0, '!');
1023 nmptr->next = the_netmap;
1031 * Bounce a message back to the sender
1033 void network_bounce(struct CtdlMessage *msg, char *reason) {
1034 char *oldpath = NULL;
1036 char bouncesource[SIZ];
1037 char recipient[SIZ];
1038 struct recptypes *valid = NULL;
1039 char force_room[ROOMNAMELEN];
1040 static int serialnum = 0;
1043 lprintf(CTDL_DEBUG, "entering network_bounce()\n");
1045 if (msg == NULL) return;
1047 snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
1050 * Give it a fresh message ID
1052 if (msg->cm_fields['I'] != NULL) {
1053 free(msg->cm_fields['I']);
1055 snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
1056 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
1057 msg->cm_fields['I'] = strdup(buf);
1060 * FIXME ... right now we're just sending a bounce; we really want to
1061 * include the text of the bounced message.
1063 if (msg->cm_fields['M'] != NULL) {
1064 free(msg->cm_fields['M']);
1066 msg->cm_fields['M'] = strdup(reason);
1067 msg->cm_format_type = 0;
1070 * Turn the message around
1072 if (msg->cm_fields['R'] == NULL) {
1073 free(msg->cm_fields['R']);
1076 if (msg->cm_fields['D'] == NULL) {
1077 free(msg->cm_fields['D']);
1080 snprintf(recipient, sizeof recipient, "%s@%s",
1081 msg->cm_fields['A'], msg->cm_fields['N']);
1083 if (msg->cm_fields['A'] == NULL) {
1084 free(msg->cm_fields['A']);
1087 if (msg->cm_fields['N'] == NULL) {
1088 free(msg->cm_fields['N']);
1091 msg->cm_fields['A'] = strdup(BOUNCESOURCE);
1092 msg->cm_fields['N'] = strdup(config.c_nodename);
1095 /* prepend our node to the path */
1096 if (msg->cm_fields['P'] != NULL) {
1097 oldpath = msg->cm_fields['P'];
1098 msg->cm_fields['P'] = NULL;
1101 oldpath = strdup("unknown_user");
1103 size = strlen(oldpath) + SIZ;
1104 msg->cm_fields['P'] = malloc(size);
1105 snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
1108 /* Now submit the message */
1109 valid = validate_recipients(recipient);
1110 if (valid != NULL) if (valid->num_error > 0) {
1114 if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
1115 strcpy(force_room, config.c_aideroom);
1118 strcpy(force_room, "");
1120 if ( (valid == NULL) && (strlen(force_room) == 0) ) {
1121 strcpy(force_room, config.c_aideroom);
1123 CtdlSubmitMsg(msg, valid, force_room);
1126 if (valid != NULL) free(valid);
1127 CtdlFreeMessage(msg);
1128 lprintf(CTDL_DEBUG, "leaving network_bounce()\n");
1135 * Process a buffer containing a single message from a single file
1136 * from the inbound queue
1138 void network_process_buffer(char *buffer, long size) {
1139 struct CtdlMessage *msg;
1142 struct recptypes *recp = NULL;
1143 char target_room[ROOMNAMELEN];
1144 struct ser_ret sermsg;
1145 char *oldpath = NULL;
1149 unsigned char firstbyte;
1150 unsigned char lastbyte;
1152 /* Validate just a little bit. First byte should be FF and
1153 * last byte should be 00.
1155 memcpy(&firstbyte, &buffer[0], 1);
1156 memcpy(&lastbyte, &buffer[size-1], 1);
1157 if ( (firstbyte != 255) || (lastbyte != 0) ) {
1158 lprintf(CTDL_ERR, "Corrupt message! Ignoring.\n");
1162 /* Set default target room to trash */
1163 strcpy(target_room, TWITROOM);
1165 /* Load the message into memory */
1166 msg = (struct CtdlMessage *) malloc(sizeof(struct CtdlMessage));
1167 memset(msg, 0, sizeof(struct CtdlMessage));
1168 msg->cm_magic = CTDLMESSAGE_MAGIC;
1169 msg->cm_anon_type = buffer[1];
1170 msg->cm_format_type = buffer[2];
1172 for (pos = 3; pos < size; ++pos) {
1173 field = buffer[pos];
1174 msg->cm_fields[field] = strdup(&buffer[pos+1]);
1175 pos = pos + strlen(&buffer[(int)pos]);
1178 /* Check for message routing */
1179 if (msg->cm_fields['D'] != NULL) {
1180 if (strcasecmp(msg->cm_fields['D'], config.c_nodename)) {
1182 /* route the message */
1183 strcpy(nexthop, "");
1184 if (is_valid_node(nexthop, NULL,
1185 msg->cm_fields['D']) == 0) {
1187 /* prepend our node to the path */
1188 if (msg->cm_fields['P'] != NULL) {
1189 oldpath = msg->cm_fields['P'];
1190 msg->cm_fields['P'] = NULL;
1193 oldpath = strdup("unknown_user");
1195 size = strlen(oldpath) + SIZ;
1196 msg->cm_fields['P'] = malloc(size);
1197 snprintf(msg->cm_fields['P'], size, "%s!%s",
1198 config.c_nodename, oldpath);
1201 /* serialize the message */
1202 serialize_message(&sermsg, msg);
1205 if (strlen(nexthop) == 0) {
1206 strcpy(nexthop, msg->cm_fields['D']);
1208 snprintf(filename, sizeof filename,
1209 "./network/spoolout/%s", nexthop);
1210 fp = fopen(filename, "ab");
1217 CtdlFreeMessage(msg);
1221 else { /* invalid destination node name */
1224 "A message you sent could not be delivered due to an invalid destination node"
1225 " name. Please check the address and try sending the message again.\n");
1234 * Check to see if we already have a copy of this message, and
1235 * abort its processing if so. (We used to post a warning to Aide>
1236 * every time this happened, but the network is now so densely
1237 * connected that it's inevitable.)
1239 if (network_usetable(msg) != 0) {
1243 /* Learn network topology from the path */
1244 if ((msg->cm_fields['N'] != NULL) && (msg->cm_fields['P'] != NULL)) {
1245 network_learn_topology(msg->cm_fields['N'],
1246 msg->cm_fields['P']);
1249 /* Is the sending node giving us a very persuasive suggestion about
1250 * which room this message should be saved in? If so, go with that.
1252 if (msg->cm_fields['C'] != NULL) {
1253 safestrncpy(target_room,
1254 msg->cm_fields['C'],
1255 sizeof target_room);
1258 /* Otherwise, does it have a recipient? If so, validate it... */
1259 else if (msg->cm_fields['R'] != NULL) {
1260 recp = validate_recipients(msg->cm_fields['R']);
1261 if (recp != NULL) if (recp->num_error > 0) {
1263 "A message you sent could not be delivered due to an invalid address.\n"
1264 "Please check the address and try sending the message again.\n");
1269 strcpy(target_room, ""); /* no target room if mail */
1272 /* Our last shot at finding a home for this message is to see if
1273 * it has the O field (Originating room) set.
1275 else if (msg->cm_fields['O'] != NULL) {
1276 safestrncpy(target_room,
1277 msg->cm_fields['O'],
1278 sizeof target_room);
1281 /* Strip out fields that are only relevant during transit */
1282 if (msg->cm_fields['D'] != NULL) {
1283 free(msg->cm_fields['D']);
1284 msg->cm_fields['D'] = NULL;
1286 if (msg->cm_fields['C'] != NULL) {
1287 free(msg->cm_fields['C']);
1288 msg->cm_fields['C'] = NULL;
1291 /* save the message into a room */
1292 if (PerformNetprocHooks(msg, target_room) == 0) {
1293 msg->cm_flags = CM_SKIP_HOOKS;
1294 CtdlSubmitMsg(msg, recp, target_room);
1296 CtdlFreeMessage(msg);
1302 * Process a single message from a single file from the inbound queue
1304 void network_process_message(FILE *fp, long msgstart, long msgend) {
1309 hold_pos = ftell(fp);
1310 size = msgend - msgstart + 1;
1311 buffer = malloc(size);
1312 if (buffer != NULL) {
1313 fseek(fp, msgstart, SEEK_SET);
1314 fread(buffer, size, 1, fp);
1315 network_process_buffer(buffer, size);
1319 fseek(fp, hold_pos, SEEK_SET);
1324 * Process a single file from the inbound queue
1326 void network_process_file(char *filename) {
1328 long msgstart = (-1L);
1329 long msgend = (-1L);
1334 fp = fopen(filename, "rb");
1336 lprintf(CTDL_CRIT, "Error opening %s: %s\n",
1337 filename, strerror(errno));
1341 lprintf(CTDL_INFO, "network: processing <%s>\n", filename);
1343 /* Look for messages in the data stream and break them out */
1344 while (ch = getc(fp), ch >= 0) {
1347 if (msgstart >= 0L) {
1348 msgend = msgcur - 1;
1349 network_process_message(fp, msgstart, msgend);
1357 msgend = msgcur - 1;
1358 if (msgstart >= 0L) {
1359 network_process_message(fp, msgstart, msgend);
1368 * Process anything in the inbound queue
1370 void network_do_spoolin(void) {
1375 dp = opendir("./network/spoolin");
1376 if (dp == NULL) return;
1378 while (d = readdir(dp), d != NULL) {
1379 snprintf(filename, sizeof filename,
1380 "./network/spoolin/%s", d->d_name);
1381 network_process_file(filename);
1390 * Delete any files in the outbound queue that were intended
1391 * to be sent to nodes which no longer exist.
1393 void network_purge_spoolout(void) {
1400 dp = opendir("./network/spoolout");
1401 if (dp == NULL) return;
1403 while (d = readdir(dp), d != NULL) {
1404 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
1406 snprintf(filename, sizeof filename,
1407 "./network/spoolout/%s", d->d_name);
1409 strcpy(nexthop, "");
1410 i = is_valid_node(nexthop, NULL, d->d_name);
1412 if ( (i != 0) || (strlen(nexthop) > 0) ) {
1424 * receive network spool from the remote system
1426 void receive_spool(int sock, char *remote_nodename) {
1428 long bytes_received;
1430 static char pbuf[IGNET_PACKET_SIZE];
1431 char tempfilename[PATH_MAX];
1435 strcpy(tempfilename, tmpnam(NULL));
1436 if (sock_puts(sock, "NDOP") < 0) return;
1437 if (sock_gets(sock, buf) < 0) return;
1438 lprintf(CTDL_DEBUG, "<%s\n", buf);
1439 if (buf[0] != '2') {
1442 download_len = extract_long(&buf[4], 0);
1444 bytes_received = 0L;
1445 fp = fopen(tempfilename, "w");
1447 lprintf(CTDL_CRIT, "cannot open download file locally: %s\n",
1452 while (bytes_received < download_len) {
1453 snprintf(buf, sizeof buf, "READ %ld|%ld",
1455 ((download_len - bytes_received > IGNET_PACKET_SIZE)
1456 ? IGNET_PACKET_SIZE : (download_len - bytes_received)));
1457 if (sock_puts(sock, buf) < 0) {
1459 unlink(tempfilename);
1462 if (sock_gets(sock, buf) < 0) {
1464 unlink(tempfilename);
1467 if (buf[0] == '6') {
1468 plen = extract_long(&buf[4], 0);
1469 if (sock_read(sock, pbuf, plen) < 0) {
1471 unlink(tempfilename);
1474 fwrite((char *) pbuf, plen, 1, fp);
1475 bytes_received = bytes_received + plen;
1480 if (sock_puts(sock, "CLOS") < 0) {
1481 unlink(tempfilename);
1484 if (sock_gets(sock, buf) < 0) {
1485 unlink(tempfilename);
1488 if (download_len > 0)
1489 lprintf(CTDL_NOTICE, "Received %ld octets from <%s>",
1490 download_len, remote_nodename);
1491 lprintf(CTDL_DEBUG, "%s", buf);
1492 snprintf(buf, sizeof buf, "mv %s ./network/spoolin/%s.%ld",
1493 tempfilename, remote_nodename, (long) getpid());
1500 * transmit network spool to the remote system
1502 void transmit_spool(int sock, char *remote_nodename)
1507 long bytes_to_write, thisblock, bytes_written;
1511 if (sock_puts(sock, "NUOP") < 0) return;
1512 if (sock_gets(sock, buf) < 0) return;
1513 lprintf(CTDL_DEBUG, "<%s\n", buf);
1514 if (buf[0] != '2') {
1518 snprintf(sfname, sizeof sfname, "./network/spoolout/%s", remote_nodename);
1519 fd = open(sfname, O_RDONLY);
1521 if (errno != ENOENT) {
1522 lprintf(CTDL_CRIT, "cannot open upload file locally: %s\n",
1528 while (plen = (long) read(fd, pbuf, IGNET_PACKET_SIZE), plen > 0L) {
1529 bytes_to_write = plen;
1530 while (bytes_to_write > 0L) {
1531 snprintf(buf, sizeof buf, "WRIT %ld", bytes_to_write);
1532 if (sock_puts(sock, buf) < 0) {
1536 if (sock_gets(sock, buf) < 0) {
1540 thisblock = atol(&buf[4]);
1541 if (buf[0] == '7') {
1542 if (sock_write(sock, pbuf,
1543 (int) thisblock) < 0) {
1547 bytes_to_write -= thisblock;
1548 bytes_written += thisblock;
1557 if (sock_puts(sock, "UCLS 1") < 0) return;
1558 if (sock_gets(sock, buf) < 0) return;
1559 lprintf(CTDL_NOTICE, "Sent %ld octets to <%s>",
1560 bytes_written, remote_nodename);
1561 lprintf(CTDL_DEBUG, "<%s\n", buf);
1562 if (buf[0] == '2') {
1570 * Poll one Citadel node (called by network_poll_other_citadel_nodes() below)
1572 void network_poll_node(char *node, char *secret, char *host, char *port) {
1576 if (network_talking_to(node, NTT_CHECK)) return;
1577 network_talking_to(node, NTT_ADD);
1578 lprintf(CTDL_NOTICE, "Connecting to <%s> at %s:%s\n", node, host, port);
1580 sock = sock_connect(host, port, "tcp");
1582 lprintf(CTDL_ERR, "Could not connect: %s\n", strerror(errno));
1583 network_talking_to(node, NTT_REMOVE);
1587 lprintf(CTDL_DEBUG, "Connected!\n");
1589 /* Read the server greeting */
1590 if (sock_gets(sock, buf) < 0) goto bail;
1591 lprintf(CTDL_DEBUG, ">%s\n", buf);
1593 /* Identify ourselves */
1594 snprintf(buf, sizeof buf, "NETP %s|%s", config.c_nodename, secret);
1595 lprintf(CTDL_DEBUG, "<%s\n", buf);
1596 if (sock_puts(sock, buf) <0) goto bail;
1597 if (sock_gets(sock, buf) < 0) goto bail;
1598 lprintf(CTDL_DEBUG, ">%s\n", buf);
1599 if (buf[0] != '2') goto bail;
1601 /* At this point we are authenticated. */
1602 receive_spool(sock, node);
1603 transmit_spool(sock, node);
1605 sock_puts(sock, "QUIT");
1606 bail: sock_close(sock);
1607 network_talking_to(node, NTT_REMOVE);
1613 * Poll other Citadel nodes and transfer inbound/outbound network data.
1614 * Set "full" to nonzero to force a poll of every node, or to zero to poll
1615 * only nodes to which we have data to send.
1617 void network_poll_other_citadel_nodes(int full_poll) {
1625 char spoolfile[SIZ];
1627 if (working_ignetcfg == NULL) {
1628 lprintf(CTDL_DEBUG, "No nodes defined - not polling\n");
1632 /* Use the string tokenizer to grab one line at a time */
1633 for (i=0; i<num_tokens(working_ignetcfg, '\n'); ++i) {
1634 extract_token(linebuf, working_ignetcfg, i, '\n');
1635 extract(node, linebuf, 0);
1636 extract(secret, linebuf, 1);
1637 extract(host, linebuf, 2);
1638 extract(port, linebuf, 3);
1639 if ( (strlen(node) > 0) && (strlen(secret) > 0)
1640 && (strlen(host) > 0) && strlen(port) > 0) {
1643 sprintf(spoolfile, "./network/spoolout/%s",
1645 if (access(spoolfile, R_OK) == 0) {
1650 network_poll_node(node, secret, host, port);
1664 * network_do_queue()
1666 * Run through the rooms doing various types of network stuff.
1668 void network_do_queue(void) {
1669 static time_t last_run = 0L;
1670 struct RoomProcList *ptr;
1671 int full_processing = 1;
1674 * Run the full set of processing tasks no more frequently
1675 * than once every n seconds
1677 if ( (time(NULL) - last_run) < config.c_net_freq ) {
1678 full_processing = 0;
1682 * This is a simple concurrency check to make sure only one queue run
1683 * is done at a time. We could do this with a mutex, but since we
1684 * don't really require extremely fine granularity here, we'll do it
1685 * with a static variable instead.
1687 if (doing_queue) return;
1690 /* Load the IGnet Configuration into memory */
1691 load_working_ignetcfg();
1694 * Poll other Citadel nodes. Maybe. If "full_processing" is set
1695 * then we poll everyone. Otherwise we only poll nodes we have stuff
1698 network_poll_other_citadel_nodes(full_processing);
1701 * Load the network map and filter list into memory.
1704 filterlist = load_filter_list();
1707 * Go ahead and run the queue
1709 if (full_processing) {
1710 lprintf(CTDL_DEBUG, "network: loading outbound queue\n");
1711 ForEachRoom(network_queue_room, NULL);
1713 lprintf(CTDL_DEBUG, "network: running outbound queue\n");
1714 while (rplist != NULL) {
1715 network_spoolout_room(rplist->name);
1717 rplist = rplist->next;
1722 lprintf(CTDL_DEBUG, "network: processing inbound queue\n");
1723 network_do_spoolin();
1725 /* Save the network map back to disk */
1726 write_network_map();
1728 /* Free the filter list in memory */
1729 free_filter_list(filterlist);
1732 network_purge_spoolout();
1734 lprintf(CTDL_DEBUG, "network: queue run completed\n");
1736 if (full_processing) {
1737 last_run = time(NULL);
1745 * cmd_netp() - authenticate to the server as another Citadel node polling
1746 * for network traffic
1748 void cmd_netp(char *cmdbuf)
1758 extract(node, cmdbuf, 0);
1759 extract(pass, cmdbuf, 1);
1762 lprintf(CTDL_WARNING, "Network node <%s> refused - spooling", node);
1763 cprintf("%d spooling - try again in a few minutes\n",
1764 ERROR + RESOURCE_BUSY);
1768 /* load the IGnet Configuration to check node validity */
1769 load_working_ignetcfg();
1770 v = is_valid_node(nexthop, secret, node);
1773 lprintf(CTDL_WARNING, "Unknown node <%s>", node);
1774 cprintf("%d authentication failed\n",
1775 ERROR + PASSWORD_REQUIRED);
1779 if (strcasecmp(pass, secret)) {
1780 lprintf(CTDL_WARNING, "Bad password for network node <%s>", node);
1781 cprintf("%d authentication failed\n", ERROR + PASSWORD_REQUIRED);
1785 if (network_talking_to(node, NTT_CHECK)) {
1786 lprintf(CTDL_WARNING, "Duplicate session for network node <%s>", node);
1787 cprintf("%d Already talking to %s right now\n", ERROR + RESOURCE_BUSY, node);
1791 safestrncpy(CC->net_node, node, sizeof CC->net_node);
1792 network_talking_to(node, NTT_ADD);
1793 lprintf(CTDL_NOTICE, "Network node <%s> logged in\n", CC->net_node);
1794 cprintf("%d authenticated as network node '%s'\n", CIT_OK,
1801 * Module entry point
1803 char *serv_network_init(void)
1805 CtdlRegisterProtoHook(cmd_gnet, "GNET", "Get network config");
1806 CtdlRegisterProtoHook(cmd_snet, "SNET", "Set network config");
1807 CtdlRegisterProtoHook(cmd_netp, "NETP", "Identify as network poller");
1808 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
1809 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER);