/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2001 Hiroyuki Yamamoto & The Sylpheed Claws Team
+ * Copyright (C) 1999-2002 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
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 <ctype.h>
#include <string.h>
#include "procheader.h"
#include "matcher.h"
#include "filtering.h"
-#include "prefs.h"
+#include "prefs_gtk.h"
#include "compose.h"
#define PREFSBUFSIZE 1024
action = g_new0(FilteringAction, 1);
+ /* NOTE:
+ * if type is MATCHACTION_CHANGE_SCORE, account_id = (-1, 0, 1) and
+ * labelcolor = the score value change
+ */
+
action->type = type;
action->account_id = account_id;
- if (destination)
- action->destination = g_strdup(destination);
+ 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;
return action;
}
void filteringaction_free(FilteringAction * 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);
}
return filtering;
}
-void filteringprop_free(FilteringProp * prop)
+FilteringProp * filteringprop_copy(FilteringProp *src)
{
- matcherlist_free(prop->matchers);
- filteringaction_free(prop->action);
- 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)
-{
- 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;
- }
+ FilteringProp * new;
+ GSList *tmp;
+
+ new = g_new0(FilteringProp, 1);
+ new->matchers = g_new0(MatcherList, 1);
+ new->action = g_new0(FilteringAction, 1);
+ for (tmp = src->matchers->matchers; tmp != NULL && tmp->data != NULL;) {
+ MatcherProp *matcher = (MatcherProp *)tmp->data;
- 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->type = src->action->type;
+ new->action->account_id = src->action->account_id;
+ if (src->action->destination)
+ new->action->destination = g_strdup(src->action->destination);
+ else
+ new->action->destination = NULL;
+ if (src->action->unesc_destination)
+ new->action->unesc_destination = g_strdup(src->action->unesc_destination);
+ else
+ new->action->unesc_destination = NULL;
+ new->action->labelcolor = src->action->labelcolor;
+ return new;
}
-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++;
- }
-
-
- 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++;
- }
- else {
- *p = *s;
- p++;
- s++;
- }
- }
- return processed_cmd;
+ matcherlist_free(prop->matchers);
+ filteringaction_free(prop->action);
+ g_free(prop);
}
/*
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;
return FALSE;
if (folder_item_move_msg(dest_folder, info) == -1) {
+ debug_print("*** could not move message\n");
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));
- }
- }
return TRUE;
case MATCHACTION_COPY:
if (folder_item_copy_msg(dest_folder, info) == -1)
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));
- }
- }
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_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);
+ debug_print("*** setting unread flags\n");
+ 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);
+ compose = compose_forward(account, info, FALSE, NULL);
if (compose->account->protocol == A_NNTP)
compose_entry_append(compose, action->destination,
COMPOSE_NEWSGROUPS);
case MATCHACTION_FORWARD_AS_ATTACHMENT:
account = account_find_from_id(action->account_id);
- compose = compose_forward(account, info, TRUE);
+ compose = compose_forward(account, info, TRUE, NULL);
if (compose->account->protocol == A_NNTP)
compose_entry_append(compose, action->destination,
COMPOSE_NEWSGROUPS);
gtk_widget_destroy(compose->window);
return FALSE;
- case MATCHACTION_BOUNCE:
+ 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
return FALSE;
case MATCHACTION_EXECUTE:
- cmd = matching_build_command(action->destination, info);
+ cmd = matching_build_command(action->unesc_destination, info);
if (cmd == NULL)
- return TRUE;
+ return FALSE;
else {
system(cmd);
g_free(cmd);
}
- return FALSE;
+ return TRUE;
+
+ case MATCHACTION_CHANGE_SCORE:
+ /* NOTE:
+ * action->account_id is 0 if just assignment, -1 if decrement
+ * and 1 if increment by action->labelcolor
+ * action->labelcolor has the score value change
+ */
+ info->score = action->account_id == 1 ? info->score + action->labelcolor
+ : action->account_id == -1 ? info->score - action->labelcolor
+ : action->labelcolor;
+ 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)
+static gboolean filtering_match_condition(FilteringProp *filtering, 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);
- }
+ return matcherlist_match(filtering->matchers, info);
+}
- 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:
- return FALSE;
- }
+static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info)
+{
+ gboolean result;
+ gchar buf[50];
+
+ if (FALSE == (result = filteringaction_apply(filtering->action, info))) {
+ g_warning("action %s could not be applied",
+ filteringaction_to_string(buf, sizeof buf, filtering->action));
}
- else
+ return result;
+}
+
+static gboolean filtering_is_final_action(FilteringProp *filtering)
+{
+ 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_REDIRECT:
+ return FALSE; /* MsgInfo still valid for message */
+ default:
return FALSE;
+ }
}
-void filter_msginfo(GSList * filtering_list, MsgInfo * info,
- GHashTable *folder_table)
+static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
+ MsgInfo * info)
{
- GSList *l;
- gboolean result;
- FolderItem *inbox;
+ GSList *l;
+ gboolean final;
+ gboolean applied;
if (info == NULL) {
- g_warning(_("msginfo is not set"));
+ g_warning("msginfo is not set");
return;
}
- for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
+ for (l = filtering_list, final = FALSE, applied = FALSE; 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 (filtering_match_condition(filtering, info)) {
+ applied = filtering_apply_rule(filtering, info);
+ if (TRUE == (final = filtering_is_final_action(filtering)))
+ break;
+ }
+ }
- inbox = folder_get_default_inbox();
- g_assert(inbox);
-
- if (folder_item_move_msg(inbox, info) == -1) {
- debug_print(_("*** Could not drop message in inbox; still in .processing\n"));
- return;
+ /* put in inbox if a final rule could not be applied, or
+ * the last rule was not a final one. */
+ if ((final && !applied) || !final) {
+ if (inbox != info->folder) {
+ if (folder_item_move_msg(inbox, info) == -1) {
+ debug_print("*** Could not drop message in inbox; check .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));
- }
- }
}
}
-void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
- GHashTable *folder_table)
+/*!
+ *\brief filters a message based on its message info data
+ *
+ *\param flist filter and actions list
+ *\param info message
+ */
+void filter_message_by_msginfo_with_inbox(GSList *flist, MsgInfo *info, FolderItem *def_inbox)
{
- GSList * l;
+ FolderItem *inbox;
- 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 ((def_inbox == NULL)) {
+ debug_print("using default inbox as final destination!\n");
+ inbox = folder_get_default_inbox();
+ } else
+ inbox = def_inbox;
+
+ /*
+ * message is already in a folder. the filtering code will
+ * handle duplicate moves and copies.
+ */
+ filter_msginfo(flist, inbox, info);
+}
- switch (filtering->action->type) {
- case MATCHACTION_MOVE:
- case MATCHACTION_DELETE:
- if (filteringprop_apply(filtering, info, folder_table))
- return;
- }
- }
+void filter_message_by_msginfo(GSList *flist, MsgInfo *info)
+{
+ filter_message_by_msginfo_with_inbox(flist, info, info->folder);
}
-void filter_message(GSList * filtering_list, FolderItem * item,
- gint msgnum, GHashTable *folder_table)
+/*!
+ *\brief filters a message waiting to be processed in the
+ * .processing folder.
+ *
+ *\param filtering_list list of filters and actions
+ *\param inbox default inbox when no filter could be applied
+ *\param msgnum message number in processing folder
+ * changed after the call to this function
+ */
+void filter_message(GSList *filtering_list, FolderItem *inbox,
+ gint msgnum)
{
- MsgInfo * msginfo;
- gchar * filename;
+ MsgInfo *msginfo;
+ gchar *filename;
MsgFlags msgflags = { 0, 0 };
+ FolderItem *item = folder_get_default_processing();
if (item == NULL) {
- g_warning(_("folderitem not set"));
+ g_warning("folderitem not set");
return;
}
filename = folder_item_fetch_msg(item, msgnum);
if (filename == NULL) {
- g_warning(_("filename is not set"));
+ g_warning("filename is not set");
return;
}
- msginfo = procheader_parse(filename, msgflags, TRUE);
+ msginfo = procheader_parse_file(filename, msgflags, TRUE, FALSE);
g_free(filename);
if (msginfo == NULL) {
- g_warning(_("could not get info for %s"), filename);
+ g_warning("could not get info for %s", filename);
return;
}
msginfo->folder = item;
msginfo->msgnum = msgnum;
- filter_msginfo(filtering_list, msginfo, folder_table);
+ filter_msginfo(filtering_list, inbox, msginfo);
+
+ procmsg_msginfo_free(msginfo);
}
gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
{
- gchar *command_str;
+ const gchar *command_str;
command_str = get_matchparser_tab_str(action->type);
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);
case MATCHACTION_COLOR:
g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
return dest;
-
default:
return NULL;
}
projects / claws.git / blobdiff