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 if (event.target.classList.contains("ctdl-mail-selected")) {
90 // The row being dragged IS selected. See if any OTHER rows are selected, and they will come along for the ride.
91 for (i=1; row=table.rows[i]; ++i) {
92 if (row.classList.contains("ctdl-mail-selected")) {
98 // The row being dragged is NOT selected. It will be dragged on its own, ignoring the selected rows.
102 // FIXME tell the clipboard what's being moved.
104 // Set the custom drag image to an envelope + number of messages being dragged
105 d = document.getElementById("ctdl_draggo");
106 d.innerHTML = "<font size='+2'><i class='fa fa-envelope' style='color: red'></i> " + count + "</font>"
107 event.dataTransfer.setDragImage(d, 0, 0);
108 event.dataTransfer.setData("text/html", "blah blah blah");
112 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
113 function reply_addr(msg) {
115 //return([msg.from]);
118 return([msg.from + " <" + msg.rfca + ">"]);
123 // Render the To: recipients for a reply-all operation
124 function replyall_to(msg) {
125 return([...reply_addr(msg), ...msg.rcpt]);
129 // Render a message into the mailbox view
130 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
131 function mail_render_one(msgnum, msg, target_div, include_controls) {
135 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
138 if (include_controls) { // omit controls if this is a pull quote
140 render_userpic(msg.from) // user avatar
141 + "<div class=\"ctdl-mmsg-content\">" // begin content
142 + "<div class=\"ctdl-msg-header\">" // begin header
143 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
144 + render_msg_author(msg, views.VIEW_MAILBOX)
145 + "<span class=\"ctdl-msgdate\">"
146 + string_timestamp(msg.time,0)
147 + "</span>" // end msgdate
148 + "</span>" // end header info on left side
149 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
151 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
152 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
153 + "<i class=\"fa fa-reply\"></i> "
157 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
158 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
159 + "<i class=\"fa fa-reply-all\"></i> "
163 if (can_delete_messages) {
165 "<span class=\"ctdl-msg-button\">"
166 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
167 + "<i class=\"fa fa-trash\"></i> "
173 "</span>"; // end buttons on right side
175 // Display the To: recipients, if any are present
177 outmsg += "<br><span>" + _("To:") + " ";
178 for (var r=0; r<msg.rcpt.length; ++r) {
182 outmsg += escapeHTML(msg.rcpt[r]);
187 // Display the Cc: recipients, if any are present
189 outmsg += "<br><span>" + _("Cc:") + " ";
190 for (var r=0; r<msg.cccc.length; ++r) {
194 outmsg += escapeHTML(msg.cccc[r]);
199 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
202 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
206 "</div>"; // end header
210 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
212 + "</div>" // end body
213 + "</div>" // end content
214 + "</div>" // end wrapper
218 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
221 target_div.innerHTML = outmsg;
225 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
226 function mail_display_message(msgnum, target_div, include_controls) {
227 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
228 mail_fetch_msg = async() => {
229 response = await fetch(url);
230 msg = await(response.json());
232 mail_render_one(msgnum, msg, target_div, include_controls);
239 // A message has been selected...
240 function click_message(event, msgnum) {
241 var table = document.getElementById("ctdl-onscreen-mailbox");
244 // ctrl + click = toggle an individual message without changing existing selection
246 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
249 // shift + click = select a range of messages (start with row 1 because row 0 is the header)
250 else if (event.shiftKey) {
251 for (i=1; row=table.rows[i]; ++i) {
252 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
254 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
255 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
257 row.classList.add("ctdl-mail-selected");
260 row.classList.remove("ctdl-mail-selected");
265 // click + no modifiers = select one message and unselect all others (start with row 1 because row 0 is the header)
267 for (i=1; row=table.rows[i]; ++i) {
268 if (row["id"] == "ctdl-msgsum-" + msgnum) {
269 row.classList.add("ctdl-mail-selected");
272 row.classList.remove("ctdl-mail-selected");
277 // display the message if it isn't already displayed
278 if (displayed_message != msgnum) {
279 displayed_message = msgnum;
280 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
285 // render one row in the mailbox table (this could be called from one of several places)
286 function mail_render_row(msg, is_selected) {
288 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
289 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
290 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
291 + "onselectstart=\"return false;\" "
292 + "draggable=\"true\" "
293 + "ondragstart=\"mail_dragstart(event)\" "
295 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
296 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
297 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
298 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
304 // RENDERER FOR THIS VIEW
305 function view_render_mail() {
306 // Put the "enter new message" button into the topbar
307 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
308 document.getElementById("ctdl-newmsg-button").style.display = "block";
310 // Put the "delete message(s)" button into the topbar
311 let d = document.getElementById("ctdl-delete-button");
312 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
313 d.style.display = "block";
314 //d.addEventListener("click", mail_delete_selected);
316 document.getElementById("ctdl-main").innerHTML
317 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
318 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
319 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
323 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
324 render_mailbox_display(newmail_notify.NO);
325 try { // if this was already set up, clear it so there aren't multiple
326 clearInterval(RefreshMailboxInterval);
330 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
334 // Refresh the mailbox, either for the first time or whenever needed
335 function refresh_mail_display() {
336 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
337 // so cancel the refresh.
339 document.getElementById("ctdl-mailbox-pane").innerHTML;
342 clearInterval(RefreshMailboxInterval);
346 // Ask the server if the room has been written to since our last look at it.
347 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
348 fetch_stat = async() => {
349 response = await fetch(url);
350 stat = await(response.json());
351 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
352 room_mtime = stat.room_mtime;
353 render_mailbox_display(newmail_notify.YES);
360 // This is where the rendering of the message list in the mailbox view is performed.
361 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
362 function render_mailbox_display(notify) {
364 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
365 fetch_mailbox = async() => {
366 response = await fetch(url);
367 msgs = await(response.json());
369 var previously_selected = [];
370 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
373 // If one or more messages was already selected, remember them so we can re-select them
374 if ( (displayed_message > 0) && (oldtable) ) {
375 for (i=0; row=oldtable.rows[i]; ++i) {
376 if (row.classList.contains("ctdl-mail-selected")) {
377 previously_selected.push(parseInt(row["id"].substring(12)));
382 // begin rendering the mailbox table
383 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
384 + "<th>" + _("Subject") + "</th>"
385 + "<th>" + _("Sender") + "</th>"
386 + "<th>" + _("Date") + "</th>"
390 for (let i=0; i<msgs.length; ++i) {
391 let m = parseInt(msgs[i].msgnum);
392 let s = (previously_selected.includes(m));
393 box += mail_render_row(msgs[i], s);
394 if (m > highest_mailnum) {
400 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
401 document.addEventListener("keydown", mail_keypress);
408 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
409 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
410 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
412 m_to = Array.from(new Set(m_to)); // remove dupes
414 for (i=0; i<m_to.length; ++i) {
418 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
425 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
427 m_cc = Array.from(new Set(m_cc)); // remove dupes
429 for (i=0; i<m_cc.length; ++i) {
433 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
440 quoted_div_name = randomString();
442 // Make the "Write mail" button disappear. We're already there!
443 document.getElementById("ctdl-newmsg-button").style.display = "none";
445 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
446 // references list of references, be sure to use this in a reply
447 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
449 // Now display the screen.
451 // Hidden values that we are storing right here in the document tree for later
452 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
453 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
455 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
456 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
458 // Visible To: field, plus a box to make the CC/BCC lines appear
459 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
460 + "<div class=\"ctdl-compose-to-line\">"
461 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
462 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
463 + "onClick=\"make_cc_bcc_visible()\">"
464 + _("CC:") + "/" + _("BCC:") + "</div>"
468 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
469 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
470 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
471 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
473 // Visible subject field
474 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
475 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
477 // Message composition box
478 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
482 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
488 // The button bar is a Grid element, and is also a Flexbox container.
489 + "<div class=\"ctdl-compose-toolbar\">"
490 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
491 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
492 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
493 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
494 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
498 document.getElementById("ctdl-main").innerHTML = compose_screen;
499 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
501 document.getElementById("ctdl-compose-cc-label").style.display = "block";
502 document.getElementById("ctdl-compose-cc-field").style.display = "block";
507 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
508 // It is also called automatically during a Reply when CC is pre-populated.
509 function make_cc_bcc_visible() {
510 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
511 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
512 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
516 // Helper function for mail_send_messages() to extract and decode metadata values.
517 function msm_field(element_name, separator) {
518 let s1 = document.getElementById(element_name).innerHTML;
519 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel
520 let s3 = decodeURI(s2);
521 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
528 // Save the posted message to the server
529 function mail_send_message() {
531 document.body.style.cursor = "wait";
532 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
533 + "/dummy_name_for_new_mail"
534 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
535 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
536 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
537 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
538 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
540 boundary = randomString();
542 "--" + boundary + "\r\n"
543 + "Content-type: text/html\r\n"
544 + "Content-transfer-encoding: quoted-printable\r\n"
546 + quoted_printable_encode(
547 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
549 + "--" + boundary + "--\r\n"
552 var request = new XMLHttpRequest();
553 request.open("PUT", url, true);
554 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
555 request.onreadystatechange = function() {
556 if (request.readyState == 4) {
557 document.body.style.cursor = "default";
558 if (Math.trunc(request.status / 100) == 2) {
559 headers = request.getAllResponseHeaders().split("\n");
560 for (var i in headers) {
561 if (headers[i].startsWith("etag: ")) {
562 new_msg_num = headers[i].split(" ")[1];
566 // After saving the message, go back to the mailbox view.
567 gotoroom(current_room);
571 error_message = request.responseText;
572 if (error_message.length == 0) {
573 error_message = _("An error has occurred.");
575 alert(error_message); // editor remains open
579 request.send(body_text);