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 void network_deliver_list(struct CtdlMessage *msg, SpoolControl *sc, const char *RoomName);
85 void aggregate_recipients(StrBuf **recps, RoomNetCfg Which, OneRoomNetCfg *OneRNCfg, long nSegments)
90 struct CitContext *CCC = CC;
94 * Figure out how big a buffer we need to allocate
96 for (nptr = OneRNCfg->NetConfigs[Which]; nptr != NULL; nptr = nptr->next) {
97 recps_len = recps_len + StrLength(nptr->Value[0]) + 2;
100 /* Nothing todo... */
104 *recps = NewStrBufPlain(NULL, recps_len);
106 if (*recps == NULL) {
108 "Cannot allocate %ld bytes for recps...\n",
114 for (nptr = OneRNCfg->NetConfigs[Which]; nptr != NULL; nptr = nptr->next) {
115 if (nptr != OneRNCfg->NetConfigs[Which]) {
116 for (i = 0; i < nSegments; i++)
117 StrBufAppendBufPlain(*recps, HKEY(","), i);
119 StrBufAppendBuf(*recps, nptr->Value[0], 0);
120 if (Which == ignet_push_share)
122 StrBufAppendBufPlain(*recps, HKEY(","), 0);
123 StrBufAppendBuf(*recps, nptr->Value[1], 0);
129 static void ListCalculateSubject(struct CtdlMessage *msg)
131 struct CitContext *CCC = CC;
132 StrBuf *Subject, *FlatSubject;
136 if (CM_IsEmpty(msg, eMsgSubject)) {
137 Subject = NewStrBufPlain(HKEY("(no subject)"));
140 Subject = NewStrBufPlain(
141 msg->cm_fields[eMsgSubject], -1);
143 FlatSubject = NewStrBufPlain(NULL, StrLength(Subject));
144 StrBuf_RFC822_to_Utf8(FlatSubject, Subject, NULL, NULL);
146 rlen = strlen(CCC->room.QRname);
147 pCh = strstr(ChrPtr(FlatSubject), CCC->room.QRname);
149 (*(pCh + rlen) != ']') ||
150 (pCh == ChrPtr(FlatSubject)) ||
155 StrBufPlain(Subject, HKEY("["));
156 StrBufAppendBufPlain(Subject,
159 StrBufAppendBufPlain(Subject, HKEY("] "), 0);
160 StrBufAppendBuf(Subject, FlatSubject, 0);
161 /* so we can free the right one swap them */
163 Subject = FlatSubject;
165 StrBufRFC2047encode(&Subject, FlatSubject);
168 CM_SetAsFieldSB(msg, eMsgSubject, &Subject);
170 FreeStrBuf(&FlatSubject);
174 * Deliver digest messages
176 void network_deliver_digest(SpoolControl *sc)
178 struct CitContext *CCC = CC;
182 struct CtdlMessage *msg = NULL;
184 struct recptypes *valid;
187 if (sc->Users[listrecp] == NULL)
190 if (sc->num_msgs_spooled < 1) {
191 fclose(sc->digestfp);
196 msg = malloc(sizeof(struct CtdlMessage));
197 memset(msg, 0, sizeof(struct CtdlMessage));
198 msg->cm_magic = CTDLMESSAGE_MAGIC;
199 msg->cm_format_type = FMT_RFC822;
200 msg->cm_anon_type = MES_NORMAL;
202 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
203 CM_SetField(msg, eAuthor, CCC->room.QRname, strlen(CCC->room.QRname));
204 len = snprintf(buf, sizeof buf, "[%s]", CCC->room.QRname);
205 CM_SetField(msg, eMsgSubject, buf, len);
207 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
208 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
210 /* Set the 'List-ID' header */
211 CM_SetField(msg, eListID, SKEY(sc->ListID));
214 * Go fetch the contents of the digest
216 fseek(sc->digestfp, 0L, SEEK_END);
217 msglen = ftell(sc->digestfp);
219 pbuf = malloc(msglen + 1);
220 fseek(sc->digestfp, 0L, SEEK_SET);
221 fread(pbuf, (size_t)msglen, 1, sc->digestfp);
223 CM_SetAsField(msg, eMesageText, &pbuf, msglen);
224 fclose(sc->digestfp);
227 /* Now generate the delivery instructions */
228 if (sc->Users[listrecp] == NULL)
231 /* Where do we want bounces and other noise to be heard?
232 *Surely not the list members! */
233 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
235 /* Now submit the message */
236 valid = validate_recipients(ChrPtr(sc->Users[listrecp]), NULL, 0);
238 valid->bounce_to = strdup(bounce_to);
239 valid->envelope_from = strdup(bounce_to);
240 CtdlSubmitMsg(msg, valid, NULL, 0);
243 free_recipients(valid);
247 void network_process_digest(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
250 struct CtdlMessage *msg = NULL;
253 * Process digest recipients
255 if ((sc->Users[digestrecp] == NULL)||
256 (sc->digestfp == NULL))
259 msg = CM_Duplicate(omsg);
261 fprintf(sc->digestfp,
262 " -----------------------------------"
263 "------------------------------------"
265 fprintf(sc->digestfp, "From: ");
266 if (!CM_IsEmpty(msg, eAuthor)) {
267 fprintf(sc->digestfp,
269 msg->cm_fields[eAuthor]);
271 if (!CM_IsEmpty(msg, erFc822Addr)) {
272 fprintf(sc->digestfp,
274 msg->cm_fields[erFc822Addr]);
276 else if (!CM_IsEmpty(msg, eNodeName)) {
277 fprintf(sc->digestfp,
279 msg->cm_fields[eNodeName]);
281 fprintf(sc->digestfp, "\n");
282 if (!CM_IsEmpty(msg, eMsgSubject)) {
283 fprintf(sc->digestfp,
285 msg->cm_fields[eMsgSubject]);
288 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
290 safestrncpy(CC->preferred_formats,
292 sizeof CC->preferred_formats);
294 CtdlOutputPreLoadedMsg(msg,
299 StrBufTrim(CC->redirect_buffer);
300 fwrite(HKEY("\n"), 1, sc->digestfp);
301 fwrite(SKEY(CC->redirect_buffer), 1, sc->digestfp);
302 fwrite(HKEY("\n"), 1, sc->digestfp);
304 FreeStrBuf(&CC->redirect_buffer);
306 sc->num_msgs_spooled += 1;
312 void network_process_list(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
314 struct CtdlMessage *msg = NULL;
317 * Process mailing list recipients
319 if (sc->Users[listrecp] == NULL)
322 /* create our own copy of the message.
323 * We're going to need to modify it
324 * in order to insert the [list name] in it, etc.
327 msg = CM_Duplicate(omsg);
330 CM_SetField(msg, eListID, SKEY(sc->Users[roommailalias]));
332 /* if there is no other recipient, Set the recipient
333 * of the list message to the email address of the
336 if (CM_IsEmpty(msg, eRecipient))
338 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
341 /* Set the 'List-ID' header */
342 CM_SetField(msg, eListID, SKEY(sc->ListID));
345 /* Prepend "[List name]" to the subject */
346 ListCalculateSubject(msg);
348 /* Handle delivery */
349 network_deliver_list(msg, sc, CC->room.QRname);
354 * Deliver list messages to everyone on the list ... efficiently
356 void network_deliver_list(struct CtdlMessage *msg, SpoolControl *sc, const char *RoomName)
358 struct recptypes *valid;
361 /* Don't do this if there were no recipients! */
362 if (sc->Users[listrecp] == NULL)
365 /* Now generate the delivery instructions */
367 /* Where do we want bounces and other noise to be heard?
368 * Surely not the list members! */
369 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
371 /* Now submit the message */
372 valid = validate_recipients(ChrPtr(sc->Users[listrecp]), NULL, 0);
374 valid->bounce_to = strdup(bounce_to);
375 valid->envelope_from = strdup(bounce_to);
376 valid->sending_room = strdup(RoomName);
377 CtdlSubmitMsg(msg, valid, NULL, 0);
378 free_recipients(valid);
380 /* Do not call CM_Free(msg) here; the caller will free it. */
384 void network_process_participate(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
386 struct CtdlMessage *msg = NULL;
387 int ok_to_participate = 0;
389 struct recptypes *valid;
392 * Process client-side list participations for this room
394 if (sc->Users[participate] == NULL)
397 msg = CM_Duplicate(omsg);
399 /* Only send messages which originated on our own
400 * Citadel network, otherwise we'll end up sending the
401 * remote mailing list's messages back to it, which
404 ok_to_participate = 0;
405 if (!CM_IsEmpty(msg, eNodeName)) {
406 if (!strcasecmp(msg->cm_fields[eNodeName],
407 config.c_nodename)) {
408 ok_to_participate = 1;
411 Buf = NewStrBufPlain(msg->cm_fields[eNodeName], -1);
412 if (CtdlIsValidNode(NULL,
415 sc->working_ignetcfg,
416 sc->the_netmap) == 0)
418 ok_to_participate = 1;
421 if (ok_to_participate)
423 /* Replace the Internet email address of the
424 * actual author with the email address of the
425 * room itself, so the remote listserv doesn't
428 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
430 valid = validate_recipients(ChrPtr(sc->Users[participate]) , NULL, 0);
432 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
433 CtdlSubmitMsg(msg, valid, "", 0);
434 free_recipients(valid);
440 void network_process_ignetpush(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
444 const char *Pos = NULL;
445 struct CtdlMessage *msg = NULL;
446 struct CitContext *CCC = CC;
447 struct ser_ret sermsg;
449 char filename[PATH_MAX];
456 if (sc->Users[ignet_push_share] == NULL)
460 * Process IGnet push shares
462 msg = CM_Duplicate(omsg);
464 /* Prepend our node name to the Path field whenever
465 * sending a message to another IGnet node
467 Netmap_AddMe(msg, HKEY("username"));
470 * Determine if this message is set to be deleted
471 * after sending out on the network
473 if (!CM_IsEmpty(msg, eSpecialField)) {
474 if (!strcasecmp(msg->cm_fields[eSpecialField], "CANCEL")) {
475 *delete_after_send = 1;
479 /* Now send it to every node */
480 Recipient = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
481 RemoteRoom = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
482 while ((Pos != StrBufNOTNULL) &&
483 StrBufExtract_NextToken(Recipient, sc->Users[ignet_push_share], &Pos, ','))
485 StrBufExtract_NextToken(RemoteRoom, sc->Users[ignet_push_share], &Pos, ',');
487 NewStrBufDupAppendFlush(&Buf, Recipient, NULL, 1);
489 /* Check for valid node name */
490 if (CtdlIsValidNode(NULL,
493 sc->working_ignetcfg,
494 sc->the_netmap) != 0)
497 "Invalid node <%s>\n",
503 /* Check for split horizon */
504 QN_syslog(LOG_DEBUG, "Path is %s\n", msg->cm_fields[eMessagePath]);
505 bang = num_tokens(msg->cm_fields[eMessagePath], '!');
507 for (i=0; i<(bang-1); ++i) {
509 msg->cm_fields[eMessagePath],
513 QN_syslog(LOG_DEBUG, "Compare <%s> to <%s>\n",
514 buf, ChrPtr(Recipient)) ;
515 if (!strcasecmp(buf, ChrPtr(Recipient))) {
522 " %sSending to %s\n",
527 /* Send the message */
531 * Force the message to appear in the correct
532 * room on the far end by setting the C field
535 if (StrLength(RemoteRoom) > 0) {
536 CM_SetField(msg, eRemoteRoom, SKEY(RemoteRoom));
539 CM_SetField(msg, eRemoteRoom, CCC->room.QRname, strlen(CCC->room.QRname));
542 /* serialize it for transmission */
543 serialize_message(&sermsg, msg);
544 if (sermsg.len > 0) {
546 /* write it to a spool file */
560 fp = fopen(filename, "ab");
573 /* free the serialized version */
579 FreeStrBuf(&Recipient);
580 FreeStrBuf(&RemoteRoom);
586 * Spools out one message from the list.
588 void network_spool_msg(long msgnum,
591 struct CitContext *CCC = CC;
592 struct CtdlMessage *msg = NULL;
593 long delete_after_send = 0; /* Set to 1 to delete after spooling */
596 sc = (SpoolControl *)userdata;
598 msg = CtdlFetchMessage(msgnum, 1);
603 "failed to load Message <%ld> from disk\n",
607 network_process_list(sc, msg, &delete_after_send);
608 network_process_digest(sc, msg, &delete_after_send);
609 network_process_participate(sc, msg, &delete_after_send);
610 network_process_ignetpush(sc, msg, &delete_after_send);
614 /* update lastsent */
615 sc->lastsent = msgnum;
617 /* Delete this message if delete-after-send is set */
618 if (delete_after_send) {
619 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");