4 * IMAP server for the Citadel system
5 * Copyright (C) 2000-2005 by Art Cancro and others.
6 * This code is released under the terms of the GNU General Public License.
8 * WARNING: the IMAP protocol is badly designed. No implementation of it
9 * is perfect. Indeed, with so much gratuitous complexity, *all* IMAP
10 * implementations have bugs.
21 #include <sys/types.h>
23 #if TIME_WITH_SYS_TIME
24 # include <sys/time.h>
28 # include <sys/time.h>
40 #include "sysdep_decls.h"
41 #include "citserver.h"
44 #include "serv_extensions.h"
51 #include "internet_addressing.h"
52 #include "serv_imap.h"
53 #include "imap_tools.h"
54 #include "imap_fetch.h"
55 #include "imap_search.h"
56 #include "imap_store.h"
57 #include "imap_misc.h"
60 #include "serv_crypto.h"
63 /* imap_rename() uses this struct containing list of rooms to rename */
66 char irl_oldroom[ROOMNAMELEN];
67 char irl_newroom[ROOMNAMELEN];
71 /* Data which is passed between imap_rename() and imap_rename_backend() */
80 * If there is a message ID map in memory, free it
82 void imap_free_msgids(void)
84 if (IMAP->msgids != NULL) {
89 if (IMAP->flags != NULL) {
97 * If there is a transmitted message in memory, free it
99 void imap_free_transmitted_message(void)
101 if (IMAP->transmitted_message != NULL) {
102 free(IMAP->transmitted_message);
103 IMAP->transmitted_message = NULL;
104 IMAP->transmitted_length = 0;
110 * Set the \\Seen flag for messages which aren't new
112 void imap_set_seen_flags(void)
117 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
118 if (IMAP->num_msgs > 0) {
119 for (i = 0; i < IMAP->num_msgs; ++i) {
120 if (is_msg_in_mset(vbuf.v_seen, IMAP->msgids[i])) {
121 IMAP->flags[i] |= IMAP_SEEN;
124 IMAP->flags[i] |= IMAP_RECENT;
127 (vbuf.v_answered, IMAP->msgids[i])) {
128 IMAP->flags[i] |= IMAP_ANSWERED;
138 * Back end for imap_load_msgids()
140 * Optimization: instead of calling realloc() to add each message, we
141 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
142 * allows the mapping to proceed much faster.
144 void imap_add_single_msgid(long msgnum, void *userdata)
147 IMAP->num_msgs = IMAP->num_msgs + 1;
148 if (IMAP->msgids == NULL) {
149 IMAP->msgids = malloc(IMAP->num_msgs * sizeof(long)
150 * REALLOC_INCREMENT);
151 } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
152 IMAP->msgids = realloc(IMAP->msgids,
154 REALLOC_INCREMENT) * sizeof(long));
156 if (IMAP->flags == NULL) {
157 IMAP->flags = malloc(IMAP->num_msgs * sizeof(long)
158 * REALLOC_INCREMENT);
159 } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
160 IMAP->flags = realloc(IMAP->flags,
162 REALLOC_INCREMENT) * sizeof(long));
164 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
165 IMAP->flags[IMAP->num_msgs - 1] = 0;
171 * Set up a message ID map for the current room (folder)
173 void imap_load_msgids(void)
176 if (IMAP->selected == 0) {
178 "imap_load_msgids() can't run; no room selected\n");
182 imap_free_msgids(); /* If there was already a map, free it */
184 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
185 imap_add_single_msgid, NULL);
187 imap_set_seen_flags();
188 /* lprintf(CTDL_DEBUG, "imap_load_msgids() mapped %d messages\n",
194 * Re-scan the selected room (folder) and see if it's been changed at all
196 void imap_rescan_msgids(void)
199 int original_num_msgs = 0;
200 long original_highest = 0L;
202 int message_still_exists;
203 struct cdbdata *cdbfr;
204 long *msglist = NULL;
209 if (IMAP->selected == 0) {
211 "imap_load_msgids() can't run; no room selected\n");
215 /* Load the *current* message list from disk, so we can compare it
216 * to what we have in memory.
218 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
220 msglist = malloc(cdbfr->len);
221 if (msglist == NULL) {
222 lprintf(CTDL_CRIT, "malloc() failed\n");
225 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
226 num_msgs = cdbfr->len / sizeof(long);
233 * Check to see if any of the messages we know about have been expunged
235 if (IMAP->num_msgs > 0)
236 for (i = 0; i < IMAP->num_msgs; ++i) {
238 message_still_exists = 0;
240 for (j = 0; j < num_msgs; ++j) {
241 if (msglist[j] == IMAP->msgids[i]) {
242 message_still_exists = 1;
246 if (message_still_exists == 0) {
247 cprintf("* %d EXPUNGE\r\n", i + 1);
249 /* Here's some nice stupid nonsense. When a message
250 * is expunged, we have to slide all the existing
251 * messages up in the message array.
254 memcpy(&IMAP->msgids[i],
255 &IMAP->msgids[i + 1],
257 (IMAP->num_msgs - i)));
258 memcpy(&IMAP->flags[i],
261 (IMAP->num_msgs - i)));
269 * Remember how many messages were here before we re-scanned.
271 original_num_msgs = IMAP->num_msgs;
272 if (IMAP->num_msgs > 0) {
273 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
275 original_highest = 0L;
279 * Now peruse the room for *new* messages only.
282 for (j = 0; j < num_msgs; ++j) {
283 if (msglist[j] > original_highest) {
284 imap_add_single_msgid(msglist[j], NULL);
287 imap_set_seen_flags();
290 * If new messages have arrived, tell the client about them.
292 if (IMAP->num_msgs > original_num_msgs) {
294 for (j = 0; j < num_msgs; ++j) {
295 if (IMAP->flags[j] & IMAP_RECENT) {
300 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
301 cprintf("* %d RECENT\r\n", num_recent);
315 * This cleanup function blows away the temporary memory and files used by
318 void imap_cleanup_function(void)
321 /* Don't do this stuff if this is not a IMAP session! */
322 if (CC->h_command_function != imap_command_loop)
325 /* If there is a mailbox selected, auto-expunge it. */
326 if (IMAP->selected) {
330 lprintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
332 imap_free_transmitted_message();
334 if (IMAP->cached_rfc822_data != NULL) {
335 free(IMAP->cached_rfc822_data);
336 IMAP->cached_rfc822_data = NULL;
337 IMAP->cached_rfc822_msgnum = (-1);
340 if (IMAP->cached_body != NULL) {
341 fclose(IMAP->cached_body);
342 IMAP->cached_body = NULL;
343 IMAP->cached_bodymsgnum = (-1);
346 lprintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
352 * Here's where our IMAP session begins its happy day.
354 void imap_greeting(void)
357 strcpy(CC->cs_clientname, "IMAP session");
358 CtdlAllocUserData(SYM_IMAP, sizeof(struct citimap));
359 IMAP->authstate = imap_as_normal;
360 IMAP->cached_rfc822_data = NULL;
361 IMAP->cached_rfc822_msgnum = (-1);
363 cprintf("* OK %s Citadel IMAP4rev1 server ready\r\n",
368 * IMAPS is just like IMAP, except it goes crypto right away.
371 void imaps_greeting(void) {
372 CtdlStartTLS(NULL, NULL, NULL);
379 * implements the LOGIN command (ordinary username/password login)
381 void imap_login(int num_parms, char *parms[])
383 if (num_parms != 4) {
384 cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
388 if (CtdlLoginExistingUser(parms[2]) == login_ok) {
389 if (CtdlTryPassword(parms[3]) == pass_ok) {
390 cprintf("%s OK login successful\r\n", parms[0]);
395 cprintf("%s BAD Login incorrect\r\n", parms[0]);
400 * Implements the AUTHENTICATE command
402 void imap_authenticate(int num_parms, char *parms[])
406 if (num_parms != 3) {
407 cprintf("%s BAD incorrect number of parameters\r\n",
413 cprintf("%s BAD Already logged in.\r\n", parms[0]);
417 if (!strcasecmp(parms[2], "LOGIN")) {
418 CtdlEncodeBase64(buf, "Username:", 9);
419 cprintf("+ %s\r\n", buf);
420 IMAP->authstate = imap_as_expecting_username;
421 strcpy(IMAP->authseq, parms[0]);
426 cprintf("%s NO AUTHENTICATE %s failed\r\n",
431 void imap_auth_login_user(char *cmd)
435 CtdlDecodeBase64(buf, cmd, SIZ);
436 CtdlLoginExistingUser(buf);
437 CtdlEncodeBase64(buf, "Password:", 9);
438 cprintf("+ %s\r\n", buf);
439 IMAP->authstate = imap_as_expecting_password;
443 void imap_auth_login_pass(char *cmd)
447 CtdlDecodeBase64(buf, cmd, SIZ);
448 if (CtdlTryPassword(buf) == pass_ok) {
449 cprintf("%s OK authentication succeeded\r\n",
452 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
454 IMAP->authstate = imap_as_normal;
460 * implements the CAPABILITY command
462 void imap_capability(int num_parms, char *parms[])
464 cprintf("* CAPABILITY IMAP4 IMAP4REV1 NAMESPACE AUTH=LOGIN");
467 cprintf(" STARTTLS");
471 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
477 * implements the STARTTLS command (Citadel API version)
480 void imap_starttls(int num_parms, char *parms[])
482 char ok_response[SIZ];
483 char nosup_response[SIZ];
484 char error_response[SIZ];
487 "%s OK begin TLS negotiation now\r\n",
489 sprintf(nosup_response,
490 "%s NO TLS not supported here\r\n",
492 sprintf(error_response,
493 "%s BAD Internal error\r\n",
495 CtdlStartTLS(ok_response, nosup_response, error_response);
501 * implements the SELECT command
503 void imap_select(int num_parms, char *parms[])
506 char augmented_roomname[ROOMNAMELEN];
510 struct ctdlroom QRscratch;
516 /* Convert the supplied folder name to a roomname */
517 i = imap_roomname(towhere, sizeof towhere, parms[2]);
519 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
523 floornum = (i & 0x00ff);
524 roomflags = (i & 0xff00);
526 /* First try a regular match */
527 c = getroom(&QRscratch, towhere);
529 /* Then try a mailbox name match */
531 MailboxName(augmented_roomname, sizeof augmented_roomname,
533 c = getroom(&QRscratch, augmented_roomname);
535 strcpy(towhere, augmented_roomname);
538 /* If the room exists, check security/access */
540 /* See if there is an existing user/room relationship */
541 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
543 /* normal clients have to pass through security */
549 /* Fail here if no such room */
551 cprintf("%s NO ... no such room, or access denied\r\n",
556 /* If we already had some other folder selected, auto-expunge it */
560 * usergoto() formally takes us to the desired room, happily returning
561 * the number of messages and number of new messages.
563 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
564 usergoto(NULL, 0, 0, &msgs, &new);
567 if (!strcasecmp(parms[1], "EXAMINE")) {
575 cprintf("* %d EXISTS\r\n", msgs);
576 cprintf("* %d RECENT\r\n", new);
578 /* Note that \Deleted is a valid flag, but not a permanent flag,
579 * because we don't maintain its state across sessions. Citadel
580 * automatically expunges mailboxes when they are de-selected.
582 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
583 cprintf("* OK [PERMANENTFLAGS (\\Seen \\Answered)] "
584 "permanent flags\r\n");
586 cprintf("* OK [UIDVALIDITY 0] UIDs valid\r\n");
587 cprintf("%s OK [%s] %s completed\r\n",
589 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
595 * does the real work for expunge
597 int imap_do_expunge(void)
600 int num_expunged = 0;
602 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
603 if (IMAP->selected == 0) {
607 if (IMAP->num_msgs > 0)
608 for (i = 0; i < IMAP->num_msgs; ++i) {
609 if (IMAP->flags[i] & IMAP_DELETED) {
610 CtdlDeleteMessages(CC->room.QRname,
611 IMAP->msgids[i], "");
616 if (num_expunged > 0) {
617 imap_rescan_msgids();
620 lprintf(CTDL_DEBUG, "Expunged %d messages.\n", num_expunged);
621 return (num_expunged);
626 * implements the EXPUNGE command syntax
628 void imap_expunge(int num_parms, char *parms[])
630 int num_expunged = 0;
632 num_expunged = imap_do_expunge();
633 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
638 * implements the CLOSE command
640 void imap_close(int num_parms, char *parms[])
643 /* Yes, we always expunge on close. */
644 if (IMAP->selected) {
651 cprintf("%s OK CLOSE completed\r\n", parms[0]);
656 * Implements the NAMESPACE command.
658 void imap_namespace(int num_parms, char *parms[])
665 cprintf("* NAMESPACE ");
667 /* All personal folders are subordinate to INBOX. */
668 cprintf("((\"INBOX/\" \"/\")) ");
670 /* Other users' folders ... coming soon! FIXME */
673 /* Show all floors as shared namespaces. Neato! */
675 for (i = 0; i < MAXFLOORS; ++i) {
677 if (fl->f_flags & F_INUSE) {
678 if (floors > 0) cprintf(" ");
680 sprintf(buf, "%s/", fl->f_name);
688 /* Wind it up with a newline and a completion message. */
690 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
696 * Used by LIST and LSUB to show the floors in the listing
698 void imap_list_floors(char *cmd, char *pattern)
703 for (i = 0; i < MAXFLOORS; ++i) {
705 if (fl->f_flags & F_INUSE) {
706 if (imap_mailbox_matches_pattern
707 (pattern, fl->f_name)) {
708 cprintf("* %s (\\NoSelect) \"/\" ", cmd);
709 imap_strout(fl->f_name);
719 * Back end for imap_lsub()
721 * IMAP "subscribed folder" is equivocated to Citadel "known rooms." This
722 * may or may not be the desired behavior in the future.
724 void imap_lsub_listroom(struct ctdlroom *qrbuf, void *data)
730 pattern = (char *) data;
732 /* Only list rooms to which the user has access!! */
733 CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
735 imap_mailboxname(buf, sizeof buf, qrbuf);
736 if (imap_mailbox_matches_pattern(pattern, buf)) {
737 cprintf("* LSUB () \"/\" ");
746 * Implements the LSUB command
748 void imap_lsub(int num_parms, char *parms[])
752 cprintf("%s BAD arguments invalid\r\n", parms[0]);
755 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
757 if (strlen(parms[3]) == 0) {
758 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
762 imap_list_floors("LSUB", pattern);
763 ForEachRoom(imap_lsub_listroom, pattern);
766 cprintf("%s OK LSUB completed\r\n", parms[0]);
772 * Back end for imap_list()
774 void imap_list_listroom(struct ctdlroom *qrbuf, void *data)
780 pattern = (char *) data;
782 /* Only list rooms to which the user has access!! */
783 CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
785 || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
786 imap_mailboxname(buf, sizeof buf, qrbuf);
787 if (imap_mailbox_matches_pattern(pattern, buf)) {
788 cprintf("* LIST () \"/\" ");
797 * Implements the LIST command
799 void imap_list(int num_parms, char *parms[])
803 cprintf("%s BAD arguments invalid\r\n", parms[0]);
806 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
808 if (strlen(parms[3]) == 0) {
809 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
813 imap_list_floors("LIST", pattern);
814 ForEachRoom(imap_list_listroom, pattern);
817 cprintf("%s OK LIST completed\r\n", parms[0]);
823 * Implements the CREATE command
826 void imap_create(int num_parms, char *parms[])
829 char roomname[ROOMNAMELEN];
835 if (strchr(parms[2], '\\') != NULL) {
836 cprintf("%s NO Invalid character in folder name\r\n",
838 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
842 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
844 cprintf("%s NO Invalid mailbox name or location\r\n",
846 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
849 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
850 flags = (ret & 0xff00); /* upper 8 bits = flags */
852 if (flags & IR_MAILBOX) {
853 if (strncasecmp(parms[2], "INBOX/", 6)) {
854 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
855 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
860 if (flags & IR_MAILBOX) {
861 newroomtype = 4; /* private mailbox */
862 newroomview = VIEW_MAILBOX;
864 newroomtype = 0; /* public folder */
865 newroomview = VIEW_BBS;
868 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
869 roomname, floornum, newroomtype);
871 ret = create_room(roomname, newroomtype, "", floornum, 1, 0, newroomview);
874 ("%s NO Mailbox already exists, or create failed\r\n",
877 cprintf("%s OK CREATE completed\r\n", parms[0]);
879 lprintf(CTDL_DEBUG, "imap_create() completed\n");
884 * Locate a room by its IMAP folder name, and check access to it.
885 * If zapped_ok is nonzero, we can also look for the room in the zapped list.
887 int imap_grabroom(char *returned_roomname, char *foldername, int zapped_ok)
890 char augmented_roomname[ROOMNAMELEN];
891 char roomname[ROOMNAMELEN];
893 struct ctdlroom QRscratch;
897 ret = imap_roomname(roomname, sizeof roomname, foldername);
902 /* First try a regular match */
903 c = getroom(&QRscratch, roomname);
905 /* Then try a mailbox name match */
907 MailboxName(augmented_roomname, sizeof augmented_roomname,
908 &CC->user, roomname);
909 c = getroom(&QRscratch, augmented_roomname);
911 strcpy(roomname, augmented_roomname);
914 /* If the room exists, check security/access */
916 /* See if there is an existing user/room relationship */
917 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
919 /* normal clients have to pass through security */
923 if ((zapped_ok) && (ra & UA_ZAPPED)) {
928 /* Fail here if no such room */
930 strcpy(returned_roomname, "");
933 strcpy(returned_roomname, QRscratch.QRname);
940 * Implements the STATUS command (sort of)
943 void imap_status(int num_parms, char *parms[])
946 char roomname[ROOMNAMELEN];
948 char savedroom[ROOMNAMELEN];
951 ret = imap_grabroom(roomname, parms[2], 0);
954 ("%s NO Invalid mailbox name or location, or access denied\r\n",
960 * usergoto() formally takes us to the desired room, happily returning
961 * the number of messages and number of new messages. (If another
962 * folder is selected, save its name so we can return there!!!!!)
964 if (IMAP->selected) {
965 strcpy(savedroom, CC->room.QRname);
967 usergoto(roomname, 0, 0, &msgs, &new);
970 * Tell the client what it wants to know. In fact, tell it *more* than
971 * it wants to know. We happily IGnore the supplied status data item
972 * names and simply spew all possible data items. It's far easier to
973 * code and probably saves us some processing time too.
975 imap_mailboxname(buf, sizeof buf, &CC->room);
976 cprintf("* STATUS ");
978 cprintf(" (MESSAGES %d ", msgs);
979 cprintf("RECENT %d ", new); /* Initially, new==recent */
980 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
981 cprintf("UNSEEN %d)\r\n", new);
984 * If another folder is selected, go back to that room so we can resume
985 * our happy day without violent explosions.
987 if (IMAP->selected) {
988 usergoto(savedroom, 0, 0, &msgs, &new);
992 * Oooh, look, we're done!
994 cprintf("%s OK STATUS completed\r\n", parms[0]);
1000 * Implements the SUBSCRIBE command
1003 void imap_subscribe(int num_parms, char *parms[])
1006 char roomname[ROOMNAMELEN];
1007 char savedroom[ROOMNAMELEN];
1010 ret = imap_grabroom(roomname, parms[2], 1);
1013 "%s NO Error %d: invalid mailbox name or location, or access denied\r\n",
1021 * usergoto() formally takes us to the desired room, which has the side
1022 * effect of marking the room as not-zapped ... exactly the effect
1023 * we're looking for.
1025 if (IMAP->selected) {
1026 strcpy(savedroom, CC->room.QRname);
1028 usergoto(roomname, 0, 0, &msgs, &new);
1031 * If another folder is selected, go back to that room so we can resume
1032 * our happy day without violent explosions.
1034 if (IMAP->selected) {
1035 usergoto(savedroom, 0, 0, &msgs, &new);
1038 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
1043 * Implements the UNSUBSCRIBE command
1046 void imap_unsubscribe(int num_parms, char *parms[])
1049 char roomname[ROOMNAMELEN];
1050 char savedroom[ROOMNAMELEN];
1053 ret = imap_grabroom(roomname, parms[2], 0);
1056 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1062 * usergoto() formally takes us to the desired room.
1064 if (IMAP->selected) {
1065 strcpy(savedroom, CC->room.QRname);
1067 usergoto(roomname, 0, 0, &msgs, &new);
1070 * Now make the API call to zap the room
1072 if (CtdlForgetThisRoom() == 0) {
1073 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1076 ("%s NO You may not unsubscribe from this folder.\r\n",
1081 * If another folder is selected, go back to that room so we can resume
1082 * our happy day without violent explosions.
1084 if (IMAP->selected) {
1085 usergoto(savedroom, 0, 0, &msgs, &new);
1092 * Implements the DELETE command
1095 void imap_delete(int num_parms, char *parms[])
1098 char roomname[ROOMNAMELEN];
1099 char savedroom[ROOMNAMELEN];
1102 ret = imap_grabroom(roomname, parms[2], 0);
1104 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1110 * usergoto() formally takes us to the desired room, happily returning
1111 * the number of messages and number of new messages. (If another
1112 * folder is selected, save its name so we can return there!!!!!)
1114 if (IMAP->selected) {
1115 strcpy(savedroom, CC->room.QRname);
1117 usergoto(roomname, 0, 0, &msgs, &new);
1120 * Now delete the room.
1122 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1123 cprintf("%s OK DELETE completed\r\n", parms[0]);
1124 delete_room(&CC->room);
1126 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1130 * If another folder is selected, go back to that room so we can resume
1131 * our happy day without violent explosions.
1133 if (IMAP->selected) {
1134 usergoto(savedroom, 0, 0, &msgs, &new);
1140 * Back end function for imap_rename()
1142 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1144 char foldername[SIZ];
1145 char newfoldername[SIZ];
1146 char newroomname[ROOMNAMELEN];
1148 struct irl *irlp = NULL; /* scratch pointer */
1149 struct irlparms *irlparms;
1151 irlparms = (struct irlparms *) data;
1152 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1154 /* Rename subfolders */
1155 if ((!strncasecmp(foldername, irlparms->oldname,
1156 strlen(irlparms->oldname))
1157 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1159 sprintf(newfoldername, "%s/%s",
1161 &foldername[strlen(irlparms->oldname) + 1]
1164 newfloor = imap_roomname(newroomname,
1166 newfoldername) & 0xFF;
1168 irlp = (struct irl *) malloc(sizeof(struct irl));
1169 strcpy(irlp->irl_newroom, newroomname);
1170 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1171 irlp->irl_newfloor = newfloor;
1172 irlp->next = *(irlparms->irl);
1173 *(irlparms->irl) = irlp;
1179 * Implements the RENAME command
1182 void imap_rename(int num_parms, char *parms[])
1184 char old_room[ROOMNAMELEN];
1185 char new_room[ROOMNAMELEN];
1189 struct irl *irl = NULL; /* the list */
1190 struct irl *irlp = NULL; /* scratch pointer */
1191 struct irlparms irlparms;
1193 if (strchr(parms[3], '\\') != NULL) {
1194 cprintf("%s NO Invalid character in folder name\r\n",
1199 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1200 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1201 new_floor = (newr & 0xFF);
1203 r = CtdlRenameRoom(old_room, new_room, new_floor);
1205 if (r == crr_room_not_found) {
1206 cprintf("%s NO Could not locate this folder\r\n",
1210 if (r == crr_already_exists) {
1211 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1214 if (r == crr_noneditable) {
1215 cprintf("%s This folder is not editable.\r\n", parms[0]);
1218 if (r == crr_invalid_floor) {
1219 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1222 if (r == crr_access_denied) {
1223 cprintf("%s You do not have permission to edit "
1224 "this folder.\r\n", parms[0]);
1228 cprintf("%s NO Rename failed - undefined error %d\r\n",
1234 /* If this is the INBOX, then RFC2060 says we have to just move the
1235 * contents. In a Citadel environment it's easier to rename the room
1236 * (already did that) and create a new inbox.
1238 if (!strcasecmp(parms[2], "INBOX")) {
1239 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1242 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1244 irlparms.oldname = parms[2];
1245 irlparms.newname = parms[3];
1246 irlparms.irl = &irl;
1247 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1249 /* ... and now rename them. */
1250 while (irl != NULL) {
1251 r = CtdlRenameRoom(irl->irl_oldroom,
1255 /* FIXME handle error returns better */
1256 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n",
1265 cprintf("%s OK RENAME completed\r\n", parms[0]);
1272 * Main command loop for IMAP sessions.
1274 void imap_command_loop(void)
1280 CC->lastcmd = time(NULL);
1281 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1283 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
1284 lprintf(CTDL_ERR, "IMAP socket is broken. Ending session.\r\n");
1289 lprintf(CTDL_INFO, "IMAP: %s\n", cmdbuf);
1290 while (strlen(cmdbuf) < 5)
1291 strcat(cmdbuf, " ");
1293 /* strip off l/t whitespace and CRLF */
1294 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1295 cmdbuf[strlen(cmdbuf) - 1] = 0;
1296 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1297 cmdbuf[strlen(cmdbuf) - 1] = 0;
1300 /* If we're in the middle of a multi-line command, handle that */
1301 if (IMAP->authstate == imap_as_expecting_username) {
1302 imap_auth_login_user(cmdbuf);
1305 if (IMAP->authstate == imap_as_expecting_password) {
1306 imap_auth_login_pass(cmdbuf);
1310 /* Ok, at this point we're in normal command mode. The first thing
1311 * we do is print any incoming pages (yeah! we really do!)
1313 imap_print_instant_messages();
1316 * Before processing the command that was just entered... if we happen
1317 * to have a folder selected, we'd like to rescan that folder for new
1318 * messages, and for deletions/changes of existing messages. This
1319 * could probably be optimized somehow, but IMAP sucks...
1321 if (IMAP->selected) {
1322 imap_rescan_msgids();
1325 /* Now for the command set. */
1327 /* Grab the tag, command, and parameters. Check syntax. */
1328 num_parms = imap_parameterize(parms, cmdbuf);
1329 if (num_parms < 2) {
1330 cprintf("BAD syntax error\r\n");
1333 /* The commands below may be executed in any state */
1335 else if ((!strcasecmp(parms[1], "NOOP"))
1336 || (!strcasecmp(parms[1], "CHECK"))) {
1337 cprintf("%s OK This command successfully did nothing.\r\n",
1341 else if (!strcasecmp(parms[1], "LOGOUT")) {
1342 if (IMAP->selected) {
1343 imap_do_expunge(); /* yes, we auto-expunge */
1345 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1346 cprintf("%s OK thank you for using Citadel IMAP\r\n",
1352 else if (!strcasecmp(parms[1], "LOGIN")) {
1353 imap_login(num_parms, parms);
1356 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1357 imap_authenticate(num_parms, parms);
1360 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1361 imap_capability(num_parms, parms);
1364 else if (!strcasecmp(parms[1], "STARTTLS")) {
1365 imap_starttls(num_parms, parms);
1368 else if (!CC->logged_in) {
1369 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1372 /* The commans below require a logged-in state */
1374 else if (!strcasecmp(parms[1], "SELECT")) {
1375 imap_select(num_parms, parms);
1378 else if (!strcasecmp(parms[1], "EXAMINE")) {
1379 imap_select(num_parms, parms);
1382 else if (!strcasecmp(parms[1], "LSUB")) {
1383 imap_lsub(num_parms, parms);
1386 else if (!strcasecmp(parms[1], "LIST")) {
1387 imap_list(num_parms, parms);
1390 else if (!strcasecmp(parms[1], "CREATE")) {
1391 imap_create(num_parms, parms);
1394 else if (!strcasecmp(parms[1], "DELETE")) {
1395 imap_delete(num_parms, parms);
1398 else if (!strcasecmp(parms[1], "RENAME")) {
1399 imap_rename(num_parms, parms);
1402 else if (!strcasecmp(parms[1], "STATUS")) {
1403 imap_status(num_parms, parms);
1406 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1407 imap_subscribe(num_parms, parms);
1410 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1411 imap_unsubscribe(num_parms, parms);
1414 else if (!strcasecmp(parms[1], "APPEND")) {
1415 imap_append(num_parms, parms);
1418 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1419 imap_namespace(num_parms, parms);
1422 else if (IMAP->selected == 0) {
1423 cprintf("%s BAD no folder selected\r\n", parms[0]);
1426 /* The commands below require the SELECT state on a mailbox */
1428 else if (!strcasecmp(parms[1], "FETCH")) {
1429 imap_fetch(num_parms, parms);
1432 else if ((!strcasecmp(parms[1], "UID"))
1433 && (!strcasecmp(parms[2], "FETCH"))) {
1434 imap_uidfetch(num_parms, parms);
1437 else if (!strcasecmp(parms[1], "SEARCH")) {
1438 imap_search(num_parms, parms);
1441 else if ((!strcasecmp(parms[1], "UID"))
1442 && (!strcasecmp(parms[2], "SEARCH"))) {
1443 imap_uidsearch(num_parms, parms);
1446 else if (!strcasecmp(parms[1], "STORE")) {
1447 imap_store(num_parms, parms);
1450 else if ((!strcasecmp(parms[1], "UID"))
1451 && (!strcasecmp(parms[2], "STORE"))) {
1452 imap_uidstore(num_parms, parms);
1455 else if (!strcasecmp(parms[1], "COPY")) {
1456 imap_copy(num_parms, parms);
1459 else if ((!strcasecmp(parms[1], "UID"))
1460 && (!strcasecmp(parms[2], "COPY"))) {
1461 imap_uidcopy(num_parms, parms);
1464 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1465 imap_expunge(num_parms, parms);
1468 else if (!strcasecmp(parms[1], "CLOSE")) {
1469 imap_close(num_parms, parms);
1472 /* End of commands. If we get here, the command is either invalid
1477 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1480 /* If the client transmitted a message we can free it now */
1481 imap_free_transmitted_message();
1487 * This function is called to register the IMAP extension with Citadel.
1489 char *serv_imap_init(void)
1491 CtdlRegisterServiceHook(config.c_imap_port,
1492 NULL, imap_greeting, imap_command_loop, NULL);
1494 CtdlRegisterServiceHook(config.c_imaps_port,
1495 NULL, imaps_greeting, imap_command_loop, NULL);
1497 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);