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 if (sc->num_msgs_spooled < 1) {
189 fclose(sc->digestfp);
194 msg = malloc(sizeof(struct CtdlMessage));
195 memset(msg, 0, sizeof(struct CtdlMessage));
196 msg->cm_magic = CTDLMESSAGE_MAGIC;
197 msg->cm_format_type = FMT_RFC822;
198 msg->cm_anon_type = MES_NORMAL;
200 CM_SetFieldLONG(msg, eTimestamp, time(NULL));
201 CM_SetField(msg, eAuthor, CCC->room.QRname, strlen(CCC->room.QRname));
202 len = snprintf(buf, sizeof buf, "[%s]", CCC->room.QRname);
203 CM_SetField(msg, eMsgSubject, buf, len);
205 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
206 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
208 /* Set the 'List-ID' header */
209 CM_SetField(msg, eListID, SKEY(sc->ListID));
212 * Go fetch the contents of the digest
214 fseek(sc->digestfp, 0L, SEEK_END);
215 msglen = ftell(sc->digestfp);
217 pbuf = malloc(msglen + 1);
218 fseek(sc->digestfp, 0L, SEEK_SET);
219 fread(pbuf, (size_t)msglen, 1, sc->digestfp);
221 CM_SetAsField(msg, eMesageText, &pbuf, msglen);
223 /* Now generate the delivery instructions */
224 if (sc->Users[digestrecp] == NULL)
227 /* Where do we want bounces and other noise to be heard?
228 *Surely not the list members! */
229 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
231 /* Now submit the message */
232 valid = validate_recipients(ChrPtr(sc->Users[digestrecp]), NULL, 0);
234 valid->bounce_to = strdup(bounce_to);
235 valid->envelope_from = strdup(bounce_to);
236 CtdlSubmitMsg(msg, valid, NULL, 0);
239 free_recipients(valid);
243 void network_process_digest(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
246 struct CtdlMessage *msg = NULL;
249 * Process digest recipients
251 if ((sc->Users[digestrecp] == NULL)||
252 (sc->digestfp == NULL))
255 msg = CM_Duplicate(omsg);
257 fprintf(sc->digestfp,
258 " -----------------------------------"
259 "------------------------------------"
261 fprintf(sc->digestfp, "From: ");
262 if (!CM_IsEmpty(msg, eAuthor)) {
263 fprintf(sc->digestfp,
265 msg->cm_fields[eAuthor]);
267 if (!CM_IsEmpty(msg, erFc822Addr)) {
268 fprintf(sc->digestfp,
270 msg->cm_fields[erFc822Addr]);
272 else if (!CM_IsEmpty(msg, eNodeName)) {
273 fprintf(sc->digestfp,
275 msg->cm_fields[eNodeName]);
277 fprintf(sc->digestfp, "\n");
278 if (!CM_IsEmpty(msg, eMsgSubject)) {
279 fprintf(sc->digestfp,
281 msg->cm_fields[eMsgSubject]);
284 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
286 safestrncpy(CC->preferred_formats,
288 sizeof CC->preferred_formats);
290 CtdlOutputPreLoadedMsg(msg,
295 StrBufTrim(CC->redirect_buffer);
296 fwrite(HKEY("\n"), 1, sc->digestfp);
297 fwrite(SKEY(CC->redirect_buffer), 1, sc->digestfp);
298 fwrite(HKEY("\n"), 1, sc->digestfp);
300 FreeStrBuf(&CC->redirect_buffer);
302 sc->num_msgs_spooled += 1;
308 void network_process_list(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
310 struct CtdlMessage *msg = NULL;
313 * Process mailing list recipients
315 if (sc->Users[listrecp] == NULL)
318 /* create our own copy of the message.
319 * We're going to need to modify it
320 * in order to insert the [list name] in it, etc.
323 msg = CM_Duplicate(omsg);
326 CM_SetField(msg, eReplyTo, SKEY(sc->Users[roommailalias]));
328 /* if there is no other recipient, Set the recipient
329 * of the list message to the email address of the
332 if (CM_IsEmpty(msg, eRecipient))
334 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
337 /* Set the 'List-ID' header */
338 CM_SetField(msg, eListID, SKEY(sc->ListID));
341 /* Prepend "[List name]" to the subject */
342 ListCalculateSubject(msg);
344 /* Handle delivery */
345 network_deliver_list(msg, sc, CC->room.QRname);
350 * Deliver list messages to everyone on the list ... efficiently
352 void network_deliver_list(struct CtdlMessage *msg, SpoolControl *sc, const char *RoomName)
357 /* Don't do this if there were no recipients! */
358 if (sc->Users[listrecp] == NULL)
361 /* Now generate the delivery instructions */
363 /* Where do we want bounces and other noise to be heard?
364 * Surely not the list members! */
365 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", config.c_fqdn);
367 /* Now submit the message */
368 valid = validate_recipients(ChrPtr(sc->Users[listrecp]), NULL, 0);
370 valid->bounce_to = strdup(bounce_to);
371 valid->envelope_from = strdup(bounce_to);
372 valid->sending_room = strdup(RoomName);
373 CtdlSubmitMsg(msg, valid, NULL, 0);
374 free_recipients(valid);
376 /* Do not call CM_Free(msg) here; the caller will free it. */
380 void network_process_participate(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
382 struct CtdlMessage *msg = NULL;
383 int ok_to_participate = 0;
388 * Process client-side list participations for this room
390 if (sc->Users[participate] == NULL)
393 msg = CM_Duplicate(omsg);
395 /* Only send messages which originated on our own
396 * Citadel network, otherwise we'll end up sending the
397 * remote mailing list's messages back to it, which
400 ok_to_participate = 0;
401 if (!CM_IsEmpty(msg, eNodeName)) {
402 if (!strcasecmp(msg->cm_fields[eNodeName],
403 config.c_nodename)) {
404 ok_to_participate = 1;
407 Buf = NewStrBufPlain(CM_KEY(msg, eNodeName));
408 if (CtdlIsValidNode(NULL,
411 sc->working_ignetcfg,
412 sc->the_netmap) == 0)
414 ok_to_participate = 1;
417 if (ok_to_participate)
419 /* Replace the Internet email address of the
420 * actual author with the email address of the
421 * room itself, so the remote listserv doesn't
424 CM_SetField(msg, erFc822Addr, SKEY(sc->Users[roommailalias]));
426 valid = validate_recipients(ChrPtr(sc->Users[participate]) , NULL, 0);
428 CM_SetField(msg, eRecipient, SKEY(sc->Users[roommailalias]));
429 CtdlSubmitMsg(msg, valid, "", 0);
430 free_recipients(valid);
436 void network_process_ignetpush(SpoolControl *sc, struct CtdlMessage *omsg, long *delete_after_send)
440 const char *Pos = NULL;
441 struct CtdlMessage *msg = NULL;
442 struct CitContext *CCC = CC;
443 struct ser_ret sermsg;
445 char filename[PATH_MAX];
452 if (sc->Users[ignet_push_share] == NULL)
456 * Process IGnet push shares
458 msg = CM_Duplicate(omsg);
460 /* Prepend our node name to the Path field whenever
461 * sending a message to another IGnet node
463 Netmap_AddMe(msg, HKEY("username"));
466 * Determine if this message is set to be deleted
467 * after sending out on the network
469 if (!CM_IsEmpty(msg, eSpecialField)) {
470 if (!strcasecmp(msg->cm_fields[eSpecialField], "CANCEL")) {
471 *delete_after_send = 1;
475 /* Now send it to every node */
476 Recipient = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
477 RemoteRoom = NewStrBufPlain(NULL, StrLength(sc->Users[ignet_push_share]));
478 while ((Pos != StrBufNOTNULL) &&
479 StrBufExtract_NextToken(Recipient, sc->Users[ignet_push_share], &Pos, ','))
481 StrBufExtract_NextToken(RemoteRoom, sc->Users[ignet_push_share], &Pos, ',');
483 NewStrBufDupAppendFlush(&Buf, Recipient, NULL, 1);
485 /* Check for valid node name */
486 if (CtdlIsValidNode(NULL,
489 sc->working_ignetcfg,
490 sc->the_netmap) != 0)
493 "Invalid node <%s>\n",
499 /* Check for split horizon */
500 QN_syslog(LOG_DEBUG, "Path is %s\n", msg->cm_fields[eMessagePath]);
501 bang = num_tokens(msg->cm_fields[eMessagePath], '!');
503 for (i=0; i<(bang-1); ++i) {
505 msg->cm_fields[eMessagePath],
509 QN_syslog(LOG_DEBUG, "Compare <%s> to <%s>\n",
510 buf, ChrPtr(Recipient)) ;
511 if (!strcasecmp(buf, ChrPtr(Recipient))) {
518 " %sSending to %s\n",
523 /* Send the message */
527 * Force the message to appear in the correct
528 * room on the far end by setting the C field
531 if (StrLength(RemoteRoom) > 0) {
532 CM_SetField(msg, eRemoteRoom, SKEY(RemoteRoom));
535 CM_SetField(msg, eRemoteRoom, CCC->room.QRname, strlen(CCC->room.QRname));
538 /* serialize it for transmission */
539 CtdlSerializeMessage(&sermsg, msg);
540 if (sermsg.len > 0) {
542 /* write it to a spool file */
556 fp = fopen(filename, "ab");
569 /* free the serialized version */
575 FreeStrBuf(&Recipient);
576 FreeStrBuf(&RemoteRoom);
582 * Spools out one message from the list.
584 void network_spool_msg(long msgnum,
587 struct CitContext *CCC = CC;
588 struct CtdlMessage *msg = NULL;
589 long delete_after_send = 0; /* Set to 1 to delete after spooling */
592 sc = (SpoolControl *)userdata;
594 msg = CtdlFetchMessage(msgnum, 1);
599 "failed to load Message <%ld> from disk\n",
603 network_process_list(sc, msg, &delete_after_send);
604 network_process_digest(sc, msg, &delete_after_send);
605 network_process_participate(sc, msg, &delete_after_send);
606 network_process_ignetpush(sc, msg, &delete_after_send);
610 /* update lastsent */
611 sc->lastsent = msgnum;
613 /* Delete this message if delete-after-send is set */
614 if (delete_after_send) {
615 CtdlDeleteMessages(CC->room.QRname, &msgnum, 1, "");