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.
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.
21 #include <sys/types.h>
23 #if TIME_WITH_SYS_TIME
24 # include <sys/time.h>
28 # include <sys/time.h>
38 #include <libcitadel.h>
41 #include "citserver.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"
57 #include "imap_metadata.h"
58 #include "imap_misc.h"
61 #include "ctdl_module.h"
64 /* imap_rename() uses this struct containing list of rooms to rename */
67 char irl_oldroom[ROOMNAMELEN];
68 char irl_newroom[ROOMNAMELEN];
72 /* Data which is passed between imap_rename() and imap_rename_backend() */
81 * If there is a message ID map in memory, free it
83 void imap_free_msgids(void)
85 if (IMAP->msgids != NULL) {
91 if (IMAP->flags != NULL) {
95 IMAP->last_mtime = (-1);
100 * If there is a transmitted message in memory, free it
102 void imap_free_transmitted_message(void)
104 if (IMAP->transmitted_message != NULL) {
105 free(IMAP->transmitted_message);
106 IMAP->transmitted_message = NULL;
107 IMAP->transmitted_length = 0;
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.
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
122 void imap_set_seen_flags(int first_msg)
128 char setstr[64], lostr[64], histr[64];
131 if (IMAP->num_msgs < 1) return;
132 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
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;
141 * Do the "\Seen" flag.
142 * (Any message not "\Seen" is considered "\Recent".)
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);
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);
156 strcpy(histr, lostr);
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;
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);
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);
182 strcpy(histr, lostr);
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;
199 * Back end for imap_load_msgids()
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.
205 void imap_add_single_msgid(long msgnum, void *userdata)
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)) );
216 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
217 IMAP->flags[IMAP->num_msgs - 1] = 0;
223 * Set up a message ID map for the current room (folder)
225 void imap_load_msgids(void)
227 struct cdbdata *cdbfr;
229 if (IMAP->selected == 0) {
230 CtdlLogPrintf(CTDL_ERR,
231 "imap_load_msgids() can't run; no room selected\n");
235 imap_free_msgids(); /* If there was already a map, free it */
237 /* Load the message list */
238 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
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);
247 if (IMAP->num_msgs) {
248 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
249 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
252 imap_set_seen_flags(0);
257 * Re-scan the selected room (folder) and see if it's been changed at all
259 void imap_rescan_msgids(void)
262 int original_num_msgs = 0;
263 long original_highest = 0L;
265 int message_still_exists;
266 struct cdbdata *cdbfr;
267 long *msglist = NULL;
271 if (IMAP->selected == 0) {
272 CtdlLogPrintf(CTDL_ERR,
273 "imap_load_msgids() can't run; no room selected\n");
278 * Check to see if the room's contents have changed.
279 * If not, we can avoid this rescan.
281 getroom(&CC->room, CC->room.QRname);
282 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
286 /* Load the *current* message list from disk, so we can compare it
287 * to what we have in memory.
289 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
291 msglist = malloc(cdbfr->len);
292 if (msglist == NULL) {
293 CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
296 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
297 num_msgs = cdbfr->len / sizeof(long);
304 * Check to see if any of the messages we know about have been expunged
306 if (IMAP->num_msgs > 0) {
308 for (i = 0; i < IMAP->num_msgs; ++i) {
310 message_still_exists = 0;
312 for (j = jstart; j < num_msgs; ++j) {
313 if (msglist[j] == IMAP->msgids[i]) {
314 message_still_exists = 1;
321 if (message_still_exists == 0) {
322 cprintf("* %d EXPUNGE\r\n", i + 1);
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
330 memcpy(&IMAP->msgids[i],
331 &IMAP->msgids[i + 1],
333 (IMAP->num_msgs - i)));
334 memcpy(&IMAP->flags[i],
337 (IMAP->num_msgs - i)));
346 * Remember how many messages were here before we re-scanned.
348 original_num_msgs = IMAP->num_msgs;
349 if (IMAP->num_msgs > 0) {
350 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
352 original_highest = 0L;
356 * Now peruse the room for *new* messages only.
359 for (j = 0; j < num_msgs; ++j) {
360 if (msglist[j] > original_highest) {
361 imap_add_single_msgid(msglist[j], NULL);
365 imap_set_seen_flags(original_num_msgs);
368 * If new messages have arrived, tell the client about them.
370 if (IMAP->num_msgs > original_num_msgs) {
372 for (j = 0; j < num_msgs; ++j) {
373 if (IMAP->flags[j] & IMAP_RECENT) {
378 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
379 cprintf("* %d RECENT\r\n", num_recent);
385 IMAP->last_mtime = CC->room.QRmtime;
395 * This cleanup function blows away the temporary memory and files used by
398 void imap_cleanup_function(void)
401 /* Don't do this stuff if this is not a IMAP session! */
402 if (CC->h_command_function != imap_command_loop)
405 /* If there is a mailbox selected, auto-expunge it. */
406 if (IMAP->selected) {
410 CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
412 imap_free_transmitted_message();
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;
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);
429 CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
434 * Does the actual work of the CAPABILITY command (because we need to
435 * output this stuff in other places as well)
437 void imap_output_capability_string(void) {
438 cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
441 if (!CC->redirect_ssl) cprintf(" STARTTLS");
444 #ifndef DISABLE_IMAP_ACL
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.
453 cprintf(" METADATA");
454 /* cprintf(" LIST-EXTENDED"); */
458 * implements the CAPABILITY command
460 void imap_capability(int num_parms, char *parms[])
463 imap_output_capability_string();
465 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
471 * Implements the ID command (specified by RFC2971)
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.
479 void imap_id(int num_parms, char *parms[])
481 cprintf("* ID NIL\r\n");
482 cprintf("%s OK ID completed\r\n", parms[0]);
488 * Here's where our IMAP session begins its happy day.
490 void imap_greeting(void)
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;
502 imap_output_capability_string();
503 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
507 * IMAPS is just like IMAP, except it goes crypto right away.
509 void imaps_greeting(void) {
510 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
512 if (!CC->redirect_ssl) CC->kill_me = 1; /* kill session if no crypto */
519 * implements the LOGIN command (ordinary username/password login)
521 void imap_login(int num_parms, char *parms[])
523 if (num_parms != 4) {
524 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
528 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
529 if (CtdlTryPassword(parms[3]) == pass_ok) {
530 cprintf("%s OK [", parms[0]);
531 imap_output_capability_string();
532 cprintf("] Hello, %s\r\n", CC->user.fullname);
537 cprintf("%s BAD Login incorrect\r\n", parms[0]);
542 * Implements the AUTHENTICATE command
544 void imap_authenticate(int num_parms, char *parms[])
548 if (num_parms != 3) {
549 cprintf("%s BAD incorrect number of parameters\r\n",
555 cprintf("%s BAD Already logged in.\r\n", parms[0]);
559 if (!strcasecmp(parms[2], "LOGIN")) {
560 CtdlEncodeBase64(buf, "Username:", 9, 0);
561 cprintf("+ %s\r\n", buf);
562 IMAP->authstate = imap_as_expecting_username;
563 strcpy(IMAP->authseq, parms[0]);
567 if (!strcasecmp(parms[2], "PLAIN")) {
568 // CtdlEncodeBase64(buf, "Username:", 9, 0);
569 // cprintf("+ %s\r\n", buf);
571 IMAP->authstate = imap_as_expecting_plainauth;
572 strcpy(IMAP->authseq, parms[0]);
577 cprintf("%s NO AUTHENTICATE %s failed\r\n",
582 void imap_auth_plain(char *cmd)
584 char decoded_authstring[1024];
590 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
591 safestrncpy(ident, decoded_authstring, sizeof ident);
592 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
593 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
595 IMAP->authstate = imap_as_normal;
597 if (!IsEmptyStr(ident)) {
598 result = CtdlLoginExistingUser(user, ident);
601 result = CtdlLoginExistingUser(NULL, user);
604 if (result == login_ok) {
605 if (CtdlTryPassword(pass) == pass_ok) {
606 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
610 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
613 void imap_auth_login_user(char *cmd)
617 CtdlDecodeBase64(buf, cmd, SIZ);
618 CtdlLoginExistingUser(NULL, buf);
619 CtdlEncodeBase64(buf, "Password:", 9, 0);
620 cprintf("+ %s\r\n", buf);
621 IMAP->authstate = imap_as_expecting_password;
625 void imap_auth_login_pass(char *cmd)
629 CtdlDecodeBase64(buf, cmd, SIZ);
630 if (CtdlTryPassword(buf) == pass_ok) {
631 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
633 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
635 IMAP->authstate = imap_as_normal;
641 * implements the STARTTLS command (Citadel API version)
643 void imap_starttls(int num_parms, char *parms[])
645 char ok_response[SIZ];
646 char nosup_response[SIZ];
647 char error_response[SIZ];
650 "%s OK begin TLS negotiation now\r\n",
652 sprintf(nosup_response,
653 "%s NO TLS not supported here\r\n",
655 sprintf(error_response,
656 "%s BAD Internal error\r\n",
658 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
663 * implements the SELECT command
665 void imap_select(int num_parms, char *parms[])
668 char augmented_roomname[ROOMNAMELEN];
672 struct ctdlroom QRscratch;
678 /* Convert the supplied folder name to a roomname */
679 i = imap_roomname(towhere, sizeof towhere, parms[2]);
681 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
685 floornum = (i & 0x00ff);
686 roomflags = (i & 0xff00);
688 /* First try a regular match */
689 c = getroom(&QRscratch, towhere);
691 /* Then try a mailbox name match */
693 MailboxName(augmented_roomname, sizeof augmented_roomname,
695 c = getroom(&QRscratch, augmented_roomname);
697 strcpy(towhere, augmented_roomname);
700 /* If the room exists, check security/access */
702 /* See if there is an existing user/room relationship */
703 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
705 /* normal clients have to pass through security */
711 /* Fail here if no such room */
713 cprintf("%s NO ... no such room, or access denied\r\n",
718 /* If we already had some other folder selected, auto-expunge it */
722 * usergoto() formally takes us to the desired room, happily returning
723 * the number of messages and number of new messages.
725 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
726 usergoto(NULL, 0, 0, &msgs, &new);
729 if (!strcasecmp(parms[1], "EXAMINE")) {
736 IMAP->last_mtime = CC->room.QRmtime;
738 cprintf("* %d EXISTS\r\n", msgs);
739 cprintf("* %d RECENT\r\n", new);
741 cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
742 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
744 /* Technically, \Deleted is a valid flag, but not a permanent flag,
745 * because we don't maintain its state across sessions. Citadel
746 * automatically expunges mailboxes when they are de-selected.
748 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
749 * some clients (particularly Thunderbird) to misbehave -- they simply
750 * electing not to transmit the flag at all. So we have to advertise
751 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
753 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
754 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
756 cprintf("%s OK [%s] %s completed\r\n",
758 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
764 * Does the real work for expunge.
766 int imap_do_expunge(void)
769 int num_expunged = 0;
770 long *delmsgs = NULL;
773 CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
774 if (IMAP->selected == 0) {
778 if (IMAP->num_msgs > 0) {
779 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
780 for (i = 0; i < IMAP->num_msgs; ++i) {
781 if (IMAP->flags[i] & IMAP_DELETED) {
782 delmsgs[num_delmsgs++] = IMAP->msgids[i];
785 if (num_delmsgs > 0) {
786 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
788 num_expunged += num_delmsgs;
792 if (num_expunged > 0) {
793 imap_rescan_msgids();
796 CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
797 num_expunged, CC->room.QRname);
798 return (num_expunged);
803 * implements the EXPUNGE command syntax
805 void imap_expunge(int num_parms, char *parms[])
807 int num_expunged = 0;
809 num_expunged = imap_do_expunge();
810 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
815 * implements the CLOSE command
817 void imap_close(int num_parms, char *parms[])
820 /* Yes, we always expunge on close. */
821 if (IMAP->selected) {
828 cprintf("%s OK CLOSE completed\r\n", parms[0]);
833 * Implements the NAMESPACE command.
835 void imap_namespace(int num_parms, char *parms[])
842 cprintf("* NAMESPACE ");
844 /* All personal folders are subordinate to INBOX. */
845 cprintf("((\"INBOX/\" \"/\")) ");
847 /* Other users' folders ... coming soon! FIXME */
850 /* Show all floors as shared namespaces. Neato! */
852 for (i = 0; i < MAXFLOORS; ++i) {
854 if (fl->f_flags & F_INUSE) {
855 if (floors > 0) cprintf(" ");
857 sprintf(buf, "%s/", fl->f_name);
865 /* Wind it up with a newline and a completion message. */
867 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
873 * Implements the CREATE command
876 void imap_create(int num_parms, char *parms[])
879 char roomname[ROOMNAMELEN];
885 if (strchr(parms[2], '\\') != NULL) {
886 cprintf("%s NO Invalid character in folder name\r\n",
888 CtdlLogPrintf(CTDL_DEBUG, "invalid character in folder name\n");
892 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
894 cprintf("%s NO Invalid mailbox name or location\r\n",
896 CtdlLogPrintf(CTDL_DEBUG, "invalid mailbox name or location\n");
899 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
900 flags = (ret & 0xff00); /* upper 8 bits = flags */
902 if (flags & IR_MAILBOX) {
903 if (strncasecmp(parms[2], "INBOX/", 6)) {
904 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
905 CtdlLogPrintf(CTDL_DEBUG, "not subordinate to inbox\n");
910 if (flags & IR_MAILBOX) {
911 newroomtype = 4; /* private mailbox */
912 newroomview = VIEW_MAILBOX;
914 newroomtype = 0; /* public folder */
915 newroomview = VIEW_BBS;
918 CtdlLogPrintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
919 roomname, floornum, newroomtype);
921 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
923 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
924 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
926 cprintf("%s OK CREATE completed\r\n", parms[0]);
928 CtdlLogPrintf(CTDL_DEBUG, "imap_create() completed\n");
933 * Locate a room by its IMAP folder name, and check access to it.
934 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
936 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
939 char augmented_roomname[ROOMNAMELEN];
940 char roomname[ROOMNAMELEN];
942 struct ctdlroom QRscratch;
946 ret = imap_roomname(roomname, sizeof roomname, foldername);
951 /* First try a regular match */
952 c = getroom(&QRscratch, roomname);
954 /* Then try a mailbox name match */
956 MailboxName(augmented_roomname, sizeof augmented_roomname,
957 &CC->user, roomname);
958 c = getroom(&QRscratch, augmented_roomname);
960 strcpy(roomname, augmented_roomname);
963 /* If the room exists, check security/access */
965 /* See if there is an existing user/room relationship */
966 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
968 /* normal clients have to pass through security */
972 if ((zapped_ok) && (ra & UA_ZAPPED)) {
977 /* Fail here if no such room */
979 strcpy(returned_roomname, "");
982 strcpy(returned_roomname, QRscratch.QRname);
989 * Implements the STATUS command (sort of)
992 void imap_status(int num_parms, char *parms[])
995 char roomname[ROOMNAMELEN];
997 char savedroom[ROOMNAMELEN];
1000 ret = imap_grabroom(roomname, parms[2], 0);
1003 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1009 * usergoto() formally takes us to the desired room, happily returning
1010 * the number of messages and number of new messages. (If another
1011 * folder is selected, save its name so we can return there!!!!!)
1013 if (IMAP->selected) {
1014 strcpy(savedroom, CC->room.QRname);
1016 usergoto(roomname, 0, 0, &msgs, &new);
1019 * Tell the client what it wants to know. In fact, tell it *more* than
1020 * it wants to know. We happily IGnore the supplied status data item
1021 * names and simply spew all possible data items. It's far easier to
1022 * code and probably saves us some processing time too.
1024 imap_mailboxname(buf, sizeof buf, &CC->room);
1025 cprintf("* STATUS ");
1027 cprintf(" (MESSAGES %d ", msgs);
1028 cprintf("RECENT %d ", new); /* Initially, new==recent */
1029 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1030 cprintf("UNSEEN %d)\r\n", new);
1033 * If another folder is selected, go back to that room so we can resume
1034 * our happy day without violent explosions.
1036 if (IMAP->selected) {
1037 usergoto(savedroom, 0, 0, &msgs, &new);
1041 * Oooh, look, we're done!
1043 cprintf("%s OK STATUS completed\r\n", parms[0]);
1049 * Implements the SUBSCRIBE command
1052 void imap_subscribe(int num_parms, char *parms[])
1055 char roomname[ROOMNAMELEN];
1056 char savedroom[ROOMNAMELEN];
1059 ret = imap_grabroom(roomname, parms[2], 1);
1062 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1070 * usergoto() formally takes us to the desired room, which has the side
1071 * effect of marking the room as not-zapped ... exactly the effect
1072 * we're looking for.
1074 if (IMAP->selected) {
1075 strcpy(savedroom, CC->room.QRname);
1077 usergoto(roomname, 0, 0, &msgs, &new);
1080 * If another folder is selected, go back to that room so we can resume
1081 * our happy day without violent explosions.
1083 if (IMAP->selected) {
1084 usergoto(savedroom, 0, 0, &msgs, &new);
1087 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1092 * Implements the UNSUBSCRIBE command
1095 void imap_unsubscribe(int num_parms, char *parms[])
1098 char roomname[ROOMNAMELEN];
1099 char savedroom[ROOMNAMELEN];
1102 ret = imap_grabroom(roomname, parms[2], 0);
1105 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1111 * usergoto() formally takes us to the desired room.
1113 if (IMAP->selected) {
1114 strcpy(savedroom, CC->room.QRname);
1116 usergoto(roomname, 0, 0, &msgs, &new);
1119 * Now make the API call to zap the room
1121 if (CtdlForgetThisRoom() == 0) {
1122 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1125 ("%s NO You may not unsubscribe from this folder.\r\n",
1130 * If another folder is selected, go back to that room so we can resume
1131 * our happy day without violent explosions.
1133 if (IMAP->selected) {
1134 usergoto(savedroom, 0, 0, &msgs, &new);
1141 * Implements the DELETE command
1144 void imap_delete(int num_parms, char *parms[])
1147 char roomname[ROOMNAMELEN];
1148 char savedroom[ROOMNAMELEN];
1151 ret = imap_grabroom(roomname, parms[2], 1);
1153 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1159 * usergoto() formally takes us to the desired room, happily returning
1160 * the number of messages and number of new messages. (If another
1161 * folder is selected, save its name so we can return there!!!!!)
1163 if (IMAP->selected) {
1164 strcpy(savedroom, CC->room.QRname);
1166 usergoto(roomname, 0, 0, &msgs, &new);
1169 * Now delete the room.
1171 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1172 schedule_room_for_deletion(&CC->room);
1173 cprintf("%s OK DELETE completed\r\n", parms[0]);
1175 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1179 * If another folder is selected, go back to that room so we can resume
1180 * our happy day without violent explosions.
1182 if (IMAP->selected) {
1183 usergoto(savedroom, 0, 0, &msgs, &new);
1189 * Back end function for imap_rename()
1191 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1193 char foldername[SIZ];
1194 char newfoldername[SIZ];
1195 char newroomname[ROOMNAMELEN];
1197 struct irl *irlp = NULL; /* scratch pointer */
1198 struct irlparms *irlparms;
1200 irlparms = (struct irlparms *) data;
1201 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1203 /* Rename subfolders */
1204 if ((!strncasecmp(foldername, irlparms->oldname,
1205 strlen(irlparms->oldname))
1206 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1208 sprintf(newfoldername, "%s/%s",
1210 &foldername[strlen(irlparms->oldname) + 1]
1213 newfloor = imap_roomname(newroomname,
1215 newfoldername) & 0xFF;
1217 irlp = (struct irl *) malloc(sizeof(struct irl));
1218 strcpy(irlp->irl_newroom, newroomname);
1219 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1220 irlp->irl_newfloor = newfloor;
1221 irlp->next = *(irlparms->irl);
1222 *(irlparms->irl) = irlp;
1228 * Implements the RENAME command
1231 void imap_rename(int num_parms, char *parms[])
1233 char old_room[ROOMNAMELEN];
1234 char new_room[ROOMNAMELEN];
1238 struct irl *irl = NULL; /* the list */
1239 struct irl *irlp = NULL; /* scratch pointer */
1240 struct irlparms irlparms;
1243 if (strchr(parms[3], '\\') != NULL) {
1244 cprintf("%s NO Invalid character in folder name\r\n",
1249 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1250 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1251 new_floor = (newr & 0xFF);
1253 r = CtdlRenameRoom(old_room, new_room, new_floor);
1255 if (r == crr_room_not_found) {
1256 cprintf("%s NO Could not locate this folder\r\n",
1260 if (r == crr_already_exists) {
1261 cprintf("%s NO '%s' already exists.\r\n", parms[0], parms[2]);
1264 if (r == crr_noneditable) {
1265 cprintf("%s NO This folder is not editable.\r\n", parms[0]);
1268 if (r == crr_invalid_floor) {
1269 cprintf("%s NO Folder root does not exist.\r\n", parms[0]);
1272 if (r == crr_access_denied) {
1273 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1278 cprintf("%s NO Rename failed - undefined error %d\r\n",
1283 /* If this is the INBOX, then RFC2060 says we have to just move the
1284 * contents. In a Citadel environment it's easier to rename the room
1285 * (already did that) and create a new inbox.
1287 if (!strcasecmp(parms[2], "INBOX")) {
1288 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1291 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1293 irlparms.oldname = parms[2];
1294 irlparms.newname = parms[3];
1295 irlparms.irl = &irl;
1296 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1298 /* ... and now rename them. */
1299 while (irl != NULL) {
1300 r = CtdlRenameRoom(irl->irl_oldroom,
1304 /* FIXME handle error returns better */
1305 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1313 snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1318 aide_message(buf, "IMAP folder rename");
1320 cprintf("%s OK RENAME completed\r\n", parms[0]);
1327 * Main command loop for IMAP sessions.
1329 void imap_command_loop(void)
1334 struct timeval tv1, tv2;
1335 suseconds_t total_time = 0;
1336 int untagged_ok = 1;
1338 gettimeofday(&tv1, NULL);
1339 CC->lastcmd = time(NULL);
1340 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1342 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1343 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1348 if (IMAP->authstate == imap_as_expecting_password) {
1349 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1351 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1352 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1354 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1355 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1358 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1361 while (strlen(cmdbuf) < 5)
1362 strcat(cmdbuf, " ");
1364 /* strip off l/t whitespace and CRLF */
1365 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1366 cmdbuf[strlen(cmdbuf) - 1] = 0;
1367 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1368 cmdbuf[strlen(cmdbuf) - 1] = 0;
1371 /* If we're in the middle of a multi-line command, handle that */
1372 if (IMAP->authstate == imap_as_expecting_username) {
1373 imap_auth_login_user(cmdbuf);
1376 if (IMAP->authstate == imap_as_expecting_plainauth) {
1377 imap_auth_plain(cmdbuf);
1380 if (IMAP->authstate == imap_as_expecting_password) {
1381 imap_auth_login_pass(cmdbuf);
1386 /* Ok, at this point we're in normal command mode.
1387 * If the command just submitted does not contain a literal, we
1388 * might think about delivering some untagged stuff...
1390 if (cmdbuf[strlen(cmdbuf)-1] == '}') {
1394 /* Grab the tag, command, and parameters. */
1395 num_parms = imap_parameterize(parms, cmdbuf);
1397 /* RFC3501 says that we cannot output untagged data during these commands */
1398 if (num_parms >= 2) {
1399 if ( (!strcasecmp(parms[1], "FETCH"))
1400 || (!strcasecmp(parms[1], "STORE"))
1401 || (!strcasecmp(parms[1], "SEARCH"))
1408 imap_print_instant_messages();
1411 * Before processing the command that was just entered... if we happen
1412 * to have a folder selected, we'd like to rescan that folder for new
1413 * messages, and for deletions/changes of existing messages. This
1414 * could probably be optimized somehow, but IMAP sucks...
1416 if (IMAP->selected) {
1417 imap_rescan_msgids();
1421 /* Now for the command set. */
1423 if (num_parms < 2) {
1424 cprintf("BAD syntax error\r\n");
1427 /* The commands below may be executed in any state */
1429 else if ((!strcasecmp(parms[1], "NOOP"))
1430 || (!strcasecmp(parms[1], "CHECK"))) {
1431 cprintf("%s OK No operation\r\n",
1435 else if (!strcasecmp(parms[1], "ID")) {
1436 imap_id(num_parms, parms);
1440 else if (!strcasecmp(parms[1], "LOGOUT")) {
1441 if (IMAP->selected) {
1442 imap_do_expunge(); /* yes, we auto-expunge */
1444 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1445 cprintf("%s OK Citadel IMAP session ended.\r\n",
1451 else if (!strcasecmp(parms[1], "LOGIN")) {
1452 imap_login(num_parms, parms);
1455 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1456 imap_authenticate(num_parms, parms);
1459 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1460 imap_capability(num_parms, parms);
1463 else if (!strcasecmp(parms[1], "STARTTLS")) {
1464 imap_starttls(num_parms, parms);
1467 else if (!CC->logged_in) {
1468 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1471 /* The commans below require a logged-in state */
1473 else if (!strcasecmp(parms[1], "SELECT")) {
1474 imap_select(num_parms, parms);
1477 else if (!strcasecmp(parms[1], "EXAMINE")) {
1478 imap_select(num_parms, parms);
1481 else if (!strcasecmp(parms[1], "LSUB")) {
1482 imap_list(num_parms, parms);
1485 else if (!strcasecmp(parms[1], "LIST")) {
1486 imap_list(num_parms, parms);
1489 else if (!strcasecmp(parms[1], "CREATE")) {
1490 imap_create(num_parms, parms);
1493 else if (!strcasecmp(parms[1], "DELETE")) {
1494 imap_delete(num_parms, parms);
1497 else if (!strcasecmp(parms[1], "RENAME")) {
1498 imap_rename(num_parms, parms);
1501 else if (!strcasecmp(parms[1], "STATUS")) {
1502 imap_status(num_parms, parms);
1505 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1506 imap_subscribe(num_parms, parms);
1509 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1510 imap_unsubscribe(num_parms, parms);
1513 else if (!strcasecmp(parms[1], "APPEND")) {
1514 imap_append(num_parms, parms);
1517 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1518 imap_namespace(num_parms, parms);
1521 else if (!strcasecmp(parms[1], "SETACL")) {
1522 imap_setacl(num_parms, parms);
1525 else if (!strcasecmp(parms[1], "DELETEACL")) {
1526 imap_deleteacl(num_parms, parms);
1529 else if (!strcasecmp(parms[1], "GETACL")) {
1530 imap_getacl(num_parms, parms);
1533 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1534 imap_listrights(num_parms, parms);
1537 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1538 imap_myrights(num_parms, parms);
1541 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1542 imap_getmetadata(num_parms, parms);
1545 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1546 imap_setmetadata(num_parms, parms);
1549 else if (IMAP->selected == 0) {
1550 cprintf("%s BAD no folder selected\r\n", parms[0]);
1553 /* The commands below require the SELECT state on a mailbox */
1555 else if (!strcasecmp(parms[1], "FETCH")) {
1556 imap_fetch(num_parms, parms);
1559 else if ((!strcasecmp(parms[1], "UID"))
1560 && (!strcasecmp(parms[2], "FETCH"))) {
1561 imap_uidfetch(num_parms, parms);
1564 else if (!strcasecmp(parms[1], "SEARCH")) {
1565 imap_search(num_parms, parms);
1568 else if ((!strcasecmp(parms[1], "UID"))
1569 && (!strcasecmp(parms[2], "SEARCH"))) {
1570 imap_uidsearch(num_parms, parms);
1573 else if (!strcasecmp(parms[1], "STORE")) {
1574 imap_store(num_parms, parms);
1577 else if ((!strcasecmp(parms[1], "UID"))
1578 && (!strcasecmp(parms[2], "STORE"))) {
1579 imap_uidstore(num_parms, parms);
1582 else if (!strcasecmp(parms[1], "COPY")) {
1583 imap_copy(num_parms, parms);
1586 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "COPY"))) {
1587 imap_uidcopy(num_parms, parms);
1590 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1591 imap_expunge(num_parms, parms);
1594 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "EXPUNGE"))) {
1595 imap_expunge(num_parms, parms);
1598 else if (!strcasecmp(parms[1], "CLOSE")) {
1599 imap_close(num_parms, parms);
1602 /* End of commands. If we get here, the command is either invalid
1607 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1610 /* If the client transmitted a message we can free it now */
1611 imap_free_transmitted_message();
1613 gettimeofday(&tv2, NULL);
1614 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1615 CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1616 (total_time / 1000000),
1617 (total_time % 1000000)
1622 const char *CitadelServiceIMAP="IMAP";
1623 const char *CitadelServiceIMAPS="IMAPS";
1626 * This function is called to register the IMAP extension with Citadel.
1628 CTDL_MODULE_INIT(imap)
1632 CtdlRegisterServiceHook(config.c_imap_port,
1633 NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1635 CtdlRegisterServiceHook(config.c_imaps_port,
1636 NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1638 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1641 /* return our Subversion id for the Log */