3 * POP3 server for the Citadel/UX system
4 * Copyright (C) 1998-2000 by Art Cancro and others.
5 * This code is released under the terms of the GNU General Public License.
7 * Current status of standards conformance:
9 * -> All required POP3 commands described in RFC1939 are implemented.
11 * -> Nearly all of the optional commands in RFC1939 are also implemented.
12 * The only one missing is APOP, because it implements a "shared secret"
13 * method of authentication which would require some major changes to the
14 * Citadel server core.
16 * -> The deprecated "LAST" command is included in this implementation, because
17 * there exist mail clients which insist on using it (such as Bynari
18 * TradeMail, and certain versions of Eudora).
30 #include <sys/types.h>
38 #include "sysdep_decls.h"
39 #include "citserver.h"
42 #include "dynloader.h"
49 #include "internet_addressing.h"
50 #include "serv_pop3.h"
57 * This cleanup function blows away the temporary memory and files used by
60 void pop3_cleanup_function(void) {
63 /* Don't do this stuff if this is not a POP3 session! */
64 if (CC->h_command_function != pop3_command_loop) return;
66 lprintf(9, "Performing POP3 cleanup hook\n");
68 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
69 fclose(POP3->msgs[i].temp);
71 if (POP3->msgs != NULL) phree(POP3->msgs);
73 lprintf(9, "Finished POP3 cleanup hook\n");
79 * Here's where our POP3 session begins its happy day.
81 void pop3_greeting(void) {
83 strcpy(CC->cs_clientname, "POP3 session");
85 CtdlAllocUserData(SYM_POP3, sizeof(struct citpop3));
89 cprintf("+OK Welcome to the Citadel/UX POP3 server at %s\r\n",
95 * Specify user name (implements POP3 "USER" command)
97 void pop3_user(char *argbuf) {
101 cprintf("-ERR You are already logged in.\r\n");
105 strcpy(username, argbuf);
108 lprintf(9, "Trying <%s>\n", username);
109 if (CtdlLoginExistingUser(username) == login_ok) {
110 cprintf("+OK Password required for %s\r\n", username);
113 cprintf("-ERR No such user.\r\n");
120 * Back end for pop3_grab_mailbox()
122 void pop3_add_message(long msgnum) {
124 lprintf(9, "in pop3_add_message()\n");
127 if (POP3->num_msgs < 2) POP3->msgs = mallok(sizeof(struct pop3msg));
128 else POP3->msgs = reallok(POP3->msgs,
129 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
130 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
131 POP3->msgs[POP3->num_msgs-1].deleted = 0;
133 POP3->msgs[POP3->num_msgs-1].temp = fp;
134 CtdlOutputMsg(msgnum, MT_RFC822, 0, 0, fp, 0, 1);
135 POP3->msgs[POP3->num_msgs-1].rfc822_length = ftell(fp);
141 * Open the inbox and read its contents.
142 * (This should be called only once, by pop3_pass(), and returns the number
143 * of messages in the inbox, or -1 for error)
145 int pop3_grab_mailbox(void) {
149 if (getroom(&CC->quickroom, MAILROOM) != 0) return(-1);
151 /* Load up the messages */
152 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, pop3_add_message);
154 /* Figure out which are old and which are new */
155 CtdlGetRelationship(&vbuf, &CC->usersupp, &CC->quickroom);
156 POP3->lastseen = (-1);
157 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
158 if ((POP3->msgs[POP3->num_msgs-1].msgnum) <= vbuf.v_lastseen) {
163 return(POP3->num_msgs);
167 * Authorize with password (implements POP3 "PASS" command)
169 void pop3_pass(char *argbuf) {
173 strcpy(password, argbuf);
176 lprintf(9, "Trying <%s>\n", password);
177 if (CtdlTryPassword(password) == pass_ok) {
178 msgs = pop3_grab_mailbox();
180 cprintf("+OK %s is logged in (%d messages)\r\n",
181 CC->usersupp.fullname, msgs);
182 lprintf(9, "POP3 password login successful\n");
185 cprintf("-ERR Can't open your mailbox\r\n");
189 cprintf("-ERR That is NOT the password! Go away!\r\n");
196 * list available msgs
198 void pop3_list(char *argbuf) {
202 which_one = atoi(argbuf);
204 /* "list one" mode */
206 if (which_one > POP3->num_msgs) {
207 cprintf("-ERR no such message, only %d are here\r\n",
211 else if (POP3->msgs[which_one-1].deleted) {
212 cprintf("-ERR Sorry, you deleted that message.\r\n");
216 cprintf("+OK %d %d\n",
218 POP3->msgs[which_one-1].rfc822_length
224 /* "list all" (scan listing) mode */
226 cprintf("+OK Here's your mail:\r\n");
227 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
228 if (! POP3->msgs[i].deleted) {
231 POP3->msgs[i].rfc822_length);
240 * STAT (tally up the total message count and byte count) command
242 void pop3_stat(char *argbuf) {
244 size_t total_octets = 0;
247 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
248 if (! POP3->msgs[i].deleted) {
250 total_octets += POP3->msgs[i].rfc822_length;
254 cprintf("+OK %d %d\n", total_msgs, total_octets);
260 * RETR command (fetch a message)
262 void pop3_retr(char *argbuf) {
265 size_t bytes_remaining;
267 which_one = atoi(argbuf);
268 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
269 cprintf("-ERR No such message.\r\n");
273 if (POP3->msgs[which_one - 1].deleted) {
274 cprintf("-ERR Sorry, you deleted that message.\r\n");
278 cprintf("+OK Whoop, there it is:\r\n");
279 bytes_remaining = POP3->msgs[which_one -1].rfc822_length;
280 rewind(POP3->msgs[which_one - 1].temp);
281 while (bytes_remaining-- > 0) {
282 ch = getc(POP3->msgs[which_one - 1].temp);
290 * TOP command (dumb way of fetching a partial message or headers-only)
292 void pop3_top(char *argbuf) {
294 int lines_requested = 0;
295 int lines_dumped = 0;
301 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
302 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
303 cprintf("-ERR No such message.\r\n");
307 if (POP3->msgs[which_one - 1].deleted) {
308 cprintf("-ERR Sorry, you deleted that message.\r\n");
312 cprintf("+OK Whoop, there it is:\r\n");
313 rewind(POP3->msgs[which_one - 1].temp);
314 while (ptr = fgets(buf, sizeof buf, POP3->msgs[which_one - 1].temp),
315 ( (ptr!=NULL) && (done == 0))) {
317 if (lines_dumped >= lines_requested) done = 1;
318 if ((in_body == 0) || (done == 0))
319 client_write(buf, strlen(buf));
320 if (in_body) ++lines_dumped;
321 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
323 if (buf[strlen(buf)-1] != 10) cprintf("\n");
329 * DELE (delete message from mailbox)
331 void pop3_dele(char *argbuf) {
334 which_one = atoi(argbuf);
335 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
336 cprintf("-ERR No such message.\r\n");
340 if (POP3->msgs[which_one - 1].deleted) {
341 cprintf("-ERR You already deleted that message.\r\n");
345 /* Flag the message as deleted. Will expunge during QUIT command. */
346 POP3->msgs[which_one - 1].deleted = 1;
347 cprintf("+OK Message %d disappears in a cloud of orange smoke.\r\n",
352 /* Perform "UPDATE state" stuff
354 void pop3_update(void) {
358 /* Remove messages marked for deletion */
359 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
360 if (POP3->msgs[i].deleted) {
361 CtdlDeleteMessages(MAILROOM,
362 POP3->msgs[i].msgnum, NULL);
366 /* Set last read pointer */
367 if (POP3->num_msgs > 0) {
368 lgetuser(&CC->usersupp, CC->curr_user);
370 CtdlGetRelationship(&vbuf, &CC->usersupp, &CC->quickroom);
371 vbuf.v_lastseen = POP3->msgs[POP3->num_msgs-1].msgnum;
372 CtdlSetRelationship(&vbuf, &CC->usersupp, &CC->quickroom);
374 lputuser(&CC->usersupp);
381 * RSET (reset, i.e. undelete any deleted messages) command
383 void pop3_rset(char *argbuf) {
386 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
387 if (POP3->msgs[i].deleted) {
388 POP3->msgs[i].deleted = 0;
391 cprintf("+OK all that has come to pass, has now gone away.\r\n");
397 * LAST (Determine which message is the last unread message)
399 void pop3_last(char *argbuf) {
400 cprintf("+OK %d\r\n", POP3->lastseen + 1);
406 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
407 * identifiers are simply the Citadel message numbers in the database.
409 void pop3_uidl(char *argbuf) {
413 which_one = atoi(argbuf);
415 /* "list one" mode */
417 if (which_one > POP3->num_msgs) {
418 cprintf("-ERR no such message, only %d are here\r\n",
422 else if (POP3->msgs[which_one-1].deleted) {
423 cprintf("-ERR Sorry, you deleted that message.\r\n");
427 cprintf("+OK %d %ld\n",
429 POP3->msgs[which_one-1].msgnum
435 /* "list all" (scan listing) mode */
437 cprintf("+OK Here's your mail:\r\n");
438 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
439 if (! POP3->msgs[i].deleted) {
440 cprintf("%d %ld\r\n",
442 POP3->msgs[i].msgnum);
453 * Main command loop for POP3 sessions.
455 void pop3_command_loop(void) {
459 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
460 if (client_gets(cmdbuf) < 1) {
461 lprintf(3, "POP3 socket is broken. Ending session.\r\n");
465 lprintf(5, "citserver[%3d]: %s\r\n", CC->cs_pid, cmdbuf);
466 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
468 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
469 cprintf("+OK This command successfully did nothing.\r\n");
472 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
473 cprintf("+OK Goodbye...\r\n");
479 else if (!strncasecmp(cmdbuf, "USER", 4)) {
480 pop3_user(&cmdbuf[5]);
483 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
484 pop3_pass(&cmdbuf[5]);
487 else if (!CC->logged_in) {
488 cprintf("-ERR Not logged in.\r\n");
491 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
492 pop3_list(&cmdbuf[5]);
495 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
496 pop3_stat(&cmdbuf[5]);
499 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
500 pop3_retr(&cmdbuf[5]);
503 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
504 pop3_dele(&cmdbuf[5]);
507 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
508 pop3_rset(&cmdbuf[5]);
511 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
512 pop3_uidl(&cmdbuf[5]);
515 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
516 pop3_top(&cmdbuf[4]);
519 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
520 pop3_last(&cmdbuf[4]);
524 cprintf("500 I'm afraid I can't do that, Dave.\r\n");
531 char *Dynamic_Module_Init(void)
533 SYM_POP3 = CtdlGetDynamicSymbol();
534 CtdlRegisterServiceHook(POP3_PORT,
537 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);