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_TEST, "test"},
104 {MATCHCRITERIA_NOT_TEST, "~test"},
107 {MATCHTYPE_MATCHCASE, "matchcase"},
108 {MATCHTYPE_MATCH, "match"},
109 {MATCHTYPE_REGEXPCASE, "regexpcase"},
110 {MATCHTYPE_REGEXP, "regexp"},
113 {MATCHACTION_SCORE, "score"}, /* for backward compatibility */
114 {MATCHACTION_MOVE, "move"},
115 {MATCHACTION_COPY, "copy"},
116 {MATCHACTION_DELETE, "delete"},
117 {MATCHACTION_MARK, "mark"},
118 {MATCHACTION_UNMARK, "unmark"},
119 {MATCHACTION_LOCK, "lock"},
120 {MATCHACTION_UNLOCK, "unlock"},
121 {MATCHACTION_MARK_AS_READ, "mark_as_read"},
122 {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
123 {MATCHACTION_FORWARD, "forward"},
124 {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
125 {MATCHACTION_EXECUTE, "execute"},
126 {MATCHACTION_COLOR, "color"},
127 {MATCHACTION_REDIRECT, "redirect"},
128 {MATCHACTION_ADD_SCORE, "add_score"},
129 {MATCHACTION_SET_SCORE, "set_score"},
130 {MATCHACTION_STOP, "stop"},
131 {MATCHACTION_HIDE, "hide"},
135 *\brief Look up table with keywords defined in \sa matchparser_tab
137 static GHashTable *matchparser_hashtab;
140 *\brief Translate keyword id to keyword string
142 *\param id Id of keyword
144 *\return const gchar * Keyword
146 const gchar *get_matchparser_tab_str(gint id)
150 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
151 if (matchparser_tab[i].id == id)
152 return matchparser_tab[i].str;
158 *\brief Create keyword lookup table
160 static void create_matchparser_hashtab(void)
164 if (matchparser_hashtab) return;
165 matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
166 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
167 g_hash_table_insert(matchparser_hashtab,
168 matchparser_tab[i].str,
169 (gpointer) &matchparser_tab[i]);
173 *\brief Return a keyword id from a keyword string
175 *\param str Keyword string
177 *\return gint Keyword id
179 gint get_matchparser_tab_id(const gchar *str)
183 if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
190 *\brief Escape characters in a string by inserting '\' characters
192 *\param str String with characters to be escaped
194 *\return gchar * Newly allocated string with escaped characters
196 gchar *matcher_escape_str(const gchar *str)
198 register const gchar *walk;
201 register char *reswalk;
206 for (escape = 0, walk = str; *walk; walk++)
207 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
211 return g_strdup(str);
213 reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
214 for (walk = str; *walk; walk++, reswalk++) {
215 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
225 *\brief Unescape string by replacing escaped char sequences
226 * (\b, \n, etc) by their actual char. Note that this
227 * function changes the contents of the buffer pointed
230 *\param str Buffer containing string that needs to be escaped.
231 * Note that this function changes the contents of the
234 *\return gchar * Pointer to changed buffer
236 gchar *matcher_unescape_str(gchar *str)
238 gchar *tmp = alloca(strlen(str) + 1);
239 register gchar *src = tmp;
240 register gchar *dst = str;
244 for ( ; *src; src++) {
249 if (*src == 'n') /* insert control characters */
251 else if (*src == 'r')
253 else if (*src == 't')
255 else if (*src == 'r')
257 else if (*src == 'b')
259 else if (*src == 'f')
261 else if (*src == '\\' || *src == '\'' || *src == '\"')
262 /* insert \\, \' or \" */
265 /* FIXME: should perhaps escape character... */
275 /* **************** data structure allocation **************** */
278 *\brief Allocate a structure for a filtering / scoring
279 * "condition" (a matcher structure)
281 *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
282 *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
283 *\param matchtype Type of action (MATCHTYPE_XXX)
284 *\param expr String value or expression to check
285 *\param value Integer value to check
287 *\return MatcherProp * Pointer to newly allocated structure
289 MatcherProp *matcherprop_new(gint criteria, const gchar *header,
290 gint matchtype, const gchar *expr,
295 prop = g_new0(MatcherProp, 1);
296 prop->criteria = criteria;
297 prop->header = header != NULL ? g_strdup(header) : NULL;
298 prop->expr = expr != NULL ? g_strdup(expr) : NULL;
299 prop->matchtype = matchtype;
308 *\brief Free a matcher structure
310 *\param prop Pointer to matcher structure allocated with
313 void matcherprop_free(MatcherProp *prop)
318 g_free(prop->header);
319 if (prop->preg != NULL) {
327 *\brief Copy a matcher structure
329 *\param src Matcher structure to copy
331 *\return MatcherProp * Pointer to newly allocated matcher structure
333 MatcherProp *matcherprop_copy(const MatcherProp *src)
335 MatcherProp *prop = g_new0(MatcherProp, 1);
337 prop->criteria = src->criteria;
338 prop->header = src->header ? g_strdup(src->header) : NULL;
339 prop->expr = src->expr ? g_strdup(src->expr) : NULL;
340 prop->matchtype = src->matchtype;
342 prop->preg = NULL; /* will be re-evaluated */
343 prop->value = src->value;
344 prop->error = src->error;
348 /* ****************** wrapper for file reading ************** */
351 *\brief Allocate a matcher structure where all strings
352 * are unescaped ("unquoted")
354 *\param criteria One of the MATCHCRITERIA_XXX constants
355 *\param header A header string
356 *\param matchtype Type of matcher (MATCHTYPE_XXX)
357 *\param expr Matcher string expression
358 *\param value Matcher integer value
360 *\return MatcherProp * Pointer to newly allocated matcher
363 MatcherProp *matcherprop_unquote_new(gint criteria, const gchar *header,
364 gint matchtype, const gchar *expr,
370 expr = matcher_unescape_str(g_strdup(expr));
373 header = matcher_unescape_str(g_strdup(header));
375 prop = matcherprop_new(criteria, header, matchtype, expr, value);
377 g_free((gpointer) header);
378 g_free((gpointer) expr);
384 /* ************** match ******************************/
387 *\brief Find out if a string matches a condition
389 *\param prop Matcher structure
390 *\param str String to check
392 *\return gboolean TRUE if str matches the condition in the
395 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
403 switch (prop->matchtype) {
404 case MATCHTYPE_REGEXPCASE:
405 case MATCHTYPE_REGEXP:
406 if (!prop->preg && (prop->error == 0)) {
407 prop->preg = g_new0(regex_t, 1);
408 /* if regexp then don't use the escaped string */
409 if (regcomp(prop->preg, prop->expr,
410 REG_NOSUB | REG_EXTENDED
411 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
412 ? REG_ICASE : 0)) != 0) {
418 if (prop->preg == NULL)
421 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
426 case MATCHTYPE_MATCH:
427 return (strstr(str, prop->expr) != NULL);
429 /* FIXME: put upper in unesc_str */
430 case MATCHTYPE_MATCHCASE:
431 str2 = alloca(strlen(prop->expr) + 1);
432 strcpy(str2, prop->expr);
434 str1 = alloca(strlen(str) + 1);
437 return (strstr(str1, str2) != NULL);
445 *\brief Execute a command defined in the matcher structure
447 *\param prop Pointer to matcher structure
448 *\param info Pointer to message info structure
450 *\return gboolean TRUE if command was executed succesfully
452 static gboolean matcherprop_match_test(const MatcherProp *prop,
459 file = procmsg_get_message_file(info);
464 cmd = matching_build_command(prop->expr, info);
468 retval = system(cmd);
469 debug_print("Command exit code: %d\n", retval);
472 return (retval == 0);
476 *\brief Check if a message matches the condition in a matcher
479 *\param prop Pointer to matcher structure
480 *\param info Pointer to message info
482 *\return gboolean TRUE if a match
484 gboolean matcherprop_match(MatcherProp *prop,
489 switch(prop->criteria) {
490 case MATCHCRITERIA_ALL:
492 case MATCHCRITERIA_UNREAD:
493 return MSG_IS_UNREAD(info->flags);
494 case MATCHCRITERIA_NOT_UNREAD:
495 return !MSG_IS_UNREAD(info->flags);
496 case MATCHCRITERIA_NEW:
497 return MSG_IS_NEW(info->flags);
498 case MATCHCRITERIA_NOT_NEW:
499 return !MSG_IS_NEW(info->flags);
500 case MATCHCRITERIA_MARKED:
501 return MSG_IS_MARKED(info->flags);
502 case MATCHCRITERIA_NOT_MARKED:
503 return !MSG_IS_MARKED(info->flags);
504 case MATCHCRITERIA_DELETED:
505 return MSG_IS_DELETED(info->flags);
506 case MATCHCRITERIA_NOT_DELETED:
507 return !MSG_IS_DELETED(info->flags);
508 case MATCHCRITERIA_REPLIED:
509 return MSG_IS_REPLIED(info->flags);
510 case MATCHCRITERIA_NOT_REPLIED:
511 return !MSG_IS_REPLIED(info->flags);
512 case MATCHCRITERIA_FORWARDED:
513 return MSG_IS_FORWARDED(info->flags);
514 case MATCHCRITERIA_NOT_FORWARDED:
515 return !MSG_IS_FORWARDED(info->flags);
516 case MATCHCRITERIA_LOCKED:
517 return MSG_IS_LOCKED(info->flags);
518 case MATCHCRITERIA_NOT_LOCKED:
519 return !MSG_IS_LOCKED(info->flags);
520 case MATCHCRITERIA_COLORLABEL:
521 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
522 case MATCHCRITERIA_NOT_COLORLABEL:
523 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
524 case MATCHCRITERIA_IGNORE_THREAD:
525 return MSG_IS_IGNORE_THREAD(info->flags);
526 case MATCHCRITERIA_NOT_IGNORE_THREAD:
527 return !MSG_IS_IGNORE_THREAD(info->flags);
528 case MATCHCRITERIA_SUBJECT:
529 return matcherprop_string_match(prop, info->subject);
530 case MATCHCRITERIA_NOT_SUBJECT:
531 return !matcherprop_string_match(prop, info->subject);
532 case MATCHCRITERIA_FROM:
533 return matcherprop_string_match(prop, info->from);
534 case MATCHCRITERIA_NOT_FROM:
535 return !matcherprop_string_match(prop, info->from);
536 case MATCHCRITERIA_TO:
537 return matcherprop_string_match(prop, info->to);
538 case MATCHCRITERIA_NOT_TO:
539 return !matcherprop_string_match(prop, info->to);
540 case MATCHCRITERIA_CC:
541 return matcherprop_string_match(prop, info->cc);
542 case MATCHCRITERIA_NOT_CC:
543 return !matcherprop_string_match(prop, info->cc);
544 case MATCHCRITERIA_TO_OR_CC:
545 return matcherprop_string_match(prop, info->to)
546 || matcherprop_string_match(prop, info->cc);
547 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
548 return !(matcherprop_string_match(prop, info->to)
549 || matcherprop_string_match(prop, info->cc));
550 case MATCHCRITERIA_AGE_GREATER:
552 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
553 case MATCHCRITERIA_AGE_LOWER:
555 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
556 case MATCHCRITERIA_SCORE_GREATER:
557 return info->score >= prop->value;
558 case MATCHCRITERIA_SCORE_LOWER:
559 return info->score <= prop->value;
560 case MATCHCRITERIA_SCORE_EQUAL:
561 return info->score == prop->value;
562 case MATCHCRITERIA_SIZE_GREATER:
563 /* FIXME: info->size is an off_t */
564 return info->size > (off_t) prop->value;
565 case MATCHCRITERIA_SIZE_EQUAL:
566 /* FIXME: info->size is an off_t */
567 return info->size == (off_t) prop->value;
568 case MATCHCRITERIA_SIZE_SMALLER:
569 /* FIXME: info->size is an off_t */
570 return info->size < (off_t) prop->value;
571 case MATCHCRITERIA_NEWSGROUPS:
572 return matcherprop_string_match(prop, info->newsgroups);
573 case MATCHCRITERIA_NOT_NEWSGROUPS:
574 return !matcherprop_string_match(prop, info->newsgroups);
575 case MATCHCRITERIA_INREPLYTO:
576 return matcherprop_string_match(prop, info->inreplyto);
577 case MATCHCRITERIA_NOT_INREPLYTO:
578 return !matcherprop_string_match(prop, info->inreplyto);
579 case MATCHCRITERIA_REFERENCES:
580 return matcherprop_string_match(prop, info->references);
581 case MATCHCRITERIA_NOT_REFERENCES:
582 return !matcherprop_string_match(prop, info->references);
583 case MATCHCRITERIA_TEST:
584 return matcherprop_match_test(prop, info);
585 case MATCHCRITERIA_NOT_TEST:
586 return !matcherprop_match_test(prop, info);
592 /* ********************* MatcherList *************************** */
595 *\brief Create a new list of matchers
597 *\param matchers List of matcher structures
598 *\param bool_and Operator
600 *\return MatcherList * New list
602 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
606 cond = g_new0(MatcherList, 1);
608 cond->matchers = matchers;
609 cond->bool_and = bool_and;
615 *\brief Frees a list of matchers
617 *\param cond List of matchers
619 void matcherlist_free(MatcherList *cond)
623 g_return_if_fail(cond);
624 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
625 matcherprop_free((MatcherProp *) l->data);
631 *\brief Skip all headers in a message file
633 *\param fp Message file
635 static void matcherlist_skip_headers(FILE *fp)
639 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
644 *\brief Check if a header matches a matcher condition
646 *\param matcher Matcher structure to check header for
647 *\param buf Header name
649 *\return boolean TRUE if matching header
651 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
657 switch (matcher->criteria) {
658 case MATCHCRITERIA_HEADER:
659 case MATCHCRITERIA_NOT_HEADER:
660 header = procheader_parse_header(buf);
663 if (procheader_headername_equal(header->name,
665 if (matcher->criteria == MATCHCRITERIA_HEADER)
666 result = matcherprop_string_match(matcher, header->body);
668 result = !matcherprop_string_match(matcher, header->body);
669 procheader_header_free(header);
673 procheader_header_free(header);
676 case MATCHCRITERIA_HEADERS_PART:
677 case MATCHCRITERIA_MESSAGE:
678 return matcherprop_string_match(matcher, buf);
679 case MATCHCRITERIA_NOT_MESSAGE:
680 case MATCHCRITERIA_NOT_HEADERS_PART:
681 return !matcherprop_string_match(matcher, buf);
687 *\brief Check if the matcher structure wants headers to
690 *\param matcher Matcher structure
692 *\return gboolean TRUE if the matcher structure describes
693 * a header match condition
695 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
697 switch (matcher->criteria) {
698 case MATCHCRITERIA_HEADER:
699 case MATCHCRITERIA_NOT_HEADER:
700 case MATCHCRITERIA_HEADERS_PART:
701 case MATCHCRITERIA_NOT_HEADERS_PART:
709 *\brief Check if the matcher structure wants the message
710 * to be matched (just perform an action on any
713 *\param matcher Matcher structure
715 *\return gboolean TRUE if matcher condition should match
718 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
720 switch (matcher->criteria) {
721 case MATCHCRITERIA_MESSAGE:
722 case MATCHCRITERIA_NOT_MESSAGE:
730 *\brief Check if a list of conditions match a header
732 *\param matchers One set of conditions
733 *\param buf Name of header
735 *\return gboolean TRUE if matching should stop
737 static gboolean matcherlist_match_one_header(MatcherList *matchers,
742 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
743 MatcherProp *matcher = (MatcherProp *) l->data;
745 /* see if a single condition matches */
746 if (matcherprop_criteria_headers(matcher) ||
747 matcherprop_criteria_message(matcher)) {
748 if (matcherprop_match_one_header(matcher, buf)) {
749 matcher->result = TRUE;
753 if (matcherprop_criteria_headers(matcher)) {
754 if (matcher->result) {
755 if (!matchers->bool_and)
765 *\brief Check if a list of conditions matches one header in
768 *\param matchers List of conditions
769 *\param fp Message file
771 *\return gboolean TRUE if one of the headers is matched by
772 * the list of conditions.
774 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
778 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
779 if (matcherlist_match_one_header(matchers, buf))
786 *\brief Check if a matcher wants to check the message body
788 *\param matcher Matcher structure
790 *\return gboolean TRUE if body must be matched.
792 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
794 switch (matcher->criteria) {
795 case MATCHCRITERIA_BODY_PART:
796 case MATCHCRITERIA_NOT_BODY_PART:
804 *\brief Check if a (line) string matches the criteria
805 * described by a matcher structure
807 *\param matcher Matcher structure
810 *\return gboolean TRUE if string matches criteria
812 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
814 switch (matcher->criteria) {
815 case MATCHCRITERIA_BODY_PART:
816 case MATCHCRITERIA_MESSAGE:
817 return matcherprop_string_match(matcher, line);
818 case MATCHCRITERIA_NOT_BODY_PART:
819 case MATCHCRITERIA_NOT_MESSAGE:
820 return !matcherprop_string_match(matcher, line);
826 *\brief Check if a list of conditions matches a (line) string
828 *\param matchers List of matchers
829 *\param line String to match
831 *\return gboolean TRUE if string matches list of criteria
833 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
837 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
838 MatcherProp *matcher = (MatcherProp *) l->data;
840 if (matcherprop_criteria_body(matcher) ||
841 matcherprop_criteria_message(matcher)) {
842 if (matcherprop_match_line(matcher, line)) {
843 matcher->result = TRUE;
847 if (matcher->result) {
848 if (!matchers->bool_and)
856 *\brief Check if a line in a message file's body matches
859 *\param matchers List of conditions
860 *\param fp Message file
862 *\return gboolean TRUE if succesful match
864 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
868 while (fgets(buf, sizeof(buf), fp) != NULL)
869 if (matcherlist_match_line(matchers, buf))
876 *\brief Check if a message file matches criteria
878 *\param matchers Criteria
879 *\param info Message info
880 *\param result Default result
882 *\return gboolean TRUE if matched
884 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
887 gboolean read_headers;
893 /* file need to be read ? */
895 read_headers = FALSE;
897 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
898 MatcherProp *matcher = (MatcherProp *) l->data;
900 if (matcherprop_criteria_headers(matcher))
902 if (matcherprop_criteria_body(matcher))
904 if (matcherprop_criteria_message(matcher)) {
908 matcher->result = FALSE;
911 if (!read_headers && !read_body)
914 file = procmsg_get_message_file(info);
918 if ((fp = fopen(file, "rb")) == NULL) {
919 FILE_OP_ERROR(file, "fopen");
924 /* read the headers */
927 if (matcherlist_match_headers(matchers, fp))
931 matcherlist_skip_headers(fp);
936 matcherlist_match_body(matchers, fp);
939 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
940 MatcherProp *matcher = (MatcherProp *) l->data;
942 if (matcherprop_criteria_headers(matcher) ||
943 matcherprop_criteria_body(matcher) ||
944 matcherprop_criteria_message(matcher)) {
945 if (matcher->result) {
946 if (!matchers->bool_and) {
952 if (matchers->bool_and) {
968 *\brief Test list of conditions on a message.
970 *\param matchers List of conditions
971 *\param info Message info
973 *\return gboolean TRUE if matched
975 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
980 if (matchers->bool_and)
985 /* test the cached elements */
987 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
988 MatcherProp *matcher = (MatcherProp *) l->data;
990 switch(matcher->criteria) {
991 case MATCHCRITERIA_ALL:
992 case MATCHCRITERIA_UNREAD:
993 case MATCHCRITERIA_NOT_UNREAD:
994 case MATCHCRITERIA_NEW:
995 case MATCHCRITERIA_NOT_NEW:
996 case MATCHCRITERIA_MARKED:
997 case MATCHCRITERIA_NOT_MARKED:
998 case MATCHCRITERIA_DELETED:
999 case MATCHCRITERIA_NOT_DELETED:
1000 case MATCHCRITERIA_REPLIED:
1001 case MATCHCRITERIA_NOT_REPLIED:
1002 case MATCHCRITERIA_FORWARDED:
1003 case MATCHCRITERIA_NOT_FORWARDED:
1004 case MATCHCRITERIA_LOCKED:
1005 case MATCHCRITERIA_NOT_LOCKED:
1006 case MATCHCRITERIA_COLORLABEL:
1007 case MATCHCRITERIA_NOT_COLORLABEL:
1008 case MATCHCRITERIA_IGNORE_THREAD:
1009 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1010 case MATCHCRITERIA_SUBJECT:
1011 case MATCHCRITERIA_NOT_SUBJECT:
1012 case MATCHCRITERIA_FROM:
1013 case MATCHCRITERIA_NOT_FROM:
1014 case MATCHCRITERIA_TO:
1015 case MATCHCRITERIA_NOT_TO:
1016 case MATCHCRITERIA_CC:
1017 case MATCHCRITERIA_NOT_CC:
1018 case MATCHCRITERIA_TO_OR_CC:
1019 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
1020 case MATCHCRITERIA_AGE_GREATER:
1021 case MATCHCRITERIA_AGE_LOWER:
1022 case MATCHCRITERIA_NEWSGROUPS:
1023 case MATCHCRITERIA_NOT_NEWSGROUPS:
1024 case MATCHCRITERIA_INREPLYTO:
1025 case MATCHCRITERIA_NOT_INREPLYTO:
1026 case MATCHCRITERIA_REFERENCES:
1027 case MATCHCRITERIA_NOT_REFERENCES:
1028 case MATCHCRITERIA_SCORE_GREATER:
1029 case MATCHCRITERIA_SCORE_LOWER:
1030 case MATCHCRITERIA_SCORE_EQUAL:
1031 case MATCHCRITERIA_SIZE_GREATER:
1032 case MATCHCRITERIA_SIZE_SMALLER:
1033 case MATCHCRITERIA_SIZE_EQUAL:
1034 case MATCHCRITERIA_TEST:
1035 case MATCHCRITERIA_NOT_TEST:
1036 if (matcherprop_match(matcher, info)) {
1037 if (!matchers->bool_and) {
1042 if (matchers->bool_and) {
1049 /* test the condition on the file */
1051 if (matcherlist_match_file(matchers, info, result)) {
1052 if (!matchers->bool_and)
1056 if (matchers->bool_and)
1064 *\brief Convert a matcher structure to a string
1066 *\param matcher Matcher structure
1068 *\return gchar * Newly allocated string
1070 gchar *matcherprop_to_string(MatcherProp *matcher)
1072 gchar *matcher_str = NULL;
1073 const gchar *criteria_str;
1074 const gchar *matchtype_str;
1078 criteria_str = NULL;
1079 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1080 if (matchparser_tab[i].id == matcher->criteria)
1081 criteria_str = matchparser_tab[i].str;
1083 if (criteria_str == NULL)
1086 switch (matcher->criteria) {
1087 case MATCHCRITERIA_AGE_GREATER:
1088 case MATCHCRITERIA_AGE_LOWER:
1089 case MATCHCRITERIA_SCORE_GREATER:
1090 case MATCHCRITERIA_SCORE_LOWER:
1091 case MATCHCRITERIA_SCORE_EQUAL:
1092 case MATCHCRITERIA_SIZE_GREATER:
1093 case MATCHCRITERIA_SIZE_SMALLER:
1094 case MATCHCRITERIA_SIZE_EQUAL:
1095 case MATCHCRITERIA_COLORLABEL:
1096 case MATCHCRITERIA_NOT_COLORLABEL:
1097 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1098 case MATCHCRITERIA_ALL:
1099 case MATCHCRITERIA_UNREAD:
1100 case MATCHCRITERIA_NOT_UNREAD:
1101 case MATCHCRITERIA_NEW:
1102 case MATCHCRITERIA_NOT_NEW:
1103 case MATCHCRITERIA_MARKED:
1104 case MATCHCRITERIA_NOT_MARKED:
1105 case MATCHCRITERIA_DELETED:
1106 case MATCHCRITERIA_NOT_DELETED:
1107 case MATCHCRITERIA_REPLIED:
1108 case MATCHCRITERIA_NOT_REPLIED:
1109 case MATCHCRITERIA_FORWARDED:
1110 case MATCHCRITERIA_NOT_FORWARDED:
1111 case MATCHCRITERIA_LOCKED:
1112 case MATCHCRITERIA_NOT_LOCKED:
1113 case MATCHCRITERIA_IGNORE_THREAD:
1114 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1115 return g_strdup(criteria_str);
1116 case MATCHCRITERIA_TEST:
1117 case MATCHCRITERIA_NOT_TEST:
1118 expr = matcher_escape_str(matcher->expr);
1119 matcher_str = g_strdup_printf("%s \"%s\"", criteria_str, expr);
1120 g_free((gpointer) expr);
1124 matchtype_str = NULL;
1125 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1126 if (matchparser_tab[i].id == matcher->matchtype)
1127 matchtype_str = matchparser_tab[i].str;
1130 if (matchtype_str == NULL)
1133 switch (matcher->matchtype) {
1134 case MATCHTYPE_MATCH:
1135 case MATCHTYPE_MATCHCASE:
1136 case MATCHTYPE_REGEXP:
1137 case MATCHTYPE_REGEXPCASE:
1138 expr = matcher_escape_str(matcher->expr);
1139 if (matcher->header)
1140 matcher_str = g_strdup_printf
1141 ("%s \"%s\" %s \"%s\"",
1142 criteria_str, matcher->header,
1143 matchtype_str, expr);
1145 matcher_str = g_strdup_printf
1146 ("%s %s \"%s\"", criteria_str,
1147 matchtype_str, expr);
1148 g_free((gpointer) expr);
1156 *\brief Convert a list of conditions to a string
1158 *\param matchers List of conditions
1160 *\return gchar * Newly allocated string
1162 gchar *matcherlist_to_string(const MatcherList *matchers)
1168 gchar *result = NULL;
1170 count = g_slist_length(matchers->matchers);
1171 vstr = g_new(gchar *, count + 1);
1173 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1174 l = g_slist_next(l), cur_str ++) {
1175 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1176 if (*cur_str == NULL)
1181 if (matchers->bool_and)
1182 result = g_strjoinv(" & ", vstr);
1184 result = g_strjoinv(" | ", vstr);
1186 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1193 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1194 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1195 /* matching_build_command() - preferably cmd should be unescaped */
1197 *\brief Build the command line to execute
1199 *\param cmd String with command line specifiers
1200 *\param info Message info to use for command
1202 *\return gchar * Newly allocated string
1204 *\warning The \a cmd string should have been unescaped using
1205 * #matcher_unescape_str.
1207 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1209 const gchar *s = cmd;
1210 gchar *filename = NULL;
1211 gchar *processed_cmd;
1215 const gchar *const no_subject = _("(none)") ;
1216 const gchar *const no_from = _("(none)") ;
1217 const gchar *const no_to = _("(none)") ;
1218 const gchar *const no_cc = _("(none)") ;
1219 const gchar *const no_date = _("(none)") ;
1220 const gchar *const no_msgid = _("(none)") ;
1221 const gchar *const no_newsgroups = _("(none)") ;
1222 const gchar *const no_references = _("(none)") ;
1224 size = STRLEN_ZERO(cmd) + 1;
1225 while (*s != '\0') {
1232 case 's': /* subject */
1233 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1235 case 'f': /* from */
1236 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1239 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1242 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1244 case 'd': /* date */
1245 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1247 case 'i': /* message-id */
1248 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1250 case 'n': /* newsgroups */
1251 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1253 case 'r': /* references */
1254 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1256 case 'F': /* file */
1257 filename = folder_item_fetch_msg(info->folder,
1260 if (filename == NULL) {
1261 g_warning("filename is not set");
1265 size += strlen(filename) - 2;
1273 processed_cmd = g_new0(gchar, size);
1277 while (*s != '\0') {
1285 case 's': /* subject */
1286 if (info->subject != NULL)
1287 strcpy(p, info->subject);
1289 strcpy(p, no_subject);
1292 case 'f': /* from */
1293 if (info->from != NULL)
1294 strcpy(p, info->from);
1300 if (info->to != NULL)
1301 strcpy(p, info->to);
1307 if (info->cc != NULL)
1308 strcpy(p, info->cc);
1313 case 'd': /* date */
1314 if (info->date != NULL)
1315 strcpy(p, info->date);
1320 case 'i': /* message-id */
1321 if (info->msgid != NULL)
1322 strcpy(p, info->msgid);
1324 strcpy(p, no_msgid);
1327 case 'n': /* newsgroups */
1328 if (info->newsgroups != NULL)
1329 strcpy(p, info->newsgroups);
1331 strcpy(p, no_newsgroups);
1334 case 'r': /* references */
1335 if (info->references != NULL)
1336 strcpy(p, info->references);
1338 strcpy(p, no_references);
1341 case 'F': /* file */
1342 strcpy(p, filename);
1362 return processed_cmd;
1364 #undef STRLEN_DEFAULT
1367 /* ************************************************************ */
1371 *\brief Write filtering list to file
1374 *\param prefs_filtering List of filtering conditions
1376 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1380 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1381 gchar *filtering_str;
1382 FilteringProp *prop;
1384 if (NULL == (prop = (FilteringProp *) cur->data))
1387 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1390 if (fputs(filtering_str, fp) == EOF ||
1391 fputc('\n', fp) == EOF) {
1392 FILE_OP_ERROR("filtering config", "fputs || fputc");
1393 g_free(filtering_str);
1396 g_free(filtering_str);
1401 *\brief Write matchers from a folder item
1403 *\param node Node with folder info
1404 *\param data File pointer
1406 *\return gboolean FALSE
1408 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1413 GSList *prefs_filtering;
1416 /* prevent warning */
1417 if (item->path == NULL)
1419 id = folder_item_get_identifier(item);
1422 prefs_filtering = item->prefs->processing;
1424 if (prefs_filtering != NULL) {
1425 fprintf(fp, "[%s]\n", id);
1426 prefs_filtering_write(fp, prefs_filtering);
1436 *\brief Save matchers from folder items
1440 static void prefs_matcher_save(FILE *fp)
1444 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1447 folder = (Folder *) cur->data;
1448 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1449 prefs_matcher_write_func, fp);
1453 fprintf(fp, "[global]\n");
1454 prefs_filtering_write(fp, global_processing);
1457 /* filtering rules */
1458 fprintf(fp, "[filtering]\n");
1459 prefs_filtering_write(fp, filtering_rules);
1464 *\brief Write filtering / matcher configuration file
1466 void prefs_matcher_write_config(void)
1471 debug_print("Writing matcher configuration...\n");
1473 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1476 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1477 g_warning("failed to write configuration to file\n");
1483 prefs_matcher_save(pfile->fp);
1487 if (prefs_file_close(pfile) < 0) {
1488 g_warning("failed to write configuration to file\n");
1493 /* ******************************************************************* */
1496 *\brief Read matcher configuration
1498 void prefs_matcher_read_config(void)
1503 create_matchparser_hashtab();
1504 prefs_filtering_clear();
1506 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1507 f = fopen(rcpath, "rb");
1511 matcher_parser_start_parsing(f);
1515 /* previous version compatibily */
1517 /* printf("reading filtering\n"); */
1518 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1519 FILTERING_RC, NULL);
1520 f = fopen(rcpath, "rb");
1524 matcher_parser_start_parsing(f);
1525 fclose(matcher_parserin);
1528 /* printf("reading scoring\n"); */
1529 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1531 f = fopen(rcpath, "rb");
1535 matcher_parser_start_parsing(f);
1536 fclose(matcher_parserin);