/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2001 Hiroyuki Yamamoto & The Sylpheed Claws Team
+ * Copyright (C) 1999-2006 Hiroyuki Yamamoto & The Sylpheed Claws 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
*
* 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
-/* (alfons) - Just a quick note of how this filtering module works on
- * new (arriving) messages.
- *
- * 1) as an initialization step, code in inc.c and mbox.c set up the
- * drop folder to the inbox (see inc.c and mbox.c).
- *
- * 2) the message is actually being copied to the drop folder using
- * folder_item_add_msg(dropfolder, file, TRUE). this function
- * eventually calls mh->add_msg(). however, the important thing
- * about this function is, is that the folder is not yet updated
- * to reflect the copy. i don't know about the validity of this
- * assumption, however, the filtering code assumes this and
- * updates the marks itself.
- *
- * 3) technically there's nothing wrong with the matcher (the
- * piece of code which matches search strings). there's
- * one gotcha in procmsg.c:procmsg_get_message_file(): it
- * only reads a message file based on a MsgInfo. for design
- * reasons the filtering system should read directly from
- * a file (based on the file's name).
- *
- * 4) after the matcher sorts out any matches, it looks at the
- * action. this part again pushes the folder system design
- * to its limits. based on the assumption in 2), the matcher
- * knows the message has not been added to the folder system yet.
- * it can happily update mark files, and in fact it does.
- *
- */
-
#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"
#define PREFSBUFSIZE 1024
-GSList * global_processing = 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)
FilteringAction * filteringaction_new(int type, int account_id,
gchar * destination,
- gint labelcolor)
+ gint labelcolor, gint score)
{
FilteringAction * action;
action->account_id = account_id;
if (destination) {
action->destination = g_strdup(destination);
- action->unesc_destination = matcher_unescape_str(g_strdup(destination));
} else {
action->destination = NULL;
- action->unesc_destination = NULL;
}
action->labelcolor = labelcolor;
+ action->score = score;
return action;
}
g_return_if_fail(action);
if (action->destination)
g_free(action->destination);
- if (action->unesc_destination)
- g_free(action->unesc_destination);
g_free(action);
}
-FilteringProp * filteringprop_new(MatcherList * matchers,
- FilteringAction * action)
+FilteringProp * filteringprop_new(const gchar *name,
+ MatcherList * matchers,
+ GSList * action_list)
{
FilteringProp * filtering;
filtering = g_new0(FilteringProp, 1);
+ filtering->name = name ? g_strdup(name): NULL;
filtering->matchers = matchers;
- filtering->action = action;
+ filtering->action_list = action_list;
return filtering;
}
-void filteringprop_free(FilteringProp * prop)
+static FilteringAction * filteringaction_copy(FilteringAction * src)
{
- matcherlist_free(prop->matchers);
- filteringaction_free(prop->action);
- g_free(prop);
+ 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;
}
-/* 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)
+FilteringProp * filteringprop_copy(FilteringProp *src)
{
- gchar * dest_path;
- FILE * fp;
+ FilteringProp * new;
+ GSList *tmp;
+
+ new = g_new0(FilteringProp, 1);
+ new->matchers = g_new0(MatcherList, 1);
- 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);
+ for (tmp = src->matchers->matchers; tmp != NULL && tmp->data != NULL;) {
+ MatcherProp *matcher = (MatcherProp *)tmp->data;
- 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;
+ new->matchers->matchers = g_slist_append(new->matchers->matchers,
+ matcherprop_copy(matcher));
+ tmp = tmp->next;
}
- return FALSE;
+
+ new->matchers->bool_and = src->matchers->bool_and;
+
+ 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));
+ }
+
+ new->name = g_strdup(src->name);
+
+ return new;
}
-#if 0
-static gchar * filteringaction_execute_command(gchar * cmd, MsgInfo * info)
+void filteringprop_free(FilteringProp * prop)
{
- 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 */
- filename = folder_item_fetch_msg(info->folder, info->msgnum);
- if (filename == NULL) {
- g_warning(_("filename is not set"));
- return NULL;
- }
- else
- size += strlen(filename) - 2;
- break;
- }
- s++;
- }
- else s++;
- }
-
+ GSList * tmp;
- processed_cmd = g_new0(gchar, size);
- s = cmd;
- p = processed_cmd;
+ g_return_if_fail(prop);
+ matcherlist_free(prop->matchers);
+
+ for (tmp = prop->action_list ; tmp != NULL ; tmp = tmp->next) {
+ filteringaction_free(tmp->data);
+ }
+ g_free(prop->name);
+ g_free(prop);
+}
- 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;
+/* 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;
+
+ while (messages) {
+ GSList *batch = NULL, *cur;
+ gint found = 0;
+ debug_print("%d messages to filter\n", g_slist_length(messages));
+ for (cur = messages; cur; cur = cur->next) {
+ MsgInfo *info = (MsgInfo *)cur->data;
+ if (last_item == NULL) {
+ last_item = info->to_folder;
+ }
+ if (last_item == NULL)
+ continue;
+ debug_print("for %s\n", folder_item_get_path(last_item));
+ if (!is_copy && !is_move) {
+ if (info->is_copy)
+ is_copy = TRUE;
+ else if (info->is_move)
+ is_move = TRUE;
+ }
+ found++;
+ if (info->to_folder == last_item
+ && info->is_copy == is_copy
+ && info->is_move == is_move) {
+ batch = g_slist_append(batch, info);
}
- s++;
}
- else {
- *p = *s;
- p++;
- s++;
+ if (found == 0) {
+ debug_print("no more messages to move/copy\n");
+ break;
+ }
+ for (cur = batch; cur; cur = cur->next) {
+ MsgInfo *info = (MsgInfo *)cur->data;
+ messages = g_slist_remove(messages, info);
}
+ if (g_slist_length(batch)) {
+ debug_print("%s %d messages to %s\n",
+ is_copy?"copying":"moving",
+ g_slist_length(batch),
+ folder_item_get_path(last_item));
+ if (is_copy) {
+ folder_item_copy_msgs(last_item, batch);
+ } else if (is_move) {
+ 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;
+ debug_print("%d messages remaining\n", g_slist_length(messages));
}
- return processed_cmd;
+ /* we don't reference the msginfos, because caller will do */
+ g_slist_free(messages);
}
-#endif
/*
fitleringaction_apply
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); \
-}
-
-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 :"");
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));
- }
}
+
+ /* mark message to be moved */
+ info->is_move = TRUE;
+ info->to_folder = dest_folder;
+ debug_print("set to move to %s\n", folder_item_get_path(dest_folder));
return TRUE;
case MATCHACTION_COPY:
dest_folder =
folder_find_item_from_identifier(action->destination);
- if (!dest_folder)
- return FALSE;
-
- 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;
-
- 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));
- }
}
+
+ /* mark message to be copied */
+ info->is_copy = TRUE;
+ info->to_folder = dest_folder;
+ debug_print("set to copy to %s\n", folder_item_get_path(dest_folder));
return TRUE;
case MATCHACTION_DELETE:
return TRUE;
case MATCHACTION_MARK:
- MSG_SET_PERM_FLAGS(info->flags, MSG_MARKED);
+ procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
return TRUE;
case MATCHACTION_UNMARK:
- MSG_UNSET_PERM_FLAGS(info->flags, MSG_MARKED);
+ procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
+ return TRUE;
+
+ 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 MATCHACTION_MARK_AS_READ:
- MSG_UNSET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
+ 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);
+ procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
return TRUE;
case MATCHACTION_COLOR:
- MSG_SET_COLORLABEL_VALUE(info->flags, action->labelcolor);
+ 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:
- 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);
-
- 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:
-
account = account_find_from_id(action->account_id);
- compose = compose_forward(account, info, TRUE);
- 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);
+ 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_BOUNCE:
+ return val == 0 ? TRUE : FALSE;
+
+ case MATCHACTION_REDIRECT:
account = account_find_from_id(action->account_id);
- compose = compose_bounce(account, info);
+ compose = compose_redirect(account, info);
if (compose->account->protocol == A_NNTP)
break;
else
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->unesc_destination, info);
+ cmd = matching_build_command(action->destination, info);
if (cmd == NULL)
return FALSE;
else {
}
return TRUE;
+ 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;
+
default:
- return FALSE;
+ break;
}
+ return FALSE;
}
-/* 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)
+gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
{
- 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);
- }
-
- 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:
- case MATCHACTION_BOUNCE:
- return FALSE; /* MsgInfo still valid for message */
- default:
+ 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;
- }
+
}
- else
- return FALSE;
+ return TRUE;
}
-static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
- MsgInfo * info, GHashTable *folder_table)
+static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
{
- GSList *l;
- gboolean result;
-
- 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 (TRUE == (result = filteringprop_apply(filtering, info, folder_table)))
- break;
- }
-
- /* drop in inbox too */
- if (!result) {
- gint val;
-
- if (folder_item_move_msg(inbox, info) == -1) {
- debug_print(_("*** Could not drop message in inbox; still in .processing\n"));
- return;
- }
-
- if (folder_table) {
- val = GPOINTER_TO_INT(g_hash_table_lookup
- (folder_table, inbox));
- if (val == 0) {
- folder_item_scan(inbox);
- g_hash_table_insert(folder_table, inbox,
- GINT_TO_POINTER(1));
- }
- }
- }
+ return matcherlist_match(filtering->matchers, info);
}
-void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
- 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)
{
- 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;
-
- switch (filtering->action->type) {
- case MATCHACTION_MOVE:
- case MATCHACTION_DELETE:
- if (filteringprop_apply(filtering, info, folder_table))
- return;
- }
- }
+ gboolean result = TRUE;
+ gchar buf[50];
+ 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;
}
-void filter_message(GSList *filtering_list, FolderItem *inbox,
- gint msgnum, 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;
- gchar *filename;
- MsgFlags msgflags = { 0, 0 };
- FolderItem *item = folder_get_default_processing();
-
- if (item == NULL) {
- g_warning(_("folderitem not set"));
- return;
+ switch(filtering_action->type) {
+ case MATCHACTION_MOVE:
+ case MATCHACTION_DELETE:
+ case MATCHACTION_STOP:
+ 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)
+{
+ 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_match_condition(filtering, info)) {
+ apply_next = filtering_apply_rule(filtering, info, &final);
+ if (final)
+ break;
+ }
}
- msginfo = procheader_parse(filename, msgflags, 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;
+ return TRUE;
+}
- filter_msginfo(filtering_list, inbox, msginfo, folder_table);
+/*!
+ *\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)
+{
+ return filter_msginfo(flist, info);
}
gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
- gchar *command_str;
-
+ const gchar *command_str;
+ gchar * quoted_dest;
+
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);
+ 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_STOP:
+ case MATCHACTION_HIDE:
g_snprintf(dest, destlen, "%s", command_str);
return dest;
- case MATCHACTION_BOUNCE:
+ 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;
+
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;
{
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? */
+}
+
projects / claws.git / blobdiff