2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2006 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);
166 /* move and copy messages by batches to be faster on IMAP */
167 void filtering_move_and_copy_msgs(GSList *msgs)
169 GSList *messages = g_slist_copy(msgs);
170 FolderItem *last_item = NULL;
171 gboolean is_copy = FALSE, is_move = FALSE;
174 GSList *batch = NULL, *cur;
176 debug_print("%d messages to filter\n", g_slist_length(messages));
177 for (cur = messages; cur; cur = cur->next) {
178 MsgInfo *info = (MsgInfo *)cur->data;
179 if (last_item == NULL) {
180 last_item = info->to_folder;
182 if (last_item == NULL)
184 debug_print("for %s\n", folder_item_get_path(last_item));
185 if (!is_copy && !is_move) {
188 else if (info->is_move)
192 if (info->to_folder == last_item
193 && info->is_copy == is_copy
194 && info->is_move == is_move) {
195 batch = g_slist_append(batch, info);
199 debug_print("no more messages to move/copy\n");
202 for (cur = batch; cur; cur = cur->next) {
203 MsgInfo *info = (MsgInfo *)cur->data;
204 messages = g_slist_remove(messages, info);
206 if (g_slist_length(batch)) {
207 debug_print("%s %d messages to %s\n",
208 is_copy?"copying":"moving",
209 g_slist_length(batch),
210 folder_item_get_path(last_item));
212 folder_item_copy_msgs(last_item, batch);
213 } else if (is_move) {
214 if (folder_item_move_msgs(last_item, batch) < 0)
215 folder_item_move_msgs(
216 folder_get_default_inbox(),
219 /* we don't reference the msginfos, because caller will do */
226 debug_print("%d messages remaining\n", g_slist_length(messages));
228 /* we don't reference the msginfos, because caller will do */
229 g_slist_free(messages);
233 fitleringaction_apply
234 runs the action on one MsgInfo
235 return value : return TRUE if the action could be applied
238 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
240 FolderItem * dest_folder;
243 PrefsAccount * account;
246 switch(action->type) {
247 case MATCHACTION_MOVE:
249 folder_find_item_from_identifier(action->destination);
251 debug_print("*** folder not found '%s'\n",
252 action->destination ?action->destination :"");
256 /* mark message to be moved */
257 info->is_move = TRUE;
258 info->to_folder = dest_folder;
259 debug_print("set to move to %s\n", folder_item_get_path(dest_folder));
262 case MATCHACTION_COPY:
264 folder_find_item_from_identifier(action->destination);
267 debug_print("*** folder not found '%s'\n",
268 action->destination ?action->destination :"");
272 /* mark message to be copied */
273 info->is_copy = TRUE;
274 info->to_folder = dest_folder;
275 debug_print("set to copy to %s\n", folder_item_get_path(dest_folder));
278 case MATCHACTION_DELETE:
279 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
283 case MATCHACTION_MARK:
284 procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
287 case MATCHACTION_UNMARK:
288 procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
291 case MATCHACTION_LOCK:
292 procmsg_msginfo_set_flags(info, MSG_LOCKED, 0);
295 case MATCHACTION_UNLOCK:
296 procmsg_msginfo_unset_flags(info, MSG_LOCKED, 0);
299 case MATCHACTION_MARK_AS_READ:
300 procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
303 case MATCHACTION_MARK_AS_UNREAD:
304 procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
307 case MATCHACTION_COLOR:
308 procmsg_msginfo_unset_flags(info, MSG_CLABEL_FLAG_MASK, 0);
309 procmsg_msginfo_set_flags(info, MSG_COLORLABEL_TO_FLAGS(action->labelcolor), 0);
312 case MATCHACTION_FORWARD:
313 case MATCHACTION_FORWARD_AS_ATTACHMENT:
314 account = account_find_from_id(action->account_id);
315 compose = compose_forward(account, info,
316 action->type == MATCHACTION_FORWARD ? FALSE : TRUE,
318 compose_entry_append(compose, action->destination,
319 compose->account->protocol == A_NNTP
323 val = compose_send(compose);
325 return val == 0 ? TRUE : FALSE;
327 case MATCHACTION_REDIRECT:
328 account = account_find_from_id(action->account_id);
329 compose = compose_redirect(account, info);
330 if (compose->account->protocol == A_NNTP)
333 compose_entry_append(compose, action->destination,
336 val = compose_send(compose);
338 return val == 0 ? TRUE : FALSE;
340 case MATCHACTION_EXECUTE:
341 cmd = matching_build_command(action->destination, info);
350 case MATCHACTION_SET_SCORE:
351 info->score = action->score;
354 case MATCHACTION_CHANGE_SCORE:
355 info->score += action->score;
358 case MATCHACTION_STOP:
361 case MATCHACTION_HIDE:
371 gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
374 g_return_val_if_fail(action_list, FALSE);
375 g_return_val_if_fail(info, FALSE);
376 for (p = action_list; p && p->data; p = g_slist_next(p)) {
377 FilteringAction *a = (FilteringAction *) p->data;
378 if (filteringaction_apply(a, info)) {
379 if (filtering_is_final_action(a))
388 static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
390 return matcherlist_match(filtering->matchers, info);
394 *\brief Apply a rule on message.
396 *\param filtering List of filtering rules.
397 *\param info Message to apply rules on.
398 *\param final Variable returning TRUE or FALSE if one of the
399 * encountered actions was final.
400 * See also \ref filtering_is_final_action.
402 *\return gboolean TRUE to continue applying rules.
404 static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
407 gboolean result = TRUE;
412 for (tmp = filtering->action_list ; tmp != NULL ; tmp = tmp->next) {
413 FilteringAction * action;
417 if (FALSE == (result = filteringaction_apply(action, info))) {
418 g_warning("No further processing after rule %s\n",
419 filteringaction_to_string(buf, sizeof buf, action));
422 if (filtering_is_final_action(action)) {
431 *\brief Check if an action is "final", i.e. should break further
434 *\param filtering_action Action to check.
436 *\return gboolean TRUE if \a filtering_action is final.
438 static gboolean filtering_is_final_action(FilteringAction *filtering_action)
440 switch(filtering_action->type) {
441 case MATCHACTION_MOVE:
442 case MATCHACTION_DELETE:
443 case MATCHACTION_STOP:
444 return TRUE; /* MsgInfo invalid for message */
450 static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info)
456 g_return_val_if_fail(info != NULL, TRUE);
458 for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
459 FilteringProp * filtering = (FilteringProp *) l->data;
461 if (filtering_match_condition(filtering, info)) {
462 apply_next = filtering_apply_rule(filtering, info, &final);
468 /* put in inbox if a final rule could not be applied, or
469 * the last rule was not a final one. */
470 if ((final && !apply_next) || !final) {
478 *\brief Filter a message against a list of rules.
480 *\param flist List of filter rules.
481 *\param info Message.
483 *\return gboolean TRUE if filter rules handled the message.
485 *\note Returning FALSE means the message was not handled,
486 * and that the calling code should do the default
487 * processing. E.g. \ref inc.c::inc_start moves the
488 * message to the inbox.
490 gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info)
492 return filter_msginfo(flist, info);
495 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
497 const gchar *command_str;
500 command_str = get_matchparser_tab_str(action->type);
502 if (command_str == NULL)
505 switch(action->type) {
506 case MATCHACTION_MOVE:
507 case MATCHACTION_COPY:
508 case MATCHACTION_EXECUTE:
509 quoted_dest = matcher_quote_str(action->destination);
510 g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
514 case MATCHACTION_DELETE:
515 case MATCHACTION_MARK:
516 case MATCHACTION_UNMARK:
517 case MATCHACTION_LOCK:
518 case MATCHACTION_UNLOCK:
519 case MATCHACTION_MARK_AS_READ:
520 case MATCHACTION_MARK_AS_UNREAD:
521 case MATCHACTION_STOP:
522 case MATCHACTION_HIDE:
523 g_snprintf(dest, destlen, "%s", command_str);
526 case MATCHACTION_REDIRECT:
527 case MATCHACTION_FORWARD:
528 case MATCHACTION_FORWARD_AS_ATTACHMENT:
529 quoted_dest = matcher_quote_str(action->destination);
530 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, quoted_dest);
534 case MATCHACTION_COLOR:
535 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
538 case MATCHACTION_CHANGE_SCORE:
539 case MATCHACTION_SET_SCORE:
540 g_snprintf(dest, destlen, "%s %d", command_str, action->score);
548 gchar * filteringaction_list_to_string(GSList * action_list)
550 gchar *action_list_str;
555 action_list_str = NULL;
556 for (tmp = action_list ; tmp != NULL ; tmp = tmp->next) {
558 FilteringAction * action;
562 action_str = filteringaction_to_string(buf,
565 if (action_list_str != NULL) {
566 list_str = g_strconcat(action_list_str, " ", action_str, NULL);
567 g_free(action_list_str);
570 list_str = g_strdup(action_str);
572 action_list_str = list_str;
575 return action_list_str;
578 gchar * filteringprop_to_string(FilteringProp * prop)
581 gchar *action_list_str;
582 gchar *filtering_str;
584 action_list_str = filteringaction_list_to_string(prop->action_list);
586 if (action_list_str == NULL)
589 list_str = matcherlist_to_string(prop->matchers);
591 if (list_str == NULL) {
592 g_free(action_list_str);
596 filtering_str = g_strconcat(list_str, " ", action_list_str, NULL);
597 g_free(action_list_str);
600 return filtering_str;
603 void prefs_filtering_free(GSList * prefs_filtering)
605 while (prefs_filtering != NULL) {
606 FilteringProp * filtering = (FilteringProp *)
607 prefs_filtering->data;
608 filteringprop_free(filtering);
609 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
613 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
615 FolderItem *item = node->data;
617 g_return_val_if_fail(item, FALSE);
618 g_return_val_if_fail(item->prefs, FALSE);
620 prefs_filtering_free(item->prefs->processing);
621 item->prefs->processing = NULL;
626 void prefs_filtering_clear(void)
630 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
633 folder = (Folder *) cur->data;
634 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
635 prefs_filtering_free_func, NULL);
638 prefs_filtering_free(filtering_rules);
639 filtering_rules = NULL;
640 prefs_filtering_free(pre_global_processing);
641 pre_global_processing = NULL;
642 prefs_filtering_free(post_global_processing);
643 post_global_processing = NULL;
646 void prefs_filtering_clear_folder(Folder *folder)
648 g_return_if_fail(folder);
649 g_return_if_fail(folder->node);
651 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
652 prefs_filtering_free_func, NULL);
653 /* FIXME: Note folder settings were changed, where the updates? */