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 var 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 var table = document.getElementById("ctdl-onscreen-mailbox");
89 for (i=1; row=table.rows[i]; ++i) {
90 if (row.classList.contains("ctdl-mail-selected")) {
95 d = document.getElementById("ctdl_draggo");
96 d.innerHTML = "<font size='+3'><i class='fa fa-envelope' style='color: red'></i> " + count + "</font>"
97 event.dataTransfer.setDragImage(d, 0, 0);
101 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
102 function reply_addr(msg) {
104 //return([msg.from]);
107 return([msg.from + " <" + msg.rfca + ">"]);
112 // Render the To: recipients for a reply-all operation
113 function replyall_to(msg) {
114 return([...reply_addr(msg), ...msg.rcpt]);
118 // Render a message into the mailbox view
119 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
120 function mail_render_one(msgnum, msg, target_div, include_controls) {
124 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
127 if (include_controls) { // omit controls if this is a pull quote
129 render_userpic(msg.from) // user avatar
130 + "<div class=\"ctdl-mmsg-content\">" // begin content
131 + "<div class=\"ctdl-msg-header\">" // begin header
132 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
133 + render_msg_author(msg, views.VIEW_MAILBOX)
134 + "<span class=\"ctdl-msgdate\">"
135 + string_timestamp(msg.time,0)
136 + "</span>" // end msgdate
137 + "</span>" // end header info on left side
138 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
140 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
141 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
142 + "<i class=\"fa fa-reply\"></i> "
146 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
147 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
148 + "<i class=\"fa fa-reply-all\"></i> "
152 if (can_delete_messages) {
154 "<span class=\"ctdl-msg-button\">"
155 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
156 + "<i class=\"fa fa-trash\"></i> "
162 "</span>"; // end buttons on right side
164 // Display the To: recipients, if any are present
166 outmsg += "<br><span>" + _("To:") + " ";
167 for (var r=0; r<msg.rcpt.length; ++r) {
171 outmsg += escapeHTML(msg.rcpt[r]);
176 // Display the Cc: recipients, if any are present
178 outmsg += "<br><span>" + _("Cc:") + " ";
179 for (var r=0; r<msg.cccc.length; ++r) {
183 outmsg += escapeHTML(msg.cccc[r]);
188 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
191 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
195 "</div>"; // end header
199 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
201 + "</div>" // end body
202 + "</div>" // end content
203 + "</div>" // end wrapper
207 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
210 target_div.innerHTML = outmsg;
214 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
215 function mail_display_message(msgnum, target_div, include_controls) {
216 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
217 mail_fetch_msg = async() => {
218 response = await fetch(url);
219 msg = await(response.json());
221 mail_render_one(msgnum, msg, target_div, include_controls);
228 // after a message is selected or deselected, we call this to set or clear the drag handler.
229 function enable_or_disable_draggable(row) {
230 if (row.classList.contains("ctdl-mail-selected")) {
231 row.draggable = "true"
232 row.addEventListener("dragstart", mail_dragstart);
235 row.draggable = "false"
236 row.removeEventListener("dragstart", mail_dragstart);
242 // A message has been selected...
243 function click_message(event, msgnum) {
244 var table = document.getElementById("ctdl-onscreen-mailbox");
247 // ctrl + click = toggle an individual message without changing existing selection
249 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
250 enable_or_disable_draggable(document.getElementById("ctdl-msgsum-" + msgnum));
253 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
254 else if (event.shiftKey) {
255 for (i=1; row=table.rows[i]; ++i) {
256 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
258 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
259 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
261 row.classList.add("ctdl-mail-selected");
264 row.classList.remove("ctdl-mail-selected");
266 enable_or_disable_draggable(row);
270 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
272 for (i=1; row=table.rows[i]; ++i) {
273 if (row["id"] == "ctdl-msgsum-" + msgnum) {
274 row.classList.add("ctdl-mail-selected");
277 row.classList.remove("ctdl-mail-selected");
279 enable_or_disable_draggable(row);
283 // display the message if it isn't already displayed
284 if (displayed_message != msgnum) {
285 displayed_message = msgnum;
286 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
291 // render one row in the mailbox table (this could be called from one of several places)
292 function mail_render_row(msg, is_selected) {
294 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
295 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
296 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
297 + "onselectstart=\"return false;\""
299 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
300 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
301 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
302 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
308 // RENDERER FOR THIS VIEW
309 function view_render_mail() {
310 // Put the "enter new message" button into the topbar
311 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
312 document.getElementById("ctdl-newmsg-button").style.display = "block";
314 // Put the "delete message(s)" button into the topbar
315 let d = document.getElementById("ctdl-delete-button");
316 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
317 d.style.display = "block";
318 //d.addEventListener("click", mail_delete_selected);
320 document.getElementById("ctdl-main").innerHTML
321 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
322 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
323 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
327 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
328 render_mailbox_display(newmail_notify.NO);
329 try { // if this was already set up, clear it so there aren't multiple
330 clearInterval(RefreshMailboxInterval);
334 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
338 // Refresh the mailbox, either for the first time or whenever needed
339 function refresh_mail_display() {
340 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
341 // so cancel the refresh.
343 document.getElementById("ctdl-mailbox-pane").innerHTML;
346 clearInterval(RefreshMailboxInterval);
350 // Ask the server if the room has been written to since our last look at it.
351 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
352 fetch_stat = async() => {
353 response = await fetch(url);
354 stat = await(response.json());
355 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
356 room_mtime = stat.room_mtime;
357 render_mailbox_display(newmail_notify.YES);
364 // This is where the rendering of the message list in the mailbox view is performed.
365 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
366 function render_mailbox_display(notify) {
368 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
369 fetch_mailbox = async() => {
370 response = await fetch(url);
371 msgs = await(response.json());
373 var previously_selected = [];
374 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
377 // If one or more messages was already selected, remember them so we can re-select them
378 if ( (displayed_message > 0) && (oldtable) ) {
379 for (i=0; row=oldtable.rows[i]; ++i) {
380 if (row.classList.contains("ctdl-mail-selected")) {
381 previously_selected.push(parseInt(row["id"].substring(12)));
386 // begin rendering the mailbox table
387 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
388 + "<th>" + _("Subject") + "</th>"
389 + "<th>" + _("Sender") + "</th>"
390 + "<th>" + _("Date") + "</th>"
394 for (let i=0; i<msgs.length; ++i) {
395 let m = parseInt(msgs[i].msgnum);
396 let s = (previously_selected.includes(m));
397 box += mail_render_row(msgs[i], s);
398 if (m > highest_mailnum) {
404 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
405 document.addEventListener("keydown", mail_keypress);
412 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
413 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
414 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
416 m_to = Array.from(new Set(m_to)); // remove dupes
418 for (i=0; i<m_to.length; ++i) {
422 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
429 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
431 m_cc = Array.from(new Set(m_cc)); // remove dupes
433 for (i=0; i<m_cc.length; ++i) {
437 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
444 quoted_div_name = randomString();
446 // Make the "Write mail" button disappear. We're already there!
447 document.getElementById("ctdl-newmsg-button").style.display = "none";
449 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
450 // references list of references, be sure to use this in a reply
451 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
453 // Now display the screen.
455 // Hidden values that we are storing right here in the document tree for later
456 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
457 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
459 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
460 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
462 // Visible To: field, plus a box to make the CC/BCC lines appear
463 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
464 + "<div class=\"ctdl-compose-to-line\">"
465 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
466 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
467 + "onClick=\"make_cc_bcc_visible()\">"
468 + _("CC:") + "/" + _("BCC:") + "</div>"
472 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
473 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
474 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
475 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
477 // Visible subject field
478 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
479 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
481 // Message composition box
482 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
486 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
492 // The button bar is a Grid element, and is also a Flexbox container.
493 + "<div class=\"ctdl-compose-toolbar\">"
494 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
495 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
496 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
497 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
498 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
502 document.getElementById("ctdl-main").innerHTML = compose_screen;
503 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
505 document.getElementById("ctdl-compose-cc-label").style.display = "block";
506 document.getElementById("ctdl-compose-cc-field").style.display = "block";
511 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
512 // It is also called automatically during a Reply when CC is pre-populated.
513 function make_cc_bcc_visible() {
514 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
515 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
516 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
520 // Helper function for mail_send_messages() to extract and decode metadata values.
521 function msm_field(element_name, separator) {
522 let s1 = document.getElementById(element_name).innerHTML;
523 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
524 let s3 = decodeURI(s2);
525 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
532 // Save the posted message to the server
533 function mail_send_message() {
535 document.body.style.cursor = "wait";
536 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
537 + "/dummy_name_for_new_mail"
538 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
539 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
540 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
541 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
542 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
544 boundary = randomString();
546 "--" + boundary + "\r\n"
547 + "Content-type: text/html\r\n"
548 + "Content-transfer-encoding: quoted-printable\r\n"
550 + quoted_printable_encode(
551 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
553 + "--" + boundary + "--\r\n"
556 var request = new XMLHttpRequest();
557 request.open("PUT", url, true);
558 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
559 request.onreadystatechange = function() {
560 if (request.readyState == 4) {
561 document.body.style.cursor = "default";
562 if (Math.trunc(request.status / 100) == 2) {
563 headers = request.getAllResponseHeaders().split("\n");
564 for (var i in headers) {
565 if (headers[i].startsWith("etag: ")) {
566 new_msg_num = headers[i].split(" ")[1];
570 // After saving the message, go back to the mailbox view.
571 gotoroom(current_room);
575 error_message = request.responseText;
576 if (error_message.length == 0) {
577 error_message = _("An error has occurred.");
579 alert(error_message); // editor remains open
583 request.send(body_text);