+/*
+ * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 1999-2001 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
+ * 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., 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 <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 "matcher.h"
#include "filtering.h"
#include "prefs.h"
+#include "compose.h"
#define PREFSBUFSIZE 1024
switch (key) {
case MATCHING_ACTION_MOVE:
- destination = matcher_parse_str(&tmp);
- if (tmp == NULL) {
- * str = NULL;
- return NULL;
- }
- break;
case MATCHING_ACTION_COPY:
+ case MATCHING_EXECUTE:
destination = matcher_parse_str(&tmp);
if (tmp == NULL) {
* str = NULL;
case MATCHING_ACTION_MARK_AS_UNREAD:
break;
case MATCHING_ACTION_FORWARD:
- 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 MATCHING_ACTION_FORWARD_AS_ATTACHEMENT:
+ case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
account_id = matcher_parse_number(&tmp);
if (tmp == NULL) {
* str = NULL;
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;
- dest_path = folder_item_get_path(info->folder);
- if (dest_path == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return FALSE;
+ 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;
+}
- if ((fp = procmsg_open_mark_file(dest_path, TRUE))
- == NULL) {
- g_warning(_("Can't open mark file.\n"));
- return FALSE;
+static gchar * filteringaction_execute_command(gchar * cmd, MsgInfo * info)
+{
+ gchar * s = cmd;
+ gchar * filename = NULL;
+ gchar * processed_cmd;
+ gchar * p;
+ gint size;
+
+ size = strlen(cmd) + 1;
+ while (*s != '\0') {
+ if (*s == '%') {
+ s++;
+ switch (*s) {
+ case '%':
+ size -= 1;
+ break;
+ case 's': /* subject */
+ size += strlen(info->subject) - 2;
+ break;
+ case 'f': /* from */
+ size += strlen(info->from) - 2;
+ break;
+ case 't': /* to */
+ size += strlen(info->to) - 2;
+ break;
+ case 'c': /* cc */
+ size += strlen(info->cc) - 2;
+ break;
+ case 'd': /* date */
+ size += strlen(info->date) - 2;
+ break;
+ case 'i': /* message-id */
+ size += strlen(info->msgid) - 2;
+ break;
+ case 'n': /* newsgroups */
+ size += strlen(info->newsgroups) - 2;
+ break;
+ case 'r': /* references */
+ size += strlen(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++;
}
- procmsg_write_flags(info, fp);
- fclose(fp);
- return TRUE;
+
+ 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;
}
/*
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)
{
FolderItem * dest_folder;
gint val;
+ Compose * compose;
+ PrefsAccount * account;
+ gchar * cmd;
switch(action->type) {
case MATCHING_ACTION_MOVE:
- dest_folder = folder_find_item_from_path(action->destination);
+ dest_folder =
+ folder_find_item_from_identifier(action->destination);
if (!dest_folder)
return FALSE;
if (folder_item_move_msg(dest_folder, info) == -1)
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);
+ */
- 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));
+ 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));
+ }
}
return TRUE;
case MATCHING_ACTION_COPY:
- dest_folder = folder_find_item_from_path(action->destination);
+ dest_folder =
+ folder_find_item_from_identifier(action->destination);
+
if (!dest_folder)
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. */
+
if (folder_item_copy_msg(dest_folder, info) == -1)
return FALSE;
- 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));
+ 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 MATCHING_ACTION_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);
+ */
return TRUE;
MSG_SET_FLAGS(info->flags, MSG_MARKED);
filteringaction_update_mark(info);
+ CHANGE_FLAGS(info);
+
return TRUE;
case MATCHING_ACTION_UNMARK:
MSG_UNSET_FLAGS(info->flags, MSG_MARKED);
filteringaction_update_mark(info);
+ CHANGE_FLAGS(info);
+
return TRUE;
case MATCHING_ACTION_MARK_AS_READ:
MSG_UNSET_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
filteringaction_update_mark(info);
+ CHANGE_FLAGS(info);
+
return TRUE;
case MATCHING_ACTION_MARK_AS_UNREAD:
MSG_SET_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
filteringaction_update_mark(info);
+ CHANGE_FLAGS(info);
+
return TRUE;
case MATCHING_ACTION_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 MATCHING_ACTION_FORWARD_AS_ATTACHEMENT:
+ case MATCHING_ACTION_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);
+
+ val = compose_send(compose);
+ if (val == 0) {
+ gtk_widget_destroy(compose->window);
+ return TRUE;
+ }
+ gtk_widget_destroy(compose->window);
return FALSE;
+ case MATCHING_EXECUTE:
+
+ cmd = matching_build_command(action->destination, info);
+ if (cmd == NULL)
+ return TRUE;
+ else {
+ system(cmd);
+ g_free(cmd);
+ }
+
+ return TRUE;
+
default:
return FALSE;
}
}
-/*
- filteringprop_apply
- runs the action on one MsgInfo if it matches the criterium
- return value : return TRUE if the action doesn't allow more actions
-*/
-
+/* 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)
{
switch(filtering->action->type) {
case MATCHING_ACTION_MOVE:
case MATCHING_ACTION_DELETE:
- return TRUE;
+ return TRUE; /* MsgInfo invalid for message */
+ case MATCHING_EXECUTE:
case MATCHING_ACTION_COPY:
case MATCHING_ACTION_MARK:
case MATCHING_ACTION_MARK_AS_READ:
case MATCHING_ACTION_UNMARK:
case MATCHING_ACTION_MARK_AS_UNREAD:
case MATCHING_ACTION_FORWARD:
- case MATCHING_ACTION_FORWARD_AS_ATTACHEMENT:
- return FALSE;
+ case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
+ return FALSE; /* MsgInfo still valid for message */
default:
return FALSE;
}
}
}
+void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
+ GHashTable *folder_table)
+{
+ 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 MATCHING_ACTION_MOVE:
+ case MATCHING_ACTION_DELETE:
+ if (filteringprop_apply(filtering, info, folder_table))
+ return;
+ }
+ }
+}
+
void filter_message(GSList * filtering_list, FolderItem * item,
gint msgnum, GHashTable *folder_table)
{
switch(action->type) {
case MATCHING_ACTION_MOVE:
case MATCHING_ACTION_COPY:
+ case MATCHING_EXECUTE:
return g_strconcat(command_str, " \"", action->destination,
"\"", NULL);
break;
case MATCHING_ACTION_FORWARD:
- case MATCHING_ACTION_FORWARD_AS_ATTACHEMENT:
+ case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
account_id_str = itos(action->account_id);
return g_strconcat(command_str, " ", account_id_str,
" \"", action->destination, "\"", NULL);
projects / claws.git / blobdiff