4 * IMAP server for the Citadel system
5 * Copyright (C) 2000-2009 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.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
35 #include <sys/types.h>
37 #if TIME_WITH_SYS_TIME
38 # include <sys/time.h>
42 # include <sys/time.h>
52 #include <libcitadel.h>
55 #include "citserver.h"
62 #include "internet_addressing.h"
63 #include "serv_imap.h"
64 #include "imap_tools.h"
65 #include "imap_list.h"
66 #include "imap_fetch.h"
67 #include "imap_search.h"
68 #include "imap_store.h"
70 #include "imap_metadata.h"
71 #include "imap_misc.h"
74 #include "ctdl_module.h"
77 /* imap_rename() uses this struct containing list of rooms to rename */
80 char irl_oldroom[ROOMNAMELEN];
81 char irl_newroom[ROOMNAMELEN];
85 /* Data which is passed between imap_rename() and imap_rename_backend() */
94 * If there is a message ID map in memory, free it
96 void imap_free_msgids(void)
98 if (IMAP->msgids != NULL) {
104 if (IMAP->flags != NULL) {
108 IMAP->last_mtime = (-1);
113 * If there is a transmitted message in memory, free it
115 void imap_free_transmitted_message(void)
117 if (IMAP->transmitted_message != NULL) {
118 free(IMAP->transmitted_message);
119 IMAP->transmitted_message = NULL;
120 IMAP->transmitted_length = 0;
126 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
127 * sets stored in the visit record for this user/room. Note that we have
128 * to parse each sequence set manually here, because calling the utility
129 * function is_msg_in_sequence_set() over and over again is too expensive.
131 * first_msg should be set to 0 to rescan the flags for every message in the
132 * room, or some other value if we're only interested in an incremental
135 void imap_set_seen_flags(int first_msg)
141 char setstr[64], lostr[64], histr[64];
144 if (IMAP->num_msgs < 1) return;
145 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
147 for (i = first_msg; i < IMAP->num_msgs; ++i) {
148 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
149 IMAP->flags[i] |= IMAP_RECENT;
150 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
154 * Do the "\Seen" flag.
155 * (Any message not "\Seen" is considered "\Recent".)
157 num_sets = num_tokens(vbuf.v_seen, ',');
158 for (s=0; s<num_sets; ++s) {
159 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
161 extract_token(lostr, setstr, 0, ':', sizeof lostr);
162 if (num_tokens(setstr, ':') >= 2) {
163 extract_token(histr, setstr, 1, ':', sizeof histr);
164 if (!strcmp(histr, "*")) {
165 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
169 strcpy(histr, lostr);
174 for (i = first_msg; i < IMAP->num_msgs; ++i) {
175 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
176 IMAP->flags[i] |= IMAP_SEEN;
177 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
182 /* Do the ANSWERED flag */
183 num_sets = num_tokens(vbuf.v_answered, ',');
184 for (s=0; s<num_sets; ++s) {
185 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
187 extract_token(lostr, setstr, 0, ':', sizeof lostr);
188 if (num_tokens(setstr, ':') >= 2) {
189 extract_token(histr, setstr, 1, ':', sizeof histr);
190 if (!strcmp(histr, "*")) {
191 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
195 strcpy(histr, lostr);
200 for (i = first_msg; i < IMAP->num_msgs; ++i) {
201 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
202 IMAP->flags[i] |= IMAP_ANSWERED;
212 * Back end for imap_load_msgids()
214 * Optimization: instead of calling realloc() to add each message, we
215 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
216 * allows the mapping to proceed much faster.
218 void imap_add_single_msgid(long msgnum, void *userdata)
222 if (IMAP->num_msgs > IMAP->num_alloc) {
223 IMAP->num_alloc += REALLOC_INCREMENT;
224 IMAP->msgids = realloc(IMAP->msgids,
225 (IMAP->num_alloc * sizeof(long)) );
226 IMAP->flags = realloc(IMAP->flags,
227 (IMAP->num_alloc * sizeof(long)) );
229 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
230 IMAP->flags[IMAP->num_msgs - 1] = 0;
236 * Set up a message ID map for the current room (folder)
238 void imap_load_msgids(void)
240 struct cdbdata *cdbfr;
242 if (IMAP->selected == 0) {
243 CtdlLogPrintf(CTDL_ERR,
244 "imap_load_msgids() can't run; no room selected\n");
248 imap_free_msgids(); /* If there was already a map, free it */
250 /* Load the message list */
251 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
253 IMAP->msgids = malloc(cdbfr->len);
254 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
255 IMAP->num_msgs = cdbfr->len / sizeof(long);
256 IMAP->num_alloc = cdbfr->len / sizeof(long);
260 if (IMAP->num_msgs) {
261 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
262 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
265 imap_set_seen_flags(0);
270 * Re-scan the selected room (folder) and see if it's been changed at all
272 void imap_rescan_msgids(void)
275 int original_num_msgs = 0;
276 long original_highest = 0L;
278 int message_still_exists;
279 struct cdbdata *cdbfr;
280 long *msglist = NULL;
284 if (IMAP->selected == 0) {
285 CtdlLogPrintf(CTDL_ERR,
286 "imap_load_msgids() can't run; no room selected\n");
291 * Check to see if the room's contents have changed.
292 * If not, we can avoid this rescan.
294 CtdlGetRoom(&CC->room, CC->room.QRname);
295 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
299 /* Load the *current* message list from disk, so we can compare it
300 * to what we have in memory.
302 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
304 msglist = malloc(cdbfr->len);
305 if (msglist == NULL) {
306 CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
309 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
310 num_msgs = cdbfr->len / sizeof(long);
317 * Check to see if any of the messages we know about have been expunged
319 if (IMAP->num_msgs > 0) {
321 for (i = 0; i < IMAP->num_msgs; ++i) {
323 message_still_exists = 0;
325 for (j = jstart; j < num_msgs; ++j) {
326 if (msglist[j] == IMAP->msgids[i]) {
327 message_still_exists = 1;
334 if (message_still_exists == 0) {
335 cprintf("* %d EXPUNGE\r\n", i + 1);
337 /* Here's some nice stupid nonsense. When a
338 * message is expunged, we have to slide all
339 * the existing messages up in the message
343 memcpy(&IMAP->msgids[i],
344 &IMAP->msgids[i + 1],
346 (IMAP->num_msgs - i)));
347 memcpy(&IMAP->flags[i],
350 (IMAP->num_msgs - i)));
359 * Remember how many messages were here before we re-scanned.
361 original_num_msgs = IMAP->num_msgs;
362 if (IMAP->num_msgs > 0) {
363 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
365 original_highest = 0L;
369 * Now peruse the room for *new* messages only.
372 for (j = 0; j < num_msgs; ++j) {
373 if (msglist[j] > original_highest) {
374 imap_add_single_msgid(msglist[j], NULL);
378 imap_set_seen_flags(original_num_msgs);
381 * If new messages have arrived, tell the client about them.
383 if (IMAP->num_msgs > original_num_msgs) {
385 for (j = 0; j < num_msgs; ++j) {
386 if (IMAP->flags[j] & IMAP_RECENT) {
391 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
392 cprintf("* %d RECENT\r\n", num_recent);
398 IMAP->last_mtime = CC->room.QRmtime;
408 * This cleanup function blows away the temporary memory and files used by
411 void imap_cleanup_function(void)
414 /* Don't do this stuff if this is not a IMAP session! */
415 if (CC->h_command_function != imap_command_loop)
418 /* If there is a mailbox selected, auto-expunge it. */
419 if (IMAP->selected) {
423 CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
425 imap_free_transmitted_message();
427 if (IMAP->cached_rfc822_data != NULL) {
428 free(IMAP->cached_rfc822_data);
429 IMAP->cached_rfc822_data = NULL;
430 IMAP->cached_rfc822_msgnum = (-1);
431 IMAP->cached_rfc822_withbody = 0;
434 if (IMAP->cached_body != NULL) {
435 free(IMAP->cached_body);
436 IMAP->cached_body = NULL;
437 IMAP->cached_body_len = 0;
438 IMAP->cached_bodymsgnum = (-1);
442 CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
447 * Does the actual work of the CAPABILITY command (because we need to
448 * output this stuff in other places as well)
450 void imap_output_capability_string(void) {
451 cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
454 if (!CC->redirect_ssl) cprintf(" STARTTLS");
457 #ifndef DISABLE_IMAP_ACL
461 /* We are building a partial implementation of METADATA for the sole purpose
462 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
463 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
464 * metadata in a compatible and graceful way.
466 cprintf(" METADATA");
469 * LIST-EXTENDED was originally going to be required by the METADATA extension.
470 * It was mercifully removed prior to the finalization of RFC5464. We started
471 * implementing this but stopped when we learned that it would not be needed.
472 * If you uncomment this declaration you are responsible for writing a lot of new
475 * cprintf(" LIST-EXTENDED")
480 * implements the CAPABILITY command
482 void imap_capability(int num_parms, char *parms[])
485 imap_output_capability_string();
487 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
493 * Implements the ID command (specified by RFC2971)
495 * We ignore the client-supplied information, and output a NIL response.
496 * Although this is technically a valid implementation of the extension, it
497 * is quite useless. It exists only so that we may see which clients are
498 * making use of this extension.
501 void imap_id(int num_parms, char *parms[])
503 cprintf("* ID NIL\r\n");
504 cprintf("%s OK ID completed\r\n", parms[0]);
510 * Here's where our IMAP session begins its happy day.
512 void imap_greeting(void)
515 strcpy(CC->cs_clientname, "IMAP session");
516 CC->session_specific_data = malloc(sizeof(struct citimap));
517 memset(IMAP, 0, sizeof(struct citimap));
518 IMAP->authstate = imap_as_normal;
519 IMAP->cached_rfc822_data = NULL;
520 IMAP->cached_rfc822_msgnum = (-1);
521 IMAP->cached_rfc822_withbody = 0;
525 cprintf("* BYE; Server busy, try later\r\n");
530 imap_output_capability_string();
531 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
535 * IMAPS is just like IMAP, except it goes crypto right away.
537 void imaps_greeting(void) {
538 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
540 if (!CC->redirect_ssl) CC->kill_me = 1; /* kill session if no crypto */
547 * implements the LOGIN command (ordinary username/password login)
549 void imap_login(int num_parms, char *parms[])
551 if (num_parms != 4) {
552 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
556 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
557 if (CtdlTryPassword(parms[3]) == pass_ok) {
558 cprintf("%s OK [", parms[0]);
559 imap_output_capability_string();
560 cprintf("] Hello, %s\r\n", CC->user.fullname);
565 cprintf("%s BAD Login incorrect\r\n", parms[0]);
570 * Implements the AUTHENTICATE command
572 void imap_authenticate(int num_parms, char *parms[])
576 if (num_parms != 3) {
577 cprintf("%s BAD incorrect number of parameters\r\n",
583 cprintf("%s BAD Already logged in.\r\n", parms[0]);
587 if (!strcasecmp(parms[2], "LOGIN")) {
588 CtdlEncodeBase64(buf, "Username:", 9, 0);
589 cprintf("+ %s\r\n", buf);
590 IMAP->authstate = imap_as_expecting_username;
591 strcpy(IMAP->authseq, parms[0]);
595 if (!strcasecmp(parms[2], "PLAIN")) {
596 // CtdlEncodeBase64(buf, "Username:", 9, 0);
597 // cprintf("+ %s\r\n", buf);
599 IMAP->authstate = imap_as_expecting_plainauth;
600 strcpy(IMAP->authseq, parms[0]);
605 cprintf("%s NO AUTHENTICATE %s failed\r\n",
610 void imap_auth_plain(char *cmd)
612 char decoded_authstring[1024];
618 memset(pass, 0, sizeof(pass));
619 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
620 safestrncpy(ident, decoded_authstring, sizeof ident);
621 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
622 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
624 IMAP->authstate = imap_as_normal;
626 if (!IsEmptyStr(ident)) {
627 result = CtdlLoginExistingUser(user, ident);
630 result = CtdlLoginExistingUser(NULL, user);
633 if (result == login_ok) {
634 if (CtdlTryPassword(pass) == pass_ok) {
635 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
639 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
642 void imap_auth_login_user(char *cmd)
646 CtdlDecodeBase64(buf, cmd, SIZ);
647 CtdlLoginExistingUser(NULL, buf);
648 CtdlEncodeBase64(buf, "Password:", 9, 0);
649 cprintf("+ %s\r\n", buf);
650 IMAP->authstate = imap_as_expecting_password;
654 void imap_auth_login_pass(char *cmd)
658 memset(buf, 0, sizeof(buf));
659 CtdlDecodeBase64(buf, cmd, SIZ);
660 if (CtdlTryPassword(buf) == pass_ok) {
661 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
663 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
665 IMAP->authstate = imap_as_normal;
671 * implements the STARTTLS command (Citadel API version)
673 void imap_starttls(int num_parms, char *parms[])
675 char ok_response[SIZ];
676 char nosup_response[SIZ];
677 char error_response[SIZ];
680 "%s OK begin TLS negotiation now\r\n",
682 sprintf(nosup_response,
683 "%s NO TLS not supported here\r\n",
685 sprintf(error_response,
686 "%s BAD Internal error\r\n",
688 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
693 * implements the SELECT command
695 void imap_select(int num_parms, char *parms[])
698 char augmented_roomname[ROOMNAMELEN];
702 struct ctdlroom QRscratch;
708 /* Convert the supplied folder name to a roomname */
709 i = imap_roomname(towhere, sizeof towhere, parms[2]);
711 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
715 floornum = (i & 0x00ff);
716 roomflags = (i & 0xff00);
718 /* First try a regular match */
719 c = CtdlGetRoom(&QRscratch, towhere);
721 /* Then try a mailbox name match */
723 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
725 c = CtdlGetRoom(&QRscratch, augmented_roomname);
727 strcpy(towhere, augmented_roomname);
730 /* If the room exists, check security/access */
732 /* See if there is an existing user/room relationship */
733 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
735 /* normal clients have to pass through security */
741 /* Fail here if no such room */
743 cprintf("%s NO ... no such room, or access denied\r\n",
748 /* If we already had some other folder selected, auto-expunge it */
752 * CtdlUserGoto() formally takes us to the desired room, happily returning
753 * the number of messages and number of new messages.
755 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
756 CtdlUserGoto(NULL, 0, 0, &msgs, &new);
759 if (!strcasecmp(parms[1], "EXAMINE")) {
766 IMAP->last_mtime = CC->room.QRmtime;
768 cprintf("* %d EXISTS\r\n", msgs);
769 cprintf("* %d RECENT\r\n", new);
771 cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
772 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
774 /* Technically, \Deleted is a valid flag, but not a permanent flag,
775 * because we don't maintain its state across sessions. Citadel
776 * automatically expunges mailboxes when they are de-selected.
778 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
779 * some clients (particularly Thunderbird) to misbehave -- they simply
780 * elect not to transmit the flag at all. So we have to advertise
781 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
783 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
784 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
786 cprintf("%s OK [%s] %s completed\r\n",
788 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
794 * Does the real work for expunge.
796 int imap_do_expunge(void)
799 int num_expunged = 0;
800 long *delmsgs = NULL;
803 CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
804 if (IMAP->selected == 0) {
808 if (IMAP->num_msgs > 0) {
809 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
810 for (i = 0; i < IMAP->num_msgs; ++i) {
811 if (IMAP->flags[i] & IMAP_DELETED) {
812 delmsgs[num_delmsgs++] = IMAP->msgids[i];
815 if (num_delmsgs > 0) {
816 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
818 num_expunged += num_delmsgs;
822 if (num_expunged > 0) {
823 imap_rescan_msgids();
826 CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n",
827 num_expunged, CC->room.QRname);
828 return (num_expunged);
833 * implements the EXPUNGE command syntax
835 void imap_expunge(int num_parms, char *parms[])
837 int num_expunged = 0;
839 num_expunged = imap_do_expunge();
840 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
845 * implements the CLOSE command
847 void imap_close(int num_parms, char *parms[])
850 /* Yes, we always expunge on close. */
851 if (IMAP->selected) {
858 cprintf("%s OK CLOSE completed\r\n", parms[0]);
863 * Implements the NAMESPACE command.
865 void imap_namespace(int num_parms, char *parms[])
872 cprintf("* NAMESPACE ");
874 /* All personal folders are subordinate to INBOX. */
875 cprintf("((\"INBOX/\" \"/\")) ");
877 /* Other users' folders ... coming soon! FIXME */
880 /* Show all floors as shared namespaces. Neato! */
882 for (i = 0; i < MAXFLOORS; ++i) {
883 fl = CtdlGetCachedFloor(i);
884 if (fl->f_flags & F_INUSE) {
885 if (floors > 0) cprintf(" ");
887 sprintf(buf, "%s/", fl->f_name);
895 /* Wind it up with a newline and a completion message. */
897 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
903 * Implements the CREATE command
906 void imap_create(int num_parms, char *parms[])
909 char roomname[ROOMNAMELEN];
914 char *notification_message = NULL;
917 cprintf("%s NO A foder name must be specified\r\n", parms[0]);
921 if (strchr(parms[2], '\\') != NULL) {
922 cprintf("%s NO Invalid character in folder name\r\n", parms[0]);
923 CtdlLogPrintf(CTDL_DEBUG, "invalid character in folder name\n");
927 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
929 cprintf("%s NO Invalid mailbox name or location\r\n",
931 CtdlLogPrintf(CTDL_DEBUG, "invalid mailbox name or location\n");
934 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
935 flags = (ret & 0xff00); /* upper 8 bits = flags */
937 if (flags & IR_MAILBOX) {
938 if (strncasecmp(parms[2], "INBOX/", 6)) {
939 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
940 CtdlLogPrintf(CTDL_DEBUG, "not subordinate to inbox\n");
945 if (flags & IR_MAILBOX) {
946 newroomtype = 4; /* private mailbox */
947 newroomview = VIEW_MAILBOX;
949 newroomtype = 0; /* public folder */
950 newroomview = VIEW_BBS;
953 CtdlLogPrintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
954 roomname, floornum, newroomtype);
956 ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
958 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY! BYNARI CONNECTOR DEPENDS ON IT! ***/
959 cprintf("%s NO Mailbox already exists, or create failed\r\n", parms[0]);
961 cprintf("%s OK CREATE completed\r\n", parms[0]);
962 /* post a message in Aide> describing the new room */
963 notification_message = malloc(1024);
964 snprintf(notification_message, 1024,
965 "A new room called \"%s\" has been created by %s%s%s%s\n",
968 ((ret & QR_MAILBOX) ? " [personal]" : ""),
969 ((ret & QR_PRIVATE) ? " [private]" : ""),
970 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
972 CtdlAideMessage(notification_message, "Room Creation Message");
973 free(notification_message);
975 CtdlLogPrintf(CTDL_DEBUG, "imap_create() completed\n");
980 * Locate a room by its IMAP folder name, and check access to it.
981 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
983 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
986 char augmented_roomname[ROOMNAMELEN];
987 char roomname[ROOMNAMELEN];
989 struct ctdlroom QRscratch;
993 ret = imap_roomname(roomname, sizeof roomname, foldername);
998 /* First try a regular match */
999 c = CtdlGetRoom(&QRscratch, roomname);
1001 /* Then try a mailbox name match */
1003 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
1004 &CC->user, roomname);
1005 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1007 strcpy(roomname, augmented_roomname);
1010 /* If the room exists, check security/access */
1012 /* See if there is an existing user/room relationship */
1013 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1015 /* normal clients have to pass through security */
1016 if (ra & UA_KNOWN) {
1019 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1024 /* Fail here if no such room */
1026 strcpy(returned_roomname, "");
1029 strcpy(returned_roomname, QRscratch.QRname);
1036 * Implements the STATUS command (sort of)
1039 void imap_status(int num_parms, char *parms[])
1042 char roomname[ROOMNAMELEN];
1044 char savedroom[ROOMNAMELEN];
1047 ret = imap_grabroom(roomname, parms[2], 1);
1050 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1056 * CtdlUserGoto() formally takes us to the desired room, happily returning
1057 * the number of messages and number of new messages. (If another
1058 * folder is selected, save its name so we can return there!!!!!)
1060 if (IMAP->selected) {
1061 strcpy(savedroom, CC->room.QRname);
1063 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1066 * Tell the client what it wants to know. In fact, tell it *more* than
1067 * it wants to know. We happily IGnore the supplied status data item
1068 * names and simply spew all possible data items. It's far easier to
1069 * code and probably saves us some processing time too.
1071 imap_mailboxname(buf, sizeof buf, &CC->room);
1072 cprintf("* STATUS ");
1074 cprintf(" (MESSAGES %d ", msgs);
1075 cprintf("RECENT %d ", new); /* Initially, new==recent */
1076 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1077 cprintf("UNSEEN %d)\r\n", new);
1080 * If another folder is selected, go back to that room so we can resume
1081 * our happy day without violent explosions.
1083 if (IMAP->selected) {
1084 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1088 * Oooh, look, we're done!
1090 cprintf("%s OK STATUS completed\r\n", parms[0]);
1096 * Implements the SUBSCRIBE command
1099 void imap_subscribe(int num_parms, char *parms[])
1102 char roomname[ROOMNAMELEN];
1103 char savedroom[ROOMNAMELEN];
1106 ret = imap_grabroom(roomname, parms[2], 1);
1109 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1117 * CtdlUserGoto() formally takes us to the desired room, which has the side
1118 * effect of marking the room as not-zapped ... exactly the effect
1119 * we're looking for.
1121 if (IMAP->selected) {
1122 strcpy(savedroom, CC->room.QRname);
1124 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1127 * If another folder is selected, go back to that room so we can resume
1128 * our happy day without violent explosions.
1130 if (IMAP->selected) {
1131 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1134 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1139 * Implements the UNSUBSCRIBE command
1142 void imap_unsubscribe(int num_parms, char *parms[])
1145 char roomname[ROOMNAMELEN];
1146 char savedroom[ROOMNAMELEN];
1149 ret = imap_grabroom(roomname, parms[2], 1);
1152 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1158 * CtdlUserGoto() formally takes us to the desired room.
1160 if (IMAP->selected) {
1161 strcpy(savedroom, CC->room.QRname);
1163 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1166 * Now make the API call to zap the room
1168 if (CtdlForgetThisRoom() == 0) {
1169 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1172 ("%s NO You may not unsubscribe from this folder.\r\n",
1177 * If another folder is selected, go back to that room so we can resume
1178 * our happy day without violent explosions.
1180 if (IMAP->selected) {
1181 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1188 * Implements the DELETE command
1191 void imap_delete(int num_parms, char *parms[])
1194 char roomname[ROOMNAMELEN];
1195 char savedroom[ROOMNAMELEN];
1198 ret = imap_grabroom(roomname, parms[2], 1);
1200 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1206 * CtdlUserGoto() formally takes us to the desired room, happily returning
1207 * the number of messages and number of new messages. (If another
1208 * folder is selected, save its name so we can return there!!!!!)
1210 if (IMAP->selected) {
1211 strcpy(savedroom, CC->room.QRname);
1213 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1216 * Now delete the room.
1218 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1219 CtdlScheduleRoomForDeletion(&CC->room);
1220 cprintf("%s OK DELETE completed\r\n", parms[0]);
1222 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1226 * If another folder is selected, go back to that room so we can resume
1227 * our happy day without violent explosions.
1229 if (IMAP->selected) {
1230 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1236 * Back end function for imap_rename()
1238 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1240 char foldername[SIZ];
1241 char newfoldername[SIZ];
1242 char newroomname[ROOMNAMELEN];
1244 struct irl *irlp = NULL; /* scratch pointer */
1245 struct irlparms *irlparms;
1247 irlparms = (struct irlparms *) data;
1248 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1250 /* Rename subfolders */
1251 if ((!strncasecmp(foldername, irlparms->oldname,
1252 strlen(irlparms->oldname))
1253 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1255 sprintf(newfoldername, "%s/%s",
1257 &foldername[strlen(irlparms->oldname) + 1]
1260 newfloor = imap_roomname(newroomname,
1262 newfoldername) & 0xFF;
1264 irlp = (struct irl *) malloc(sizeof(struct irl));
1265 strcpy(irlp->irl_newroom, newroomname);
1266 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1267 irlp->irl_newfloor = newfloor;
1268 irlp->next = *(irlparms->irl);
1269 *(irlparms->irl) = irlp;
1275 * Implements the RENAME command
1278 void imap_rename(int num_parms, char *parms[])
1280 char old_room[ROOMNAMELEN];
1281 char new_room[ROOMNAMELEN];
1285 struct irl *irl = NULL; /* the list */
1286 struct irl *irlp = NULL; /* scratch pointer */
1287 struct irlparms irlparms;
1290 if (strchr(parms[3], '\\') != NULL) {
1291 cprintf("%s NO Invalid character in folder name\r\n",
1296 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1297 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1298 new_floor = (newr & 0xFF);
1300 r = CtdlRenameRoom(old_room, new_room, new_floor);
1302 if (r == crr_room_not_found) {
1303 cprintf("%s NO Could not locate this folder\r\n",
1307 if (r == crr_already_exists) {
1308 cprintf("%s NO '%s' already exists.\r\n", parms[0], parms[2]);
1311 if (r == crr_noneditable) {
1312 cprintf("%s NO This folder is not editable.\r\n", parms[0]);
1315 if (r == crr_invalid_floor) {
1316 cprintf("%s NO Folder root does not exist.\r\n", parms[0]);
1319 if (r == crr_access_denied) {
1320 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1325 cprintf("%s NO Rename failed - undefined error %d\r\n",
1330 /* If this is the INBOX, then RFC2060 says we have to just move the
1331 * contents. In a Citadel environment it's easier to rename the room
1332 * (already did that) and create a new inbox.
1334 if (!strcasecmp(parms[2], "INBOX")) {
1335 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1338 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1340 irlparms.oldname = parms[2];
1341 irlparms.newname = parms[3];
1342 irlparms.irl = &irl;
1343 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1345 /* ... and now rename them. */
1346 while (irl != NULL) {
1347 r = CtdlRenameRoom(irl->irl_oldroom,
1351 /* FIXME handle error returns better */
1352 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1360 snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1365 CtdlAideMessage(buf, "IMAP folder rename");
1367 cprintf("%s OK RENAME completed\r\n", parms[0]);
1374 * Main command loop for IMAP sessions.
1376 void imap_command_loop(void)
1381 struct timeval tv1, tv2;
1382 suseconds_t total_time = 0;
1383 int untagged_ok = 1;
1385 gettimeofday(&tv1, NULL);
1386 CC->lastcmd = time(NULL);
1387 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1389 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1390 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1395 if (IMAP->authstate == imap_as_expecting_password) {
1396 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1398 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1399 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1401 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1402 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1405 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1408 while (strlen(cmdbuf) < 5)
1409 strcat(cmdbuf, " ");
1411 /* strip off l/t whitespace and CRLF */
1412 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1413 cmdbuf[strlen(cmdbuf) - 1] = 0;
1414 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1415 cmdbuf[strlen(cmdbuf) - 1] = 0;
1418 /* If we're in the middle of a multi-line command, handle that */
1419 if (IMAP->authstate == imap_as_expecting_username) {
1420 imap_auth_login_user(cmdbuf);
1423 if (IMAP->authstate == imap_as_expecting_plainauth) {
1424 imap_auth_plain(cmdbuf);
1427 if (IMAP->authstate == imap_as_expecting_password) {
1428 imap_auth_login_pass(cmdbuf);
1433 /* Ok, at this point we're in normal command mode.
1434 * If the command just submitted does not contain a literal, we
1435 * might think about delivering some untagged stuff...
1437 if (cmdbuf[strlen(cmdbuf)-1] == '}') {
1441 /* Grab the tag, command, and parameters. */
1442 num_parms = imap_parameterize(parms, cmdbuf);
1444 /* RFC3501 says that we cannot output untagged data during these commands */
1445 if (num_parms >= 2) {
1446 if ( (!strcasecmp(parms[1], "FETCH"))
1447 || (!strcasecmp(parms[1], "STORE"))
1448 || (!strcasecmp(parms[1], "SEARCH"))
1456 /* we can put any additional untagged stuff right here in the future */
1459 * Before processing the command that was just entered... if we happen
1460 * to have a folder selected, we'd like to rescan that folder for new
1461 * messages, and for deletions/changes of existing messages. This
1462 * could probably be optimized better with some deep thought...
1464 if (IMAP->selected) {
1465 imap_rescan_msgids();
1469 /* Now for the command set. */
1471 if (num_parms < 2) {
1472 cprintf("BAD syntax error\r\n");
1475 /* The commands below may be executed in any state */
1477 else if ((!strcasecmp(parms[1], "NOOP"))
1478 || (!strcasecmp(parms[1], "CHECK"))) {
1479 cprintf("%s OK No operation\r\n",
1483 else if (!strcasecmp(parms[1], "ID")) {
1484 imap_id(num_parms, parms);
1488 else if (!strcasecmp(parms[1], "LOGOUT")) {
1489 if (IMAP->selected) {
1490 imap_do_expunge(); /* yes, we auto-expunge at logout */
1492 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1493 cprintf("%s OK Citadel IMAP session ended.\r\n",
1499 else if (!strcasecmp(parms[1], "LOGIN")) {
1500 imap_login(num_parms, parms);
1503 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1504 imap_authenticate(num_parms, parms);
1507 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1508 imap_capability(num_parms, parms);
1511 else if (!strcasecmp(parms[1], "STARTTLS")) {
1512 imap_starttls(num_parms, parms);
1515 else if (!CC->logged_in) {
1516 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1519 /* The commans below require a logged-in state */
1521 else if (!strcasecmp(parms[1], "SELECT")) {
1522 imap_select(num_parms, parms);
1525 else if (!strcasecmp(parms[1], "EXAMINE")) {
1526 imap_select(num_parms, parms);
1529 else if (!strcasecmp(parms[1], "LSUB")) {
1530 imap_list(num_parms, parms);
1533 else if (!strcasecmp(parms[1], "LIST")) {
1534 imap_list(num_parms, parms);
1537 else if (!strcasecmp(parms[1], "CREATE")) {
1538 imap_create(num_parms, parms);
1541 else if (!strcasecmp(parms[1], "DELETE")) {
1542 imap_delete(num_parms, parms);
1545 else if (!strcasecmp(parms[1], "RENAME")) {
1546 imap_rename(num_parms, parms);
1549 else if (!strcasecmp(parms[1], "STATUS")) {
1550 imap_status(num_parms, parms);
1553 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1554 imap_subscribe(num_parms, parms);
1557 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1558 imap_unsubscribe(num_parms, parms);
1561 else if (!strcasecmp(parms[1], "APPEND")) {
1562 imap_append(num_parms, parms);
1565 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1566 imap_namespace(num_parms, parms);
1569 else if (!strcasecmp(parms[1], "SETACL")) {
1570 imap_setacl(num_parms, parms);
1573 else if (!strcasecmp(parms[1], "DELETEACL")) {
1574 imap_deleteacl(num_parms, parms);
1577 else if (!strcasecmp(parms[1], "GETACL")) {
1578 imap_getacl(num_parms, parms);
1581 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1582 imap_listrights(num_parms, parms);
1585 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1586 imap_myrights(num_parms, parms);
1589 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1590 imap_getmetadata(num_parms, parms);
1593 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1594 imap_setmetadata(num_parms, parms);
1597 else if (IMAP->selected == 0) {
1598 cprintf("%s BAD no folder selected\r\n", parms[0]);
1601 /* The commands below require the SELECT state on a mailbox */
1603 else if (!strcasecmp(parms[1], "FETCH")) {
1604 imap_fetch(num_parms, parms);
1607 else if ((!strcasecmp(parms[1], "UID"))
1608 && (!strcasecmp(parms[2], "FETCH"))) {
1609 imap_uidfetch(num_parms, parms);
1612 else if (!strcasecmp(parms[1], "SEARCH")) {
1613 imap_search(num_parms, parms);
1616 else if ((!strcasecmp(parms[1], "UID"))
1617 && (!strcasecmp(parms[2], "SEARCH"))) {
1618 imap_uidsearch(num_parms, parms);
1621 else if (!strcasecmp(parms[1], "STORE")) {
1622 imap_store(num_parms, parms);
1625 else if ((!strcasecmp(parms[1], "UID"))
1626 && (!strcasecmp(parms[2], "STORE"))) {
1627 imap_uidstore(num_parms, parms);
1630 else if (!strcasecmp(parms[1], "COPY")) {
1631 imap_copy(num_parms, parms);
1634 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "COPY"))) {
1635 imap_uidcopy(num_parms, parms);
1638 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1639 imap_expunge(num_parms, parms);
1642 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "EXPUNGE"))) {
1643 imap_expunge(num_parms, parms);
1646 else if (!strcasecmp(parms[1], "CLOSE")) {
1647 imap_close(num_parms, parms);
1650 /* End of commands. If we get here, the command is either invalid
1655 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1658 /* If the client transmitted a message we can free it now */
1659 imap_free_transmitted_message();
1661 gettimeofday(&tv2, NULL);
1662 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1663 CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1664 (total_time / 1000000),
1665 (total_time % 1000000)
1670 const char *CitadelServiceIMAP="IMAP";
1671 const char *CitadelServiceIMAPS="IMAPS";
1674 * This function is called to register the IMAP extension with Citadel.
1676 CTDL_MODULE_INIT(imap)
1680 CtdlRegisterServiceHook(config.c_imap_port,
1681 NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1683 CtdlRegisterServiceHook(config.c_imaps_port,
1684 NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1686 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1689 /* return our Subversion id for the Log */