2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
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.
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.
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.
26 #include "procheader.h"
29 #include "matcher_parser.h"
30 #include "prefs_gtk.h"
33 *\brief Keyword lookup element
36 gint id; /*!< keyword id */
37 gchar *str; /*!< keyword */
39 typedef struct _MatchParser MatchParser;
42 *\brief Table with strings and ids used by the lexer and
43 * the parser. New keywords can be added here.
45 static const MatchParser matchparser_tab[] = {
47 {MATCHCRITERIA_ALL, "all"},
48 {MATCHCRITERIA_UNREAD, "unread"},
49 {MATCHCRITERIA_NOT_UNREAD, "~unread"},
50 {MATCHCRITERIA_NEW, "new"},
51 {MATCHCRITERIA_NOT_NEW, "~new"},
52 {MATCHCRITERIA_MARKED, "marked"},
53 {MATCHCRITERIA_NOT_MARKED, "~marked"},
54 {MATCHCRITERIA_DELETED, "deleted"},
55 {MATCHCRITERIA_NOT_DELETED, "~deleted"},
56 {MATCHCRITERIA_REPLIED, "replied"},
57 {MATCHCRITERIA_NOT_REPLIED, "~replied"},
58 {MATCHCRITERIA_FORWARDED, "forwarded"},
59 {MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
60 {MATCHCRITERIA_LOCKED, "locked"},
61 {MATCHCRITERIA_NOT_LOCKED, "~locked"},
62 {MATCHCRITERIA_COLORLABEL, "colorlabel"},
63 {MATCHCRITERIA_NOT_COLORLABEL, "~colorlabel"},
64 {MATCHCRITERIA_IGNORE_THREAD, "ignore_thread"},
65 {MATCHCRITERIA_NOT_IGNORE_THREAD, "~ignore_thread"},
68 {MATCHCRITERIA_SUBJECT, "subject"},
69 {MATCHCRITERIA_NOT_SUBJECT, "~subject"},
70 {MATCHCRITERIA_FROM, "from"},
71 {MATCHCRITERIA_NOT_FROM, "~from"},
72 {MATCHCRITERIA_TO, "to"},
73 {MATCHCRITERIA_NOT_TO, "~to"},
74 {MATCHCRITERIA_CC, "cc"},
75 {MATCHCRITERIA_NOT_CC, "~cc"},
76 {MATCHCRITERIA_TO_OR_CC, "to_or_cc"},
77 {MATCHCRITERIA_NOT_TO_AND_NOT_CC, "~to_or_cc"},
78 {MATCHCRITERIA_AGE_GREATER, "age_greater"},
79 {MATCHCRITERIA_AGE_LOWER, "age_lower"},
80 {MATCHCRITERIA_NEWSGROUPS, "newsgroups"},
81 {MATCHCRITERIA_NOT_NEWSGROUPS, "~newsgroups"},
82 {MATCHCRITERIA_INREPLYTO, "inreplyto"},
83 {MATCHCRITERIA_NOT_INREPLYTO, "~inreplyto"},
84 {MATCHCRITERIA_REFERENCES, "references"},
85 {MATCHCRITERIA_NOT_REFERENCES, "~references"},
86 {MATCHCRITERIA_SCORE_GREATER, "score_greater"},
87 {MATCHCRITERIA_SCORE_LOWER, "score_lower"},
88 {MATCHCRITERIA_SCORE_EQUAL, "score_equal"},
90 {MATCHCRITERIA_SIZE_GREATER, "size_greater"},
91 {MATCHCRITERIA_SIZE_SMALLER, "size_smaller"},
92 {MATCHCRITERIA_SIZE_EQUAL, "size_equal"},
94 /* content have to be read */
95 {MATCHCRITERIA_HEADER, "header"},
96 {MATCHCRITERIA_NOT_HEADER, "~header"},
97 {MATCHCRITERIA_HEADERS_PART, "headers_part"},
98 {MATCHCRITERIA_NOT_HEADERS_PART, "~headers_part"},
99 {MATCHCRITERIA_MESSAGE, "message"},
100 {MATCHCRITERIA_NOT_MESSAGE, "~message"},
101 {MATCHCRITERIA_BODY_PART, "body_part"},
102 {MATCHCRITERIA_NOT_BODY_PART, "~body_part"},
103 {MATCHCRITERIA_EXECUTE, "execute"},
104 {MATCHCRITERIA_NOT_EXECUTE, "~execute"},
107 {MATCHTYPE_MATCHCASE, "matchcase"},
108 {MATCHTYPE_MATCH, "match"},
109 {MATCHTYPE_REGEXPCASE, "regexpcase"},
110 {MATCHTYPE_REGEXP, "regexp"},
113 {MATCHACTION_SCORE, "score"},
114 {MATCHACTION_MOVE, "move"},
115 {MATCHACTION_COPY, "copy"},
116 {MATCHACTION_DELETE, "delete"},
117 {MATCHACTION_MARK, "mark"},
118 {MATCHACTION_UNMARK, "unmark"},
119 {MATCHACTION_MARK_AS_READ, "mark_as_read"},
120 {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
121 {MATCHACTION_FORWARD, "forward"},
122 {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
123 {MATCHACTION_EXECUTE, "execute"},
124 {MATCHACTION_COLOR, "color"},
125 {MATCHACTION_REDIRECT, "redirect"},
126 {MATCHACTION_DELETE_ON_SERVER, "delete_on_server"},
127 {MATCHACTION_CHANGE_SCORE, "change_score"}
131 *\brief Look up table with keywords defined in \sa matchparser_tab
133 static GHashTable *matchparser_hashtab;
136 *\brief Translate keyword id to keyword string
138 *\param id Id of keyword
140 *\return const gchar * Keyword
142 const gchar *get_matchparser_tab_str(gint id)
146 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
147 if (matchparser_tab[i].id == id)
148 return matchparser_tab[i].str;
154 *\brief Create keyword lookup table
156 static void create_matchparser_hashtab(void)
160 if (matchparser_hashtab) return;
161 matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
162 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
163 g_hash_table_insert(matchparser_hashtab,
164 matchparser_tab[i].str,
165 (gpointer) &matchparser_tab[i]);
169 *\brief Return a keyword id from a keyword string
171 *\param str Keyword string
173 *\return gint Keyword id
175 gint get_matchparser_tab_id(const gchar *str)
179 if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
186 *\brief Escape characters in a string by inserting '\' characters
188 *\param str String with characters to be escaped
190 *\return gchar * Newly allocated string with escaped characters
192 gchar *matcher_escape_str(const gchar *str)
194 register const gchar *walk;
197 register char *reswalk;
202 for (escape = 0, walk = str; *walk; walk++)
203 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
207 return g_strdup(str);
209 reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
210 for (walk = str; *walk; walk++, reswalk++) {
211 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
221 *\brief Unescape string by replacing escaped char sequences
222 * (\b, \n, etc) by their actual char. Note that this
223 * function changes the contents of the buffer pointed
226 *\param str Buffer containing string that needs to be escaped.
227 * Note that this function changes the contents of the
230 *\return gchar * Pointer to changed buffer
232 gchar *matcher_unescape_str(gchar *str)
234 gchar *tmp = alloca(strlen(str) + 1);
235 register gchar *src = tmp;
236 register gchar *dst = str;
240 for ( ; *src; src++) {
245 if (*src == 'n') /* insert control characters */
247 else if (*src == 'r')
249 else if (*src == 't')
251 else if (*src == 'r')
253 else if (*src == 'b')
255 else if (*src == 'f')
257 else if (*src == '\\' || *src == '\'' || *src == '\"')
258 /* insert \\, \' or \" */
261 /* FIXME: should perhaps escape character... */
271 /* **************** data structure allocation **************** */
274 *\brief Allocate a structure for a filtering / scoring
275 * "condition" (a matcher structure)
277 *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
278 *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
279 *\param matchtype Type of action (MATCHTYPE_XXX)
280 *\param expr String value or expression to check
281 *\param value Integer value to check
283 *\return MatcherProp * Pointer to newly allocated structure
285 MatcherProp *matcherprop_new(gint criteria, const gchar *header,
286 gint matchtype, const gchar *expr,
291 prop = g_new0(MatcherProp, 1);
292 prop->criteria = criteria;
293 prop->header = header != NULL ? g_strdup(header) : NULL;
294 prop->expr = expr != NULL ? g_strdup(expr) : NULL;
295 prop->matchtype = matchtype;
304 *\brief Free a matcher structure
306 *\param prop Pointer to matcher structure allocated with
309 void matcherprop_free(MatcherProp *prop)
314 g_free(prop->header);
315 if (prop->preg != NULL) {
323 *\brief Copy a matcher structure
325 *\param src Matcher structure to copy
327 *\return MatcherProp * Pointer to newly allocated matcher structure
329 MatcherProp *matcherprop_copy(const MatcherProp *src)
331 MatcherProp *prop = g_new0(MatcherProp, 1);
333 prop->criteria = src->criteria;
334 prop->header = src->header ? g_strdup(src->header) : NULL;
335 prop->expr = src->expr ? g_strdup(src->expr) : NULL;
336 prop->matchtype = src->matchtype;
338 prop->preg = NULL; /* will be re-evaluated */
339 prop->value = src->value;
340 prop->error = src->error;
344 /* ****************** wrapper for file reading ************** */
347 *\brief Allocate a matcher structure where all strings
348 * are unescaped ("unquoted")
350 *\param criteria One of the MATCHCRITERIA_XXX constants
351 *\param header A header string
352 *\param matchtype Type of matcher (MATCHTYPE_XXX)
353 *\param expr Matcher string expression
354 *\param value Matcher integer value
356 *\return MatcherProp * Pointer to newly allocated matcher
359 MatcherProp *matcherprop_unquote_new(gint criteria, const gchar *header,
360 gint matchtype, const gchar *expr,
366 expr = matcher_unescape_str(g_strdup(expr));
369 header = matcher_unescape_str(g_strdup(header));
371 prop = matcherprop_new(criteria, header, matchtype, expr, value);
373 g_free((gpointer) header);
374 g_free((gpointer) expr);
380 /* ************** match ******************************/
383 *\brief Find out if a string matches a condition
385 *\param prop Matcher structure
386 *\param str String to check
388 *\return gboolean TRUE if str matches the condition in the
391 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
399 switch (prop->matchtype) {
400 case MATCHTYPE_REGEXPCASE:
401 case MATCHTYPE_REGEXP:
402 if (!prop->preg && (prop->error == 0)) {
403 prop->preg = g_new0(regex_t, 1);
404 /* if regexp then don't use the escaped string */
405 if (regcomp(prop->preg, prop->expr,
406 REG_NOSUB | REG_EXTENDED
407 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
408 ? REG_ICASE : 0)) != 0) {
414 if (prop->preg == NULL)
417 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
422 case MATCHTYPE_MATCH:
423 return (strstr(str, prop->expr) != NULL);
425 /* FIXME: put upper in unesc_str */
426 case MATCHTYPE_MATCHCASE:
427 str2 = alloca(strlen(prop->expr) + 1);
428 strcpy(str2, prop->expr);
430 str1 = alloca(strlen(str) + 1);
433 return (strstr(str1, str2) != NULL);
441 *\brief Execute a command defined in the matcher structure
443 *\param prop Pointer to matcher structure
444 *\param info Pointer to message info structure
446 *\return gboolean TRUE if command was executed succesfully
448 static gboolean matcherprop_match_execute(const MatcherProp *prop,
455 file = procmsg_get_message_file(info);
460 cmd = matching_build_command(prop->expr, info);
464 retval = system(cmd);
465 debug_print("Command exit code: %d\n", retval);
468 return (retval == 0);
472 *\brief Check if a message matches the condition in a matcher
475 *\param prop Pointer to matcher structure
476 *\param info Pointer to message info
478 *\return gboolean TRUE if a match
480 gboolean matcherprop_match(MatcherProp *prop,
485 switch(prop->criteria) {
486 case MATCHCRITERIA_ALL:
488 case MATCHCRITERIA_UNREAD:
489 return MSG_IS_UNREAD(info->flags);
490 case MATCHCRITERIA_NOT_UNREAD:
491 return !MSG_IS_UNREAD(info->flags);
492 case MATCHCRITERIA_NEW:
493 return MSG_IS_NEW(info->flags);
494 case MATCHCRITERIA_NOT_NEW:
495 return !MSG_IS_NEW(info->flags);
496 case MATCHCRITERIA_MARKED:
497 return MSG_IS_MARKED(info->flags);
498 case MATCHCRITERIA_NOT_MARKED:
499 return !MSG_IS_MARKED(info->flags);
500 case MATCHCRITERIA_DELETED:
501 return MSG_IS_DELETED(info->flags);
502 case MATCHCRITERIA_NOT_DELETED:
503 return !MSG_IS_DELETED(info->flags);
504 case MATCHCRITERIA_REPLIED:
505 return MSG_IS_REPLIED(info->flags);
506 case MATCHCRITERIA_NOT_REPLIED:
507 return !MSG_IS_REPLIED(info->flags);
508 case MATCHCRITERIA_FORWARDED:
509 return MSG_IS_FORWARDED(info->flags);
510 case MATCHCRITERIA_NOT_FORWARDED:
511 return !MSG_IS_FORWARDED(info->flags);
512 case MATCHCRITERIA_LOCKED:
513 return MSG_IS_LOCKED(info->flags);
514 case MATCHCRITERIA_NOT_LOCKED:
515 return !MSG_IS_LOCKED(info->flags);
516 case MATCHCRITERIA_COLORLABEL:
517 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
518 case MATCHCRITERIA_NOT_COLORLABEL:
519 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
520 case MATCHCRITERIA_IGNORE_THREAD:
521 return MSG_IS_IGNORE_THREAD(info->flags);
522 case MATCHCRITERIA_NOT_IGNORE_THREAD:
523 return !MSG_IS_IGNORE_THREAD(info->flags);
524 case MATCHCRITERIA_SUBJECT:
525 return matcherprop_string_match(prop, info->subject);
526 case MATCHCRITERIA_NOT_SUBJECT:
527 return !matcherprop_string_match(prop, info->subject);
528 case MATCHCRITERIA_FROM:
529 return matcherprop_string_match(prop, info->from);
530 case MATCHCRITERIA_NOT_FROM:
531 return !matcherprop_string_match(prop, info->from);
532 case MATCHCRITERIA_TO:
533 return matcherprop_string_match(prop, info->to);
534 case MATCHCRITERIA_NOT_TO:
535 return !matcherprop_string_match(prop, info->to);
536 case MATCHCRITERIA_CC:
537 return matcherprop_string_match(prop, info->cc);
538 case MATCHCRITERIA_NOT_CC:
539 return !matcherprop_string_match(prop, info->cc);
540 case MATCHCRITERIA_TO_OR_CC:
541 return matcherprop_string_match(prop, info->to)
542 || matcherprop_string_match(prop, info->cc);
543 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
544 return !(matcherprop_string_match(prop, info->to)
545 || matcherprop_string_match(prop, info->cc));
546 case MATCHCRITERIA_AGE_GREATER:
548 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
549 case MATCHCRITERIA_AGE_LOWER:
551 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
552 case MATCHCRITERIA_SCORE_GREATER:
553 return info->score >= prop->value;
554 case MATCHCRITERIA_SCORE_LOWER:
555 return info->score <= prop->value;
556 case MATCHCRITERIA_SCORE_EQUAL:
557 return info->score == prop->value;
558 case MATCHCRITERIA_SIZE_GREATER:
559 /* FIXME: info->size is an off_t */
560 return info->size > (off_t) prop->value;
561 case MATCHCRITERIA_SIZE_EQUAL:
562 /* FIXME: info->size is an off_t */
563 return info->size == (off_t) prop->value;
564 case MATCHCRITERIA_SIZE_SMALLER:
565 /* FIXME: info->size is an off_t */
566 return info->size < (off_t) prop->value;
567 case MATCHCRITERIA_NEWSGROUPS:
568 return matcherprop_string_match(prop, info->newsgroups);
569 case MATCHCRITERIA_NOT_NEWSGROUPS:
570 return !matcherprop_string_match(prop, info->newsgroups);
571 case MATCHCRITERIA_INREPLYTO:
572 return matcherprop_string_match(prop, info->inreplyto);
573 case MATCHCRITERIA_NOT_INREPLYTO:
574 return !matcherprop_string_match(prop, info->inreplyto);
575 case MATCHCRITERIA_REFERENCES:
576 return matcherprop_string_match(prop, info->references);
577 case MATCHCRITERIA_NOT_REFERENCES:
578 return !matcherprop_string_match(prop, info->references);
579 case MATCHCRITERIA_EXECUTE:
580 return matcherprop_match_execute(prop, info);
581 case MATCHCRITERIA_NOT_EXECUTE:
582 return !matcherprop_match_execute(prop, info);
588 /* ********************* MatcherList *************************** */
591 *\brief Create a new list of matchers
593 *\param matchers List of matcher structures
594 *\param bool_and Operator
596 *\return MatcherList * New list
598 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
602 cond = g_new0(MatcherList, 1);
604 cond->matchers = matchers;
605 cond->bool_and = bool_and;
611 *\brief Frees a list of matchers
613 *\param cond List of matchers
615 void matcherlist_free(MatcherList *cond)
619 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
620 matcherprop_free((MatcherProp *) l->data);
626 *\brief Skip all headers in a message file
628 *\param fp Message file
630 static void matcherlist_skip_headers(FILE *fp)
634 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
639 *\brief Check if a header matches a matcher condition
641 *\param matcher Matcher structure to check header for
642 *\param buf Header name
644 *\return boolean TRUE if matching header
646 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
652 switch (matcher->criteria) {
653 case MATCHCRITERIA_HEADER:
654 case MATCHCRITERIA_NOT_HEADER:
655 header = procheader_parse_header(buf);
658 if (procheader_headername_equal(header->name,
660 if (matcher->criteria == MATCHCRITERIA_HEADER)
661 result = matcherprop_string_match(matcher, header->body);
663 result = !matcherprop_string_match(matcher, header->body);
664 procheader_header_free(header);
668 procheader_header_free(header);
671 case MATCHCRITERIA_HEADERS_PART:
672 case MATCHCRITERIA_MESSAGE:
673 return matcherprop_string_match(matcher, buf);
674 case MATCHCRITERIA_NOT_MESSAGE:
675 case MATCHCRITERIA_NOT_HEADERS_PART:
676 return !matcherprop_string_match(matcher, buf);
682 *\brief Check if the matcher structure wants headers to
685 *\param matcher Matcher structure
687 *\return gboolean TRUE if the matcher structure describes
688 * a header match condition
690 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
692 switch (matcher->criteria) {
693 case MATCHCRITERIA_HEADER:
694 case MATCHCRITERIA_NOT_HEADER:
695 case MATCHCRITERIA_HEADERS_PART:
696 case MATCHCRITERIA_NOT_HEADERS_PART:
704 *\brief Check if the matcher structure wants the message
705 * to be matched (just perform an action on any
708 *\param matcher Matcher structure
710 *\return gboolean TRUE if matcher condition should match
713 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
715 switch (matcher->criteria) {
716 case MATCHCRITERIA_MESSAGE:
717 case MATCHCRITERIA_NOT_MESSAGE:
725 *\brief Check if a list of conditions match a header
727 *\param matchers One set of conditions
728 *\param buf Name of header
730 *\return gboolean TRUE if matching should stop
732 static gboolean matcherlist_match_one_header(MatcherList *matchers,
737 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
738 MatcherProp *matcher = (MatcherProp *) l->data;
740 /* see if a single condition matches */
741 if (matcherprop_criteria_headers(matcher) ||
742 matcherprop_criteria_message(matcher)) {
743 if (matcherprop_match_one_header(matcher, buf)) {
744 matcher->result = TRUE;
748 if (matcherprop_criteria_headers(matcher)) {
749 if (matcher->result) {
750 if (!matchers->bool_and)
760 *\brief Check if a list of conditions matches one header in
763 *\param matchers List of conditions
764 *\param fp Message file
766 *\return gboolean TRUE if one of the headers is matched by
767 * the list of conditions.
769 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
773 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
774 if (matcherlist_match_one_header(matchers, buf))
781 *\brief Check if a matcher wants to check the message body
783 *\param matcher Matcher structure
785 *\return gboolean TRUE if body must be matched.
787 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
789 switch (matcher->criteria) {
790 case MATCHCRITERIA_BODY_PART:
791 case MATCHCRITERIA_NOT_BODY_PART:
799 *\brief Check if a (line) string matches the criteria
800 * described by a matcher structure
802 *\param matcher Matcher structure
805 *\return gboolean TRUE if string matches criteria
807 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
809 switch (matcher->criteria) {
810 case MATCHCRITERIA_BODY_PART:
811 case MATCHCRITERIA_MESSAGE:
812 return matcherprop_string_match(matcher, line);
813 case MATCHCRITERIA_NOT_BODY_PART:
814 case MATCHCRITERIA_NOT_MESSAGE:
815 return !matcherprop_string_match(matcher, line);
821 *\brief Check if a list of conditions matches a (line) string
823 *\param matchers List of matchers
824 *\param line String to match
826 *\return gboolean TRUE if string matches list of criteria
828 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
832 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
833 MatcherProp *matcher = (MatcherProp *) l->data;
835 if (matcherprop_criteria_body(matcher) ||
836 matcherprop_criteria_message(matcher)) {
837 if (matcherprop_match_line(matcher, line)) {
838 matcher->result = TRUE;
842 if (matcher->result) {
843 if (!matchers->bool_and)
851 *\brief Check if a line in a message file's body matches
854 *\param matchers List of conditions
855 *\param fp Message file
857 *\return gboolean TRUE if succesful match
859 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
863 while (fgets(buf, sizeof(buf), fp) != NULL)
864 if (matcherlist_match_line(matchers, buf))
871 *\brief Check if a message file matches criteria
873 *\param matchers Criteria
874 *\param info Message info
875 *\param result Default result
877 *\return gboolean TRUE if matched
879 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
882 gboolean read_headers;
888 /* file need to be read ? */
890 read_headers = FALSE;
892 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
893 MatcherProp *matcher = (MatcherProp *) l->data;
895 if (matcherprop_criteria_headers(matcher))
897 if (matcherprop_criteria_body(matcher))
899 if (matcherprop_criteria_message(matcher)) {
903 matcher->result = FALSE;
906 if (!read_headers && !read_body)
909 file = procmsg_get_message_file(info);
913 if ((fp = fopen(file, "rb")) == NULL) {
914 FILE_OP_ERROR(file, "fopen");
919 /* read the headers */
922 if (matcherlist_match_headers(matchers, fp))
926 matcherlist_skip_headers(fp);
931 matcherlist_match_body(matchers, fp);
934 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
935 MatcherProp *matcher = (MatcherProp *) l->data;
937 if (matcherprop_criteria_headers(matcher) ||
938 matcherprop_criteria_body(matcher) ||
939 matcherprop_criteria_message(matcher)) {
940 if (matcher->result) {
941 if (!matchers->bool_and) {
947 if (matchers->bool_and) {
963 *\brief Test list of conditions on a message.
965 *\param matchers List of conditions
966 *\param info Message info
968 *\return gboolean TRUE if matched
970 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
975 if (matchers->bool_and)
980 /* test the cached elements */
982 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
983 MatcherProp *matcher = (MatcherProp *) l->data;
985 switch(matcher->criteria) {
986 case MATCHCRITERIA_ALL:
987 case MATCHCRITERIA_UNREAD:
988 case MATCHCRITERIA_NOT_UNREAD:
989 case MATCHCRITERIA_NEW:
990 case MATCHCRITERIA_NOT_NEW:
991 case MATCHCRITERIA_MARKED:
992 case MATCHCRITERIA_NOT_MARKED:
993 case MATCHCRITERIA_DELETED:
994 case MATCHCRITERIA_NOT_DELETED:
995 case MATCHCRITERIA_REPLIED:
996 case MATCHCRITERIA_NOT_REPLIED:
997 case MATCHCRITERIA_FORWARDED:
998 case MATCHCRITERIA_NOT_FORWARDED:
999 case MATCHCRITERIA_LOCKED:
1000 case MATCHCRITERIA_NOT_LOCKED:
1001 case MATCHCRITERIA_COLORLABEL:
1002 case MATCHCRITERIA_NOT_COLORLABEL:
1003 case MATCHCRITERIA_IGNORE_THREAD:
1004 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1005 case MATCHCRITERIA_SUBJECT:
1006 case MATCHCRITERIA_NOT_SUBJECT:
1007 case MATCHCRITERIA_FROM:
1008 case MATCHCRITERIA_NOT_FROM:
1009 case MATCHCRITERIA_TO:
1010 case MATCHCRITERIA_NOT_TO:
1011 case MATCHCRITERIA_CC:
1012 case MATCHCRITERIA_NOT_CC:
1013 case MATCHCRITERIA_TO_OR_CC:
1014 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
1015 case MATCHCRITERIA_AGE_GREATER:
1016 case MATCHCRITERIA_AGE_LOWER:
1017 case MATCHCRITERIA_NEWSGROUPS:
1018 case MATCHCRITERIA_NOT_NEWSGROUPS:
1019 case MATCHCRITERIA_INREPLYTO:
1020 case MATCHCRITERIA_NOT_INREPLYTO:
1021 case MATCHCRITERIA_REFERENCES:
1022 case MATCHCRITERIA_NOT_REFERENCES:
1023 case MATCHCRITERIA_SCORE_GREATER:
1024 case MATCHCRITERIA_SCORE_LOWER:
1025 case MATCHCRITERIA_SCORE_EQUAL:
1026 case MATCHCRITERIA_SIZE_GREATER:
1027 case MATCHCRITERIA_SIZE_SMALLER:
1028 case MATCHCRITERIA_SIZE_EQUAL:
1029 case MATCHCRITERIA_EXECUTE:
1030 case MATCHCRITERIA_NOT_EXECUTE:
1031 if (matcherprop_match(matcher, info)) {
1032 if (!matchers->bool_and) {
1037 if (matchers->bool_and) {
1044 /* test the condition on the file */
1046 if (matcherlist_match_file(matchers, info, result)) {
1047 if (!matchers->bool_and)
1051 if (matchers->bool_and)
1059 *\brief Convert a matcher structure to a string
1061 *\param matcher Matcher structure
1063 *\return gchar * Newly allocated string
1065 gchar *matcherprop_to_string(MatcherProp *matcher)
1067 gchar *matcher_str = NULL;
1068 const gchar *criteria_str;
1069 const gchar *matchtype_str;
1073 criteria_str = NULL;
1074 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1075 if (matchparser_tab[i].id == matcher->criteria)
1076 criteria_str = matchparser_tab[i].str;
1078 if (criteria_str == NULL)
1081 switch (matcher->criteria) {
1082 case MATCHCRITERIA_AGE_GREATER:
1083 case MATCHCRITERIA_AGE_LOWER:
1084 case MATCHCRITERIA_SCORE_GREATER:
1085 case MATCHCRITERIA_SCORE_LOWER:
1086 case MATCHCRITERIA_SCORE_EQUAL:
1087 case MATCHCRITERIA_SIZE_GREATER:
1088 case MATCHCRITERIA_SIZE_SMALLER:
1089 case MATCHCRITERIA_SIZE_EQUAL:
1090 case MATCHCRITERIA_COLORLABEL:
1091 case MATCHCRITERIA_NOT_COLORLABEL:
1092 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1093 case MATCHCRITERIA_ALL:
1094 case MATCHCRITERIA_UNREAD:
1095 case MATCHCRITERIA_NOT_UNREAD:
1096 case MATCHCRITERIA_NEW:
1097 case MATCHCRITERIA_NOT_NEW:
1098 case MATCHCRITERIA_MARKED:
1099 case MATCHCRITERIA_NOT_MARKED:
1100 case MATCHCRITERIA_DELETED:
1101 case MATCHCRITERIA_NOT_DELETED:
1102 case MATCHCRITERIA_REPLIED:
1103 case MATCHCRITERIA_NOT_REPLIED:
1104 case MATCHCRITERIA_FORWARDED:
1105 case MATCHCRITERIA_NOT_FORWARDED:
1106 case MATCHCRITERIA_LOCKED:
1107 case MATCHCRITERIA_NOT_LOCKED:
1108 case MATCHCRITERIA_IGNORE_THREAD:
1109 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1110 return g_strdup(criteria_str);
1111 case MATCHCRITERIA_EXECUTE:
1112 case MATCHCRITERIA_NOT_EXECUTE:
1113 expr = matcher_escape_str(matcher->expr);
1114 matcher_str = g_strdup_printf("%s \"%s\"", criteria_str, expr);
1115 g_free((gpointer) expr);
1119 matchtype_str = NULL;
1120 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1121 if (matchparser_tab[i].id == matcher->matchtype)
1122 matchtype_str = matchparser_tab[i].str;
1125 if (matchtype_str == NULL)
1128 switch (matcher->matchtype) {
1129 case MATCHTYPE_MATCH:
1130 case MATCHTYPE_MATCHCASE:
1131 case MATCHTYPE_REGEXP:
1132 case MATCHTYPE_REGEXPCASE:
1133 expr = matcher_escape_str(matcher->expr);
1134 if (matcher->header)
1135 matcher_str = g_strdup_printf
1136 ("%s \"%s\" %s \"%s\"",
1137 criteria_str, matcher->header,
1138 matchtype_str, expr);
1140 matcher_str = g_strdup_printf
1141 ("%s %s \"%s\"", criteria_str,
1142 matchtype_str, expr);
1143 g_free((gpointer) expr);
1151 *\brief Convert a list of conditions to a string
1153 *\param matchers List of conditions
1155 *\return gchar * Newly allocated string
1157 gchar *matcherlist_to_string(const MatcherList *matchers)
1163 gchar *result = NULL;
1165 count = g_slist_length(matchers->matchers);
1166 vstr = g_new(gchar *, count + 1);
1168 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1169 l = g_slist_next(l), cur_str ++) {
1170 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1171 if (*cur_str == NULL)
1176 if (matchers->bool_and)
1177 result = g_strjoinv(" & ", vstr);
1179 result = g_strjoinv(" | ", vstr);
1181 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1188 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1189 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1190 /* matching_build_command() - preferably cmd should be unescaped */
1192 *\brief Build the command line to execute
1194 *\param cmd String with command line specifiers
1195 *\param info Message info to use for command
1197 *\return gchar * Newly allocated string
1199 *\warning The \a cmd string should have been unescaped using
1200 * #matcher_unescape_str.
1202 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1204 const gchar *s = cmd;
1205 gchar *filename = NULL;
1206 gchar *processed_cmd;
1210 const gchar *const no_subject = _("(none)") ;
1211 const gchar *const no_from = _("(none)") ;
1212 const gchar *const no_to = _("(none)") ;
1213 const gchar *const no_cc = _("(none)") ;
1214 const gchar *const no_date = _("(none)") ;
1215 const gchar *const no_msgid = _("(none)") ;
1216 const gchar *const no_newsgroups = _("(none)") ;
1217 const gchar *const no_references = _("(none)") ;
1219 size = STRLEN_ZERO(cmd) + 1;
1220 while (*s != '\0') {
1227 case 's': /* subject */
1228 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1230 case 'f': /* from */
1231 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1234 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1237 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1239 case 'd': /* date */
1240 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1242 case 'i': /* message-id */
1243 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1245 case 'n': /* newsgroups */
1246 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1248 case 'r': /* references */
1249 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1251 case 'F': /* file */
1252 filename = folder_item_fetch_msg(info->folder,
1255 if (filename == NULL) {
1256 g_warning("filename is not set");
1260 size += strlen(filename) - 2;
1268 processed_cmd = g_new0(gchar, size);
1272 while (*s != '\0') {
1280 case 's': /* subject */
1281 if (info->subject != NULL)
1282 strcpy(p, info->subject);
1284 strcpy(p, no_subject);
1287 case 'f': /* from */
1288 if (info->from != NULL)
1289 strcpy(p, info->from);
1295 if (info->to != NULL)
1296 strcpy(p, info->to);
1302 if (info->cc != NULL)
1303 strcpy(p, info->cc);
1308 case 'd': /* date */
1309 if (info->date != NULL)
1310 strcpy(p, info->date);
1315 case 'i': /* message-id */
1316 if (info->msgid != NULL)
1317 strcpy(p, info->msgid);
1319 strcpy(p, no_msgid);
1322 case 'n': /* newsgroups */
1323 if (info->newsgroups != NULL)
1324 strcpy(p, info->newsgroups);
1326 strcpy(p, no_newsgroups);
1329 case 'r': /* references */
1330 if (info->references != NULL)
1331 strcpy(p, info->references);
1333 strcpy(p, no_references);
1336 case 'F': /* file */
1337 strcpy(p, filename);
1357 return processed_cmd;
1359 #undef STRLEN_DEFAULT
1362 /* ************************************************************ */
1365 *\brief Write scoring list to file
1368 *\param prefs_scoring List of scoring conditions
1370 static void prefs_scoring_write(FILE *fp, GSList *prefs_scoring)
1374 for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1378 prop = (ScoringProp *) cur->data;
1379 scoring_str = scoringprop_to_string(prop);
1380 if (fputs(scoring_str, fp) == EOF ||
1381 fputc('\n', fp) == EOF) {
1382 FILE_OP_ERROR("scoring config", "fputs || fputc");
1383 g_free(scoring_str);
1386 g_free(scoring_str);
1391 *\brief Write filtering list to file
1394 *\param prefs_filtering List of filtering conditions
1396 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1400 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1401 gchar *filtering_str;
1402 FilteringProp *prop;
1404 if (NULL == (prop = (FilteringProp *) cur->data))
1407 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1410 if (fputs(filtering_str, fp) == EOF ||
1411 fputc('\n', fp) == EOF) {
1412 FILE_OP_ERROR("filtering config", "fputs || fputc");
1413 g_free(filtering_str);
1416 g_free(filtering_str);
1421 *\brief Write matchers from a folder item
1423 *\param node Node with folder info
1424 *\param data File pointer
1426 *\return gboolean FALSE
1428 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1433 GSList *prefs_scoring;
1434 GSList *prefs_filtering;
1438 /* prevent warning */
1439 if (item->path == NULL)
1441 id = folder_item_get_identifier(item);
1444 prefs_scoring = item->prefs->scoring;
1445 prefs_filtering = item->prefs->processing;
1449 id = g_strdup("global"); /* because it is g_freed */
1450 prefs_scoring = global_scoring;
1451 prefs_filtering = global_processing;
1454 if (prefs_filtering != NULL || prefs_scoring != NULL) {
1455 fprintf(fp, "[%s]\n", id);
1457 prefs_filtering_write(fp, prefs_filtering);
1458 prefs_scoring_write(fp, prefs_scoring);
1469 *\brief Save matchers from folder items
1473 static void prefs_matcher_save(FILE *fp)
1477 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1480 folder = (Folder *) cur->data;
1481 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1482 prefs_matcher_write_func, fp);
1484 prefs_matcher_write_func(NULL, fp);
1488 *\brief Write filtering / matcher configuration file
1490 void prefs_matcher_write_config(void)
1495 debug_print("Writing matcher configuration...\n");
1497 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1500 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1501 g_warning("failed to write configuration to file\n");
1507 prefs_matcher_save(pfile->fp);
1511 if (prefs_file_close(pfile) < 0) {
1512 g_warning("failed to write configuration to file\n");
1517 /* ******************************************************************* */
1520 *\brief Read matcher configuration
1522 void prefs_matcher_read_config(void)
1527 create_matchparser_hashtab();
1528 prefs_scoring_clear();
1529 prefs_filtering_clear();
1531 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1532 f = fopen(rcpath, "rb");
1536 matcher_parser_start_parsing(f);
1540 /* previous version compatibily */
1542 /* printf("reading filtering\n"); */
1543 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1544 FILTERING_RC, NULL);
1545 f = fopen(rcpath, "rb");
1549 matcher_parser_start_parsing(f);
1550 fclose(matcher_parserin);
1553 /* printf("reading scoring\n"); */
1554 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1556 f = fopen(rcpath, "rb");
1560 matcher_parser_start_parsing(f);
1561 fclose(matcher_parserin);