imap_output_copyuid_response() now accepts an IMAP session context passed up the...
[citadel.git] / citadel / modules / imap / imap_misc.c
1 /*
2  * Copyright (c) 1987-2017 by the citadel.org team
3  *
4  * This program is open source software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14
15
16 #include "sysdep.h"
17 #include <stdlib.h>
18 #include <unistd.h>
19 #include <stdio.h>
20 #include <fcntl.h>
21 #include <signal.h>
22 #include <pwd.h>
23 #include <errno.h>
24 #include <sys/types.h>
25
26 #if TIME_WITH_SYS_TIME
27 # include <sys/time.h>
28 # include <time.h>
29 #else
30 # if HAVE_SYS_TIME_H
31 #  include <sys/time.h>
32 # else
33 #  include <time.h>
34 # endif
35 #endif
36
37 #include <sys/wait.h>
38 #include <ctype.h>
39 #include <string.h>
40 #include <limits.h>
41 #include <libcitadel.h>
42 #include "citadel.h"
43 #include "server.h"
44 #include "sysdep_decls.h"
45 #include "citserver.h"
46 #include "support.h"
47 #include "config.h"
48 #include "user_ops.h"
49 #include "database.h"
50 #include "msgbase.h"
51 #include "room_ops.h"
52 #include "internet_addressing.h"
53 #include "serv_imap.h"
54 #include "imap_tools.h"
55 #include "imap_fetch.h"
56 #include "imap_misc.h"
57 #include "genstamp.h"
58 #include "ctdl_module.h"
59
60
61
62
63
64 /*
65  * imap_copy() calls imap_do_copy() to do its actual work, once it's
66  * validated and boiled down the request a bit.  (returns 0 on success)
67  */
68 int imap_do_copy(const char *destination_folder) {
69         citimap *Imap = IMAP;
70         int i;
71         char roomname[ROOMNAMELEN];
72         struct ctdlroom qrbuf;
73         long *selected_msgs = NULL;
74         int num_selected = 0;
75
76         if (Imap->num_msgs < 1) {
77                 return(0);
78         }
79
80         i = imap_grabroom(roomname, destination_folder, 1);
81         if (i != 0) return(i);
82
83         /*
84          * Copy all the message pointers in one shot.
85          */
86         selected_msgs = malloc(sizeof(long) * Imap->num_msgs);
87         if (selected_msgs == NULL) return(-1);
88
89         for (i = 0; i < Imap->num_msgs; ++i) {
90                 if (Imap->flags[i] & IMAP_SELECTED) {
91                         selected_msgs[num_selected++] = Imap->msgids[i];
92                 }
93         }
94
95         if (num_selected > 0) {
96                 CtdlSaveMsgPointersInRoom(roomname, selected_msgs, num_selected, 1, NULL, 0);
97         }
98         free(selected_msgs);
99
100         /* Don't bother wasting any more time if there were no messages. */
101         if (num_selected == 0) {
102                 return(0);
103         }
104
105         /* Enumerate lists of messages for which flags are toggled */
106         long *seen_yes = NULL;
107         int num_seen_yes = 0;
108         long *seen_no = NULL;
109         int num_seen_no = 0;
110         long *answ_yes = NULL;
111         int num_answ_yes = 0;
112         long *answ_no = NULL;
113         int num_answ_no = 0;
114
115         seen_yes = malloc(num_selected * sizeof(long));
116         seen_no = malloc(num_selected * sizeof(long));
117         answ_yes = malloc(num_selected * sizeof(long));
118         answ_no = malloc(num_selected * sizeof(long));
119
120         for (i = 0; i < Imap->num_msgs; ++i) {
121                 if (Imap->flags[i] & IMAP_SELECTED) {
122                         if (Imap->flags[i] & IMAP_SEEN) {
123                                 seen_yes[num_seen_yes++] = Imap->msgids[i];
124                         }
125                         if ((Imap->flags[i] & IMAP_SEEN) == 0) {
126                                 seen_no[num_seen_no++] = Imap->msgids[i];
127                         }
128                         if (Imap->flags[i] & IMAP_ANSWERED) {
129                                 answ_yes[num_answ_yes++] = Imap->msgids[i];
130                         }
131                         if ((Imap->flags[i] & IMAP_ANSWERED) == 0) {
132                                 answ_no[num_answ_no++] = Imap->msgids[i];
133                         }
134                 }
135         }
136
137         /* Set the flags... */
138         i = CtdlGetRoom(&qrbuf, roomname);
139         if (i == 0) {
140                 CtdlSetSeen(seen_yes, num_seen_yes, 1, ctdlsetseen_seen, NULL, &qrbuf);
141                 CtdlSetSeen(seen_no, num_seen_no, 0, ctdlsetseen_seen, NULL, &qrbuf);
142                 CtdlSetSeen(answ_yes, num_answ_yes, 1, ctdlsetseen_answered, NULL, &qrbuf);
143                 CtdlSetSeen(answ_no, num_answ_no, 0, ctdlsetseen_answered, NULL, &qrbuf);
144         }
145
146         free(seen_yes);
147         free(seen_no);
148         free(answ_yes);
149         free(answ_no);
150
151         return(0);
152 }
153
154
155 /*
156  * Output the [COPYUID xxx yyy] response code required by RFC2359
157  * to tell the client the UID's of the messages that were copied (if any).
158  * We are assuming that the IMAP_SELECTED flag is still set on any relevant
159  * messages in our source room.  Since the Citadel system uses UID's that
160  * are both globally unique and persistent across a room-to-room copy, we
161  * can get this done quite easily.
162  *
163  * FIXME this is outputing WRONG !!!   See https://tools.ietf.org/html/rfc2359#section-4.3
164  */
165 void imap_output_copyuid_response(citimap *Imap) {
166         int i;
167         int num_output = 0;
168   
169         for (i = 0; i < Imap->num_msgs; ++i) {
170                 if (Imap->flags[i] & IMAP_SELECTED) {
171                         ++num_output;
172                         if (num_output == 1) {
173                                 IAPuts("[COPYUID ");
174                         }
175                         else if (num_output > 1) {
176                                 IAPuts(",");
177                         }
178                         IAPrintf("%ld", Imap->msgids[i]);
179                 }
180         }
181         if (num_output > 0) {
182                 IAPuts("] ");
183         }
184 }
185
186
187 /*
188  * This function is called by the main command loop.
189  */
190 void imap_copy(int num_parms, ConstStr *Params) {
191         int ret;
192
193         if (num_parms != 4) {
194                 IReply("BAD invalid parameters");
195                 return;
196         }
197
198         if (imap_is_message_set(Params[2].Key)) {
199                 imap_pick_range(Params[2].Key, 0);
200         }
201         else {
202                 IReply("BAD invalid parameters");
203                 return;
204         }
205
206         ret = imap_do_copy(Params[3].Key);
207         if (!ret) {
208                 IAPrintf("%s OK ", Params[0].Key);
209                 imap_output_copyuid_response(IMAP);
210                 IAPuts("COPY completed\r\n");
211         }
212         else {
213                 IReplyPrintf("NO COPY failed (error %d)", ret);
214         }
215 }
216
217 /*
218  * This function is called by the main command loop.
219  */
220 void imap_uidcopy(int num_parms, ConstStr *Params) {
221
222         if (num_parms != 5) {
223                 IReply("BAD invalid parameters");
224                 return;
225         }
226
227         if (imap_is_message_set(Params[3].Key)) {
228                 imap_pick_range(Params[3].Key, 1);
229         }
230         else {
231                 IReply("BAD invalid parameters");
232                 return;
233         }
234
235         if (imap_do_copy(Params[4].Key) == 0) {
236                 IAPrintf("%s OK ", Params[0].Key);
237                 imap_output_copyuid_response(IMAP);
238                 IAPuts("UID COPY completed\r\n");
239         }
240         else {
241                 IReply("NO UID COPY failed");
242         }
243 }
244
245
246 /*
247  * imap_do_append_flags() is called by imap_append() to set any flags that
248  * the client specified at append time.
249  *
250  * FIXME find a way to do these in bulk so we don't max out our db journal
251  */
252 void imap_do_append_flags(long new_msgnum, char *new_message_flags) {
253         char flags[32];
254         char this_flag[sizeof flags];
255         int i;
256
257         if (new_message_flags == NULL) return;
258         if (IsEmptyStr(new_message_flags)) return;
259
260         safestrncpy(flags, new_message_flags, sizeof flags);
261
262         for (i=0; i<num_tokens(flags, ' '); ++i) {
263                 extract_token(this_flag, flags, i, ' ', sizeof this_flag);
264                 if (this_flag[0] == '\\') strcpy(this_flag, &this_flag[1]);
265                 if (!strcasecmp(this_flag, "Seen")) {
266                         CtdlSetSeen(&new_msgnum, 1, 1, ctdlsetseen_seen,
267                                 NULL, NULL);
268                 }
269                 if (!strcasecmp(this_flag, "Answered")) {
270                         CtdlSetSeen(&new_msgnum, 1, 1, ctdlsetseen_answered,
271                                 NULL, NULL);
272                 }
273         }
274 }
275
276
277 /*
278  * This function is called by the main command loop.
279  */
280 void imap_append(int num_parms, ConstStr *Params) {
281         struct CitContext *CCC = CC;
282         long literal_length;
283         struct CtdlMessage *msg = NULL;
284         long new_msgnum = (-1L);
285         int ret = 0;
286         char roomname[ROOMNAMELEN];
287         char errbuf[SIZ];
288         char dummy[SIZ];
289         char savedroom[ROOMNAMELEN];
290         int msgs, new;
291         int i;
292         char new_message_flags[SIZ];
293         citimap *Imap;
294
295         if (num_parms < 4) {
296                 IReply("BAD usage error");
297                 return;
298         }
299
300         if ( (Params[num_parms-1].Key[0] != '{')
301            || (Params[num_parms-1].Key[Params[num_parms-1].len-1] != '}') )  {
302                 IReply("BAD no message literal supplied");
303                 return;
304         }
305
306         *new_message_flags = '\0';
307         if (num_parms >= 5) {
308                 for (i=3; i<num_parms; ++i) {
309                         strcat(new_message_flags, Params[i].Key);
310                         strcat(new_message_flags, " ");
311                 }
312                 stripallbut(new_message_flags, '(', ')');
313         }
314
315         /* This is how we'd do this if it were relevant in our data store.
316          * if (num_parms >= 6) {
317          *  new_message_internaldate = parms[4];
318          * }
319          */
320
321         literal_length = atol(&Params[num_parms-1].Key[1]);
322         if (literal_length < 1) {
323                 IReply("BAD Message length must be at least 1.");
324                 return;
325         }
326
327         Imap = IMAP;
328         imap_free_transmitted_message();        /* just in case. */
329
330         Imap->TransmittedMessage = NewStrBufPlain(NULL, literal_length);
331
332         if (Imap->TransmittedMessage == NULL) {
333                 IReply("NO Cannot allocate memory.");
334                 return;
335         }
336         
337         IAPrintf("+ Transmit message now.\r\n");
338         
339         IUnbuffer ();
340
341         client_read_blob(Imap->TransmittedMessage, literal_length, CtdlGetConfigInt("c_sleeping"));
342
343         if ((ret < 0) || (StrLength(Imap->TransmittedMessage) < literal_length)) {
344                 IReply("NO Read failed.");
345                 return;
346         }
347
348         /* Client will transmit a trailing CRLF after the literal (the message
349          * text) is received.  This call to client_getln() absorbs it.
350          */
351         flush_output();
352         client_getln(dummy, sizeof dummy);
353
354         /* Convert RFC822 newlines (CRLF) to Unix newlines (LF) */
355         syslog(LOG_DEBUG, "Converting CRLF to LF");
356         StrBufToUnixLF(Imap->TransmittedMessage);
357
358         syslog(LOG_DEBUG, "Converting message format");
359         msg = convert_internet_message_buf(&Imap->TransmittedMessage);
360
361         ret = imap_grabroom(roomname, Params[2].Key, 1);
362         if (ret != 0) {
363                 IReply("NO Invalid mailbox name or access denied");
364                 return;
365         }
366
367         /*
368          * CtdlUserGoto() formally takes us to the desired room.  (If another
369          * folder is selected, save its name so we can return there!!!!!)
370          */
371         if (Imap->selected) {
372                 strcpy(savedroom, CCC->room.QRname);
373         }
374         CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
375
376         /* If the user is locally authenticated, FORCE the From: header to
377          * show up as the real sender.  (Configurable setting)
378          */
379         if (CCC->logged_in) {
380                 if ( ((CCC->room.QRflags & QR_MAILBOX) == 0) && (CtdlGetConfigInt("c_imap_keep_from") == 0))
381                 {
382                         CM_SetField(msg, eAuthor, CCC->user.fullname, strlen(CCC->user.fullname));
383                         CM_SetField(msg, eNodeName, CtdlGetConfigStr("c_nodename"), strlen(CtdlGetConfigStr("c_nodename")));
384                         CM_SetField(msg, eHumanNode, CtdlGetConfigStr("c_humannode"), strlen(CtdlGetConfigStr("c_humannode")));
385                 }
386         }
387
388         /* 
389          * Can we post here?
390          */
391         ret = CtdlDoIHavePermissionToPostInThisRoom(errbuf, sizeof errbuf, NULL, POST_LOGGED_IN, 0);
392
393         if (ret) {
394                 /* Nope ... print an error message */
395                 IReplyPrintf("NO %s", errbuf);
396         }
397
398         else {
399                 /* Yes ... go ahead and post! */
400                 if (msg != NULL) {
401                         new_msgnum = CtdlSubmitMsg(msg, NULL, "", 0);
402                 }
403                 if (new_msgnum >= 0L) {
404                         IReplyPrintf("OK [APPENDUID %ld %ld] APPEND completed",
405                                      GLOBAL_UIDVALIDITY_VALUE, new_msgnum);
406                 }
407                 else {
408                         IReplyPrintf("BAD Error %ld saving message to disk.",
409                                      new_msgnum);
410                 }
411         }
412
413         /*
414          * IMAP protocol response to client has already been sent by now.
415          *
416          * If another folder is selected, go back to that room so we can resume
417          * our happy day without violent explosions.
418          */
419         if (Imap->selected) {
420                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
421         }
422
423         /* We don't need this buffer anymore */
424         CM_Free(msg);
425
426         if (IsEmptyStr(new_message_flags)) {
427                 imap_do_append_flags(new_msgnum, new_message_flags);
428         }
429 }