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 // Handler function for keypresses detected while the mail view is displayed. Mainly for deleting messages.
19 function mail_keypress(event) {
21 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
22 // so cancel the event listener.
24 document.getElementById("ctdl-mailbox-pane").innerHTML;
27 document.removeEventListener("keydown", mail_keypress);
31 const key = event.key.toLowerCase();
32 if (key == "delete") {
33 console.log("delete key was pressed (FIXME do something with this)");
39 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
40 function reply_addr(msg) {
45 return([msg.from + " <" + msg.rfca + ">"]);
50 // Render the To: recipients for a reply-all operation
51 function replyall_to(msg) {
52 return([...reply_addr(msg), ...msg.rcpt]);
56 // Render a message into the mailbox view
57 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
58 function mail_render_one(msgnum, msg, target_div, include_controls) {
62 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
65 if (include_controls) { // omit controls if this is a pull quote
67 render_userpic(msg.from) // user avatar
68 + "<div class=\"ctdl-mmsg-content\">" // begin content
69 + "<div class=\"ctdl-msg-header\">" // begin header
70 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
71 + render_msg_author(msg, views.VIEW_MAILBOX)
72 + "<span class=\"ctdl-msgdate\">"
73 + string_timestamp(msg.time,0)
74 + "</span>" // end msgdate
75 + "</span>" // end header info on left side
76 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
78 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
79 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
80 + "<i class=\"fa fa-reply\"></i> "
84 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
85 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
86 + "<i class=\"fa fa-reply-all\"></i> "
90 if (can_delete_messages) {
92 "<span class=\"ctdl-msg-button\">"
93 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
94 + "<i class=\"fa fa-trash\"></i> "
100 "</span>"; // end buttons on right side
102 // Display the To: recipients, if any are present
104 outmsg += "<br><span>" + _("To:") + " ";
105 for (var r=0; r<msg.rcpt.length; ++r) {
109 outmsg += escapeHTML(msg.rcpt[r]);
114 // Display the Cc: recipients, if any are present
116 outmsg += "<br><span>" + _("Cc:") + " ";
117 for (var r=0; r<msg.cccc.length; ++r) {
121 outmsg += escapeHTML(msg.cccc[r]);
126 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
129 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
133 "</div>"; // end header
137 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
139 + "</div>" // end body
140 + "</div>" // end content
141 + "</div>" // end wrapper
145 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
148 target_div.innerHTML = outmsg;
152 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
153 function mail_display_message(msgnum, target_div, include_controls) {
154 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
155 mail_fetch_msg = async() => {
156 response = await fetch(url);
157 msg = await(response.json());
159 mail_render_one(msgnum, msg, target_div, include_controls);
166 // A message has been selected...
167 function click_message(event, msgnum) {
168 var table = document.getElementById("ctdl-onscreen-mailbox");
171 // ctrl + click = toggle an individual message without changing existing selection
173 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
176 // shift + click = select a range of messages
177 else if (event.shiftKey) {
178 for (i=0; row=table.rows[i]; ++i) {
179 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
181 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
182 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
184 row.classList.add("ctdl-mail-selected");
187 row.classList.remove("ctdl-mail-selected");
192 // click + no modifiers = select one message and unselect all others
194 for (i=0; row=table.rows[i]; ++i) {
195 if (row["id"] == "ctdl-msgsum-" + msgnum) {
196 row.classList.add("ctdl-mail-selected");
199 row.classList.remove("ctdl-mail-selected");
204 // display the message if it isn't already displayed
205 if (displayed_message != msgnum) {
206 displayed_message = msgnum;
207 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
212 // render one row in the mailbox table (this could be called from one of several places)
213 function mail_render_row(msg, is_selected) {
215 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
216 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
217 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
218 + "onselectstart=\"return false;\""
220 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
221 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
222 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
223 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
229 // RENDERER FOR THIS VIEW
230 function view_render_mail() {
231 // Put the "enter new message" button into the sidebar
232 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
233 document.getElementById("ctdl-newmsg-button").style.display = "block";
235 document.getElementById("ctdl-main").innerHTML
236 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
237 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
238 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
242 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
243 render_mailbox_display(newmail_notify.NO);
244 try { // if this was already set up, clear it so there aren't multiple
245 clearInterval(RefreshMailboxInterval);
249 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
253 // Refresh the mailbox, either for the first time or whenever needed
254 function refresh_mail_display() {
255 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
256 // so cancel the refresh.
258 document.getElementById("ctdl-mailbox-pane").innerHTML;
261 clearInterval(RefreshMailboxInterval);
265 // Ask the server if the room has been written to since our last look at it.
266 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
267 fetch_stat = async() => {
268 response = await fetch(url);
269 stat = await(response.json());
270 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
271 room_mtime = stat.room_mtime;
272 render_mailbox_display(newmail_notify.YES);
279 // This is where the rendering of the message list in the mailbox view is performed.
280 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
281 function render_mailbox_display(notify) {
283 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
284 fetch_mailbox = async() => {
285 response = await fetch(url);
286 msgs = await(response.json());
288 var previously_selected = [];
289 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
292 // If one or more messages was already selected, remember them so we can re-select them
293 if ( (displayed_message > 0) && (oldtable) ) {
294 for (i=0; row=oldtable.rows[i]; ++i) {
295 if (row.classList.contains("ctdl-mail-selected")) {
296 previously_selected.push(parseInt(row["id"].substring(12)));
301 // begin rendering the mailbox table
302 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
303 + "<th>" + _("Subject") + "</th>"
304 + "<th>" + _("Sender") + "</th>"
305 + "<th>" + _("Date") + "</th>"
309 for (let i=0; i<msgs.length; ++i) {
310 let m = parseInt(msgs[i].msgnum);
311 let s = (previously_selected.includes(m));
312 box += mail_render_row(msgs[i], s);
313 if (m > highest_mailnum) {
319 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
320 document.addEventListener("keydown", mail_keypress);
327 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
328 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
329 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
331 m_to = Array.from(new Set(m_to)); // remove dupes
333 for (i=0; i<m_to.length; ++i) {
337 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
344 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
346 m_cc = Array.from(new Set(m_cc)); // remove dupes
348 for (i=0; i<m_cc.length; ++i) {
352 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
359 quoted_div_name = randomString();
361 // Make the "Write mail" button disappear. We're already there!
362 document.getElementById("ctdl-newmsg-button").style.display = "none";
364 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
365 // references list of references, be sure to use this in a reply
366 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
368 // Now display the screen.
370 // Hidden values that we are storing right here in the document tree for later
371 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
372 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
374 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
375 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
377 // Visible To: field, plus a box to make the CC/BCC lines appear
378 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
379 + "<div class=\"ctdl-compose-to-line\">"
380 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
381 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
382 + "onClick=\"make_cc_bcc_visible()\">"
383 + _("CC:") + "/" + _("BCC:") + "</div>"
387 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
388 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
389 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
390 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
392 // Visible subject field
393 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
394 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
396 // Message composition box
397 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
401 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
407 // The button bar is a Grid element, and is also a Flexbox container.
408 + "<div class=\"ctdl-compose-toolbar\">"
409 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
410 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
411 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
412 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
413 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
417 document.getElementById("ctdl-main").innerHTML = compose_screen;
418 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
420 document.getElementById("ctdl-compose-cc-label").style.display = "block";
421 document.getElementById("ctdl-compose-cc-field").style.display = "block";
426 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
427 // It is also called automatically during a Reply when CC is pre-populated.
428 function make_cc_bcc_visible() {
429 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
430 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
431 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
435 // Helper function for mail_send_messages() to extract and decode metadata values.
436 function msm_field(element_name, separator) {
437 let s1 = document.getElementById(element_name).innerHTML;
438 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
439 let s3 = decodeURI(s2);
440 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
447 // Save the posted message to the server
448 function mail_send_message() {
450 document.body.style.cursor = "wait";
451 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
452 + "/dummy_name_for_new_mail"
453 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
454 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
455 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
456 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
457 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
459 boundary = randomString();
461 "--" + boundary + "\r\n"
462 + "Content-type: text/html\r\n"
463 + "Content-transfer-encoding: quoted-printable\r\n"
465 + quoted_printable_encode(
466 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
468 + "--" + boundary + "--\r\n"
471 var request = new XMLHttpRequest();
472 request.open("PUT", url, true);
473 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
474 request.onreadystatechange = function() {
475 if (request.readyState == 4) {
476 document.body.style.cursor = "default";
477 if (Math.trunc(request.status / 100) == 2) {
478 headers = request.getAllResponseHeaders().split("\n");
479 for (var i in headers) {
480 if (headers[i].startsWith("etag: ")) {
481 new_msg_num = headers[i].split(" ")[1];
485 // After saving the message, go back to the mailbox view.
486 gotoroom(current_room);
490 error_message = request.responseText;
491 if (error_message.length == 0) {
492 error_message = _("An error has occurred.");
494 alert(error_message); // editor remains open
498 request.send(body_text);