Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Add logic to generate the text of email alert messages. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | email-alerts |
Files: | files | file ages | folders |
SHA3-256: |
bb30d02efdb768b424b05efa50649bfb |
User & Date: | drh 2018-06-22 15:34:06.540 |
Context
2018-06-22
| ||
15:57 | Generate event report in chronological order for an alert text. ... (check-in: e0289252 user: drh tags: email-alerts) | |
15:34 | Add logic to generate the text of email alert messages. ... (check-in: bb30d02e user: drh tags: email-alerts) | |
13:50 | Add the --sql option to the timeline command. ... (check-in: d51ca5f5 user: drh tags: email-alerts) | |
Changes
Changes to src/email.c.
︙ | ︙ | |||
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | 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(); 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> | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | 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> |
︙ | ︙ | |||
191 192 193 194 195 196 197 | 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> | < < < < < < < < | 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | 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> |
︙ | ︙ | |||
1211 1212 1213 1214 1215 1216 1217 | @ <td>%s(db_column_int(&q,4)?"yes":"pending")</td> @ </tr> } @ </table> db_finalize(&q); style_footer(); } | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 | @ <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"); 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); } |