/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 Hiroyuki Yamamoto & The Sylpheed Claws Team
+ * 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
+ * the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* 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.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
*/
#include "defs.h"
#include "filtering.h"
#include "prefs_gtk.h"
#include "compose.h"
+#include "prefs_common.h"
+#include "addrbook.h"
+#include "addr_compl.h"
+#include "tags.h"
+#include "log.h"
#define PREFSBUFSIZE 1024
GSList * post_global_processing = NULL;
GSList * filtering_rules = NULL;
+gboolean debug_filtering_session = FALSE;
+
static gboolean filtering_is_final_action(FilteringAction *filtering_action);
#define STRLEN_WITH_CHECK(expr) \
if (str)
return strlen(str);
else {
- debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
+ debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr?expr:"(null)");
return 0;
}
}
FilteringAction * filteringaction_new(int type, int account_id,
gchar * destination,
- gint labelcolor, gint score)
+ gint labelcolor, gint score, gchar * header)
{
FilteringAction * action;
} else {
action->destination = NULL;
}
+ if (header) {
+ action->header = g_strdup(header);
+ } else {
+ action->header = NULL;
+ }
action->labelcolor = labelcolor;
action->score = score;
return action;
void filteringaction_free(FilteringAction * action)
{
g_return_if_fail(action);
+ g_free(action->header);
g_free(action->destination);
g_free(action);
}
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;
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;
batch);
}
/* we don't reference the msginfos, because caller will do */
+ if (prefs_common.real_time_sync)
+ folder_item_synchronise(last_item);
g_slist_free(batch);
batch = NULL;
+ GTK_EVENTS_FLUSH();
}
last_item = NULL;
is_copy = FALSE;
folder_find_item_from_identifier(action->destination);
if (!dest_folder) {
debug_print("*** folder not found '%s'\n",
- action->destination ?action->destination :"");
+ action->destination ?action->destination :"(null)");
return FALSE;
}
if (!dest_folder) {
debug_print("*** folder not found '%s'\n",
- action->destination ?action->destination :"");
+ action->destination ?action->destination :"(null)");
return FALSE;
}
info->to_filter_folder = dest_folder;
return TRUE;
+ case MATCHACTION_SET_TAG:
+ case MATCHACTION_UNSET_TAG:
+ val = tags_get_id_for_str(action->destination);
+ if (val == -1) {
+ debug_print("*** tag '%s' not found\n",
+ action->destination ?action->destination :"(null)");
+ return FALSE;
+ }
+
+ procmsg_msginfo_update_tags(info, (action->type == MATCHACTION_SET_TAG), val);
+ return TRUE;
+
+ case MATCHACTION_CLEAR_TAGS:
+ procmsg_msginfo_clear_tags(info);
+ return TRUE;
+
case MATCHACTION_DELETE:
if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
return FALSE;
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 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);
procmsg_msginfo_set_flags(info, MSG_IGNORE_THREAD, 0);
return TRUE;
+ case MATCHACTION_WATCH:
+ procmsg_msginfo_set_flags(info, MSG_WATCH_THREAD, 0);
+ return TRUE;
+
+ case MATCHACTION_ADD_TO_ADDRESSBOOK:
+ {
+ AddressDataSource *book = NULL;
+ AddressBookFile *abf = NULL;
+ ItemFolder *folder = NULL;
+ gchar buf[BUFFSIZE];
+ Header *header;
+ gint errors = 0;
+
+ if (!addressbook_peek_folder_exists(action->destination, &book, &folder)) {
+ g_warning("addressbook folder not found '%s'\n", action->destination);
+ return FALSE;
+ }
+ if (!book) {
+ g_warning("addressbook_peek_folder_exists returned NULL book\n");
+ return FALSE;
+ }
+
+ abf = book->rawDataSource;
+
+ /* get the header */
+ procheader_get_header_from_msginfo(info, buf, sizeof(buf), action->header);
+ header = procheader_parse_header(buf);
+
+ /* add all addresses that are not already in */
+ if (header && *header->body && (*header->body != '\0')) {
+ GSList *address_list = NULL;
+ GSList *walk = NULL;
+ gchar *path = NULL;
+
+ if (action->destination == NULL ||
+ strcasecmp(action->destination, _("Any")) == 0 ||
+ *(action->destination) == '\0')
+ path = NULL;
+ else
+ path = action->destination;
+ start_address_completion(path);
+
+ address_list = address_list_append(address_list, header->body);
+ for (walk = address_list; walk != NULL; walk = walk->next) {
+ gchar *stripped_addr = g_strdup(walk->data);
+ extract_address(stripped_addr);
+
+ if (complete_matches_found(walk->data) == 0) {
+ debug_print("adding address '%s' to addressbook '%s'\n",
+ stripped_addr, action->destination);
+ if (!addrbook_add_contact(abf, folder, stripped_addr, stripped_addr, NULL)) {
+ g_warning("contact could not been added\n");
+ errors++;
+ }
+ } else {
+ debug_print("address '%s' already found in addressbook '%s', skipping\n",
+ stripped_addr, action->destination);
+ }
+ g_free(stripped_addr);
+ }
+
+ g_slist_free(address_list);
+ end_address_completion();
+ } else {
+ g_warning("header '%s' not set or empty\n", action->header);
+ }
+ return (errors == 0);
+ }
+
default:
break;
}
static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info,
PrefsAccount *ac_prefs)
+
+/* this function returns true if a filtering rule applies regarding to its account
+ data and if it does, if the conditions list match.
+
+ per-account data of a filtering rule is either matched against current account
+ when filtering is done manually, or against the account currently used for
+ retrieving messages when it's an manual or automatic fetching of messages.
+ per-account data match doesn't apply to pre-/post-/folder-processing rules.
+
+ when filtering messages manually:
+ - either the filtering rule is not account-based and it will be processed
+ - or it's per-account and we check if we HAVE TO match it against the current
+ account (according to user-land settings, per-account rules might have to
+ be skipped, or only the rules that match the current account have to be
+ applied, or all rules will have to be applied regardless to if they are
+ account-based or not)
+
+ notes about debugging output in that function:
+ when not matching, log_status_skip() is used, otherwise log_status_ok() is used
+ no debug output is done when filtering_debug_level is low
+*/
{
gboolean matches = FALSE;
- if (ac_prefs != NULL)
+ if (ac_prefs != NULL) {
matches = ((filtering->account_id == 0)
|| (filtering->account_id == ac_prefs->account_id));
- else
- matches = TRUE;
+
+ /* debug output */
+ if (debug_filtering_session) {
+ if (matches && prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ if (filtering->account_id == 0) {
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is not account-based\n"));
+ } else {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_MED) {
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "matching the account currently used to retrieve messages\n"),
+ ac_prefs->account_id, ac_prefs->account_name);
+ }
+ }
+ }
+ else
+ if (!matches) {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_MED) {
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based, "
+ "not matching the account currently used to retrieve messages\n"));
+ } else {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ PrefsAccount *account = account_find_from_id(filtering->account_id);
+
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "not matching the account currently used to retrieve messages [id=%d, name='%s']\n"),
+ filtering->account_id, account->account_name,
+ ac_prefs->account_id, ac_prefs->account_name);
+ }
+ }
+ }
+ }
+ } else {
+ switch (prefs_common.apply_per_account_filtering_rules) {
+ case FILTERING_ACCOUNT_RULES_FORCE:
+ /* apply filtering rules regardless to the account info */
+ matches = TRUE;
+
+ /* debug output */
+ if (debug_filtering_session) {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ if (filtering->account_id == 0) {
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is not account-based, "
+ "all rules are applied on user request anyway\n"));
+ } else {
+ PrefsAccount *account = account_find_from_id(filtering->account_id);
+
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "but all rules are applied on user request\n"),
+ filtering->account_id, account->account_name);
+ }
+ }
+ }
+ break;
+ case FILTERING_ACCOUNT_RULES_SKIP:
+ /* don't apply filtering rules that belong to an account */
+ matches = (filtering->account_id == 0);
+
+ /* debug output */
+ if (debug_filtering_session) {
+ if (!matches) {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ PrefsAccount *account = account_find_from_id(filtering->account_id);
+
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "skipped on user request\n"),
+ filtering->account_id, account->account_name);
+ } else {
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based, "
+ "skipped on user request\n"));
+ }
+ } else {
+ if (matches && prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is not account-based\n"));
+ }
+ }
+ }
+ break;
+ case FILTERING_ACCOUNT_RULES_USE_CURRENT:
+ matches = ((filtering->account_id == 0)
+ || (filtering->account_id == cur_account->account_id));
+
+ /* debug output */
+ if (debug_filtering_session) {
+ if (!matches) {
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ PrefsAccount *account = account_find_from_id(filtering->account_id);
+
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "not matching current account [id=%d, name='%s']\n"),
+ filtering->account_id, account->account_name,
+ cur_account->account_id, cur_account->account_name);
+ } else {
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("rule is account-based, "
+ "not matching current account\n"));
+ }
+ } else {
+ if (matches && prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_HIGH) {
+ if (filtering->account_id == 0) {
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is not account-based\n"));
+ } else {
+ PrefsAccount *account = account_find_from_id(filtering->account_id);
+
+ log_status_ok(LOG_DEBUG_FILTERING,
+ _("rule is account-based [id=%d, name='%s'], "
+ "current account [id=%d, name='%s']\n"),
+ account->account_id, account->account_name,
+ cur_account->account_id, cur_account->account_name);
+ }
+ }
+ }
+ }
+ break;
+ }
+ }
return matches && matcherlist_match(filtering->matchers, info);
}
gboolean * final)
{
gboolean result = TRUE;
- gchar buf[50];
+ gchar buf[256];
GSList * tmp;
* final = FALSE;
for (tmp = filtering->action_list ; tmp != NULL ; tmp = tmp->next) {
FilteringAction * action;
-
+
action = tmp->data;
-
+ filteringaction_to_string(buf, sizeof buf, action);
+ if (debug_filtering_session)
+ log_print(LOG_DEBUG_FILTERING, _("applying action [ %s ]\n"), buf);
+
if (FALSE == (result = filteringaction_apply(action, info))) {
- g_warning("No further processing after rule %s\n",
- filteringaction_to_string(buf, sizeof buf, action));
+ if (debug_filtering_session) {
+ if (action->type != MATCHACTION_STOP)
+ log_warning(LOG_DEBUG_FILTERING, _("action could not apply\n"));
+ log_print(LOG_DEBUG_FILTERING,
+ _("no further processing after action [ %s ]\n"), buf);
+ } else
+ g_warning("No further processing after rule %s\n", buf);
}
if (filtering_is_final_action(action)) {
case MATCHACTION_MOVE:
case MATCHACTION_DELETE:
case MATCHACTION_STOP:
+ case MATCHACTION_MARK_AS_SPAM:
return TRUE; /* MsgInfo invalid for message */
default:
return FALSE;
for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
FilteringProp * filtering = (FilteringProp *) l->data;
- if (filtering->enabled && filtering_match_condition(filtering, info, ac_prefs)) {
- apply_next = filtering_apply_rule(filtering, info, &final);
- if (final)
- break;
- }
+ if (filtering->enabled) {
+ if (debug_filtering_session) {
+ gchar *buf = filteringprop_to_string(filtering);
+ if (filtering->name && *filtering->name != '\0') {
+ log_print(LOG_DEBUG_FILTERING,
+ _("processing rule '%s' [ %s ]\n"),
+ filtering->name, buf);
+ } else {
+ log_print(LOG_DEBUG_FILTERING,
+ _("processing rule <unnamed> [ %s ]\n"),
+ buf);
+ }
+ }
+
+ if (filtering_match_condition(filtering, info, ac_prefs)) {
+ apply_next = filtering_apply_rule(filtering, info, &final);
+ if (final)
+ break;
+ }
+
+ } else {
+ if (debug_filtering_session) {
+ gchar *buf = filteringprop_to_string(filtering);
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_MED) {
+ if (filtering->name && *filtering->name != '\0') {
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("disabled rule '%s' [ %s ]\n"),
+ filtering->name, buf);
+ } else {
+ log_status_skip(LOG_DEBUG_FILTERING,
+ _("disabled rule <unnamed> [ %s ]\n"),
+ buf);
+ }
+ }
+ g_free(buf);
+ }
+ }
}
/* put in inbox if a final rule could not be applied, or
* 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)
+gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info, PrefsAccount* ac_prefs,
+ FilteringInvocationType context, gchar *extra_info)
{
- return filter_msginfo(flist, info, ac_prefs);
+ gboolean ret;
+
+ if (prefs_common.enable_filtering_debug) {
+ gchar *tmp = _("undetermined");
+
+ switch (context) {
+ case FILTERING_INCORPORATION:
+ tmp = _("incorporation");
+ debug_filtering_session = prefs_common.enable_filtering_debug_inc;
+ break;
+ case FILTERING_MANUALLY:
+ tmp = _("manually");
+ debug_filtering_session = prefs_common.enable_filtering_debug_manual;
+ break;
+ case FILTERING_FOLDER_PROCESSING:
+ tmp = _("folder processing");
+ debug_filtering_session = prefs_common.enable_filtering_debug_folder_proc;
+ break;
+ case FILTERING_PRE_PROCESSING:
+ tmp = _("pre-processing");
+ debug_filtering_session = prefs_common.enable_filtering_debug_pre_proc;
+ break;
+ case FILTERING_POST_PROCESSING:
+ tmp = _("post-processing");
+ debug_filtering_session = prefs_common.enable_filtering_debug_post_proc;
+ break;
+ default:
+ debug_filtering_session = FALSE;
+ break;
+ }
+ if (debug_filtering_session) {
+ gchar *file = procmsg_get_message_file_path(info);
+ gchar *spc = g_strnfill(LOG_TIME_LEN + 1, ' ');
+
+ /* show context info and essential info about the message */
+ if (prefs_common.filtering_debug_level >= FILTERING_DEBUG_LEVEL_MED) {
+ log_print(LOG_DEBUG_FILTERING,
+ _("filtering message (%s%s%s)\n"
+ "%smessage file: %s\n%s%s %s\n%s%s %s\n%s%s %s\n%s%s %s\n"),
+ tmp, extra_info ? _(": ") : "", extra_info ? extra_info : "",
+ spc, file, spc, prefs_common_translated_header_name("Date:"), info->date,
+ spc, prefs_common_translated_header_name("From:"), info->from,
+ spc, prefs_common_translated_header_name("To:"), info->to,
+ spc, prefs_common_translated_header_name("Subject:"), info->subject);
+ } else {
+ log_print(LOG_DEBUG_FILTERING,
+ _("filtering message (%s%s%s)\n"
+ "%smessage file: %s\n"),
+ tmp, extra_info ? _(": ") : "", extra_info ? extra_info : "",
+ spc, file);
+ }
+ g_free(file);
+ g_free(spc);
+ }
+ } else
+ debug_filtering_session = FALSE;
+
+ ret = filter_msginfo(flist, info, ac_prefs);
+ debug_filtering_session = FALSE;
+ return ret;
}
gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
const gchar *command_str;
gchar * quoted_dest;
+ gchar * quoted_header;
command_str = get_matchparser_tab_str(action->type);
case MATCHACTION_MOVE:
case MATCHACTION_COPY:
case MATCHACTION_EXECUTE:
+ case MATCHACTION_SET_TAG:
+ case MATCHACTION_UNSET_TAG:
quoted_dest = matcher_quote_str(action->destination);
g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
g_free(quoted_dest);
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:
+ case MATCHACTION_WATCH:
+ case MATCHACTION_CLEAR_TAGS:
g_snprintf(dest, destlen, "%s", command_str);
return dest;
g_snprintf(dest, destlen, "%s %d", command_str, action->score);
return dest;
+ case MATCHACTION_ADD_TO_ADDRESSBOOK:
+ quoted_header = matcher_quote_str(action->header);
+ quoted_dest = matcher_quote_str(action->destination);
+ g_snprintf(dest, destlen, "%s \"%s\" \"%s\"", command_str, quoted_header, quoted_dest);
+ g_free(quoted_dest);
+ g_free(quoted_header);
+ return dest;
+
default:
return NULL;
}
/* FIXME: Note folder settings were changed, where the updates? */
}
+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;
+}
projects / claws.git / blobdiff