1 // This module handles the view for "mailbox" rooms.
3 // Copyright (c) 2016-2022 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 // Delete the selected messages (can be activated by mouse click or keypress)
19 function mail_delete_selected() {
20 var table = document.getElementById("ctdl-onscreen-mailbox");
22 for (i=0; row=table.rows[i]; ++i) {
23 if (row.classList.contains("ctdl-mail-selected")) {
24 console.log("delete " + row["id"]);
30 // Handler function for keypresses detected while the mail view is displayed. Mainly for deleting messages.
31 function mail_keypress(event) {
33 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
34 // so cancel the event listener.
36 document.getElementById("ctdl-mailbox-pane").innerHTML;
39 document.removeEventListener("keydown", mail_keypress);
43 const key = event.key.toLowerCase();
44 if (key == "delete") {
45 mail_delete_selected();
51 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
52 function reply_addr(msg) {
57 return([msg.from + " <" + msg.rfca + ">"]);
62 // Render the To: recipients for a reply-all operation
63 function replyall_to(msg) {
64 return([...reply_addr(msg), ...msg.rcpt]);
68 // Render a message into the mailbox view
69 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
70 function mail_render_one(msgnum, msg, target_div, include_controls) {
74 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
77 if (include_controls) { // omit controls if this is a pull quote
79 render_userpic(msg.from) // user avatar
80 + "<div class=\"ctdl-mmsg-content\">" // begin content
81 + "<div class=\"ctdl-msg-header\">" // begin header
82 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
83 + render_msg_author(msg, views.VIEW_MAILBOX)
84 + "<span class=\"ctdl-msgdate\">"
85 + string_timestamp(msg.time,0)
86 + "</span>" // end msgdate
87 + "</span>" // end header info on left side
88 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
90 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
91 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
92 + "<i class=\"fa fa-reply\"></i> "
96 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
97 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
98 + "<i class=\"fa fa-reply-all\"></i> "
102 if (can_delete_messages) {
104 "<span class=\"ctdl-msg-button\">"
105 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
106 + "<i class=\"fa fa-trash\"></i> "
112 "</span>"; // end buttons on right side
114 // Display the To: recipients, if any are present
116 outmsg += "<br><span>" + _("To:") + " ";
117 for (var r=0; r<msg.rcpt.length; ++r) {
121 outmsg += escapeHTML(msg.rcpt[r]);
126 // Display the Cc: recipients, if any are present
128 outmsg += "<br><span>" + _("Cc:") + " ";
129 for (var r=0; r<msg.cccc.length; ++r) {
133 outmsg += escapeHTML(msg.cccc[r]);
138 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
141 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
145 "</div>"; // end header
149 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
151 + "</div>" // end body
152 + "</div>" // end content
153 + "</div>" // end wrapper
157 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
160 target_div.innerHTML = outmsg;
164 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
165 function mail_display_message(msgnum, target_div, include_controls) {
166 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
167 mail_fetch_msg = async() => {
168 response = await fetch(url);
169 msg = await(response.json());
171 mail_render_one(msgnum, msg, target_div, include_controls);
178 // A message has been selected...
179 function click_message(event, msgnum) {
180 var table = document.getElementById("ctdl-onscreen-mailbox");
183 // ctrl + click = toggle an individual message without changing existing selection
185 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
188 // shift + click = select a range of messages
189 else if (event.shiftKey) {
190 for (i=0; row=table.rows[i]; ++i) {
191 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
193 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
194 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
196 row.classList.add("ctdl-mail-selected");
199 row.classList.remove("ctdl-mail-selected");
204 // click + no modifiers = select one message and unselect all others
206 for (i=0; row=table.rows[i]; ++i) {
207 if (row["id"] == "ctdl-msgsum-" + msgnum) {
208 row.classList.add("ctdl-mail-selected");
211 row.classList.remove("ctdl-mail-selected");
216 // display the message if it isn't already displayed
217 if (displayed_message != msgnum) {
218 displayed_message = msgnum;
219 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
224 // render one row in the mailbox table (this could be called from one of several places)
225 function mail_render_row(msg, is_selected) {
227 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
228 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
229 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
230 + "onselectstart=\"return false;\""
232 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
233 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
234 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
235 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
241 // RENDERER FOR THIS VIEW
242 function view_render_mail() {
243 // Put the "enter new message" button into the topbar
244 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
245 document.getElementById("ctdl-newmsg-button").style.display = "block";
247 // Put the "delete message(s)" button into the topbar
248 if (can_delete_messages) {
249 let d = document.getElementById("ctdl-delete-button");
250 d.innerHTML = "<i class=\"fa fa-trash\"></i>" + _("Delete");
251 d.style.display = "block";
252 d.addEventListener("click", mail_delete_selected);
255 document.getElementById("ctdl-main").innerHTML
256 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
257 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
258 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
262 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
263 render_mailbox_display(newmail_notify.NO);
264 try { // if this was already set up, clear it so there aren't multiple
265 clearInterval(RefreshMailboxInterval);
269 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
273 // Refresh the mailbox, either for the first time or whenever needed
274 function refresh_mail_display() {
275 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
276 // so cancel the refresh.
278 document.getElementById("ctdl-mailbox-pane").innerHTML;
281 clearInterval(RefreshMailboxInterval);
285 // Ask the server if the room has been written to since our last look at it.
286 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
287 fetch_stat = async() => {
288 response = await fetch(url);
289 stat = await(response.json());
290 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
291 room_mtime = stat.room_mtime;
292 render_mailbox_display(newmail_notify.YES);
299 // This is where the rendering of the message list in the mailbox view is performed.
300 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
301 function render_mailbox_display(notify) {
303 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
304 fetch_mailbox = async() => {
305 response = await fetch(url);
306 msgs = await(response.json());
308 var previously_selected = [];
309 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
312 // If one or more messages was already selected, remember them so we can re-select them
313 if ( (displayed_message > 0) && (oldtable) ) {
314 for (i=0; row=oldtable.rows[i]; ++i) {
315 if (row.classList.contains("ctdl-mail-selected")) {
316 previously_selected.push(parseInt(row["id"].substring(12)));
321 // begin rendering the mailbox table
322 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
323 + "<th>" + _("Subject") + "</th>"
324 + "<th>" + _("Sender") + "</th>"
325 + "<th>" + _("Date") + "</th>"
329 for (let i=0; i<msgs.length; ++i) {
330 let m = parseInt(msgs[i].msgnum);
331 let s = (previously_selected.includes(m));
332 box += mail_render_row(msgs[i], s);
333 if (m > highest_mailnum) {
339 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
340 document.addEventListener("keydown", mail_keypress);
347 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
348 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
349 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
351 m_to = Array.from(new Set(m_to)); // remove dupes
353 for (i=0; i<m_to.length; ++i) {
357 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
364 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
366 m_cc = Array.from(new Set(m_cc)); // remove dupes
368 for (i=0; i<m_cc.length; ++i) {
372 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
379 quoted_div_name = randomString();
381 // Make the "Write mail" button disappear. We're already there!
382 document.getElementById("ctdl-newmsg-button").style.display = "none";
384 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
385 // references list of references, be sure to use this in a reply
386 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
388 // Now display the screen.
390 // Hidden values that we are storing right here in the document tree for later
391 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
392 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
394 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
395 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
397 // Visible To: field, plus a box to make the CC/BCC lines appear
398 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
399 + "<div class=\"ctdl-compose-to-line\">"
400 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
401 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
402 + "onClick=\"make_cc_bcc_visible()\">"
403 + _("CC:") + "/" + _("BCC:") + "</div>"
407 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
408 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
409 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
410 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
412 // Visible subject field
413 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
414 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
416 // Message composition box
417 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
421 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
427 // The button bar is a Grid element, and is also a Flexbox container.
428 + "<div class=\"ctdl-compose-toolbar\">"
429 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
430 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
431 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
432 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
433 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
437 document.getElementById("ctdl-main").innerHTML = compose_screen;
438 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
440 document.getElementById("ctdl-compose-cc-label").style.display = "block";
441 document.getElementById("ctdl-compose-cc-field").style.display = "block";
446 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
447 // It is also called automatically during a Reply when CC is pre-populated.
448 function make_cc_bcc_visible() {
449 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
450 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
451 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
455 // Helper function for mail_send_messages() to extract and decode metadata values.
456 function msm_field(element_name, separator) {
457 let s1 = document.getElementById(element_name).innerHTML;
458 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
459 let s3 = decodeURI(s2);
460 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
467 // Save the posted message to the server
468 function mail_send_message() {
470 document.body.style.cursor = "wait";
471 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
472 + "/dummy_name_for_new_mail"
473 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
474 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
475 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
476 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
477 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
479 boundary = randomString();
481 "--" + boundary + "\r\n"
482 + "Content-type: text/html\r\n"
483 + "Content-transfer-encoding: quoted-printable\r\n"
485 + quoted_printable_encode(
486 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
488 + "--" + boundary + "--\r\n"
491 var request = new XMLHttpRequest();
492 request.open("PUT", url, true);
493 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
494 request.onreadystatechange = function() {
495 if (request.readyState == 4) {
496 document.body.style.cursor = "default";
497 if (Math.trunc(request.status / 100) == 2) {
498 headers = request.getAllResponseHeaders().split("\n");
499 for (var i in headers) {
500 if (headers[i].startsWith("etag: ")) {
501 new_msg_num = headers[i].split(" ")[1];
505 // After saving the message, go back to the mailbox view.
506 gotoroom(current_room);
510 error_message = request.responseText;
511 if (error_message.length == 0) {
512 error_message = _("An error has occurred.");
514 alert(error_message); // editor remains open
518 request.send(body_text);