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 /*
  21  * initital     Hoa             initial
  22  * 07/16/01     Alfons          fix bugs
  23  * 07/18/01     Alfons          rewrite things
  24  */
  25
  26 /* 07/18/01 (alfons)
  27  *
  28  * filter_message() is no longer the entry point for filtering. it's
  29  * replaced with filter_incoming_message() which does not trust
  30  * on MsgInfo's from a folder. instead it directly works with
  31  * the temporary file.
  32  * updating the mark file is a lot easier now, because we can do that
  33  * right after a call to folder_item_add_msg().
  34  */
  35
  36 #include "defs.h"
  37 #include <ctype.h>
  38 #include <string.h>
  39 #include <stdlib.h>
  40 #include <errno.h>
  41 #include <gtk/gtk.h>
  42 #include <stdio.h>
  43 #include "intl.h"
  44 #include "utils.h"
  45 #include "procheader.h"
  46 #include "matcher.h"
  47 #include "filtering.h"
  48 #include "prefs.h"
  49 #include "compose.h"
  50
  51 #define PREFSBUFSIZE            1024
  52
  53 GSList * prefs_filtering = NULL;
  54
  55 FilteringAction * filteringaction_new(int type, int account_id,
  56                                       gchar * destination,
  57                                       gint labelcolor)
  58 {
  59         FilteringAction * action;
  60
  61         action = g_new0(FilteringAction, 1);
  62
  63         action->type = type;
  64         action->account_id = account_id;
  65         if (destination)
  66                 action->destination = g_strdup(destination);
  67         action->labelcolor = labelcolor;
  68         return action;
  69 }
  70
  71 void filteringaction_free(FilteringAction * action)
  72 {
  73         if (action->destination)
  74                 g_free(action->destination);
  75         g_free(action);
  76 }
  77
  78 FilteringAction * filteringaction_parse(gchar ** str)
  79 {
  80         FilteringAction * action;
  81         gchar * tmp;
  82         gchar * destination = NULL;
  83         gint account_id = 0;
  84         gint key;
  85         gint labelcolor = 0;
  86
  87         tmp = * str;
  88
  89         key = matcher_parse_keyword(&tmp);
  90
  91         switch (key) {
  92         case MATCHING_ACTION_MOVE:
  93         case MATCHING_ACTION_COPY:
  94         case MATCHING_EXECUTE:
  95                 destination = matcher_parse_str(&tmp);
  96                 if (tmp == NULL) {
  97                         * str = NULL;
  98                         return NULL;
  99                 }
 100                 break;
 101         case MATCHING_ACTION_DELETE:
 102                 break;
 103         case MATCHING_ACTION_MARK:
 104                 break;
 105         case MATCHING_ACTION_MARK_AS_READ:
 106                 break;
 107         case MATCHING_ACTION_UNMARK:
 108                 break;
 109         case MATCHING_ACTION_MARK_AS_UNREAD:
 110                 break;
 111         case MATCHING_ACTION_FORWARD:
 112         case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
 113                 account_id = matcher_parse_number(&tmp);
 114                 if (tmp == NULL) {
 115                         * str = NULL;
 116                         return NULL;
 117                 }
 118
 119                 destination = matcher_parse_str(&tmp);
 120                 if (tmp == NULL) {
 121                         * str = NULL;
 122                         return NULL;
 123                 }
 124
 125                 break;
 126         case MATCHING_ACTION_COLOR:
 127                 labelcolor = matcher_parse_number(&tmp);
 128                 if (tmp == NULL) {
 129                         *str = NULL;
 130                         return NULL;
 131                 }
 132
 133                 break;
 134         default:
 135                 * str = NULL;
 136                 return NULL;
 137         }
 138
 139         * str = tmp;
 140
 141         action = filteringaction_new(key, account_id, destination, labelcolor);
 142
 143         return action;
 144 }
 145
 146 FilteringProp * filteringprop_parse(gchar ** str)
 147 {
 148         gchar * tmp;
 149         gint key;
 150         FilteringProp * filtering;
 151         MatcherList * matchers;
 152         FilteringAction * action;
 153
 154         tmp = * str;
 155
 156         matchers = matcherlist_parse(&tmp);
 157         if (tmp == NULL) {
 158                 * str = NULL;
 159                 return NULL;
 160         }
 161
 162         if (tmp == NULL) {
 163                 matcherlist_free(matchers);
 164                 * str = NULL;
 165                 return NULL;
 166         }
 167
 168         action = filteringaction_parse(&tmp);
 169         if (tmp == NULL) {
 170                 matcherlist_free(matchers);
 171                 * str = NULL;
 172                 return NULL;
 173         }
 174
 175         filtering = filteringprop_new(matchers, action);
 176
 177         * str = tmp;
 178         return filtering;
 179 }
 180
 181
 182 FilteringProp * filteringprop_new(MatcherList * matchers,
 183                                   FilteringAction * action)
 184 {
 185         FilteringProp * filtering;
 186
 187         filtering = g_new0(FilteringProp, 1);
 188         filtering->matchers = matchers;
 189         filtering->action = action;
 190
 191         return filtering;
 192 }
 193
 194 void filteringprop_free(FilteringProp * prop)
 195 {
 196         matcherlist_free(prop->matchers);
 197         filteringaction_free(prop->action);
 198         g_free(prop);
 199 }
 200
 201 /* filteringaction_update_mark() - updates a mark for a message. note that
 202  * the message should not have been moved or copied. remember that the
 203  * procmsg_open_mark_file(PATH, TRUE) actually _appends_ a new record.
 204  */
 205 static gboolean filteringaction_update_mark(MsgInfo * info)
 206 {
 207         gchar * dest_path;
 208         FILE * fp;
 209
 210         if (info->folder->folder->type == F_MH) {
 211                 dest_path = folder_item_get_path(info->folder);
 212                 if (!is_dir_exist(dest_path))
 213                         make_dir_hier(dest_path);
 214
 215                 if (dest_path == NULL) {
 216                         g_warning(_("Can't open mark file.\n"));
 217                         return FALSE;
 218                 }
 219
 220                 if ((fp = procmsg_open_mark_file(dest_path, TRUE))
 221                     == NULL) {
 222                         g_warning(_("Can't open mark file.\n"));
 223                         return FALSE;
 224                 }
 225
 226                 procmsg_write_flags(info, fp);
 227                 fclose(fp);
 228                 return TRUE;
 229         }
 230         return FALSE;
 231 }
 232
 233 static inline gint strlen_with_check(const gchar *expr, gint fline, const gchar *str)
 234 {
 235         if (str)
 236                 return strlen(str);
 237         else {
 238                 debug_print("%s(%d) - invalid string %s\n", __FILE__, fline, expr);
 239                 return 0;
 240         }
 241 }
 242
 243 #define STRLEN_WITH_CHECK(expr) \
 244         strlen_with_check(#expr, __LINE__, expr)
 245
 246 static gchar * filteringaction_execute_command(gchar * cmd, MsgInfo * info)
 247 {
 248         gchar * s = cmd;
 249         gchar * filename = NULL;
 250         gchar * processed_cmd;
 251         gchar * p;
 252         gint size;
 253
 254         matcher_unescape_str(cmd);
 255
 256         size = strlen(cmd) + 1;
 257         while (*s != '\0') {
 258                 if (*s == '%') {
 259                         s++;
 260                         switch (*s) {
 261                         case '%':
 262                                 size -= 1;
 263                                 break;
 264                         case 's': /* subject */
 265                                 size += STRLEN_WITH_CHECK(info->subject) - 2;
 266                                 break;
 267                         case 'f': /* from */
 268                                 size += STRLEN_WITH_CHECK(info->from) - 2;
 269                                 break;
 270                         case 't': /* to */
 271                                 size += STRLEN_WITH_CHECK(info->to) - 2;
 272                                 break;
 273                         case 'c': /* cc */
 274                                 size += STRLEN_WITH_CHECK(info->cc) - 2;
 275                                 break;
 276                         case 'd': /* date */
 277                                 size += STRLEN_WITH_CHECK(info->date) - 2;
 278                                 break;
 279                         case 'i': /* message-id */
 280                                 size += STRLEN_WITH_CHECK(info->msgid) - 2;
 281                                 break;
 282                         case 'n': /* newsgroups */
 283                                 size += STRLEN_WITH_CHECK(info->newsgroups) - 2;
 284                                 break;
 285                         case 'r': /* references */
 286                                 size += STRLEN_WITH_CHECK(info->references) - 2;
 287                                 break;
 288                         case 'F': /* file */
 289                                 if (MSG_IS_FILTERING(info->flags))
 290                                         filename = g_strdup((gchar *)info->folder);
 291                                 else
 292                                         filename = folder_item_fetch_msg(info->folder, info->msgnum);
 293
 294                                 if (filename == NULL) {
 295                                         g_warning(_("filename is not set"));
 296                                         return NULL;
 297                                 }
 298                                 else
 299                                         size += strlen(filename) - 2;
 300                                 break;
 301                         }
 302                         s++;
 303                 }
 304                 else s++;
 305         }
 306
 307
 308         processed_cmd = g_new0(gchar, size);
 309         s = cmd;
 310         p = processed_cmd;
 311
 312         while (*s != '\0') {
 313                 if (*s == '%') {
 314                         s++;
 315                         switch (*s) {
 316                         case '%':
 317                                 *p = '%';
 318                                 p++;
 319                                 break;
 320                         case 's': /* subject */
 321                                 if (info->subject != NULL)
 322                                         strcpy(p, info->subject);
 323                                 else
 324                                         strcpy(p, "(none)");
 325                                 p += strlen(p);
 326                                 break;
 327                         case 'f': /* from */
 328                                 if (info->from != NULL)
 329                                         strcpy(p, info->from);
 330                                 else
 331                                         strcpy(p, "(none)");
 332                                 p += strlen(p);
 333                                 break;
 334                         case 't': /* to */
 335                                 if (info->to != NULL)
 336                                         strcpy(p, info->to);
 337                                 else
 338                                         strcpy(p, "(none)");
 339                                 p += strlen(p);
 340                                 break;
 341                         case 'c': /* cc */
 342                                 if (info->cc != NULL)
 343                                         strcpy(p, info->cc);
 344                                 else
 345                                         strcpy(p, "(none)");
 346                                 p += strlen(p);
 347                                 break;
 348                         case 'd': /* date */
 349                                 if (info->date != NULL)
 350                                         strcpy(p, info->date);
 351                                 else
 352                                         strcpy(p, "(none)");
 353                                 p += strlen(p);
 354                                 break;
 355                         case 'i': /* message-id */
 356                                 if (info->msgid != NULL)
 357                                         strcpy(p, info->msgid);
 358                                 else
 359                                         strcpy(p, "(none)");
 360                                 p += strlen(p);
 361                                 break;
 362                         case 'n': /* newsgroups */
 363                                 if (info->newsgroups != NULL)
 364                                         strcpy(p, info->newsgroups);
 365                                 else
 366                                         strcpy(p, "(none)");
 367                                 p += strlen(p);
 368                                 break;
 369                         case 'r': /* references */
 370                                 if (info->references != NULL)
 371                                         strcpy(p, info->references);
 372                                 else
 373                                         strcpy(p, "(none)");
 374                                 p += strlen(p);
 375                                 break;
 376                         case 'F': /* file */
 377                                 strcpy(p, filename);
 378                                 p += strlen(p);
 379                                 break;
 380                         default:
 381                                 *p = '%';
 382                                 p++;
 383                                 *p = *s;
 384                                 p++;
 385                                 break;
 386                         }
 387                         s++;
 388                 }
 389                 else {
 390                         *p = *s;
 391                         p++;
 392                         s++;
 393                 }
 394         }
 395
 396         g_free(filename);
 397         return processed_cmd;
 398 }
 399
 400 /*
 401   fitleringaction_apply
 402   runs the action on one MsgInfo
 403   return value : return TRUE if the action could be applied
 404 */
 405
 406 #define CHANGE_FLAGS(msginfo) \
 407 { \
 408 if (msginfo->folder->folder->change_flags != NULL) \
 409 msginfo->folder->folder->change_flags(msginfo->folder->folder, \
 410                                       msginfo->folder, \
 411                                       msginfo); \
 412 }
 413
 414 static gboolean filteringaction_apply(FilteringAction * action, MsgInfo * info,
 415                                       GHashTable *folder_table)
 416 {
 417         FolderItem * dest_folder;
 418         gint val;
 419         Compose * compose;
 420         PrefsAccount * account;
 421         gchar * cmd;
 422
 423         switch(action->type) {
 424         case MATCHING_ACTION_MOVE:
 425                 dest_folder =
 426                         folder_find_item_from_identifier(action->destination);
 427                 if (!dest_folder)
 428                         return FALSE;
 429
 430                 if (folder_item_move_msg(dest_folder, info) == -1)
 431                         return FALSE;
 432
 433                 /* WRONG: can not update the mark, because the message has
 434                  * been moved. info pertains to original location.
 435                  * folder_item_move_msg() already updated the mark for the
 436                  * destination folder.
 437                 info->flags = 0;
 438                 filteringaction_update_mark(info);
 439                  */
 440                 if (folder_table) {
 441                         val = GPOINTER_TO_INT(g_hash_table_lookup
 442                                               (folder_table, dest_folder));
 443                         if (val == 0) {
 444                                 folder_item_scan(dest_folder);
 445                                 g_hash_table_insert(folder_table, dest_folder,
 446                                                     GINT_TO_POINTER(1));
 447                         }
 448                         val = GPOINTER_TO_INT(g_hash_table_lookup
 449                                               (folder_table, info->folder));
 450                         if (val == 0) {
 451                                 folder_item_scan(info->folder);
 452                                 g_hash_table_insert(folder_table, info->folder,
 453                                                     GINT_TO_POINTER(1));
 454                         }
 455                 }
 456                 return TRUE;
 457
 458         case MATCHING_ACTION_COPY:
 459                 dest_folder =
 460                         folder_find_item_from_identifier(action->destination);
 461
 462                 if (!dest_folder)
 463                         return FALSE;
 464
 465                 /* NOTE: the following call *will* update the mark file for
 466                  * the destination folder. but the original message will
 467                  * still be there in the inbox. */
 468
 469                 if (folder_item_copy_msg(dest_folder, info) == -1)
 470                         return FALSE;
 471
 472                 if (folder_table) {
 473                         val = GPOINTER_TO_INT(g_hash_table_lookup
 474                                               (folder_table, dest_folder));
 475                         if (val == 0) {
 476                                 folder_item_scan(dest_folder);
 477                                 g_hash_table_insert(folder_table, dest_folder,
 478                                                     GINT_TO_POINTER(1));
 479                         }
 480                 }
 481
 482                 return TRUE;
 483
 484         case MATCHING_ACTION_DELETE:
 485                 if (folder_item_remove_msg(info->folder, info->msgnum) == -1)
 486                         return FALSE;
 487
 488                 /* WRONG: can not update the mark. this would actually add
 489                  * a bogus record to the mark file for the message's original
 490                  * folder.
 491                 info->flags = 0;
 492                 filteringaction_update_mark(info);
 493                  */
 494
 495                 return TRUE;
 496
 497         case MATCHING_ACTION_MARK:
 498                 MSG_SET_PERM_FLAGS(info->flags, MSG_MARKED);
 499                 debug_print("*** MARKING message %d, in folder %s, \"%s\"\n",
 500                             info->msgnum, info->folder->name,
 501                             info->subject ? info->subject : "<none>");
 502                 filteringaction_update_mark(info);
 503
 504                 CHANGE_FLAGS(info);
 505
 506                 return TRUE;
 507
 508         case MATCHING_ACTION_UNMARK:
 509                 MSG_UNSET_PERM_FLAGS(info->flags, MSG_MARKED);
 510                 filteringaction_update_mark(info);
 511
 512                 CHANGE_FLAGS(info);
 513
 514                 return TRUE;
 515
 516         case MATCHING_ACTION_MARK_AS_READ:
 517                 MSG_UNSET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
 518                 filteringaction_update_mark(info);
 519
 520                 CHANGE_FLAGS(info);
 521
 522                 return TRUE;
 523
 524         case MATCHING_ACTION_MARK_AS_UNREAD:
 525                 MSG_SET_PERM_FLAGS(info->flags, MSG_UNREAD | MSG_NEW);
 526                 filteringaction_update_mark(info);
 527
 528                 CHANGE_FLAGS(info);
 529
 530                 return TRUE;
 531
 532         case MATCHING_ACTION_FORWARD:
 533
 534                 account = account_find_from_id(action->account_id);
 535                 compose = compose_forward(account, info, FALSE);
 536                 if (compose->account->protocol == A_NNTP)
 537                         compose_entry_append(compose, action->destination,
 538                                              COMPOSE_NEWSGROUPS);
 539                 else
 540                         compose_entry_append(compose, action->destination,
 541                                              COMPOSE_TO);
 542
 543                 val = compose_send(compose);
 544                 if (val == 0) {
 545                         gtk_widget_destroy(compose->window);
 546                         return TRUE;
 547                 }
 548
 549                 gtk_widget_destroy(compose->window);
 550                 return FALSE;
 551
 552         case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
 553
 554                 account = account_find_from_id(action->account_id);
 555                 compose = compose_forward(account, info, TRUE);
 556                 if (compose->account->protocol == A_NNTP)
 557                         compose_entry_append(compose, action->destination,
 558                                              COMPOSE_NEWSGROUPS);
 559                 else
 560                         compose_entry_append(compose, action->destination,
 561                                              COMPOSE_TO);
 562
 563                 val = compose_send(compose);
 564                 if (val == 0) {
 565                         gtk_widget_destroy(compose->window);
 566                         return TRUE;
 567                 }
 568
 569                 gtk_widget_destroy(compose->window);
 570                 return FALSE;
 571
 572         case MATCHING_EXECUTE:
 573
 574                 cmd = matching_build_command(action->destination, info);
 575                 if (cmd == NULL)
 576                         return TRUE;
 577                 else {
 578                         system(cmd);
 579                         g_free(cmd);
 580                 }
 581
 582                 return TRUE;
 583
 584         default:
 585                 return FALSE;
 586         }
 587 }
 588
 589 /* filteringprop_apply() - runs the action on one MsgInfo if it matches the
 590  * criterium. certain actions can be followed by other actions. in this
 591  * case the function returns FALSE. if an action can not be followed
 592  * by others, the function returns TRUE.
 593  *
 594  * remember that this is because of the fact that msg flags are always
 595  * _appended_ to mark files. currently sylpheed does not insert messages
 596  * at a certain index.
 597  * now, after having performed a certain action, the MsgInfo is still
 598  * valid for the message. in *this* case the function returns FALSE.
 599  */
 600 static gboolean filteringprop_apply(FilteringProp * filtering, MsgInfo * info,
 601                                     GHashTable *folder_table)
 602 {
 603         if (matcherlist_match(filtering->matchers, info)) {
 604                 gint result;
 605                 gchar * action_str;
 606
 607                 result = TRUE;
 608
 609                 result = filteringaction_apply(filtering->action, info,
 610                                                folder_table);
 611                 action_str =
 612                         filteringaction_to_string(filtering->action);
 613                 if (!result) {
 614                         g_warning(_("action %s could not be applied"),
 615                                   action_str);
 616                 }
 617                 else {
 618                         debug_print(_("message %i %s..."),
 619                                       info->msgnum, action_str);
 620                 }
 621
 622                 g_free(action_str);
 623
 624                 switch(filtering->action->type) {
 625                 case MATCHING_ACTION_MOVE:
 626                 case MATCHING_ACTION_DELETE:
 627                         return TRUE; /* MsgInfo invalid for message */
 628                 case MATCHING_EXECUTE:
 629                 case MATCHING_ACTION_COPY:
 630                 case MATCHING_ACTION_MARK:
 631                 case MATCHING_ACTION_MARK_AS_READ:
 632                 case MATCHING_ACTION_UNMARK:
 633                 case MATCHING_ACTION_MARK_AS_UNREAD:
 634                 case MATCHING_ACTION_FORWARD:
 635                 case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
 636                         return FALSE; /* MsgInfo still valid for message */
 637                 default:
 638                         return FALSE;
 639                 }
 640         }
 641         else
 642                 return FALSE;
 643 }
 644
 645 void filter_msginfo(GSList * filtering_list, MsgInfo * info,
 646                     GHashTable *folder_table)
 647 {
 648         GSList * l;
 649
 650         if (info == NULL) {
 651                 g_warning(_("msginfo is not set"));
 652                 return;
 653         }
 654
 655         for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
 656                 FilteringProp * filtering = (FilteringProp *) l->data;
 657
 658                 if (filteringprop_apply(filtering, info, folder_table))
 659                         break;
 660         }
 661 }
 662
 663 void filter_msginfo_move_or_delete(GSList * filtering_list, MsgInfo * info,
 664                                    GHashTable *folder_table)
 665 {
 666         GSList * l;
 667
 668         if (info == NULL) {
 669                 g_warning(_("msginfo is not set"));
 670                 return;
 671         }
 672
 673         for(l = filtering_list ; l != NULL ; l = g_slist_next(l)) {
 674                 FilteringProp * filtering = (FilteringProp *) l->data;
 675
 676                 switch (filtering->action->type) {
 677                 case MATCHING_ACTION_MOVE:
 678                 case MATCHING_ACTION_DELETE:
 679                         if (filteringprop_apply(filtering, info, folder_table))
 680                                 return;
 681                 }
 682         }
 683 }
 684
 685 void filter_message(GSList * filtering_list, FolderItem * item,
 686                     gint msgnum, GHashTable *folder_table)
 687 {
 688         MsgInfo * msginfo;
 689         gchar * filename;
 690         MsgFlags  msgflags = { 0, 0 };
 691
 692         if (item == NULL) {
 693                 g_warning(_("folderitem not set"));
 694                 return;
 695         }
 696
 697         filename = folder_item_fetch_msg(item, msgnum);
 698
 699         if (filename == NULL) {
 700                 g_warning(_("filename is not set"));
 701                 return;
 702         }
 703
 704         msginfo = procheader_parse(filename, msgflags, TRUE);
 705
 706         g_free(filename);
 707
 708         if (msginfo == NULL) {
 709                 g_warning(_("could not get info for %s"), filename);
 710                 return;
 711         }
 712
 713         msginfo->folder = item;
 714         msginfo->msgnum = msgnum;
 715
 716         filter_msginfo(filtering_list, msginfo, folder_table);
 717 }
 718
 719
 720 /******************************************************************************/
 721
 722 /* revised filtering system.
 723  *
 724  * 07/18/01     alfons          initial revisement
 725  */
 726
 727 /* (alfons)
 728  *
 729  * the revised filtering system does not rely on a message being "registered"
 730  * in one of sylpheed's folders. it now uses the file sylpheed created on
 731  * incorporation of mail.
 732  * i do use MsgInfo data; that's needed by the matcher, but for the rest
 733  * the MsgInfo is not really used. */
 734
 735
 736 /* add_mark() - adds a mark for a file */
 737 static void add_mark(FolderItem *folder, gint msgnum, MsgPermFlags flags)
 738 {
 739         gchar * dest_path;
 740         FILE * fp;
 741
 742         if (folder->folder->type == F_MH) {
 743                 dest_path = folder_item_get_path(folder);
 744                 if (!is_dir_exist(dest_path))
 745                         make_dir_hier(dest_path);
 746
 747                 if (dest_path == NULL) {
 748                         g_warning(_("Can't open mark file.\n"));
 749                         return;
 750                 }
 751
 752                 if ((fp = procmsg_open_mark_file(dest_path, TRUE))
 753                     == NULL) {
 754                         g_warning(_("Can't open mark file.\n"));
 755                         return;
 756                 }
 757
 758                 /* TODO: straight from procmsg.c:procmsg_write_flags()
 759                  * should update this when mark file version changes */
 760 #if MARK_VERSION == 2
 761                 WRITE_CACHE_DATA_INT(msgnum, fp);
 762                 WRITE_CACHE_DATA_INT(flags, fp);
 763 #else
 764 #error should rewrite the above for new  mark version
 765                 /* paste the source code of procmsg.c:procmsg_write_flags() */
 766 #endif
 767                 fclose(fp);
 768                 return;
 769         }
 770         return;
 771 }
 772
 773 /* prepare_destination() - prepares destination folder by registering it
 774  * in the global folder table (if not already there). it returns TRUE if
 775  * successful. it also returns the FolderItem for the destination */
 776 static gboolean prepare_destination(const gchar *destination, FolderItem **item,
 777                                     GHashTable *folder_table)
 778 {
 779         gint val;
 780         FolderItem *result;
 781
 782         result = folder_find_item_from_identifier(destination);
 783         if (!result)
 784                 return FALSE;
 785         if (folder_table) {
 786                 *item = result;
 787                 val = GPOINTER_TO_INT(g_hash_table_lookup(folder_table, *item));
 788                 if (val == 0) {
 789                         folder_item_scan(*item);
 790                         g_hash_table_insert(folder_table, *item, GINT_TO_POINTER(1));
 791                 }
 792         }
 793         return TRUE;
 794 }
 795
 796 /* filter_incoming_perform_actions() - performs actions on incoming
 797  * message. this function handles updating marks a little bit smarter;
 798  * remember that marks can only be appended. */
 799 static gboolean filter_incoming_perform_actions(FolderItem *default_folder,
 800                                                 MsgInfo    *msginfo,
 801                                                 GHashTable *folder_table)
 802 {
 803         /* matching actions for msginfo */
 804         struct matching_action {
 805                 FilteringAction         *action;
 806                 struct matching_action  *next;
 807         };
 808
 809         struct matching_action  ma_head = { NULL, NULL };
 810         struct matching_action *ma_tail = &ma_head;
 811
 812         /* need this for the forwarding stuff */
 813         PrefsAccount *account;
 814         Compose      *compose;
 815         MsgFlags      tmp;
 816         gchar        *fwd_msg_name;
 817         gint          val;
 818         MsgInfo      *fwd_msg;
 819
 820         MsgFlags     markflags = { 0, 0 };
 821
 822         /* use the global prefs_filtering list */
 823         GSList *     list = prefs_filtering;
 824
 825         /* things we get after having added a message to a folder */
 826         FolderItem  *dest_folder;
 827         gint         msgnum;
 828
 829         /* after performing certain action, we may have to copy
 830          * the message to inbox too */
 831         gboolean     copy_to_inbox_too = TRUE;
 832
 833         /* filename is only put in msginfo->folder if MSG_FILTERING is set. */
 834         const gchar *filename = (gchar *) msginfo->folder;
 835
 836         MsgPermFlags flags;
 837         gboolean     stop;
 838         gchar        *cmd;
 839
 840         /* build list of matching actions */
 841         for (; list != NULL; list = g_slist_next(list)) {
 842                 FilteringProp *prop = (FilteringProp *) list->data;
 843
 844                 if (!matcherlist_match(prop->matchers, msginfo))
 845                         continue;
 846
 847                 if (NULL == (ma_tail->next = alloca(sizeof(struct matching_action)))) {
 848                         debug_print(_("action allocation error\n"));
 849                         break;
 850                 }
 851
 852                 debug_print("*** action %d\n", prop->action->type);
 853
 854                 ma_tail->action = prop->action;
 855                 ma_tail->next->action = NULL;
 856                 ma_tail->next->next = NULL;
 857                 ma_tail = ma_tail->next;
 858         }
 859
 860         debug_print("*** collecting marks\n");
 861
 862         /* collect all marks */
 863         for (ma_tail = &ma_head, stop = FALSE; ma_tail->action && !stop; ma_tail = ma_tail->next) {
 864                 switch (ma_tail->action->type) {
 865
 866                 case MATCHING_ACTION_MARK:
 867                         MSG_SET_PERM_FLAGS(markflags, MSG_MARKED);
 868                         break;
 869
 870                 case MATCHING_ACTION_UNMARK:
 871                         MSG_UNSET_PERM_FLAGS(markflags, MSG_MARKED);
 872                         break;
 873
 874                 case MATCHING_ACTION_MARK_AS_READ:
 875                         MSG_UNSET_PERM_FLAGS(markflags, MSG_UNREAD);
 876                         break;
 877
 878                 case MATCHING_ACTION_MARK_AS_UNREAD:
 879                         MSG_SET_PERM_FLAGS(markflags, MSG_UNREAD);
 880                         break;
 881
 882                 case MATCHING_ACTION_COLOR:
 883                         MSG_SET_LABEL_VALUE(markflags, ma_tail->action->labelcolor);
 884                         break;
 885
 886                 /* UNCONTINUABLE */
 887                 case MATCHING_ACTION_FORWARD:
 888                 case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
 889                 case MATCHING_ACTION_MOVE:
 890                 case MATCHING_ACTION_DELETE:
 891                         stop = TRUE;
 892                         break;
 893
 894                 default:
 895                         break;
 896                 }
 897         }
 898
 899
 900         /* msgnum & dest_folder should have valid values after a succesful
 901          * drop; in this case there is a MsgInfo available */
 902         msgnum      = -1;
 903         dest_folder = NULL;
 904
 905         debug_print("*** performing actions\n");
 906
 907         for (ma_tail = &ma_head ; ma_tail->action; ma_tail = ma_tail->next) {
 908
 909                 /* there are variables you have to use when defining new actions:
 910                  *
 911                  * copy_to_inbox_too - if the original message should be copied to the inbox
 912                  *                     (default_folder) too.
 913                  *
 914                  * also note that after dropping it to a folder (folder_item_add_msg()) you have
 915                  * to mark the message, just to make sure any defined mark actions are applied. */
 916
 917 #define ACTION  (ma_tail->action->type)
 918
 919                 /* C O N T I N U A B L E */
 920
 921                 if (MATCHING_ACTION_COPY == ACTION) {
 922                         debug_print("*** performing copy\n");
 923                         copy_to_inbox_too = TRUE;
 924                         if (!prepare_destination(ma_tail->action->destination, &dest_folder, folder_table)) {
 925                                 debug_print("Rule failed: unknown destination %s\n", ma_tail->action->destination);
 926                                 continue; /* try next action */
 927                         }
 928                         if (0 > (msgnum = folder_item_add_msg(dest_folder, filename, FALSE))) {
 929                                 debug_print(_("Rule failed: could not copy to folder %s\n"),
 930                                             ma_tail->action->destination);
 931                                 continue; /* try next action */
 932                         }
 933                         flags = msginfo->flags.perm_flags | markflags.perm_flags;
 934                         add_mark(dest_folder, msgnum, flags);
 935                 }
 936                 else if (MATCHING_EXECUTE == ACTION) {
 937                         debug_print("*** performing exec\n");
 938                         copy_to_inbox_too = TRUE;
 939
 940                         /* matching_build_command() knows about filtering */
 941                         cmd = matching_build_command(ma_tail->action->destination, msginfo);
 942                         if (cmd) {
 943                                 system(cmd);
 944                                 g_free(cmd);
 945                         }
 946                         else
 947                                 debug_print(_("Rule failed: no command line\n"));
 948                 }
 949
 950                 /* U N C O N T I N U A B L E */
 951
 952                 else if (MATCHING_ACTION_FORWARD == ACTION
 953                 ||       MATCHING_ACTION_FORWARD_AS_ATTACHMENT == ACTION) {
 954                         debug_print("*** performing forward\n");
 955
 956                         /* forwarding messages is complicated because there's currently no
 957                          * way to forward a message using "filenames"; you can only forward
 958                          * a message if you have its MsgInfo. this means we have to drop
 959                          * the message first */
 960                         if (0 > (msgnum = folder_item_add_msg(default_folder, filename, FALSE))) {
 961                                 debug_print(_("Rule failed: could not forward\n"));
 962                                 copy_to_inbox_too = TRUE;
 963                                 continue;
 964                         }
 965
 966                         flags = msginfo->flags.perm_flags | markflags.perm_flags;
 967                         flags |= MSG_FORWARDED;
 968                         add_mark(default_folder, msgnum, flags);
 969
 970                         /* grab the dropped message */
 971                         fwd_msg_name = folder_item_fetch_msg(default_folder, msgnum);
 972
 973                         tmp.perm_flags = tmp.tmp_flags = 0;
 974                         fwd_msg = procheader_parse(fwd_msg_name, tmp, TRUE);
 975
 976                         fwd_msg->folder = default_folder;
 977                         fwd_msg->msgnum = msgnum;
 978
 979                         /* do the compose_XXX stuff */
 980                         account = account_find_from_id(ma_tail->action->account_id);
 981                         compose = compose_forward(account, fwd_msg, ACTION == MATCHING_ACTION_FORWARD ? FALSE : TRUE);
 982                         if (compose->account->protocol == A_NNTP)
 983                                 compose_entry_append(compose, ma_tail->action->destination,
 984                                                      COMPOSE_NEWSGROUPS);
 985                         else
 986                                 compose_entry_append(compose, ma_tail->action->destination,
 987                                                      COMPOSE_TO);
 988
 989                         compose_send(compose);
 990
 991                         procmsg_msginfo_free(fwd_msg);
 992
 993                         gtk_widget_destroy(compose->window);
 994                         break;
 995                 }
 996                 else if (MATCHING_ACTION_DELETE == ACTION) {
 997                         debug_print("*** performing delete\n");
 998                         copy_to_inbox_too = FALSE;
 999
1000                         /* drop to Trash */
1001                         dest_folder = folder_get_default_trash();
1002                         msgnum = folder_item_add_msg(dest_folder, filename, FALSE);
1003                         if (msgnum < 0) {
1004                                 debug_print(_("Rule failed: could not move to trash"));
1005                                 copy_to_inbox_too = TRUE;
1006                         }
1007                         else {
1008                                 flags = msginfo->flags.perm_flags | markflags.perm_flags;
1009                                 add_mark(dest_folder, msgnum, flags);
1010                         }
1011                         break;
1012                 }
1013                 else if (MATCHING_ACTION_MOVE == ACTION) {
1014                         debug_print("*** performing move\n");
1015                         copy_to_inbox_too = FALSE;
1016
1017                         if (!prepare_destination(ma_tail->action->destination, &dest_folder, folder_table)) {
1018                                 copy_to_inbox_too = TRUE;
1019                                 break;
1020                         }
1021
1022                         msgnum = folder_item_add_msg(dest_folder, filename, FALSE);
1023                         if (msgnum < 0) {
1024                                 debug_print(_("Rule failed: could not move to folder %s\n"),
1025                                             ma_tail->action->destination);
1026                                 copy_to_inbox_too = TRUE;
1027                                 break;
1028                         }
1029
1030                         flags = msginfo->flags.perm_flags | markflags.perm_flags;
1031                         add_mark(dest_folder, msgnum, flags);
1032                         break;
1033                 }
1034         }
1035
1036         /* may need to copy it to inbox too */
1037         if (copy_to_inbox_too) {
1038                 debug_print("*** performing inbox copy\n");
1039                 msgnum = folder_item_add_msg(default_folder, filename, TRUE);
1040                 if (msgnum < 0) {
1041                         debug_print(_("error copying incoming file %s to inbox\n"),
1042                                     filename);
1043                         return FALSE;
1044                 }
1045                 flags = msginfo->flags.perm_flags | markflags.perm_flags;
1046                 add_mark(default_folder, msgnum, flags);
1047         }
1048         else {
1049                 debug_print("*** unlinking\n");
1050                 if (unlink(filename) < 0)
1051                         debug_print(_("error deleting incoming message file\n"));
1052         }
1053
1054 #undef ACTION
1055
1056         return TRUE;
1057 }
1058
1059 static void filter_incoming_msginfo(FolderItem *default_folder, MsgInfo *msginfo,
1060                                     GHashTable *folder_table)
1061 {
1062         filter_incoming_perform_actions(default_folder, msginfo, folder_table);
1063 }
1064
1065 /* filter_incoming_message() - tries to apply a filter on one incoming message.
1066  * it also handles the case when there's no filter match */
1067 void filter_incoming_message(FolderItem *default_folder, const gchar *file_name,
1068                              GHashTable *folder_table)
1069 {
1070         MsgInfo *msginfo;
1071         MsgFlags msgflags = { 0, 0 };
1072
1073         /* make an "uncomplete" msginfo. it's incomplete because it doesn't
1074          * have a message number / folder yet. */
1075         if (NULL == (msginfo = procheader_parse(file_name, msgflags, TRUE))) {
1076                 g_warning(_("error filtering incoming message %s\n"),
1077                           file_name);
1078                 return;
1079         }
1080
1081         /* let matcher know that this is a message that has no
1082          * valid body data yet. */
1083         MSG_SET_TMP_FLAGS(msginfo->flags, MSG_FILTERING);
1084         msginfo->folder = (FolderItem *) g_strdup(file_name); /* actually storing a pointer to a string */
1085         msginfo->msgnum = 0;
1086
1087         filter_incoming_msginfo(default_folder, msginfo, folder_table);
1088
1089         g_free(msginfo->folder);
1090         procmsg_msginfo_free(msginfo);
1091 }
1092
1093 /******************************************************************************/
1094
1095 void prefs_filtering_read_config(void)
1096 {
1097         gchar *rcpath;
1098         FILE *fp;
1099         gchar buf[PREFSBUFSIZE];
1100
1101         debug_print(_("Reading filtering configuration...\n"));
1102
1103         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1104                              FILTERING_RC, NULL);
1105         if ((fp = fopen(rcpath, "r")) == NULL) {
1106                 if (ENOENT != errno) FILE_OP_ERROR(rcpath, "fopen");
1107                 g_free(rcpath);
1108                 prefs_filtering = NULL;
1109                 return;
1110         }
1111         g_free(rcpath);
1112
1113         /* remove all filtering */
1114         while (prefs_filtering != NULL) {
1115                 FilteringProp * filtering =
1116                         (FilteringProp *) prefs_filtering->data;
1117                 filteringprop_free(filtering);
1118                 prefs_filtering = g_slist_remove(prefs_filtering, filtering);
1119         }
1120
1121         while (fgets(buf, sizeof(buf), fp) != NULL) {
1122                 FilteringProp * filtering;
1123                 gchar * tmp;
1124
1125                 g_strchomp(buf);
1126
1127                 if ((*buf != '#') && (*buf != '\0')) {
1128                         tmp = buf;
1129                         filtering = filteringprop_parse(&tmp);
1130                         if (tmp != NULL) {
1131                                 prefs_filtering =
1132                                         g_slist_append(prefs_filtering,
1133                                                        filtering);
1134                         }
1135                         else {
1136                                 /* debug */
1137                                 g_warning(_("syntax error : %s\n"), buf);
1138                         }
1139                 }
1140         }
1141
1142         fclose(fp);
1143 }
1144
1145 gchar * filteringaction_to_string(FilteringAction * action)
1146 {
1147         gchar * command_str;
1148         gint i;
1149         gchar * account_id_str;
1150         gchar * labelcolor_str;
1151
1152         /* FIXME: use g_sprintf() throughout */
1153
1154         command_str = NULL;
1155         command_str = get_matchparser_tab_str(action->type);
1156
1157         if (command_str == NULL)
1158                 return NULL;
1159
1160         switch(action->type) {
1161         case MATCHING_ACTION_MOVE:
1162         case MATCHING_ACTION_COPY:
1163         case MATCHING_EXECUTE:
1164                 return g_strconcat(command_str, " \"", action->destination,
1165                                    "\"", NULL);
1166
1167         case MATCHING_ACTION_DELETE:
1168         case MATCHING_ACTION_MARK:
1169         case MATCHING_ACTION_UNMARK:
1170         case MATCHING_ACTION_MARK_AS_READ:
1171         case MATCHING_ACTION_MARK_AS_UNREAD:
1172                 return g_strdup(command_str);
1173                 break;
1174
1175         case MATCHING_ACTION_FORWARD:
1176         case MATCHING_ACTION_FORWARD_AS_ATTACHMENT:
1177                 account_id_str = itos(action->account_id);
1178                 return g_strconcat(command_str, " ", account_id_str,
1179                                    " \"", action->destination, "\"", NULL);
1180
1181         case MATCHING_ACTION_COLOR:
1182                 labelcolor_str = itos(action->labelcolor);
1183                 return g_strconcat(command_str, " ", labelcolor_str, NULL);
1184
1185         default:
1186                 return NULL;
1187         }
1188 }
1189
1190 gchar * filteringprop_to_string(FilteringProp * prop)
1191 {
1192         gchar * list_str;
1193         gchar * action_str;
1194         gchar * filtering_str;
1195
1196         action_str = filteringaction_to_string(prop->action);
1197
1198         if (action_str == NULL)
1199                 return NULL;
1200
1201         list_str = matcherlist_to_string(prop->matchers);
1202
1203         if (list_str == NULL) {
1204                 g_free(action_str);
1205                 return NULL;
1206         }
1207
1208         filtering_str = g_strconcat(list_str, " ", action_str, NULL);
1209         g_free(list_str);
1210         g_free(action_str);
1211
1212         return filtering_str;
1213 }
1214
1215 void prefs_filtering_write_config(void)
1216 {
1217         gchar *rcpath;
1218         PrefFile *pfile;
1219         GSList *cur;
1220         FilteringProp * prop;
1221
1222         debug_print(_("Writing filtering configuration...\n"));
1223
1224         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, FILTERING_RC, NULL);
1225
1226         if ((pfile = prefs_write_open(rcpath)) == NULL) {
1227                 g_warning(_("failed to write configuration to file\n"));
1228                 g_free(rcpath);
1229                 return;
1230         }
1231
1232         for (cur = prefs_filtering; cur != NULL; cur = cur->next) {
1233                 gchar *filtering_str;
1234
1235                 prop = (FilteringProp *) cur->data;
1236                 filtering_str = filteringprop_to_string(prop);
1237
1238                 if (fputs(filtering_str, pfile->fp) == EOF ||
1239                     fputc('\n', pfile->fp) == EOF) {
1240                         FILE_OP_ERROR(rcpath, "fputs || fputc");
1241                         prefs_write_close_revert(pfile);
1242                         g_free(rcpath);
1243                         g_free(filtering_str);
1244                         return;
1245                 }
1246                 g_free(filtering_str);
1247         }
1248
1249         g_free(rcpath);
1250
1251         if (prefs_write_close(pfile) < 0) {
1252                 g_warning(_("failed to write configuration to file\n"));
1253                 return;
1254         }
1255 }