4 * IMAP server for the Citadel/UX system
5 * Copyright (C) 2000-2002 by Art Cancro and others.
6 * This code is released under the terms of the GNU General Public License.
8 * WARNING: Mark Crispin is an idiot. IMAP is the most brain-damaged protocol
9 * you will ever have the profound lack of pleasure to encounter.
20 #include <sys/types.h>
22 #if TIME_WITH_SYS_TIME
23 # include <sys/time.h>
27 # include <sys/time.h>
39 #include "sysdep_decls.h"
40 #include "citserver.h"
43 #include "serv_extensions.h"
50 #include "internet_addressing.h"
51 #include "serv_imap.h"
52 #include "imap_tools.h"
53 #include "imap_fetch.h"
54 #include "imap_search.h"
55 #include "imap_store.h"
56 #include "imap_misc.h"
59 #include "serv_crypto.h"
62 /* imap_rename() uses this struct containing list of rooms to rename */
65 char irl_oldroom[ROOMNAMELEN];
66 char irl_newroom[ROOMNAMELEN];
70 /* Data which is passed between imap_rename() and imap_rename_backend() */
79 * If there is a message ID map in memory, free it
81 void imap_free_msgids(void)
83 if (IMAP->msgids != NULL) {
88 if (IMAP->flags != NULL) {
96 * If there is a transmitted message in memory, free it
98 void imap_free_transmitted_message(void)
100 if (IMAP->transmitted_message != NULL) {
101 free(IMAP->transmitted_message);
102 IMAP->transmitted_message = NULL;
103 IMAP->transmitted_length = 0;
109 * Set the \\Seen flag for messages which aren't new
111 void imap_set_seen_flags(void)
116 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
117 if (IMAP->num_msgs > 0) {
118 for (i = 0; i < IMAP->num_msgs; ++i) {
119 if (is_msg_in_mset(vbuf.v_seen, IMAP->msgids[i])) {
120 IMAP->flags[i] |= IMAP_SEEN;
123 (vbuf.v_answered, IMAP->msgids[i])) {
124 IMAP->flags[i] |= IMAP_ANSWERED;
134 * Back end for imap_load_msgids()
136 * Optimization: instead of calling realloc() to add each message, we
137 * allocate space in the list for REALLOC_INCREMENT messages at a time. This
138 * allows the mapping to proceed much faster.
140 void imap_add_single_msgid(long msgnum, void *userdata)
143 IMAP->num_msgs = IMAP->num_msgs + 1;
144 if (IMAP->msgids == NULL) {
145 IMAP->msgids = malloc(IMAP->num_msgs * sizeof(long)
146 * REALLOC_INCREMENT);
147 } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
148 IMAP->msgids = realloc(IMAP->msgids,
150 REALLOC_INCREMENT) * sizeof(long));
152 if (IMAP->flags == NULL) {
153 IMAP->flags = malloc(IMAP->num_msgs * sizeof(long)
154 * REALLOC_INCREMENT);
155 } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
156 IMAP->flags = realloc(IMAP->flags,
158 REALLOC_INCREMENT) * sizeof(long));
160 IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
161 IMAP->flags[IMAP->num_msgs - 1] = 0;
167 * Set up a message ID map for the current room (folder)
169 void imap_load_msgids(void)
172 if (IMAP->selected == 0) {
174 "imap_load_msgids() can't run; no room selected\n");
178 imap_free_msgids(); /* If there was already a map, free it */
180 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
181 imap_add_single_msgid, NULL);
183 imap_set_seen_flags();
184 lprintf(CTDL_DEBUG, "imap_load_msgids() mapped %d messages\n",
190 * Re-scan the selected room (folder) and see if it's been changed at all
192 void imap_rescan_msgids(void)
195 int original_num_msgs = 0;
196 long original_highest = 0L;
198 int message_still_exists;
199 struct cdbdata *cdbfr;
200 long *msglist = NULL;
204 if (IMAP->selected == 0) {
206 "imap_load_msgids() can't run; no room selected\n");
210 /* Load the *current* message list from disk, so we can compare it
211 * to what we have in memory.
213 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
215 msglist = malloc(cdbfr->len);
216 memcpy(msglist, cdbfr->ptr, cdbfr->len);
217 num_msgs = cdbfr->len / sizeof(long);
224 * Check to see if any of the messages we know about have been expunged
226 if (IMAP->num_msgs > 0)
227 for (i = 0; i < IMAP->num_msgs; ++i) {
229 message_still_exists = 0;
231 for (j = 0; j < num_msgs; ++j) {
232 if (msglist[j] == IMAP->msgids[i]) {
233 message_still_exists = 1;
237 if (message_still_exists == 0) {
238 cprintf("* %d EXPUNGE\r\n", i + 1);
240 /* Here's some nice stupid nonsense. When a message
241 * is expunged, we have to slide all the existing
242 * messages up in the message array.
245 memcpy(&IMAP->msgids[i],
246 &IMAP->msgids[i + 1],
248 (IMAP->num_msgs - i)));
249 memcpy(&IMAP->flags[i],
252 (IMAP->num_msgs - i)));
260 * Remember how many messages were here before we re-scanned.
262 original_num_msgs = IMAP->num_msgs;
263 if (IMAP->num_msgs > 0) {
264 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
266 original_highest = 0L;
270 * Now peruse the room for *new* messages only.
273 for (j = 0; j < num_msgs; ++j) {
274 if (msglist[j] > original_highest) {
275 imap_add_single_msgid(msglist[j], NULL);
278 imap_set_seen_flags();
281 * If new messages have arrived, tell the client about them.
283 if (IMAP->num_msgs > original_num_msgs) {
284 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
298 * This cleanup function blows away the temporary memory and files used by
301 void imap_cleanup_function(void)
304 /* Don't do this stuff if this is not a IMAP session! */
305 if (CC->h_command_function != imap_command_loop)
308 lprintf(CTDL_DEBUG, "Performing IMAP cleanup hook\n");
310 imap_free_transmitted_message();
312 if (IMAP->cached_fetch != NULL) {
313 fclose(IMAP->cached_fetch);
314 IMAP->cached_fetch = NULL;
315 IMAP->cached_msgnum = (-1);
318 if (IMAP->cached_body != NULL) {
319 fclose(IMAP->cached_body);
320 IMAP->cached_body = NULL;
321 IMAP->cached_bodymsgnum = (-1);
324 lprintf(CTDL_DEBUG, "Finished IMAP cleanup hook\n");
330 * Here's where our IMAP session begins its happy day.
332 void imap_greeting(void)
335 strcpy(CC->cs_clientname, "IMAP session");
336 CtdlAllocUserData(SYM_IMAP, sizeof(struct citimap));
337 IMAP->authstate = imap_as_normal;
338 IMAP->cached_fetch = NULL;
339 IMAP->cached_msgnum = (-1);
341 cprintf("* OK %s Citadel/UX IMAP4rev1 server ready\r\n",
347 * implements the LOGIN command (ordinary username/password login)
349 void imap_login(int num_parms, char *parms[])
351 if (CtdlLoginExistingUser(parms[2]) == login_ok) {
352 if (CtdlTryPassword(parms[3]) == pass_ok) {
353 cprintf("%s OK login successful\r\n", parms[0]);
358 cprintf("%s BAD Login incorrect\r\n", parms[0]);
363 * Implements the AUTHENTICATE command
365 void imap_authenticate(int num_parms, char *parms[])
369 if (num_parms != 3) {
370 cprintf("%s BAD incorrect number of parameters\r\n",
376 cprintf("%s BAD Already logged in.\r\n", parms[0]);
380 if (!strcasecmp(parms[2], "LOGIN")) {
381 CtdlEncodeBase64(buf, "Username:", 9);
382 cprintf("+ %s\r\n", buf);
383 IMAP->authstate = imap_as_expecting_username;
384 strcpy(IMAP->authseq, parms[0]);
389 cprintf("%s NO AUTHENTICATE %s failed\r\n",
394 void imap_auth_login_user(char *cmd)
398 CtdlDecodeBase64(buf, cmd, SIZ);
399 CtdlLoginExistingUser(buf);
400 CtdlEncodeBase64(buf, "Password:", 9);
401 cprintf("+ %s\r\n", buf);
402 IMAP->authstate = imap_as_expecting_password;
406 void imap_auth_login_pass(char *cmd)
410 CtdlDecodeBase64(buf, cmd, SIZ);
411 if (CtdlTryPassword(buf) == pass_ok) {
412 cprintf("%s OK authentication succeeded\r\n",
415 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
417 IMAP->authstate = imap_as_normal;
423 * implements the CAPABILITY command
425 void imap_capability(int num_parms, char *parms[])
427 cprintf("* CAPABILITY IMAP4 IMAP4REV1 NAMESPACE AUTH=LOGIN");
430 cprintf(" STARTTLS");
434 cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
440 * implements the STARTTLS command (Citadel API version)
443 void imap_starttls(int num_parms, char *parms[])
445 char ok_response[SIZ];
446 char nosup_response[SIZ];
447 char error_response[SIZ];
450 "%s OK begin TLS negotiation now\r\n",
452 sprintf(nosup_response,
453 "%s NO TLS not supported here\r\n",
455 sprintf(error_response,
456 "%s BAD Internal error\r\n",
458 CtdlStartTLS(ok_response, nosup_response, error_response);
464 * implements the SELECT command
466 void imap_select(int num_parms, char *parms[])
469 char augmented_roomname[ROOMNAMELEN];
473 struct ctdlroom QRscratch;
479 /* Convert the supplied folder name to a roomname */
480 i = imap_roomname(towhere, sizeof towhere, parms[2]);
482 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
486 floornum = (i & 0x00ff);
487 roomflags = (i & 0xff00);
489 /* First try a regular match */
490 c = getroom(&QRscratch, towhere);
492 /* Then try a mailbox name match */
494 MailboxName(augmented_roomname, sizeof augmented_roomname,
496 c = getroom(&QRscratch, augmented_roomname);
498 strcpy(towhere, augmented_roomname);
501 /* If the room exists, check security/access */
503 /* See if there is an existing user/room relationship */
504 ra = CtdlRoomAccess(&QRscratch, &CC->user);
506 /* normal clients have to pass through security */
512 /* Fail here if no such room */
514 cprintf("%s NO ... no such room, or access denied\r\n",
516 /* IMAP->selected = 0; */
520 /* If we already had some other folder selected, auto-expunge it */
524 * usergoto() formally takes us to the desired room, happily returning
525 * the number of messages and number of new messages.
527 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
528 usergoto(NULL, 0, 0, &msgs, &new);
531 if (!strcasecmp(parms[1], "EXAMINE")) {
539 cprintf("* %d EXISTS\r\n", msgs);
540 cprintf("* %d RECENT\r\n", new);
542 /* Note that \Deleted is a valid flag, but not a permanent flag,
543 * because we don't maintain its state across sessions. Citadel
544 * automatically expunges mailboxes when they are de-selected.
546 cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
547 cprintf("* OK [PERMANENTFLAGS (\\Seen \\Answered)] "
548 "permanent flags\r\n");
550 cprintf("* OK [UIDVALIDITY 0] UIDs valid\r\n");
551 cprintf("%s OK [%s] %s completed\r\n",
553 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
559 * does the real work for expunge
561 int imap_do_expunge(void)
564 int num_expunged = 0;
566 lprintf(CTDL_DEBUG, "imap_do_expunge() called\n");
567 if (IMAP->selected == 0)
570 if (IMAP->num_msgs > 0)
571 for (i = 0; i < IMAP->num_msgs; ++i) {
572 if (IMAP->flags[i] & IMAP_DELETED) {
573 CtdlDeleteMessages(CC->room.QRname,
574 IMAP->msgids[i], "");
576 lprintf(CTDL_DEBUG, "%ld ... deleted\n",
579 lprintf(CTDL_DEBUG, "%ld ... not deleted\n",
584 if (num_expunged > 0) {
585 imap_rescan_msgids();
588 return (num_expunged);
593 * implements the EXPUNGE command syntax
595 void imap_expunge(int num_parms, char *parms[])
597 int num_expunged = 0;
599 num_expunged = imap_do_expunge();
600 cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
605 * implements the CLOSE command
607 void imap_close(int num_parms, char *parms[])
610 /* Yes, we always expunge on close. */
616 cprintf("%s OK CLOSE completed\r\n", parms[0]);
621 * Implements the NAMESPACE command.
623 void imap_namespace(int num_parms, char *parms[])
630 cprintf("* NAMESPACE ");
632 /* All personal folders are subordinate to INBOX. */
633 cprintf("((\"INBOX/\" \"/\")) ");
635 /* Other users' folders ... coming soon! FIXME */
638 /* Show all floors as shared namespaces. Neato! */
640 for (i = 0; i < MAXFLOORS; ++i) {
642 if (fl->f_flags & F_INUSE) {
643 if (floors > 0) cprintf(" ");
645 sprintf(buf, "%s/", fl->f_name);
653 /* Wind it up with a newline and a completion message. */
655 cprintf("%s OK NAMESPACE completed\r\n", parms[0]);
661 * Used by LIST and LSUB to show the floors in the listing
663 void imap_list_floors(char *cmd, char *pattern)
668 for (i = 0; i < MAXFLOORS; ++i) {
670 if (fl->f_flags & F_INUSE) {
671 if (imap_mailbox_matches_pattern
672 (pattern, fl->f_name)) {
673 cprintf("* %s (\\NoSelect) \"/\" ", cmd);
674 imap_strout(fl->f_name);
684 * Back end for imap_lsub()
686 * IMAP "subscribed folder" is equivocated to Citadel "known rooms." This
687 * may or may not be the desired behavior in the future.
689 void imap_lsub_listroom(struct ctdlroom *qrbuf, void *data)
695 pattern = (char *) data;
697 /* Only list rooms to which the user has access!! */
698 ra = CtdlRoomAccess(qrbuf, &CC->user);
700 imap_mailboxname(buf, sizeof buf, qrbuf);
701 if (imap_mailbox_matches_pattern(pattern, buf)) {
702 cprintf("* LSUB () \"/\" ");
711 * Implements the LSUB command
713 void imap_lsub(int num_parms, char *parms[])
717 cprintf("%s BAD arguments invalid\r\n", parms[0]);
720 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
722 if (strlen(parms[3]) == 0) {
723 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
727 imap_list_floors("LSUB", pattern);
728 ForEachRoom(imap_lsub_listroom, pattern);
731 cprintf("%s OK LSUB completed\r\n", parms[0]);
737 * Back end for imap_list()
739 void imap_list_listroom(struct ctdlroom *qrbuf, void *data)
745 pattern = (char *) data;
747 /* Only list rooms to which the user has access!! */
748 ra = CtdlRoomAccess(qrbuf, &CC->user);
750 || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
751 imap_mailboxname(buf, sizeof buf, qrbuf);
752 if (imap_mailbox_matches_pattern(pattern, buf)) {
753 cprintf("* LIST () \"/\" ");
762 * Implements the LIST command
764 void imap_list(int num_parms, char *parms[])
768 cprintf("%s BAD arguments invalid\r\n", parms[0]);
771 snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
773 if (strlen(parms[3]) == 0) {
774 cprintf("* LIST (\\Noselect) \"/\" \"\"\r\n");
778 imap_list_floors("LIST", pattern);
779 ForEachRoom(imap_list_listroom, pattern);
782 cprintf("%s OK LIST completed\r\n", parms[0]);
788 * Implements the CREATE command
791 void imap_create(int num_parms, char *parms[])
794 char roomname[ROOMNAMELEN];
799 if (strchr(parms[2], '\\') != NULL) {
800 cprintf("%s NO Invalid character in folder name\r\n",
802 lprintf(CTDL_DEBUG, "invalid character in folder name\n");
806 ret = imap_roomname(roomname, sizeof roomname, parms[2]);
808 cprintf("%s NO Invalid mailbox name or location\r\n",
810 lprintf(CTDL_DEBUG, "invalid mailbox name or location\n");
813 floornum = (ret & 0x00ff); /* lower 8 bits = floor number */
814 flags = (ret & 0xff00); /* upper 8 bits = flags */
816 if (flags & IR_MAILBOX) {
817 if (strncasecmp(parms[2], "INBOX/", 6)) {
818 cprintf("%s NO Personal folders must be created under INBOX\r\n", parms[0]);
819 lprintf(CTDL_DEBUG, "not subordinate to inbox\n");
824 if (flags & IR_MAILBOX) {
825 newroomtype = 4; /* private mailbox */
827 newroomtype = 0; /* public folder */
830 lprintf(CTDL_INFO, "Create new room <%s> on floor <%d> with type <%d>\n",
831 roomname, floornum, newroomtype);
833 ret = create_room(roomname, newroomtype, "", floornum, 1, 0);
836 ("%s NO Mailbox already exists, or create failed\r\n",
839 cprintf("%s OK CREATE completed\r\n", parms[0]);
841 lprintf(CTDL_DEBUG, "imap_create() completed\n");
846 * Locate a room by its IMAP folder name, and check access to it
848 int imap_grabroom(char *returned_roomname, char *foldername)
851 char augmented_roomname[ROOMNAMELEN];
852 char roomname[ROOMNAMELEN];
854 struct ctdlroom QRscratch;
858 ret = imap_roomname(roomname, sizeof roomname, foldername);
863 /* First try a regular match */
864 c = getroom(&QRscratch, roomname);
866 /* Then try a mailbox name match */
868 MailboxName(augmented_roomname, sizeof augmented_roomname,
869 &CC->user, roomname);
870 c = getroom(&QRscratch, augmented_roomname);
872 strcpy(roomname, augmented_roomname);
875 /* If the room exists, check security/access */
877 /* See if there is an existing user/room relationship */
878 ra = CtdlRoomAccess(&QRscratch, &CC->user);
880 /* normal clients have to pass through security */
886 /* Fail here if no such room */
888 strcpy(returned_roomname, "");
891 strcpy(returned_roomname, QRscratch.QRname);
898 * Implements the STATUS command (sort of)
901 void imap_status(int num_parms, char *parms[])
904 char roomname[ROOMNAMELEN];
906 char savedroom[ROOMNAMELEN];
909 ret = imap_grabroom(roomname, parms[2]);
912 ("%s NO Invalid mailbox name or location, or access denied\r\n",
918 * usergoto() formally takes us to the desired room, happily returning
919 * the number of messages and number of new messages. (If another
920 * folder is selected, save its name so we can return there!!!!!)
922 if (IMAP->selected) {
923 strcpy(savedroom, CC->room.QRname);
925 usergoto(roomname, 0, 0, &msgs, &new);
928 * Tell the client what it wants to know. In fact, tell it *more* than
929 * it wants to know. We happily IGnore the supplied status data item
930 * names and simply spew all possible data items. It's far easier to
931 * code and probably saves us some processing time too.
933 imap_mailboxname(buf, sizeof buf, &CC->room);
934 cprintf("* STATUS ");
936 cprintf(" (MESSAGES %d ", msgs);
937 cprintf("RECENT 0 "); /* FIXME we need to implement this */
938 cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
939 cprintf("UNSEEN %d)\r\n", new);
942 * If another folder is selected, go back to that room so we can resume
943 * our happy day without violent explosions.
945 if (IMAP->selected) {
946 usergoto(savedroom, 0, 0, &msgs, &new);
950 * Oooh, look, we're done!
952 cprintf("%s OK STATUS completed\r\n", parms[0]);
958 * Implements the SUBSCRIBE command
961 void imap_subscribe(int num_parms, char *parms[])
964 char roomname[ROOMNAMELEN];
965 char savedroom[ROOMNAMELEN];
968 ret = imap_grabroom(roomname, parms[2]);
971 ("%s NO Invalid mailbox name or location, or access denied\r\n",
977 * usergoto() formally takes us to the desired room, which has the side
978 * effect of marking the room as not-zapped ... exactly the effect
981 if (IMAP->selected) {
982 strcpy(savedroom, CC->room.QRname);
984 usergoto(roomname, 0, 0, &msgs, &new);
987 * If another folder is selected, go back to that room so we can resume
988 * our happy day without violent explosions.
990 if (IMAP->selected) {
991 usergoto(savedroom, 0, 0, &msgs, &new);
994 cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
999 * Implements the UNSUBSCRIBE command
1002 void imap_unsubscribe(int num_parms, char *parms[])
1005 char roomname[ROOMNAMELEN];
1006 char savedroom[ROOMNAMELEN];
1009 ret = imap_grabroom(roomname, parms[2]);
1012 ("%s NO Invalid mailbox name or location, or access denied\r\n",
1018 * usergoto() formally takes us to the desired room.
1020 if (IMAP->selected) {
1021 strcpy(savedroom, CC->room.QRname);
1023 usergoto(roomname, 0, 0, &msgs, &new);
1026 * Now make the API call to zap the room
1028 if (CtdlForgetThisRoom() == 0) {
1029 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
1032 ("%s NO You may not unsubscribe from this folder.\r\n",
1037 * If another folder is selected, go back to that room so we can resume
1038 * our happy day without violent explosions.
1040 if (IMAP->selected) {
1041 usergoto(savedroom, 0, 0, &msgs, &new);
1048 * Implements the DELETE command
1051 void imap_delete(int num_parms, char *parms[])
1054 char roomname[ROOMNAMELEN];
1055 char savedroom[ROOMNAMELEN];
1058 ret = imap_grabroom(roomname, parms[2]);
1060 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
1066 * usergoto() formally takes us to the desired room, happily returning
1067 * the number of messages and number of new messages. (If another
1068 * folder is selected, save its name so we can return there!!!!!)
1070 if (IMAP->selected) {
1071 strcpy(savedroom, CC->room.QRname);
1073 usergoto(roomname, 0, 0, &msgs, &new);
1076 * Now delete the room.
1078 if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1079 cprintf("%s OK DELETE completed\r\n", parms[0]);
1080 delete_room(&CC->room);
1082 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1086 * If another folder is selected, go back to that room so we can resume
1087 * our happy day without violent explosions.
1089 if (IMAP->selected) {
1090 usergoto(savedroom, 0, 0, &msgs, &new);
1096 * Back end function for imap_rename()
1098 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1100 char foldername[SIZ];
1101 char newfoldername[SIZ];
1102 char newroomname[ROOMNAMELEN];
1104 struct irl *irlp = NULL; /* scratch pointer */
1105 struct irlparms *irlparms;
1107 irlparms = (struct irlparms *) data;
1108 imap_mailboxname(foldername, sizeof foldername, qrbuf);
1110 /* Rename subfolders */
1111 if ((!strncasecmp(foldername, irlparms->oldname,
1112 strlen(irlparms->oldname))
1113 && (foldername[strlen(irlparms->oldname)] == '/'))) {
1115 sprintf(newfoldername, "%s/%s",
1117 &foldername[strlen(irlparms->oldname) + 1]
1120 newfloor = imap_roomname(newroomname,
1122 newfoldername) & 0xFF;
1124 irlp = (struct irl *) malloc(sizeof(struct irl));
1125 strcpy(irlp->irl_newroom, newroomname);
1126 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1127 irlp->irl_newfloor = newfloor;
1128 irlp->next = *(irlparms->irl);
1129 *(irlparms->irl) = irlp;
1135 * Implements the RENAME command
1138 void imap_rename(int num_parms, char *parms[])
1140 char old_room[ROOMNAMELEN];
1141 char new_room[ROOMNAMELEN];
1145 struct irl *irl = NULL; /* the list */
1146 struct irl *irlp = NULL; /* scratch pointer */
1147 struct irlparms irlparms;
1149 if (strchr(parms[3], '\\') != NULL) {
1150 cprintf("%s NO Invalid character in folder name\r\n",
1155 oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1156 newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1157 new_floor = (newr & 0xFF);
1159 r = CtdlRenameRoom(old_room, new_room, new_floor);
1161 if (r == crr_room_not_found) {
1162 cprintf("%s NO Could not locate this folder\r\n",
1166 if (r == crr_already_exists) {
1167 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1170 if (r == crr_noneditable) {
1171 cprintf("%s This folder is not editable.\r\n", parms[0]);
1174 if (r == crr_invalid_floor) {
1175 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1178 if (r == crr_access_denied) {
1179 cprintf("%s You do not have permission to edit "
1180 "this folder.\r\n", parms[0]);
1184 cprintf("%s NO Rename failed - undefined error %d\r\n",
1190 /* If this is the INBOX, then RFC2060 says we have to just move the
1191 * contents. In a Citadel environment it's easier to rename the room
1192 * (already did that) and create a new inbox.
1194 if (!strcasecmp(parms[2], "INBOX")) {
1195 create_room(MAILROOM, 4, "", 0, 1, 0);
1198 /* Otherwise, do the subfolders. Build a list of rooms to rename... */
1200 irlparms.oldname = parms[2];
1201 irlparms.newname = parms[3];
1202 irlparms.irl = &irl;
1203 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1205 /* ... and now rename them. */
1206 while (irl != NULL) {
1207 r = CtdlRenameRoom(irl->irl_oldroom,
1211 /* FIXME handle error returns better */
1212 lprintf(CTDL_ERR, "CtdlRenameRoom() error %d\n",
1221 cprintf("%s OK RENAME completed\r\n", parms[0]);
1228 * Main command loop for IMAP sessions.
1230 void imap_command_loop(void)
1237 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1238 if (client_gets(cmdbuf) < 1) {
1239 lprintf(CTDL_ERR, "IMAP socket is broken. Ending session.\r\n");
1244 lprintf(CTDL_INFO, "IMAP: %s\r\n", cmdbuf);
1245 while (strlen(cmdbuf) < 5)
1246 strcat(cmdbuf, " ");
1249 /* strip off l/t whitespace and CRLF */
1250 if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1251 cmdbuf[strlen(cmdbuf) - 1] = 0;
1252 if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1253 cmdbuf[strlen(cmdbuf) - 1] = 0;
1256 /* If we're in the middle of a multi-line command, handle that */
1257 if (IMAP->authstate == imap_as_expecting_username) {
1258 imap_auth_login_user(cmdbuf);
1261 if (IMAP->authstate == imap_as_expecting_password) {
1262 imap_auth_login_pass(cmdbuf);
1267 /* Ok, at this point we're in normal command mode. The first thing
1268 * we do is print any incoming pages (yeah! we really do!)
1270 imap_print_express_messages();
1273 * Before processing the command that was just entered... if we happen
1274 * to have a folder selected, we'd like to rescan that folder for new
1275 * messages, and for deletions/changes of existing messages. This
1276 * could probably be optimized somehow, but IMAP sucks...
1278 if (IMAP->selected) {
1279 imap_rescan_msgids();
1282 /* Now for the command set. */
1284 /* Grab the tag, command, and parameters. Check syntax. */
1285 num_parms = imap_parameterize(parms, cmdbuf);
1286 if (num_parms < 2) {
1287 cprintf("BAD syntax error\r\n");
1290 /* The commands below may be executed in any state */
1292 else if ((!strcasecmp(parms[1], "NOOP"))
1293 || (!strcasecmp(parms[1], "CHECK"))) {
1294 cprintf("%s OK This command successfully did nothing.\r\n",
1298 else if (!strcasecmp(parms[1], "LOGOUT")) {
1299 imap_do_expunge(); /* yes, we auto-expunge */
1300 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1301 cprintf("%s OK thank you for using Citadel IMAP\r\n",
1307 else if (!strcasecmp(parms[1], "LOGIN")) {
1308 imap_login(num_parms, parms);
1311 else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1312 imap_authenticate(num_parms, parms);
1315 else if (!strcasecmp(parms[1], "CAPABILITY")) {
1316 imap_capability(num_parms, parms);
1319 else if (!strcasecmp(parms[1], "STARTTLS")) {
1320 imap_starttls(num_parms, parms);
1323 else if (!CC->logged_in) {
1324 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1327 /* The commans below require a logged-in state */
1329 else if (!strcasecmp(parms[1], "SELECT")) {
1330 imap_select(num_parms, parms);
1333 else if (!strcasecmp(parms[1], "EXAMINE")) {
1334 imap_select(num_parms, parms);
1337 else if (!strcasecmp(parms[1], "LSUB")) {
1338 imap_lsub(num_parms, parms);
1341 else if (!strcasecmp(parms[1], "LIST")) {
1342 imap_list(num_parms, parms);
1345 else if (!strcasecmp(parms[1], "CREATE")) {
1346 imap_create(num_parms, parms);
1349 else if (!strcasecmp(parms[1], "DELETE")) {
1350 imap_delete(num_parms, parms);
1353 else if (!strcasecmp(parms[1], "RENAME")) {
1354 imap_rename(num_parms, parms);
1357 else if (!strcasecmp(parms[1], "STATUS")) {
1358 imap_status(num_parms, parms);
1361 else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1362 imap_subscribe(num_parms, parms);
1365 else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1366 imap_unsubscribe(num_parms, parms);
1369 else if (!strcasecmp(parms[1], "APPEND")) {
1370 imap_append(num_parms, parms);
1373 else if (!strcasecmp(parms[1], "NAMESPACE")) {
1374 imap_namespace(num_parms, parms);
1377 else if (IMAP->selected == 0) {
1378 cprintf("%s BAD no folder selected\r\n", parms[0]);
1381 /* The commands below require the SELECT state on a mailbox */
1383 else if (!strcasecmp(parms[1], "FETCH")) {
1384 imap_fetch(num_parms, parms);
1387 else if ((!strcasecmp(parms[1], "UID"))
1388 && (!strcasecmp(parms[2], "FETCH"))) {
1389 imap_uidfetch(num_parms, parms);
1392 else if (!strcasecmp(parms[1], "SEARCH")) {
1393 imap_search(num_parms, parms);
1396 else if ((!strcasecmp(parms[1], "UID"))
1397 && (!strcasecmp(parms[2], "SEARCH"))) {
1398 imap_uidsearch(num_parms, parms);
1401 else if (!strcasecmp(parms[1], "STORE")) {
1402 imap_store(num_parms, parms);
1405 else if ((!strcasecmp(parms[1], "UID"))
1406 && (!strcasecmp(parms[2], "STORE"))) {
1407 imap_uidstore(num_parms, parms);
1410 else if (!strcasecmp(parms[1], "COPY")) {
1411 imap_copy(num_parms, parms);
1414 else if ((!strcasecmp(parms[1], "UID"))
1415 && (!strcasecmp(parms[2], "COPY"))) {
1416 imap_uidcopy(num_parms, parms);
1419 else if (!strcasecmp(parms[1], "EXPUNGE")) {
1420 imap_expunge(num_parms, parms);
1423 else if (!strcasecmp(parms[1], "CLOSE")) {
1424 imap_close(num_parms, parms);
1427 /* End of commands. If we get here, the command is either invalid
1432 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1435 /* If the client transmitted a message we can free it now */
1436 imap_free_transmitted_message();
1442 * This function is called to register the IMAP extension with Citadel.
1444 char *serv_imap_init(void)
1446 CtdlRegisterServiceHook(config.c_imap_port,
1447 NULL, imap_greeting, imap_command_loop);
1448 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);