re-organize matcher part 5; more to come
[claws.git] / src / matcher.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #include <ctype.h>
21 #include <string.h>
22 #include <stdlib.h>
23 #include <errno.h>
24 #include "defs.h"
25 #include "utils.h"
26 #include "procheader.h"
27 #include "matcher.h"
28 #include "intl.h"
29 #include "matcher_parser.h"
30 #include "prefs_gtk.h"
31
32 struct _MatchParser {
33         gint id;
34         gchar *str;
35 };
36
37 typedef struct _MatchParser MatchParser;
38
39 static MatchParser matchparser_tab[] = {
40         /* msginfo flags */
41         {MATCHCRITERIA_ALL, "all"},
42         {MATCHCRITERIA_UNREAD, "unread"},
43         {MATCHCRITERIA_NOT_UNREAD, "~unread"},
44         {MATCHCRITERIA_NEW, "new"},
45         {MATCHCRITERIA_NOT_NEW, "~new"},
46         {MATCHCRITERIA_MARKED, "marked"},
47         {MATCHCRITERIA_NOT_MARKED, "~marked"},
48         {MATCHCRITERIA_DELETED, "deleted"},
49         {MATCHCRITERIA_NOT_DELETED, "~deleted"},
50         {MATCHCRITERIA_REPLIED, "replied"},
51         {MATCHCRITERIA_NOT_REPLIED, "~replied"},
52         {MATCHCRITERIA_FORWARDED, "forwarded"},
53         {MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
54         {MATCHCRITERIA_LOCKED, "locked"},
55         {MATCHCRITERIA_NOT_LOCKED, "~locked"},
56         {MATCHCRITERIA_COLORLABEL, "colorlabel"},
57         {MATCHCRITERIA_NOT_COLORLABEL, "~colorlabel"},
58
59         /* msginfo headers */
60         {MATCHCRITERIA_SUBJECT, "subject"},
61         {MATCHCRITERIA_NOT_SUBJECT, "~subject"},
62         {MATCHCRITERIA_FROM, "from"},
63         {MATCHCRITERIA_NOT_FROM, "~from"},
64         {MATCHCRITERIA_TO, "to"},
65         {MATCHCRITERIA_NOT_TO, "~to"},
66         {MATCHCRITERIA_CC, "cc"},
67         {MATCHCRITERIA_NOT_CC, "~cc"},
68         {MATCHCRITERIA_TO_OR_CC, "to_or_cc"},
69         {MATCHCRITERIA_NOT_TO_AND_NOT_CC, "~to_or_cc"},
70         {MATCHCRITERIA_AGE_GREATER, "age_greater"},
71         {MATCHCRITERIA_AGE_LOWER, "age_lower"},
72         {MATCHCRITERIA_NEWSGROUPS, "newsgroups"},
73         {MATCHCRITERIA_NOT_NEWSGROUPS, "~newsgroups"},
74         {MATCHCRITERIA_INREPLYTO, "inreplyto"},
75         {MATCHCRITERIA_NOT_INREPLYTO, "~inreplyto"},
76         {MATCHCRITERIA_REFERENCES, "references"},
77         {MATCHCRITERIA_NOT_REFERENCES, "~references"},
78         {MATCHCRITERIA_SCORE_GREATER, "score_greater"},
79         {MATCHCRITERIA_SCORE_LOWER, "score_lower"},
80         {MATCHCRITERIA_SCORE_EQUAL, "score_equal"},
81
82         {MATCHCRITERIA_SIZE_GREATER, "size_greater"},
83         {MATCHCRITERIA_SIZE_SMALLER, "size_smaller"},
84         {MATCHCRITERIA_SIZE_EQUAL,   "size_equal"},
85
86         /* content have to be read */
87         {MATCHCRITERIA_HEADER, "header"},
88         {MATCHCRITERIA_NOT_HEADER, "~header"},
89         {MATCHCRITERIA_HEADERS_PART, "headers_part"},
90         {MATCHCRITERIA_NOT_HEADERS_PART, "~headers_part"},
91         {MATCHCRITERIA_MESSAGE, "message"},
92         {MATCHCRITERIA_NOT_MESSAGE, "~message"},
93         {MATCHCRITERIA_BODY_PART, "body_part"},
94         {MATCHCRITERIA_NOT_BODY_PART, "~body_part"},
95         {MATCHCRITERIA_EXECUTE, "execute"},
96         {MATCHCRITERIA_NOT_EXECUTE, "~execute"},
97
98         /* match type */
99         {MATCHTYPE_MATCHCASE, "matchcase"},
100         {MATCHTYPE_MATCH, "match"},
101         {MATCHTYPE_REGEXPCASE, "regexpcase"},
102         {MATCHTYPE_REGEXP, "regexp"},
103
104         /* actions */
105         {MATCHACTION_SCORE, "score"},
106         {MATCHACTION_MOVE, "move"},
107         {MATCHACTION_COPY, "copy"},
108         {MATCHACTION_DELETE, "delete"},
109         {MATCHACTION_MARK, "mark"},
110         {MATCHACTION_UNMARK, "unmark"},
111         {MATCHACTION_MARK_AS_READ, "mark_as_read"},
112         {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
113         {MATCHACTION_FORWARD, "forward"},
114         {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
115         {MATCHACTION_EXECUTE, "execute"},
116         {MATCHACTION_COLOR, "color"},
117         {MATCHACTION_REDIRECT, "redirect"},
118         {MATCHACTION_DELETE_ON_SERVER, "delete_on_server"}
119 };
120
121 static GHashTable *matchparser_hashtab;
122
123 /* get_matchparser_tab_str() - used by filtering.c to translate 
124  * actions to debug strings */
125 gchar *get_matchparser_tab_str(gint id)
126 {
127         gint i;
128
129         for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
130                 if (matchparser_tab[i].id == id)
131                         return matchparser_tab[i].str;
132         }
133         return NULL;
134 }
135
136 static void create_matchparser_hashtab(void)
137 {
138         int i;
139         
140         if (matchparser_hashtab) return;
141         matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
142         for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
143                 g_hash_table_insert(matchparser_hashtab,
144                                     matchparser_tab[i].str,
145                                     &matchparser_tab[i]);
146 }
147
148 gint get_matchparser_tab_id(const gchar *str)
149 {
150         gint i;
151         MatchParser *res;
152
153         if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
154                 return res->id;
155         } else
156                 return -1;
157 }
158
159 /* matcher_escape_str() - escapes a string returns newly allocated escaped string */
160 gchar *matcher_escape_str(const gchar *str)
161 {
162         register const gchar *walk;
163         register int escape;
164         gchar *res;
165         register char *reswalk;
166
167         if (str == NULL)
168                 return NULL;
169
170         for (escape = 0, walk = str; *walk; walk++)
171                 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
172                         escape++;
173
174         if (!escape)
175                 return g_strdup(str);
176         
177         reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
178         for (walk = str; *walk; walk++, reswalk++) {
179                 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
180                         *reswalk++ = '\\';
181                 *reswalk = *walk;
182         }
183
184         *reswalk = 0;
185         return res;
186 }
187
188 /* matcher_unescape_str() - assumes that unescaping frees up room
189  * in the string, so it returns the unescaped string in the 
190  * source */
191 gchar *matcher_unescape_str(gchar *str)
192 {
193         gchar *tmp = alloca(strlen(str) + 1);
194         register gchar *src = tmp;
195         register gchar *dst = str;
196         
197         strcpy(tmp, str);
198
199         for ( ; *src; src++) {
200                 if (*src != '\\') 
201                         *dst++ = *src;
202                 else {
203                         src++;
204                         if (*src == 'n')   /* insert control characters */
205                                 *dst++ = '\n';
206                         else if (*src == 'r') 
207                                 *dst++ = '\r';
208                         else if (*src == 't') 
209                                 *dst++ = '\t';
210                         else if (*src == 'r') 
211                                 *dst++ = '\r';
212                         else if (*src == 'b')
213                                 *dst++ = '\b';
214                         else if (*src == 'f')
215                                 *dst++ = '\f';
216                         else if (*src == '\\' || *src == '\'' || *src == '\"')
217                                 /* insert \\, \' or \" */
218                                 *dst++ = *src;
219                         else {
220                                 /* FIXME: should perhaps escape character... */
221                                 src--;
222                                 *dst++ = *src;
223                         }                               
224                 }
225         }
226         *dst = 0;
227         return str;
228 }
229
230 /* **************** data structure allocation **************** */
231
232 /* matcherprop_new() - allocates a structure for one condition
233  */
234 MatcherProp *matcherprop_new(gint criteria, gchar *header,
235                               gint matchtype, gchar *expr,
236                               int value)
237 {
238         MatcherProp *prop;
239
240         prop = g_new0(MatcherProp, 1);
241         prop->criteria = criteria;
242         prop->header = header != NULL ? g_strdup(header) : NULL;
243         prop->expr = expr != NULL ? g_strdup(expr) : NULL;
244         prop->matchtype = matchtype;
245         prop->preg = NULL;
246         prop->value = value;
247         prop->error = 0;
248
249         return prop;
250 }
251
252 /* matcherprop_free()
253  */
254 void matcherprop_free(MatcherProp *prop)
255 {
256         if (prop->expr) 
257                 g_free(prop->expr);
258         if (prop->header)
259                 g_free(prop->header);
260         if (prop->preg != NULL) {
261                 regfree(prop->preg);
262                 g_free(prop->preg);
263         }
264         g_free(prop);
265 }
266
267 MatcherProp *matcherprop_copy(MatcherProp *src)
268 {
269         MatcherProp *prop = g_new0(MatcherProp, 1);
270         
271         prop->criteria = src->criteria;
272         prop->header = src->header ? g_strdup(src->header) : NULL;
273         prop->expr = src->expr ? g_strdup(src->expr) : NULL;
274         prop->matchtype = src->matchtype;
275         
276         prop->preg = NULL; /* will be re-evaluated */
277         prop->value = src->value;
278         prop->error = src->error;       
279         return prop;            
280 }
281
282 /* ****************** wrapper for file reading ************** */
283
284 MatcherProp *matcherprop_unquote_new(gint criteria, gchar *header,
285                                      gint matchtype, gchar *expr,
286                                      int value)
287 {
288         MatcherProp *prop;
289
290         if (expr != NULL)
291                 expr = matcher_unescape_str(g_strdup(expr));
292
293         if (header != NULL)
294                 header = matcher_unescape_str(g_strdup(header));
295         
296         prop = matcherprop_new(criteria, header, matchtype, expr, value);
297
298         g_free(header);
299         g_free(expr);
300
301         return prop;
302 }
303
304
305 /* ************** match ******************************/
306
307
308 /* matcherprop_string_match() - finds out if a string matches
309  * with a criterium */
310 static gboolean matcherprop_string_match(MatcherProp *prop, gchar *str)
311 {
312         gchar *str1;
313         gchar *str2;
314
315         if (str == NULL)
316                 return FALSE;
317
318         switch (prop->matchtype) {
319         case MATCHTYPE_REGEXPCASE:
320         case MATCHTYPE_REGEXP:
321                 if (!prop->preg && (prop->error == 0)) {
322                         prop->preg = g_new0(regex_t, 1);
323                         /* if regexp then don't use the escaped string */
324                         if (regcomp(prop->preg, prop->expr,
325                                     REG_NOSUB | REG_EXTENDED
326                                     | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
327                                     ? REG_ICASE : 0)) != 0) {
328                                 prop->error = 1;
329                                 g_free(prop->preg);
330                                 prop->preg = NULL;
331                         }
332                 }
333                 if (prop->preg == NULL)
334                         return FALSE;
335                 
336                 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
337                         return TRUE;
338                 else
339                         return FALSE;
340
341         case MATCHTYPE_MATCH:
342                 return (strstr(str, prop->expr) != NULL);
343
344         /* FIXME: put upper in unesc_str */
345         case MATCHTYPE_MATCHCASE:
346                 str2 = alloca(strlen(prop->expr) + 1);
347                 strcpy(str2, prop->expr);
348                 g_strup(str2);
349                 str1 = alloca(strlen(str) + 1);
350                 strcpy(str1, str);
351                 g_strup(str1);
352                 return (strstr(str1, str2) != NULL);
353                 
354         default:
355                 return FALSE;
356         }
357 }
358
359 gboolean matcherprop_match_execute(MatcherProp *prop, MsgInfo *info)
360 {
361         gchar *file;
362         gchar *cmd;
363         gint retval;
364
365         file = procmsg_get_message_file(info);
366         if (file == NULL)
367                 return FALSE;
368         g_free(file);           
369
370         cmd = matching_build_command(prop->expr, info);
371         if (cmd == NULL)
372                 return FALSE;
373
374         retval = system(cmd);
375         debug_print("Command exit code: %d\n", retval);
376
377         g_free(cmd);
378         return (retval == 0);
379 }
380
381 /* match a message and his headers, hlist can be NULL if you don't
382    want to use headers */
383
384 gboolean matcherprop_match(MatcherProp *prop, MsgInfo *info)
385 {
386         time_t t;
387
388         switch(prop->criteria) {
389         case MATCHCRITERIA_ALL:
390                 return 1;
391         case MATCHCRITERIA_UNREAD:
392                 return MSG_IS_UNREAD(info->flags);
393         case MATCHCRITERIA_NOT_UNREAD:
394                 return !MSG_IS_UNREAD(info->flags);
395         case MATCHCRITERIA_NEW:
396                 return MSG_IS_NEW(info->flags);
397         case MATCHCRITERIA_NOT_NEW:
398                 return !MSG_IS_NEW(info->flags);
399         case MATCHCRITERIA_MARKED:
400                 return MSG_IS_MARKED(info->flags);
401         case MATCHCRITERIA_NOT_MARKED:
402                 return !MSG_IS_MARKED(info->flags);
403         case MATCHCRITERIA_DELETED:
404                 return MSG_IS_DELETED(info->flags);
405         case MATCHCRITERIA_NOT_DELETED:
406                 return !MSG_IS_DELETED(info->flags);
407         case MATCHCRITERIA_REPLIED:
408                 return MSG_IS_REPLIED(info->flags);
409         case MATCHCRITERIA_NOT_REPLIED:
410                 return !MSG_IS_REPLIED(info->flags);
411         case MATCHCRITERIA_FORWARDED:
412                 return MSG_IS_FORWARDED(info->flags);
413         case MATCHCRITERIA_NOT_FORWARDED:
414                 return !MSG_IS_FORWARDED(info->flags);
415         case MATCHCRITERIA_LOCKED:
416                 return MSG_IS_LOCKED(info->flags);
417         case MATCHCRITERIA_NOT_LOCKED:
418                 return !MSG_IS_LOCKED(info->flags);
419         case MATCHCRITERIA_COLORLABEL:
420                 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value; 
421         case MATCHCRITERIA_NOT_COLORLABEL:
422                 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value; 
423         case MATCHCRITERIA_SUBJECT:
424                 return matcherprop_string_match(prop, info->subject);
425         case MATCHCRITERIA_NOT_SUBJECT:
426                 return !matcherprop_string_match(prop, info->subject);
427         case MATCHCRITERIA_FROM:
428                 return matcherprop_string_match(prop, info->from);
429         case MATCHCRITERIA_NOT_FROM:
430                 return !matcherprop_string_match(prop, info->from);
431         case MATCHCRITERIA_TO:
432                 return matcherprop_string_match(prop, info->to);
433         case MATCHCRITERIA_NOT_TO:
434                 return !matcherprop_string_match(prop, info->to);
435         case MATCHCRITERIA_CC:
436                 return matcherprop_string_match(prop, info->cc);
437         case MATCHCRITERIA_NOT_CC:
438                 return !matcherprop_string_match(prop, info->cc);
439         case MATCHCRITERIA_TO_OR_CC:
440                 return matcherprop_string_match(prop, info->to)
441                         || matcherprop_string_match(prop, info->cc);
442         case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
443                 return !(matcherprop_string_match(prop, info->to)
444                 || matcherprop_string_match(prop, info->cc));
445         case MATCHCRITERIA_AGE_GREATER:
446                 t = time(NULL);
447                 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
448         case MATCHCRITERIA_AGE_LOWER:
449                 t = time(NULL);
450                 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
451         case MATCHCRITERIA_SCORE_GREATER:
452                 return info->score >= prop->value;
453         case MATCHCRITERIA_SCORE_LOWER:
454                 return info->score <= prop->value;
455         case MATCHCRITERIA_SCORE_EQUAL:
456                 return info->score == prop->value;
457         case MATCHCRITERIA_SIZE_GREATER:
458                 /* FIXME: info->size is an off_t */
459                 return info->size > (off_t) prop->value;
460         case MATCHCRITERIA_SIZE_EQUAL:
461                 /* FIXME: info->size is an off_t */
462                 return info->size == (off_t) prop->value;
463         case MATCHCRITERIA_SIZE_SMALLER:
464                 /* FIXME: info->size is an off_t */
465                 return info->size <  (off_t) prop->value;
466         case MATCHCRITERIA_NEWSGROUPS:
467                 return matcherprop_string_match(prop, info->newsgroups);
468         case MATCHCRITERIA_NOT_NEWSGROUPS:
469                 return !matcherprop_string_match(prop, info->newsgroups);
470         case MATCHCRITERIA_INREPLYTO:
471                 return matcherprop_string_match(prop, info->inreplyto);
472         case MATCHCRITERIA_NOT_INREPLYTO:
473                 return !matcherprop_string_match(prop, info->inreplyto);
474         case MATCHCRITERIA_REFERENCES:
475                 return matcherprop_string_match(prop, info->references);
476         case MATCHCRITERIA_NOT_REFERENCES:
477                 return !matcherprop_string_match(prop, info->references);
478         case MATCHCRITERIA_EXECUTE:
479                 return matcherprop_match_execute(prop, info);
480         case MATCHCRITERIA_NOT_EXECUTE:
481                 return !matcherprop_match_execute(prop, info);
482         default:
483                 return 0;
484         }
485 }
486
487 /* ********************* MatcherList *************************** */
488
489
490 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
491 {
492         MatcherList *cond;
493
494         cond = g_new0(MatcherList, 1);
495
496         cond->matchers = matchers;
497         cond->bool_and = bool_and;
498
499         return cond;
500 }
501
502 void matcherlist_free(MatcherList *cond)
503 {
504         GSList *l;
505
506         for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
507                 matcherprop_free((MatcherProp *) l->data);
508         }
509         g_free(cond);
510 }
511
512 /*
513   skip the headers
514  */
515
516 static void matcherlist_skip_headers(FILE *fp)
517 {
518         gchar buf[BUFFSIZE];
519
520         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
521                 ;
522 }
523
524 /*
525   matcherprop_match_one_header
526   returns TRUE if buf matchs the MatchersProp criteria
527  */
528
529 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
530                                              gchar *buf)
531 {
532         gboolean result;
533         Header *header;
534
535         switch (matcher->criteria) {
536         case MATCHCRITERIA_HEADER:
537         case MATCHCRITERIA_NOT_HEADER:
538                 header = procheader_parse_header(buf);
539                 if (!header)
540                         return FALSE;
541                 if (procheader_headername_equal(header->name,
542                                                 matcher->header)) {
543                         if (matcher->criteria == MATCHCRITERIA_HEADER)
544                                 result = matcherprop_string_match(matcher, header->body);
545                         else
546                                 result = !matcherprop_string_match(matcher, header->body);
547                         procheader_header_free(header);
548                         return result;
549                 }
550                 else {
551                         procheader_header_free(header);
552                 }
553                 break;
554         case MATCHCRITERIA_HEADERS_PART:
555         case MATCHCRITERIA_MESSAGE:
556                 return matcherprop_string_match(matcher, buf);
557         case MATCHCRITERIA_NOT_MESSAGE:
558         case MATCHCRITERIA_NOT_HEADERS_PART:
559                 return !matcherprop_string_match(matcher, buf);
560         }
561         return FALSE;
562 }
563
564 /*
565   matcherprop_criteria_header
566   returns TRUE if the headers must be matched
567  */
568
569 static gboolean matcherprop_criteria_headers(MatcherProp *matcher)
570 {
571         switch (matcher->criteria) {
572         case MATCHCRITERIA_HEADER:
573         case MATCHCRITERIA_NOT_HEADER:
574         case MATCHCRITERIA_HEADERS_PART:
575         case MATCHCRITERIA_NOT_HEADERS_PART:
576                 return TRUE;
577         default:
578                 return FALSE;
579         }
580 }
581
582 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
583 {
584         switch (matcher->criteria) {
585         case MATCHCRITERIA_MESSAGE:
586         case MATCHCRITERIA_NOT_MESSAGE:
587                 return TRUE;
588         default:
589                 return FALSE;
590         }
591 }
592
593 /*
594   matcherlist_match_one_header
595   returns TRUE if match should stop
596  */
597
598 static gboolean matcherlist_match_one_header(MatcherList *matchers,
599                                              gchar *buf)
600 {
601         GSList *l;
602
603         for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
604                 MatcherProp *matcher = (MatcherProp *) l->data;
605
606                 if (matcherprop_criteria_headers(matcher) ||
607                     matcherprop_criteria_message(matcher)) {
608                         if (matcherprop_match_one_header(matcher, buf)) {
609                                 matcher->result = TRUE;
610                         }
611                 }
612
613                 if (matcherprop_criteria_headers(matcher)) {
614                         if (matcher->result) {
615                                 if (!matchers->bool_and)
616                                         return TRUE;
617                         }
618                 }
619         }
620
621         return FALSE;
622 }
623
624 /*
625   matcherlist_match_headers
626   returns TRUE if one of the headers matchs the MatcherList criteria
627  */
628
629 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
630 {
631         gchar buf[BUFFSIZE];
632
633         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
634                 if (matcherlist_match_one_header(matchers, buf))
635                         return TRUE;
636
637         return FALSE;
638 }
639
640 /*
641   matcherprop_criteria_body
642   returns TRUE if the body must be matched
643  */
644
645 static gboolean matcherprop_criteria_body(MatcherProp *matcher)
646 {
647         switch (matcher->criteria) {
648         case MATCHCRITERIA_BODY_PART:
649         case MATCHCRITERIA_NOT_BODY_PART:
650                 return TRUE;
651         default:
652                 return FALSE;
653         }
654 }
655
656 /*
657   matcherprop_match_line
658   returns TRUE if the string matchs the MatcherProp criteria
659  */
660
661 static gboolean matcherprop_match_line(MatcherProp *matcher, gchar *line)
662 {
663         switch (matcher->criteria) {
664         case MATCHCRITERIA_BODY_PART:
665         case MATCHCRITERIA_MESSAGE:
666                 return matcherprop_string_match(matcher, line);
667         case MATCHCRITERIA_NOT_BODY_PART:
668         case MATCHCRITERIA_NOT_MESSAGE:
669                 return !matcherprop_string_match(matcher, line);
670         }
671         return FALSE;
672 }
673
674 /*
675   matcherlist_match_line
676   returns TRUE if the string matchs the MatcherList criteria
677  */
678
679 static gboolean matcherlist_match_line(MatcherList *matchers, gchar *line)
680 {
681         GSList *l;
682
683         for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
684                 MatcherProp *matcher = (MatcherProp *) l->data;
685
686                 if (matcherprop_criteria_body(matcher) ||
687                     matcherprop_criteria_message(matcher)) {
688                         if (matcherprop_match_line(matcher, line)) {
689                                 matcher->result = TRUE;
690                         }
691                 }
692                         
693                 if (matcher->result) {
694                         if (!matchers->bool_and)
695                                 return TRUE;
696                 }
697         }
698         return FALSE;
699 }
700
701 /*
702   matcherlist_match_body
703   returns TRUE if one line of the body matchs the MatcherList criteria
704  */
705
706 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
707 {
708         gchar buf[BUFFSIZE];
709
710         while (fgets(buf, sizeof(buf), fp) != NULL)
711                 if (matcherlist_match_line(matchers, buf))
712                         return TRUE;
713
714         return FALSE;
715 }
716
717 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
718                                 gboolean result)
719 {
720         gboolean read_headers;
721         gboolean read_body;
722         GSList *l;
723         FILE *fp;
724         gchar *file;
725
726         /* file need to be read ? */
727
728         read_headers = FALSE;
729         read_body = FALSE;
730         for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
731                 MatcherProp *matcher = (MatcherProp *) l->data;
732
733                 if (matcherprop_criteria_headers(matcher))
734                         read_headers = TRUE;
735                 if (matcherprop_criteria_body(matcher))
736                         read_body = TRUE;
737                 if (matcherprop_criteria_message(matcher)) {
738                         read_headers = TRUE;
739                         read_body = TRUE;
740                 }
741                 matcher->result = FALSE;
742         }
743
744         if (!read_headers && !read_body)
745                 return result;
746
747         file = procmsg_get_message_file(info);
748         if (file == NULL)
749                 return FALSE;
750
751         if ((fp = fopen(file, "rb")) == NULL) {
752                 FILE_OP_ERROR(file, "fopen");
753                 g_free(file);
754                 return result;
755         }
756
757         /* read the headers */
758
759         if (read_headers) {
760                 if (matcherlist_match_headers(matchers, fp))
761                         read_body = FALSE;
762         }
763         else {
764                 matcherlist_skip_headers(fp);
765         }
766
767         /* read the body */
768         if (read_body) {
769                 matcherlist_match_body(matchers, fp);
770         }
771         
772         for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
773                 MatcherProp *matcher = (MatcherProp *) l->data;
774
775                 if (matcherprop_criteria_headers(matcher) ||
776                     matcherprop_criteria_body(matcher)    ||
777                     matcherprop_criteria_message(matcher)) {
778                         if (matcher->result) {
779                                 if (!matchers->bool_and) {
780                                         result = TRUE;
781                                         break;
782                                 }
783                         }
784                         else {
785                                 if (matchers->bool_and) {
786                                         result = FALSE;
787                                         break;
788                                 }
789                         }
790                 }                       
791         }
792
793         g_free(file);
794
795         fclose(fp);
796         
797         return result;
798 }
799
800 /* test a list of condition */
801
802 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
803 {
804         GSList *l;
805         gboolean result;
806
807         if (matchers->bool_and)
808                 result = TRUE;
809         else
810                 result = FALSE;
811
812         /* test the cached elements */
813
814         for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
815                 MatcherProp *matcher = (MatcherProp *) l->data;
816
817                 switch(matcher->criteria) {
818                 case MATCHCRITERIA_ALL:
819                 case MATCHCRITERIA_UNREAD:
820                 case MATCHCRITERIA_NOT_UNREAD:
821                 case MATCHCRITERIA_NEW:
822                 case MATCHCRITERIA_NOT_NEW:
823                 case MATCHCRITERIA_MARKED:
824                 case MATCHCRITERIA_NOT_MARKED:
825                 case MATCHCRITERIA_DELETED:
826                 case MATCHCRITERIA_NOT_DELETED:
827                 case MATCHCRITERIA_REPLIED:
828                 case MATCHCRITERIA_NOT_REPLIED:
829                 case MATCHCRITERIA_FORWARDED:
830                 case MATCHCRITERIA_NOT_FORWARDED:
831                 case MATCHCRITERIA_LOCKED:
832                 case MATCHCRITERIA_NOT_LOCKED:
833                 case MATCHCRITERIA_COLORLABEL:
834                 case MATCHCRITERIA_NOT_COLORLABEL:
835                 case MATCHCRITERIA_SUBJECT:
836                 case MATCHCRITERIA_NOT_SUBJECT:
837                 case MATCHCRITERIA_FROM:
838                 case MATCHCRITERIA_NOT_FROM:
839                 case MATCHCRITERIA_TO:
840                 case MATCHCRITERIA_NOT_TO:
841                 case MATCHCRITERIA_CC:
842                 case MATCHCRITERIA_NOT_CC:
843                 case MATCHCRITERIA_TO_OR_CC:
844                 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
845                 case MATCHCRITERIA_AGE_GREATER:
846                 case MATCHCRITERIA_AGE_LOWER:
847                 case MATCHCRITERIA_NEWSGROUPS:
848                 case MATCHCRITERIA_NOT_NEWSGROUPS:
849                 case MATCHCRITERIA_INREPLYTO:
850                 case MATCHCRITERIA_NOT_INREPLYTO:
851                 case MATCHCRITERIA_REFERENCES:
852                 case MATCHCRITERIA_NOT_REFERENCES:
853                 case MATCHCRITERIA_SCORE_GREATER:
854                 case MATCHCRITERIA_SCORE_LOWER:
855                 case MATCHCRITERIA_SCORE_EQUAL:
856                 case MATCHCRITERIA_SIZE_GREATER:
857                 case MATCHCRITERIA_SIZE_SMALLER:
858                 case MATCHCRITERIA_SIZE_EQUAL:
859                 case MATCHCRITERIA_EXECUTE:
860                 case MATCHCRITERIA_NOT_EXECUTE:
861                         if (matcherprop_match(matcher, info)) {
862                                 if (!matchers->bool_and) {
863                                         return TRUE;
864                                 }
865                         }
866                         else {
867                                 if (matchers->bool_and) {
868                                         return FALSE;
869                                 }
870                         }
871                 }
872         }
873
874         /* test the condition on the file */
875
876         if (matcherlist_match_file(matchers, info, result)) {
877                 if (!matchers->bool_and)
878                         return TRUE;
879         }
880         else {
881                 if (matchers->bool_and)
882                         return FALSE;
883         }
884
885         return result;
886 }
887
888
889 gchar *matcherprop_to_string(MatcherProp *matcher)
890 {
891         gchar *matcher_str = NULL;
892         gchar *criteria_str;
893         gchar *matchtype_str;
894         int i;
895         char *expr;
896         char *header;
897
898         criteria_str = NULL;
899         for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
900                 if (matchparser_tab[i].id == matcher->criteria)
901                         criteria_str = matchparser_tab[i].str;
902         }
903         if (criteria_str == NULL)
904                 return NULL;
905
906         switch (matcher->criteria) {
907         case MATCHCRITERIA_AGE_GREATER:
908         case MATCHCRITERIA_AGE_LOWER:
909         case MATCHCRITERIA_SCORE_GREATER:
910         case MATCHCRITERIA_SCORE_LOWER:
911         case MATCHCRITERIA_SCORE_EQUAL:
912         case MATCHCRITERIA_SIZE_GREATER:
913         case MATCHCRITERIA_SIZE_SMALLER:
914         case MATCHCRITERIA_SIZE_EQUAL:
915         case MATCHCRITERIA_COLORLABEL:
916         case MATCHCRITERIA_NOT_COLORLABEL:
917                 return g_strdup_printf("%s %i", criteria_str, matcher->value);
918         case MATCHCRITERIA_ALL:
919         case MATCHCRITERIA_UNREAD:
920         case MATCHCRITERIA_NOT_UNREAD:
921         case MATCHCRITERIA_NEW:
922         case MATCHCRITERIA_NOT_NEW:
923         case MATCHCRITERIA_MARKED:
924         case MATCHCRITERIA_NOT_MARKED:
925         case MATCHCRITERIA_DELETED:
926         case MATCHCRITERIA_NOT_DELETED:
927         case MATCHCRITERIA_REPLIED:
928         case MATCHCRITERIA_NOT_REPLIED:
929         case MATCHCRITERIA_FORWARDED:
930         case MATCHCRITERIA_NOT_FORWARDED:
931         case MATCHCRITERIA_LOCKED:
932         case MATCHCRITERIA_NOT_LOCKED:
933                 return g_strdup(criteria_str);
934         case MATCHCRITERIA_EXECUTE:
935         case MATCHCRITERIA_NOT_EXECUTE:
936                 expr = matcher_escape_str(matcher->expr);
937                 matcher_str = g_strdup_printf("%s \"%s\"", criteria_str, expr);
938                 g_free(expr);
939                 return matcher_str;
940         }
941
942         matchtype_str = NULL;
943         for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
944                 if (matchparser_tab[i].id == matcher->matchtype)
945                         matchtype_str = matchparser_tab[i].str;
946         }
947
948         if (matchtype_str == NULL)
949                 return NULL;
950
951         switch (matcher->matchtype) {
952         case MATCHTYPE_MATCH:
953         case MATCHTYPE_MATCHCASE:
954         case MATCHTYPE_REGEXP:
955         case MATCHTYPE_REGEXPCASE:
956                 expr = matcher_escape_str(matcher->expr);
957                 header = matcher_escape_str(matcher->header);
958                 if (matcher->header)
959                         matcher_str = g_strdup_printf
960                                         ("%s \"%s\" %s \"%s\"",
961                                          criteria_str, matcher->header,
962                                          matchtype_str, expr);
963                 else
964                         matcher_str = g_strdup_printf
965                                         ("%s %s \"%s\"", criteria_str,
966                                          matchtype_str, expr);
967                 break;
968                 g_free(header);
969                 g_free(expr);
970         }
971
972         return matcher_str;
973 }
974
975 gchar *matcherlist_to_string(MatcherList *matchers)
976 {
977         gint count;
978         gchar **vstr;
979         GSList *l;
980         gchar **cur_str;
981         gchar *result = NULL;
982
983         count = g_slist_length(matchers->matchers);
984         vstr = g_new(gchar *, count + 1);
985
986         for (l = matchers->matchers, cur_str = vstr; l != NULL;
987              l = g_slist_next(l), cur_str ++) {
988                 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
989                 if (*cur_str == NULL)
990                         break;
991         }
992         *cur_str = NULL;
993         
994         if (matchers->bool_and)
995                 result = g_strjoinv(" & ", vstr);
996         else
997                 result = g_strjoinv(" | ", vstr);
998
999         for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1000                 g_free(*cur_str);
1001         g_free(vstr);
1002
1003         return result;
1004 }
1005
1006 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1007 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1008 /* matching_build_command() - preferably cmd should be unescaped */
1009 gchar *matching_build_command(gchar *cmd, MsgInfo *info)
1010 {
1011         gchar *s = cmd;
1012         gchar *filename = NULL;
1013         gchar *processed_cmd;
1014         gchar *p;
1015         gint size;
1016
1017         const gchar *const no_subject    = _("(none)") ;
1018         const gchar *const no_from       = _("(none)") ;
1019         const gchar *const no_to         = _("(none)") ;
1020         const gchar *const no_cc         = _("(none)") ;
1021         const gchar *const no_date       = _("(none)") ;
1022         const gchar *const no_msgid      = _("(none)") ;
1023         const gchar *const no_newsgroups = _("(none)") ;
1024         const gchar *const no_references = _("(none)") ;
1025
1026         size = STRLEN_ZERO(cmd) + 1;
1027         while (*s != '\0') {
1028                 if (*s == '%') {
1029                         s++;
1030                         switch (*s) {
1031                         case '%':
1032                                 size -= 1;
1033                                 break;
1034                         case 's': /* subject */
1035                                 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1036                                 break;
1037                         case 'f': /* from */
1038                                 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1039                                 break;
1040                         case 't': /* to */
1041                                 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1042                                 break;
1043                         case 'c': /* cc */
1044                                 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1045                                 break;
1046                         case 'd': /* date */
1047                                 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1048                                 break;
1049                         case 'i': /* message-id */
1050                                 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1051                                 break;
1052                         case 'n': /* newsgroups */
1053                                 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1054                                 break;
1055                         case 'r': /* references */
1056                                 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1057                                 break;
1058                         case 'F': /* file */
1059                                 filename = folder_item_fetch_msg(info->folder,
1060                                                                  info->msgnum);
1061                                 
1062                                 if (filename == NULL) {
1063                                         g_warning("filename is not set");
1064                                         return NULL;
1065                                 }
1066                                 else
1067                                         size += strlen(filename) - 2;
1068                                 break;
1069                         }
1070                         s++;
1071                 }
1072                 else s++;
1073         }
1074
1075         processed_cmd = g_new0(gchar, size);
1076         s = cmd;
1077         p = processed_cmd;
1078
1079         while (*s != '\0') {
1080                 if (*s == '%') {
1081                         s++;
1082                         switch (*s) {
1083                         case '%':
1084                                 *p = '%';
1085                                 p++;
1086                                 break;
1087                         case 's': /* subject */
1088                                 if (info->subject != NULL)
1089                                         strcpy(p, info->subject);
1090                                 else
1091                                         strcpy(p, no_subject);
1092                                 p += strlen(p);
1093                                 break;
1094                         case 'f': /* from */
1095                                 if (info->from != NULL)
1096                                         strcpy(p, info->from);
1097                                 else
1098                                         strcpy(p, no_from);
1099                                 p += strlen(p);
1100                                 break;
1101                         case 't': /* to */
1102                                 if (info->to != NULL)
1103                                         strcpy(p, info->to);
1104                                 else
1105                                         strcpy(p, no_to);
1106                                 p += strlen(p);
1107                                 break;
1108                         case 'c': /* cc */
1109                                 if (info->cc != NULL)
1110                                         strcpy(p, info->cc);
1111                                 else
1112                                         strcpy(p, no_cc);
1113                                 p += strlen(p);
1114                                 break;
1115                         case 'd': /* date */
1116                                 if (info->date != NULL)
1117                                         strcpy(p, info->date);
1118                                 else
1119                                         strcpy(p, no_date);
1120                                 p += strlen(p);
1121                                 break;
1122                         case 'i': /* message-id */
1123                                 if (info->msgid != NULL)
1124                                         strcpy(p, info->msgid);
1125                                 else
1126                                         strcpy(p, no_msgid);
1127                                 p += strlen(p);
1128                                 break;
1129                         case 'n': /* newsgroups */
1130                                 if (info->newsgroups != NULL)
1131                                         strcpy(p, info->newsgroups);
1132                                 else
1133                                         strcpy(p, no_newsgroups);
1134                                 p += strlen(p);
1135                                 break;
1136                         case 'r': /* references */
1137                                 if (info->references != NULL)
1138                                         strcpy(p, info->references);
1139                                 else
1140                                         strcpy(p, no_references);
1141                                 p += strlen(p);
1142                                 break;
1143                         case 'F': /* file */
1144                                 strcpy(p, filename);
1145                                 p += strlen(p);
1146                                 g_free(filename);
1147                                 break;
1148                         default:
1149                                 *p = '%';
1150                                 p++;
1151                                 *p = *s;
1152                                 p++;
1153                                 break;
1154                         }
1155                         s++;
1156                 }
1157                 else {
1158                         *p = *s;
1159                         p++;
1160                         s++;
1161                 }
1162         }
1163
1164         return processed_cmd;
1165 }
1166 #undef STRLEN_DEFAULT
1167 #undef STRLEN_ZERO
1168
1169 /* ************************************************************ */
1170
1171 static void prefs_scoring_write(FILE *fp, GSList *prefs_scoring)
1172 {
1173         GSList *cur;
1174
1175         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1176                 gchar *scoring_str;
1177                 ScoringProp *prop;
1178
1179                 prop = (ScoringProp *) cur->data;
1180                 scoring_str = scoringprop_to_string(prop);
1181                 if (fputs(scoring_str, fp) == EOF ||
1182                     fputc('\n', fp) == EOF) {
1183                         FILE_OP_ERROR("scoring config", "fputs || fputc");
1184                         g_free(scoring_str);
1185                         return;
1186                 }
1187                 g_free(scoring_str);
1188         }
1189 }
1190
1191 static void prefs_filtering_write(FILE *fp, GSList *prefs_scoring)
1192 {
1193         GSList *cur;
1194
1195         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1196                 gchar *filtering_str;
1197                 FilteringProp *prop;
1198
1199                 if (NULL == (prop = (FilteringProp *) cur->data))
1200                         continue;
1201                 
1202                 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1203                         continue;
1204                 
1205                 if (fputs(filtering_str, fp) == EOF ||
1206                     fputc('\n', fp) == EOF) {
1207                         FILE_OP_ERROR("filtering config", "fputs || fputc");
1208                         g_free(filtering_str);
1209                         return;
1210                 }
1211                 g_free(filtering_str);
1212         }
1213 }
1214
1215 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1216 {
1217         FolderItem *item;
1218         FILE *fp = data;
1219         gchar *id;
1220         GSList *prefs_scoring;
1221         GSList *prefs_filtering;
1222
1223         if (node != NULL) {
1224                 item = node->data;
1225                 /* prevent warning */
1226                 if (item->path == NULL)
1227                         return FALSE;
1228                 id = folder_item_get_identifier(item);
1229                 if (id == NULL)
1230                         return FALSE;
1231                 prefs_scoring = item->prefs->scoring;
1232                 prefs_filtering = item->prefs->processing;
1233         }
1234         else {
1235                 item = NULL;
1236                 id = g_strdup("global"); /* because it is g_freed */
1237                 prefs_scoring = global_scoring;
1238                 prefs_filtering = global_processing;
1239         }
1240
1241         if (prefs_filtering != NULL || prefs_scoring != NULL) {
1242                 fprintf(fp, "[%s]\n", id);
1243
1244                 prefs_filtering_write(fp, prefs_filtering);
1245                 prefs_scoring_write(fp, prefs_scoring);
1246
1247                 fputc('\n', fp);
1248         }
1249
1250         g_free(id);
1251
1252         return FALSE;
1253 }
1254
1255 static void prefs_matcher_save(FILE *fp)
1256 {
1257         GList *cur;
1258
1259         for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1260                 Folder *folder;
1261
1262                 folder = (Folder *) cur->data;
1263                 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1264                                 prefs_matcher_write_func, fp);
1265         }
1266         prefs_matcher_write_func(NULL, fp);
1267 }
1268
1269
1270 void prefs_matcher_write_config(void)
1271 {
1272         gchar *rcpath;
1273         PrefFile *pfile;
1274
1275         debug_print("Writing matcher configuration...\n");
1276
1277         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1278                              MATCHER_RC, NULL);
1279
1280         if ((pfile = prefs_write_open(rcpath)) == NULL) {
1281                 g_warning("failed to write configuration to file\n");
1282                 g_free(rcpath);
1283                 return;
1284         }
1285
1286
1287         prefs_matcher_save(pfile->fp);
1288
1289         g_free(rcpath);
1290
1291         if (prefs_write_close(pfile) < 0) {
1292                 g_warning("failed to write configuration to file\n");
1293                 return;
1294         }
1295 }
1296
1297 /* ******************************************************************* */
1298
1299 void prefs_matcher_read_config(void)
1300 {
1301         gchar *rcpath;
1302         FILE *f;
1303
1304         create_matchparser_hashtab();
1305         prefs_scoring_clear();
1306         prefs_filtering_clear();
1307
1308         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1309         f = fopen(rcpath, "rb");
1310         g_free(rcpath);
1311
1312         if (f != NULL) {
1313                 matcher_parser_start_parsing(f);
1314                 fclose(f);
1315         }
1316         else {
1317                 /* previous version compatibily */
1318
1319                 /* printf("reading filtering\n"); */
1320                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1321                                      FILTERING_RC, NULL);
1322                 f = fopen(rcpath, "rb");
1323                 g_free(rcpath);
1324                 
1325                 if (f != NULL) {
1326                         matcher_parser_start_parsing(f);
1327                         fclose(matcher_parserin);
1328                 }
1329                 
1330                 /* printf("reading scoring\n"); */
1331                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1332                                      SCORING_RC, NULL);
1333                 f = fopen(rcpath, "rb");
1334                 g_free(rcpath);
1335                 
1336                 if (f != NULL) {
1337                         matcher_parser_start_parsing(f);
1338                         fclose(matcher_parserin);
1339                 }
1340         }
1341 }