4 * IMAP server for the Citadel system
5 * Copyright (C) 2000-2007 by Art Cancro and others.
6 * This code is released under the terms of the GNU General Public License.
8 * WARNING: the IMAP protocol is badly designed. No implementation of it
9 * is perfect. Indeed, with so much gratuitous complexity, *all* IMAP
10 * implementations have bugs.
21 #include <sys/types.h>
23 #if TIME_WITH_SYS_TIME
24 # include <sys/time.h>
28 # include <sys/time.h>
38 #include <libcitadel.h>
41 #include "citserver.h"
49 #include "internet_addressing.h"
50 #include "serv_imap.h"
51 #include "imap_tools.h"
52 #include "imap_list.h"
53 #include "imap_fetch.h"
54 #include "imap_search.h"
55 #include "imap_store.h"
57 #include "imap_metadata.h"
58 #include "imap_misc.h"
61 #include "ctdl_module.h"
64 /* imap_rename() uses this struct containing list of rooms to rename */
67 char irl_oldroom[ROOMNAMELEN];
68 char irl_newroom[ROOMNAMELEN];
72 /* Data which is passed between imap_rename() and imap_rename_backend() */
81 * If there is a message ID map in memory, free it
83 void imap_free_msgids(void)
85 if (IMAP->msgids != NULL) {
91 if (IMAP->flags != NULL) {
95 IMAP->last_mtime = (-1);
100 * If there is a transmitted message in memory, free it
102 void imap_free_transmitted_message(void)
104 if (IMAP->transmitted_message != NULL) {
105 free(IMAP->transmitted_message);
106 IMAP->transmitted_message = NULL;
107 IMAP->transmitted_length = 0;
113 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
114 * sets stored in the visit record for this user/room. Note that we have
115 * to parse each sequence set manually here, because calling the utility
116 * function is_msg_in_sequence_set() over and over again is too expensive.
118 * first_msg should be set to 0 to rescan the flags for every message in the
119 * room, or some other value if we're only interested in an incremental
122 void imap_set_seen_flags(int first_msg)
128 char setstr[64], lostr[64], histr[64];
131 if (IMAP->num_msgs < 1) return;
132 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
134 for (i = first_msg; i < IMAP->num_msgs; ++i) {
135 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
136 IMAP->flags[i] |= IMAP_RECENT;
137 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
141 * Do the "\Seen" flag.
142 * (Any message not "\Seen" is considered "\Recent".)
144 num_sets = num_tokens(vbuf.v_seen, ',');
145 for (s=0; s<num_sets; ++s) {
146 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
148 extract_token(lostr, setstr, 0, ':', sizeof lostr);
149 if (num_tokens(setstr, ':') >= 2) {
150 extract_token(histr, setstr, 1, ':', sizeof histr);
151 if (!strcmp(histr, "*")) {
152 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
156 strcpy(histr, lostr);
161 for (i = first_msg; i < IMAP->num_msgs; ++i) {
162 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
163 IMAP->flags[i] |= IMAP_SEEN;
164 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
169 /* Do the ANSWERED flag */
170 num_sets = num_tokens(vbuf.v_answered, ',');
171 for (s=0; s<num_sets; ++s) {
172 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
174 extract_token(lostr, setstr, 0, ':', sizeof lostr);
175 if (num_tokens(setstr, ':') >= 2) {
176 extract_token(histr, setstr, 1, ':', sizeof histr);
177 if (!strcmp(histr, "*")) {
178 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
182 strcpy(histr, lostr);
187 for (i = first_msg; i < IMAP->num_msgs; ++i) {
188 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
189 IMAP->flags[i] |= IMAP_ANSWERED;
199 * Back end for imap_load_msgids()
201 * Optimization: instead of calling realloc() to add each message, we
202 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
203 * allows the mapping to proceed much faster.
205 void imap_add_single_msgid(long msgnum, void *userdata)
209 if (IMAP->num_msgs > IMAP->num_alloc) {
210 IMAP->num_alloc += REALLOC_INCREMENT;
211 IMAP->msgids = realloc(IMAP->msgids,
212 (IMAP->num_alloc * sizeof(long)) );
213 IMAP->flags = realloc(IMAP->flags,
214 (IMAP->num_alloc * sizeof(long)) );
216 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
217 IMAP->flags[IMAP->num_msgs - 1] = 0;
223 * Set up a message ID map for the current room (folder)
225 void imap_load_msgids(void)
227 struct cdbdata *cdbfr;
229 if (IMAP->selected == 0) {
230 CtdlLogPrintf(CTDL_ERR,
231 "imap_load_msgids() can't run; no room selected\n");
235 imap_free_msgids(); /* If there was already a map, free it */
237 /* Load the message list */
238 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
240 IMAP->msgids = malloc(cdbfr->len);
241 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
242 IMAP->num_msgs = cdbfr->len / sizeof(long);
243 IMAP->num_alloc = cdbfr->len / sizeof(long);
247 if (IMAP->num_msgs) {
248 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
249 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
252 imap_set_seen_flags(0);
257 * Re-scan the selected room (folder) and see if it's been changed at all
259 void imap_rescan_msgids(void)
262 int original_num_msgs = 0;
263 long original_highest = 0L;
265 int message_still_exists;
266 struct cdbdata *cdbfr;
267 long *msglist = NULL;
271 if (IMAP->selected == 0) {
272 CtdlLogPrintf(CTDL_ERR,
273 "imap_load_msgids() can't run; no room selected\n");
278 * Check to see if the room's contents have changed.
279 * If not, we can avoid this rescan.
281 getroom(&CC->room, CC->room.QRname);
282 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
286 /* Load the *current* message list from disk, so we can compare it
287 * to what we have in memory.
289 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
291 msglist = malloc(cdbfr->len);
292 if (msglist == NULL) {
293 CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
296 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
297 num_msgs = cdbfr->len / sizeof(long);
304 * Check to see if any of the messages we know about have been expunged
306 if (IMAP->num_msgs > 0) {
308 for (i = 0; i < IMAP->num_msgs; ++i) {
310 message_still_exists = 0;
312 for (j = jstart; j < num_msgs; ++j) {
313 if (msglist[j] == IMAP->msgids[i]) {
314 message_still_exists = 1;
321 if (message_still_exists == 0) {
322 cprintf("* %d EXPUNGE\r\n", i + 1);
324 /* Here's some nice stupid nonsense. When a
325 * message is expunged, we have to slide all
326 * the existing messages up in the message
330 memcpy(&IMAP->msgids[i],
331 &IMAP->msgids[i + 1],
333 (IMAP->num_msgs - i)));
334 memcpy(&IMAP->flags[i],
337 (IMAP->num_msgs - i)));
346 * Remember how many messages were here before we re-scanned.
348 original_num_msgs = IMAP->num_msgs;
349 if (IMAP->num_msgs > 0) {
350 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
352 original_highest = 0L;
356 * Now peruse the room for *new* messages only.
359 for (j = 0; j < num_msgs; ++j) {
360 if (msglist[j] > original_highest) {
361 imap_add_single_msgid(msglist[j], NULL);
365 imap_set_seen_flags(original_num_msgs);
368 * If new messages have arrived, tell the client about them.
370 if (IMAP->num_msgs > original_num_msgs) {
372 for (j = 0; j < num_msgs; ++j) {
373 if (IMAP->flags[j] & IMAP_RECENT) {
378 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
379 cprintf("* %d RECENT\r\n", num_recent);
385 IMAP->last_mtime = CC->room.QRmtime;
395 * This cleanup function blows away the temporary memory and files used by
398 void imap_cleanup_function(void)
401 /* Don't do this stuff if this is not a IMAP session! */
402 if (CC->h_command_function != imap_command_loop)
405 /* If there is a mailbox selected, auto-expunge it. */
406 if (IMAP->selected) {
410 CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
412 imap_free_transmitted_message();
414 if (IMAP->cached_rfc822_data != NULL) {
415 free(IMAP->cached_rfc822_data);
416 IMAP->cached_rfc822_data = NULL;
417 IMAP->cached_rfc822_msgnum = (-1);
418 IMAP->cached_rfc822_withbody = 0;
421 if (IMAP->cached_body != NULL) {
422 free(IMAP->cached_body);
423 IMAP->cached_body = NULL;
424 IMAP->cached_body_len = 0;
425 IMAP->cached_bodymsgnum = (-1);
429 CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
434 * Does the actual work of the CAPABILITY command (because we need to
435 * output this stuff in other places as well)
437 void imap_output_capability_string(void) {
438 cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
441 if (!CC->redirect_ssl) cprintf(" STARTTLS");
444 #ifndef DISABLE_IMAP_ACL
448 /* We are building a partial implementation of METADATA for the sole purpose
449 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
450 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
451 * metadata in a compatible and graceful way.
453 cprintf(" METADATA");
456 * LIST-EXTENDED was originally going to be required by the METADATA extension.
457 * It was mercifully removed prior to the finalization of RFC5464. We started
458 * implementing this but stopped when we learned that it would not be needed.
459 * If you uncomment this declaration you are responsible for writing a lot of new
462 * cprintf(" LIST-EXTENDED")
467 * implements the CAPABILITY command
469 void imap_capability(int num_parms, char *parms[])
472 imap_output_capability_string();
474 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
480 * Implements the ID command (specified by RFC2971)
482 * We ignore the client-supplied information, and output a NIL response.
483 * Although this is technically a valid implementation of the extension, it
484 * is quite useless. It exists only so that we may see which clients are
485 * making use of this extension.
488 void imap_id(int num_parms, char *parms[])
490 cprintf("* ID NIL\r\n");
491 cprintf("%s OK ID completed\r\n", parms[0]);
497 * Here's where our IMAP session begins its happy day.
499 void imap_greeting(void)
502 strcpy(CC->cs_clientname, "IMAP session");
503 CC->session_specific_data = malloc(sizeof(struct citimap));
504 memset(IMAP, 0, sizeof(struct citimap));
505 IMAP->authstate = imap_as_normal;
506 IMAP->cached_rfc822_data = NULL;
507 IMAP->cached_rfc822_msgnum = (-1);
508 IMAP->cached_rfc822_withbody = 0;
512 cprintf("* BYE; Server busy, try later\r\n");
517 imap_output_capability_string();
518 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
522 * IMAPS is just like IMAP, except it goes crypto right away.
524 void imaps_greeting(void) {
525 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
527 if (!CC->redirect_ssl) CC->kill_me = 1; /* kill session if no crypto */
534 * implements the LOGIN command (ordinary username/password login)
536 void imap_login(int num_parms, char *parms[])
538 if (num_parms != 4) {
539 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
543 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
544 if (CtdlTryPassword(parms[3]) == pass_ok) {
545 cprintf("%s OK [", parms[0]);
546 imap_output_capability_string();
547 cprintf("] Hello, %s\r\n", CC->user.fullname);
552 cprintf("%s BAD Login incorrect\r\n", parms[0]);
557 * Implements the AUTHENTICATE command
559 void imap_authenticate(int num_parms, char *parms[])
563 if (num_parms != 3) {
564 cprintf("%s BAD incorrect number of parameters\r\n",
570 cprintf("%s BAD Already logged in.\r\n", parms[0]);
574 if (!strcasecmp(parms[2], "LOGIN")) {
575 CtdlEncodeBase64(buf, "Username:", 9, 0);
576 cprintf("+ %s\r\n", buf);
577 IMAP->authstate = imap_as_expecting_username;
578 strcpy(IMAP->authseq, parms[0]);
582 if (!strcasecmp(parms[2], "PLAIN")) {
583 // CtdlEncodeBase64(buf, "Username:", 9, 0);
584 // cprintf("+ %s\r\n", buf);
586 IMAP->authstate = imap_as_expecting_plainauth;
587 strcpy(IMAP->authseq, parms[0]);
592 cprintf("%s NO AUTHENTICATE %s failed\r\n",
597 void imap_auth_plain(char *cmd)
599 char decoded_authstring[1024];
605 memset(pass, 0, sizeof(pass));
606 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
607 safestrncpy(ident, decoded_authstring, sizeof ident);
608 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
609 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
611 IMAP->authstate = imap_as_normal;
613 if (!IsEmptyStr(ident)) {
614 result = CtdlLoginExistingUser(user, ident);
617 result = CtdlLoginExistingUser(NULL, user);
620 if (result == login_ok) {
621 if (CtdlTryPassword(pass) == pass_ok) {
622 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
626 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
629 void imap_auth_login_user(char *cmd)
633 CtdlDecodeBase64(buf, cmd, SIZ);
634 CtdlLoginExistingUser(NULL, buf);
635 CtdlEncodeBase64(buf, "Password:", 9, 0);
636 cprintf("+ %s\r\n", buf);
637 IMAP->authstate = imap_as_expecting_password;
641 void imap_auth_login_pass(char *cmd)
645 memset(buf, 0, sizeof(buf));
646 CtdlDecodeBase64(buf, cmd, SIZ);
647 if (CtdlTryPassword(buf) == pass_ok) {
648 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
650 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
652 IMAP->authstate = imap_as_normal;
658 * implements the STARTTLS command (Citadel API version)
660 void imap_starttls(int num_parms, char *parms[])
662 char ok_response[SIZ];
663 char nosup_response[SIZ];
664 char error_response[SIZ];
667 "%s OK begin TLS negotiation now\r\n",
669 sprintf(nosup_response,
670 "%s NO TLS not supported here\r\n",
672 sprintf(error_response,
673 "%s BAD Internal error\r\n",
675 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
680 * implements the SELECT command
682 void imap_select(int num_parms, char *parms[])
685 char augmented_roomname[ROOMNAMELEN];
689 struct ctdlroom QRscratch;
695 /* Convert the supplied folder name to a roomname */
696 i = imap_roomname(towhere, sizeof towhere, parms[2]);
698 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
702 floornum = (i & 0x00ff);
703 roomflags = (i & 0xff00);
705 /* First try a regular match */
706 c = getroom(&QRscratch, towhere);
708 /* Then try a mailbox name match */
710 MailboxName(augmented_roomname, sizeof augmented_roomname,
712 c = getroom(&QRscratch, augmented_roomname);
714 strcpy(towhere, augmented_roomname);
717 /* If the room exists, check security/access */
719 /* See if there is an existing user/room relationship */
720 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
722 /* normal clients have to pass through security */
728 /* Fail here if no such room */
730 cprintf("%s NO ... no such room, or access denied\r\n",
735 /* If we already had some other folder selected, auto-expunge it */
739 * usergoto() formally takes us to the desired room, happily returning
740 * the number of messages and number of new messages.
742 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
743 usergoto(NULL, 0, 0, &msgs, &new);
746 if (!strcasecmp(parms[1], "EXAMINE")) {
753 IMAP->last_mtime = CC->room.QRmtime;
755 cprintf("* %d EXISTS\r\n", msgs);
756 cprintf("* %d RECENT\r\n", new);
758 cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
759 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
761 /* Technically, \Deleted is a valid flag, but not a permanent flag,
762 * because we don't maintain its state across sessions. Citadel
763 * automatically expunges mailboxes when they are de-selected.
765 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
766 * some clients (particularly Thunderbird) to misbehave -- they simply
767 * elect not to transmit the flag at all. So we have to advertise
768 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
770 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
771 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
773 cprintf("%s OK [%s] %s completed\r\n",
775 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
781 * Does the real work for expunge.
783 int imap_do_expunge(void)
786 int num_expunged = 0;
787 long *delmsgs = NULL;
790 CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
791 if (IMAP->selected == 0) {
795 if (IMAP->num_msgs > 0) {
796 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
797 for (i = 0; i < IMAP->num_msgs; ++i) {
798 if (IMAP->flags[i] & IMAP_DELETED) {
799 delmsgs[num_delmsgs++] = IMAP->msgids[i];
802 if (num_delmsgs > 0) {
803 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
805 num_expunged += num_delmsgs;
809 if (num_expunged > 0) {
810 imap_rescan_msgids();
813 CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
814 num_expunged, CC->room.QRname);
815 return (num_expunged);
820 * implements the EXPUNGE command syntax
822 void imap_expunge(int num_parms, char *parms[])
824 int num_expunged = 0;
826 num_expunged = imap_do_expunge();
827 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
832 * implements the CLOSE command
834 void imap_close(int num_parms, char *parms[])
837 /* Yes, we always expunge on close. */
838 if (IMAP->selected) {
845 cprintf("%s OK CLOSE completed\r\n", parms[0]);
850 * Implements the NAMESPACE command.
852 void imap_namespace(int num_parms, char *parms[])
859 cprintf("* NAMESPACE ");
861 /* All personal folders are subordinate to INBOX. */
862 cprintf("((\"INBOX/\" \"/\")) ");
864 /* Other users' folders ... coming soon! FIXME */
867 /* Show all floors as shared namespaces. Neato! */
869 for (i = 0; i < MAXFLOORS; ++i) {
871 if (fl->f_flags & F_INUSE) {
872 if (floors > 0) cprintf(" ");
874 sprintf(buf, "%s/", fl->f_name);
882 /* Wind it up with a newline and a completion message. */
884 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
890 * Implements the CREATE command
893 void imap_create(int num_parms, char *parms[])
896 char roomname[ROOMNAMELEN];
901 char *notification_message = NULL;
904 cprintf("%s NO A foder name must be specified\r\n", parms[0]);
908 if (strchr(parms[2], '\\') != NULL) {
909 cprintf("%s NO Invalid character in folder name\r\n", parms[0]);
910 CtdlLogPrintf(CTDL_DEBUG, "invalid character in folder name\n");
914 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
916 cprintf("%s NO Invalid mailbox name or location\r\n",
918 CtdlLogPrintf(CTDL_DEBUG, "invalid mailbox name or location\n");
921 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
922 flags = (ret & 0xff00); /* upper 8 bits = flags */
924 if (flags & IR_MAILBOX) {
925 if (strncasecmp(parms[2], "INBOX/", 6)) {
926 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
927 CtdlLogPrintf(CTDL_DEBUG, "not subordinate to inbox\n");
932 if (flags & IR_MAILBOX) {
933 newroomtype = 4; /* private mailbox */
934 newroomview = VIEW_MAILBOX;
936 newroomtype = 0; /* public folder */
937 newroomview = VIEW_BBS;
940 CtdlLogPrintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
941 roomname, floornum, newroomtype);
943 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
945 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
946 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
948 cprintf("%s OK CREATE completed\r\n", parms[0]);
949 /* post a message in Aide> describing the new room */
950 notification_message = malloc(1024);
951 snprintf(notification_message, 1024,
952 "A new room called \"%s\" has been created by %s%s%s%s\n",
955 ((ret & QR_MAILBOX) ? " [personal]" : ""),
956 ((ret & QR_PRIVATE) ? " [private]" : ""),
957 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
959 aide_message(notification_message, "Room Creation Message");
960 free(notification_message);
962 CtdlLogPrintf(CTDL_DEBUG, "imap_create() completed\n");
967 * Locate a room by its IMAP folder name, and check access to it.
968 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
970 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
973 char augmented_roomname[ROOMNAMELEN];
974 char roomname[ROOMNAMELEN];
976 struct ctdlroom QRscratch;
980 ret = imap_roomname(roomname, sizeof roomname, foldername);
985 /* First try a regular match */
986 c = getroom(&QRscratch, roomname);
988 /* Then try a mailbox name match */
990 MailboxName(augmented_roomname, sizeof augmented_roomname,
991 &CC->user, roomname);
992 c = getroom(&QRscratch, augmented_roomname);
994 strcpy(roomname, augmented_roomname);
997 /* If the room exists, check security/access */
999 /* See if there is an existing user/room relationship */
1000 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1002 /* normal clients have to pass through security */
1003 if (ra & UA_KNOWN) {
1006 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1011 /* Fail here if no such room */
1013 strcpy(returned_roomname, "");
1016 strcpy(returned_roomname, QRscratch.QRname);
1023 * Implements the STATUS command (sort of)
1026 void imap_status(int num_parms, char *parms[])
1029 char roomname[ROOMNAMELEN];
1031 char savedroom[ROOMNAMELEN];
1034 ret = imap_grabroom(roomname, parms[2], 1);
1037 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1043 * usergoto() formally takes us to the desired room, happily returning
1044 * the number of messages and number of new messages. (If another
1045 * folder is selected, save its name so we can return there!!!!!)
1047 if (IMAP->selected) {
1048 strcpy(savedroom, CC->room.QRname);
1050 usergoto(roomname, 0, 0, &msgs, &new);
1053 * Tell the client what it wants to know. In fact, tell it *more* than
1054 * it wants to know. We happily IGnore the supplied status data item
1055 * names and simply spew all possible data items. It's far easier to
1056 * code and probably saves us some processing time too.
1058 imap_mailboxname(buf, sizeof buf, &CC->room);
1059 cprintf("* STATUS ");
1061 cprintf(" (MESSAGES %d ", msgs);
1062 cprintf("RECENT %d ", new); /* Initially, new==recent */
1063 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1064 cprintf("UNSEEN %d)\r\n", new);
1067 * If another folder is selected, go back to that room so we can resume
1068 * our happy day without violent explosions.
1070 if (IMAP->selected) {
1071 usergoto(savedroom, 0, 0, &msgs, &new);
1075 * Oooh, look, we're done!
1077 cprintf("%s OK STATUS completed\r\n", parms[0]);
1083 * Implements the SUBSCRIBE command
1086 void imap_subscribe(int num_parms, char *parms[])
1089 char roomname[ROOMNAMELEN];
1090 char savedroom[ROOMNAMELEN];
1093 ret = imap_grabroom(roomname, parms[2], 1);
1096 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1104 * usergoto() formally takes us to the desired room, which has the side
1105 * effect of marking the room as not-zapped ... exactly the effect
1106 * we're looking for.
1108 if (IMAP->selected) {
1109 strcpy(savedroom, CC->room.QRname);
1111 usergoto(roomname, 0, 0, &msgs, &new);
1114 * If another folder is selected, go back to that room so we can resume
1115 * our happy day without violent explosions.
1117 if (IMAP->selected) {
1118 usergoto(savedroom, 0, 0, &msgs, &new);
1121 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1126 * Implements the UNSUBSCRIBE command
1129 void imap_unsubscribe(int num_parms, char *parms[])
1132 char roomname[ROOMNAMELEN];
1133 char savedroom[ROOMNAMELEN];
1136 ret = imap_grabroom(roomname, parms[2], 1);
1139 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1145 * usergoto() formally takes us to the desired room.
1147 if (IMAP->selected) {
1148 strcpy(savedroom, CC->room.QRname);
1150 usergoto(roomname, 0, 0, &msgs, &new);
1153 * Now make the API call to zap the room
1155 if (CtdlForgetThisRoom() == 0) {
1156 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1159 ("%s NO You may not unsubscribe from this folder.\r\n",
1164 * If another folder is selected, go back to that room so we can resume
1165 * our happy day without violent explosions.
1167 if (IMAP->selected) {
1168 usergoto(savedroom, 0, 0, &msgs, &new);
1175 * Implements the DELETE command
1178 void imap_delete(int num_parms, char *parms[])
1181 char roomname[ROOMNAMELEN];
1182 char savedroom[ROOMNAMELEN];
1185 ret = imap_grabroom(roomname, parms[2], 1);
1187 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1193 * usergoto() formally takes us to the desired room, happily returning
1194 * the number of messages and number of new messages. (If another
1195 * folder is selected, save its name so we can return there!!!!!)
1197 if (IMAP->selected) {
1198 strcpy(savedroom, CC->room.QRname);
1200 usergoto(roomname, 0, 0, &msgs, &new);
1203 * Now delete the room.
1205 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1206 schedule_room_for_deletion(&CC->room);
1207 cprintf("%s OK DELETE completed\r\n", parms[0]);
1209 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1213 * If another folder is selected, go back to that room so we can resume
1214 * our happy day without violent explosions.
1216 if (IMAP->selected) {
1217 usergoto(savedroom, 0, 0, &msgs, &new);
1223 * Back end function for imap_rename()
1225 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1227 char foldername[SIZ];
1228 char newfoldername[SIZ];
1229 char newroomname[ROOMNAMELEN];
1231 struct irl *irlp = NULL; /* scratch pointer */
1232 struct irlparms *irlparms;
1234 irlparms = (struct irlparms *) data;
1235 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1237 /* Rename subfolders */
1238 if ((!strncasecmp(foldername, irlparms->oldname,
1239 strlen(irlparms->oldname))
1240 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1242 sprintf(newfoldername, "%s/%s",
1244 &foldername[strlen(irlparms->oldname) + 1]
1247 newfloor = imap_roomname(newroomname,
1249 newfoldername) & 0xFF;
1251 irlp = (struct irl *) malloc(sizeof(struct irl));
1252 strcpy(irlp->irl_newroom, newroomname);
1253 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1254 irlp->irl_newfloor = newfloor;
1255 irlp->next = *(irlparms->irl);
1256 *(irlparms->irl) = irlp;
1262 * Implements the RENAME command
1265 void imap_rename(int num_parms, char *parms[])
1267 char old_room[ROOMNAMELEN];
1268 char new_room[ROOMNAMELEN];
1272 struct irl *irl = NULL; /* the list */
1273 struct irl *irlp = NULL; /* scratch pointer */
1274 struct irlparms irlparms;
1277 if (strchr(parms[3], '\\') != NULL) {
1278 cprintf("%s NO Invalid character in folder name\r\n",
1283 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1284 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1285 new_floor = (newr & 0xFF);
1287 r = CtdlRenameRoom(old_room, new_room, new_floor);
1289 if (r == crr_room_not_found) {
1290 cprintf("%s NO Could not locate this folder\r\n",
1294 if (r == crr_already_exists) {
1295 cprintf("%s NO '%s' already exists.\r\n", parms[0], parms[2]);
1298 if (r == crr_noneditable) {
1299 cprintf("%s NO This folder is not editable.\r\n", parms[0]);
1302 if (r == crr_invalid_floor) {
1303 cprintf("%s NO Folder root does not exist.\r\n", parms[0]);
1306 if (r == crr_access_denied) {
1307 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1312 cprintf("%s NO Rename failed - undefined error %d\r\n",
1317 /* If this is the INBOX, then RFC2060 says we have to just move the
1318 * contents. In a Citadel environment it's easier to rename the room
1319 * (already did that) and create a new inbox.
1321 if (!strcasecmp(parms[2], "INBOX")) {
1322 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1325 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1327 irlparms.oldname = parms[2];
1328 irlparms.newname = parms[3];
1329 irlparms.irl = &irl;
1330 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1332 /* ... and now rename them. */
1333 while (irl != NULL) {
1334 r = CtdlRenameRoom(irl->irl_oldroom,
1338 /* FIXME handle error returns better */
1339 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1347 snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1352 aide_message(buf, "IMAP folder rename");
1354 cprintf("%s OK RENAME completed\r\n", parms[0]);
1361 * Main command loop for IMAP sessions.
1363 void imap_command_loop(void)
1368 struct timeval tv1, tv2;
1369 suseconds_t total_time = 0;
1370 int untagged_ok = 1;
1372 gettimeofday(&tv1, NULL);
1373 CC->lastcmd = time(NULL);
1374 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1376 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1377 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1382 if (IMAP->authstate == imap_as_expecting_password) {
1383 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1385 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1386 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1388 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1389 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1392 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1395 while (strlen(cmdbuf) < 5)
1396 strcat(cmdbuf, " ");
1398 /* strip off l/t whitespace and CRLF */
1399 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1400 cmdbuf[strlen(cmdbuf) - 1] = 0;
1401 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1402 cmdbuf[strlen(cmdbuf) - 1] = 0;
1405 /* If we're in the middle of a multi-line command, handle that */
1406 if (IMAP->authstate == imap_as_expecting_username) {
1407 imap_auth_login_user(cmdbuf);
1410 if (IMAP->authstate == imap_as_expecting_plainauth) {
1411 imap_auth_plain(cmdbuf);
1414 if (IMAP->authstate == imap_as_expecting_password) {
1415 imap_auth_login_pass(cmdbuf);
1420 /* Ok, at this point we're in normal command mode.
1421 * If the command just submitted does not contain a literal, we
1422 * might think about delivering some untagged stuff...
1424 if (cmdbuf[strlen(cmdbuf)-1] == '}') {
1428 /* Grab the tag, command, and parameters. */
1429 num_parms = imap_parameterize(parms, cmdbuf);
1431 /* RFC3501 says that we cannot output untagged data during these commands */
1432 if (num_parms >= 2) {
1433 if ( (!strcasecmp(parms[1], "FETCH"))
1434 || (!strcasecmp(parms[1], "STORE"))
1435 || (!strcasecmp(parms[1], "SEARCH"))
1443 /* we can put any additional untagged stuff right here in the future */
1446 * Before processing the command that was just entered... if we happen
1447 * to have a folder selected, we'd like to rescan that folder for new
1448 * messages, and for deletions/changes of existing messages. This
1449 * could probably be optimized better with some deep thought...
1451 if (IMAP->selected) {
1452 imap_rescan_msgids();
1456 /* Now for the command set. */
1458 if (num_parms < 2) {
1459 cprintf("BAD syntax error\r\n");
1462 /* The commands below may be executed in any state */
1464 else if ((!strcasecmp(parms[1], "NOOP"))
1465 || (!strcasecmp(parms[1], "CHECK"))) {
1466 cprintf("%s OK No operation\r\n",
1470 else if (!strcasecmp(parms[1], "ID")) {
1471 imap_id(num_parms, parms);
1475 else if (!strcasecmp(parms[1], "LOGOUT")) {
1476 if (IMAP->selected) {
1477 imap_do_expunge(); /* yes, we auto-expunge at logout */
1479 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1480 cprintf("%s OK Citadel IMAP session ended.\r\n",
1486 else if (!strcasecmp(parms[1], "LOGIN")) {
1487 imap_login(num_parms, parms);
1490 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1491 imap_authenticate(num_parms, parms);
1494 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1495 imap_capability(num_parms, parms);
1498 else if (!strcasecmp(parms[1], "STARTTLS")) {
1499 imap_starttls(num_parms, parms);
1502 else if (!CC->logged_in) {
1503 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1506 /* The commans below require a logged-in state */
1508 else if (!strcasecmp(parms[1], "SELECT")) {
1509 imap_select(num_parms, parms);
1512 else if (!strcasecmp(parms[1], "EXAMINE")) {
1513 imap_select(num_parms, parms);
1516 else if (!strcasecmp(parms[1], "LSUB")) {
1517 imap_list(num_parms, parms);
1520 else if (!strcasecmp(parms[1], "LIST")) {
1521 imap_list(num_parms, parms);
1524 else if (!strcasecmp(parms[1], "CREATE")) {
1525 imap_create(num_parms, parms);
1528 else if (!strcasecmp(parms[1], "DELETE")) {
1529 imap_delete(num_parms, parms);
1532 else if (!strcasecmp(parms[1], "RENAME")) {
1533 imap_rename(num_parms, parms);
1536 else if (!strcasecmp(parms[1], "STATUS")) {
1537 imap_status(num_parms, parms);
1540 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1541 imap_subscribe(num_parms, parms);
1544 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1545 imap_unsubscribe(num_parms, parms);
1548 else if (!strcasecmp(parms[1], "APPEND")) {
1549 imap_append(num_parms, parms);
1552 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1553 imap_namespace(num_parms, parms);
1556 else if (!strcasecmp(parms[1], "SETACL")) {
1557 imap_setacl(num_parms, parms);
1560 else if (!strcasecmp(parms[1], "DELETEACL")) {
1561 imap_deleteacl(num_parms, parms);
1564 else if (!strcasecmp(parms[1], "GETACL")) {
1565 imap_getacl(num_parms, parms);
1568 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1569 imap_listrights(num_parms, parms);
1572 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1573 imap_myrights(num_parms, parms);
1576 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1577 imap_getmetadata(num_parms, parms);
1580 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1581 imap_setmetadata(num_parms, parms);
1584 else if (IMAP->selected == 0) {
1585 cprintf("%s BAD no folder selected\r\n", parms[0]);
1588 /* The commands below require the SELECT state on a mailbox */
1590 else if (!strcasecmp(parms[1], "FETCH")) {
1591 imap_fetch(num_parms, parms);
1594 else if ((!strcasecmp(parms[1], "UID"))
1595 && (!strcasecmp(parms[2], "FETCH"))) {
1596 imap_uidfetch(num_parms, parms);
1599 else if (!strcasecmp(parms[1], "SEARCH")) {
1600 imap_search(num_parms, parms);
1603 else if ((!strcasecmp(parms[1], "UID"))
1604 && (!strcasecmp(parms[2], "SEARCH"))) {
1605 imap_uidsearch(num_parms, parms);
1608 else if (!strcasecmp(parms[1], "STORE")) {
1609 imap_store(num_parms, parms);
1612 else if ((!strcasecmp(parms[1], "UID"))
1613 && (!strcasecmp(parms[2], "STORE"))) {
1614 imap_uidstore(num_parms, parms);
1617 else if (!strcasecmp(parms[1], "COPY")) {
1618 imap_copy(num_parms, parms);
1621 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "COPY"))) {
1622 imap_uidcopy(num_parms, parms);
1625 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1626 imap_expunge(num_parms, parms);
1629 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "EXPUNGE"))) {
1630 imap_expunge(num_parms, parms);
1633 else if (!strcasecmp(parms[1], "CLOSE")) {
1634 imap_close(num_parms, parms);
1637 /* End of commands. If we get here, the command is either invalid
1642 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1645 /* If the client transmitted a message we can free it now */
1646 imap_free_transmitted_message();
1648 gettimeofday(&tv2, NULL);
1649 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1650 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf); // FIXME FIXME FIXME REMOVE THIS NOW
1651 CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1652 (total_time / 1000000),
1653 (total_time % 1000000)
1658 const char *CitadelServiceIMAP="IMAP";
1659 const char *CitadelServiceIMAPS="IMAPS";
1662 * This function is called to register the IMAP extension with Citadel.
1664 CTDL_MODULE_INIT(imap)
1668 CtdlRegisterServiceHook(config.c_imap_port,
1669 NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1671 CtdlRegisterServiceHook(config.c_imaps_port,
1672 NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1674 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1677 /* return our Subversion id for the Log */