/*
** Copyright (c) 2007 D. Richard Hipp
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the Simplified BSD License (also
** known as the "2-Clause License" or "FreeBSD License".)
**
** 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.
**
** Author contact information:
** drh@hwaci.com
** http://www.hwaci.com/drh/
**
*******************************************************************************
**
** Email notification features
*/
#include "config.h"
#include "email.h"
#include <assert.h>
/*
** Maximum size of the subscriberCode blob, in bytes
*/
#define SUBSCRIBER_CODE_SZ 32
/*
** SQL code to implement the tables needed by the email notification
** system.
*/
static const char zEmailInit[] =
@ -- Subscribers are distinct from users. A person can have a log-in in
@ -- the USER table without being a subscriber. Or a person can be a
@ -- subscriber without having a USER table entry. Or they can have both.
@ -- In the last case the suname column points from the subscriber entry
@ -- to the USER entry.
@ --
@ -- The ssub field is a string where each character indicates a particular
@ -- type of event to subscribe to. Choices:
@ -- a - Announcements
@ -- c - Check-ins
@ -- t - Ticket changes
@ -- w - Wiki changes
@ -- Probably different codes will be added in the future. In the future
@ -- we might also add a separate table that allows subscribing to email
@ -- notifications for specific branches or tags or tickets.
@ --
@ CREATE TABLE repository.subscriber(
@ subscriberId INTEGER PRIMARY KEY, -- numeric subscriber ID. Internal use
@ subscriberCode BLOB UNIQUE, -- UUID for subscriber. External use
@ semail TEXT UNIQUE COLLATE nocase,-- email address
@ suname TEXT, -- corresponding USER entry
@ sverified BOOLEAN, -- email address verified
@ sdonotcall BOOLEAN, -- true for Do Not Call
@ sdigest BOOLEAN, -- true for daily digests only
@ ssub TEXT, -- baseline subscriptions
@ sctime DATE, -- When this entry was created. JulianDay
@ smtime DATE, -- Last change. JulianDay
@ smip TEXT -- IP address of last change
@ );
@ CREATE INDEX repository.subscriberUname
@ ON subscriber(suname) WHERE suname IS NOT NULL;
@
@ -- Email notifications that need to be sent.
@ --
@ -- The first character of the eventid determines the event type.
@ -- Remaining characters determine the specific event. For example,
@ -- 'c4413' means check-in with rid=4413.
@ --
@ CREATE TABLE repository.pending_alert(
@ eventid TEXT PRIMARY KEY, -- Object that changed
@ sentSep BOOLEAN DEFAULT false, -- individual emails sent
@ mtime DATETIME -- when added to queue
@ ) WITHOUT ROWID;
@
@ -- Record bounced emails. If too many bounces are received within
@ -- some defined time range, then cancel the subscription. Older
@ -- entries are periodically purged.
@ --
@ CREATE TABLE repository.email_bounce(
@ subscriberId INTEGER, -- to whom the email was sent.
@ sendTime INTEGER, -- seconds since 1970 when email was sent
@ rcvdTime INTEGER -- seconds since 1970 when bounce was received
@ );
;
/*
** Make sure the unversioned table exists in the repository.
*/
void email_schema(void){
if( !db_table_exists("repository", "subscriber") ){
db_multi_exec(zEmailInit/*works-like:""*/);
email_triggers_enable();
}
}
/*
** Enable triggers that automatically populate the event_pending
** table.
*/
void email_triggers_enable(void){
if( !db_table_exists("repository","pending_alert") ) return;
db_multi_exec(
"CREATE TRIGGER IF NOT EXISTS repository.email_trigger1\n"
"AFTER INSERT ON event BEGIN\n"
" INSERT INTO pending_alert(eventid,mtime)\n"
" SELECT printf('%%.1c%%d',new.type,new.objid),"
" julianday('now') WHERE true\n"
" ON CONFLICT(eventId) DO NOTHING;\n"
"END;"
);
}
/*
** Disable triggers the event_pending triggers.
**
** This must be called before rebuilding the EVENT table, for example
** via the "fossil rebuild" command.
*/
void email_triggers_disable(void){
db_multi_exec(
"DROP TRIGGER IF EXISTS repository.email_trigger1;\n"
);
}
/*
** Return true if email alerts are active.
*/
int email_enabled(void){
if( !db_table_exists("repository", "subscriber") ) return 0;
if( fossil_strcmp(db_get("email-send-method","off"),"off")==0 ) return 0;
return 1;
}
/*
** Insert a "Subscriber List" submenu link if the current user
** is an administrator.
*/
void email_subscriber_list_link(void){
if( g.perm.Admin ){
style_submenu_element("Subscriber List","%R/subscribers");
}
}
/*
** WEBPAGE: setup_email
**
** Administrative page for configuring and controlling email notification
*/
void setup_email(void){
static const char *const azSendMethods[] = {
"off", "Disabled",
"pipe", "Pipe to a command",
"db", "Store in a database",
"dir", "Store in a directory"
};
login_check_credentials();
if( !g.perm.Setup ){
login_needed(0);
return;
}
db_begin_transaction();
email_subscriber_list_link();
style_header("Email Notification Setup");
@ <form action="%R/setup_email" method="post"><div>
@ <input type="submit" name="submit" value="Apply Changes" /><hr>
login_insert_csrf_secret();
entry_attribute("Canonical Server URL", 40, "email-url",
"eurl", "", 0);
@ <p><b>Required.</b>
@ This is URL used as the basename for hyperlinks included in
@ email alert text. Omit the trailing "/".
@ Suggested value: "%h(g.zBaseURL)"
@ (Property: "email-url")</p>
@ <hr>
entry_attribute("\"From\" email address", 20, "email-self",
"eself", "", 0);
@ <p><b>Required.</b>
@ This is the email from which email notifications are sent. The
@ system administrator should arrange for emails sent to this address
@ to be handed off to the "fossil email incoming" command so that Fossil
@ can handle bounces. (Property: "email-self")</p>
@ <hr>
entry_attribute("Repository Nickname", 16, "email-subname",
"enn", "", 0);
@ <p><b>Required.</b>
@ This is short name used to identifies the repository in the
@ Subject: line of email alerts. Traditionally this name is
@ included in square brackets. Examples: "[fossil-src]", "[sqlite-src]".
@ (Property: "email-subname")</p>
@ <hr>
multiple_choice_attribute("Email Send Method", "email-send-method", "esm",
"off", count(azSendMethods)/2, azSendMethods);
@ <p>How to send email. The "Pipe to a command"
@ method is the usual choice in production.
@ (Property: "email-send-method")</p>
@ <hr>
entry_attribute("Command To Pipe Email To", 80, "email-send-command",
"ecmd", "sendmail -t", 0);
@ <p>When the send method is "pipe to a command", this is the command
@ that is run. Email messages are piped into the standard input of this
@ command. The command is expected to extract the sender address,
@ recepient addresses, and subject from the header of the piped email
@ text. (Property: "email-send-command")</p>
entry_attribute("Database In Which To Store Email", 60, "email-send-db",
"esdb", "", 0);
@ <p>When the send method is "store in a databaes", each email message is
@ stored in an SQLite database file with the name given here.
@ (Property: "email-send-db")</p>
entry_attribute("Directory In Which To Store Email", 60, "email-send-dir",
"esdir", "", 0);
@ <p>When the send method is "store in a directory", each email message is
@ stored as a separate file in the directory shown here.
@ (Property: "email-send-dir")</p>
@ <hr>
entry_attribute("Administrator email address", 40, "email-admin",
"eadmin", "", 0);
@ <p>This is the email for the human administrator for the system.
@ Abuse and trouble reports are send here.
@ (Property: "email-admin")</p>
@ <hr>
entry_attribute("Inbound email directory", 40, "email-receive-dir",
"erdir", "", 0);
@ <p>Inbound emails can be stored in a directory for analysis as
@ a debugging aid. Put the name of that directory in this entry box.
@ Disable saving of inbound email by making this an empty string.
@ Abuse and trouble reports are send here.
@ (Property: "email-receive-dir")</p>
@ <hr>
@ <p><input type="submit" name="submit" value="Apply Changes" /></p>
@ </div></form>
db_end_transaction(0);
style_footer();
}
/*
** Encode pMsg as MIME base64 and append it to pOut
*/
static void append_base64(Blob *pOut, Blob *pMsg){
int n, i, k;
char zBuf[100];
n = blob_size(pMsg);
for(i=0; i<n; i+=54){
k = translateBase64(blob_buffer(pMsg)+i, i+54<n ? 54 : n-i, zBuf);
blob_append(pOut, zBuf, k);
blob_append(pOut, "\r\n", 2);
}
}
/*
** Come up with a unique filename in the zDir directory.
**
** Space to hold the filename is obtained from mprintf() and must
** be freed using fossil_free() by the caller.
*/
static char *emailTempFilename(const char *zDir){
char *zFile = db_text(0,
"SELECT %Q||strftime('/%%Y%%m%%d%%H%%M%%S-','now')||hex(randomblob(8))",
zDir);
return zFile;
}
#if defined(_WIN32) || defined(WIN32)
# undef popen
# define popen _popen
# undef pclose
# define pclose _pclose
#endif
/*
** Send an email message using whatever sending mechanism is configured
** by these settings:
**
** email-send-method "off" Do not send any emails
** "pipe" Pipe the email to email-send-command
** "db" Store the mail in database email-send-db
** "file" Store the email as a file in email-send-dir
**
** The recepient(s) must be specified using "To:" or "Cc:" or "Bcc:" fields
** in the header. Likewise, the header must contains a "Subject:" line.
** The header might also include fields like "Message-Id:" or
** "In-Reply-To:".
**
** This routine will add fields to the header as follows:
**
** From:
** Content-Type:
** Content-Transfer-Encoding:
**
** At least one body must be supplied.
**
** The caller maintains ownership of the input Blobs. This routine will
** read the Blobs and send them onward to the email system, but it will
** not free them.
**
** If zDest is not NULL then it is an overwrite for the email-send-method.
** zDest can be "stdout" to send output to the console for debugging.
*/
void email_send(Blob *pHdr, Blob *pPlain, Blob *pHtml, const char *zDest){
const char *zFrom = db_get("email-self", 0);
char *zBoundary = 0;
Blob all;
if( zFrom==0 ){
fossil_warning("Missing configuration: \"email-self\"");
return;
}
if( zDest==0 ) zDest = db_get("email-send-method", "off");
if( strcmp(zDest, "off")==0 ){
return;
}
blob_init(&all, 0, 0);
blob_append(&all, blob_buffer(pHdr), blob_size(pHdr));
blob_appendf(&all, "From: %s\r\n", zFrom);
if( pPlain && pHtml ){
blob_appendf(&all, "MIME-Version: 1.0\r\n");
zBoundary = db_text(0, "SELECT hex(randomblob(20))");
blob_appendf(&all, "Content-Type: multipart/alternative;"
" boundary=\"%s\"\r\n", zBoundary);
}
if( pPlain ){
blob_add_final_newline(pPlain);
if( zBoundary ){
blob_appendf(&all, "\r\n--%s\r\n", zBoundary);
}
blob_appendf(&all,"Content-Type: text/plain\r\n");
blob_appendf(&all, "Content-Transfer-Encoding: base64\r\n\r\n");
append_base64(&all, pPlain);
}
if( pHtml ){
blob_add_final_newline(pHtml);
if( zBoundary ){
blob_appendf(&all, "--%s\r\n", zBoundary);
}
blob_appendf(&all,"Content-Type: text/html\r\n");
blob_appendf(&all, "Content-Transfer-Encoding: base64\r\n\r\n");
append_base64(&all, pHtml);
}
if( zBoundary ){
blob_appendf(&all, "--%s--\r\n", zBoundary);
fossil_free(zBoundary);
zBoundary = 0;
}
if( strcmp(zDest, "db")==0 ){
sqlite3 *db;
sqlite3_stmt *pStmt;
int rc;
const char *zDb = db_get("email-send-db",0);
rc = sqlite3_open(zDb, &db);
if( rc==SQLITE_OK ){
sqlite3_exec(db, "CREATE TABLE IF NOT EXISTS email(\n"
" emailid INTEGER PRIMARY KEY,\n"
" msg TEXT\n);", 0, 0, 0);
rc = sqlite3_prepare_v2(db, "INSERT INTO email(msg) VALUES(?1)", -1,
&pStmt, 0);
if( rc==SQLITE_OK ){
sqlite3_bind_text(pStmt, 1, blob_str(&all), -1, SQLITE_TRANSIENT);
sqlite3_step(pStmt);
sqlite3_finalize(pStmt);
}
sqlite3_close(db);
}
}else if( strcmp(zDest, "pipe")==0 ){
const char *zCmd = db_get("email-send-command", 0);
if( zCmd ){
FILE *out = popen(zCmd, "w");
if( out ){
fwrite(blob_buffer(&all), 1, blob_size(&all), out);
fclose(out);
}
}
}else if( strcmp(zDest, "dir")==0 ){
const char *zDir = db_get("email-send-dir","./");
char *zFile = emailTempFilename(zDir);
blob_write_to_file(&all, zFile);
fossil_free(zFile);
}else if( strcmp(zDest, "stdout")==0 ){
fossil_print("%s\n", blob_str(&all));
}
blob_zero(&all);
}
/*
** Analyze and act on a received email.
**
** This routine takes ownership of the Blob parameter and is responsible
** for freeing that blob when it is done with it.
**
** This routine acts on all email messages received from the
** "fossil email inbound" command.
*/
void email_receive(Blob *pMsg){
/* To Do: Look for bounce messages and possibly disable subscriptions */
blob_zero(pMsg);
}
/*
** SETTING: email-send-method width=5 default=off
** Determine the method used to send email. Allowed values are
** "off", "pipe", "dir", "db", and "stdout". The "off" value means
** no email is ever sent. The "pipe" value means email messages are
** piped into a command determined by the email-send-command setting.
** The "dir" value means emails are written to individual files in a
** directory determined by the email-send-dir setting. The "db" value
** means that emails are added to an SQLite database named by the
** email-send-db setting. The "stdout" value writes email text to
** standard output, for debugging.
*/
/*
** SETTING: email-send-command width=40
** This is a command to which outbound email content is piped when the
** email-send-method is set to "pipe". The command must extract
** recipient, sender, subject, and all other relevant information
** from the email header.
*/
/*
** SETTING: email-send-dir width=40
** This is a directory into which outbound emails are written as individual
** files if the email-send-method is set to "dir".
*/
/*
** SETTING: email-send-db width=40
** This is an SQLite database file into which outbound emails are written
** if the email-send-method is set to "db".
*/
/*
** SETTING: email-self width=40
** This is the email address for the repository. Outbound emails add
** this email address as the "From:" field.
*/
/*
** SETTING: email-receive-dir width=40
** Inbound email messages are saved as separate files in this directory,
** for debugging analysis. Disable saving of inbound emails omitting
** this setting, or making it an empty string.
*/
/*
** COMMAND: email
**
** Usage: %fossil email SUBCOMMAND ARGS...
**
** Subcommands:
**
** inbound [FILE] Receive an inbound email message. This message
** is analyzed to see if it is a bounce, and if
** necessary, subscribers may be disabled.
**
** reset Hard reset of all email notification tables
** in the repository. This erases all subscription
** information. Use with extreme care.
**
** send TO [OPTIONS] Send a single email message using whatever
** email sending mechanism is currently configured.
** Use this for testing the email configuration.
** Options:
**
** --body FILENAME
** --html
** --stdout
** --subject|-S SUBJECT
**
** settings [NAME VALUE] With no arguments, list all email settings.
** Or change the value of a single email setting.
*/
void email_cmd(void){
const char *zCmd;
int nCmd;
db_find_and_open_repository(0, 0);
email_schema();
zCmd = g.argc>=3 ? g.argv[2] : "x";
nCmd = (int)strlen(zCmd);
if( strncmp(zCmd, "inbound", nCmd)==0 ){
Blob email;
const char *zInboundDir = db_get("email-receive-dir","");
verify_all_options();
if( g.argc!=3 && g.argc!=4 ){
usage("inbound [FILE]");
}
blob_read_from_file(&email, g.argc==3 ? "-" : g.argv[3], ExtFILE);
if( zInboundDir[0] ){
char *zFN = emailTempFilename(zInboundDir);
blob_write_to_file(&email, zFN);
fossil_free(zFN);
}
email_receive(&email);
}else
if( strncmp(zCmd, "reset", nCmd)==0 ){
int c;
int bForce = find_option("force","f",0)!=0;
verify_all_options();
if( bForce ){
c = 'y';
}else{
Blob yn;
fossil_print(
"This will erase all content in the repository tables, thus\n"
"deleting all subscriber information. The information will be\n"
"unrecoverable.\n");
prompt_user("Continue? (y/N) ", &yn);
c = blob_str(&yn)[0];
blob_zero(&yn);
}
if( c=='y' ){
email_triggers_disable();
db_multi_exec(
"DROP TABLE IF EXISTS subscriber;\n"
"DROP TABLE IF EXISTS pending_alert;\n"
"DROP TABLE IF EXISTS email_bounce;\n"
/* Legacy */
"DROP TABLE IF EXISTS email_pending;\n"
"DROP TABLE IF EXISTS subscription;\n"
);
email_schema();
}
}else
if( strncmp(zCmd, "send", nCmd)==0 ){
Blob prompt, body, hdr;
int sendAsBoth = find_option("both",0,0)!=0;
int sendAsHtml = find_option("html",0,0)!=0;
const char *zDest = find_option("stdout",0,0)!=0 ? "stdout" : 0;
int i;
const char *zSubject = find_option("subject", "S", 1);
const char *zSource = find_option("body", 0, 1);
verify_all_options();
blob_init(&prompt, 0, 0);
blob_init(&body, 0, 0);
blob_init(&hdr, 0, 0);
for(i=3; i<g.argc; i++){
blob_appendf(&hdr, "To: %s\n", g.argv[i]);
}
if( zSubject ){
blob_appendf(&hdr, "Subject: %s\n", zSubject);
}
if( zSource ){
blob_read_from_file(&body, zSource, ExtFILE);
}else{
prompt_for_user_comment(&body, &prompt);
}
blob_add_final_newline(&body);
if( sendAsHtml ){
email_send(&hdr, 0, &body, zDest);
}else if( sendAsBoth ){
Blob html;
blob_init(&html, 0, 0);
blob_appendf(&html, "<pre>\n%h</pre>\n", blob_str(&body));
email_send(&hdr, &body, &html, zDest);
blob_zero(&html);
}else{
email_send(&hdr, &body, 0, zDest);
}
blob_zero(&hdr);
blob_zero(&body);
blob_zero(&prompt);
}
else if( strncmp(zCmd, "settings", nCmd)==0 ){
int isGlobal = find_option("global",0,0)!=0;
int nSetting;
const Setting *pSetting = setting_info(&nSetting);
db_open_config(1, 0);
verify_all_options();
if( g.argc!=3 && g.argc!=5 ) usage("setting [NAME VALUE]");
if( g.argc==5 ){
const char *zLabel = g.argv[3];
if( strncmp(zLabel, "email-", 6)!=0
|| (pSetting = db_find_setting(zLabel, 1))==0 ){
fossil_fatal("not a valid email setting: \"%s\"", zLabel);
}
db_set(pSetting->name, g.argv[4], isGlobal);
g.argc = 3;
}
pSetting = setting_info(&nSetting);
for(; nSetting>0; nSetting--, pSetting++ ){
if( strncmp(pSetting->name,"email-",6)!=0 ) continue;
print_setting(pSetting);
}
}
else{
usage("inbound|reset|send|setting");
}
}
/*
** Do error checking on a submitted subscription form. Return TRUE
** if the submission is valid. Return false if any problems are seen.
*/
static int subscribe_error_check(
int *peErr, /* Type of error */
char **pzErr, /* Error message text */
int needCaptcha /* True if captcha check needed */
){
const char *zEAddr;
int i, j, n;
char c;
*peErr = 0;
*pzErr = 0;
/* Check the validity of the email address.
**
** (1) Exactly one '@' character.
** (2) No other characters besides [a-zA-Z0-9._-]
*/
zEAddr = P("e");
if( zEAddr==0 ) return 0;
for(i=j=0; (c = zEAddr[i])!=0; i++){
if( c=='@' ){
n = i;
j++;
continue;
}
if( !fossil_isalnum(c) && c!='.' && c!='_' && c!='-' ){
*peErr = 1;
*pzErr = mprintf("illegal character in email address: 0x%x '%c'",
c, c);
return 0;
}
}
if( j!=1 ){
*peErr = 1;
*pzErr = mprintf("email address should contain exactly one '@'");
return 0;
}
if( n<1 ){
*peErr = 1;
*pzErr = mprintf("name missing before '@' in email address");
return 0;
}
if( n>i-5 ){
*peErr = 1;
*pzErr = mprintf("email domain too short");
return 0;
}
/* Verify the captcha */
if( needCaptcha && !captcha_is_correct(1) ){
*peErr = 2;
*pzErr = mprintf("incorrect security code");
return 0;
}
/* Check to make sure the email address is available for reuse */
if( db_exists("SELECT 1 FROM subscriber WHERE semail=%Q", zEAddr) ){
*peErr = 1;
*pzErr = mprintf("this email address is used by someone else");
return 0;
}
/* If we reach this point, all is well */
return 1;
}
/*
** Text of email message sent in order to confirm a subscription.
*/
static const char zConfirmMsg[] =
@ Someone has signed you up for email alerts on the Fossil repository
@ at %s.
@
@ To confirm your subscription and begin receiving alerts, click on
@ the following hyperlink:
@
@ %s/alerts/%s
@
@ Save the hyperlink above! You can reuse this same hyperlink to
@ unsubscribe or to change the kinds of alerts you receive.
@
@ If you do not want to subscribe, you can simply ignore this message.
@ You will not be contacted again.
@
;
/*
** WEBPAGE: subscribe
**
** Allow users to subscribe to email notifications, or to change or
** verify their subscription.
*/
void subscribe_page(void){
int needCaptcha;
unsigned int uSeed;
const char *zDecoded;
char *zCaptcha = 0;
char *zErr = 0;
int eErr = 0;
login_check_credentials();
if( !g.perm.EmailAlert ){
login_needed(g.anon.EmailAlert);
return;
}
if( login_is_individual()
&& db_exists("SELECT 1 FROM subscriber WHERE suname=%Q",g.zLogin)
){
/* This person is already signed up for email alerts. Jump
** to the screen that lets them edit their alert preferences.
*/
cgi_redirectf("%R/alerts");
return;
}
email_subscriber_list_link();
needCaptcha = !login_is_individual();
if( P("submit")
&& cgi_csrf_safe(1)
&& subscribe_error_check(&eErr,&zErr,needCaptcha)
){
/* A validated request for a new subscription has been received. */
char ssub[20];
const char *zEAddr = P("e");
sqlite3_int64 id; /* New subscriber Id */
const char *zCode; /* New subscriber code (in hex) */
int nsub = 0;
if( PB("sa") ) ssub[nsub++] = 'a';
if( PB("sc") ) ssub[nsub++] = 'c';
if( PB("st") ) ssub[nsub++] = 't';
if( PB("sw") ) ssub[nsub++] = 'w';
ssub[nsub] = 0;
db_multi_exec(
"INSERT INTO subscriber(subscriberCode,semail,suname,"
" sverified,sdonotcall,sdigest,ssub,sctime,smtime,smip)"
"VALUES(randomblob(32),%Q,%Q,%d,0,%d,%Q,"
" julianday('now'),julianday('now'),%Q)",
/* semail */ zEAddr,
/* suname */ needCaptcha==0 ? g.zLogin : 0,
/* sverified */ needCaptcha==0,
/* sdigest */ PB("di"),
/* ssub */ ssub,
/* smip */ g.zIpAddr
);
id = db_last_insert_rowid();
zCode = db_text(0,
"SELECT hex(subscriberCode) FROM subscriber WHERE subscriberId=%lld",
id);
if( !needCaptcha ){
/* The new subscription has been added on behalf of a logged-in user.
** No verification is required. Jump immediately to /alerts page.
*/
cgi_redirectf("%R/alerts/%s", zCode);
return;
}else{
/* We need to send a verification email */
Blob hdr, body;
blob_init(&hdr,0,0);
blob_init(&body,0,0);
blob_appendf(&hdr, "To: %s\n", zEAddr);
blob_appendf(&hdr, "Subject: Subscription verification\n");
blob_appendf(&body, zConfirmMsg/*works-like:"%s%s%s"*/,
g.zBaseURL, g.zBaseURL, zCode);
email_send(&hdr, &body, 0, 0);
style_header("Email Alert Verification");
@ <p>An email has been sent to "%h(zEAddr)". That email contains a
@ hyperlink that you must click on in order to activate your
@ subscription.</p>
style_footer();
}
return;
}
style_header("Signup For Email Alerts");
@ <p>To receive email notifications for changes to this
@ repository, fill out the form below and press "Submit" button.</p>
form_begin(0, "%R/subscribe");
@ <table class="subscribe">
@ <tr>
@ <td class="form_label">Email Address:</td>
@ <td><input type="text" name="e" value="%h(PD("e",""))" size="30"></td>
if( eErr==1 ){
@ <td><span class="loginError">← %h(zErr)</span></td>
}
@ </tr>
if( needCaptcha ){
uSeed = captcha_seed();
zDecoded = captcha_decode(uSeed);
zCaptcha = captcha_render(zDecoded);
@ <tr>
@ <td class="form_label">Security Code:</td>
@ <td><input type="text" name="captcha" value="" size="30">
@ <input type="hidden" name="captchaseed" value="%u(uSeed)"></td>
if( eErr==2 ){
@ <td><span class="loginError">← %h(zErr)</span></td>
}
@ </tr>
}
if( g.perm.Admin ){
@ <tr>
@ <td class="form_label">User:</td>
@ <td><input type="text" name="suname" value="%h(PD("suname",g.zLogin))" \
@ size="30"></td>
if( eErr==3 ){
@ <td><span class="loginError">← %h(zErr)</span></td>
}
@ </tr>
}
@ <tr>
@ <td class="form_label">Options:</td>
@ <td><label><input type="checkbox" name="sa" %s(PCK("sa"))> \
@ Announcements</label><br>
@ <label><input type="checkbox" name="sc" %s(PCK("sc"))> \
@ Check-ins</label><br>
@ <label><input type="checkbox" name="st" %s(PCK("st"))> \
@ Ticket changes</label><br>
@ <label><input type="checkbox" name="sw" %s(PCK("sw"))> \
@ Wiki</label><br>
@ <label><input type="checkbox" name="di" %s(PCK("di"))> \
@ Daily digest only</label><br>
if( g.perm.Admin ){
@ <label><input type="checkbox" name="vi" %s(PCK("vi"))> \
@ Verified</label><br>
@ <label><input type="checkbox" name="dnc" %s(PCK("dnc"))> \
@ Do not call</label><br>
}
@ </td>
@ </tr>
@ <tr>
@ <td></td>
if( needCaptcha && !email_enabled() ){
@ <td><input type="submit" name="submit" value="Submit" disabled>
@ (Email current disabled)</td>
}else{
@ <td><input type="submit" name="submit" value="Submit"></td>
}
@ </tr>
@ </table>
if( needCaptcha ){
@ <div class="captcha"><table class="captcha"><tr><td><pre>
@ %h(zCaptcha)
@ </pre>
@ Enter the 8 characters above in the "Security Code" box
@ </td></tr></table></div>
}
@ </form>
fossil_free(zErr);
style_footer();
}
/*
** Either shutdown or completely delete a subscription entry given
** by the hex value zName. Then paint a webpage that explains that
** the entry has been removed.
*/
static void email_unsubscribe(const char *zName){
char *zEmail;
zEmail = db_text(0, "SELECT semail FROM subscriber"
" WHERE subscriberCode=hextoblob(%Q)", zName);
if( zEmail==0 ){
style_header("Unsubscribe Fail");
@ <p>Unable to locate a subscriber with the requested key</p>
}else{
db_multi_exec(
"DELETE FROM subscriber WHERE subscriberCode=hextoblob(%Q)",
zName
);
style_header("Unsubscribed");
@ <p>The "%h(zEmail)" email address has been delisted.
@ All traces of that email address have been removed</p>
}
style_footer();
return;
}
/*
** WEBPAGE: alerts
**
** Edit email alert and notification settings.
**
** The subscriber entry is identified in either of two ways:
**
** (1) The name= query parameter contains the subscriberCode.
**
** (2) The user is logged into an account other than "nobody" or
** "anonymous". In that case the notification settings
** associated with that account can be edited without needing
** to know the subscriber code.
*/
void alerts_page(void){
const char *zName = P("name");
Stmt q;
int sa, sc, st, sw;
int sdigest, sdonotcall, sverified;
const char *ssub;
const char *semail;
const char *smip;
const char *suname;
int eErr = 0;
char *zErr = 0;
login_check_credentials();
if( !g.perm.EmailAlert ){
cgi_redirect("subscribe");
return;
}
if( zName==0 && login_is_individual() ){
zName = db_text(0, "SELECT hex(subscriberCode) FROM subscriber"
" WHERE suname=%Q", g.zLogin);
}
if( zName==0 || !validate16(zName, -1) ){
cgi_redirect("subscribe");
return;
}
email_subscriber_list_link();
if( P("submit")!=0 && cgi_csrf_safe(1) ){
int sdonotcall = PB("sdonotcall");
int sdigest = PB("sdigest");
char ssub[10];
int nsub = 0;
const char *suname = 0;
if( PB("sa") ) ssub[nsub++] = 'a';
if( PB("sc") ) ssub[nsub++] = 'c';
if( PB("st") ) ssub[nsub++] = 't';
if( PB("sw") ) ssub[nsub++] = 'w';
ssub[nsub] = 0;
if( g.perm.Admin ){
suname = PT("suname");
if( suname && suname[0]==0 ) suname = 0;
}
db_multi_exec(
"UPDATE subscriber SET"
" sdonotcall=%d,"
" sdigest=%d,"
" ssub=%Q,"
" smtime=julianday('now'),"
" smip=%Q,"
" suname=COALESCE(%Q,suname)"
" WHERE subscriberCode=hextoblob(%Q)",
sdonotcall,
sdigest,
ssub,
g.zIpAddr,
suname,
zName
);
}
if( P("delete")!=0 && cgi_csrf_safe(1) ){
if( !PB("dodelete") ){
eErr = 9;
zErr = mprintf("Select this checkbox and press \"Unsubscribe\" to"
" unsubscribe");
}else{
email_unsubscribe(zName);
return;
}
}
db_prepare(&q,
"SELECT"
" semail,"
" sverified,"
" sdonotcall,"
" sdigest,"
" ssub,"
" smip,"
" suname"
" FROM subscriber WHERE subscriberCode=hextoblob(%Q)", zName);
if( db_step(&q)!=SQLITE_ROW ){
db_finalize(&q);
cgi_redirect("subscribe");
return;
}
style_header("Update Subscription");
semail = db_column_text(&q, 0);
sverified = db_column_int(&q, 1);
sdonotcall = db_column_int(&q, 2);
sdigest = db_column_int(&q, 3);
ssub = db_column_text(&q, 4);
sa = strchr(ssub,'a')!=0;
sc = strchr(ssub,'c')!=0;
st = strchr(ssub,'t')!=0;
sw = strchr(ssub,'w')!=0;
smip = db_column_text(&q, 5);
suname = db_column_text(&q, 6);
if( !g.perm.Admin && !sverified ){
db_multi_exec(
"UPDATE subscriber SET sverified=1 WHERE subscriberCode=hextoblob(%Q)",
zName);
@ <h1>Your email alert subscription has been verified!</h1>
@ <p>Use the form below to update your subscription information.</p>
@ <p>Hint: Bookmark this page so that you can more easily update
@ your subscription information in the future</p>
}else{
@ <p>Make changes to the email subscription shown below and
@ press "Submit".</p>
}
form_begin(0, "%R/alerts");
@ <input type="hidden" name="name" value="%h(zName)">
@ <table class="subscribe">
@ <tr>
@ <td class="form_label">Email Address:</td>
@ <td>%h(semail)</td>
@ </tr>
if( g.perm.Admin ){
@ <tr>
@ <td class='form_label'>IP Address:</td>
@ <td>%h(smip)</td>
@ </tr>
@ <tr>
@ <td class='form_label'>User:</td>
@ <td>%h(suname?suname:"")</td>
@ </tr>
}
@ <tr>
@ <td class="form_label">Options:</td>
@ <td><label><input type="checkbox" name="sa" %s(sa?"checked":"")>\
@ Announcements</label><br>
@ <label><input type="checkbox" name="sc" %s(sc?"checked":"")>\
@ Check-ins</label><br>
@ <label><input type="checkbox" name="st" %s(st?"checked":"")>\
@ Ticket changes</label><br>
@ <label><input type="checkbox" name="sw" %s(sw?"checked":"")>\
@ Wiki</label><br>
@ <label><input type="checkbox" name="sdigest" %s(sdigest?"checked":"")>\
@ Daily digest only</label><br>
if( g.perm.Admin ){
@ <label><input type="checkbox" name="sdonotcall" \
@ %s(sdonotcall?"checked":"")> Do not call</label><br>
@ <label><input type="checkbox" name="sverified" \
@ %s(sverified?"checked":"")>\
@ Verified</label><br>
}
@ <label><input type="checkbox" name="dodelete">
@ Unsubscribe</label> \
if( eErr==9 ){
@ <span class="loginError">← %h(zErr)</span>\
}
@ <br>
@ </td></tr>
@ <tr>
@ <td></td>
@ <td><input type="submit" name="submit" value="Submit">
@ <input type="submit" name="delete" value="Unsubscribe">
@ </tr>
@ </table>
@ </form>
fossil_free(zErr);
db_finalize(&q);
style_footer();
}
/* This is the message that gets sent to describe how to change
** or modify a subscription
*/
static const char zUnsubMsg[] =
@ To changes your subscription settings at %s visit this link:
@
@ %s/alerts/%s
@
@ To completely unsubscribe from %s, visit the following link:
@
@ %s/unsubscribe/%s
;
/*
** WEBPAGE: unsubscribe
**
** Users visit this page to be delisted from email alerts.
**
** If a valid subscriber code is supplied in the name= query parameter,
** then that subscriber is delisted.
**
** Otherwise, If the users is logged in, then they are redirected
** to the /alerts page where they have an unsubscribe button.
**
** Non-logged-in users with no name= query parameter are invited to enter
** an email address to which will be sent the unsubscribe link that
** contains the correct subscriber code.
*/
void unsubscribe_page(void){
const char *zName = P("name");
char *zErr = 0;
int eErr = 0;
unsigned int uSeed;
const char *zDecoded;
char *zCaptcha = 0;
int dx;
int bSubmit;
const char *zEAddr;
char *zCode = 0;
/* If a valid subscriber code is supplied, then unsubscribe immediately.
*/
if( zName
&& db_exists("SELECT 1 FROM subscriber WHERE subscriberCode=hextoblob(%Q)",
zName)
){
email_unsubscribe(zName);
return;
}
/* Logged in users are redirected to the /alerts page */
login_check_credentials();
if( login_is_individual() ){
cgi_redirectf("%R/alerts");
return;
}
zEAddr = PD("e","");
dx = atoi(PD("dx","0"));
bSubmit = P("submit")!=0 && P("e")!=0 && cgi_csrf_safe(1);
if( bSubmit ){
if( !captcha_is_correct(1) ){
eErr = 2;
zErr = mprintf("enter the security code shown below");
bSubmit = 0;
}
}
if( bSubmit ){
zCode = db_text(0,"SELECT hex(subscriberCode) FROM subscriber"
" WHERE semail=%Q", zEAddr);
if( zCode==0 ){
eErr = 1;
zErr = mprintf("not a valid email address");
bSubmit = 0;
}
}
if( bSubmit ){
/* If we get this far, it means that a valid unsubscribe request has
** been submitted. Send the appropriate email. */
Blob hdr, body;
blob_init(&hdr,0,0);
blob_init(&body,0,0);
blob_appendf(&hdr, "To: %s\n", zEAddr);
blob_appendf(&hdr, "Subject: Unsubscribe Instructions\n");
blob_appendf(&body, zUnsubMsg/*works-like:"%s%s%s%s%s%s"*/,
g.zBaseURL, g.zBaseURL, zCode, g.zBaseURL, g.zBaseURL, zCode);
email_send(&hdr, &body, 0, 0);
style_header("Unsubscribe Instructions Sent");
@ <p>An email has been sent to "%h(zEAddr)" that explains how to
@ unsubscribe and/or modify your subscription settings</p>
style_footer();
return;
}
/* Non-logged-in users have to enter an email address to which is
** sent a message containing the unsubscribe link.
*/
style_header("Unsubscribe Request");
@ <p>Fill out the form below to request an email message that will
@ explain how to unsubscribe and/or change your subscription settings.</p>
@
form_begin(0, "%R/unsubscribe");
@ <table class="subscribe">
@ <tr>
@ <td class="form_label">Email Address:</td>
@ <td><input type="text" name="e" value="%h(zEAddr)" size="30"></td>
if( eErr==1 ){
@ <td><span class="loginError">← %h(zErr)</span></td>
}
@ </tr>
uSeed = captcha_seed();
zDecoded = captcha_decode(uSeed);
zCaptcha = captcha_render(zDecoded);
@ <tr>
@ <td class="form_label">Security Code:</td>
@ <td><input type="text" name="captcha" value="" size="30">
@ <input type="hidden" name="captchaseed" value="%u(uSeed)"></td>
if( eErr==2 ){
@ <td><span class="loginError">← %h(zErr)</span></td>
}
@ </tr>
@ <tr>
@ <td class="form_label">Options:</td>
@ <td><label><input type="radio" name="dx" value="0" %s(dx?"":"checked")>\
@ Modify subscription</label><br>
@ <label><input type="radio" name="dx" value="1" %s(dx?"checked":"")>\
@ Completely unsubscribe</label><br>
@ <tr>
@ <td></td>
@ <td><input type="submit" name="submit" value="Submit"></td>
@ </tr>
@ </table>
@ <div class="captcha"><table class="captcha"><tr><td><pre>
@ %h(zCaptcha)
@ </pre>
@ Enter the 8 characters above in the "Security Code" box
@ </td></tr></table></div>
@ </form>
fossil_free(zErr);
style_footer();
}
/*
** WEBPAGE: subscribers
**
** This page, accessible to administrators only,
** shows a list of email notification email addresses with
** links to facilities for editing.
*/
void subscriber_list_page(void){
Blob sql;
Stmt q;
login_check_credentials();
if( !g.perm.Admin ){
fossil_redirect_home();
return;
}
style_header("Subscriber List");
blob_init(&sql, 0, 0);
blob_append_sql(&sql,
"SELECT hex(subscriberCode),"
" semail,"
" ssub,"
" suname,"
" sverified,"
" sdigest"
" FROM subscriber"
);
db_prepare_blob(&q, &sql);
@ <table border="1">
@ <tr>
@ <th>Email
@ <th>Events
@ <th>Digest-Only?
@ <th>User
@ <th>Verified?
@ </tr>
while( db_step(&q)==SQLITE_ROW ){
@ <tr>
@ <td><a href='%R/alerts/%s(db_column_text(&q,0))'>\
@ %h(db_column_text(&q,1))</a></td>
@ <td>%h(db_column_text(&q,2))</td>
@ <td>%s(db_column_int(&q,5)?"digest":"")</td>
@ <td>%h(db_column_text(&q,3))</td>
@ <td>%s(db_column_int(&q,4)?"yes":"pending")</td>
@ </tr>
}
@ </table>
db_finalize(&q);
style_footer();
}
#if LOCAL_INTERFACE
/* Allowed values for the mAlert flags parameter to email_alert_text
*/
#define ALERT_HTML 0x01 /* Generate HTML instead of plain text */
#endif
/*
** Append the text for a single alert to the end of pOut
*/
void email_one_alert(const char *zEvent, u32 mAlert, Blob *pOut){
static Stmt q;
int id;
const char *zType = "";
db_static_prepare(&q,
"SELECT"
" blob.uuid," /* 0 */
" datetime(event.mtime)," /* 1 */
" coalesce(ecomment,comment)"
" || ' (user: ' || coalesce(euser,user,'?')"
" || (SELECT case when length(x)>0 then ' tags: ' || x else '' end"
" FROM (SELECT group_concat(substr(tagname,5), ', ') AS x"
" FROM tag, tagxref"
" WHERE tagname GLOB 'sym-*' AND tag.tagid=tagxref.tagid"
" AND tagxref.rid=blob.rid AND tagxref.tagtype>0))"
" || ')' as comment," /* 2 */
" tagxref.value AS branch" /* 3 */
" FROM tag CROSS JOIN event CROSS JOIN blob"
" LEFT JOIN tagxref ON tagxref.tagid=tag.tagid"
" AND tagxref.tagtype>0"
" AND tagxref.rid=blob.rid"
" WHERE blob.rid=event.objid"
" AND tag.tagname='branch'"
" AND event.objid=:objid"
);
switch( zEvent[0] ){
case 'c': zType = "Check-In"; break;
case 't': zType = "Wiki Edit"; break;
case 'w': zType = "Ticket Change"; break;
default: return;
}
id = atoi(zEvent+1);
if( id<=0 ) return;
db_bind_int(&q, ":objid", id);
if( db_step(&q)==SQLITE_ROW ){
blob_appendf(pOut,"\n== %s %s ==\n%s\n%s/info/%.20s\n",
db_column_text(&q,1),
zType,
db_column_text(&q,2),
db_get("email-url","http://localhost:8080"),
db_column_text(&q,0)
);
}
db_reset(&q);
}
/*
** Put a header on an alert email
*/
void email_header(u32 mAlert, Blob *pOut){
blob_appendf(pOut,
"This is an automated email reporting changes "
"on Fossil repository %s (%s/timeline)\n",
db_get("email-subname","(unknown)"),
db_get("email-url","http://localhost:8080"));
}
/*
** Append the "unsubscribe" notification and other footer text to
** the end of an email alert being assemblied in pOut.
*/
void email_footer(u32 mAlert, Blob *pOut){
blob_appendf(pOut, "\n%.72c\nTo unsubscribe: %s/unsubscribe\n",
'-', db_get("email-url","http://localhost:8080"));
}
/*
** COMMAND: test-generate-alert
**
** Usage: %fossil test-generate-alert [--html] [--actual] EVENTID ...
**
** Generate the text of an email alert for all of the EVENTIDs
** listed on the command-line. Write that text to standard
** output. If the --actual flag is present, then the EVENTIDs are
** the actual event-ids in the pending_alert table.
**
** This command is intended for testing and debugging the logic
** that generates email alert text.
**
** The mimetype is text/plain by default. Use the --html option
** to generate text/html alert text.
*/
void test_generate_alert_cmd(void){
u32 mAlert = 0;
int bActual = find_option("actual",0,0)!=0;
Blob out;
int i;
if( find_option("html",0,0)!=0 ) mAlert |= ALERT_HTML;
db_find_and_open_repository(0, 0);
verify_all_options();
email_schema();
blob_init(&out, 0, 0);
email_header(mAlert, &out);
if( bActual ){
Stmt q;
db_prepare(&q,
"SELECT eventid FROM pending_alert, event"
" WHERE event.objid=substr(pending_alert.eventid,2)+0"
" ORDER BY event.mtime"
);
while( db_step(&q)==SQLITE_ROW ){
email_one_alert(db_column_text(&q,0), mAlert, &out);
}
db_finalize(&q);
}else{
int i;
for(i=2; i<g.argc; i++){
email_one_alert(g.argv[i], mAlert, &out);
}
}
email_footer(mAlert, &out);
fossil_print("%s", blob_str(&out));
blob_zero(&out);
}