Displaying incoming instant messages through an IMAP client
[citadel.git] / citadel / modules / imap / serv_imap.c
1 /*
2  * $Id$ 
3  *
4  * IMAP server for the Citadel system
5  * Copyright (C) 2000-2007 by Art Cancro and others.
6  * This code is released under the terms of the GNU General Public License.
7  *
8  * WARNING: the IMAP protocol is badly designed.  No implementation of it
9  * is perfect.  Indeed, with so much gratuitous complexity, *all* IMAP
10  * implementations have bugs.
11  */
12
13 #include "sysdep.h"
14 #include <stdlib.h>
15 #include <unistd.h>
16 #include <stdio.h>
17 #include <fcntl.h>
18 #include <signal.h>
19 #include <pwd.h>
20 #include <errno.h>
21 #include <sys/types.h>
22
23 #if TIME_WITH_SYS_TIME
24 # include <sys/time.h>
25 # include <time.h>
26 #else
27 # if HAVE_SYS_TIME_H
28 #  include <sys/time.h>
29 # else
30 #  include <time.h>
31 # endif
32 #endif
33
34 #include <sys/wait.h>
35 #include <ctype.h>
36 #include <string.h>
37 #include <limits.h>
38 #include <libcitadel.h>
39 #include "citadel.h"
40 #include "server.h"
41 #include "citserver.h"
42 #include "support.h"
43 #include "config.h"
44 #include "room_ops.h"
45 #include "user_ops.h"
46 #include "policy.h"
47 #include "database.h"
48 #include "msgbase.h"
49 #include "internet_addressing.h"
50 #include "serv_imap.h"
51 #include "imap_tools.h"
52 #include "imap_list.h"
53 #include "imap_fetch.h"
54 #include "imap_search.h"
55 #include "imap_store.h"
56 #include "imap_acl.h"
57 #include "imap_metadata.h"
58 #include "imap_misc.h"
59
60
61 #include "ctdl_module.h"
62
63
64 /* imap_rename() uses this struct containing list of rooms to rename */
65 struct irl {
66         struct irl *next;
67         char irl_oldroom[ROOMNAMELEN];
68         char irl_newroom[ROOMNAMELEN];
69         int irl_newfloor;
70 };
71
72 /* Data which is passed between imap_rename() and imap_rename_backend() */
73 struct irlparms {
74         char *oldname;
75         char *newname;
76         struct irl **irl;
77 };
78
79
80 /*
81  * If there is a message ID map in memory, free it
82  */
83 void imap_free_msgids(void)
84 {
85         if (IMAP->msgids != NULL) {
86                 free(IMAP->msgids);
87                 IMAP->msgids = NULL;
88                 IMAP->num_msgs = 0;
89                 IMAP->num_alloc = 0;
90         }
91         if (IMAP->flags != NULL) {
92                 free(IMAP->flags);
93                 IMAP->flags = NULL;
94         }
95         IMAP->last_mtime = (-1);
96 }
97
98
99 /*
100  * If there is a transmitted message in memory, free it
101  */
102 void imap_free_transmitted_message(void)
103 {
104         if (IMAP->transmitted_message != NULL) {
105                 free(IMAP->transmitted_message);
106                 IMAP->transmitted_message = NULL;
107                 IMAP->transmitted_length = 0;
108         }
109 }
110
111
112 /*
113  * Set the \Seen, \Recent. and \Answered flags, based on the sequence
114  * sets stored in the visit record for this user/room.  Note that we have
115  * to parse each sequence set manually here, because calling the utility
116  * function is_msg_in_sequence_set() over and over again is too expensive.
117  *
118  * first_msg should be set to 0 to rescan the flags for every message in the
119  * room, or some other value if we're only interested in an incremental
120  * update.
121  */
122 void imap_set_seen_flags(int first_msg)
123 {
124         struct visit vbuf;
125         int i;
126         int num_sets;
127         int s;
128         char setstr[64], lostr[64], histr[64];
129         long lo, hi;
130
131         if (IMAP->num_msgs < 1) return;
132         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
133
134         for (i = first_msg; i < IMAP->num_msgs; ++i) {
135                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
136                 IMAP->flags[i] |= IMAP_RECENT;
137                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
138         }
139
140         /*
141          * Do the "\Seen" flag.
142          * (Any message not "\Seen" is considered "\Recent".)
143          */
144         num_sets = num_tokens(vbuf.v_seen, ',');
145         for (s=0; s<num_sets; ++s) {
146                 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
147
148                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
149                 if (num_tokens(setstr, ':') >= 2) {
150                         extract_token(histr, setstr, 1, ':', sizeof histr);
151                         if (!strcmp(histr, "*")) {
152                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
153                         }
154                 } 
155                 else {
156                         strcpy(histr, lostr);
157                 }
158                 lo = atol(lostr);
159                 hi = atol(histr);
160
161                 for (i = first_msg; i < IMAP->num_msgs; ++i) {
162                         if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
163                                 IMAP->flags[i] |= IMAP_SEEN;
164                                 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
165                         }
166                 }
167         }
168
169         /* Do the ANSWERED flag */
170         num_sets = num_tokens(vbuf.v_answered, ',');
171         for (s=0; s<num_sets; ++s) {
172                 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
173
174                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
175                 if (num_tokens(setstr, ':') >= 2) {
176                         extract_token(histr, setstr, 1, ':', sizeof histr);
177                         if (!strcmp(histr, "*")) {
178                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
179                         }
180                 } 
181                 else {
182                         strcpy(histr, lostr);
183                 }
184                 lo = atol(lostr);
185                 hi = atol(histr);
186
187                 for (i = first_msg; i < IMAP->num_msgs; ++i) {
188                         if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
189                                 IMAP->flags[i] |= IMAP_ANSWERED;
190                         }
191                 }
192         }
193
194 }
195
196
197
198 /*
199  * Back end for imap_load_msgids()
200  *
201  * Optimization: instead of calling realloc() to add each message, we
202  * allocate space in the list for REALLOC_INCREMENT messages at a time.  This
203  * allows the mapping to proceed much faster.
204  */
205 void imap_add_single_msgid(long msgnum, void *userdata)
206 {
207
208         ++IMAP->num_msgs;
209         if (IMAP->num_msgs > IMAP->num_alloc) {
210                 IMAP->num_alloc += REALLOC_INCREMENT;
211                 IMAP->msgids = realloc(IMAP->msgids,
212                                         (IMAP->num_alloc * sizeof(long)) );
213                 IMAP->flags = realloc(IMAP->flags,
214                                         (IMAP->num_alloc * sizeof(long)) );
215         }
216         IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
217         IMAP->flags[IMAP->num_msgs - 1] = 0;
218 }
219
220
221
222 /*
223  * Set up a message ID map for the current room (folder)
224  */
225 void imap_load_msgids(void)
226 {
227         struct cdbdata *cdbfr;
228
229         if (IMAP->selected == 0) {
230                 CtdlLogPrintf(CTDL_ERR,
231                         "imap_load_msgids() can't run; no room selected\n");
232                 return;
233         }
234
235         imap_free_msgids();     /* If there was already a map, free it */
236
237         /* Load the message list */
238         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
239         if (cdbfr != NULL) {
240                 IMAP->msgids = malloc(cdbfr->len);
241                 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
242                 IMAP->num_msgs = cdbfr->len / sizeof(long);
243                 IMAP->num_alloc = cdbfr->len / sizeof(long);
244                 cdb_free(cdbfr);
245         }
246
247         if (IMAP->num_msgs) {
248                 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
249                 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
250         }
251
252         imap_set_seen_flags(0);
253 }
254
255
256 /*
257  * Re-scan the selected room (folder) and see if it's been changed at all
258  */
259 void imap_rescan_msgids(void)
260 {
261
262         int original_num_msgs = 0;
263         long original_highest = 0L;
264         int i, j, jstart;
265         int message_still_exists;
266         struct cdbdata *cdbfr;
267         long *msglist = NULL;
268         int num_msgs = 0;
269         int num_recent = 0;
270
271         if (IMAP->selected == 0) {
272                 CtdlLogPrintf(CTDL_ERR,
273                         "imap_load_msgids() can't run; no room selected\n");
274                 return;
275         }
276
277         /*
278          * Check to see if the room's contents have changed.
279          * If not, we can avoid this rescan.
280          */
281         getroom(&CC->room, CC->room.QRname);
282         if (IMAP->last_mtime == CC->room.QRmtime) {     /* No changes! */
283                 return;
284         }
285
286         /* Load the *current* message list from disk, so we can compare it
287          * to what we have in memory.
288          */
289         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
290         if (cdbfr != NULL) {
291                 msglist = malloc(cdbfr->len);
292                 if (msglist == NULL) {
293                         CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
294                         abort();
295                 }
296                 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
297                 num_msgs = cdbfr->len / sizeof(long);
298                 cdb_free(cdbfr);
299         } else {
300                 num_msgs = 0;
301         }
302
303         /*
304          * Check to see if any of the messages we know about have been expunged
305          */
306         if (IMAP->num_msgs > 0) {
307                 jstart = 0;
308                 for (i = 0; i < IMAP->num_msgs; ++i) {
309
310                         message_still_exists = 0;
311                         if (num_msgs > 0) {
312                                 for (j = jstart; j < num_msgs; ++j) {
313                                         if (msglist[j] == IMAP->msgids[i]) {
314                                                 message_still_exists = 1;
315                                                 jstart = j;
316                                                 break;
317                                         }
318                                 }
319                         }
320
321                         if (message_still_exists == 0) {
322                                 cprintf("* %d EXPUNGE\r\n", i + 1);
323
324                                 /* Here's some nice stupid nonsense.  When a
325                                  * message is expunged, we have to slide all
326                                  * the existing messages up in the message
327                                  * array.
328                                  */
329                                 --IMAP->num_msgs;
330                                 memcpy(&IMAP->msgids[i],
331                                        &IMAP->msgids[i + 1],
332                                        (sizeof(long) *
333                                         (IMAP->num_msgs - i)));
334                                 memcpy(&IMAP->flags[i],
335                                        &IMAP->flags[i + 1],
336                                        (sizeof(long) *
337                                         (IMAP->num_msgs - i)));
338
339                                 --i;
340                         }
341
342                 }
343         }
344
345         /*
346          * Remember how many messages were here before we re-scanned.
347          */
348         original_num_msgs = IMAP->num_msgs;
349         if (IMAP->num_msgs > 0) {
350                 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
351         } else {
352                 original_highest = 0L;
353         }
354
355         /*
356          * Now peruse the room for *new* messages only.
357          */
358         if (num_msgs > 0) {
359                 for (j = 0; j < num_msgs; ++j) {
360                         if (msglist[j] > original_highest) {
361                                 imap_add_single_msgid(msglist[j], NULL);
362                         }
363                 }
364         }
365         imap_set_seen_flags(original_num_msgs);
366
367         /*
368          * If new messages have arrived, tell the client about them.
369          */
370         if (IMAP->num_msgs > original_num_msgs) {
371
372                 for (j = 0; j < num_msgs; ++j) {
373                         if (IMAP->flags[j] & IMAP_RECENT) {
374                                 ++num_recent;
375                         }
376                 }
377
378                 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
379                 cprintf("* %d RECENT\r\n", num_recent);
380         }
381
382         if (num_msgs != 0) {
383                 free(msglist);
384         }
385         IMAP->last_mtime = CC->room.QRmtime;
386 }
387
388
389
390
391
392
393
394 /*
395  * This cleanup function blows away the temporary memory and files used by
396  * the IMAP server.
397  */
398 void imap_cleanup_function(void)
399 {
400
401         /* Don't do this stuff if this is not a IMAP session! */
402         if (CC->h_command_function != imap_command_loop)
403                 return;
404
405         /* If there is a mailbox selected, auto-expunge it. */
406         if (IMAP->selected) {
407                 imap_do_expunge();
408         }
409
410         CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
411         imap_free_msgids();
412         imap_free_transmitted_message();
413
414         if (IMAP->cached_rfc822_data != NULL) {
415                 free(IMAP->cached_rfc822_data);
416                 IMAP->cached_rfc822_data = NULL;
417                 IMAP->cached_rfc822_msgnum = (-1);
418                 IMAP->cached_rfc822_withbody = 0;
419         }
420
421         if (IMAP->cached_body != NULL) {
422                 free(IMAP->cached_body);
423                 IMAP->cached_body = NULL;
424                 IMAP->cached_body_len = 0;
425                 IMAP->cached_bodymsgnum = (-1);
426         }
427
428         free(IMAP);
429         CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
430 }
431
432
433 /*
434  * Does the actual work of the CAPABILITY command (because we need to
435  * output this stuff in other places as well)
436  */
437 void imap_output_capability_string(void) {
438         cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
439
440 #ifdef HAVE_OPENSSL
441         if (!CC->redirect_ssl) cprintf(" STARTTLS");
442 #endif
443
444 #ifndef DISABLE_IMAP_ACL
445         cprintf(" ACL");
446 #endif
447
448         /* We are building a partial implementation of METADATA for the sole purpose
449          * of interoperating with the ical/vcard version of the Bynari Insight Connector.
450          * If you were expecting something else, comment out one or both of these
451          * extension advertisements.
452          */
453         cprintf(" METADATA");
454         /* cprintf(" LIST-EXTENDED"); */
455 }
456
457 /*
458  * implements the CAPABILITY command
459  */
460 void imap_capability(int num_parms, char *parms[])
461 {
462         cprintf("* ");
463         imap_output_capability_string();
464         cprintf("\r\n");
465         cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
466 }
467
468
469
470 /*
471  * Implements the ID command (specified by RFC2971)
472  *
473  * We ignore the client-supplied information, and output a NIL response.
474  * Although this is technically a valid implementation of the extension, it
475  * is quite useless.  It exists only so that we may see which clients are
476  * making use of this extension.
477  * 
478  */
479 void imap_id(int num_parms, char *parms[])
480 {
481         cprintf("* ID NIL\r\n");
482         cprintf("%s OK ID completed\r\n", parms[0]);
483 }
484
485
486
487 /*
488  * Here's where our IMAP session begins its happy day.
489  */
490 void imap_greeting(void)
491 {
492
493         strcpy(CC->cs_clientname, "IMAP session");
494         CC->session_specific_data = malloc(sizeof(struct citimap));
495         memset(IMAP, 0, sizeof(struct citimap));
496         IMAP->authstate = imap_as_normal;
497         IMAP->cached_rfc822_data = NULL;
498         IMAP->cached_rfc822_msgnum = (-1);
499         IMAP->cached_rfc822_withbody = 0;
500
501         if (CC->nologin)
502         {
503                 cprintf("* BYE; Server busy, try later\r\n");
504                 CC->kill_me = 1;
505                 return;
506         }
507         cprintf("* OK [");
508         imap_output_capability_string();
509         cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
510 }
511
512 /*
513  * IMAPS is just like IMAP, except it goes crypto right away.
514  */
515 void imaps_greeting(void) {
516         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
517 #ifdef HAVE_OPENSSL
518         if (!CC->redirect_ssl) CC->kill_me = 1;         /* kill session if no crypto */
519 #endif
520         imap_greeting();
521 }
522
523
524 /*
525  * implements the LOGIN command (ordinary username/password login)
526  */
527 void imap_login(int num_parms, char *parms[])
528 {
529         if (num_parms != 4) {
530                 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
531                 return;
532         }
533
534         if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
535                 if (CtdlTryPassword(parms[3]) == pass_ok) {
536                         cprintf("%s OK [", parms[0]);
537                         imap_output_capability_string();
538                         cprintf("] Hello, %s\r\n", CC->user.fullname);
539                         return;
540                 }
541         }
542
543         cprintf("%s BAD Login incorrect\r\n", parms[0]);
544 }
545
546
547 /*
548  * Implements the AUTHENTICATE command
549  */
550 void imap_authenticate(int num_parms, char *parms[])
551 {
552         char buf[SIZ];
553
554         if (num_parms != 3) {
555                 cprintf("%s BAD incorrect number of parameters\r\n",
556                         parms[0]);
557                 return;
558         }
559
560         if (CC->logged_in) {
561                 cprintf("%s BAD Already logged in.\r\n", parms[0]);
562                 return;
563         }
564
565         if (!strcasecmp(parms[2], "LOGIN")) {
566                 CtdlEncodeBase64(buf, "Username:", 9, 0);
567                 cprintf("+ %s\r\n", buf);
568                 IMAP->authstate = imap_as_expecting_username;
569                 strcpy(IMAP->authseq, parms[0]);
570                 return;
571         }
572
573         if (!strcasecmp(parms[2], "PLAIN")) {
574                 // CtdlEncodeBase64(buf, "Username:", 9, 0);
575                 // cprintf("+ %s\r\n", buf);
576                 cprintf("+ \r\n");
577                 IMAP->authstate = imap_as_expecting_plainauth;
578                 strcpy(IMAP->authseq, parms[0]);
579                 return;
580         }
581
582         else {
583                 cprintf("%s NO AUTHENTICATE %s failed\r\n",
584                         parms[0], parms[1]);
585         }
586 }
587
588 void imap_auth_plain(char *cmd)
589 {
590         char decoded_authstring[1024];
591         char ident[256];
592         char user[256];
593         char pass[256];
594         int result;
595
596         CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
597         safestrncpy(ident, decoded_authstring, sizeof ident);
598         safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
599         safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
600
601         IMAP->authstate = imap_as_normal;
602
603         if (!IsEmptyStr(ident)) {
604                 result = CtdlLoginExistingUser(user, ident);
605         }
606         else {
607                 result = CtdlLoginExistingUser(NULL, user);
608         }
609
610         if (result == login_ok) {
611                 if (CtdlTryPassword(pass) == pass_ok) {
612                         cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
613                         return;
614                 }
615         }
616         cprintf("%s NO authentication failed\r\n", IMAP->authseq);
617 }
618
619 void imap_auth_login_user(char *cmd)
620 {
621         char buf[SIZ];
622
623         CtdlDecodeBase64(buf, cmd, SIZ);
624         CtdlLoginExistingUser(NULL, buf);
625         CtdlEncodeBase64(buf, "Password:", 9, 0);
626         cprintf("+ %s\r\n", buf);
627         IMAP->authstate = imap_as_expecting_password;
628         return;
629 }
630
631 void imap_auth_login_pass(char *cmd)
632 {
633         char buf[SIZ];
634
635         CtdlDecodeBase64(buf, cmd, SIZ);
636         if (CtdlTryPassword(buf) == pass_ok) {
637                 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
638         } else {
639                 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
640         }
641         IMAP->authstate = imap_as_normal;
642         return;
643 }
644
645
646 /*
647  * implements the STARTTLS command (Citadel API version)
648  */
649 void imap_starttls(int num_parms, char *parms[])
650 {
651         char ok_response[SIZ];
652         char nosup_response[SIZ];
653         char error_response[SIZ];
654
655         sprintf(ok_response,
656                 "%s OK begin TLS negotiation now\r\n",
657                 parms[0]);
658         sprintf(nosup_response,
659                 "%s NO TLS not supported here\r\n",
660                 parms[0]);
661         sprintf(error_response,
662                 "%s BAD Internal error\r\n",
663                 parms[0]);
664         CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
665 }
666
667
668 /*
669  * implements the SELECT command
670  */
671 void imap_select(int num_parms, char *parms[])
672 {
673         char towhere[SIZ];
674         char augmented_roomname[ROOMNAMELEN];
675         int c = 0;
676         int ok = 0;
677         int ra = 0;
678         struct ctdlroom QRscratch;
679         int msgs, new;
680         int floornum;
681         int roomflags;
682         int i;
683
684         /* Convert the supplied folder name to a roomname */
685         i = imap_roomname(towhere, sizeof towhere, parms[2]);
686         if (i < 0) {
687                 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
688                 IMAP->selected = 0;
689                 return;
690         }
691         floornum = (i & 0x00ff);
692         roomflags = (i & 0xff00);
693
694         /* First try a regular match */
695         c = getroom(&QRscratch, towhere);
696
697         /* Then try a mailbox name match */
698         if (c != 0) {
699                 MailboxName(augmented_roomname, sizeof augmented_roomname,
700                             &CC->user, towhere);
701                 c = getroom(&QRscratch, augmented_roomname);
702                 if (c == 0)
703                         strcpy(towhere, augmented_roomname);
704         }
705
706         /* If the room exists, check security/access */
707         if (c == 0) {
708                 /* See if there is an existing user/room relationship */
709                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
710
711                 /* normal clients have to pass through security */
712                 if (ra & UA_KNOWN) {
713                         ok = 1;
714                 }
715         }
716
717         /* Fail here if no such room */
718         if (!ok) {
719                 cprintf("%s NO ... no such room, or access denied\r\n",
720                         parms[0]);
721                 return;
722         }
723
724         /* If we already had some other folder selected, auto-expunge it */
725         imap_do_expunge();
726
727         /*
728          * usergoto() formally takes us to the desired room, happily returning
729          * the number of messages and number of new messages.
730          */
731         memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
732         usergoto(NULL, 0, 0, &msgs, &new);
733         IMAP->selected = 1;
734
735         if (!strcasecmp(parms[1], "EXAMINE")) {
736                 IMAP->readonly = 1;
737         } else {
738                 IMAP->readonly = 0;
739         }
740
741         imap_load_msgids();
742         IMAP->last_mtime = CC->room.QRmtime;
743
744         cprintf("* %d EXISTS\r\n", msgs);
745         cprintf("* %d RECENT\r\n", new);
746
747         cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
748         cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
749
750         /* Technically, \Deleted is a valid flag, but not a permanent flag,
751          * because we don't maintain its state across sessions.  Citadel
752          * automatically expunges mailboxes when they are de-selected.
753          * 
754          * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
755          * some clients (particularly Thunderbird) to misbehave -- they simply
756          * electing not to transmit the flag at all.  So we have to advertise
757          * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
758          */
759         cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
760         cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
761
762         cprintf("%s OK [%s] %s completed\r\n",
763                 parms[0],
764                 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
765 }
766
767
768
769 /*
770  * Does the real work for expunge.
771  */
772 int imap_do_expunge(void)
773 {
774         int i;
775         int num_expunged = 0;
776         long *delmsgs = NULL;
777         int num_delmsgs = 0;
778
779         CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
780         if (IMAP->selected == 0) {
781                 return (0);
782         }
783
784         if (IMAP->num_msgs > 0) {
785                 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
786                 for (i = 0; i < IMAP->num_msgs; ++i) {
787                         if (IMAP->flags[i] & IMAP_DELETED) {
788                                 delmsgs[num_delmsgs++] = IMAP->msgids[i];
789                         }
790                 }
791                 if (num_delmsgs > 0) {
792                         CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
793                 }
794                 num_expunged += num_delmsgs;
795                 free(delmsgs);
796         }
797
798         if (num_expunged > 0) {
799                 imap_rescan_msgids();
800         }
801
802         CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
803                 num_expunged, CC->room.QRname);
804         return (num_expunged);
805 }
806
807
808 /*
809  * implements the EXPUNGE command syntax
810  */
811 void imap_expunge(int num_parms, char *parms[])
812 {
813         int num_expunged = 0;
814
815         num_expunged = imap_do_expunge();
816         cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
817 }
818
819
820 /*
821  * implements the CLOSE command
822  */
823 void imap_close(int num_parms, char *parms[])
824 {
825
826         /* Yes, we always expunge on close. */
827         if (IMAP->selected) {
828                 imap_do_expunge();
829         }
830
831         IMAP->selected = 0;
832         IMAP->readonly = 0;
833         imap_free_msgids();
834         cprintf("%s OK CLOSE completed\r\n", parms[0]);
835 }
836
837
838 /*
839  * Implements the NAMESPACE command.
840  */
841 void imap_namespace(int num_parms, char *parms[])
842 {
843         int i;
844         struct floor *fl;
845         int floors = 0;
846         char buf[SIZ];
847
848         cprintf("* NAMESPACE ");
849
850         /* All personal folders are subordinate to INBOX. */
851         cprintf("((\"INBOX/\" \"/\")) ");
852
853         /* Other users' folders ... coming soon! FIXME */
854         cprintf("NIL ");
855
856         /* Show all floors as shared namespaces.  Neato! */
857         cprintf("(");
858         for (i = 0; i < MAXFLOORS; ++i) {
859                 fl = cgetfloor(i);
860                 if (fl->f_flags & F_INUSE) {
861                         if (floors > 0) cprintf(" ");
862                         cprintf("(");
863                         sprintf(buf, "%s/", fl->f_name);
864                         imap_strout(buf);
865                         cprintf(" \"/\")");
866                         ++floors;
867                 }
868         }
869         cprintf(")");
870
871         /* Wind it up with a newline and a completion message. */
872         cprintf("\r\n");
873         cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
874 }
875
876
877
878 /*
879  * Implements the CREATE command
880  *
881  */
882 void imap_create(int num_parms, char *parms[])
883 {
884         int ret;
885         char roomname[ROOMNAMELEN];
886         int floornum;
887         int flags;
888         int newroomtype = 0;
889         int newroomview = 0;
890         char *notification_message = NULL;
891
892         if (strchr(parms[2], '\\') != NULL) {
893                 cprintf("%s NO Invalid character in folder name\r\n",
894                         parms[0]);
895                 CtdlLogPrintf(CTDL_DEBUG, "invalid character in folder name\n");
896                 return;
897         }
898
899         ret = imap_roomname(roomname, sizeof roomname, parms[2]);
900         if (ret < 0) {
901                 cprintf("%s NO Invalid mailbox name or location\r\n",
902                         parms[0]);
903                 CtdlLogPrintf(CTDL_DEBUG, "invalid mailbox name or location\n");
904                 return;
905         }
906         floornum = (ret & 0x00ff);      /* lower 8 bits = floor number */
907         flags = (ret & 0xff00); /* upper 8 bits = flags        */
908
909         if (flags & IR_MAILBOX) {
910                 if (strncasecmp(parms[2], "INBOX/", 6)) {
911                         cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
912                         CtdlLogPrintf(CTDL_DEBUG, "not subordinate to inbox\n");
913                         return;
914                 }
915         }
916
917         if (flags & IR_MAILBOX) {
918                 newroomtype = 4;                /* private mailbox */
919                 newroomview = VIEW_MAILBOX;
920         } else {
921                 newroomtype = 0;                /* public folder */
922                 newroomview = VIEW_BBS;
923         }
924
925         CtdlLogPrintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
926                 roomname, floornum, newroomtype);
927
928         ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
929         if (ret == 0) {
930                 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY!  BYNARI CONNECTOR DEPENDS ON IT! ***/
931                 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
932         } else {
933                 cprintf("%s OK CREATE completed\r\n", parms[0]);
934                 /* post a message in Aide> describing the new room */
935                 notification_message = malloc(1024);
936                 snprintf(notification_message, 1024,
937                         "A new room called \"%s\" has been created by %s%s%s%s\n",
938                         roomname,
939                         CC->user.fullname,
940                         ((ret & QR_MAILBOX) ? " [personal]" : ""),
941                         ((ret & QR_PRIVATE) ? " [private]" : ""),
942                         ((ret & QR_GUESSNAME) ? " [hidden]" : "")
943                 );
944                 aide_message(notification_message, "Room Creation Message");
945                 free(notification_message);
946         }
947         CtdlLogPrintf(CTDL_DEBUG, "imap_create() completed\n");
948 }
949
950
951 /*
952  * Locate a room by its IMAP folder name, and check access to it.
953  * If zapped_ok is nonzero, we can also look for the room in the zapped list.
954  */
955 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
956 {
957         int ret;
958         char augmented_roomname[ROOMNAMELEN];
959         char roomname[ROOMNAMELEN];
960         int c;
961         struct ctdlroom QRscratch;
962         int ra;
963         int ok = 0;
964
965         ret = imap_roomname(roomname, sizeof roomname, foldername);
966         if (ret < 0) {
967                 return (1);
968         }
969
970         /* First try a regular match */
971         c = getroom(&QRscratch, roomname);
972
973         /* Then try a mailbox name match */
974         if (c != 0) {
975                 MailboxName(augmented_roomname, sizeof augmented_roomname,
976                             &CC->user, roomname);
977                 c = getroom(&QRscratch, augmented_roomname);
978                 if (c == 0)
979                         strcpy(roomname, augmented_roomname);
980         }
981
982         /* If the room exists, check security/access */
983         if (c == 0) {
984                 /* See if there is an existing user/room relationship */
985                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
986
987                 /* normal clients have to pass through security */
988                 if (ra & UA_KNOWN) {
989                         ok = 1;
990                 }
991                 if ((zapped_ok) && (ra & UA_ZAPPED)) {
992                         ok = 1;
993                 }
994         }
995
996         /* Fail here if no such room */
997         if (!ok) {
998                 strcpy(returned_roomname, "");
999                 return (2);
1000         } else {
1001                 strcpy(returned_roomname, QRscratch.QRname);
1002                 return (0);
1003         }
1004 }
1005
1006
1007 /*
1008  * Implements the STATUS command (sort of)
1009  *
1010  */
1011 void imap_status(int num_parms, char *parms[])
1012 {
1013         int ret;
1014         char roomname[ROOMNAMELEN];
1015         char buf[SIZ];
1016         char savedroom[ROOMNAMELEN];
1017         int msgs, new;
1018
1019         ret = imap_grabroom(roomname, parms[2], 0);
1020         if (ret != 0) {
1021                 cprintf
1022                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
1023                      parms[0]);
1024                 return;
1025         }
1026
1027         /*
1028          * usergoto() formally takes us to the desired room, happily returning
1029          * the number of messages and number of new messages.  (If another
1030          * folder is selected, save its name so we can return there!!!!!)
1031          */
1032         if (IMAP->selected) {
1033                 strcpy(savedroom, CC->room.QRname);
1034         }
1035         usergoto(roomname, 0, 0, &msgs, &new);
1036
1037         /*
1038          * Tell the client what it wants to know.  In fact, tell it *more* than
1039          * it wants to know.  We happily IGnore the supplied status data item
1040          * names and simply spew all possible data items.  It's far easier to
1041          * code and probably saves us some processing time too.
1042          */
1043         imap_mailboxname(buf, sizeof buf, &CC->room);
1044         cprintf("* STATUS ");
1045         imap_strout(buf);
1046         cprintf(" (MESSAGES %d ", msgs);
1047         cprintf("RECENT %d ", new);     /* Initially, new==recent */
1048         cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1049         cprintf("UNSEEN %d)\r\n", new);
1050
1051         /*
1052          * If another folder is selected, go back to that room so we can resume
1053          * our happy day without violent explosions.
1054          */
1055         if (IMAP->selected) {
1056                 usergoto(savedroom, 0, 0, &msgs, &new);
1057         }
1058
1059         /*
1060          * Oooh, look, we're done!
1061          */
1062         cprintf("%s OK STATUS completed\r\n", parms[0]);
1063 }
1064
1065
1066
1067 /*
1068  * Implements the SUBSCRIBE command
1069  *
1070  */
1071 void imap_subscribe(int num_parms, char *parms[])
1072 {
1073         int ret;
1074         char roomname[ROOMNAMELEN];
1075         char savedroom[ROOMNAMELEN];
1076         int msgs, new;
1077
1078         ret = imap_grabroom(roomname, parms[2], 1);
1079         if (ret != 0) {
1080                 cprintf(
1081                         "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1082                         parms[0],
1083                         ret
1084                 );
1085                 return;
1086         }
1087
1088         /*
1089          * usergoto() formally takes us to the desired room, which has the side
1090          * effect of marking the room as not-zapped ... exactly the effect
1091          * we're looking for.
1092          */
1093         if (IMAP->selected) {
1094                 strcpy(savedroom, CC->room.QRname);
1095         }
1096         usergoto(roomname, 0, 0, &msgs, &new);
1097
1098         /*
1099          * If another folder is selected, go back to that room so we can resume
1100          * our happy day without violent explosions.
1101          */
1102         if (IMAP->selected) {
1103                 usergoto(savedroom, 0, 0, &msgs, &new);
1104         }
1105
1106         cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1107 }
1108
1109
1110 /*
1111  * Implements the UNSUBSCRIBE command
1112  *
1113  */
1114 void imap_unsubscribe(int num_parms, char *parms[])
1115 {
1116         int ret;
1117         char roomname[ROOMNAMELEN];
1118         char savedroom[ROOMNAMELEN];
1119         int msgs, new;
1120
1121         ret = imap_grabroom(roomname, parms[2], 0);
1122         if (ret != 0) {
1123                 cprintf
1124                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
1125                      parms[0]);
1126                 return;
1127         }
1128
1129         /*
1130          * usergoto() formally takes us to the desired room.
1131          */
1132         if (IMAP->selected) {
1133                 strcpy(savedroom, CC->room.QRname);
1134         }
1135         usergoto(roomname, 0, 0, &msgs, &new);
1136
1137         /* 
1138          * Now make the API call to zap the room
1139          */
1140         if (CtdlForgetThisRoom() == 0) {
1141                 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1142         } else {
1143                 cprintf
1144                     ("%s NO You may not unsubscribe from this folder.\r\n",
1145                      parms[0]);
1146         }
1147
1148         /*
1149          * If another folder is selected, go back to that room so we can resume
1150          * our happy day without violent explosions.
1151          */
1152         if (IMAP->selected) {
1153                 usergoto(savedroom, 0, 0, &msgs, &new);
1154         }
1155 }
1156
1157
1158
1159 /*
1160  * Implements the DELETE command
1161  *
1162  */
1163 void imap_delete(int num_parms, char *parms[])
1164 {
1165         int ret;
1166         char roomname[ROOMNAMELEN];
1167         char savedroom[ROOMNAMELEN];
1168         int msgs, new;
1169
1170         ret = imap_grabroom(roomname, parms[2], 1);
1171         if (ret != 0) {
1172                 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1173                         parms[0]);
1174                 return;
1175         }
1176
1177         /*
1178          * usergoto() formally takes us to the desired room, happily returning
1179          * the number of messages and number of new messages.  (If another
1180          * folder is selected, save its name so we can return there!!!!!)
1181          */
1182         if (IMAP->selected) {
1183                 strcpy(savedroom, CC->room.QRname);
1184         }
1185         usergoto(roomname, 0, 0, &msgs, &new);
1186
1187         /*
1188          * Now delete the room.
1189          */
1190         if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1191                 schedule_room_for_deletion(&CC->room);
1192                 cprintf("%s OK DELETE completed\r\n", parms[0]);
1193         } else {
1194                 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1195         }
1196
1197         /*
1198          * If another folder is selected, go back to that room so we can resume
1199          * our happy day without violent explosions.
1200          */
1201         if (IMAP->selected) {
1202                 usergoto(savedroom, 0, 0, &msgs, &new);
1203         }
1204 }
1205
1206
1207 /*
1208  * Back end function for imap_rename()
1209  */
1210 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1211 {
1212         char foldername[SIZ];
1213         char newfoldername[SIZ];
1214         char newroomname[ROOMNAMELEN];
1215         int newfloor = 0;
1216         struct irl *irlp = NULL;        /* scratch pointer */
1217         struct irlparms *irlparms;
1218
1219         irlparms = (struct irlparms *) data;
1220         imap_mailboxname(foldername, sizeof foldername, qrbuf);
1221
1222         /* Rename subfolders */
1223         if ((!strncasecmp(foldername, irlparms->oldname,
1224                           strlen(irlparms->oldname))
1225              && (foldername[strlen(irlparms->oldname)] == '/'))) {
1226
1227                 sprintf(newfoldername, "%s/%s",
1228                         irlparms->newname,
1229                         &foldername[strlen(irlparms->oldname) + 1]
1230                     );
1231
1232                 newfloor = imap_roomname(newroomname,
1233                                          sizeof newroomname,
1234                                          newfoldername) & 0xFF;
1235
1236                 irlp = (struct irl *) malloc(sizeof(struct irl));
1237                 strcpy(irlp->irl_newroom, newroomname);
1238                 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1239                 irlp->irl_newfloor = newfloor;
1240                 irlp->next = *(irlparms->irl);
1241                 *(irlparms->irl) = irlp;
1242         }
1243 }
1244
1245
1246 /*
1247  * Implements the RENAME command
1248  *
1249  */
1250 void imap_rename(int num_parms, char *parms[])
1251 {
1252         char old_room[ROOMNAMELEN];
1253         char new_room[ROOMNAMELEN];
1254         int oldr, newr;
1255         int new_floor;
1256         int r;
1257         struct irl *irl = NULL; /* the list */
1258         struct irl *irlp = NULL;        /* scratch pointer */
1259         struct irlparms irlparms;
1260         char buf[1024];
1261
1262         if (strchr(parms[3], '\\') != NULL) {
1263                 cprintf("%s NO Invalid character in folder name\r\n",
1264                         parms[0]);
1265                 return;
1266         }
1267
1268         oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1269         newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1270         new_floor = (newr & 0xFF);
1271
1272         r = CtdlRenameRoom(old_room, new_room, new_floor);
1273
1274         if (r == crr_room_not_found) {
1275                 cprintf("%s NO Could not locate this folder\r\n",
1276                         parms[0]);
1277                 return;
1278         }
1279         if (r == crr_already_exists) {
1280                 cprintf("%s NO '%s' already exists.\r\n", parms[0], parms[2]);
1281                 return;
1282         }
1283         if (r == crr_noneditable) {
1284                 cprintf("%s NO This folder is not editable.\r\n", parms[0]);
1285                 return;
1286         }
1287         if (r == crr_invalid_floor) {
1288                 cprintf("%s NO Folder root does not exist.\r\n", parms[0]);
1289                 return;
1290         }
1291         if (r == crr_access_denied) {
1292                 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1293                         parms[0]);
1294                 return;
1295         }
1296         if (r != crr_ok) {
1297                 cprintf("%s NO Rename failed - undefined error %d\r\n",
1298                         parms[0], r);
1299                 return;
1300         }
1301
1302         /* If this is the INBOX, then RFC2060 says we have to just move the
1303          * contents.  In a Citadel environment it's easier to rename the room
1304          * (already did that) and create a new inbox.
1305          */
1306         if (!strcasecmp(parms[2], "INBOX")) {
1307                 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1308         }
1309
1310         /* Otherwise, do the subfolders.  Build a list of rooms to rename... */
1311         else {
1312                 irlparms.oldname = parms[2];
1313                 irlparms.newname = parms[3];
1314                 irlparms.irl = &irl;
1315                 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1316
1317                 /* ... and now rename them. */
1318                 while (irl != NULL) {
1319                         r = CtdlRenameRoom(irl->irl_oldroom,
1320                                            irl->irl_newroom,
1321                                            irl->irl_newfloor);
1322                         if (r != crr_ok) {
1323                                 /* FIXME handle error returns better */
1324                                 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1325                         }
1326                         irlp = irl;
1327                         irl = irl->next;
1328                         free(irlp);
1329                 }
1330         }
1331
1332         snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1333                 parms[2],
1334                 parms[3],
1335                 CC->curr_user
1336         );
1337         aide_message(buf, "IMAP folder rename");
1338
1339         cprintf("%s OK RENAME completed\r\n", parms[0]);
1340 }
1341
1342
1343
1344
1345 /* 
1346  * Main command loop for IMAP sessions.
1347  */
1348 void imap_command_loop(void)
1349 {
1350         char cmdbuf[SIZ];
1351         char *parms[SIZ];
1352         int num_parms;
1353         struct timeval tv1, tv2;
1354         suseconds_t total_time = 0;
1355         int untagged_ok = 1;
1356
1357         gettimeofday(&tv1, NULL);
1358         CC->lastcmd = time(NULL);
1359         memset(cmdbuf, 0, sizeof cmdbuf);       /* Clear it, just in case */
1360         flush_output();
1361         if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1362                 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1363                 CC->kill_me = 1;
1364                 return;
1365         }
1366
1367         if (IMAP->authstate == imap_as_expecting_password) {
1368                 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1369         }
1370         else if (IMAP->authstate == imap_as_expecting_plainauth) {
1371                 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1372         }
1373         else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1374                 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1375         }
1376         else {
1377                 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1378         }
1379
1380         while (strlen(cmdbuf) < 5)
1381                 strcat(cmdbuf, " ");
1382
1383         /* strip off l/t whitespace and CRLF */
1384         if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1385                 cmdbuf[strlen(cmdbuf) - 1] = 0;
1386         if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1387                 cmdbuf[strlen(cmdbuf) - 1] = 0;
1388         striplt(cmdbuf);
1389
1390         /* If we're in the middle of a multi-line command, handle that */
1391         if (IMAP->authstate == imap_as_expecting_username) {
1392                 imap_auth_login_user(cmdbuf);
1393                 return;
1394         }
1395         if (IMAP->authstate == imap_as_expecting_plainauth) {
1396                 imap_auth_plain(cmdbuf);
1397                 return;
1398         }
1399         if (IMAP->authstate == imap_as_expecting_password) {
1400                 imap_auth_login_pass(cmdbuf);
1401                 return;
1402         }
1403
1404
1405         /* Ok, at this point we're in normal command mode.
1406          * If the command just submitted does not contain a literal, we
1407          * might think about delivering some untagged stuff...
1408          */
1409         if (cmdbuf[strlen(cmdbuf)-1] == '}') {
1410                 untagged_ok = 0;
1411         }
1412
1413         /* Grab the tag, command, and parameters. */
1414         num_parms = imap_parameterize(parms, cmdbuf);
1415
1416         /* RFC3501 says that we cannot output untagged data during these commands */
1417         if (num_parms >= 2) {
1418                 if (  (!strcasecmp(parms[1], "FETCH"))
1419                    || (!strcasecmp(parms[1], "STORE"))
1420                    || (!strcasecmp(parms[1], "SEARCH"))
1421                 ) {
1422                         untagged_ok = 0;
1423                 }
1424         }
1425         
1426         if (untagged_ok) {
1427
1428                 /* we can put any additional untagged stuff right here in the future */
1429
1430                 /*
1431                  * Before processing the command that was just entered... if we happen
1432                  * to have a folder selected, we'd like to rescan that folder for new
1433                  * messages, and for deletions/changes of existing messages.  This
1434                  * could probably be optimized better with some deep thought...
1435                  */
1436                 if (IMAP->selected) {
1437                         imap_rescan_msgids();
1438                 }
1439         }
1440
1441         /* Now for the command set. */
1442
1443         if (num_parms < 2) {
1444                 cprintf("BAD syntax error\r\n");
1445         }
1446
1447         /* The commands below may be executed in any state */
1448
1449         else if ((!strcasecmp(parms[1], "NOOP"))
1450                  || (!strcasecmp(parms[1], "CHECK"))) {
1451                 cprintf("%s OK No operation\r\n",
1452                         parms[0]);
1453         }
1454
1455         else if (!strcasecmp(parms[1], "ID")) {
1456                 imap_id(num_parms, parms);
1457         }
1458
1459
1460         else if (!strcasecmp(parms[1], "LOGOUT")) {
1461                 if (IMAP->selected) {
1462                         imap_do_expunge();      /* yes, we auto-expunge at logout */
1463                 }
1464                 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1465                 cprintf("%s OK Citadel IMAP session ended.\r\n",
1466                         parms[0]);
1467                 CC->kill_me = 1;
1468                 return;
1469         }
1470
1471         else if (!strcasecmp(parms[1], "LOGIN")) {
1472                 imap_login(num_parms, parms);
1473         }
1474
1475         else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1476                 imap_authenticate(num_parms, parms);
1477         }
1478
1479         else if (!strcasecmp(parms[1], "CAPABILITY")) {
1480                 imap_capability(num_parms, parms);
1481         }
1482 #ifdef HAVE_OPENSSL
1483         else if (!strcasecmp(parms[1], "STARTTLS")) {
1484                 imap_starttls(num_parms, parms);
1485         }
1486 #endif
1487         else if (!CC->logged_in) {
1488                 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1489         }
1490
1491         /* The commans below require a logged-in state */
1492
1493         else if (!strcasecmp(parms[1], "SELECT")) {
1494                 imap_select(num_parms, parms);
1495         }
1496
1497         else if (!strcasecmp(parms[1], "EXAMINE")) {
1498                 imap_select(num_parms, parms);
1499         }
1500
1501         else if (!strcasecmp(parms[1], "LSUB")) {
1502                 imap_list(num_parms, parms);
1503         }
1504
1505         else if (!strcasecmp(parms[1], "LIST")) {
1506                 imap_list(num_parms, parms);
1507         }
1508
1509         else if (!strcasecmp(parms[1], "CREATE")) {
1510                 imap_create(num_parms, parms);
1511         }
1512
1513         else if (!strcasecmp(parms[1], "DELETE")) {
1514                 imap_delete(num_parms, parms);
1515         }
1516
1517         else if (!strcasecmp(parms[1], "RENAME")) {
1518                 imap_rename(num_parms, parms);
1519         }
1520
1521         else if (!strcasecmp(parms[1], "STATUS")) {
1522                 imap_status(num_parms, parms);
1523         }
1524
1525         else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1526                 imap_subscribe(num_parms, parms);
1527         }
1528
1529         else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1530                 imap_unsubscribe(num_parms, parms);
1531         }
1532
1533         else if (!strcasecmp(parms[1], "APPEND")) {
1534                 imap_append(num_parms, parms);
1535         }
1536
1537         else if (!strcasecmp(parms[1], "NAMESPACE")) {
1538                 imap_namespace(num_parms, parms);
1539         }
1540
1541         else if (!strcasecmp(parms[1], "SETACL")) {
1542                 imap_setacl(num_parms, parms);
1543         }
1544
1545         else if (!strcasecmp(parms[1], "DELETEACL")) {
1546                 imap_deleteacl(num_parms, parms);
1547         }
1548
1549         else if (!strcasecmp(parms[1], "GETACL")) {
1550                 imap_getacl(num_parms, parms);
1551         }
1552
1553         else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1554                 imap_listrights(num_parms, parms);
1555         }
1556
1557         else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1558                 imap_myrights(num_parms, parms);
1559         }
1560
1561         else if (!strcasecmp(parms[1], "GETMETADATA")) {
1562                 imap_getmetadata(num_parms, parms);
1563         }
1564
1565         else if (!strcasecmp(parms[1], "SETMETADATA")) {
1566                 imap_setmetadata(num_parms, parms);
1567         }
1568
1569         else if (IMAP->selected == 0) {
1570                 cprintf("%s BAD no folder selected\r\n", parms[0]);
1571         }
1572
1573         /* The commands below require the SELECT state on a mailbox */
1574
1575         else if (!strcasecmp(parms[1], "FETCH")) {
1576                 imap_fetch(num_parms, parms);
1577         }
1578
1579         else if ((!strcasecmp(parms[1], "UID"))
1580                  && (!strcasecmp(parms[2], "FETCH"))) {
1581                 imap_uidfetch(num_parms, parms);
1582         }
1583
1584         else if (!strcasecmp(parms[1], "SEARCH")) {
1585                 imap_search(num_parms, parms);
1586         }
1587
1588         else if ((!strcasecmp(parms[1], "UID"))
1589                  && (!strcasecmp(parms[2], "SEARCH"))) {
1590                 imap_uidsearch(num_parms, parms);
1591         }
1592
1593         else if (!strcasecmp(parms[1], "STORE")) {
1594                 imap_store(num_parms, parms);
1595         }
1596
1597         else if ((!strcasecmp(parms[1], "UID"))
1598                  && (!strcasecmp(parms[2], "STORE"))) {
1599                 imap_uidstore(num_parms, parms);
1600         }
1601
1602         else if (!strcasecmp(parms[1], "COPY")) {
1603                 imap_copy(num_parms, parms);
1604         }
1605
1606         else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "COPY"))) {
1607                 imap_uidcopy(num_parms, parms);
1608         }
1609
1610         else if (!strcasecmp(parms[1], "EXPUNGE")) {
1611                 imap_expunge(num_parms, parms);
1612         }
1613
1614         else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "EXPUNGE"))) {
1615                 imap_expunge(num_parms, parms);
1616         }
1617
1618         else if (!strcasecmp(parms[1], "CLOSE")) {
1619                 imap_close(num_parms, parms);
1620         }
1621
1622         /* End of commands.  If we get here, the command is either invalid
1623          * or unimplemented.
1624          */
1625
1626         else {
1627                 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1628         }
1629
1630         /* If the client transmitted a message we can free it now */
1631         imap_free_transmitted_message();
1632
1633         gettimeofday(&tv2, NULL);
1634         total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1635         CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1636                 (total_time / 1000000),
1637                 (total_time % 1000000)
1638         );
1639 }
1640
1641
1642 const char *CitadelServiceIMAP="IMAP";
1643 const char *CitadelServiceIMAPS="IMAPS";
1644
1645 /*
1646  * This function is called to register the IMAP extension with Citadel.
1647  */
1648 CTDL_MODULE_INIT(imap)
1649 {
1650         if (!threading)
1651         {
1652                 CtdlRegisterServiceHook(config.c_imap_port,
1653                                         NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1654 #ifdef HAVE_OPENSSL
1655                 CtdlRegisterServiceHook(config.c_imaps_port,
1656                                         NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1657 #endif
1658                 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1659         }
1660         
1661         /* return our Subversion id for the Log */
1662         return "$Id$";
1663 }