* move policy.c into modules/expire/expire_policy.c, since it just controls this.
[citadel.git] / citadel / modules / spam / serv_spam.c
1 /*
2  * $Id$
3  *
4  * This module allows Citadel to use SpamAssassin to filter incoming messages
5  * arriving via SMTP.  For more information on SpamAssassin, visit
6  * http://www.spamassassin.org (the SpamAssassin project is not in any way
7  * affiliated with the Citadel project).
8  *
9  * Copyright (c) 1998-2009 by the citadel.org team
10  *
11  *  This program is free software; you can redistribute it and/or modify
12  *  it under the terms of the GNU General Public License as published by
13  *  the Free Software Foundation; either version 3 of the License, or
14  *  (at your option) any later version.
15  *
16  *  This program is distributed in the hope that it will be useful,
17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *  GNU General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License
22  *  along with this program; if not, write to the Free Software
23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25
26 #define SPAMASSASSIN_PORT       "783"
27
28 #include "sysdep.h"
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <stdio.h>
32 #include <fcntl.h>
33 #include <signal.h>
34 #include <pwd.h>
35 #include <errno.h>
36 #include <sys/types.h>
37
38 #if TIME_WITH_SYS_TIME
39 # include <sys/time.h>
40 # include <time.h>
41 #else
42 # if HAVE_SYS_TIME_H
43 #  include <sys/time.h>
44 # else
45 #  include <time.h>
46 # endif
47 #endif
48
49 #include <sys/wait.h>
50 #include <string.h>
51 #include <limits.h>
52 #include <sys/socket.h>
53 #include <libcitadel.h>
54 #include "citadel.h"
55 #include "server.h"
56 #include "citserver.h"
57 #include "support.h"
58 #include "config.h"
59 #include "control.h"
60 #include "user_ops.h"
61 #include "database.h"
62 #include "msgbase.h"
63 #include "internet_addressing.h"
64 #include "domain.h"
65 #include "clientsocket.h"
66
67
68 #include "ctdl_module.h"
69
70
71
72 /*
73  * Connect to the SpamAssassin server and scan a message.
74  */
75 int spam_assassin(struct CtdlMessage *msg) {
76         int sock = (-1);
77         char sahosts[SIZ];
78         int num_sahosts;
79         char buf[SIZ];
80         int is_spam = 0;
81         int sa;
82         StrBuf *msgtext;
83         CitContext *CCC=CC;
84
85         /* For users who have authenticated to this server we never want to
86          * apply spam filtering, because presumably they're trustworthy.
87          */
88         if (CC->logged_in) return(0);
89
90         /* See if we have any SpamAssassin hosts configured */
91         num_sahosts = get_hosts(sahosts, "spamassassin");
92         if (num_sahosts < 1) return(0);
93
94         /* Try them one by one until we get a working one */
95         for (sa=0; sa<num_sahosts; ++sa) {
96                 extract_token(buf, sahosts, sa, '|', sizeof buf);
97                 CtdlLogPrintf(CTDL_INFO, "Connecting to SpamAssassin at <%s>\n", buf);
98                 sock = sock_connect(buf, SPAMASSASSIN_PORT, "tcp");
99                 if (sock >= 0) CtdlLogPrintf(CTDL_DEBUG, "Connected!\n");
100         }
101
102         if (sock < 0) {
103                 /* If the service isn't running, just pass the mail
104                  * through.  Potentially throwing away mails isn't good.
105                  */
106                 return(0);
107         }
108
109         CCC->sReadBuf = NewStrBuf();
110         CCC->sMigrateBuf = NewStrBuf();
111         CCC->sPos = NULL;
112
113         /* Command */
114         CtdlLogPrintf(CTDL_DEBUG, "Transmitting command\n");
115         sprintf(buf, "CHECK SPAMC/1.2\r\n\r\n");
116         sock_write(&sock, buf, strlen(buf));
117
118         /* Message */
119         CCC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
120         CtdlOutputPreLoadedMsg(msg, MT_RFC822, HEADERS_ALL, 0, 1, 0);
121         msgtext = CC->redirect_buffer;
122         CC->redirect_buffer = NULL;
123
124         sock_write(&sock, SKEY(msgtext));
125         FreeStrBuf(&msgtext);
126
127         /* Close one end of the socket connection; this tells SpamAssassin
128          * that we're done.
129          */
130         if (sock != -1)
131                 sock_shutdown(sock, SHUT_WR);
132         
133         /* Response */
134         CtdlLogPrintf(CTDL_DEBUG, "Awaiting response\n");
135         if (sock_getln(&sock, buf, sizeof buf) < 0) {
136                 goto bail;
137         }
138         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
139         if (strncasecmp(buf, "SPAMD", 5)) {
140                 goto bail;
141         }
142         if (sock_getln(&sock, buf, sizeof buf) < 0) {
143                 goto bail;
144         }
145         CtdlLogPrintf(CTDL_DEBUG, "<%s\n", buf);
146         CtdlLogPrintf(CTDL_DEBUG, "c_spam_flag_only setting %d\n", config.c_spam_flag_only);
147         if (config.c_spam_flag_only) {
148                 CtdlLogPrintf(CTDL_DEBUG, "flag spam code used");
149                 int headerlen;
150                 int newmsgsize;
151                 int oldmsgsize;
152
153                 char sastatus[10];
154                 char sascore[10];
155                 char saoutof[10];
156                 int numscore;
157
158                 extract_token(sastatus, buf, 1, ' ', sizeof sastatus);
159                 extract_token(sascore, buf, 3, ' ', sizeof sascore);
160                 extract_token(saoutof, buf, 5, ' ', sizeof saoutof);
161
162                 sprintf(buf,"X-Spam-Level: ");
163                 char *cur = buf + 14;
164                 for (numscore = atoi(sascore); numscore>0; numscore--)
165                         *(cur++) = '*';
166                 *cur = '\0';
167
168                 sprintf(cur,"\r\nX-Spam-Status: %s, score=%s required=%s\r\n", sastatus, sascore, saoutof);
169                 headerlen = strlen(buf);
170                 oldmsgsize = strlen(msg->cm_fields['M']) + 1;
171                 newmsgsize = headerlen + oldmsgsize;
172
173                 msg->cm_fields['M'] = realloc(msg->cm_fields['M'], newmsgsize);
174
175                 memmove(msg->cm_fields['M']+headerlen,msg->cm_fields['M'],oldmsgsize);
176                 memcpy(msg->cm_fields['M'],buf,headerlen);
177
178         } else {
179                 CtdlLogPrintf(CTDL_DEBUG, "reject spam code used");
180                 if (!strncasecmp(buf, "Spam: True", 10)) {
181                         is_spam = 1;
182                 }
183
184                 if (is_spam) {
185                         if (msg->cm_fields['0'] != NULL) {
186                                 free(msg->cm_fields['0']);
187                         }
188                         msg->cm_fields['0'] = strdup("message rejected by spam filter");
189                 }
190         }
191
192 bail:   close(sock);
193         FreeStrBuf(&CCC->sReadBuf);
194         FreeStrBuf(&CCC->sMigrateBuf);
195         return(is_spam);
196 }
197
198
199
200 CTDL_MODULE_INIT(spam)
201 {
202         if (!threading)
203         {
204                 CtdlRegisterMessageHook(spam_assassin, EVT_SMTPSCAN);
205         }
206         
207         /* return our Subversion id for the Log */
208         return "$Id$";
209 }