Generate subscription/unsubscription confirmation emails
[citadel.git] / citadel / modules / listsub / serv_listsub.c
index c67582da088de6b3790abfc558b217e06d9a0a09..9cf3fb86c83f9ebf1bb94c8e66eec66771602b2c 100644 (file)
@@ -1,16 +1,17 @@
-/*
- * This module handles self-service subscription/unsubscription to mail lists.
- *
- * Copyright (c) 2002-2016 by the citadel.org team
- *
- * This program is open source software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 3.
- *  
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- */
+//
+// This module handles self-service subscription/unsubscription to mail lists.
+//
+// Copyright (c) 2002-2021 by the citadel.org team
+//
+// This program is open source software.  It runs great on the
+// Linux operating system (and probably elsewhere).  You can use,
+// copy, and run it under the terms of the GNU General Public
+// License version 3.  Richard Stallman is an asshole communist.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
 
 #include "sysdep.h"
 #include <stdlib.h>
 #include "ctdl_module.h"
 
 
+enum {                         // one of these gets passed to do_subscribe_or_unsubscribe() so it knows what we asked for
+       UNSUBSCRIBE,
+       SUBSCRIBE
+};
+
+
+/*
+ * This generates an email with a link the user clicks to confirm a list subscription.
+ */
+void send_subscribe_confirmation_email(char *roomname, char *emailaddr, char *url, char *confirmation_token) {
+       // We need a URL-safe representation of the room name
+       char urlroom[ROOMNAMELEN+10];
+       urlesc(urlroom, sizeof(urlroom), roomname);
 
-// FIXME rewrite the subscribe-o-matic AJC 2021
+       char from_address[1024];
+       snprintf(from_address, sizeof from_address, "noreply@%s", CtdlGetConfigStr("c_fqdn"));
+
+       char emailtext[SIZ];
+       snprintf(emailtext, sizeof emailtext,
+               "MIME-Version: 1.0\n"
+               "Content-Type: multipart/alternative; boundary=\"__ctdlmultipart__\"\n"
+               "\n"
+               "This is a multipart message in MIME format.\n"
+               "\n"
+               "--__ctdlmultipart__\n"
+               "Content-type: text/plain\n"
+               "\n"
+               "Someone (probably you) has submitted a request to subscribe\n"
+               "<%s> to the <%s> mailing list.\n"
+               "\n"
+               "Please go here to confirm this request:\n"
+               "%s?room=%s&token=%s&cmd=confirm\n"
+               "\n"
+               "If this request has been submitted in error and you do not\n"
+               "wish to receive the <%s> mailing list, simply do nothing,\n"
+               "and you will not receive any further mailings.\n"
+               "\n"
+               "--__ctdlmultipart__\n"
+               "Content-type: text/html\n"
+               "\n"
+               "<html><body><p>Someone (probably you) has submitted a request to subscribe "
+               "<strong>%s</strong> to the <strong>%s</strong> mailing list.</p>"
+               "<p>Please go here to confirm this request:</p>"
+               "<p><a href=\"%s?room=%s&token=%s&cmd=confirm\">"
+               "%s?room=%s&token=%s&cmd=confirm</a></p>"
+               "<p>If this request has been submitted in error and you do not "
+               "wish to receive the <strong>%s<strong> mailing list, simply do nothing, "
+               "and you will not receive any further mailings.</p>"
+               "</body></html>\n"
+               "\n"
+               "--__ctdlmultipart__--\n"
+               ,
+               emailaddr, roomname, url, urlroom, confirmation_token, roomname,
+               emailaddr, roomname,
+               url, urlroom, confirmation_token,
+               url, urlroom, confirmation_token,
+               roomname
+       );
+
+       quickie_message("Citadel", from_address, emailaddr, NULL, emailtext, FMT_RFC822, "Please confirm your list subscription");
+}
+
+
+/*
+ * This generates an email with a link the user clicks to confirm a list unsubscription.
+ */
+void send_unsubscribe_confirmation_email(char *roomname, char *emailaddr, char *url, char *confirmation_token) {
+       // We need a URL-safe representation of the room name
+       char urlroom[ROOMNAMELEN+10];
+       urlesc(urlroom, sizeof(urlroom), roomname);
+
+       char from_address[1024];
+       snprintf(from_address, sizeof from_address, "noreply@%s", CtdlGetConfigStr("c_fqdn"));
+
+       char emailtext[SIZ];
+       snprintf(emailtext, sizeof emailtext,
+               "MIME-Version: 1.0\n"
+               "Content-Type: multipart/alternative; boundary=\"__ctdlmultipart__\"\n"
+               "\n"
+               "This is a multipart message in MIME format.\n"
+               "\n"
+               "--__ctdlmultipart__\n"
+               "Content-type: text/plain\n"
+               "\n"
+               "Someone (probably you) has submitted a request to unsubscribe\n"
+               "<%s> from the <%s> mailing list.\n"
+               "\n"
+               "Please go here to confirm this request:\n"
+               "%s?room=%s&token=%s&cmd=confirm\n"
+               "\n"
+               "If this request has been submitted in error and you still\n"
+               "wish to receive the <%s> mailing list, simply do nothing,\n"
+               "and you will remain subscribed.\n"
+               "\n"
+               "--__ctdlmultipart__\n"
+               "Content-type: text/html\n"
+               "\n"
+               "<html><body><p>Someone (probably you) has submitted a request to unsubscribe "
+               "<strong>%s</strong> from the <strong>%s</strong> mailing list.</p>"
+               "<p>Please go here to confirm this request:</p>"
+               "<p><a href=\"%s?room=%s&token=%s&cmd=confirm\">"
+               "%s?room=%s&token=%s&cmd=confirm</a></p>"
+               "<p>If this request has been submitted in error and you still "
+               "wish to receive the <strong>%s<strong> mailing list, simply do nothing, "
+               "and you will remain subscribed.</p>"
+               "</body></html>\n"
+               "\n"
+               "--__ctdlmultipart__--\n"
+               ,
+               emailaddr, roomname, url, urlroom, confirmation_token, roomname,
+               emailaddr, roomname,
+               url, urlroom, confirmation_token,
+               url, urlroom, confirmation_token,
+               roomname
+       );
+
+       quickie_message("Citadel", from_address, emailaddr, NULL, emailtext, FMT_RFC822, "Please confirm your list subscription");
+}
+
+
+/*
+ * "Subscribe" and "Unsubscribe" operations are so similar that they share a function.
+ * The actual subscription doesn't take place here -- we just send out the confirmation request
+ * and record the address and confirmation token.
+ */
+void do_subscribe_or_unsubscribe(int action, char *emailaddr, char *url) {
+
+       int i;
+       char buf[1024];
+       char confirmation_token[40];
+
+       // Update this room's netconfig with the updated lastsent
+       begin_critical_section(S_NETCONFIGS);
+        char *oldnetconfig = LoadRoomNetConfigFile(CC->room.QRnumber);
+        if (!oldnetconfig) {
+               oldnetconfig = strdup("");
+       }
+
+       // The new netconfig begins with an empty buffer...
+       char *newnetconfig = malloc(strlen(oldnetconfig) + 1024);
+       newnetconfig[0] = 0;
+
+       // And then we...
+       int is_already_subscribed = 0;
+       int config_lines = num_tokens(oldnetconfig, '\n');
+       for (i=0; i<config_lines; ++i) {
+               extract_token(buf, oldnetconfig, i, '\n', sizeof buf);
+               int keep_this_line =1;                                          // set to nonzero if we are discarding a line
+
+               if (IsEmptyStr(buf)) {
+                       keep_this_line = 0;
+               }
+
+               char buf_token[1024];
+               char buf_email[1024];
+               extract_token(buf_token, buf, 0, '|', sizeof buf_token);
+               extract_token(buf_email, buf, 1, '|', sizeof buf_email);
+
+               if (    ( (!strcasecmp(buf_token, "listrecp")) || (!strcasecmp(buf_token, "digestrecp")) )
+                       && (!strcasecmp(buf_email, emailaddr)) 
+               ) {
+                       is_already_subscribed = 1;
+               }
+
+               if ( (!strcasecmp(buf_token, "subpending")) || (!strcasecmp(buf_token, "unsubpending")) ) {
+                       time_t pendingtime = extract_long(buf, 3);
+                       if ((time(NULL) - pendingtime) > 259200) {
+                               syslog(LOG_DEBUG, "%s %s is %ld seconds old - deleting it", buf_email, buf_token, time(NULL) - pendingtime);
+                               keep_this_line = 0;
+                       }
+               }
+               
+               if (keep_this_line) {
+                       sprintf(&newnetconfig[strlen(newnetconfig)], "%s\n", buf);
+               }
+       }
+
+       // Do we need to send out a confirmation email?
+       if ((action == SUBSCRIBE) && (!is_already_subscribed)) {
+               generate_uuid(confirmation_token);
+               sprintf(&newnetconfig[strlen(newnetconfig)], "subpending|%s|%s|%ld|%s", emailaddr, confirmation_token, time(NULL), url);
+               send_subscribe_confirmation_email(CC->room.QRname, emailaddr, url, confirmation_token);
+       }
+       if ((action == UNSUBSCRIBE) && (is_already_subscribed)) {
+               generate_uuid(confirmation_token);
+               sprintf(&newnetconfig[strlen(newnetconfig)], "unsubpending|%s|%s|%ld|%s", emailaddr, confirmation_token, time(NULL), url);
+               send_unsubscribe_confirmation_email(CC->room.QRname, emailaddr, url, confirmation_token);
+       }
+
+       // Write the new netconfig back to disk
+       syslog(LOG_DEBUG, "old: <\033[31m%s\033[0m>", oldnetconfig);
+       syslog(LOG_DEBUG, "new: <\033[32m%s\033[0m>", newnetconfig);
+       SaveRoomNetConfigFile(CC->room.QRnumber, newnetconfig);
+       end_critical_section(S_NETCONFIGS);
+       free(newnetconfig);                     // this was the new netconfig, free it because we're done with it
+       free(oldnetconfig);                     // this was the old netconfig, free it even if we didn't do anything
+
+       // Tell the client what happened.
+       if ((action == SUBSCRIBE) && (is_already_subscribed)) {
+               cprintf("%d This email is already subscribed.\n", ERROR + ALREADY_EXISTS);
+       }
+       else if ((action == SUBSCRIBE) && (!is_already_subscribed)) {
+               cprintf("%d Confirmation email sent.\n", CIT_OK);
+       }
+       else if ((action == UNSUBSCRIBE) && (!is_already_subscribed)) {
+               cprintf("%d This email is not subscribed.\n", ERROR + NO_SUCH_USER);
+       }
+       else if ((action == UNSUBSCRIBE) && (is_already_subscribed)) {
+               cprintf("%d Confirmation email sent.\n", CIT_OK);
+       }
+       else {
+               cprintf("%d FIXME tell the client what we did\n", ERROR);
+       }
+}
 
 
 /* 
  * process subscribe/unsubscribe requests and confirmations
  */
-void cmd_subs(char *cmdbuf)
-{
-       cprintf("%d Invalid command\n", ERROR + ILLEGAL_VALUE);
+void cmd_subs(char *cmdbuf) {
+       char cmd[20];
+       char roomname[ROOMNAMELEN];
+       char emailaddr[1024];
+       char options[256];
+       char url[1024];
+       char token[128];
+
+       extract_token(cmd, cmdbuf, 0, '|', sizeof cmd);                         // token 0 is the sub-command being sent
+       extract_token(roomname, cmdbuf, 1, '|', sizeof roomname);               // token 1 is always a room name
+
+       // First confirm that the caller is referencing a room that actually exists.
+       if (CtdlGetRoom(&CC->room, roomname) != 0) {
+               cprintf("%d There is no list called '%s'\n", ERROR + ROOM_NOT_FOUND, roomname);
+               return;
+       }
+
+       if ((CC->room.QRflags2 & QR2_SELFLIST) == 0) {
+               cprintf("%d '%s' does not accept subscribe/unsubscribe requests.\n", ERROR + ROOM_NOT_FOUND, roomname);
+               return;
+       }
+
+       // Room confirmed, now parse the command.
+
+       if (!strcasecmp(cmd, "subscribe")) {
+               extract_token(emailaddr, cmdbuf, 2, '|', sizeof emailaddr);     // token 2 is the subscriber's email address
+               extract_token(options, cmdbuf, 3, '|', sizeof options);         // there are no options ... ignore this token
+               extract_token(url, cmdbuf, 4, '|', sizeof url);                 // token 3 is the URL at which we subscribed
+               do_subscribe_or_unsubscribe(SUBSCRIBE, emailaddr, url);
+       }
+
+       else if (!strcasecmp(cmd, "unsubscribe")) {
+               extract_token(emailaddr, cmdbuf, 2, '|', sizeof emailaddr);     // token 2 is the subscriber's email address
+               extract_token(options, cmdbuf, 3, '|', sizeof options);         // there are no options ... ignore this token
+               extract_token(url, cmdbuf, 4, '|', sizeof url);                 // token 3 is the URL at which we subscribed
+               do_subscribe_or_unsubscribe(UNSUBSCRIBE, emailaddr, url);
+       }
+
+       else if (!strcasecmp(cmd, "confirm")) {
+               extract_token(token, cmdbuf, 2, '|', sizeof token);             // token 2 is the confirmation token
+               cprintf("%d not implemented\n", ERROR);
+       }
+
+       else {                                                                  // sorry man, I can't deal with that
+               cprintf("%d Invalid command '%s'\n", ERROR + ILLEGAL_VALUE, cmd);
+       }
 }