/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2001 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- */
-
-/*
- * initital Hoa initial
- * 07/16/01 Alfons fix bugs
- * 07/18/01 Alfons rewrite things
- */
-
-/* 07/18/01 (alfons)
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*
- * filter_message() is no longer the entry point for filtering. it's
- * replaced with filter_incoming_message() which does not trust
- * on MsgInfo's from a folder. instead it directly works with
- * the temporary file.
- * updating the mark file is a lot easier now, because we can do that
- * right after a call to folder_item_add_msg().
- */
+ */
#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 "procheader.h"
#include "matcher.h"
#include "filtering.h"
-#include "prefs.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"
+
+GSList * pre_global_processing = NULL;
+GSList * post_global_processing = NULL;
+GSList * filtering_rules = NULL;
-#define PREFSBUFSIZE 1024
+gboolean debug_filtering_session = FALSE;
-GSList * global_processing = 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?expr:"(null)");
+ return 0;
+ }
+}
FilteringAction * filteringaction_new(int type, int account_id,
gchar * destination,
- gint labelcolor)
+ gint labelcolor, gint score, gchar * header)
{
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;
+ }
+ if (header) {
+ action->header = g_strdup(header);
+ } else {
+ action->header = 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->header);
+ 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;
- gint labelcolor = 0;
-
- tmp = * str;
-
- key = matcher_parse_keyword(&tmp);
-
- switch (key) {
- case MATCHACTION_MOVE:
- case MATCHACTION_COPY:
- case MATCHACTION_EXECUTE:
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
- break;
- case MATCHACTION_DELETE:
- break;
- case MATCHACTION_MARK:
- break;
- case MATCHACTION_MARK_AS_READ:
- break;
- case MATCHACTION_UNMARK:
- break;
- case MATCHACTION_MARK_AS_UNREAD:
- break;
- case MATCHACTION_FORWARD:
- case MATCHACTION_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;
- }
-
- break;
- case MATCHACTION_COLOR:
- labelcolor = matcher_parse_number(&tmp);
- if (tmp == NULL) {
- *str = NULL;
- return NULL;
- }
-
- break;
- default:
- * str = NULL;
- return NULL;
- }
+ FilteringProp * filtering;
- * str = tmp;
+ 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;
- action = filteringaction_new(key, account_id, destination, labelcolor);
+ 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;
+ 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;
}
- if (tmp == NULL) {
- matcherlist_free(matchers);
- * str = NULL;
- return NULL;
- }
+ new->matchers->bool_and = src->matchers->bool_and;
- action = filteringaction_parse(&tmp);
- if (tmp == NULL) {
- matcherlist_free(matchers);
- * str = NULL;
- return NULL;
- }
+ new->action_list = NULL;
- filtering = filteringprop_new(matchers, action);
+ 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));
+ }
- * str = tmp;
- return filtering;
-}
-*/
-
-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_slist_free(prop->action_list);
+ g_free(prop->name);
g_free(prop);
}
-/* filteringaction_update_mark() - updates a mark for a message. note that
- * the message should not have been moved or copied. remember that the
- * procmsg_open_mark_file(PATH, TRUE) actually _appends_ a new record.
- */
-static gboolean filteringaction_update_mark(MsgInfo * info)
+/* move and copy messages by batches to be faster on IMAP */
+void filtering_move_and_copy_msgs(GSList *msgs)
{
- gchar * dest_path;
- FILE * fp;
-
- if (info->folder->folder->type == F_MH) {
- 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;
- }
-
- if ((fp = procmsg_open_mark_file(dest_path, TRUE))
- == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return FALSE;
- }
-
- procmsg_write_flags(info, fp);
- fclose(fp);
- return TRUE;
- }
- return FALSE;
-}
-
-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;
- }
-}
-
-#define STRLEN_WITH_CHECK(expr) \
- strlen_with_check(#expr, __LINE__, expr)
-
-static gchar * filteringaction_execute_command(gchar * cmd, MsgInfo * info)
-{
- gchar * s = cmd;
- gchar * filename = NULL;
- gchar * processed_cmd;
- gchar * p;
- gint size;
-
- matcher_unescape_str(cmd);
-
- size = strlen(cmd) + 1;
- while (*s != '\0') {
- if (*s == '%') {
- s++;
- switch (*s) {
- case '%':
- size -= 1;
- break;
- case 's': /* subject */
- size += STRLEN_WITH_CHECK(info->subject) - 2;
- break;
- case 'f': /* from */
- size += STRLEN_WITH_CHECK(info->from) - 2;
- break;
- case 't': /* to */
- size += STRLEN_WITH_CHECK(info->to) - 2;
- break;
- case 'c': /* cc */
- size += STRLEN_WITH_CHECK(info->cc) - 2;
- break;
- case 'd': /* date */
- size += STRLEN_WITH_CHECK(info->date) - 2;
- break;
- case 'i': /* message-id */
- size += STRLEN_WITH_CHECK(info->msgid) - 2;
- break;
- case 'n': /* newsgroups */
- size += STRLEN_WITH_CHECK(info->newsgroups) - 2;
- break;
- case 'r': /* references */
- size += STRLEN_WITH_CHECK(info->references) - 2;
- break;
- case 'F': /* file */
- if (MSG_IS_FILTERING(info->flags))
- filename = g_strdup((gchar *)info->folder);
- else
- filename = folder_item_fetch_msg(info->folder, info->msgnum);
-
- if (filename == NULL) {
- g_warning(_("filename is not set"));
- return NULL;
+ GSList *messages = g_slist_copy(msgs);
+ FolderItem *last_item = NULL;
+ FiltOp cur_op = IS_NOTHING;
+
+ 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) {
+ if (info->filter_op == IS_COPY || info->filter_op == IS_MOVE)
+ last_item = info->to_filter_folder;
+ else if (info->filter_op == IS_DELE)
+ last_item = info->folder;
+ }
+ if (last_item == NULL)
+ continue;
+ if (cur_op == IS_NOTHING) {
+ if (info->filter_op == IS_COPY)
+ cur_op = IS_COPY;
+ else if (info->filter_op == IS_MOVE)
+ cur_op = IS_MOVE;
+ else if (info->filter_op == IS_DELE)
+ cur_op = IS_DELE;
+ }
+ if (info->filter_op == IS_COPY || info->filter_op == IS_MOVE) {
+ if (info->to_filter_folder == last_item
+ && cur_op == info->filter_op) {
+ found++;
+ batch = g_slist_prepend(batch, info);
+ }
+ } else if (info->filter_op == IS_DELE) {
+ if (info->folder == last_item
+ && cur_op == info->filter_op) {
+ found++;
+ batch = g_slist_prepend(batch, info);
}
- else
- size += strlen(filename) - 2;
- break;
}
- s++;
}
- else s++;
- }
-
-
- processed_cmd = g_new0(gchar, size);
- s = cmd;
- p = processed_cmd;
-
- while (*s != '\0') {
- if (*s == '%') {
- s++;
- switch (*s) {
- case '%':
- *p = '%';
- p++;
- break;
- case 's': /* subject */
- if (info->subject != NULL)
- strcpy(p, info->subject);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'f': /* from */
- if (info->from != NULL)
- strcpy(p, info->from);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 't': /* to */
- if (info->to != NULL)
- strcpy(p, info->to);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'c': /* cc */
- if (info->cc != NULL)
- strcpy(p, info->cc);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'd': /* date */
- if (info->date != NULL)
- strcpy(p, info->date);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'i': /* message-id */
- if (info->msgid != NULL)
- strcpy(p, info->msgid);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'n': /* newsgroups */
- if (info->newsgroups != NULL)
- strcpy(p, info->newsgroups);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'r': /* references */
- if (info->references != NULL)
- strcpy(p, info->references);
- else
- strcpy(p, "(none)");
- p += strlen(p);
- break;
- case 'F': /* file */
- strcpy(p, filename);
- p += strlen(p);
- break;
- default:
- *p = '%';
- p++;
- *p = *s;
- p++;
- break;
- }
- s++;
+ if (found == 0) {
+ debug_print("no more messages to move/copy/del\n");
+ break;
+ } else {
+ debug_print("%d messages to %s in %s\n", found,
+ cur_op==IS_COPY ? "copy":(cur_op==IS_DELE ?"delete":"move"),
+ last_item?(last_item->name ? last_item->name:"(noname)"):"nowhere");
}
- else {
- *p = *s;
- p++;
- s++;
+ for (cur = batch; cur; cur = cur->next) {
+ MsgInfo *info = (MsgInfo *)cur->data;
+ messages = g_slist_remove(messages, info);
+ info->to_filter_folder = NULL;
+ info->filter_op = IS_NOTHING;
+ }
+ batch = g_slist_reverse(batch);
+ if (g_slist_length(batch)) {
+ MsgInfo *info = (MsgInfo *)batch->data;
+ if (cur_op == IS_COPY && last_item != info->folder) {
+ folder_item_copy_msgs(last_item, batch);
+ } else if (cur_op == IS_MOVE && last_item != info->folder) {
+ if (folder_item_move_msgs(last_item, batch) < 0)
+ folder_item_move_msgs(
+ folder_get_default_inbox(),
+ batch);
+ } else if (cur_op == IS_DELE && last_item == info->folder) {
+ folder_item_remove_msgs(last_item, 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;
+ cur_op = IS_NOTHING;
}
-
- g_free(filename);
- return processed_cmd;
+ /* we don't reference the msginfos, because caller will do */
+ g_slist_free(messages);
}
/*
return value : return TRUE if the action could be applied
*/
-#define CHANGE_FLAGS(msginfo) \
-{ \
-if (msginfo->folder->folder->change_flags != NULL) \
-msginfo->folder->folder->change_flags(msginfo->folder->folder, \
- msginfo->folder, \
- msginfo); \
+#define FLUSH_COPY_IF_NEEDED(info) { \
+ if (info->filter_op == IS_COPY && info->to_filter_folder) { \
+ debug_print("must debatch pending copy\n"); \
+ folder_item_copy_msg(info->to_filter_folder, info); \
+ info->filter_op = IS_NOTHING; \
+ } \
}
-static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
- GHashTable *folder_table)
+static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
{
FolderItem * dest_folder;
gint val;
case MATCHACTION_MOVE:
dest_folder =
folder_find_item_from_identifier(action->destination);
- if (!dest_folder)
- return FALSE;
-
- if (folder_item_move_msg(dest_folder, info) == -1) {
+ if (!dest_folder) {
+ debug_print("*** folder not found '%s'\n",
+ action->destination ?action->destination :"(null)");
return FALSE;
- }
-
- /* WRONG: can not update the mark, because the message has
- * been moved. info pertains to original location.
- * folder_item_move_msg() already updated the mark for the
- * destination folder.
- info->flags = 0;
- filteringaction_update_mark(info);
- */
- if (folder_table) {
- 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));
- }
}
+
+ FLUSH_COPY_IF_NEEDED(info);
+ /* mark message to be moved */
+ info->filter_op = IS_MOVE;
+ info->to_filter_folder = dest_folder;
return TRUE;
case MATCHACTION_COPY:
dest_folder =
folder_find_item_from_identifier(action->destination);
- if (!dest_folder)
+ if (!dest_folder) {
+ debug_print("*** folder not found '%s'\n",
+ action->destination ?action->destination :"(null)");
return FALSE;
+ }
- /* NOTE: the following call *will* update the mark file for
- * the destination folder. but the original message will
- * still be there in the inbox. */
+ FLUSH_COPY_IF_NEEDED(info);
+ /* mark message to be copied */
+ info->filter_op = IS_COPY;
+ info->to_filter_folder = dest_folder;
+ return TRUE;
- if (folder_item_copy_msg(dest_folder, info) == -1)
+ 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;
-
- if (folder_table) {
- 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));
- }
}
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_update_tags(info, (action->type == MATCHACTION_SET_TAG), val);
return TRUE;
- case MATCHACTION_DELETE:
- if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
- return FALSE;
-
- /* WRONG: can not update the mark. this would actually add
- * a bogus record to the mark file for the message's original
- * folder.
- info->flags = 0;
- filteringaction_update_mark(info);
- */
+ case MATCHACTION_CLEAR_TAGS:
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_clear_tags(info);
+ return TRUE;
+ case MATCHACTION_DELETE:
+ FLUSH_COPY_IF_NEEDED(info);
+ info->filter_op = IS_DELE;
return TRUE;
case MATCHACTION_MARK:
- MSG_SET_PERM_FLAGS(info->flags, MSG_MARKED);
- debug_print("*** MARKING message %d, in folder %s, \"%s\"\n",
- info->msgnum, info->folder->name,
- info->subject ? info->subject : "<none>");
- filteringaction_update_mark(info);
-
- CHANGE_FLAGS(info);
-
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
return TRUE;
case MATCHACTION_UNMARK:
- MSG_UNSET_PERM_FLAGS(info->flags, MSG_MARKED);
- filteringaction_update_mark(info);
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
+ return TRUE;
- CHANGE_FLAGS(info);
+ case MATCHACTION_LOCK:
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_set_flags(info, MSG_LOCKED, 0);
+ return TRUE;
+ case MATCHACTION_UNLOCK:
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_unset_flags(info, MSG_LOCKED, 0);
return TRUE;
case MATCHACTION_MARK_AS_READ:
- MSG_UNSET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
- filteringaction_update_mark(info);
-
- CHANGE_FLAGS(info);
-
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
return TRUE;
case MATCHACTION_MARK_AS_UNREAD:
- MSG_SET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
- filteringaction_update_mark(info);
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_set_flags(info, MSG_UNREAD, 0);
+ return TRUE;
+
+ case MATCHACTION_MARK_AS_SPAM:
+ FLUSH_COPY_IF_NEEDED(info);
+ 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->filter_op = IS_MOVE;
+ info->to_filter_folder = procmsg_spam_get_folder(info);
+ }
+ return TRUE;
- CHANGE_FLAGS(info);
-
+ case MATCHACTION_MARK_AS_HAM:
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_spam_learner_learn(info, NULL, FALSE);
+ procmsg_msginfo_unset_flags(info, MSG_SPAM, 0);
+ return TRUE;
+
+ case MATCHACTION_COLOR:
+ FLUSH_COPY_IF_NEEDED(info);
+ 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 MATCHACTION_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;
- }
-
- gtk_widget_destroy(compose->window);
- return FALSE;
+
+ return val == 0 ? TRUE : FALSE;
case MATCHACTION_EXECUTE:
-
cmd = matching_build_command(action->destination, info);
if (cmd == NULL)
- return TRUE;
+ return FALSE;
else {
system(cmd);
g_free(cmd);
}
-
return TRUE;
- default:
- return FALSE;
- }
-}
+ case MATCHACTION_SET_SCORE:
+ FLUSH_COPY_IF_NEEDED(info);
+ info->score = action->score;
+ return TRUE;
-/* filteringprop_apply() - runs the action on one MsgInfo if it matches the
- * criterium. certain actions can be followed by other actions. in this
- * case the function returns FALSE. if an action can not be followed
- * by others, the function returns TRUE.
- *
- * remember that this is because of the fact that msg flags are always
- * _appended_ to mark files. currently sylpheed does not insert messages
- * at a certain index.
- * now, after having performed a certain action, the MsgInfo is still
- * valid for the message. in *this* case the function returns FALSE.
- */
-static gboolean filteringprop_apply(FilteringProp * filtering, MsgInfo * info,
- GHashTable *folder_table)
-{
- if (matcherlist_match(filtering->matchers, info)) {
- gboolean result;
- gchar *action_str;
- gchar buf[256];
-
- if (FALSE == (result = filteringaction_apply(filtering->action, info,
- folder_table))) {
- action_str = filteringaction_to_string(buf, sizeof buf, filtering->action);
- g_warning(_("action %s could not be applied"), action_str);
- }
+ case MATCHACTION_CHANGE_SCORE:
+ FLUSH_COPY_IF_NEEDED(info);
+ info->score += action->score;
+ return TRUE;
- g_free(action_str);
-
- switch(filtering->action->type) {
- case MATCHACTION_MOVE:
- case MATCHACTION_DELETE:
- return TRUE; /* MsgInfo invalid for message */
- case MATCHACTION_EXECUTE:
- case MATCHACTION_COPY:
- case MATCHACTION_MARK:
- case MATCHACTION_MARK_AS_READ:
- case MATCHACTION_UNMARK:
- case MATCHACTION_MARK_AS_UNREAD:
- case MATCHACTION_FORWARD:
- case MATCHACTION_FORWARD_AS_ATTACHMENT:
- return FALSE; /* MsgInfo still valid for message */
- default:
- return FALSE;
- }
- }
- else
- return FALSE;
-}
+ case MATCHACTION_STOP:
+ return FALSE;
+
+ case MATCHACTION_HIDE:
+ FLUSH_COPY_IF_NEEDED(info);
+ info->hidden = TRUE;
+ return TRUE;
+
+ case MATCHACTION_IGNORE:
+ FLUSH_COPY_IF_NEEDED(info);
+ procmsg_msginfo_set_flags(info, MSG_IGNORE_THREAD, 0);
+ return TRUE;
+
+ case MATCHACTION_WATCH:
+ FLUSH_COPY_IF_NEEDED(info);
+ 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?action->destination:"(null)");
+ return FALSE;
+ }
+ if (!book) {
+ g_warning("addressbook_peek_folder_exists returned NULL book\n");
+ return FALSE;
+ }
-void filter_msginfo(GSList * filtering_list, MsgInfo * info,
- GHashTable *folder_table)
-{
- GSList * l;
+ abf = book->rawDataSource;
- 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))
- break;
- }
-}
+ /* get the header */
+ procheader_get_header_from_msginfo(info, buf, sizeof(buf), action->header);
+ header = procheader_parse_header(buf);
-void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
- GHashTable *folder_table)
-{
- GSList * l;
+ /* 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 (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 (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);
+ }
- switch (filtering->action->type) {
- case MATCHACTION_MOVE:
- case MATCHACTION_DELETE:
- if (filteringprop_apply(filtering, info, folder_table))
- return;
+ g_slist_free(address_list);
+ end_address_completion();
+ } else {
+ g_warning("header '%s' not set or empty\n", action->header?action->header:"(null)");
+ }
+ return (errors == 0);
}
- }
-}
-
-void filter_message(GSList * filtering_list, FolderItem * item,
- gint msgnum, GHashTable *folder_table)
-{
- MsgInfo * msginfo;
- gchar * filename;
- MsgFlags msgflags = { 0, 0 };
- if (item == NULL) {
- g_warning(_("folderitem not set"));
- return;
- }
-
- filename = folder_item_fetch_msg(item, msgnum);
-
- if (filename == NULL) {
- g_warning(_("filename is not set"));
- return;
- }
-
- msginfo = procheader_parse(filename, msgflags, TRUE);
-
- g_free(filename);
-
- if (msginfo == NULL) {
- g_warning(_("could not get info for %s"), filename);
- return;
+ default:
+ break;
}
-
- msginfo->folder = item;
- msginfo->msgnum = msgnum;
-
- filter_msginfo(filtering_list, msginfo, folder_table);
+ return FALSE;
}
-
-/******************************************************************************/
-
-/* revised filtering system.
- *
- * 07/18/01 alfons initial revisement
- */
-
-/* (alfons)
- *
- * the revised filtering system does not rely on a message being "registered"
- * in one of sylpheed's folders. it now uses the file sylpheed created on
- * incorporation of mail.
- * i do use MsgInfo data; that's needed by the matcher, but for the rest
- * the MsgInfo is not really used. */
-
-
-/* add_mark() - adds a mark for a file */
-static void add_mark(FolderItem *folder, gint msgnum, MsgPermFlags flags)
+gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
{
- gchar * dest_path;
- FILE * fp;
-
- if (folder->folder->type == F_MH) {
- dest_path = folder_item_get_path(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;
- }
+ 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;
- if ((fp = procmsg_open_mark_file(dest_path, TRUE))
- == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return;
- }
-
- /* TODO: straight from procmsg.c:procmsg_write_flags()
- * should update this when mark file version changes */
-#if MARK_VERSION == 2
- WRITE_CACHE_DATA_INT(msgnum, fp);
- WRITE_CACHE_DATA_INT(flags, fp);
-#else
-#error should rewrite the above for new mark version
- /* paste the source code of procmsg.c:procmsg_write_flags() */
-#endif
- fclose(fp);
- return;
- }
- return;
-}
-
-/* prepare_destination() - prepares destination folder by registering it
- * in the global folder table (if not already there). it returns TRUE if
- * successful. it also returns the FolderItem for the destination */
-static gboolean prepare_destination(const gchar *destination, FolderItem **item,
- GHashTable *folder_table)
-{
- gint val;
- FolderItem *result;
-
- result = folder_find_item_from_identifier(destination);
- if (!result)
- return FALSE;
- if (folder_table) {
- *item = result;
- val = GPOINTER_TO_INT(g_hash_table_lookup(folder_table, *item));
- if (val == 0) {
- folder_item_scan(*item);
- g_hash_table_insert(folder_table, *item, GINT_TO_POINTER(1));
- }
}
return TRUE;
}
-/* filter_incoming_perform_actions() - performs actions on incoming
- * message. this function handles updating marks a little bit smarter;
- * remember that marks can only be appended. */
-static gboolean filter_incoming_perform_actions(FolderItem *default_folder,
- MsgInfo *msginfo,
- GHashTable *folder_table)
-{
- /* matching actions for msginfo */
- struct matching_action {
- FilteringAction *action;
- struct matching_action *next;
- };
-
- struct matching_action ma_head = { NULL, NULL };
- struct matching_action *ma_tail = &ma_head;
-
- /* need this for the forwarding stuff */
- PrefsAccount *account;
- Compose *compose;
- MsgFlags tmp;
- gchar *fwd_msg_name;
- gint val;
- MsgInfo *fwd_msg;
-
- MsgFlags markflags = { 0, 0 };
-
- /* use the global prefs_filtering list */
- GSList * list = global_processing;
-
- /* things we get after having added a message to a folder */
- FolderItem *dest_folder;
- gint msgnum;
-
- /* after performing certain action, we may have to copy
- * the message to inbox too */
- gboolean copy_to_inbox_too = TRUE;
-
- /* filename is only put in msginfo->folder if MSG_FILTERING is set. */
- const gchar *filename = (gchar *) msginfo->folder;
-
- MsgPermFlags flags;
- gboolean stop;
- gchar *cmd;
-
- /* build list of matching actions */
- for (; list != NULL; list = g_slist_next(list)) {
- FilteringProp *prop = (FilteringProp *) list->data;
-
- if (!matcherlist_match(prop->matchers, msginfo))
- continue;
+static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info,
+ PrefsAccount *ac_prefs)
- if (NULL == (ma_tail->next = alloca(sizeof(struct matching_action)))) {
- debug_print(_("action allocation error\n"));
- break;
- }
+/* this function returns true if a filtering rule applies regarding to its account
+ data and if it does, if the conditions list match.
- debug_print("*** action %d\n", prop->action->type);
+ 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.
- ma_tail->action = prop->action;
- ma_tail->next->action = NULL;
- ma_tail->next->next = NULL;
- ma_tail = ma_tail->next;
- }
+ 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)
- debug_print("*** collecting marks\n");
-
- /* collect all marks */
- for (ma_tail = &ma_head, stop = FALSE; ma_tail->action && !stop; ma_tail = ma_tail->next) {
- switch (ma_tail->action->type) {
-
- case MATCHACTION_MARK:
- MSG_SET_PERM_FLAGS(markflags, MSG_MARKED);
- break;
-
- case MATCHACTION_UNMARK:
- MSG_UNSET_PERM_FLAGS(markflags, MSG_MARKED);
- break;
-
- case MATCHACTION_MARK_AS_READ:
- MSG_UNSET_PERM_FLAGS(markflags, MSG_UNREAD);
- break;
-
- case MATCHACTION_MARK_AS_UNREAD:
- MSG_SET_PERM_FLAGS(markflags, MSG_UNREAD);
- break;
-
- case MATCHACTION_COLOR:
- MSG_SET_COLORLABEL_VALUE(markflags, ma_tail->action->labelcolor);
- break;
-
- /* UNCONTINUABLE */
- case MATCHACTION_FORWARD:
- case MATCHACTION_FORWARD_AS_ATTACHMENT:
- case MATCHACTION_MOVE:
- case MATCHACTION_DELETE:
- stop = TRUE;
- break;
-
- default:
- break;
- }
- }
-
-
- /* msgnum & dest_folder should have valid values after a succesful
- * drop; in this case there is a MsgInfo available */
- msgnum = -1;
- dest_folder = NULL;
-
- debug_print("*** performing actions\n");
-
- for (ma_tail = &ma_head ; ma_tail->action; ma_tail = ma_tail->next) {
-
- /* there are variables you have to use when defining new actions:
- *
- * copy_to_inbox_too - if the original message should be copied to the inbox
- * (default_folder) too.
- *
- * also note that after dropping it to a folder (folder_item_add_msg()) you have
- * to mark the message, just to make sure any defined mark actions are applied. */
-
-#define ACTION (ma_tail->action->type)
-
- /* C O N T I N U A B L E */
-
- if (MATCHACTION_COPY == ACTION) {
- debug_print("*** performing copy\n");
- copy_to_inbox_too = TRUE;
- if (!prepare_destination(ma_tail->action->destination, &dest_folder, folder_table)) {
- debug_print("Rule failed: unknown destination %s\n", ma_tail->action->destination);
- continue; /* try next action */
- }
- if (0 > (msgnum = folder_item_add_msg(dest_folder, filename, FALSE))) {
- debug_print(_("Rule failed: could not copy to folder %s\n"),
- ma_tail->action->destination);
- continue; /* try next action */
- }
- flags = msginfo->flags.perm_flags | markflags.perm_flags;
- add_mark(dest_folder, msgnum, flags);
- }
- else if (MATCHACTION_EXECUTE == ACTION) {
- debug_print("*** performing exec\n");
- copy_to_inbox_too = TRUE;
-
- /* matching_build_command() knows about filtering */
- cmd = matching_build_command(ma_tail->action->destination, msginfo);
- if (cmd) {
- system(cmd);
- g_free(cmd);
+ 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) {
+ matches = ((filtering->account_id == 0)
+ || (filtering->account_id == ac_prefs->account_id));
+
+ /* 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?ac_prefs->account_name:_("NON_EXISTENT"));
+ }
+ }
}
else
- debug_print(_("Rule failed: no command line\n"));
- }
-
- /* U N C O N T I N U A B L E */
-
- else if (MATCHACTION_FORWARD == ACTION
- || MATCHACTION_FORWARD_AS_ATTACHMENT == ACTION) {
- debug_print("*** performing forward\n");
-
- /* forwarding messages is complicated because there's currently no
- * way to forward a message using "filenames"; you can only forward
- * a message if you have its MsgInfo. this means we have to drop
- * the message first */
- if (0 > (msgnum = folder_item_add_msg(default_folder, filename, FALSE))) {
- debug_print(_("Rule failed: could not forward\n"));
- copy_to_inbox_too = TRUE;
- continue;
+ 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->account_name:_("NON_EXISTENT"),
+ ac_prefs->account_id, ac_prefs?ac_prefs->account_name:_("NON_EXISTENT"));
+ }
+ }
}
-
- flags = msginfo->flags.perm_flags | markflags.perm_flags;
- flags |= MSG_FORWARDED;
- add_mark(default_folder, msgnum, flags);
-
- /* grab the dropped message */
- fwd_msg_name = folder_item_fetch_msg(default_folder, msgnum);
-
- tmp.perm_flags = tmp.tmp_flags = 0;
- fwd_msg = procheader_parse(fwd_msg_name, tmp, TRUE);
-
- fwd_msg->folder = default_folder;
- fwd_msg->msgnum = msgnum;
-
- /* do the compose_XXX stuff */
- account = account_find_from_id(ma_tail->action->account_id);
- compose = compose_forward(account, fwd_msg, ACTION == MATCHACTION_FORWARD ? FALSE : TRUE);
- if (compose->account->protocol == A_NNTP)
- compose_entry_append(compose, ma_tail->action->destination,
- COMPOSE_NEWSGROUPS);
- else
- compose_entry_append(compose, ma_tail->action->destination,
- COMPOSE_TO);
-
- compose_send(compose);
-
- procmsg_msginfo_free(fwd_msg);
-
- gtk_widget_destroy(compose->window);
- break;
- }
- else if (MATCHACTION_DELETE == ACTION) {
- debug_print("*** performing delete\n");
- copy_to_inbox_too = FALSE;
-
- /* drop to Trash */
- dest_folder = folder_get_default_trash();
- msgnum = folder_item_add_msg(dest_folder, filename, FALSE);
- if (msgnum < 0) {
- debug_print(_("Rule failed: could not move to trash"));
- copy_to_inbox_too = TRUE;
+ }
+ } 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->account_name:_("NON_EXISTENT"));
+ }
+ }
}
- else {
- flags = msginfo->flags.perm_flags | markflags.perm_flags;
- add_mark(dest_folder, msgnum, flags);
+ 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->account_name:_("NON_EXISTENT"));
+ } 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;
- }
- else if (MATCHACTION_MOVE == ACTION) {
- debug_print("*** performing move\n");
- copy_to_inbox_too = FALSE;
-
- if (!prepare_destination(ma_tail->action->destination, &dest_folder, folder_table)) {
- copy_to_inbox_too = TRUE;
- break;
+ 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->account_name:_("NON_EXISTENT"),
+ cur_account->account_id, cur_account?cur_account->account_name:_("NON_EXISTENT"));
+ } 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->account_name:_("NON_EXISTENT"),
+ cur_account->account_id, cur_account?cur_account->account_name:_("NON_EXISTENT"));
+ }
+ }
+ }
}
-
- msgnum = folder_item_add_msg(dest_folder, filename, FALSE);
- if (msgnum < 0) {
- debug_print(_("Rule failed: could not move to folder %s\n"),
- ma_tail->action->destination);
- copy_to_inbox_too = TRUE;
- break;
- }
-
- flags = msginfo->flags.perm_flags | markflags.perm_flags;
- add_mark(dest_folder, msgnum, flags);
break;
}
}
- /* may need to copy it to inbox too */
- if (copy_to_inbox_too) {
- debug_print("*** performing inbox copy\n");
- msgnum = folder_item_add_msg(default_folder, filename, TRUE);
- if (msgnum < 0) {
- debug_print(_("error copying incoming file %s to inbox\n"),
- filename);
- return FALSE;
- }
- flags = msginfo->flags.perm_flags | markflags.perm_flags;
- add_mark(default_folder, msgnum, flags);
- }
- else {
- debug_print("*** unlinking\n");
- if (unlink(filename) < 0)
- debug_print(_("error deleting incoming message file\n"));
- }
-
-#undef ACTION
-
- return TRUE;
+ return matches && matcherlist_match(filtering->matchers, info);
}
-static void filter_incoming_msginfo(FolderItem *default_folder, MsgInfo *msginfo,
- 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)
{
- filter_incoming_perform_actions(default_folder, msginfo, folder_table);
+ 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;
+ 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))) {
+ 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)) {
+ * final = TRUE;
+ break;
+ }
+ }
+ return result;
}
-/* filter_incoming_message() - tries to apply a filter on one incoming message.
- * it also handles the case when there's no filter match */
-void filter_incoming_message(FolderItem *default_folder, const gchar *file_name,
- GHashTable *folder_table)
+/*!
+ *\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)
{
- MsgInfo *msginfo;
- MsgFlags msgflags = { 0, 0 };
-
- /* make an "uncomplete" msginfo. it's incomplete because it doesn't
- * have a message number / folder yet. */
- if (NULL == (msginfo = procheader_parse(file_name, msgflags, TRUE))) {
- g_warning(_("error filtering incoming message %s\n"),
- file_name);
- return;
+ 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;
}
-
- /* let matcher know that this is a message that has no
- * valid body data yet. */
- MSG_SET_TMP_FLAGS(msginfo->flags, MSG_FILTERING);
- msginfo->folder = (FolderItem *) g_strdup(file_name); /* actually storing a pointer to a string */
- msginfo->msgnum = 0;
-
- filter_incoming_msginfo(default_folder, msginfo, folder_table);
-
- g_free(msginfo->folder);
- procmsg_msginfo_free(msginfo);
}
-/****************************************************************************/
-
-
-
-/*
-void prefs_filtering_read_config(void)
+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;
- gchar *rcpath;
- FILE *fp;
- gchar buf[PREFSBUFSIZE];
+ 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);
+ }
+ g_free(buf);
+ }
- debug_print(_("Reading filtering configuration...\n"));
+ if (filtering_match_condition(filtering, info, ac_prefs)) {
+ apply_next = filtering_apply_rule(filtering, info, &final);
+ if (final)
+ break;
+ }
- 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;
+ } 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);
+ }
+ }
}
- 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;
+ /* 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;
+ }
- g_strchomp(buf);
+ return TRUE;
+}
- 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);
+/*!
+ *\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,
+ FilteringInvocationType context, gchar *extra_info)
+{
+ gboolean ret;
+
+ if (prefs_common.enable_filtering_debug) {
+ gchar *tmp = _("undetermined");
+#ifndef G_OS_WIN32
+ 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;
+ }
+#else
+ debug_filtering_session = FALSE;
+#endif
+ 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;
- fclose(fp);
+ ret = filter_msginfo(flist, info, ac_prefs);
+ debug_filtering_session = FALSE;
+ return ret;
}
-*/
gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
- gchar *command_str;
-
+ const gchar *command_str;
+ gchar * quoted_dest;
+ gchar * quoted_header;
+
command_str = get_matchparser_tab_str(action->type);
if (command_str == NULL)
case MATCHACTION_MOVE:
case MATCHACTION_COPY:
case MATCHACTION_EXECUTE:
- g_snprintf(dest, destlen, "%s \"%s\"", command_str, action->destination);
+ 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);
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:
+ case MATCHACTION_WATCH:
+ case MATCHACTION_CLEAR_TAGS:
g_snprintf(dest, destlen, "%s", command_str);
return dest;
+ case MATCHACTION_REDIRECT:
case MATCHACTION_FORWARD:
case MATCHACTION_FORWARD_AS_ATTACHMENT:
- g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, action->destination);
+ 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;
+
+ 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;
}
}
+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 *action_list_str;
gchar *filtering_str;
- gchar buf[256];
- action_str = filteringaction_to_string(buf, sizeof buf, 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)
+ if (list_str == NULL) {
+ 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);
return filtering_str;
}
-void prefs_filtering_write_config(void)
-{
- /*
- gchar *rcpath;
- PrefFile *pfile;
- GSList *cur;
- FilteringProp * prop;
-
- debug_print(_("Writing filtering configuration...\n"));
-
- rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, FILTERING_RC, NULL);
-
- if ((pfile = prefs_write_open(rcpath)) == NULL) {
- g_warning(_("failed to write configuration to file\n"));
- g_free(rcpath);
- return;
- }
-
- for (cur = global_processing; 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);
- }
-
- g_free(rcpath);
-
- if (prefs_write_close(pfile) < 0) {
- g_warning(_("failed to write configuration to file\n"));
- return;
- }
- */
-}
-
-void prefs_filtering_free(GSList * prefs_filtering)
+static void prefs_filtering_free(GSList * prefs_filtering)
{
while (prefs_filtering != NULL) {
FilteringProp * filtering = (FilteringProp *)
{
FolderItem *item = node->data;
- if(!item->prefs)
- return FALSE;
+ g_return_val_if_fail(item, FALSE);
+ g_return_val_if_fail(item->prefs, FALSE);
prefs_filtering_free(item->prefs->processing);
item->prefs->processing = NULL;
return FALSE;
}
-void prefs_filtering_clear()
+void prefs_filtering_clear(void)
{
GList * cur;
prefs_filtering_free_func, NULL);
}
- prefs_filtering_free(global_processing);
- global_processing = NULL;
+ 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? */
+}
+
+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