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>
40 #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) {
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) {
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 lprintf(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 lprintf(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 lprintf(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 ACL AUTH=PLAIN AUTH=LOGIN");
441 if (!CC->redirect_ssl) cprintf(" STARTTLS");
444 /* We are building a partial implementation of METADATA for the sole purpose
445 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
446 * If you were expecting something else, comment out one or both of these
447 * extension advertisements.
449 cprintf(" METADATA");
450 /* cprintf(" LIST-EXTENDED"); */
454 * implements the CAPABILITY command
456 void imap_capability(int num_parms, char *parms[])
459 imap_output_capability_string();
461 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
467 * Implements the ID command (specified by RFC2971)
469 * We ignore the client-supplied information, and output a NIL response.
470 * Although this is technically a valid implementation of the extension, it
471 * is quite useless. It exists only so that we may see which clients are
472 * making use of this extension.
475 void imap_id(int num_parms, char *parms[])
477 cprintf("* ID NIL\r\n");
478 cprintf("%s OK ID completed\r\n", parms[0]);
484 * Here's where our IMAP session begins its happy day.
486 void imap_greeting(void)
489 strcpy(CC->cs_clientname, "IMAP session");
490 IMAP = malloc(sizeof (struct citimap));
491 memset(IMAP, 0, sizeof(struct citimap));
492 IMAP->authstate = imap_as_normal;
493 IMAP->cached_rfc822_data = NULL;
494 IMAP->cached_rfc822_msgnum = (-1);
495 IMAP->cached_rfc822_withbody = 0;
498 imap_output_capability_string();
499 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
503 * IMAPS is just like IMAP, except it goes crypto right away.
505 void imaps_greeting(void) {
506 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
512 * implements the LOGIN command (ordinary username/password login)
514 void imap_login(int num_parms, char *parms[])
516 if (num_parms != 4) {
517 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
521 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
522 if (CtdlTryPassword(parms[3]) == pass_ok) {
523 cprintf("%s OK [", parms[0]);
524 imap_output_capability_string();
525 cprintf("] Hello, %s\r\n", CC->user.fullname);
530 cprintf("%s BAD Login incorrect\r\n", parms[0]);
535 * Implements the AUTHENTICATE command
537 void imap_authenticate(int num_parms, char *parms[])
541 if (num_parms != 3) {
542 cprintf("%s BAD incorrect number of parameters\r\n",
548 cprintf("%s BAD Already logged in.\r\n", parms[0]);
552 if (!strcasecmp(parms[2], "LOGIN")) {
553 CtdlEncodeBase64(buf, "Username:", 9);
554 cprintf("+ %s\r\n", buf);
555 IMAP->authstate = imap_as_expecting_username;
556 strcpy(IMAP->authseq, parms[0]);
560 if (!strcasecmp(parms[2], "PLAIN")) {
561 // CtdlEncodeBase64(buf, "Username:", 9);
562 // cprintf("+ %s\r\n", buf);
564 IMAP->authstate = imap_as_expecting_plainauth;
565 strcpy(IMAP->authseq, parms[0]);
570 cprintf("%s NO AUTHENTICATE %s failed\r\n",
575 void imap_auth_plain(char *cmd)
577 char decoded_authstring[1024];
583 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
584 safestrncpy(ident, decoded_authstring, sizeof ident);
585 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
586 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
588 IMAP->authstate = imap_as_normal;
590 if (strlen(ident) > 0) {
591 result = CtdlLoginExistingUser(user, ident);
594 result = CtdlLoginExistingUser(NULL, user);
597 if (result == login_ok) {
598 if (CtdlTryPassword(pass) == pass_ok) {
599 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
603 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
606 void imap_auth_login_user(char *cmd)
610 CtdlDecodeBase64(buf, cmd, SIZ);
611 CtdlLoginExistingUser(NULL, buf);
612 CtdlEncodeBase64(buf, "Password:", 9);
613 cprintf("+ %s\r\n", buf);
614 IMAP->authstate = imap_as_expecting_password;
618 void imap_auth_login_pass(char *cmd)
622 CtdlDecodeBase64(buf, cmd, SIZ);
623 if (CtdlTryPassword(buf) == pass_ok) {
624 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
626 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
628 IMAP->authstate = imap_as_normal;
634 * implements the STARTTLS command (Citadel API version)
636 void imap_starttls(int num_parms, char *parms[])
638 char ok_response[SIZ];
639 char nosup_response[SIZ];
640 char error_response[SIZ];
643 "%s OK begin TLS negotiation now\r\n",
645 sprintf(nosup_response,
646 "%s NO TLS not supported here\r\n",
648 sprintf(error_response,
649 "%s BAD Internal error\r\n",
651 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
656 * implements the SELECT command
658 void imap_select(int num_parms, char *parms[])
661 char augmented_roomname[ROOMNAMELEN];
665 struct ctdlroom QRscratch;
671 /* Convert the supplied folder name to a roomname */
672 i = imap_roomname(towhere, sizeof towhere, parms[2]);
674 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
678 floornum = (i & 0x00ff);
679 roomflags = (i & 0xff00);
681 /* First try a regular match */
682 c = getroom(&QRscratch, towhere);
684 /* Then try a mailbox name match */
686 MailboxName(augmented_roomname, sizeof augmented_roomname,
688 c = getroom(&QRscratch, augmented_roomname);
690 strcpy(towhere, augmented_roomname);
693 /* If the room exists, check security/access */
695 /* See if there is an existing user/room relationship */
696 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
698 /* normal clients have to pass through security */
704 /* Fail here if no such room */
706 cprintf("%s NO ... no such room, or access denied\r\n",
711 /* If we already had some other folder selected, auto-expunge it */
715 * usergoto() formally takes us to the desired room, happily returning
716 * the number of messages and number of new messages.
718 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
719 usergoto(NULL, 0, 0, &msgs, &new);
722 if (!strcasecmp(parms[1], "EXAMINE")) {
729 IMAP->last_mtime = CC->room.QRmtime;
731 cprintf("* %d EXISTS\r\n", msgs);
732 cprintf("* %d RECENT\r\n", new);
734 cprintf("* OK [UIDVALIDITY 1] UID validity status\r\n");
735 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
737 /* Note that \Deleted is a valid flag, but not a permanent flag,
738 * because we don't maintain its state across sessions. Citadel
739 * automatically expunges mailboxes when they are de-selected.
741 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
742 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] "
743 "permanent flags\r\n");
745 cprintf("%s OK [%s] %s completed\r\n",
747 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
753 * Does the real work for expunge.
755 int imap_do_expunge(void)
758 int num_expunged = 0;
759 long *delmsgs = NULL;
762 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
763 if (IMAP->selected == 0) {
767 if (IMAP->num_msgs > 0) {
768 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
769 for (i = 0; i < IMAP->num_msgs; ++i) {
770 if (IMAP->flags[i] & IMAP_DELETED) {
771 delmsgs[num_delmsgs++] = IMAP->msgids[i];
774 if (num_delmsgs > 0) {
775 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
777 num_expunged += num_delmsgs;
781 if (num_expunged > 0) {
782 imap_rescan_msgids();
785 lprintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
786 num_expunged, CC->room.QRname);
787 return (num_expunged);
792 * implements the EXPUNGE command syntax
794 void imap_expunge(int num_parms, char *parms[])
796 int num_expunged = 0;
798 num_expunged = imap_do_expunge();
799 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
804 * implements the CLOSE command
806 void imap_close(int num_parms, char *parms[])
809 /* Yes, we always expunge on close. */
810 if (IMAP->selected) {
817 cprintf("%s OK CLOSE completed\r\n", parms[0]);
822 * Implements the NAMESPACE command.
824 void imap_namespace(int num_parms, char *parms[])
831 cprintf("* NAMESPACE ");
833 /* All personal folders are subordinate to INBOX. */
834 cprintf("((\"INBOX/\" \"/\")) ");
836 /* Other users' folders ... coming soon! FIXME */
839 /* Show all floors as shared namespaces. Neato! */
841 for (i = 0; i < MAXFLOORS; ++i) {
843 if (fl->f_flags & F_INUSE) {
844 if (floors > 0) cprintf(" ");
846 sprintf(buf, "%s/", fl->f_name);
854 /* Wind it up with a newline and a completion message. */
856 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
862 * Implements the CREATE command
865 void imap_create(int num_parms, char *parms[])
868 char roomname[ROOMNAMELEN];
874 if (strchr(parms[2], '\\') != NULL) {
875 cprintf("%s NO Invalid character in folder name\r\n",
877 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
881 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
883 cprintf("%s NO Invalid mailbox name or location\r\n",
885 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
888 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
889 flags = (ret & 0xff00); /* upper 8 bits = flags */
891 if (flags & IR_MAILBOX) {
892 if (strncasecmp(parms[2], "INBOX/", 6)) {
893 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
894 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
899 if (flags & IR_MAILBOX) {
900 newroomtype = 4; /* private mailbox */
901 newroomview = VIEW_MAILBOX;
903 newroomtype = 0; /* public folder */
904 newroomview = VIEW_BBS;
907 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
908 roomname, floornum, newroomtype);
910 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
912 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
913 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
915 cprintf("%s OK CREATE completed\r\n", parms[0]);
917 lprintf(CTDL_DEBUG, "imap_create() completed\n");
922 * Locate a room by its IMAP folder name, and check access to it.
923 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
925 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
928 char augmented_roomname[ROOMNAMELEN];
929 char roomname[ROOMNAMELEN];
931 struct ctdlroom QRscratch;
935 ret = imap_roomname(roomname, sizeof roomname, foldername);
940 /* First try a regular match */
941 c = getroom(&QRscratch, roomname);
943 /* Then try a mailbox name match */
945 MailboxName(augmented_roomname, sizeof augmented_roomname,
946 &CC->user, roomname);
947 c = getroom(&QRscratch, augmented_roomname);
949 strcpy(roomname, augmented_roomname);
952 /* If the room exists, check security/access */
954 /* See if there is an existing user/room relationship */
955 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
957 /* normal clients have to pass through security */
961 if ((zapped_ok) && (ra & UA_ZAPPED)) {
966 /* Fail here if no such room */
968 strcpy(returned_roomname, "");
971 strcpy(returned_roomname, QRscratch.QRname);
978 * Implements the STATUS command (sort of)
981 void imap_status(int num_parms, char *parms[])
984 char roomname[ROOMNAMELEN];
986 char savedroom[ROOMNAMELEN];
989 ret = imap_grabroom(roomname, parms[2], 0);
992 ("%s NO Invalid mailbox name or location, or access denied\r\n",
998 * usergoto() formally takes us to the desired room, happily returning
999 * the number of messages and number of new messages. (If another
1000 * folder is selected, save its name so we can return there!!!!!)
1002 if (IMAP->selected) {
1003 strcpy(savedroom, CC->room.QRname);
1005 usergoto(roomname, 0, 0, &msgs, &new);
1008 * Tell the client what it wants to know. In fact, tell it *more* than
1009 * it wants to know. We happily IGnore the supplied status data item
1010 * names and simply spew all possible data items. It's far easier to
1011 * code and probably saves us some processing time too.
1013 imap_mailboxname(buf, sizeof buf, &CC->room);
1014 cprintf("* STATUS ");
1016 cprintf(" (MESSAGES %d ", msgs);
1017 cprintf("RECENT %d ", new); /* Initially, new==recent */
1018 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1019 cprintf("UNSEEN %d)\r\n", new);
1022 * If another folder is selected, go back to that room so we can resume
1023 * our happy day without violent explosions.
1025 if (IMAP->selected) {
1026 usergoto(savedroom, 0, 0, &msgs, &new);
1030 * Oooh, look, we're done!
1032 cprintf("%s OK STATUS completed\r\n", parms[0]);
1038 * Implements the SUBSCRIBE command
1041 void imap_subscribe(int num_parms, char *parms[])
1044 char roomname[ROOMNAMELEN];
1045 char savedroom[ROOMNAMELEN];
1048 ret = imap_grabroom(roomname, parms[2], 1);
1051 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1059 * usergoto() formally takes us to the desired room, which has the side
1060 * effect of marking the room as not-zapped ... exactly the effect
1061 * we're looking for.
1063 if (IMAP->selected) {
1064 strcpy(savedroom, CC->room.QRname);
1066 usergoto(roomname, 0, 0, &msgs, &new);
1069 * If another folder is selected, go back to that room so we can resume
1070 * our happy day without violent explosions.
1072 if (IMAP->selected) {
1073 usergoto(savedroom, 0, 0, &msgs, &new);
1076 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1081 * Implements the UNSUBSCRIBE command
1084 void imap_unsubscribe(int num_parms, char *parms[])
1087 char roomname[ROOMNAMELEN];
1088 char savedroom[ROOMNAMELEN];
1091 ret = imap_grabroom(roomname, parms[2], 0);
1094 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1100 * usergoto() formally takes us to the desired room.
1102 if (IMAP->selected) {
1103 strcpy(savedroom, CC->room.QRname);
1105 usergoto(roomname, 0, 0, &msgs, &new);
1108 * Now make the API call to zap the room
1110 if (CtdlForgetThisRoom() == 0) {
1111 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1114 ("%s NO You may not unsubscribe from this folder.\r\n",
1119 * If another folder is selected, go back to that room so we can resume
1120 * our happy day without violent explosions.
1122 if (IMAP->selected) {
1123 usergoto(savedroom, 0, 0, &msgs, &new);
1130 * Implements the DELETE command
1133 void imap_delete(int num_parms, char *parms[])
1136 char roomname[ROOMNAMELEN];
1137 char savedroom[ROOMNAMELEN];
1140 ret = imap_grabroom(roomname, parms[2], 1);
1142 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1148 * usergoto() formally takes us to the desired room, happily returning
1149 * the number of messages and number of new messages. (If another
1150 * folder is selected, save its name so we can return there!!!!!)
1152 if (IMAP->selected) {
1153 strcpy(savedroom, CC->room.QRname);
1155 usergoto(roomname, 0, 0, &msgs, &new);
1158 * Now delete the room.
1160 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1161 schedule_room_for_deletion(&CC->room);
1162 cprintf("%s OK DELETE completed\r\n", parms[0]);
1164 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1168 * If another folder is selected, go back to that room so we can resume
1169 * our happy day without violent explosions.
1171 if (IMAP->selected) {
1172 usergoto(savedroom, 0, 0, &msgs, &new);
1178 * Back end function for imap_rename()
1180 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1182 char foldername[SIZ];
1183 char newfoldername[SIZ];
1184 char newroomname[ROOMNAMELEN];
1186 struct irl *irlp = NULL; /* scratch pointer */
1187 struct irlparms *irlparms;
1189 irlparms = (struct irlparms *) data;
1190 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1192 /* Rename subfolders */
1193 if ((!strncasecmp(foldername, irlparms->oldname,
1194 strlen(irlparms->oldname))
1195 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1197 sprintf(newfoldername, "%s/%s",
1199 &foldername[strlen(irlparms->oldname) + 1]
1202 newfloor = imap_roomname(newroomname,
1204 newfoldername) & 0xFF;
1206 irlp = (struct irl *) malloc(sizeof(struct irl));
1207 strcpy(irlp->irl_newroom, newroomname);
1208 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1209 irlp->irl_newfloor = newfloor;
1210 irlp->next = *(irlparms->irl);
1211 *(irlparms->irl) = irlp;
1217 * Implements the RENAME command
1220 void imap_rename(int num_parms, char *parms[])
1222 char old_room[ROOMNAMELEN];
1223 char new_room[ROOMNAMELEN];
1227 struct irl *irl = NULL; /* the list */
1228 struct irl *irlp = NULL; /* scratch pointer */
1229 struct irlparms irlparms;
1231 if (strchr(parms[3], '\\') != NULL) {
1232 cprintf("%s NO Invalid character in folder name\r\n",
1237 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1238 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1239 new_floor = (newr & 0xFF);
1241 r = CtdlRenameRoom(old_room, new_room, new_floor);
1243 if (r == crr_room_not_found) {
1244 cprintf("%s NO Could not locate this folder\r\n",
1248 if (r == crr_already_exists) {
1249 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1252 if (r == crr_noneditable) {
1253 cprintf("%s This folder is not editable.\r\n", parms[0]);
1256 if (r == crr_invalid_floor) {
1257 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1260 if (r == crr_access_denied) {
1261 cprintf("%s You do not have permission to edit "
1262 "this folder.\r\n", parms[0]);
1266 cprintf("%s NO Rename failed - undefined error %d\r\n",
1272 /* If this is the INBOX, then RFC2060 says we have to just move the
1273 * contents. In a Citadel environment it's easier to rename the room
1274 * (already did that) and create a new inbox.
1276 if (!strcasecmp(parms[2], "INBOX")) {
1277 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1280 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1282 irlparms.oldname = parms[2];
1283 irlparms.newname = parms[3];
1284 irlparms.irl = &irl;
1285 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1287 /* ... and now rename them. */
1288 while (irl != NULL) {
1289 r = CtdlRenameRoom(irl->irl_oldroom,
1293 /* FIXME handle error returns better */
1294 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1302 cprintf("%s OK RENAME completed\r\n", parms[0]);
1309 * Main command loop for IMAP sessions.
1311 void imap_command_loop(void)
1316 struct timeval tv1, tv2;
1317 suseconds_t total_time = 0;
1319 gettimeofday(&tv1, NULL);
1320 CC->lastcmd = time(NULL);
1321 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1323 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1324 lprintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1329 if (IMAP->authstate == imap_as_expecting_password) {
1330 lprintf(CTDL_INFO, "IMAP: <password>\n");
1332 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1333 lprintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1335 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1336 lprintf(CTDL_INFO, "IMAP: LOGIN...\n");
1339 lprintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1342 while (strlen(cmdbuf) < 5)
1343 strcat(cmdbuf, " ");
1345 /* strip off l/t whitespace and CRLF */
1346 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1347 cmdbuf[strlen(cmdbuf) - 1] = 0;
1348 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1349 cmdbuf[strlen(cmdbuf) - 1] = 0;
1352 /* If we're in the middle of a multi-line command, handle that */
1353 if (IMAP->authstate == imap_as_expecting_username) {
1354 imap_auth_login_user(cmdbuf);
1357 if (IMAP->authstate == imap_as_expecting_plainauth) {
1358 imap_auth_plain(cmdbuf);
1361 if (IMAP->authstate == imap_as_expecting_password) {
1362 imap_auth_login_pass(cmdbuf);
1366 /* Ok, at this point we're in normal command mode. The first thing
1367 * we do is print any incoming pages (yeah! we really do!)
1369 imap_print_instant_messages();
1372 * Before processing the command that was just entered... if we happen
1373 * to have a folder selected, we'd like to rescan that folder for new
1374 * messages, and for deletions/changes of existing messages. This
1375 * could probably be optimized somehow, but IMAP sucks...
1377 if (IMAP->selected) {
1378 imap_rescan_msgids();
1381 /* Now for the command set. */
1383 /* Grab the tag, command, and parameters. Check syntax. */
1384 num_parms = imap_parameterize(parms, cmdbuf);
1385 if (num_parms < 2) {
1386 cprintf("BAD syntax error\r\n");
1389 /* The commands below may be executed in any state */
1391 else if ((!strcasecmp(parms[1], "NOOP"))
1392 || (!strcasecmp(parms[1], "CHECK"))) {
1393 cprintf("%s OK No operation\r\n",
1397 else if (!strcasecmp(parms[1], "ID")) {
1398 imap_id(num_parms, parms);
1402 else if (!strcasecmp(parms[1], "LOGOUT")) {
1403 if (IMAP->selected) {
1404 imap_do_expunge(); /* yes, we auto-expunge */
1406 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1407 cprintf("%s OK Citadel IMAP session ended.\r\n",
1413 else if (!strcasecmp(parms[1], "LOGIN")) {
1414 imap_login(num_parms, parms);
1417 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1418 imap_authenticate(num_parms, parms);
1421 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1422 imap_capability(num_parms, parms);
1425 else if (!strcasecmp(parms[1], "STARTTLS")) {
1426 imap_starttls(num_parms, parms);
1429 else if (!CC->logged_in) {
1430 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1433 /* The commans below require a logged-in state */
1435 else if (!strcasecmp(parms[1], "SELECT")) {
1436 imap_select(num_parms, parms);
1439 else if (!strcasecmp(parms[1], "EXAMINE")) {
1440 imap_select(num_parms, parms);
1443 else if (!strcasecmp(parms[1], "LSUB")) {
1444 imap_list(num_parms, parms);
1447 else if (!strcasecmp(parms[1], "LIST")) {
1448 imap_list(num_parms, parms);
1451 else if (!strcasecmp(parms[1], "CREATE")) {
1452 imap_create(num_parms, parms);
1455 else if (!strcasecmp(parms[1], "DELETE")) {
1456 imap_delete(num_parms, parms);
1459 else if (!strcasecmp(parms[1], "RENAME")) {
1460 imap_rename(num_parms, parms);
1463 else if (!strcasecmp(parms[1], "STATUS")) {
1464 imap_status(num_parms, parms);
1467 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1468 imap_subscribe(num_parms, parms);
1471 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1472 imap_unsubscribe(num_parms, parms);
1475 else if (!strcasecmp(parms[1], "APPEND")) {
1476 imap_append(num_parms, parms);
1479 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1480 imap_namespace(num_parms, parms);
1483 else if (!strcasecmp(parms[1], "SETACL")) {
1484 imap_setacl(num_parms, parms);
1487 else if (!strcasecmp(parms[1], "DELETEACL")) {
1488 imap_deleteacl(num_parms, parms);
1491 else if (!strcasecmp(parms[1], "GETACL")) {
1492 imap_getacl(num_parms, parms);
1495 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1496 imap_listrights(num_parms, parms);
1499 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1500 imap_myrights(num_parms, parms);
1503 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1504 imap_getmetadata(num_parms, parms);
1507 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1508 imap_setmetadata(num_parms, parms);
1511 else if (IMAP->selected == 0) {
1512 cprintf("%s BAD no folder selected\r\n", parms[0]);
1515 /* The commands below require the SELECT state on a mailbox */
1517 else if (!strcasecmp(parms[1], "FETCH")) {
1518 imap_fetch(num_parms, parms);
1521 else if ((!strcasecmp(parms[1], "UID"))
1522 && (!strcasecmp(parms[2], "FETCH"))) {
1523 imap_uidfetch(num_parms, parms);
1526 else if (!strcasecmp(parms[1], "SEARCH")) {
1527 imap_search(num_parms, parms);
1530 else if ((!strcasecmp(parms[1], "UID"))
1531 && (!strcasecmp(parms[2], "SEARCH"))) {
1532 imap_uidsearch(num_parms, parms);
1535 else if (!strcasecmp(parms[1], "STORE")) {
1536 imap_store(num_parms, parms);
1539 else if ((!strcasecmp(parms[1], "UID"))
1540 && (!strcasecmp(parms[2], "STORE"))) {
1541 imap_uidstore(num_parms, parms);
1544 else if (!strcasecmp(parms[1], "COPY")) {
1545 imap_copy(num_parms, parms);
1548 else if ((!strcasecmp(parms[1], "UID"))
1549 && (!strcasecmp(parms[2], "COPY"))) {
1550 imap_uidcopy(num_parms, parms);
1553 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1554 imap_expunge(num_parms, parms);
1557 else if (!strcasecmp(parms[1], "CLOSE")) {
1558 imap_close(num_parms, parms);
1561 /* End of commands. If we get here, the command is either invalid
1566 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1569 /* If the client transmitted a message we can free it now */
1570 imap_free_transmitted_message();
1572 gettimeofday(&tv2, NULL);
1573 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1574 lprintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1575 (total_time / 1000000),
1576 (total_time % 1000000)
1582 * This function is called to register the IMAP extension with Citadel.
1584 CTDL_MODULE_INIT(imap)
1586 CtdlRegisterServiceHook(config.c_imap_port,
1587 NULL, imap_greeting, imap_command_loop, NULL);
1589 CtdlRegisterServiceHook(config.c_imaps_port,
1590 NULL, imaps_greeting, imap_command_loop, NULL);
1592 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1594 /* return our Subversion id for the Log */