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 "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"
58 #include "imap_misc.h"
61 #include "serv_crypto.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=LOGIN");
440 if (!CC->redirect_ssl) cprintf(" STARTTLS");
445 * implements the CAPABILITY command
447 void imap_capability(int num_parms, char *parms[])
450 imap_output_capability_string();
452 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
458 * Implements the ID command (specified by RFC2971)
460 * We ignore the client-supplied information, and output a NIL response.
461 * Although this is technically a valid implementation of the extension, it
462 * is quite useless. It exists only so that we may see which clients are
463 * making use of this extension.
466 void imap_id(int num_parms, char *parms[])
468 cprintf("* ID NIL\r\n");
469 cprintf("%s OK ID completed\r\n", parms[0]);
475 * Here's where our IMAP session begins its happy day.
477 void imap_greeting(void)
480 strcpy(CC->cs_clientname, "IMAP session");
481 IMAP = malloc(sizeof (struct citimap));
482 memset(IMAP, 0, sizeof(struct citimap));
483 IMAP->authstate = imap_as_normal;
484 IMAP->cached_rfc822_data = NULL;
485 IMAP->cached_rfc822_msgnum = (-1);
486 IMAP->cached_rfc822_withbody = 0;
489 imap_output_capability_string();
490 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
494 * IMAPS is just like IMAP, except it goes crypto right away.
497 void imaps_greeting(void) {
498 CtdlStartTLS(NULL, NULL, NULL);
505 * implements the LOGIN command (ordinary username/password login)
507 void imap_login(int num_parms, char *parms[])
509 if (num_parms != 4) {
510 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
514 if (CtdlLoginExistingUser(parms[2]) == login_ok) {
515 if (CtdlTryPassword(parms[3]) == pass_ok) {
516 cprintf("%s OK [", parms[0]);
517 imap_output_capability_string();
518 cprintf("] Hello, %s\r\n", CC->user.fullname);
523 cprintf("%s BAD Login incorrect\r\n", parms[0]);
528 * Implements the AUTHENTICATE command
530 void imap_authenticate(int num_parms, char *parms[])
534 if (num_parms != 3) {
535 cprintf("%s BAD incorrect number of parameters\r\n",
541 cprintf("%s BAD Already logged in.\r\n", parms[0]);
545 if (!strcasecmp(parms[2], "LOGIN")) {
546 CtdlEncodeBase64(buf, "Username:", 9);
547 cprintf("+ %s\r\n", buf);
548 IMAP->authstate = imap_as_expecting_username;
549 strcpy(IMAP->authseq, parms[0]);
554 cprintf("%s NO AUTHENTICATE %s failed\r\n",
559 void imap_auth_login_user(char *cmd)
563 CtdlDecodeBase64(buf, cmd, SIZ);
564 CtdlLoginExistingUser(buf);
565 CtdlEncodeBase64(buf, "Password:", 9);
566 cprintf("+ %s\r\n", buf);
567 IMAP->authstate = imap_as_expecting_password;
571 void imap_auth_login_pass(char *cmd)
575 CtdlDecodeBase64(buf, cmd, SIZ);
576 if (CtdlTryPassword(buf) == pass_ok) {
577 cprintf("%s OK authentication succeeded\r\n",
580 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
582 IMAP->authstate = imap_as_normal;
588 * implements the STARTTLS command (Citadel API version)
591 void imap_starttls(int num_parms, char *parms[])
593 char ok_response[SIZ];
594 char nosup_response[SIZ];
595 char error_response[SIZ];
598 "%s OK begin TLS negotiation now\r\n",
600 sprintf(nosup_response,
601 "%s NO TLS not supported here\r\n",
603 sprintf(error_response,
604 "%s BAD Internal error\r\n",
606 CtdlStartTLS(ok_response, nosup_response, error_response);
612 * implements the SELECT command
614 void imap_select(int num_parms, char *parms[])
617 char augmented_roomname[ROOMNAMELEN];
621 struct ctdlroom QRscratch;
627 /* Convert the supplied folder name to a roomname */
628 i = imap_roomname(towhere, sizeof towhere, parms[2]);
630 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
634 floornum = (i & 0x00ff);
635 roomflags = (i & 0xff00);
637 /* First try a regular match */
638 c = getroom(&QRscratch, towhere);
640 /* Then try a mailbox name match */
642 MailboxName(augmented_roomname, sizeof augmented_roomname,
644 c = getroom(&QRscratch, augmented_roomname);
646 strcpy(towhere, augmented_roomname);
649 /* If the room exists, check security/access */
651 /* See if there is an existing user/room relationship */
652 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
654 /* normal clients have to pass through security */
660 /* Fail here if no such room */
662 cprintf("%s NO ... no such room, or access denied\r\n",
667 /* If we already had some other folder selected, auto-expunge it */
671 * usergoto() formally takes us to the desired room, happily returning
672 * the number of messages and number of new messages.
674 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
675 usergoto(NULL, 0, 0, &msgs, &new);
678 if (!strcasecmp(parms[1], "EXAMINE")) {
685 IMAP->last_mtime = CC->room.QRmtime;
687 cprintf("* %d EXISTS\r\n", msgs);
688 cprintf("* %d RECENT\r\n", new);
690 cprintf("* OK [UIDVALIDITY 1] UID validity status\r\n");
691 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
693 /* Note that \Deleted is a valid flag, but not a permanent flag,
694 * because we don't maintain its state across sessions. Citadel
695 * automatically expunges mailboxes when they are de-selected.
697 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
698 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] "
699 "permanent flags\r\n");
701 cprintf("%s OK [%s] %s completed\r\n",
703 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
709 * Does the real work for expunge.
711 int imap_do_expunge(void)
714 int num_expunged = 0;
715 long *delmsgs = NULL;
718 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
719 if (IMAP->selected == 0) {
723 if (IMAP->num_msgs > 0) {
724 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
725 for (i = 0; i < IMAP->num_msgs; ++i) {
726 if (IMAP->flags[i] & IMAP_DELETED) {
727 delmsgs[num_delmsgs++] = IMAP->msgids[i];
730 if (num_delmsgs > 0) {
731 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
733 num_expunged += num_delmsgs;
737 if (num_expunged > 0) {
738 imap_rescan_msgids();
741 lprintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
742 num_expunged, CC->room.QRname);
743 return (num_expunged);
748 * implements the EXPUNGE command syntax
750 void imap_expunge(int num_parms, char *parms[])
752 int num_expunged = 0;
754 num_expunged = imap_do_expunge();
755 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
760 * implements the CLOSE command
762 void imap_close(int num_parms, char *parms[])
765 /* Yes, we always expunge on close. */
766 if (IMAP->selected) {
773 cprintf("%s OK CLOSE completed\r\n", parms[0]);
778 * Implements the NAMESPACE command.
780 void imap_namespace(int num_parms, char *parms[])
787 cprintf("* NAMESPACE ");
789 /* All personal folders are subordinate to INBOX. */
790 cprintf("((\"INBOX/\" \"/\")) ");
792 /* Other users' folders ... coming soon! FIXME */
795 /* Show all floors as shared namespaces. Neato! */
797 for (i = 0; i < MAXFLOORS; ++i) {
799 if (fl->f_flags & F_INUSE) {
800 if (floors > 0) cprintf(" ");
802 sprintf(buf, "%s/", fl->f_name);
810 /* Wind it up with a newline and a completion message. */
812 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
818 * Used by LIST and LSUB to show the floors in the listing
820 void imap_list_floors(char *cmd, char *pattern)
825 for (i = 0; i < MAXFLOORS; ++i) {
827 if (fl->f_flags & F_INUSE) {
828 if (imap_mailbox_matches_pattern
829 (pattern, fl->f_name)) {
830 cprintf("* %s (\\NoSelect) \"/\" ", cmd);
831 imap_strout(fl->f_name);
841 * Back end for imap_lsub()
843 * IMAP "subscribed folder" is equivocated to Citadel "known rooms." This
844 * may or may not be the desired behavior in the future.
846 void imap_lsub_listroom(struct ctdlroom *qrbuf, void *data)
852 pattern = (char *) data;
854 /* Only list rooms to which the user has access!! */
855 CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
857 imap_mailboxname(buf, sizeof buf, qrbuf);
858 if (imap_mailbox_matches_pattern(pattern, buf)) {
859 cprintf("* LSUB () \"/\" ");
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 and LSUB commands
895 void imap_list(int num_parms, char *parms[])
898 int subscribed_rooms_only = 0;
903 cprintf("%s BAD arguments invalid\r\n", parms[0]);
907 /* parms[1] is the IMAP verb being used (e.g. LIST or LSUB)
908 * This tells us how to behave, and what verb to return back to the caller
910 safestrncpy(verb, parms[1], sizeof verb);
912 for (i=0; i<j; ++i) {
913 verb[i] = toupper(verb[i]);
916 if (!strcasecmp(verb, "LSUB")) {
917 subscribed_rooms_only = 1;
920 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
922 if (strlen(parms[3]) == 0) {
923 cprintf("* %s (\\Noselect) \"/\" \"\"\r\n", verb);
927 imap_list_floors(verb, pattern);
929 (subscribed_rooms_only ? imap_lsub_listroom : imap_list_listroom),
934 cprintf("%s OK %s completed\r\n", parms[0], verb);
940 * Implements the CREATE command
943 void imap_create(int num_parms, char *parms[])
946 char roomname[ROOMNAMELEN];
952 if (strchr(parms[2], '\\') != NULL) {
953 cprintf("%s NO Invalid character in folder name\r\n",
955 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
959 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
961 cprintf("%s NO Invalid mailbox name or location\r\n",
963 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
966 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
967 flags = (ret & 0xff00); /* upper 8 bits = flags */
969 if (flags & IR_MAILBOX) {
970 if (strncasecmp(parms[2], "INBOX/", 6)) {
971 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
972 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
977 if (flags & IR_MAILBOX) {
978 newroomtype = 4; /* private mailbox */
979 newroomview = VIEW_MAILBOX;
981 newroomtype = 0; /* public folder */
982 newroomview = VIEW_BBS;
985 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
986 roomname, floornum, newroomtype);
988 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
990 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
991 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
993 cprintf("%s OK CREATE completed\r\n", parms[0]);
995 lprintf(CTDL_DEBUG, "imap_create() completed\n");
1000 * Locate a room by its IMAP folder name, and check access to it.
1001 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1003 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
1006 char augmented_roomname[ROOMNAMELEN];
1007 char roomname[ROOMNAMELEN];
1009 struct ctdlroom QRscratch;
1013 ret = imap_roomname(roomname, sizeof roomname, foldername);
1018 /* First try a regular match */
1019 c = getroom(&QRscratch, roomname);
1021 /* Then try a mailbox name match */
1023 MailboxName(augmented_roomname, sizeof augmented_roomname,
1024 &CC->user, roomname);
1025 c = getroom(&QRscratch, augmented_roomname);
1027 strcpy(roomname, augmented_roomname);
1030 /* If the room exists, check security/access */
1032 /* See if there is an existing user/room relationship */
1033 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1035 /* normal clients have to pass through security */
1036 if (ra & UA_KNOWN) {
1039 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1044 /* Fail here if no such room */
1046 strcpy(returned_roomname, "");
1049 strcpy(returned_roomname, QRscratch.QRname);
1056 * Implements the STATUS command (sort of)
1059 void imap_status(int num_parms, char *parms[])
1062 char roomname[ROOMNAMELEN];
1064 char savedroom[ROOMNAMELEN];
1067 ret = imap_grabroom(roomname, parms[2], 0);
1070 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1076 * usergoto() formally takes us to the desired room, happily returning
1077 * the number of messages and number of new messages. (If another
1078 * folder is selected, save its name so we can return there!!!!!)
1080 if (IMAP->selected) {
1081 strcpy(savedroom, CC->room.QRname);
1083 usergoto(roomname, 0, 0, &msgs, &new);
1086 * Tell the client what it wants to know. In fact, tell it *more* than
1087 * it wants to know. We happily IGnore the supplied status data item
1088 * names and simply spew all possible data items. It's far easier to
1089 * code and probably saves us some processing time too.
1091 imap_mailboxname(buf, sizeof buf, &CC->room);
1092 cprintf("* STATUS ");
1094 cprintf(" (MESSAGES %d ", msgs);
1095 cprintf("RECENT %d ", new); /* Initially, new==recent */
1096 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1097 cprintf("UNSEEN %d)\r\n", new);
1100 * If another folder is selected, go back to that room so we can resume
1101 * our happy day without violent explosions.
1103 if (IMAP->selected) {
1104 usergoto(savedroom, 0, 0, &msgs, &new);
1108 * Oooh, look, we're done!
1110 cprintf("%s OK STATUS completed\r\n", parms[0]);
1116 * Implements the SUBSCRIBE command
1119 void imap_subscribe(int num_parms, char *parms[])
1122 char roomname[ROOMNAMELEN];
1123 char savedroom[ROOMNAMELEN];
1126 ret = imap_grabroom(roomname, parms[2], 1);
1129 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1137 * usergoto() formally takes us to the desired room, which has the side
1138 * effect of marking the room as not-zapped ... exactly the effect
1139 * we're looking for.
1141 if (IMAP->selected) {
1142 strcpy(savedroom, CC->room.QRname);
1144 usergoto(roomname, 0, 0, &msgs, &new);
1147 * If another folder is selected, go back to that room so we can resume
1148 * our happy day without violent explosions.
1150 if (IMAP->selected) {
1151 usergoto(savedroom, 0, 0, &msgs, &new);
1154 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1159 * Implements the UNSUBSCRIBE command
1162 void imap_unsubscribe(int num_parms, char *parms[])
1165 char roomname[ROOMNAMELEN];
1166 char savedroom[ROOMNAMELEN];
1169 ret = imap_grabroom(roomname, parms[2], 0);
1172 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1178 * usergoto() formally takes us to the desired room.
1180 if (IMAP->selected) {
1181 strcpy(savedroom, CC->room.QRname);
1183 usergoto(roomname, 0, 0, &msgs, &new);
1186 * Now make the API call to zap the room
1188 if (CtdlForgetThisRoom() == 0) {
1189 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1192 ("%s NO You may not unsubscribe from this folder.\r\n",
1197 * If another folder is selected, go back to that room so we can resume
1198 * our happy day without violent explosions.
1200 if (IMAP->selected) {
1201 usergoto(savedroom, 0, 0, &msgs, &new);
1208 * Implements the DELETE command
1211 void imap_delete(int num_parms, char *parms[])
1214 char roomname[ROOMNAMELEN];
1215 char savedroom[ROOMNAMELEN];
1218 ret = imap_grabroom(roomname, parms[2], 1);
1220 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1226 * usergoto() formally takes us to the desired room, happily returning
1227 * the number of messages and number of new messages. (If another
1228 * folder is selected, save its name so we can return there!!!!!)
1230 if (IMAP->selected) {
1231 strcpy(savedroom, CC->room.QRname);
1233 usergoto(roomname, 0, 0, &msgs, &new);
1236 * Now delete the room.
1238 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1239 schedule_room_for_deletion(&CC->room);
1240 cprintf("%s OK DELETE completed\r\n", parms[0]);
1242 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1246 * If another folder is selected, go back to that room so we can resume
1247 * our happy day without violent explosions.
1249 if (IMAP->selected) {
1250 usergoto(savedroom, 0, 0, &msgs, &new);
1256 * Back end function for imap_rename()
1258 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1260 char foldername[SIZ];
1261 char newfoldername[SIZ];
1262 char newroomname[ROOMNAMELEN];
1264 struct irl *irlp = NULL; /* scratch pointer */
1265 struct irlparms *irlparms;
1267 irlparms = (struct irlparms *) data;
1268 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1270 /* Rename subfolders */
1271 if ((!strncasecmp(foldername, irlparms->oldname,
1272 strlen(irlparms->oldname))
1273 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1275 sprintf(newfoldername, "%s/%s",
1277 &foldername[strlen(irlparms->oldname) + 1]
1280 newfloor = imap_roomname(newroomname,
1282 newfoldername) & 0xFF;
1284 irlp = (struct irl *) malloc(sizeof(struct irl));
1285 strcpy(irlp->irl_newroom, newroomname);
1286 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1287 irlp->irl_newfloor = newfloor;
1288 irlp->next = *(irlparms->irl);
1289 *(irlparms->irl) = irlp;
1295 * Implements the RENAME command
1298 void imap_rename(int num_parms, char *parms[])
1300 char old_room[ROOMNAMELEN];
1301 char new_room[ROOMNAMELEN];
1305 struct irl *irl = NULL; /* the list */
1306 struct irl *irlp = NULL; /* scratch pointer */
1307 struct irlparms irlparms;
1309 if (strchr(parms[3], '\\') != NULL) {
1310 cprintf("%s NO Invalid character in folder name\r\n",
1315 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1316 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1317 new_floor = (newr & 0xFF);
1319 r = CtdlRenameRoom(old_room, new_room, new_floor);
1321 if (r == crr_room_not_found) {
1322 cprintf("%s NO Could not locate this folder\r\n",
1326 if (r == crr_already_exists) {
1327 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1330 if (r == crr_noneditable) {
1331 cprintf("%s This folder is not editable.\r\n", parms[0]);
1334 if (r == crr_invalid_floor) {
1335 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1338 if (r == crr_access_denied) {
1339 cprintf("%s You do not have permission to edit "
1340 "this folder.\r\n", parms[0]);
1344 cprintf("%s NO Rename failed - undefined error %d\r\n",
1350 /* If this is the INBOX, then RFC2060 says we have to just move the
1351 * contents. In a Citadel environment it's easier to rename the room
1352 * (already did that) and create a new inbox.
1354 if (!strcasecmp(parms[2], "INBOX")) {
1355 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1358 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1360 irlparms.oldname = parms[2];
1361 irlparms.newname = parms[3];
1362 irlparms.irl = &irl;
1363 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1365 /* ... and now rename them. */
1366 while (irl != NULL) {
1367 r = CtdlRenameRoom(irl->irl_oldroom,
1371 /* FIXME handle error returns better */
1372 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1380 cprintf("%s OK RENAME completed\r\n", parms[0]);
1387 * Main command loop for IMAP sessions.
1389 void imap_command_loop(void)
1394 struct timeval tv1, tv2;
1395 suseconds_t total_time = 0;
1397 gettimeofday(&tv1, NULL);
1398 CC->lastcmd = time(NULL);
1399 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1401 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1402 lprintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1407 if (IMAP->authstate == imap_as_expecting_password) {
1408 lprintf(CTDL_INFO, "IMAP: <password>\n");
1410 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1411 lprintf(CTDL_INFO, "IMAP: LOGIN...\n");
1414 lprintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1417 while (strlen(cmdbuf) < 5)
1418 strcat(cmdbuf, " ");
1420 /* strip off l/t whitespace and CRLF */
1421 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1422 cmdbuf[strlen(cmdbuf) - 1] = 0;
1423 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1424 cmdbuf[strlen(cmdbuf) - 1] = 0;
1427 /* If we're in the middle of a multi-line command, handle that */
1428 if (IMAP->authstate == imap_as_expecting_username) {
1429 imap_auth_login_user(cmdbuf);
1432 if (IMAP->authstate == imap_as_expecting_password) {
1433 imap_auth_login_pass(cmdbuf);
1437 /* Ok, at this point we're in normal command mode. The first thing
1438 * we do is print any incoming pages (yeah! we really do!)
1440 imap_print_instant_messages();
1443 * Before processing the command that was just entered... if we happen
1444 * to have a folder selected, we'd like to rescan that folder for new
1445 * messages, and for deletions/changes of existing messages. This
1446 * could probably be optimized somehow, but IMAP sucks...
1448 if (IMAP->selected) {
1449 imap_rescan_msgids();
1452 /* Now for the command set. */
1454 /* Grab the tag, command, and parameters. Check syntax. */
1455 num_parms = imap_parameterize(parms, cmdbuf);
1456 if (num_parms < 2) {
1457 cprintf("BAD syntax error\r\n");
1460 /* The commands below may be executed in any state */
1462 else if ((!strcasecmp(parms[1], "NOOP"))
1463 || (!strcasecmp(parms[1], "CHECK"))) {
1464 cprintf("%s OK No operation\r\n",
1468 else if (!strcasecmp(parms[1], "ID")) {
1469 imap_id(num_parms, parms);
1473 else if (!strcasecmp(parms[1], "LOGOUT")) {
1474 if (IMAP->selected) {
1475 imap_do_expunge(); /* yes, we auto-expunge */
1477 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1478 cprintf("%s OK Citadel IMAP session ended.\r\n",
1484 else if (!strcasecmp(parms[1], "LOGIN")) {
1485 imap_login(num_parms, parms);
1488 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1489 imap_authenticate(num_parms, parms);
1492 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1493 imap_capability(num_parms, parms);
1496 else if (!strcasecmp(parms[1], "STARTTLS")) {
1497 imap_starttls(num_parms, parms);
1500 else if (!CC->logged_in) {
1501 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1504 /* The commans below require a logged-in state */
1506 else if (!strcasecmp(parms[1], "SELECT")) {
1507 imap_select(num_parms, parms);
1510 else if (!strcasecmp(parms[1], "EXAMINE")) {
1511 imap_select(num_parms, parms);
1514 else if (!strcasecmp(parms[1], "LSUB")) {
1515 imap_list(num_parms, parms);
1518 else if (!strcasecmp(parms[1], "LIST")) {
1519 imap_list(num_parms, parms);
1522 else if (!strcasecmp(parms[1], "CREATE")) {
1523 imap_create(num_parms, parms);
1526 else if (!strcasecmp(parms[1], "DELETE")) {
1527 imap_delete(num_parms, parms);
1530 else if (!strcasecmp(parms[1], "RENAME")) {
1531 imap_rename(num_parms, parms);
1534 else if (!strcasecmp(parms[1], "STATUS")) {
1535 imap_status(num_parms, parms);
1538 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1539 imap_subscribe(num_parms, parms);
1542 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1543 imap_unsubscribe(num_parms, parms);
1546 else if (!strcasecmp(parms[1], "APPEND")) {
1547 imap_append(num_parms, parms);
1550 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1551 imap_namespace(num_parms, parms);
1554 else if (!strcasecmp(parms[1], "SETACL")) {
1555 imap_setacl(num_parms, parms);
1558 else if (!strcasecmp(parms[1], "DELETEACL")) {
1559 imap_deleteacl(num_parms, parms);
1562 else if (!strcasecmp(parms[1], "GETACL")) {
1563 imap_getacl(num_parms, parms);
1566 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1567 imap_listrights(num_parms, parms);
1570 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1571 imap_myrights(num_parms, parms);
1574 else if (IMAP->selected == 0) {
1575 cprintf("%s BAD no folder selected\r\n", parms[0]);
1578 /* The commands below require the SELECT state on a mailbox */
1580 else if (!strcasecmp(parms[1], "FETCH")) {
1581 imap_fetch(num_parms, parms);
1584 else if ((!strcasecmp(parms[1], "UID"))
1585 && (!strcasecmp(parms[2], "FETCH"))) {
1586 imap_uidfetch(num_parms, parms);
1589 else if (!strcasecmp(parms[1], "SEARCH")) {
1590 imap_search(num_parms, parms);
1593 else if ((!strcasecmp(parms[1], "UID"))
1594 && (!strcasecmp(parms[2], "SEARCH"))) {
1595 imap_uidsearch(num_parms, parms);
1598 else if (!strcasecmp(parms[1], "STORE")) {
1599 imap_store(num_parms, parms);
1602 else if ((!strcasecmp(parms[1], "UID"))
1603 && (!strcasecmp(parms[2], "STORE"))) {
1604 imap_uidstore(num_parms, parms);
1607 else if (!strcasecmp(parms[1], "COPY")) {
1608 imap_copy(num_parms, parms);
1611 else if ((!strcasecmp(parms[1], "UID"))
1612 && (!strcasecmp(parms[2], "COPY"))) {
1613 imap_uidcopy(num_parms, parms);
1616 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1617 imap_expunge(num_parms, parms);
1620 else if (!strcasecmp(parms[1], "CLOSE")) {
1621 imap_close(num_parms, parms);
1624 /* End of commands. If we get here, the command is either invalid
1629 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1632 /* If the client transmitted a message we can free it now */
1633 imap_free_transmitted_message();
1635 gettimeofday(&tv2, NULL);
1636 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1637 lprintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1638 (total_time / 1000000),
1639 (total_time % 1000000)
1645 * This function is called to register the IMAP extension with Citadel.
1647 char *serv_imap_init(void)
1649 CtdlRegisterServiceHook(config.c_imap_port,
1650 NULL, imap_greeting, imap_command_loop, NULL);
1652 CtdlRegisterServiceHook(config.c_imaps_port,
1653 NULL, imaps_greeting, imap_command_loop, NULL);
1655 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);