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 // Figure out how many messages are being dragged
90 for (i=1; row=table.rows[i]; ++i) {
91 if (row.classList.contains("ctdl-mail-selected")) {
96 // Set the custom drag image to an envelope + number of messages being dragged
97 d = document.getElementById("ctdl_draggo");
98 d.innerHTML = "<font size='+3'><i class='fa fa-envelope' style='color: red'></i> " + count + "</font>"
99 event.dataTransfer.setDragImage(d, 0, 0);
100 event.dataTransfer.setData("text/html", "blah blah blah");
101 console.log("source dragstart");
105 // Handler function for dragging email messages to other folders
106 function mail_dragend(event) {
107 console.log("source dragend");
111 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
112 function reply_addr(msg) {
114 //return([msg.from]);
117 return([msg.from + " <" + msg.rfca + ">"]);
122 // Render the To: recipients for a reply-all operation
123 function replyall_to(msg) {
124 return([...reply_addr(msg), ...msg.rcpt]);
128 // Render a message into the mailbox view
129 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
130 function mail_render_one(msgnum, msg, target_div, include_controls) {
134 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
137 if (include_controls) { // omit controls if this is a pull quote
139 render_userpic(msg.from) // user avatar
140 + "<div class=\"ctdl-mmsg-content\">" // begin content
141 + "<div class=\"ctdl-msg-header\">" // begin header
142 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
143 + render_msg_author(msg, views.VIEW_MAILBOX)
144 + "<span class=\"ctdl-msgdate\">"
145 + string_timestamp(msg.time,0)
146 + "</span>" // end msgdate
147 + "</span>" // end header info on left side
148 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
150 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
151 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
152 + "<i class=\"fa fa-reply\"></i> "
156 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
157 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
158 + "<i class=\"fa fa-reply-all\"></i> "
162 if (can_delete_messages) {
164 "<span class=\"ctdl-msg-button\">"
165 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
166 + "<i class=\"fa fa-trash\"></i> "
172 "</span>"; // end buttons on right side
174 // Display the To: recipients, if any are present
176 outmsg += "<br><span>" + _("To:") + " ";
177 for (var r=0; r<msg.rcpt.length; ++r) {
181 outmsg += escapeHTML(msg.rcpt[r]);
186 // Display the Cc: recipients, if any are present
188 outmsg += "<br><span>" + _("Cc:") + " ";
189 for (var r=0; r<msg.cccc.length; ++r) {
193 outmsg += escapeHTML(msg.cccc[r]);
198 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
201 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
205 "</div>"; // end header
209 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
211 + "</div>" // end body
212 + "</div>" // end content
213 + "</div>" // end wrapper
217 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
220 target_div.innerHTML = outmsg;
224 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
225 function mail_display_message(msgnum, target_div, include_controls) {
226 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
227 mail_fetch_msg = async() => {
228 response = await fetch(url);
229 msg = await(response.json());
231 mail_render_one(msgnum, msg, target_div, include_controls);
238 // after a message is selected or deselected, we call this to set or clear the drag handler.
239 function enable_or_disable_draggable(row) {
240 if (row.classList.contains("ctdl-mail-selected")) {
241 row.draggable = "true"
242 row.addEventListener("dragstart", mail_dragstart);
243 row.addEventListener("dragend", mail_dragend);
246 row.draggable = "false"
247 row.removeEventListener("dragstart", mail_dragstart);
248 row.removeEventListener("dragend", mail_dragend);
254 // A message has been selected...
255 function click_message(event, msgnum) {
256 var table = document.getElementById("ctdl-onscreen-mailbox");
259 // ctrl + click = toggle an individual message without changing existing selection
261 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
262 enable_or_disable_draggable(document.getElementById("ctdl-msgsum-" + msgnum));
265 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
266 else if (event.shiftKey) {
267 for (i=1; row=table.rows[i]; ++i) {
268 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
270 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
271 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
273 row.classList.add("ctdl-mail-selected");
276 row.classList.remove("ctdl-mail-selected");
278 enable_or_disable_draggable(row);
282 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
284 for (i=1; row=table.rows[i]; ++i) {
285 if (row["id"] == "ctdl-msgsum-" + msgnum) {
286 row.classList.add("ctdl-mail-selected");
289 row.classList.remove("ctdl-mail-selected");
291 enable_or_disable_draggable(row);
295 // display the message if it isn't already displayed
296 if (displayed_message != msgnum) {
297 displayed_message = msgnum;
298 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
303 // render one row in the mailbox table (this could be called from one of several places)
304 function mail_render_row(msg, is_selected) {
306 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
307 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
308 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
309 + "onselectstart=\"return false;\""
311 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
312 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
313 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
314 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
320 // RENDERER FOR THIS VIEW
321 function view_render_mail() {
322 // Put the "enter new message" button into the topbar
323 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
324 document.getElementById("ctdl-newmsg-button").style.display = "block";
326 // Put the "delete message(s)" button into the topbar
327 let d = document.getElementById("ctdl-delete-button");
328 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
329 d.style.display = "block";
330 //d.addEventListener("click", mail_delete_selected);
332 document.getElementById("ctdl-main").innerHTML
333 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
334 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
335 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
339 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
340 render_mailbox_display(newmail_notify.NO);
341 try { // if this was already set up, clear it so there aren't multiple
342 clearInterval(RefreshMailboxInterval);
346 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
350 // Refresh the mailbox, either for the first time or whenever needed
351 function refresh_mail_display() {
352 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
353 // so cancel the refresh.
355 document.getElementById("ctdl-mailbox-pane").innerHTML;
358 clearInterval(RefreshMailboxInterval);
362 // Ask the server if the room has been written to since our last look at it.
363 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
364 fetch_stat = async() => {
365 response = await fetch(url);
366 stat = await(response.json());
367 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
368 room_mtime = stat.room_mtime;
369 render_mailbox_display(newmail_notify.YES);
376 // This is where the rendering of the message list in the mailbox view is performed.
377 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
378 function render_mailbox_display(notify) {
380 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
381 fetch_mailbox = async() => {
382 response = await fetch(url);
383 msgs = await(response.json());
385 var previously_selected = [];
386 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
389 // If one or more messages was already selected, remember them so we can re-select them
390 if ( (displayed_message > 0) && (oldtable) ) {
391 for (i=0; row=oldtable.rows[i]; ++i) {
392 if (row.classList.contains("ctdl-mail-selected")) {
393 previously_selected.push(parseInt(row["id"].substring(12)));
398 // begin rendering the mailbox table
399 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
400 + "<th>" + _("Subject") + "</th>"
401 + "<th>" + _("Sender") + "</th>"
402 + "<th>" + _("Date") + "</th>"
406 for (let i=0; i<msgs.length; ++i) {
407 let m = parseInt(msgs[i].msgnum);
408 let s = (previously_selected.includes(m));
409 box += mail_render_row(msgs[i], s);
410 if (m > highest_mailnum) {
416 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
417 document.addEventListener("keydown", mail_keypress);
424 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
425 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
426 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
428 m_to = Array.from(new Set(m_to)); // remove dupes
430 for (i=0; i<m_to.length; ++i) {
434 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
441 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
443 m_cc = Array.from(new Set(m_cc)); // remove dupes
445 for (i=0; i<m_cc.length; ++i) {
449 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
456 quoted_div_name = randomString();
458 // Make the "Write mail" button disappear. We're already there!
459 document.getElementById("ctdl-newmsg-button").style.display = "none";
461 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
462 // references list of references, be sure to use this in a reply
463 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
465 // Now display the screen.
467 // Hidden values that we are storing right here in the document tree for later
468 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
469 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
471 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
472 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
474 // Visible To: field, plus a box to make the CC/BCC lines appear
475 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
476 + "<div class=\"ctdl-compose-to-line\">"
477 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
478 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
479 + "onClick=\"make_cc_bcc_visible()\">"
480 + _("CC:") + "/" + _("BCC:") + "</div>"
484 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
485 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
486 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
487 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
489 // Visible subject field
490 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
491 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
493 // Message composition box
494 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
498 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
504 // The button bar is a Grid element, and is also a Flexbox container.
505 + "<div class=\"ctdl-compose-toolbar\">"
506 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
507 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
508 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
509 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
510 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
514 document.getElementById("ctdl-main").innerHTML = compose_screen;
515 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
517 document.getElementById("ctdl-compose-cc-label").style.display = "block";
518 document.getElementById("ctdl-compose-cc-field").style.display = "block";
523 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
524 // It is also called automatically during a Reply when CC is pre-populated.
525 function make_cc_bcc_visible() {
526 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
527 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
528 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
532 // Helper function for mail_send_messages() to extract and decode metadata values.
533 function msm_field(element_name, separator) {
534 let s1 = document.getElementById(element_name).innerHTML;
535 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel
536 let s3 = decodeURI(s2);
537 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
544 // Save the posted message to the server
545 function mail_send_message() {
547 document.body.style.cursor = "wait";
548 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
549 + "/dummy_name_for_new_mail"
550 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
551 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
552 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
553 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
554 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
556 boundary = randomString();
558 "--" + boundary + "\r\n"
559 + "Content-type: text/html\r\n"
560 + "Content-transfer-encoding: quoted-printable\r\n"
562 + quoted_printable_encode(
563 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
565 + "--" + boundary + "--\r\n"
568 var request = new XMLHttpRequest();
569 request.open("PUT", url, true);
570 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
571 request.onreadystatechange = function() {
572 if (request.readyState == 4) {
573 document.body.style.cursor = "default";
574 if (Math.trunc(request.status / 100) == 2) {
575 headers = request.getAllResponseHeaders().split("\n");
576 for (var i in headers) {
577 if (headers[i].startsWith("etag: ")) {
578 new_msg_num = headers[i].split(" ")[1];
582 // After saving the message, go back to the mailbox view.
583 gotoroom(current_room);
587 error_message = request.responseText;
588 if (error_message.length == 0) {
589 error_message = _("An error has occurred.");
591 alert(error_message); // editor remains open
595 request.send(body_text);