-/* $Id$
+/*
+ * $Id$
*
* IMAP server for the Citadel/UX system
* Copyright (C) 2000 by Art Cancro and others.
* This code is released under the terms of the GNU General Public License.
*
- * Current status of standards conformance:
- *
- * *** ABSOLUTELY NOTHING WORKS ***
+ * *** THIS IS UNDER DEVELOPMENT. IT DOES NOT WORK. DO NOT USE IT. ***
*
*/
#include <sys/types.h>
#include <sys/time.h>
#include <sys/wait.h>
+#include <ctype.h>
#include <string.h>
#include <limits.h>
#include "citadel.h"
#include "tools.h"
#include "internet_addressing.h"
#include "serv_imap.h"
+#include "imap_tools.h"
+#include "imap_fetch.h"
+#include "imap_search.h"
long SYM_IMAP;
+/*
+ * If there is a message ID map in memory, free it
+ */
+void imap_free_msgids(void) {
+ if (IMAP->msgids != NULL) {
+ phree(IMAP->msgids);
+ IMAP->msgids = NULL;
+ IMAP->num_msgs = 0;
+ }
+ if (IMAP->flags != NULL) {
+ phree(IMAP->flags);
+ IMAP->flags = NULL;
+ }
+}
+
+
+/*
+ * Back end for imap_load_msgids()
+ *
+ * FIXME: this should be optimized by figuring out a way to allocate memory
+ * once rather than doing a reallok() for each message.
+ */
+void imap_add_single_msgid(long msgnum, void *userdata) {
+
+ IMAP->num_msgs = IMAP->num_msgs + 1;
+ if (IMAP->msgids == NULL) {
+ IMAP->msgids = mallok(IMAP->num_msgs * sizeof(long));
+ }
+ else {
+ IMAP->msgids = reallok(IMAP->msgids,
+ IMAP->num_msgs * sizeof(long));
+ }
+ if (IMAP->flags == NULL) {
+ IMAP->flags = mallok(IMAP->num_msgs * sizeof(long));
+ }
+ else {
+ IMAP->flags = reallok(IMAP->flags,
+ IMAP->num_msgs * sizeof(long));
+ }
+ IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
+ IMAP->flags[IMAP->num_msgs - 1] = 0;
+}
+
+
+
+/*
+ * Set up a message ID map for the current room (folder)
+ */
+void imap_load_msgids(void) {
+
+ if (IMAP->selected == 0) {
+ lprintf(5, "imap_load_msgids() can't run; no room selected\n");
+ return;
+ }
+
+ imap_free_msgids(); /* If there was already a map, free it */
+
+ CtdlForEachMessage(MSGS_ALL, 0L, (-63), NULL, NULL,
+ imap_add_single_msgid, NULL);
+
+ lprintf(9, "imap_load_msgids() mapped %d messages\n", IMAP->num_msgs);
+}
+
+
+
+
/*
* This cleanup function blows away the temporary memory and files used by
* the IMAP server.
if (CC->h_command_function != imap_command_loop) return;
lprintf(9, "Performing IMAP cleanup hook\n");
-
-
+ imap_free_msgids();
lprintf(9, "Finished IMAP cleanup hook\n");
}
void imap_greeting(void) {
strcpy(CC->cs_clientname, "IMAP session");
- CC->internal_pgm = 1;
CtdlAllocUserData(SYM_IMAP, sizeof(struct citimap));
+ IMAP->authstate = imap_as_normal;
cprintf("* OK %s Citadel/UX IMAP4rev1 server ready\r\n",
config.c_fqdn);
}
+/*
+ * implements the LOGIN command (ordinary username/password login)
+ */
+void imap_login(int num_parms, char *parms[]) {
+ if (CtdlLoginExistingUser(parms[2]) == login_ok) {
+ if (CtdlTryPassword(parms[3]) == pass_ok) {
+ cprintf("%s OK login successful\r\n", parms[0]);
+ return;
+ }
+ }
+
+ cprintf("%s BAD Login incorrect\r\n", parms[0]);
+}
+
+
+/*
+ * Implements the AYTHENTICATE command
+ */
+void imap_authenticate(int num_parms, char *parms[]) {
+ char buf[SIZ];
+
+ if (num_parms != 3) {
+ cprintf("%s BAD incorrect number of parameters\r\n", parms[0]);
+ return;
+ }
+
+ if (!strcasecmp(parms[2], "LOGIN")) {
+ encode_base64(buf, "Username:");
+ cprintf("+ %s\r\n", buf);
+ IMAP->authstate = imap_as_expecting_username;
+ strcpy(IMAP->authseq, parms[0]);
+ return;
+ }
+
+ else {
+ cprintf("%s NO AUTHENTICATE %s failed\r\n",
+ parms[0], parms[1]);
+ }
+}
+
+void imap_auth_login_user(char *cmd) {
+ char buf[SIZ];
+
+ decode_base64(buf, cmd);
+ CtdlLoginExistingUser(buf);
+ encode_base64(buf, "Password:");
+ cprintf("+ %s\r\n", buf);
+ IMAP->authstate = imap_as_expecting_password;
+ return;
+}
+
+void imap_auth_login_pass(char *cmd) {
+ char buf[SIZ];
+
+ decode_base64(buf, cmd);
+ if (CtdlTryPassword(buf) == pass_ok) {
+ cprintf("%s OK authentication succeeded\r\n", IMAP->authseq);
+ }
+ else {
+ cprintf("%s NO authentication failed\r\n", IMAP->authseq);
+ }
+ IMAP->authstate = imap_as_normal;
+ return;
+}
+
+
+
+/*
+ * implements the CAPABILITY command
+ */
+void imap_capability(int num_parms, char *parms[]) {
+ cprintf("* CAPABILITY IMAP4 IMAP4REV1 AUTH=LOGIN\r\n");
+ cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
+}
+
+
+
+
+
+/*
+ * implements the SELECT command
+ */
+void imap_select(int num_parms, char *parms[]) {
+ char towhere[SIZ];
+ char augmented_roomname[SIZ];
+ int c = 0;
+ int ok = 0;
+ int ra = 0;
+ struct quickroom QRscratch;
+ int msgs, new;
+
+ strcpy(towhere, parms[2]);
+
+ /* IMAP uses the reserved name "INBOX" for the user's default incoming
+ * mail folder. Convert this to whatever Citadel is using for the
+ * default mail room name (usually "Mail>").
+ */
+ if (!strcasecmp(towhere, "INBOX")) {
+ strcpy(towhere, MAILROOM);
+ }
+
+ /* First try a regular match */
+ c = getroom(&QRscratch, towhere);
+
+ /* Then try a mailbox name match */
+ if (c != 0) {
+ MailboxName(augmented_roomname, &CC->usersupp, towhere);
+ c = getroom(&QRscratch, augmented_roomname);
+ if (c == 0)
+ strcpy(towhere, augmented_roomname);
+ }
+
+ /* If the room exists, check security/access */
+ if (c == 0) {
+ /* See if there is an existing user/room relationship */
+ ra = CtdlRoomAccess(&QRscratch, &CC->usersupp);
+
+ /* normal clients have to pass through security */
+ if (ra & UA_KNOWN) {
+ ok = 1;
+ }
+ }
+
+ /* Fail here if no such room */
+ if (!ok) {
+ cprintf("%s NO ... no such room, or access denied\r\n",
+ parms[0]);
+ IMAP->selected = 0;
+ return;
+ }
+
+ /*
+ * usergoto() formally takes us to the desired room, happily returning
+ * the number of messages and number of new messages.
+ */
+ usergoto(QRscratch.QRname, 0, &msgs, &new);
+ IMAP->selected = 1;
+
+ if (!strcasecmp(parms[1], "EXAMINE")) {
+ IMAP->readonly = 1;
+ }
+ else {
+ IMAP->readonly = 0;
+ }
+
+ imap_load_msgids();
+
+ /* FIXME ... much more info needs to be supplied here */
+ cprintf("* %d EXISTS\r\n", msgs);
+ cprintf("* %d RECENT\r\n", new);
+ cprintf("* OK [UIDVALIDITY 0] UIDs valid\r\n");
+ cprintf("%s OK [%s] %s completed\r\n",
+ parms[0],
+ (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"),
+ parms[1]);
+}
+
+
+
+/*
+ * implements the CLOSE command
+ */
+void imap_close(int num_parms, char *parms[]) {
+ IMAP->selected = 0;
+ IMAP->readonly = 0;
+ imap_free_msgids();
+ cprintf("%s OK CLOSE completed\r\n", parms[0]);
+}
+
+
+
+
+
+/*
+ * Back end for imap_lsub()
+ *
+ * IMAP "subscribed folder" is equivocated to Citadel "known rooms." This
+ * may or may not be the desired behavior in the future.
+ */
+void imap_lsub_listroom(struct quickroom *qrbuf, void *data) {
+ char buf[SIZ];
+ int ra;
+
+ /* Only list rooms to which the user has access!! */
+ ra = CtdlRoomAccess(qrbuf, &CC->usersupp);
+ if (ra & UA_KNOWN) {
+ imap_mailboxname(buf, sizeof buf, qrbuf);
+ cprintf("* LSUB () \"|\" \"%s\"\r\n", buf);
+ }
+}
+
+
+/*
+ * Implements the LSUB command
+ *
+ * FIXME: Handle wildcards, please.
+ */
+void imap_lsub(int num_parms, char *parms[]) {
+ ForEachRoom(imap_lsub_listroom, NULL);
+ cprintf("%s OK LSUB completed\r\n", parms[0]);
+}
+
+
+
+/*
+ * Back end for imap_list()
+ */
+void imap_list_listroom(struct quickroom *qrbuf, void *data) {
+ char buf[SIZ];
+ int ra;
+
+ /* Only list rooms to which the user has access!! */
+ ra = CtdlRoomAccess(qrbuf, &CC->usersupp);
+ if ( (ra & UA_KNOWN)
+ || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
+ imap_mailboxname(buf, sizeof buf, qrbuf);
+ cprintf("* LIST () \"|\" \"%s\"\r\n", buf);
+ }
+}
+
+
+/*
+ * Implements the LIST command
+ *
+ * FIXME: Handle wildcards, please.
+ */
+void imap_list(int num_parms, char *parms[]) {
+ ForEachRoom(imap_list_listroom, NULL);
+ cprintf("%s OK LIST completed\r\n", parms[0]);
+}
+
/*
* Main command loop for IMAP sessions.
*/
void imap_command_loop(void) {
- char cmdbuf[256];
- char tag[256];
+ char cmdbuf[SIZ];
+ char *parms[SIZ];
+ int num_parms;
time(&CC->lastcmd);
memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
if (cmdbuf[strlen(cmdbuf)-1]=='\r') cmdbuf[strlen(cmdbuf)-1]=0;
striplt(cmdbuf);
+ /* If we're in the middle of a multi-line command, handle that */
+ if (IMAP->authstate == imap_as_expecting_username) {
+ imap_auth_login_user(cmdbuf);
+ return;
+ }
+ if (IMAP->authstate == imap_as_expecting_password) {
+ imap_auth_login_pass(cmdbuf);
+ return;
+ }
+
+
+ /* Ok, at this point we're in normal command mode */
+
/* grab the tag */
- extract_token(tag, cmdbuf, 0, ' ');
- remove_token(cmdbuf, 0, ' ');
- lprintf(9, "tag=<%s> cmd=<%s>\n", tag, cmdbuf);
+ num_parms = imap_parameterize(parms, cmdbuf);
+
+ /* commands which may be executed in any state */
- if (!strncasecmp(cmdbuf, "NOOP", 4)) {
+ if ( (!strcasecmp(parms[1], "NOOP"))
+ || (!strcasecmp(parms[1], "CHECK")) ) {
cprintf("%s OK This command successfully did nothing.\r\n",
- tag);
+ parms[0]);
}
- else if (!strncasecmp(cmdbuf, "LOGOUT", 4)) {
- cprintf("%s OK thank you for using Citadel IMAP\r\n", tag);
+ else if (!strcasecmp(parms[1], "LOGOUT")) {
+ cprintf("* BYE %s logging out\r\n", config.c_fqdn);
+ cprintf("%s OK thank you for using Citadel IMAP\r\n", parms[0]);
CC->kill_me = 1;
return;
}
- /* FIXME ... implement login commands HERE */
+ else if (!strcasecmp(parms[1], "LOGIN")) {
+ imap_login(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
+ imap_authenticate(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "CAPABILITY")) {
+ imap_capability(num_parms, parms);
+ }
else if (!CC->logged_in) {
- cprintf("%s BAD Not logged in.\r\n", tag);
+ cprintf("%s BAD Not logged in.\r\n", parms[0]);
+ }
+
+ /* commands requiring the client to be logged in */
+
+ else if (!strcasecmp(parms[1], "SELECT")) {
+ imap_select(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "EXAMINE")) {
+ imap_select(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "LSUB")) {
+ imap_lsub(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "LIST")) {
+ imap_list(num_parms, parms);
+ }
+
+ else if (IMAP->selected == 0) {
+ cprintf("%s BAD no folder selected\r\n", parms[0]);
+ }
+
+ /* commands requiring the SELECT state */
+
+ else if (!strcasecmp(parms[1], "FETCH")) {
+ imap_fetch(num_parms, parms);
+ }
+
+ else if ( (!strcasecmp(parms[1], "UID"))
+ && (!strcasecmp(parms[2], "FETCH")) ) {
+ imap_uidfetch(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "SEARCH")) {
+ imap_search(num_parms, parms);
+ }
+
+ else if ( (!strcasecmp(parms[1], "UID"))
+ && (!strcasecmp(parms[2], "SEARCH")) ) {
+ imap_uidsearch(num_parms, parms);
+ }
+
+ else if (!strcasecmp(parms[1], "CLOSE")) {
+ imap_close(num_parms, parms);
}
- /* FIXME ... implement commands requiring login here */
+ /* end of commands */
else {
- cprintf("%s BAD command unrecognized\r\n", tag);
+ cprintf("%s BAD command unrecognized\r\n", parms[0]);
}
}
char *Dynamic_Module_Init(void)
{
SYM_IMAP = CtdlGetDynamicSymbol();
- CtdlRegisterServiceHook(143, /* FIXME put in config setup */
+ CtdlRegisterServiceHook(config.c_imap_port,
NULL,
imap_greeting,
imap_command_loop);
projects / citadel.git / blobdiff