gfgit/claws-mail
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
claws-mail/src/filtering.c
Colin Leroy ccda55996e try again
2006-11-07 10:47:23 +00:00

721 lines
19 KiB
C
Raw Blame History

/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
* Copyright (C) 1999-2006 Hiroyuki Yamamoto & The Claws Mail Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include "defs.h"
#include <glib.h>
#include <glib/gi18n.h>
#include <ctype.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <gtk/gtk.h>
#include <stdio.h>
#include "utils.h"
#include "procheader.h"
#include "matcher.h"
#include "filtering.h"
#include "prefs_gtk.h"
#include "compose.h"
#include "prefs_common.h"
#define PREFSBUFSIZE 1024
GSList * pre_global_processing = NULL;
GSList * post_global_processing = NULL;
GSList * filtering_rules = NULL;
static gboolean filtering_is_final_action(FilteringAction *filtering_action);
#define STRLEN_WITH_CHECK(expr) \
strlen_with_check(#expr, __LINE__, expr)
static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
{
if (str)
return strlen(str);
else {
debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
return 0;
}
}
FilteringAction * filteringaction_new(int type, int account_id,
gchar * destination,
gint labelcolor, gint score)
{
FilteringAction * action;
action = g_new0(FilteringAction, 1);
action->type = type;
action->account_id = account_id;
if (destination) {
action->destination = g_strdup(destination);
} else {
action->destination = NULL;
}
action->labelcolor = labelcolor;
action->score = score;
return action;
}
void filteringaction_free(FilteringAction * action)
{
g_return_if_fail(action);
g_free(action->destination);
g_free(action);
}
FilteringProp * filteringprop_new(gboolean enabled,
const gchar *name,
gint account_id,
MatcherList * matchers,
GSList * action_list)
{
FilteringProp * filtering;
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;
return filtering;
}
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_copy(FilteringProp *src)
{
FilteringProp * new;
GSList *tmp;
new = g_new0(FilteringProp, 1);
new->matchers = g_new0(MatcherList, 1);
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;
}
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->enabled = src->enabled;
new->name = g_strdup(src->name);
return new;
}
void filteringprop_free(FilteringProp * prop)
{
GSList * tmp;
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);
}
void filtering_move_and_copy_msg(MsgInfo *msginfo)
{
GSList *list = g_slist_append(NULL, msginfo);
filtering_move_and_copy_msgs(list);
g_slist_free(list);
}
/* move and copy messages by batches to be faster on IMAP */
void filtering_move_and_copy_msgs(GSList *msgs)
{
GSList *messages = g_slist_copy(msgs);
FolderItem *last_item = NULL;
gboolean is_copy = FALSE, is_move = FALSE;
debug_print("checking %d messages\n", g_slist_length(msgs));
while (messages) {
GSList *batch = NULL, *cur;
gint found = 0;
for (cur = messages; cur; cur = cur->next) {
MsgInfo *info = (MsgInfo *)cur->data;
if (last_item == NULL) {
last_item = info->to_filter_folder;
}
if (last_item == NULL)
continue;
if (!is_copy && !is_move) {
if (info->is_copy)
is_copy = TRUE;
else if (info->is_move)
is_move = TRUE;
}
found++;
if (info->to_filter_folder == last_item
&& info->is_copy == is_copy
&& info->is_move == is_move) {
batch = g_slist_prepend(batch, info);
}
}
if (found == 0) {
debug_print("no more messages to move/copy\n");
break;
} else {
debug_print("%d messages to %s in %s\n", found,
is_copy ? "copy":"move", last_item->name ? last_item->name:"(noname)");
}
for (cur = batch; cur; cur = cur->next) {
MsgInfo *info = (MsgInfo *)cur->data;
messages = g_slist_remove(messages, info);
}
batch = g_slist_reverse(batch);
if (g_slist_length(batch)) {
MsgInfo *info = (MsgInfo *)batch->data;
if (is_copy && last_item != info->folder) {
folder_item_copy_msgs(last_item, batch);
} else if (is_move && last_item != info->folder) {
if (folder_item_move_msgs(last_item, batch) < 0)
folder_item_move_msgs(
folder_get_default_inbox(),
batch);
}
/* we don't reference the msginfos, because caller will do */
g_slist_free(batch);
batch = NULL;
}
last_item = NULL;
is_copy = FALSE;
is_move = FALSE;
}
/* we don't reference the msginfos, because caller will do */
g_slist_free(messages);
}
/*
fitleringaction_apply
runs the action on one MsgInfo
return value : return TRUE if the action could be applied
*/
static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info)
{
FolderItem * dest_folder;
gint val;
Compose * compose;
PrefsAccount * account;
gchar * cmd;
switch(action->type) {
case MATCHACTION_MOVE:
dest_folder =
folder_find_item_from_identifier(action->destination);
if (!dest_folder) {
debug_print("*** folder not found '%s'\n",
action->destination ?action->destination :"");
return FALSE;
}
/* check if mail is set to copy already,
* in which case we have to do it */
if (info->is_copy && info->to_filter_folder) {
debug_print("should cp and mv !\n");
folder_item_copy_msg(info->to_filter_folder, info);
info->is_copy = FALSE;
}
/* mark message to be moved */
info->is_move = TRUE;
info->to_filter_folder = dest_folder;
return TRUE;
case MATCHACTION_COPY:
dest_folder =
folder_find_item_from_identifier(action->destination);
if (!dest_folder) {
debug_print("*** folder not found '%s'\n",
action->destination ?action->destination :"");
return FALSE;
}
/* check if mail is set to copy already,
* in which case we have to do it */
if (info->is_copy && info->to_filter_folder) {
debug_print("should cp and mv !\n");
folder_item_copy_msg(info->to_filter_folder, info);
info->is_copy = FALSE;
}
/* mark message to be copied */
info->is_copy = TRUE;
info->to_filter_folder = dest_folder;
return TRUE;
case MATCHACTION_DELETE:
if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
return FALSE;
return TRUE;
case MATCHACTION_MARK:
procmsg_msginfo_set_flags(info, MSG_MARKED, 0);
return TRUE;
case MATCHACTION_UNMARK:
procmsg_msginfo_unset_flags(info, MSG_MARKED, 0);
return TRUE;
case 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:
procmsg_msginfo_unset_flags(info, MSG_UNREAD | MSG_NEW, 0);
return TRUE;
case MATCHACTION_MARK_AS_UNREAD:
procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
return TRUE;
case MATCHACTION_COLOR:
procmsg_msginfo_unset_flags(info, MSG_CLABEL_FLAG_MASK, 0);
procmsg_msginfo_set_flags(info, MSG_COLORLABEL_TO_FLAGS(action->labelcolor), 0);
return TRUE;
case MATCHACTION_FORWARD:
case MATCHACTION_FORWARD_AS_ATTACHMENT:
account = account_find_from_id(action->account_id);
compose = compose_forward(account, info,
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);
return val == 0 ? TRUE : FALSE;
case MATCHACTION_REDIRECT:
account = account_find_from_id(action->account_id);
compose = compose_redirect(account, info, TRUE);
if (compose->account->protocol == A_NNTP)
break;
else
compose_entry_append(compose, action->destination,
COMPOSE_TO);
val = compose_send(compose);
return val == 0 ? TRUE : FALSE;
case MATCHACTION_EXECUTE:
cmd = matching_build_command(action->destination, info);
if (cmd == NULL)
return FALSE;
else {
system(cmd);
g_free(cmd);
}
return TRUE;
case MATCHACTION_SET_SCORE:
info->score = action->score;
return TRUE;
case MATCHACTION_CHANGE_SCORE:
info->score += action->score;
return TRUE;
case MATCHACTION_STOP:
return FALSE;
case MATCHACTION_HIDE:
info->hidden = TRUE;
return TRUE;
case MATCHACTION_IGNORE:
procmsg_msginfo_set_flags(info, MSG_IGNORE_THREAD, 0);
return TRUE;
default:
break;
}
return FALSE;
}
gboolean filteringaction_apply_action_list(GSList *action_list, MsgInfo *info)
{
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;
}
return TRUE;
}
static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info,
PrefsAccount *ac_prefs)
{
gboolean matches = FALSE;
if (ac_prefs != NULL) {
matches = ((filtering->account_id == 0)
|| (filtering->account_id == ac_prefs->account_id));
} else {
switch (prefs_common.apply_per_account_filtering_rules) {
case FILTERING_ACCOUNT_RULES_FORCE:
/* apply filtering rules regardless to the account info */
matches = TRUE;
break;
case FILTERING_ACCOUNT_RULES_SKIP:
/* don't apply filtering rules that belong to an account */
matches = (filtering->account_id == 0);
break;
case FILTERING_ACCOUNT_RULES_USE_CURRENT:
matches = ((filtering->account_id == 0)
|| (filtering->account_id == cur_account->account_id));
break;
}
}
return matches && matcherlist_match(filtering->matchers, info);
}
/*!
*\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)
{
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;
}
/*!
*\brief Check if an action is "final", i.e. should break further
* processing.
*
*\param filtering_action Action to check.
*
*\return gboolean TRUE if \a filtering_action is final.
*/
static gboolean filtering_is_final_action(FilteringAction *filtering_action)
{
switch(filtering_action->type) {
case MATCHACTION_MOVE:
case MATCHACTION_DELETE:
case MATCHACTION_STOP:
return TRUE; /* MsgInfo invalid for message */
default:
return FALSE;
}
}
static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info, PrefsAccount* ac_prefs)
{
GSList *l;
gboolean final;
gboolean apply_next;
g_return_val_if_fail(info != NULL, TRUE);
for (l = filtering_list, final = FALSE, apply_next = FALSE; l != NULL; l = g_slist_next(l)) {
FilteringProp * filtering = (FilteringProp *) l->data;
if (filtering->enabled && filtering_match_condition(filtering, info, ac_prefs)) {
apply_next = filtering_apply_rule(filtering, info, &final);
if (final)
break;
}
}
/* 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;
}
return TRUE;
}
/*!
*\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)
{
return filter_msginfo(flist, info, ac_prefs);
}
gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
const gchar *command_str;
gchar * quoted_dest;
command_str = get_matchparser_tab_str(action->type);
if (command_str == NULL)
return NULL;
switch(action->type) {
case MATCHACTION_MOVE:
case MATCHACTION_COPY:
case MATCHACTION_EXECUTE:
quoted_dest = matcher_quote_str(action->destination);
g_snprintf(dest, destlen, "%s \"%s\"", command_str, quoted_dest);
g_free(quoted_dest);
return dest;
case MATCHACTION_DELETE:
case MATCHACTION_MARK:
case MATCHACTION_UNMARK:
case MATCHACTION_LOCK:
case MATCHACTION_UNLOCK:
case MATCHACTION_MARK_AS_READ:
case MATCHACTION_MARK_AS_UNREAD:
case MATCHACTION_STOP:
case MATCHACTION_HIDE:
case MATCHACTION_IGNORE:
g_snprintf(dest, destlen, "%s", command_str);
return dest;
case MATCHACTION_REDIRECT:
case MATCHACTION_FORWARD:
case MATCHACTION_FORWARD_AS_ATTACHMENT:
quoted_dest = matcher_quote_str(action->destination);
g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, quoted_dest);
g_free(quoted_dest);
return dest;
case MATCHACTION_COLOR:
g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
return dest;
case MATCHACTION_CHANGE_SCORE:
case MATCHACTION_SET_SCORE:
g_snprintf(dest, destlen, "%s %d", command_str, action->score);
return dest;
default:
return NULL;
}
}
gchar * filteringaction_list_to_string(GSList * action_list)
{
gchar *action_list_str;
gchar buf[256];
GSList * tmp;
gchar *list_str;
action_list_str = NULL;
for (tmp = action_list ; tmp != NULL ; tmp = tmp->next) {
gchar *action_str;
FilteringAction * action;
action = tmp->data;
action_str = filteringaction_to_string(buf,
sizeof buf, action);
if (action_list_str != NULL) {
list_str = g_strconcat(action_list_str, " ", action_str, NULL);
g_free(action_list_str);
}
else {
list_str = g_strdup(action_str);
}
action_list_str = list_str;
}
return action_list_str;
}
gchar * filteringprop_to_string(FilteringProp * prop)
{
gchar *list_str;
gchar *action_list_str;
gchar *filtering_str;
action_list_str = filteringaction_list_to_string(prop->action_list);
if (action_list_str == NULL)
return NULL;
list_str = matcherlist_to_string(prop->matchers);
if (list_str == NULL) {
g_free(action_list_str);
return 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_free(GSList * prefs_filtering)
{
while (prefs_filtering != NULL) {
FilteringProp * filtering = (FilteringProp *)
prefs_filtering->data;
filteringprop_free(filtering);
prefs_filtering = g_slist_remove(prefs_filtering, filtering);
}
}
static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
{
FolderItem *item = node->data;
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)
{
GList * cur;
for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
Folder *folder;
folder = (Folder *) cur->data;
g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
prefs_filtering_free_func, NULL);
}
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;
}
Reference in a new issue View git blame Copy permalink