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 void network_deliver_list(struct CtdlMessage *msg, SpoolControl *sc, const char *RoomName);
84 void aggregate_recipients(StrBuf **recps, RoomNetCfg Which, OneRoomNetCfg *OneRNCfg, long nSegments)
89 struct CitContext *CCC = CC;
93 * Figure out how big a buffer we need to allocate
95 for (nptr = OneRNCfg->NetConfigs[Which]; nptr != NULL; nptr = nptr->next) {
96 recps_len = recps_len + StrLength(nptr->Value[0]) + 2;
103 *recps = NewStrBufPlain(NULL, recps_len);
105 if (*recps == NULL) {
107 "Cannot allocate %ld bytes for recps...\n",
113 for (nptr = OneRNCfg->NetConfigs[Which]; nptr != NULL; nptr = nptr->next) {
114 if (nptr != OneRNCfg->NetConfigs[Which]) {
115 for (i = 0; i < nSegments; i++)
116 StrBufAppendBufPlain(*recps, HKEY(","), i);
118 StrBufAppendBuf(*recps, nptr->Value[0], 0);
119 if (Which == ignet_push_share)
121 StrBufAppendBufPlain(*recps, HKEY(","), 0);
122 StrBufAppendBuf(*recps, nptr->Value[1], 0);
128 static void ListCalculateSubject(struct CtdlMessage *msg)
130 struct CitContext *CCC = CC;
131 StrBuf *Subject, *FlatSubject;
135 if (CM_IsEmpty(msg, eMsgSubject)) {
136 Subject = NewStrBufPlain(HKEY("(no subject)"));
139 Subject = NewStrBufPlain(CM_KEY(msg, eMsgSubject));
141 FlatSubject = NewStrBufPlain(NULL, StrLength(Subject));
142 StrBuf_RFC822_to_Utf8(FlatSubject, Subject, NULL, NULL);
144 rlen = strlen(CCC->room.QRname);
145 pCh = strstr(ChrPtr(FlatSubject), CCC->room.QRname);
147 (*(pCh + rlen) != ']') ||
148 (pCh == ChrPtr(FlatSubject)) ||
153 StrBufPlain(Subject, HKEY("["));
154 StrBufAppendBufPlain(Subject,
157 StrBufAppendBufPlain(Subject, HKEY("] "), 0);
158 StrBufAppendBuf(Subject, FlatSubject, 0);
159 /* so we can free the right one swap them */
161 Subject = FlatSubject;
163 StrBufRFC2047encode(&Subject, FlatSubject);
166 CM_SetAsFieldSB(msg, eMsgSubject, &Subject);
168 FreeStrBuf(&FlatSubject);
172 * Deliver digest messages
174 void network_deliver_digest(SpoolControl *sc)
176 struct CitContext *CCC = CC;
180 struct CtdlMessage *msg = NULL;
185 if (sc->Users[digestrecp] == NULL)
188 msg = malloc(sizeof(struct CtdlMessage));
189 memset(msg, 0, sizeof(struct CtdlMessage));
190 msg->cm_magic = CTDLMESSAGE_MAGIC;
191 msg->cm_format_type = FMT_RFC822;
192 msg->cm_anon_type = MES_NORMAL;
194 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
195 CM_SetField(msg, eAuthor, CCC->room.QRname, strlen(CCC->room.QRname));
196 len = snprintf(buf, sizeof buf, "[%s]", CCC->room.QRname);
197 CM_SetField(msg, eMsgSubject, buf, len);
199 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
200 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
202 /* Set the 'List-ID' header */
203 CM_SetField(msg, eListID, SKEY(sc->ListID));
206 * Go fetch the contents of the digest
208 fseek(sc->digestfp, 0L, SEEK_END);
209 msglen = ftell(sc->digestfp);
211 pbuf = malloc(msglen + 1);
212 fseek(sc->digestfp, 0L, SEEK_SET);
213 fread(pbuf, (size_t)msglen, 1, sc->digestfp);
215 CM_SetAsField(msg, eMesageText, &pbuf, msglen);
217 /* Now generate the delivery instructions */
219 /* Where do we want bounces and other noise to be heard?
220 * Surely not the list members! */
221 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
223 /* Now submit the message */
224 valid = validate_recipients(ChrPtr(sc->Users[digestrecp]), NULL, 0);
226 valid->bounce_to = strdup(bounce_to);
227 valid->envelope_from = strdup(bounce_to);
228 CtdlSubmitMsg(msg, valid, NULL, 0);
231 free_recipients(valid);
235 void network_process_digest(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
238 struct CtdlMessage *msg = NULL;
241 * Process digest recipients
243 if ((sc->Users[digestrecp] == NULL)||
244 (sc->digestfp == NULL))
247 msg = CM_Duplicate(omsg);
250 fprintf(sc->digestfp,
251 " -----------------------------------"
252 "------------------------------------"
254 fprintf(sc->digestfp, "From: ");
255 if (!CM_IsEmpty(msg, eAuthor)) {
256 fprintf(sc->digestfp,
258 msg->cm_fields[eAuthor]);
260 if (!CM_IsEmpty(msg, erFc822Addr)) {
261 fprintf(sc->digestfp,
263 msg->cm_fields[erFc822Addr]);
265 else if (!CM_IsEmpty(msg, eNodeName)) {
266 fprintf(sc->digestfp,
268 msg->cm_fields[eNodeName]);
270 fprintf(sc->digestfp, "\n");
271 if (!CM_IsEmpty(msg, eMsgSubject)) {
272 fprintf(sc->digestfp,
274 msg->cm_fields[eMsgSubject]);
277 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
279 safestrncpy(CC->preferred_formats,
281 sizeof CC->preferred_formats);
283 CtdlOutputPreLoadedMsg(msg,
288 StrBufTrim(CC->redirect_buffer);
289 fwrite(HKEY("\n"), 1, sc->digestfp);
290 fwrite(SKEY(CC->redirect_buffer), 1, sc->digestfp);
291 fwrite(HKEY("\n"), 1, sc->digestfp);
293 FreeStrBuf(&CC->redirect_buffer);
295 sc->num_msgs_spooled += 1;
301 void network_process_list(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
303 struct CtdlMessage *msg = NULL;
306 * Process mailing list recipients
308 if (sc->Users[listrecp] == NULL)
311 /* create our own copy of the message.
312 * We're going to need to modify it
313 * in order to insert the [list name] in it, etc.
316 msg = CM_Duplicate(omsg);
319 CM_SetField(msg, eReplyTo, SKEY(sc->Users[roommailalias]));
321 /* if there is no other recipient, Set the recipient
322 * of the list message to the email address of the
325 if (CM_IsEmpty(msg, eRecipient))
327 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
330 /* Set the 'List-ID' header */
331 CM_SetField(msg, eListID, SKEY(sc->ListID));
334 /* Prepend "[List name]" to the subject */
335 ListCalculateSubject(msg);
337 /* Handle delivery */
338 network_deliver_list(msg, sc, CC->room.QRname);
343 * Deliver list messages to everyone on the list ... efficiently
345 void network_deliver_list(struct CtdlMessage *msg, SpoolControl *sc, const char *RoomName)
350 /* Don't do this if there were no recipients! */
351 if (sc->Users[listrecp] == NULL)
354 /* Now generate the delivery instructions */
356 /* Where do we want bounces and other noise to be heard?
357 * Surely not the list members! */
358 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
360 /* Now submit the message */
361 valid = validate_recipients(ChrPtr(sc->Users[listrecp]), NULL, 0);
363 valid->bounce_to = strdup(bounce_to);
364 valid->envelope_from = strdup(bounce_to);
365 valid->sending_room = strdup(RoomName);
366 CtdlSubmitMsg(msg, valid, NULL, 0);
367 free_recipients(valid);
369 /* Do not call CM_Free(msg) here; the caller will free it. */
373 void network_process_participate(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
375 struct CtdlMessage *msg = NULL;
376 int ok_to_participate = 0;
381 * Process client-side list participations for this room
383 if (sc->Users[participate] == NULL)
386 msg = CM_Duplicate(omsg);
388 /* Only send messages which originated on our own
389 * Citadel network, otherwise we'll end up sending the
390 * remote mailing list's messages back to it, which
393 ok_to_participate = 0;
394 if (!CM_IsEmpty(msg, eNodeName)) {
395 if (!strcasecmp(msg->cm_fields[eNodeName],
396 config.c_nodename)) {
397 ok_to_participate = 1;
400 Buf = NewStrBufPlain(CM_KEY(msg, eNodeName));
401 if (CtdlIsValidNode(NULL,
404 sc->working_ignetcfg,
405 sc->the_netmap) == 0)
407 ok_to_participate = 1;
410 if (ok_to_participate)
412 /* Replace the Internet email address of the
413 * actual author with the email address of the
414 * room itself, so the remote listserv doesn't
417 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
419 valid = validate_recipients(ChrPtr(sc->Users[participate]) , NULL, 0);
421 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
422 CtdlSubmitMsg(msg, valid, "", 0);
423 free_recipients(valid);
429 void network_process_ignetpush(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
433 const char *Pos = NULL;
434 struct CtdlMessage *msg = NULL;
435 struct CitContext *CCC = CC;
436 struct ser_ret sermsg;
438 char filename[PATH_MAX];
445 if (sc->Users[ignet_push_share] == NULL)
449 * Process IGnet push shares
451 msg = CM_Duplicate(omsg);
453 /* Prepend our node name to the Path field whenever
454 * sending a message to another IGnet node
456 Netmap_AddMe(msg, HKEY("username"));
459 * Determine if this message is set to be deleted
460 * after sending out on the network
462 if (!CM_IsEmpty(msg, eSpecialField)) {
463 if (!strcasecmp(msg->cm_fields[eSpecialField], "CANCEL")) {
464 *delete_after_send = 1;
468 /* Now send it to every node */
469 Recipient = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
470 RemoteRoom = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
471 while ((Pos != StrBufNOTNULL) &&
472 StrBufExtract_NextToken(Recipient, sc->Users[ignet_push_share], &Pos, ','))
474 StrBufExtract_NextToken(RemoteRoom, sc->Users[ignet_push_share], &Pos, ',');
476 NewStrBufDupAppendFlush(&Buf, Recipient, NULL, 1);
478 /* Check for valid node name */
479 if (CtdlIsValidNode(NULL,
482 sc->working_ignetcfg,
483 sc->the_netmap) != 0)
486 "Invalid node <%s>\n",
492 /* Check for split horizon */
493 QN_syslog(LOG_DEBUG, "Path is %s\n", msg->cm_fields[eMessagePath]);
494 bang = num_tokens(msg->cm_fields[eMessagePath], '!');
496 for (i=0; i<(bang-1); ++i) {
498 msg->cm_fields[eMessagePath],
502 QN_syslog(LOG_DEBUG, "Compare <%s> to <%s>\n",
503 buf, ChrPtr(Recipient)) ;
504 if (!strcasecmp(buf, ChrPtr(Recipient))) {
511 " %sSending to %s\n",
516 /* Send the message */
520 * Force the message to appear in the correct
521 * room on the far end by setting the C field
524 if (StrLength(RemoteRoom) > 0) {
525 CM_SetField(msg, eRemoteRoom, SKEY(RemoteRoom));
528 CM_SetField(msg, eRemoteRoom, CCC->room.QRname, strlen(CCC->room.QRname));
531 /* serialize it for transmission */
532 CtdlSerializeMessage(&sermsg, msg);
533 if (sermsg.len > 0) {
535 /* write it to a spool file */
549 fp = fopen(filename, "ab");
562 /* free the serialized version */
568 FreeStrBuf(&Recipient);
569 FreeStrBuf(&RemoteRoom);
575 * Spools out one message from the list.
577 void network_spool_msg(long msgnum,
580 struct CitContext *CCC = CC;
581 struct CtdlMessage *msg = NULL;
582 long delete_after_send = 0; /* Set to 1 to delete after spooling */
585 sc = (SpoolControl *)userdata;
587 msg = CtdlFetchMessage(msgnum, 1);
592 "failed to load Message <%ld> from disk\n",
596 network_process_list(sc, msg, &delete_after_send);
597 network_process_digest(sc, msg, &delete_after_send);
598 network_process_participate(sc, msg, &delete_after_send);
599 network_process_ignetpush(sc, msg, &delete_after_send);
603 /* update lastsent */
604 sc->lastsent = msgnum;
606 /* Delete this message if delete-after-send is set */
607 if (delete_after_send) {
608 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");