2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002-2004 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"
31 #include "addr_compl.h"
35 *\brief Keyword lookup element
38 gint id; /*!< keyword id */
39 gchar *str; /*!< keyword */
41 typedef struct _MatchParser MatchParser;
44 *\brief Table with strings and ids used by the lexer and
45 * the parser. New keywords can be added here.
47 static const MatchParser matchparser_tab[] = {
49 {MATCHCRITERIA_ALL, "all"},
50 {MATCHCRITERIA_UNREAD, "unread"},
51 {MATCHCRITERIA_NOT_UNREAD, "~unread"},
52 {MATCHCRITERIA_NEW, "new"},
53 {MATCHCRITERIA_NOT_NEW, "~new"},
54 {MATCHCRITERIA_MARKED, "marked"},
55 {MATCHCRITERIA_NOT_MARKED, "~marked"},
56 {MATCHCRITERIA_DELETED, "deleted"},
57 {MATCHCRITERIA_NOT_DELETED, "~deleted"},
58 {MATCHCRITERIA_REPLIED, "replied"},
59 {MATCHCRITERIA_NOT_REPLIED, "~replied"},
60 {MATCHCRITERIA_FORWARDED, "forwarded"},
61 {MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
62 {MATCHCRITERIA_LOCKED, "locked"},
63 {MATCHCRITERIA_NOT_LOCKED, "~locked"},
64 {MATCHCRITERIA_COLORLABEL, "colorlabel"},
65 {MATCHCRITERIA_NOT_COLORLABEL, "~colorlabel"},
66 {MATCHCRITERIA_IGNORE_THREAD, "ignore_thread"},
67 {MATCHCRITERIA_NOT_IGNORE_THREAD, "~ignore_thread"},
70 {MATCHCRITERIA_SUBJECT, "subject"},
71 {MATCHCRITERIA_NOT_SUBJECT, "~subject"},
72 {MATCHCRITERIA_FROM, "from"},
73 {MATCHCRITERIA_NOT_FROM, "~from"},
74 {MATCHCRITERIA_TO, "to"},
75 {MATCHCRITERIA_NOT_TO, "~to"},
76 {MATCHCRITERIA_CC, "cc"},
77 {MATCHCRITERIA_NOT_CC, "~cc"},
78 {MATCHCRITERIA_TO_OR_CC, "to_or_cc"},
79 {MATCHCRITERIA_NOT_TO_AND_NOT_CC, "~to_or_cc"},
80 {MATCHCRITERIA_AGE_GREATER, "age_greater"},
81 {MATCHCRITERIA_AGE_LOWER, "age_lower"},
82 {MATCHCRITERIA_NEWSGROUPS, "newsgroups"},
83 {MATCHCRITERIA_NOT_NEWSGROUPS, "~newsgroups"},
84 {MATCHCRITERIA_INREPLYTO, "inreplyto"},
85 {MATCHCRITERIA_NOT_INREPLYTO, "~inreplyto"},
86 {MATCHCRITERIA_REFERENCES, "references"},
87 {MATCHCRITERIA_NOT_REFERENCES, "~references"},
88 {MATCHCRITERIA_SCORE_GREATER, "score_greater"},
89 {MATCHCRITERIA_SCORE_LOWER, "score_lower"},
90 {MATCHCRITERIA_SCORE_EQUAL, "score_equal"},
92 {MATCHCRITERIA_SIZE_GREATER, "size_greater"},
93 {MATCHCRITERIA_SIZE_SMALLER, "size_smaller"},
94 {MATCHCRITERIA_SIZE_EQUAL, "size_equal"},
96 /* content have to be read */
97 {MATCHCRITERIA_HEADER, "header"},
98 {MATCHCRITERIA_NOT_HEADER, "~header"},
99 {MATCHCRITERIA_HEADERS_PART, "headers_part"},
100 {MATCHCRITERIA_NOT_HEADERS_PART, "~headers_part"},
101 {MATCHCRITERIA_MESSAGE, "message"},
102 {MATCHCRITERIA_NOT_MESSAGE, "~message"},
103 {MATCHCRITERIA_BODY_PART, "body_part"},
104 {MATCHCRITERIA_NOT_BODY_PART, "~body_part"},
105 {MATCHCRITERIA_TEST, "test"},
106 {MATCHCRITERIA_NOT_TEST, "~test"},
109 {MATCHTYPE_MATCHCASE, "matchcase"},
110 {MATCHTYPE_MATCH, "match"},
111 {MATCHTYPE_REGEXPCASE, "regexpcase"},
112 {MATCHTYPE_REGEXP, "regexp"},
113 {MATCHTYPE_ANY_IN_ADDRESSBOOK, "any_in_addressbook"},
114 {MATCHTYPE_ALL_IN_ADDRESSBOOK, "all_in_addressbook"},
117 {MATCHACTION_SCORE, "score"}, /* for backward compatibility */
118 {MATCHACTION_MOVE, "move"},
119 {MATCHACTION_COPY, "copy"},
120 {MATCHACTION_DELETE, "delete"},
121 {MATCHACTION_MARK, "mark"},
122 {MATCHACTION_UNMARK, "unmark"},
123 {MATCHACTION_LOCK, "lock"},
124 {MATCHACTION_UNLOCK, "unlock"},
125 {MATCHACTION_MARK_AS_READ, "mark_as_read"},
126 {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
127 {MATCHACTION_FORWARD, "forward"},
128 {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
129 {MATCHACTION_EXECUTE, "execute"},
130 {MATCHACTION_COLOR, "color"},
131 {MATCHACTION_REDIRECT, "redirect"},
132 {MATCHACTION_CHANGE_SCORE, "change_score"},
133 {MATCHACTION_SET_SCORE, "set_score"},
134 {MATCHACTION_STOP, "stop"},
135 {MATCHACTION_HIDE, "hide"},
139 *\brief Look up table with keywords defined in \sa matchparser_tab
141 static GHashTable *matchparser_hashtab;
144 *\brief Translate keyword id to keyword string
146 *\param id Id of keyword
148 *\return const gchar * Keyword
150 const gchar *get_matchparser_tab_str(gint id)
154 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
155 if (matchparser_tab[i].id == id)
156 return matchparser_tab[i].str;
162 *\brief Create keyword lookup table
164 static void create_matchparser_hashtab(void)
168 if (matchparser_hashtab) return;
169 matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
170 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
171 g_hash_table_insert(matchparser_hashtab,
172 matchparser_tab[i].str,
173 (gpointer) &matchparser_tab[i]);
177 *\brief Return a keyword id from a keyword string
179 *\param str Keyword string
181 *\return gint Keyword id
183 gint get_matchparser_tab_id(const gchar *str)
187 if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
193 /* **************** data structure allocation **************** */
196 *\brief Allocate a structure for a filtering / scoring
197 * "condition" (a matcher structure)
199 *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
200 *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
201 *\param matchtype Type of action (MATCHTYPE_XXX)
202 *\param expr String value or expression to check
203 *\param value Integer value to check
205 *\return MatcherProp * Pointer to newly allocated structure
207 MatcherProp *matcherprop_new(gint criteria, const gchar *header,
208 gint matchtype, const gchar *expr,
213 prop = g_new0(MatcherProp, 1);
214 prop->criteria = criteria;
215 prop->header = header != NULL ? g_strdup(header) : NULL;
216 prop->expr = expr != NULL ? g_strdup(expr) : NULL;
217 prop->matchtype = matchtype;
226 *\brief Free a matcher structure
228 *\param prop Pointer to matcher structure allocated with
231 void matcherprop_free(MatcherProp *prop)
236 g_free(prop->header);
237 if (prop->preg != NULL) {
245 *\brief Copy a matcher structure
247 *\param src Matcher structure to copy
249 *\return MatcherProp * Pointer to newly allocated matcher structure
251 MatcherProp *matcherprop_copy(const MatcherProp *src)
253 MatcherProp *prop = g_new0(MatcherProp, 1);
255 prop->criteria = src->criteria;
256 prop->header = src->header ? g_strdup(src->header) : NULL;
257 prop->expr = src->expr ? g_strdup(src->expr) : NULL;
258 prop->matchtype = src->matchtype;
260 prop->preg = NULL; /* will be re-evaluated */
261 prop->value = src->value;
262 prop->error = src->error;
266 /* ************** match ******************************/
268 static gboolean match_with_addresses_in_addressbook
269 (MatcherProp *prop, const gchar *str, gint type)
271 GSList *address_list = NULL;
273 gboolean res = FALSE;
275 if (str == NULL || *str == 0)
278 /* XXX: perhaps complete with comments too */
279 address_list = address_list_append(address_list, str);
283 start_address_completion();
285 for (walk = address_list; walk != NULL; walk = walk->next) {
286 gboolean found = complete_address(walk->data) ? TRUE : FALSE;
287 if (!found && type == MATCHTYPE_ALL_IN_ADDRESSBOOK) {
294 end_address_completion();
299 *\brief Find out if a string matches a condition
301 *\param prop Matcher structure
302 *\param str String to check
304 *\return gboolean TRUE if str matches the condition in the
307 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
315 switch (prop->matchtype) {
316 case MATCHTYPE_REGEXPCASE:
317 case MATCHTYPE_REGEXP:
318 if (!prop->preg && (prop->error == 0)) {
319 prop->preg = g_new0(regex_t, 1);
320 /* if regexp then don't use the escaped string */
321 if (regcomp(prop->preg, prop->expr,
322 REG_NOSUB | REG_EXTENDED
323 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
324 ? REG_ICASE : 0)) != 0) {
330 if (prop->preg == NULL)
333 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
338 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
339 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
340 return match_with_addresses_in_addressbook
341 (prop, str, prop->matchtype);
343 case MATCHTYPE_MATCH:
344 return (strstr(str, prop->expr) != NULL);
346 /* FIXME: put upper in unesc_str */
347 case MATCHTYPE_MATCHCASE:
348 str2 = alloca(strlen(prop->expr) + 1);
349 strcpy(str2, prop->expr);
351 str1 = alloca(strlen(str) + 1);
354 return (strstr(str1, str2) != NULL);
362 *\brief Execute a command defined in the matcher structure
364 *\param prop Pointer to matcher structure
365 *\param info Pointer to message info structure
367 *\return gboolean TRUE if command was executed succesfully
369 static gboolean matcherprop_match_test(const MatcherProp *prop,
376 file = procmsg_get_message_file(info);
381 cmd = matching_build_command(prop->expr, info);
385 retval = system(cmd);
386 debug_print("Command exit code: %d\n", retval);
389 return (retval == 0);
393 *\brief Check if a message matches the condition in a matcher
396 *\param prop Pointer to matcher structure
397 *\param info Pointer to message info
399 *\return gboolean TRUE if a match
401 gboolean matcherprop_match(MatcherProp *prop,
406 switch(prop->criteria) {
407 case MATCHCRITERIA_ALL:
409 case MATCHCRITERIA_UNREAD:
410 return MSG_IS_UNREAD(info->flags);
411 case MATCHCRITERIA_NOT_UNREAD:
412 return !MSG_IS_UNREAD(info->flags);
413 case MATCHCRITERIA_NEW:
414 return MSG_IS_NEW(info->flags);
415 case MATCHCRITERIA_NOT_NEW:
416 return !MSG_IS_NEW(info->flags);
417 case MATCHCRITERIA_MARKED:
418 return MSG_IS_MARKED(info->flags);
419 case MATCHCRITERIA_NOT_MARKED:
420 return !MSG_IS_MARKED(info->flags);
421 case MATCHCRITERIA_DELETED:
422 return MSG_IS_DELETED(info->flags);
423 case MATCHCRITERIA_NOT_DELETED:
424 return !MSG_IS_DELETED(info->flags);
425 case MATCHCRITERIA_REPLIED:
426 return MSG_IS_REPLIED(info->flags);
427 case MATCHCRITERIA_NOT_REPLIED:
428 return !MSG_IS_REPLIED(info->flags);
429 case MATCHCRITERIA_FORWARDED:
430 return MSG_IS_FORWARDED(info->flags);
431 case MATCHCRITERIA_NOT_FORWARDED:
432 return !MSG_IS_FORWARDED(info->flags);
433 case MATCHCRITERIA_LOCKED:
434 return MSG_IS_LOCKED(info->flags);
435 case MATCHCRITERIA_NOT_LOCKED:
436 return !MSG_IS_LOCKED(info->flags);
437 case MATCHCRITERIA_COLORLABEL:
438 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
439 case MATCHCRITERIA_NOT_COLORLABEL:
440 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
441 case MATCHCRITERIA_IGNORE_THREAD:
442 return MSG_IS_IGNORE_THREAD(info->flags);
443 case MATCHCRITERIA_NOT_IGNORE_THREAD:
444 return !MSG_IS_IGNORE_THREAD(info->flags);
445 case MATCHCRITERIA_SUBJECT:
446 return matcherprop_string_match(prop, info->subject);
447 case MATCHCRITERIA_NOT_SUBJECT:
448 return !matcherprop_string_match(prop, info->subject);
449 case MATCHCRITERIA_FROM:
450 return matcherprop_string_match(prop, info->from);
451 case MATCHCRITERIA_NOT_FROM:
452 return !matcherprop_string_match(prop, info->from);
453 case MATCHCRITERIA_TO:
454 return matcherprop_string_match(prop, info->to);
455 case MATCHCRITERIA_NOT_TO:
456 return !matcherprop_string_match(prop, info->to);
457 case MATCHCRITERIA_CC:
458 return matcherprop_string_match(prop, info->cc);
459 case MATCHCRITERIA_NOT_CC:
460 return !matcherprop_string_match(prop, info->cc);
461 case MATCHCRITERIA_TO_OR_CC:
462 return matcherprop_string_match(prop, info->to)
463 || matcherprop_string_match(prop, info->cc);
464 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
465 return !(matcherprop_string_match(prop, info->to)
466 || matcherprop_string_match(prop, info->cc));
467 case MATCHCRITERIA_AGE_GREATER:
469 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
470 case MATCHCRITERIA_AGE_LOWER:
472 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
473 case MATCHCRITERIA_SCORE_GREATER:
474 return info->score >= prop->value;
475 case MATCHCRITERIA_SCORE_LOWER:
476 return info->score <= prop->value;
477 case MATCHCRITERIA_SCORE_EQUAL:
478 return info->score == prop->value;
479 case MATCHCRITERIA_SIZE_GREATER:
480 /* FIXME: info->size is an off_t */
481 return info->size > (off_t) prop->value;
482 case MATCHCRITERIA_SIZE_EQUAL:
483 /* FIXME: info->size is an off_t */
484 return info->size == (off_t) prop->value;
485 case MATCHCRITERIA_SIZE_SMALLER:
486 /* FIXME: info->size is an off_t */
487 return info->size < (off_t) prop->value;
488 case MATCHCRITERIA_NEWSGROUPS:
489 return matcherprop_string_match(prop, info->newsgroups);
490 case MATCHCRITERIA_NOT_NEWSGROUPS:
491 return !matcherprop_string_match(prop, info->newsgroups);
492 case MATCHCRITERIA_INREPLYTO:
493 return matcherprop_string_match(prop, info->inreplyto);
494 case MATCHCRITERIA_NOT_INREPLYTO:
495 return !matcherprop_string_match(prop, info->inreplyto);
496 case MATCHCRITERIA_REFERENCES:
497 return matcherprop_string_match(prop, info->references);
498 case MATCHCRITERIA_NOT_REFERENCES:
499 return !matcherprop_string_match(prop, info->references);
500 case MATCHCRITERIA_TEST:
501 return matcherprop_match_test(prop, info);
502 case MATCHCRITERIA_NOT_TEST:
503 return !matcherprop_match_test(prop, info);
509 /* ********************* MatcherList *************************** */
512 *\brief Create a new list of matchers
514 *\param matchers List of matcher structures
515 *\param bool_and Operator
517 *\return MatcherList * New list
519 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
523 cond = g_new0(MatcherList, 1);
525 cond->matchers = matchers;
526 cond->bool_and = bool_and;
532 *\brief Frees a list of matchers
534 *\param cond List of matchers
536 void matcherlist_free(MatcherList *cond)
540 g_return_if_fail(cond);
541 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
542 matcherprop_free((MatcherProp *) l->data);
548 *\brief Skip all headers in a message file
550 *\param fp Message file
552 static void matcherlist_skip_headers(FILE *fp)
556 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
561 *\brief Check if a header matches a matcher condition
563 *\param matcher Matcher structure to check header for
564 *\param buf Header name
566 *\return boolean TRUE if matching header
568 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
574 switch (matcher->criteria) {
575 case MATCHCRITERIA_HEADER:
576 case MATCHCRITERIA_NOT_HEADER:
577 header = procheader_parse_header(buf);
580 if (procheader_headername_equal(header->name,
582 if (matcher->criteria == MATCHCRITERIA_HEADER)
583 result = matcherprop_string_match(matcher, header->body);
585 result = !matcherprop_string_match(matcher, header->body);
586 procheader_header_free(header);
590 procheader_header_free(header);
593 case MATCHCRITERIA_HEADERS_PART:
594 case MATCHCRITERIA_MESSAGE:
595 return matcherprop_string_match(matcher, buf);
596 case MATCHCRITERIA_NOT_MESSAGE:
597 case MATCHCRITERIA_NOT_HEADERS_PART:
598 return !matcherprop_string_match(matcher, buf);
604 *\brief Check if the matcher structure wants headers to
607 *\param matcher Matcher structure
609 *\return gboolean TRUE if the matcher structure describes
610 * a header match condition
612 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
614 switch (matcher->criteria) {
615 case MATCHCRITERIA_HEADER:
616 case MATCHCRITERIA_NOT_HEADER:
617 case MATCHCRITERIA_HEADERS_PART:
618 case MATCHCRITERIA_NOT_HEADERS_PART:
626 *\brief Check if the matcher structure wants the message
627 * to be matched (just perform an action on any
630 *\param matcher Matcher structure
632 *\return gboolean TRUE if matcher condition should match
635 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
637 switch (matcher->criteria) {
638 case MATCHCRITERIA_MESSAGE:
639 case MATCHCRITERIA_NOT_MESSAGE:
647 *\brief Check if a list of conditions match a header
649 *\param matchers One set of conditions
650 *\param buf Name of header
652 *\return gboolean TRUE if matching should stop
654 static gboolean matcherlist_match_one_header(MatcherList *matchers,
659 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
660 MatcherProp *matcher = (MatcherProp *) l->data;
662 /* see if a single condition matches */
663 if (matcherprop_criteria_headers(matcher) ||
664 matcherprop_criteria_message(matcher)) {
665 if (matcherprop_match_one_header(matcher, buf)) {
666 matcher->result = TRUE;
670 if (matcherprop_criteria_headers(matcher)) {
671 if (matcher->result) {
672 if (!matchers->bool_and)
682 *\brief Check if a list of conditions matches one header in
685 *\param matchers List of conditions
686 *\param fp Message file
688 *\return gboolean TRUE if one of the headers is matched by
689 * the list of conditions.
691 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
695 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
696 if (matcherlist_match_one_header(matchers, buf))
703 *\brief Check if a matcher wants to check the message body
705 *\param matcher Matcher structure
707 *\return gboolean TRUE if body must be matched.
709 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
711 switch (matcher->criteria) {
712 case MATCHCRITERIA_BODY_PART:
713 case MATCHCRITERIA_NOT_BODY_PART:
721 *\brief Check if a (line) string matches the criteria
722 * described by a matcher structure
724 *\param matcher Matcher structure
727 *\return gboolean TRUE if string matches criteria
729 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
731 switch (matcher->criteria) {
732 case MATCHCRITERIA_BODY_PART:
733 case MATCHCRITERIA_MESSAGE:
734 return matcherprop_string_match(matcher, line);
735 case MATCHCRITERIA_NOT_BODY_PART:
736 case MATCHCRITERIA_NOT_MESSAGE:
737 return !matcherprop_string_match(matcher, line);
743 *\brief Check if a list of conditions matches a (line) string
745 *\param matchers List of matchers
746 *\param line String to match
748 *\return gboolean TRUE if string matches list of criteria
750 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
754 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
755 MatcherProp *matcher = (MatcherProp *) l->data;
757 if (matcherprop_criteria_body(matcher) ||
758 matcherprop_criteria_message(matcher)) {
759 if (matcherprop_match_line(matcher, line)) {
760 matcher->result = TRUE;
764 if (matcher->result) {
765 if (!matchers->bool_and)
773 *\brief Check if a line in a message file's body matches
776 *\param matchers List of conditions
777 *\param fp Message file
779 *\return gboolean TRUE if succesful match
781 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
785 while (fgets(buf, sizeof(buf), fp) != NULL)
786 if (matcherlist_match_line(matchers, buf))
793 *\brief Check if a message file matches criteria
795 *\param matchers Criteria
796 *\param info Message info
797 *\param result Default result
799 *\return gboolean TRUE if matched
801 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
804 gboolean read_headers;
810 /* file need to be read ? */
812 read_headers = FALSE;
814 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
815 MatcherProp *matcher = (MatcherProp *) l->data;
817 if (matcherprop_criteria_headers(matcher))
819 if (matcherprop_criteria_body(matcher))
821 if (matcherprop_criteria_message(matcher)) {
825 matcher->result = FALSE;
828 if (!read_headers && !read_body)
831 file = procmsg_get_message_file(info);
835 if ((fp = fopen(file, "rb")) == NULL) {
836 FILE_OP_ERROR(file, "fopen");
841 /* read the headers */
844 if (matcherlist_match_headers(matchers, fp))
848 matcherlist_skip_headers(fp);
853 matcherlist_match_body(matchers, fp);
856 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
857 MatcherProp *matcher = (MatcherProp *) l->data;
859 if (matcherprop_criteria_headers(matcher) ||
860 matcherprop_criteria_body(matcher) ||
861 matcherprop_criteria_message(matcher)) {
862 if (matcher->result) {
863 if (!matchers->bool_and) {
869 if (matchers->bool_and) {
885 *\brief Test list of conditions on a message.
887 *\param matchers List of conditions
888 *\param info Message info
890 *\return gboolean TRUE if matched
892 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
897 if (matchers->bool_and)
902 /* test the cached elements */
904 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
905 MatcherProp *matcher = (MatcherProp *) l->data;
907 switch(matcher->criteria) {
908 case MATCHCRITERIA_ALL:
909 case MATCHCRITERIA_UNREAD:
910 case MATCHCRITERIA_NOT_UNREAD:
911 case MATCHCRITERIA_NEW:
912 case MATCHCRITERIA_NOT_NEW:
913 case MATCHCRITERIA_MARKED:
914 case MATCHCRITERIA_NOT_MARKED:
915 case MATCHCRITERIA_DELETED:
916 case MATCHCRITERIA_NOT_DELETED:
917 case MATCHCRITERIA_REPLIED:
918 case MATCHCRITERIA_NOT_REPLIED:
919 case MATCHCRITERIA_FORWARDED:
920 case MATCHCRITERIA_NOT_FORWARDED:
921 case MATCHCRITERIA_LOCKED:
922 case MATCHCRITERIA_NOT_LOCKED:
923 case MATCHCRITERIA_COLORLABEL:
924 case MATCHCRITERIA_NOT_COLORLABEL:
925 case MATCHCRITERIA_IGNORE_THREAD:
926 case MATCHCRITERIA_NOT_IGNORE_THREAD:
927 case MATCHCRITERIA_SUBJECT:
928 case MATCHCRITERIA_NOT_SUBJECT:
929 case MATCHCRITERIA_FROM:
930 case MATCHCRITERIA_NOT_FROM:
931 case MATCHCRITERIA_TO:
932 case MATCHCRITERIA_NOT_TO:
933 case MATCHCRITERIA_CC:
934 case MATCHCRITERIA_NOT_CC:
935 case MATCHCRITERIA_TO_OR_CC:
936 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
937 case MATCHCRITERIA_AGE_GREATER:
938 case MATCHCRITERIA_AGE_LOWER:
939 case MATCHCRITERIA_NEWSGROUPS:
940 case MATCHCRITERIA_NOT_NEWSGROUPS:
941 case MATCHCRITERIA_INREPLYTO:
942 case MATCHCRITERIA_NOT_INREPLYTO:
943 case MATCHCRITERIA_REFERENCES:
944 case MATCHCRITERIA_NOT_REFERENCES:
945 case MATCHCRITERIA_SCORE_GREATER:
946 case MATCHCRITERIA_SCORE_LOWER:
947 case MATCHCRITERIA_SCORE_EQUAL:
948 case MATCHCRITERIA_SIZE_GREATER:
949 case MATCHCRITERIA_SIZE_SMALLER:
950 case MATCHCRITERIA_SIZE_EQUAL:
951 case MATCHCRITERIA_TEST:
952 case MATCHCRITERIA_NOT_TEST:
953 if (matcherprop_match(matcher, info)) {
954 if (!matchers->bool_and) {
959 if (matchers->bool_and) {
966 /* test the condition on the file */
968 if (matcherlist_match_file(matchers, info, result)) {
969 if (!matchers->bool_and)
973 if (matchers->bool_and)
981 static gint quote_filter_str(gchar * result, guint size,
991 for(p = path ; * p != '\0' ; p ++) {
993 if ((* p != '\"') && (* p != '\\')) {
1000 result[size - 1] = '\0';
1005 if (remaining >= 2) {
1013 result[size - 1] = '\0';
1018 if (remaining > 0) {
1022 result[size - 1] = '\0';
1030 gchar * matcher_quote_str(const gchar * src)
1035 len = strlen(src) * 2 + 1;
1036 res = g_malloc(len);
1037 quote_filter_str(res, len, src);
1043 *\brief Convert a matcher structure to a string
1045 *\param matcher Matcher structure
1047 *\return gchar * Newly allocated string
1049 gchar *matcherprop_to_string(MatcherProp *matcher)
1051 gchar *matcher_str = NULL;
1052 const gchar *criteria_str;
1053 const gchar *matchtype_str;
1055 gchar * quoted_expr;
1057 criteria_str = NULL;
1058 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1059 if (matchparser_tab[i].id == matcher->criteria)
1060 criteria_str = matchparser_tab[i].str;
1062 if (criteria_str == NULL)
1065 switch (matcher->criteria) {
1066 case MATCHCRITERIA_AGE_GREATER:
1067 case MATCHCRITERIA_AGE_LOWER:
1068 case MATCHCRITERIA_SCORE_GREATER:
1069 case MATCHCRITERIA_SCORE_LOWER:
1070 case MATCHCRITERIA_SCORE_EQUAL:
1071 case MATCHCRITERIA_SIZE_GREATER:
1072 case MATCHCRITERIA_SIZE_SMALLER:
1073 case MATCHCRITERIA_SIZE_EQUAL:
1074 case MATCHCRITERIA_COLORLABEL:
1075 case MATCHCRITERIA_NOT_COLORLABEL:
1076 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1077 case MATCHCRITERIA_ALL:
1078 case MATCHCRITERIA_UNREAD:
1079 case MATCHCRITERIA_NOT_UNREAD:
1080 case MATCHCRITERIA_NEW:
1081 case MATCHCRITERIA_NOT_NEW:
1082 case MATCHCRITERIA_MARKED:
1083 case MATCHCRITERIA_NOT_MARKED:
1084 case MATCHCRITERIA_DELETED:
1085 case MATCHCRITERIA_NOT_DELETED:
1086 case MATCHCRITERIA_REPLIED:
1087 case MATCHCRITERIA_NOT_REPLIED:
1088 case MATCHCRITERIA_FORWARDED:
1089 case MATCHCRITERIA_NOT_FORWARDED:
1090 case MATCHCRITERIA_LOCKED:
1091 case MATCHCRITERIA_NOT_LOCKED:
1092 case MATCHCRITERIA_IGNORE_THREAD:
1093 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1094 return g_strdup(criteria_str);
1095 case MATCHCRITERIA_TEST:
1096 case MATCHCRITERIA_NOT_TEST:
1097 quoted_expr = matcher_quote_str(matcher->expr);
1098 matcher_str = g_strdup_printf("%s \"%s\"",
1099 criteria_str, quoted_expr);
1100 g_free(quoted_expr);
1104 matchtype_str = NULL;
1105 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1106 if (matchparser_tab[i].id == matcher->matchtype)
1107 matchtype_str = matchparser_tab[i].str;
1110 if (matchtype_str == NULL)
1113 switch (matcher->matchtype) {
1114 case MATCHTYPE_MATCH:
1115 case MATCHTYPE_MATCHCASE:
1116 case MATCHTYPE_REGEXP:
1117 case MATCHTYPE_REGEXPCASE:
1118 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
1119 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
1120 quoted_expr = matcher_quote_str(matcher->expr);
1121 if (matcher->header) {
1122 gchar * quoted_header;
1124 quoted_header = matcher_quote_str(matcher->header);
1125 matcher_str = g_strdup_printf
1126 ("%s \"%s\" %s \"%s\"",
1127 criteria_str, quoted_header,
1128 matchtype_str, quoted_expr);
1129 g_free(quoted_header);
1132 matcher_str = g_strdup_printf
1133 ("%s %s \"%s\"", criteria_str,
1134 matchtype_str, quoted_expr);
1135 g_free(quoted_expr);
1143 *\brief Convert a list of conditions to a string
1145 *\param matchers List of conditions
1147 *\return gchar * Newly allocated string
1149 gchar *matcherlist_to_string(const MatcherList *matchers)
1155 gchar *result = NULL;
1157 count = g_slist_length(matchers->matchers);
1158 vstr = g_new(gchar *, count + 1);
1160 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1161 l = g_slist_next(l), cur_str ++) {
1162 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1163 if (*cur_str == NULL)
1168 if (matchers->bool_and)
1169 result = g_strjoinv(" & ", vstr);
1171 result = g_strjoinv(" | ", vstr);
1173 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1181 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1182 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1184 static void add_str_default(gchar ** dest,
1185 const gchar * s, const gchar * d)
1187 gchar quoted_str[4096];
1195 quote_cmd_argument(quoted_str, sizeof(quoted_str), str);
1196 strcpy(* dest, quoted_str);
1198 (* dest) += strlen(* dest);
1201 /* matching_build_command() - preferably cmd should be unescaped */
1203 *\brief Build the command line to execute
1205 *\param cmd String with command line specifiers
1206 *\param info Message info to use for command
1208 *\return gchar * Newly allocated string
1210 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1212 const gchar *s = cmd;
1213 gchar *filename = NULL;
1214 gchar *processed_cmd;
1218 const gchar *const no_subject = _("(none)") ;
1219 const gchar *const no_from = _("(none)") ;
1220 const gchar *const no_to = _("(none)") ;
1221 const gchar *const no_cc = _("(none)") ;
1222 const gchar *const no_date = _("(none)") ;
1223 const gchar *const no_msgid = _("(none)") ;
1224 const gchar *const no_newsgroups = _("(none)") ;
1225 const gchar *const no_references = _("(none)") ;
1227 size = STRLEN_ZERO(cmd) + 1;
1228 while (*s != '\0') {
1235 case 's': /* subject */
1236 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1238 case 'f': /* from */
1239 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1242 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1245 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1247 case 'd': /* date */
1248 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1250 case 'i': /* message-id */
1251 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1253 case 'n': /* newsgroups */
1254 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1256 case 'r': /* references */
1257 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1259 case 'F': /* file */
1260 if (filename == NULL)
1261 filename = folder_item_fetch_msg(info->folder, info->msgnum);
1263 if (filename == NULL) {
1264 g_warning("filename is not set");
1268 size += strlen(filename) - 2;
1277 /* as the string can be quoted, we double the result */
1280 processed_cmd = g_new0(gchar, size);
1284 while (*s != '\0') {
1292 case 's': /* subject */
1293 add_str_default(&p, info->subject,
1296 case 'f': /* from */
1297 add_str_default(&p, info->from,
1301 add_str_default(&p, info->to,
1305 add_str_default(&p, info->cc,
1308 case 'd': /* date */
1309 add_str_default(&p, info->date,
1312 case 'i': /* message-id */
1313 add_str_default(&p, info->msgid,
1316 case 'n': /* newsgroups */
1317 add_str_default(&p, info->newsgroups,
1320 case 'r': /* references */
1321 add_str_default(&p, info->references,
1324 case 'F': /* file */
1325 if (filename != NULL)
1326 add_str_default(&p, filename, NULL);
1345 return processed_cmd;
1347 #undef STRLEN_DEFAULT
1350 /* ************************************************************ */
1354 *\brief Write filtering list to file
1357 *\param prefs_filtering List of filtering conditions
1359 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1363 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1364 gchar *filtering_str;
1365 FilteringProp *prop;
1367 if (NULL == (prop = (FilteringProp *) cur->data))
1370 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1373 if (fputs(filtering_str, fp) == EOF ||
1374 fputc('\n', fp) == EOF) {
1375 FILE_OP_ERROR("filtering config", "fputs || fputc");
1376 g_free(filtering_str);
1379 g_free(filtering_str);
1384 *\brief Write matchers from a folder item
1386 *\param node Node with folder info
1387 *\param data File pointer
1389 *\return gboolean FALSE
1391 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1396 GSList *prefs_filtering;
1399 /* prevent warning */
1400 if (item->path == NULL)
1402 id = folder_item_get_identifier(item);
1405 prefs_filtering = item->prefs->processing;
1407 if (prefs_filtering != NULL) {
1408 fprintf(fp, "[%s]\n", id);
1409 prefs_filtering_write(fp, prefs_filtering);
1419 *\brief Save matchers from folder items
1423 static void prefs_matcher_save(FILE *fp)
1427 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1430 folder = (Folder *) cur->data;
1431 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1432 prefs_matcher_write_func, fp);
1435 /* pre global rules */
1436 fprintf(fp, "[preglobal]\n");
1437 prefs_filtering_write(fp, pre_global_processing);
1440 /* post global rules */
1441 fprintf(fp, "[postglobal]\n");
1442 prefs_filtering_write(fp, post_global_processing);
1445 /* filtering rules */
1446 fprintf(fp, "[filtering]\n");
1447 prefs_filtering_write(fp, filtering_rules);
1452 *\brief Write filtering / matcher configuration file
1454 void prefs_matcher_write_config(void)
1459 debug_print("Writing matcher configuration...\n");
1461 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1464 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1465 g_warning("failed to write configuration to file\n");
1471 prefs_matcher_save(pfile->fp);
1475 if (prefs_file_close(pfile) < 0) {
1476 g_warning("failed to write configuration to file\n");
1481 /* ******************************************************************* */
1484 *\brief Read matcher configuration
1486 void prefs_matcher_read_config(void)
1491 create_matchparser_hashtab();
1492 prefs_filtering_clear();
1494 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1495 f = fopen(rcpath, "rb");
1499 matcher_parser_start_parsing(f);
1500 fclose(matcher_parserin);
1503 /* previous version compatibily */
1505 /* printf("reading filtering\n"); */
1506 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1507 FILTERING_RC, NULL);
1508 f = fopen(rcpath, "rb");
1512 matcher_parser_start_parsing(f);
1513 fclose(matcher_parserin);
1516 /* printf("reading scoring\n"); */
1517 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1519 f = fopen(rcpath, "rb");
1523 matcher_parser_start_parsing(f);
1524 fclose(matcher_parserin);