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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #include "procheader.h"
31 #include "filtering.h"
32 #include "prefs_gtk.h"
35 #define PREFSBUFSIZE 1024
37 GSList * pre_global_processing = NULL;
38 GSList * post_global_processing = NULL;
39 GSList * filtering_rules = NULL;
41 static gboolean filtering_is_final_action(FilteringAction *filtering_action);
43 #define STRLEN_WITH_CHECK(expr) \
44 strlen_with_check(#expr, __LINE__, expr)
46 static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
51 debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
56 FilteringAction * filteringaction_new(int type, int account_id,
58 gint labelcolor, gint score)
60 FilteringAction * action;
62 action = g_new0(FilteringAction, 1);
65 action->account_id = account_id;
67 action->destination = g_strdup(destination);
69 action->destination = NULL;
71 action->labelcolor = labelcolor;
72 action->score = score;
76 void filteringaction_free(FilteringAction * action)
78 g_return_if_fail(action);
79 if (action->destination)
80 g_free(action->destination);
84 FilteringProp * filteringprop_new(MatcherList * matchers,
87 FilteringProp * filtering;
89 filtering = g_new0(FilteringProp, 1);
90 filtering->matchers = matchers;
91 filtering->action_list = action_list;
96 static FilteringAction * filteringaction_copy(FilteringAction * src)
98 FilteringAction * new;
100 new = g_new0(FilteringAction, 1);
102 new->type = src->type;
103 new->account_id = src->account_id;
104 if (src->destination)
105 new->destination = g_strdup(src->destination);
107 new->destination = NULL;
108 new->labelcolor = src->labelcolor;
113 FilteringProp * filteringprop_copy(FilteringProp *src)
118 new = g_new0(FilteringProp, 1);
119 new->matchers = g_new0(MatcherList, 1);
121 for (tmp = src->matchers->matchers; tmp != NULL && tmp->data != NULL;) {
122 MatcherProp *matcher = (MatcherProp *)tmp->data;
124 new->matchers->matchers = g_slist_append(new->matchers->matchers,
125 matcherprop_copy(matcher));
129 new->matchers->bool_and = src->matchers->bool_and;
131 new->action_list = NULL;
133 for (tmp = src->action_list ; tmp != NULL ; tmp = tmp->next) {
134 FilteringAction *filtering_action;
136 filtering_action = tmp->data;
138 new->action_list = g_slist_append(new->action_list,
139 filteringaction_copy(filtering_action));
145 void filteringprop_free(FilteringProp * prop)
149 g_return_if_fail(prop);
150 matcherlist_free(prop->matchers);
152 for (tmp = prop->action_list ; tmp != NULL ; tmp = tmp->next) {
153 filteringaction_free(tmp->data);
159 fitleringaction_apply
160 runs the action on one MsgInfo
161 return value : return TRUE if the action could be applied
164 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
166 FolderItem * dest_folder;
169 PrefsAccount * account;
172 switch(action->type) {
173 case MATCHACTION_MOVE:
175 folder_find_item_from_identifier(action->destination);
177 debug_print("*** folder not found '%s'\n",
178 action->destination ?action->destination :"");
182 if (folder_item_move_msg(dest_folder, info) == -1) {
183 debug_print("*** could not move message\n");
189 case MATCHACTION_COPY:
191 folder_find_item_from_identifier(action->destination);
194 debug_print("*** folder not found '%s'\n",
195 action->destination ?action->destination :"");
199 if (folder_item_copy_msg(dest_folder, info) == -1)
204 case MATCHACTION_DELETE:
205 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
209 case MATCHACTION_MARK:
210 procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
213 case MATCHACTION_UNMARK:
214 procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
217 case MATCHACTION_LOCK:
218 procmsg_msginfo_set_flags(info, MSG_LOCKED, 0);
221 case MATCHACTION_UNLOCK:
222 procmsg_msginfo_unset_flags(info, MSG_LOCKED, 0);
225 case MATCHACTION_MARK_AS_READ:
226 procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
229 case MATCHACTION_MARK_AS_UNREAD:
230 procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
233 case MATCHACTION_COLOR:
234 procmsg_msginfo_unset_flags(info, MSG_CLABEL_FLAG_MASK, 0);
235 procmsg_msginfo_set_flags(info, MSG_COLORLABEL_TO_FLAGS(action->labelcolor), 0);
238 case MATCHACTION_FORWARD:
239 case MATCHACTION_FORWARD_AS_ATTACHMENT:
240 account = account_find_from_id(action->account_id);
241 compose = compose_forward(account, info,
242 action->type == MATCHACTION_FORWARD ? FALSE : TRUE,
244 compose_entry_append(compose, action->destination,
245 compose->account->protocol == A_NNTP
249 val = compose_send(compose);
251 return val == 0 ? TRUE : FALSE;
253 case MATCHACTION_REDIRECT:
254 account = account_find_from_id(action->account_id);
255 compose = compose_redirect(account, info);
256 if (compose->account->protocol == A_NNTP)
259 compose_entry_append(compose, action->destination,
262 val = compose_send(compose);
264 return val == 0 ? TRUE : FALSE;
266 case MATCHACTION_EXECUTE:
267 cmd = matching_build_command(action->destination, info);
276 case MATCHACTION_SET_SCORE:
277 info->score = action->score;
280 case MATCHACTION_CHANGE_SCORE:
281 info->score += action->score;
284 case MATCHACTION_STOP:
287 case MATCHACTION_HIDE:
297 gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
300 g_return_val_if_fail(action_list, FALSE);
301 g_return_val_if_fail(info, FALSE);
302 for (p = action_list; p && p->data; p = g_slist_next(p)) {
303 FilteringAction *a = (FilteringAction *) p->data;
304 if (filteringaction_apply(a, info)) {
305 if (filtering_is_final_action(a))
314 static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
316 return matcherlist_match(filtering->matchers, info);
320 *\brief Apply a rule on message.
322 *\param filtering List of filtering rules.
323 *\param info Message to apply rules on.
324 *\param final Variable returning TRUE or FALSE if one of the
325 * encountered actions was final.
326 * See also \ref filtering_is_final_action.
328 *\return gboolean TRUE to continue applying rules.
330 static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
333 gboolean result = TRUE;
338 for (tmp = filtering->action_list ; tmp != NULL ; tmp = tmp->next) {
339 FilteringAction * action;
343 if (FALSE == (result = filteringaction_apply(action, info))) {
344 g_warning("No further processing after rule %s\n",
345 filteringaction_to_string(buf, sizeof buf, action));
348 if (filtering_is_final_action(action)) {
357 *\brief Check if an action is "final", i.e. should break further
360 *\param filtering_action Action to check.
362 *\return gboolean TRUE if \a filtering_action is final.
364 static gboolean filtering_is_final_action(FilteringAction *filtering_action)
366 switch(filtering_action->type) {
367 case MATCHACTION_MOVE:
368 case MATCHACTION_DELETE:
369 case MATCHACTION_STOP:
370 return TRUE; /* MsgInfo invalid for message */
376 static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info)
382 g_return_val_if_fail(info != NULL, TRUE);
384 for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
385 FilteringProp * filtering = (FilteringProp *) l->data;
387 if (filtering_match_condition(filtering, info)) {
388 apply_next = filtering_apply_rule(filtering, info, &final);
394 /* put in inbox if a final rule could not be applied, or
395 * the last rule was not a final one. */
396 if ((final && !apply_next) || !final) {
404 *\brief Filter a message against a list of rules.
406 *\param flist List of filter rules.
407 *\param info Message.
409 *\return gboolean TRUE if filter rules handled the message.
411 *\note Returning FALSE means the message was not handled,
412 * and that the calling code should do the default
413 * processing. E.g. \ref inc.c::inc_start moves the
414 * message to the inbox.
416 gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info)
418 return filter_msginfo(flist, info);
421 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
423 const gchar *command_str;
426 command_str = get_matchparser_tab_str(action->type);
428 if (command_str == NULL)
431 switch(action->type) {
432 case MATCHACTION_MOVE:
433 case MATCHACTION_COPY:
434 case MATCHACTION_EXECUTE:
435 quoted_dest = matcher_quote_str(action->destination);
436 g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
440 case MATCHACTION_DELETE:
441 case MATCHACTION_MARK:
442 case MATCHACTION_UNMARK:
443 case MATCHACTION_LOCK:
444 case MATCHACTION_UNLOCK:
445 case MATCHACTION_MARK_AS_READ:
446 case MATCHACTION_MARK_AS_UNREAD:
447 case MATCHACTION_STOP:
448 case MATCHACTION_HIDE:
449 g_snprintf(dest, destlen, "%s", command_str);
452 case MATCHACTION_REDIRECT:
453 case MATCHACTION_FORWARD:
454 case MATCHACTION_FORWARD_AS_ATTACHMENT:
455 quoted_dest = matcher_quote_str(action->destination);
456 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, quoted_dest);
460 case MATCHACTION_COLOR:
461 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
464 case MATCHACTION_CHANGE_SCORE:
465 case MATCHACTION_SET_SCORE:
466 g_snprintf(dest, destlen, "%s %d", command_str, action->score);
474 gchar * filteringaction_list_to_string(GSList * action_list)
476 gchar *action_list_str;
481 action_list_str = NULL;
482 for (tmp = action_list ; tmp != NULL ; tmp = tmp->next) {
484 FilteringAction * action;
488 action_str = filteringaction_to_string(buf,
491 if (action_list_str != NULL) {
492 list_str = g_strconcat(action_list_str, " ", action_str, NULL);
493 g_free(action_list_str);
496 list_str = g_strdup(action_str);
498 action_list_str = list_str;
501 return action_list_str;
504 gchar * filteringprop_to_string(FilteringProp * prop)
507 gchar *action_list_str;
508 gchar *filtering_str;
510 action_list_str = filteringaction_list_to_string(prop->action_list);
512 if (action_list_str == NULL)
515 list_str = matcherlist_to_string(prop->matchers);
517 if (list_str == NULL) {
518 g_free(action_list_str);
522 filtering_str = g_strconcat(list_str, " ", action_list_str, NULL);
523 g_free(action_list_str);
526 return filtering_str;
529 void prefs_filtering_free(GSList * prefs_filtering)
531 while (prefs_filtering != NULL) {
532 FilteringProp * filtering = (FilteringProp *)
533 prefs_filtering->data;
534 filteringprop_free(filtering);
535 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
539 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
541 FolderItem *item = node->data;
543 g_return_val_if_fail(item, FALSE);
544 g_return_val_if_fail(item->prefs, FALSE);
546 prefs_filtering_free(item->prefs->processing);
547 item->prefs->processing = NULL;
552 void prefs_filtering_clear(void)
556 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
559 folder = (Folder *) cur->data;
560 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
561 prefs_filtering_free_func, NULL);
564 prefs_filtering_free(filtering_rules);
565 filtering_rules = NULL;
566 prefs_filtering_free(pre_global_processing);
567 pre_global_processing = NULL;
568 prefs_filtering_free(post_global_processing);
569 post_global_processing = NULL;
572 void prefs_filtering_clear_folder(Folder *folder)
574 g_return_if_fail(folder);
575 g_return_if_fail(folder->node);
577 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
578 prefs_filtering_free_func, NULL);
579 /* FIXME: Note folder settings were changed, where the updates? */