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_list.h"
55 #include "imap_fetch.h"
56 #include "imap_search.h"
57 #include "imap_store.h"
59 #include "imap_metadata.h"
60 #include "imap_misc.h"
63 #include "serv_crypto.h"
66 /* imap_rename() uses this struct containing list of rooms to rename */
69 char irl_oldroom[ROOMNAMELEN];
70 char irl_newroom[ROOMNAMELEN];
74 /* Data which is passed between imap_rename() and imap_rename_backend() */
83 * If there is a message ID map in memory, free it
85 void imap_free_msgids(void)
87 if (IMAP->msgids != NULL) {
93 if (IMAP->flags != NULL) {
97 IMAP->last_mtime = (-1);
102 * If there is a transmitted message in memory, free it
104 void imap_free_transmitted_message(void)
106 if (IMAP->transmitted_message != NULL) {
107 free(IMAP->transmitted_message);
108 IMAP->transmitted_message = NULL;
109 IMAP->transmitted_length = 0;
115 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
116 * sets stored in the visit record for this user/room. Note that we have
117 * to parse each sequence set manually here, because calling the utility
118 * function is_msg_in_sequence_set() over and over again is too expensive.
120 * first_msg should be set to 0 to rescan the flags for every message in the
121 * room, or some other value if we're only interested in an incremental
124 void imap_set_seen_flags(int first_msg)
130 char setstr[64], lostr[64], histr[64];
133 if (IMAP->num_msgs < 1) return;
134 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
136 for (i = first_msg; i < IMAP->num_msgs; ++i) {
137 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
138 IMAP->flags[i] |= IMAP_RECENT;
139 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
143 * Do the "\Seen" flag.
144 * (Any message not "\Seen" is considered "\Recent".)
146 num_sets = num_tokens(vbuf.v_seen, ',');
147 for (s=0; s<num_sets; ++s) {
148 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
150 extract_token(lostr, setstr, 0, ':', sizeof lostr);
151 if (num_tokens(setstr, ':') >= 2) {
152 extract_token(histr, setstr, 1, ':', sizeof histr);
153 if (!strcmp(histr, "*")) {
154 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
158 strcpy(histr, lostr);
163 for (i = first_msg; i < IMAP->num_msgs; ++i) {
164 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
165 IMAP->flags[i] |= IMAP_SEEN;
166 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
171 /* Do the ANSWERED flag */
172 num_sets = num_tokens(vbuf.v_answered, ',');
173 for (s=0; s<num_sets; ++s) {
174 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
176 extract_token(lostr, setstr, 0, ':', sizeof lostr);
177 if (num_tokens(setstr, ':') >= 2) {
178 extract_token(histr, setstr, 1, ':', sizeof histr);
179 if (!strcmp(histr, "*")) {
180 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
184 strcpy(histr, lostr);
189 for (i = first_msg; i < IMAP->num_msgs; ++i) {
190 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
191 IMAP->flags[i] |= IMAP_ANSWERED;
201 * Back end for imap_load_msgids()
203 * Optimization: instead of calling realloc() to add each message, we
204 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
205 * allows the mapping to proceed much faster.
207 void imap_add_single_msgid(long msgnum, void *userdata)
211 if (IMAP->num_msgs > IMAP->num_alloc) {
212 IMAP->num_alloc += REALLOC_INCREMENT;
213 IMAP->msgids = realloc(IMAP->msgids,
214 (IMAP->num_alloc * sizeof(long)) );
215 IMAP->flags = realloc(IMAP->flags,
216 (IMAP->num_alloc * sizeof(long)) );
218 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
219 IMAP->flags[IMAP->num_msgs - 1] = 0;
225 * Set up a message ID map for the current room (folder)
227 void imap_load_msgids(void)
229 struct cdbdata *cdbfr;
231 if (IMAP->selected == 0) {
233 "imap_load_msgids() can't run; no room selected\n");
237 imap_free_msgids(); /* If there was already a map, free it */
239 /* Load the message list */
240 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
242 IMAP->msgids = malloc(cdbfr->len);
243 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
244 IMAP->num_msgs = cdbfr->len / sizeof(long);
245 IMAP->num_alloc = cdbfr->len / sizeof(long);
249 if (IMAP->num_msgs) {
250 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
251 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
254 imap_set_seen_flags(0);
259 * Re-scan the selected room (folder) and see if it's been changed at all
261 void imap_rescan_msgids(void)
264 int original_num_msgs = 0;
265 long original_highest = 0L;
267 int message_still_exists;
268 struct cdbdata *cdbfr;
269 long *msglist = NULL;
273 if (IMAP->selected == 0) {
275 "imap_load_msgids() can't run; no room selected\n");
280 * Check to see if the room's contents have changed.
281 * If not, we can avoid this rescan.
283 getroom(&CC->room, CC->room.QRname);
284 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
288 /* Load the *current* message list from disk, so we can compare it
289 * to what we have in memory.
291 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
293 msglist = malloc(cdbfr->len);
294 if (msglist == NULL) {
295 lprintf(CTDL_CRIT, "malloc() failed\n");
298 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
299 num_msgs = cdbfr->len / sizeof(long);
306 * Check to see if any of the messages we know about have been expunged
308 if (IMAP->num_msgs > 0) {
310 for (i = 0; i < IMAP->num_msgs; ++i) {
312 message_still_exists = 0;
314 for (j = jstart; j < num_msgs; ++j) {
315 if (msglist[j] == IMAP->msgids[i]) {
316 message_still_exists = 1;
323 if (message_still_exists == 0) {
324 cprintf("* %d EXPUNGE\r\n", i + 1);
326 /* Here's some nice stupid nonsense. When a
327 * message is expunged, we have to slide all
328 * the existing messages up in the message
332 memcpy(&IMAP->msgids[i],
333 &IMAP->msgids[i + 1],
335 (IMAP->num_msgs - i)));
336 memcpy(&IMAP->flags[i],
339 (IMAP->num_msgs - i)));
348 * Remember how many messages were here before we re-scanned.
350 original_num_msgs = IMAP->num_msgs;
351 if (IMAP->num_msgs > 0) {
352 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
354 original_highest = 0L;
358 * Now peruse the room for *new* messages only.
361 for (j = 0; j < num_msgs; ++j) {
362 if (msglist[j] > original_highest) {
363 imap_add_single_msgid(msglist[j], NULL);
367 imap_set_seen_flags(original_num_msgs);
370 * If new messages have arrived, tell the client about them.
372 if (IMAP->num_msgs > original_num_msgs) {
374 for (j = 0; j < num_msgs; ++j) {
375 if (IMAP->flags[j] & IMAP_RECENT) {
380 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
381 cprintf("* %d RECENT\r\n", num_recent);
387 IMAP->last_mtime = CC->room.QRmtime;
397 * This cleanup function blows away the temporary memory and files used by
400 void imap_cleanup_function(void)
403 /* Don't do this stuff if this is not a IMAP session! */
404 if (CC->h_command_function != imap_command_loop)
407 /* If there is a mailbox selected, auto-expunge it. */
408 if (IMAP->selected) {
412 lprintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
414 imap_free_transmitted_message();
416 if (IMAP->cached_rfc822_data != NULL) {
417 free(IMAP->cached_rfc822_data);
418 IMAP->cached_rfc822_data = NULL;
419 IMAP->cached_rfc822_msgnum = (-1);
420 IMAP->cached_rfc822_withbody = 0;
423 if (IMAP->cached_body != NULL) {
424 free(IMAP->cached_body);
425 IMAP->cached_body = NULL;
426 IMAP->cached_body_len = 0;
427 IMAP->cached_bodymsgnum = (-1);
431 lprintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
436 * Does the actual work of the CAPABILITY command (because we need to
437 * output this stuff in other places as well)
439 void imap_output_capability_string(void) {
440 cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID ACL AUTH=PLAIN AUTH=LOGIN");
443 if (!CC->redirect_ssl) cprintf(" STARTTLS");
446 /* We are building a partial implementation of METADATA for the sole purpose
447 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
448 * If you were expecting something else, comment out one or both of these
449 * extension advertisements.
451 cprintf(" METADATA");
452 /* cprintf(" LIST-EXTENDED"); */
456 * implements the CAPABILITY command
458 void imap_capability(int num_parms, char *parms[])
461 imap_output_capability_string();
463 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
469 * Implements the ID command (specified by RFC2971)
471 * We ignore the client-supplied information, and output a NIL response.
472 * Although this is technically a valid implementation of the extension, it
473 * is quite useless. It exists only so that we may see which clients are
474 * making use of this extension.
477 void imap_id(int num_parms, char *parms[])
479 cprintf("* ID NIL\r\n");
480 cprintf("%s OK ID completed\r\n", parms[0]);
486 * Here's where our IMAP session begins its happy day.
488 void imap_greeting(void)
491 strcpy(CC->cs_clientname, "IMAP session");
492 IMAP = malloc(sizeof (struct citimap));
493 memset(IMAP, 0, sizeof(struct citimap));
494 IMAP->authstate = imap_as_normal;
495 IMAP->cached_rfc822_data = NULL;
496 IMAP->cached_rfc822_msgnum = (-1);
497 IMAP->cached_rfc822_withbody = 0;
500 imap_output_capability_string();
501 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
505 * IMAPS is just like IMAP, except it goes crypto right away.
508 void imaps_greeting(void) {
509 CtdlStartTLS(NULL, NULL, NULL);
516 * implements the LOGIN command (ordinary username/password login)
518 void imap_login(int num_parms, char *parms[])
520 if (num_parms != 4) {
521 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
525 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
526 if (CtdlTryPassword(parms[3]) == pass_ok) {
527 cprintf("%s OK [", parms[0]);
528 imap_output_capability_string();
529 cprintf("] Hello, %s\r\n", CC->user.fullname);
534 cprintf("%s BAD Login incorrect\r\n", parms[0]);
539 * Implements the AUTHENTICATE command
541 void imap_authenticate(int num_parms, char *parms[])
545 if (num_parms != 3) {
546 cprintf("%s BAD incorrect number of parameters\r\n",
552 cprintf("%s BAD Already logged in.\r\n", parms[0]);
556 if (!strcasecmp(parms[2], "LOGIN")) {
557 CtdlEncodeBase64(buf, "Username:", 9);
558 cprintf("+ %s\r\n", buf);
559 IMAP->authstate = imap_as_expecting_username;
560 strcpy(IMAP->authseq, parms[0]);
564 if (!strcasecmp(parms[2], "PLAIN")) {
565 // CtdlEncodeBase64(buf, "Username:", 9);
566 // cprintf("+ %s\r\n", buf);
568 IMAP->authstate = imap_as_expecting_plainauth;
569 strcpy(IMAP->authseq, parms[0]);
574 cprintf("%s NO AUTHENTICATE %s failed\r\n",
579 void imap_auth_plain(char *cmd)
581 char decoded_authstring[1024];
587 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
588 safestrncpy(ident, decoded_authstring, sizeof ident);
589 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
590 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
592 IMAP->authstate = imap_as_normal;
594 if (strlen(ident) > 0) {
595 result = CtdlLoginExistingUser(user, ident);
598 result = CtdlLoginExistingUser(NULL, user);
601 if (result == login_ok) {
602 if (CtdlTryPassword(pass) == pass_ok) {
603 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
607 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
610 void imap_auth_login_user(char *cmd)
614 CtdlDecodeBase64(buf, cmd, SIZ);
615 CtdlLoginExistingUser(NULL, buf);
616 CtdlEncodeBase64(buf, "Password:", 9);
617 cprintf("+ %s\r\n", buf);
618 IMAP->authstate = imap_as_expecting_password;
622 void imap_auth_login_pass(char *cmd)
626 CtdlDecodeBase64(buf, cmd, SIZ);
627 if (CtdlTryPassword(buf) == pass_ok) {
628 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
630 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
632 IMAP->authstate = imap_as_normal;
638 * implements the STARTTLS command (Citadel API version)
641 void imap_starttls(int num_parms, char *parms[])
643 char ok_response[SIZ];
644 char nosup_response[SIZ];
645 char error_response[SIZ];
648 "%s OK begin TLS negotiation now\r\n",
650 sprintf(nosup_response,
651 "%s NO TLS not supported here\r\n",
653 sprintf(error_response,
654 "%s BAD Internal error\r\n",
656 CtdlStartTLS(ok_response, nosup_response, error_response);
662 * implements the SELECT command
664 void imap_select(int num_parms, char *parms[])
667 char augmented_roomname[ROOMNAMELEN];
671 struct ctdlroom QRscratch;
677 /* Convert the supplied folder name to a roomname */
678 i = imap_roomname(towhere, sizeof towhere, parms[2]);
680 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
684 floornum = (i & 0x00ff);
685 roomflags = (i & 0xff00);
687 /* First try a regular match */
688 c = getroom(&QRscratch, towhere);
690 /* Then try a mailbox name match */
692 MailboxName(augmented_roomname, sizeof augmented_roomname,
694 c = getroom(&QRscratch, augmented_roomname);
696 strcpy(towhere, augmented_roomname);
699 /* If the room exists, check security/access */
701 /* See if there is an existing user/room relationship */
702 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
704 /* normal clients have to pass through security */
710 /* Fail here if no such room */
712 cprintf("%s NO ... no such room, or access denied\r\n",
717 /* If we already had some other folder selected, auto-expunge it */
721 * usergoto() formally takes us to the desired room, happily returning
722 * the number of messages and number of new messages.
724 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
725 usergoto(NULL, 0, 0, &msgs, &new);
728 if (!strcasecmp(parms[1], "EXAMINE")) {
735 IMAP->last_mtime = CC->room.QRmtime;
737 cprintf("* %d EXISTS\r\n", msgs);
738 cprintf("* %d RECENT\r\n", new);
740 cprintf("* OK [UIDVALIDITY 1] UID validity status\r\n");
741 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
743 /* Note that \Deleted is a valid flag, but not a permanent flag,
744 * because we don't maintain its state across sessions. Citadel
745 * automatically expunges mailboxes when they are de-selected.
747 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
748 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] "
749 "permanent flags\r\n");
751 cprintf("%s OK [%s] %s completed\r\n",
753 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
759 * Does the real work for expunge.
761 int imap_do_expunge(void)
764 int num_expunged = 0;
765 long *delmsgs = NULL;
768 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
769 if (IMAP->selected == 0) {
773 if (IMAP->num_msgs > 0) {
774 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
775 for (i = 0; i < IMAP->num_msgs; ++i) {
776 if (IMAP->flags[i] & IMAP_DELETED) {
777 delmsgs[num_delmsgs++] = IMAP->msgids[i];
780 if (num_delmsgs > 0) {
781 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
783 num_expunged += num_delmsgs;
787 if (num_expunged > 0) {
788 imap_rescan_msgids();
791 lprintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
792 num_expunged, CC->room.QRname);
793 return (num_expunged);
798 * implements the EXPUNGE command syntax
800 void imap_expunge(int num_parms, char *parms[])
802 int num_expunged = 0;
804 num_expunged = imap_do_expunge();
805 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
810 * implements the CLOSE command
812 void imap_close(int num_parms, char *parms[])
815 /* Yes, we always expunge on close. */
816 if (IMAP->selected) {
823 cprintf("%s OK CLOSE completed\r\n", parms[0]);
828 * Implements the NAMESPACE command.
830 void imap_namespace(int num_parms, char *parms[])
837 cprintf("* NAMESPACE ");
839 /* All personal folders are subordinate to INBOX. */
840 cprintf("((\"INBOX/\" \"/\")) ");
842 /* Other users' folders ... coming soon! FIXME */
845 /* Show all floors as shared namespaces. Neato! */
847 for (i = 0; i < MAXFLOORS; ++i) {
849 if (fl->f_flags & F_INUSE) {
850 if (floors > 0) cprintf(" ");
852 sprintf(buf, "%s/", fl->f_name);
860 /* Wind it up with a newline and a completion message. */
862 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
868 * Implements the CREATE command
871 void imap_create(int num_parms, char *parms[])
874 char roomname[ROOMNAMELEN];
880 if (strchr(parms[2], '\\') != NULL) {
881 cprintf("%s NO Invalid character in folder name\r\n",
883 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
887 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
889 cprintf("%s NO Invalid mailbox name or location\r\n",
891 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
894 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
895 flags = (ret & 0xff00); /* upper 8 bits = flags */
897 if (flags & IR_MAILBOX) {
898 if (strncasecmp(parms[2], "INBOX/", 6)) {
899 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
900 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
905 if (flags & IR_MAILBOX) {
906 newroomtype = 4; /* private mailbox */
907 newroomview = VIEW_MAILBOX;
909 newroomtype = 0; /* public folder */
910 newroomview = VIEW_BBS;
913 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
914 roomname, floornum, newroomtype);
916 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
918 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
919 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
921 cprintf("%s OK CREATE completed\r\n", parms[0]);
923 lprintf(CTDL_DEBUG, "imap_create() completed\n");
928 * Locate a room by its IMAP folder name, and check access to it.
929 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
931 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
934 char augmented_roomname[ROOMNAMELEN];
935 char roomname[ROOMNAMELEN];
937 struct ctdlroom QRscratch;
941 ret = imap_roomname(roomname, sizeof roomname, foldername);
946 /* First try a regular match */
947 c = getroom(&QRscratch, roomname);
949 /* Then try a mailbox name match */
951 MailboxName(augmented_roomname, sizeof augmented_roomname,
952 &CC->user, roomname);
953 c = getroom(&QRscratch, augmented_roomname);
955 strcpy(roomname, augmented_roomname);
958 /* If the room exists, check security/access */
960 /* See if there is an existing user/room relationship */
961 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
963 /* normal clients have to pass through security */
967 if ((zapped_ok) && (ra & UA_ZAPPED)) {
972 /* Fail here if no such room */
974 strcpy(returned_roomname, "");
977 strcpy(returned_roomname, QRscratch.QRname);
984 * Implements the STATUS command (sort of)
987 void imap_status(int num_parms, char *parms[])
990 char roomname[ROOMNAMELEN];
992 char savedroom[ROOMNAMELEN];
995 ret = imap_grabroom(roomname, parms[2], 0);
998 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1004 * usergoto() formally takes us to the desired room, happily returning
1005 * the number of messages and number of new messages. (If another
1006 * folder is selected, save its name so we can return there!!!!!)
1008 if (IMAP->selected) {
1009 strcpy(savedroom, CC->room.QRname);
1011 usergoto(roomname, 0, 0, &msgs, &new);
1014 * Tell the client what it wants to know. In fact, tell it *more* than
1015 * it wants to know. We happily IGnore the supplied status data item
1016 * names and simply spew all possible data items. It's far easier to
1017 * code and probably saves us some processing time too.
1019 imap_mailboxname(buf, sizeof buf, &CC->room);
1020 cprintf("* STATUS ");
1022 cprintf(" (MESSAGES %d ", msgs);
1023 cprintf("RECENT %d ", new); /* Initially, new==recent */
1024 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1025 cprintf("UNSEEN %d)\r\n", new);
1028 * If another folder is selected, go back to that room so we can resume
1029 * our happy day without violent explosions.
1031 if (IMAP->selected) {
1032 usergoto(savedroom, 0, 0, &msgs, &new);
1036 * Oooh, look, we're done!
1038 cprintf("%s OK STATUS completed\r\n", parms[0]);
1044 * Implements the SUBSCRIBE command
1047 void imap_subscribe(int num_parms, char *parms[])
1050 char roomname[ROOMNAMELEN];
1051 char savedroom[ROOMNAMELEN];
1054 ret = imap_grabroom(roomname, parms[2], 1);
1057 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1065 * usergoto() formally takes us to the desired room, which has the side
1066 * effect of marking the room as not-zapped ... exactly the effect
1067 * we're looking for.
1069 if (IMAP->selected) {
1070 strcpy(savedroom, CC->room.QRname);
1072 usergoto(roomname, 0, 0, &msgs, &new);
1075 * If another folder is selected, go back to that room so we can resume
1076 * our happy day without violent explosions.
1078 if (IMAP->selected) {
1079 usergoto(savedroom, 0, 0, &msgs, &new);
1082 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1087 * Implements the UNSUBSCRIBE command
1090 void imap_unsubscribe(int num_parms, char *parms[])
1093 char roomname[ROOMNAMELEN];
1094 char savedroom[ROOMNAMELEN];
1097 ret = imap_grabroom(roomname, parms[2], 0);
1100 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1106 * usergoto() formally takes us to the desired room.
1108 if (IMAP->selected) {
1109 strcpy(savedroom, CC->room.QRname);
1111 usergoto(roomname, 0, 0, &msgs, &new);
1114 * Now make the API call to zap the room
1116 if (CtdlForgetThisRoom() == 0) {
1117 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1120 ("%s NO You may not unsubscribe from this folder.\r\n",
1125 * If another folder is selected, go back to that room so we can resume
1126 * our happy day without violent explosions.
1128 if (IMAP->selected) {
1129 usergoto(savedroom, 0, 0, &msgs, &new);
1136 * Implements the DELETE command
1139 void imap_delete(int num_parms, char *parms[])
1142 char roomname[ROOMNAMELEN];
1143 char savedroom[ROOMNAMELEN];
1146 ret = imap_grabroom(roomname, parms[2], 1);
1148 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1154 * usergoto() formally takes us to the desired room, happily returning
1155 * the number of messages and number of new messages. (If another
1156 * folder is selected, save its name so we can return there!!!!!)
1158 if (IMAP->selected) {
1159 strcpy(savedroom, CC->room.QRname);
1161 usergoto(roomname, 0, 0, &msgs, &new);
1164 * Now delete the room.
1166 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1167 schedule_room_for_deletion(&CC->room);
1168 cprintf("%s OK DELETE completed\r\n", parms[0]);
1170 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1174 * If another folder is selected, go back to that room so we can resume
1175 * our happy day without violent explosions.
1177 if (IMAP->selected) {
1178 usergoto(savedroom, 0, 0, &msgs, &new);
1184 * Back end function for imap_rename()
1186 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1188 char foldername[SIZ];
1189 char newfoldername[SIZ];
1190 char newroomname[ROOMNAMELEN];
1192 struct irl *irlp = NULL; /* scratch pointer */
1193 struct irlparms *irlparms;
1195 irlparms = (struct irlparms *) data;
1196 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1198 /* Rename subfolders */
1199 if ((!strncasecmp(foldername, irlparms->oldname,
1200 strlen(irlparms->oldname))
1201 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1203 sprintf(newfoldername, "%s/%s",
1205 &foldername[strlen(irlparms->oldname) + 1]
1208 newfloor = imap_roomname(newroomname,
1210 newfoldername) & 0xFF;
1212 irlp = (struct irl *) malloc(sizeof(struct irl));
1213 strcpy(irlp->irl_newroom, newroomname);
1214 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1215 irlp->irl_newfloor = newfloor;
1216 irlp->next = *(irlparms->irl);
1217 *(irlparms->irl) = irlp;
1223 * Implements the RENAME command
1226 void imap_rename(int num_parms, char *parms[])
1228 char old_room[ROOMNAMELEN];
1229 char new_room[ROOMNAMELEN];
1233 struct irl *irl = NULL; /* the list */
1234 struct irl *irlp = NULL; /* scratch pointer */
1235 struct irlparms irlparms;
1237 if (strchr(parms[3], '\\') != NULL) {
1238 cprintf("%s NO Invalid character in folder name\r\n",
1243 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1244 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1245 new_floor = (newr & 0xFF);
1247 r = CtdlRenameRoom(old_room, new_room, new_floor);
1249 if (r == crr_room_not_found) {
1250 cprintf("%s NO Could not locate this folder\r\n",
1254 if (r == crr_already_exists) {
1255 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1258 if (r == crr_noneditable) {
1259 cprintf("%s This folder is not editable.\r\n", parms[0]);
1262 if (r == crr_invalid_floor) {
1263 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1266 if (r == crr_access_denied) {
1267 cprintf("%s You do not have permission to edit "
1268 "this folder.\r\n", parms[0]);
1272 cprintf("%s NO Rename failed - undefined error %d\r\n",
1278 /* If this is the INBOX, then RFC2060 says we have to just move the
1279 * contents. In a Citadel environment it's easier to rename the room
1280 * (already did that) and create a new inbox.
1282 if (!strcasecmp(parms[2], "INBOX")) {
1283 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1286 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1288 irlparms.oldname = parms[2];
1289 irlparms.newname = parms[3];
1290 irlparms.irl = &irl;
1291 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1293 /* ... and now rename them. */
1294 while (irl != NULL) {
1295 r = CtdlRenameRoom(irl->irl_oldroom,
1299 /* FIXME handle error returns better */
1300 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1308 cprintf("%s OK RENAME completed\r\n", parms[0]);
1315 * Main command loop for IMAP sessions.
1317 void imap_command_loop(void)
1322 struct timeval tv1, tv2;
1323 suseconds_t total_time = 0;
1325 gettimeofday(&tv1, NULL);
1326 CC->lastcmd = time(NULL);
1327 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1329 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1330 lprintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1335 if (IMAP->authstate == imap_as_expecting_password) {
1336 lprintf(CTDL_INFO, "IMAP: <password>\n");
1338 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1339 lprintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1341 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1342 lprintf(CTDL_INFO, "IMAP: LOGIN...\n");
1345 lprintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1348 while (strlen(cmdbuf) < 5)
1349 strcat(cmdbuf, " ");
1351 /* strip off l/t whitespace and CRLF */
1352 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1353 cmdbuf[strlen(cmdbuf) - 1] = 0;
1354 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1355 cmdbuf[strlen(cmdbuf) - 1] = 0;
1358 /* If we're in the middle of a multi-line command, handle that */
1359 if (IMAP->authstate == imap_as_expecting_username) {
1360 imap_auth_login_user(cmdbuf);
1363 if (IMAP->authstate == imap_as_expecting_plainauth) {
1364 imap_auth_plain(cmdbuf);
1367 if (IMAP->authstate == imap_as_expecting_password) {
1368 imap_auth_login_pass(cmdbuf);
1372 /* Ok, at this point we're in normal command mode. The first thing
1373 * we do is print any incoming pages (yeah! we really do!)
1375 imap_print_instant_messages();
1378 * Before processing the command that was just entered... if we happen
1379 * to have a folder selected, we'd like to rescan that folder for new
1380 * messages, and for deletions/changes of existing messages. This
1381 * could probably be optimized somehow, but IMAP sucks...
1383 if (IMAP->selected) {
1384 imap_rescan_msgids();
1387 /* Now for the command set. */
1389 /* Grab the tag, command, and parameters. Check syntax. */
1390 num_parms = imap_parameterize(parms, cmdbuf);
1391 if (num_parms < 2) {
1392 cprintf("BAD syntax error\r\n");
1395 /* The commands below may be executed in any state */
1397 else if ((!strcasecmp(parms[1], "NOOP"))
1398 || (!strcasecmp(parms[1], "CHECK"))) {
1399 cprintf("%s OK No operation\r\n",
1403 else if (!strcasecmp(parms[1], "ID")) {
1404 imap_id(num_parms, parms);
1408 else if (!strcasecmp(parms[1], "LOGOUT")) {
1409 if (IMAP->selected) {
1410 imap_do_expunge(); /* yes, we auto-expunge */
1412 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1413 cprintf("%s OK Citadel IMAP session ended.\r\n",
1419 else if (!strcasecmp(parms[1], "LOGIN")) {
1420 imap_login(num_parms, parms);
1423 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1424 imap_authenticate(num_parms, parms);
1427 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1428 imap_capability(num_parms, parms);
1431 else if (!strcasecmp(parms[1], "STARTTLS")) {
1432 imap_starttls(num_parms, parms);
1435 else if (!CC->logged_in) {
1436 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1439 /* The commans below require a logged-in state */
1441 else if (!strcasecmp(parms[1], "SELECT")) {
1442 imap_select(num_parms, parms);
1445 else if (!strcasecmp(parms[1], "EXAMINE")) {
1446 imap_select(num_parms, parms);
1449 else if (!strcasecmp(parms[1], "LSUB")) {
1450 imap_list(num_parms, parms);
1453 else if (!strcasecmp(parms[1], "LIST")) {
1454 imap_list(num_parms, parms);
1457 else if (!strcasecmp(parms[1], "CREATE")) {
1458 imap_create(num_parms, parms);
1461 else if (!strcasecmp(parms[1], "DELETE")) {
1462 imap_delete(num_parms, parms);
1465 else if (!strcasecmp(parms[1], "RENAME")) {
1466 imap_rename(num_parms, parms);
1469 else if (!strcasecmp(parms[1], "STATUS")) {
1470 imap_status(num_parms, parms);
1473 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1474 imap_subscribe(num_parms, parms);
1477 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1478 imap_unsubscribe(num_parms, parms);
1481 else if (!strcasecmp(parms[1], "APPEND")) {
1482 imap_append(num_parms, parms);
1485 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1486 imap_namespace(num_parms, parms);
1489 else if (!strcasecmp(parms[1], "SETACL")) {
1490 imap_setacl(num_parms, parms);
1493 else if (!strcasecmp(parms[1], "DELETEACL")) {
1494 imap_deleteacl(num_parms, parms);
1497 else if (!strcasecmp(parms[1], "GETACL")) {
1498 imap_getacl(num_parms, parms);
1501 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1502 imap_listrights(num_parms, parms);
1505 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1506 imap_myrights(num_parms, parms);
1509 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1510 imap_getmetadata(num_parms, parms);
1513 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1514 imap_setmetadata(num_parms, parms);
1517 else if (IMAP->selected == 0) {
1518 cprintf("%s BAD no folder selected\r\n", parms[0]);
1521 /* The commands below require the SELECT state on a mailbox */
1523 else if (!strcasecmp(parms[1], "FETCH")) {
1524 imap_fetch(num_parms, parms);
1527 else if ((!strcasecmp(parms[1], "UID"))
1528 && (!strcasecmp(parms[2], "FETCH"))) {
1529 imap_uidfetch(num_parms, parms);
1532 else if (!strcasecmp(parms[1], "SEARCH")) {
1533 imap_search(num_parms, parms);
1536 else if ((!strcasecmp(parms[1], "UID"))
1537 && (!strcasecmp(parms[2], "SEARCH"))) {
1538 imap_uidsearch(num_parms, parms);
1541 else if (!strcasecmp(parms[1], "STORE")) {
1542 imap_store(num_parms, parms);
1545 else if ((!strcasecmp(parms[1], "UID"))
1546 && (!strcasecmp(parms[2], "STORE"))) {
1547 imap_uidstore(num_parms, parms);
1550 else if (!strcasecmp(parms[1], "COPY")) {
1551 imap_copy(num_parms, parms);
1554 else if ((!strcasecmp(parms[1], "UID"))
1555 && (!strcasecmp(parms[2], "COPY"))) {
1556 imap_uidcopy(num_parms, parms);
1559 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1560 imap_expunge(num_parms, parms);
1563 else if (!strcasecmp(parms[1], "CLOSE")) {
1564 imap_close(num_parms, parms);
1567 /* End of commands. If we get here, the command is either invalid
1572 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1575 /* If the client transmitted a message we can free it now */
1576 imap_free_transmitted_message();
1578 gettimeofday(&tv2, NULL);
1579 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1580 lprintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1581 (total_time / 1000000),
1582 (total_time % 1000000)
1588 * This function is called to register the IMAP extension with Citadel.
1590 char *serv_imap_init(void)
1592 CtdlRegisterServiceHook(config.c_imap_port,
1593 NULL, imap_greeting, imap_command_loop, NULL);
1595 CtdlRegisterServiceHook(config.c_imaps_port,
1596 NULL, imaps_greeting, imap_command_loop, NULL);
1598 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1600 /* return our Subversion id for the Log */