src/matcher.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
   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 <ctype.h>
  21 #include <string.h>
  22 #include <stdlib.h>
  23 #include <errno.h>
  24 #include "defs.h"
  25 #include "utils.h"
  26 #include "procheader.h"
  27 #include "matcher.h"
  28 #include "intl.h"
  29 #include "matcher_parser.h"
  30 #include "prefs.h"
  31
  32 struct _MatchParser {
  33         gint id;
  34         gchar * str;
  35 };
  36
  37 typedef struct _MatchParser MatchParser;
  38
  39 static MatchParser matchparser_tab[] = {
  40         /* msginfo flags */
  41         {MATCHCRITERIA_ALL, "all"},
  42         {MATCHCRITERIA_UNREAD, "unread"},
  43         {MATCHCRITERIA_NOT_UNREAD, "~unread"},
  44         {MATCHCRITERIA_NEW, "new"},
  45         {MATCHCRITERIA_NOT_NEW, "~new"},
  46         {MATCHCRITERIA_MARKED, "marked"},
  47         {MATCHCRITERIA_NOT_MARKED, "~marked"},
  48         {MATCHCRITERIA_DELETED, "deleted"},
  49         {MATCHCRITERIA_NOT_DELETED, "~deleted"},
  50         {MATCHCRITERIA_REPLIED, "replied"},
  51         {MATCHCRITERIA_NOT_REPLIED, "~replied"},
  52         {MATCHCRITERIA_FORWARDED, "forwarded"},
  53         {MATCHCRITERIA_NOT_FORWARDED, "~forwarded"},
  54
  55         /* msginfo headers */
  56         {MATCHCRITERIA_SUBJECT, "subject"},
  57         {MATCHCRITERIA_NOT_SUBJECT, "~subject"},
  58         {MATCHCRITERIA_FROM, "from"},
  59         {MATCHCRITERIA_NOT_FROM, "~from"},
  60         {MATCHCRITERIA_TO, "to"},
  61         {MATCHCRITERIA_NOT_TO, "~to"},
  62         {MATCHCRITERIA_CC, "cc"},
  63         {MATCHCRITERIA_NOT_CC, "~cc"},
  64         {MATCHCRITERIA_TO_OR_CC, "to_or_cc"},
  65         {MATCHCRITERIA_NOT_TO_AND_NOT_CC, "~to_or_cc"},
  66         {MATCHCRITERIA_AGE_GREATER, "age_greater"},
  67         {MATCHCRITERIA_AGE_LOWER, "age_lower"},
  68         {MATCHCRITERIA_NEWSGROUPS, "newsgroups"},
  69         {MATCHCRITERIA_NOT_NEWSGROUPS, "~newsgroups"},
  70         {MATCHCRITERIA_INREPLYTO, "inreplyto"},
  71         {MATCHCRITERIA_NOT_INREPLYTO, "~inreplyto"},
  72         {MATCHCRITERIA_REFERENCES, "references"},
  73         {MATCHCRITERIA_NOT_REFERENCES, "~references"},
  74         {MATCHCRITERIA_SCORE_GREATER, "score_greater"},
  75         {MATCHCRITERIA_SCORE_LOWER, "score_lower"},
  76         {MATCHCRITERIA_SCORE_EQUAL, "score_equal"},
  77
  78         {MATCHCRITERIA_SIZE_GREATER, "size_greater"},
  79         {MATCHCRITERIA_SIZE_SMALLER, "size_smaller"},
  80         {MATCHCRITERIA_SIZE_EQUAL,   "size_equal"},
  81
  82         /* content have to be read */
  83         {MATCHCRITERIA_HEADER, "header"},
  84         {MATCHCRITERIA_NOT_HEADER, "~header"},
  85         {MATCHCRITERIA_HEADERS_PART, "headers_part"},
  86         {MATCHCRITERIA_NOT_HEADERS_PART, "~headers_part"},
  87         {MATCHCRITERIA_MESSAGE, "message"},
  88         {MATCHCRITERIA_NOT_MESSAGE, "~message"},
  89         {MATCHCRITERIA_BODY_PART, "body_part"},
  90         {MATCHCRITERIA_NOT_BODY_PART, "~body_part"},
  91         {MATCHCRITERIA_EXECUTE, "execute"},
  92         {MATCHCRITERIA_NOT_EXECUTE, "~execute"},
  93
  94         /* match type */
  95         {MATCHTYPE_MATCHCASE, "matchcase"},
  96         {MATCHTYPE_MATCH, "match"},
  97         {MATCHTYPE_REGEXPCASE, "regexpcase"},
  98         {MATCHTYPE_REGEXP, "regexp"},
  99
 100         /* actions */
 101         {MATCHACTION_SCORE, "score"},
 102         {MATCHACTION_MOVE, "move"},
 103         {MATCHACTION_COPY, "copy"},
 104         {MATCHACTION_DELETE, "delete"},
 105         {MATCHACTION_MARK, "mark"},
 106         {MATCHACTION_UNMARK, "unmark"},
 107         {MATCHACTION_MARK_AS_READ, "mark_as_read"},
 108         {MATCHACTION_MARK_AS_UNREAD, "mark_as_unread"},
 109         {MATCHACTION_FORWARD, "forward"},
 110         {MATCHACTION_FORWARD_AS_ATTACHMENT, "forward_as_attachment"},
 111         {MATCHACTION_EXECUTE, "execute"},
 112         {MATCHACTION_COLOR, "color"},
 113         {MATCHACTION_REDIRECT, "redirect"},
 114         {MATCHACTION_DELETE_ON_SERVER, "delete_on_server"}
 115 };
 116
 117 /* get_matchparser_tab_str() - used by filtering.c to translate
 118  * actions to debug strings */
 119 gchar * get_matchparser_tab_str(gint id)
 120 {
 121         gint i;
 122
 123         for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
 124             i++) {
 125                 if (matchparser_tab[i].id == id)
 126                         return matchparser_tab[i].str;
 127         }
 128         return NULL;
 129 }
 130
 131 /* matcher_escape_str() - escapes a string returns newly allocated escaped string */
 132 gchar *matcher_escape_str(const gchar *str)
 133 {
 134         register const gchar *walk;
 135         register int escape;
 136         gchar *res;
 137         register char *reswalk;
 138
 139         if (str == NULL)
 140                 return NULL;
 141
 142         for (escape = 0, walk = str; *walk; walk++)
 143                 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
 144                         escape++;
 145
 146         if (!escape)
 147                 return g_strdup(str);
 148
 149         reswalk = res = g_new0(gchar, (walk - str) + escape + 1);
 150         for (walk = str; *walk; walk++, reswalk++) {
 151                 if (*walk == '\\' || *walk == '\'' || *walk == '\"')
 152                         *reswalk++ = '\\';
 153                 *reswalk = *walk;
 154         }
 155
 156         *reswalk = 0;
 157         return res;
 158 }
 159
 160 /* matcher_unescape_str() - assumes that unescaping frees up room
 161  * in the string, so it returns the unescaped string in the
 162  * source */
 163 gchar *matcher_unescape_str(gchar *str)
 164 {
 165         gchar *tmp = alloca(strlen(str) + 1);
 166         register gchar *src = tmp;
 167         register gchar *dst = str;
 168
 169         strcpy(tmp, str);
 170
 171         for ( ; *src; src++) {
 172                 if (*src != '\\')
 173                         *dst++ = *src;
 174                 else {
 175                         src++;
 176                         if (*src == 'n')   /* insert control characters */
 177                                 *dst++ = '\n';
 178                         else if (*src == 'r')
 179                                 *dst++ = '\r';
 180                         else if (*src == 't')
 181                                 *dst++ = '\t';
 182                         else if (*src == 'r')
 183                                 *dst++ = '\r';
 184                         else if (*src == 'b')
 185                                 *dst++ = '\b';
 186                         else if (*src == 'f')
 187                                 *dst++ = '\f';
 188                         else if (*src == '\\' || *src == '\'' || *src == '\"')
 189                                 /* insert \\, \' or \" */
 190                                 *dst++ = *src;
 191                         else {
 192                                 /* FIXME: should perhaps escape character... */
 193                                 src--;
 194                                 *dst++ = *src;
 195                         }
 196                 }
 197         }
 198         *dst = 0;
 199         return str;
 200 }
 201
 202 /* **************** data structure allocation **************** */
 203
 204 /* matcherprop_new() - allocates a structure for one condition
 205  */
 206 MatcherProp * matcherprop_new(gint criteria, gchar * header,
 207                               gint matchtype, gchar * expr,
 208                               int value)
 209 {
 210         MatcherProp * prop;
 211
 212         prop = g_new0(MatcherProp, 1);
 213         prop->criteria = criteria;
 214         if (header != NULL) {
 215                 prop->header       = g_strdup(header);
 216                 prop->unesc_header = matcher_unescape_str(g_strdup(header));
 217         }
 218         else {
 219                 prop->header       = NULL;
 220                 prop->unesc_header = NULL;
 221         }
 222         if (expr != NULL) {
 223                 prop->expr       = g_strdup(expr);
 224                 prop->unesc_expr = matcher_unescape_str(g_strdup(expr));
 225         }
 226         else {
 227                 prop->expr       = NULL;
 228                 prop->unesc_expr = NULL;
 229         }
 230         prop->matchtype = matchtype;
 231         prop->preg = NULL;
 232         prop->value = value;
 233         prop->error = 0;
 234
 235         return prop;
 236 }
 237
 238 /* matcherprop_free()
 239  */
 240 void matcherprop_free(MatcherProp * prop)
 241 {
 242         if (prop->expr)
 243                 g_free(prop->expr);
 244         if (prop->unesc_expr)
 245                 g_free(prop->unesc_expr);
 246         if (prop->header)
 247                 g_free(prop->header);
 248         if (prop->unesc_header)
 249                 g_free(prop->unesc_header);
 250         if (prop->preg != NULL) {
 251                 regfree(prop->preg);
 252                 g_free(prop->preg);
 253         }
 254         g_free(prop);
 255 }
 256
 257
 258 /* ************** match ******************************/
 259
 260
 261 /* matcherprop_string_match() - finds out if a string matches
 262  * with a criterium */
 263 static gboolean matcherprop_string_match(MatcherProp * prop, gchar * str)
 264 {
 265         gchar * str1;
 266         gchar * str2;
 267
 268         if (str == NULL)
 269                 return FALSE;
 270
 271         switch(prop->matchtype) {
 272         case MATCHTYPE_REGEXPCASE:
 273         case MATCHTYPE_REGEXP:
 274                 if (!prop->preg && (prop->error == 0)) {
 275                         prop->preg = g_new0(regex_t, 1);
 276                         /* if regexp then don't use the escaped string */
 277                         printf("%s\n", prop->expr);
 278                         if (regcomp(prop->preg, prop->unesc_expr,
 279                                     REG_NOSUB | REG_EXTENDED
 280                                     | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
 281                                     ? REG_ICASE : 0)) != 0) {
 282                                 prop->error = 1;
 283                                 g_free(prop->preg);
 284                                 prop->preg = NULL;
 285                         }
 286                 }
 287                 if (prop->preg == NULL)
 288                         return FALSE;
 289
 290                 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
 291                         return TRUE;
 292                 else
 293                         return FALSE;
 294
 295         case MATCHTYPE_MATCH:
 296                 return (strstr(str, prop->unesc_expr) != NULL);
 297
 298         /* FIXME: put upper in unesc_str */
 299         case MATCHTYPE_MATCHCASE:
 300                 str2 = alloca(strlen(prop->unesc_expr) + 1);
 301                 strcpy(str2, prop->unesc_expr);
 302                 g_strup(str2);
 303                 str1 = alloca(strlen(str) + 1);
 304                 strcpy(str1, str);
 305                 g_strup(str1);
 306                 return (strstr(str1, str2) != NULL);
 307
 308         default:
 309                 return FALSE;
 310         }
 311 }
 312
 313 gboolean matcherprop_match_execute(MatcherProp * prop, MsgInfo * info)
 314 {
 315         gchar * file;
 316         gchar * cmd;
 317         gint retval;
 318
 319         file = procmsg_get_message_file(info);
 320         if (file == NULL)
 321                 return FALSE;
 322         g_free(file);
 323
 324         cmd = matching_build_command(prop->unesc_expr, info);
 325         if (cmd == NULL)
 326                 return FALSE;
 327
 328         retval = system(cmd);
 329         debug_print("Command exit code: %d\n", retval);
 330
 331         g_free(cmd);
 332         return (retval == 0);
 333 }
 334
 335 /* match a message and his headers, hlist can be NULL if you don't
 336    want to use headers */
 337
 338 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info)
 339 {
 340         time_t t;
 341
 342         switch(prop->criteria) {
 343         case MATCHCRITERIA_ALL:
 344                 return 1;
 345         case MATCHCRITERIA_UNREAD:
 346                 return MSG_IS_UNREAD(info->flags);
 347         case MATCHCRITERIA_NOT_UNREAD:
 348                 return !MSG_IS_UNREAD(info->flags);
 349         case MATCHCRITERIA_NEW:
 350                 return MSG_IS_NEW(info->flags);
 351         case MATCHCRITERIA_NOT_NEW:
 352                 return !MSG_IS_NEW(info->flags);
 353         case MATCHCRITERIA_MARKED:
 354                 return MSG_IS_MARKED(info->flags);
 355         case MATCHCRITERIA_NOT_MARKED:
 356                 return !MSG_IS_MARKED(info->flags);
 357         case MATCHCRITERIA_DELETED:
 358                 return MSG_IS_DELETED(info->flags);
 359         case MATCHCRITERIA_NOT_DELETED:
 360                 return !MSG_IS_DELETED(info->flags);
 361         case MATCHCRITERIA_REPLIED:
 362                 return MSG_IS_REPLIED(info->flags);
 363         case MATCHCRITERIA_NOT_REPLIED:
 364                 return !MSG_IS_REPLIED(info->flags);
 365         case MATCHCRITERIA_FORWARDED:
 366                 return MSG_IS_FORWARDED(info->flags);
 367         case MATCHCRITERIA_NOT_FORWARDED:
 368                 return !MSG_IS_FORWARDED(info->flags);
 369         case MATCHCRITERIA_SUBJECT:
 370                 return matcherprop_string_match(prop, info->subject);
 371         case MATCHCRITERIA_NOT_SUBJECT:
 372                 return !matcherprop_string_match(prop, info->subject);
 373         case MATCHCRITERIA_FROM:
 374                 return matcherprop_string_match(prop, info->from);
 375         case MATCHCRITERIA_NOT_FROM:
 376                 return !matcherprop_string_match(prop, info->from);
 377         case MATCHCRITERIA_TO:
 378                 return matcherprop_string_match(prop, info->to);
 379         case MATCHCRITERIA_NOT_TO:
 380                 return !matcherprop_string_match(prop, info->to);
 381         case MATCHCRITERIA_CC:
 382                 return matcherprop_string_match(prop, info->cc);
 383         case MATCHCRITERIA_NOT_CC:
 384                 return !matcherprop_string_match(prop, info->cc);
 385         case MATCHCRITERIA_TO_OR_CC:
 386                 return matcherprop_string_match(prop, info->to)
 387                         || matcherprop_string_match(prop, info->cc);
 388         case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
 389                 return !(matcherprop_string_match(prop, info->to)
 390                 || matcherprop_string_match(prop, info->cc));
 391         case MATCHCRITERIA_AGE_GREATER:
 392                 t = time(NULL);
 393                 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
 394         case MATCHCRITERIA_AGE_LOWER:
 395                 t = time(NULL);
 396                 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
 397         case MATCHCRITERIA_SCORE_GREATER:
 398                 return info->score >= prop->value;
 399         case MATCHCRITERIA_SCORE_LOWER:
 400                 return info->score <= prop->value;
 401         case MATCHCRITERIA_SCORE_EQUAL:
 402                 return info->score == prop->value;
 403         case MATCHCRITERIA_SIZE_GREATER:
 404                 /* FIXME: info->size is an off_t */
 405                 return info->size > (off_t) prop->value;
 406         case MATCHCRITERIA_SIZE_EQUAL:
 407                 /* FIXME: info->size is an off_t */
 408                 return info->size == (off_t) prop->value;
 409         case MATCHCRITERIA_SIZE_SMALLER:
 410                 /* FIXME: info->size is an off_t */
 411                 return info->size <  (off_t) prop->value;
 412         case MATCHCRITERIA_NEWSGROUPS:
 413                 return matcherprop_string_match(prop, info->newsgroups);
 414         case MATCHCRITERIA_NOT_NEWSGROUPS:
 415                 return !matcherprop_string_match(prop, info->newsgroups);
 416         case MATCHCRITERIA_INREPLYTO:
 417                 return matcherprop_string_match(prop, info->inreplyto);
 418         case MATCHCRITERIA_NOT_INREPLYTO:
 419                 return !matcherprop_string_match(prop, info->inreplyto);
 420         case MATCHCRITERIA_REFERENCES:
 421                 return matcherprop_string_match(prop, info->references);
 422         case MATCHCRITERIA_NOT_REFERENCES:
 423                 return !matcherprop_string_match(prop, info->references);
 424         case MATCHCRITERIA_EXECUTE:
 425                 return matcherprop_match_execute(prop, info);
 426         case MATCHCRITERIA_NOT_EXECUTE:
 427                 return !matcherprop_match_execute(prop, info);
 428         default:
 429                 return 0;
 430         }
 431 }
 432
 433 /* ********************* MatcherList *************************** */
 434
 435
 436 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and)
 437 {
 438         MatcherList * cond;
 439
 440         cond = g_new0(MatcherList, 1);
 441
 442         cond->matchers = matchers;
 443         cond->bool_and = bool_and;
 444
 445         return cond;
 446 }
 447
 448 void matcherlist_free(MatcherList * cond)
 449 {
 450         GSList * l;
 451
 452         for(l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
 453                 matcherprop_free((MatcherProp *) l->data);
 454         }
 455         g_free(cond);
 456 }
 457
 458 /*
 459   skip the headers
 460  */
 461
 462 static void matcherlist_skip_headers(FILE *fp)
 463 {
 464         gchar buf[BUFFSIZE];
 465
 466         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1) {
 467         }
 468 }
 469
 470 /*
 471   matcherprop_match_one_header
 472   returns TRUE if buf matchs the MatchersProp criteria
 473  */
 474
 475 static gboolean matcherprop_match_one_header(MatcherProp * matcher,
 476                                              gchar * buf)
 477 {
 478         gboolean result;
 479         Header *header;
 480
 481         switch(matcher->criteria) {
 482         case MATCHCRITERIA_HEADER:
 483         case MATCHCRITERIA_NOT_HEADER:
 484                 header = procheader_parse_header(buf);
 485                 if (!header)
 486                         return FALSE;
 487                 if (procheader_headername_equal(header->name,
 488                                                 matcher->header)) {
 489                         if (matcher->criteria == MATCHCRITERIA_HEADER)
 490                                 result = matcherprop_string_match(matcher, header->body);
 491                         else
 492                                 result = !matcherprop_string_match(matcher, header->body);
 493                         procheader_header_free(header);
 494                         return result;
 495                 }
 496                 else {
 497                         procheader_header_free(header);
 498                 }
 499                 break;
 500         case MATCHCRITERIA_HEADERS_PART:
 501         case MATCHCRITERIA_MESSAGE:
 502                 return matcherprop_string_match(matcher, buf);
 503         case MATCHCRITERIA_NOT_MESSAGE:
 504         case MATCHCRITERIA_NOT_HEADERS_PART:
 505                 return !matcherprop_string_match(matcher, buf);
 506         }
 507         return FALSE;
 508 }
 509
 510 /*
 511   matcherprop_criteria_header
 512   returns TRUE if the headers must be matched
 513  */
 514
 515 static gboolean matcherprop_criteria_headers(MatcherProp * matcher)
 516 {
 517         switch(matcher->criteria) {
 518         case MATCHCRITERIA_HEADER:
 519         case MATCHCRITERIA_NOT_HEADER:
 520         case MATCHCRITERIA_HEADERS_PART:
 521         case MATCHCRITERIA_NOT_HEADERS_PART:
 522                 return TRUE;
 523         default:
 524                 return FALSE;
 525         }
 526 }
 527
 528 static gboolean matcherprop_criteria_message(MatcherProp * matcher)
 529 {
 530         switch(matcher->criteria) {
 531         case MATCHCRITERIA_MESSAGE:
 532         case MATCHCRITERIA_NOT_MESSAGE:
 533                 return TRUE;
 534         default:
 535                 return FALSE;
 536         }
 537 }
 538
 539 /*
 540   matcherlist_match_one_header
 541   returns TRUE if match should stop
 542  */
 543
 544 static gboolean matcherlist_match_one_header(MatcherList * matchers,
 545                                          gchar * buf)
 546 {
 547         GSList * l;
 548
 549         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 550                 MatcherProp * matcher = (MatcherProp *) l->data;
 551
 552                 if (matcherprop_criteria_headers(matcher) ||
 553                     matcherprop_criteria_message(matcher)) {
 554                         if (matcherprop_match_one_header(matcher, buf)) {
 555                                 matcher->result = TRUE;
 556                         }
 557                 }
 558
 559                 if (matcherprop_criteria_headers(matcher)) {
 560                         if (matcher->result) {
 561                                 if (!matchers->bool_and)
 562                                         return TRUE;
 563                         }
 564                 }
 565         }
 566
 567         return FALSE;
 568 }
 569
 570 /*
 571   matcherlist_match_headers
 572   returns TRUE if one of the headers matchs the MatcherList criteria
 573  */
 574
 575 static gboolean matcherlist_match_headers(MatcherList * matchers, FILE * fp)
 576 {
 577         gchar buf[BUFFSIZE];
 578
 579         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
 580                 if (matcherlist_match_one_header(matchers, buf))
 581                         return TRUE;
 582
 583         return FALSE;
 584 }
 585
 586 /*
 587   matcherprop_criteria_body
 588   returns TRUE if the body must be matched
 589  */
 590
 591 static gboolean matcherprop_criteria_body(MatcherProp * matcher)
 592 {
 593         switch(matcher->criteria) {
 594         case MATCHCRITERIA_BODY_PART:
 595         case MATCHCRITERIA_NOT_BODY_PART:
 596                 return TRUE;
 597         default:
 598                 return FALSE;
 599         }
 600 }
 601
 602 /*
 603   matcherprop_match_line
 604   returns TRUE if the string matchs the MatcherProp criteria
 605  */
 606
 607 static gboolean matcherprop_match_line(MatcherProp * matcher, gchar * line)
 608 {
 609         switch(matcher->criteria) {
 610         case MATCHCRITERIA_BODY_PART:
 611         case MATCHCRITERIA_MESSAGE:
 612                 return matcherprop_string_match(matcher, line);
 613         case MATCHCRITERIA_NOT_BODY_PART:
 614         case MATCHCRITERIA_NOT_MESSAGE:
 615                 return !matcherprop_string_match(matcher, line);
 616         }
 617         return FALSE;
 618 }
 619
 620 /*
 621   matcherlist_match_line
 622   returns TRUE if the string matchs the MatcherList criteria
 623  */
 624
 625 static gboolean matcherlist_match_line(MatcherList * matchers, gchar * line)
 626 {
 627         GSList * l;
 628
 629         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 630                 MatcherProp * matcher = (MatcherProp *) l->data;
 631
 632                 if (matcherprop_criteria_body(matcher) ||
 633                     matcherprop_criteria_message(matcher)) {
 634                         if (matcherprop_match_line(matcher, line)) {
 635                                 matcher->result = TRUE;
 636                         }
 637                 }
 638
 639                 if (matcher->result) {
 640                         if (!matchers->bool_and)
 641                                 return TRUE;
 642                 }
 643         }
 644         return FALSE;
 645 }
 646
 647 /*
 648   matcherlist_match_body
 649   returns TRUE if one line of the body matchs the MatcherList criteria
 650  */
 651
 652 static gboolean matcherlist_match_body(MatcherList * matchers, FILE * fp)
 653 {
 654         gchar buf[BUFFSIZE];
 655
 656         while (fgets(buf, sizeof(buf), fp) != NULL)
 657                 if (matcherlist_match_line(matchers, buf))
 658                         return TRUE;
 659
 660         return FALSE;
 661 }
 662
 663 gboolean matcherlist_match_file(MatcherList * matchers, MsgInfo * info,
 664                                 gboolean result)
 665 {
 666         gboolean read_headers;
 667         gboolean read_body;
 668         GSList * l;
 669         FILE * fp;
 670         gchar * file;
 671
 672         /* file need to be read ? */
 673
 674         read_headers = FALSE;
 675         read_body = FALSE;
 676         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 677                 MatcherProp * matcher = (MatcherProp *) l->data;
 678
 679                 if (matcherprop_criteria_headers(matcher))
 680                         read_headers = TRUE;
 681                 if (matcherprop_criteria_body(matcher))
 682                         read_body = TRUE;
 683                 if (matcherprop_criteria_message(matcher)) {
 684                         read_headers = TRUE;
 685                         read_body = TRUE;
 686                 }
 687                 matcher->result = FALSE;
 688         }
 689
 690         if (!read_headers && !read_body)
 691                 return result;
 692
 693         file = procmsg_get_message_file(info);
 694         if (file == NULL)
 695                 return FALSE;
 696
 697         if ((fp = fopen(file, "rb")) == NULL) {
 698                 FILE_OP_ERROR(file, "fopen");
 699                 g_free(file);
 700                 return result;
 701         }
 702
 703         /* read the headers */
 704
 705         if (read_headers) {
 706                 if (matcherlist_match_headers(matchers, fp))
 707                         read_body = FALSE;
 708         }
 709         else {
 710                 matcherlist_skip_headers(fp);
 711         }
 712
 713         /* read the body */
 714         if (read_body) {
 715                 matcherlist_match_body(matchers, fp);
 716         }
 717
 718         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 719                 MatcherProp * matcher = (MatcherProp *) l->data;
 720
 721                 if (matcherprop_criteria_headers(matcher) ||
 722                     matcherprop_criteria_body(matcher)    ||
 723                     matcherprop_criteria_message(matcher)) {
 724                         if (matcher->result) {
 725                                 if (!matchers->bool_and) {
 726                                         result = TRUE;
 727                                         break;
 728                                 }
 729                         }
 730                         else {
 731                                 if (matchers->bool_and) {
 732                                         result = FALSE;
 733                                         break;
 734                                 }
 735                         }
 736                 }
 737         }
 738
 739         g_free(file);
 740
 741         fclose(fp);
 742
 743         return result;
 744 }
 745
 746 /* test a list of condition */
 747
 748 gboolean matcherlist_match(MatcherList * matchers, MsgInfo * info)
 749 {
 750         GSList * l;
 751         gboolean result;
 752
 753         if (matchers->bool_and)
 754                 result = TRUE;
 755         else
 756                 result = FALSE;
 757
 758         /* test the cached elements */
 759
 760         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 761                 MatcherProp * matcher = (MatcherProp *) l->data;
 762
 763                 switch(matcher->criteria) {
 764                 case MATCHCRITERIA_ALL:
 765                 case MATCHCRITERIA_UNREAD:
 766                 case MATCHCRITERIA_NOT_UNREAD:
 767                 case MATCHCRITERIA_NEW:
 768                 case MATCHCRITERIA_NOT_NEW:
 769                 case MATCHCRITERIA_MARKED:
 770                 case MATCHCRITERIA_NOT_MARKED:
 771                 case MATCHCRITERIA_DELETED:
 772                 case MATCHCRITERIA_NOT_DELETED:
 773                 case MATCHCRITERIA_REPLIED:
 774                 case MATCHCRITERIA_NOT_REPLIED:
 775                 case MATCHCRITERIA_FORWARDED:
 776                 case MATCHCRITERIA_NOT_FORWARDED:
 777                 case MATCHCRITERIA_SUBJECT:
 778                 case MATCHCRITERIA_NOT_SUBJECT:
 779                 case MATCHCRITERIA_FROM:
 780                 case MATCHCRITERIA_NOT_FROM:
 781                 case MATCHCRITERIA_TO:
 782                 case MATCHCRITERIA_NOT_TO:
 783                 case MATCHCRITERIA_CC:
 784                 case MATCHCRITERIA_NOT_CC:
 785                 case MATCHCRITERIA_TO_OR_CC:
 786                 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
 787                 case MATCHCRITERIA_AGE_GREATER:
 788                 case MATCHCRITERIA_AGE_LOWER:
 789                 case MATCHCRITERIA_NEWSGROUPS:
 790                 case MATCHCRITERIA_NOT_NEWSGROUPS:
 791                 case MATCHCRITERIA_INREPLYTO:
 792                 case MATCHCRITERIA_NOT_INREPLYTO:
 793                 case MATCHCRITERIA_REFERENCES:
 794                 case MATCHCRITERIA_NOT_REFERENCES:
 795                 case MATCHCRITERIA_SCORE_GREATER:
 796                 case MATCHCRITERIA_SCORE_LOWER:
 797                 case MATCHCRITERIA_SCORE_EQUAL:
 798                 case MATCHCRITERIA_SIZE_GREATER:
 799                 case MATCHCRITERIA_SIZE_SMALLER:
 800                 case MATCHCRITERIA_SIZE_EQUAL:
 801                 case MATCHCRITERIA_EXECUTE:
 802                 case MATCHCRITERIA_NOT_EXECUTE:
 803                         if (matcherprop_match(matcher, info)) {
 804                                 if (!matchers->bool_and) {
 805                                         return TRUE;
 806                                 }
 807                         }
 808                         else {
 809                                 if (matchers->bool_and) {
 810                                         return FALSE;
 811                                 }
 812                         }
 813                 }
 814         }
 815
 816         /* test the condition on the file */
 817
 818         if (matcherlist_match_file(matchers, info, result)) {
 819                 if (!matchers->bool_and)
 820                         return TRUE;
 821         }
 822         else {
 823                 if (matchers->bool_and)
 824                         return FALSE;
 825         }
 826
 827         return result;
 828 }
 829
 830
 831 gchar * matcherprop_to_string(MatcherProp * matcher)
 832 {
 833         gchar * matcher_str = NULL;
 834         gchar * criteria_str;
 835         gchar * matchtype_str;
 836         int i;
 837
 838         criteria_str = NULL;
 839         for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
 840             i++) {
 841                 if (matchparser_tab[i].id == matcher->criteria)
 842                         criteria_str = matchparser_tab[i].str;
 843         }
 844         if (criteria_str == NULL)
 845                 return NULL;
 846
 847         switch(matcher->criteria) {
 848         case MATCHCRITERIA_AGE_GREATER:
 849         case MATCHCRITERIA_AGE_LOWER:
 850         case MATCHCRITERIA_SCORE_GREATER:
 851         case MATCHCRITERIA_SCORE_LOWER:
 852         case MATCHCRITERIA_SCORE_EQUAL:
 853         case MATCHCRITERIA_SIZE_GREATER:
 854         case MATCHCRITERIA_SIZE_SMALLER:
 855         case MATCHCRITERIA_SIZE_EQUAL:
 856                 return g_strdup_printf("%s %i", criteria_str, matcher->value);
 857         case MATCHCRITERIA_ALL:
 858         case MATCHCRITERIA_UNREAD:
 859         case MATCHCRITERIA_NOT_UNREAD:
 860         case MATCHCRITERIA_NEW:
 861         case MATCHCRITERIA_NOT_NEW:
 862         case MATCHCRITERIA_MARKED:
 863         case MATCHCRITERIA_NOT_MARKED:
 864         case MATCHCRITERIA_DELETED:
 865         case MATCHCRITERIA_NOT_DELETED:
 866         case MATCHCRITERIA_REPLIED:
 867         case MATCHCRITERIA_NOT_REPLIED:
 868         case MATCHCRITERIA_FORWARDED:
 869         case MATCHCRITERIA_NOT_FORWARDED:
 870                 return g_strdup(criteria_str);
 871         case MATCHCRITERIA_EXECUTE:
 872         case MATCHCRITERIA_NOT_EXECUTE:
 873                 return g_strdup_printf("%s \"%s\"", criteria_str, matcher->expr);
 874         }
 875
 876         matchtype_str = NULL;
 877         for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
 878             i++) {
 879                 if (matchparser_tab[i].id == matcher->matchtype)
 880                         matchtype_str = matchparser_tab[i].str;
 881         }
 882
 883         if (matchtype_str == NULL)
 884                 return NULL;
 885
 886         switch (matcher->matchtype) {
 887         case MATCHTYPE_MATCH:
 888         case MATCHTYPE_MATCHCASE:
 889         case MATCHTYPE_REGEXP:
 890         case MATCHTYPE_REGEXPCASE:
 891                 if (matcher->header)
 892                         matcher_str =
 893                                 g_strdup_printf("%s \"%s\" %s \"%s\"",
 894                                            criteria_str, matcher->header,
 895                                            matchtype_str, matcher->expr);
 896                 else
 897                         matcher_str =
 898                                 g_strdup_printf("%s %s \"%s\"", criteria_str,
 899                                                 matchtype_str, matcher->expr);
 900                 break;
 901         }
 902
 903         return matcher_str;
 904 }
 905
 906 gchar * matcherlist_to_string(MatcherList * matchers)
 907 {
 908         gint count;
 909         gchar ** vstr;
 910         GSList * l;
 911         gchar ** cur_str;
 912         gchar * result;
 913
 914         count = g_slist_length(matchers->matchers);
 915         vstr = g_new(gchar *, count + 1);
 916
 917         for (l = matchers->matchers, cur_str = vstr ; l != NULL ;
 918              l = g_slist_next(l), cur_str ++) {
 919                 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
 920                 if (*cur_str == NULL)
 921                         break;
 922         }
 923         *cur_str = NULL;
 924
 925         if (matchers->bool_and)
 926                 result = g_strjoinv(" & ", vstr);
 927         else
 928                 result = g_strjoinv(" | ", vstr);
 929
 930         for(cur_str = vstr ; *cur_str != NULL ; cur_str ++)
 931                 g_free(*cur_str);
 932         g_free(vstr);
 933
 934         return result;
 935 }
 936
 937 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
 938 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
 939 /* matching_build_command() - preferably cmd should be unescaped */
 940 gchar * matching_build_command(gchar * cmd, MsgInfo * info)
 941 {
 942         gchar * s = cmd;
 943         gchar * filename = NULL;
 944         gchar * processed_cmd;
 945         gchar * p;
 946         gint size;
 947
 948         const gchar *const no_subject    = _("(none)") ;
 949         const gchar *const no_from       = _("(none)") ;
 950         const gchar *const no_to         = _("(none)") ;
 951         const gchar *const no_cc         = _("(none)") ;
 952         const gchar *const no_date       = _("(none)") ;
 953         const gchar *const no_msgid      = _("(none)") ;
 954         const gchar *const no_newsgroups = _("(none)") ;
 955         const gchar *const no_references = _("(none)") ;
 956
 957         size = STRLEN_ZERO(cmd) + 1;
 958         while (*s != '\0') {
 959                 if (*s == '%') {
 960                         s++;
 961                         switch (*s) {
 962                         case '%':
 963                                 size -= 1;
 964                                 break;
 965                         case 's': /* subject */
 966                                 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
 967                                 break;
 968                         case 'f': /* from */
 969                                 size += STRLEN_DEFAULT(info->from, no_from) - 2;
 970                                 break;
 971                         case 't': /* to */
 972                                 size += STRLEN_DEFAULT(info->to, no_to) - 2;
 973                                 break;
 974                         case 'c': /* cc */
 975                                 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
 976                                 break;
 977                         case 'd': /* date */
 978                                 size += STRLEN_DEFAULT(info->date, no_date) - 2;
 979                                 break;
 980                         case 'i': /* message-id */
 981                                 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
 982                                 break;
 983                         case 'n': /* newsgroups */
 984                                 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
 985                                 break;
 986                         case 'r': /* references */
 987                                 size += STRLEN_DEFAULT(info->references, no_references) - 2;
 988                                 break;
 989                         case 'F': /* file */
 990                                 filename = folder_item_fetch_msg(info->folder,
 991                                                                  info->msgnum);
 992
 993                                 if (filename == NULL) {
 994                                         g_warning(_("filename is not set"));
 995                                         return NULL;
 996                                 }
 997                                 else
 998                                         size += strlen(filename) - 2;
 999                                 break;
1000                         }
1001                         s++;
1002                 }
1003                 else s++;
1004         }
1005
1006
1007         processed_cmd = g_new0(gchar, size);
1008         s = cmd;
1009         p = processed_cmd;
1010
1011         while (*s != '\0') {
1012                 if (*s == '%') {
1013                         s++;
1014                         switch (*s) {
1015                         case '%':
1016                                 *p = '%';
1017                                 p++;
1018                                 break;
1019                         case 's': /* subject */
1020                                 if (info->subject != NULL)
1021                                         strcpy(p, info->subject);
1022                                 else
1023                                         strcpy(p, no_subject);
1024                                 p += strlen(p);
1025                                 break;
1026                         case 'f': /* from */
1027                                 if (info->from != NULL)
1028                                         strcpy(p, info->from);
1029                                 else
1030                                         strcpy(p, no_from);
1031                                 p += strlen(p);
1032                                 break;
1033                         case 't': /* to */
1034                                 if (info->to != NULL)
1035                                         strcpy(p, info->to);
1036                                 else
1037                                         strcpy(p, no_to);
1038                                 p += strlen(p);
1039                                 break;
1040                         case 'c': /* cc */
1041                                 if (info->cc != NULL)
1042                                         strcpy(p, info->cc);
1043                                 else
1044                                         strcpy(p, no_cc);
1045                                 p += strlen(p);
1046                                 break;
1047                         case 'd': /* date */
1048                                 if (info->date != NULL)
1049                                         strcpy(p, info->date);
1050                                 else
1051                                         strcpy(p, no_date);
1052                                 p += strlen(p);
1053                                 break;
1054                         case 'i': /* message-id */
1055                                 if (info->msgid != NULL)
1056                                         strcpy(p, info->msgid);
1057                                 else
1058                                         strcpy(p, no_msgid);
1059                                 p += strlen(p);
1060                                 break;
1061                         case 'n': /* newsgroups */
1062                                 if (info->newsgroups != NULL)
1063                                         strcpy(p, info->newsgroups);
1064                                 else
1065                                         strcpy(p, no_newsgroups);
1066                                 p += strlen(p);
1067                                 break;
1068                         case 'r': /* references */
1069                                 if (info->references != NULL)
1070                                         strcpy(p, info->references);
1071                                 else
1072                                         strcpy(p, no_references);
1073                                 p += strlen(p);
1074                                 break;
1075                         case 'F': /* file */
1076                                 strcpy(p, filename);
1077                                 p += strlen(p);
1078                                 g_free(filename);
1079                                 break;
1080                         default:
1081                                 *p = '%';
1082                                 p++;
1083                                 *p = *s;
1084                                 p++;
1085                                 break;
1086                         }
1087                         s++;
1088                 }
1089                 else {
1090                         *p = *s;
1091                         p++;
1092                         s++;
1093                 }
1094         }
1095
1096         debug_print("*** exec string \"%s\"\n", processed_cmd);
1097         return processed_cmd;
1098 }
1099 #undef STRLEN_DEFAULT
1100 #undef STRLEN_ZERO
1101
1102 /* ************************************************************ */
1103
1104 static void prefs_scoring_write(FILE * fp, GSList * prefs_scoring)
1105 {
1106         GSList * cur;
1107
1108         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1109                 gchar *scoring_str;
1110                 ScoringProp * prop;
1111
1112                 prop = (ScoringProp *) cur->data;
1113                 scoring_str = scoringprop_to_string(prop);
1114                 if (fputs(scoring_str, fp) == EOF ||
1115                     fputc('\n', fp) == EOF) {
1116                         FILE_OP_ERROR("scoring config", "fputs || fputc");
1117                         g_free(scoring_str);
1118                         return;
1119                 }
1120                 g_free(scoring_str);
1121         }
1122 }
1123
1124 static void prefs_filtering_write(FILE * fp, GSList * prefs_scoring)
1125 {
1126         GSList * cur;
1127
1128         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1129                 gchar *filtering_str;
1130                 FilteringProp * prop;
1131
1132                 if (NULL == (prop = (FilteringProp *) cur->data))
1133                         continue;
1134
1135                 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1136                         continue;
1137
1138                 if (fputs(filtering_str, fp) == EOF ||
1139                     fputc('\n', fp) == EOF) {
1140                         FILE_OP_ERROR("filtering config", "fputs || fputc");
1141                         g_free(filtering_str);
1142                         return;
1143                 }
1144                 g_free(filtering_str);
1145         }
1146 }
1147
1148 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1149 {
1150         FolderItem *item;
1151         FILE * fp = data;
1152         gchar * id;
1153         GSList * prefs_scoring;
1154         GSList * prefs_filtering;
1155
1156         if (node != NULL) {
1157                 item = node->data;
1158                 /* prevent from the warning */
1159                 if (item->path == NULL)
1160                         return FALSE;
1161                 id = folder_item_get_identifier(item);
1162                 if (id == NULL)
1163                         return FALSE;
1164                 prefs_scoring = item->prefs->scoring;
1165                 prefs_filtering = item->prefs->processing;
1166         }
1167         else {
1168                 item = NULL;
1169                 id = g_strdup("global"); /* because it is g_freed */
1170                 prefs_scoring = global_scoring;
1171                 prefs_filtering = global_processing;
1172         }
1173
1174         if (prefs_filtering != NULL || prefs_scoring != NULL) {
1175                 fprintf(fp, "[%s]\n", id);
1176
1177                 prefs_filtering_write(fp, prefs_filtering);
1178                 prefs_scoring_write(fp, prefs_scoring);
1179
1180                 fputc('\n', fp);
1181         }
1182
1183         g_free(id);
1184
1185         return FALSE;
1186 }
1187
1188 static void prefs_matcher_save(FILE * fp)
1189 {
1190         GList * cur;
1191
1192         for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1193                 Folder *folder;
1194
1195                 folder = (Folder *) cur->data;
1196                 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1197                                 prefs_matcher_write_func, fp);
1198         }
1199         prefs_matcher_write_func(NULL, fp);
1200 }
1201
1202
1203 void prefs_matcher_write_config(void)
1204 {
1205         gchar *rcpath;
1206         PrefFile *pfile;
1207
1208         debug_print("Writing matcher configuration...\n");
1209
1210         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1211                              MATCHER_RC, NULL);
1212
1213         if ((pfile = prefs_write_open(rcpath)) == NULL) {
1214                 g_warning(_("failed to write configuration to file\n"));
1215                 g_free(rcpath);
1216                 return;
1217         }
1218
1219
1220         prefs_matcher_save(pfile->fp);
1221
1222         g_free(rcpath);
1223
1224         if (prefs_write_close(pfile) < 0) {
1225                 g_warning(_("failed to write configuration to file\n"));
1226                 return;
1227         }
1228 }
1229
1230 /* ******************************************************************* */
1231
1232 void prefs_matcher_read_config(void)
1233 {
1234         gchar * rcpath;
1235         FILE * f;
1236
1237         prefs_scoring_clear();
1238         prefs_filtering_clear();
1239
1240         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1241         f = fopen(rcpath, "rb");
1242         g_free(rcpath);
1243
1244         if (f != NULL) {
1245                 matcher_parser_start_parsing(f);
1246                 fclose(f);
1247         }
1248         else {
1249                 /* previous version compatibily */
1250
1251                 /* printf("reading filtering\n"); */
1252                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1253                                      FILTERING_RC, NULL);
1254                 f = fopen(rcpath, "rb");
1255                 g_free(rcpath);
1256
1257                 if (f != NULL) {
1258                         matcher_parser_start_parsing(f);
1259                         fclose(matcher_parserin);
1260                 }
1261
1262                 /* printf("reading scoring\n"); */
1263                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1264                                      SCORING_RC, NULL);
1265                 f = fopen(rcpath, "rb");
1266                 g_free(rcpath);
1267
1268                 if (f != NULL) {
1269                         matcher_parser_start_parsing(f);
1270                         fclose(matcher_parserin);
1271                 }
1272         }
1273 }