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;
289 if (!found && type == MATCHTYPE_ALL_IN_ADDRESSBOOK) {
296 g_slist_free(address_list);
298 end_address_completion();
304 *\brief Find out if a string matches a condition
306 *\param prop Matcher structure
307 *\param str String to check
309 *\return gboolean TRUE if str matches the condition in the
312 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
320 switch (prop->matchtype) {
321 case MATCHTYPE_REGEXPCASE:
322 case MATCHTYPE_REGEXP:
323 if (!prop->preg && (prop->error == 0)) {
324 prop->preg = g_new0(regex_t, 1);
325 /* if regexp then don't use the escaped string */
326 if (regcomp(prop->preg, prop->expr,
327 REG_NOSUB | REG_EXTENDED
328 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
329 ? REG_ICASE : 0)) != 0) {
335 if (prop->preg == NULL)
338 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
343 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
344 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
345 return match_with_addresses_in_addressbook
346 (prop, str, prop->matchtype);
348 case MATCHTYPE_MATCH:
349 return (strstr(str, prop->expr) != NULL);
351 /* FIXME: put upper in unesc_str */
352 case MATCHTYPE_MATCHCASE:
353 str2 = alloca(strlen(prop->expr) + 1);
354 strcpy(str2, prop->expr);
356 str1 = alloca(strlen(str) + 1);
359 return (strstr(str1, str2) != NULL);
367 *\brief Execute a command defined in the matcher structure
369 *\param prop Pointer to matcher structure
370 *\param info Pointer to message info structure
372 *\return gboolean TRUE if command was executed succesfully
374 static gboolean matcherprop_match_test(const MatcherProp *prop,
381 file = procmsg_get_message_file(info);
386 cmd = matching_build_command(prop->expr, info);
390 retval = system(cmd);
391 debug_print("Command exit code: %d\n", retval);
394 return (retval == 0);
398 *\brief Check if a message matches the condition in a matcher
401 *\param prop Pointer to matcher structure
402 *\param info Pointer to message info
404 *\return gboolean TRUE if a match
406 gboolean matcherprop_match(MatcherProp *prop,
411 switch(prop->criteria) {
412 case MATCHCRITERIA_ALL:
414 case MATCHCRITERIA_UNREAD:
415 return MSG_IS_UNREAD(info->flags);
416 case MATCHCRITERIA_NOT_UNREAD:
417 return !MSG_IS_UNREAD(info->flags);
418 case MATCHCRITERIA_NEW:
419 return MSG_IS_NEW(info->flags);
420 case MATCHCRITERIA_NOT_NEW:
421 return !MSG_IS_NEW(info->flags);
422 case MATCHCRITERIA_MARKED:
423 return MSG_IS_MARKED(info->flags);
424 case MATCHCRITERIA_NOT_MARKED:
425 return !MSG_IS_MARKED(info->flags);
426 case MATCHCRITERIA_DELETED:
427 return MSG_IS_DELETED(info->flags);
428 case MATCHCRITERIA_NOT_DELETED:
429 return !MSG_IS_DELETED(info->flags);
430 case MATCHCRITERIA_REPLIED:
431 return MSG_IS_REPLIED(info->flags);
432 case MATCHCRITERIA_NOT_REPLIED:
433 return !MSG_IS_REPLIED(info->flags);
434 case MATCHCRITERIA_FORWARDED:
435 return MSG_IS_FORWARDED(info->flags);
436 case MATCHCRITERIA_NOT_FORWARDED:
437 return !MSG_IS_FORWARDED(info->flags);
438 case MATCHCRITERIA_LOCKED:
439 return MSG_IS_LOCKED(info->flags);
440 case MATCHCRITERIA_NOT_LOCKED:
441 return !MSG_IS_LOCKED(info->flags);
442 case MATCHCRITERIA_COLORLABEL:
443 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
444 case MATCHCRITERIA_NOT_COLORLABEL:
445 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
446 case MATCHCRITERIA_IGNORE_THREAD:
447 return MSG_IS_IGNORE_THREAD(info->flags);
448 case MATCHCRITERIA_NOT_IGNORE_THREAD:
449 return !MSG_IS_IGNORE_THREAD(info->flags);
450 case MATCHCRITERIA_SUBJECT:
451 return matcherprop_string_match(prop, info->subject);
452 case MATCHCRITERIA_NOT_SUBJECT:
453 return !matcherprop_string_match(prop, info->subject);
454 case MATCHCRITERIA_FROM:
455 return matcherprop_string_match(prop, info->from);
456 case MATCHCRITERIA_NOT_FROM:
457 return !matcherprop_string_match(prop, info->from);
458 case MATCHCRITERIA_TO:
459 return matcherprop_string_match(prop, info->to);
460 case MATCHCRITERIA_NOT_TO:
461 return !matcherprop_string_match(prop, info->to);
462 case MATCHCRITERIA_CC:
463 return matcherprop_string_match(prop, info->cc);
464 case MATCHCRITERIA_NOT_CC:
465 return !matcherprop_string_match(prop, info->cc);
466 case MATCHCRITERIA_TO_OR_CC:
467 return matcherprop_string_match(prop, info->to)
468 || matcherprop_string_match(prop, info->cc);
469 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
470 return !(matcherprop_string_match(prop, info->to)
471 || matcherprop_string_match(prop, info->cc));
472 case MATCHCRITERIA_AGE_GREATER:
474 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
475 case MATCHCRITERIA_AGE_LOWER:
477 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
478 case MATCHCRITERIA_SCORE_GREATER:
479 return info->score >= prop->value;
480 case MATCHCRITERIA_SCORE_LOWER:
481 return info->score <= prop->value;
482 case MATCHCRITERIA_SCORE_EQUAL:
483 return info->score == prop->value;
484 case MATCHCRITERIA_SIZE_GREATER:
485 /* FIXME: info->size is an off_t */
486 return info->size > (off_t) prop->value;
487 case MATCHCRITERIA_SIZE_EQUAL:
488 /* FIXME: info->size is an off_t */
489 return info->size == (off_t) prop->value;
490 case MATCHCRITERIA_SIZE_SMALLER:
491 /* FIXME: info->size is an off_t */
492 return info->size < (off_t) prop->value;
493 case MATCHCRITERIA_NEWSGROUPS:
494 return matcherprop_string_match(prop, info->newsgroups);
495 case MATCHCRITERIA_NOT_NEWSGROUPS:
496 return !matcherprop_string_match(prop, info->newsgroups);
497 case MATCHCRITERIA_INREPLYTO:
498 return matcherprop_string_match(prop, info->inreplyto);
499 case MATCHCRITERIA_NOT_INREPLYTO:
500 return !matcherprop_string_match(prop, info->inreplyto);
501 case MATCHCRITERIA_REFERENCES:
502 return matcherprop_string_match(prop, info->references);
503 case MATCHCRITERIA_NOT_REFERENCES:
504 return !matcherprop_string_match(prop, info->references);
505 case MATCHCRITERIA_TEST:
506 return matcherprop_match_test(prop, info);
507 case MATCHCRITERIA_NOT_TEST:
508 return !matcherprop_match_test(prop, info);
514 /* ********************* MatcherList *************************** */
517 *\brief Create a new list of matchers
519 *\param matchers List of matcher structures
520 *\param bool_and Operator
522 *\return MatcherList * New list
524 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
528 cond = g_new0(MatcherList, 1);
530 cond->matchers = matchers;
531 cond->bool_and = bool_and;
537 *\brief Frees a list of matchers
539 *\param cond List of matchers
541 void matcherlist_free(MatcherList *cond)
545 g_return_if_fail(cond);
546 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
547 matcherprop_free((MatcherProp *) l->data);
553 *\brief Skip all headers in a message file
555 *\param fp Message file
557 static void matcherlist_skip_headers(FILE *fp)
561 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
566 *\brief Check if a header matches a matcher condition
568 *\param matcher Matcher structure to check header for
569 *\param buf Header name
571 *\return boolean TRUE if matching header
573 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
579 switch (matcher->criteria) {
580 case MATCHCRITERIA_HEADER:
581 case MATCHCRITERIA_NOT_HEADER:
582 header = procheader_parse_header(buf);
585 if (procheader_headername_equal(header->name,
587 if (matcher->criteria == MATCHCRITERIA_HEADER)
588 result = matcherprop_string_match(matcher, header->body);
590 result = !matcherprop_string_match(matcher, header->body);
591 procheader_header_free(header);
595 procheader_header_free(header);
598 case MATCHCRITERIA_HEADERS_PART:
599 case MATCHCRITERIA_MESSAGE:
600 return matcherprop_string_match(matcher, buf);
601 case MATCHCRITERIA_NOT_MESSAGE:
602 case MATCHCRITERIA_NOT_HEADERS_PART:
603 return !matcherprop_string_match(matcher, buf);
609 *\brief Check if the matcher structure wants headers to
612 *\param matcher Matcher structure
614 *\return gboolean TRUE if the matcher structure describes
615 * a header match condition
617 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
619 switch (matcher->criteria) {
620 case MATCHCRITERIA_HEADER:
621 case MATCHCRITERIA_NOT_HEADER:
622 case MATCHCRITERIA_HEADERS_PART:
623 case MATCHCRITERIA_NOT_HEADERS_PART:
631 *\brief Check if the matcher structure wants the message
632 * to be matched (just perform an action on any
635 *\param matcher Matcher structure
637 *\return gboolean TRUE if matcher condition should match
640 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
642 switch (matcher->criteria) {
643 case MATCHCRITERIA_MESSAGE:
644 case MATCHCRITERIA_NOT_MESSAGE:
652 *\brief Check if a list of conditions match a header
654 *\param matchers One set of conditions
655 *\param buf Name of header
657 *\return gboolean TRUE if matching should stop
659 static gboolean matcherlist_match_one_header(MatcherList *matchers,
664 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
665 MatcherProp *matcher = (MatcherProp *) l->data;
667 /* see if a single condition matches */
668 if (matcherprop_criteria_headers(matcher) ||
669 matcherprop_criteria_message(matcher)) {
670 if (matcherprop_match_one_header(matcher, buf)) {
671 matcher->result = TRUE;
675 if (matcherprop_criteria_headers(matcher)) {
676 if (matcher->result) {
677 if (!matchers->bool_and)
687 *\brief Check if a list of conditions matches one header in
690 *\param matchers List of conditions
691 *\param fp Message file
693 *\return gboolean TRUE if one of the headers is matched by
694 * the list of conditions.
696 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
700 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
701 if (matcherlist_match_one_header(matchers, buf))
708 *\brief Check if a matcher wants to check the message body
710 *\param matcher Matcher structure
712 *\return gboolean TRUE if body must be matched.
714 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
716 switch (matcher->criteria) {
717 case MATCHCRITERIA_BODY_PART:
718 case MATCHCRITERIA_NOT_BODY_PART:
726 *\brief Check if a (line) string matches the criteria
727 * described by a matcher structure
729 *\param matcher Matcher structure
732 *\return gboolean TRUE if string matches criteria
734 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
736 switch (matcher->criteria) {
737 case MATCHCRITERIA_BODY_PART:
738 case MATCHCRITERIA_MESSAGE:
739 return matcherprop_string_match(matcher, line);
740 case MATCHCRITERIA_NOT_BODY_PART:
741 case MATCHCRITERIA_NOT_MESSAGE:
742 return !matcherprop_string_match(matcher, line);
748 *\brief Check if a list of conditions matches a (line) string
750 *\param matchers List of matchers
751 *\param line String to match
753 *\return gboolean TRUE if string matches list of criteria
755 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
759 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
760 MatcherProp *matcher = (MatcherProp *) l->data;
762 if (matcherprop_criteria_body(matcher) ||
763 matcherprop_criteria_message(matcher)) {
764 if (matcherprop_match_line(matcher, line)) {
765 matcher->result = TRUE;
769 if (matcher->result) {
770 if (!matchers->bool_and)
778 *\brief Check if a line in a message file's body matches
781 *\param matchers List of conditions
782 *\param fp Message file
784 *\return gboolean TRUE if succesful match
786 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
790 while (fgets(buf, sizeof(buf), fp) != NULL)
791 if (matcherlist_match_line(matchers, buf))
798 *\brief Check if a message file matches criteria
800 *\param matchers Criteria
801 *\param info Message info
802 *\param result Default result
804 *\return gboolean TRUE if matched
806 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
809 gboolean read_headers;
815 /* file need to be read ? */
817 read_headers = FALSE;
819 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
820 MatcherProp *matcher = (MatcherProp *) l->data;
822 if (matcherprop_criteria_headers(matcher))
824 if (matcherprop_criteria_body(matcher))
826 if (matcherprop_criteria_message(matcher)) {
830 matcher->result = FALSE;
833 if (!read_headers && !read_body)
836 file = procmsg_get_message_file(info);
840 if ((fp = fopen(file, "rb")) == NULL) {
841 FILE_OP_ERROR(file, "fopen");
846 /* read the headers */
849 if (matcherlist_match_headers(matchers, fp))
853 matcherlist_skip_headers(fp);
858 matcherlist_match_body(matchers, fp);
861 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
862 MatcherProp *matcher = (MatcherProp *) l->data;
864 if (matcherprop_criteria_headers(matcher) ||
865 matcherprop_criteria_body(matcher) ||
866 matcherprop_criteria_message(matcher)) {
867 if (matcher->result) {
868 if (!matchers->bool_and) {
874 if (matchers->bool_and) {
890 *\brief Test list of conditions on a message.
892 *\param matchers List of conditions
893 *\param info Message info
895 *\return gboolean TRUE if matched
897 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
902 if (matchers->bool_and)
907 /* test the cached elements */
909 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
910 MatcherProp *matcher = (MatcherProp *) l->data;
912 switch(matcher->criteria) {
913 case MATCHCRITERIA_ALL:
914 case MATCHCRITERIA_UNREAD:
915 case MATCHCRITERIA_NOT_UNREAD:
916 case MATCHCRITERIA_NEW:
917 case MATCHCRITERIA_NOT_NEW:
918 case MATCHCRITERIA_MARKED:
919 case MATCHCRITERIA_NOT_MARKED:
920 case MATCHCRITERIA_DELETED:
921 case MATCHCRITERIA_NOT_DELETED:
922 case MATCHCRITERIA_REPLIED:
923 case MATCHCRITERIA_NOT_REPLIED:
924 case MATCHCRITERIA_FORWARDED:
925 case MATCHCRITERIA_NOT_FORWARDED:
926 case MATCHCRITERIA_LOCKED:
927 case MATCHCRITERIA_NOT_LOCKED:
928 case MATCHCRITERIA_COLORLABEL:
929 case MATCHCRITERIA_NOT_COLORLABEL:
930 case MATCHCRITERIA_IGNORE_THREAD:
931 case MATCHCRITERIA_NOT_IGNORE_THREAD:
932 case MATCHCRITERIA_SUBJECT:
933 case MATCHCRITERIA_NOT_SUBJECT:
934 case MATCHCRITERIA_FROM:
935 case MATCHCRITERIA_NOT_FROM:
936 case MATCHCRITERIA_TO:
937 case MATCHCRITERIA_NOT_TO:
938 case MATCHCRITERIA_CC:
939 case MATCHCRITERIA_NOT_CC:
940 case MATCHCRITERIA_TO_OR_CC:
941 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
942 case MATCHCRITERIA_AGE_GREATER:
943 case MATCHCRITERIA_AGE_LOWER:
944 case MATCHCRITERIA_NEWSGROUPS:
945 case MATCHCRITERIA_NOT_NEWSGROUPS:
946 case MATCHCRITERIA_INREPLYTO:
947 case MATCHCRITERIA_NOT_INREPLYTO:
948 case MATCHCRITERIA_REFERENCES:
949 case MATCHCRITERIA_NOT_REFERENCES:
950 case MATCHCRITERIA_SCORE_GREATER:
951 case MATCHCRITERIA_SCORE_LOWER:
952 case MATCHCRITERIA_SCORE_EQUAL:
953 case MATCHCRITERIA_SIZE_GREATER:
954 case MATCHCRITERIA_SIZE_SMALLER:
955 case MATCHCRITERIA_SIZE_EQUAL:
956 case MATCHCRITERIA_TEST:
957 case MATCHCRITERIA_NOT_TEST:
958 if (matcherprop_match(matcher, info)) {
959 if (!matchers->bool_and) {
964 if (matchers->bool_and) {
971 /* test the condition on the file */
973 if (matcherlist_match_file(matchers, info, result)) {
974 if (!matchers->bool_and)
978 if (matchers->bool_and)
986 static gint quote_filter_str(gchar * result, guint size,
996 for(p = path ; * p != '\0' ; p ++) {
998 if ((* p != '\"') && (* p != '\\')) {
1005 result[size - 1] = '\0';
1010 if (remaining >= 2) {
1018 result[size - 1] = '\0';
1023 if (remaining > 0) {
1027 result[size - 1] = '\0';
1035 gchar * matcher_quote_str(const gchar * src)
1040 len = strlen(src) * 2 + 1;
1041 res = g_malloc(len);
1042 quote_filter_str(res, len, src);
1048 *\brief Convert a matcher structure to a string
1050 *\param matcher Matcher structure
1052 *\return gchar * Newly allocated string
1054 gchar *matcherprop_to_string(MatcherProp *matcher)
1056 gchar *matcher_str = NULL;
1057 const gchar *criteria_str;
1058 const gchar *matchtype_str;
1060 gchar * quoted_expr;
1062 criteria_str = NULL;
1063 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1064 if (matchparser_tab[i].id == matcher->criteria)
1065 criteria_str = matchparser_tab[i].str;
1067 if (criteria_str == NULL)
1070 switch (matcher->criteria) {
1071 case MATCHCRITERIA_AGE_GREATER:
1072 case MATCHCRITERIA_AGE_LOWER:
1073 case MATCHCRITERIA_SCORE_GREATER:
1074 case MATCHCRITERIA_SCORE_LOWER:
1075 case MATCHCRITERIA_SCORE_EQUAL:
1076 case MATCHCRITERIA_SIZE_GREATER:
1077 case MATCHCRITERIA_SIZE_SMALLER:
1078 case MATCHCRITERIA_SIZE_EQUAL:
1079 case MATCHCRITERIA_COLORLABEL:
1080 case MATCHCRITERIA_NOT_COLORLABEL:
1081 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1082 case MATCHCRITERIA_ALL:
1083 case MATCHCRITERIA_UNREAD:
1084 case MATCHCRITERIA_NOT_UNREAD:
1085 case MATCHCRITERIA_NEW:
1086 case MATCHCRITERIA_NOT_NEW:
1087 case MATCHCRITERIA_MARKED:
1088 case MATCHCRITERIA_NOT_MARKED:
1089 case MATCHCRITERIA_DELETED:
1090 case MATCHCRITERIA_NOT_DELETED:
1091 case MATCHCRITERIA_REPLIED:
1092 case MATCHCRITERIA_NOT_REPLIED:
1093 case MATCHCRITERIA_FORWARDED:
1094 case MATCHCRITERIA_NOT_FORWARDED:
1095 case MATCHCRITERIA_LOCKED:
1096 case MATCHCRITERIA_NOT_LOCKED:
1097 case MATCHCRITERIA_IGNORE_THREAD:
1098 case MATCHCRITERIA_NOT_IGNORE_THREAD:
1099 return g_strdup(criteria_str);
1100 case MATCHCRITERIA_TEST:
1101 case MATCHCRITERIA_NOT_TEST:
1102 quoted_expr = matcher_quote_str(matcher->expr);
1103 matcher_str = g_strdup_printf("%s \"%s\"",
1104 criteria_str, quoted_expr);
1105 g_free(quoted_expr);
1109 matchtype_str = NULL;
1110 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1111 if (matchparser_tab[i].id == matcher->matchtype)
1112 matchtype_str = matchparser_tab[i].str;
1115 if (matchtype_str == NULL)
1118 switch (matcher->matchtype) {
1119 case MATCHTYPE_MATCH:
1120 case MATCHTYPE_MATCHCASE:
1121 case MATCHTYPE_REGEXP:
1122 case MATCHTYPE_REGEXPCASE:
1123 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
1124 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
1125 quoted_expr = matcher_quote_str(matcher->expr);
1126 if (matcher->header) {
1127 gchar * quoted_header;
1129 quoted_header = matcher_quote_str(matcher->header);
1130 matcher_str = g_strdup_printf
1131 ("%s \"%s\" %s \"%s\"",
1132 criteria_str, quoted_header,
1133 matchtype_str, quoted_expr);
1134 g_free(quoted_header);
1137 matcher_str = g_strdup_printf
1138 ("%s %s \"%s\"", criteria_str,
1139 matchtype_str, quoted_expr);
1140 g_free(quoted_expr);
1148 *\brief Convert a list of conditions to a string
1150 *\param matchers List of conditions
1152 *\return gchar * Newly allocated string
1154 gchar *matcherlist_to_string(const MatcherList *matchers)
1160 gchar *result = NULL;
1162 count = g_slist_length(matchers->matchers);
1163 vstr = g_new(gchar *, count + 1);
1165 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1166 l = g_slist_next(l), cur_str ++) {
1167 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1168 if (*cur_str == NULL)
1173 if (matchers->bool_and)
1174 result = g_strjoinv(" & ", vstr);
1176 result = g_strjoinv(" | ", vstr);
1178 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1186 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1187 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1189 static void add_str_default(gchar ** dest,
1190 const gchar * s, const gchar * d)
1192 gchar quoted_str[4096];
1200 quote_cmd_argument(quoted_str, sizeof(quoted_str), str);
1201 strcpy(* dest, quoted_str);
1203 (* dest) += strlen(* dest);
1206 /* matching_build_command() - preferably cmd should be unescaped */
1208 *\brief Build the command line to execute
1210 *\param cmd String with command line specifiers
1211 *\param info Message info to use for command
1213 *\return gchar * Newly allocated string
1215 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1217 const gchar *s = cmd;
1218 gchar *filename = NULL;
1219 gchar *processed_cmd;
1223 const gchar *const no_subject = _("(none)") ;
1224 const gchar *const no_from = _("(none)") ;
1225 const gchar *const no_to = _("(none)") ;
1226 const gchar *const no_cc = _("(none)") ;
1227 const gchar *const no_date = _("(none)") ;
1228 const gchar *const no_msgid = _("(none)") ;
1229 const gchar *const no_newsgroups = _("(none)") ;
1230 const gchar *const no_references = _("(none)") ;
1232 size = STRLEN_ZERO(cmd) + 1;
1233 while (*s != '\0') {
1240 case 's': /* subject */
1241 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1243 case 'f': /* from */
1244 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1247 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1250 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1252 case 'd': /* date */
1253 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1255 case 'i': /* message-id */
1256 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1258 case 'n': /* newsgroups */
1259 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1261 case 'r': /* references */
1262 size += STRLEN_DEFAULT(info->references, no_references) - 2;
1264 case 'F': /* file */
1265 if (filename == NULL)
1266 filename = folder_item_fetch_msg(info->folder, info->msgnum);
1268 if (filename == NULL) {
1269 g_warning("filename is not set");
1273 size += strlen(filename) - 2;
1282 /* as the string can be quoted, we double the result */
1285 processed_cmd = g_new0(gchar, size);
1289 while (*s != '\0') {
1297 case 's': /* subject */
1298 add_str_default(&p, info->subject,
1301 case 'f': /* from */
1302 add_str_default(&p, info->from,
1306 add_str_default(&p, info->to,
1310 add_str_default(&p, info->cc,
1313 case 'd': /* date */
1314 add_str_default(&p, info->date,
1317 case 'i': /* message-id */
1318 add_str_default(&p, info->msgid,
1321 case 'n': /* newsgroups */
1322 add_str_default(&p, info->newsgroups,
1325 case 'r': /* references */
1326 add_str_default(&p, info->references,
1329 case 'F': /* file */
1330 if (filename != NULL)
1331 add_str_default(&p, filename, NULL);
1350 return processed_cmd;
1352 #undef STRLEN_DEFAULT
1355 /* ************************************************************ */
1359 *\brief Write filtering list to file
1362 *\param prefs_filtering List of filtering conditions
1364 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1368 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1369 gchar *filtering_str;
1370 FilteringProp *prop;
1372 if (NULL == (prop = (FilteringProp *) cur->data))
1375 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1378 if (fputs(filtering_str, fp) == EOF ||
1379 fputc('\n', fp) == EOF) {
1380 FILE_OP_ERROR("filtering config", "fputs || fputc");
1381 g_free(filtering_str);
1384 g_free(filtering_str);
1389 *\brief Write matchers from a folder item
1391 *\param node Node with folder info
1392 *\param data File pointer
1394 *\return gboolean FALSE
1396 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1401 GSList *prefs_filtering;
1404 /* prevent warning */
1405 if (item->path == NULL)
1407 id = folder_item_get_identifier(item);
1410 prefs_filtering = item->prefs->processing;
1412 if (prefs_filtering != NULL) {
1413 fprintf(fp, "[%s]\n", id);
1414 prefs_filtering_write(fp, prefs_filtering);
1424 *\brief Save matchers from folder items
1428 static void prefs_matcher_save(FILE *fp)
1432 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1435 folder = (Folder *) cur->data;
1436 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1437 prefs_matcher_write_func, fp);
1440 /* pre global rules */
1441 fprintf(fp, "[preglobal]\n");
1442 prefs_filtering_write(fp, pre_global_processing);
1445 /* post global rules */
1446 fprintf(fp, "[postglobal]\n");
1447 prefs_filtering_write(fp, post_global_processing);
1450 /* filtering rules */
1451 fprintf(fp, "[filtering]\n");
1452 prefs_filtering_write(fp, filtering_rules);
1457 *\brief Write filtering / matcher configuration file
1459 void prefs_matcher_write_config(void)
1464 debug_print("Writing matcher configuration...\n");
1466 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1469 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1470 g_warning("failed to write configuration to file\n");
1476 prefs_matcher_save(pfile->fp);
1480 if (prefs_file_close(pfile) < 0) {
1481 g_warning("failed to write configuration to file\n");
1486 /* ******************************************************************* */
1489 *\brief Read matcher configuration
1491 void prefs_matcher_read_config(void)
1496 create_matchparser_hashtab();
1497 prefs_filtering_clear();
1499 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1500 f = fopen(rcpath, "rb");
1504 matcher_parser_start_parsing(f);
1505 fclose(matcher_parserin);
1508 /* previous version compatibily */
1510 /* printf("reading filtering\n"); */
1511 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1512 FILTERING_RC, NULL);
1513 f = fopen(rcpath, "rb");
1517 matcher_parser_start_parsing(f);
1518 fclose(matcher_parserin);
1521 /* printf("reading scoring\n"); */
1522 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1524 f = fopen(rcpath, "rb");
1528 matcher_parser_start_parsing(f);
1529 fclose(matcher_parserin);