1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <glib/gi18n.h>
36 #include <modest-tny-platform-factory.h>
37 #include <modest-text-utils.h>
38 #include <modest-runtime.h>
43 #endif /*HAVE_CONFIG_H */
46 #define FORWARD_STRING _("-----Forwarded Message-----")
47 #define FROM_STRING _("From:")
48 #define SENT_STRING _("Sent:")
49 #define TO_STRING _("To:")
50 #define SUBJECT_STRING _("Subject:")
51 #define EMPTY_STRING ""
54 * we need these regexps to find URLs in plain text e-mails
56 typedef struct _url_match_pattern_t url_match_pattern_t;
57 struct _url_match_pattern_t {
63 typedef struct _url_match_t url_match_t;
70 #define MAIL_VIEWER_URL_MATCH_PATTERNS { \
71 { "(file|rtsp|http|ftp|https)://[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]+[-A-Za-z0-9_$%&=?/~#]",\
73 { "www\\.[-a-z0-9.]+[-a-z0-9](:[0-9]*)?(/[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]*[^]}\\),?!;:\"]?)?",\
75 { "ftp\\.[-a-z0-9.]+[-a-z0-9](:[0-9]*)?(/[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]*[^]}\\),?!;:\"]?)?",\
77 { "(voipto|callto|chatto|jabberto|xmpp):[-_a-z@0-9.\\+]+", \
79 { "mailto:[-_a-z0-9.\\+]+@[-_a-z0-9.]+", \
81 { "[-_a-z0-9.\\+]+@[-_a-z0-9.]+",\
86 static gchar* cite (const time_t sent_date, const gchar *from);
87 static void hyperlinkify_plain_text (GString *txt);
88 static gint cmp_offsets_reverse (const url_match_t *match1, const url_match_t *match2);
89 static void chk_partial_match (const url_match_t *match, guint* offset);
90 static GSList* get_url_matches (GString *txt);
92 static GString* get_next_line (const char *b, const gsize blen, const gchar * iter);
93 static int get_indent_level (const char *l);
94 static void unquote_line (GString * l);
95 static void append_quoted (GString * buf, const int indent, const GString * str,
97 static int get_breakpoint_utf8 (const gchar * s, const gint indent, const gint limit);
98 static int get_breakpoint_ascii (const gchar * s, const gint indent, const gint limit);
99 static int get_breakpoint (const gchar * s, const gint indent, const gint limit);
101 static gchar* modest_text_utils_quote_plain_text (const gchar *text,
105 static gchar* modest_text_utils_quote_html (const gchar *text,
110 /* ******************************************************************* */
111 /* ************************* PUBLIC FUNCTIONS ************************ */
112 /* ******************************************************************* */
115 modest_text_utils_quote (const gchar *text,
116 const gchar *content_type,
118 const time_t sent_date,
121 gchar *retval, *cited;
123 g_return_val_if_fail (text, NULL);
124 g_return_val_if_fail (content_type, NULL);
126 cited = cite (sent_date, from);
128 if (content_type && strcmp (content_type, "text/html") == 0)
129 /* TODO: extract the <body> of the HTML and pass it to
131 retval = modest_text_utils_quote_html (text, cited, limit);
133 retval = modest_text_utils_quote_plain_text (text, cited, limit);
142 modest_text_utils_cite (const gchar *text,
143 const gchar *content_type,
149 g_return_val_if_fail (text, NULL);
150 g_return_val_if_fail (content_type, NULL);
152 tmp = cite (sent_date, from);
153 retval = g_strdup_printf ("%s%s\n", tmp, text);
160 modest_text_utils_inline (const gchar *text,
161 const gchar *content_type,
165 const gchar *subject)
168 const gchar *plain_format = "%s\n%s %s\n%s %s\n%s %s\n%s %s\n\n%s";
169 const gchar *html_format = \
170 "%s<br>\n<table width=\"100%\" border=\"0\" cellspacing=\"2\" cellpadding=\"2\">\n" \
171 "<tr><td>%s</td><td>%s</td></tr>\n" \
172 "<tr><td>%s</td><td>%s</td></tr>\n" \
173 "<tr><td>%s</td><td>%s</td></tr>\n" \
174 "<tr><td>%s</td><td>%s</td></tr>\n" \
178 g_return_val_if_fail (text, NULL);
179 g_return_val_if_fail (content_type, NULL);
180 g_return_val_if_fail (text, NULL);
182 modest_text_utils_strftime (sent_str, 100, "%c", sent_date);
184 if (!strcmp (content_type, "text/html"))
185 /* TODO: extract the <body> of the HTML and pass it to
187 format = html_format;
189 format = plain_format;
191 return g_strdup_printf (format,
193 FROM_STRING, (from) ? from : EMPTY_STRING,
194 SENT_STRING, sent_str,
195 TO_STRING, (to) ? to : EMPTY_STRING,
196 SUBJECT_STRING, (subject) ? subject : EMPTY_STRING,
200 /* just to prevent warnings:
201 * warning: `%x' yields only last 2 digits of year in some locales
204 modest_text_utils_strftime(char *s, gsize max, const char *fmt, time_t timet)
208 #if MODEST_PLATFORM_ID==1 /* gtk */
209 g_date_set_time_t (&date, timet);
210 #elif MODEST_PLATFORM_ID==2 /* hildon (maemo) */
211 g_date_set_time (&date, (GTime) timet);
213 return g_date_strftime (s, max, fmt, (const GDate*) &date);
217 modest_text_utils_derived_subject (const gchar *subject, const gchar *prefix)
221 g_return_val_if_fail (prefix, NULL);
224 return g_strdup (prefix);
226 tmp = g_strchug (g_strdup (subject));
228 if (!strncmp (tmp, prefix, strlen (prefix))) {
232 return g_strdup_printf ("%s %s", prefix, subject);
237 modest_text_utils_remove_address (const gchar *address_list, const gchar *address)
239 gchar *dup, *token, *ptr, *result;
240 GString *filtered_emails;
242 g_return_val_if_fail (address_list, NULL);
245 return g_strdup (address_list);
247 /* search for substring */
248 if (!strstr ((const char *) address_list, (const char *) address))
249 return g_strdup (address_list);
251 dup = g_strdup (address_list);
252 filtered_emails = g_string_new (NULL);
254 token = strtok_r (dup, ",", &ptr);
256 while (token != NULL) {
257 /* Add to list if not found */
258 if (!strstr ((const char *) token, (const char *) address)) {
259 if (filtered_emails->len == 0)
260 g_string_append_printf (filtered_emails, "%s", g_strstrip (token));
262 g_string_append_printf (filtered_emails, ",%s", g_strstrip (token));
264 token = strtok_r (NULL, ",", &ptr);
266 result = filtered_emails->str;
270 g_string_free (filtered_emails, FALSE);
276 modest_text_utils_convert_to_html (const gchar *data)
279 gboolean first_space = TRUE;
287 html = g_string_sized_new (len + 100); /* just a guess... */
289 g_string_append_printf (html,
292 "<meta http-equiv=\"content-type\""
293 " content=\"text/html; charset=utf8\">"
297 /* replace with special html chars where needed*/
298 for (i = 0; i != len; ++i) {
302 case 0: break; /* ignore embedded \0s */
303 case '<' : g_string_append (html, "<"); break;
304 case '>' : g_string_append (html, ">"); break;
305 case '&' : g_string_append (html, """); break;
306 case '\n': g_string_append (html, "<br>\n"); break;
309 g_string_append (html, first_space ? " " : " ");
311 } else if (kar == '\t')
312 g_string_append (html, " ");
316 /* optimization trick: accumulate 'normal' chars, then copy */
318 kar = data [++charnum + i];
320 } while ((i + charnum < len) &&
321 (kar > '>' || (kar != '<' && kar != '>'
322 && kar != '&' && kar != ' '
323 && kar != '\n' && kar != '\t')));
324 g_string_append_len (html, &data[i], charnum);
330 g_string_append (html, "</tt></body></html>");
331 hyperlinkify_plain_text (html);
333 return g_string_free (html, FALSE);
336 /* ******************************************************************* */
337 /* ************************* UTILIY FUNCTIONS ************************ */
338 /* ******************************************************************* */
341 get_next_line (const gchar * b, const gsize blen, const gchar * iter)
347 return g_string_new("");
355 gs = g_string_new_len (i0, iter - i0);
359 get_indent_level (const char *l)
376 /* if we hit the signature marker "-- ", we return -(indent + 1). This
377 * stops reformatting.
379 if (strcmp (l, "-- ") == 0) {
387 unquote_line (GString * l)
402 g_string_erase (l, 0, p - l->str);
406 append_quoted (GString * buf, int indent, const GString * str,
411 indent = indent < 0 ? abs (indent) - 1 : indent;
412 for (i = 0; i <= indent; i++) {
413 g_string_append (buf, "> ");
416 g_string_append_len (buf, str->str, cutpoint);
418 g_string_append (buf, str->str);
420 g_string_append (buf, "\n");
424 get_breakpoint_utf8 (const gchar * s, gint indent, const gint limit)
427 const gchar *pos, *last;
430 indent = indent < 0 ? abs (indent) - 1 : indent;
434 uni = g_utf8_to_ucs4_fast (s, -1, NULL);
436 if ((index + 2 * indent > limit) && last) {
440 if (g_unichar_isspace (uni[index])) {
443 pos = g_utf8_next_char (pos);
451 get_breakpoint_ascii (const gchar * s, const gint indent, const gint limit)
456 if (last + 2 * indent < limit)
459 for (i = strlen (s); i > 0; i--) {
461 if (i + 2 * indent <= limit) {
472 get_breakpoint (const gchar * s, const gint indent, const gint limit)
475 if (g_utf8_validate (s, -1, NULL)) {
476 return get_breakpoint_utf8 (s, indent, limit);
477 } else { /* assume ASCII */
478 //g_warning("invalid UTF-8 in msg");
479 return get_breakpoint_ascii (s, indent, limit);
484 cite (const time_t sent_date, const gchar *from)
488 /* format sent_date */
489 modest_text_utils_strftime (sent_str, 100, "%c", sent_date);
490 return g_strdup_printf (N_("On %s, %s wrote:\n"),
492 (from) ? from : EMPTY_STRING);
497 modest_text_utils_quote_plain_text (const gchar *text,
502 gint indent, breakpoint, rem_indent = 0;
503 GString *q, *l, *remaining;
506 /* remaining will store the rest of the line if we have to break it */
507 q = g_string_new (cite);
508 remaining = g_string_new ("");
513 l = get_next_line (text, len, iter);
514 iter = iter + l->len + 1;
515 indent = get_indent_level (l->str);
518 if (remaining->len) {
519 if (l->len && indent == rem_indent) {
520 g_string_prepend (l, " ");
521 g_string_prepend (l, remaining->str);
525 get_breakpoint (remaining->str,
528 append_quoted (q, rem_indent,
529 remaining, breakpoint);
530 g_string_erase (remaining, 0,
532 if (remaining->str[0] == ' ') {
533 g_string_erase (remaining, 0,
536 } while (remaining->len);
539 g_string_free (remaining, TRUE);
540 breakpoint = get_breakpoint (l->str, indent, limit);
541 remaining = g_string_new (l->str + breakpoint);
542 if (remaining->str[0] == ' ') {
543 g_string_erase (remaining, 0, 1);
546 append_quoted (q, indent, l, breakpoint);
547 g_string_free (l, TRUE);
548 } while ((iter < text + len) || (remaining->str[0]));
550 return g_string_free (q, FALSE);
554 modest_text_utils_quote_html (const gchar *text,
558 const gchar *format = \
559 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">\n" \
563 "<blockquote type=\"cite\">\n%s\n</blockquote>\n" \
567 return g_strdup_printf (format, cite, text);
571 cmp_offsets_reverse (const url_match_t *match1, const url_match_t *match2)
573 return match2->offset - match1->offset;
579 * check if the match is inside an existing match... */
581 chk_partial_match (const url_match_t *match, guint* offset)
583 if (*offset >= match->offset && *offset < match->offset + match->len)
588 get_url_matches (GString *txt)
591 guint rv, i, offset = 0;
592 GSList *match_list = NULL;
594 static url_match_pattern_t patterns[] = MAIL_VIEWER_URL_MATCH_PATTERNS;
595 const size_t pattern_num = sizeof(patterns)/sizeof(url_match_pattern_t);
597 /* initalize the regexps */
598 for (i = 0; i != pattern_num; ++i) {
599 patterns[i].preg = g_slice_new0 (regex_t);
601 /* this should not happen */
602 g_return_val_if_fail (regcomp (patterns[i].preg, patterns[i].regex,
603 REG_ICASE|REG_EXTENDED|REG_NEWLINE) == 0, NULL);
605 /* find all the matches */
606 for (i = 0; i != pattern_num; ++i) {
610 if ((rv = regexec (patterns[i].preg, txt->str + offset, 1, &rm, 0)) != 0) {
611 g_return_val_if_fail (rv == REG_NOMATCH, NULL); /* this should not happen */
612 break; /* try next regexp */
617 /* FIXME: optimize this */
618 /* to avoid partial matches on something that was already found... */
619 /* check_partial_match will put -1 in the data ptr if that is the case */
620 test_offset = offset + rm.rm_so;
621 g_slist_foreach (match_list, (GFunc)chk_partial_match, &test_offset);
623 /* make a list of our matches (<offset, len, prefix> tupels)*/
624 if (test_offset != -1) {
625 url_match_t *match = g_slice_new (url_match_t);
626 match->offset = offset + rm.rm_so;
627 match->len = rm.rm_eo - rm.rm_so;
628 match->prefix = patterns[i].prefix;
629 match_list = g_slist_prepend (match_list, match);
635 for (i = 0; i != pattern_num; ++i) {
636 regfree (patterns[i].preg);
637 g_slice_free (regex_t, patterns[i].preg);
638 } /* don't free patterns itself -- it's static */
640 /* now sort the list, so the matches are in reverse order of occurence.
641 * that way, we can do the replacements starting from the end, so we don't need
642 * to recalculate the offsets
644 match_list = g_slist_sort (match_list,
645 (GCompareFunc)cmp_offsets_reverse);
652 hyperlinkify_plain_text (GString *txt)
655 GSList *match_list = get_url_matches (txt);
657 /* we will work backwards, so the offsets stay valid */
658 for (cursor = match_list; cursor; cursor = cursor->next) {
660 url_match_t *match = (url_match_t*) cursor->data;
661 gchar *url = g_strndup (txt->str + match->offset, match->len);
662 gchar *repl = NULL; /* replacement */
664 /* the prefix is NULL: use the one that is already there */
665 repl = g_strdup_printf ("<a href=\"%s%s\">%s</a>",
666 match->prefix ? match->prefix : EMPTY_STRING,
669 /* replace the old thing with our hyperlink
670 * replacement thing */
671 g_string_erase (txt, match->offset, match->len);
672 g_string_insert (txt, match->offset, repl);
677 g_slice_free (url_match_t, match);
680 g_slist_free (match_list);
686 modest_text_utils_get_display_address (gchar *address)
693 g_return_val_if_fail (g_utf8_validate (address, -1, NULL), NULL);
695 g_strchug (address); /* remove leading whitespace */
697 /* <email@address> from display name */
698 cursor = g_strstr_len (address, strlen(address), "<");
699 if (cursor == address) /* there's nothing else? leave it */
704 /* remove (bla bla) from display name */
705 cursor = g_strstr_len (address, strlen(address), "(");
706 if (cursor == address) /* there's nothing else? leave it */
711 g_strchomp (address); /* remove trailing whitespace */
719 modest_text_utils_get_subject_prefix_len (const gchar *sub)
722 static const gchar* prefix[] = {
723 "Re:", "RE:", "Fwd:", "FWD:", "FW:", NULL
726 if (!sub || (sub[0] != 'R' && sub[0] != 'F')) /* optimization */
732 if (g_str_has_prefix(sub, prefix[i])) {
733 int prefix_len = strlen(prefix[i]);
734 if (sub[prefix_len] == ' ')
735 ++prefix_len; /* ignore space after prefix as well */
745 modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive)
750 /* work even when s1 and/or s2 == NULL */
751 if (G_UNLIKELY(s1 == s2))
754 /* if it's not case sensitive */
756 return strcmp (s1 ? s1 : "", s2 ? s2 : "");
758 n1 = g_utf8_collate_key (s1 ? s1 : "", -1);
759 n2 = g_utf8_collate_key (s2 ? s2 : "", -1);
761 result = strcmp (n1, n2);
771 modest_text_utils_get_display_date (time_t date)
774 const guint BUF_SIZE = 64;
775 gchar date_buf[BUF_SIZE];
776 gchar now_buf [BUF_SIZE];
780 modest_text_utils_strftime (date_buf, BUF_SIZE, "%x", date);
781 modest_text_utils_strftime (now_buf, BUF_SIZE, "%x", now); /* today */
783 /* if this is today, get the time instead of the date */
784 if (strcmp (date_buf, now_buf) == 0)
785 modest_text_utils_strftime (date_buf, BUF_SIZE, _("%X"), date);
787 return g_strdup(date_buf);
791 modest_text_utils_validate_email_address (const gchar *email_address)
794 const gchar *c, *domain;
795 static gchar *rfc822_specials = "()<>@,;:\\\"[]";
797 /* first we validate the name portion (name@domain) */
798 for (c = email_address; *c; c++) {
800 (c == email_address ||
806 if (*c == '\\' && (*++c == ' '))
808 if (*c <= ' ' || *c >= 127)
821 if (*c <= ' ' || *c >= 127)
823 if (strchr(rfc822_specials, *c))
826 if (c == email_address || *(c - 1) == '.')
829 /* next we validate the domain portion (name@domain) */
830 if (!*(domain = ++c))
834 if (c == domain || *(c - 1) == '.')
838 if (*c <= ' ' || *c >= 127)
840 if (strchr(rfc822_specials, *c))
844 return (count >= 1) ? TRUE : FALSE;
851 modest_text_utils_get_display_size (guint size)
854 const guint MB=1024 * KB;
855 const guint GB=1024 * MB;
856 const guint TB=1024 * GB;
859 return g_strdup_printf (_("%0.1f Kb"), (double)size / KB);
861 return g_strdup_printf (_("%d Kb"), size / KB);
863 return g_strdup_printf (_("%d Mb"), size / MB);
865 return g_strdup_printf (_("%d Gb"), size/ GB);
867 return g_strdup_printf (_("Very big"));