webcit-ng/static/js/view_mail.js

   1 // This module handles the view for "mailbox" rooms.
   2 //
   3 // Copyright (c) 2016-2022 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or
   6 // disclosure are subject to the GNU General Public License v3.
   7
   8
   9 var displayed_message = 0;                                                      // ID of message currently being displayed
  10 var RefreshMailboxInterval;                                                     // We store our refresh timer here
  11 var highest_mailnum;                                                            // This is used to detect newly arrived mail
  12 var newmail_notify = {
  13         NO  : 0,                                                                // do not perform new mail notifications
  14         YES : 1                                                                 // yes, perform new mail notifications
  15 };
  16
  17
  18 // This is the async back end for mail_delete_selected()
  19 mail_delete_func = async(table, row) => {
  20         let m = parseInt(row["id"].substring(12));      // derive msgnum from row id
  21         response = await fetch(
  22                 "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + m,
  23                 { method: "DELETE" }
  24         );
  25         if (response.ok) {                              // If the server accepted the delete, blank out the message div.
  26                 table.deleteRow(row.rowIndex);
  27                 if (m == displayed_message) {
  28                         document.getElementById("ctdl-mailbox-reading-pane").innerHTML = "";
  29                         displayed_message = 0;
  30                 }
  31         }
  32 }
  33
  34
  35 // Delete the selected messages (can be activated by mouse click or keypress)
  36 function mail_delete_selected() {
  37         var table = document.getElementById("ctdl-onscreen-mailbox");
  38         var i, row;
  39         for (i=0; row=table.rows[i]; ++i) {
  40                 if (row.classList.contains("ctdl-mail-selected")) {
  41                         mail_delete_func(table, row);
  42                 }
  43         }
  44 }
  45
  46
  47 // Handler function for keypresses detected while the mail view is displayed.  Mainly for deleting messages.
  48 function mail_keypress(event) {
  49
  50         // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
  51         // so cancel the event listener.
  52         try {
  53                 document.getElementById("ctdl-mailbox-pane").innerHTML;
  54         }
  55         catch {
  56                 document.removeEventListener("keydown", mail_keypress);
  57                 return;
  58         }
  59
  60         const key = event.key.toLowerCase();
  61         if (key == "delete") {
  62                 mail_delete_selected();
  63         }
  64
  65 }
  66
  67
  68 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
  69 function reply_addr(msg) {
  70         //if (msg.locl) {
  71                 //return([msg.from]);
  72         //}
  73         //else {
  74                 return([msg.from + " &lt;" + msg.rfca + "&gt;"]);
  75         //}
  76 }
  77
  78
  79 // Render the To: recipients for a reply-all operation
  80 function replyall_to(msg) {
  81         return([...reply_addr(msg), ...msg.rcpt]);
  82 }
  83
  84
  85 // Render a message into the mailbox view
  86 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
  87 function mail_render_one(msgnum, msg, target_div, include_controls) {
  88         let div = "";
  89         try {
  90                 outmsg =
  91                   "<div class=\"ctdl-mmsg-wrapper\">"                           // begin message wrapper
  92                 ;
  93
  94                 if (include_controls) {                                         // omit controls if this is a pull quote
  95                         outmsg +=
  96                           render_userpic(msg.from)                              // user avatar
  97                         + "<div class=\"ctdl-mmsg-content\">"                   // begin content
  98                         + "<div class=\"ctdl-msg-header\">"                     // begin header
  99                         + "<span class=\"ctdl-msg-header-info\">"               // begin header info on left side
 100                         + render_msg_author(msg, views.VIEW_MAILBOX)
 101                         + "<span class=\"ctdl-msgdate\">"
 102                         + string_timestamp(msg.time,0)
 103                         + "</span>"                                             // end msgdate
 104                         + "</span>"                                             // end header info on left side
 105                         + "<span class=\"ctdl-msg-header-buttons\">"            // begin buttons on right side
 106
 107                         + "<span class=\"ctdl-msg-button\">"                    // Reply (mail is always Quoted)
 108                         + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
 109                         + "<i class=\"fa fa-reply\"></i> "
 110                         + _("Reply")
 111                         + "</a></span>"
 112
 113                         + "<span class=\"ctdl-msg-button\">"                    // Reply-All (mail is always Quoted)
 114                         + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
 115                         + "<i class=\"fa fa-reply-all\"></i> "
 116                         + _("ReplyAll")
 117                         + "</a></span>";
 118
 119                         if (can_delete_messages) {
 120                                 outmsg +=
 121                                 "<span class=\"ctdl-msg-button\">"
 122                                 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
 123                                 + "<i class=\"fa fa-trash\"></i> "
 124                                 + _("Delete")
 125                                 + "</a></span>";
 126                         }
 127
 128                         outmsg +=
 129                           "</span>";                                            // end buttons on right side
 130
 131                         // Display the To: recipients, if any are present
 132                         if (msg.rcpt) {
 133                                 outmsg += "<br><span>" + _("To:") + " ";
 134                                 for (var r=0; r<msg.rcpt.length; ++r) {
 135                                         if (r != 0) {
 136                                                 outmsg += ", ";
 137                                         }
 138                                         outmsg += escapeHTML(msg.rcpt[r]);
 139                                 }
 140                                 outmsg += "</span>";
 141                         }
 142
 143                         // Display the Cc: recipients, if any are present
 144                         if (msg.cccc) {
 145                                 outmsg += "<br><span>" + _("Cc:") + " ";
 146                                 for (var r=0; r<msg.cccc.length; ++r) {
 147                                         if (r != 0) {
 148                                                 outmsg += ", ";
 149                                         }
 150                                         outmsg += escapeHTML(msg.cccc[r]);
 151                                 }
 152                                 outmsg += "</span>";
 153                         }
 154
 155                         // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
 156                         if (msg.subj) {
 157                                 outmsg +=
 158                                 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
 159                         }
 160
 161                         outmsg +=
 162                           "</div>";                                             // end header
 163                 }
 164
 165                 outmsg +=
 166                   "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">"       // begin body
 167                 + msg.text
 168                 + "</div>"                                                      // end body
 169                 + "</div>"                                                      // end content
 170                 + "</div>"                                                      // end wrapper
 171                 ;
 172         }
 173         catch(err) {
 174                 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
 175         }
 176
 177         target_div.innerHTML = outmsg;
 178 }
 179
 180
 181 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
 182 function mail_display_message(msgnum, target_div, include_controls) {
 183         url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
 184         mail_fetch_msg = async() => {
 185                 response = await fetch(url);
 186                 msg = await(response.json());
 187                 if (response.ok) {
 188                         mail_render_one(msgnum, msg, target_div, include_controls);
 189                 }
 190         }
 191         mail_fetch_msg();
 192 }
 193
 194
 195 // A message has been selected...
 196 function click_message(event, msgnum) {
 197         var table = document.getElementById("ctdl-onscreen-mailbox");
 198         var i, m, row;
 199
 200         // ctrl + click = toggle an individual message without changing existing selection
 201         if (event.ctrlKey) {
 202                 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
 203         }
 204
 205         // shift + click = select a range of messages
 206         else if (event.shiftKey) {
 207                 for (i=0; row=table.rows[i]; ++i) {
 208                         m = parseInt(row["id"].substring(12));                          // derive msgnum from row id
 209                         if (
 210                                 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
 211                                 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
 212                         ) {
 213                                 row.classList.add("ctdl-mail-selected");
 214                         }
 215                         else {
 216                                 row.classList.remove("ctdl-mail-selected");
 217                         }
 218                 }
 219         }
 220
 221         // click + no modifiers = select one message and unselect all others
 222         else {
 223                 for (i=0; row=table.rows[i]; ++i) {
 224                         if (row["id"] == "ctdl-msgsum-" + msgnum) {
 225                                 row.classList.add("ctdl-mail-selected");
 226                         }
 227                         else {
 228                                 row.classList.remove("ctdl-mail-selected");
 229                         }
 230                 }
 231         }
 232
 233         // display the message if it isn't already displayed
 234         if (displayed_message != msgnum) {
 235                 displayed_message = msgnum;
 236                 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
 237         }
 238 }
 239
 240
 241 // render one row in the mailbox table (this could be called from one of several places)
 242 function mail_render_row(msg, is_selected) {
 243         row     = "<tr "
 244                 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
 245                 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
 246                 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
 247                 + "onselectstart=\"return false;\""
 248                 + ">"
 249                 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
 250                 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
 251                 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
 252                 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
 253                 + "</tr>";
 254         return(row);
 255 }
 256
 257
 258 // RENDERER FOR THIS VIEW
 259 function view_render_mail() {
 260         // Put the "enter new message" button into the topbar
 261         document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
 262         document.getElementById("ctdl-newmsg-button").style.display = "block";
 263
 264         // Put the "delete message(s)" button into the topbar
 265         let d = document.getElementById("ctdl-delete-button");
 266         d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
 267         d.style.display = "block";
 268         //d.addEventListener("click", mail_delete_selected);
 269
 270         document.getElementById("ctdl-main").innerHTML
 271                 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
 272                 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
 273                 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
 274                 + "</div>"
 275         ;
 276
 277         highest_mailnum = 0;                                    // Keep track of highest message number to track newly arrived messages
 278         render_mailbox_display(newmail_notify.NO);
 279         try {                                                   // if this was already set up, clear it so there aren't multiple
 280                 clearInterval(RefreshMailboxInterval);
 281         }
 282         catch {
 283         }
 284         RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
 285 }
 286
 287
 288 // Refresh the mailbox, either for the first time or whenever needed
 289 function refresh_mail_display() {
 290         // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
 291         // so cancel the refresh.
 292         try {
 293                 document.getElementById("ctdl-mailbox-pane").innerHTML;
 294         }
 295         catch {
 296                 clearInterval(RefreshMailboxInterval);
 297                 return;
 298         }
 299
 300         // Ask the server if the room has been written to since our last look at it.
 301         url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
 302         fetch_stat = async() => {
 303                 response = await fetch(url);
 304                 stat = await(response.json());
 305                 if (stat.room_mtime > room_mtime) {                     // FIXME commented out to force refreshes
 306                         room_mtime = stat.room_mtime;
 307                         render_mailbox_display(newmail_notify.YES);
 308                 }
 309         }
 310         fetch_stat();
 311 }
 312
 313
 314 // This is where the rendering of the message list in the mailbox view is performed.
 315 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
 316 function render_mailbox_display(notify) {
 317
 318         url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
 319         fetch_mailbox = async() => {
 320                 response = await fetch(url);
 321                 msgs = await(response.json());
 322                 if (response.ok) {
 323                         var previously_selected = [];
 324                         var oldtable = document.getElementById("ctdl-onscreen-mailbox");
 325                         var i, row;
 326
 327                         // If one or more messages was already selected, remember them so we can re-select them
 328                         if ( (displayed_message > 0) && (oldtable) ) {
 329                                 for (i=0; row=oldtable.rows[i]; ++i) {
 330                                         if (row.classList.contains("ctdl-mail-selected")) {
 331                                                 previously_selected.push(parseInt(row["id"].substring(12)));
 332                                         }
 333                                 }
 334                         }
 335
 336                         // begin rendering the mailbox table
 337                         box =   "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
 338                                 + "<th>" + _("Subject") + "</th>"
 339                                 + "<th>" + _("Sender") + "</th>"
 340                                 + "<th>" + _("Date") + "</th>"
 341                                 + "<th>#</th>"
 342                                 + "</tr>";
 343
 344                         for (let i=0; i<msgs.length; ++i) {
 345                                 let m = parseInt(msgs[i].msgnum);
 346                                 let s = (previously_selected.includes(m));
 347                                 box += mail_render_row(msgs[i], s);
 348                                 if (m > highest_mailnum) {
 349                                         highest_mailnum = m;
 350                                 }
 351                         }
 352
 353                         box +=  "</table>";
 354                         document.getElementById("ctdl-mailbox-pane").innerHTML = box;
 355                         document.addEventListener("keydown", mail_keypress);
 356                 }
 357         }
 358         fetch_mailbox();
 359 }
 360
 361
 362 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
 363 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
 364         // m_to will be an array of zero or more recipients for the To: field.  Convert it to a string.
 365         if (m_to) {
 366                 m_to = Array.from(new Set(m_to));       // remove dupes
 367                 m_to_str = "";
 368                 for (i=0; i<m_to.length; ++i) {
 369                         if (i > 0) {
 370                                 m_to_str += ", ";
 371                         }
 372                         m_to_str += m_to[i].replaceAll("<", "&lt;").replaceAll(">", "&gt;");
 373                 }
 374         }
 375         else {
 376                 m_to_str = "";
 377         }
 378
 379         // m_to will be an array of zero or more recipients for the Cc: field.  Convert it to a string.
 380         if (m_cc) {
 381                 m_cc = Array.from(new Set(m_cc));       // remove dupes
 382                 m_cc_str = "";
 383                 for (i=0; i<m_cc.length; ++i) {
 384                         if (i > 0) {
 385                                 m_cc_str += ", ";
 386                         }
 387                         m_cc_str += m_cc[i].replaceAll("<", "&lt;").replaceAll(">", "&gt;");
 388                 }
 389         }
 390         else {
 391                 m_cc_str = "";
 392         }
 393
 394         quoted_div_name = randomString();
 395
 396         // Make the "Write mail" button disappear.  We're already there!
 397         document.getElementById("ctdl-newmsg-button").style.display = "none";
 398
 399         // is_quoted    true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
 400         // references   list of references, be sure to use this in a reply
 401         // msgid        if a reply, the msgid of the most recent message in the chain, the one to which we are replying
 402
 403         // Now display the screen.
 404         compose_screen =
 405                 // Hidden values that we are storing right here in the document tree for later
 406                   "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
 407                 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
 408
 409                 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
 410                 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
 411
 412                 // Visible To: field, plus a box to make the CC/BCC lines appear
 413                 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
 414                 + "<div class=\"ctdl-compose-to-line\">"
 415                 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
 416                 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
 417                 + "onClick=\"make_cc_bcc_visible()\">"
 418                 + _("CC:") + "/" + _("BCC:") + "</div>"
 419                 + "</div>"
 420
 421                 // CC/BCC
 422                 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
 423                 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
 424                 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
 425                 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
 426
 427                 // Visible subject field
 428                 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
 429                 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
 430
 431                 // Message composition box
 432                 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
 433         ;
 434
 435         if (is_quoted) {
 436                 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
 437         }
 438
 439         compose_screen +=
 440                   "</div>"
 441
 442                 // The button bar is a Grid element, and is also a Flexbox container.
 443                 + "<div class=\"ctdl-compose-toolbar\">"
 444                 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
 445                 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
 446                 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
 447                 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
 448                 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
 449                 + "</div>"
 450         ;
 451
 452         document.getElementById("ctdl-main").innerHTML = compose_screen;
 453         mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
 454         if (m_cc) {
 455                 document.getElementById("ctdl-compose-cc-label").style.display = "block";
 456                 document.getElementById("ctdl-compose-cc-field").style.display = "block";
 457         }
 458 }
 459
 460
 461 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
 462 // It is also called automatically during a Reply when CC is pre-populated.
 463 function make_cc_bcc_visible() {
 464         document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
 465         document.getElementById("ctdl-compose-bcc-label").style.display = "block";
 466         document.getElementById("ctdl-compose-bcc-field").style.display = "block";
 467 }
 468
 469
 470 // Helper function for mail_send_messages() to extract and decode metadata values.
 471 function msm_field(element_name, separator) {
 472         let s1 = document.getElementById(element_name).innerHTML;
 473         let s2 = s1.replaceAll("|",separator);          // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
 474         let s3 = decodeURI(s2);
 475         let s4 = document.createElement("textarea");    // This One Weird Trick Unescapes All HTML Entities
 476         s4.innerHTML = s3;
 477         let s5 = s4.value;
 478         return(s5);
 479 }
 480
 481
 482 // Save the posted message to the server
 483 function mail_send_message() {
 484
 485         document.body.style.cursor = "wait";
 486         let url = "/ctdl/r/" + escapeHTMLURI(current_room)
 487                 + "/dummy_name_for_new_mail"
 488                 + "?wefw="      + msm_field("ctdl_mc_references", "!")                          // references (if present)
 489                 + "&subj="      + msm_field("ctdl-compose-subject-field", " ")                  // subject (if present)
 490                 + "&mailto="    + msm_field("ctdl-compose-to-field", ",")                       // To: (required)
 491                 + "&mailcc="    + msm_field("ctdl-compose-cc-field", ",")                       // Cc: (if present)
 492                 + "&mailbcc="   + msm_field("ctdl-compose-bcc-field", ",")                      // Bcc: (if present)
 493         ;
 494         boundary = randomString();
 495         body_text =
 496                 "--" + boundary + "\r\n"
 497                 + "Content-type: text/html\r\n"
 498                 + "Content-transfer-encoding: quoted-printable\r\n"
 499                 + "\r\n"
 500                 + quoted_printable_encode(
 501                         "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
 502                 ) + "\r\n"
 503                 + "--" + boundary + "--\r\n"
 504         ;
 505
 506         var request = new XMLHttpRequest();
 507         request.open("PUT", url, true);
 508         request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
 509         request.onreadystatechange = function() {
 510                 if (request.readyState == 4) {
 511                         document.body.style.cursor = "default";
 512                         if (Math.trunc(request.status / 100) == 2) {
 513                                 headers = request.getAllResponseHeaders().split("\n");
 514                                 for (var i in headers) {
 515                                         if (headers[i].startsWith("etag: ")) {
 516                                                 new_msg_num = headers[i].split(" ")[1];
 517                                         }
 518                                 }
 519
 520                                 // After saving the message, go back to the mailbox view.
 521                                 gotoroom(current_room);
 522
 523                         }
 524                         else {
 525                                 error_message = request.responseText;
 526                                 if (error_message.length == 0) {
 527                                         error_message = _("An error has occurred.");
 528                                 }
 529                                 alert(error_message);                                           // editor remains open
 530                         }
 531                 }
 532         };
 533         request.send(body_text);
 534 }