Consistent calling syntax for view renderers
[citadel.git] / webcit-ng / static / js / view_mail.js
1 // This module handles the view for "mailbox" rooms.
2 //
3 // Copyright (c) 2016-2022 by the citadel.org team
4 //
5 // This program is open source software.  Use, duplication, or
6 // disclosure are subject to the GNU General Public License v3.
7
8
9 var selected_message = 0;                                                       // Remember the last message that was selected
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
15 };
16
17
18 // Render reply address for a message (FIXME figure out how to deal with "reply-to:")
19 function reply_addr(msg) {
20         //if (msg.locl) {
21                 //return([msg.from]);
22         //}
23         //else {
24                 return([msg.from + " <" + msg.rfca + ">"]);
25         //}
26 }
27
28
29 // Render the To: recipients for a reply-all operation
30 function replyall_to(msg) {
31         return([...reply_addr(msg), ...msg.rcpt]);
32 }
33
34
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) {
38         let div = "FIXME";
39         try {
40                 outmsg =
41                   "<div class=\"ctdl-mmsg-wrapper\">"                           // begin message wrapper
42                 ;
43
44                 if (include_controls) {                                         // omit controls if this is a pull quote
45                         outmsg +=
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
56                 
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> " 
60                         + _("Reply")
61                         + "</a></span>"
62                 
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> " 
66                         + _("ReplyAll")
67                         + "</a></span>";
68                 
69                         if (can_delete_messages) {
70                                 outmsg +=
71                                 "<span class=\"ctdl-msg-button\">"
72                                 + "<a href=\"javascript:forum_delete_message('"+div+"','"+msg.msgnum+"');\">"
73                                 + "<i class=\"fa fa-trash\"></i> " 
74                                 + _("Delete")
75                                 + "</a></span>";
76                         }
77                 
78                         outmsg +=
79                           "</span>";                                            // end buttons on right side
80
81                         // Display the To: recipients, if any are present
82                         if (msg.rcpt) {
83                                 outmsg += "<br><span>" + _("To:") + " ";
84                                 for (var r=0; r<msg.rcpt.length; ++r) {
85                                         if (r != 0) {
86                                                 outmsg += ", ";
87                                         }
88                                         outmsg += escapeHTML(msg.rcpt[r]);
89                                 }
90                                 outmsg += "</span>";
91                         }
92
93                         // Display the Cc: recipients, if any are present
94                         if (msg.cccc) {
95                                 outmsg += "<br><span>" + _("Cc:") + " ";
96                                 for (var r=0; r<msg.cccc.length; ++r) {
97                                         if (r != 0) {
98                                                 outmsg += ", ";
99                                         }
100                                         outmsg += escapeHTML(msg.cccc[r]);
101                                 }
102                                 outmsg += "</span>";
103                         }
104
105                         // Display a subject line, but only if the message has a subject (internal Citadel messages often don't)
106                         if (msg.subj) {
107                                 outmsg +=
108                                 "<br><span class=\"ctdl-msgsubject\">" + msg.subj + "</span>";
109                         }
110
111                         outmsg +=
112                           "</div>";                                             // end header
113                 }
114
115                 outmsg +=
116                   "<div class=\"ctdl-msg-body\" id=\"" + div + "_body\">"       // begin body
117                 + msg.text
118                 + "</div>"                                                      // end body
119                 + "</div>"                                                      // end content
120                 + "</div>"                                                      // end wrapper
121                 ;
122         }
123         catch(err) {
124                 outmsg = "<div class=\"ctdl-mmsg-wrapper\">" + err.message + "</div>";
125         }
126
127         target_div.innerHTML = outmsg;
128 }
129
130
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());
137                 if (response.ok) {
138                         mail_render_one(msgnum, msg, target_div, include_controls);
139                 }
140         }
141         mail_fetch_msg();
142 }
143
144
145 // A message has been selected...
146 function select_message(msgnum) {
147         // unhighlight any previously selected message
148         try {
149                 document.getElementById("ctdl-msgsum-" + selected_message).classList.remove("ctdl-mail-selected");
150         }
151         catch {
152         }
153
154         // highlight the newly selected message
155         document.getElementById("ctdl-msgsum-" + msgnum).classList.add("ctdl-mail-selected");
156         //document.getElementById("ctdl-msgsum-" + msgnum).scrollIntoView();
157
158         // display the message if it isn't already displayed
159         if (selected_message != msgnum) {
160                 selected_message = msgnum;
161                 mail_display_message(msgnum, document.getElementById("ctdl-mailbox-reading-pane"), 1);
162         }
163 }
164
165
166 // render one row in the mailbox table (this could be called from one of several places)
167 function mail_render_row(msg) {
168         row     = "<tr "
169                 + "id=\"ctdl-msgsum-" + msg["msgnum"] + "\" "
170                 + "onClick=\"select_message(" + msg["msgnum"] + ");\" "
171                 //+ "onmouseenter=\"console.log('mouse in');\" "
172                 //+ "onmouseleave=\"console.log('mouse out');\""
173                 + ">"
174                 + "<td class=\"ctdl-mail-subject\">" + msg["subject"] + "</td>"
175                 + "<td class=\"ctdl-mail-sender\">" + msg["author"] + "</td>"
176                 + "<td class=\"ctdl-mail-date\">" + string_timestamp(msg["time"],1) + "</td>"
177                 + "<td class=\"ctdl-mail-msgnum\">" + msg["msgnum"] + "</td>"
178                 + "</tr>";
179         return(row);
180 }
181
182
183 // RENDERER FOR THIS VIEW
184 function view_render_mail() {
185         // Put the "enter new message" button into the sidebar
186         document.getElementById("ctdl-newmsg-button").innerHTML = "<i class=\"fa fa-edit\"></i>" + _("Write mail");
187         document.getElementById("ctdl-newmsg-button").style.display = "block";
188
189         document.getElementById("ctdl-main").innerHTML
190                 = "<div id=\"ctdl-mailbox-grid-container\" class=\"ctdl-mailbox-grid-container\">"
191                 + "<div id=\"ctdl-mailbox-pane\" class=\"ctdl-mailbox-pane\"></div>"
192                 + "<div id=\"ctdl-mailbox-reading-pane\" class=\"ctdl-mailbox-reading-pane\"></div>"
193                 + "</div>"
194         ;
195
196         highest_mailnum = 0;                                    // Keep track of highest message number to track newly arrived messages
197         render_mailbox_display(newmail_notify.NO);
198         try {                                                   // if this was already set up, clear it so there aren't multiple
199                 clearInterval(RefreshMailboxInterval);
200         }
201         catch {
202         }
203         RefreshMailboxInterval = setInterval(refresh_mail_display, 10000);
204 }
205
206
207 // Refresh the mailbox, either for the first time or whenever needed
208 function refresh_mail_display() {
209         // If the "ctdl-mailbox-pane" no longer exists, the user has navigated to a different part of the site,
210         // so cancel the refresh.
211         try {
212                 document.getElementById("ctdl-mailbox-pane").innerHTML;
213         }
214         catch {
215                 clearInterval(RefreshMailboxInterval);
216                 return;
217         }
218
219         // Ask the server if the room has been written to since our last look at it.
220         url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/stat";
221         fetch_stat = async() => {
222                 response = await fetch(url);
223                 stat = await(response.json());
224                 if (stat.room_mtime > room_mtime) {
225                         room_mtime = stat.room_mtime;
226                         render_mailbox_display(newmail_notify.YES);
227                 }
228         }
229         fetch_stat();
230 }
231
232
233 // This is where the rendering of the message list in the mailbox view is performed.
234 // Set notify to newmail_notify.NO or newmail_notify.YES depending on whether we want notifications for new mail.
235 function render_mailbox_display(notify) {
236
237         let do_notify = 0;
238
239         url = "/ctdl/r/" + escapeHTMLURI(current_room) + "/mailbox";
240         fetch_mailbox = async() => {
241                 response = await fetch(url);
242                 msgs = await(response.json());
243                 if (response.ok) {
244
245                         box =   "<table class=\"ctdl-mailbox-table\" width=100%><tr>"
246                                 + "<th>" + _("Subject") + "</th>"
247                                 + "<th>" + _("Sender") + "</th>"
248                                 + "<th>" + _("Date") + "</th>"
249                                 + "<th>#</th>"
250                                 + "</tr>";
251
252                         for (let i=0; i<msgs.length; ++i) {
253                                 box += mail_render_row(msgs[i]);
254                                 let m = parseInt(msgs[i].msgnum);
255                                 if (m > highest_mailnum) {
256                                         highest_mailnum = m;
257                                         do_notify += 1;
258                                 }
259                         }
260
261                         box +=  "</table>";
262                         document.getElementById("ctdl-mailbox-pane").innerHTML = box;
263
264                         if (selected_message > 0) {                     // if we had a message selected, keep it selected
265                                 select_message(selected_message);
266                         }
267                         if ( (do_notify > 0) && (notify == newmail_notify.YES) ) {
268                                 console.log(do_notify + " new mail");
269                                 new_mail_sound.play();                  // FIXME do a visual notification as well
270                         }
271                 }
272         }
273         fetch_mailbox();
274 }
275
276
277 // Compose a new mail message (called by the Reply button here, or by the dispatcher in views.js)
278 function mail_compose(is_quoted, references, quoted_msgnum, m_to, m_cc, m_subject) {
279         // m_to will be an array of zero or more recipients for the To: field.  Convert it to a string.
280         if (m_to) {
281                 m_to = Array.from(new Set(m_to));       // remove dupes
282                 m_to_str = "";
283                 for (i=0; i<m_to.length; ++i) {
284                         if (i > 0) {
285                                 m_to_str += ", ";
286                         }
287                         m_to_str += m_to[i].replaceAll("<", "&lt;").replaceAll(">", "&gt;");
288                 }
289         }
290         else {
291                 m_to_str = "";
292         }
293
294         // m_to will be an array of zero or more recipients for the Cc: field.  Convert it to a string.
295         if (m_cc) {
296                 m_cc = Array.from(new Set(m_cc));       // remove dupes
297                 m_cc_str = "";
298                 for (i=0; i<m_cc.length; ++i) {
299                         if (i > 0) {
300                                 m_cc_str += ", ";
301                         }
302                         m_cc_str += m_cc[i].replaceAll("<", "&lt;").replaceAll(">", "&gt;");
303                 }
304         }
305         else {
306                 m_cc_str = "";
307         }
308
309         quoted_div_name = randomString();
310
311         // Make the "Write mail" button disappear.  We're already there!
312         document.getElementById("ctdl-newmsg-button").style.display = "none";
313
314         // is_quoted    true or false depending on whether the user selected "reply quoted" (is this appropriate for mail?)
315         // references   list of references, be sure to use this in a reply
316         // msgid        if a reply, the msgid of the most recent message in the chain, the one to which we are replying
317
318         // Now display the screen.
319         compose_screen =
320                 // Hidden values that we are storing right here in the document tree for later
321                   "<input id=\"ctdl_mc_is_quoted\" style=\"display:none\" value=\"" + is_quoted + "\"></input>"
322                 + "<input id=\"ctdl_mc_references\" style=\"display:none\" value=\"" + references + "\"></input>"
323
324                 // Header fields, the composition window, and the button bar are arranged using a Grid layout.
325                 + "<div id=\"ctdl-compose-mail\" class=\"ctdl-compose-mail\">"
326
327                 // Visible To: field, plus a box to make the CC/BCC lines appear
328                 + "<div class=\"ctdl-compose-to-label\">" + _("To:") + "</div>"
329                 + "<div class=\"ctdl-compose-to-line\">"
330                 + "<div class=\"ctdl-compose-to-field\" id=\"ctdl-compose-to-field\" contenteditable=\"true\">" + m_to_str + "</div>"
331                 + "<div class=\"ctdl-cc-bcc-buttons ctdl-msg-button\" id=\"ctdl-cc-bcc-buttons\" "
332                 + "onClick=\"make_cc_bcc_visible()\">"
333                 + _("CC:") + "/" + _("BCC:") + "</div>"
334                 + "</div>"
335
336                 // CC/BCC
337                 + "<div class=\"ctdl-compose-cc-label\" id=\"ctdl-compose-cc-label\">" + _("CC:") + "</div>"
338                 + "<div class=\"ctdl-compose-cc-field\" id=\"ctdl-compose-cc-field\" contenteditable=\"true\">" + m_cc_str + "</div>"
339                 + "<div class=\"ctdl-compose-bcc-label\" id=\"ctdl-compose-bcc-label\">" + _("BCC:") + "</div>"
340                 + "<div class=\"ctdl-compose-bcc-field\" id=\"ctdl-compose-bcc-field\" contenteditable=\"true\"></div>"
341
342                 // Visible subject field
343                 + "<div class=\"ctdl-compose-subject-label\">" + _("Subject:") + "</div>"
344                 + "<div class=\"ctdl-compose-subject-field\" id=\"ctdl-compose-subject-field\" contenteditable=\"true\">" + m_subject + "</div>"
345
346                 // Message composition box
347                 + "<div class=\"ctdl-compose-message-box\" id=\"ctdl-editor-body\" contenteditable=\"true\">"
348         ;
349
350         if (is_quoted) {
351                 compose_screen += "<br><br><blockquote><div id=\"" + quoted_div_name + "\"></div></blockquote>";
352         }
353
354         compose_screen +=
355                   "</div>"
356
357                 // The button bar is a Grid element, and is also a Flexbox container.
358                 + "<div class=\"ctdl-compose-toolbar\">"
359                 + "<span class=\"ctdl-msg-button\" onclick=\"mail_send_message()\"><i class=\"fa fa-paper-plane\" style=\"color:green\"></i> " + _("Send message") + "</span>"
360                 + "<span class=\"ctdl-msg-button\">" + _("Save to Drafts") + "</span>"
361                 + "<span class=\"ctdl-msg-button\">" + _("Attachments:") + " 0" + "</span>"
362                 + "<span class=\"ctdl-msg-button\">" + _("Contacts") + "</span>"
363                 + "<span class=\"ctdl-msg-button\" onClick=\"gotoroom(current_room)\"><i class=\"fa fa-trash\" style=\"color:red\"></i> " + _("Cancel") + "</span>"
364                 + "</div>"
365         ;
366
367         document.getElementById("ctdl-main").innerHTML = compose_screen;
368         mail_display_message(quoted_msgnum, document.getElementById(quoted_div_name), 0);
369         if (m_cc) {
370                 document.getElementById("ctdl-compose-cc-label").style.display = "block";
371                 document.getElementById("ctdl-compose-cc-field").style.display = "block";
372         }
373 }
374
375
376 // Called when the user clicks the button to make the hidden "CC" and "BCC" lines appear.
377 // It is also called automatically during a Reply when CC is pre-populated.
378 function make_cc_bcc_visible() {
379         document.getElementById("ctdl-cc-bcc-buttons").style.display = "none";
380         document.getElementById("ctdl-compose-bcc-label").style.display = "block";
381         document.getElementById("ctdl-compose-bcc-field").style.display = "block";
382 }
383
384
385 // Helper function for mail_send_messages() to extract and decode metadata values.
386 function msm_field(element_name, separator) {
387         let s1 = document.getElementById(element_name).innerHTML;
388         let s2 = s1.replaceAll("|",separator);          // Replace "|" with "!" because "|" is a field separator in Citadel wire protocol
389         let s3 = decodeURI(s2);
390         let s4 = document.createElement("textarea");    // This One Weird Trick Unescapes All HTML Entities
391         s4.innerHTML = s3;
392         let s5 = s4.value;
393         return(s5);
394 }
395
396
397 // Save the posted message to the server
398 function mail_send_message() {
399
400         document.body.style.cursor = "wait";
401         let url = "/ctdl/r/" + escapeHTMLURI(current_room)
402                 + "/dummy_name_for_new_mail"
403                 + "?wefw="      + msm_field("ctdl_mc_references", "!")                          // references (if present)
404                 + "&subj="      + msm_field("ctdl-compose-subject-field", " ")                  // subject (if present)
405                 + "&mailto="    + msm_field("ctdl-compose-to-field", ",")                       // To: (required)
406                 + "&mailcc="    + msm_field("ctdl-compose-cc-field", ",")                       // Cc: (if present)
407                 + "&mailbcc="   + msm_field("ctdl-compose-bcc-field", ",")                      // Bcc: (if present)
408         ;
409         boundary = randomString();
410         body_text =
411                 "--" + boundary + "\r\n"
412                 + "Content-type: text/html\r\n"
413                 + "Content-transfer-encoding: quoted-printable\r\n"
414                 + "\r\n"
415                 + quoted_printable_encode(
416                         "<html><body>" + document.getElementById("ctdl-editor-body").innerHTML + "</body></html>"
417                 ) + "\r\n"
418                 + "--" + boundary + "--\r\n"
419         ;
420
421         var request = new XMLHttpRequest();
422         request.open("PUT", url, true);
423         request.setRequestHeader("Content-type", "multipart/mixed; boundary=\"" + boundary + "\"");
424         request.onreadystatechange = function() {
425                 if (request.readyState == 4) {
426                         document.body.style.cursor = "default";
427                         if (Math.trunc(request.status / 100) == 2) {
428                                 headers = request.getAllResponseHeaders().split("\n");
429                                 for (var i in headers) {
430                                         if (headers[i].startsWith("etag: ")) {
431                                                 new_msg_num = headers[i].split(" ")[1];
432                                         }
433                                 }
434
435                                 // After saving the message, go back to the mailbox view.
436                                 gotoroom(current_room);
437
438                         }
439                         else {
440                                 error_message = request.responseText;
441                                 if (error_message.length == 0) {
442                                         error_message = _("An error has occurred.");
443                                 }
444                                 alert(error_message);                                           // editor remains open
445                         }
446                 }
447         };
448         request.send(body_text);
449 }