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)
180 if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
187 *\brief Escape characters in a string by inserting '\' characters
189 *\param str String with characters to be escaped
191 *\return gchar * Newly allocated string with escaped characters
193 const gchar *matcher_escape_str(const gchar *str)
195 register const gchar *walk;
198 register char *reswalk;
203 for (escape = 0, walk = str; *walk; walk++)
204 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
208 return g_strdup(str);
210 reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
211 for (walk = str; *walk; walk++, reswalk++) {
212 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
222 *\brief Unescape string by replacing escaped char sequences
223 * (\b, \n, etc) by their actual char. Note that this
224 * function changes the contents of the buffer pointed
227 *\param str Buffer containing string that needs to be escaped.
228 * Note that this function changes the contents of the
231 *\return gchar * Pointer to changed buffer
233 gchar *matcher_unescape_str(gchar *str)
235 gchar *tmp = alloca(strlen(str) + 1);
236 register gchar *src = tmp;
237 register gchar *dst = str;
241 for ( ; *src; src++) {
246 if (*src == 'n') /* insert control characters */
248 else if (*src == 'r')
250 else if (*src == 't')
252 else if (*src == 'r')
254 else if (*src == 'b')
256 else if (*src == 'f')
258 else if (*src == '\\' || *src == '\'' || *src == '\"')
259 /* insert \\, \' or \" */
262 /* FIXME: should perhaps escape character... */
272 /* **************** data structure allocation **************** */
275 *\brief Allocate a structure for a filtering / scoring
276 * "condition" (a matcher structure)
278 *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
279 *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
280 *\param matchtype Type of action (MATCHTYPE_XXX)
281 *\param expr String value or expression to check
282 *\param value Integer value to check
284 *\return MatcherProp * Pointer to newly allocated structure
286 MatcherProp *matcherprop_new(gint criteria, const gchar *header,
287 gint matchtype, const gchar *expr,
292 prop = g_new0(MatcherProp, 1);
293 prop->criteria = criteria;
294 prop->header = header != NULL ? g_strdup(header) : NULL;
295 prop->expr = expr != NULL ? g_strdup(expr) : NULL;
296 prop->matchtype = matchtype;
305 *\brief Free a matcher structure
307 *\param prop Pointer to matcher structure allocated with
310 void matcherprop_free(MatcherProp *prop)
315 g_free(prop->header);
316 if (prop->preg != NULL) {
324 *\brief Copy a matcher structure
326 *\param src Matcher structure to copy
328 *\return MatcherProp * Pointer to newly allocated matcher structure
330 MatcherProp *matcherprop_copy(const MatcherProp *src)
332 MatcherProp *prop = g_new0(MatcherProp, 1);
334 prop->criteria = src->criteria;
335 prop->header = src->header ? g_strdup(src->header) : NULL;
336 prop->expr = src->expr ? g_strdup(src->expr) : NULL;
337 prop->matchtype = src->matchtype;
339 prop->preg = NULL; /* will be re-evaluated */
340 prop->value = src->value;
341 prop->error = src->error;
345 /* ****************** wrapper for file reading ************** */
348 *\brief Allocate a matcher structure where all strings
349 * are unescaped ("unquoted")
351 *\param criteria One of the MATCHCRITERIA_XXX constants
352 *\param header A header string
353 *\param matchtype Type of matcher (MATCHTYPE_XXX)
354 *\param expr Matcher string expression
355 *\param value Matcher integer value
357 *\return MatcherProp * Pointer to newly allocated matcher
360 MatcherProp *matcherprop_unquote_new(gint criteria, const gchar *header,
361 gint matchtype, const gchar *expr,
367 expr = matcher_unescape_str(g_strdup(expr));
370 header = matcher_unescape_str(g_strdup(header));
372 prop = matcherprop_new(criteria, header, matchtype, expr, value);
374 g_free((gpointer) header);
375 g_free((gpointer) expr);
381 /* ************** match ******************************/
384 *\brief Find out if a string matches a condition
386 *\param prop Matcher structure
387 *\param str String to check
389 *\return gboolean TRUE if str matches the condition in the
392 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
400 switch (prop->matchtype) {
401 case MATCHTYPE_REGEXPCASE:
402 case MATCHTYPE_REGEXP:
403 if (!prop->preg && (prop->error == 0)) {
404 prop->preg = g_new0(regex_t, 1);
405 /* if regexp then don't use the escaped string */
406 if (regcomp(prop->preg, prop->expr,
407 REG_NOSUB | REG_EXTENDED
408 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
409 ? REG_ICASE : 0)) != 0) {
415 if (prop->preg == NULL)
418 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
423 case MATCHTYPE_MATCH:
424 return (strstr(str, prop->expr) != NULL);
426 /* FIXME: put upper in unesc_str */
427 case MATCHTYPE_MATCHCASE:
428 str2 = alloca(strlen(prop->expr) + 1);
429 strcpy(str2, prop->expr);
431 str1 = alloca(strlen(str) + 1);
434 return (strstr(str1, str2) != NULL);
442 *\brief Execute a command defined in the matcher structure
444 *\param prop Pointer to matcher structure
445 *\param info Pointer to message info structure
447 *\return gboolean TRUE if command was executed succesfully
449 static gboolean matcherprop_match_execute(const MatcherProp *prop,
456 file = procmsg_get_message_file(info);
461 cmd = matching_build_command(prop->expr, info);
465 retval = system(cmd);
466 debug_print("Command exit code: %d\n", retval);
469 return (retval == 0);
473 *\brief Check if a message matches the condition in a matcher
476 *\param prop Pointer to matcher structure
477 *\param info Pointer to message info
479 *\return gboolean TRUE if a match
481 gboolean matcherprop_match(MatcherProp *prop,
486 switch(prop->criteria) {
487 case MATCHCRITERIA_ALL:
489 case MATCHCRITERIA_UNREAD:
490 return MSG_IS_UNREAD(info->flags);
491 case MATCHCRITERIA_NOT_UNREAD:
492 return !MSG_IS_UNREAD(info->flags);
493 case MATCHCRITERIA_NEW:
494 return MSG_IS_NEW(info->flags);
495 case MATCHCRITERIA_NOT_NEW:
496 return !MSG_IS_NEW(info->flags);
497 case MATCHCRITERIA_MARKED:
498 return MSG_IS_MARKED(info->flags);
499 case MATCHCRITERIA_NOT_MARKED:
500 return !MSG_IS_MARKED(info->flags);
501 case MATCHCRITERIA_DELETED:
502 return MSG_IS_DELETED(info->flags);
503 case MATCHCRITERIA_NOT_DELETED:
504 return !MSG_IS_DELETED(info->flags);
505 case MATCHCRITERIA_REPLIED:
506 return MSG_IS_REPLIED(info->flags);
507 case MATCHCRITERIA_NOT_REPLIED:
508 return !MSG_IS_REPLIED(info->flags);
509 case MATCHCRITERIA_FORWARDED:
510 return MSG_IS_FORWARDED(info->flags);
511 case MATCHCRITERIA_NOT_FORWARDED:
512 return !MSG_IS_FORWARDED(info->flags);
513 case MATCHCRITERIA_LOCKED:
514 return MSG_IS_LOCKED(info->flags);
515 case MATCHCRITERIA_NOT_LOCKED:
516 return !MSG_IS_LOCKED(info->flags);
517 case MATCHCRITERIA_COLORLABEL:
518 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
519 case MATCHCRITERIA_NOT_COLORLABEL:
520 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
521 case MATCHCRITERIA_IGNORE_THREAD:
522 return MSG_IS_IGNORE_THREAD(info->flags);
523 case MATCHCRITERIA_NOT_IGNORE_THREAD:
524 return !MSG_IS_IGNORE_THREAD(info->flags);
525 case MATCHCRITERIA_SUBJECT:
526 return matcherprop_string_match(prop, info->subject);
527 case MATCHCRITERIA_NOT_SUBJECT:
528 return !matcherprop_string_match(prop, info->subject);
529 case MATCHCRITERIA_FROM:
530 return matcherprop_string_match(prop, info->from);
531 case MATCHCRITERIA_NOT_FROM:
532 return !matcherprop_string_match(prop, info->from);
533 case MATCHCRITERIA_TO:
534 return matcherprop_string_match(prop, info->to);
535 case MATCHCRITERIA_NOT_TO:
536 return !matcherprop_string_match(prop, info->to);
537 case MATCHCRITERIA_CC:
538 return matcherprop_string_match(prop, info->cc);
539 case MATCHCRITERIA_NOT_CC:
540 return !matcherprop_string_match(prop, info->cc);
541 case MATCHCRITERIA_TO_OR_CC:
542 return matcherprop_string_match(prop, info->to)
543 || matcherprop_string_match(prop, info->cc);
544 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
545 return !(matcherprop_string_match(prop, info->to)
546 || matcherprop_string_match(prop, info->cc));
547 case MATCHCRITERIA_AGE_GREATER:
549 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
550 case MATCHCRITERIA_AGE_LOWER:
552 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
553 case MATCHCRITERIA_SCORE_GREATER:
554 return info->score >= prop->value;
555 case MATCHCRITERIA_SCORE_LOWER:
556 return info->score <= prop->value;
557 case MATCHCRITERIA_SCORE_EQUAL:
558 return info->score == prop->value;
559 case MATCHCRITERIA_SIZE_GREATER:
560 /* FIXME: info->size is an off_t */
561 return info->size > (off_t) prop->value;
562 case MATCHCRITERIA_SIZE_EQUAL:
563 /* FIXME: info->size is an off_t */
564 return info->size == (off_t) prop->value;
565 case MATCHCRITERIA_SIZE_SMALLER:
566 /* FIXME: info->size is an off_t */
567 return info->size < (off_t) prop->value;
568 case MATCHCRITERIA_NEWSGROUPS:
569 return matcherprop_string_match(prop, info->newsgroups);
570 case MATCHCRITERIA_NOT_NEWSGROUPS:
571 return !matcherprop_string_match(prop, info->newsgroups);
572 case MATCHCRITERIA_INREPLYTO:
573 return matcherprop_string_match(prop, info->inreplyto);
574 case MATCHCRITERIA_NOT_INREPLYTO:
575 return !matcherprop_string_match(prop, info->inreplyto);
576 case MATCHCRITERIA_REFERENCES:
577 return matcherprop_string_match(prop, info->references);
578 case MATCHCRITERIA_NOT_REFERENCES:
579 return !matcherprop_string_match(prop, info->references);
580 case MATCHCRITERIA_EXECUTE:
581 return matcherprop_match_execute(prop, info);
582 case MATCHCRITERIA_NOT_EXECUTE:
583 return !matcherprop_match_execute(prop, info);
589 /* ********************* MatcherList *************************** */
592 *\brief Create a new list of matchers
594 *\param matchers List of matcher structures
595 *\param bool_and Operator
597 *\return MatcherList * New list
599 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
603 cond = g_new0(MatcherList, 1);
605 cond->matchers = matchers;
606 cond->bool_and = bool_and;
612 *\brief Frees a list of matchers
614 *\param cond List of matchers
616 void matcherlist_free(MatcherList *cond)
620 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
621 matcherprop_free((MatcherProp *) l->data);
627 *\brief Skip all headers in a message file
629 *\param fp Message file
631 static void matcherlist_skip_headers(FILE *fp)
635 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
640 *\brief Check if a header matches a matcher condition
642 *\param matcher Matcher structure to check header for
643 *\param buf Header name
645 *\return boolean TRUE if matching header
647 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
653 switch (matcher->criteria) {
654 case MATCHCRITERIA_HEADER:
655 case MATCHCRITERIA_NOT_HEADER:
656 header = procheader_parse_header(buf);
659 if (procheader_headername_equal(header->name,
661 if (matcher->criteria == MATCHCRITERIA_HEADER)
662 result = matcherprop_string_match(matcher, header->body);
664 result = !matcherprop_string_match(matcher, header->body);
665 procheader_header_free(header);
669 procheader_header_free(header);
672 case MATCHCRITERIA_HEADERS_PART:
673 case MATCHCRITERIA_MESSAGE:
674 return matcherprop_string_match(matcher, buf);
675 case MATCHCRITERIA_NOT_MESSAGE:
676 case MATCHCRITERIA_NOT_HEADERS_PART:
677 return !matcherprop_string_match(matcher, buf);
683 *\brief Check if the matcher structure wants headers to
686 *\param matcher Matcher structure
688 *\return gboolean TRUE if the matcher structure describes
689 * a header match condition
691 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
693 switch (matcher->criteria) {
694 case MATCHCRITERIA_HEADER:
695 case MATCHCRITERIA_NOT_HEADER:
696 case MATCHCRITERIA_HEADERS_PART:
697 case MATCHCRITERIA_NOT_HEADERS_PART:
705 *\brief Check if the matcher structure wants the message
706 * to be matched (just perform an action on any
709 *\param matcher Matcher structure
711 *\return gboolean TRUE if matcher condition should match
714 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
716 switch (matcher->criteria) {
717 case MATCHCRITERIA_MESSAGE:
718 case MATCHCRITERIA_NOT_MESSAGE:
726 *\brief Check if a list of conditions match a header
728 *\param matchers One set of conditions
729 *\param buf Name of header
731 *\return gboolean TRUE if matching should stop
733 static gboolean matcherlist_match_one_header(MatcherList *matchers,
738 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
739 MatcherProp *matcher = (MatcherProp *) l->data;
741 /* see if a single condition matches */
742 if (matcherprop_criteria_headers(matcher) ||
743 matcherprop_criteria_message(matcher)) {
744 if (matcherprop_match_one_header(matcher, buf)) {
745 matcher->result = TRUE;
749 if (matcherprop_criteria_headers(matcher)) {
750 if (matcher->result) {
751 if (!matchers->bool_and)
761 *\brief Check if a list of conditions matches one header in
764 *\param matchers List of conditions
765 *\param fp Message file
767 *\return gboolean TRUE if one of the headers is matched by
768 * the list of conditions.
770 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
774 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
775 if (matcherlist_match_one_header(matchers, buf))
782 *\brief Check if a matcher wants to check the message body
784 *\param matcher Matcher structure
786 *\return gboolean TRUE if body must be matched.
788 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
790 switch (matcher->criteria) {
791 case MATCHCRITERIA_BODY_PART:
792 case MATCHCRITERIA_NOT_BODY_PART:
800 *\brief Check if a (line) string matches the criteria
801 * described by a matcher structure
803 *\param matcher Matcher structure
806 *\return gboolean TRUE if string matches criteria
808 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
810 switch (matcher->criteria) {
811 case MATCHCRITERIA_BODY_PART:
812 case MATCHCRITERIA_MESSAGE:
813 return matcherprop_string_match(matcher, line);
814 case MATCHCRITERIA_NOT_BODY_PART:
815 case MATCHCRITERIA_NOT_MESSAGE:
816 return !matcherprop_string_match(matcher, line);
822 *\brief Check if a list of conditions matches a (line) string
824 *\param matchers List of matchers
825 *\param line String to match
827 *\return gboolean TRUE if string matches list of criteria
829 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
833 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
834 MatcherProp *matcher = (MatcherProp *) l->data;
836 if (matcherprop_criteria_body(matcher) ||
837 matcherprop_criteria_message(matcher)) {
838 if (matcherprop_match_line(matcher, line)) {
839 matcher->result = TRUE;
843 if (matcher->result) {
844 if (!matchers->bool_and)
852 *\brief Check if a line in a message file's body matches
855 *\param matchers List of conditions
856 *\param fp Message file
858 *\return gboolean TRUE if succesful match
860 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
864 while (fgets(buf, sizeof(buf), fp) != NULL)
865 if (matcherlist_match_line(matchers, buf))
872 *\brief Check if a message file matches criteria
874 *\param matchers Criteria
875 *\param info Message info
876 *\param result Default result
878 *\return gboolean TRUE if matched
880 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
883 gboolean read_headers;
889 /* file need to be read ? */
891 read_headers = FALSE;
893 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
894 MatcherProp *matcher = (MatcherProp *) l->data;
896 if (matcherprop_criteria_headers(matcher))
898 if (matcherprop_criteria_body(matcher))
900 if (matcherprop_criteria_message(matcher)) {
904 matcher->result = FALSE;
907 if (!read_headers && !read_body)
910 file = procmsg_get_message_file(info);
914 if ((fp = fopen(file, "rb")) == NULL) {
915 FILE_OP_ERROR(file, "fopen");
920 /* read the headers */
923 if (matcherlist_match_headers(matchers, fp))
927 matcherlist_skip_headers(fp);
932 matcherlist_match_body(matchers, fp);
935 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
936 MatcherProp *matcher = (MatcherProp *) l->data;
938 if (matcherprop_criteria_headers(matcher) ||
939 matcherprop_criteria_body(matcher) ||
940 matcherprop_criteria_message(matcher)) {
941 if (matcher->result) {
942 if (!matchers->bool_and) {
948 if (matchers->bool_and) {
964 *\brief Test list of conditions on a message.
966 *\param matchers List of conditions
967 *\param info Message info
969 *\return gboolean TRUE if matched
971 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
976 if (matchers->bool_and)
981 /* test the cached elements */
983 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
984 MatcherProp *matcher = (MatcherProp *) l->data;
986 switch(matcher->criteria) {
987 case MATCHCRITERIA_ALL:
988 case MATCHCRITERIA_UNREAD:
989 case MATCHCRITERIA_NOT_UNREAD:
990 case MATCHCRITERIA_NEW:
991 case MATCHCRITERIA_NOT_NEW:
992 case MATCHCRITERIA_MARKED:
993 case MATCHCRITERIA_NOT_MARKED:
994 case MATCHCRITERIA_DELETED:
995 case MATCHCRITERIA_NOT_DELETED:
996 case MATCHCRITERIA_REPLIED:
997 case MATCHCRITERIA_NOT_REPLIED:
998 case MATCHCRITERIA_FORWARDED:
999 case MATCHCRITERIA_NOT_FORWARDED:
1000 case MATCHCRITERIA_LOCKED:
1001 case MATCHCRITERIA_NOT_LOCKED:
1002 case MATCHCRITERIA_COLORLABEL:
1003 case MATCHCRITERIA_NOT_COLORLABEL:
1004 case MATCHCRITERIA_IGNORE_THREAD:
1005 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1006 case MATCHCRITERIA_SUBJECT:
1007 case MATCHCRITERIA_NOT_SUBJECT:
1008 case MATCHCRITERIA_FROM:
1009 case MATCHCRITERIA_NOT_FROM:
1010 case MATCHCRITERIA_TO:
1011 case MATCHCRITERIA_NOT_TO:
1012 case MATCHCRITERIA_CC:
1013 case MATCHCRITERIA_NOT_CC:
1014 case MATCHCRITERIA_TO_OR_CC:
1015 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
1016 case MATCHCRITERIA_AGE_GREATER:
1017 case MATCHCRITERIA_AGE_LOWER:
1018 case MATCHCRITERIA_NEWSGROUPS:
1019 case MATCHCRITERIA_NOT_NEWSGROUPS:
1020 case MATCHCRITERIA_INREPLYTO:
1021 case MATCHCRITERIA_NOT_INREPLYTO:
1022 case MATCHCRITERIA_REFERENCES:
1023 case MATCHCRITERIA_NOT_REFERENCES:
1024 case MATCHCRITERIA_SCORE_GREATER:
1025 case MATCHCRITERIA_SCORE_LOWER:
1026 case MATCHCRITERIA_SCORE_EQUAL:
1027 case MATCHCRITERIA_SIZE_GREATER:
1028 case MATCHCRITERIA_SIZE_SMALLER:
1029 case MATCHCRITERIA_SIZE_EQUAL:
1030 case MATCHCRITERIA_EXECUTE:
1031 case MATCHCRITERIA_NOT_EXECUTE:
1032 if (matcherprop_match(matcher, info)) {
1033 if (!matchers->bool_and) {
1038 if (matchers->bool_and) {
1045 /* test the condition on the file */
1047 if (matcherlist_match_file(matchers, info, result)) {
1048 if (!matchers->bool_and)
1052 if (matchers->bool_and)
1060 *\brief Convert a matcher structure to a string
1062 *\param matcher Matcher structure
1064 *\return gchar * Newly allocated string
1066 gchar *matcherprop_to_string(MatcherProp *matcher)
1068 gchar *matcher_str = NULL;
1069 const gchar *criteria_str;
1070 const gchar *matchtype_str;
1075 criteria_str = NULL;
1076 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1077 if (matchparser_tab[i].id == matcher->criteria)
1078 criteria_str = matchparser_tab[i].str;
1080 if (criteria_str == NULL)
1083 switch (matcher->criteria) {
1084 case MATCHCRITERIA_AGE_GREATER:
1085 case MATCHCRITERIA_AGE_LOWER:
1086 case MATCHCRITERIA_SCORE_GREATER:
1087 case MATCHCRITERIA_SCORE_LOWER:
1088 case MATCHCRITERIA_SCORE_EQUAL:
1089 case MATCHCRITERIA_SIZE_GREATER:
1090 case MATCHCRITERIA_SIZE_SMALLER:
1091 case MATCHCRITERIA_SIZE_EQUAL:
1092 case MATCHCRITERIA_COLORLABEL:
1093 case MATCHCRITERIA_NOT_COLORLABEL:
1094 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1095 case MATCHCRITERIA_ALL:
1096 case MATCHCRITERIA_UNREAD:
1097 case MATCHCRITERIA_NOT_UNREAD:
1098 case MATCHCRITERIA_NEW:
1099 case MATCHCRITERIA_NOT_NEW:
1100 case MATCHCRITERIA_MARKED:
1101 case MATCHCRITERIA_NOT_MARKED:
1102 case MATCHCRITERIA_DELETED:
1103 case MATCHCRITERIA_NOT_DELETED:
1104 case MATCHCRITERIA_REPLIED:
1105 case MATCHCRITERIA_NOT_REPLIED:
1106 case MATCHCRITERIA_FORWARDED:
1107 case MATCHCRITERIA_NOT_FORWARDED:
1108 case MATCHCRITERIA_LOCKED:
1109 case MATCHCRITERIA_NOT_LOCKED:
1110 case MATCHCRITERIA_IGNORE_THREAD:
1111 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1112 return g_strdup(criteria_str);
1113 case MATCHCRITERIA_EXECUTE:
1114 case MATCHCRITERIA_NOT_EXECUTE:
1115 expr = matcher_escape_str(matcher->expr);
1116 matcher_str = g_strdup_printf("%s \"%s\"", criteria_str, expr);
1117 g_free((gpointer) expr);
1121 matchtype_str = NULL;
1122 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1123 if (matchparser_tab[i].id == matcher->matchtype)
1124 matchtype_str = matchparser_tab[i].str;
1127 if (matchtype_str == NULL)
1130 switch (matcher->matchtype) {
1131 case MATCHTYPE_MATCH:
1132 case MATCHTYPE_MATCHCASE:
1133 case MATCHTYPE_REGEXP:
1134 case MATCHTYPE_REGEXPCASE:
1135 expr = matcher_escape_str(matcher->expr);
1136 if (matcher->header)
1137 matcher_str = g_strdup_printf
1138 ("%s \"%s\" %s \"%s\"",
1139 criteria_str, matcher->header,
1140 matchtype_str, expr);
1142 matcher_str = g_strdup_printf
1143 ("%s %s \"%s\"", criteria_str,
1144 matchtype_str, expr);
1145 g_free((gpointer) expr);
1153 *\brief Convert a list of conditions to a string
1155 *\param matchers List of conditions
1157 *\return gchar * Newly allocated string
1159 gchar *matcherlist_to_string(const MatcherList *matchers)
1165 gchar *result = NULL;
1167 count = g_slist_length(matchers->matchers);
1168 vstr = g_new(gchar *, count + 1);
1170 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1171 l = g_slist_next(l), cur_str ++) {
1172 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1173 if (*cur_str == NULL)
1178 if (matchers->bool_and)
1179 result = g_strjoinv(" & ", vstr);
1181 result = g_strjoinv(" | ", vstr);
1183 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1190 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1191 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1192 /* matching_build_command() - preferably cmd should be unescaped */
1194 *\brief Build the command line to execute
1196 *\param cmd String with command line specifiers
1197 *\param info Message info to use for command
1199 *\return gchar * Newly allocated string
1201 *\warning The \a cmd string should have been unescaped using
1202 * #matcher_unescape_str.
1204 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1206 const gchar *s = cmd;
1207 gchar *filename = NULL;
1208 gchar *processed_cmd;
1212 const gchar *const no_subject = _("(none)") ;
1213 const gchar *const no_from = _("(none)") ;
1214 const gchar *const no_to = _("(none)") ;
1215 const gchar *const no_cc = _("(none)") ;
1216 const gchar *const no_date = _("(none)") ;
1217 const gchar *const no_msgid = _("(none)") ;
1218 const gchar *const no_newsgroups = _("(none)") ;
1219 const gchar *const no_references = _("(none)") ;
1221 size = STRLEN_ZERO(cmd) + 1;
1222 while (*s != '\0') {
1229 case 's': /* subject */
1230 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1232 case 'f': /* from */
1233 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1236 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1239 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1241 case 'd': /* date */
1242 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1244 case 'i': /* message-id */
1245 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1247 case 'n': /* newsgroups */
1248 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1250 case 'r': /* references */
1251 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1253 case 'F': /* file */
1254 filename = folder_item_fetch_msg(info->folder,
1257 if (filename == NULL) {
1258 g_warning("filename is not set");
1262 size += strlen(filename) - 2;
1270 processed_cmd = g_new0(gchar, size);
1274 while (*s != '\0') {
1282 case 's': /* subject */
1283 if (info->subject != NULL)
1284 strcpy(p, info->subject);
1286 strcpy(p, no_subject);
1289 case 'f': /* from */
1290 if (info->from != NULL)
1291 strcpy(p, info->from);
1297 if (info->to != NULL)
1298 strcpy(p, info->to);
1304 if (info->cc != NULL)
1305 strcpy(p, info->cc);
1310 case 'd': /* date */
1311 if (info->date != NULL)
1312 strcpy(p, info->date);
1317 case 'i': /* message-id */
1318 if (info->msgid != NULL)
1319 strcpy(p, info->msgid);
1321 strcpy(p, no_msgid);
1324 case 'n': /* newsgroups */
1325 if (info->newsgroups != NULL)
1326 strcpy(p, info->newsgroups);
1328 strcpy(p, no_newsgroups);
1331 case 'r': /* references */
1332 if (info->references != NULL)
1333 strcpy(p, info->references);
1335 strcpy(p, no_references);
1338 case 'F': /* file */
1339 strcpy(p, filename);
1359 return processed_cmd;
1361 #undef STRLEN_DEFAULT
1364 /* ************************************************************ */
1367 *\brief Write scoring list to file
1370 *\param prefs_scoring List of scoring conditions
1372 static void prefs_scoring_write(FILE *fp, GSList *prefs_scoring)
1376 for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1380 prop = (ScoringProp *) cur->data;
1381 scoring_str = scoringprop_to_string(prop);
1382 if (fputs(scoring_str, fp) == EOF ||
1383 fputc('\n', fp) == EOF) {
1384 FILE_OP_ERROR("scoring config", "fputs || fputc");
1385 g_free(scoring_str);
1388 g_free(scoring_str);
1393 *\brief Write filtering list to file
1396 *\param prefs_filtering List of filtering conditions
1398 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1402 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1403 gchar *filtering_str;
1404 FilteringProp *prop;
1406 if (NULL == (prop = (FilteringProp *) cur->data))
1409 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1412 if (fputs(filtering_str, fp) == EOF ||
1413 fputc('\n', fp) == EOF) {
1414 FILE_OP_ERROR("filtering config", "fputs || fputc");
1415 g_free(filtering_str);
1418 g_free(filtering_str);
1423 *\brief Write matchers from a folder item
1425 *\param node Node with folder info
1426 *\param data File pointer
1428 *\return gboolean FALSE
1430 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1435 GSList *prefs_scoring;
1436 GSList *prefs_filtering;
1440 /* prevent warning */
1441 if (item->path == NULL)
1443 id = folder_item_get_identifier(item);
1446 prefs_scoring = item->prefs->scoring;
1447 prefs_filtering = item->prefs->processing;
1451 id = g_strdup("global"); /* because it is g_freed */
1452 prefs_scoring = global_scoring;
1453 prefs_filtering = global_processing;
1456 if (prefs_filtering != NULL || prefs_scoring != NULL) {
1457 fprintf(fp, "[%s]\n", id);
1459 prefs_filtering_write(fp, prefs_filtering);
1460 prefs_scoring_write(fp, prefs_scoring);
1471 *\brief Save matchers from folder items
1475 static void prefs_matcher_save(FILE *fp)
1479 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1482 folder = (Folder *) cur->data;
1483 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1484 prefs_matcher_write_func, fp);
1486 prefs_matcher_write_func(NULL, fp);
1490 *\brief Write filtering / matcher configuration file
1492 void prefs_matcher_write_config(void)
1497 debug_print("Writing matcher configuration...\n");
1499 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1502 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1503 g_warning("failed to write configuration to file\n");
1509 prefs_matcher_save(pfile->fp);
1513 if (prefs_file_close(pfile) < 0) {
1514 g_warning("failed to write configuration to file\n");
1519 /* ******************************************************************* */
1522 *\brief Read matcher configuration
1524 void prefs_matcher_read_config(void)
1529 create_matchparser_hashtab();
1530 prefs_scoring_clear();
1531 prefs_filtering_clear();
1533 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1534 f = fopen(rcpath, "rb");
1538 matcher_parser_start_parsing(f);
1542 /* previous version compatibily */
1544 /* printf("reading filtering\n"); */
1545 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1546 FILTERING_RC, NULL);
1547 f = fopen(rcpath, "rb");
1551 matcher_parser_start_parsing(f);
1552 fclose(matcher_parserin);
1555 /* printf("reading scoring\n"); */
1556 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1558 f = fopen(rcpath, "rb");
1562 matcher_parser_start_parsing(f);
1563 fclose(matcher_parserin);