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");
88 var 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);
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);
105 // FIXME tell the clipboard what's being moved.
107 // Set the custom drag image to an envelope + number of messages being dragged
108 d = document.getElementById("ctdl_draggo");
109 d.innerHTML = "<font size='+2'><i class='fa fa-envelope' style='color: red'></i> " + count + "</font>"
110 event.dataTransfer.setDragImage(d, 0, 0);
111 event.dataTransfer.setData("text", messages_being_dragged);
115 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
116 function reply_addr(msg) {
118 //return([msg.from]);
121 return([msg.from + " <" + msg.rfca + ">"]);
126 // Render the To: recipients for a reply-all operation
127 function replyall_to(msg) {
128 return([...reply_addr(msg), ...msg.rcpt]);
132 // Render a message into the mailbox view
133 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
134 function mail_render_one(msgnum, msg, target_div, include_controls) {
138 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
141 if (include_controls) { // omit controls if this is a pull quote
143 render_userpic(msg.from) // user avatar
144 + "<div class=\"ctdl-mmsg-content\">" // begin content
145 + "<div class=\"ctdl-msg-header\">" // begin header
146 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
147 + render_msg_author(msg, views.VIEW_MAILBOX)
148 + "<span class=\"ctdl-msgdate\">"
149 + string_timestamp(msg.time,0)
150 + "</span>" // end msgdate
151 + "</span>" // end header info on left side
152 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
154 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
155 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
156 + "<i class=\"fa fa-reply\"></i> "
160 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
161 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
162 + "<i class=\"fa fa-reply-all\"></i> "
166 if (can_delete_messages) {
168 "<span class=\"ctdl-msg-button\">"
169 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
170 + "<i class=\"fa fa-trash\"></i> "
176 "</span>"; // end buttons on right side
178 // Display the To: recipients, if any are present
180 outmsg += "<br><span>" + _("To:") + " ";
181 for (var r=0; r<msg.rcpt.length; ++r) {
185 outmsg += escapeHTML(msg.rcpt[r]);
190 // Display the Cc: recipients, if any are present
192 outmsg += "<br><span>" + _("Cc:") + " ";
193 for (var r=0; r<msg.cccc.length; ++r) {
197 outmsg += escapeHTML(msg.cccc[r]);
202 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
205 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
209 "</div>"; // end header
213 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
215 + "</div>" // end body
216 + "</div>" // end content
217 + "</div>" // end wrapper
221 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
224 target_div.innerHTML = outmsg;
228 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
229 function mail_display_message(msgnum, target_div, include_controls) {
230 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
231 mail_fetch_msg = async() => {
232 response = await fetch(url);
233 msg = await(response.json());
235 mail_render_one(msgnum, msg, target_div, include_controls);
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");
252 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
253 else if (event.shiftKey) {
254 for (i=1; row=table.rows[i]; ++i) {
255 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
257 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
258 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
260 row.classList.add("ctdl-mail-selected");
263 row.classList.remove("ctdl-mail-selected");
268 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
270 for (i=1; row=table.rows[i]; ++i) {
271 if (row["id"] == "ctdl-msgsum-" + msgnum) {
272 row.classList.add("ctdl-mail-selected");
275 row.classList.remove("ctdl-mail-selected");
280 // display the message if it isn't already displayed
281 if (displayed_message != msgnum) {
282 displayed_message = msgnum;
283 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
288 // render one row in the mailbox table (this could be called from one of several places)
289 function mail_render_row(msg, is_selected) {
291 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
292 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
293 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
294 + "onselectstart=\"return false;\" "
295 + "draggable=\"true\" "
296 + "ondragstart=\"mail_dragstart(event)\" "
298 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
299 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
300 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
301 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
307 // RENDERER FOR THIS VIEW
308 function view_render_mail() {
309 // Put the "enter new message" button into the topbar
310 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
311 document.getElementById("ctdl-newmsg-button").style.display = "block";
313 // Put the "delete message(s)" button into the topbar
314 let d = document.getElementById("ctdl-delete-button");
315 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
316 d.style.display = "block";
317 //d.addEventListener("click", mail_delete_selected);
319 document.getElementById("ctdl-main").innerHTML
320 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
321 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
322 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
326 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
327 render_mailbox_display(newmail_notify.NO);
328 try { // if this was already set up, clear it so there aren't multiple
329 clearInterval(RefreshMailboxInterval);
333 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
337 // Refresh the mailbox, either for the first time or whenever needed
338 function refresh_mail_display() {
339 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
340 // so cancel the refresh.
342 document.getElementById("ctdl-mailbox-pane").innerHTML;
345 clearInterval(RefreshMailboxInterval);
349 // Ask the server if the room has been written to since our last look at it.
350 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
351 fetch_stat = async() => {
352 response = await fetch(url);
353 stat = await(response.json());
354 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
355 room_mtime = stat.room_mtime;
356 render_mailbox_display(newmail_notify.YES);
363 // This is where the rendering of the message list in the mailbox view is performed.
364 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
365 function render_mailbox_display(notify) {
367 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
368 fetch_mailbox = async() => {
369 response = await fetch(url);
370 msgs = await(response.json());
372 var previously_selected = [];
373 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
376 // If one or more messages was already selected, remember them so we can re-select them
377 if ( (displayed_message > 0) && (oldtable) ) {
378 for (i=0; row=oldtable.rows[i]; ++i) {
379 if (row.classList.contains("ctdl-mail-selected")) {
380 previously_selected.push(parseInt(row["id"].substring(12)));
385 // begin rendering the mailbox table
386 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
387 + "<th>" + _("Subject") + "</th>"
388 + "<th>" + _("Sender") + "</th>"
389 + "<th>" + _("Date") + "</th>"
393 for (let i=0; i<msgs.length; ++i) {
394 let m = parseInt(msgs[i].msgnum);
395 let s = (previously_selected.includes(m));
396 box += mail_render_row(msgs[i], s);
397 if (m > highest_mailnum) {
403 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
404 document.addEventListener("keydown", mail_keypress);
411 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
412 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
413 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
415 m_to = Array.from(new Set(m_to)); // remove dupes
417 for (i=0; i<m_to.length; ++i) {
421 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
428 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
430 m_cc = Array.from(new Set(m_cc)); // remove dupes
432 for (i=0; i<m_cc.length; ++i) {
436 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
443 quoted_div_name = randomString();
445 // Make the "Write mail" button disappear. We're already there!
446 document.getElementById("ctdl-newmsg-button").style.display = "none";
448 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
449 // references list of references, be sure to use this in a reply
450 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
452 // Now display the screen.
454 // Hidden values that we are storing right here in the document tree for later
455 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
456 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
458 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
459 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
461 // Visible To: field, plus a box to make the CC/BCC lines appear
462 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
463 + "<div class=\"ctdl-compose-to-line\">"
464 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
465 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
466 + "onClick=\"make_cc_bcc_visible()\">"
467 + _("CC:") + "/" + _("BCC:") + "</div>"
471 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
472 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
473 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
474 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
476 // Visible subject field
477 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
478 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
480 // Message composition box
481 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
485 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
491 // The button bar is a Grid element, and is also a Flexbox container.
492 + "<div class=\"ctdl-compose-toolbar\">"
493 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
494 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
495 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
496 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
497 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
501 document.getElementById("ctdl-main").innerHTML = compose_screen;
502 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
504 document.getElementById("ctdl-compose-cc-label").style.display = "block";
505 document.getElementById("ctdl-compose-cc-field").style.display = "block";
510 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
511 // It is also called automatically during a Reply when CC is pre-populated.
512 function make_cc_bcc_visible() {
513 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
514 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
515 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
519 // Helper function for mail_send_messages() to extract and decode metadata values.
520 function msm_field(element_name, separator) {
521 let s1 = document.getElementById(element_name).innerHTML;
522 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel
523 let s3 = decodeURI(s2);
524 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
531 // Save the posted message to the server
532 function mail_send_message() {
534 document.body.style.cursor = "wait";
535 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
536 + "/dummy_name_for_new_mail"
537 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
538 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
539 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
540 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
541 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
543 boundary = randomString();
545 "--" + boundary + "\r\n"
546 + "Content-type: text/html\r\n"
547 + "Content-transfer-encoding: quoted-printable\r\n"
549 + quoted_printable_encode(
550 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
552 + "--" + boundary + "--\r\n"
555 var request = new XMLHttpRequest();
556 request.open("PUT", url, true);
557 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
558 request.onreadystatechange = function() {
559 if (request.readyState == 4) {
560 document.body.style.cursor = "default";
561 if (Math.trunc(request.status / 100) == 2) {
562 headers = request.getAllResponseHeaders().split("\n");
563 for (var i in headers) {
564 if (headers[i].startsWith("etag: ")) {
565 new_msg_num = headers[i].split(" ")[1];
569 // After saving the message, go back to the mailbox view.
570 gotoroom(current_room);
574 error_message = request.responseText;
575 if (error_message.length == 0) {
576 error_message = _("An error has occurred.");
578 alert(error_message); // editor remains open
582 request.send(body_text);