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 render_userpic(msg.from) // user avatar
142 + "<div class=\"ctdl-mmsg-content\">" // begin content
143 + "<div class=\"ctdl-msg-header\">" // begin header
144 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
145 + render_msg_author(msg, views.VIEW_MAILBOX)
146 + "<span class=\"ctdl-msgdate\">"
147 + string_timestamp(msg.time,0)
148 + "</span>" // end msgdate
149 + "</span>" // end header info on left side
150 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
152 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
153 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
154 + "<i class=\"fa fa-reply\"></i> "
158 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
159 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
160 + "<i class=\"fa fa-reply-all\"></i> "
164 if (can_delete_messages) {
166 "<span class=\"ctdl-msg-button\">"
167 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
168 + "<i class=\"fa fa-trash\"></i> "
174 "</span>"; // end buttons on right side
176 // Display the To: recipients, if any are present
178 outmsg += "<br><span>" + _("To:") + " ";
179 for (let r=0; r<msg.rcpt.length; ++r) {
183 outmsg += escapeHTML(msg.rcpt[r]);
188 // Display the Cc: recipients, if any are present
190 outmsg += "<br><span>" + _("Cc:") + " ";
191 for (let r=0; r<msg.cccc.length; ++r) {
195 outmsg += escapeHTML(msg.cccc[r]);
200 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
203 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
207 "</div>"; // end header
210 // Display attachments, if any are present
212 let display_attachments = 0;
213 for (let r=0; r<msg.part.length; ++r) {
214 if (msg.part[r].disp == "attachment") {
215 if (display_attachments == 0) {
218 display_attachments += 1;
220 + "<a href=\"/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/" + msg.part[r].partnum + "/" + escapeHTMLURI(msg.part[r].filename) + "\" target=\"_blank\">"
221 + "<i class=\"fa fa-paperclip\"></i> " + msg.part[r].partnum + ": " + msg.part[r].filename
222 + " (" + msg.part[r].len + " " + _("bytes") + ")"
227 if (display_attachments > 0) {
228 outmsg += "</ul><br>";
234 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
236 + "</div>" // end body
237 + "</div>" // end content
238 + "</div>" // end wrapper
242 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
245 target_div.innerHTML = outmsg;
249 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
250 function mail_display_message(msgnum, target_div, include_controls) {
251 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
252 mail_fetch_msg = async() => {
253 response = await fetch(url);
254 msg = await(response.json());
256 mail_render_one(msgnum, msg, target_div, include_controls);
263 // A message has been selected...
264 function click_message(event, msgnum) {
265 var table = document.getElementById("ctdl-onscreen-mailbox");
268 // ctrl + click = toggle an individual message without changing existing selection
270 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
273 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
274 else if (event.shiftKey) {
275 for (i=1; row=table.rows[i]; ++i) {
276 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
278 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
279 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
281 row.classList.add("ctdl-mail-selected");
284 row.classList.remove("ctdl-mail-selected");
289 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
291 for (i=1; row=table.rows[i]; ++i) {
292 if (row["id"] == "ctdl-msgsum-" + msgnum) {
293 row.classList.add("ctdl-mail-selected");
296 row.classList.remove("ctdl-mail-selected");
301 // display the message if it isn't already displayed
302 if (displayed_message != msgnum) {
303 displayed_message = msgnum;
304 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
309 // render one row in the mailbox table (this could be called from one of several places)
310 function mail_render_row(msg, is_selected) {
312 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
313 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
314 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
315 + "onselectstart=\"return false;\" "
316 + "draggable=\"true\" "
317 + "ondragstart=\"mail_dragstart(event)\" "
319 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
320 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
321 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
322 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
328 // RENDERER FOR THIS VIEW
329 function view_render_mail() {
330 // Put the "enter new message" button into the topbar
331 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
332 document.getElementById("ctdl-newmsg-button").style.display = "block";
334 // Put the "delete message(s)" button into the topbar
335 let d = document.getElementById("ctdl-delete-button");
336 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
337 d.style.display = "block";
338 //d.addEventListener("click", mail_delete_selected);
340 document.getElementById("ctdl-main").innerHTML
341 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
342 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
343 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
347 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
348 render_mailbox_display(newmail_notify.NO);
349 try { // if this was already set up, clear it so there aren't multiple
350 clearInterval(RefreshMailboxInterval);
354 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
358 // Refresh the mailbox, either for the first time or whenever needed
359 function refresh_mail_display() {
360 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
361 // so cancel the refresh.
363 document.getElementById("ctdl-mailbox-pane").innerHTML;
366 clearInterval(RefreshMailboxInterval);
370 // Ask the server if the room has been written to since our last look at it.
371 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
372 fetch_stat = async() => {
373 response = await fetch(url);
374 stat = await(response.json());
375 if (stat.room_mtime > room_mtime) { // if modified...
376 room_mtime = stat.room_mtime;
377 render_mailbox_display(newmail_notify.YES); // ...force a refresh
384 // This is where the rendering of the message list in the mailbox view is performed.
385 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
386 function render_mailbox_display(notify) {
388 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
389 fetch_mailbox = async() => {
390 response = await fetch(url);
391 msgs = await(response.json());
393 var previously_selected = [];
394 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
397 // If one or more messages was already selected, remember them so we can re-select them
398 if ( (displayed_message > 0) && (oldtable) ) {
399 for (i=0; row=oldtable.rows[i]; ++i) {
400 if (row.classList.contains("ctdl-mail-selected")) {
401 previously_selected.push(parseInt(row["id"].substring(12)));
406 // begin rendering the mailbox table
407 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
408 + "<th>" + _("Subject") + "</th>"
409 + "<th>" + _("Sender") + "</th>"
410 + "<th>" + _("Date") + "</th>"
414 for (let i=0; i<msgs.length; ++i) {
415 let m = parseInt(msgs[i].msgnum);
416 let s = (previously_selected.includes(m));
417 box += mail_render_row(msgs[i], s);
418 if (m > highest_mailnum) {
424 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
425 document.addEventListener("keydown", mail_keypress);
432 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
433 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
437 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
440 m_to = Array.from(new Set(m_to)); // remove dupes
442 for (i=0; i<m_to.length; ++i) {
446 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
453 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
456 m_cc = Array.from(new Set(m_cc)); // remove dupes
458 for (i=0; i<m_cc.length; ++i) {
462 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
469 quoted_div_name = randomString();
471 // Make the "Write mail" button disappear. We're already there!
472 document.getElementById("ctdl-newmsg-button").style.display = "none";
474 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
475 // references list of references, be sure to use this in a reply
476 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
478 // Now display the screen. (Yes, I combined regular strings + template literals. I just learned template literals. Converting to all template literals would be fine.)
480 // Hidden values that we are storing right here in the document tree for later
481 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
482 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
484 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
485 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
487 // Visible To: field, plus a box to make the CC/BCC lines appear
488 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
489 + "<div class=\"ctdl-compose-to-line\">"
490 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
491 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
492 + "onClick=\"make_cc_bcc_visible()\">"
493 + _("CC:") + "/" + _("BCC:") + "</div>"
497 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
498 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
499 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
500 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
502 // Visible subject field
503 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
504 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
506 // Message composition box
507 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
510 // If this is a quoted reply, insert a div within which we will render the original message.
512 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\">QUOTED MESSAGE HERE</div></blockquote>";
515 // The button bar is a Grid element, and is also a Flexbox container.
518 <div class="ctdl-compose-toolbar">
519 <span class="ctdl-msg-button" onclick="mail_send_message()"><i class="fa fa-paper-plane" style="color:green"></i> ${_("Send message")} </span>
520 <span class="ctdl-msg-button"> ${_("Save to Drafts")} </span>
521 <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>
522 <span class="ctdl-msg-button"> ${_("Contacts")} </span>
523 <span class="ctdl-msg-button" onClick="flush_uploads();gotoroom(current_room)"><i class="fa fa-trash" style="color:red"></i> ${_("Cancel")} </span>
528 document.getElementById("ctdl-main").innerHTML = compose_screen;
531 document.getElementById("ctdl-compose-cc-label").style.display = "block";
532 document.getElementById("ctdl-compose-cc-field").style.display = "block";
535 activate_uploads("ctdl-editor-body");
537 // If this is a quoted reply, render the original message into the div we set up earlier.
539 document.getElementById(quoted_div_name).innerHTML = quoted_msgnum;
540 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
544 setTimeout(() => { document.getElementById("ctdl-editor-body").focus(); }, 0);
547 setTimeout(() => { document.getElementById("ctdl-compose-to-field").focus(); }, 0);
552 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
553 // It is also called automatically during a Reply when CC is pre-populated.
554 function make_cc_bcc_visible() {
555 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
556 document.getElementById("ctdl-compose-cc-label").style.display = "block";
557 document.getElementById("ctdl-compose-cc-field").style.display = "block";
558 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
559 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
563 // Helper function for mail_send_messages() to extract and decode metadata values.
564 function msm_field(element_name, separator) {
565 let s1 = document.getElementById(element_name).innerHTML;
566 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel
567 let s3 = decodeURI(s2);
568 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
575 // Save the posted message to the server
576 function mail_send_message() {
578 document.body.style.cursor = "wait";
579 deactivate_uploads();
580 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
581 + "/dummy_name_for_new_mail"
582 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
583 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
584 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
585 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
586 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
588 if (uploads.length > 0) {
590 for (let i=0; i<uploads.length; ++i) {
591 url += uploads[i]["ref"];
592 if (i != uploads.length - 1) {
597 body_text = "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>\r\n";
599 var request = new XMLHttpRequest();
600 request.open("PUT", url, true);
601 request.setRequestHeader("Content-type", "text/html");
602 request.onreadystatechange = function() {
603 if (request.readyState == 4) {
604 document.body.style.cursor = "default";
605 if (Math.trunc(request.status / 100) == 2) {
606 headers = request.getAllResponseHeaders().split("\n");
607 for (var i in headers) {
608 if (headers[i].startsWith("etag: ")) {
609 new_msg_num = headers[i].split(" ")[1];
613 // successfully saving a message means the attachments are now gone from the server.
616 // After saving the message, go back to the mailbox view.
617 gotoroom(current_room);
621 error_message = request.responseText;
622 if (error_message.length == 0) {
623 error_message = _("An error has occurred.");
625 alert(error_message); // editor remains open
629 request.send(body_text);