src/filtering.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2001 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);
 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);
 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 /* filteringprop_apply() - runs the action on one MsgInfo if it matches the
 266  * criterium. certain actions can be followed by other actions. in this
 267  * case the function returns FALSE. if an action can not be followed
 268  * by others, the function returns TRUE. */
 269 static gboolean filteringprop_apply(FilteringProp * filtering, MsgInfo * info,
 270                                     GHashTable *folder_table)
 271 {
 272         if (matcherlist_match(filtering->matchers, info)) {
 273                 gboolean result;
 274                 gchar   *action_str;
 275                 gchar    buf[256];
 276
 277                 if (FALSE == (result = filteringaction_apply(filtering->action, info,
 278                                                folder_table))) {
 279                         action_str = filteringaction_to_string(buf, sizeof buf, filtering->action);
 280                         g_warning(_("action %s could not be applied"), action_str);
 281                 }
 282
 283                 switch(filtering->action->type) {
 284                 case MATCHACTION_MOVE:
 285                 case MATCHACTION_DELETE:
 286                         return TRUE; /* MsgInfo invalid for message */
 287                 case MATCHACTION_EXECUTE:
 288                 case MATCHACTION_COPY:
 289                 case MATCHACTION_MARK:
 290                 case MATCHACTION_MARK_AS_READ:
 291                 case MATCHACTION_UNMARK:
 292                 case MATCHACTION_MARK_AS_UNREAD:
 293                 case MATCHACTION_FORWARD:
 294                 case MATCHACTION_FORWARD_AS_ATTACHMENT:
 295                 case MATCHACTION_BOUNCE:
 296                         return FALSE; /* MsgInfo still valid for message */
 297                 default:
 298                         return FALSE;
 299                 }
 300         }
 301         else
 302                 return FALSE;
 303 }
 304
 305 static void filter_msginfo(GSList * filtering_list, FolderItem *inbox,
 306                            MsgInfo * info, GHashTable *folder_table)
 307 {
 308         GSList          *l;
 309         gboolean         result;
 310
 311         if (info == NULL) {
 312                 g_warning(_("msginfo is not set"));
 313                 return;
 314         }
 315
 316         for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
 317                 FilteringProp * filtering = (FilteringProp *) l->data;
 318                 if (TRUE == (result = filteringprop_apply(filtering, info, folder_table)))
 319                         break;
 320         }
 321
 322         /* drop in inbox too */
 323         if (!result) {
 324                 gint val;
 325
 326                 if (folder_item_move_msg(inbox, info) == -1) {
 327                         debug_print(_("*** Could not drop message in inbox; still in .processing\n"));
 328                         return;
 329                 }
 330
 331                 if (folder_table) {
 332                         val = GPOINTER_TO_INT(g_hash_table_lookup
 333                                               (folder_table, inbox));
 334                         if (val == 0) {
 335                                 folder_item_scan(inbox);
 336                                 g_hash_table_insert(folder_table, inbox,
 337                                                     GINT_TO_POINTER(1));
 338                         }
 339                 }
 340         }
 341 }
 342
 343 void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
 344                                    GHashTable *folder_table)
 345 {
 346         GSList * l;
 347
 348         if (info == NULL) {
 349                 g_warning(_("msginfo is not set"));
 350                 return;
 351         }
 352
 353         for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
 354                 FilteringProp * filtering = (FilteringProp *) l->data;
 355
 356                 switch (filtering->action->type) {
 357                 case MATCHACTION_MOVE:
 358                 case MATCHACTION_DELETE:
 359                         if (filteringprop_apply(filtering, info, folder_table))
 360                                 return;
 361                 }
 362         }
 363 }
 364
 365 void filter_message(GSList *filtering_list, FolderItem *inbox,
 366                     gint msgnum, GHashTable *folder_table)
 367 {
 368         MsgInfo *msginfo;
 369         gchar *filename;
 370         MsgFlags  msgflags = { 0, 0 };
 371         FolderItem *item = folder_get_default_processing();
 372
 373         if (item == NULL) {
 374                 g_warning(_("folderitem not set"));
 375                 return;
 376         }
 377
 378         filename = folder_item_fetch_msg(item, msgnum);
 379
 380         if (filename == NULL) {
 381                 g_warning(_("filename is not set"));
 382                 return;
 383         }
 384
 385         msginfo = procheader_parse(filename, msgflags, TRUE);
 386
 387         g_free(filename);
 388
 389         if (msginfo == NULL) {
 390                 g_warning(_("could not get info for %s"), filename);
 391                 return;
 392         }
 393
 394         msginfo->folder = item;
 395         msginfo->msgnum = msgnum;
 396
 397         filter_msginfo(filtering_list, inbox, msginfo, folder_table);
 398 }
 399
 400 gchar *filteringaction_to_string(gchar *dest, gint destlen, FilteringAction *action)
 401 {
 402         gchar *command_str;
 403
 404         command_str = get_matchparser_tab_str(action->type);
 405
 406         if (command_str == NULL)
 407                 return NULL;
 408
 409         switch(action->type) {
 410         case MATCHACTION_MOVE:
 411         case MATCHACTION_COPY:
 412         case MATCHACTION_EXECUTE:
 413                 g_snprintf(dest, destlen, "%s \"%s\"", command_str, action->destination);
 414                 return dest;
 415
 416         case MATCHACTION_DELETE:
 417         case MATCHACTION_MARK:
 418         case MATCHACTION_UNMARK:
 419         case MATCHACTION_MARK_AS_READ:
 420         case MATCHACTION_MARK_AS_UNREAD:
 421                 g_snprintf(dest, destlen, "%s", command_str);
 422                 return dest;
 423
 424         case MATCHACTION_BOUNCE:
 425         case MATCHACTION_FORWARD:
 426         case MATCHACTION_FORWARD_AS_ATTACHMENT:
 427                 g_snprintf(dest, destlen, "%s %d \"%s\"", command_str, action->account_id, action->destination);
 428                 return dest;
 429
 430         case MATCHACTION_COLOR:
 431                 g_snprintf(dest, destlen, "%s %d", command_str, action->labelcolor);
 432                 return dest;
 433
 434         default:
 435                 return NULL;
 436         }
 437 }
 438
 439 gchar * filteringprop_to_string(FilteringProp * prop)
 440 {
 441         gchar *list_str;
 442         gchar *action_str;
 443         gchar *filtering_str;
 444         gchar  buf[256];
 445
 446         action_str = filteringaction_to_string(buf, sizeof buf, prop->action);
 447
 448         if (action_str == NULL)
 449                 return NULL;
 450
 451         list_str = matcherlist_to_string(prop->matchers);
 452
 453         if (list_str == NULL)
 454                 return NULL;
 455
 456         filtering_str = g_strconcat(list_str, " ", action_str, NULL);
 457         g_free(list_str);
 458
 459         return filtering_str;
 460 }
 461
 462 void prefs_filtering_free(GSList * prefs_filtering)
 463 {
 464         while (prefs_filtering != NULL) {
 465                 FilteringProp * filtering = (FilteringProp *)
 466                         prefs_filtering->data;
 467                 filteringprop_free(filtering);
 468                 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
 469         }
 470 }
 471
 472 static gboolean prefs_filtering_free_func(GNode *node, gpointer data)
 473 {
 474         FolderItem *item = node->data;
 475
 476         if(!item->prefs)
 477                 return FALSE;
 478
 479         prefs_filtering_free(item->prefs->processing);
 480         item->prefs->processing = NULL;
 481
 482         return FALSE;
 483 }
 484
 485 void prefs_filtering_clear()
 486 {
 487         GList * cur;
 488
 489         for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
 490                 Folder *folder;
 491
 492                 folder = (Folder *) cur->data;
 493                 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
 494                                 prefs_filtering_free_func, NULL);
 495         }
 496
 497         prefs_filtering_free(global_processing);
 498         global_processing = NULL;
 499 }