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