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 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
19 function reply_addr(msg) {
24 return([msg.from + " <" + msg.rfca + ">"]);
29 // Render the To: recipients for a reply-all operation
30 function replyall_to(msg) {
31 return([...reply_addr(msg), ...msg.rcpt]);
35 // Render a message into the mailbox view
36 // (We want the message number and the message itself because we need to keep the msgnum for reply purposes)
37 function mail_render_one(msgnum, msg, target_div, include_controls) {
41 "<div class=\"ctdl-mmsg-wrapper\">" // begin message wrapper
44 if (include_controls) { // omit controls if this is a pull quote
46 render_userpic(msg.from) // user avatar
47 + "<div class=\"ctdl-mmsg-content\">" // begin content
48 + "<div class=\"ctdl-msg-header\">" // begin header
49 + "<span class=\"ctdl-msg-header-info\">" // begin header info on left side
50 + render_msg_author(msg, views.VIEW_MAILBOX)
51 + "<span class=\"ctdl-msgdate\">"
52 + string_timestamp(msg.time,0)
53 + "</span>" // end msgdate
54 + "</span>" // end header info on left side
55 + "<span class=\"ctdl-msg-header-buttons\">" // begin buttons on right side
57 + "<span class=\"ctdl-msg-button\">" // Reply (mail is always Quoted)
58 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', reply_addr(msg), [], 'Re: '+msg.subj);\">"
59 + "<i class=\"fa fa-reply\"></i> "
63 + "<span class=\"ctdl-msg-button\">" // Reply-All (mail is always Quoted)
64 + "<a href=\"javascript:mail_compose(true,'"+msg.wefw+"','"+msgnum+"', replyall_to(msg), msg.cccc, 'Re: '+msg.subj);\">"
65 + "<i class=\"fa fa-reply-all\"></i> "
69 if (can_delete_messages) {
71 "<span class=\"ctdl-msg-button\">"
72 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
73 + "<i class=\"fa fa-trash\"></i> "
79 "</span>"; // end buttons on right side
81 // Display the To: recipients, if any are present
83 outmsg += "<br><span>" + _("To:") + " ";
84 for (var r=0; r<msg.rcpt.length; ++r) {
88 outmsg += escapeHTML(msg.rcpt[r]);
93 // Display the Cc: recipients, if any are present
95 outmsg += "<br><span>" + _("Cc:") + " ";
96 for (var r=0; r<msg.cccc.length; ++r) {
100 outmsg += escapeHTML(msg.cccc[r]);
105 // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
108 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
112 "</div>"; // end header
116 "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">" // begin body
118 + "</div>" // end body
119 + "</div>" // end content
120 + "</div>" // end wrapper
124 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
127 target_div.innerHTML = outmsg;
131 // display an individual message (note: this wants an actual div object, not a string containing the name of a div)
132 function mail_display_message(msgnum, target_div, include_controls) {
133 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/" + msgnum + "/json";
134 mail_fetch_msg = async() => {
135 response = await fetch(url);
136 msg = await(response.json());
138 mail_render_one(msgnum, msg, target_div, include_controls);
145 // A message has been selected...
146 function click_message(event, msgnum) {
147 var table = document.getElementById("ctdl-onscreen-mailbox");
150 // ctrl + click = toggle an individual message without changing existing selection
152 document.getElementById("ctdl-msgsum-" + msgnum).classList.toggle("ctdl-mail-selected");
155 // shift + click = select a range of messages
156 else if (event.shiftKey) {
157 for (i=0; row=table.rows[i]; ++i) {
158 m = parseInt(row["id"].substring(12)); // derive msgnum from row id
160 ((msgnum >= displayed_message) && (m >= displayed_message) && (m <= msgnum))
161 || ((msgnum <= displayed_message) && (m <= displayed_message) && (m >= msgnum))
163 row.classList.add("ctdl-mail-selected");
166 row.classList.remove("ctdl-mail-selected");
171 // click + no modifiers = select one message and unselect all others
173 for (i=0; row=table.rows[i]; ++i) {
174 if (row["id"] == "ctdl-msgsum-" + msgnum) {
175 row.classList.add("ctdl-mail-selected");
178 row.classList.remove("ctdl-mail-selected");
183 // display the message if it isn't already displayed
184 if (displayed_message != msgnum) {
185 displayed_message = msgnum;
186 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
191 // render one row in the mailbox table (this could be called from one of several places)
192 function mail_render_row(msg, is_selected) {
194 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
195 + (is_selected ? "class=\"ctdl-mail-selected\" " : "")
196 + "onClick=\"click_message(event," + msg["msgnum"] + ");\""
197 + "onselectstart=\"return false;\""
199 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
200 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
201 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
202 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
208 // RENDERER FOR THIS VIEW
209 function view_render_mail() {
210 // Put the "enter new message" button into the sidebar
211 document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
212 document.getElementById("ctdl-newmsg-button").style.display = "block";
214 document.getElementById("ctdl-main").innerHTML
215 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
216 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
217 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
221 highest_mailnum = 0; // Keep track of highest message number to track newly arrived messages
222 render_mailbox_display(newmail_notify.NO);
223 try { // if this was already set up, clear it so there aren't multiple
224 clearInterval(RefreshMailboxInterval);
228 RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
232 // Refresh the mailbox, either for the first time or whenever needed
233 function refresh_mail_display() {
234 // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
235 // so cancel the refresh.
237 document.getElementById("ctdl-mailbox-pane").innerHTML;
240 clearInterval(RefreshMailboxInterval);
244 // Ask the server if the room has been written to since our last look at it.
245 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
246 fetch_stat = async() => {
247 response = await fetch(url);
248 stat = await(response.json());
249 if (stat.room_mtime > room_mtime) { // FIXME commented out to force refreshes
250 room_mtime = stat.room_mtime;
251 render_mailbox_display(newmail_notify.YES);
258 // This is where the rendering of the message list in the mailbox view is performed.
259 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we are interested in the arrival of new messages.
260 function render_mailbox_display(notify) {
262 url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
263 fetch_mailbox = async() => {
264 response = await fetch(url);
265 msgs = await(response.json());
267 var previously_selected = [];
268 var oldtable = document.getElementById("ctdl-onscreen-mailbox");
271 // If one or more messages was already selected, remember them so we can re-select them
272 if ( (displayed_message > 0) && (oldtable) ) {
273 for (i=0; row=oldtable.rows[i]; ++i) {
274 if (row.classList.contains("ctdl-mail-selected")) {
275 previously_selected.push(parseInt(row["id"].substring(12)));
280 // begin rendering the mailbox table
281 box = "<table id=\"ctdl-onscreen-mailbox\" class=\"ctdl-mailbox-table\" width=100%><tr>"
282 + "<th>" + _("Subject") + "</th>"
283 + "<th>" + _("Sender") + "</th>"
284 + "<th>" + _("Date") + "</th>"
288 for (let i=0; i<msgs.length; ++i) {
289 let m = parseInt(msgs[i].msgnum);
290 let s = (previously_selected.includes(m));
291 box += mail_render_row(msgs[i], s);
292 if (m > highest_mailnum) {
298 document.getElementById("ctdl-mailbox-pane").innerHTML = box;
305 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
306 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
307 // m_to will be an array of zero or more recipients for the To: field. Convert it to a string.
309 m_to = Array.from(new Set(m_to)); // remove dupes
311 for (i=0; i<m_to.length; ++i) {
315 m_to_str += m_to[i].replaceAll("<", "<").replaceAll(">", ">");
322 // m_to will be an array of zero or more recipients for the Cc: field. Convert it to a string.
324 m_cc = Array.from(new Set(m_cc)); // remove dupes
326 for (i=0; i<m_cc.length; ++i) {
330 m_cc_str += m_cc[i].replaceAll("<", "<").replaceAll(">", ">");
337 quoted_div_name = randomString();
339 // Make the "Write mail" button disappear. We're already there!
340 document.getElementById("ctdl-newmsg-button").style.display = "none";
342 // is_quoted true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
343 // references list of references, be sure to use this in a reply
344 // msgid if a reply, the msgid of the most recent message in the chain, the one to which we are replying
346 // Now display the screen.
348 // Hidden values that we are storing right here in the document tree for later
349 "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
350 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
352 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
353 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
355 // Visible To: field, plus a box to make the CC/BCC lines appear
356 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
357 + "<div class=\"ctdl-compose-to-line\">"
358 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
359 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
360 + "onClick=\"make_cc_bcc_visible()\">"
361 + _("CC:") + "/" + _("BCC:") + "</div>"
365 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
366 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
367 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
368 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
370 // Visible subject field
371 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
372 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
374 // Message composition box
375 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
379 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
385 // The button bar is a Grid element, and is also a Flexbox container.
386 + "<div class=\"ctdl-compose-toolbar\">"
387 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
388 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
389 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
390 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
391 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
395 document.getElementById("ctdl-main").innerHTML = compose_screen;
396 mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
398 document.getElementById("ctdl-compose-cc-label").style.display = "block";
399 document.getElementById("ctdl-compose-cc-field").style.display = "block";
404 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
405 // It is also called automatically during a Reply when CC is pre-populated.
406 function make_cc_bcc_visible() {
407 document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
408 document.getElementById("ctdl-compose-bcc-label").style.display = "block";
409 document.getElementById("ctdl-compose-bcc-field").style.display = "block";
413 // Helper function for mail_send_messages() to extract and decode metadata values.
414 function msm_field(element_name, separator) {
415 let s1 = document.getElementById(element_name).innerHTML;
416 let s2 = s1.replaceAll("|",separator); // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
417 let s3 = decodeURI(s2);
418 let s4 = document.createElement("textarea"); // This One Weird Trick Unescapes All HTML Entities
425 // Save the posted message to the server
426 function mail_send_message() {
428 document.body.style.cursor = "wait";
429 let url = "/ctdl/r/" + escapeHTMLURI(current_room)
430 + "/dummy_name_for_new_mail"
431 + "?wefw=" + msm_field("ctdl_mc_references", "!") // references (if present)
432 + "&subj=" + msm_field("ctdl-compose-subject-field", " ") // subject (if present)
433 + "&mailto=" + msm_field("ctdl-compose-to-field", ",") // To: (required)
434 + "&mailcc=" + msm_field("ctdl-compose-cc-field", ",") // Cc: (if present)
435 + "&mailbcc=" + msm_field("ctdl-compose-bcc-field", ",") // Bcc: (if present)
437 boundary = randomString();
439 "--" + boundary + "\r\n"
440 + "Content-type: text/html\r\n"
441 + "Content-transfer-encoding: quoted-printable\r\n"
443 + quoted_printable_encode(
444 "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
446 + "--" + boundary + "--\r\n"
449 var request = new XMLHttpRequest();
450 request.open("PUT", url, true);
451 request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
452 request.onreadystatechange = function() {
453 if (request.readyState == 4) {
454 document.body.style.cursor = "default";
455 if (Math.trunc(request.status / 100) == 2) {
456 headers = request.getAllResponseHeaders().split("\n");
457 for (var i in headers) {
458 if (headers[i].startsWith("etag: ")) {
459 new_msg_num = headers[i].split(" ")[1];
463 // After saving the message, go back to the mailbox view.
464 gotoroom(current_room);
468 error_message = request.responseText;
469 if (error_message.length == 0) {
470 error_message = _("An error has occurred.");
472 alert(error_message); // editor remains open
476 request.send(body_text);