4 * IMAP server for the Citadel system
5 * Copyright (C) 2000-2005 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 "sysdep_decls.h"
41 #include "citserver.h"
44 #include "serv_extensions.h"
51 #include "internet_addressing.h"
52 #include "serv_imap.h"
53 #include "imap_tools.h"
54 #include "imap_fetch.h"
55 #include "imap_search.h"
56 #include "imap_store.h"
57 #include "imap_misc.h"
60 #include "serv_crypto.h"
63 /* imap_rename() uses this struct containing list of rooms to rename */
66 char irl_oldroom[ROOMNAMELEN];
67 char irl_newroom[ROOMNAMELEN];
71 /* Data which is passed between imap_rename() and imap_rename_backend() */
80 * If there is a message ID map in memory, free it
82 void imap_free_msgids(void)
84 if (IMAP->msgids != NULL) {
90 if (IMAP->flags != NULL) {
94 IMAP->last_mtime = (-1);
99 * If there is a transmitted message in memory, free it
101 void imap_free_transmitted_message(void)
103 if (IMAP->transmitted_message != NULL) {
104 free(IMAP->transmitted_message);
105 IMAP->transmitted_message = NULL;
106 IMAP->transmitted_length = 0;
112 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
113 * sets stored in the visit record for this user/room. Note that we have
114 * to parse each sequence set manually here, because calling the utility
115 * function is_msg_in_sequence_set() over and over again is too expensive.
117 * first_msg should be set to 0 to rescan the flags for every message in the
118 * room, or some other value if we're only interested in an incremental
121 void imap_set_seen_flags(int first_msg)
127 char setstr[64], lostr[64], histr[64];
130 if (IMAP->num_msgs < 1) return;
131 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
133 for (i = first_msg; i < IMAP->num_msgs; ++i) {
134 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
135 IMAP->flags[i] |= IMAP_RECENT;
136 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
140 * Do the "\Seen" flag.
141 * (Any message not "\Seen" is considered "\Recent".)
143 num_sets = num_tokens(vbuf.v_seen, ',');
144 for (s=0; s<num_sets; ++s) {
145 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
147 extract_token(lostr, setstr, 0, ':', sizeof lostr);
148 if (num_tokens(setstr, ':') >= 2) {
149 extract_token(histr, setstr, 1, ':', sizeof histr);
150 if (!strcmp(histr, "*")) {
151 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
155 strcpy(histr, lostr);
160 for (i = first_msg; i < IMAP->num_msgs; ++i) {
161 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
162 IMAP->flags[i] |= IMAP_SEEN;
163 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
168 /* Do the ANSWERED flag */
169 num_sets = num_tokens(vbuf.v_answered, ',');
170 for (s=0; s<num_sets; ++s) {
171 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
173 extract_token(lostr, setstr, 0, ':', sizeof lostr);
174 if (num_tokens(setstr, ':') >= 2) {
175 extract_token(histr, setstr, 1, ':', sizeof histr);
176 if (!strcmp(histr, "*")) {
177 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
181 strcpy(histr, lostr);
186 for (i = first_msg; i < IMAP->num_msgs; ++i) {
187 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
188 IMAP->flags[i] |= IMAP_ANSWERED;
198 * Back end for imap_load_msgids()
200 * Optimization: instead of calling realloc() to add each message, we
201 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
202 * allows the mapping to proceed much faster.
204 void imap_add_single_msgid(long msgnum, void *userdata)
208 if (IMAP->num_msgs > IMAP->num_alloc) {
209 IMAP->num_alloc += REALLOC_INCREMENT;
210 IMAP->msgids = realloc(IMAP->msgids,
211 (IMAP->num_alloc * sizeof(long)) );
212 IMAP->flags = realloc(IMAP->flags,
213 (IMAP->num_alloc * sizeof(long)) );
215 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
216 IMAP->flags[IMAP->num_msgs - 1] = 0;
222 * Set up a message ID map for the current room (folder)
224 void imap_load_msgids(void)
226 struct cdbdata *cdbfr;
228 if (IMAP->selected == 0) {
230 "imap_load_msgids() can't run; no room selected\n");
234 imap_free_msgids(); /* If there was already a map, free it */
236 /* Load the message list */
237 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
239 IMAP->msgids = malloc(cdbfr->len);
240 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
241 IMAP->num_msgs = cdbfr->len / sizeof(long);
242 IMAP->num_alloc = cdbfr->len / sizeof(long);
246 if (IMAP->num_msgs) {
247 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
248 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
251 imap_set_seen_flags(0);
256 * Re-scan the selected room (folder) and see if it's been changed at all
258 void imap_rescan_msgids(void)
261 int original_num_msgs = 0;
262 long original_highest = 0L;
264 int message_still_exists;
265 struct cdbdata *cdbfr;
266 long *msglist = NULL;
270 if (IMAP->selected == 0) {
272 "imap_load_msgids() can't run; no room selected\n");
277 * Check to see if the room's contents have changed.
278 * If not, we can avoid this rescan.
280 getroom(&CC->room, CC->room.QRname);
281 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
285 /* Load the *current* message list from disk, so we can compare it
286 * to what we have in memory.
288 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
290 msglist = malloc(cdbfr->len);
291 if (msglist == NULL) {
292 lprintf(CTDL_CRIT, "malloc() failed\n");
295 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
296 num_msgs = cdbfr->len / sizeof(long);
303 * Check to see if any of the messages we know about have been expunged
305 if (IMAP->num_msgs > 0) {
307 for (i = 0; i < IMAP->num_msgs; ++i) {
309 message_still_exists = 0;
311 for (j = jstart; j < num_msgs; ++j) {
312 if (msglist[j] == IMAP->msgids[i]) {
313 message_still_exists = 1;
320 if (message_still_exists == 0) {
321 cprintf("* %d EXPUNGE\r\n", i + 1);
323 /* Here's some nice stupid nonsense. When a
324 * message is expunged, we have to slide all
325 * the existing messages up in the message
329 memcpy(&IMAP->msgids[i],
330 &IMAP->msgids[i + 1],
332 (IMAP->num_msgs - i)));
333 memcpy(&IMAP->flags[i],
336 (IMAP->num_msgs - i)));
345 * Remember how many messages were here before we re-scanned.
347 original_num_msgs = IMAP->num_msgs;
348 if (IMAP->num_msgs > 0) {
349 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
351 original_highest = 0L;
355 * Now peruse the room for *new* messages only.
358 for (j = 0; j < num_msgs; ++j) {
359 if (msglist[j] > original_highest) {
360 imap_add_single_msgid(msglist[j], NULL);
364 imap_set_seen_flags(original_num_msgs);
367 * If new messages have arrived, tell the client about them.
369 if (IMAP->num_msgs > original_num_msgs) {
371 for (j = 0; j < num_msgs; ++j) {
372 if (IMAP->flags[j] & IMAP_RECENT) {
377 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
378 cprintf("* %d RECENT\r\n", num_recent);
384 IMAP->last_mtime = CC->room.QRmtime;
394 * This cleanup function blows away the temporary memory and files used by
397 void imap_cleanup_function(void)
400 /* Don't do this stuff if this is not a IMAP session! */
401 if (CC->h_command_function != imap_command_loop)
404 /* If there is a mailbox selected, auto-expunge it. */
405 if (IMAP->selected) {
409 lprintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
411 imap_free_transmitted_message();
413 if (IMAP->cached_rfc822_data != NULL) {
414 free(IMAP->cached_rfc822_data);
415 IMAP->cached_rfc822_data = NULL;
416 IMAP->cached_rfc822_msgnum = (-1);
417 IMAP->cached_rfc822_withbody = 0;
420 if (IMAP->cached_body != NULL) {
421 free(IMAP->cached_body);
422 IMAP->cached_body = NULL;
423 IMAP->cached_body_len = 0;
424 IMAP->cached_bodymsgnum = (-1);
428 lprintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
433 * Does the actual work of the CAPABILITY command (because we need to
434 * output this stuff in other places as well)
436 void imap_output_capability_string(void) {
437 cprintf("CAPABILITY IMAP4REV1 NAMESPACE AUTH=LOGIN");
439 if (!CC->redirect_ssl) cprintf(" STARTTLS");
444 * implements the CAPABILITY command
446 void imap_capability(int num_parms, char *parms[])
449 imap_output_capability_string();
451 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
457 * Here's where our IMAP session begins its happy day.
459 void imap_greeting(void)
462 strcpy(CC->cs_clientname, "IMAP session");
463 IMAP = malloc(sizeof (struct citimap));
464 memset(IMAP, 0, sizeof(struct citimap));
465 IMAP->authstate = imap_as_normal;
466 IMAP->cached_rfc822_data = NULL;
467 IMAP->cached_rfc822_msgnum = (-1);
468 IMAP->cached_rfc822_withbody = 0;
471 imap_output_capability_string();
472 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
476 * IMAPS is just like IMAP, except it goes crypto right away.
479 void imaps_greeting(void) {
480 CtdlStartTLS(NULL, NULL, NULL);
487 * implements the LOGIN command (ordinary username/password login)
489 void imap_login(int num_parms, char *parms[])
491 if (num_parms != 4) {
492 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
496 if (CtdlLoginExistingUser(parms[2]) == login_ok) {
497 if (CtdlTryPassword(parms[3]) == pass_ok) {
498 cprintf("%s OK [", parms[0]);
499 imap_output_capability_string();
500 cprintf("] Hello, %s\r\n", CC->user.fullname);
505 cprintf("%s BAD Login incorrect\r\n", parms[0]);
510 * Implements the AUTHENTICATE command
512 void imap_authenticate(int num_parms, char *parms[])
516 if (num_parms != 3) {
517 cprintf("%s BAD incorrect number of parameters\r\n",
523 cprintf("%s BAD Already logged in.\r\n", parms[0]);
527 if (!strcasecmp(parms[2], "LOGIN")) {
528 CtdlEncodeBase64(buf, "Username:", 9);
529 cprintf("+ %s\r\n", buf);
530 IMAP->authstate = imap_as_expecting_username;
531 strcpy(IMAP->authseq, parms[0]);
536 cprintf("%s NO AUTHENTICATE %s failed\r\n",
541 void imap_auth_login_user(char *cmd)
545 CtdlDecodeBase64(buf, cmd, SIZ);
546 CtdlLoginExistingUser(buf);
547 CtdlEncodeBase64(buf, "Password:", 9);
548 cprintf("+ %s\r\n", buf);
549 IMAP->authstate = imap_as_expecting_password;
553 void imap_auth_login_pass(char *cmd)
557 CtdlDecodeBase64(buf, cmd, SIZ);
558 if (CtdlTryPassword(buf) == pass_ok) {
559 cprintf("%s OK authentication succeeded\r\n",
562 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
564 IMAP->authstate = imap_as_normal;
570 * implements the STARTTLS command (Citadel API version)
573 void imap_starttls(int num_parms, char *parms[])
575 char ok_response[SIZ];
576 char nosup_response[SIZ];
577 char error_response[SIZ];
580 "%s OK begin TLS negotiation now\r\n",
582 sprintf(nosup_response,
583 "%s NO TLS not supported here\r\n",
585 sprintf(error_response,
586 "%s BAD Internal error\r\n",
588 CtdlStartTLS(ok_response, nosup_response, error_response);
594 * implements the SELECT command
596 void imap_select(int num_parms, char *parms[])
599 char augmented_roomname[ROOMNAMELEN];
603 struct ctdlroom QRscratch;
609 /* Convert the supplied folder name to a roomname */
610 i = imap_roomname(towhere, sizeof towhere, parms[2]);
612 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
616 floornum = (i & 0x00ff);
617 roomflags = (i & 0xff00);
619 /* First try a regular match */
620 c = getroom(&QRscratch, towhere);
622 /* Then try a mailbox name match */
624 MailboxName(augmented_roomname, sizeof augmented_roomname,
626 c = getroom(&QRscratch, augmented_roomname);
628 strcpy(towhere, augmented_roomname);
631 /* If the room exists, check security/access */
633 /* See if there is an existing user/room relationship */
634 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
636 /* normal clients have to pass through security */
642 /* Fail here if no such room */
644 cprintf("%s NO ... no such room, or access denied\r\n",
649 /* If we already had some other folder selected, auto-expunge it */
653 * usergoto() formally takes us to the desired room, happily returning
654 * the number of messages and number of new messages.
656 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
657 usergoto(NULL, 0, 0, &msgs, &new);
660 if (!strcasecmp(parms[1], "EXAMINE")) {
667 IMAP->last_mtime = CC->room.QRmtime;
669 cprintf("* %d EXISTS\r\n", msgs);
670 cprintf("* %d RECENT\r\n", new);
672 cprintf("* OK [UIDVALIDITY 1] UID validity status\r\n");
673 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
675 /* Note that \Deleted is a valid flag, but not a permanent flag,
676 * because we don't maintain its state across sessions. Citadel
677 * automatically expunges mailboxes when they are de-selected.
679 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
680 cprintf("* OK [PERMANENTFLAGS (\\Seen \\Answered)] "
681 "permanent flags\r\n");
683 cprintf("%s OK [%s] %s completed\r\n",
685 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
691 * does the real work for expunge
693 int imap_do_expunge(void)
696 int num_expunged = 0;
698 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
699 if (IMAP->selected == 0) {
703 if (IMAP->num_msgs > 0)
704 for (i = 0; i < IMAP->num_msgs; ++i) {
705 if (IMAP->flags[i] & IMAP_DELETED) {
706 CtdlDeleteMessages(CC->room.QRname,
707 IMAP->msgids[i], "");
712 if (num_expunged > 0) {
713 imap_rescan_msgids();
716 lprintf(CTDL_DEBUG, "Expunged %d messages.\n", num_expunged);
717 return (num_expunged);
722 * implements the EXPUNGE command syntax
724 void imap_expunge(int num_parms, char *parms[])
726 int num_expunged = 0;
728 num_expunged = imap_do_expunge();
729 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
734 * implements the CLOSE command
736 void imap_close(int num_parms, char *parms[])
739 /* Yes, we always expunge on close. */
740 if (IMAP->selected) {
747 cprintf("%s OK CLOSE completed\r\n", parms[0]);
752 * Implements the NAMESPACE command.
754 void imap_namespace(int num_parms, char *parms[])
761 cprintf("* NAMESPACE ");
763 /* All personal folders are subordinate to INBOX. */
764 cprintf("((\"INBOX/\" \"/\")) ");
766 /* Other users' folders ... coming soon! FIXME */
769 /* Show all floors as shared namespaces. Neato! */
771 for (i = 0; i < MAXFLOORS; ++i) {
773 if (fl->f_flags & F_INUSE) {
774 if (floors > 0) cprintf(" ");
776 sprintf(buf, "%s/", fl->f_name);
784 /* Wind it up with a newline and a completion message. */
786 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
792 * Used by LIST and LSUB to show the floors in the listing
794 void imap_list_floors(char *cmd, char *pattern)
799 for (i = 0; i < MAXFLOORS; ++i) {
801 if (fl->f_flags & F_INUSE) {
802 if (imap_mailbox_matches_pattern
803 (pattern, fl->f_name)) {
804 cprintf("* %s (\\NoSelect) \"/\" ", cmd);
805 imap_strout(fl->f_name);
815 * Back end for imap_lsub()
817 * IMAP "subscribed folder" is equivocated to Citadel "known rooms." This
818 * may or may not be the desired behavior in the future.
820 void imap_lsub_listroom(struct ctdlroom *qrbuf, void *data)
826 pattern = (char *) data;
828 /* Only list rooms to which the user has access!! */
829 CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
831 imap_mailboxname(buf, sizeof buf, qrbuf);
832 if (imap_mailbox_matches_pattern(pattern, buf)) {
833 cprintf("* LSUB () \"/\" ");
842 * Implements the LSUB command
844 void imap_lsub(int num_parms, char *parms[])
848 cprintf("%s BAD arguments invalid\r\n", parms[0]);
851 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
853 if (strlen(parms[3]) == 0) {
854 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
858 imap_list_floors("LSUB", pattern);
859 ForEachRoom(imap_lsub_listroom, pattern);
862 cprintf("%s OK LSUB completed\r\n", parms[0]);
868 * Back end for imap_list()
870 void imap_list_listroom(struct ctdlroom *qrbuf, void *data)
876 pattern = (char *) data;
878 /* Only list rooms to which the user has access!! */
879 CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
881 || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
882 imap_mailboxname(buf, sizeof buf, qrbuf);
883 if (imap_mailbox_matches_pattern(pattern, buf)) {
884 cprintf("* LIST () \"/\" ");
893 * Implements the LIST command
895 void imap_list(int num_parms, char *parms[])
899 cprintf("%s BAD arguments invalid\r\n", parms[0]);
902 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
904 if (strlen(parms[3]) == 0) {
905 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
909 imap_list_floors("LIST", pattern);
910 ForEachRoom(imap_list_listroom, pattern);
913 cprintf("%s OK LIST completed\r\n", parms[0]);
919 * Implements the CREATE command
922 void imap_create(int num_parms, char *parms[])
925 char roomname[ROOMNAMELEN];
931 if (strchr(parms[2], '\\') != NULL) {
932 cprintf("%s NO Invalid character in folder name\r\n",
934 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
938 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
940 cprintf("%s NO Invalid mailbox name or location\r\n",
942 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
945 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
946 flags = (ret & 0xff00); /* upper 8 bits = flags */
948 if (flags & IR_MAILBOX) {
949 if (strncasecmp(parms[2], "INBOX/", 6)) {
950 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
951 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
956 if (flags & IR_MAILBOX) {
957 newroomtype = 4; /* private mailbox */
958 newroomview = VIEW_MAILBOX;
960 newroomtype = 0; /* public folder */
961 newroomview = VIEW_BBS;
964 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
965 roomname, floornum, newroomtype);
967 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
970 ("%s NO Mailbox already exists, or create failed\r\n",
973 cprintf("%s OK CREATE completed\r\n", parms[0]);
975 lprintf(CTDL_DEBUG, "imap_create() completed\n");
980 * Locate a room by its IMAP folder name, and check access to it.
981 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
983 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
986 char augmented_roomname[ROOMNAMELEN];
987 char roomname[ROOMNAMELEN];
989 struct ctdlroom QRscratch;
993 ret = imap_roomname(roomname, sizeof roomname, foldername);
998 /* First try a regular match */
999 c = getroom(&QRscratch, roomname);
1001 /* Then try a mailbox name match */
1003 MailboxName(augmented_roomname, sizeof augmented_roomname,
1004 &CC->user, roomname);
1005 c = getroom(&QRscratch, augmented_roomname);
1007 strcpy(roomname, augmented_roomname);
1010 /* If the room exists, check security/access */
1012 /* See if there is an existing user/room relationship */
1013 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1015 /* normal clients have to pass through security */
1016 if (ra & UA_KNOWN) {
1019 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1024 /* Fail here if no such room */
1026 strcpy(returned_roomname, "");
1029 strcpy(returned_roomname, QRscratch.QRname);
1036 * Implements the STATUS command (sort of)
1039 void imap_status(int num_parms, char *parms[])
1042 char roomname[ROOMNAMELEN];
1044 char savedroom[ROOMNAMELEN];
1047 ret = imap_grabroom(roomname, parms[2], 0);
1050 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1056 * usergoto() formally takes us to the desired room, happily returning
1057 * the number of messages and number of new messages. (If another
1058 * folder is selected, save its name so we can return there!!!!!)
1060 if (IMAP->selected) {
1061 strcpy(savedroom, CC->room.QRname);
1063 usergoto(roomname, 0, 0, &msgs, &new);
1066 * Tell the client what it wants to know. In fact, tell it *more* than
1067 * it wants to know. We happily IGnore the supplied status data item
1068 * names and simply spew all possible data items. It's far easier to
1069 * code and probably saves us some processing time too.
1071 imap_mailboxname(buf, sizeof buf, &CC->room);
1072 cprintf("* STATUS ");
1074 cprintf(" (MESSAGES %d ", msgs);
1075 cprintf("RECENT %d ", new); /* Initially, new==recent */
1076 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1077 cprintf("UNSEEN %d)\r\n", 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);
1088 * Oooh, look, we're done!
1090 cprintf("%s OK STATUS completed\r\n", parms[0]);
1096 * Implements the SUBSCRIBE command
1099 void imap_subscribe(int num_parms, char *parms[])
1102 char roomname[ROOMNAMELEN];
1103 char savedroom[ROOMNAMELEN];
1106 ret = imap_grabroom(roomname, parms[2], 1);
1109 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1117 * usergoto() formally takes us to the desired room, which has the side
1118 * effect of marking the room as not-zapped ... exactly the effect
1119 * we're looking for.
1121 if (IMAP->selected) {
1122 strcpy(savedroom, CC->room.QRname);
1124 usergoto(roomname, 0, 0, &msgs, &new);
1127 * If another folder is selected, go back to that room so we can resume
1128 * our happy day without violent explosions.
1130 if (IMAP->selected) {
1131 usergoto(savedroom, 0, 0, &msgs, &new);
1134 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1139 * Implements the UNSUBSCRIBE command
1142 void imap_unsubscribe(int num_parms, char *parms[])
1145 char roomname[ROOMNAMELEN];
1146 char savedroom[ROOMNAMELEN];
1149 ret = imap_grabroom(roomname, parms[2], 0);
1152 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1158 * usergoto() formally takes us to the desired room.
1160 if (IMAP->selected) {
1161 strcpy(savedroom, CC->room.QRname);
1163 usergoto(roomname, 0, 0, &msgs, &new);
1166 * Now make the API call to zap the room
1168 if (CtdlForgetThisRoom() == 0) {
1169 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1172 ("%s NO You may not unsubscribe from this folder.\r\n",
1177 * If another folder is selected, go back to that room so we can resume
1178 * our happy day without violent explosions.
1180 if (IMAP->selected) {
1181 usergoto(savedroom, 0, 0, &msgs, &new);
1188 * Implements the DELETE command
1191 void imap_delete(int num_parms, char *parms[])
1194 char roomname[ROOMNAMELEN];
1195 char savedroom[ROOMNAMELEN];
1198 ret = imap_grabroom(roomname, parms[2], 0);
1200 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1206 * usergoto() formally takes us to the desired room, happily returning
1207 * the number of messages and number of new messages. (If another
1208 * folder is selected, save its name so we can return there!!!!!)
1210 if (IMAP->selected) {
1211 strcpy(savedroom, CC->room.QRname);
1213 usergoto(roomname, 0, 0, &msgs, &new);
1216 * Now delete the room.
1218 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1219 schedule_room_for_deletion(&CC->room);
1220 cprintf("%s OK DELETE completed\r\n", parms[0]);
1222 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1226 * If another folder is selected, go back to that room so we can resume
1227 * our happy day without violent explosions.
1229 if (IMAP->selected) {
1230 usergoto(savedroom, 0, 0, &msgs, &new);
1236 * Back end function for imap_rename()
1238 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1240 char foldername[SIZ];
1241 char newfoldername[SIZ];
1242 char newroomname[ROOMNAMELEN];
1244 struct irl *irlp = NULL; /* scratch pointer */
1245 struct irlparms *irlparms;
1247 irlparms = (struct irlparms *) data;
1248 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1250 /* Rename subfolders */
1251 if ((!strncasecmp(foldername, irlparms->oldname,
1252 strlen(irlparms->oldname))
1253 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1255 sprintf(newfoldername, "%s/%s",
1257 &foldername[strlen(irlparms->oldname) + 1]
1260 newfloor = imap_roomname(newroomname,
1262 newfoldername) & 0xFF;
1264 irlp = (struct irl *) malloc(sizeof(struct irl));
1265 strcpy(irlp->irl_newroom, newroomname);
1266 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1267 irlp->irl_newfloor = newfloor;
1268 irlp->next = *(irlparms->irl);
1269 *(irlparms->irl) = irlp;
1275 * Implements the RENAME command
1278 void imap_rename(int num_parms, char *parms[])
1280 char old_room[ROOMNAMELEN];
1281 char new_room[ROOMNAMELEN];
1285 struct irl *irl = NULL; /* the list */
1286 struct irl *irlp = NULL; /* scratch pointer */
1287 struct irlparms irlparms;
1289 if (strchr(parms[3], '\\') != NULL) {
1290 cprintf("%s NO Invalid character in folder name\r\n",
1295 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1296 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1297 new_floor = (newr & 0xFF);
1299 r = CtdlRenameRoom(old_room, new_room, new_floor);
1301 if (r == crr_room_not_found) {
1302 cprintf("%s NO Could not locate this folder\r\n",
1306 if (r == crr_already_exists) {
1307 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1310 if (r == crr_noneditable) {
1311 cprintf("%s This folder is not editable.\r\n", parms[0]);
1314 if (r == crr_invalid_floor) {
1315 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1318 if (r == crr_access_denied) {
1319 cprintf("%s You do not have permission to edit "
1320 "this folder.\r\n", parms[0]);
1324 cprintf("%s NO Rename failed - undefined error %d\r\n",
1330 /* If this is the INBOX, then RFC2060 says we have to just move the
1331 * contents. In a Citadel environment it's easier to rename the room
1332 * (already did that) and create a new inbox.
1334 if (!strcasecmp(parms[2], "INBOX")) {
1335 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1338 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1340 irlparms.oldname = parms[2];
1341 irlparms.newname = parms[3];
1342 irlparms.irl = &irl;
1343 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1345 /* ... and now rename them. */
1346 while (irl != NULL) {
1347 r = CtdlRenameRoom(irl->irl_oldroom,
1351 /* FIXME handle error returns better */
1352 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n",
1361 cprintf("%s OK RENAME completed\r\n", parms[0]);
1368 * Main command loop for IMAP sessions.
1370 void imap_command_loop(void)
1376 CC->lastcmd = time(NULL);
1377 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1379 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1380 lprintf(CTDL_ERR, "IMAP socket is broken. Ending session.\r\n");
1385 lprintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1386 while (strlen(cmdbuf) < 5)
1387 strcat(cmdbuf, " ");
1389 /* strip off l/t whitespace and CRLF */
1390 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1391 cmdbuf[strlen(cmdbuf) - 1] = 0;
1392 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1393 cmdbuf[strlen(cmdbuf) - 1] = 0;
1396 /* If we're in the middle of a multi-line command, handle that */
1397 if (IMAP->authstate == imap_as_expecting_username) {
1398 imap_auth_login_user(cmdbuf);
1401 if (IMAP->authstate == imap_as_expecting_password) {
1402 imap_auth_login_pass(cmdbuf);
1406 /* Ok, at this point we're in normal command mode. The first thing
1407 * we do is print any incoming pages (yeah! we really do!)
1409 imap_print_instant_messages();
1412 * Before processing the command that was just entered... if we happen
1413 * to have a folder selected, we'd like to rescan that folder for new
1414 * messages, and for deletions/changes of existing messages. This
1415 * could probably be optimized somehow, but IMAP sucks...
1417 if (IMAP->selected) {
1418 imap_rescan_msgids();
1421 /* Now for the command set. */
1423 /* Grab the tag, command, and parameters. Check syntax. */
1424 num_parms = imap_parameterize(parms, cmdbuf);
1425 if (num_parms < 2) {
1426 cprintf("BAD syntax error\r\n");
1429 /* The commands below may be executed in any state */
1431 else if ((!strcasecmp(parms[1], "NOOP"))
1432 || (!strcasecmp(parms[1], "CHECK"))) {
1433 cprintf("%s OK This command successfully did nothing.\r\n",
1437 else if (!strcasecmp(parms[1], "LOGOUT")) {
1438 if (IMAP->selected) {
1439 imap_do_expunge(); /* yes, we auto-expunge */
1441 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1442 cprintf("%s OK thank you for using Citadel IMAP\r\n",
1448 else if (!strcasecmp(parms[1], "LOGIN")) {
1449 imap_login(num_parms, parms);
1452 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1453 imap_authenticate(num_parms, parms);
1456 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1457 imap_capability(num_parms, parms);
1460 else if (!strcasecmp(parms[1], "STARTTLS")) {
1461 imap_starttls(num_parms, parms);
1464 else if (!CC->logged_in) {
1465 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1468 /* The commans below require a logged-in state */
1470 else if (!strcasecmp(parms[1], "SELECT")) {
1471 imap_select(num_parms, parms);
1474 else if (!strcasecmp(parms[1], "EXAMINE")) {
1475 imap_select(num_parms, parms);
1478 else if (!strcasecmp(parms[1], "LSUB")) {
1479 imap_lsub(num_parms, parms);
1482 else if (!strcasecmp(parms[1], "LIST")) {
1483 imap_list(num_parms, parms);
1486 else if (!strcasecmp(parms[1], "CREATE")) {
1487 imap_create(num_parms, parms);
1490 else if (!strcasecmp(parms[1], "DELETE")) {
1491 imap_delete(num_parms, parms);
1494 else if (!strcasecmp(parms[1], "RENAME")) {
1495 imap_rename(num_parms, parms);
1498 else if (!strcasecmp(parms[1], "STATUS")) {
1499 imap_status(num_parms, parms);
1502 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1503 imap_subscribe(num_parms, parms);
1506 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1507 imap_unsubscribe(num_parms, parms);
1510 else if (!strcasecmp(parms[1], "APPEND")) {
1511 imap_append(num_parms, parms);
1514 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1515 imap_namespace(num_parms, parms);
1518 else if (IMAP->selected == 0) {
1519 cprintf("%s BAD no folder selected\r\n", parms[0]);
1522 /* The commands below require the SELECT state on a mailbox */
1524 else if (!strcasecmp(parms[1], "FETCH")) {
1525 imap_fetch(num_parms, parms);
1528 else if ((!strcasecmp(parms[1], "UID"))
1529 && (!strcasecmp(parms[2], "FETCH"))) {
1530 imap_uidfetch(num_parms, parms);
1533 else if (!strcasecmp(parms[1], "SEARCH")) {
1534 imap_search(num_parms, parms);
1537 else if ((!strcasecmp(parms[1], "UID"))
1538 && (!strcasecmp(parms[2], "SEARCH"))) {
1539 imap_uidsearch(num_parms, parms);
1542 else if (!strcasecmp(parms[1], "STORE")) {
1543 imap_store(num_parms, parms);
1546 else if ((!strcasecmp(parms[1], "UID"))
1547 && (!strcasecmp(parms[2], "STORE"))) {
1548 imap_uidstore(num_parms, parms);
1551 else if (!strcasecmp(parms[1], "COPY")) {
1552 imap_copy(num_parms, parms);
1555 else if ((!strcasecmp(parms[1], "UID"))
1556 && (!strcasecmp(parms[2], "COPY"))) {
1557 imap_uidcopy(num_parms, parms);
1560 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1561 imap_expunge(num_parms, parms);
1564 else if (!strcasecmp(parms[1], "CLOSE")) {
1565 imap_close(num_parms, parms);
1568 /* End of commands. If we get here, the command is either invalid
1573 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1576 /* If the client transmitted a message we can free it now */
1577 imap_free_transmitted_message();
1583 * This function is called to register the IMAP extension with Citadel.
1585 char *serv_imap_init(void)
1587 CtdlRegisterServiceHook(config.c_imap_port,
1588 NULL, imap_greeting, imap_command_loop, NULL);
1590 CtdlRegisterServiceHook(config.c_imaps_port,
1591 NULL, imaps_greeting, imap_command_loop, NULL);
1593 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);