1 // IMAP server for the Citadel system
3 // Copyright (c) 1987-2023 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>
23 #include <libcitadel.h>
24 #include "../../citadel_defs.h"
25 #include "../../server.h"
26 #include "../../citserver.h"
27 #include "../../support.h"
28 #include "../../config.h"
29 #include "../../user_ops.h"
30 #include "../../room_ops.h"
31 #include "../../database.h"
32 #include "../../msgbase.h"
33 #include "../../internet_addressing.h"
34 #include "serv_imap.h"
35 #include "imap_tools.h"
36 #include "imap_list.h"
37 #include "imap_fetch.h"
38 #include "imap_search.h"
39 #include "imap_store.h"
41 #include "imap_metadata.h"
42 #include "imap_misc.h"
44 #include "../../ctdl_module.h"
45 HashList *ImapCmds = NULL;
46 void registerImapCMD(const char *First, long FLen, const char *Second, long SLen, imap_handler H, int Flags) {
49 h = (imap_handler_hook*) malloc(sizeof(imap_handler_hook));
50 memset(h, 0, sizeof(imap_handler_hook));
55 Put(ImapCmds, First, FLen, h, NULL);
59 memcpy(CMD, First, FLen);
60 memcpy(CMD+FLen, Second, SLen);
61 CMD[FLen+SLen] = '\0';
62 Put(ImapCmds, CMD, FLen + SLen, h, NULL);
67 const imap_handler_hook *imap_lookup(int num_parms, ConstStr *Params) {
74 /* we abuse the Reply-buffer for uppercasing... */
75 StrBufPlain(Imap->Reply, CKEY(Params[1]));
76 StrBufUpCase(Imap->Reply);
78 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
79 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
80 syslog(LOG_DEBUG, "Found.");
81 FlushStrBuf(Imap->Reply);
82 return (imap_handler_hook *) v;
86 syslog(LOG_DEBUG, "NOT Found.");
87 FlushStrBuf(Imap->Reply);
91 syslog(LOG_DEBUG, "---- Looking up [%s] -----", ChrPtr(Imap->Reply));
92 StrBufAppendBufPlain(Imap->Reply, CKEY(Params[2]), 0);
93 StrBufUpCase(Imap->Reply);
94 if (GetHash(ImapCmds, SKEY(Imap->Reply), &v)) {
95 syslog(LOG_DEBUG, "Found.");
96 FlushStrBuf(Imap->Reply);
97 return (imap_handler_hook *) v;
99 syslog(LOG_DEBUG, "NOT Found.");
100 FlushStrBuf(Imap->Reply);
105 /* imap_rename() uses this struct containing list of rooms to rename */
108 char irl_oldroom[ROOMNAMELEN];
109 char irl_newroom[ROOMNAMELEN];
114 /* Data which is passed between imap_rename() and imap_rename_backend() */
115 typedef struct __irlparms {
125 * If there is a message ID map in memory, free it
127 void imap_free_msgids(void) {
128 citimap *Imap = IMAP;
129 if (Imap->msgids != NULL) {
135 if (Imap->flags != NULL) {
139 Imap->last_mtime = (-1);
144 * If there is a transmitted message in memory, free it
146 void imap_free_transmitted_message(void) {
147 FreeStrBuf(&IMAP->TransmittedMessage);
152 * Set the \Seen, \Recent. and \Answered flags, based on the sequence
153 * sets stored in the visit record for this user/room. Note that we have
154 * to parse each sequence set manually here, because calling the utility
155 * function is_msg_in_sequence_set() over and over again is too expensive.
157 * first_msg should be set to 0 to rescan the flags for every message in the
158 * room, or some other value if we're only interested in an incremental
161 void imap_set_seen_flags(int first_msg) {
162 citimap *Imap = IMAP;
167 char setstr[64], lostr[64], histr[64];
170 if (Imap->num_msgs < 0) return;
171 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
173 for (i = first_msg; i < Imap->num_msgs; ++i) {
174 Imap->flags[i] = Imap->flags[i] & ~IMAP_SEEN;
175 Imap->flags[i] |= IMAP_RECENT;
176 Imap->flags[i] = Imap->flags[i] & ~IMAP_ANSWERED;
180 * Do the "\Seen" flag.
181 * (Any message not "\Seen" is considered "\Recent".)
183 num_sets = num_tokens(vbuf.v_seen, ',');
184 for (s=0; s<num_sets; ++s) {
185 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
187 extract_token(lostr, setstr, 0, ':', sizeof lostr);
188 if (num_tokens(setstr, ':') >= 2) {
189 extract_token(histr, setstr, 1, ':', sizeof histr);
190 if (!strcmp(histr, "*")) {
191 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
195 strcpy(histr, lostr);
200 for (i = first_msg; i < Imap->num_msgs; ++i) {
201 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
202 Imap->flags[i] |= IMAP_SEEN;
203 Imap->flags[i] = Imap->flags[i] & ~IMAP_RECENT;
208 /* Do the ANSWERED flag */
209 num_sets = num_tokens(vbuf.v_answered, ',');
210 for (s=0; s<num_sets; ++s) {
211 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
213 extract_token(lostr, setstr, 0, ':', sizeof lostr);
214 if (num_tokens(setstr, ':') >= 2) {
215 extract_token(histr, setstr, 1, ':', sizeof histr);
216 if (!strcmp(histr, "*")) {
217 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
221 strcpy(histr, lostr);
226 for (i = first_msg; i < Imap->num_msgs; ++i) {
227 if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
228 Imap->flags[i] |= IMAP_ANSWERED;
237 * Back end for imap_load_msgids()
239 * Optimization: instead of calling realloc() to add each message, we
240 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
241 * allows the mapping to proceed much faster.
243 void imap_add_single_msgid(long msgnum, void *userdata) {
244 citimap *Imap = IMAP;
247 if (Imap->num_msgs > Imap->num_alloc) {
248 Imap->num_alloc += REALLOC_INCREMENT;
249 Imap->msgids = realloc(Imap->msgids, (Imap->num_alloc * sizeof(long)) );
250 Imap->flags = realloc(Imap->flags, (Imap->num_alloc * sizeof(unsigned int)) );
252 Imap->msgids[Imap->num_msgs - 1] = msgnum;
253 Imap->flags[Imap->num_msgs - 1] = 0;
258 * Set up a message ID map for the current room (folder)
260 void imap_load_msgids(void) {
261 citimap *Imap = IMAP;
263 if (Imap->selected == 0) {
264 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
268 imap_free_msgids(); /* If there was already a map, free it */
270 /* Load the message list */
271 Imap->num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &Imap->msgids);
272 Imap->num_alloc = Imap->num_msgs;
274 if (Imap->num_msgs) {
275 Imap->flags = malloc(Imap->num_alloc * sizeof(unsigned int));
276 memset(Imap->flags, 0, (Imap->num_alloc * sizeof(unsigned int)) );
278 imap_set_seen_flags(0);
283 * Re-scan the selected room (folder) and see if it's been changed at all
285 void imap_rescan_msgids(void) {
286 citimap *Imap = IMAP;
287 int original_num_msgs = 0;
288 long original_highest = 0L;
290 int message_still_exists;
291 long *msglist = NULL;
295 if (Imap->selected == 0) {
296 syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
301 * Check to see if the room's contents have changed.
302 * If not, we can avoid this rescan.
304 CtdlGetRoom(&CC->room, CC->room.QRname);
305 if (Imap->last_mtime == CC->room.QRmtime) { /* No changes! */
309 /* Load the *current* message list from disk, so we can compare it
310 * to what we have in memory.
312 num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
315 * Check to see if any of the messages we know about have been expunged
317 if (Imap->num_msgs > 0) {
319 for (i = 0; i < Imap->num_msgs; ++i) {
321 message_still_exists = 0;
323 for (j = jstart; j < num_msgs; ++j) {
324 if (msglist[j] == Imap->msgids[i]) {
325 message_still_exists = 1;
332 if (message_still_exists == 0) {
333 IAPrintf("* %d EXPUNGE\r\n", i + 1);
335 // When a message is expunged, we have to slide all the existing messages up in the message array.
337 memmove(&Imap->msgids[i], &Imap->msgids[i + 1], (sizeof(long) * (Imap->num_msgs - i)));
338 memmove(&Imap->flags[i], &Imap->flags[i + 1], (sizeof(unsigned int) * (Imap->num_msgs - i)));
345 // Remember how many messages were here before we re-scanned.
346 original_num_msgs = Imap->num_msgs;
347 if (Imap->num_msgs > 0) {
348 original_highest = Imap->msgids[Imap->num_msgs - 1];
351 original_highest = 0L;
354 // Now peruse the room for *new* messages only.
355 // This logic is probably the cause of Bug # 368
356 // [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
358 for (j = 0; j < num_msgs; ++j) {
359 if (msglist[j] > original_highest) {
360 imap_add_single_msgid(msglist[j], NULL);
364 imap_set_seen_flags(original_num_msgs);
367 * If new messages have arrived, tell the client about them.
369 if (Imap->num_msgs > original_num_msgs) {
371 for (j = 0; j < num_msgs; ++j) {
372 if (Imap->flags[j] & IMAP_RECENT) {
377 IAPrintf("* %d EXISTS\r\n", Imap->num_msgs);
378 IAPrintf("* %d RECENT\r\n", num_recent);
382 Imap->last_mtime = CC->room.QRmtime;
387 * This cleanup function blows away the temporary memory and files used by
390 void imap_cleanup_function(void) {
391 citimap *Imap = IMAP;
393 /* Don't do this stuff if this is not a Imap session! */
394 if (CC->h_command_function != imap_command_loop)
397 /* If there is a mailbox selected, auto-expunge it. */
398 if (Imap->selected) {
402 syslog(LOG_DEBUG, "Performing IMAP cleanup hook");
404 imap_free_transmitted_message();
406 if (Imap->cached_rfc822 != NULL) {
407 FreeStrBuf(&Imap->cached_rfc822);
408 Imap->cached_rfc822_msgnum = (-1);
409 Imap->cached_rfc822_withbody = 0;
412 if (Imap->cached_body != NULL) {
413 free(Imap->cached_body);
414 Imap->cached_body = NULL;
415 Imap->cached_body_len = 0;
416 Imap->cached_bodymsgnum = (-1);
418 FreeStrBuf(&Imap->Cmd.CmdBuf);
419 FreeStrBuf(&Imap->Reply);
420 if (Imap->Cmd.Params != NULL) free(Imap->Cmd.Params);
422 syslog(LOG_DEBUG, "Finished IMAP cleanup hook");
427 * Does the actual work of the CAPABILITY command (because we need to output this stuff in other places as well)
429 void imap_output_capability_string(void) {
430 IAPuts("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
433 if (!CC->redirect_ssl) IAPuts(" STARTTLS");
436 #ifndef DISABLE_IMAP_ACL
440 /* We are building a partial implementation of METADATA for the sole purpose
441 * of interoperating with the ical/vcard version of the Bynari Insight Connector.
442 * It is not a full RFC5464 implementation, but it should refuse non-Bynari
443 * metadata in a compatible and graceful way.
448 * LIST-EXTENDED was originally going to be required by the METADATA extension.
449 * It was mercifully removed prior to the finalization of RFC5464. We started
450 * implementing this but stopped when we learned that it would not be needed.
451 * If you uncomment this declaration you are responsible for writing a lot of new
454 * IAPuts(" LIST-EXTENDED")
460 * implements the CAPABILITY command
462 void imap_capability(int num_parms, ConstStr *Params) {
464 imap_output_capability_string();
466 IReply("OK CAPABILITY completed");
471 * Implements the ID command (specified by RFC2971)
473 * We ignore the client-supplied information, and output a NIL response.
474 * Although this is technically a valid implementation of the extension, it
475 * is quite useless. It exists only so that we may see which clients are
476 * making use of this extension.
479 void imap_id(int num_parms, ConstStr *Params) {
480 IAPuts("* ID NIL\r\n");
481 IReply("OK ID completed");
486 * Here's where our IMAP session begins its happy day.
488 void imap_greeting(void) {
491 strcpy(CC->cs_clientname, "IMAP session");
492 CC->session_specific_data = malloc(sizeof(citimap));
493 Imap = (citimap *)CC->session_specific_data;
494 memset(Imap, 0, sizeof(citimap));
495 Imap->authstate = imap_as_normal;
496 Imap->cached_rfc822_msgnum = (-1);
497 Imap->cached_rfc822_withbody = 0;
498 Imap->Reply = NewStrBufPlain(NULL, SIZ * 10); /* 40k */
501 IAPuts("* BYE; Server busy, try later\r\n");
502 CC->kill_me = KILLME_NOLOGIN;
508 imap_output_capability_string();
509 IAPrintf("] %s IMAP4rev1 %s ready\r\n", CtdlGetConfigStr("c_fqdn"), CITADEL);
515 * IMAPS is just like IMAP, except it goes crypto right away.
517 void imaps_greeting(void) {
518 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
520 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO; /* kill session if no crypto */
527 * implements the LOGIN command (ordinary username/password login)
529 void imap_login(int num_parms, ConstStr *Params) {
533 if (Params[2].len && (Params[2].Key[0] == '{')) {
534 IAPuts("+ go ahead\r\n");
535 IMAP->authstate = imap_as_expecting_multilineusername;
536 strcpy(IMAP->authseq, Params[0].Key);
540 IReply("BAD incorrect number of parameters");
544 if (CtdlLoginExistingUser(Params[2].Key) == login_ok) {
545 if (CtdlTryPassword(Params[3].Key, Params[3].len) == pass_ok) {
546 /* hm, thats not doable by IReply :-( */
547 IAPrintf("%s OK [", Params[0].Key);
548 imap_output_capability_string();
549 IAPrintf("] Hello, %s\r\n", CC->user.fullname);
553 IReplyPrintf("NO AUTHENTICATE %s failed", Params[3].Key);
558 IReply("BAD Login incorrect");
561 IReply("BAD incorrect number of parameters");
569 * Implements the AUTHENTICATE command
571 void imap_authenticate(int num_parms, ConstStr *Params) {
574 if (num_parms != 3) {
575 IReply("BAD incorrect number of parameters");
580 IReply("BAD Already logged in.");
584 if (!strcasecmp(Params[2].Key, "LOGIN")) {
585 size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
586 if (UsrBuf[len - 1] == '\n') {
587 UsrBuf[len - 1] = '\0';
590 IAPrintf("+ %s\r\n", UsrBuf);
591 IMAP->authstate = imap_as_expecting_username;
592 strcpy(IMAP->authseq, Params[0].Key);
596 if (!strcasecmp(Params[2].Key, "PLAIN")) {
597 // size_t len = CtdlEncodeBase64(UsrBuf, "Username:", 9, BASE64_NO_LINEBREAKS);
598 // if (UsrBuf[len - 1] == '\n') {
599 // UsrBuf[len - 1] = '\0';
601 // IAPuts("+ %s\r\n", UsrBuf);
603 IMAP->authstate = imap_as_expecting_plainauth;
604 strcpy(IMAP->authseq, Params[0].Key);
609 IReplyPrintf("NO AUTHENTICATE %s failed",
615 void imap_auth_plain(void) {
616 citimap *Imap = IMAP;
617 const char *decoded_authstring;
618 char ident[256] = "";
626 memset(pass, 0, sizeof(pass));
627 decoded_len = StrBufDecodeBase64(Imap->Cmd.CmdBuf);
629 if (decoded_len > 0) {
630 decoded_authstring = ChrPtr(Imap->Cmd.CmdBuf);
632 len = safestrncpy(ident, decoded_authstring, sizeof ident);
634 decoded_len -= len - 1;
635 decoded_authstring += len + 1;
637 if (decoded_len > 0) {
638 len = safestrncpy(user, decoded_authstring, sizeof user);
640 decoded_authstring += len + 1;
641 decoded_len -= len - 1;
644 if (decoded_len > 0) {
645 plen = safestrncpy(pass, decoded_authstring, sizeof pass);
648 plen = sizeof(pass) - 1;
651 Imap->authstate = imap_as_normal;
653 if (!IsEmptyStr(ident)) {
654 result = CtdlLoginExistingUser(ident);
657 result = CtdlLoginExistingUser(user);
660 if (result == login_ok) {
661 if (CtdlTryPassword(pass, plen) == pass_ok) {
662 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
666 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
670 void imap_auth_login_user(long state) {
672 citimap *Imap = IMAP;
675 case imap_as_expecting_username:
676 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
677 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
678 size_t len = CtdlEncodeBase64(PWBuf, "Password:", 9, BASE64_NO_LINEBREAKS);
679 if (PWBuf[len - 1] == '\n') {
680 PWBuf[len - 1] = '\0';
683 IAPrintf("+ %s\r\n", PWBuf);
685 Imap->authstate = imap_as_expecting_password;
687 case imap_as_expecting_multilineusername:
688 extract_token(PWBuf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(PWBuf));
689 CtdlLoginExistingUser(ChrPtr(Imap->Cmd.CmdBuf));
690 IAPuts("+ go ahead\r\n");
691 Imap->authstate = imap_as_expecting_multilinepassword;
697 void imap_auth_login_pass(long state) {
698 citimap *Imap = IMAP;
699 const char *pass = NULL;
704 case imap_as_expecting_password:
705 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
706 pass = ChrPtr(Imap->Cmd.CmdBuf);
707 len = StrLength(Imap->Cmd.CmdBuf);
709 case imap_as_expecting_multilinepassword:
710 pass = ChrPtr(Imap->Cmd.CmdBuf);
711 len = StrLength(Imap->Cmd.CmdBuf);
714 if (len > USERNAME_SIZE)
715 StrBufCutAt(Imap->Cmd.CmdBuf, USERNAME_SIZE, NULL);
717 if (CtdlTryPassword(pass, len) == pass_ok) {
718 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
721 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
723 Imap->authstate = imap_as_normal;
729 * implements the STARTTLS command (Citadel API version)
731 void imap_starttls(int num_parms, ConstStr *Params) {
732 char ok_response[SIZ];
733 char nosup_response[SIZ];
734 char error_response[SIZ];
736 snprintf(ok_response, SIZ, "%s OK begin TLS negotiation now\r\n", Params[0].Key);
737 snprintf(nosup_response, SIZ, "%s NO TLS not supported here\r\n", Params[0].Key);
738 snprintf(error_response, SIZ, "%s BAD Internal error\r\n", Params[0].Key);
739 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
744 * implements the SELECT command
746 void imap_select(int num_parms, ConstStr *Params) {
747 citimap *Imap = IMAP;
748 char towhere[ROOMNAMELEN];
749 char augmented_roomname[ROOMNAMELEN];
753 struct ctdlroom QRscratch;
757 /* Convert the supplied folder name to a roomname */
758 i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
760 IReply("NO Invalid mailbox name.");
765 /* First try a regular match */
766 c = CtdlGetRoom(&QRscratch, towhere);
768 /* Then try a mailbox name match */
770 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
771 c = CtdlGetRoom(&QRscratch, augmented_roomname);
773 safestrncpy(towhere, augmented_roomname, sizeof(towhere));
777 /* If the room exists, check security/access */
779 /* See if there is an existing user/room relationship */
780 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
782 /* normal clients have to pass through security */
788 /* Fail here if no such room */
790 IReply("NO ... no such room, or access denied");
794 /* If we already had some other folder selected, auto-expunge it */
798 * CtdlUserGoto() formally takes us to the desired room, happily returning
799 * the number of messages and number of new messages.
801 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
802 CtdlUserGoto(NULL, 0, 0, &msgs, &new, NULL, NULL);
805 if (!strcasecmp(Params[1].Key, "EXAMINE")) {
813 Imap->last_mtime = CC->room.QRmtime;
815 IAPrintf("* %d EXISTS\r\n", msgs);
816 IAPrintf("* %d RECENT\r\n", new);
818 IAPrintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
819 IAPrintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CtdlGetConfigLong("MMhighest") + 1);
821 /* Technically, \Deleted is a valid flag, but not a permanent flag,
822 * because we don't maintain its state across sessions. Citadel
823 * automatically expunges mailboxes when they are de-selected.
825 * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
826 * some clients (particularly Thunderbird) to misbehave -- they simply
827 * elect not to transmit the flag at all. So we have to advertise
828 * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
830 IAPuts("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
831 IAPuts("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
832 IReplyPrintf("OK [%s] %s completed", (Imap->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key);
837 * Does the real work for expunge.
839 int imap_do_expunge(void) {
840 citimap *Imap = IMAP;
842 int num_expunged = 0;
843 long *delmsgs = NULL;
846 syslog(LOG_DEBUG, "imap_do_expunge() called");
847 if (Imap->selected == 0) {
851 if (Imap->num_msgs > 0) {
852 delmsgs = malloc(Imap->num_msgs * sizeof(long));
853 for (i = 0; i < Imap->num_msgs; ++i) {
854 if (Imap->flags[i] & IMAP_DELETED) {
855 delmsgs[num_delmsgs++] = Imap->msgids[i];
858 if (num_delmsgs > 0) {
859 CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
861 num_expunged += num_delmsgs;
865 if (num_expunged > 0) {
866 imap_rescan_msgids();
869 syslog(LOG_DEBUG, "Expunged %d messages from <%s>", num_expunged, CC->room.QRname);
870 return (num_expunged);
875 * implements the EXPUNGE command syntax
877 void imap_expunge(int num_parms, ConstStr *Params) {
878 int num_expunged = 0;
880 num_expunged = imap_do_expunge();
881 IReplyPrintf("OK expunged %d messages.", num_expunged);
886 * implements the CLOSE command
888 void imap_close(int num_parms, ConstStr *Params) {
890 /* Yes, we always expunge on close. */
891 if (IMAP->selected) {
898 IReply("OK CLOSE completed");
903 * Implements the NAMESPACE command.
905 void imap_namespace(int num_parms, ConstStr *Params) {
912 IAPuts("* NAMESPACE ");
914 /* All personal folders are subordinate to INBOX. */
915 IAPuts("((\"INBOX/\" \"/\")) ");
917 /* Other users' folders ... eventually? FIXME */
920 /* Show all floors as shared namespaces. Neato! */
922 for (i = 0; i < MAXFLOORS; ++i) {
923 fl = CtdlGetCachedFloor(i);
924 if (fl->f_flags & F_INUSE) {
925 /* if (floors > 0) IAPuts(" "); samjam says this confuses javamail */
927 len = snprintf(Namespace, sizeof(Namespace), "%s/", fl->f_name);
928 IPutStr(Namespace, len);
935 /* Wind it up with a newline and a completion message. */
937 IReply("OK NAMESPACE completed");
942 * Implements the CREATE command
945 void imap_create(int num_parms, ConstStr *Params) {
947 char roomname[ROOMNAMELEN];
952 char *notification_message = NULL;
955 IReply("NO A foder name must be specified");
959 if (strchr(Params[2].Key, '\\') != NULL) {
960 IReply("NO Invalid character in folder name");
961 syslog(LOG_ERR, "invalid character in folder name");
965 ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
967 IReply("NO Invalid mailbox name or location");
968 syslog(LOG_ERR, "invalid mailbox name or location");
971 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
972 flags = (ret & 0xff00); /* upper 8 bits = flags */
974 if (flags & IR_MAILBOX) {
975 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
976 IReply("NO Personal folders must be created under INBOX");
977 syslog(LOG_ERR, "not subordinate to inbox");
982 if (flags & IR_MAILBOX) {
983 newroomtype = 4; /* private mailbox */
984 newroomview = VIEW_MAILBOX;
987 newroomtype = 0; /* public folder */
988 newroomview = VIEW_BBS;
991 syslog(LOG_INFO, "Create new room <%s> on floor <%d> with type <%d>",
992 roomname, floornum, newroomtype);
994 ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
996 IReply("NO Mailbox already exists, or create failed");
999 IReply("OK CREATE completed");
1000 // post a message in Aide> describing the new room
1001 notification_message = malloc(1024);
1002 snprintf(notification_message, 1024,
1003 "A new room called \"%s\" has been created by %s%s%s%s\n",
1006 ((ret & QR_MAILBOX) ? " [personal]" : ""),
1007 ((ret & QR_PRIVATE) ? " [private]" : ""),
1008 ((ret & QR_GUESSNAME) ? " [hidden]" : "")
1010 CtdlAideMessage(notification_message, "Room Creation Message");
1011 free(notification_message);
1013 syslog(LOG_DEBUG, "imap_create() completed");
1018 * Locate a room by its IMAP folder name, and check access to it.
1019 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1021 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok) {
1023 char augmented_roomname[ROOMNAMELEN];
1024 char roomname[ROOMNAMELEN];
1026 struct ctdlroom QRscratch;
1030 ret = imap_roomname(roomname, sizeof roomname, foldername);
1035 /* First try a regular match */
1036 c = CtdlGetRoom(&QRscratch, roomname);
1038 /* Then try a mailbox name match */
1040 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, roomname);
1041 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1043 safestrncpy(roomname, augmented_roomname, sizeof(roomname));
1046 /* If the room exists, check security/access */
1048 /* See if there is an existing user/room relationship */
1049 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1051 /* normal clients have to pass through security */
1052 if (ra & UA_KNOWN) {
1055 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1060 /* Fail here if no such room */
1062 strcpy(returned_roomname, "");
1066 safestrncpy(returned_roomname, QRscratch.QRname, ROOMNAMELEN);
1073 * Implements the STATUS command (sort of)
1076 void imap_status(int num_parms, ConstStr *Params) {
1079 char roomname[ROOMNAMELEN];
1080 char imaproomname[SIZ];
1081 char savedroom[ROOMNAMELEN];
1084 ret = imap_grabroom(roomname, Params[2].Key, 1);
1086 IReply("NO Invalid mailbox name or location, or access denied");
1091 * CtdlUserGoto() formally takes us to the desired room, happily returning
1092 * the number of messages and number of new messages. (If another
1093 * folder is selected, save its name so we can return there!!!!!)
1095 if (IMAP->selected) {
1096 strcpy(savedroom, CC->room.QRname);
1098 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1101 * Tell the client what it wants to know. In fact, tell it *more* than
1102 * it wants to know. We happily IGnore the supplied status data item
1103 * names and simply spew all possible data items. It's far easier to
1104 * code and probably saves us some processing time too.
1106 len = imap_mailboxname(imaproomname, sizeof imaproomname, &CC->room);
1107 IAPuts("* STATUS ");
1108 IPutStr(imaproomname, len);
1109 IAPrintf(" (MESSAGES %d ", msgs);
1110 IAPrintf("RECENT %d ", new); /* Initially, new==recent */
1111 IAPrintf("UIDNEXT %ld ", CtdlGetConfigLong("MMhighest") + 1);
1112 IAPrintf("UNSEEN %d)\r\n", new);
1115 * If another folder is selected, go back to that room so we can resume
1116 * our happy day without violent explosions.
1118 if (IMAP->selected) {
1119 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1123 * Oooh, look, we're done!
1125 IReply("OK STATUS completed");
1130 * Implements the SUBSCRIBE command
1133 void imap_subscribe(int num_parms, ConstStr *Params) {
1135 char roomname[ROOMNAMELEN];
1136 char savedroom[ROOMNAMELEN];
1139 ret = imap_grabroom(roomname, Params[2].Key, 1);
1142 "NO Error %d: invalid mailbox name or location, or access denied",
1149 * CtdlUserGoto() formally takes us to the desired room, which has the side
1150 * effect of marking the room as not-zapped ... exactly the effect
1151 * we're looking for.
1153 if (IMAP->selected) {
1154 strcpy(savedroom, CC->room.QRname);
1156 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1159 * If another folder is selected, go back to that room so we can resume
1160 * our happy day without violent explosions.
1162 if (IMAP->selected) {
1163 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1166 IReply("OK SUBSCRIBE completed");
1171 * Implements the UNSUBSCRIBE command
1174 void imap_unsubscribe(int num_parms, ConstStr *Params) {
1176 char roomname[ROOMNAMELEN];
1177 char savedroom[ROOMNAMELEN];
1180 ret = imap_grabroom(roomname, Params[2].Key, 1);
1182 IReply("NO Invalid mailbox name or location, or access denied");
1187 * CtdlUserGoto() formally takes us to the desired room.
1189 if (IMAP->selected) {
1190 strcpy(savedroom, CC->room.QRname);
1192 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1195 * Now make the API call to zap the room
1197 if (CtdlForgetThisRoom() == 0) {
1198 IReply("OK UNSUBSCRIBE completed");
1201 IReply("NO You may not unsubscribe from this folder.");
1205 * If another folder is selected, go back to that room so we can resume
1206 * our happy day without violent explosions.
1208 if (IMAP->selected) {
1209 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1215 * Implements the DELETE command
1218 void imap_delete(int num_parms, ConstStr *Params) {
1220 char roomname[ROOMNAMELEN];
1221 char savedroom[ROOMNAMELEN];
1224 ret = imap_grabroom(roomname, Params[2].Key, 1);
1226 IReply("NO Invalid mailbox name, or access denied");
1231 * CtdlUserGoto() formally takes us to the desired room, happily returning
1232 * the number of messages and number of new messages. (If another
1233 * folder is selected, save its name so we can return there!!!!!)
1235 if (IMAP->selected) {
1236 strcpy(savedroom, CC->room.QRname);
1238 CtdlUserGoto(roomname, 0, 0, &msgs, &new, NULL, NULL);
1241 * Now delete the room.
1243 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1244 CtdlScheduleRoomForDeletion(&CC->room);
1245 IReply("OK DELETE completed");
1248 IReply("NO Can't delete this folder.");
1252 * If another folder is selected, go back to that room so we can resume
1253 * our happy day without violent explosions.
1255 if (IMAP->selected) {
1256 CtdlUserGoto(savedroom, 0, 0, &msgs, &new, NULL, NULL);
1262 * Back end function for imap_rename()
1264 void imap_rename_backend(struct ctdlroom *qrbuf, void *data) {
1265 char foldername[SIZ];
1266 char newfoldername[SIZ];
1267 char newroomname[ROOMNAMELEN];
1269 struct irl *irlp = NULL; /* scratch pointer */
1270 irlparms *myirlparms;
1272 myirlparms = (irlparms *) data;
1273 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1275 /* Rename subfolders */
1276 if ((!strncasecmp(foldername, myirlparms->oldname, myirlparms->oldnamelen) && (foldername[myirlparms->oldnamelen] == '/'))) {
1277 snprintf(newfoldername, sizeof newfoldername, "%s/%s", myirlparms->newname, &foldername[myirlparms->oldnamelen + 1]);
1278 newfloor = imap_roomname(newroomname, sizeof newroomname, newfoldername) & 0xFF;
1279 irlp = (struct irl *) malloc(sizeof(struct irl));
1280 strcpy(irlp->irl_newroom, newroomname);
1281 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1282 irlp->irl_newfloor = newfloor;
1283 irlp->next = *(myirlparms->irl);
1284 *(myirlparms->irl) = irlp;
1290 * Implements the RENAME command
1293 void imap_rename(int num_parms, ConstStr *Params) {
1294 char old_room[ROOMNAMELEN];
1295 char new_room[ROOMNAMELEN];
1299 struct irl *irl = NULL; /* the list */
1300 struct irl *irlp = NULL; /* scratch pointer */
1304 if (strchr(Params[3].Key, '\\') != NULL) {
1305 IReply("NO Invalid character in folder name");
1309 imap_roomname(old_room, sizeof old_room, Params[2].Key);
1310 newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1311 new_floor = (newr & 0xFF);
1313 r = CtdlRenameRoom(old_room, new_room, new_floor);
1315 if (r == crr_room_not_found) {
1316 IReply("NO Could not locate this folder");
1319 if (r == crr_already_exists) {
1320 IReplyPrintf("NO '%s' already exists.");
1323 if (r == crr_noneditable) {
1324 IReply("NO This folder is not editable.");
1327 if (r == crr_invalid_floor) {
1328 IReply("NO Folder root does not exist.");
1331 if (r == crr_access_denied) {
1332 IReply("NO You do not have permission to edit this folder.");
1336 IReplyPrintf("NO Rename failed - undefined error %d", r);
1340 /* If this is the INBOX, then RFC2060 says we have to just move the
1341 * contents. In a Citadel environment it's easier to rename the room
1342 * (already did that) and create a new inbox.
1344 if (!strcasecmp(Params[2].Key, "INBOX")) {
1345 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1348 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1350 irlparms.oldname = Params[2].Key;
1351 irlparms.oldnamelen = Params[2].len;
1352 irlparms.newname = Params[3].Key;
1353 irlparms.newnamelen = Params[3].len;
1354 irlparms.irl = &irl;
1355 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1357 /* ... and now rename them. */
1358 while (irl != NULL) {
1359 r = CtdlRenameRoom(irl->irl_oldroom, irl->irl_newroom, irl->irl_newfloor);
1361 /* FIXME handle error returns better */
1362 syslog(LOG_ERR, "CtdlRenameRoom() error %d", r);
1370 snprintf(aidemsg, sizeof aidemsg, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1375 CtdlAideMessage(aidemsg, "IMAP folder rename");
1377 IReply("OK RENAME completed");
1382 * Main command loop for IMAP sessions.
1384 void imap_command_loop(void) {
1385 struct timeval tv1, tv2;
1386 suseconds_t total_time = 0;
1388 const char *pchs, *pche;
1389 const imap_handler_hook *h;
1391 gettimeofday(&tv1, NULL);
1392 CC->lastcmd = time(NULL);
1396 if (Imap->Cmd.CmdBuf == NULL)
1397 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1399 FlushStrBuf(Imap->Cmd.CmdBuf);
1401 if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1402 syslog(LOG_ERR, "client disconnected: ending session.");
1403 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1407 if (Imap->authstate == imap_as_expecting_password) {
1408 syslog(LOG_INFO, "<password>");
1410 else if (Imap->authstate == imap_as_expecting_plainauth) {
1411 syslog(LOG_INFO, "<plain_auth>");
1413 else if ((Imap->authstate == imap_as_expecting_multilineusername) || cbmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1414 syslog(LOG_INFO, "LOGIN...");
1417 syslog(LOG_DEBUG, "%s", ChrPtr(Imap->Cmd.CmdBuf));
1420 pchs = ChrPtr(Imap->Cmd.CmdBuf);
1421 pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1423 while ((pche > pchs) && ((*pche == '\n') || (*pche == '\r'))) {
1425 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1427 StrBufTrim(Imap->Cmd.CmdBuf);
1429 /* If we're in the middle of a multi-line command, handle that */
1430 switch (Imap->authstate){
1431 case imap_as_expecting_username:
1432 imap_auth_login_user(imap_as_expecting_username);
1435 case imap_as_expecting_multilineusername:
1436 imap_auth_login_user(imap_as_expecting_multilineusername);
1439 case imap_as_expecting_plainauth:
1443 case imap_as_expecting_password:
1444 imap_auth_login_pass(imap_as_expecting_password);
1447 case imap_as_expecting_multilinepassword:
1448 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1455 /* Ok, at this point we're in normal command mode.
1456 * If the command just submitted does not contain a literal, we
1457 * might think about delivering some untagged stuff...
1460 /* Grab the tag, command, and parameters. */
1461 imap_parameterize(&Imap->Cmd);
1463 /* Now for the command set. */
1464 h = imap_lookup(Imap->Cmd.num_parms, Imap->Cmd.Params);
1467 IReply("BAD command unrecognized");
1471 /* RFC3501 says that we cannot output untagged data during these commands */
1472 if ((h->Flags & I_FLAG_UNTAGGED) == 0) {
1474 // we can put any additional untagged stuff right here in the future
1476 // Before processing the command that was just entered... if we happen
1477 // to have a folder selected, we'd like to rescan that folder for new
1478 // messages, and for deletions/changes of existing messages. This
1479 // could probably be optimized better with some deep thought...
1480 if (Imap->selected) {
1481 imap_rescan_msgids();
1485 /* does our command require a logged-in state */
1486 if ((!CC->logged_in) && ((h->Flags & I_FLAG_LOGGED_IN) != 0)) {
1487 IReply("BAD Not logged in.");
1491 /* does our command require the SELECT state on a mailbox */
1492 if ((Imap->selected == 0) && ((h->Flags & I_FLAG_SELECT) != 0)){
1493 IReply("BAD no folder selected");
1496 h->h(Imap->Cmd.num_parms, Imap->Cmd.Params);
1498 /* If the client transmitted a message we can free it now */
1503 imap_free_transmitted_message();
1505 gettimeofday(&tv2, NULL);
1506 total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1507 syslog(LOG_DEBUG, "IMAP command completed in %ld.%ld seconds",
1508 (total_time / 1000000),
1509 (total_time % 1000000)
1514 void imap_noop(int num_parms, ConstStr *Params) {
1515 IReply("OK No operation");
1519 void imap_logout(int num_parms, ConstStr *Params) {
1520 if (IMAP->selected) {
1521 imap_do_expunge(); /* yes, we auto-expunge at logout */
1523 IAPrintf("* BYE %s logging out\r\n", CtdlGetConfigStr("c_fqdn"));
1524 IReply("OK Citadel IMAP session ended.");
1525 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
1530 const char *CitadelServiceIMAP="IMAP";
1531 const char *CitadelServiceIMAPS="IMAPS";
1534 // Initialization function, called from modules_init.c
1535 char *ctdl_module_init_imap(void) {
1536 if (ImapCmds == NULL) {
1537 ImapCmds = NewHash(1, NULL);
1540 RegisterImapCMD("NOOP", "", imap_noop, I_FLAG_NONE);
1541 RegisterImapCMD("CHECK", "", imap_noop, I_FLAG_NONE);
1542 RegisterImapCMD("ID", "", imap_id, I_FLAG_NONE);
1543 RegisterImapCMD("LOGOUT", "", imap_logout, I_FLAG_NONE);
1544 RegisterImapCMD("LOGIN", "", imap_login, I_FLAG_NONE);
1545 RegisterImapCMD("AUTHENTICATE", "", imap_authenticate, I_FLAG_NONE);
1546 RegisterImapCMD("CAPABILITY", "", imap_capability, I_FLAG_NONE);
1548 RegisterImapCMD("STARTTLS", "", imap_starttls, I_FLAG_NONE);
1551 /* The commans below require a logged-in state */
1552 RegisterImapCMD("SELECT", "", imap_select, I_FLAG_LOGGED_IN);
1553 RegisterImapCMD("EXAMINE", "", imap_select, I_FLAG_LOGGED_IN);
1554 RegisterImapCMD("LSUB", "", imap_list, I_FLAG_LOGGED_IN);
1555 RegisterImapCMD("LIST", "", imap_list, I_FLAG_LOGGED_IN);
1556 RegisterImapCMD("CREATE", "", imap_create, I_FLAG_LOGGED_IN);
1557 RegisterImapCMD("DELETE", "", imap_delete, I_FLAG_LOGGED_IN);
1558 RegisterImapCMD("RENAME", "", imap_rename, I_FLAG_LOGGED_IN);
1559 RegisterImapCMD("STATUS", "", imap_status, I_FLAG_LOGGED_IN);
1560 RegisterImapCMD("SUBSCRIBE", "", imap_subscribe, I_FLAG_LOGGED_IN);
1561 RegisterImapCMD("UNSUBSCRIBE", "", imap_unsubscribe, I_FLAG_LOGGED_IN);
1562 RegisterImapCMD("APPEND", "", imap_append, I_FLAG_LOGGED_IN);
1563 RegisterImapCMD("NAMESPACE", "", imap_namespace, I_FLAG_LOGGED_IN);
1564 RegisterImapCMD("SETACL", "", imap_setacl, I_FLAG_LOGGED_IN);
1565 RegisterImapCMD("DELETEACL", "", imap_deleteacl, I_FLAG_LOGGED_IN);
1566 RegisterImapCMD("GETACL", "", imap_getacl, I_FLAG_LOGGED_IN);
1567 RegisterImapCMD("LISTRIGHTS", "", imap_listrights, I_FLAG_LOGGED_IN);
1568 RegisterImapCMD("MYRIGHTS", "", imap_myrights, I_FLAG_LOGGED_IN);
1569 RegisterImapCMD("GETMETADATA", "", imap_getmetadata, I_FLAG_LOGGED_IN);
1570 RegisterImapCMD("SETMETADATA", "", imap_setmetadata, I_FLAG_LOGGED_IN);
1572 /* The commands below require the SELECT state on a mailbox */
1573 RegisterImapCMD("FETCH", "", imap_fetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1574 RegisterImapCMD("UID", "FETCH", imap_uidfetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1575 RegisterImapCMD("SEARCH", "", imap_search, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1576 RegisterImapCMD("UID", "SEARCH", imap_uidsearch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1577 RegisterImapCMD("STORE", "", imap_store, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1578 RegisterImapCMD("UID", "STORE", imap_uidstore, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1579 RegisterImapCMD("COPY", "", imap_copy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1580 RegisterImapCMD("UID", "COPY", imap_uidcopy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1581 RegisterImapCMD("EXPUNGE", "", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1582 RegisterImapCMD("UID", "EXPUNGE", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1583 RegisterImapCMD("CLOSE", "", imap_close, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1586 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imap_port"), NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1588 CtdlRegisterServiceHook(CtdlGetConfigInt("c_imaps_port"), NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1590 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP, PRIO_STOP + 30);
1593 // return our module name for the log