+/*
+ * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2007 Hiroyuki Yamamoto & The Claws Mail Team
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+#include "defs.h"
+#include <glib.h>
+#include <glib/gi18n.h>
#include <ctype.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <gtk/gtk.h>
#include <stdio.h>
-#include "intl.h"
+
#include "utils.h"
-#include "defs.h"
#include "procheader.h"
#include "matcher.h"
#include "filtering.h"
-#include "prefs.h"
+#include "prefs_gtk.h"
#include "compose.h"
+#include "prefs_common.h"
#define PREFSBUFSIZE 1024
-GSList * prefs_filtering = NULL;
+GSList * pre_global_processing = NULL;
+GSList * post_global_processing = NULL;
+GSList * filtering_rules = NULL;
+
+static gboolean filtering_is_final_action(FilteringAction *filtering_action);
+
+#define STRLEN_WITH_CHECK(expr) \
+ strlen_with_check(#expr, __LINE__, expr)
+
+static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
+{
+ if (str)
+ return strlen(str);
+ else {
+ debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
+ return 0;
+ }
+}
FilteringAction * filteringaction_new(int type, int account_id,
- gchar * destination)
+ gchar * destination,
+ gint labelcolor, gint score)
{
FilteringAction * action;
action->type = type;
action->account_id = account_id;
- if (destination)
- action->destination = g_strdup(destination);
-
+ if (destination) {
+ action->destination = g_strdup(destination);
+ } else {
+ action->destination = NULL;
+ }
+ action->labelcolor = labelcolor;
+ action->score = score;
return action;
}
void filteringaction_free(FilteringAction * action)
{
- if (action->destination)
- g_free(action->destination);
+ g_return_if_fail(action);
+ g_free(action->destination);
g_free(action);
}
-FilteringAction * filteringaction_parse(gchar ** str)
+FilteringProp * filteringprop_new(gboolean enabled,
+ const gchar *name,
+ gint account_id,
+ MatcherList * matchers,
+ GSList * action_list)
{
- FilteringAction * action;
- gchar * tmp;
- gchar * destination = NULL;
- gint account_id = 0;
- gint key;
-
- tmp = * str;
-
- key = matcher_parse_keyword(&tmp);
-
- switch (key) {
- case MATCHING_ACTION_MOVE:
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
- break;
- case MATCHING_ACTION_COPY:
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
- break;
- case MATCHING_ACTION_DELETE:
- break;
- case MATCHING_ACTION_MARK:
- break;
- case MATCHING_ACTION_MARK_AS_READ:
- break;
- case MATCHING_ACTION_UNMARK:
- break;
- case MATCHING_ACTION_MARK_AS_UNREAD:
- break;
- case MATCHING_ACTION_FORWARD:
- account_id = matcher_parse_number(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
-
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
-
- break;
- case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
- account_id = matcher_parse_number(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
-
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
+ FilteringProp * filtering;
- break;
- default:
- * str = NULL;
- return NULL;
- }
+ filtering = g_new0(FilteringProp, 1);
+ filtering->enabled = enabled;
+ filtering->name = name ? g_strdup(name): NULL;
+ filtering->account_id = account_id;
+ filtering->matchers = matchers;
+ filtering->action_list = action_list;
- * str = tmp;
- action = filteringaction_new(key, account_id, destination);
+ return filtering;
+}
- return action;
+static FilteringAction * filteringaction_copy(FilteringAction * src)
+{
+ FilteringAction * new;
+
+ new = g_new0(FilteringAction, 1);
+
+ new->type = src->type;
+ new->account_id = src->account_id;
+ if (src->destination)
+ new->destination = g_strdup(src->destination);
+ else
+ new->destination = NULL;
+ new->labelcolor = src->labelcolor;
+ new->score = src->score;
+
+ return new;
}
-FilteringProp * filteringprop_parse(gchar ** str)
+FilteringProp * filteringprop_copy(FilteringProp *src)
{
- gchar * tmp;
- gint key;
- FilteringProp * filtering;
- MatcherList * matchers;
- FilteringAction * action;
+ FilteringProp * new;
+ GSList *tmp;
- tmp = * str;
+ new = g_new0(FilteringProp, 1);
+ new->matchers = g_new0(MatcherList, 1);
- matchers = matcherlist_parse(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
-
- if (tmp == NULL) {
- matcherlist_free(matchers);
- * str = NULL;
- return NULL;
- }
-
- action = filteringaction_parse(&tmp);
- if (tmp == NULL) {
- matcherlist_free(matchers);
- * str = NULL;
- return NULL;
+ for (tmp = src->matchers->matchers; tmp != NULL && tmp->data != NULL;) {
+ MatcherProp *matcher = (MatcherProp *)tmp->data;
+
+ new->matchers->matchers = g_slist_append(new->matchers->matchers,
+ matcherprop_copy(matcher));
+ tmp = tmp->next;
}
- filtering = filteringprop_new(matchers, action);
+ new->matchers->bool_and = src->matchers->bool_and;
- * str = tmp;
- return filtering;
-}
+ new->action_list = NULL;
+ for (tmp = src->action_list ; tmp != NULL ; tmp = tmp->next) {
+ FilteringAction *filtering_action;
+
+ filtering_action = tmp->data;
+
+ new->action_list = g_slist_append(new->action_list,
+ filteringaction_copy(filtering_action));
+ }
-FilteringProp * filteringprop_new(MatcherList * matchers,
- FilteringAction * action)
-{
- FilteringProp * filtering;
-
- filtering = g_new0(FilteringProp, 1);
- filtering->matchers = matchers;
- filtering->action = action;
+ new->enabled = src->enabled;
+ new->name = g_strdup(src->name);
- return filtering;
+ return new;
}
void filteringprop_free(FilteringProp * prop)
{
+ GSList * tmp;
+
+ g_return_if_fail(prop);
matcherlist_free(prop->matchers);
- filteringaction_free(prop->action);
+
+ for (tmp = prop->action_list ; tmp != NULL ; tmp = tmp->next) {
+ filteringaction_free(tmp->data);
+ }
+ g_free(prop->name);
g_free(prop);
}
-static gboolean filteringaction_update_mark(MsgInfo * info)
+void filtering_move_and_copy_msg(MsgInfo *msginfo)
{
- gchar * dest_path;
- FILE * fp;
-
- dest_path = folder_item_get_path(info->folder);
- if (!is_dir_exist(dest_path))
- make_dir_hier(dest_path);
-
- if (dest_path == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return FALSE;
- }
+ GSList *list = g_slist_append(NULL, msginfo);
+ filtering_move_and_copy_msgs(list);
+ g_slist_free(list);
+}
- if ((fp = procmsg_open_mark_file(dest_path, TRUE))
- == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return FALSE;
+/* move and copy messages by batches to be faster on IMAP */
+void filtering_move_and_copy_msgs(GSList *msgs)
+{
+ GSList *messages = g_slist_copy(msgs);
+ FolderItem *last_item = NULL;
+ gboolean is_copy = FALSE, is_move = FALSE;
+ debug_print("checking %d messages\n", g_slist_length(msgs));
+ while (messages) {
+ GSList *batch = NULL, *cur;
+ gint found = 0;
+ for (cur = messages; cur; cur = cur->next) {
+ MsgInfo *info = (MsgInfo *)cur->data;
+ if (last_item == NULL) {
+ last_item = info->to_filter_folder;
+ }
+ if (last_item == NULL)
+ continue;
+ if (!is_copy && !is_move) {
+ if (info->is_copy)
+ is_copy = TRUE;
+ else if (info->is_move)
+ is_move = TRUE;
+ }
+ found++;
+ if (info->to_filter_folder == last_item
+ && info->is_copy == is_copy
+ && info->is_move == is_move) {
+ batch = g_slist_prepend(batch, info);
+ }
+ }
+ if (found == 0) {
+ debug_print("no more messages to move/copy\n");
+ break;
+ } else {
+ debug_print("%d messages to %s in %s\n", found,
+ is_copy ? "copy":"move", last_item->name ? last_item->name:"(noname)");
+ }
+ for (cur = batch; cur; cur = cur->next) {
+ MsgInfo *info = (MsgInfo *)cur->data;
+ messages = g_slist_remove(messages, info);
+ }
+ batch = g_slist_reverse(batch);
+ if (g_slist_length(batch)) {
+ MsgInfo *info = (MsgInfo *)batch->data;
+ if (is_copy && last_item != info->folder) {
+ folder_item_copy_msgs(last_item, batch);
+ } else if (is_move && last_item != info->folder) {
+ if (folder_item_move_msgs(last_item, batch) < 0)
+ folder_item_move_msgs(
+ folder_get_default_inbox(),
+ batch);
+ }
+ /* we don't reference the msginfos, because caller will do */
+ g_slist_free(batch);
+ batch = NULL;
+ }
+ last_item = NULL;
+ is_copy = FALSE;
+ is_move = FALSE;
}
-
- procmsg_write_flags(info, fp);
- fclose(fp);
- return TRUE;
+ /* we don't reference the msginfos, because caller will do */
+ g_slist_free(messages);
}
/*
return value : return TRUE if the action could be applied
*/
-static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
- GHashTable *folder_table)
+static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
{
FolderItem * dest_folder;
gint val;
Compose * compose;
PrefsAccount * account;
+ gchar * cmd;
switch(action->type) {
- case MATCHING_ACTION_MOVE:
- dest_folder = folder_find_item_from_path(action->destination);
- if (!dest_folder)
- return FALSE;
-
- if (folder_item_move_msg(dest_folder, info) == -1)
+ case MATCHACTION_MOVE:
+ dest_folder =
+ folder_find_item_from_identifier(action->destination);
+ if (!dest_folder) {
+ debug_print("*** folder not found '%s'\n",
+ action->destination ?action->destination :"");
return FALSE;
-
- info->flags = 0;
- filteringaction_update_mark(info);
-
- val = GPOINTER_TO_INT(g_hash_table_lookup
- (folder_table, dest_folder));
- if (val == 0) {
- folder_item_scan(dest_folder);
- g_hash_table_insert(folder_table, dest_folder,
- GINT_TO_POINTER(1));
}
- val = GPOINTER_TO_INT(g_hash_table_lookup
- (folder_table, info->folder));
- if (val == 0) {
- folder_item_scan(info->folder);
- g_hash_table_insert(folder_table, info->folder,
- GINT_TO_POINTER(1));
+
+ /* check if mail is set to copy already,
+ * in which case we have to do it */
+ if (info->is_copy && info->to_filter_folder) {
+ debug_print("should cp and mv !\n");
+ folder_item_copy_msg(info->to_filter_folder, info);
+ info->is_copy = FALSE;
}
-
+ /* mark message to be moved */
+ info->is_move = TRUE;
+ info->to_filter_folder = dest_folder;
return TRUE;
- case MATCHING_ACTION_COPY:
- dest_folder = folder_find_item_from_path(action->destination);
- if (!dest_folder)
- return FALSE;
+ case MATCHACTION_COPY:
+ dest_folder =
+ folder_find_item_from_identifier(action->destination);
- if (folder_item_copy_msg(dest_folder, info) == -1)
+ if (!dest_folder) {
+ debug_print("*** folder not found '%s'\n",
+ action->destination ?action->destination :"");
return FALSE;
-
- val = GPOINTER_TO_INT(g_hash_table_lookup
- (folder_table, dest_folder));
- if (val == 0) {
- folder_item_scan(dest_folder);
- g_hash_table_insert(folder_table, dest_folder,
- GINT_TO_POINTER(1));
}
+ /* check if mail is set to copy already,
+ * in which case we have to do it */
+ if (info->is_copy && info->to_filter_folder) {
+ debug_print("should cp and mv !\n");
+ folder_item_copy_msg(info->to_filter_folder, info);
+ info->is_copy = FALSE;
+ }
+ /* mark message to be copied */
+ info->is_copy = TRUE;
+ info->to_filter_folder = dest_folder;
return TRUE;
- case MATCHING_ACTION_DELETE:
+ case MATCHACTION_DELETE:
if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
return FALSE;
-
- info->flags = 0;
- filteringaction_update_mark(info);
-
return TRUE;
- case MATCHING_ACTION_MARK:
- MSG_SET_FLAGS(info->flags, MSG_MARKED);
- filteringaction_update_mark(info);
+ case MATCHACTION_MARK:
+ procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
+ return TRUE;
+ case MATCHACTION_UNMARK:
+ procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
return TRUE;
- case MATCHING_ACTION_UNMARK:
- MSG_UNSET_FLAGS(info->flags, MSG_MARKED);
- filteringaction_update_mark(info);
+ case MATCHACTION_LOCK:
+ procmsg_msginfo_set_flags(info, MSG_LOCKED, 0);
+ return TRUE;
+ case MATCHACTION_UNLOCK:
+ procmsg_msginfo_unset_flags(info, MSG_LOCKED, 0);
return TRUE;
- case MATCHING_ACTION_MARK_AS_READ:
- MSG_UNSET_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
- filteringaction_update_mark(info);
-
+ case MATCHACTION_MARK_AS_READ:
+ procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
return TRUE;
- case MATCHING_ACTION_MARK_AS_UNREAD:
- MSG_SET_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
- filteringaction_update_mark(info);
-
+ case MATCHACTION_MARK_AS_UNREAD:
+ procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
+ return TRUE;
+
+ case MATCHACTION_MARK_AS_SPAM:
+ procmsg_spam_learner_learn(info, NULL, TRUE);
+ procmsg_msginfo_change_flags(info, MSG_SPAM, 0, MSG_NEW|MSG_UNREAD, 0);
+ if (procmsg_spam_get_folder(info)) {
+ info->is_move = TRUE;
+ info->to_filter_folder = procmsg_spam_get_folder(info);
+ }
return TRUE;
- case MATCHING_ACTION_FORWARD:
+ case MATCHACTION_MARK_AS_HAM:
+ procmsg_spam_learner_learn(info, NULL, FALSE);
+ procmsg_msginfo_unset_flags(info, MSG_SPAM, 0);
+ return TRUE;
+
+ case MATCHACTION_COLOR:
+ procmsg_msginfo_unset_flags(info, MSG_CLABEL_FLAG_MASK, 0);
+ procmsg_msginfo_set_flags(info, MSG_COLORLABEL_TO_FLAGS(action->labelcolor), 0);
+ return TRUE;
+ case MATCHACTION_FORWARD:
+ case MATCHACTION_FORWARD_AS_ATTACHMENT:
account = account_find_from_id(action->account_id);
- compose = compose_forward(account, info, FALSE);
- if (compose->account->protocol == A_NNTP)
- compose_entry_append(compose, action->destination,
- COMPOSE_NEWSGROUPS);
- else
- compose_entry_append(compose, action->destination,
- COMPOSE_TO);
+ compose = compose_forward(account, info,
+ action->type == MATCHACTION_FORWARD ? FALSE : TRUE,
+ NULL, TRUE, TRUE);
+ compose_entry_append(compose, action->destination,
+ compose->account->protocol == A_NNTP
+ ? COMPOSE_NEWSGROUPS
+ : COMPOSE_TO);
val = compose_send(compose);
- if (val == 0) {
- gtk_widget_destroy(compose->window);
- return TRUE;
- }
- gtk_widget_destroy(compose->window);
- return FALSE;
-
- case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
+ return val == 0 ? TRUE : FALSE;
+ case MATCHACTION_REDIRECT:
account = account_find_from_id(action->account_id);
- compose = compose_forward(account, info, TRUE);
+ compose = compose_redirect(account, info, TRUE);
if (compose->account->protocol == A_NNTP)
- compose_entry_append(compose, action->destination,
- COMPOSE_NEWSGROUPS);
+ break;
else
compose_entry_append(compose, action->destination,
COMPOSE_TO);
val = compose_send(compose);
- if (val == 0) {
- gtk_widget_destroy(compose->window);
- return TRUE;
+
+ return val == 0 ? TRUE : FALSE;
+
+ case MATCHACTION_EXECUTE:
+ cmd = matching_build_command(action->destination, info);
+ if (cmd == NULL)
+ return FALSE;
+ else {
+ system(cmd);
+ g_free(cmd);
}
+ return TRUE;
- gtk_widget_destroy(compose->window);
- return FALSE;
+ case MATCHACTION_SET_SCORE:
+ info->score = action->score;
+ return TRUE;
+
+ case MATCHACTION_CHANGE_SCORE:
+ info->score += action->score;
+ return TRUE;
+
+ case MATCHACTION_STOP:
+ return FALSE;
+
+ case MATCHACTION_HIDE:
+ info->hidden = TRUE;
+ return TRUE;
+
+ case MATCHACTION_IGNORE:
+ procmsg_msginfo_set_flags(info, MSG_IGNORE_THREAD, 0);
+ return TRUE;
default:
- return FALSE;
+ break;
}
+ return FALSE;
}
-/*
- filteringprop_apply
- runs the action on one MsgInfo if it matches the criterium
- return value : return TRUE if the action doesn't allow more actions
-*/
-
-static gboolean filteringprop_apply(FilteringProp * filtering, MsgInfo * info,
- GHashTable *folder_table)
+gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
{
- if (matcherlist_match(filtering->matchers, info)) {
- gint result;
- gchar * action_str;
-
- result = TRUE;
-
- result = filteringaction_apply(filtering->action, info,
- folder_table);
- action_str =
- filteringaction_to_string(filtering->action);
- if (!result) {
- g_warning(_("action %s could not be applied"),
- action_str);
- }
- else {
- debug_print(_("message %i %s..."),
- info->msgnum, action_str);
- }
-
- g_free(action_str);
-
- switch(filtering->action->type) {
- case MATCHING_ACTION_MOVE:
- case MATCHING_ACTION_DELETE:
- return TRUE;
- case MATCHING_ACTION_COPY:
- case MATCHING_ACTION_MARK:
- case MATCHING_ACTION_MARK_AS_READ:
- case MATCHING_ACTION_UNMARK:
- case MATCHING_ACTION_MARK_AS_UNREAD:
- case MATCHING_ACTION_FORWARD:
- case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
+ GSList *p;
+ g_return_val_if_fail(action_list, FALSE);
+ g_return_val_if_fail(info, FALSE);
+ for (p = action_list; p && p->data; p = g_slist_next(p)) {
+ FilteringAction *a = (FilteringAction *) p->data;
+ if (filteringaction_apply(a, info)) {
+ if (filtering_is_final_action(a))
+ break;
+ } else
return FALSE;
- default:
- return FALSE;
- }
+
}
- else
- return FALSE;
+ return TRUE;
}
-void filter_msginfo(GSList * filtering_list, MsgInfo * info,
- GHashTable *folder_table)
+static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info,
+ PrefsAccount *ac_prefs)
{
- GSList * l;
-
- if (info == NULL) {
- g_warning(_("msginfo is not set"));
- return;
- }
-
- for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
- FilteringProp * filtering = (FilteringProp *) l->data;
-
- if (filteringprop_apply(filtering, info, folder_table))
+ gboolean matches = FALSE;
+
+ if (ac_prefs != NULL) {
+ matches = ((filtering->account_id == 0)
+ || (filtering->account_id == ac_prefs->account_id));
+ } else {
+ switch (prefs_common.apply_per_account_filtering_rules) {
+ case FILTERING_ACCOUNT_RULES_FORCE:
+ /* apply filtering rules regardless to the account info */
+ matches = TRUE;
+ break;
+ case FILTERING_ACCOUNT_RULES_SKIP:
+ /* don't apply filtering rules that belong to an account */
+ matches = (filtering->account_id == 0);
break;
+ case FILTERING_ACCOUNT_RULES_USE_CURRENT:
+ matches = ((filtering->account_id == 0)
+ || (filtering->account_id == cur_account->account_id));
+ break;
+ }
}
+
+ return matches && matcherlist_match(filtering->matchers, info);
}
-void filter_message(GSList * filtering_list, FolderItem * item,
- gint msgnum, GHashTable *folder_table)
+/*!
+ *\brief Apply a rule on message.
+ *
+ *\param filtering List of filtering rules.
+ *\param info Message to apply rules on.
+ *\param final Variable returning TRUE or FALSE if one of the
+ * encountered actions was final.
+ * See also \ref filtering_is_final_action.
+ *
+ *\return gboolean TRUE to continue applying rules.
+ */
+static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
+ gboolean * final)
{
- MsgInfo * msginfo;
- gchar * filename;
+ gboolean result = TRUE;
+ gchar buf[256];
+ GSList * tmp;
+
+ * final = FALSE;
+ for (tmp = filtering->action_list ; tmp != NULL ; tmp = tmp->next) {
+ FilteringAction * action;
+
+ action = tmp->data;
+
+ if (FALSE == (result = filteringaction_apply(action, info))) {
+ g_warning("No further processing after rule %s\n",
+ filteringaction_to_string(buf, sizeof buf, action));
+ }
+
+ if (filtering_is_final_action(action)) {
+ * final = TRUE;
+ break;
+ }
+ }
+ return result;
+}
- if (item == NULL) {
- g_warning(_("folderitem not set"));
- return;
+/*!
+ *\brief Check if an action is "final", i.e. should break further
+ * processing.
+ *
+ *\param filtering_action Action to check.
+ *
+ *\return gboolean TRUE if \a filtering_action is final.
+ */
+static gboolean filtering_is_final_action(FilteringAction *filtering_action)
+{
+ switch(filtering_action->type) {
+ case MATCHACTION_MOVE:
+ case MATCHACTION_DELETE:
+ case MATCHACTION_STOP:
+ case MATCHACTION_MARK_AS_SPAM:
+ return TRUE; /* MsgInfo invalid for message */
+ default:
+ return FALSE;
}
+}
- filename = folder_item_fetch_msg(item, msgnum);
+static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info, PrefsAccount* ac_prefs)
+{
+ GSList *l;
+ gboolean final;
+ gboolean apply_next;
+
+ g_return_val_if_fail(info != NULL, TRUE);
+
+ for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
+ FilteringProp * filtering = (FilteringProp *) l->data;
- if (filename == NULL) {
- g_warning(_("filename is not set"));
- return;
+ if (filtering->enabled && filtering_match_condition(filtering, info, ac_prefs)) {
+ apply_next = filtering_apply_rule(filtering, info, &final);
+ if (final)
+ break;
+ }
}
- msginfo = procheader_parse(filename, 0, TRUE);
-
- g_free(filename);
-
- if (msginfo == NULL) {
- g_warning(_("could not get info for %s"), filename);
- return;
+ /* put in inbox if a final rule could not be applied, or
+ * the last rule was not a final one. */
+ if ((final && !apply_next) || !final) {
+ return FALSE;
}
- msginfo->folder = item;
- msginfo->msgnum = msgnum;
-
- filter_msginfo(filtering_list, msginfo, folder_table);
+ return TRUE;
}
-void prefs_filtering_read_config(void)
+/*!
+ *\brief Filter a message against a list of rules.
+ *
+ *\param flist List of filter rules.
+ *\param info Message.
+ *
+ *\return gboolean TRUE if filter rules handled the message.
+ *
+ *\note Returning FALSE means the message was not handled,
+ * and that the calling code should do the default
+ * processing. E.g. \ref inc.c::inc_start moves the
+ * message to the inbox.
+ */
+gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info, PrefsAccount* ac_prefs)
{
- gchar *rcpath;
- FILE *fp;
- gchar buf[PREFSBUFSIZE];
-
- debug_print(_("Reading filtering configuration...\n"));
-
- rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
- FILTERING_RC, NULL);
- if ((fp = fopen(rcpath, "r")) == NULL) {
- if (ENOENT != errno) FILE_OP_ERROR(rcpath, "fopen");
- g_free(rcpath);
- prefs_filtering = NULL;
- return;
- }
- g_free(rcpath);
-
- /* remove all filtering */
- while (prefs_filtering != NULL) {
- FilteringProp * filtering =
- (FilteringProp *) prefs_filtering->data;
- filteringprop_free(filtering);
- prefs_filtering = g_slist_remove(prefs_filtering, filtering);
- }
-
- while (fgets(buf, sizeof(buf), fp) != NULL) {
- FilteringProp * filtering;
- gchar * tmp;
-
- g_strchomp(buf);
-
- if ((*buf != '#') && (*buf != '\0')) {
- tmp = buf;
- filtering = filteringprop_parse(&tmp);
- if (tmp != NULL) {
- prefs_filtering =
- g_slist_append(prefs_filtering,
- filtering);
- }
- else {
- /* debug */
- g_warning(_("syntax error : %s\n"), buf);
- }
- }
- }
-
- fclose(fp);
+ return filter_msginfo(flist, info, ac_prefs);
}
-gchar * filteringaction_to_string(FilteringAction * action)
+gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
- gchar * command_str;
- gint i;
- gchar * account_id_str;
-
- command_str = NULL;
+ const gchar *command_str;
+ gchar * quoted_dest;
+
command_str = get_matchparser_tab_str(action->type);
if (command_str == NULL)
return NULL;
switch(action->type) {
- case MATCHING_ACTION_MOVE:
- case MATCHING_ACTION_COPY:
- return g_strconcat(command_str, " \"", action->destination,
- "\"", NULL);
-
- case MATCHING_ACTION_DELETE:
- case MATCHING_ACTION_MARK:
- case MATCHING_ACTION_UNMARK:
- case MATCHING_ACTION_MARK_AS_READ:
- case MATCHING_ACTION_MARK_AS_UNREAD:
- return g_strdup(command_str);
- break;
-
- case MATCHING_ACTION_FORWARD:
- case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
- account_id_str = itos(action->account_id);
- return g_strconcat(command_str, " ", account_id_str,
- " \"", action->destination, "\"", NULL);
+ case MATCHACTION_MOVE:
+ case MATCHACTION_COPY:
+ case MATCHACTION_EXECUTE:
+ quoted_dest = matcher_quote_str(action->destination);
+ g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
+ g_free(quoted_dest);
+ return dest;
+
+ case MATCHACTION_DELETE:
+ case MATCHACTION_MARK:
+ case MATCHACTION_UNMARK:
+ case MATCHACTION_LOCK:
+ case MATCHACTION_UNLOCK:
+ case MATCHACTION_MARK_AS_READ:
+ case MATCHACTION_MARK_AS_UNREAD:
+ case MATCHACTION_MARK_AS_SPAM:
+ case MATCHACTION_MARK_AS_HAM:
+ case MATCHACTION_STOP:
+ case MATCHACTION_HIDE:
+ case MATCHACTION_IGNORE:
+ g_snprintf(dest, destlen, "%s", command_str);
+ return dest;
+
+ case MATCHACTION_REDIRECT:
+ case MATCHACTION_FORWARD:
+ case MATCHACTION_FORWARD_AS_ATTACHMENT:
+ quoted_dest = matcher_quote_str(action->destination);
+ g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, quoted_dest);
+ g_free(quoted_dest);
+ return dest;
+
+ case MATCHACTION_COLOR:
+ g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
+ return dest;
+
+ case MATCHACTION_CHANGE_SCORE:
+ case MATCHACTION_SET_SCORE:
+ g_snprintf(dest, destlen, "%s %d", command_str, action->score);
+ return dest;
default:
return NULL;
}
}
+gchar * filteringaction_list_to_string(GSList * action_list)
+{
+ gchar *action_list_str;
+ gchar buf[256];
+ GSList * tmp;
+ gchar *list_str;
+
+ action_list_str = NULL;
+ for (tmp = action_list ; tmp != NULL ; tmp = tmp->next) {
+ gchar *action_str;
+ FilteringAction * action;
+
+ action = tmp->data;
+
+ action_str = filteringaction_to_string(buf,
+ sizeof buf, action);
+
+ if (action_list_str != NULL) {
+ list_str = g_strconcat(action_list_str, " ", action_str, NULL);
+ g_free(action_list_str);
+ }
+ else {
+ list_str = g_strdup(action_str);
+ }
+ action_list_str = list_str;
+ }
+
+ return action_list_str;
+}
+
gchar * filteringprop_to_string(FilteringProp * prop)
{
- gchar * list_str;
- gchar * action_str;
- gchar * filtering_str;
+ gchar *list_str;
+ gchar *action_list_str;
+ gchar *filtering_str;
- action_str = filteringaction_to_string(prop->action);
+ action_list_str = filteringaction_list_to_string(prop->action_list);
- if (action_str == NULL)
+ if (action_list_str == NULL)
return NULL;
list_str = matcherlist_to_string(prop->matchers);
if (list_str == NULL) {
- g_free(action_str);
+ g_free(action_list_str);
return NULL;
- }
+ }
- filtering_str = g_strconcat(list_str, " ", action_str, NULL);
+ filtering_str = g_strconcat(list_str, " ", action_list_str, NULL);
+ g_free(action_list_str);
g_free(list_str);
- g_free(action_str);
return filtering_str;
}
-void prefs_filtering_write_config(void)
+void prefs_filtering_free(GSList * prefs_filtering)
{
- gchar *rcpath;
- PrefFile *pfile;
- GSList *cur;
- FilteringProp * prop;
+ while (prefs_filtering != NULL) {
+ FilteringProp * filtering = (FilteringProp *)
+ prefs_filtering->data;
+ filteringprop_free(filtering);
+ prefs_filtering = g_slist_remove(prefs_filtering, filtering);
+ }
+}
- debug_print(_("Writing filtering configuration...\n"));
+static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
+{
+ FolderItem *item = node->data;
- rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, FILTERING_RC, NULL);
+ g_return_val_if_fail(item, FALSE);
+ g_return_val_if_fail(item->prefs, FALSE);
- if ((pfile = prefs_write_open(rcpath)) == NULL) {
- g_warning(_("failed to write configuration to file\n"));
- g_free(rcpath);
- return;
- }
+ prefs_filtering_free(item->prefs->processing);
+ item->prefs->processing = NULL;
- for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
- gchar *filtering_str;
-
- prop = (FilteringProp *) cur->data;
- filtering_str = filteringprop_to_string(prop);
- if (fputs(filtering_str, pfile->fp) == EOF ||
- fputc('\n', pfile->fp) == EOF) {
- FILE_OP_ERROR(rcpath, "fputs || fputc");
- prefs_write_close_revert(pfile);
- g_free(rcpath);
- g_free(filtering_str);
- return;
- }
- g_free(filtering_str);
+ return FALSE;
+}
+
+void prefs_filtering_clear(void)
+{
+ GList * cur;
+
+ for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
+ Folder *folder;
+
+ folder = (Folder *) cur->data;
+ g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
+ prefs_filtering_free_func, NULL);
}
- g_free(rcpath);
+ prefs_filtering_free(filtering_rules);
+ filtering_rules = NULL;
+ prefs_filtering_free(pre_global_processing);
+ pre_global_processing = NULL;
+ prefs_filtering_free(post_global_processing);
+ post_global_processing = NULL;
+}
+
+void prefs_filtering_clear_folder(Folder *folder)
+{
+ g_return_if_fail(folder);
+ g_return_if_fail(folder->node);
+
+ g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
+ prefs_filtering_free_func, NULL);
+ /* FIXME: Note folder settings were changed, where the updates? */
+}
- if (prefs_write_close(pfile) < 0) {
- g_warning(_("failed to write configuration to file\n"));
- return;
+gboolean filtering_peek_per_account_rules(GSList *filtering_list)
+/* return TRUE if there's at least one per-account filtering rule */
+{
+ GSList *l;
+
+ for (l = filtering_list; l != NULL; l = g_slist_next(l)) {
+ FilteringProp * filtering = (FilteringProp *) l->data;
+
+ if (filtering->enabled && (filtering->account_id != 0)) {
+ return TRUE;
+ }
}
+
+ return FALSE;
}