New hooklist to collect avatar data from headers
[claws.git] / src / procheader.c
index 2c1d4bf5efe69fdac627cd61e25c1f44ad531d5c..4b7ff05ff7f41bce1256b8d24c2996bde46c19cb 100644 (file)
@@ -1,10 +1,10 @@
 /*
  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws team
+ * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * 
  */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
+#include "claws-features.h"
 #endif
 
 #include <glib.h>
 #include <time.h>
 #include <sys/stat.h>
 
+#ifdef G_OS_WIN32
+#  include <w32lib.h>
+#endif
+
 #include "procheader.h"
 #include "procmsg.h"
 #include "codeconv.h"
 #include "prefs_common.h"
+#include "hooks.h"
 #include "utils.h"
+#include "defs.h"
 
 #define BUFFSIZE       8192
 
+static gchar monthstr[] = "JanFebMarAprMayJunJulAugSepOctNovDec";
+
 typedef char *(*getlinefunc) (char *, size_t, void *);
 typedef int (*peekcharfunc) (void *);
 typedef int (*getcharfunc) (void *);
@@ -61,7 +70,7 @@ gint procheader_get_one_field(gchar *buf, size_t len, FILE *fp,
                              HeaderEntry hentry[])
 {
        return generic_get_one_field(buf, len, fp, hentry,
-                                    (getlinefunc)fgets, (peekcharfunc)file_peekchar,
+                                    (getlinefunc)fgets_crlf, (peekcharfunc)file_peekchar,
                                     TRUE);
 }
 
@@ -76,12 +85,25 @@ static gint string_get_one_field(gchar *buf, size_t len, char **str,
 
 static char *string_getline(char *buf, size_t len, char **str)
 {
+       gboolean is_cr = FALSE;
+       gboolean last_was_cr = FALSE;
+
        if (!*str || !**str)
                return NULL;
 
-       for (; **str && len > 1; --len)
-               if ((*buf++ = *(*str)++) == '\n')
+       for (; **str && len > 1; --len) {
+               is_cr = (**str == '\r');
+               if ((*buf++ = *(*str)++) == '\n') {
                    break;
+               }
+               if (last_was_cr) {
+                       *(--buf) = '\n';
+                       buf++;
+                   break;
+               }
+               last_was_cr = is_cr;
+       }
+               
        *buf = '\0';
 
        return buf;
@@ -164,7 +186,7 @@ static gint generic_get_one_field(gchar *buf, size_t len, void *data,
 gint procheader_get_one_field_asis(gchar *buf, size_t len, FILE *fp)
 {
        return generic_get_one_field(buf, len, fp, NULL,
-                                    (getlinefunc)fgets, 
+                                    (getlinefunc)fgets_crlf
                                     (peekcharfunc)file_peekchar,
                                     FALSE);
 }
@@ -175,28 +197,13 @@ GPtrArray *procheader_get_header_array_asis(FILE *fp)
        GPtrArray *headers;
        Header *header;
 
-       g_return_val_if_fail(fp != NULL, NULL);
+       cm_return_val_if_fail(fp != NULL, NULL);
 
        headers = g_ptr_array_new();
 
        while (procheader_get_one_field_asis(buf, sizeof(buf), fp) != -1) {
                if ((header = procheader_parse_header(buf)) != NULL)
                        g_ptr_array_add(headers, header);
-                       /*
-               if (*buf == ':') continue;
-               for (p = buf; *p && *p != ' '; p++) {
-                       if (*p == ':') {
-                               header = g_new(Header, 1);
-                               header->name = g_strndup(buf, p - buf);
-                               p++;
-                               conv_unmime_header(tmp, sizeof(tmp), p, NULL);
-                               header->body = g_strdup(tmp);
-
-                               g_ptr_array_add(headers, header);
-                               break;
-                       }
-               }
-                       */
        }
 
        return headers;
@@ -252,11 +259,36 @@ gboolean procheader_headername_equal(char * hdr1, char * hdr2)
   header->name = "From:"
   header->body = "dinh@enseirb.fr"
  */
+static gboolean header_is_addr_field(const gchar *hdr)
+{
+       static char *addr_headers[] = {
+                               "To:",
+                               "Cc:",
+                               "Bcc:",
+                               "From:",
+                               "Reply-To:",
+                               "Followup-To:",
+                               "Followup-and-Reply-To:",
+                               "Disposition-Notification-To:",
+                               "Return-Receipt-To:",
+                               NULL};
+       int i;
+
+       if (!hdr)
+               return FALSE;
+
+       for (i = 0; addr_headers[i] != NULL; i++)
+               if (!strcasecmp(hdr, addr_headers[i]))
+                       return FALSE;
+
+       return FALSE;
+}
 
 Header * procheader_parse_header(gchar * buf)
 {
-       gchar *p = buf;
+       gchar *p;
        Header * header;
+       gboolean addr_field = FALSE;
 
        if ((*buf == ':') || (*buf == ' '))
                return NULL;
@@ -265,9 +297,10 @@ Header * procheader_parse_header(gchar * buf)
                if ((*p == ':') || (*p == ' ')) {
                        header = g_new(Header, 1);
                        header->name = g_strndup(buf, p - buf + 1);
+                       addr_field = header_is_addr_field(header->name);
                        p++;
                        while (*p == ' ' || *p == '\t') p++;
-                        header->body = conv_unmime_header(p, NULL);
+                       header->body = conv_unmime_header(p, NULL, addr_field);
                        return header;
                }
        }
@@ -308,7 +341,7 @@ MsgInfo *procheader_parse_file(const gchar *file, MsgFlags flags,
        FILE *fp;
        MsgInfo *msginfo;
 
-       if (stat(file, &s) < 0) {
+       if (g_stat(file, &s) < 0) {
                FILE_OP_ERROR(file, "stat");
                return NULL;
        }
@@ -419,7 +452,7 @@ static HeaderEntry hentry_short[] = {{"Date:",              NULL, FALSE},
                                    {"SC-Message-Size:",NULL, FALSE},
                                    {NULL,              NULL, FALSE}};
 
-HeaderEntry* procheader_get_headernames(gboolean full)
+static HeaderEntry* procheader_get_headernames(gboolean full)
 {
        return full ? hentry_full : hentry_short;
 }
@@ -430,6 +463,26 @@ MsgInfo *procheader_parse_stream(FILE *fp, MsgFlags flags, gboolean full,
        return parse_stream(fp, FALSE, flags, full, decrypted);
 }
 
+static gboolean avatar_from_some_face(gpointer source, gpointer userdata)
+{
+       AvatarCaptureData *acd = (AvatarCaptureData *)source;
+       
+       if (*(acd->content) == '\0') /* won't be null, but may be empty */
+               return FALSE;
+
+       if (!strcmp(acd->header, hentry_full[H_FACE].name)) {
+               debug_print("avatar_from_some_face: found 'Face' header\n");
+               procmsg_msginfo_add_avatar(acd->msginfo, AVATAR_FACE, acd->content);
+       }
+#if HAVE_LIBCOMPFACE
+       else if (!strcmp(acd->header, hentry_full[H_X_FACE].name)) {
+               debug_print("avatar_from_some_face: found 'X-Face' header\n");
+               procmsg_msginfo_add_avatar(acd->msginfo, AVATAR_XFACE, acd->content);
+       }
+#endif
+       return FALSE;
+}
+
 static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                             gboolean full, gboolean decrypted)
 {
@@ -440,6 +493,7 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
        HeaderEntry *hentry;
        gint hnum;
        void *orig_data = data;
+       guint hook_id = -1;
 
        get_one_field_func get_one_field =
                isstring ? (get_one_field_func)string_get_one_field
@@ -449,8 +503,10 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
 
        if (MSG_IS_QUEUED(flags) || MSG_IS_DRAFT(flags)) {
                while (get_one_field(buf, sizeof(buf), data, NULL) != -1) {
-                       if (!strncmp(buf, "X-Sylpheed-End-Special-Headers: 1",
-                               strlen("X-Sylpheed-End-Special-Headers:")))
+                       if ((!strncmp(buf, "X-Claws-End-Special-Headers: 1",
+                               strlen("X-Claws-End-Special-Headers:"))) ||
+                           (!strncmp(buf, "X-Sylpheed-End-Special-Headers: 1",
+                               strlen("X-Sylpheed-End-Special-Headers:"))))
                                break;
                        /* from other mailers */
                        if (!strncmp(buf, "Date: ", 6)
@@ -475,6 +531,10 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
        
        msginfo->inreplyto = NULL;
 
+       if (prefs_common.enable_avatars | AVATARS_ENABLE_CAPTURE) {
+               hook_id = hooks_register_hook(AVATAR_HEADER_UPDATE_HOOKLIST, avatar_from_some_face, NULL);
+       }
+
        while ((hnum = get_one_field(buf, sizeof(buf), data, hentry))
               != -1) {
                hp = buf + strlen(hentry[hnum].name);
@@ -504,13 +564,13 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                        break;
                case H_FROM:
                        if (msginfo->from) break;
-                        msginfo->from = conv_unmime_header(hp, NULL);
+                       msginfo->from = conv_unmime_header(hp, NULL, TRUE);
                        msginfo->fromname = procheader_get_fromname(msginfo->from);
                        remove_return(msginfo->from);
                        remove_return(msginfo->fromname);
                        break;
                case H_TO:
-                        tmp = conv_unmime_header(hp, NULL);
+                       tmp = conv_unmime_header(hp, NULL, TRUE);
                        remove_return(tmp);
                        if (msginfo->to) {
                                p = msginfo->to;
@@ -522,7 +582,7 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                         g_free(tmp);                                
                        break;
                case H_CC:
-                        tmp = conv_unmime_header(hp, NULL);
+                       tmp = conv_unmime_header(hp, NULL, TRUE);
                        remove_return(tmp);
                        if (msginfo->cc) {
                                p = msginfo->cc;
@@ -544,8 +604,9 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                        break;
                case H_SUBJECT:
                        if (msginfo->subject) break;
-                        msginfo->subject = conv_unmime_header(hp, NULL);
-                       break;
+                       msginfo->subject = conv_unmime_header(hp, NULL, FALSE);
+                       unfold_line(msginfo->subject);
+                       break;
                case H_MSG_ID:
                        if (msginfo->msgid) break;
 
@@ -580,18 +641,6 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                        MSG_UNSET_PERM_FLAGS(msginfo->flags, MSG_NEW|MSG_UNREAD);
                        break;
 #endif                 
-               case H_FACE:
-                       if (!msginfo->extradata)
-                               msginfo->extradata = g_new0(MsgInfoExtraData, 1);
-                       if (msginfo->extradata->face) break;
-                       msginfo->extradata->face = g_strdup(hp);
-                       break;
-               case H_X_FACE:
-                       if (!msginfo->extradata)
-                               msginfo->extradata = g_new0(MsgInfoExtraData, 1);
-                       if (msginfo->extradata->xface) break;
-                       msginfo->extradata->xface = g_strdup(hp);
-                       break;
                case H_DISPOSITION_NOTIFICATION_TO:
                        if (!msginfo->extradata)
                                msginfo->extradata = g_new0(MsgInfoExtraData, 1);
@@ -700,12 +749,28 @@ static MsgInfo *parse_stream(void *data, gboolean isstring, MsgFlags flags,
                default:
                        break;
                }
+               /* to avoid performance penalty hooklist is invoked only for
+                  headers known to be able to generate avatars */
+               if (hnum == H_FROM || hnum == H_X_FACE || hnum == H_FACE) {
+                       AvatarCaptureData *acd = g_new0(AvatarCaptureData, 1);
+                       /* no extra memory is wasted, hooks are expected to
+                          take care of copying members when needed */
+                       acd->msginfo = msginfo;
+                       acd->header  = hentry_full[hnum].name;
+                       acd->content = hp;
+                       hooks_invoke(AVATAR_HEADER_UPDATE_HOOKLIST, (gpointer)acd);
+                       g_free(acd);
+               }
        }
 
        if (!msginfo->inreplyto && msginfo->references)
                msginfo->inreplyto =
                        g_strdup((gchar *)msginfo->references->data);
 
+       if (hook_id != -1) {
+               hooks_unregister_hook(AVATAR_HEADER_UPDATE_HOOKLIST, hook_id);
+       }
+
        return msginfo;
 }
 
@@ -746,11 +811,18 @@ static gint procheader_scan_date_string(const gchar *str,
                                        gchar *zone)
 {
        gint result;
+       gint month_n;
+       gchar zone1[3];
+       gchar zone2[3];
+
+       if (str == NULL)
+               return -1;
 
        result = sscanf(str, "%10s %d %9s %d %2d:%2d:%2d %5s",
                        weekday, day, month, year, hh, mm, ss, zone);
        if (result == 8) return 0;
 
+       /* RFC2822 */
        result = sscanf(str, "%3s,%d %9s %d %2d:%2d:%2d %5s",
                        weekday, day, month, year, hh, mm, ss, zone);
        if (result == 8) return 0;
@@ -786,6 +858,32 @@ static gint procheader_scan_date_string(const gchar *str,
                        day, month, year, hh, mm);
        if (result == 5) return 0;
 
+       /* RFC3339 subset */
+       *weekday = '\0';
+       result = sscanf(str, "%4d-%2d-%2d %2d:%2d:%2d+%2s:%2s",
+                       year, &month_n, day, hh, mm, ss, zone1, zone2);
+       if (result == 8) {
+               if (1 <= month_n && month_n <= 12) {
+                       strncpy2(month, monthstr+((month_n-1)*3), 4);
+                       *zone = '+';
+                       strncpy2(zone+1, zone1, 3);
+                       strncpy2(zone+3, zone2, 3);
+                       return 0;
+               }
+       }
+
+       /* RFC3339 subset */
+       *zone = '\0';
+       *weekday = '\0';
+       result = sscanf(str, "%4d-%2d-%2d %2d:%2d:%2d",
+                       year, &month_n, day, hh, mm, ss);
+       if (result == 6) {
+               if (1 <= month_n && month_n <= 12) {
+                       strncpy2(month, monthstr+((month_n-1)*3), 4);
+                       return 0;
+               }
+       }
+
        return -1;
 }
 
@@ -795,7 +893,6 @@ static gint procheader_scan_date_string(const gchar *str,
  */
 gboolean procheader_date_parse_to_tm(const gchar *src, struct tm *t, char *zone)
 {
-       static gchar monthstr[] = "JanFebMarAprMayJunJulAugSepOctNovDec";
        gchar weekday[11];
        gint day;
        gchar month[10];
@@ -848,7 +945,6 @@ gboolean procheader_date_parse_to_tm(const gchar *src, struct tm *t, char *zone)
 
 time_t procheader_date_parse(gchar *dest, const gchar *src, gint len)
 {
-       static gchar monthstr[] = "JanFebMarAprMayJunJulAugSepOctNovDec";
        gchar weekday[11];
        gint day;
        gchar month[10];
@@ -911,8 +1007,14 @@ void procheader_date_get_localtime(gchar *dest, gint len, const time_t timer)
        gchar *default_format = "%y/%m/%d(%a) %H:%M";
        gchar *str;
        const gchar *src_codeset, *dest_codeset;
+       struct tm buf;
 
-       lt = localtime(&timer);
+       if (timer > 0)
+               lt = localtime_r(&timer, &buf);
+       else {
+               time_t dummy = 1;
+               lt = localtime_r(&dummy, &buf);
+       }
 
        if (prefs_common.date_format)
                fast_strftime(dest, len, prefs_common.date_format, lt);
@@ -942,7 +1044,7 @@ gint procheader_get_header_from_msginfo(MsgInfo *msginfo, gchar *buf, gint len,
 
         hentry[0].name = header;
        
-       g_return_val_if_fail(msginfo != NULL, -1);
+       cm_return_val_if_fail(msginfo != NULL, -1);
        file = procmsg_get_message_file_path(msginfo);
        if ((fp = g_fopen(file, "rb")) == NULL) {
                FILE_OP_ERROR(file, "fopen");
@@ -952,7 +1054,7 @@ gint procheader_get_header_from_msginfo(MsgInfo *msginfo, gchar *buf, gint len,
        val = procheader_get_one_field(buf,len, fp, hentry);
        if (fclose(fp) == EOF) {
                FILE_OP_ERROR(file, "fclose");
-               g_unlink(file);
+               claws_unlink(file);
                g_free(file);
                return -1;
        }
@@ -963,3 +1065,51 @@ gint procheader_get_header_from_msginfo(MsgInfo *msginfo, gchar *buf, gint len,
 
        return 0;
 }
+
+HeaderEntry *procheader_entries_from_str(const gchar *str)
+{
+       HeaderEntry *entries = NULL, *he;
+       int numh = 0, i = 0;
+       gchar **names = NULL;
+       const gchar *s = str;
+
+       if (s == NULL) {
+               return NULL;
+       }
+       while (*s != '\0') {
+               if (*s == ' ') ++numh;
+               ++s;
+       }
+       if (numh == 0) {
+               return NULL;
+       }
+       entries = g_new0(HeaderEntry, numh + 1); /* room for last NULL */
+       s = str;
+       ++s; /* skip first space */
+       names = g_strsplit(s, " ", numh);
+       he = entries;
+       while (names[i]) {
+               he->name = g_strdup_printf("%s:", names[i]);
+               he->body = NULL;
+               he->unfold = FALSE;
+               ++i, ++he;
+       }
+       he->name = NULL;
+       g_strfreev(names);
+       return entries;
+}
+
+void procheader_entries_free (HeaderEntry *entries)
+{
+       if (entries != NULL) {
+               HeaderEntry *he = entries;
+               while (he->name != NULL) {
+                       g_free(he->name);
+                       if (he->body != NULL)
+                               g_free(he->body);
+                       ++he;                   
+               }
+               g_free(entries);
+       }
+}
+