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) {
66 struct CitContext *CCC = CC;
68 citimap *Imap = CCCIMAP;
73 /* we abuse the Reply-buffer for uppercasing... */
74 StrBufPlain(Imap->Reply, CKEY(Params[1]));
75 StrBufUpCase(Imap->Reply);
77 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
78 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
79 syslog(LOG_DEBUG, "Found.");
80 FlushStrBuf(Imap->Reply);
81 return (imap_handler_hook *) v;
85 syslog(LOG_DEBUG, "NOT Found.");
86 FlushStrBuf(Imap->Reply);
90 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
91 StrBufAppendBufPlain(Imap->Reply, CKEY(Params[2]), 0);
92 StrBufUpCase(Imap->Reply);
93 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
94 syslog(LOG_DEBUG, "Found.");
95 FlushStrBuf(Imap->Reply);
96 return (imap_handler_hook *) v;
98 syslog(LOG_DEBUG, "NOT Found.");
99 FlushStrBuf(Imap->Reply);
104 /* imap_rename() uses this struct containing list of rooms to rename */
107 char irl_oldroom[ROOMNAMELEN];
108 char irl_newroom[ROOMNAMELEN];
113 /* Data which is passed between imap_rename() and imap_rename_backend() */
114 typedef struct __irlparms {
124 * If there is a message ID map in memory, free it
126 void imap_free_msgids(void) {
127 citimap *Imap = IMAP;
128 if (Imap->msgids != NULL) {
134 if (Imap->flags != NULL) {
138 Imap->last_mtime = (-1);
143 * If there is a transmitted message in memory, free it
145 void imap_free_transmitted_message(void) {
146 FreeStrBuf(&IMAP->TransmittedMessage);
151 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
152 * sets stored in the visit record for this user/room. Note that we have
153 * to parse each sequence set manually here, because calling the utility
154 * function is_msg_in_sequence_set() over and over again is too expensive.
156 * first_msg should be set to 0 to rescan the flags for every message in the
157 * room, or some other value if we're only interested in an incremental
160 void imap_set_seen_flags(int first_msg) {
161 citimap *Imap = IMAP;
166 char setstr[64], lostr[64], histr[64];
169 if (Imap->num_msgs < 1) return;
170 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
172 for (i = first_msg; i < Imap->num_msgs; ++i) {
173 Imap->flags[i] = Imap->flags[i] & ~IMAP_SEEN;
174 Imap->flags[i] |= IMAP_RECENT;
175 Imap->flags[i] = Imap->flags[i] & ~IMAP_ANSWERED;
179 * Do the "\Seen" flag.
180 * (Any message not "\Seen" is considered "\Recent".)
182 num_sets = num_tokens(vbuf.v_seen, ',');
183 for (s=0; s<num_sets; ++s) {
184 extract_token(setstr, vbuf.v_seen, 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_SEEN;
202 Imap->flags[i] = Imap->flags[i] & ~IMAP_RECENT;
207 /* Do the ANSWERED flag */
208 num_sets = num_tokens(vbuf.v_answered, ',');
209 for (s=0; s<num_sets; ++s) {
210 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
212 extract_token(lostr, setstr, 0, ':', sizeof lostr);
213 if (num_tokens(setstr, ':') >= 2) {
214 extract_token(histr, setstr, 1, ':', sizeof histr);
215 if (!strcmp(histr, "*")) {
216 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
220 strcpy(histr, lostr);
225 for (i = first_msg; i < Imap->num_msgs; ++i) {
226 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
227 Imap->flags[i] |= IMAP_ANSWERED;
236 * Back end for imap_load_msgids()
238 * Optimization: instead of calling realloc() to add each message, we
239 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
240 * allows the mapping to proceed much faster.
242 void imap_add_single_msgid(long msgnum, void *userdata) {
243 citimap *Imap = IMAP;
246 if (Imap->num_msgs > Imap->num_alloc) {
247 Imap->num_alloc += REALLOC_INCREMENT;
248 Imap->msgids = realloc(Imap->msgids, (Imap->num_alloc * sizeof(long)) );
249 Imap->flags = realloc(Imap->flags, (Imap->num_alloc * sizeof(unsigned int)) );
251 Imap->msgids[Imap->num_msgs - 1] = msgnum;
252 Imap->flags[Imap->num_msgs - 1] = 0;
257 * Set up a message ID map for the current room (folder)
259 void imap_load_msgids(void) {
260 struct CitContext *CCC = CC;
261 struct cdbdata *cdbfr;
262 citimap *Imap = CCCIMAP;
264 if (Imap->selected == 0) {
265 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
269 imap_free_msgids(); /* If there was already a map, free it */
271 /* Load the message list */
272 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
274 Imap->msgids = (long*)cdbfr->ptr;
275 Imap->num_msgs = cdbfr->len / sizeof(long);
276 Imap->num_alloc = cdbfr->len / sizeof(long);
282 if (Imap->num_msgs) {
283 Imap->flags = malloc(Imap->num_alloc * sizeof(unsigned int));
284 memset(Imap->flags, 0, (Imap->num_alloc * sizeof(unsigned int)) );
287 imap_set_seen_flags(0);
292 * Re-scan the selected room (folder) and see if it's been changed at all
294 void imap_rescan_msgids(void) {
295 struct CitContext *CCC = CC;
296 citimap *Imap = CCCIMAP;
297 int original_num_msgs = 0;
298 long original_highest = 0L;
300 int message_still_exists;
301 struct cdbdata *cdbfr;
302 long *msglist = NULL;
306 if (Imap->selected == 0) {
307 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
312 * Check to see if the room's contents have changed.
313 * If not, we can avoid this rescan.
315 CtdlGetRoom(&CC->room, CC->room.QRname);
316 if (Imap->last_mtime == CC->room.QRmtime) { /* No changes! */
320 /* Load the *current* message list from disk, so we can compare it
321 * to what we have in memory.
323 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
325 msglist = (long*)cdbfr->ptr;
327 num_msgs = cdbfr->len / sizeof(long);
336 * Check to see if any of the messages we know about have been expunged
338 if (Imap->num_msgs > 0) {
340 for (i = 0; i < Imap->num_msgs; ++i) {
342 message_still_exists = 0;
344 for (j = jstart; j < num_msgs; ++j) {
345 if (msglist[j] == Imap->msgids[i]) {
346 message_still_exists = 1;
353 if (message_still_exists == 0) {
354 IAPrintf("* %d EXPUNGE\r\n", i + 1);
356 // When a message is expunged, we have to slide all the existing messages up in the message array.
358 memmove(&Imap->msgids[i], &Imap->msgids[i + 1], (sizeof(long) * (Imap->num_msgs - i)));
359 memmove(&Imap->flags[i], &Imap->flags[i + 1], (sizeof(unsigned int) * (Imap->num_msgs - i)));
366 // Remember how many messages were here before we re-scanned.
367 original_num_msgs = Imap->num_msgs;
368 if (Imap->num_msgs > 0) {
369 original_highest = Imap->msgids[Imap->num_msgs - 1];
372 original_highest = 0L;
375 // Now peruse the room for *new* messages only.
376 // This logic is probably the cause of Bug # 368
377 // [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
379 for (j = 0; j < num_msgs; ++j) {
380 if (msglist[j] > original_highest) {
381 imap_add_single_msgid(msglist[j], NULL);
385 imap_set_seen_flags(original_num_msgs);
388 * If new messages have arrived, tell the client about them.
390 if (Imap->num_msgs > original_num_msgs) {
392 for (j = 0; j < num_msgs; ++j) {
393 if (Imap->flags[j] & IMAP_RECENT) {
398 IAPrintf("* %d EXISTS\r\n", Imap->num_msgs);
399 IAPrintf("* %d RECENT\r\n", num_recent);
402 if (msglist != NULL) {
405 Imap->last_mtime = CC->room.QRmtime;
410 * This cleanup function blows away the temporary memory and files used by
413 void imap_cleanup_function(void) {
414 struct CitContext *CCC = CC;
415 citimap *Imap = CCCIMAP;
417 /* Don't do this stuff if this is not a Imap session! */
418 if (CC->h_command_function != imap_command_loop)
421 /* If there is a mailbox selected, auto-expunge it. */
422 if (Imap->selected) {
426 syslog(LOG_DEBUG, "Performing IMAP cleanup hook");
428 imap_free_transmitted_message();
430 if (Imap->cached_rfc822 != NULL) {
431 FreeStrBuf(&Imap->cached_rfc822);
432 Imap->cached_rfc822_msgnum = (-1);
433 Imap->cached_rfc822_withbody = 0;
436 if (Imap->cached_body != NULL) {
437 free(Imap->cached_body);
438 Imap->cached_body = NULL;
439 Imap->cached_body_len = 0;
440 Imap->cached_bodymsgnum = (-1);
442 FreeStrBuf(&Imap->Cmd.CmdBuf);
443 FreeStrBuf(&Imap->Reply);
444 if (Imap->Cmd.Params != NULL) free(Imap->Cmd.Params);
446 syslog(LOG_DEBUG, "Finished IMAP cleanup hook");
451 * Does the actual work of the CAPABILITY command (because we need to output this stuff in other places as well)
453 void imap_output_capability_string(void) {
454 IAPuts("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
457 if (!CC->redirect_ssl) IAPuts(" STARTTLS");
460 #ifndef DISABLE_IMAP_ACL
464 /* We are building a partial implementation of METADATA for the sole purpose
465 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
466 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
467 * metadata in a compatible and graceful way.
472 * LIST-EXTENDED was originally going to be required by the METADATA extension.
473 * It was mercifully removed prior to the finalization of RFC5464. We started
474 * implementing this but stopped when we learned that it would not be needed.
475 * If you uncomment this declaration you are responsible for writing a lot of new
478 * IAPuts(" LIST-EXTENDED")
484 * implements the CAPABILITY command
486 void imap_capability(int num_parms, ConstStr *Params) {
488 imap_output_capability_string();
490 IReply("OK CAPABILITY completed");
495 * Implements the ID command (specified by RFC2971)
497 * We ignore the client-supplied information, and output a NIL response.
498 * Although this is technically a valid implementation of the extension, it
499 * is quite useless. It exists only so that we may see which clients are
500 * making use of this extension.
503 void imap_id(int num_parms, ConstStr *Params) {
504 IAPuts("* ID NIL\r\n");
505 IReply("OK ID completed");
510 * Here's where our IMAP session begins its happy day.
512 void imap_greeting(void) {
514 CitContext *CCC = CC;
516 strcpy(CCC->cs_clientname, "IMAP session");
517 CCC->session_specific_data = malloc(sizeof(citimap));
518 Imap = (citimap *)CCC->session_specific_data;
519 memset(Imap, 0, sizeof(citimap));
520 Imap->authstate = imap_as_normal;
521 Imap->cached_rfc822_msgnum = (-1);
522 Imap->cached_rfc822_withbody = 0;
523 Imap->Reply = NewStrBufPlain(NULL, SIZ * 10); /* 40k */
526 IAPuts("* BYE; Server busy, try later\r\n");
527 CCC->kill_me = KILLME_NOLOGIN;
533 imap_output_capability_string();
534 IAPrintf("] %s IMAP4rev1 %s ready\r\n", CtdlGetConfigStr("c_fqdn"), CITADEL);
540 * IMAPS is just like IMAP, except it goes crypto right away.
542 void imaps_greeting(void) {
543 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
545 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO; /* kill session if no crypto */
552 * implements the LOGIN command (ordinary username/password login)
554 void imap_login(int num_parms, ConstStr *Params) {
558 if (Params[2].Key[0] == '{') {
559 IAPuts("+ go ahead\r\n");
560 IMAP->authstate = imap_as_expecting_multilineusername;
561 strcpy(IMAP->authseq, Params[0].Key);
565 IReply("BAD incorrect number of parameters");
569 if (CtdlLoginExistingUser(Params[2].Key) == login_ok) {
570 if (CtdlTryPassword(Params[3].Key, Params[3].len) == pass_ok) {
571 /* hm, thats not doable by IReply :-( */
572 IAPrintf("%s OK [", Params[0].Key);
573 imap_output_capability_string();
574 IAPrintf("] Hello, %s\r\n", CC->user.fullname);
578 IReplyPrintf("NO AUTHENTICATE %s failed", Params[3].Key);
583 IReply("BAD Login incorrect");
586 IReply("BAD incorrect number of parameters");
594 * Implements the AUTHENTICATE command
596 void imap_authenticate(int num_parms, ConstStr *Params) {
599 if (num_parms != 3) {
600 IReply("BAD incorrect number of parameters");
605 IReply("BAD Already logged in.");
609 if (!strcasecmp(Params[2].Key, "LOGIN")) {
610 size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
611 if (UsrBuf[len - 1] == '\n') {
612 UsrBuf[len - 1] = '\0';
615 IAPrintf("+ %s\r\n", UsrBuf);
616 IMAP->authstate = imap_as_expecting_username;
617 strcpy(IMAP->authseq, Params[0].Key);
621 if (!strcasecmp(Params[2].Key, "PLAIN")) {
622 // size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
623 // if (UsrBuf[len - 1] == '\n') {
624 // UsrBuf[len - 1] = '\0';
626 // IAPuts("+ %s\r\n", UsrBuf);
628 IMAP->authstate = imap_as_expecting_plainauth;
629 strcpy(IMAP->authseq, Params[0].Key);
634 IReplyPrintf("NO AUTHENTICATE %s failed",
640 void imap_auth_plain(void) {
641 citimap *Imap = IMAP;
642 const char *decoded_authstring;
643 char ident[256] = "";
651 memset(pass, 0, sizeof(pass));
652 decoded_len = StrBufDecodeBase64(Imap->Cmd.CmdBuf);
654 if (decoded_len > 0) {
655 decoded_authstring = ChrPtr(Imap->Cmd.CmdBuf);
657 len = safestrncpy(ident, decoded_authstring, sizeof ident);
659 decoded_len -= len - 1;
660 decoded_authstring += len + 1;
662 if (decoded_len > 0) {
663 len = safestrncpy(user, decoded_authstring, sizeof user);
665 decoded_authstring += len + 1;
666 decoded_len -= len - 1;
669 if (decoded_len > 0) {
670 plen = safestrncpy(pass, decoded_authstring, sizeof pass);
673 plen = sizeof(pass) - 1;
676 Imap->authstate = imap_as_normal;
678 if (!IsEmptyStr(ident)) {
679 result = CtdlLoginExistingUser(ident);
682 result = CtdlLoginExistingUser(user);
685 if (result == login_ok) {
686 if (CtdlTryPassword(pass, plen) == pass_ok) {
687 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
691 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
695 void imap_auth_login_user(long state) {
697 citimap *Imap = IMAP;
700 case imap_as_expecting_username:
701 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
702 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
703 size_t len = CtdlEncodeBase64(PWBuf, "Password:", 9, BASE64_NO_LINEBREAKS);
704 if (PWBuf[len - 1] == '\n') {
705 PWBuf[len - 1] = '\0';
708 IAPrintf("+ %s\r\n", PWBuf);
710 Imap->authstate = imap_as_expecting_password;
712 case imap_as_expecting_multilineusername:
713 extract_token(PWBuf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(PWBuf));
714 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
715 IAPuts("+ go ahead\r\n");
716 Imap->authstate = imap_as_expecting_multilinepassword;
722 void imap_auth_login_pass(long state) {
723 citimap *Imap = IMAP;
724 const char *pass = NULL;
729 case imap_as_expecting_password:
730 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
731 pass = ChrPtr(Imap->Cmd.CmdBuf);
732 len = StrLength(Imap->Cmd.CmdBuf);
734 case imap_as_expecting_multilinepassword:
735 pass = ChrPtr(Imap->Cmd.CmdBuf);
736 len = StrLength(Imap->Cmd.CmdBuf);
739 if (len > USERNAME_SIZE)
740 StrBufCutAt(Imap->Cmd.CmdBuf, USERNAME_SIZE, NULL);
742 if (CtdlTryPassword(pass, len) == pass_ok) {
743 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
746 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
748 Imap->authstate = imap_as_normal;
754 * implements the STARTTLS command (Citadel API version)
756 void imap_starttls(int num_parms, ConstStr *Params) {
757 char ok_response[SIZ];
758 char nosup_response[SIZ];
759 char error_response[SIZ];
761 snprintf(ok_response, SIZ, "%s OK begin TLS negotiation now\r\n", Params[0].Key);
762 snprintf(nosup_response, SIZ, "%s NO TLS not supported here\r\n", Params[0].Key);
763 snprintf(error_response, SIZ, "%s BAD Internal error\r\n", Params[0].Key);
764 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
769 * implements the SELECT command
771 void imap_select(int num_parms, ConstStr *Params) {
772 citimap *Imap = IMAP;
773 char towhere[ROOMNAMELEN];
774 char augmented_roomname[ROOMNAMELEN];
778 struct ctdlroom QRscratch;
782 /* Convert the supplied folder name to a roomname */
783 i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
785 IReply("NO Invalid mailbox name.");
790 /* First try a regular match */
791 c = CtdlGetRoom(&QRscratch, towhere);
793 /* Then try a mailbox name match */
795 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
796 c = CtdlGetRoom(&QRscratch, augmented_roomname);
798 safestrncpy(towhere, augmented_roomname, sizeof(towhere));
802 /* If the room exists, check security/access */
804 /* See if there is an existing user/room relationship */
805 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
807 /* normal clients have to pass through security */
813 /* Fail here if no such room */
815 IReply("NO ... no such room, or access denied");
819 /* If we already had some other folder selected, auto-expunge it */
823 * CtdlUserGoto() formally takes us to the desired room, happily returning
824 * the number of messages and number of new messages.
826 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
827 CtdlUserGoto(NULL, 0, 0, &msgs, &new, NULL, NULL);
830 if (!strcasecmp(Params[1].Key, "EXAMINE")) {
838 Imap->last_mtime = CC->room.QRmtime;
840 IAPrintf("* %d EXISTS\r\n", msgs);
841 IAPrintf("* %d RECENT\r\n", new);
843 IAPrintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
844 IAPrintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CtdlGetConfigLong("MMhighest") + 1);
846 /* Technically, \Deleted is a valid flag, but not a permanent flag,
847 * because we don't maintain its state across sessions. Citadel
848 * automatically expunges mailboxes when they are de-selected.
850 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
851 * some clients (particularly Thunderbird) to misbehave -- they simply
852 * elect not to transmit the flag at all. So we have to advertise
853 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
855 IAPuts("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
856 IAPuts("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
857 IReplyPrintf("OK [%s] %s completed", (Imap->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key);
862 * Does the real work for expunge.
864 int imap_do_expunge(void) {
865 struct CitContext *CCC = CC;
866 citimap *Imap = CCCIMAP;
868 int num_expunged = 0;
869 long *delmsgs = NULL;
872 syslog(LOG_DEBUG, "imap_do_expunge() called");
873 if (Imap->selected == 0) {
877 if (Imap->num_msgs > 0) {
878 delmsgs = malloc(Imap->num_msgs * sizeof(long));
879 for (i = 0; i < Imap->num_msgs; ++i) {
880 if (Imap->flags[i] & IMAP_DELETED) {
881 delmsgs[num_delmsgs++] = Imap->msgids[i];
884 if (num_delmsgs > 0) {
885 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
887 num_expunged += num_delmsgs;
891 if (num_expunged > 0) {
892 imap_rescan_msgids();
895 syslog(LOG_DEBUG, "Expunged %d messages from <%s>", num_expunged, CC->room.QRname);
896 return (num_expunged);
901 * implements the EXPUNGE command syntax
903 void imap_expunge(int num_parms, ConstStr *Params) {
904 int num_expunged = 0;
906 num_expunged = imap_do_expunge();
907 IReplyPrintf("OK expunged %d messages.", num_expunged);
912 * implements the CLOSE command
914 void imap_close(int num_parms, ConstStr *Params) {
916 /* Yes, we always expunge on close. */
917 if (IMAP->selected) {
924 IReply("OK CLOSE completed");
929 * Implements the NAMESPACE command.
931 void imap_namespace(int num_parms, ConstStr *Params) {
938 IAPuts("* NAMESPACE ");
940 /* All personal folders are subordinate to INBOX. */
941 IAPuts("((\"INBOX/\" \"/\")) ");
943 /* Other users' folders ... eventually? FIXME */
946 /* Show all floors as shared namespaces. Neato! */
948 for (i = 0; i < MAXFLOORS; ++i) {
949 fl = CtdlGetCachedFloor(i);
950 if (fl->f_flags & F_INUSE) {
951 /* if (floors > 0) IAPuts(" "); samjam says this confuses javamail */
953 len = snprintf(Namespace, sizeof(Namespace), "%s/", fl->f_name);
954 IPutStr(Namespace, len);
961 /* Wind it up with a newline and a completion message. */
963 IReply("OK NAMESPACE completed");
968 * Implements the CREATE command
971 void imap_create(int num_parms, ConstStr *Params) {
973 char roomname[ROOMNAMELEN];
978 char *notification_message = NULL;
981 IReply("NO A foder name must be specified");
985 if (strchr(Params[2].Key, '\\') != NULL) {
986 IReply("NO Invalid character in folder name");
987 syslog(LOG_ERR, "invalid character in folder name");
991 ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
993 IReply("NO Invalid mailbox name or location");
994 syslog(LOG_ERR, "invalid mailbox name or location");
997 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
998 flags = (ret & 0xff00); /* upper 8 bits = flags */
1000 if (flags & IR_MAILBOX) {
1001 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
1002 IReply("NO Personal folders must be created under INBOX");
1003 syslog(LOG_ERR, "not subordinate to inbox");
1008 if (flags & IR_MAILBOX) {
1009 newroomtype = 4; /* private mailbox */
1010 newroomview = VIEW_MAILBOX;
1013 newroomtype = 0; /* public folder */
1014 newroomview = VIEW_BBS;
1017 syslog(LOG_INFO, "Create new room <%s> on floor <%d> with type <%d>",
1018 roomname, floornum, newroomtype);
1020 ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
1022 IReply("NO Mailbox already exists, or create failed");
1025 IReply("OK CREATE completed");
1026 // post a message in Aide> describing the new room
1027 notification_message = malloc(1024);
1028 snprintf(notification_message, 1024,
1029 "A new room called \"%s\" has been created by %s%s%s%s\n",
1032 ((ret & QR_MAILBOX) ? " [personal]" : ""),
1033 ((ret & QR_PRIVATE) ? " [private]" : ""),
1034 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
1036 CtdlAideMessage(notification_message, "Room Creation Message");
1037 free(notification_message);
1039 syslog(LOG_DEBUG, "imap_create() completed");
1044 * Locate a room by its IMAP folder name, and check access to it.
1045 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1047 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok) {
1049 char augmented_roomname[ROOMNAMELEN];
1050 char roomname[ROOMNAMELEN];
1052 struct ctdlroom QRscratch;
1056 ret = imap_roomname(roomname, sizeof roomname, foldername);
1061 /* First try a regular match */
1062 c = CtdlGetRoom(&QRscratch, roomname);
1064 /* Then try a mailbox name match */
1066 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, roomname);
1067 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1069 safestrncpy(roomname, augmented_roomname, sizeof(roomname));
1072 /* If the room exists, check security/access */
1074 /* See if there is an existing user/room relationship */
1075 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1077 /* normal clients have to pass through security */
1078 if (ra & UA_KNOWN) {
1081 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1086 /* Fail here if no such room */
1088 strcpy(returned_roomname, "");
1092 safestrncpy(returned_roomname, QRscratch.QRname, ROOMNAMELEN);
1099 * Implements the STATUS command (sort of)
1102 void imap_status(int num_parms, ConstStr *Params) {
1105 char roomname[ROOMNAMELEN];
1106 char imaproomname[SIZ];
1107 char savedroom[ROOMNAMELEN];
1110 ret = imap_grabroom(roomname, Params[2].Key, 1);
1112 IReply("NO Invalid mailbox name or location, or access denied");
1117 * CtdlUserGoto() formally takes us to the desired room, happily returning
1118 * the number of messages and number of new messages. (If another
1119 * folder is selected, save its name so we can return there!!!!!)
1121 if (IMAP->selected) {
1122 strcpy(savedroom, CC->room.QRname);
1124 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1127 * Tell the client what it wants to know. In fact, tell it *more* than
1128 * it wants to know. We happily IGnore the supplied status data item
1129 * names and simply spew all possible data items. It's far easier to
1130 * code and probably saves us some processing time too.
1132 len = imap_mailboxname(imaproomname, sizeof imaproomname, &CC->room);
1133 IAPuts("* STATUS ");
1134 IPutStr(imaproomname, len);
1135 IAPrintf(" (MESSAGES %d ", msgs);
1136 IAPrintf("RECENT %d ", new); /* Initially, new==recent */
1137 IAPrintf("UIDNEXT %ld ", CtdlGetConfigLong("MMhighest") + 1);
1138 IAPrintf("UNSEEN %d)\r\n", new);
1141 * If another folder is selected, go back to that room so we can resume
1142 * our happy day without violent explosions.
1144 if (IMAP->selected) {
1145 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1149 * Oooh, look, we're done!
1151 IReply("OK STATUS completed");
1156 * Implements the SUBSCRIBE command
1159 void imap_subscribe(int num_parms, ConstStr *Params) {
1161 char roomname[ROOMNAMELEN];
1162 char savedroom[ROOMNAMELEN];
1165 ret = imap_grabroom(roomname, Params[2].Key, 1);
1168 "NO Error %d: invalid mailbox name or location, or access denied",
1175 * CtdlUserGoto() formally takes us to the desired room, which has the side
1176 * effect of marking the room as not-zapped ... exactly the effect
1177 * we're looking for.
1179 if (IMAP->selected) {
1180 strcpy(savedroom, CC->room.QRname);
1182 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1185 * If another folder is selected, go back to that room so we can resume
1186 * our happy day without violent explosions.
1188 if (IMAP->selected) {
1189 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1192 IReply("OK SUBSCRIBE completed");
1197 * Implements the UNSUBSCRIBE command
1200 void imap_unsubscribe(int num_parms, ConstStr *Params) {
1202 char roomname[ROOMNAMELEN];
1203 char savedroom[ROOMNAMELEN];
1206 ret = imap_grabroom(roomname, Params[2].Key, 1);
1208 IReply("NO Invalid mailbox name or location, or access denied");
1213 * CtdlUserGoto() formally takes us to the desired room.
1215 if (IMAP->selected) {
1216 strcpy(savedroom, CC->room.QRname);
1218 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1221 * Now make the API call to zap the room
1223 if (CtdlForgetThisRoom() == 0) {
1224 IReply("OK UNSUBSCRIBE completed");
1227 IReply("NO You may not unsubscribe from this folder.");
1231 * If another folder is selected, go back to that room so we can resume
1232 * our happy day without violent explosions.
1234 if (IMAP->selected) {
1235 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1241 * Implements the DELETE command
1244 void imap_delete(int num_parms, ConstStr *Params) {
1246 char roomname[ROOMNAMELEN];
1247 char savedroom[ROOMNAMELEN];
1250 ret = imap_grabroom(roomname, Params[2].Key, 1);
1252 IReply("NO Invalid mailbox name, or access denied");
1257 * CtdlUserGoto() formally takes us to the desired room, happily returning
1258 * the number of messages and number of new messages. (If another
1259 * folder is selected, save its name so we can return there!!!!!)
1261 if (IMAP->selected) {
1262 strcpy(savedroom, CC->room.QRname);
1264 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1267 * Now delete the room.
1269 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1270 CtdlScheduleRoomForDeletion(&CC->room);
1271 IReply("OK DELETE completed");
1274 IReply("NO Can't delete this folder.");
1278 * If another folder is selected, go back to that room so we can resume
1279 * our happy day without violent explosions.
1281 if (IMAP->selected) {
1282 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1288 * Back end function for imap_rename()
1290 void imap_rename_backend(struct ctdlroom *qrbuf, void *data) {
1291 char foldername[SIZ];
1292 char newfoldername[SIZ];
1293 char newroomname[ROOMNAMELEN];
1295 struct irl *irlp = NULL; /* scratch pointer */
1296 irlparms *myirlparms;
1298 myirlparms = (irlparms *) data;
1299 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1301 /* Rename subfolders */
1302 if ((!strncasecmp(foldername, myirlparms->oldname, myirlparms->oldnamelen) && (foldername[myirlparms->oldnamelen] == '/'))) {
1303 snprintf(newfoldername, sizeof newfoldername, "%s/%s", myirlparms->newname, &foldername[myirlparms->oldnamelen + 1]);
1304 newfloor = imap_roomname(newroomname, sizeof newroomname, newfoldername) & 0xFF;
1305 irlp = (struct irl *) malloc(sizeof(struct irl));
1306 strcpy(irlp->irl_newroom, newroomname);
1307 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1308 irlp->irl_newfloor = newfloor;
1309 irlp->next = *(myirlparms->irl);
1310 *(myirlparms->irl) = irlp;
1316 * Implements the RENAME command
1319 void imap_rename(int num_parms, ConstStr *Params) {
1320 char old_room[ROOMNAMELEN];
1321 char new_room[ROOMNAMELEN];
1325 struct irl *irl = NULL; /* the list */
1326 struct irl *irlp = NULL; /* scratch pointer */
1330 if (strchr(Params[3].Key, '\\') != NULL) {
1331 IReply("NO Invalid character in folder name");
1335 imap_roomname(old_room, sizeof old_room, Params[2].Key);
1336 newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1337 new_floor = (newr & 0xFF);
1339 r = CtdlRenameRoom(old_room, new_room, new_floor);
1341 if (r == crr_room_not_found) {
1342 IReply("NO Could not locate this folder");
1345 if (r == crr_already_exists) {
1346 IReplyPrintf("NO '%s' already exists.");
1349 if (r == crr_noneditable) {
1350 IReply("NO This folder is not editable.");
1353 if (r == crr_invalid_floor) {
1354 IReply("NO Folder root does not exist.");
1357 if (r == crr_access_denied) {
1358 IReply("NO You do not have permission to edit this folder.");
1362 IReplyPrintf("NO Rename failed - undefined error %d", r);
1366 /* If this is the INBOX, then RFC2060 says we have to just move the
1367 * contents. In a Citadel environment it's easier to rename the room
1368 * (already did that) and create a new inbox.
1370 if (!strcasecmp(Params[2].Key, "INBOX")) {
1371 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1374 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1376 irlparms.oldname = Params[2].Key;
1377 irlparms.oldnamelen = Params[2].len;
1378 irlparms.newname = Params[3].Key;
1379 irlparms.newnamelen = Params[3].len;
1380 irlparms.irl = &irl;
1381 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1383 /* ... and now rename them. */
1384 while (irl != NULL) {
1385 r = CtdlRenameRoom(irl->irl_oldroom, irl->irl_newroom, irl->irl_newfloor);
1387 /* FIXME handle error returns better */
1388 syslog(LOG_ERR, "CtdlRenameRoom() error %d", r);
1396 snprintf(aidemsg, sizeof aidemsg, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1401 CtdlAideMessage(aidemsg, "IMAP folder rename");
1403 IReply("OK RENAME completed");
1408 * Main command loop for IMAP sessions.
1410 void imap_command_loop(void) {
1411 struct CitContext *CCC = CC;
1412 struct timeval tv1, tv2;
1413 suseconds_t total_time = 0;
1415 const char *pchs, *pche;
1416 const imap_handler_hook *h;
1418 gettimeofday(&tv1, NULL);
1419 CCC->lastcmd = time(NULL);
1423 if (Imap->Cmd.CmdBuf == NULL)
1424 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1426 FlushStrBuf(Imap->Cmd.CmdBuf);
1428 if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1429 syslog(LOG_ERR, "client disconnected: ending session.");
1430 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1434 if (Imap->authstate == imap_as_expecting_password) {
1435 syslog(LOG_INFO, "<password>");
1437 else if (Imap->authstate == imap_as_expecting_plainauth) {
1438 syslog(LOG_INFO, "<plain_auth>");
1440 else if ((Imap->authstate == imap_as_expecting_multilineusername) || cbmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1441 syslog(LOG_INFO, "LOGIN...");
1444 syslog(LOG_DEBUG, "%s", ChrPtr(Imap->Cmd.CmdBuf));
1447 pchs = ChrPtr(Imap->Cmd.CmdBuf);
1448 pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1450 while ((pche > pchs) && ((*pche == '\n') || (*pche == '\r'))) {
1452 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1454 StrBufTrim(Imap->Cmd.CmdBuf);
1456 /* If we're in the middle of a multi-line command, handle that */
1457 switch (Imap->authstate){
1458 case imap_as_expecting_username:
1459 imap_auth_login_user(imap_as_expecting_username);
1462 case imap_as_expecting_multilineusername:
1463 imap_auth_login_user(imap_as_expecting_multilineusername);
1466 case imap_as_expecting_plainauth:
1470 case imap_as_expecting_password:
1471 imap_auth_login_pass(imap_as_expecting_password);
1474 case imap_as_expecting_multilinepassword:
1475 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1482 /* Ok, at this point we're in normal command mode.
1483 * If the command just submitted does not contain a literal, we
1484 * might think about delivering some untagged stuff...
1487 /* Grab the tag, command, and parameters. */
1488 imap_parameterize(&Imap->Cmd);
1490 /* Now for the command set. */
1491 h = imap_lookup(Imap->Cmd.num_parms, Imap->Cmd.Params);
1494 IReply("BAD command unrecognized");
1498 /* RFC3501 says that we cannot output untagged data during these commands */
1499 if ((h->Flags & I_FLAG_UNTAGGED) == 0) {
1501 // we can put any additional untagged stuff right here in the future
1503 // Before processing the command that was just entered... if we happen
1504 // to have a folder selected, we'd like to rescan that folder for new
1505 // messages, and for deletions/changes of existing messages. This
1506 // could probably be optimized better with some deep thought...
1507 if (Imap->selected) {
1508 imap_rescan_msgids();
1512 /* does our command require a logged-in state */
1513 if ((!CC->logged_in) && ((h->Flags & I_FLAG_LOGGED_IN) != 0)) {
1514 IReply("BAD Not logged in.");
1518 /* does our command require the SELECT state on a mailbox */
1519 if ((Imap->selected == 0) && ((h->Flags & I_FLAG_SELECT) != 0)){
1520 IReply("BAD no folder selected");
1523 h->h(Imap->Cmd.num_parms, Imap->Cmd.Params);
1525 /* If the client transmitted a message we can free it now */
1530 imap_free_transmitted_message();
1532 gettimeofday(&tv2, NULL);
1533 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1534 syslog(LOG_DEBUG, "IMAP command completed in %ld.%ld seconds",
1535 (total_time / 1000000),
1536 (total_time % 1000000)
1541 void imap_noop(int num_parms, ConstStr *Params) {
1542 IReply("OK No operation");
1546 void imap_logout(int num_parms, ConstStr *Params) {
1547 if (IMAP->selected) {
1548 imap_do_expunge(); /* yes, we auto-expunge at logout */
1550 IAPrintf("* BYE %s logging out\r\n", CtdlGetConfigStr("c_fqdn"));
1551 IReply("OK Citadel IMAP session ended.");
1552 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
1557 const char *CitadelServiceIMAP="IMAP";
1558 const char *CitadelServiceIMAPS="IMAPS";
1561 // Initialization function, called from modules_init.c
1562 char *ctdl_module_init_imap(void) {
1563 if (ImapCmds == NULL) {
1564 ImapCmds = NewHash(1, NULL);
1567 RegisterImapCMD("NOOP", "", imap_noop, I_FLAG_NONE);
1568 RegisterImapCMD("CHECK", "", imap_noop, I_FLAG_NONE);
1569 RegisterImapCMD("ID", "", imap_id, I_FLAG_NONE);
1570 RegisterImapCMD("LOGOUT", "", imap_logout, I_FLAG_NONE);
1571 RegisterImapCMD("LOGIN", "", imap_login, I_FLAG_NONE);
1572 RegisterImapCMD("AUTHENTICATE", "", imap_authenticate, I_FLAG_NONE);
1573 RegisterImapCMD("CAPABILITY", "", imap_capability, I_FLAG_NONE);
1575 RegisterImapCMD("STARTTLS", "", imap_starttls, I_FLAG_NONE);
1578 /* The commans below require a logged-in state */
1579 RegisterImapCMD("SELECT", "", imap_select, I_FLAG_LOGGED_IN);
1580 RegisterImapCMD("EXAMINE", "", imap_select, I_FLAG_LOGGED_IN);
1581 RegisterImapCMD("LSUB", "", imap_list, I_FLAG_LOGGED_IN);
1582 RegisterImapCMD("LIST", "", imap_list, I_FLAG_LOGGED_IN);
1583 RegisterImapCMD("CREATE", "", imap_create, I_FLAG_LOGGED_IN);
1584 RegisterImapCMD("DELETE", "", imap_delete, I_FLAG_LOGGED_IN);
1585 RegisterImapCMD("RENAME", "", imap_rename, I_FLAG_LOGGED_IN);
1586 RegisterImapCMD("STATUS", "", imap_status, I_FLAG_LOGGED_IN);
1587 RegisterImapCMD("SUBSCRIBE", "", imap_subscribe, I_FLAG_LOGGED_IN);
1588 RegisterImapCMD("UNSUBSCRIBE", "", imap_unsubscribe, I_FLAG_LOGGED_IN);
1589 RegisterImapCMD("APPEND", "", imap_append, I_FLAG_LOGGED_IN);
1590 RegisterImapCMD("NAMESPACE", "", imap_namespace, I_FLAG_LOGGED_IN);
1591 RegisterImapCMD("SETACL", "", imap_setacl, I_FLAG_LOGGED_IN);
1592 RegisterImapCMD("DELETEACL", "", imap_deleteacl, I_FLAG_LOGGED_IN);
1593 RegisterImapCMD("GETACL", "", imap_getacl, I_FLAG_LOGGED_IN);
1594 RegisterImapCMD("LISTRIGHTS", "", imap_listrights, I_FLAG_LOGGED_IN);
1595 RegisterImapCMD("MYRIGHTS", "", imap_myrights, I_FLAG_LOGGED_IN);
1596 RegisterImapCMD("GETMETADATA", "", imap_getmetadata, I_FLAG_LOGGED_IN);
1597 RegisterImapCMD("SETMETADATA", "", imap_setmetadata, I_FLAG_LOGGED_IN);
1599 /* The commands below require the SELECT state on a mailbox */
1600 RegisterImapCMD("FETCH", "", imap_fetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1601 RegisterImapCMD("UID", "FETCH", imap_uidfetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1602 RegisterImapCMD("SEARCH", "", imap_search, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1603 RegisterImapCMD("UID", "SEARCH", imap_uidsearch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1604 RegisterImapCMD("STORE", "", imap_store, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1605 RegisterImapCMD("UID", "STORE", imap_uidstore, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1606 RegisterImapCMD("COPY", "", imap_copy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1607 RegisterImapCMD("UID", "COPY", imap_uidcopy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1608 RegisterImapCMD("EXPUNGE", "", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1609 RegisterImapCMD("UID", "EXPUNGE", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1610 RegisterImapCMD("CLOSE", "", imap_close, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1613 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imap_port"), NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1615 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imaps_port"), NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1617 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP, PRIO_STOP + 30);
1620 // return our module name for the log