1 // IMAP server for the Citadel system
3 // Copyright (c) 1987-2022 by the citadel.org team
5 // This program is open source software. Use, duplication, or disclosure
6 // is subject to the terms of the GNU General Public License, version 3.
8 #include "../../sysdep.h"
16 #include <sys/types.h>
22 #include <libcitadel.h>
23 #include "../../citadel_defs.h"
24 #include "../../server.h"
25 #include "../../citserver.h"
26 #include "../../support.h"
27 #include "../../config.h"
28 #include "../../user_ops.h"
29 #include "../../database.h"
30 #include "../../msgbase.h"
31 #include "../../internet_addressing.h"
32 #include "serv_imap.h"
33 #include "imap_tools.h"
34 #include "imap_list.h"
35 #include "imap_fetch.h"
36 #include "imap_search.h"
37 #include "imap_store.h"
39 #include "imap_metadata.h"
40 #include "imap_misc.h"
42 #include "../../ctdl_module.h"
43 HashList *ImapCmds = NULL;
44 void registerImapCMD(const char *First, long FLen, const char *Second, long SLen, imap_handler H, int Flags) {
47 h = (imap_handler_hook*) malloc(sizeof(imap_handler_hook));
48 memset(h, 0, sizeof(imap_handler_hook));
53 Put(ImapCmds, First, FLen, h, NULL);
57 memcpy(CMD, First, FLen);
58 memcpy(CMD+FLen, Second, SLen);
59 CMD[FLen+SLen] = '\0';
60 Put(ImapCmds, CMD, FLen + SLen, h, NULL);
65 const imap_handler_hook *imap_lookup(int num_parms, ConstStr *Params) {
72 /* we abuse the Reply-buffer for uppercasing... */
73 StrBufPlain(Imap->Reply, CKEY(Params[1]));
74 StrBufUpCase(Imap->Reply);
76 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
77 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
78 syslog(LOG_DEBUG, "Found.");
79 FlushStrBuf(Imap->Reply);
80 return (imap_handler_hook *) v;
84 syslog(LOG_DEBUG, "NOT Found.");
85 FlushStrBuf(Imap->Reply);
89 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
90 StrBufAppendBufPlain(Imap->Reply, CKEY(Params[2]), 0);
91 StrBufUpCase(Imap->Reply);
92 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
93 syslog(LOG_DEBUG, "Found.");
94 FlushStrBuf(Imap->Reply);
95 return (imap_handler_hook *) v;
97 syslog(LOG_DEBUG, "NOT Found.");
98 FlushStrBuf(Imap->Reply);
103 /* imap_rename() uses this struct containing list of rooms to rename */
106 char irl_oldroom[ROOMNAMELEN];
107 char irl_newroom[ROOMNAMELEN];
112 /* Data which is passed between imap_rename() and imap_rename_backend() */
113 typedef struct __irlparms {
123 * If there is a message ID map in memory, free it
125 void imap_free_msgids(void) {
126 citimap *Imap = IMAP;
127 if (Imap->msgids != NULL) {
133 if (Imap->flags != NULL) {
137 Imap->last_mtime = (-1);
142 * If there is a transmitted message in memory, free it
144 void imap_free_transmitted_message(void) {
145 FreeStrBuf(&IMAP->TransmittedMessage);
150 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
151 * sets stored in the visit record for this user/room. Note that we have
152 * to parse each sequence set manually here, because calling the utility
153 * function is_msg_in_sequence_set() over and over again is too expensive.
155 * first_msg should be set to 0 to rescan the flags for every message in the
156 * room, or some other value if we're only interested in an incremental
159 void imap_set_seen_flags(int first_msg) {
160 citimap *Imap = IMAP;
165 char setstr[64], lostr[64], histr[64];
168 if (Imap->num_msgs < 0) return;
169 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
171 for (i = first_msg; i < Imap->num_msgs; ++i) {
172 Imap->flags[i] = Imap->flags[i] & ~IMAP_SEEN;
173 Imap->flags[i] |= IMAP_RECENT;
174 Imap->flags[i] = Imap->flags[i] & ~IMAP_ANSWERED;
178 * Do the "\Seen" flag.
179 * (Any message not "\Seen" is considered "\Recent".)
181 num_sets = num_tokens(vbuf.v_seen, ',');
182 for (s=0; s<num_sets; ++s) {
183 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
185 extract_token(lostr, setstr, 0, ':', sizeof lostr);
186 if (num_tokens(setstr, ':') >= 2) {
187 extract_token(histr, setstr, 1, ':', sizeof histr);
188 if (!strcmp(histr, "*")) {
189 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
193 strcpy(histr, lostr);
198 for (i = first_msg; i < Imap->num_msgs; ++i) {
199 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
200 Imap->flags[i] |= IMAP_SEEN;
201 Imap->flags[i] = Imap->flags[i] & ~IMAP_RECENT;
206 /* Do the ANSWERED flag */
207 num_sets = num_tokens(vbuf.v_answered, ',');
208 for (s=0; s<num_sets; ++s) {
209 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
211 extract_token(lostr, setstr, 0, ':', sizeof lostr);
212 if (num_tokens(setstr, ':') >= 2) {
213 extract_token(histr, setstr, 1, ':', sizeof histr);
214 if (!strcmp(histr, "*")) {
215 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
219 strcpy(histr, lostr);
224 for (i = first_msg; i < Imap->num_msgs; ++i) {
225 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
226 Imap->flags[i] |= IMAP_ANSWERED;
235 * Back end for imap_load_msgids()
237 * Optimization: instead of calling realloc() to add each message, we
238 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
239 * allows the mapping to proceed much faster.
241 void imap_add_single_msgid(long msgnum, void *userdata) {
242 citimap *Imap = IMAP;
245 if (Imap->num_msgs > Imap->num_alloc) {
246 Imap->num_alloc += REALLOC_INCREMENT;
247 Imap->msgids = realloc(Imap->msgids, (Imap->num_alloc * sizeof(long)) );
248 Imap->flags = realloc(Imap->flags, (Imap->num_alloc * sizeof(unsigned int)) );
250 Imap->msgids[Imap->num_msgs - 1] = msgnum;
251 Imap->flags[Imap->num_msgs - 1] = 0;
256 * Set up a message ID map for the current room (folder)
258 void imap_load_msgids(void) {
259 struct cdbdata *cdbfr;
260 citimap *Imap = IMAP;
262 if (Imap->selected == 0) {
263 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
267 imap_free_msgids(); /* If there was already a map, free it */
269 /* Load the message list */
270 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
272 Imap->msgids = (long*)cdbfr->ptr;
273 Imap->num_msgs = cdbfr->len / sizeof(long);
274 Imap->num_alloc = cdbfr->len / sizeof(long);
275 cdbfr->ptr = NULL; // (this needs attention if we move to LMDB)
280 if (Imap->num_msgs) {
281 Imap->flags = malloc(Imap->num_alloc * sizeof(unsigned int));
282 memset(Imap->flags, 0, (Imap->num_alloc * sizeof(unsigned int)) );
285 imap_set_seen_flags(0);
290 * Re-scan the selected room (folder) and see if it's been changed at all
292 void imap_rescan_msgids(void) {
293 citimap *Imap = IMAP;
294 int original_num_msgs = 0;
295 long original_highest = 0L;
297 int message_still_exists;
298 struct cdbdata *cdbfr;
299 long *msglist = NULL;
303 if (Imap->selected == 0) {
304 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
309 * Check to see if the room's contents have changed.
310 * If not, we can avoid this rescan.
312 CtdlGetRoom(&CC->room, CC->room.QRname);
313 if (Imap->last_mtime == CC->room.QRmtime) { /* No changes! */
317 /* Load the *current* message list from disk, so we can compare it
318 * to what we have in memory.
320 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
322 msglist = (long*)cdbfr->ptr;
323 cdbfr->ptr = NULL; // (this needs attention if we move to LMDB)
324 num_msgs = cdbfr->len / sizeof(long);
333 * Check to see if any of the messages we know about have been expunged
335 if (Imap->num_msgs > 0) {
337 for (i = 0; i < Imap->num_msgs; ++i) {
339 message_still_exists = 0;
341 for (j = jstart; j < num_msgs; ++j) {
342 if (msglist[j] == Imap->msgids[i]) {
343 message_still_exists = 1;
350 if (message_still_exists == 0) {
351 IAPrintf("* %d EXPUNGE\r\n", i + 1);
353 // When a message is expunged, we have to slide all the existing messages up in the message array.
355 memmove(&Imap->msgids[i], &Imap->msgids[i + 1], (sizeof(long) * (Imap->num_msgs - i)));
356 memmove(&Imap->flags[i], &Imap->flags[i + 1], (sizeof(unsigned int) * (Imap->num_msgs - i)));
363 // Remember how many messages were here before we re-scanned.
364 original_num_msgs = Imap->num_msgs;
365 if (Imap->num_msgs > 0) {
366 original_highest = Imap->msgids[Imap->num_msgs - 1];
369 original_highest = 0L;
372 // Now peruse the room for *new* messages only.
373 // This logic is probably the cause of Bug # 368
374 // [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
376 for (j = 0; j < num_msgs; ++j) {
377 if (msglist[j] > original_highest) {
378 imap_add_single_msgid(msglist[j], NULL);
382 imap_set_seen_flags(original_num_msgs);
385 * If new messages have arrived, tell the client about them.
387 if (Imap->num_msgs > original_num_msgs) {
389 for (j = 0; j < num_msgs; ++j) {
390 if (Imap->flags[j] & IMAP_RECENT) {
395 IAPrintf("* %d EXISTS\r\n", Imap->num_msgs);
396 IAPrintf("* %d RECENT\r\n", num_recent);
399 if (msglist != NULL) {
402 Imap->last_mtime = CC->room.QRmtime;
407 * This cleanup function blows away the temporary memory and files used by
410 void imap_cleanup_function(void) {
411 citimap *Imap = IMAP;
413 /* Don't do this stuff if this is not a Imap session! */
414 if (CC->h_command_function != imap_command_loop)
417 /* If there is a mailbox selected, auto-expunge it. */
418 if (Imap->selected) {
422 syslog(LOG_DEBUG, "Performing IMAP cleanup hook");
424 imap_free_transmitted_message();
426 if (Imap->cached_rfc822 != NULL) {
427 FreeStrBuf(&Imap->cached_rfc822);
428 Imap->cached_rfc822_msgnum = (-1);
429 Imap->cached_rfc822_withbody = 0;
432 if (Imap->cached_body != NULL) {
433 free(Imap->cached_body);
434 Imap->cached_body = NULL;
435 Imap->cached_body_len = 0;
436 Imap->cached_bodymsgnum = (-1);
438 FreeStrBuf(&Imap->Cmd.CmdBuf);
439 FreeStrBuf(&Imap->Reply);
440 if (Imap->Cmd.Params != NULL) free(Imap->Cmd.Params);
442 syslog(LOG_DEBUG, "Finished IMAP cleanup hook");
447 * Does the actual work of the CAPABILITY command (because we need to output this stuff in other places as well)
449 void imap_output_capability_string(void) {
450 IAPuts("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
453 if (!CC->redirect_ssl) IAPuts(" STARTTLS");
456 #ifndef DISABLE_IMAP_ACL
460 /* We are building a partial implementation of METADATA for the sole purpose
461 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
462 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
463 * metadata in a compatible and graceful way.
468 * LIST-EXTENDED was originally going to be required by the METADATA extension.
469 * It was mercifully removed prior to the finalization of RFC5464. We started
470 * implementing this but stopped when we learned that it would not be needed.
471 * If you uncomment this declaration you are responsible for writing a lot of new
474 * IAPuts(" LIST-EXTENDED")
480 * implements the CAPABILITY command
482 void imap_capability(int num_parms, ConstStr *Params) {
484 imap_output_capability_string();
486 IReply("OK CAPABILITY completed");
491 * Implements the ID command (specified by RFC2971)
493 * We ignore the client-supplied information, and output a NIL response.
494 * Although this is technically a valid implementation of the extension, it
495 * is quite useless. It exists only so that we may see which clients are
496 * making use of this extension.
499 void imap_id(int num_parms, ConstStr *Params) {
500 IAPuts("* ID NIL\r\n");
501 IReply("OK ID completed");
506 * Here's where our IMAP session begins its happy day.
508 void imap_greeting(void) {
511 strcpy(CC->cs_clientname, "IMAP session");
512 CC->session_specific_data = malloc(sizeof(citimap));
513 Imap = (citimap *)CC->session_specific_data;
514 memset(Imap, 0, sizeof(citimap));
515 Imap->authstate = imap_as_normal;
516 Imap->cached_rfc822_msgnum = (-1);
517 Imap->cached_rfc822_withbody = 0;
518 Imap->Reply = NewStrBufPlain(NULL, SIZ * 10); /* 40k */
521 IAPuts("* BYE; Server busy, try later\r\n");
522 CC->kill_me = KILLME_NOLOGIN;
528 imap_output_capability_string();
529 IAPrintf("] %s IMAP4rev1 %s ready\r\n", CtdlGetConfigStr("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 = KILLME_NO_CRYPTO; /* kill session if no crypto */
547 * implements the LOGIN command (ordinary username/password login)
549 void imap_login(int num_parms, ConstStr *Params) {
553 if (Params[2].len && (Params[2].Key[0] == '{')) {
554 IAPuts("+ go ahead\r\n");
555 IMAP->authstate = imap_as_expecting_multilineusername;
556 strcpy(IMAP->authseq, Params[0].Key);
560 IReply("BAD incorrect number of parameters");
564 if (CtdlLoginExistingUser(Params[2].Key) == login_ok) {
565 if (CtdlTryPassword(Params[3].Key, Params[3].len) == pass_ok) {
566 /* hm, thats not doable by IReply :-( */
567 IAPrintf("%s OK [", Params[0].Key);
568 imap_output_capability_string();
569 IAPrintf("] Hello, %s\r\n", CC->user.fullname);
573 IReplyPrintf("NO AUTHENTICATE %s failed", Params[3].Key);
578 IReply("BAD Login incorrect");
581 IReply("BAD incorrect number of parameters");
589 * Implements the AUTHENTICATE command
591 void imap_authenticate(int num_parms, ConstStr *Params) {
594 if (num_parms != 3) {
595 IReply("BAD incorrect number of parameters");
600 IReply("BAD Already logged in.");
604 if (!strcasecmp(Params[2].Key, "LOGIN")) {
605 size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
606 if (UsrBuf[len - 1] == '\n') {
607 UsrBuf[len - 1] = '\0';
610 IAPrintf("+ %s\r\n", UsrBuf);
611 IMAP->authstate = imap_as_expecting_username;
612 strcpy(IMAP->authseq, Params[0].Key);
616 if (!strcasecmp(Params[2].Key, "PLAIN")) {
617 // size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
618 // if (UsrBuf[len - 1] == '\n') {
619 // UsrBuf[len - 1] = '\0';
621 // IAPuts("+ %s\r\n", UsrBuf);
623 IMAP->authstate = imap_as_expecting_plainauth;
624 strcpy(IMAP->authseq, Params[0].Key);
629 IReplyPrintf("NO AUTHENTICATE %s failed",
635 void imap_auth_plain(void) {
636 citimap *Imap = IMAP;
637 const char *decoded_authstring;
638 char ident[256] = "";
646 memset(pass, 0, sizeof(pass));
647 decoded_len = StrBufDecodeBase64(Imap->Cmd.CmdBuf);
649 if (decoded_len > 0) {
650 decoded_authstring = ChrPtr(Imap->Cmd.CmdBuf);
652 len = safestrncpy(ident, decoded_authstring, sizeof ident);
654 decoded_len -= len - 1;
655 decoded_authstring += len + 1;
657 if (decoded_len > 0) {
658 len = safestrncpy(user, decoded_authstring, sizeof user);
660 decoded_authstring += len + 1;
661 decoded_len -= len - 1;
664 if (decoded_len > 0) {
665 plen = safestrncpy(pass, decoded_authstring, sizeof pass);
668 plen = sizeof(pass) - 1;
671 Imap->authstate = imap_as_normal;
673 if (!IsEmptyStr(ident)) {
674 result = CtdlLoginExistingUser(ident);
677 result = CtdlLoginExistingUser(user);
680 if (result == login_ok) {
681 if (CtdlTryPassword(pass, plen) == pass_ok) {
682 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
686 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
690 void imap_auth_login_user(long state) {
692 citimap *Imap = IMAP;
695 case imap_as_expecting_username:
696 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
697 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
698 size_t len = CtdlEncodeBase64(PWBuf, "Password:", 9, BASE64_NO_LINEBREAKS);
699 if (PWBuf[len - 1] == '\n') {
700 PWBuf[len - 1] = '\0';
703 IAPrintf("+ %s\r\n", PWBuf);
705 Imap->authstate = imap_as_expecting_password;
707 case imap_as_expecting_multilineusername:
708 extract_token(PWBuf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(PWBuf));
709 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
710 IAPuts("+ go ahead\r\n");
711 Imap->authstate = imap_as_expecting_multilinepassword;
717 void imap_auth_login_pass(long state) {
718 citimap *Imap = IMAP;
719 const char *pass = NULL;
724 case imap_as_expecting_password:
725 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
726 pass = ChrPtr(Imap->Cmd.CmdBuf);
727 len = StrLength(Imap->Cmd.CmdBuf);
729 case imap_as_expecting_multilinepassword:
730 pass = ChrPtr(Imap->Cmd.CmdBuf);
731 len = StrLength(Imap->Cmd.CmdBuf);
734 if (len > USERNAME_SIZE)
735 StrBufCutAt(Imap->Cmd.CmdBuf, USERNAME_SIZE, NULL);
737 if (CtdlTryPassword(pass, len) == pass_ok) {
738 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
741 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
743 Imap->authstate = imap_as_normal;
749 * implements the STARTTLS command (Citadel API version)
751 void imap_starttls(int num_parms, ConstStr *Params) {
752 char ok_response[SIZ];
753 char nosup_response[SIZ];
754 char error_response[SIZ];
756 snprintf(ok_response, SIZ, "%s OK begin TLS negotiation now\r\n", Params[0].Key);
757 snprintf(nosup_response, SIZ, "%s NO TLS not supported here\r\n", Params[0].Key);
758 snprintf(error_response, SIZ, "%s BAD Internal error\r\n", Params[0].Key);
759 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
764 * implements the SELECT command
766 void imap_select(int num_parms, ConstStr *Params) {
767 citimap *Imap = IMAP;
768 char towhere[ROOMNAMELEN];
769 char augmented_roomname[ROOMNAMELEN];
773 struct ctdlroom QRscratch;
777 /* Convert the supplied folder name to a roomname */
778 i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
780 IReply("NO Invalid mailbox name.");
785 /* First try a regular match */
786 c = CtdlGetRoom(&QRscratch, towhere);
788 /* Then try a mailbox name match */
790 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
791 c = CtdlGetRoom(&QRscratch, augmented_roomname);
793 safestrncpy(towhere, augmented_roomname, sizeof(towhere));
797 /* If the room exists, check security/access */
799 /* See if there is an existing user/room relationship */
800 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
802 /* normal clients have to pass through security */
808 /* Fail here if no such room */
810 IReply("NO ... no such room, or access denied");
814 /* If we already had some other folder selected, auto-expunge it */
818 * CtdlUserGoto() formally takes us to the desired room, happily returning
819 * the number of messages and number of new messages.
821 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
822 CtdlUserGoto(NULL, 0, 0, &msgs, &new, NULL, NULL);
825 if (!strcasecmp(Params[1].Key, "EXAMINE")) {
833 Imap->last_mtime = CC->room.QRmtime;
835 IAPrintf("* %d EXISTS\r\n", msgs);
836 IAPrintf("* %d RECENT\r\n", new);
838 IAPrintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
839 IAPrintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CtdlGetConfigLong("MMhighest") + 1);
841 /* Technically, \Deleted is a valid flag, but not a permanent flag,
842 * because we don't maintain its state across sessions. Citadel
843 * automatically expunges mailboxes when they are de-selected.
845 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
846 * some clients (particularly Thunderbird) to misbehave -- they simply
847 * elect not to transmit the flag at all. So we have to advertise
848 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
850 IAPuts("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
851 IAPuts("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
852 IReplyPrintf("OK [%s] %s completed", (Imap->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key);
857 * Does the real work for expunge.
859 int imap_do_expunge(void) {
860 citimap *Imap = IMAP;
862 int num_expunged = 0;
863 long *delmsgs = NULL;
866 syslog(LOG_DEBUG, "imap_do_expunge() called");
867 if (Imap->selected == 0) {
871 if (Imap->num_msgs > 0) {
872 delmsgs = malloc(Imap->num_msgs * sizeof(long));
873 for (i = 0; i < Imap->num_msgs; ++i) {
874 if (Imap->flags[i] & IMAP_DELETED) {
875 delmsgs[num_delmsgs++] = Imap->msgids[i];
878 if (num_delmsgs > 0) {
879 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
881 num_expunged += num_delmsgs;
885 if (num_expunged > 0) {
886 imap_rescan_msgids();
889 syslog(LOG_DEBUG, "Expunged %d messages from <%s>", num_expunged, CC->room.QRname);
890 return (num_expunged);
895 * implements the EXPUNGE command syntax
897 void imap_expunge(int num_parms, ConstStr *Params) {
898 int num_expunged = 0;
900 num_expunged = imap_do_expunge();
901 IReplyPrintf("OK expunged %d messages.", num_expunged);
906 * implements the CLOSE command
908 void imap_close(int num_parms, ConstStr *Params) {
910 /* Yes, we always expunge on close. */
911 if (IMAP->selected) {
918 IReply("OK CLOSE completed");
923 * Implements the NAMESPACE command.
925 void imap_namespace(int num_parms, ConstStr *Params) {
932 IAPuts("* NAMESPACE ");
934 /* All personal folders are subordinate to INBOX. */
935 IAPuts("((\"INBOX/\" \"/\")) ");
937 /* Other users' folders ... eventually? FIXME */
940 /* Show all floors as shared namespaces. Neato! */
942 for (i = 0; i < MAXFLOORS; ++i) {
943 fl = CtdlGetCachedFloor(i);
944 if (fl->f_flags & F_INUSE) {
945 /* if (floors > 0) IAPuts(" "); samjam says this confuses javamail */
947 len = snprintf(Namespace, sizeof(Namespace), "%s/", fl->f_name);
948 IPutStr(Namespace, len);
955 /* Wind it up with a newline and a completion message. */
957 IReply("OK NAMESPACE completed");
962 * Implements the CREATE command
965 void imap_create(int num_parms, ConstStr *Params) {
967 char roomname[ROOMNAMELEN];
972 char *notification_message = NULL;
975 IReply("NO A foder name must be specified");
979 if (strchr(Params[2].Key, '\\') != NULL) {
980 IReply("NO Invalid character in folder name");
981 syslog(LOG_ERR, "invalid character in folder name");
985 ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
987 IReply("NO Invalid mailbox name or location");
988 syslog(LOG_ERR, "invalid mailbox name or location");
991 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
992 flags = (ret & 0xff00); /* upper 8 bits = flags */
994 if (flags & IR_MAILBOX) {
995 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
996 IReply("NO Personal folders must be created under INBOX");
997 syslog(LOG_ERR, "not subordinate to inbox");
1002 if (flags & IR_MAILBOX) {
1003 newroomtype = 4; /* private mailbox */
1004 newroomview = VIEW_MAILBOX;
1007 newroomtype = 0; /* public folder */
1008 newroomview = VIEW_BBS;
1011 syslog(LOG_INFO, "Create new room <%s> on floor <%d> with type <%d>",
1012 roomname, floornum, newroomtype);
1014 ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
1016 IReply("NO Mailbox already exists, or create failed");
1019 IReply("OK CREATE completed");
1020 // post a message in Aide> describing the new room
1021 notification_message = malloc(1024);
1022 snprintf(notification_message, 1024,
1023 "A new room called \"%s\" has been created by %s%s%s%s\n",
1026 ((ret & QR_MAILBOX) ? " [personal]" : ""),
1027 ((ret & QR_PRIVATE) ? " [private]" : ""),
1028 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
1030 CtdlAideMessage(notification_message, "Room Creation Message");
1031 free(notification_message);
1033 syslog(LOG_DEBUG, "imap_create() completed");
1038 * Locate a room by its IMAP folder name, and check access to it.
1039 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1041 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok) {
1043 char augmented_roomname[ROOMNAMELEN];
1044 char roomname[ROOMNAMELEN];
1046 struct ctdlroom QRscratch;
1050 ret = imap_roomname(roomname, sizeof roomname, foldername);
1055 /* First try a regular match */
1056 c = CtdlGetRoom(&QRscratch, roomname);
1058 /* Then try a mailbox name match */
1060 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, roomname);
1061 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1063 safestrncpy(roomname, augmented_roomname, sizeof(roomname));
1066 /* If the room exists, check security/access */
1068 /* See if there is an existing user/room relationship */
1069 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1071 /* normal clients have to pass through security */
1072 if (ra & UA_KNOWN) {
1075 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1080 /* Fail here if no such room */
1082 strcpy(returned_roomname, "");
1086 safestrncpy(returned_roomname, QRscratch.QRname, ROOMNAMELEN);
1093 * Implements the STATUS command (sort of)
1096 void imap_status(int num_parms, ConstStr *Params) {
1099 char roomname[ROOMNAMELEN];
1100 char imaproomname[SIZ];
1101 char savedroom[ROOMNAMELEN];
1104 ret = imap_grabroom(roomname, Params[2].Key, 1);
1106 IReply("NO Invalid mailbox name or location, or access denied");
1111 * CtdlUserGoto() formally takes us to the desired room, happily returning
1112 * the number of messages and number of new messages. (If another
1113 * folder is selected, save its name so we can return there!!!!!)
1115 if (IMAP->selected) {
1116 strcpy(savedroom, CC->room.QRname);
1118 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1121 * Tell the client what it wants to know. In fact, tell it *more* than
1122 * it wants to know. We happily IGnore the supplied status data item
1123 * names and simply spew all possible data items. It's far easier to
1124 * code and probably saves us some processing time too.
1126 len = imap_mailboxname(imaproomname, sizeof imaproomname, &CC->room);
1127 IAPuts("* STATUS ");
1128 IPutStr(imaproomname, len);
1129 IAPrintf(" (MESSAGES %d ", msgs);
1130 IAPrintf("RECENT %d ", new); /* Initially, new==recent */
1131 IAPrintf("UIDNEXT %ld ", CtdlGetConfigLong("MMhighest") + 1);
1132 IAPrintf("UNSEEN %d)\r\n", new);
1135 * If another folder is selected, go back to that room so we can resume
1136 * our happy day without violent explosions.
1138 if (IMAP->selected) {
1139 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1143 * Oooh, look, we're done!
1145 IReply("OK STATUS completed");
1150 * Implements the SUBSCRIBE command
1153 void imap_subscribe(int num_parms, ConstStr *Params) {
1155 char roomname[ROOMNAMELEN];
1156 char savedroom[ROOMNAMELEN];
1159 ret = imap_grabroom(roomname, Params[2].Key, 1);
1162 "NO Error %d: invalid mailbox name or location, or access denied",
1169 * CtdlUserGoto() formally takes us to the desired room, which has the side
1170 * effect of marking the room as not-zapped ... exactly the effect
1171 * we're looking for.
1173 if (IMAP->selected) {
1174 strcpy(savedroom, CC->room.QRname);
1176 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1179 * If another folder is selected, go back to that room so we can resume
1180 * our happy day without violent explosions.
1182 if (IMAP->selected) {
1183 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1186 IReply("OK SUBSCRIBE completed");
1191 * Implements the UNSUBSCRIBE command
1194 void imap_unsubscribe(int num_parms, ConstStr *Params) {
1196 char roomname[ROOMNAMELEN];
1197 char savedroom[ROOMNAMELEN];
1200 ret = imap_grabroom(roomname, Params[2].Key, 1);
1202 IReply("NO Invalid mailbox name or location, or access denied");
1207 * CtdlUserGoto() formally takes us to the desired room.
1209 if (IMAP->selected) {
1210 strcpy(savedroom, CC->room.QRname);
1212 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1215 * Now make the API call to zap the room
1217 if (CtdlForgetThisRoom() == 0) {
1218 IReply("OK UNSUBSCRIBE completed");
1221 IReply("NO You may not unsubscribe from this folder.");
1225 * If another folder is selected, go back to that room so we can resume
1226 * our happy day without violent explosions.
1228 if (IMAP->selected) {
1229 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1235 * Implements the DELETE command
1238 void imap_delete(int num_parms, ConstStr *Params) {
1240 char roomname[ROOMNAMELEN];
1241 char savedroom[ROOMNAMELEN];
1244 ret = imap_grabroom(roomname, Params[2].Key, 1);
1246 IReply("NO Invalid mailbox name, or access denied");
1251 * CtdlUserGoto() formally takes us to the desired room, happily returning
1252 * the number of messages and number of new messages. (If another
1253 * folder is selected, save its name so we can return there!!!!!)
1255 if (IMAP->selected) {
1256 strcpy(savedroom, CC->room.QRname);
1258 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1261 * Now delete the room.
1263 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1264 CtdlScheduleRoomForDeletion(&CC->room);
1265 IReply("OK DELETE completed");
1268 IReply("NO Can't delete this folder.");
1272 * If another folder is selected, go back to that room so we can resume
1273 * our happy day without violent explosions.
1275 if (IMAP->selected) {
1276 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1282 * Back end function for imap_rename()
1284 void imap_rename_backend(struct ctdlroom *qrbuf, void *data) {
1285 char foldername[SIZ];
1286 char newfoldername[SIZ];
1287 char newroomname[ROOMNAMELEN];
1289 struct irl *irlp = NULL; /* scratch pointer */
1290 irlparms *myirlparms;
1292 myirlparms = (irlparms *) data;
1293 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1295 /* Rename subfolders */
1296 if ((!strncasecmp(foldername, myirlparms->oldname, myirlparms->oldnamelen) && (foldername[myirlparms->oldnamelen] == '/'))) {
1297 snprintf(newfoldername, sizeof newfoldername, "%s/%s", myirlparms->newname, &foldername[myirlparms->oldnamelen + 1]);
1298 newfloor = imap_roomname(newroomname, sizeof newroomname, newfoldername) & 0xFF;
1299 irlp = (struct irl *) malloc(sizeof(struct irl));
1300 strcpy(irlp->irl_newroom, newroomname);
1301 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1302 irlp->irl_newfloor = newfloor;
1303 irlp->next = *(myirlparms->irl);
1304 *(myirlparms->irl) = irlp;
1310 * Implements the RENAME command
1313 void imap_rename(int num_parms, ConstStr *Params) {
1314 char old_room[ROOMNAMELEN];
1315 char new_room[ROOMNAMELEN];
1319 struct irl *irl = NULL; /* the list */
1320 struct irl *irlp = NULL; /* scratch pointer */
1324 if (strchr(Params[3].Key, '\\') != NULL) {
1325 IReply("NO Invalid character in folder name");
1329 imap_roomname(old_room, sizeof old_room, Params[2].Key);
1330 newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1331 new_floor = (newr & 0xFF);
1333 r = CtdlRenameRoom(old_room, new_room, new_floor);
1335 if (r == crr_room_not_found) {
1336 IReply("NO Could not locate this folder");
1339 if (r == crr_already_exists) {
1340 IReplyPrintf("NO '%s' already exists.");
1343 if (r == crr_noneditable) {
1344 IReply("NO This folder is not editable.");
1347 if (r == crr_invalid_floor) {
1348 IReply("NO Folder root does not exist.");
1351 if (r == crr_access_denied) {
1352 IReply("NO You do not have permission to edit this folder.");
1356 IReplyPrintf("NO Rename failed - undefined error %d", r);
1360 /* If this is the INBOX, then RFC2060 says we have to just move the
1361 * contents. In a Citadel environment it's easier to rename the room
1362 * (already did that) and create a new inbox.
1364 if (!strcasecmp(Params[2].Key, "INBOX")) {
1365 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1368 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1370 irlparms.oldname = Params[2].Key;
1371 irlparms.oldnamelen = Params[2].len;
1372 irlparms.newname = Params[3].Key;
1373 irlparms.newnamelen = Params[3].len;
1374 irlparms.irl = &irl;
1375 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1377 /* ... and now rename them. */
1378 while (irl != NULL) {
1379 r = CtdlRenameRoom(irl->irl_oldroom, irl->irl_newroom, irl->irl_newfloor);
1381 /* FIXME handle error returns better */
1382 syslog(LOG_ERR, "CtdlRenameRoom() error %d", r);
1390 snprintf(aidemsg, sizeof aidemsg, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1395 CtdlAideMessage(aidemsg, "IMAP folder rename");
1397 IReply("OK RENAME completed");
1402 * Main command loop for IMAP sessions.
1404 void imap_command_loop(void) {
1405 struct timeval tv1, tv2;
1406 suseconds_t total_time = 0;
1408 const char *pchs, *pche;
1409 const imap_handler_hook *h;
1411 gettimeofday(&tv1, NULL);
1412 CC->lastcmd = time(NULL);
1416 if (Imap->Cmd.CmdBuf == NULL)
1417 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1419 FlushStrBuf(Imap->Cmd.CmdBuf);
1421 if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1422 syslog(LOG_ERR, "client disconnected: ending session.");
1423 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1427 if (Imap->authstate == imap_as_expecting_password) {
1428 syslog(LOG_INFO, "<password>");
1430 else if (Imap->authstate == imap_as_expecting_plainauth) {
1431 syslog(LOG_INFO, "<plain_auth>");
1433 else if ((Imap->authstate == imap_as_expecting_multilineusername) || cbmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1434 syslog(LOG_INFO, "LOGIN...");
1437 syslog(LOG_DEBUG, "%s", ChrPtr(Imap->Cmd.CmdBuf));
1440 pchs = ChrPtr(Imap->Cmd.CmdBuf);
1441 pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1443 while ((pche > pchs) && ((*pche == '\n') || (*pche == '\r'))) {
1445 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1447 StrBufTrim(Imap->Cmd.CmdBuf);
1449 /* If we're in the middle of a multi-line command, handle that */
1450 switch (Imap->authstate){
1451 case imap_as_expecting_username:
1452 imap_auth_login_user(imap_as_expecting_username);
1455 case imap_as_expecting_multilineusername:
1456 imap_auth_login_user(imap_as_expecting_multilineusername);
1459 case imap_as_expecting_plainauth:
1463 case imap_as_expecting_password:
1464 imap_auth_login_pass(imap_as_expecting_password);
1467 case imap_as_expecting_multilinepassword:
1468 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1475 /* Ok, at this point we're in normal command mode.
1476 * If the command just submitted does not contain a literal, we
1477 * might think about delivering some untagged stuff...
1480 /* Grab the tag, command, and parameters. */
1481 imap_parameterize(&Imap->Cmd);
1483 /* Now for the command set. */
1484 h = imap_lookup(Imap->Cmd.num_parms, Imap->Cmd.Params);
1487 IReply("BAD command unrecognized");
1491 /* RFC3501 says that we cannot output untagged data during these commands */
1492 if ((h->Flags & I_FLAG_UNTAGGED) == 0) {
1494 // we can put any additional untagged stuff right here in the future
1496 // Before processing the command that was just entered... if we happen
1497 // to have a folder selected, we'd like to rescan that folder for new
1498 // messages, and for deletions/changes of existing messages. This
1499 // could probably be optimized better with some deep thought...
1500 if (Imap->selected) {
1501 imap_rescan_msgids();
1505 /* does our command require a logged-in state */
1506 if ((!CC->logged_in) && ((h->Flags & I_FLAG_LOGGED_IN) != 0)) {
1507 IReply("BAD Not logged in.");
1511 /* does our command require the SELECT state on a mailbox */
1512 if ((Imap->selected == 0) && ((h->Flags & I_FLAG_SELECT) != 0)){
1513 IReply("BAD no folder selected");
1516 h->h(Imap->Cmd.num_parms, Imap->Cmd.Params);
1518 /* If the client transmitted a message we can free it now */
1523 imap_free_transmitted_message();
1525 gettimeofday(&tv2, NULL);
1526 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1527 syslog(LOG_DEBUG, "IMAP command completed in %ld.%ld seconds",
1528 (total_time / 1000000),
1529 (total_time % 1000000)
1534 void imap_noop(int num_parms, ConstStr *Params) {
1535 IReply("OK No operation");
1539 void imap_logout(int num_parms, ConstStr *Params) {
1540 if (IMAP->selected) {
1541 imap_do_expunge(); /* yes, we auto-expunge at logout */
1543 IAPrintf("* BYE %s logging out\r\n", CtdlGetConfigStr("c_fqdn"));
1544 IReply("OK Citadel IMAP session ended.");
1545 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
1550 const char *CitadelServiceIMAP="IMAP";
1551 const char *CitadelServiceIMAPS="IMAPS";
1554 // Initialization function, called from modules_init.c
1555 char *ctdl_module_init_imap(void) {
1556 if (ImapCmds == NULL) {
1557 ImapCmds = NewHash(1, NULL);
1560 RegisterImapCMD("NOOP", "", imap_noop, I_FLAG_NONE);
1561 RegisterImapCMD("CHECK", "", imap_noop, I_FLAG_NONE);
1562 RegisterImapCMD("ID", "", imap_id, I_FLAG_NONE);
1563 RegisterImapCMD("LOGOUT", "", imap_logout, I_FLAG_NONE);
1564 RegisterImapCMD("LOGIN", "", imap_login, I_FLAG_NONE);
1565 RegisterImapCMD("AUTHENTICATE", "", imap_authenticate, I_FLAG_NONE);
1566 RegisterImapCMD("CAPABILITY", "", imap_capability, I_FLAG_NONE);
1568 RegisterImapCMD("STARTTLS", "", imap_starttls, I_FLAG_NONE);
1571 /* The commans below require a logged-in state */
1572 RegisterImapCMD("SELECT", "", imap_select, I_FLAG_LOGGED_IN);
1573 RegisterImapCMD("EXAMINE", "", imap_select, I_FLAG_LOGGED_IN);
1574 RegisterImapCMD("LSUB", "", imap_list, I_FLAG_LOGGED_IN);
1575 RegisterImapCMD("LIST", "", imap_list, I_FLAG_LOGGED_IN);
1576 RegisterImapCMD("CREATE", "", imap_create, I_FLAG_LOGGED_IN);
1577 RegisterImapCMD("DELETE", "", imap_delete, I_FLAG_LOGGED_IN);
1578 RegisterImapCMD("RENAME", "", imap_rename, I_FLAG_LOGGED_IN);
1579 RegisterImapCMD("STATUS", "", imap_status, I_FLAG_LOGGED_IN);
1580 RegisterImapCMD("SUBSCRIBE", "", imap_subscribe, I_FLAG_LOGGED_IN);
1581 RegisterImapCMD("UNSUBSCRIBE", "", imap_unsubscribe, I_FLAG_LOGGED_IN);
1582 RegisterImapCMD("APPEND", "", imap_append, I_FLAG_LOGGED_IN);
1583 RegisterImapCMD("NAMESPACE", "", imap_namespace, I_FLAG_LOGGED_IN);
1584 RegisterImapCMD("SETACL", "", imap_setacl, I_FLAG_LOGGED_IN);
1585 RegisterImapCMD("DELETEACL", "", imap_deleteacl, I_FLAG_LOGGED_IN);
1586 RegisterImapCMD("GETACL", "", imap_getacl, I_FLAG_LOGGED_IN);
1587 RegisterImapCMD("LISTRIGHTS", "", imap_listrights, I_FLAG_LOGGED_IN);
1588 RegisterImapCMD("MYRIGHTS", "", imap_myrights, I_FLAG_LOGGED_IN);
1589 RegisterImapCMD("GETMETADATA", "", imap_getmetadata, I_FLAG_LOGGED_IN);
1590 RegisterImapCMD("SETMETADATA", "", imap_setmetadata, I_FLAG_LOGGED_IN);
1592 /* The commands below require the SELECT state on a mailbox */
1593 RegisterImapCMD("FETCH", "", imap_fetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1594 RegisterImapCMD("UID", "FETCH", imap_uidfetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1595 RegisterImapCMD("SEARCH", "", imap_search, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1596 RegisterImapCMD("UID", "SEARCH", imap_uidsearch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1597 RegisterImapCMD("STORE", "", imap_store, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1598 RegisterImapCMD("UID", "STORE", imap_uidstore, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1599 RegisterImapCMD("COPY", "", imap_copy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1600 RegisterImapCMD("UID", "COPY", imap_uidcopy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1601 RegisterImapCMD("EXPUNGE", "", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1602 RegisterImapCMD("UID", "EXPUNGE", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1603 RegisterImapCMD("CLOSE", "", imap_close, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1606 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imap_port"), NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1608 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imaps_port"), NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1610 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP, PRIO_STOP + 30);
1613 // return our module name for the log