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"
73 #include "ctdl_module.h"
76 /* imap_rename() uses this struct containing list of rooms to rename */
79 char irl_oldroom[ROOMNAMELEN];
80 char irl_newroom[ROOMNAMELEN];
84 /* Data which is passed between imap_rename() and imap_rename_backend() */
93 * If there is a message ID map in memory, free it
95 void imap_free_msgids(void)
97 if (IMAP->msgids != NULL) {
103 if (IMAP->flags != NULL) {
107 IMAP->last_mtime = (-1);
112 * If there is a transmitted message in memory, free it
114 void imap_free_transmitted_message(void)
116 if (IMAP->transmitted_message != NULL) {
117 free(IMAP->transmitted_message);
118 IMAP->transmitted_message = NULL;
119 IMAP->transmitted_length = 0;
125 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
126 * sets stored in the visit record for this user/room. Note that we have
127 * to parse each sequence set manually here, because calling the utility
128 * function is_msg_in_sequence_set() over and over again is too expensive.
130 * first_msg should be set to 0 to rescan the flags for every message in the
131 * room, or some other value if we're only interested in an incremental
134 void imap_set_seen_flags(int first_msg)
140 char setstr[64], lostr[64], histr[64];
143 if (IMAP->num_msgs < 1) return;
144 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
146 for (i = first_msg; i < IMAP->num_msgs; ++i) {
147 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_SEEN;
148 IMAP->flags[i] |= IMAP_RECENT;
149 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_ANSWERED;
153 * Do the "\Seen" flag.
154 * (Any message not "\Seen" is considered "\Recent".)
156 num_sets = num_tokens(vbuf.v_seen, ',');
157 for (s=0; s<num_sets; ++s) {
158 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
160 extract_token(lostr, setstr, 0, ':', sizeof lostr);
161 if (num_tokens(setstr, ':') >= 2) {
162 extract_token(histr, setstr, 1, ':', sizeof histr);
163 if (!strcmp(histr, "*")) {
164 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
168 strcpy(histr, lostr);
173 for (i = first_msg; i < IMAP->num_msgs; ++i) {
174 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
175 IMAP->flags[i] |= IMAP_SEEN;
176 IMAP->flags[i] = IMAP->flags[i] & ~IMAP_RECENT;
181 /* Do the ANSWERED flag */
182 num_sets = num_tokens(vbuf.v_answered, ',');
183 for (s=0; s<num_sets; ++s) {
184 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
186 extract_token(lostr, setstr, 0, ':', sizeof lostr);
187 if (num_tokens(setstr, ':') >= 2) {
188 extract_token(histr, setstr, 1, ':', sizeof histr);
189 if (!strcmp(histr, "*")) {
190 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
194 strcpy(histr, lostr);
199 for (i = first_msg; i < IMAP->num_msgs; ++i) {
200 if ((IMAP->msgids[i] >= lo) && (IMAP->msgids[i] <= hi)){
201 IMAP->flags[i] |= IMAP_ANSWERED;
211 * Back end for imap_load_msgids()
213 * Optimization: instead of calling realloc() to add each message, we
214 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
215 * allows the mapping to proceed much faster.
217 void imap_add_single_msgid(long msgnum, void *userdata)
221 if (IMAP->num_msgs > IMAP->num_alloc) {
222 IMAP->num_alloc += REALLOC_INCREMENT;
223 IMAP->msgids = realloc(IMAP->msgids, (IMAP->num_alloc * sizeof(long)) );
224 IMAP->flags = realloc(IMAP->flags, (IMAP->num_alloc * sizeof(long)) );
226 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
227 IMAP->flags[IMAP->num_msgs - 1] = 0;
233 * Set up a message ID map for the current room (folder)
235 void imap_load_msgids(void)
237 struct cdbdata *cdbfr;
239 if (IMAP->selected == 0) {
240 CtdlLogPrintf(CTDL_ERR,
241 "imap_load_msgids() can't run; no room selected\n");
245 imap_free_msgids(); /* If there was already a map, free it */
247 /* Load the message list */
248 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
250 IMAP->msgids = malloc(cdbfr->len);
251 memcpy(IMAP->msgids, cdbfr->ptr, cdbfr->len);
252 IMAP->num_msgs = cdbfr->len / sizeof(long);
253 IMAP->num_alloc = cdbfr->len / sizeof(long);
257 if (IMAP->num_msgs) {
258 IMAP->flags = malloc(IMAP->num_alloc * sizeof(long));
259 memset(IMAP->flags, 0, (IMAP->num_alloc * sizeof(long)) );
262 imap_set_seen_flags(0);
267 * Re-scan the selected room (folder) and see if it's been changed at all
269 void imap_rescan_msgids(void)
272 int original_num_msgs = 0;
273 long original_highest = 0L;
275 int message_still_exists;
276 struct cdbdata *cdbfr;
277 long *msglist = NULL;
281 if (IMAP->selected == 0) {
282 CtdlLogPrintf(CTDL_ERR, "imap_load_msgids() can't run; no room selected\n");
287 * Check to see if the room's contents have changed.
288 * If not, we can avoid this rescan.
290 CtdlGetRoom(&CC->room, CC->room.QRname);
291 if (IMAP->last_mtime == CC->room.QRmtime) { /* No changes! */
295 /* Load the *current* message list from disk, so we can compare it
296 * to what we have in memory.
298 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
300 msglist = malloc(cdbfr->len);
301 if (msglist == NULL) {
302 CtdlLogPrintf(CTDL_CRIT, "malloc() failed\n");
305 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
306 num_msgs = cdbfr->len / sizeof(long);
313 * Check to see if any of the messages we know about have been expunged
315 if (IMAP->num_msgs > 0) {
317 for (i = 0; i < IMAP->num_msgs; ++i) {
319 message_still_exists = 0;
321 for (j = jstart; j < num_msgs; ++j) {
322 if (msglist[j] == IMAP->msgids[i]) {
323 message_still_exists = 1;
330 if (message_still_exists == 0) {
331 cprintf("* %d EXPUNGE\r\n", i + 1);
333 /* Here's some nice stupid nonsense. When a
334 * message is expunged, we have to slide all
335 * the existing messages up in the message
339 memcpy(&IMAP->msgids[i],
340 &IMAP->msgids[i + 1],
342 (IMAP->num_msgs - i)));
343 memcpy(&IMAP->flags[i],
346 (IMAP->num_msgs - i)));
355 * Remember how many messages were here before we re-scanned.
357 original_num_msgs = IMAP->num_msgs;
358 if (IMAP->num_msgs > 0) {
359 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
361 original_highest = 0L;
365 * Now peruse the room for *new* messages only.
366 * This logic is probably the cause of Bug # 368
367 * [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
370 for (j = 0; j < num_msgs; ++j) {
371 if (msglist[j] > original_highest) {
372 imap_add_single_msgid(msglist[j], NULL);
376 imap_set_seen_flags(original_num_msgs);
379 * If new messages have arrived, tell the client about them.
381 if (IMAP->num_msgs > original_num_msgs) {
383 for (j = 0; j < num_msgs; ++j) {
384 if (IMAP->flags[j] & IMAP_RECENT) {
389 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
390 cprintf("* %d RECENT\r\n", num_recent);
396 IMAP->last_mtime = CC->room.QRmtime;
401 * This cleanup function blows away the temporary memory and files used by
404 void imap_cleanup_function(void)
407 /* Don't do this stuff if this is not a IMAP session! */
408 if (CC->h_command_function != imap_command_loop)
411 /* If there is a mailbox selected, auto-expunge it. */
412 if (IMAP->selected) {
416 CtdlLogPrintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
418 imap_free_transmitted_message();
420 if (IMAP->cached_rfc822_data != NULL) {
421 free(IMAP->cached_rfc822_data);
422 IMAP->cached_rfc822_data = NULL;
423 IMAP->cached_rfc822_msgnum = (-1);
424 IMAP->cached_rfc822_withbody = 0;
427 if (IMAP->cached_body != NULL) {
428 free(IMAP->cached_body);
429 IMAP->cached_body = NULL;
430 IMAP->cached_body_len = 0;
431 IMAP->cached_bodymsgnum = (-1);
435 CtdlLogPrintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
440 * Does the actual work of the CAPABILITY command (because we need to
441 * output this stuff in other places as well)
443 void imap_output_capability_string(void) {
444 cprintf("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
447 if (!CC->redirect_ssl) cprintf(" STARTTLS");
450 #ifndef DISABLE_IMAP_ACL
454 /* We are building a partial implementation of METADATA for the sole purpose
455 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
456 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
457 * metadata in a compatible and graceful way.
459 cprintf(" METADATA");
462 * LIST-EXTENDED was originally going to be required by the METADATA extension.
463 * It was mercifully removed prior to the finalization of RFC5464. We started
464 * implementing this but stopped when we learned that it would not be needed.
465 * If you uncomment this declaration you are responsible for writing a lot of new
468 * cprintf(" LIST-EXTENDED")
474 * implements the CAPABILITY command
476 void imap_capability(int num_parms, char *parms[])
479 imap_output_capability_string();
481 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
486 * Implements the ID command (specified by RFC2971)
488 * We ignore the client-supplied information, and output a NIL response.
489 * Although this is technically a valid implementation of the extension, it
490 * is quite useless. It exists only so that we may see which clients are
491 * making use of this extension.
494 void imap_id(int num_parms, char *parms[])
496 cprintf("* ID NIL\r\n");
497 cprintf("%s OK ID completed\r\n", parms[0]);
502 * Here's where our IMAP session begins its happy day.
504 void imap_greeting(void)
507 strcpy(CC->cs_clientname, "IMAP session");
508 CC->session_specific_data = malloc(sizeof(struct citimap));
509 memset(IMAP, 0, sizeof(struct citimap));
510 IMAP->authstate = imap_as_normal;
511 IMAP->cached_rfc822_data = NULL;
512 IMAP->cached_rfc822_msgnum = (-1);
513 IMAP->cached_rfc822_withbody = 0;
517 cprintf("* BYE; Server busy, try later\r\n");
522 imap_output_capability_string();
523 cprintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
528 * IMAPS is just like IMAP, except it goes crypto right away.
530 void imaps_greeting(void) {
531 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
533 if (!CC->redirect_ssl) CC->kill_me = 1; /* kill session if no crypto */
540 * implements the LOGIN command (ordinary username/password login)
542 void imap_login(int num_parms, char *parms[])
544 if (num_parms != 4) {
545 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
549 if (CtdlLoginExistingUser(NULL, parms[2]) == login_ok) {
550 if (CtdlTryPassword(parms[3]) == pass_ok) {
551 cprintf("%s OK [", parms[0]);
552 imap_output_capability_string();
553 cprintf("] Hello, %s\r\n", CC->user.fullname);
558 cprintf("%s BAD Login incorrect\r\n", parms[0]);
563 * Implements the AUTHENTICATE command
565 void imap_authenticate(int num_parms, char *parms[])
569 if (num_parms != 3) {
570 cprintf("%s BAD incorrect number of parameters\r\n",
576 cprintf("%s BAD Already logged in.\r\n", parms[0]);
580 if (!strcasecmp(parms[2], "LOGIN")) {
581 CtdlEncodeBase64(buf, "Username:", 9, 0);
582 cprintf("+ %s\r\n", buf);
583 IMAP->authstate = imap_as_expecting_username;
584 strcpy(IMAP->authseq, parms[0]);
588 if (!strcasecmp(parms[2], "PLAIN")) {
589 // CtdlEncodeBase64(buf, "Username:", 9, 0);
590 // cprintf("+ %s\r\n", buf);
592 IMAP->authstate = imap_as_expecting_plainauth;
593 strcpy(IMAP->authseq, parms[0]);
598 cprintf("%s NO AUTHENTICATE %s failed\r\n",
604 void imap_auth_plain(char *cmd)
606 char decoded_authstring[1024];
612 memset(pass, 0, sizeof(pass));
613 CtdlDecodeBase64(decoded_authstring, cmd, strlen(cmd));
614 safestrncpy(ident, decoded_authstring, sizeof ident);
615 safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
616 safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
618 IMAP->authstate = imap_as_normal;
620 if (!IsEmptyStr(ident)) {
621 result = CtdlLoginExistingUser(user, ident);
624 result = CtdlLoginExistingUser(NULL, user);
627 if (result == login_ok) {
628 if (CtdlTryPassword(pass) == pass_ok) {
629 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
633 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
637 void imap_auth_login_user(char *cmd)
641 CtdlDecodeBase64(buf, cmd, SIZ);
642 CtdlLoginExistingUser(NULL, buf);
643 CtdlEncodeBase64(buf, "Password:", 9, 0);
644 cprintf("+ %s\r\n", buf);
645 IMAP->authstate = imap_as_expecting_password;
650 void imap_auth_login_pass(char *cmd)
654 memset(buf, 0, sizeof(buf));
655 CtdlDecodeBase64(buf, cmd, SIZ);
656 if (CtdlTryPassword(buf) == pass_ok) {
657 cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
659 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
661 IMAP->authstate = imap_as_normal;
667 * implements the STARTTLS command (Citadel API version)
669 void imap_starttls(int num_parms, char *parms[])
671 char ok_response[SIZ];
672 char nosup_response[SIZ];
673 char error_response[SIZ];
675 sprintf(ok_response, "%s OK begin TLS negotiation now\r\n", parms[0]);
676 sprintf(nosup_response, "%s NO TLS not supported here\r\n", parms[0]);
677 sprintf(error_response, "%s BAD Internal error\r\n", parms[0]);
678 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
683 * implements the SELECT command
685 void imap_select(int num_parms, char *parms[])
688 char augmented_roomname[ROOMNAMELEN];
692 struct ctdlroom QRscratch;
698 /* Convert the supplied folder name to a roomname */
699 i = imap_roomname(towhere, sizeof towhere, parms[2]);
701 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
705 floornum = (i & 0x00ff);
706 roomflags = (i & 0xff00);
708 /* First try a regular match */
709 c = CtdlGetRoom(&QRscratch, towhere);
711 /* Then try a mailbox name match */
713 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
714 c = CtdlGetRoom(&QRscratch, augmented_roomname);
716 strcpy(towhere, augmented_roomname);
720 /* If the room exists, check security/access */
722 /* See if there is an existing user/room relationship */
723 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
725 /* normal clients have to pass through security */
731 /* Fail here if no such room */
733 cprintf("%s NO ... no such room, or access denied\r\n", parms[0]);
737 /* If we already had some other folder selected, auto-expunge it */
741 * CtdlUserGoto() formally takes us to the desired room, happily returning
742 * the number of messages and number of new messages.
744 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
745 CtdlUserGoto(NULL, 0, 0, &msgs, &new);
748 if (!strcasecmp(parms[1], "EXAMINE")) {
755 IMAP->last_mtime = CC->room.QRmtime;
757 cprintf("* %d EXISTS\r\n", msgs);
758 cprintf("* %d RECENT\r\n", new);
760 cprintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
761 cprintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
763 /* Technically, \Deleted is a valid flag, but not a permanent flag,
764 * because we don't maintain its state across sessions. Citadel
765 * automatically expunges mailboxes when they are de-selected.
767 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
768 * some clients (particularly Thunderbird) to misbehave -- they simply
769 * elect not to transmit the flag at all. So we have to advertise
770 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
772 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
773 cprintf("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
775 cprintf("%s OK [%s] %s completed\r\n",
777 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]
783 * Does the real work for expunge.
785 int imap_do_expunge(void)
788 int num_expunged = 0;
789 long *delmsgs = NULL;
792 CtdlLogPrintf(CTDL_DEBUG, "imap_do_expunge() called\n");
793 if (IMAP->selected == 0) {
797 if (IMAP->num_msgs > 0) {
798 delmsgs = malloc(IMAP->num_msgs * sizeof(long));
799 for (i = 0; i < IMAP->num_msgs; ++i) {
800 if (IMAP->flags[i] & IMAP_DELETED) {
801 delmsgs[num_delmsgs++] = IMAP->msgids[i];
804 if (num_delmsgs > 0) {
805 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
807 num_expunged += num_delmsgs;
811 if (num_expunged > 0) {
812 imap_rescan_msgids();
815 CtdlLogPrintf(CTDL_DEBUG, "Expunged %d messages from <%s>\n", num_expunged, CC->room.QRname);
816 return (num_expunged);
821 * implements the EXPUNGE command syntax
823 void imap_expunge(int num_parms, char *parms[])
825 int num_expunged = 0;
827 num_expunged = imap_do_expunge();
828 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
833 * implements the CLOSE command
835 void imap_close(int num_parms, char *parms[])
838 /* Yes, we always expunge on close. */
839 if (IMAP->selected) {
846 cprintf("%s OK CLOSE completed\r\n", parms[0]);
851 * Implements the NAMESPACE command.
853 void imap_namespace(int num_parms, char *parms[])
860 cprintf("* NAMESPACE ");
862 /* All personal folders are subordinate to INBOX. */
863 cprintf("((\"INBOX/\" \"/\")) ");
865 /* Other users' folders ... coming soon! FIXME */
868 /* Show all floors as shared namespaces. Neato! */
870 for (i = 0; i < MAXFLOORS; ++i) {
871 fl = CtdlGetCachedFloor(i);
872 if (fl->f_flags & F_INUSE) {
873 if (floors > 0) cprintf(" ");
875 sprintf(buf, "%s/", fl->f_name);
883 /* Wind it up with a newline and a completion message. */
885 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 = CtdlCreateRoom(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 CtdlAideMessage(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 = CtdlGetRoom(&QRscratch, roomname);
988 /* Then try a mailbox name match */
990 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
991 &CC->user, roomname);
992 c = CtdlGetRoom(&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 * CtdlUserGoto() 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 CtdlUserGoto(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 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1075 * Oooh, look, we're done!
1077 cprintf("%s OK STATUS completed\r\n", parms[0]);
1082 * Implements the SUBSCRIBE command
1085 void imap_subscribe(int num_parms, char *parms[])
1088 char roomname[ROOMNAMELEN];
1089 char savedroom[ROOMNAMELEN];
1092 ret = imap_grabroom(roomname, parms[2], 1);
1095 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1103 * CtdlUserGoto() formally takes us to the desired room, which has the side
1104 * effect of marking the room as not-zapped ... exactly the effect
1105 * we're looking for.
1107 if (IMAP->selected) {
1108 strcpy(savedroom, CC->room.QRname);
1110 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1113 * If another folder is selected, go back to that room so we can resume
1114 * our happy day without violent explosions.
1116 if (IMAP->selected) {
1117 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1120 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1125 * Implements the UNSUBSCRIBE command
1128 void imap_unsubscribe(int num_parms, char *parms[])
1131 char roomname[ROOMNAMELEN];
1132 char savedroom[ROOMNAMELEN];
1135 ret = imap_grabroom(roomname, parms[2], 1);
1138 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1144 * CtdlUserGoto() formally takes us to the desired room.
1146 if (IMAP->selected) {
1147 strcpy(savedroom, CC->room.QRname);
1149 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1152 * Now make the API call to zap the room
1154 if (CtdlForgetThisRoom() == 0) {
1155 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1158 ("%s NO You may not unsubscribe from this folder.\r\n",
1163 * If another folder is selected, go back to that room so we can resume
1164 * our happy day without violent explosions.
1166 if (IMAP->selected) {
1167 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1173 * Implements the DELETE command
1176 void imap_delete(int num_parms, char *parms[])
1179 char roomname[ROOMNAMELEN];
1180 char savedroom[ROOMNAMELEN];
1183 ret = imap_grabroom(roomname, parms[2], 1);
1185 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1191 * CtdlUserGoto() formally takes us to the desired room, happily returning
1192 * the number of messages and number of new messages. (If another
1193 * folder is selected, save its name so we can return there!!!!!)
1195 if (IMAP->selected) {
1196 strcpy(savedroom, CC->room.QRname);
1198 CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1201 * Now delete the room.
1203 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1204 CtdlScheduleRoomForDeletion(&CC->room);
1205 cprintf("%s OK DELETE completed\r\n", parms[0]);
1207 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1211 * If another folder is selected, go back to that room so we can resume
1212 * our happy day without violent explosions.
1214 if (IMAP->selected) {
1215 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1221 * Back end function for imap_rename()
1223 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1225 char foldername[SIZ];
1226 char newfoldername[SIZ];
1227 char newroomname[ROOMNAMELEN];
1229 struct irl *irlp = NULL; /* scratch pointer */
1230 struct irlparms *irlparms;
1232 irlparms = (struct irlparms *) data;
1233 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1235 /* Rename subfolders */
1236 if ((!strncasecmp(foldername, irlparms->oldname,
1237 strlen(irlparms->oldname))
1238 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1240 sprintf(newfoldername, "%s/%s",
1242 &foldername[strlen(irlparms->oldname) + 1]
1245 newfloor = imap_roomname(newroomname,
1247 newfoldername) & 0xFF;
1249 irlp = (struct irl *) malloc(sizeof(struct irl));
1250 strcpy(irlp->irl_newroom, newroomname);
1251 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1252 irlp->irl_newfloor = newfloor;
1253 irlp->next = *(irlparms->irl);
1254 *(irlparms->irl) = irlp;
1260 * Implements the RENAME command
1263 void imap_rename(int num_parms, char *parms[])
1265 char old_room[ROOMNAMELEN];
1266 char new_room[ROOMNAMELEN];
1270 struct irl *irl = NULL; /* the list */
1271 struct irl *irlp = NULL; /* scratch pointer */
1272 struct irlparms irlparms;
1275 if (strchr(parms[3], '\\') != NULL) {
1276 cprintf("%s NO Invalid character in folder name\r\n",
1281 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1282 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1283 new_floor = (newr & 0xFF);
1285 r = CtdlRenameRoom(old_room, new_room, new_floor);
1287 if (r == crr_room_not_found) {
1288 cprintf("%s NO Could not locate this folder\r\n",
1292 if (r == crr_already_exists) {
1293 cprintf("%s NO '%s' already exists.\r\n", parms[0], parms[2]);
1296 if (r == crr_noneditable) {
1297 cprintf("%s NO This folder is not editable.\r\n", parms[0]);
1300 if (r == crr_invalid_floor) {
1301 cprintf("%s NO Folder root does not exist.\r\n", parms[0]);
1304 if (r == crr_access_denied) {
1305 cprintf("%s NO You do not have permission to edit this folder.\r\n",
1310 cprintf("%s NO Rename failed - undefined error %d\r\n",
1315 /* If this is the INBOX, then RFC2060 says we have to just move the
1316 * contents. In a Citadel environment it's easier to rename the room
1317 * (already did that) and create a new inbox.
1319 if (!strcasecmp(parms[2], "INBOX")) {
1320 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1323 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1325 irlparms.oldname = parms[2];
1326 irlparms.newname = parms[3];
1327 irlparms.irl = &irl;
1328 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1330 /* ... and now rename them. */
1331 while (irl != NULL) {
1332 r = CtdlRenameRoom(irl->irl_oldroom,
1336 /* FIXME handle error returns better */
1337 CtdlLogPrintf(CTDL_ERR, "CtdlRenameRoom() error %d\n", r);
1345 snprintf(buf, sizeof buf, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1350 CtdlAideMessage(buf, "IMAP folder rename");
1352 cprintf("%s OK RENAME completed\r\n", parms[0]);
1357 * Main command loop for IMAP sessions.
1359 void imap_command_loop(void)
1364 struct timeval tv1, tv2;
1365 suseconds_t total_time = 0;
1366 int untagged_ok = 1;
1368 gettimeofday(&tv1, NULL);
1369 CC->lastcmd = time(NULL);
1370 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1372 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1373 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
1378 if (IMAP->authstate == imap_as_expecting_password) {
1379 CtdlLogPrintf(CTDL_INFO, "IMAP: <password>\n");
1381 else if (IMAP->authstate == imap_as_expecting_plainauth) {
1382 CtdlLogPrintf(CTDL_INFO, "IMAP: <plain_auth>\n");
1384 else if (bmstrcasestr(cmdbuf, " LOGIN ")) {
1385 CtdlLogPrintf(CTDL_INFO, "IMAP: LOGIN...\n");
1388 CtdlLogPrintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1391 while (strlen(cmdbuf) < 5)
1392 strcat(cmdbuf, " ");
1394 /* strip off l/t whitespace and CRLF */
1395 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1396 cmdbuf[strlen(cmdbuf) - 1] = 0;
1397 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1398 cmdbuf[strlen(cmdbuf) - 1] = 0;
1401 /* If we're in the middle of a multi-line command, handle that */
1402 if (IMAP->authstate == imap_as_expecting_username) {
1403 imap_auth_login_user(cmdbuf);
1406 if (IMAP->authstate == imap_as_expecting_plainauth) {
1407 imap_auth_plain(cmdbuf);
1410 if (IMAP->authstate == imap_as_expecting_password) {
1411 imap_auth_login_pass(cmdbuf);
1415 /* Ok, at this point we're in normal command mode.
1416 * If the command just submitted does not contain a literal, we
1417 * might think about delivering some untagged stuff...
1419 if (cmdbuf[strlen(cmdbuf)-1] == '}') {
1423 /* Grab the tag, command, and parameters. */
1424 num_parms = imap_parameterize(parms, cmdbuf);
1426 /* RFC3501 says that we cannot output untagged data during these commands */
1427 if (num_parms >= 2) {
1428 if ( (!strcasecmp(parms[1], "FETCH"))
1429 || (!strcasecmp(parms[1], "STORE"))
1430 || (!strcasecmp(parms[1], "SEARCH"))
1438 /* we can put any additional untagged stuff right here in the future */
1441 * Before processing the command that was just entered... if we happen
1442 * to have a folder selected, we'd like to rescan that folder for new
1443 * messages, and for deletions/changes of existing messages. This
1444 * could probably be optimized better with some deep thought...
1446 if (IMAP->selected) {
1447 imap_rescan_msgids();
1451 /* Now for the command set. */
1453 if (num_parms < 2) {
1454 cprintf("BAD syntax error\r\n");
1457 /* The commands below may be executed in any state */
1459 else if ((!strcasecmp(parms[1], "NOOP"))
1460 || (!strcasecmp(parms[1], "CHECK"))) {
1461 cprintf("%s OK No operation\r\n",
1465 else if (!strcasecmp(parms[1], "ID")) {
1466 imap_id(num_parms, parms);
1470 else if (!strcasecmp(parms[1], "LOGOUT")) {
1471 if (IMAP->selected) {
1472 imap_do_expunge(); /* yes, we auto-expunge at logout */
1474 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1475 cprintf("%s OK Citadel IMAP session ended.\r\n",
1481 else if (!strcasecmp(parms[1], "LOGIN")) {
1482 imap_login(num_parms, parms);
1485 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1486 imap_authenticate(num_parms, parms);
1489 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1490 imap_capability(num_parms, parms);
1493 else if (!strcasecmp(parms[1], "STARTTLS")) {
1494 imap_starttls(num_parms, parms);
1497 else if (!CC->logged_in) {
1498 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1501 /* The commans below require a logged-in state */
1503 else if (!strcasecmp(parms[1], "SELECT")) {
1504 imap_select(num_parms, parms);
1507 else if (!strcasecmp(parms[1], "EXAMINE")) {
1508 imap_select(num_parms, parms);
1511 else if (!strcasecmp(parms[1], "LSUB")) {
1512 imap_list(num_parms, parms);
1515 else if (!strcasecmp(parms[1], "LIST")) {
1516 imap_list(num_parms, parms);
1519 else if (!strcasecmp(parms[1], "CREATE")) {
1520 imap_create(num_parms, parms);
1523 else if (!strcasecmp(parms[1], "DELETE")) {
1524 imap_delete(num_parms, parms);
1527 else if (!strcasecmp(parms[1], "RENAME")) {
1528 imap_rename(num_parms, parms);
1531 else if (!strcasecmp(parms[1], "STATUS")) {
1532 imap_status(num_parms, parms);
1535 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1536 imap_subscribe(num_parms, parms);
1539 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1540 imap_unsubscribe(num_parms, parms);
1543 else if (!strcasecmp(parms[1], "APPEND")) {
1544 imap_append(num_parms, parms);
1547 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1548 imap_namespace(num_parms, parms);
1551 else if (!strcasecmp(parms[1], "SETACL")) {
1552 imap_setacl(num_parms, parms);
1555 else if (!strcasecmp(parms[1], "DELETEACL")) {
1556 imap_deleteacl(num_parms, parms);
1559 else if (!strcasecmp(parms[1], "GETACL")) {
1560 imap_getacl(num_parms, parms);
1563 else if (!strcasecmp(parms[1], "LISTRIGHTS")) {
1564 imap_listrights(num_parms, parms);
1567 else if (!strcasecmp(parms[1], "MYRIGHTS")) {
1568 imap_myrights(num_parms, parms);
1571 else if (!strcasecmp(parms[1], "GETMETADATA")) {
1572 imap_getmetadata(num_parms, parms);
1575 else if (!strcasecmp(parms[1], "SETMETADATA")) {
1576 imap_setmetadata(num_parms, parms);
1579 else if (IMAP->selected == 0) {
1580 cprintf("%s BAD no folder selected\r\n", parms[0]);
1583 /* The commands below require the SELECT state on a mailbox */
1585 else if (!strcasecmp(parms[1], "FETCH")) {
1586 imap_fetch(num_parms, parms);
1589 else if ((!strcasecmp(parms[1], "UID"))
1590 && (!strcasecmp(parms[2], "FETCH"))) {
1591 imap_uidfetch(num_parms, parms);
1594 else if (!strcasecmp(parms[1], "SEARCH")) {
1595 imap_search(num_parms, parms);
1598 else if ((!strcasecmp(parms[1], "UID"))
1599 && (!strcasecmp(parms[2], "SEARCH"))) {
1600 imap_uidsearch(num_parms, parms);
1603 else if (!strcasecmp(parms[1], "STORE")) {
1604 imap_store(num_parms, parms);
1607 else if ((!strcasecmp(parms[1], "UID"))
1608 && (!strcasecmp(parms[2], "STORE"))) {
1609 imap_uidstore(num_parms, parms);
1612 else if (!strcasecmp(parms[1], "COPY")) {
1613 imap_copy(num_parms, parms);
1616 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "COPY"))) {
1617 imap_uidcopy(num_parms, parms);
1620 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1621 imap_expunge(num_parms, parms);
1624 else if ((!strcasecmp(parms[1], "UID")) && (!strcasecmp(parms[2], "EXPUNGE"))) {
1625 imap_expunge(num_parms, parms);
1628 else if (!strcasecmp(parms[1], "CLOSE")) {
1629 imap_close(num_parms, parms);
1632 /* End of commands. If we get here, the command is either invalid
1637 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1640 /* If the client transmitted a message we can free it now */
1641 imap_free_transmitted_message();
1643 gettimeofday(&tv2, NULL);
1644 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1645 CtdlLogPrintf(CTDL_DEBUG, "IMAP command completed in %ld.%ld seconds\n",
1646 (total_time / 1000000),
1647 (total_time % 1000000)
1652 const char *CitadelServiceIMAP="IMAP";
1653 const char *CitadelServiceIMAPS="IMAPS";
1656 * This function is called to register the IMAP extension with Citadel.
1658 CTDL_MODULE_INIT(imap)
1662 CtdlRegisterServiceHook(config.c_imap_port,
1663 NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1665 CtdlRegisterServiceHook(config.c_imaps_port,
1666 NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1668 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1671 /* return our Subversion id for the Log */