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                         if (regcomp(prop->preg, prop->expr,
 278                                     REG_NOSUB | REG_EXTENDED
 279                                     | ((prop->matchtype == MATCHTYPE_REGEXPCASE)
 280                                     ? REG_ICASE : 0)) != 0) {
 281                                 prop->error = 1;
 282                                 g_free(prop->preg);
 283                                 prop->preg = NULL;
 284                         }
 285                 }
 286                 if (prop->preg == NULL)
 287                         return FALSE;
 288
 289                 if (regexec(prop->preg, str, 0, NULL, 0) == 0)
 290                         return TRUE;
 291                 else
 292                         return FALSE;
 293
 294         case MATCHTYPE_MATCH:
 295                 return (strstr(str, prop->unesc_expr) != NULL);
 296
 297         /* FIXME: put upper in unesc_str */
 298         case MATCHTYPE_MATCHCASE:
 299                 str2 = alloca(strlen(prop->unesc_expr) + 1);
 300                 strcpy(str2, prop->unesc_expr);
 301                 g_strup(str2);
 302                 str1 = alloca(strlen(str) + 1);
 303                 strcpy(str1, str);
 304                 g_strup(str1);
 305                 return (strstr(str1, str2) != NULL);
 306
 307         default:
 308                 return FALSE;
 309         }
 310 }
 311
 312 gboolean matcherprop_match_execute(MatcherProp * prop, MsgInfo * info)
 313 {
 314         gchar * file;
 315         gchar * cmd;
 316         gint retval;
 317
 318         file = procmsg_get_message_file(info);
 319         if (file == NULL)
 320                 return FALSE;
 321         g_free(file);
 322
 323         cmd = matching_build_command(prop->unesc_expr, info);
 324         if (cmd == NULL)
 325                 return FALSE;
 326
 327         retval = system(cmd);
 328         debug_print("Command exit code: %d\n", retval);
 329
 330         g_free(cmd);
 331         return (retval == 0);
 332 }
 333
 334 /* match a message and his headers, hlist can be NULL if you don't
 335    want to use headers */
 336
 337 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info)
 338 {
 339         time_t t;
 340
 341         switch(prop->criteria) {
 342         case MATCHCRITERIA_ALL:
 343                 return 1;
 344         case MATCHCRITERIA_UNREAD:
 345                 return MSG_IS_UNREAD(info->flags);
 346         case MATCHCRITERIA_NOT_UNREAD:
 347                 return !MSG_IS_UNREAD(info->flags);
 348         case MATCHCRITERIA_NEW:
 349                 return MSG_IS_NEW(info->flags);
 350         case MATCHCRITERIA_NOT_NEW:
 351                 return !MSG_IS_NEW(info->flags);
 352         case MATCHCRITERIA_MARKED:
 353                 return MSG_IS_MARKED(info->flags);
 354         case MATCHCRITERIA_NOT_MARKED:
 355                 return !MSG_IS_MARKED(info->flags);
 356         case MATCHCRITERIA_DELETED:
 357                 return MSG_IS_DELETED(info->flags);
 358         case MATCHCRITERIA_NOT_DELETED:
 359                 return !MSG_IS_DELETED(info->flags);
 360         case MATCHCRITERIA_REPLIED:
 361                 return MSG_IS_REPLIED(info->flags);
 362         case MATCHCRITERIA_NOT_REPLIED:
 363                 return !MSG_IS_REPLIED(info->flags);
 364         case MATCHCRITERIA_FORWARDED:
 365                 return MSG_IS_FORWARDED(info->flags);
 366         case MATCHCRITERIA_NOT_FORWARDED:
 367                 return !MSG_IS_FORWARDED(info->flags);
 368         case MATCHCRITERIA_SUBJECT:
 369                 return matcherprop_string_match(prop, info->subject);
 370         case MATCHCRITERIA_NOT_SUBJECT:
 371                 return !matcherprop_string_match(prop, info->subject);
 372         case MATCHCRITERIA_FROM:
 373                 return matcherprop_string_match(prop, info->from);
 374         case MATCHCRITERIA_NOT_FROM:
 375                 return !matcherprop_string_match(prop, info->from);
 376         case MATCHCRITERIA_TO:
 377                 return matcherprop_string_match(prop, info->to);
 378         case MATCHCRITERIA_NOT_TO:
 379                 return !matcherprop_string_match(prop, info->to);
 380         case MATCHCRITERIA_CC:
 381                 return matcherprop_string_match(prop, info->cc);
 382         case MATCHCRITERIA_NOT_CC:
 383                 return !matcherprop_string_match(prop, info->cc);
 384         case MATCHCRITERIA_TO_OR_CC:
 385                 return matcherprop_string_match(prop, info->to)
 386                         || matcherprop_string_match(prop, info->cc);
 387         case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
 388                 return !(matcherprop_string_match(prop, info->to)
 389                 || matcherprop_string_match(prop, info->cc));
 390         case MATCHCRITERIA_AGE_GREATER:
 391                 t = time(NULL);
 392                 return ((t - info->date_t) / (60 * 60 * 24)) >= prop->value;
 393         case MATCHCRITERIA_AGE_LOWER:
 394                 t = time(NULL);
 395                 return ((t - info->date_t) / (60 * 60 * 24)) <= prop->value;
 396         case MATCHCRITERIA_SCORE_GREATER:
 397                 return info->score >= prop->value;
 398         case MATCHCRITERIA_SCORE_LOWER:
 399                 return info->score <= prop->value;
 400         case MATCHCRITERIA_SCORE_EQUAL:
 401                 return info->score == prop->value;
 402         case MATCHCRITERIA_SIZE_GREATER:
 403                 /* FIXME: info->size is an off_t */
 404                 return info->size > (off_t) prop->value;
 405         case MATCHCRITERIA_SIZE_EQUAL:
 406                 /* FIXME: info->size is an off_t */
 407                 return info->size == (off_t) prop->value;
 408         case MATCHCRITERIA_SIZE_SMALLER:
 409                 /* FIXME: info->size is an off_t */
 410                 return info->size <  (off_t) prop->value;
 411         case MATCHCRITERIA_NEWSGROUPS:
 412                 return matcherprop_string_match(prop, info->newsgroups);
 413         case MATCHCRITERIA_NOT_NEWSGROUPS:
 414                 return !matcherprop_string_match(prop, info->newsgroups);
 415         case MATCHCRITERIA_INREPLYTO:
 416                 return matcherprop_string_match(prop, info->inreplyto);
 417         case MATCHCRITERIA_NOT_INREPLYTO:
 418                 return !matcherprop_string_match(prop, info->inreplyto);
 419         case MATCHCRITERIA_REFERENCES:
 420                 return matcherprop_string_match(prop, info->references);
 421         case MATCHCRITERIA_NOT_REFERENCES:
 422                 return !matcherprop_string_match(prop, info->references);
 423         case MATCHCRITERIA_EXECUTE:
 424                 return matcherprop_match_execute(prop, info);
 425         case MATCHCRITERIA_NOT_EXECUTE:
 426                 return !matcherprop_match_execute(prop, info);
 427         default:
 428                 return 0;
 429         }
 430 }
 431
 432 /* ********************* MatcherList *************************** */
 433
 434
 435 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and)
 436 {
 437         MatcherList * cond;
 438
 439         cond = g_new0(MatcherList, 1);
 440
 441         cond->matchers = matchers;
 442         cond->bool_and = bool_and;
 443
 444         return cond;
 445 }
 446
 447 void matcherlist_free(MatcherList * cond)
 448 {
 449         GSList * l;
 450
 451         for(l = cond->matchers ; l != NULL ; l = g_slist_next(l)) {
 452                 matcherprop_free((MatcherProp *) l->data);
 453         }
 454         g_free(cond);
 455 }
 456
 457 /*
 458   skip the headers
 459  */
 460
 461 static void matcherlist_skip_headers(FILE *fp)
 462 {
 463         gchar buf[BUFFSIZE];
 464
 465         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1) {
 466         }
 467 }
 468
 469 /*
 470   matcherprop_match_one_header
 471   returns TRUE if buf matchs the MatchersProp criteria
 472  */
 473
 474 static gboolean matcherprop_match_one_header(MatcherProp * matcher,
 475                                              gchar * buf)
 476 {
 477         gboolean result;
 478         Header *header;
 479
 480         switch(matcher->criteria) {
 481         case MATCHCRITERIA_HEADER:
 482         case MATCHCRITERIA_NOT_HEADER:
 483                 header = procheader_parse_header(buf);
 484                 if (!header)
 485                         return FALSE;
 486                 if (procheader_headername_equal(header->name,
 487                                                 matcher->header)) {
 488                         if (matcher->criteria == MATCHCRITERIA_HEADER)
 489                                 result = matcherprop_string_match(matcher, header->body);
 490                         else
 491                                 result = !matcherprop_string_match(matcher, header->body);
 492                         procheader_header_free(header);
 493                         return result;
 494                 }
 495                 else {
 496                         procheader_header_free(header);
 497                 }
 498                 break;
 499         case MATCHCRITERIA_HEADERS_PART:
 500         case MATCHCRITERIA_MESSAGE:
 501                 return matcherprop_string_match(matcher, buf);
 502         case MATCHCRITERIA_NOT_MESSAGE:
 503         case MATCHCRITERIA_NOT_HEADERS_PART:
 504                 return !matcherprop_string_match(matcher, buf);
 505         }
 506         return FALSE;
 507 }
 508
 509 /*
 510   matcherprop_criteria_header
 511   returns TRUE if the headers must be matched
 512  */
 513
 514 static gboolean matcherprop_criteria_headers(MatcherProp * matcher)
 515 {
 516         switch(matcher->criteria) {
 517         case MATCHCRITERIA_HEADER:
 518         case MATCHCRITERIA_NOT_HEADER:
 519         case MATCHCRITERIA_HEADERS_PART:
 520         case MATCHCRITERIA_NOT_HEADERS_PART:
 521                 return TRUE;
 522         default:
 523                 return FALSE;
 524         }
 525 }
 526
 527 static gboolean matcherprop_criteria_message(MatcherProp * matcher)
 528 {
 529         switch(matcher->criteria) {
 530         case MATCHCRITERIA_MESSAGE:
 531         case MATCHCRITERIA_NOT_MESSAGE:
 532                 return TRUE;
 533         default:
 534                 return FALSE;
 535         }
 536 }
 537
 538 /*
 539   matcherlist_match_one_header
 540   returns TRUE if match should stop
 541  */
 542
 543 static gboolean matcherlist_match_one_header(MatcherList * matchers,
 544                                          gchar * buf)
 545 {
 546         GSList * l;
 547
 548         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 549                 MatcherProp * matcher = (MatcherProp *) l->data;
 550
 551                 if (matcherprop_criteria_headers(matcher) ||
 552                     matcherprop_criteria_message(matcher)) {
 553                         if (matcherprop_match_one_header(matcher, buf)) {
 554                                 matcher->result = TRUE;
 555                         }
 556                 }
 557
 558                 if (matcherprop_criteria_headers(matcher)) {
 559                         if (matcher->result) {
 560                                 if (!matchers->bool_and)
 561                                         return TRUE;
 562                         }
 563                 }
 564         }
 565
 566         return FALSE;
 567 }
 568
 569 /*
 570   matcherlist_match_headers
 571   returns TRUE if one of the headers matchs the MatcherList criteria
 572  */
 573
 574 static gboolean matcherlist_match_headers(MatcherList * matchers, FILE * fp)
 575 {
 576         gchar buf[BUFFSIZE];
 577
 578         while (procheader_get_one_field(buf, sizeof(buf), fp, NULL) != -1)
 579                 if (matcherlist_match_one_header(matchers, buf))
 580                         return TRUE;
 581
 582         return FALSE;
 583 }
 584
 585 /*
 586   matcherprop_criteria_body
 587   returns TRUE if the body must be matched
 588  */
 589
 590 static gboolean matcherprop_criteria_body(MatcherProp * matcher)
 591 {
 592         switch(matcher->criteria) {
 593         case MATCHCRITERIA_BODY_PART:
 594         case MATCHCRITERIA_NOT_BODY_PART:
 595                 return TRUE;
 596         default:
 597                 return FALSE;
 598         }
 599 }
 600
 601 /*
 602   matcherprop_match_line
 603   returns TRUE if the string matchs the MatcherProp criteria
 604  */
 605
 606 static gboolean matcherprop_match_line(MatcherProp * matcher, gchar * line)
 607 {
 608         switch(matcher->criteria) {
 609         case MATCHCRITERIA_BODY_PART:
 610         case MATCHCRITERIA_MESSAGE:
 611                 return matcherprop_string_match(matcher, line);
 612         case MATCHCRITERIA_NOT_BODY_PART:
 613         case MATCHCRITERIA_NOT_MESSAGE:
 614                 return !matcherprop_string_match(matcher, line);
 615         }
 616         return FALSE;
 617 }
 618
 619 /*
 620   matcherlist_match_line
 621   returns TRUE if the string matchs the MatcherList criteria
 622  */
 623
 624 static gboolean matcherlist_match_line(MatcherList * matchers, gchar * line)
 625 {
 626         GSList * l;
 627
 628         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 629                 MatcherProp * matcher = (MatcherProp *) l->data;
 630
 631                 if (matcherprop_criteria_body(matcher) ||
 632                     matcherprop_criteria_message(matcher)) {
 633                         if (matcherprop_match_line(matcher, line)) {
 634                                 matcher->result = TRUE;
 635                         }
 636                 }
 637
 638                 if (matcher->result) {
 639                         if (!matchers->bool_and)
 640                                 return TRUE;
 641                 }
 642         }
 643         return FALSE;
 644 }
 645
 646 /*
 647   matcherlist_match_body
 648   returns TRUE if one line of the body matchs the MatcherList criteria
 649  */
 650
 651 static gboolean matcherlist_match_body(MatcherList * matchers, FILE * fp)
 652 {
 653         gchar buf[BUFFSIZE];
 654
 655         while (fgets(buf, sizeof(buf), fp) != NULL)
 656                 if (matcherlist_match_line(matchers, buf))
 657                         return TRUE;
 658
 659         return FALSE;
 660 }
 661
 662 gboolean matcherlist_match_file(MatcherList * matchers, MsgInfo * info,
 663                                 gboolean result)
 664 {
 665         gboolean read_headers;
 666         gboolean read_body;
 667         GSList * l;
 668         FILE * fp;
 669         gchar * file;
 670
 671         /* file need to be read ? */
 672
 673         read_headers = FALSE;
 674         read_body = FALSE;
 675         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 676                 MatcherProp * matcher = (MatcherProp *) l->data;
 677
 678                 if (matcherprop_criteria_headers(matcher))
 679                         read_headers = TRUE;
 680                 if (matcherprop_criteria_body(matcher))
 681                         read_body = TRUE;
 682                 if (matcherprop_criteria_message(matcher)) {
 683                         read_headers = TRUE;
 684                         read_body = TRUE;
 685                 }
 686                 matcher->result = FALSE;
 687         }
 688
 689         if (!read_headers && !read_body)
 690                 return result;
 691
 692         file = procmsg_get_message_file(info);
 693         if (file == NULL)
 694                 return FALSE;
 695
 696         if ((fp = fopen(file, "rb")) == NULL) {
 697                 FILE_OP_ERROR(file, "fopen");
 698                 g_free(file);
 699                 return result;
 700         }
 701
 702         /* read the headers */
 703
 704         if (read_headers) {
 705                 if (matcherlist_match_headers(matchers, fp))
 706                         read_body = FALSE;
 707         }
 708         else {
 709                 matcherlist_skip_headers(fp);
 710         }
 711
 712         /* read the body */
 713         if (read_body) {
 714                 matcherlist_match_body(matchers, fp);
 715         }
 716
 717         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 718                 MatcherProp * matcher = (MatcherProp *) l->data;
 719
 720                 if (matcherprop_criteria_headers(matcher) ||
 721                     matcherprop_criteria_body(matcher)    ||
 722                     matcherprop_criteria_message(matcher)) {
 723                         if (matcher->result) {
 724                                 if (!matchers->bool_and) {
 725                                         result = TRUE;
 726                                         break;
 727                                 }
 728                         }
 729                         else {
 730                                 if (matchers->bool_and) {
 731                                         result = FALSE;
 732                                         break;
 733                                 }
 734                         }
 735                 }
 736         }
 737
 738         g_free(file);
 739
 740         fclose(fp);
 741
 742         return result;
 743 }
 744
 745 /* test a list of condition */
 746
 747 gboolean matcherlist_match(MatcherList * matchers, MsgInfo * info)
 748 {
 749         GSList * l;
 750         gboolean result;
 751
 752         if (matchers->bool_and)
 753                 result = TRUE;
 754         else
 755                 result = FALSE;
 756
 757         /* test the cached elements */
 758
 759         for(l = matchers->matchers ; l != NULL ; l = g_slist_next(l)) {
 760                 MatcherProp * matcher = (MatcherProp *) l->data;
 761
 762                 switch(matcher->criteria) {
 763                 case MATCHCRITERIA_ALL:
 764                 case MATCHCRITERIA_UNREAD:
 765                 case MATCHCRITERIA_NOT_UNREAD:
 766                 case MATCHCRITERIA_NEW:
 767                 case MATCHCRITERIA_NOT_NEW:
 768                 case MATCHCRITERIA_MARKED:
 769                 case MATCHCRITERIA_NOT_MARKED:
 770                 case MATCHCRITERIA_DELETED:
 771                 case MATCHCRITERIA_NOT_DELETED:
 772                 case MATCHCRITERIA_REPLIED:
 773                 case MATCHCRITERIA_NOT_REPLIED:
 774                 case MATCHCRITERIA_FORWARDED:
 775                 case MATCHCRITERIA_NOT_FORWARDED:
 776                 case MATCHCRITERIA_SUBJECT:
 777                 case MATCHCRITERIA_NOT_SUBJECT:
 778                 case MATCHCRITERIA_FROM:
 779                 case MATCHCRITERIA_NOT_FROM:
 780                 case MATCHCRITERIA_TO:
 781                 case MATCHCRITERIA_NOT_TO:
 782                 case MATCHCRITERIA_CC:
 783                 case MATCHCRITERIA_NOT_CC:
 784                 case MATCHCRITERIA_TO_OR_CC:
 785                 case MATCHCRITERIA_NOT_TO_AND_NOT_CC:
 786                 case MATCHCRITERIA_AGE_GREATER:
 787                 case MATCHCRITERIA_AGE_LOWER:
 788                 case MATCHCRITERIA_NEWSGROUPS:
 789                 case MATCHCRITERIA_NOT_NEWSGROUPS:
 790                 case MATCHCRITERIA_INREPLYTO:
 791                 case MATCHCRITERIA_NOT_INREPLYTO:
 792                 case MATCHCRITERIA_REFERENCES:
 793                 case MATCHCRITERIA_NOT_REFERENCES:
 794                 case MATCHCRITERIA_SCORE_GREATER:
 795                 case MATCHCRITERIA_SCORE_LOWER:
 796                 case MATCHCRITERIA_SCORE_EQUAL:
 797                 case MATCHCRITERIA_SIZE_GREATER:
 798                 case MATCHCRITERIA_SIZE_SMALLER:
 799                 case MATCHCRITERIA_SIZE_EQUAL:
 800                 case MATCHCRITERIA_EXECUTE:
 801                 case MATCHCRITERIA_NOT_EXECUTE:
 802                         if (matcherprop_match(matcher, info)) {
 803                                 if (!matchers->bool_and) {
 804                                         return TRUE;
 805                                 }
 806                         }
 807                         else {
 808                                 if (matchers->bool_and) {
 809                                         return FALSE;
 810                                 }
 811                         }
 812                 }
 813         }
 814
 815         /* test the condition on the file */
 816
 817         if (matcherlist_match_file(matchers, info, result)) {
 818                 if (!matchers->bool_and)
 819                         return TRUE;
 820         }
 821         else {
 822                 if (matchers->bool_and)
 823                         return FALSE;
 824         }
 825
 826         return result;
 827 }
 828
 829
 830 gchar * matcherprop_to_string(MatcherProp * matcher)
 831 {
 832         gchar * matcher_str = NULL;
 833         gchar * criteria_str;
 834         gchar * matchtype_str;
 835         int i;
 836
 837         criteria_str = NULL;
 838         for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
 839             i++) {
 840                 if (matchparser_tab[i].id == matcher->criteria)
 841                         criteria_str = matchparser_tab[i].str;
 842         }
 843         if (criteria_str == NULL)
 844                 return NULL;
 845
 846         switch(matcher->criteria) {
 847         case MATCHCRITERIA_AGE_GREATER:
 848         case MATCHCRITERIA_AGE_LOWER:
 849         case MATCHCRITERIA_SCORE_GREATER:
 850         case MATCHCRITERIA_SCORE_LOWER:
 851         case MATCHCRITERIA_SCORE_EQUAL:
 852         case MATCHCRITERIA_SIZE_GREATER:
 853         case MATCHCRITERIA_SIZE_SMALLER:
 854         case MATCHCRITERIA_SIZE_EQUAL:
 855                 return g_strdup_printf("%s %i", criteria_str, matcher->value);
 856         case MATCHCRITERIA_ALL:
 857         case MATCHCRITERIA_UNREAD:
 858         case MATCHCRITERIA_NOT_UNREAD:
 859         case MATCHCRITERIA_NEW:
 860         case MATCHCRITERIA_NOT_NEW:
 861         case MATCHCRITERIA_MARKED:
 862         case MATCHCRITERIA_NOT_MARKED:
 863         case MATCHCRITERIA_DELETED:
 864         case MATCHCRITERIA_NOT_DELETED:
 865         case MATCHCRITERIA_REPLIED:
 866         case MATCHCRITERIA_NOT_REPLIED:
 867         case MATCHCRITERIA_FORWARDED:
 868         case MATCHCRITERIA_NOT_FORWARDED:
 869                 return g_strdup(criteria_str);
 870         case MATCHCRITERIA_EXECUTE:
 871         case MATCHCRITERIA_NOT_EXECUTE:
 872                 return g_strdup_printf("%s \"%s\"", criteria_str, matcher->expr);
 873         }
 874
 875         matchtype_str = NULL;
 876         for(i = 0 ; i < (int) (sizeof(matchparser_tab) / sizeof(MatchParser)) ;
 877             i++) {
 878                 if (matchparser_tab[i].id == matcher->matchtype)
 879                         matchtype_str = matchparser_tab[i].str;
 880         }
 881
 882         if (matchtype_str == NULL)
 883                 return NULL;
 884
 885         switch (matcher->matchtype) {
 886         case MATCHTYPE_MATCH:
 887         case MATCHTYPE_MATCHCASE:
 888         case MATCHTYPE_REGEXP:
 889         case MATCHTYPE_REGEXPCASE:
 890                 if (matcher->header)
 891                         matcher_str =
 892                                 g_strdup_printf("%s \"%s\" %s \"%s\"",
 893                                            criteria_str, matcher->header,
 894                                            matchtype_str, matcher->expr);
 895                 else
 896                         matcher_str =
 897                                 g_strdup_printf("%s %s \"%s\"", criteria_str,
 898                                                 matchtype_str, matcher->expr);
 899                 break;
 900         }
 901
 902         return matcher_str;
 903 }
 904
 905 gchar * matcherlist_to_string(MatcherList * matchers)
 906 {
 907         gint count;
 908         gchar ** vstr;
 909         GSList * l;
 910         gchar ** cur_str;
 911         gchar * result;
 912
 913         count = g_slist_length(matchers->matchers);
 914         vstr = g_new(gchar *, count + 1);
 915
 916         for (l = matchers->matchers, cur_str = vstr ; l != NULL ;
 917              l = g_slist_next(l), cur_str ++) {
 918                 *cur_str = matcherprop_to_string((MatcherProp *) l->data);
 919                 if (*cur_str == NULL)
 920                         break;
 921         }
 922         *cur_str = NULL;
 923
 924         if (matchers->bool_and)
 925                 result = g_strjoinv(" & ", vstr);
 926         else
 927                 result = g_strjoinv(" | ", vstr);
 928
 929         for(cur_str = vstr ; *cur_str != NULL ; cur_str ++)
 930                 g_free(*cur_str);
 931         g_free(vstr);
 932
 933         return result;
 934 }
 935
 936 #define STRLEN_ZERO(s) ((s) ? strlen(s) : 0)
 937 #define STRLEN_DEFAULT(s,d) ((s) ? strlen(s) : STRLEN_ZERO(d))
 938 /* matching_build_command() - preferably cmd should be unescaped */
 939 gchar * matching_build_command(gchar * cmd, MsgInfo * info)
 940 {
 941         gchar * s = cmd;
 942         gchar * filename = NULL;
 943         gchar * processed_cmd;
 944         gchar * p;
 945         gint size;
 946
 947         const gchar *const no_subject    = _("(none)") ;
 948         const gchar *const no_from       = _("(none)") ;
 949         const gchar *const no_to         = _("(none)") ;
 950         const gchar *const no_cc         = _("(none)") ;
 951         const gchar *const no_date       = _("(none)") ;
 952         const gchar *const no_msgid      = _("(none)") ;
 953         const gchar *const no_newsgroups = _("(none)") ;
 954         const gchar *const no_references = _("(none)") ;
 955
 956         size = STRLEN_ZERO(cmd) + 1;
 957         while (*s != '\0') {
 958                 if (*s == '%') {
 959                         s++;
 960                         switch (*s) {
 961                         case '%':
 962                                 size -= 1;
 963                                 break;
 964                         case 's': /* subject */
 965                                 size += STRLEN_DEFAULT(info->subject, no_subject) - 2;
 966                                 break;
 967                         case 'f': /* from */
 968                                 size += STRLEN_DEFAULT(info->from, no_from) - 2;
 969                                 break;
 970                         case 't': /* to */
 971                                 size += STRLEN_DEFAULT(info->to, no_to) - 2;
 972                                 break;
 973                         case 'c': /* cc */
 974                                 size += STRLEN_DEFAULT(info->cc, no_cc) - 2;
 975                                 break;
 976                         case 'd': /* date */
 977                                 size += STRLEN_DEFAULT(info->date, no_date) - 2;
 978                                 break;
 979                         case 'i': /* message-id */
 980                                 size += STRLEN_DEFAULT(info->msgid, no_msgid) - 2;
 981                                 break;
 982                         case 'n': /* newsgroups */
 983                                 size += STRLEN_DEFAULT(info->newsgroups, no_newsgroups) - 2;
 984                                 break;
 985                         case 'r': /* references */
 986                                 size += STRLEN_DEFAULT(info->references, no_references) - 2;
 987                                 break;
 988                         case 'F': /* file */
 989                                 filename = folder_item_fetch_msg(info->folder,
 990                                                                  info->msgnum);
 991
 992                                 if (filename == NULL) {
 993                                         g_warning(_("filename is not set"));
 994                                         return NULL;
 995                                 }
 996                                 else
 997                                         size += strlen(filename) - 2;
 998                                 break;
 999                         }
1000                         s++;
1001                 }
1002                 else s++;
1003         }
1004
1005
1006         processed_cmd = g_new0(gchar, size);
1007         s = cmd;
1008         p = processed_cmd;
1009
1010         while (*s != '\0') {
1011                 if (*s == '%') {
1012                         s++;
1013                         switch (*s) {
1014                         case '%':
1015                                 *p = '%';
1016                                 p++;
1017                                 break;
1018                         case 's': /* subject */
1019                                 if (info->subject != NULL)
1020                                         strcpy(p, info->subject);
1021                                 else
1022                                         strcpy(p, no_subject);
1023                                 p += strlen(p);
1024                                 break;
1025                         case 'f': /* from */
1026                                 if (info->from != NULL)
1027                                         strcpy(p, info->from);
1028                                 else
1029                                         strcpy(p, no_from);
1030                                 p += strlen(p);
1031                                 break;
1032                         case 't': /* to */
1033                                 if (info->to != NULL)
1034                                         strcpy(p, info->to);
1035                                 else
1036                                         strcpy(p, no_to);
1037                                 p += strlen(p);
1038                                 break;
1039                         case 'c': /* cc */
1040                                 if (info->cc != NULL)
1041                                         strcpy(p, info->cc);
1042                                 else
1043                                         strcpy(p, no_cc);
1044                                 p += strlen(p);
1045                                 break;
1046                         case 'd': /* date */
1047                                 if (info->date != NULL)
1048                                         strcpy(p, info->date);
1049                                 else
1050                                         strcpy(p, no_date);
1051                                 p += strlen(p);
1052                                 break;
1053                         case 'i': /* message-id */
1054                                 if (info->msgid != NULL)
1055                                         strcpy(p, info->msgid);
1056                                 else
1057                                         strcpy(p, no_msgid);
1058                                 p += strlen(p);
1059                                 break;
1060                         case 'n': /* newsgroups */
1061                                 if (info->newsgroups != NULL)
1062                                         strcpy(p, info->newsgroups);
1063                                 else
1064                                         strcpy(p, no_newsgroups);
1065                                 p += strlen(p);
1066                                 break;
1067                         case 'r': /* references */
1068                                 if (info->references != NULL)
1069                                         strcpy(p, info->references);
1070                                 else
1071                                         strcpy(p, no_references);
1072                                 p += strlen(p);
1073                                 break;
1074                         case 'F': /* file */
1075                                 strcpy(p, filename);
1076                                 p += strlen(p);
1077                                 g_free(filename);
1078                                 break;
1079                         default:
1080                                 *p = '%';
1081                                 p++;
1082                                 *p = *s;
1083                                 p++;
1084                                 break;
1085                         }
1086                         s++;
1087                 }
1088                 else {
1089                         *p = *s;
1090                         p++;
1091                         s++;
1092                 }
1093         }
1094
1095         debug_print("*** exec string \"%s\"\n", processed_cmd);
1096         return processed_cmd;
1097 }
1098 #undef STRLEN_DEFAULT
1099 #undef STRLEN_ZERO
1100
1101 /* ************************************************************ */
1102
1103 static void prefs_scoring_write(FILE * fp, GSList * prefs_scoring)
1104 {
1105         GSList * cur;
1106
1107         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1108                 gchar *scoring_str;
1109                 ScoringProp * prop;
1110
1111                 prop = (ScoringProp *) cur->data;
1112                 scoring_str = scoringprop_to_string(prop);
1113                 if (fputs(scoring_str, fp) == EOF ||
1114                     fputc('\n', fp) == EOF) {
1115                         FILE_OP_ERROR("scoring config", "fputs || fputc");
1116                         g_free(scoring_str);
1117                         return;
1118                 }
1119                 g_free(scoring_str);
1120         }
1121 }
1122
1123 static void prefs_filtering_write(FILE * fp, GSList * prefs_scoring)
1124 {
1125         GSList * cur;
1126
1127         for (cur = prefs_scoring; cur != NULL; cur = cur->next) {
1128                 gchar *filtering_str;
1129                 FilteringProp * prop;
1130
1131                 if (NULL == (prop = (FilteringProp *) cur->data))
1132                         continue;
1133
1134                 if (NULL == (filtering_str = filteringprop_to_string(prop)))
1135                         continue;
1136
1137                 if (fputs(filtering_str, fp) == EOF ||
1138                     fputc('\n', fp) == EOF) {
1139                         FILE_OP_ERROR("filtering config", "fputs || fputc");
1140                         g_free(filtering_str);
1141                         return;
1142                 }
1143                 g_free(filtering_str);
1144         }
1145 }
1146
1147 static gboolean prefs_matcher_write_func(GNode *node, gpointer data)
1148 {
1149         FolderItem *item;
1150         FILE * fp = data;
1151         gchar * id;
1152         GSList * prefs_scoring;
1153         GSList * prefs_filtering;
1154
1155         if (node != NULL) {
1156                 item = node->data;
1157                 /* prevent from the warning */
1158                 if (item->path == NULL)
1159                         return FALSE;
1160                 id = folder_item_get_identifier(item);
1161                 if (id == NULL)
1162                         return FALSE;
1163                 prefs_scoring = item->prefs->scoring;
1164                 prefs_filtering = item->prefs->processing;
1165         }
1166         else {
1167                 item = NULL;
1168                 id = g_strdup("global"); /* because it is g_freed */
1169                 prefs_scoring = global_scoring;
1170                 prefs_filtering = global_processing;
1171         }
1172
1173         if (prefs_filtering != NULL || prefs_scoring != NULL) {
1174                 fprintf(fp, "[%s]\n", id);
1175
1176                 prefs_filtering_write(fp, prefs_filtering);
1177                 prefs_scoring_write(fp, prefs_scoring);
1178
1179                 fputc('\n', fp);
1180         }
1181
1182         g_free(id);
1183
1184         return FALSE;
1185 }
1186
1187 static void prefs_matcher_save(FILE * fp)
1188 {
1189         GList * cur;
1190
1191         for (cur = folder_get_list() ; cur != NULL ; cur = g_list_next(cur)) {
1192                 Folder *folder;
1193
1194                 folder = (Folder *) cur->data;
1195                 g_node_traverse(folder->node, G_PRE_ORDER, G_TRAVERSE_ALL, -1,
1196                                 prefs_matcher_write_func, fp);
1197         }
1198         prefs_matcher_write_func(NULL, fp);
1199 }
1200
1201
1202 void prefs_matcher_write_config(void)
1203 {
1204         gchar *rcpath;
1205         PrefFile *pfile;
1206
1207         debug_print("Writing matcher configuration...\n");
1208
1209         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1210                              MATCHER_RC, NULL);
1211
1212         if ((pfile = prefs_write_open(rcpath)) == NULL) {
1213                 g_warning(_("failed to write configuration to file\n"));
1214                 g_free(rcpath);
1215                 return;
1216         }
1217
1218
1219         prefs_matcher_save(pfile->fp);
1220
1221         g_free(rcpath);
1222
1223         if (prefs_write_close(pfile) < 0) {
1224                 g_warning(_("failed to write configuration to file\n"));
1225                 return;
1226         }
1227 }
1228
1229 /* ******************************************************************* */
1230
1231 void prefs_matcher_read_config(void)
1232 {
1233         gchar * rcpath;
1234         FILE * f;
1235
1236         prefs_scoring_clear();
1237         prefs_filtering_clear();
1238
1239         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, MATCHER_RC, NULL);
1240         f = fopen(rcpath, "rb");
1241         g_free(rcpath);
1242
1243         if (f != NULL) {
1244                 matcher_parser_start_parsing(f);
1245                 fclose(f);
1246         }
1247         else {
1248                 /* previous version compatibily */
1249
1250                 /* printf("reading filtering\n"); */
1251                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1252                                      FILTERING_RC, NULL);
1253                 f = fopen(rcpath, "rb");
1254                 g_free(rcpath);
1255
1256                 if (f != NULL) {
1257                         matcher_parser_start_parsing(f);
1258                         fclose(matcher_parserin);
1259                 }
1260
1261                 /* printf("reading scoring\n"); */
1262                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S,
1263                                      SCORING_RC, NULL);
1264                 f = fopen(rcpath, "rb");
1265                 g_free(rcpath);
1266
1267                 if (f != NULL) {
1268                         matcher_parser_start_parsing(f);
1269                         fclose(matcher_parserin);
1270                 }
1271         }
1272 }