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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #include <glib/gi18n.h>
29 #include "procheader.h"
31 #include "matcher_parser.h"
32 #include "prefs_gtk.h"
33 #include "addr_compl.h"
37 *\brief Keyword lookup element
40 gint id; /*!< keyword id */
41 gchar *str; /*!< keyword */
43 typedef struct _MatchParser MatchParser;
46 *\brief Table with strings and ids used by the lexer and
47 * the parser. New keywords can be added here.
49 static const MatchParser matchparser_tab[] = {
51 {MATCHCRITERIA_ALL, "all"},
52 {MATCHCRITERIA_UNREAD, "unread"},
53 {MATCHCRITERIA_NOT_UNREAD, "~unread"},
54 {MATCHCRITERIA_NEW, "new"},
55 {MATCHCRITERIA_NOT_NEW, "~new"},
56 {MATCHCRITERIA_MARKED, "marked"},
57 {MATCHCRITERIA_NOT_MARKED, "~marked"},
58 {MATCHCRITERIA_DELETED, "deleted"},
59 {MATCHCRITERIA_NOT_DELETED, "~deleted"},
60 {MATCHCRITERIA_REPLIED, "replied"},
61 {MATCHCRITERIA_NOT_REPLIED, "~replied"},
62 {MATCHCRITERIA_FORWARDED, "forwarded"},
63 {MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
64 {MATCHCRITERIA_LOCKED, "locked"},
65 {MATCHCRITERIA_NOT_LOCKED, "~locked"},
66 {MATCHCRITERIA_COLORLABEL, "colorlabel"},
67 {MATCHCRITERIA_NOT_COLORLABEL, "~colorlabel"},
68 {MATCHCRITERIA_IGNORE_THREAD, "ignore_thread"},
69 {MATCHCRITERIA_NOT_IGNORE_THREAD, "~ignore_thread"},
72 {MATCHCRITERIA_SUBJECT, "subject"},
73 {MATCHCRITERIA_NOT_SUBJECT, "~subject"},
74 {MATCHCRITERIA_FROM, "from"},
75 {MATCHCRITERIA_NOT_FROM, "~from"},
76 {MATCHCRITERIA_TO, "to"},
77 {MATCHCRITERIA_NOT_TO, "~to"},
78 {MATCHCRITERIA_CC, "cc"},
79 {MATCHCRITERIA_NOT_CC, "~cc"},
80 {MATCHCRITERIA_TO_OR_CC, "to_or_cc"},
81 {MATCHCRITERIA_NOT_TO_AND_NOT_CC, "~to_or_cc"},
82 {MATCHCRITERIA_AGE_GREATER, "age_greater"},
83 {MATCHCRITERIA_AGE_LOWER, "age_lower"},
84 {MATCHCRITERIA_NEWSGROUPS, "newsgroups"},
85 {MATCHCRITERIA_NOT_NEWSGROUPS, "~newsgroups"},
86 {MATCHCRITERIA_INREPLYTO, "inreplyto"},
87 {MATCHCRITERIA_NOT_INREPLYTO, "~inreplyto"},
88 {MATCHCRITERIA_REFERENCES, "references"},
89 {MATCHCRITERIA_NOT_REFERENCES, "~references"},
90 {MATCHCRITERIA_SCORE_GREATER, "score_greater"},
91 {MATCHCRITERIA_SCORE_LOWER, "score_lower"},
92 {MATCHCRITERIA_SCORE_EQUAL, "score_equal"},
93 {MATCHCRITERIA_PARTIAL, "partial"},
94 {MATCHCRITERIA_NOT_PARTIAL, "~partial"},
96 {MATCHCRITERIA_SIZE_GREATER, "size_greater"},
97 {MATCHCRITERIA_SIZE_SMALLER, "size_smaller"},
98 {MATCHCRITERIA_SIZE_EQUAL, "size_equal"},
100 /* content have to be read */
101 {MATCHCRITERIA_HEADER, "header"},
102 {MATCHCRITERIA_NOT_HEADER, "~header"},
103 {MATCHCRITERIA_HEADERS_PART, "headers_part"},
104 {MATCHCRITERIA_NOT_HEADERS_PART, "~headers_part"},
105 {MATCHCRITERIA_MESSAGE, "message"},
106 {MATCHCRITERIA_NOT_MESSAGE, "~message"},
107 {MATCHCRITERIA_BODY_PART, "body_part"},
108 {MATCHCRITERIA_NOT_BODY_PART, "~body_part"},
109 {MATCHCRITERIA_TEST, "test"},
110 {MATCHCRITERIA_NOT_TEST, "~test"},
113 {MATCHTYPE_MATCHCASE, "matchcase"},
114 {MATCHTYPE_MATCH, "match"},
115 {MATCHTYPE_REGEXPCASE, "regexpcase"},
116 {MATCHTYPE_REGEXP, "regexp"},
117 {MATCHTYPE_ANY_IN_ADDRESSBOOK, "any_in_addressbook"},
118 {MATCHTYPE_ALL_IN_ADDRESSBOOK, "all_in_addressbook"},
121 {MATCHACTION_SCORE, "score"}, /* for backward compatibility */
122 {MATCHACTION_MOVE, "move"},
123 {MATCHACTION_COPY, "copy"},
124 {MATCHACTION_DELETE, "delete"},
125 {MATCHACTION_MARK, "mark"},
126 {MATCHACTION_UNMARK, "unmark"},
127 {MATCHACTION_LOCK, "lock"},
128 {MATCHACTION_UNLOCK, "unlock"},
129 {MATCHACTION_MARK_AS_READ, "mark_as_read"},
130 {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
131 {MATCHACTION_FORWARD, "forward"},
132 {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
133 {MATCHACTION_EXECUTE, "execute"},
134 {MATCHACTION_COLOR, "color"},
135 {MATCHACTION_REDIRECT, "redirect"},
136 {MATCHACTION_CHANGE_SCORE, "change_score"},
137 {MATCHACTION_SET_SCORE, "set_score"},
138 {MATCHACTION_STOP, "stop"},
139 {MATCHACTION_HIDE, "hide"},
143 *\brief Look up table with keywords defined in \sa matchparser_tab
145 static GHashTable *matchparser_hashtab;
148 *\brief Translate keyword id to keyword string
150 *\param id Id of keyword
152 *\return const gchar * Keyword
154 const gchar *get_matchparser_tab_str(gint id)
158 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
159 if (matchparser_tab[i].id == id)
160 return matchparser_tab[i].str;
166 *\brief Create keyword lookup table
168 static void create_matchparser_hashtab(void)
172 if (matchparser_hashtab) return;
173 matchparser_hashtab = g_hash_table_new(g_str_hash, g_str_equal);
174 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++)
175 g_hash_table_insert(matchparser_hashtab,
176 matchparser_tab[i].str,
177 (gpointer) &matchparser_tab[i]);
181 *\brief Return a keyword id from a keyword string
183 *\param str Keyword string
185 *\return gint Keyword id
187 gint get_matchparser_tab_id(const gchar *str)
191 if (NULL != (res = g_hash_table_lookup(matchparser_hashtab, str))) {
197 /* **************** data structure allocation **************** */
200 *\brief Allocate a structure for a filtering / scoring
201 * "condition" (a matcher structure)
203 *\param criteria Criteria ID (MATCHCRITERIA_XXXX)
204 *\param header Header string (if criteria is MATCHCRITERIA_HEADER)
205 *\param matchtype Type of action (MATCHTYPE_XXX)
206 *\param expr String value or expression to check
207 *\param value Integer value to check
209 *\return MatcherProp * Pointer to newly allocated structure
211 MatcherProp *matcherprop_new(gint criteria, const gchar *header,
212 gint matchtype, const gchar *expr,
217 prop = g_new0(MatcherProp, 1);
218 prop->criteria = criteria;
219 prop->header = header != NULL ? g_strdup(header) : NULL;
220 prop->expr = expr != NULL ? g_strdup(expr) : NULL;
221 prop->matchtype = matchtype;
230 *\brief Free a matcher structure
232 *\param prop Pointer to matcher structure allocated with
235 void matcherprop_free(MatcherProp *prop)
240 g_free(prop->header);
241 if (prop->preg != NULL) {
249 *\brief Copy a matcher structure
251 *\param src Matcher structure to copy
253 *\return MatcherProp * Pointer to newly allocated matcher structure
255 MatcherProp *matcherprop_copy(const MatcherProp *src)
257 MatcherProp *prop = g_new0(MatcherProp, 1);
259 prop->criteria = src->criteria;
260 prop->header = src->header ? g_strdup(src->header) : NULL;
261 prop->expr = src->expr ? g_strdup(src->expr) : NULL;
262 prop->matchtype = src->matchtype;
264 prop->preg = NULL; /* will be re-evaluated */
265 prop->value = src->value;
266 prop->error = src->error;
270 /* ************** match ******************************/
272 static gboolean match_with_addresses_in_addressbook
273 (MatcherProp *prop, const gchar *str, gint type)
275 GSList *address_list = NULL;
277 gboolean res = FALSE;
279 if (str == NULL || *str == 0)
282 /* XXX: perhaps complete with comments too */
283 address_list = address_list_append(address_list, str);
287 start_address_completion();
289 for (walk = address_list; walk != NULL; walk = walk->next) {
290 gboolean found = complete_address(walk->data) ? TRUE : FALSE;
293 if (!found && type == MATCHTYPE_ALL_IN_ADDRESSBOOK) {
300 g_slist_free(address_list);
302 end_address_completion();
308 *\brief Find out if a string matches a condition
310 *\param prop Matcher structure
311 *\param str String to check
313 *\return gboolean TRUE if str matches the condition in the
316 static gboolean matcherprop_string_match(MatcherProp *prop, const gchar *str)
324 switch (prop->matchtype) {
325 case MATCHTYPE_REGEXPCASE:
326 case MATCHTYPE_REGEXP:
327 if (!prop->preg && (prop->error == 0)) {
328 prop->preg = g_new0(regex_t, 1);
329 /* if regexp then don't use the escaped string */
330 if (regcomp(prop->preg, prop->expr,
331 REG_NOSUB | REG_EXTENDED
332 | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
333 ? REG_ICASE : 0)) != 0) {
339 if (prop->preg == NULL)
342 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
347 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
348 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
349 return match_with_addresses_in_addressbook
350 (prop, str, prop->matchtype);
352 case MATCHTYPE_MATCH:
353 return (strstr(str, prop->expr) != NULL);
355 /* FIXME: put upper in unesc_str */
356 case MATCHTYPE_MATCHCASE:
357 str2 = alloca(strlen(prop->expr) + 1);
358 strcpy(str2, prop->expr);
360 str1 = alloca(strlen(str) + 1);
363 return (strstr(str1, str2) != NULL);
371 *\brief Execute a command defined in the matcher structure
373 *\param prop Pointer to matcher structure
374 *\param info Pointer to message info structure
376 *\return gboolean TRUE if command was executed succesfully
378 static gboolean matcherprop_match_test(const MatcherProp *prop,
385 file = procmsg_get_message_file(info);
390 cmd = matching_build_command(prop->expr, info);
394 retval = system(cmd);
395 debug_print("Command exit code: %d\n", retval);
398 return (retval == 0);
402 *\brief Check if a message matches the condition in a matcher
405 *\param prop Pointer to matcher structure
406 *\param info Pointer to message info
408 *\return gboolean TRUE if a match
410 gboolean matcherprop_match(MatcherProp *prop,
415 switch(prop->criteria) {
416 case MATCHCRITERIA_ALL:
418 case MATCHCRITERIA_UNREAD:
419 return MSG_IS_UNREAD(info->flags);
420 case MATCHCRITERIA_NOT_UNREAD:
421 return !MSG_IS_UNREAD(info->flags);
422 case MATCHCRITERIA_NEW:
423 return MSG_IS_NEW(info->flags);
424 case MATCHCRITERIA_NOT_NEW:
425 return !MSG_IS_NEW(info->flags);
426 case MATCHCRITERIA_MARKED:
427 return MSG_IS_MARKED(info->flags);
428 case MATCHCRITERIA_NOT_MARKED:
429 return !MSG_IS_MARKED(info->flags);
430 case MATCHCRITERIA_DELETED:
431 return MSG_IS_DELETED(info->flags);
432 case MATCHCRITERIA_NOT_DELETED:
433 return !MSG_IS_DELETED(info->flags);
434 case MATCHCRITERIA_REPLIED:
435 return MSG_IS_REPLIED(info->flags);
436 case MATCHCRITERIA_NOT_REPLIED:
437 return !MSG_IS_REPLIED(info->flags);
438 case MATCHCRITERIA_FORWARDED:
439 return MSG_IS_FORWARDED(info->flags);
440 case MATCHCRITERIA_NOT_FORWARDED:
441 return !MSG_IS_FORWARDED(info->flags);
442 case MATCHCRITERIA_LOCKED:
443 return MSG_IS_LOCKED(info->flags);
444 case MATCHCRITERIA_NOT_LOCKED:
445 return !MSG_IS_LOCKED(info->flags);
446 case MATCHCRITERIA_COLORLABEL:
447 return MSG_GET_COLORLABEL_VALUE(info->flags) == prop->value;
448 case MATCHCRITERIA_NOT_COLORLABEL:
449 return MSG_GET_COLORLABEL_VALUE(info->flags) != prop->value;
450 case MATCHCRITERIA_IGNORE_THREAD:
451 return MSG_IS_IGNORE_THREAD(info->flags);
452 case MATCHCRITERIA_NOT_IGNORE_THREAD:
453 return !MSG_IS_IGNORE_THREAD(info->flags);
454 case MATCHCRITERIA_SUBJECT:
455 return matcherprop_string_match(prop, info->subject);
456 case MATCHCRITERIA_NOT_SUBJECT:
457 return !matcherprop_string_match(prop, info->subject);
458 case MATCHCRITERIA_FROM:
459 return matcherprop_string_match(prop, info->from);
460 case MATCHCRITERIA_NOT_FROM:
461 return !matcherprop_string_match(prop, info->from);
462 case MATCHCRITERIA_TO:
463 return matcherprop_string_match(prop, info->to);
464 case MATCHCRITERIA_NOT_TO:
465 return !matcherprop_string_match(prop, info->to);
466 case MATCHCRITERIA_CC:
467 return matcherprop_string_match(prop, info->cc);
468 case MATCHCRITERIA_NOT_CC:
469 return !matcherprop_string_match(prop, info->cc);
470 case MATCHCRITERIA_TO_OR_CC:
471 return matcherprop_string_match(prop, info->to)
472 || matcherprop_string_match(prop, info->cc);
473 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
474 return !(matcherprop_string_match(prop, info->to)
475 || matcherprop_string_match(prop, info->cc));
476 case MATCHCRITERIA_AGE_GREATER:
478 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
479 case MATCHCRITERIA_AGE_LOWER:
481 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
482 case MATCHCRITERIA_SCORE_GREATER:
483 return info->score >= prop->value;
484 case MATCHCRITERIA_SCORE_LOWER:
485 return info->score <= prop->value;
486 case MATCHCRITERIA_SCORE_EQUAL:
487 return info->score == prop->value;
488 case MATCHCRITERIA_SIZE_GREATER:
489 /* FIXME: info->size is an off_t */
490 return info->size > (off_t) prop->value;
491 case MATCHCRITERIA_SIZE_EQUAL:
492 /* FIXME: info->size is an off_t */
493 return info->size == (off_t) prop->value;
494 case MATCHCRITERIA_SIZE_SMALLER:
495 /* FIXME: info->size is an off_t */
496 return info->size < (off_t) prop->value;
497 case MATCHCRITERIA_PARTIAL:
498 /* FIXME: info->size is an off_t */
499 return (info->total_size != 0 && info->size != (off_t)info->total_size);
500 case MATCHCRITERIA_NOT_PARTIAL:
501 /* FIXME: info->size is an off_t */
502 return (info->total_size == 0 || info->size == (off_t)info->total_size);
503 case MATCHCRITERIA_NEWSGROUPS:
504 return matcherprop_string_match(prop, info->newsgroups);
505 case MATCHCRITERIA_NOT_NEWSGROUPS:
506 return !matcherprop_string_match(prop, info->newsgroups);
507 case MATCHCRITERIA_INREPLYTO:
508 return matcherprop_string_match(prop, info->inreplyto);
509 case MATCHCRITERIA_NOT_INREPLYTO:
510 return !matcherprop_string_match(prop, info->inreplyto);
511 /* FIXME: Using inreplyto, but matching the (newly implemented)
512 * list of references is better */
513 case MATCHCRITERIA_REFERENCES:
514 return matcherprop_string_match(prop, info->inreplyto);
515 case MATCHCRITERIA_NOT_REFERENCES:
516 return !matcherprop_string_match(prop, info->inreplyto);
517 case MATCHCRITERIA_TEST:
518 return matcherprop_match_test(prop, info);
519 case MATCHCRITERIA_NOT_TEST:
520 return !matcherprop_match_test(prop, info);
526 /* ********************* MatcherList *************************** */
529 *\brief Create a new list of matchers
531 *\param matchers List of matcher structures
532 *\param bool_and Operator
534 *\return MatcherList * New list
536 MatcherList *matcherlist_new(GSList *matchers, gboolean bool_and)
540 cond = g_new0(MatcherList, 1);
542 cond->matchers = matchers;
543 cond->bool_and = bool_and;
549 *\brief Frees a list of matchers
551 *\param cond List of matchers
553 void matcherlist_free(MatcherList *cond)
557 g_return_if_fail(cond);
558 for (l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
559 matcherprop_free((MatcherProp *) l->data);
565 *\brief Skip all headers in a message file
567 *\param fp Message file
569 static void matcherlist_skip_headers(FILE *fp)
573 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
578 *\brief Check if a header matches a matcher condition
580 *\param matcher Matcher structure to check header for
581 *\param buf Header name
583 *\return boolean TRUE if matching header
585 static gboolean matcherprop_match_one_header(MatcherProp *matcher,
591 switch (matcher->criteria) {
592 case MATCHCRITERIA_HEADER:
593 case MATCHCRITERIA_NOT_HEADER:
594 header = procheader_parse_header(buf);
597 if (procheader_headername_equal(header->name,
599 if (matcher->criteria == MATCHCRITERIA_HEADER)
600 result = matcherprop_string_match(matcher, header->body);
602 result = !matcherprop_string_match(matcher, header->body);
603 procheader_header_free(header);
607 procheader_header_free(header);
610 case MATCHCRITERIA_HEADERS_PART:
611 case MATCHCRITERIA_MESSAGE:
612 return matcherprop_string_match(matcher, buf);
613 case MATCHCRITERIA_NOT_MESSAGE:
614 case MATCHCRITERIA_NOT_HEADERS_PART:
615 return !matcherprop_string_match(matcher, buf);
621 *\brief Check if the matcher structure wants headers to
624 *\param matcher Matcher structure
626 *\return gboolean TRUE if the matcher structure describes
627 * a header match condition
629 static gboolean matcherprop_criteria_headers(const MatcherProp *matcher)
631 switch (matcher->criteria) {
632 case MATCHCRITERIA_HEADER:
633 case MATCHCRITERIA_NOT_HEADER:
634 case MATCHCRITERIA_HEADERS_PART:
635 case MATCHCRITERIA_NOT_HEADERS_PART:
643 *\brief Check if the matcher structure wants the message
644 * to be matched (just perform an action on any
647 *\param matcher Matcher structure
649 *\return gboolean TRUE if matcher condition should match
652 static gboolean matcherprop_criteria_message(MatcherProp *matcher)
654 switch (matcher->criteria) {
655 case MATCHCRITERIA_MESSAGE:
656 case MATCHCRITERIA_NOT_MESSAGE:
664 *\brief Check if a list of conditions match a header
666 *\param matchers One set of conditions
667 *\param buf Name of header
669 *\return gboolean TRUE if matching should stop
671 static gboolean matcherlist_match_one_header(MatcherList *matchers,
676 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
677 MatcherProp *matcher = (MatcherProp *) l->data;
679 /* see if a single condition matches */
680 if (matcherprop_criteria_headers(matcher) ||
681 matcherprop_criteria_message(matcher)) {
682 if (matcherprop_match_one_header(matcher, buf)) {
683 matcher->result = TRUE;
687 if (matcherprop_criteria_headers(matcher)) {
688 if (matcher->result) {
689 if (!matchers->bool_and)
699 *\brief Check if a list of conditions matches one header in
702 *\param matchers List of conditions
703 *\param fp Message file
705 *\return gboolean TRUE if one of the headers is matched by
706 * the list of conditions.
708 static gboolean matcherlist_match_headers(MatcherList *matchers, FILE *fp)
712 while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
713 if (matcherlist_match_one_header(matchers, buf))
720 *\brief Check if a matcher wants to check the message body
722 *\param matcher Matcher structure
724 *\return gboolean TRUE if body must be matched.
726 static gboolean matcherprop_criteria_body(const MatcherProp *matcher)
728 switch (matcher->criteria) {
729 case MATCHCRITERIA_BODY_PART:
730 case MATCHCRITERIA_NOT_BODY_PART:
738 *\brief Check if a (line) string matches the criteria
739 * described by a matcher structure
741 *\param matcher Matcher structure
744 *\return gboolean TRUE if string matches criteria
746 static gboolean matcherprop_match_line(MatcherProp *matcher, const gchar *line)
748 switch (matcher->criteria) {
749 case MATCHCRITERIA_BODY_PART:
750 case MATCHCRITERIA_MESSAGE:
751 return matcherprop_string_match(matcher, line);
752 case MATCHCRITERIA_NOT_BODY_PART:
753 case MATCHCRITERIA_NOT_MESSAGE:
754 return !matcherprop_string_match(matcher, line);
760 *\brief Check if a list of conditions matches a (line) string
762 *\param matchers List of matchers
763 *\param line String to match
765 *\return gboolean TRUE if string matches list of criteria
767 static gboolean matcherlist_match_line(MatcherList *matchers, const gchar *line)
771 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
772 MatcherProp *matcher = (MatcherProp *) l->data;
774 if (matcherprop_criteria_body(matcher) ||
775 matcherprop_criteria_message(matcher)) {
776 if (matcherprop_match_line(matcher, line)) {
777 matcher->result = TRUE;
781 if (matcher->result) {
782 if (!matchers->bool_and)
790 *\brief Check if a line in a message file's body matches
793 *\param matchers List of conditions
794 *\param fp Message file
796 *\return gboolean TRUE if succesful match
798 static gboolean matcherlist_match_body(MatcherList *matchers, FILE *fp)
802 while (fgets(buf, sizeof(buf), fp) != NULL)
803 if (matcherlist_match_line(matchers, buf))
810 *\brief Check if a message file matches criteria
812 *\param matchers Criteria
813 *\param info Message info
814 *\param result Default result
816 *\return gboolean TRUE if matched
818 gboolean matcherlist_match_file(MatcherList *matchers, MsgInfo *info,
821 gboolean read_headers;
827 /* file need to be read ? */
829 read_headers = FALSE;
831 for (l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
832 MatcherProp *matcher = (MatcherProp *) l->data;
834 if (matcherprop_criteria_headers(matcher))
836 if (matcherprop_criteria_body(matcher))
838 if (matcherprop_criteria_message(matcher)) {
842 matcher->result = FALSE;
845 if (!read_headers && !read_body)
848 file = procmsg_get_message_file_full(info, read_headers, read_body);
852 if ((fp = g_fopen(file, "rb")) == NULL) {
853 FILE_OP_ERROR(file, "fopen");
858 /* read the headers */
861 if (matcherlist_match_headers(matchers, fp))
865 matcherlist_skip_headers(fp);
870 matcherlist_match_body(matchers, fp);
873 for (l = matchers->matchers; l != NULL; l = g_slist_next(l)) {
874 MatcherProp *matcher = (MatcherProp *) l->data;
876 if (matcherprop_criteria_headers(matcher) ||
877 matcherprop_criteria_body(matcher) ||
878 matcherprop_criteria_message(matcher)) {
879 if (matcher->result) {
880 if (!matchers->bool_and) {
886 if (matchers->bool_and) {
902 *\brief Test list of conditions on a message.
904 *\param matchers List of conditions
905 *\param info Message info
907 *\return gboolean TRUE if matched
909 gboolean matcherlist_match(MatcherList *matchers, MsgInfo *info)
914 if (matchers->bool_and)
919 /* test the cached elements */
921 for (l = matchers->matchers; l != NULL ;l = g_slist_next(l)) {
922 MatcherProp *matcher = (MatcherProp *) l->data;
924 switch(matcher->criteria) {
925 case MATCHCRITERIA_ALL:
926 case MATCHCRITERIA_UNREAD:
927 case MATCHCRITERIA_NOT_UNREAD:
928 case MATCHCRITERIA_NEW:
929 case MATCHCRITERIA_NOT_NEW:
930 case MATCHCRITERIA_MARKED:
931 case MATCHCRITERIA_NOT_MARKED:
932 case MATCHCRITERIA_DELETED:
933 case MATCHCRITERIA_NOT_DELETED:
934 case MATCHCRITERIA_REPLIED:
935 case MATCHCRITERIA_NOT_REPLIED:
936 case MATCHCRITERIA_FORWARDED:
937 case MATCHCRITERIA_NOT_FORWARDED:
938 case MATCHCRITERIA_LOCKED:
939 case MATCHCRITERIA_NOT_LOCKED:
940 case MATCHCRITERIA_COLORLABEL:
941 case MATCHCRITERIA_NOT_COLORLABEL:
942 case MATCHCRITERIA_IGNORE_THREAD:
943 case MATCHCRITERIA_NOT_IGNORE_THREAD:
944 case MATCHCRITERIA_SUBJECT:
945 case MATCHCRITERIA_NOT_SUBJECT:
946 case MATCHCRITERIA_FROM:
947 case MATCHCRITERIA_NOT_FROM:
948 case MATCHCRITERIA_TO:
949 case MATCHCRITERIA_NOT_TO:
950 case MATCHCRITERIA_CC:
951 case MATCHCRITERIA_NOT_CC:
952 case MATCHCRITERIA_TO_OR_CC:
953 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
954 case MATCHCRITERIA_AGE_GREATER:
955 case MATCHCRITERIA_AGE_LOWER:
956 case MATCHCRITERIA_NEWSGROUPS:
957 case MATCHCRITERIA_NOT_NEWSGROUPS:
958 case MATCHCRITERIA_INREPLYTO:
959 case MATCHCRITERIA_NOT_INREPLYTO:
960 case MATCHCRITERIA_REFERENCES:
961 case MATCHCRITERIA_NOT_REFERENCES:
962 case MATCHCRITERIA_SCORE_GREATER:
963 case MATCHCRITERIA_SCORE_LOWER:
964 case MATCHCRITERIA_SCORE_EQUAL:
965 case MATCHCRITERIA_SIZE_GREATER:
966 case MATCHCRITERIA_SIZE_SMALLER:
967 case MATCHCRITERIA_SIZE_EQUAL:
968 case MATCHCRITERIA_TEST:
969 case MATCHCRITERIA_NOT_TEST:
970 case MATCHCRITERIA_PARTIAL:
971 case MATCHCRITERIA_NOT_PARTIAL:
972 if (matcherprop_match(matcher, info)) {
973 if (!matchers->bool_and) {
978 if (matchers->bool_and) {
985 /* test the condition on the file */
987 if (matcherlist_match_file(matchers, info, result)) {
988 if (!matchers->bool_and)
992 if (matchers->bool_and)
1000 static gint quote_filter_str(gchar * result, guint size,
1010 for(p = path ; * p != '\0' ; p ++) {
1012 if ((* p != '\"') && (* p != '\\')) {
1013 if (remaining > 0) {
1019 result[size - 1] = '\0';
1024 if (remaining >= 2) {
1032 result[size - 1] = '\0';
1037 if (remaining > 0) {
1041 result[size - 1] = '\0';
1049 gchar * matcher_quote_str(const gchar * src)
1054 len = strlen(src) * 2 + 1;
1055 res = g_malloc(len);
1056 quote_filter_str(res, len, src);
1062 *\brief Convert a matcher structure to a string
1064 *\param matcher Matcher structure
1066 *\return gchar * Newly allocated string
1068 gchar *matcherprop_to_string(MatcherProp *matcher)
1070 gchar *matcher_str = NULL;
1071 const gchar *criteria_str;
1072 const gchar *matchtype_str;
1074 gchar * quoted_expr;
1076 criteria_str = NULL;
1077 for (i = 0; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)); i++) {
1078 if (matchparser_tab[i].id == matcher->criteria)
1079 criteria_str = matchparser_tab[i].str;
1081 if (criteria_str == NULL)
1084 switch (matcher->criteria) {
1085 case MATCHCRITERIA_AGE_GREATER:
1086 case MATCHCRITERIA_AGE_LOWER:
1087 case MATCHCRITERIA_SCORE_GREATER:
1088 case MATCHCRITERIA_SCORE_LOWER:
1089 case MATCHCRITERIA_SCORE_EQUAL:
1090 case MATCHCRITERIA_SIZE_GREATER:
1091 case MATCHCRITERIA_SIZE_SMALLER:
1092 case MATCHCRITERIA_SIZE_EQUAL:
1093 case MATCHCRITERIA_COLORLABEL:
1094 case MATCHCRITERIA_NOT_COLORLABEL:
1095 return g_strdup_printf("%s %i", criteria_str, matcher->value);
1096 case MATCHCRITERIA_ALL:
1097 case MATCHCRITERIA_UNREAD:
1098 case MATCHCRITERIA_NOT_UNREAD:
1099 case MATCHCRITERIA_NEW:
1100 case MATCHCRITERIA_NOT_NEW:
1101 case MATCHCRITERIA_MARKED:
1102 case MATCHCRITERIA_NOT_MARKED:
1103 case MATCHCRITERIA_DELETED:
1104 case MATCHCRITERIA_NOT_DELETED:
1105 case MATCHCRITERIA_REPLIED:
1106 case MATCHCRITERIA_NOT_REPLIED:
1107 case MATCHCRITERIA_FORWARDED:
1108 case MATCHCRITERIA_NOT_FORWARDED:
1109 case MATCHCRITERIA_LOCKED:
1110 case MATCHCRITERIA_NOT_LOCKED:
1111 case MATCHCRITERIA_PARTIAL:
1112 case MATCHCRITERIA_NOT_PARTIAL:
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 quoted_expr = matcher_quote_str(matcher->expr);
1119 matcher_str = g_strdup_printf("%s \"%s\"",
1120 criteria_str, quoted_expr);
1121 g_free(quoted_expr);
1125 matchtype_str = NULL;
1126 for (i = 0; i < sizeof matchparser_tab / sizeof matchparser_tab[0]; i++) {
1127 if (matchparser_tab[i].id == matcher->matchtype)
1128 matchtype_str = matchparser_tab[i].str;
1131 if (matchtype_str == NULL)
1134 switch (matcher->matchtype) {
1135 case MATCHTYPE_MATCH:
1136 case MATCHTYPE_MATCHCASE:
1137 case MATCHTYPE_REGEXP:
1138 case MATCHTYPE_REGEXPCASE:
1139 case MATCHTYPE_ALL_IN_ADDRESSBOOK:
1140 case MATCHTYPE_ANY_IN_ADDRESSBOOK:
1141 quoted_expr = matcher_quote_str(matcher->expr);
1142 if (matcher->header) {
1143 gchar * quoted_header;
1145 quoted_header = matcher_quote_str(matcher->header);
1146 matcher_str = g_strdup_printf
1147 ("%s \"%s\" %s \"%s\"",
1148 criteria_str, quoted_header,
1149 matchtype_str, quoted_expr);
1150 g_free(quoted_header);
1153 matcher_str = g_strdup_printf
1154 ("%s %s \"%s\"", criteria_str,
1155 matchtype_str, quoted_expr);
1156 g_free(quoted_expr);
1164 *\brief Convert a list of conditions to a string
1166 *\param matchers List of conditions
1168 *\return gchar * Newly allocated string
1170 gchar *matcherlist_to_string(const MatcherList *matchers)
1176 gchar *result = NULL;
1178 count = g_slist_length(matchers->matchers);
1179 vstr = g_new(gchar *, count + 1);
1181 for (l = matchers->matchers, cur_str = vstr; l != NULL;
1182 l = g_slist_next(l), cur_str ++) {
1183 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
1184 if (*cur_str == NULL)
1189 if (matchers->bool_and)
1190 result = g_strjoinv(" & ", vstr);
1192 result = g_strjoinv(" | ", vstr);
1194 for (cur_str = vstr ; *cur_str != NULL ; cur_str ++)
1202 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
1203 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
1205 static void add_str_default(gchar ** dest,
1206 const gchar * s, const gchar * d)
1208 gchar quoted_str[4096];
1216 quote_cmd_argument(quoted_str, sizeof(quoted_str), str);
1217 strcpy(* dest, quoted_str);
1219 (* dest) += strlen(* dest);
1222 /* matching_build_command() - preferably cmd should be unescaped */
1224 *\brief Build the command line to execute
1226 *\param cmd String with command line specifiers
1227 *\param info Message info to use for command
1229 *\return gchar * Newly allocated string
1231 gchar *matching_build_command(const gchar *cmd, MsgInfo *info)
1233 const gchar *s = cmd;
1234 gchar *filename = NULL;
1235 gchar *processed_cmd;
1239 const gchar *const no_subject = _("(none)") ;
1240 const gchar *const no_from = _("(none)") ;
1241 const gchar *const no_to = _("(none)") ;
1242 const gchar *const no_cc = _("(none)") ;
1243 const gchar *const no_date = _("(none)") ;
1244 const gchar *const no_msgid = _("(none)") ;
1245 const gchar *const no_newsgroups = _("(none)") ;
1246 const gchar *const no_references = _("(none)") ;
1248 size = STRLEN_ZERO(cmd) + 1;
1249 while (*s != '\0') {
1256 case 's': /* subject */
1257 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
1259 case 'f': /* from */
1260 size += STRLEN_DEFAULT(info->from, no_from) - 2;
1263 size += STRLEN_DEFAULT(info->to, no_to) - 2;
1266 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
1268 case 'd': /* date */
1269 size += STRLEN_DEFAULT(info->date, no_date) - 2;
1271 case 'i': /* message-id */
1272 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
1274 case 'n': /* newsgroups */
1275 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
1277 case 'r': /* references */
1278 /* FIXME: using the inreplyto header for reference */
1279 size += STRLEN_DEFAULT(info->inreplyto, no_references) - 2;
1281 case 'F': /* file */
1282 if (filename == NULL)
1283 filename = folder_item_fetch_msg(info->folder, info->msgnum);
1285 if (filename == NULL) {
1286 g_warning("filename is not set");
1290 size += strlen(filename) - 2;
1299 /* as the string can be quoted, we double the result */
1302 processed_cmd = g_new0(gchar, size);
1306 while (*s != '\0') {
1314 case 's': /* subject */
1315 add_str_default(&p, info->subject,
1318 case 'f': /* from */
1319 add_str_default(&p, info->from,
1323 add_str_default(&p, info->to,
1327 add_str_default(&p, info->cc,
1330 case 'd': /* date */
1331 add_str_default(&p, info->date,
1334 case 'i': /* message-id */
1335 add_str_default(&p, info->msgid,
1338 case 'n': /* newsgroups */
1339 add_str_default(&p, info->newsgroups,
1342 case 'r': /* references */
1343 /* FIXME: using the inreplyto header for references */
1344 add_str_default(&p, info->inreplyto, no_references);
1346 case 'F': /* file */
1347 if (filename != NULL)
1348 add_str_default(&p, filename, NULL);
1367 return processed_cmd;
1369 #undef STRLEN_DEFAULT
1372 /* ************************************************************ */
1376 *\brief Write filtering list to file
1379 *\param prefs_filtering List of filtering conditions
1381 static void prefs_filtering_write(FILE *fp, GSList *prefs_filtering)
1385 for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1386 gchar *filtering_str;
1387 gchar *tmp_name = NULL;
1388 FilteringProp *prop;
1390 if (NULL == (prop = (FilteringProp *) cur->data))
1393 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1396 if (fputs("rulename \"", fp) == EOF) {
1397 FILE_OP_ERROR("filtering config", "fputs || fputc");
1398 g_free(filtering_str);
1401 tmp_name = prop->name;
1402 while (tmp_name && *tmp_name != '\0') {
1403 if (*tmp_name != '"') {
1404 if (fputc(*tmp_name, fp) == EOF) {
1405 FILE_OP_ERROR("filtering config", "fputc");
1406 g_free(filtering_str);
1409 } else if (*tmp_name == '"') {
1410 if (fputc('\\', fp) == EOF ||
1411 fputc('"', fp) == EOF) {
1412 FILE_OP_ERROR("filtering config", "fputc");
1413 g_free(filtering_str);
1419 if(fputs("\" ", fp) == EOF ||
1420 fputs(filtering_str, fp) == EOF ||
1421 fputc('\n', fp) == EOF) {
1422 FILE_OP_ERROR("filtering config", "fputs || fputc");
1423 g_free(filtering_str);
1426 g_free(filtering_str);
1431 *\brief Write matchers from a folder item
1433 *\param node Node with folder info
1434 *\param data File pointer
1436 *\return gboolean FALSE
1438 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1443 GSList *prefs_filtering;
1446 /* prevent warning */
1447 if (item->path == NULL)
1449 id = folder_item_get_identifier(item);
1452 prefs_filtering = item->prefs->processing;
1454 if (prefs_filtering != NULL) {
1455 fprintf(fp, "[%s]\n", id);
1456 prefs_filtering_write(fp, prefs_filtering);
1466 *\brief Save matchers from folder items
1470 static void prefs_matcher_save(FILE *fp)
1474 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1477 folder = (Folder *) cur->data;
1478 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1479 prefs_matcher_write_func, fp);
1482 /* pre global rules */
1483 fprintf(fp, "[preglobal]\n");
1484 prefs_filtering_write(fp, pre_global_processing);
1487 /* post global rules */
1488 fprintf(fp, "[postglobal]\n");
1489 prefs_filtering_write(fp, post_global_processing);
1492 /* filtering rules */
1493 fprintf(fp, "[filtering]\n");
1494 prefs_filtering_write(fp, filtering_rules);
1499 *\brief Write filtering / matcher configuration file
1501 void prefs_matcher_write_config(void)
1506 debug_print("Writing matcher configuration...\n");
1508 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1511 if ((pfile = prefs_write_open(rcpath)) == NULL) {
1512 g_warning("failed to write configuration to file\n");
1518 prefs_matcher_save(pfile->fp);
1522 if (prefs_file_close(pfile) < 0) {
1523 g_warning("failed to write configuration to file\n");
1528 /* ******************************************************************* */
1530 void matcher_add_rulenames(const gchar *rcpath)
1532 gchar *newpath = g_strconcat(rcpath, ".new", NULL);
1533 FILE *src = g_fopen(rcpath, "rb");
1534 FILE *dst = g_fopen(newpath, "wb");
1535 gchar buf[BUFFSIZE];
1543 while (fgets (buf, sizeof(buf), src) != NULL) {
1544 if (strlen(buf) > 2 && buf[0] != '['
1545 && strncmp(buf, "rulename \"", 10)) {
1546 fwrite("rulename \"\" ",
1547 strlen("rulename \"\" "), 1, dst);
1549 fwrite(buf, strlen(buf), 1, dst);
1553 move_file(newpath, rcpath, TRUE);
1558 *\brief Read matcher configuration
1560 void prefs_matcher_read_config(void)
1563 gchar *rc_old_format;
1566 create_matchparser_hashtab();
1567 prefs_filtering_clear();
1569 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1570 rc_old_format = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC,
1571 ".pre_names", NULL);
1573 if (!is_file_exist(rc_old_format) && is_file_exist(rcpath)) {
1574 /* backup file with no rules names, in case
1575 * anything goes wrong */
1576 copy_file(rcpath, rc_old_format, FALSE);
1577 /* now hack the file in order to have it to the new format */
1578 matcher_add_rulenames(rcpath);
1580 f = g_fopen(rcpath, "rb");
1584 matcher_parser_start_parsing(f);
1585 fclose(matcher_parserin);
1588 /* previous version compatibily */
1590 /* printf("reading filtering\n"); */
1591 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1592 FILTERING_RC, NULL);
1593 f = g_fopen(rcpath, "rb");
1597 matcher_parser_start_parsing(f);
1598 fclose(matcher_parserin);
1601 /* printf("reading scoring\n"); */
1602 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1604 f = g_fopen(rcpath, "rb");
1608 matcher_parser_start_parsing(f);
1609 fclose(matcher_parserin);