add 'Selective download'
[claws.git] / src / filtering.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2002 Hiroyuki Yamamoto & The Sylpheed Claws Team
4  *
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.
9  *
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.
14  *
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.
18  */
19
20 #include "defs.h"
21 #include <ctype.h>
22 #include <string.h>
23 #include <stdlib.h>
24 #include <errno.h>
25 #include <gtk/gtk.h>
26 #include <stdio.h>
27 #include "intl.h"
28 #include "utils.h"
29 #include "procheader.h"
30 #include "matcher.h"
31 #include "filtering.h"
32 #include "prefs.h"
33 #include "compose.h"
34
35 #define PREFSBUFSIZE            1024
36
37 GSList * global_processing = NULL;
38
39 #define STRLEN_WITH_CHECK(expr) \
40         strlen_with_check(#expr, __LINE__, expr)
41                 
42 static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
43 {
44         if (str) 
45                 return strlen(str);
46         else {
47                 debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
48                 return 0;
49         }
50 }
51
52 FilteringAction * filteringaction_new(int type, int account_id,
53                                       gchar * destination,
54                                       gint labelcolor)
55 {
56         FilteringAction * action;
57
58         action = g_new0(FilteringAction, 1);
59
60         action->type = type;
61         action->account_id = account_id;
62         if (destination) {
63                 action->destination       = g_strdup(destination);
64                 action->unesc_destination = matcher_unescape_str(g_strdup(destination));
65         } else {
66                 action->destination       = NULL;
67                 action->unesc_destination = NULL;
68         }
69         action->labelcolor = labelcolor;        
70         return action;
71 }
72
73 void filteringaction_free(FilteringAction * action)
74 {
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);
80         g_free(action);
81 }
82
83 FilteringProp * filteringprop_new(MatcherList * matchers,
84                                   FilteringAction * action)
85 {
86         FilteringProp * filtering;
87
88         filtering = g_new0(FilteringProp, 1);
89         filtering->matchers = matchers;
90         filtering->action = action;
91
92         return filtering;
93 }
94
95 void filteringprop_free(FilteringProp * prop)
96 {
97         matcherlist_free(prop->matchers);
98         filteringaction_free(prop->action);
99         g_free(prop);
100 }
101
102 /*
103   fitleringaction_apply
104   runs the action on one MsgInfo
105   return value : return TRUE if the action could be applied
106 */
107
108 #define CHANGE_FLAGS(msginfo) \
109 { \
110 if (msginfo->folder->folder->change_flags != NULL) \
111 msginfo->folder->folder->change_flags(msginfo->folder->folder, \
112                                       msginfo->folder, \
113                                       msginfo); \
114 }
115
116 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
117                                       GHashTable *folder_table)
118 {
119         FolderItem * dest_folder;
120         gint val;
121         Compose * compose;
122         PrefsAccount * account;
123         gchar * cmd;
124
125         switch(action->type) {
126         case MATCHACTION_MOVE:
127                 dest_folder =
128                         folder_find_item_from_identifier(action->destination);
129                 if (!dest_folder)
130                         return FALSE;
131                 
132                 if (folder_item_move_msg(dest_folder, info) == -1) {
133                         debug_print("*** could not move message\n");
134                         return FALSE;
135                 }       
136
137                 if (folder_table) {
138                         val = GPOINTER_TO_INT(g_hash_table_lookup
139                                               (folder_table, dest_folder));
140                         if (val == 0) {
141                                 folder_item_scan(dest_folder);
142                                 g_hash_table_insert(folder_table, dest_folder,
143                                                     GINT_TO_POINTER(1));
144                         }
145                 }
146                 return TRUE;
147
148         case MATCHACTION_COPY:
149                 dest_folder =
150                         folder_find_item_from_identifier(action->destination);
151
152                 if (!dest_folder)
153                         return FALSE;
154
155                 if (folder_item_copy_msg(dest_folder, info) == -1)
156                         return FALSE;
157
158                 if (folder_table) {
159                         val = GPOINTER_TO_INT(g_hash_table_lookup
160                                               (folder_table, dest_folder));
161                         if (val == 0) {
162                                 folder_item_scan(dest_folder);
163                                 g_hash_table_insert(folder_table, dest_folder,
164                                                     GINT_TO_POINTER(1));
165                         }
166                 }
167                 return TRUE;
168
169         case MATCHACTION_DELETE:
170                 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
171                         return FALSE;
172                 return TRUE;
173
174         case MATCHACTION_MARK:
175                 MSG_SET_PERM_FLAGS(info->flags, MSG_MARKED);
176                 return TRUE;
177
178         case MATCHACTION_UNMARK:
179                 MSG_UNSET_PERM_FLAGS(info->flags, MSG_MARKED);
180                 return TRUE;
181                 
182         case MATCHACTION_MARK_AS_READ:
183                 MSG_UNSET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
184                 return TRUE;
185
186         case MATCHACTION_MARK_AS_UNREAD:
187                 MSG_SET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
188                 return TRUE;
189         
190         case MATCHACTION_COLOR:
191                 MSG_SET_COLORLABEL_VALUE(info->flags, action->labelcolor);
192                 return TRUE;
193
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,
199                                              COMPOSE_NEWSGROUPS);
200                 else
201                         compose_entry_append(compose, action->destination,
202                                              COMPOSE_TO);
203
204                 val = compose_send(compose);
205                 if (val == 0) {
206                         gtk_widget_destroy(compose->window);
207                         return TRUE;
208                 }
209
210                 gtk_widget_destroy(compose->window);
211                 return FALSE;
212
213         case MATCHACTION_FORWARD_AS_ATTACHMENT:
214
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,
219                                              COMPOSE_NEWSGROUPS);
220                 else
221                         compose_entry_append(compose, action->destination,
222                                              COMPOSE_TO);
223
224                 val = compose_send(compose);
225                 if (val == 0) {
226                         gtk_widget_destroy(compose->window);
227                         return TRUE;
228                 }
229                 gtk_widget_destroy(compose->window);
230                 return FALSE;
231
232         case MATCHACTION_BOUNCE:
233                 account = account_find_from_id(action->account_id);
234                 compose = compose_bounce(account, info);
235                 if (compose->account->protocol == A_NNTP)
236                         break;
237                 else
238                         compose_entry_append(compose, action->destination,
239                                              COMPOSE_TO);
240
241                 val = compose_send(compose);
242                 if (val == 0) {
243                         gtk_widget_destroy(compose->window);
244                         return TRUE;
245                 }
246
247                 gtk_widget_destroy(compose->window);
248                 return FALSE;
249
250         case MATCHACTION_EXECUTE:
251                 cmd = matching_build_command(action->unesc_destination, info);
252                 if (cmd == NULL)
253                         return FALSE;
254                 else {
255                         system(cmd);
256                         g_free(cmd);
257                 }
258                 return TRUE;
259
260         default:
261                 return FALSE;
262         }
263 }
264
265 static gboolean filtering_match_condition(FilteringProp *filtering, MsgInfo *info)
266 {
267         return matcherlist_match(filtering->matchers, info);
268 }
269
270 static gboolean filtering_apply_rule(FilteringProp *filtering, MsgInfo *info, 
271                                      GHashTable *foldertable)
272 {
273         gboolean result;
274         gchar    actionstr;
275         gchar    buf[50];
276
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));
280         }
281         return result;
282 }
283
284 static gboolean filtering_is_final_action(FilteringProp *filtering)
285 {
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_BOUNCE:
299                 return FALSE; /* MsgInfo still valid for message */
300         default:
301                 return FALSE;
302         }
303 }
304
305 static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
306                            MsgInfo * info, GHashTable *folder_table)
307 {
308         GSList  *l;
309         gboolean final;
310         gboolean applied;
311         gint val;
312         
313         if (info == NULL) {
314                 g_warning(_("msginfo is not set"));
315                 return;
316         }
317         
318         for (l = filtering_list, final = FALSE, applied = FALSE; l != NULL; l = g_slist_next(l)) {
319                 FilteringProp * filtering = (FilteringProp *) l->data;
320
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)))
324                                 break;
325                 }               
326         }
327
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 (folder_item_move_msg(inbox, info) == -1) {
332                         debug_print(_("*** Could not drop message in inbox; still in .processing\n"));
333                         return;
334                 }       
335                 if (folder_table) {
336                         val = GPOINTER_TO_INT(g_hash_table_lookup
337                                               (folder_table, inbox));
338                         if (val == 0) {
339                                 folder_item_scan(inbox);
340                                 g_hash_table_insert(folder_table, inbox,
341                                                     GINT_TO_POINTER(1));
342                         }
343                 }
344         }
345 }
346
347 void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
348                                    GHashTable *folder_table)
349 {
350         GSList * l;
351
352         if (info == NULL) {
353                 g_warning(_("msginfo is not set"));
354                 return;
355         }
356         
357         for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
358                 FilteringProp * filtering = (FilteringProp *) l->data;
359
360                 switch (filtering->action->type) {
361                 case MATCHACTION_MOVE:
362                 case MATCHACTION_DELETE:
363                         if (filtering_match_condition(filtering, info) &&
364                             filtering_apply_rule(filtering, info, folder_table))
365                                 return;
366                 }
367         }
368 }
369
370 void filter_message(GSList *filtering_list, FolderItem *inbox,
371                     gint msgnum, GHashTable *folder_table)
372 {
373         MsgInfo *msginfo;
374         gchar *filename;
375         MsgFlags  msgflags = { 0, 0 };
376         FolderItem *item = folder_get_default_processing();
377
378         if (item == NULL) {
379                 g_warning(_("folderitem not set"));
380                 return;
381         }
382
383         filename = folder_item_fetch_msg(item, msgnum);
384
385         if (filename == NULL) {
386                 g_warning(_("filename is not set"));
387                 return;
388         }
389
390         msginfo = procheader_parse(filename, msgflags, TRUE, FALSE);
391         
392         g_free(filename);
393
394         if (msginfo == NULL) {
395                 g_warning(_("could not get info for %s"), filename);
396                 return;
397         }
398
399         msginfo->folder = item;
400         msginfo->msgnum = msgnum;
401
402         filter_msginfo(filtering_list, inbox, msginfo, folder_table);
403
404         procmsg_msginfo_free(msginfo);
405 }
406
407 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
408 {
409         gchar *command_str;
410
411         command_str = get_matchparser_tab_str(action->type);
412
413         if (command_str == NULL)
414                 return NULL;
415
416         switch(action->type) {
417         case MATCHACTION_MOVE:
418         case MATCHACTION_COPY:
419         case MATCHACTION_EXECUTE:
420                 g_snprintf(dest, destlen, "%s \"%s\"", command_str, action->destination);
421                 return dest;
422
423         case MATCHACTION_DELETE:
424         case MATCHACTION_MARK:
425         case MATCHACTION_UNMARK:
426         case MATCHACTION_MARK_AS_READ:
427         case MATCHACTION_MARK_AS_UNREAD:
428                 g_snprintf(dest, destlen, "%s", command_str);
429                 return dest;
430
431         case MATCHACTION_BOUNCE:
432         case MATCHACTION_FORWARD:
433         case MATCHACTION_FORWARD_AS_ATTACHMENT:
434                 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, action->destination); 
435                 return dest; 
436
437         case MATCHACTION_COLOR:
438                 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
439                 return dest;  
440         case MATCHACTION_DELETE_ON_SERVER:
441                 g_snprintf(dest, destlen, "%s", command_str);
442                 return dest;
443         default:
444                 return NULL;
445         }
446 }
447
448 gchar * filteringprop_to_string(FilteringProp * prop)
449 {
450         gchar *list_str;
451         gchar *action_str;
452         gchar *filtering_str;
453         gchar  buf[256];
454
455         action_str = filteringaction_to_string(buf, sizeof buf, prop->action);
456
457         if (action_str == NULL)
458                 return NULL;
459
460         list_str = matcherlist_to_string(prop->matchers);
461
462         if (list_str == NULL)
463                 return NULL;
464
465         filtering_str = g_strconcat(list_str, " ", action_str, NULL);
466         g_free(list_str);
467
468         return filtering_str;
469 }
470
471 void prefs_filtering_free(GSList * prefs_filtering)
472 {
473         while (prefs_filtering != NULL) {
474                 FilteringProp * filtering = (FilteringProp *)
475                         prefs_filtering->data;
476                 filteringprop_free(filtering);
477                 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
478         }
479 }
480
481 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
482 {
483         FolderItem *item = node->data;
484
485         if(!item->prefs)
486                 return FALSE;
487
488         prefs_filtering_free(item->prefs->processing);
489         item->prefs->processing = NULL;
490
491         return FALSE;
492 }
493
494 void prefs_filtering_clear()
495 {
496         GList * cur;
497
498         for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
499                 Folder *folder;
500
501                 folder = (Folder *) cur->data;
502                 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
503                                 prefs_filtering_free_func, NULL);
504         }
505
506         prefs_filtering_free(global_processing);
507         global_processing = NULL;
508 }