uninitialized filter list when deleting a folder; debug_print some warning if destfol...
[claws.git] / src / filtering.c
index 01a03f7a274f6b6f818ba8557b90663b8e358a4a..bac28cedd907c349dcffbd73626ae04ea33320fd 100644 (file)
 #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)
@@ -51,7 +55,7 @@ static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar
 
 FilteringAction * filteringaction_new(int type, int account_id,
                                      gchar * destination,
-                                     gint labelcolor)
+                                     gint labelcolor, gint score)
 {
        FilteringAction * action;
 
@@ -61,12 +65,11 @@ FilteringAction * filteringaction_new(int type, int account_id,
        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;
 }
 
@@ -75,27 +78,80 @@ 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);
 }
 
 FilteringProp * filteringprop_new(MatcherList * matchers,
-                                 FilteringAction * action)
+                                 GSList * action_list)
 {
        FilteringProp * filtering;
 
        filtering = g_new0(FilteringProp, 1);
        filtering->matchers = matchers;
-       filtering->action = action;
+       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;
+
+        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));
+        }
+
+       return new;
+}
+
 void filteringprop_free(FilteringProp * prop)
 {
+        GSList * tmp;
+
+       g_return_if_fail(prop);
        matcherlist_free(prop->matchers);
-       filteringaction_free(prop->action);
+        
+        for (tmp = prop->action_list ; tmp != NULL ; tmp = tmp->next) {
+                filteringaction_free(tmp->data);
+        }
        g_free(prop);
 }
 
@@ -105,16 +161,7 @@ void filteringprop_free(FilteringProp * 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;
@@ -126,42 +173,32 @@ static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
        case MATCHACTION_MOVE:
                dest_folder =
                        folder_find_item_from_identifier(action->destination);
-               if (!dest_folder)
+               if (!dest_folder) {
+                       debug_print("*** folder not found '%s'\n",
+                               action->destination ?action->destination :"");
                        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) {
-                               g_hash_table_insert(folder_table, dest_folder,
-                                                   GINT_TO_POINTER(1));
-                       }
-               }
                return TRUE;
 
        case MATCHACTION_COPY:
                dest_folder =
                        folder_find_item_from_identifier(action->destination);
 
-               if (!dest_folder)
+               if (!dest_folder) {
+                       debug_print("*** folder not found '%s'\n",
+                               action->destination ?action->destination :"");
                        return FALSE;
+               }
 
                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) {
-                               g_hash_table_insert(folder_table, dest_folder,
-                                                   GINT_TO_POINTER(1));
-                       }
-               }
                return TRUE;
 
        case MATCHACTION_DELETE:
@@ -176,13 +213,20 @@ static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
        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:
-               debug_print("*** setting unread flags\n");
                procmsg_msginfo_set_flags(info, MSG_UNREAD | MSG_NEW, 0);
                return TRUE;
        
@@ -192,42 +236,20 @@ static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
                return TRUE;
 
        case MATCHACTION_FORWARD:
-               account = account_find_from_id(action->account_id);
-               compose = compose_forward(account, info, FALSE, NULL);
-               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, NULL);
-               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;
+
+               return val == 0 ? TRUE : FALSE;
 
        case MATCHACTION_REDIRECT:
                account = account_find_from_id(action->account_id);
@@ -239,16 +261,12 @@ static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
                                             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 {
@@ -257,9 +275,42 @@ static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
                }
                return TRUE;
 
+       case MATCHACTION_SET_SCORE:
+               info->score = action->score;
+               return TRUE;
+
+       case MATCHACTION_ADD_SCORE:
+               info->score += action->score;
+               return TRUE;
+
+       case MATCHACTION_STOP:
+                return TRUE;
+
+       case MATCHACTION_HIDE:
+                info->hidden = TRUE;
+                return TRUE;
+
        default:
-               return FALSE;
+               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)
@@ -267,165 +318,81 @@ static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *inf
        return matcherlist_match(filtering->matchers, info);
 }
 
-static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info, 
-                                    GHashTable *foldertable)
+static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info,
+    gboolean * final)
 {
        gboolean result;
-       gchar    actionstr;
        gchar    buf[50];
-
-       if (FALSE == (result = filteringaction_apply(filtering->action, info, foldertable))) {
-               g_warning(_("action %s could not be applied"), 
-               filteringaction_to_string(buf, sizeof buf, filtering->action));
-       }
+        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("action %s could not be applied", 
+                            filteringaction_to_string(buf, sizeof buf, action));
+                }
+                
+                if (filtering_is_final_action(action)) {
+                        * final = TRUE;
+                        break;
+                }
+        }
        return result;
 }
 
-static gboolean filtering_is_final_action(FilteringProp *filtering)
+static gboolean filtering_is_final_action(FilteringAction *filtering_action)
 {
-       switch(filtering->action->type) {
+       switch(filtering_action->type) {
        case MATCHACTION_MOVE:
        case MATCHACTION_DELETE:
+       case MATCHACTION_STOP:
                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;
        }
 }
 
-static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
-                          MsgInfo * info, GHashTable *folder_table)
+static gboolean filter_msginfo(GSList * filtering_list, MsgInfo * info)
 {
        GSList  *l;
        gboolean final;
        gboolean applied;
-       gint val;
        
-       if (info == NULL) {
-               g_warning(_("msginfo is not set"));
-               return;
-       }
+       g_return_val_if_fail(info != NULL, TRUE);
        
        for (l = filtering_list, final = FALSE, applied = FALSE; l != NULL; l = g_slist_next(l)) {
                FilteringProp * filtering = (FilteringProp *) l->data;
 
                if (filtering_match_condition(filtering, info)) {
-                       applied = filtering_apply_rule(filtering, info, folder_table);
-                       if (TRUE == (final = filtering_is_final_action(filtering)))
-                               break;
+                       applied = 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 && !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));
-                               }
-                       }
-               }       
+               return FALSE;
        }
-}
 
-/*!
- *\brief       filters a message based on its message info data
- *
- *\param       flist filter and actions list
- *\param       info message
- *\param       ftable table with changed folders after call
- */
-void filter_message_by_msginfo_with_inbox(GSList *flist, MsgInfo *info, GHashTable *ftable, FolderItem *def_inbox)
-{
-       FolderItem *inbox;
-
-       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, ftable);
+       return TRUE;
 }
 
-void filter_message_by_msginfo(GSList *flist, MsgInfo *info, GHashTable *ftable)
+gboolean filter_message_by_msginfo(GSList *flist, MsgInfo *info)
 {
-       filter_message_by_msginfo_with_inbox(flist, info, ftable, info->folder);
-}
-
-/*!
- *\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
-  *\param      folder_table table with folders that have been
-  *            changed after the call to this function
-  */
-void filter_message(GSList *filtering_list, FolderItem *inbox,
-                   gint msgnum, GHashTable *folder_table)
-{
-       MsgInfo *msginfo;
-       gchar *filename;
-       MsgFlags  msgflags = { 0, 0 };
-       FolderItem *item = folder_get_default_processing();
-
-       if (item == NULL) {
-               g_warning(_("folderitem not set"));
-               return;
-       }
-
-       filename = folder_item_fetch_msg(item, msgnum);
-
-       if (filename == NULL) {
-               g_warning(_("filename is not set"));
-               return;
-       }
-
-       msginfo = procheader_parse_file(filename, msgflags, TRUE, FALSE);
-       
-       g_free(filename);
-
-       if (msginfo == NULL) {
-               g_warning(_("could not get info for %s"), filename);
-               return;
-       }
-
-       msginfo->folder = item;
-       msginfo->msgnum = msgnum;
-
-       filter_msginfo(filtering_list, inbox, msginfo, folder_table);
-
-       procmsg_msginfo_free(msginfo);
+       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)
@@ -435,52 +402,95 @@ gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *act
        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_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_DELETE_ON_SERVER:
-               g_snprintf(dest, destlen, "%s", command_str);
-               return dest;
+
+       case MATCHACTION_ADD_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;
@@ -500,8 +510,8 @@ static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
 {
        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;
@@ -509,7 +519,7 @@ static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
        return FALSE;
 }
 
-void prefs_filtering_clear()
+void prefs_filtering_clear(void)
 {
        GList * cur;
 
@@ -521,6 +531,21 @@ void prefs_filtering_clear()
                                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? */
+}
+