2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2002 Hiroyuki Yamamoto & The Sylpheed Claws Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #include "procheader.h"
31 #include "filtering.h"
35 #define PREFSBUFSIZE 1024
37 GSList * global_processing = NULL;
39 #define STRLEN_WITH_CHECK(expr) \
40 strlen_with_check(#expr, __LINE__, expr)
42 static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
47 debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
52 FilteringAction * filteringaction_new(int type, int account_id,
56 FilteringAction * action;
58 action = g_new0(FilteringAction, 1);
61 action->account_id = account_id;
63 action->destination = g_strdup(destination);
64 action->unesc_destination = matcher_unescape_str(g_strdup(destination));
66 action->destination = NULL;
67 action->unesc_destination = NULL;
69 action->labelcolor = labelcolor;
73 void filteringaction_free(FilteringAction * action)
75 g_return_if_fail(action);
76 if (action->destination)
77 g_free(action->destination);
78 if (action->unesc_destination)
79 g_free(action->unesc_destination);
83 FilteringProp * filteringprop_new(MatcherList * matchers,
84 FilteringAction * action)
86 FilteringProp * filtering;
88 filtering = g_new0(FilteringProp, 1);
89 filtering->matchers = matchers;
90 filtering->action = action;
95 void filteringprop_free(FilteringProp * prop)
97 matcherlist_free(prop->matchers);
98 filteringaction_free(prop->action);
103 fitleringaction_apply
104 runs the action on one MsgInfo
105 return value : return TRUE if the action could be applied
108 #define CHANGE_FLAGS(msginfo) \
110 if (msginfo->folder->folder->change_flags != NULL) \
111 msginfo->folder->folder->change_flags(msginfo->folder->folder, \
116 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
117 GHashTable *folder_table)
119 FolderItem * dest_folder;
122 PrefsAccount * account;
125 switch(action->type) {
126 case MATCHACTION_MOVE:
128 folder_find_item_from_identifier(action->destination);
132 if (folder_item_move_msg(dest_folder, info) == -1) {
133 debug_print("*** could not move message\n");
138 val = GPOINTER_TO_INT(g_hash_table_lookup
139 (folder_table, dest_folder));
141 g_hash_table_insert(folder_table, dest_folder,
147 case MATCHACTION_COPY:
149 folder_find_item_from_identifier(action->destination);
154 if (folder_item_copy_msg(dest_folder, info) == -1)
158 val = GPOINTER_TO_INT(g_hash_table_lookup
159 (folder_table, dest_folder));
161 g_hash_table_insert(folder_table, dest_folder,
167 case MATCHACTION_DELETE:
168 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
172 case MATCHACTION_MARK:
173 MSG_SET_PERM_FLAGS(info->flags, MSG_MARKED);
176 case MATCHACTION_UNMARK:
177 MSG_UNSET_PERM_FLAGS(info->flags, MSG_MARKED);
180 case MATCHACTION_MARK_AS_READ:
181 MSG_UNSET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
184 case MATCHACTION_MARK_AS_UNREAD:
185 debug_print("*** setting unread flags\n");
186 MSG_SET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
189 case MATCHACTION_COLOR:
190 MSG_UNSET_PERM_FLAGS(info->flags, MSG_CLABEL_FLAG_MASK);
191 MSG_SET_COLORLABEL_VALUE(info->flags, action->labelcolor);
194 case MATCHACTION_FORWARD:
195 account = account_find_from_id(action->account_id);
196 compose = compose_forward(account, info, FALSE, NULL);
197 if (compose->account->protocol == A_NNTP)
198 compose_entry_append(compose, action->destination,
201 compose_entry_append(compose, action->destination,
204 val = compose_send(compose);
206 gtk_widget_destroy(compose->window);
210 gtk_widget_destroy(compose->window);
213 case MATCHACTION_FORWARD_AS_ATTACHMENT:
215 account = account_find_from_id(action->account_id);
216 compose = compose_forward(account, info, TRUE, NULL);
217 if (compose->account->protocol == A_NNTP)
218 compose_entry_append(compose, action->destination,
221 compose_entry_append(compose, action->destination,
224 val = compose_send(compose);
226 gtk_widget_destroy(compose->window);
229 gtk_widget_destroy(compose->window);
232 case MATCHACTION_REDIRECT:
233 account = account_find_from_id(action->account_id);
234 compose = compose_redirect(account, info);
235 if (compose->account->protocol == A_NNTP)
238 compose_entry_append(compose, action->destination,
241 val = compose_send(compose);
243 gtk_widget_destroy(compose->window);
247 gtk_widget_destroy(compose->window);
250 case MATCHACTION_EXECUTE:
251 cmd = matching_build_command(action->unesc_destination, info);
265 static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
267 return matcherlist_match(filtering->matchers, info);
270 static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
271 GHashTable *foldertable)
277 if (FALSE == (result = filteringaction_apply(filtering->action, info, foldertable))) {
278 g_warning(_("action %s could not be applied"),
279 filteringaction_to_string(buf, sizeof buf, filtering->action));
284 static gboolean filtering_is_final_action(FilteringProp *filtering)
286 switch(filtering->action->type) {
287 case MATCHACTION_MOVE:
288 case MATCHACTION_DELETE:
289 return TRUE; /* MsgInfo invalid for message */
290 case MATCHACTION_EXECUTE:
291 case MATCHACTION_COPY:
292 case MATCHACTION_MARK:
293 case MATCHACTION_MARK_AS_READ:
294 case MATCHACTION_UNMARK:
295 case MATCHACTION_MARK_AS_UNREAD:
296 case MATCHACTION_FORWARD:
297 case MATCHACTION_FORWARD_AS_ATTACHMENT:
298 case MATCHACTION_REDIRECT:
299 return FALSE; /* MsgInfo still valid for message */
305 static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
306 MsgInfo * info, GHashTable *folder_table)
314 g_warning(_("msginfo is not set"));
318 for (l = filtering_list, final = FALSE, applied = FALSE; l != NULL; l = g_slist_next(l)) {
319 FilteringProp * filtering = (FilteringProp *) l->data;
321 if (filtering_match_condition(filtering, info)) {
322 applied = filtering_apply_rule(filtering, info, folder_table);
323 if (TRUE == (final = filtering_is_final_action(filtering)))
328 /* put in inbox if a final rule could not be applied, or
329 * the last rule was not a final one. */
330 if ((final && !applied) || !final) {
331 if (inbox != info->folder) {
332 if (folder_item_move_msg(inbox, info) == -1) {
333 debug_print(_("*** Could not drop message in inbox; check .processing\n"));
337 val = GPOINTER_TO_INT(g_hash_table_lookup
338 (folder_table, inbox));
340 folder_item_scan(inbox);
341 g_hash_table_insert(folder_table, inbox,
350 *\brief filters a message based on its message info data
352 *\param flist filter and actions list
354 *\param ftable table with changed folders after call
356 void filter_message_by_msginfo_with_inbox(GSList *flist, MsgInfo *info, GHashTable *ftable, FolderItem *def_inbox)
360 if ((def_inbox == NULL)) {
361 debug_print("using default inbox as final destination!\n");
362 inbox = folder_get_default_inbox();
367 * message is already in a folder. the filtering code will
368 * handle duplicate moves and copies.
370 filter_msginfo(flist, inbox, info, ftable);
373 void filter_message_by_msginfo(GSList *flist, MsgInfo *info, GHashTable *ftable)
375 filter_message_by_msginfo_with_inbox(flist, info, ftable, info->folder);
379 *\brief filters a message waiting to be processed in the
380 * .processing folder.
382 *\param filtering_list list of filters and actions
383 *\param inbox default inbox when no filter could be applied
384 *\param msgnum message number in processing folder
385 *\param folder_table table with folders that have been
386 * changed after the call to this function
388 void filter_message(GSList *filtering_list, FolderItem *inbox,
389 gint msgnum, GHashTable *folder_table)
393 MsgFlags msgflags = { 0, 0 };
394 FolderItem *item = folder_get_default_processing();
397 g_warning(_("folderitem not set"));
401 filename = folder_item_fetch_msg(item, msgnum);
403 if (filename == NULL) {
404 g_warning(_("filename is not set"));
408 msginfo = procheader_parse_file(filename, msgflags, TRUE, FALSE);
412 if (msginfo == NULL) {
413 g_warning(_("could not get info for %s"), filename);
417 msginfo->folder = item;
418 msginfo->msgnum = msgnum;
420 filter_msginfo(filtering_list, inbox, msginfo, folder_table);
422 procmsg_msginfo_free(msginfo);
425 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
429 command_str = get_matchparser_tab_str(action->type);
431 if (command_str == NULL)
434 switch(action->type) {
435 case MATCHACTION_MOVE:
436 case MATCHACTION_COPY:
437 case MATCHACTION_EXECUTE:
438 g_snprintf(dest, destlen, "%s \"%s\"", command_str, action->destination);
441 case MATCHACTION_DELETE:
442 case MATCHACTION_MARK:
443 case MATCHACTION_UNMARK:
444 case MATCHACTION_MARK_AS_READ:
445 case MATCHACTION_MARK_AS_UNREAD:
446 g_snprintf(dest, destlen, "%s", command_str);
449 case MATCHACTION_REDIRECT:
450 case MATCHACTION_FORWARD:
451 case MATCHACTION_FORWARD_AS_ATTACHMENT:
452 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, action->destination);
455 case MATCHACTION_COLOR:
456 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
458 case MATCHACTION_DELETE_ON_SERVER:
459 g_snprintf(dest, destlen, "%s", command_str);
466 gchar * filteringprop_to_string(FilteringProp * prop)
470 gchar *filtering_str;
473 action_str = filteringaction_to_string(buf, sizeof buf, prop->action);
475 if (action_str == NULL)
478 list_str = matcherlist_to_string(prop->matchers);
480 if (list_str == NULL)
483 filtering_str = g_strconcat(list_str, " ", action_str, NULL);
486 return filtering_str;
489 void prefs_filtering_free(GSList * prefs_filtering)
491 while (prefs_filtering != NULL) {
492 FilteringProp * filtering = (FilteringProp *)
493 prefs_filtering->data;
494 filteringprop_free(filtering);
495 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
499 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
501 FolderItem *item = node->data;
506 prefs_filtering_free(item->prefs->processing);
507 item->prefs->processing = NULL;
512 void prefs_filtering_clear()
516 for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
519 folder = (Folder *) cur->data;
520 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
521 prefs_filtering_free_func, NULL);
524 prefs_filtering_free(global_processing);
525 global_processing = NULL;