2 * This module delivers messages to mailing lists.
4 * Copyright (c) 2002-2021 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
24 #include <sys/types.h>
30 #include <libcitadel.h>
33 #include "citserver.h"
39 #include "internet_addressing.h"
40 #include "clientsocket.h"
41 #include "ctdl_module.h"
43 int doing_listdeliver = 0;
46 // data passed back and forth between listdeliver_do_msg() and listdeliver_sweep_room()
48 long msgnum; // number of most recent message processed
49 char *netconf; // netconfig for this room (contains the recipients)
54 void listdeliver_do_msg(long msgnum, void *userdata) {
55 struct lddata *ld = (struct lddata *) userdata;
63 if (msgnum <= 0) return;
65 struct CtdlMessage *TheMessage = CtdlFetchMessage(msgnum, 1);
66 if (!TheMessage) return;
68 // If the subject line does not contain the name of the room, add it now.
69 if (!bmstrcasestr(TheMessage->cm_fields[eMsgSubject], CC->room.QRname)) {
70 snprintf(buf, sizeof buf, "[%s] %s", CC->room.QRname, TheMessage->cm_fields[eMsgSubject]);
71 CM_SetField(TheMessage, eMsgSubject, buf, strlen(buf));
74 // Reply-to: should be set so that replies come to the list.
75 snprintf(buf, sizeof buf, "room_%s@%s", CC->room.QRname, CtdlGetConfigStr("c_fqdn"));
76 for (ch=buf; *ch; ++ch) {
77 if (isspace(*ch)) *ch = '_';
79 CM_SetField(TheMessage, eReplyTo, buf, strlen(buf));
81 // With that out of the way, let's figure out who this message needs to be sent to.
82 char *recipients = malloc(strlen(ld->netconf));
86 int config_lines = num_tokens(ld->netconf, '\n');
87 for (i=0; i<config_lines; ++i) {
88 extract_token(buf, ld->netconf, i, '\n', sizeof buf);
89 if (!strncasecmp(buf, "listrecp|", 9)) {
90 if (recipients[0] != 0) {
91 strcat(recipients, ",");
93 strcat(recipients, &buf[9]);
95 if (!strncasecmp(buf, "digestrecp|", 11)) {
96 if (recipients[0] != 0) {
97 strcat(recipients, ",");
99 strcat(recipients, &buf[11]);
103 // Where do we want bounces and other noise to be sent? Certainly not to the list members!
104 snprintf(bounce_to, sizeof bounce_to, "room_aide@%s", CtdlGetConfigStr("c_fqdn"));
106 // Now submit the message
107 struct recptypes *valid = validate_recipients(recipients, NULL, 0);
109 valid->bounce_to = strdup(bounce_to);
110 valid->envelope_from = strdup(bounce_to);
111 CtdlSubmitMsg(TheMessage, valid, "");
112 free_recipients(valid);
120 * Sweep through one room looking for mailing list deliveries to do
122 void listdeliver_sweep_room(char *roomname) {
123 char *netconfig = NULL;
124 char *newnetconfig = NULL;
129 int number_of_messages_processed = 0;
130 int number_of_recipients = 0;
133 if (CtdlGetRoom(&CC->room, roomname)) {
134 syslog(LOG_DEBUG, "listdeliver: no room <%s>", roomname);
138 netconfig = LoadRoomNetConfigFile(CC->room.QRnumber);
140 return; // no netconfig, no processing, no problem
143 config_lines = num_tokens(netconfig, '\n');
144 for (i=0; i<config_lines; ++i) {
145 extract_token(buf, netconfig, i, '\n', sizeof buf);
147 if (!strncasecmp(buf, "lastsent|", 9)) {
148 lastsent = atol(&buf[9]);
150 else if ( (!strncasecmp(buf, "listrecp|", 9)) || (!strncasecmp(buf, "digestrecp|", 11)) ) {
151 ++number_of_recipients;
155 if (number_of_recipients > 0) {
156 syslog(LOG_DEBUG, "listdeliver: processing new messages in <%s> for <%d> recipients", CC->room.QRname, number_of_recipients);
157 ld.netconf = netconfig;
158 number_of_messages_processed = CtdlForEachMessage(MSGS_GT, lastsent, NULL, NULL, NULL, listdeliver_do_msg, &ld);
159 syslog(LOG_INFO, "listdeliver: processed <%d> messages in <%s> for <%d> recipients", number_of_messages_processed, CC->room.QRname, number_of_recipients);
161 if (number_of_messages_processed > 0) {
162 syslog(LOG_DEBUG, "listdeliver: new lastsent is %ld", ld.msgnum);
164 // Update this room's netconfig with the updated lastsent
165 begin_critical_section(S_NETCONFIGS);
166 netconfig = LoadRoomNetConfigFile(CC->room.QRnumber);
168 netconfig = strdup("");
171 // The new netconfig begins with the new lastsent directive
172 newnetconfig = malloc(strlen(netconfig) + 1024);
173 sprintf(newnetconfig, "lastsent|%ld\n", ld.msgnum);
175 // And then we append all of the old netconfig, minus the old lastsent. Also omit blank lines.
176 config_lines = num_tokens(netconfig, '\n');
177 for (i=0; i<config_lines; ++i) {
178 extract_token(buf, netconfig, i, '\n', sizeof buf);
179 if ( (!IsEmptyStr(buf)) && (strncasecmp(buf, "lastsent|", 9)) ) {
180 sprintf(&newnetconfig[strlen(newnetconfig)], "%s\n", buf);
184 // Write the new netconfig back to disk
185 SaveRoomNetConfigFile(CC->room.QRnumber, newnetconfig);
186 end_critical_section(S_NETCONFIGS);
187 free(newnetconfig); // this was the new netconfig, free it because we're done with it
190 free(netconfig); // this was the old netconfig, free it even if we didn't do anything
195 * Callback for listdeliver_sweep()
196 * Adds one room to the queue
198 void listdeliver_queue_room(struct ctdlroom *qrbuf, void *data) {
199 Array *roomlistarr = (Array *)data;
200 array_append(roomlistarr, qrbuf->QRname);
205 * Queue up the list of rooms so we can sweep them for mailing list delivery instructions
207 void listdeliver_sweep(void) {
208 static time_t last_run = 0L;
212 * Run mailing list delivery no more frequently than once every 15 minutes (we should make this configurable)
214 if ( (time(NULL) - last_run) < 900 ) {
219 * This is a simple concurrency check to make sure only one listdeliver
220 * run is done at a time. We could do this with a mutex, but since we
221 * don't really require extremely fine granularity here, we'll do it
222 * with a static variable instead.
224 if (doing_listdeliver) return;
225 doing_listdeliver = 1;
228 * Go through each room looking for mailing lists to process
230 syslog(LOG_DEBUG, "listdeliver: sweep started");
232 Array *roomlistarr = array_new(ROOMNAMELEN); // we have to queue them
233 CtdlForEachRoom(listdeliver_queue_room, roomlistarr); // otherwise we get multiple cursors in progress
235 for (i=0; i<array_len(roomlistarr); ++i) {
236 listdeliver_sweep_room((char *)array_get_element_at(roomlistarr, i));
239 array_free(roomlistarr);
240 syslog(LOG_DEBUG, "listdeliver: ended");
241 last_run = time(NULL);
242 doing_listdeliver = 0;
249 CTDL_MODULE_INIT(listdeliver)
252 CtdlRegisterSessionHook(listdeliver_sweep, EVT_TIMER, PRIO_AGGR + 50);
255 /* return our module name for the log */