POP3: optionalize pop3 verbose logging.
[citadel.git] / citadel / modules / pop3 / serv_pop3.c
index 761a4da967e510c06b697ef7722ea9fcb5964073..5468af94bacecb2f092579dd44c17a33fdcaf49f 100644 (file)
@@ -1,9 +1,21 @@
 /*
- * $Id$ 
- *
  * POP3 service for the Citadel system
- * Copyright (C) 1998-2001 by Art Cancro and others.
- * This code is released under the terms of the GNU General Public License.
+ *
+ * Copyright (c) 1998-2012 by the citadel.org team
+ *
+ *  This program is open source software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 3.
+ *  
+ *  
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  
+ *  
+ *  
  *
  * Current status of standards conformance:
  *
 #include <string.h>
 #include <limits.h>
 #include <ctype.h>
+#include <libcitadel.h>
 #include "citadel.h"
 #include "server.h"
 #include "citserver.h"
 #include "support.h"
 #include "config.h"
-#include "room_ops.h"
 #include "user_ops.h"
-#include "policy.h"
 #include "database.h"
 #include "msgbase.h"
-#include "tools.h"
 #include "internet_addressing.h"
 #include "serv_pop3.h"
 #include "md5.h"
 
 #include "ctdl_module.h"
 
+int POP3DebugEnabled = 0;
+
+#define POP3DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (POP3DebugEnabled != 0))
+#define CCCID CCC->cs_pid
+#define POP3_syslog(LEVEL, FORMAT, ...)                        \
+       POP3DBGLOG(LEVEL) syslog(LEVEL,                 \
+                                "POP3CC[%d] " FORMAT,  \
+                                CCCID, __VA_ARGS__)
 
+#define POP3M_syslog(LEVEL, FORMAT)                    \
+       POP3DBGLOG(LEVEL) syslog(LEVEL,                 \
+                                "POP3CC[%d] " FORMAT,  \
+                                CCCID)
 
 /*
  * This cleanup function blows away the temporary memory and files used by
  * the POP3 server.
  */
-void pop3_cleanup_function(void) {
+void pop3_cleanup_function(void)
+{
+       struct CitContext *CCC = CC;
 
        /* Don't do this stuff if this is not a POP3 session! */
-       if (CC->h_command_function != pop3_command_loop) return;
+       if (CCC->h_command_function != pop3_command_loop) return;
 
-       lprintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
+       POP3M_syslog(LOG_DEBUG, "Performing POP3 cleanup hook");
        if (POP3->msgs != NULL) free(POP3->msgs);
 
        free(POP3);
@@ -82,22 +106,34 @@ void pop3_cleanup_function(void) {
 /*
  * Here's where our POP3 session begins its happy day.
  */
-void pop3_greeting(void) {
-       strcpy(CC->cs_clientname, "POP3 session");
-       CC->internal_pgm = 1;
-       POP3 = malloc(sizeof(struct citpop3));
+void pop3_greeting(void)
+{
+       struct CitContext *CCC = CC;
+
+       strcpy(CCC->cs_clientname, "POP3 session");
+       CCC->internal_pgm = 1;
+       CCC->session_specific_data = malloc(sizeof(struct citpop3));
        memset(POP3, 0, sizeof(struct citpop3));
 
-       cprintf("+OK Citadel POP3 server %s\r\n",
-               CC->cs_nonce);
+       cprintf("+OK Citadel POP3 server ready.\r\n");
 }
 
 
 /*
  * POP3S is just like POP3, except it goes crypto right away.
  */
-void pop3s_greeting(void) {
+void pop3s_greeting(void)
+{
+       struct CitContext *CCC = CC;
        CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
+
+/* kill session if no crypto */
+#ifdef HAVE_OPENSSL
+       if (!CCC->redirect_ssl) CCC->kill_me = KILLME_NO_CRYPTO;
+#else
+       CCC->kill_me = KILLME_NO_CRYPTO;
+#endif
+
        pop3_greeting();
 }
 
@@ -106,10 +142,12 @@ void pop3s_greeting(void) {
 /*
  * Specify user name (implements POP3 "USER" command)
  */
-void pop3_user(char *argbuf) {
+void pop3_user(char *argbuf)
+{
+       struct CitContext *CCC = CC;
        char username[SIZ];
 
-       if (CC->logged_in) {
+       if (CCC->logged_in) {
                cprintf("-ERR You are already logged in.\r\n");
                return;
        }
@@ -117,7 +155,7 @@ void pop3_user(char *argbuf) {
        strcpy(username, argbuf);
        striplt(username);
 
-       /* lprintf(CTDL_DEBUG, "Trying <%s>\n", username); */
+       /* POP3_syslog(LOG_DEBUG, "Trying <%s>", username); */
        if (CtdlLoginExistingUser(NULL, username) == login_ok) {
                cprintf("+OK Password required for %s\r\n", username);
        }
@@ -131,7 +169,9 @@ void pop3_user(char *argbuf) {
 /*
  * Back end for pop3_grab_mailbox()
  */
-void pop3_add_message(long msgnum, void *userdata) {
+void pop3_add_message(long msgnum, void *userdata)
+{
+       struct CitContext *CCC = CC;
        struct MetaData smi;
 
        ++POP3->num_msgs;
@@ -148,15 +188,17 @@ void pop3_add_message(long msgnum, void *userdata) {
         */
        GetMetaData(&smi, msgnum);
        if (smi.meta_rfc822_length <= 0L) {
-               CC->redirect_buffer = malloc(SIZ);
-               CC->redirect_len = 0;
-               CC->redirect_alloc = SIZ;
-               CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL);
-               smi.meta_rfc822_length = CC->redirect_len;
-               free(CC->redirect_buffer);
-               CC->redirect_buffer = NULL;
-               CC->redirect_len = 0;
-               CC->redirect_alloc = 0;
+               CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
+
+               CtdlOutputMsg(msgnum,
+                             MT_RFC822,
+                             HEADERS_ALL,
+                             0, 1, NULL,
+                             SUPPRESS_ENV_TO,
+                             NULL, NULL);
+
+               smi.meta_rfc822_length = StrLength(CCC->redirect_buffer);
+               FreeStrBuf(&CCC->redirect_buffer); /* TODO: WHEW, all this for just knowing the length???? */
                PutMetaData(&smi);
        }
        POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
@@ -169,18 +211,20 @@ void pop3_add_message(long msgnum, void *userdata) {
  * (This should be called only once, by pop3_pass(), and returns the number
  * of messages in the inbox, or -1 for error)
  */
-int pop3_grab_mailbox(void) {
-        struct visit vbuf;
+int pop3_grab_mailbox(void)
+{
+       struct CitContext *CCC = CC;
+        visit vbuf;
        int i;
 
-       if (getroom(&CC->room, MAILROOM) != 0) return(-1);
+       if (CtdlGetRoom(&CCC->room, MAILROOM) != 0) return(-1);
 
        /* Load up the messages */
        CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
                pop3_add_message, NULL);
 
        /* Figure out which are old and which are new */
-        CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
+        CtdlGetRelationship(&vbuf, &CCC->user, &CCC->room);
        POP3->lastseen = (-1);
        if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
                if (is_msg_in_sequence_set(vbuf.v_seen,
@@ -194,13 +238,14 @@ int pop3_grab_mailbox(void) {
 
 void pop3_login(void)
 {
+       struct CitContext *CCC = CC;
        int msgs;
        
        msgs = pop3_grab_mailbox();
        if (msgs >= 0) {
                cprintf("+OK %s is logged in (%d messages)\r\n",
-                       CC->user.fullname, msgs);
-               lprintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
+                       CCC->user.fullname, msgs);
+               POP3_syslog(LOG_DEBUG, "POP3 authenticated %s", CCC->user.fullname);
        }
        else {
                cprintf("-ERR Can't open your mailbox\r\n");
@@ -208,60 +253,6 @@ void pop3_login(void)
        
 }
 
-void pop3_apop(char *argbuf)
-{
-   char username[SIZ];
-   char userdigest[MD5_HEXSTRING_SIZE];
-   char realdigest[MD5_HEXSTRING_SIZE];
-   char *sptr;
-   
-   if (CC->logged_in)
-   {
-       cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
-       return;
-   }
-   
-   if ((sptr = strchr(argbuf, ' ')) == NULL)
-   {
-       cprintf("-ERR Invalid APOP line.\r\n");
-       return;
-   }
-   
-   *sptr++ = '\0';
-   
-   while ((*sptr) && isspace(*sptr))
-      sptr++;
-   
-   strncpy(username, argbuf, sizeof(username)-1);
-   username[sizeof(username)-1] = '\0';
-   
-   memset(userdigest, MD5_HEXSTRING_SIZE, 0);
-   strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
-   
-   if (CtdlLoginExistingUser(NULL, username) != login_ok)
-   {
-       cprintf("-ERR No such user.\r\n");
-       return;
-   }
-   
-   if (getuser(&CC->user, CC->curr_user))
-   {
-       cprintf("-ERR No such user.\r\n");
-       return;
-   }
-   
-   make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
-   if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
-   {
-       do_login();
-       pop3_login();
-   }
-   else
-   {
-       cprintf("-ERR That is NOT the password.\r\n");
-   }
-}
-
 
 /*
  * Authorize with password (implements POP3 "PASS" command)
@@ -269,11 +260,11 @@ void pop3_apop(char *argbuf)
 void pop3_pass(char *argbuf) {
        char password[SIZ];
 
-       strcpy(password, argbuf);
+       safestrncpy(password, argbuf, sizeof password);
        striplt(password);
 
-       /* lprintf(CTDL_DEBUG, "Trying <%s>\n", password); */
-       if (CtdlTryPassword(password) == pass_ok) {
+       /* POP3_syslog(LOG_DEBUG, "Trying <%s>", password); */
+       if (CtdlTryPassword(password, strlen(password)) == pass_ok) {
                pop3_login();
        }
        else {
@@ -365,7 +356,10 @@ void pop3_retr(char *argbuf) {
        }
 
        cprintf("+OK Message %d:\r\n", which_one);
-       CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL);
+       CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
+                     MT_RFC822, HEADERS_ALL, 0, 1, NULL,
+                     (ESC_DOT|SUPPRESS_ENV_TO),
+                     NULL, NULL);
        cprintf(".\r\n");
 }
 
@@ -373,13 +367,15 @@ void pop3_retr(char *argbuf) {
 /*
  * TOP command (dumb way of fetching a partial message or headers-only)
  */
-void pop3_top(char *argbuf) {
+void pop3_top(char *argbuf)
+{
+       struct CitContext *CCC = CC;
        int which_one;
        int lines_requested = 0;
        int lines_dumped = 0;
        char buf[1024];
-       char *msgtext;
-       char *ptr;
+       StrBuf *msgtext;
+       const char *ptr;
        int in_body = 0;
        int done = 0;
 
@@ -394,21 +390,22 @@ void pop3_top(char *argbuf) {
                return;
        }
 
-       CC->redirect_buffer = malloc(SIZ);
-       CC->redirect_len = 0;
-       CC->redirect_alloc = SIZ;
-       CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
-                       MT_RFC822, HEADERS_ALL, 0, 1, NULL);
-       msgtext = CC->redirect_buffer;
-       CC->redirect_buffer = NULL;
-       CC->redirect_len = 0;
-       CC->redirect_alloc = 0;
+       CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 
-       cprintf("+OK Message %d:\r\n", which_one);
+       CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
+                     MT_RFC822,
+                     HEADERS_ALL,
+                     0, 1, NULL,
+                     SUPPRESS_ENV_TO,
+                     NULL, NULL);
 
-       ptr = msgtext;
+       msgtext = CCC->redirect_buffer;
+       CCC->redirect_buffer = NULL;
 
-       while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
+       cprintf("+OK Message %d:\r\n", which_one);
+       
+       ptr = ChrPtr(msgtext);
+       while (ptr = cmemreadline(ptr, buf, (sizeof buf - 2)),
              ( (*ptr != 0) && (done == 0))) {
                strcat(buf, "\r\n");
                if (in_body == 1) {
@@ -426,7 +423,7 @@ void pop3_top(char *argbuf) {
        }
 
        if (buf[strlen(buf)-1] != 10) cprintf("\n");
-       free(msgtext);
+       FreeStrBuf(&msgtext);
 
        cprintf(".\r\n");
 }
@@ -458,9 +455,11 @@ void pop3_dele(char *argbuf) {
 
 /* Perform "UPDATE state" stuff
  */
-void pop3_update(void) {
+void pop3_update(void)
+{
+       struct CitContext *CCC = CC;
        int i;
-        struct visit vbuf;
+        visit vbuf;
 
        long *deletemsgs = NULL;
        int num_deletemsgs = 0;
@@ -481,14 +480,14 @@ void pop3_update(void) {
 
        /* Set last read pointer */
        if (POP3->num_msgs > 0) {
-               lgetuser(&CC->user, CC->curr_user);
+               CtdlGetUserLock(&CCC->user, CCC->curr_user);
 
-               CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
+               CtdlGetRelationship(&vbuf, &CCC->user, &CCC->room);
                snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
                        POP3->msgs[POP3->num_msgs-1].msgnum);
-               CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
+               CtdlSetRelationship(&vbuf, &CCC->user, &CCC->room);
 
-               lputuser(&CC->user);
+               CtdlPutUserLock(&CCC->user);
        }
 
 }
@@ -608,21 +607,23 @@ void pop3_stls(void)
 /* 
  * Main command loop for POP3 sessions.
  */
-void pop3_command_loop(void) {
+void pop3_command_loop(void)
+{
+       struct CitContext *CCC = CC;
        char cmdbuf[SIZ];
 
-       time(&CC->lastcmd);
+       time(&CCC->lastcmd);
        memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
        if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
-               lprintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
-               CC->kill_me = 1;
+               POP3M_syslog(LOG_INFO, "POP3 client disconnected: ending session.");
+               CCC->kill_me = KILLME_CLIENT_DISCONNECTED;
                return;
        }
        if (!strncasecmp(cmdbuf, "PASS", 4)) {
-               lprintf(CTDL_INFO, "POP3: PASS...\r\n");
+               POP3M_syslog(LOG_DEBUG, "POP3: PASS...");
        }
        else {
-               lprintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
+               POP3_syslog(LOG_DEBUG, "POP3: %s", cmdbuf);
        }
        while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
 
@@ -637,7 +638,7 @@ void pop3_command_loop(void) {
        else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
                cprintf("+OK Goodbye...\r\n");
                pop3_update();
-               CC->kill_me = 1;
+               CCC->kill_me = KILLME_CLIENT_LOGGED_OUT;
                return;
        }
 
@@ -649,20 +650,20 @@ void pop3_command_loop(void) {
                pop3_pass(&cmdbuf[5]);
        }
 
-       else if (!strncasecmp(cmdbuf, "APOP", 4))
-       {
-               pop3_apop(&cmdbuf[5]);
-       }
-
 #ifdef HAVE_OPENSSL
        else if (!strncasecmp(cmdbuf, "STLS", 4)) {
                pop3_stls();
        }
 #endif
 
-       else if (!CC->logged_in) {
+       else if (!CCC->logged_in) {
                cprintf("-ERR Not logged in.\r\n");
        }
+       
+       else if (CCC->nologin) {
+               cprintf("-ERR System busy, try later.\r\n");
+               CCC->kill_me = KILLME_NOLOGIN;
+       }
 
        else if (!strncasecmp(cmdbuf, "LIST", 4)) {
                pop3_list(&cmdbuf[5]);
@@ -705,25 +706,35 @@ void pop3_command_loop(void) {
 const char *CitadelServicePop3="POP3";
 const char *CitadelServicePop3S="POP3S";
 
+void SetPOP3DebugEnabled(const int n)
+{
+       POP3DebugEnabled = n;
+}
+
 
 CTDL_MODULE_INIT(pop3)
 {
-       CtdlRegisterServiceHook(config.c_pop3_port,
-                               NULL,
-                               pop3_greeting,
-                               pop3_command_loop,
-                               NULL,
-                               CitadelServicePop3);
+       if(!threading)
+       {
+               CtdlRegisterDebugFlagHook(HKEY("pop3srv"), SetPOP3DebugEnabled, &POP3DebugEnabled);
+
+               CtdlRegisterServiceHook(config.c_pop3_port,
+                                       NULL,
+                                       pop3_greeting,
+                                       pop3_command_loop,
+                                       NULL,
+                                       CitadelServicePop3);
 #ifdef HAVE_OPENSSL
-       CtdlRegisterServiceHook(config.c_pop3s_port,
-                               NULL,
-                               pop3s_greeting,
-                               pop3_command_loop,
-                               NULL,
-                               CitadelServicePop3S);
+               CtdlRegisterServiceHook(config.c_pop3s_port,
+                                       NULL,
+                                       pop3s_greeting,
+                                       pop3_command_loop,
+                                       NULL,
+                                       CitadelServicePop3S);
 #endif
-       CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);
-
-       /* return our Subversion id for the Log */
-       return "$Id$";
+               CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP, PRIO_STOP + 30);
+       }
+       
+       /* return our module name for the log */
+       return "pop3";
 }