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 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
84 function reply_addr(msg) {
89 return([msg.from + " <" + msg.rfca + ">"]);
94 // Render the To: recipients for a reply-all operation
95 function replyall_to(msg) {
96 return([...reply_addr(msg), ...msg.rcpt]);
100 // Render a message into the mailbox view
101 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
102 function mail_render_one(msgnum, msg, target_div, include_controls) {
106 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
109 if (include_controls) { // omit controls if this is a pull quote
111 render_userpic(msg.from) // user avatar
112 + "<div class=\"ctdl-mmsg-content\">" // begin content
113 + "<div class=\"ctdl-msg-header\">" // begin header
114 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
115 + render_msg_author(msg, views.VIEW_MAILBOX)
116 + "<span class=\"ctdl-msgdate\">"
117 + string_timestamp(msg.time,0)
118 + "</span>" // end msgdate
119 + "</span>" // end header info on left side
120 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
122 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
123 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
124 + "<i class=\"fa fa-reply\"></i> "
128 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
129 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
130 + "<i class=\"fa fa-reply-all\"></i> "
134 if (can_delete_messages) {
136 "<span class=\"ctdl-msg-button\">"
137 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
138 + "<i class=\"fa fa-trash\"></i> "
144 "</span>"; // end buttons on right side
146 // Display the To: recipients, if any are present
148 outmsg += "<br><span>" + _("To:") + " ";
149 for (var r=0; r<msg.rcpt.length; ++r) {
153 outmsg += escapeHTML(msg.rcpt[r]);
158 // Display the Cc: recipients, if any are present
160 outmsg += "<br><span>" + _("Cc:") + " ";
161 for (var r=0; r<msg.cccc.length; ++r) {
165 outmsg += escapeHTML(msg.cccc[r]);
170 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
173 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
177 "</div>"; // end header
181 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
183 + "</div>" // end body
184 + "</div>" // end content
185 + "</div>" // end wrapper
189 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
192 target_div.innerHTML = outmsg;
196 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
197 function mail_display_message(msgnum, target_div, include_controls) {
198 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
199 mail_fetch_msg = async() => {
200 response = await fetch(url);
201 msg = await(response.json());
203 mail_render_one(msgnum, msg, target_div, include_controls);
210 // after a message is selected or deselected, we call this to set or clear the drag handler.
211 function enable_or_disable_draggable(row) {
212 if (row.classList.contains("ctdl-mail-selected")) {
213 console.log(row.id + " selected");
214 row.draggable = "true"
217 console.log(row.id + " deselected");
218 row.draggable = "false"
220 console.log(row.dragstart);
225 // A message has been selected...
226 function click_message(event, msgnum) {
227 var table = document.getElementById("ctdl-onscreen-mailbox");
230 // ctrl + click = toggle an individual message without changing existing selection
232 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
233 enable_or_disable_draggable(document.getElementById("ctdl-msgsum-" + msgnum));
236 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
237 else if (event.shiftKey) {
238 for (i=1; row=table.rows[i]; ++i) {
239 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
241 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
242 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
244 row.classList.add("ctdl-mail-selected");
247 row.classList.remove("ctdl-mail-selected");
249 enable_or_disable_draggable(row);
253 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
255 for (i=1; row=table.rows[i]; ++i) {
256 if (row["id"] == "ctdl-msgsum-" + msgnum) {
257 row.classList.add("ctdl-mail-selected");
260 row.classList.remove("ctdl-mail-selected");
262 enable_or_disable_draggable(row);
266 // display the message if it isn't already displayed
267 if (displayed_message != msgnum) {
268 displayed_message = msgnum;
269 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
274 // render one row in the mailbox table (this could be called from one of several places)
275 function mail_render_row(msg, is_selected) {
277 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
278 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
279 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
280 + "onselectstart=\"return false;\""
282 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
283 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
284 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
285 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
291 // RENDERER FOR THIS VIEW
292 function view_render_mail() {
293 // Put the "enter new message" button into the topbar
294 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
295 document.getElementById("ctdl-newmsg-button").style.display = "block";
297 // Put the "delete message(s)" button into the topbar
298 let d = document.getElementById("ctdl-delete-button");
299 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
300 d.style.display = "block";
301 //d.addEventListener("click", mail_delete_selected);
303 document.getElementById("ctdl-main").innerHTML
304 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
305 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
306 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
310 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
311 render_mailbox_display(newmail_notify.NO);
312 try { // if this was already set up, clear it so there aren't multiple
313 clearInterval(RefreshMailboxInterval);
317 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
321 // Refresh the mailbox, either for the first time or whenever needed
322 function refresh_mail_display() {
323 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
324 // so cancel the refresh.
326 document.getElementById("ctdl-mailbox-pane").innerHTML;
329 clearInterval(RefreshMailboxInterval);
333 // Ask the server if the room has been written to since our last look at it.
334 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
335 fetch_stat = async() => {
336 response = await fetch(url);
337 stat = await(response.json());
338 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
339 room_mtime = stat.room_mtime;
340 render_mailbox_display(newmail_notify.YES);
347 // This is where the rendering of the message list in the mailbox view is performed.
348 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
349 function render_mailbox_display(notify) {
351 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
352 fetch_mailbox = async() => {
353 response = await fetch(url);
354 msgs = await(response.json());
356 var previously_selected = [];
357 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
360 // If one or more messages was already selected, remember them so we can re-select them
361 if ( (displayed_message > 0) && (oldtable) ) {
362 for (i=0; row=oldtable.rows[i]; ++i) {
363 if (row.classList.contains("ctdl-mail-selected")) {
364 previously_selected.push(parseInt(row["id"].substring(12)));
369 // begin rendering the mailbox table
370 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
371 + "<th>" + _("Subject") + "</th>"
372 + "<th>" + _("Sender") + "</th>"
373 + "<th>" + _("Date") + "</th>"
377 for (let i=0; i<msgs.length; ++i) {
378 let m = parseInt(msgs[i].msgnum);
379 let s = (previously_selected.includes(m));
380 box += mail_render_row(msgs[i], s);
381 if (m > highest_mailnum) {
387 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
388 document.addEventListener("keydown", mail_keypress);
395 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
396 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
397 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
399 m_to = Array.from(new Set(m_to)); // remove dupes
401 for (i=0; i<m_to.length; ++i) {
405 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
412 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
414 m_cc = Array.from(new Set(m_cc)); // remove dupes
416 for (i=0; i<m_cc.length; ++i) {
420 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
427 quoted_div_name = randomString();
429 // Make the "Write mail" button disappear. We're already there!
430 document.getElementById("ctdl-newmsg-button").style.display = "none";
432 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
433 // references list of references, be sure to use this in a reply
434 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
436 // Now display the screen.
438 // Hidden values that we are storing right here in the document tree for later
439 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
440 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
442 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
443 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
445 // Visible To: field, plus a box to make the CC/BCC lines appear
446 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
447 + "<div class=\"ctdl-compose-to-line\">"
448 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
449 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
450 + "onClick=\"make_cc_bcc_visible()\">"
451 + _("CC:") + "/" + _("BCC:") + "</div>"
455 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
456 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
457 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
458 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
460 // Visible subject field
461 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
462 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
464 // Message composition box
465 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
469 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
475 // The button bar is a Grid element, and is also a Flexbox container.
476 + "<div class=\"ctdl-compose-toolbar\">"
477 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
478 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
479 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
480 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
481 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
485 document.getElementById("ctdl-main").innerHTML = compose_screen;
486 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
488 document.getElementById("ctdl-compose-cc-label").style.display = "block";
489 document.getElementById("ctdl-compose-cc-field").style.display = "block";
494 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
495 // It is also called automatically during a Reply when CC is pre-populated.
496 function make_cc_bcc_visible() {
497 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
498 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
499 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
503 // Helper function for mail_send_messages() to extract and decode metadata values.
504 function msm_field(element_name, separator) {
505 let s1 = document.getElementById(element_name).innerHTML;
506 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
507 let s3 = decodeURI(s2);
508 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
515 // Save the posted message to the server
516 function mail_send_message() {
518 document.body.style.cursor = "wait";
519 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
520 + "/dummy_name_for_new_mail"
521 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
522 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
523 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
524 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
525 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
527 boundary = randomString();
529 "--" + boundary + "\r\n"
530 + "Content-type: text/html\r\n"
531 + "Content-transfer-encoding: quoted-printable\r\n"
533 + quoted_printable_encode(
534 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
536 + "--" + boundary + "--\r\n"
539 var request = new XMLHttpRequest();
540 request.open("PUT", url, true);
541 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
542 request.onreadystatechange = function() {
543 if (request.readyState == 4) {
544 document.body.style.cursor = "default";
545 if (Math.trunc(request.status / 100) == 2) {
546 headers = request.getAllResponseHeaders().split("\n");
547 for (var i in headers) {
548 if (headers[i].startsWith("etag: ")) {
549 new_msg_num = headers[i].split(" ")[1];
553 // After saving the message, go back to the mailbox view.
554 gotoroom(current_room);
558 error_message = request.responseText;
559 if (error_message.length == 0) {
560 error_message = _("An error has occurred.");
562 alert(error_message); // editor remains open
566 request.send(body_text);