1 // This module handles the view for "mailbox" rooms.
3 // Copyright (c) 2016-2023 by the citadel.org team
5 // This program is open source software. Use, duplication, or
6 // disclosure are subject to the GNU General Public License v3.
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
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
22 if (is_trash_folder) {
23 response = await fetch(
24 "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + m,
26 method: "DELETE" // If this is the Trash folder, delete permanently
31 response = await fetch(
32 "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + m,
34 method: "MOVE", // Otherwise, move to the Trash folder
35 headers: { "Destination" : "/ctdl/r/_TRASH_" }
40 if (response.ok) { // If the server accepted the delete, blank out the message div
41 table.deleteRow(row.rowIndex);
42 if (m == displayed_message) {
43 document.getElementById("ctdl-mailbox-reading-pane").innerHTML = "";
44 displayed_message = 0;
50 // Delete the selected messages (can be activated by mouse click or keypress)
51 function mail_delete_selected() {
52 let table = document.getElementById("ctdl-onscreen-mailbox");
54 for (i=0; row=table.rows[i]; ++i) {
55 if (row.classList.contains("ctdl-mail-selected")) {
56 mail_delete_func(table, row);
62 // Handler function for keypresses detected while the mail view is displayed. Mainly for deleting messages.
63 function mail_keypress(event) {
65 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
66 // so cancel the event listener.
68 document.getElementById("ctdl-mailbox-pane").innerHTML;
71 document.removeEventListener("keydown", mail_keypress);
75 const key = event.key.toLowerCase();
76 if (key == "delete") {
77 mail_delete_selected();
83 // Handler function for dragging email messages to other folders
84 function mail_dragstart(event) {
87 let table = document.getElementById("ctdl-onscreen-mailbox");
88 let messages_being_dragged = [] ;
90 if (event.target.classList.contains("ctdl-mail-selected")) {
91 // The row being dragged IS selected. See if any OTHER rows are selected, and they will come along for the ride.
92 for (i=1; row=table.rows[i]; ++i) {
93 if (row.classList.contains("ctdl-mail-selected")) {
95 messages_being_dragged.push(row.id); // Tell the clipboard what's being moved.
100 // The row being dragged is NOT selected. It will be dragged on its own, ignoring the selected rows.
102 messages_being_dragged.push(event.target.id); // Tell the clipboard what's being moved.
105 // Set the custom drag image to an envelope + number of messages being dragged
106 d = document.getElementById("ctdl_draggo");
107 d.innerHTML = "<font size='+2'><i class='fa fa-envelope' style='color: red'></i> " + count + "</font>"
108 event.dataTransfer.setDragImage(d, 0, 0);
109 event.dataTransfer.setData("text", messages_being_dragged);
113 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
114 function reply_addr(msg) {
116 //return([msg.from]);
119 return([msg.from + " <" + msg.rfca + ">"]);
124 // Render the To: recipients for a reply-all operation
125 function replyall_to(msg) {
126 return([...reply_addr(msg), ...msg.rcpt]);
130 // Render a message into the mailbox view
131 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
132 function mail_render_one(msgnum, msg, target_div, include_controls) {
136 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
139 if (include_controls) { // omit controls if this is a pull quote
141 let subject = msg.subj ? escapeJS(msg.subj) : "" ;
144 render_userpic(msg.from) // user avatar
145 + "<div class=\"ctdl-mmsg-content\">" // begin content
146 + "<div class=\"ctdl-msg-header\">" // begin header
147 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
148 + render_msg_author(msg, views.VIEW_MAILBOX)
149 + "<span class=\"ctdl-msgdate\">"
150 + string_timestamp(msg.time,0)
151 + "</span>" // end msgdate
152 + "</span>" // end header info on left side
153 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
155 + "<span class=\"ctdl-msg-button\">" // Reply
156 + `<a href="javascript:mail_compose(msg.wefw, ${msgnum}, reply_addr(msg), [], 'Re: ${subject}');">`
157 + "<i class=\"fa fa-reply\"></i> "
161 + "<span class=\"ctdl-msg-button\">" // Reply-All
162 + `<a href="javascript:mail_compose(msg.wefw, ${msgnum}, replyall_to(msg), msg.cccc, 'Re: ${subject}');">`
163 + "<i class=\"fa fa-reply-all\"></i> "
167 + "<span class=\"ctdl-msg-button\">" // Forward FIXME
168 + `<a href="javascript:mail_compose(msg.wefw, ${msgnum}, [], [], 'Re: ${subject}');">`
169 + "<i class=\"fa fa-mail-forward\"></i> "
173 if (can_delete_messages) {
175 "<span class=\"ctdl-msg-button\">"
176 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
177 + "<i class=\"fa fa-trash\"></i> "
183 "</span>"; // end buttons on right side
185 // Display the To: recipients, if any are present
187 outmsg += "<br><span>" + _("To:") + " ";
188 for (let r=0; r<msg.rcpt.length; ++r) {
192 outmsg += escapeHTML(msg.rcpt[r]);
197 // Display the Cc: recipients, if any are present
199 outmsg += "<br><span>" + _("Cc:") + " ";
200 for (let r=0; r<msg.cccc.length; ++r) {
204 outmsg += escapeHTML(msg.cccc[r]);
209 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
212 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
216 "</div>"; // end header
219 // Display attachments, if any are present
221 let display_attachments = 0;
222 for (let r=0; r<msg.part.length; ++r) {
223 if (msg.part[r].disp == "attachment") {
224 if (display_attachments == 0) {
227 display_attachments += 1;
229 + "<a href=\"/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/" + msg.part[r].partnum + "/" + escapeHTMLURI(msg.part[r].filename) + "\" target=\"_blank\">"
230 + "<i class=\"fa fa-paperclip\"></i> " + msg.part[r].partnum + ": " + msg.part[r].filename
231 + " (" + msg.part[r].len + " " + _("bytes") + ")"
236 if (display_attachments > 0) {
237 outmsg += "</ul><br>";
243 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
245 + "</div>" // end body
246 + "</div>" // end content
247 + "</div>" // end wrapper
251 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
254 target_div.innerHTML = outmsg;
258 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
259 function mail_display_message(msgnum, target_div, include_controls) {
260 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
261 mail_fetch_msg = async() => {
262 response = await fetch(url);
263 msg = await(response.json());
265 mail_render_one(msgnum, msg, target_div, include_controls);
272 // A message has been selected...
273 function click_message(event, msgnum) {
274 var table = document.getElementById("ctdl-onscreen-mailbox");
277 // ctrl + click = toggle an individual message without changing existing selection
279 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
282 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
283 else if (event.shiftKey) {
284 for (i=1; row=table.rows[i]; ++i) {
285 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
287 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
288 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
290 row.classList.add("ctdl-mail-selected");
293 row.classList.remove("ctdl-mail-selected");
298 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
300 for (i=1; row=table.rows[i]; ++i) {
301 if (row["id"] == "ctdl-msgsum-" + msgnum) {
302 row.classList.add("ctdl-mail-selected");
305 row.classList.remove("ctdl-mail-selected");
310 // display the message if it isn't already displayed
311 if (displayed_message != msgnum) {
312 displayed_message = msgnum;
313 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
318 // render one row in the mailbox table (this could be called from one of several places)
319 function mail_render_row(msg, is_selected) {
321 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
322 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
323 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
324 + "onselectstart=\"return false;\" "
325 + "draggable=\"true\" "
326 + "ondragstart=\"mail_dragstart(event)\" "
328 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
329 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
330 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
331 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
337 // RENDERER FOR THIS VIEW
338 function view_render_mail() {
339 // Put the "enter new message" button into the topbar
340 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
341 document.getElementById("ctdl-newmsg-button").style.display = "block";
343 // Put the "delete message(s)" button into the topbar
344 let d = document.getElementById("ctdl-delete-button");
345 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
346 d.style.display = "block";
347 //d.addEventListener("click", mail_delete_selected);
349 document.getElementById("ctdl-main").innerHTML
350 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
351 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
352 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
356 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
357 render_mailbox_display(newmail_notify.NO);
358 try { // if this was already set up, clear it so there aren't multiple
359 clearInterval(RefreshMailboxInterval);
363 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
367 // Refresh the mailbox, either for the first time or whenever needed
368 function refresh_mail_display() {
369 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
370 // so cancel the refresh.
372 document.getElementById("ctdl-mailbox-pane").innerHTML;
375 clearInterval(RefreshMailboxInterval);
379 // Ask the server if the room has been written to since our last look at it.
380 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
381 fetch_stat = async() => {
382 response = await fetch(url);
383 stat = await(response.json());
384 if (stat.room_mtime > room_mtime) { // if modified...
385 room_mtime = stat.room_mtime;
386 render_mailbox_display(newmail_notify.YES); // ...force a refresh
393 // This is where the rendering of the message list in the mailbox view is performed.
394 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
395 function render_mailbox_display(notify) {
397 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
398 fetch_mailbox = async() => {
399 response = await fetch(url);
400 msgs = await(response.json());
402 var previously_selected = [];
403 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
406 // If one or more messages was already selected, remember them so we can re-select them
407 if ( (displayed_message > 0) && (oldtable) ) {
408 for (i=0; row=oldtable.rows[i]; ++i) {
409 if (row.classList.contains("ctdl-mail-selected")) {
410 previously_selected.push(parseInt(row["id"].substring(12)));
415 // begin rendering the mailbox table
416 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
417 + "<th>" + _("Subject") + "</th>"
418 + "<th>" + _("Sender") + "</th>"
419 + "<th>" + _("Date") + "</th>"
423 for (let i=0; i<msgs.length; ++i) {
424 let m = parseInt(msgs[i].msgnum);
425 let s = (previously_selected.includes(m));
426 box += mail_render_row(msgs[i], s);
427 if (m > highest_mailnum) {
433 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
434 document.addEventListener("keydown", mail_keypress);
441 // helper function for mail_compose() -- converts a recipient array to a string suitable for the To: or Cc: field
442 function recipient_array_to_string(recps_arr) {
444 let returned_string = ""
449 // first clean up the recipients
450 for (i=0; i<recps_arr.length; ++i) {
451 recps_arr[i] = recps_arr[i].replaceAll("<", "<").replaceAll(">", ">");
455 recps_arr = Array.from(new Set(recps_arr));
457 // now convert it to a string
458 returned_string = "";
459 for (i=0; i<recps_arr.length; ++i) {
461 returned_string += ", ";
463 returned_string += recps_arr[i];
467 return(returned_string);
472 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
474 // references list of references, be sure to use this in a reply
475 // quoted_msgnum if a reply, the msgid of the most recent message in the chain, the one to which we are replying
476 // (set to 0 if this is not a reply)
477 // m_to an ARRAY of zero or more recipients to pre-insert into the To: field
478 // m_cc an ARRAY of zero or more recipients to pre-insert into the Cc: field
479 // m_subject a string to pre-insert into the Subject: field
481 function mail_compose(references, quoted_msgnum, m_to, m_cc, m_subject) {
484 let is_quoted = (quoted_msgnum > 0) ? true : false ;
486 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
487 m_to_str = recipient_array_to_string(m_to);
489 // m_cc will be an array of zero or more recipients for the Cc: field. Convert it to a string.
490 m_cc_str = recipient_array_to_string(m_cc);
492 quoted_div_name = randomString();
494 // Make the "Write mail" button disappear. We're already there!
495 document.getElementById("ctdl-newmsg-button").style.display = "none";
497 // Now display the screen. (Yes, I combined regular strings + template literals.
498 // I just learned template literals. Converting the whole thing to template literals would be fine.)
500 // Hidden values that we are storing right here in the document tree for later
501 "<div id=\"ctdl-mc-references\" style=\"display:none\">" + references + "</div>"
503 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
504 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
506 // Visible To: field, plus a box to make the CC/BCC lines appear
507 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
508 + "<div class=\"ctdl-compose-to-line\">"
509 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
510 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
511 + "onClick=\"make_cc_bcc_visible()\">"
512 + _("CC:") + "/" + _("BCC:") + "</div>"
516 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
517 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
518 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
519 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
521 // Visible subject field
522 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
523 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
525 // Message composition box
526 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
529 // If this is a quoted reply, insert a div within which we will render the original message.
531 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\">QUOTED MESSAGE HERE</div></blockquote>";
534 // The button bar is a Grid element, and is also a Flexbox container.
537 <div class="ctdl-compose-toolbar">
538 <span class="ctdl-msg-button" onclick="mail_send_message()"><i class="fa fa-paper-plane" style="color:green"></i> ${_("Send message")} </span>
539 <span class="ctdl-msg-button"> ${_("Save to Drafts")} </span>
540 <span class="ctdl-msg-button" onClick="show_or_hide_upload_window()"><i class="fa fa-paperclip" style="color:grey"></i> ${_("Attachments:")} <span id="ctdl_num_attachments"> ${uploads.length} </span></span>
541 <span class="ctdl-msg-button"> ${_("Contacts")} </span>
542 <span class="ctdl-msg-button" onClick="flush_uploads();gotoroom(current_room)"><i class="fa fa-trash" style="color:red"></i> ${_("Cancel")} </span>
547 document.getElementById("ctdl-main").innerHTML = compose_screen;
550 document.getElementById("ctdl-compose-cc-label").style.display = "block";
551 document.getElementById("ctdl-compose-cc-field").style.display = "block";
554 activate_uploads("ctdl-editor-body");
556 // If this is a quoted reply, render the original message into the div we set up earlier.
558 document.getElementById(quoted_div_name).innerHTML = quoted_msgnum;
559 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
563 setTimeout(() => { document.getElementById("ctdl-editor-body").focus(); }, 0);
566 setTimeout(() => { document.getElementById("ctdl-compose-to-field").focus(); }, 0);
571 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
572 // It is also called automatically during a Reply when CC is pre-populated.
573 function make_cc_bcc_visible() {
574 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
575 document.getElementById("ctdl-compose-cc-label").style.display = "block";
576 document.getElementById("ctdl-compose-cc-field").style.display = "block";
577 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
578 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
582 // Helper function for mail_send_messages() to extract and decode metadata values.
583 function msm_field(element_name, separator) {
584 let s1 = document.getElementById(element_name).innerHTML;
585 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel
586 let s3 = decodeURI(s2);
587 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
594 // Save the posted message to the server
595 function mail_send_message() {
597 document.body.style.cursor = "wait";
598 deactivate_uploads();
599 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
600 + "/dummy_name_for_new_mail"
601 + "?wefw=" + msm_field("ctdl-mc-references", "!") // references (if present)
602 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
603 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
604 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
605 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
607 if (uploads.length > 0) {
609 for (let i=0; i<uploads.length; ++i) {
610 url += uploads[i]["ref"];
611 if (i != uploads.length - 1) {
616 body_text = "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>\r\n";
618 var request = new XMLHttpRequest();
619 request.open("PUT", url, true);
620 request.setRequestHeader("Content-type", "text/html");
621 request.onreadystatechange = function() {
622 if (request.readyState == 4) {
623 document.body.style.cursor = "default";
624 if (Math.trunc(request.status / 100) == 2) {
625 headers = request.getAllResponseHeaders().split("\n");
626 for (var i in headers) {
627 if (headers[i].startsWith("etag: ")) {
628 new_msg_num = headers[i].split(" ")[1];
632 // successfully saving a message means the attachments are now gone from the server.
635 // After saving the message, go back to the mailbox view.
636 gotoroom(current_room);
640 error_message = request.responseText;
641 if (error_message.length == 0) {
642 error_message = _("An error has occurred.");
644 alert(error_message); // editor remains open
648 request.send(body_text);