2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2002 Hiroyuki Yamamoto & The Sylpheed Claws Team
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.
22 #include <glib/gi18n.h>
31 #include "procheader.h"
33 #include "filtering.h"
34 #include "prefs_gtk.h"
37 #define PREFSBUFSIZE 1024
39 GSList * pre_global_processing = NULL;
40 GSList * post_global_processing = NULL;
41 GSList * filtering_rules = NULL;
43 static gboolean filtering_is_final_action(FilteringAction *filtering_action);
45 #define STRLEN_WITH_CHECK(expr) \
46 strlen_with_check(#expr, __LINE__, expr)
48 static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
53 debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
58 FilteringAction * filteringaction_new(int type, int account_id,
60 gint labelcolor, gint score)
62 FilteringAction * action;
64 action = g_new0(FilteringAction, 1);
67 action->account_id = account_id;
69 action->destination = g_strdup(destination);
71 action->destination = NULL;
73 action->labelcolor = labelcolor;
74 action->score = score;
78 void filteringaction_free(FilteringAction * action)
80 g_return_if_fail(action);
81 if (action->destination)
82 g_free(action->destination);
86 FilteringProp * filteringprop_new(const gchar *name,
87 MatcherList * matchers,
90 FilteringProp * filtering;
92 filtering = g_new0(FilteringProp, 1);
93 filtering->name = name ? g_strdup(name): NULL;
94 filtering->matchers = matchers;
95 filtering->action_list = action_list;
100 static FilteringAction * filteringaction_copy(FilteringAction * src)
102 FilteringAction * new;
104 new = g_new0(FilteringAction, 1);
106 new->type = src->type;
107 new->account_id = src->account_id;
108 if (src->destination)
109 new->destination = g_strdup(src->destination);
111 new->destination = NULL;
112 new->labelcolor = src->labelcolor;
113 new->score = src->score;
118 FilteringProp * filteringprop_copy(FilteringProp *src)
123 new = g_new0(FilteringProp, 1);
124 new->matchers = g_new0(MatcherList, 1);
126 for (tmp = src->matchers->matchers; tmp != NULL && tmp->data != NULL;) {
127 MatcherProp *matcher = (MatcherProp *)tmp->data;
129 new->matchers->matchers = g_slist_append(new->matchers->matchers,
130 matcherprop_copy(matcher));
134 new->matchers->bool_and = src->matchers->bool_and;
136 new->action_list = NULL;
138 for (tmp = src->action_list ; tmp != NULL ; tmp = tmp->next) {
139 FilteringAction *filtering_action;
141 filtering_action = tmp->data;
143 new->action_list = g_slist_append(new->action_list,
144 filteringaction_copy(filtering_action));
147 new->name = g_strdup(src->name);
152 void filteringprop_free(FilteringProp * prop)
156 g_return_if_fail(prop);
157 matcherlist_free(prop->matchers);
159 for (tmp = prop->action_list ; tmp != NULL ; tmp = tmp->next) {
160 filteringaction_free(tmp->data);
167 fitleringaction_apply
168 runs the action on one MsgInfo
169 return value : return TRUE if the action could be applied
172 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
174 FolderItem * dest_folder;
177 PrefsAccount * account;
180 switch(action->type) {
181 case MATCHACTION_MOVE:
183 folder_find_item_from_identifier(action->destination);
185 debug_print("*** folder not found '%s'\n",
186 action->destination ?action->destination :"");
190 if (folder_item_move_msg(dest_folder, info) == -1) {
191 debug_print("*** could not move message\n");
197 case MATCHACTION_COPY:
199 folder_find_item_from_identifier(action->destination);
202 debug_print("*** folder not found '%s'\n",
203 action->destination ?action->destination :"");
207 if (folder_item_copy_msg(dest_folder, info) == -1)
212 case MATCHACTION_DELETE:
213 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
217 case MATCHACTION_MARK:
218 procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
221 case MATCHACTION_UNMARK:
222 procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
225 case MATCHACTION_LOCK:
226 procmsg_msginfo_set_flags(info, MSG_LOCKED, 0);
229 case MATCHACTION_UNLOCK:
230 procmsg_msginfo_unset_flags(info, MSG_LOCKED, 0);
233 case MATCHACTION_MARK_AS_READ:
234 procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
237 case MATCHACTION_MARK_AS_UNREAD:
238 procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
241 case MATCHACTION_COLOR:
242 procmsg_msginfo_unset_flags(info, MSG_CLABEL_FLAG_MASK, 0);
243 procmsg_msginfo_set_flags(info, MSG_COLORLABEL_TO_FLAGS(action->labelcolor), 0);
246 case MATCHACTION_FORWARD:
247 case MATCHACTION_FORWARD_AS_ATTACHMENT:
248 account = account_find_from_id(action->account_id);
249 compose = compose_forward(account, info,
250 action->type == MATCHACTION_FORWARD ? FALSE : TRUE,
252 compose_entry_append(compose, action->destination,
253 compose->account->protocol == A_NNTP
257 val = compose_send(compose);
259 return val == 0 ? TRUE : FALSE;
261 case MATCHACTION_REDIRECT:
262 account = account_find_from_id(action->account_id);
263 compose = compose_redirect(account, info);
264 if (compose->account->protocol == A_NNTP)
267 compose_entry_append(compose, action->destination,
270 val = compose_send(compose);
272 return val == 0 ? TRUE : FALSE;
274 case MATCHACTION_EXECUTE:
275 cmd = matching_build_command(action->destination, info);
284 case MATCHACTION_SET_SCORE:
285 info->score = action->score;
288 case MATCHACTION_CHANGE_SCORE:
289 info->score += action->score;
292 case MATCHACTION_STOP:
295 case MATCHACTION_HIDE:
305 gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
308 g_return_val_if_fail(action_list, FALSE);
309 g_return_val_if_fail(info, FALSE);
310 for (p = action_list; p && p->data; p = g_slist_next(p)) {
311 FilteringAction *a = (FilteringAction *) p->data;
312 if (filteringaction_apply(a, info)) {
313 if (filtering_is_final_action(a))
322 static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
324 return matcherlist_match(filtering->matchers, info);
328 *\brief Apply a rule on message.
330 *\param filtering List of filtering rules.
331 *\param info Message to apply rules on.
332 *\param final Variable returning TRUE or FALSE if one of the
333 * encountered actions was final.
334 * See also \ref filtering_is_final_action.
336 *\return gboolean TRUE to continue applying rules.
338 static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
341 gboolean result = TRUE;
346 for (tmp = filtering->action_list ; tmp != NULL ; tmp = tmp->next) {
347 FilteringAction * action;
351 if (FALSE == (result = filteringaction_apply(action, info))) {
352 g_warning("No further processing after rule %s\n",
353 filteringaction_to_string(buf, sizeof buf, action));
356 if (filtering_is_final_action(action)) {
365 *\brief Check if an action is "final", i.e. should break further
368 *\param filtering_action Action to check.
370 *\return gboolean TRUE if \a filtering_action is final.
372 static gboolean filtering_is_final_action(FilteringAction *filtering_action)
374 switch(filtering_action->type) {
375 case MATCHACTION_MOVE:
376 case MATCHACTION_DELETE:
377 case MATCHACTION_STOP:
378 return TRUE; /* MsgInfo invalid for message */
384 static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info)
390 g_return_val_if_fail(info != NULL, TRUE);
392 for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
393 FilteringProp * filtering = (FilteringProp *) l->data;
395 if (filtering_match_condition(filtering, info)) {
396 apply_next = filtering_apply_rule(filtering, info, &final);
402 /* put in inbox if a final rule could not be applied, or
403 * the last rule was not a final one. */
404 if ((final && !apply_next) || !final) {
412 *\brief Filter a message against a list of rules.
414 *\param flist List of filter rules.
415 *\param info Message.
417 *\return gboolean TRUE if filter rules handled the message.
419 *\note Returning FALSE means the message was not handled,
420 * and that the calling code should do the default
421 * processing. E.g. \ref inc.c::inc_start moves the
422 * message to the inbox.
424 gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info)
426 return filter_msginfo(flist, info);
429 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
431 const gchar *command_str;
434 command_str = get_matchparser_tab_str(action->type);
436 if (command_str == NULL)
439 switch(action->type) {
440 case MATCHACTION_MOVE:
441 case MATCHACTION_COPY:
442 case MATCHACTION_EXECUTE:
443 quoted_dest = matcher_quote_str(action->destination);
444 g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
448 case MATCHACTION_DELETE:
449 case MATCHACTION_MARK:
450 case MATCHACTION_UNMARK:
451 case MATCHACTION_LOCK:
452 case MATCHACTION_UNLOCK:
453 case MATCHACTION_MARK_AS_READ:
454 case MATCHACTION_MARK_AS_UNREAD:
455 case MATCHACTION_STOP:
456 case MATCHACTION_HIDE:
457 g_snprintf(dest, destlen, "%s", command_str);
460 case MATCHACTION_REDIRECT:
461 case MATCHACTION_FORWARD:
462 case MATCHACTION_FORWARD_AS_ATTACHMENT:
463 quoted_dest = matcher_quote_str(action->destination);
464 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, quoted_dest);
468 case MATCHACTION_COLOR:
469 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
472 case MATCHACTION_CHANGE_SCORE:
473 case MATCHACTION_SET_SCORE:
474 g_snprintf(dest, destlen, "%s %d", command_str, action->score);
482 gchar * filteringaction_list_to_string(GSList * action_list)
484 gchar *action_list_str;
489 action_list_str = NULL;
490 for (tmp = action_list ; tmp != NULL ; tmp = tmp->next) {
492 FilteringAction * action;
496 action_str = filteringaction_to_string(buf,
499 if (action_list_str != NULL) {
500 list_str = g_strconcat(action_list_str, " ", action_str, NULL);
501 g_free(action_list_str);
504 list_str = g_strdup(action_str);
506 action_list_str = list_str;
509 return action_list_str;
512 gchar * filteringprop_to_string(FilteringProp * prop)
515 gchar *action_list_str;
516 gchar *filtering_str;
518 action_list_str = filteringaction_list_to_string(prop->action_list);
520 if (action_list_str == NULL)
523 list_str = matcherlist_to_string(prop->matchers);
525 if (list_str == NULL) {
526 g_free(action_list_str);
530 filtering_str = g_strconcat(list_str, " ", action_list_str, NULL);
531 g_free(action_list_str);
534 return filtering_str;
537 void prefs_filtering_free(GSList * prefs_filtering)
539 while (prefs_filtering != NULL) {
540 FilteringProp * filtering = (FilteringProp *)
541 prefs_filtering->data;
542 filteringprop_free(filtering);
543 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
547 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
549 FolderItem *item = node->data;
551 g_return_val_if_fail(item, FALSE);
552 g_return_val_if_fail(item->prefs, FALSE);
554 prefs_filtering_free(item->prefs->processing);
555 item->prefs->processing = NULL;
560 void prefs_filtering_clear(void)
564 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
567 folder = (Folder *) cur->data;
568 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
569 prefs_filtering_free_func, NULL);
572 prefs_filtering_free(filtering_rules);
573 filtering_rules = NULL;
574 prefs_filtering_free(pre_global_processing);
575 pre_global_processing = NULL;
576 prefs_filtering_free(post_global_processing);
577 post_global_processing = NULL;
580 void prefs_filtering_clear_folder(Folder *folder)
582 g_return_if_fail(folder);
583 g_return_if_fail(folder->node);
585 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
586 prefs_filtering_free_func, NULL);
587 /* FIXME: Note folder settings were changed, where the updates? */