020b160e0a13e0cc22f1ccdcf28b442eb40010b6
[modest] / src / modest-text-utils.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30
31
32 #ifndef _GNU_SOURCE
33 #define _GNU_SOURCE
34 #endif /*_GNU_SOURCE*/
35 #include <string.h> /* for strcasestr */
36
37
38 #include <glib.h>
39 #include <stdlib.h>
40 #include <glib/gi18n.h>
41 #include <regex.h>
42 #include <modest-tny-platform-factory.h>
43 #include <modest-text-utils.h>
44 #include <modest-runtime.h>
45 #include <ctype.h>
46
47 #ifdef HAVE_CONFIG_H
48 #include <config.h>
49 #endif /*HAVE_CONFIG_H */
50
51 /* defines */
52 #define FORWARD_STRING _("mcen_ia_editor_original_message")
53 #define FROM_STRING _("mail_va_from")
54 #define SENT_STRING _("mcen_fi_message_properties_sent")
55 #define TO_STRING _("mail_va_to")
56 #define SUBJECT_STRING _("mail_va_subject")
57 #define EMPTY_STRING ""
58
59 /*
60  * do the hyperlinkification only for texts < 50 Kb,
61  * as it's quite slow. Without this, e.g. mail with
62  * an uuencoded part (which is not recognized as attachment,
63  * will hang modest
64  */
65 #define HYPERLINKIFY_MAX_LENGTH (1024*50)
66
67 /*
68  * we need these regexps to find URLs in plain text e-mails
69  */
70 typedef struct _url_match_pattern_t url_match_pattern_t;
71 struct _url_match_pattern_t {
72         gchar   *regex;
73         regex_t *preg;
74         gchar   *prefix;
75 };
76
77 typedef struct _url_match_t url_match_t;
78 struct _url_match_t {
79         guint offset;
80         guint len;
81         const gchar* prefix;
82 };
83
84
85 /*
86  * we mark the ampersand with \007 when converting text->html
87  * because after text->html we do hyperlink detecting, which
88  * could be screwed up by the ampersand.
89  * ie. 1<3 ==> 1\007lt;3
90  */
91 #define MARK_AMP '\007'
92 #define MARK_AMP_STR "\007"
93
94 /* mark &amp; separately, because they are parts of urls.
95  * ie. a&b => a\006amp;b, but a>b => a\007gt;b
96  *
97  * we need to handle '&' separately, because it can be part of URIs
98  * (as in href="http://foo.bar?a=1&b=1"), so inside those URIs
99  * we need to re-replace \006amp; with '&' again, while outside uri's
100  * it will be '&amp;'
101  * 
102  * yes, it's messy, but a consequence of doing text->html first, then hyperlinkify
103  */
104 #define MARK_AMP_URI '\006'
105 #define MARK_AMP_URI_STR "\006"
106
107
108 /* note: match MARK_AMP_URI_STR as well, because after txt->html, a '&' will look like $(MARK_AMP_URI_STR)"amp;" */
109 #define MAIL_VIEWER_URL_MATCH_PATTERNS  {                               \
110         { "(feed:|)(file|rtsp|http|ftp|https|mms|mmsh|webcal|feed|rtsp|rdp|lastfm|sip)://[-a-z0-9_$.+!*(),;:@%=\?/~#&" MARK_AMP_URI_STR \
111                         "]+[-a-z0-9_$%&" MARK_AMP_URI_STR "=?/~#]",     \
112           NULL, NULL },\
113         { "www\\.[-a-z0-9_$.+!*(),;:@%=?/~#" MARK_AMP_URI_STR "]+[-a-z0-9_$%" MARK_AMP_URI_STR "=?/~#]",\
114                         NULL, "http://" },                              \
115         { "ftp\\.[-a-z0-9_$.+!*(),;:@%=?/~#" MARK_AMP_URI_STR "]+[-a-z0-9_$%" MARK_AMP_URI_STR "=?/~#]",\
116           NULL, "ftp://" },\
117         { "(jabberto|voipto|sipto|sip|chatto|skype|xmpp):[-_a-z@0-9.+]+", \
118            NULL, NULL},                                             \
119         { "mailto:[-_a-z0-9.\\+]+@[-_a-z0-9.]+",                    \
120           NULL, NULL},\
121         { "[-_a-z0-9.\\+]+@[-_a-z0-9.]+",\
122           NULL, "mailto:"}\
123         }
124
125 const gchar account_title_forbidden_chars[] = {
126         '\\', '/', ':', '*', '?', '\'', '<', '>', '|', '^'
127 };
128 const gchar folder_name_forbidden_chars[] = {
129         '<', '>', ':', '\'', '/', '\\', '|', '?', '*', '^', '%', '$', '#', '&'
130 };
131 const gchar user_name_forbidden_chars[] = {
132         '<', '>'
133 };
134 const guint ACCOUNT_TITLE_FORBIDDEN_CHARS_LENGTH = G_N_ELEMENTS (account_title_forbidden_chars);
135 const guint FOLDER_NAME_FORBIDDEN_CHARS_LENGTH = G_N_ELEMENTS (folder_name_forbidden_chars);
136 const guint USER_NAME_FORBIDDEN_CHARS_LENGTH = G_N_ELEMENTS (user_name_forbidden_chars);
137
138 /* private */
139 static gchar*   cite                    (const time_t sent_date, const gchar *from);
140 static void     hyperlinkify_plain_text (GString *txt, gint offset);
141 static gint     cmp_offsets_reverse     (const url_match_t *match1, const url_match_t *match2);
142 static GSList*  get_url_matches         (GString *txt, gint offset);
143
144 static GString* get_next_line           (const char *b, const gsize blen, const gchar * iter);
145 static int      get_indent_level        (const char *l);
146 static void     unquote_line            (GString * l, const gchar *quote_symbol);
147 static void     append_quoted           (GString * buf, const gchar *quote_symbol,
148                                          const int indent, const GString * str, 
149                                          const int cutpoint);
150 static int      get_breakpoint_utf8     (const gchar * s, const gint indent, const gint limit);
151 static int      get_breakpoint_ascii    (const gchar * s, const gint indent, const gint limit);
152 static int      get_breakpoint          (const gchar * s, const gint indent, const gint limit);
153
154 static gchar*   modest_text_utils_quote_plain_text (const gchar *text, 
155                                                     const gchar *cite, 
156                                                     const gchar *signature,
157                                                     GList *attachments, 
158                                                     int limit);
159
160 static gchar*   modest_text_utils_quote_html       (const gchar *text, 
161                                                     const gchar *cite,
162                                                     const gchar *signature,
163                                                     GList *attachments,
164                                                     int limit);
165 static gchar*   get_email_from_address (const gchar *address);
166
167
168 /* ******************************************************************* */
169 /* ************************* PUBLIC FUNCTIONS ************************ */
170 /* ******************************************************************* */
171
172 gchar *
173 modest_text_utils_quote (const gchar *text, 
174                          const gchar *content_type,
175                          const gchar *signature,
176                          const gchar *from,
177                          const time_t sent_date, 
178                          GList *attachments,
179                          int limit)
180 {
181         gchar *retval, *cited;
182
183         g_return_val_if_fail (text, NULL);
184         g_return_val_if_fail (content_type, NULL);
185
186         cited = cite (sent_date, from);
187         
188         if (content_type && strcmp (content_type, "text/html") == 0)
189                 /* TODO: extract the <body> of the HTML and pass it to
190                    the function */
191                 retval = modest_text_utils_quote_html (text, cited, signature, attachments, limit);
192         else
193                 retval = modest_text_utils_quote_plain_text (text, cited, signature, attachments, limit);
194         
195         g_free (cited);
196         
197         return retval;
198 }
199
200
201 gchar *
202 modest_text_utils_cite (const gchar *text,
203                         const gchar *content_type,
204                         const gchar *signature,
205                         const gchar *from,
206                         time_t sent_date)
207 {
208         gchar *retval;
209         gchar *tmp_sig;
210         
211         g_return_val_if_fail (text, NULL);
212         g_return_val_if_fail (content_type, NULL);
213         
214         if (!signature) {
215                 tmp_sig = g_strdup (text);
216         } else {
217                 tmp_sig = g_strconcat (text, "\n", MODEST_TEXT_UTILS_SIGNATURE_MARKER, "\n", signature, NULL);
218         }
219
220         if (strcmp (content_type, "text/html") == 0) {
221                 retval = modest_text_utils_convert_to_html_body (tmp_sig, -1, TRUE);
222                 g_free (tmp_sig);
223         } else {
224                 retval = tmp_sig;
225         }
226
227         return retval;
228 }
229
230 static gchar *
231 forward_cite (const gchar *from,
232               const gchar *sent,
233               const gchar *to,
234               const gchar *subject)
235 {
236         g_return_val_if_fail (sent, NULL);
237         
238         return g_strdup_printf ("%s\n%s %s\n%s %s\n%s %s\n%s %s\n", 
239                                 FORWARD_STRING, 
240                                 FROM_STRING, (from)?from:"",
241                                 SENT_STRING, sent,
242                                 TO_STRING, (to)?to:"",
243                                 SUBJECT_STRING, (subject)?subject:"");
244 }
245
246 gchar * 
247 modest_text_utils_inline (const gchar *text,
248                           const gchar *content_type,
249                           const gchar *signature,
250                           const gchar *from,
251                           time_t sent_date,
252                           const gchar *to,
253                           const gchar *subject)
254 {
255         gchar sent_str[101];
256         gchar *cited;
257         gchar *retval;
258         
259         g_return_val_if_fail (text, NULL);
260         g_return_val_if_fail (content_type, NULL);
261         
262         modest_text_utils_strftime (sent_str, 100, "%c", sent_date);
263
264         cited = forward_cite (from, sent_str, to, subject);
265         
266         if (content_type && strcmp (content_type, "text/html") == 0)
267                 retval = modest_text_utils_quote_html (text, cited, signature, NULL, 80);
268         else
269                 retval = modest_text_utils_quote_plain_text (text, cited, signature, NULL, 80);
270         
271         g_free (cited);
272         return retval;
273 }
274
275 /* just to prevent warnings:
276  * warning: `%x' yields only last 2 digits of year in some locales
277  */
278 gsize
279 modest_text_utils_strftime(char *s, gsize max, const char *fmt, time_t timet)
280 {
281         struct tm tm;
282
283         /* To prevent possible problems in strftime that could leave
284            garbage in the s variable */
285         if (s)
286                 s[0] = '\0';
287         else
288                 return 0;
289
290         /* does not work on old maemo glib: 
291          *   g_date_set_time_t (&date, timet);
292          */
293         localtime_r (&timet, &tm);
294         return strftime(s, max, fmt, &tm);
295 }
296
297 gchar *
298 modest_text_utils_derived_subject (const gchar *subject, const gchar *prefix)
299 {
300         gchar *tmp, *subject_dup, *retval;
301         gint prefix_len;
302
303         g_return_val_if_fail (prefix, NULL);
304
305         if (!subject || subject[0] == '\0')
306                 subject = _("mail_va_no_subject");
307
308         subject_dup = g_strdup (subject);
309         tmp = g_strchug (subject_dup);
310
311         /* We do not want things like "Re: Re: Re:" or "Fw: Fw:" so
312            delete the previous ones */
313         prefix_len = strlen (prefix);
314         do {
315                 if (g_str_has_prefix (tmp, prefix)) {
316                         tmp += prefix_len;
317                         tmp = g_strchug (tmp);
318                 } else {
319                         gchar *prefix_down, *tmp_down;
320
321                         /* We need this to properly check the cases of
322                            some clients adding FW: instead of Fw: for
323                            example */
324                         prefix_down = g_utf8_strdown (prefix, -1);
325                         tmp_down = g_utf8_strdown (tmp, -1);
326                         if (g_str_has_prefix (tmp_down, prefix_down)) {
327                                 tmp += prefix_len;
328                                 tmp = g_strchug (tmp);
329                                 g_free (prefix_down);
330                                 g_free (tmp_down);
331                         } else {
332                                 g_free (prefix_down);
333                                 g_free (tmp_down);
334                                 break;
335                         }
336                 }
337         } while (tmp);
338
339         retval = g_strdup_printf ("%s %s", prefix, tmp);
340         g_free (subject_dup);
341
342         return retval;
343 }
344
345
346 /* Performs a case-insensitive strstr for ASCII strings */
347 static const gchar *
348 ascii_stristr(const gchar *haystack, const gchar *needle)
349 {
350         int needle_len;
351         int haystack_len;
352         const gchar *pos;
353         const gchar *max_pos;
354
355         if (haystack == NULL || needle == NULL) {
356                 return haystack;  /* as in strstr */
357         }
358
359         needle_len = strlen(needle);
360
361         if (needle_len == 0) {
362                 return haystack;  /* as in strstr */
363         }
364
365         haystack_len = strlen(haystack);
366         max_pos = haystack + haystack_len - needle_len;
367
368         for (pos = haystack; pos <= max_pos; pos++) {
369                 if (g_ascii_strncasecmp (pos, needle, needle_len) == 0) {
370                         return pos;
371                 }
372         }
373
374         return NULL;
375 }
376
377
378 gchar*
379 modest_text_utils_remove_address (const gchar *address_list, const gchar *address)
380 {
381         gchar *dup, *token, *ptr = NULL, *result;
382         GString *filtered_emails;
383         gchar *email_address;
384
385         g_return_val_if_fail (address_list, NULL);
386
387         if (!address)
388                 return g_strdup (address_list);
389
390         email_address = get_email_from_address (address);
391
392         /* search for substring */
393         if (!ascii_stristr ((const char *) address_list, (const char *) email_address)) {
394                 g_free (email_address);
395                 return g_strdup (address_list);
396         }
397
398         dup = g_strdup (address_list);
399         filtered_emails = g_string_new (NULL);
400
401         token = strtok_r (dup, ",", &ptr);
402
403         while (token != NULL) {
404                 /* Add to list if not found */
405                 if (!ascii_stristr ((const char *) token, (const char *) email_address)) {
406                         if (filtered_emails->len == 0)
407                                 g_string_append_printf (filtered_emails, "%s", g_strstrip (token));
408                         else
409                                 g_string_append_printf (filtered_emails, ",%s", g_strstrip (token));
410                 }
411                 token = strtok_r (NULL, ",", &ptr);
412         }
413         result = filtered_emails->str;
414
415         /* Clean */
416         g_free (email_address);
417         g_free (dup);
418         g_string_free (filtered_emails, FALSE);
419
420         return result;
421 }
422
423
424 gchar*
425 modest_text_utils_remove_duplicate_addresses (const gchar *address_list)
426 {
427         GSList *addresses, *cursor;
428         GHashTable *table;
429         gchar *new_list = NULL;
430         
431         g_return_val_if_fail (address_list, NULL);
432
433         table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
434         addresses = modest_text_utils_split_addresses_list (address_list);
435
436         cursor = addresses;
437         while (cursor) {
438                 const gchar* address = (const gchar*)cursor->data;
439
440                 /* We need only the email to just compare it and not
441                    the full address which would make "a <a@a.com>"
442                    different from "a@a.com" */
443                 const gchar *email = get_email_from_address (address);
444
445                 /* ignore the address if already seen */
446                 if (g_hash_table_lookup (table, email) == 0) {
447                         gchar *tmp;
448
449                         /* Include the full address and not only the
450                            email in the returned list */
451                         if (!new_list) {
452                                 tmp = g_strdup (address);
453                         } else {
454                                 tmp = g_strjoin (",", new_list, address, NULL);
455                                 g_free (new_list);
456                         }
457                         new_list = tmp;
458                         
459                         g_hash_table_insert (table, (gchar*)email, GINT_TO_POINTER(1));
460                 }
461                 cursor = g_slist_next (cursor);
462         }
463
464         g_hash_table_unref (table);
465         g_slist_foreach (addresses, (GFunc)g_free, NULL);
466         g_slist_free (addresses);
467
468         if (new_list == NULL)
469                 new_list = g_strdup ("");
470
471         return new_list;
472 }
473
474
475 static void
476 modest_text_utils_convert_buffer_to_html_start (GString *html, const gchar *data, gssize n)
477 {
478         guint           i;
479         gboolean        space_seen = FALSE;
480         guint           break_dist = 0; /* distance since last break point */
481
482         if (n == -1)
483                 n = strlen (data);
484
485         /* replace with special html chars where needed*/
486         for (i = 0; i != n; ++i)  {
487                 guchar kar = data[i];
488                 
489                 if (space_seen && kar != ' ') {
490                         g_string_append (html, " ");
491                         space_seen = FALSE;
492                 }
493                 
494                 /* we artificially insert a breakpoint (newline)
495                  * after 256, to make sure our lines are not so long
496                  * they will DOS the regexping later
497                  * Also, check that kar is ASCII to make sure that we
498                  * don't break a UTF8 char in two
499                  */
500                 if (++break_dist >= 256 && kar < 127) {
501                         g_string_append_c (html, '\n');
502                         break_dist = 0;
503                 }
504                 
505                 switch (kar) {
506                 case 0:
507                 case MARK_AMP:
508                 case MARK_AMP_URI:      
509                         /* this is a temp place holder for '&'; we can only
510                                 * set the real '&' after hyperlink translation, otherwise
511                                 * we might screw that up */
512                         break; /* ignore embedded \0s and MARK_AMP */   
513                 case '<'  : g_string_append (html, MARK_AMP_STR "lt;");   break;
514                 case '>'  : g_string_append (html, MARK_AMP_STR "gt;");   break;
515                 case '&'  : g_string_append (html, MARK_AMP_URI_STR "amp;");  break; /* special case */
516                 case '"'  : g_string_append (html, MARK_AMP_STR "quot;");  break;
517
518                 /* don't convert &apos; --> wpeditor will try to re-convert it... */    
519                 //case '\'' : g_string_append (html, "&apos;"); break;
520                 case '\n' : g_string_append (html, "<br>\n");break_dist= 0; break;
521                 case '\t' : g_string_append (html, MARK_AMP_STR "nbsp;" MARK_AMP_STR "nbsp;" MARK_AMP_STR "nbsp; ");
522                         break_dist=0; break; /* note the space at the end*/
523                 case ' ':
524                         break_dist = 0;
525                         if (space_seen) { /* second space in a row */
526                                 g_string_append (html, "&nbsp; ");
527                         } else
528                                 space_seen = TRUE;
529                         break;
530                 default:
531                         g_string_append_c (html, kar);
532                 }
533         }
534 }
535
536
537 static void
538 modest_text_utils_convert_buffer_to_html_finish (GString *html)
539 {
540         int i;
541         /* replace all our MARK_AMPs with real ones */
542         for (i = 0; i != html->len; ++i)
543                 if ((html->str)[i] == MARK_AMP || (html->str)[i] == MARK_AMP_URI)
544                         (html->str)[i] = '&';
545 }
546
547
548 gchar*
549 modest_text_utils_convert_to_html (const gchar *data)
550 {
551         GString         *html;      
552         gsize           len;
553
554         g_return_val_if_fail (data, NULL);
555         
556         if (!data)
557                 return NULL;
558
559         len = strlen (data);
560         html = g_string_sized_new (1.5 * len);  /* just a  guess... */
561
562         g_string_append_printf (html,
563                                 "<html><head>"
564                                 "<meta http-equiv=\"content-type\" content=\"text/html; charset=utf8\">"
565                                 "</head>"
566                                 "<body>");
567
568         modest_text_utils_convert_buffer_to_html_start (html, data, -1);
569         
570         g_string_append (html, "</body></html>");
571
572         if (len <= HYPERLINKIFY_MAX_LENGTH)
573                 hyperlinkify_plain_text (html, 0);
574
575         modest_text_utils_convert_buffer_to_html_finish (html);
576         
577         return g_string_free (html, FALSE);
578 }
579
580 gchar *
581 modest_text_utils_convert_to_html_body (const gchar *data, gssize n, gboolean hyperlinkify)
582 {
583         GString         *html;      
584
585         g_return_val_if_fail (data, NULL);
586
587         if (!data)
588                 return NULL;
589
590         if (n == -1) 
591                 n = strlen (data);
592         html = g_string_sized_new (1.5 * n);    /* just a  guess... */
593
594         modest_text_utils_convert_buffer_to_html_start (html, data, n);
595
596         if (hyperlinkify && (n < HYPERLINKIFY_MAX_LENGTH))
597                 hyperlinkify_plain_text (html, 0);
598
599         modest_text_utils_convert_buffer_to_html_finish (html);
600         
601         return g_string_free (html, FALSE);
602 }
603
604 void
605 modest_text_utils_get_addresses_indexes (const gchar *addresses, GSList **start_indexes, GSList **end_indexes)
606 {
607         gchar *current, *start, *last_blank;
608         gint start_offset = 0, current_offset = 0;
609
610         g_return_if_fail (start_indexes != NULL);
611         g_return_if_fail (end_indexes != NULL);
612
613         start = (gchar *) addresses;
614         current = start;
615         last_blank = start;
616
617         while (*current != '\0') {
618                 if ((start == current)&&((*current == ' ')||(*current == ',')||(*current == ';'))) {
619                         start = g_utf8_next_char (start);
620                         start_offset++;
621                         last_blank = current;
622                 } else if ((*current == ',')||(*current == ';')) {
623                         gint *start_index, *end_index;
624                         start_index = g_new0(gint, 1);
625                         end_index = g_new0(gint, 1);
626                         *start_index = start_offset;
627                         *end_index = current_offset;
628                         *start_indexes = g_slist_prepend (*start_indexes, start_index);
629                         *end_indexes = g_slist_prepend (*end_indexes, end_index);
630                         start = g_utf8_next_char (current);
631                         start_offset = current_offset + 1;
632                         last_blank = start;
633                 } else if (*current == '"') {
634                         current = g_utf8_next_char (current);
635                         current_offset ++;
636                         while ((*current != '"')&&(*current != '\0')) {
637                                 current = g_utf8_next_char (current);
638                                 current_offset ++;
639                         }
640                 }
641                                 
642                 current = g_utf8_next_char (current);
643                 current_offset ++;
644         }
645
646         if (start != current) {
647                         gint *start_index, *end_index;
648                         start_index = g_new0(gint, 1);
649                         end_index = g_new0(gint, 1);
650                         *start_index = start_offset;
651                         *end_index = current_offset;
652                         *start_indexes = g_slist_prepend (*start_indexes, start_index);
653                         *end_indexes = g_slist_prepend (*end_indexes, end_index);
654         }
655         
656         *start_indexes = g_slist_reverse (*start_indexes);
657         *end_indexes = g_slist_reverse (*end_indexes);
658
659         return;
660 }
661
662
663 GSList *
664 modest_text_utils_split_addresses_list (const gchar *addresses)
665 {
666         GSList *head;
667         const gchar *my_addrs = addresses;
668         const gchar *end;
669         gchar *addr;
670         gboolean after_at = FALSE;
671
672         g_return_val_if_fail (addresses, NULL);
673         
674         /* skip any space, ',', ';' at the start */
675         while (my_addrs && (my_addrs[0] == ' ' || my_addrs[0] == ',' || my_addrs[0] == ';'))
676                ++my_addrs;
677
678         /* are we at the end of addresses list? */
679         if (!my_addrs[0])
680                 return NULL;
681         
682         /* nope, we are at the start of some address
683          * now, let's find the end of the address */
684         end = my_addrs + 1;
685         while (end[0] && end[0] != ';' && !(after_at && end[0] == ',')) {
686                 if (end[0] == '\"') {
687                         while (end[0] && end[0] != '\"')
688                                 ++end;
689                 }
690                 if (end[0] == '@') {
691                         after_at = TRUE;
692                 }
693                 if ((end[0] && end[0] == '>')&&(end[1] && end[1] == ',')) {
694                         ++end;
695                         break;
696                 }
697                 ++end;
698         }
699
700         /* we got the address; copy it and remove trailing whitespace */
701         addr = g_strndup (my_addrs, end - my_addrs);
702         g_strchomp (addr);
703
704         head = g_slist_append (NULL, addr);
705         head->next = modest_text_utils_split_addresses_list (end); /* recurse */
706
707         return head;
708 }
709
710
711 void
712 modest_text_utils_address_range_at_position (const gchar *recipients_list,
713                                              guint position,
714                                              guint *start,
715                                              guint *end)
716 {
717         gchar *current = NULL;
718         gint range_start = 0;
719         gint range_end = 0;
720         gint index;
721         gboolean is_quoted = FALSE;
722
723         g_return_if_fail (recipients_list);
724         g_return_if_fail (position < g_utf8_strlen(recipients_list, -1));
725                 
726         index = 0;
727         for (current = (gchar *) recipients_list; *current != '\0';
728              current = g_utf8_find_next_char (current, NULL)) {
729                 gunichar c = g_utf8_get_char (current);
730
731                 if ((c == ',') && (!is_quoted)) {
732                         if (index < position) {
733                                 range_start = index + 1;
734                         } else {
735                                 break;
736                         }
737                 } else if (c == '\"') {
738                         is_quoted = !is_quoted;
739                 } else if ((c == ' ') &&(range_start == index)) {
740                         range_start ++;
741                 }
742                 index ++;
743                 range_end = index;
744         }
745
746         if (start)
747                 *start = range_start;
748         if (end)
749                 *end = range_end;
750 }
751
752 gchar *
753 modest_text_utils_address_with_standard_length (const gchar *recipients_list)
754 {
755         gchar ** splitted;
756         gchar ** current;
757         GString *buffer = g_string_new ("");
758
759         splitted = g_strsplit (recipients_list, "\n", 0);
760         current = splitted;
761         while (*current) {
762                 gchar *line;
763                 if (current != splitted)
764                         buffer = g_string_append_c (buffer, '\n');
765                 line = g_strndup (*splitted, 1000);
766                 buffer = g_string_append (buffer, line);
767                 g_free (line);
768                 current++;
769         }
770
771         g_strfreev (splitted);
772
773         return g_string_free (buffer, FALSE);
774 }
775
776
777 /* ******************************************************************* */
778 /* ************************* UTILIY FUNCTIONS ************************ */
779 /* ******************************************************************* */
780
781 static GString *
782 get_next_line (const gchar * b, const gsize blen, const gchar * iter)
783 {
784         GString *gs;
785         const gchar *i0;
786         
787         if (iter > b + blen)
788                 return g_string_new("");
789         
790         i0 = iter;
791         while (iter[0]) {
792                 if (iter[0] == '\n')
793                         break;
794                 iter++;
795         }
796         gs = g_string_new_len (i0, iter - i0);
797         return gs;
798 }
799 static int
800 get_indent_level (const char *l)
801 {
802         int indent = 0;
803
804         while (l[0]) {
805                 if (l[0] == '>') {
806                         indent++;
807                         if (l[1] == ' ') {
808                                 l++;
809                         }
810                 } else {
811                         break;
812                 }
813                 l++;
814
815         }
816
817         /*      if we hit the signature marker "-- ", we return -(indent + 1). This
818          *      stops reformatting.
819          */
820         if (strcmp (l, MODEST_TEXT_UTILS_SIGNATURE_MARKER) == 0) {
821                 return -1 - indent;
822         } else {
823                 return indent;
824         }
825 }
826
827 static void
828 unquote_line (GString * l, const gchar *quote_symbol)
829 {
830         gchar *p;
831         gint quote_len;
832
833         p = l->str;
834         quote_len = strlen (quote_symbol);
835         while (p[0]) {
836                 if (g_str_has_prefix (p, quote_symbol)) {
837                         if (p[quote_len] == ' ') {
838                                 p += quote_len;
839                         }
840                 } else {
841                         break;
842                 }
843                 p++;
844         }
845         g_string_erase (l, 0, p - l->str);
846 }
847
848 static void
849 append_quoted (GString * buf, const gchar *quote_symbol,
850                int indent, const GString * str,
851                const int cutpoint)
852 {
853         int i;
854         gchar *quote_concat;
855
856         indent = indent < 0 ? abs (indent) - 1 : indent;
857         quote_concat = g_strconcat (quote_symbol, " ", NULL);
858         for (i = 0; i <= indent; i++) {
859                 g_string_append (buf, quote_concat);
860         }
861         g_free (quote_concat);
862         if (cutpoint > 0) {
863                 g_string_append_len (buf, str->str, cutpoint);
864         } else {
865                 g_string_append (buf, str->str);
866         }
867         g_string_append (buf, "\n");
868 }
869
870 static int
871 get_breakpoint_utf8 (const gchar * s, gint indent, const gint limit)
872 {
873         gint index = 0;
874         const gchar *pos, *last;
875         gunichar *uni;
876
877         indent = indent < 0 ? abs (indent) - 1 : indent;
878
879         last = NULL;
880         pos = s;
881         uni = g_utf8_to_ucs4_fast (s, -1, NULL);
882         while (pos[0]) {
883                 if ((index + 2 * indent > limit) && last) {
884                         g_free (uni);
885                         return last - s;
886                 }
887                 if (g_unichar_isspace (uni[index])) {
888                         last = pos;
889                 }
890                 pos = g_utf8_next_char (pos);
891                 index++;
892         }
893         g_free (uni);
894         return strlen (s);
895 }
896
897 static int
898 get_breakpoint_ascii (const gchar * s, const gint indent, const gint limit)
899 {
900         gint i, last;
901
902         last = strlen (s);
903         if (last + 2 * indent < limit)
904                 return last;
905
906         for (i = strlen (s); i > 0; i--) {
907                 if (s[i] == ' ') {
908                         if (i + 2 * indent <= limit) {
909                                 return i;
910                         } else {
911                                 last = i;
912                         }
913                 }
914         }
915         return last;
916 }
917
918 static int
919 get_breakpoint (const gchar * s, const gint indent, const gint limit)
920 {
921
922         if (g_utf8_validate (s, -1, NULL)) {
923                 return get_breakpoint_utf8 (s, indent, limit);
924         } else {                /* assume ASCII */
925                 //g_warning("invalid UTF-8 in msg");
926                 return get_breakpoint_ascii (s, indent, limit);
927         }
928 }
929
930 static gchar *
931 cite (const time_t sent_date, const gchar *from)
932 {
933         return g_strdup (_("mcen_ia_editor_original_message"));
934 }
935
936 static gchar *
937 quoted_attachments (GList *attachments)
938 {
939         GList *node = NULL;
940         GString *result = g_string_new ("");
941         for (node = attachments; node != NULL; node = g_list_next (node)) {
942                 gchar *filename = (gchar *) node->data;
943                 g_string_append_printf ( result, "%s %s\n", _("mcen_ia_editor_attach_filename"), filename);
944         }
945
946         return g_string_free (result, FALSE);
947
948 }
949
950 static GString *
951 modest_text_utils_quote_body (GString *output, const gchar *text,
952                               const gchar *quote_symbol,
953                               int limit)
954 {
955
956         const gchar *iter;
957         gsize len;
958         gint indent, breakpoint, rem_indent = 0;
959         GString *l, *remaining;
960
961         iter = text;
962         len = strlen(text);
963         remaining = g_string_new ("");
964         do {
965                 l = get_next_line (text, len, iter);
966                 iter = iter + l->len + 1;
967                 indent = get_indent_level (l->str);
968                 unquote_line (l, quote_symbol);
969
970                 if (remaining->len) {
971                         if (l->len && indent == rem_indent) {
972                                 g_string_prepend (l, " ");
973                                 g_string_prepend (l, remaining->str);
974                         } else {
975                                 do {
976                                         breakpoint =
977                                                 get_breakpoint (remaining->str,
978                                                                 rem_indent,
979                                                                 limit);
980                                         append_quoted (output, quote_symbol, rem_indent,
981                                                        remaining, breakpoint);
982                                         g_string_erase (remaining, 0,
983                                                         breakpoint);
984                                         if (remaining->str[0] == ' ') {
985                                                 g_string_erase (remaining, 0,
986                                                                 1);
987                                         }
988                                 } while (remaining->len);
989                         }
990                 }
991                 g_string_free (remaining, TRUE);
992                 breakpoint = get_breakpoint (l->str, indent, limit);
993                 remaining = g_string_new (l->str + breakpoint);
994                 if (remaining->str[0] == ' ') {
995                         g_string_erase (remaining, 0, 1);
996                 }
997                 rem_indent = indent;
998                 append_quoted (output, quote_symbol, indent, l, breakpoint);
999                 g_string_free (l, TRUE);
1000         } while ((iter < text + len) || (remaining->str[0]));
1001
1002         return output;
1003 }
1004
1005 static gchar *
1006 modest_text_utils_quote_plain_text (const gchar *text, 
1007                                     const gchar *cite, 
1008                                     const gchar *signature,
1009                                     GList *attachments,
1010                                     int limit)
1011 {
1012         GString *q;
1013         gchar *attachments_string = NULL;
1014
1015         q = g_string_new ("");
1016
1017         if (signature != NULL) {
1018                 g_string_append_printf (q, "\n%s\n", MODEST_TEXT_UTILS_SIGNATURE_MARKER);
1019                 q = g_string_append (q, signature);
1020         }
1021
1022         q = g_string_append (q, "\n");
1023         q = g_string_append (q, cite);
1024         q = g_string_append_c (q, '\n');
1025
1026         q = modest_text_utils_quote_body (q, text, ">", limit);
1027
1028         attachments_string = quoted_attachments (attachments);
1029         q = g_string_append (q, attachments_string);
1030         g_free (attachments_string);
1031
1032         return g_string_free (q, FALSE);
1033 }
1034
1035 static void
1036 quote_html_add_to_gstring (GString *string,
1037                            const gchar *text)
1038 {
1039         if (text && strcmp (text, "")) {
1040                 gchar *html_text = modest_text_utils_convert_to_html_body (text, -1, TRUE);
1041                 g_string_append_printf (string, "%s<br/>", html_text);
1042                 g_free (html_text);
1043         }
1044 }
1045
1046 static gchar*
1047 modest_text_utils_quote_html (const gchar *text, 
1048                               const gchar *cite, 
1049                               const gchar *signature,
1050                               GList *attachments,
1051                               int limit)
1052 {
1053         GString *result_string;
1054
1055         result_string = 
1056                 g_string_new ( \
1057                               "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">\n" \
1058                               "<html>\n"                                \
1059                               "<body>\n<br/>\n");
1060
1061         if (text || cite || signature) {
1062                 GString *quoted_text;
1063                 g_string_append (result_string, "<pre>\n");
1064                 if (signature) {
1065                         quote_html_add_to_gstring (result_string, MODEST_TEXT_UTILS_SIGNATURE_MARKER);
1066                         quote_html_add_to_gstring (result_string, signature);
1067                 }
1068                 quote_html_add_to_gstring (result_string, cite);
1069                 quoted_text = g_string_new ("");
1070                 quoted_text = modest_text_utils_quote_body (quoted_text, (text) ? text : "", ">", limit);
1071                 quote_html_add_to_gstring (result_string, quoted_text->str);
1072                 g_string_free (quoted_text, TRUE);
1073                 if (attachments) {
1074                         gchar *attachments_string = quoted_attachments (attachments);
1075                         quote_html_add_to_gstring (result_string, attachments_string);
1076                         g_free (attachments_string);
1077                 }
1078                 g_string_append (result_string, "</pre>");
1079         }
1080         g_string_append (result_string, "</body>");
1081         g_string_append (result_string, "</html>");
1082
1083         return g_string_free (result_string, FALSE);
1084 }
1085
1086 static gint 
1087 cmp_offsets_reverse (const url_match_t *match1, const url_match_t *match2)
1088 {
1089         return match2->offset - match1->offset;
1090 }
1091
1092 static gint url_matches_block = 0;
1093 static url_match_pattern_t patterns[] = MAIL_VIEWER_URL_MATCH_PATTERNS;
1094 static GMutex *url_patterns_mutex = NULL;
1095
1096
1097 static gboolean
1098 compile_patterns ()
1099 {
1100         guint i;
1101         const size_t pattern_num = sizeof(patterns)/sizeof(url_match_pattern_t);
1102         for (i = 0; i != pattern_num; ++i) {
1103                 patterns[i].preg = g_slice_new0 (regex_t);
1104                 
1105                 /* this should not happen */
1106                 if (regcomp (patterns[i].preg, patterns[i].regex,
1107                              REG_ICASE|REG_EXTENDED|REG_NEWLINE) != 0) {
1108                         g_warning ("%s: error in regexp:\n%s\n", __FUNCTION__, patterns[i].regex);
1109                         return FALSE;
1110                 }
1111         }
1112         return TRUE;
1113 }
1114
1115 static void 
1116 free_patterns ()
1117 {
1118         guint i;
1119         const size_t pattern_num = sizeof(patterns)/sizeof(url_match_pattern_t);
1120         for (i = 0; i != pattern_num; ++i) {
1121                 regfree (patterns[i].preg);
1122                 g_slice_free  (regex_t, patterns[i].preg);
1123         } /* don't free patterns itself -- it's static */
1124 }
1125
1126 void
1127 modest_text_utils_hyperlinkify_begin (void)
1128 {
1129
1130         if (url_patterns_mutex == NULL) {
1131                 url_patterns_mutex = g_mutex_new ();
1132         }
1133         g_mutex_lock (url_patterns_mutex);
1134         if (url_matches_block == 0)
1135                 compile_patterns ();
1136         url_matches_block ++;
1137         g_mutex_unlock (url_patterns_mutex);
1138 }
1139
1140 void
1141 modest_text_utils_hyperlinkify_end (void)
1142 {
1143         g_mutex_lock (url_patterns_mutex);
1144         url_matches_block--;
1145         if (url_matches_block <= 0)
1146                 free_patterns ();
1147         g_mutex_unlock (url_patterns_mutex);
1148 }
1149
1150
1151 static GSList*
1152 get_url_matches (GString *txt, gint offset)
1153 {
1154         regmatch_t rm;
1155         guint rv, i, tmp_offset = 0;
1156         GSList *match_list = NULL;
1157
1158         const size_t pattern_num = sizeof(patterns)/sizeof(url_match_pattern_t);
1159
1160         /* initalize the regexps */
1161         modest_text_utils_hyperlinkify_begin ();
1162
1163         /* find all the matches */
1164         for (i = 0; i != pattern_num; ++i) {
1165                 tmp_offset     = offset;        
1166                 while (1) {
1167                         url_match_t *match;
1168                         gboolean is_submatch;
1169                         GSList *cursor;
1170                         
1171                         if ((rv = regexec (patterns[i].preg, txt->str + tmp_offset, 1, &rm, 0)) != 0) {
1172                                 g_return_val_if_fail (rv == REG_NOMATCH, NULL); /* this should not happen */
1173                                 break; /* try next regexp */ 
1174                         }
1175                         if (rm.rm_so == -1)
1176                                 break;
1177                         
1178                         is_submatch = FALSE;
1179                         /* check  old matches to see if this has already been matched */
1180                         cursor = match_list;
1181                         while (cursor && !is_submatch) {
1182                                 const url_match_t *old_match =
1183                                         (const url_match_t *) cursor->data;
1184                                 guint new_offset = tmp_offset + rm.rm_so;
1185                                 is_submatch = (new_offset >  old_match->offset &&
1186                                                new_offset <  old_match->offset + old_match->len);
1187                                 cursor = g_slist_next (cursor);
1188                         }
1189
1190                         if (!is_submatch) {
1191                                 /* make a list of our matches (<offset, len, prefix> tupels)*/
1192                                 match = g_slice_new (url_match_t);
1193                                 match->offset = tmp_offset + rm.rm_so;
1194                                 match->len    = rm.rm_eo - rm.rm_so;
1195                                 match->prefix = patterns[i].prefix;
1196                                 match_list = g_slist_prepend (match_list, match);
1197                         }               
1198                         tmp_offset += rm.rm_eo;
1199                 }
1200         }
1201
1202         modest_text_utils_hyperlinkify_end ();
1203         
1204         /* now sort the list, so the matches are in reverse order of occurence.
1205          * that way, we can do the replacements starting from the end, so we don't need
1206          * to recalculate the offsets
1207          */
1208         match_list = g_slist_sort (match_list,
1209                                    (GCompareFunc)cmp_offsets_reverse); 
1210         return match_list;      
1211 }
1212
1213
1214
1215 /* replace all occurences of needle in haystack with repl*/
1216 static gchar*
1217 replace_string (const gchar *haystack, const gchar *needle, gchar repl)
1218 {
1219         gchar *str, *cursor;
1220
1221         if (!haystack || !needle || strlen(needle) == 0)
1222                 return haystack ? g_strdup(haystack) : NULL;
1223         
1224         str = g_strdup (haystack);
1225
1226         for (cursor = str; cursor && *cursor; ++cursor) {
1227                 if (g_str_has_prefix (cursor, needle)) {
1228                         cursor[0] = repl;
1229                         memmove (cursor + 1,
1230                                  cursor + strlen (needle),
1231                                  strlen (cursor + strlen (needle)) + 1);
1232                 }
1233         }
1234         
1235         return str;
1236 }
1237
1238 static void
1239 hyperlinkify_plain_text (GString *txt, gint offset)
1240 {
1241         GSList *cursor;
1242         GSList *match_list = get_url_matches (txt, offset);
1243
1244         /* we will work backwards, so the offsets stay valid */
1245         for (cursor = match_list; cursor; cursor = cursor->next) {
1246
1247                 url_match_t *match = (url_match_t*) cursor->data;
1248                 gchar *url  = g_strndup (txt->str + match->offset, match->len);
1249                 gchar *repl = NULL; /* replacement  */
1250
1251                 /* the string still contains $(MARK_AMP_URI_STR)"amp;" for each
1252                  * '&' in the original, because of the text->html conversion.
1253                  * in the href-URL (and only there), we must convert that back to
1254                  * '&'
1255                  */
1256                 gchar *href_url = replace_string (url, MARK_AMP_URI_STR "amp;", '&');
1257                 
1258                 /* the prefix is NULL: use the one that is already there */
1259                 repl = g_strdup_printf ("<a href=\"%s%s\">%s</a>",
1260                                         match->prefix ? match->prefix : EMPTY_STRING, 
1261                                         href_url, url);
1262
1263                 /* replace the old thing with our hyperlink
1264                  * replacement thing */
1265                 g_string_erase  (txt, match->offset, match->len);
1266                 g_string_insert (txt, match->offset, repl);
1267                 
1268                 g_free (url);
1269                 g_free (repl);
1270                 g_free (href_url);
1271
1272                 g_slice_free (url_match_t, match);      
1273         }
1274         
1275         g_slist_free (match_list);
1276 }
1277
1278 void
1279 modest_text_utils_hyperlinkify (GString *string_buffer)
1280 {
1281         gchar *after_body;
1282         gint offset = 0;
1283
1284         after_body = strstr (string_buffer->str, "<body>");
1285         if (after_body != NULL)
1286                 offset = after_body - string_buffer->str;
1287         hyperlinkify_plain_text (string_buffer, offset);
1288 }
1289
1290
1291 /* for optimization reasons, we change the string in-place */
1292 void
1293 modest_text_utils_get_display_address (gchar *address)
1294 {
1295         int i;
1296
1297         g_return_if_fail (address);
1298         
1299         if (!address)
1300                 return;
1301         
1302         /* should not be needed, and otherwise, we probably won't screw up the address
1303          * more than it already is :) 
1304          * g_return_val_if_fail (g_utf8_validate (address, -1, NULL), NULL);
1305          * */
1306         
1307         /* remove leading whitespace */
1308         if (address[0] == ' ')
1309                 g_strchug (address);
1310                 
1311         for (i = 0; address[i]; ++i) {
1312                 if (address[i] == '<') {
1313                         if (G_UNLIKELY(i == 0)) {
1314                                 break; /* there's nothing else, leave it */
1315                         }else {
1316                                 address[i] = '\0'; /* terminate the string here */
1317                                 break;
1318                         }
1319                 }
1320         }
1321
1322         g_strchomp (address);
1323 }
1324
1325
1326 gchar *
1327 modest_text_utils_get_display_addresses (const gchar *recipients)
1328 {
1329         gchar *addresses;
1330         GSList *recipient_list;
1331
1332         addresses = NULL;
1333         recipient_list = modest_text_utils_split_addresses_list (recipients);
1334         if (recipient_list) {
1335                 GString *add_string = g_string_sized_new (strlen (recipients));
1336                 GSList *iter = recipient_list;
1337                 gboolean first = TRUE;
1338
1339                 while (iter) {
1340                         /* Strings are changed in place */
1341                         modest_text_utils_get_display_address ((gchar *) iter->data);
1342                         if (G_UNLIKELY (first)) {
1343                                 g_string_append_printf (add_string, "%s", (gchar *) iter->data);
1344                                 first = FALSE;
1345                         } else {
1346                                 g_string_append_printf (add_string, ", %s", (gchar *) iter->data);
1347                         }
1348                         iter = g_slist_next (iter);
1349                 }
1350                 g_slist_foreach (recipient_list, (GFunc) g_free, NULL);
1351                 g_slist_free (recipient_list);
1352                 addresses = g_string_free (add_string, FALSE);
1353         }
1354
1355         return addresses;
1356 }
1357
1358
1359 gchar *
1360 modest_text_utils_get_email_address (const gchar *full_address)
1361 {
1362         const gchar *left, *right;
1363
1364         g_return_val_if_fail (full_address, NULL);
1365         
1366         if (!full_address)
1367                 return NULL;
1368         
1369         g_return_val_if_fail (g_utf8_validate (full_address, -1, NULL), NULL);
1370         
1371         left = g_strrstr_len (full_address, strlen(full_address), "<");
1372         if (left == NULL)
1373                 return g_strdup (full_address);
1374
1375         right = g_strstr_len (left, strlen(left), ">");
1376         if (right == NULL)
1377                 return g_strdup (full_address);
1378
1379         return g_strndup (left + 1, right - left - 1);
1380 }
1381
1382 gint 
1383 modest_text_utils_get_subject_prefix_len (const gchar *sub)
1384 {
1385         gint prefix_len = 0;    
1386
1387         g_return_val_if_fail (sub, 0);
1388
1389         if (!sub)
1390                 return 0;
1391         
1392         /* optimization: "Re", "RE", "re","Fwd", "FWD", "fwd","FW","Fw", "fw" */
1393         if (sub[0] != 'R' && sub[0] != 'F' && sub[0] != 'r' && sub[0] != 'f')
1394                 return 0;
1395         else if (sub[0] && sub[1] != 'e' && sub[1] != 'E' && sub[1] != 'w' && sub[1] != 'W')
1396                 return 0;
1397
1398         prefix_len = 2;
1399         if (sub[2] == 'd')
1400                 ++prefix_len;
1401
1402         /* skip over a [...] block */
1403         if (sub[prefix_len] == '[') {
1404                 int c = prefix_len + 1;
1405                 while (sub[c] && sub[c] != ']')
1406                         ++c;
1407                 if (!sub[c])
1408                         return 0; /* no end to the ']' found */
1409                 else
1410                         prefix_len = c + 1;
1411         }
1412
1413         /* did we find the ':' ? */
1414         if (sub[prefix_len] == ':') {
1415                 ++prefix_len;
1416                 if (sub[prefix_len] == ' ')
1417                         ++prefix_len;
1418                 prefix_len += modest_text_utils_get_subject_prefix_len (sub + prefix_len);
1419 /*              g_warning ("['%s','%s']", sub, (char*) sub + prefix_len); */
1420                 return prefix_len;
1421         } else
1422                 return 0;
1423 }
1424
1425
1426 gint
1427 modest_text_utils_utf8_strcmp (const gchar* s1, const gchar *s2, gboolean insensitive)
1428 {
1429
1430 /* work even when s1 and/or s2 == NULL */
1431         if (G_UNLIKELY(s1 == s2))
1432                 return 0;
1433         if (G_UNLIKELY(!s1))
1434                 return -1;
1435         if (G_UNLIKELY(!s2))
1436                 return 1;
1437         
1438         /* if it's not case sensitive */
1439         if (!insensitive) {
1440
1441                 /* optimization: shortcut if first char is ascii */ 
1442                 if (((s1[0] & 0x80)== 0) && ((s2[0] & 0x80) == 0) &&
1443                     (s1[0] != s2[0])) 
1444                         return s1[0] - s2[0];
1445                 
1446                 return g_utf8_collate (s1, s2);
1447
1448         } else {
1449                 gint result;
1450                 gchar *n1, *n2;
1451
1452                 /* optimization: shortcut if first char is ascii */ 
1453                 if (((s1[0] & 0x80) == 0) && ((s2[0] & 0x80) == 0) &&
1454                     (tolower(s1[0]) != tolower (s2[0]))) 
1455                         return tolower(s1[0]) - tolower(s2[0]);
1456                 
1457                 n1 = g_utf8_strdown (s1, -1);
1458                 n2 = g_utf8_strdown (s2, -1);
1459                 
1460                 result = g_utf8_collate (n1, n2);
1461                 
1462                 g_free (n1);
1463                 g_free (n2);
1464         
1465                 return result;
1466         }
1467 }
1468
1469
1470 const gchar*
1471 modest_text_utils_get_display_date (time_t date)
1472 {
1473 #define DATE_BUF_SIZE 64 
1474         static gchar date_buf[DATE_BUF_SIZE];
1475         
1476         /* calculate the # of days since epoch for 
1477          * for today and for the date provided 
1478          * based on idea from pvanhoof */
1479         int day      = time(NULL) / (24 * 60 * 60);
1480         int date_day = date       / (24 * 60 * 60);
1481
1482         /* if it's today, show the time, if it's not today, show the date instead */
1483
1484         /* TODO: take into account the system config for 24/12h */
1485 #ifdef MODEST_TOOLKIT_HILDON2
1486         if (day == date_day) /* is the date today? */
1487                 modest_text_utils_strftime (date_buf, DATE_BUF_SIZE, _HL("wdgt_va_24h_time"), date);
1488         else 
1489                 modest_text_utils_strftime (date_buf, DATE_BUF_SIZE, _HL("wdgt_va_date"), date); 
1490 #else
1491         if (day == date_day) /* is the date today? */
1492                 modest_text_utils_strftime (date_buf, DATE_BUF_SIZE, "%X", date);
1493         else 
1494                 modest_text_utils_strftime (date_buf, DATE_BUF_SIZE, "%x", date); 
1495 #endif
1496
1497         return date_buf; /* this is a static buffer, don't free! */
1498 }
1499
1500
1501
1502 gboolean
1503 modest_text_utils_validate_folder_name (const gchar *folder_name)
1504 {
1505         /* based on http://msdn2.microsoft.com/en-us/library/aa365247.aspx,
1506          * with some extras */
1507         
1508         guint len;
1509         gint i;
1510         const gchar **cursor = NULL;
1511         const gchar *forbidden_names[] = { /* windows does not like these */
1512                 "CON", "PRN", "AUX", "NUL", ".", "..", "cur", "tmp", "new", 
1513                 NULL /* cur, tmp, new are reserved for Maildir */
1514         };
1515         
1516         /* cannot be NULL */
1517         if (!folder_name) 
1518                 return FALSE;
1519
1520         /* cannot be empty */
1521         len = strlen(folder_name);
1522         if (len == 0)
1523                 return FALSE;
1524         
1525         /* cannot start with a dot, vfat does not seem to like that */
1526         if (folder_name[0] == '.')
1527                 return FALSE;
1528
1529         /* cannot start or end with a space */
1530         if (g_ascii_isspace(folder_name[0]) || g_ascii_isspace(folder_name[len - 1]))
1531                 return FALSE; 
1532
1533         /* cannot contain a forbidden char */   
1534         for (i = 0; i < len; i++)
1535                 if (modest_text_utils_is_forbidden_char (folder_name[i], FOLDER_NAME_FORBIDDEN_CHARS))
1536                         return FALSE;
1537
1538         /* Cannot contain Windows port numbers. I'd like to use GRegex
1539            but it's still not available in Maemo. sergio */
1540         if (!g_ascii_strncasecmp (folder_name, "LPT", 3) ||
1541             !g_ascii_strncasecmp (folder_name, "COM", 3)) {
1542                 glong val;
1543                 gchar *endptr;
1544
1545                 /* We skip the first 3 characters for the
1546                    comparison */
1547                 val = strtol(folder_name+3, &endptr, 10);
1548
1549                 /* If the conversion to long succeeded then the string
1550                    is not valid for us */
1551                 if (*endptr == '\0')
1552                         return FALSE;
1553                 else
1554                         return TRUE;
1555         }
1556         
1557         /* cannot contain a forbidden word */
1558         if (len <= 4) {
1559                 for (cursor = forbidden_names; cursor && *cursor; ++cursor) {
1560                         if (g_ascii_strcasecmp (folder_name, *cursor) == 0)
1561                                 return FALSE;
1562                 }
1563         }
1564
1565         return TRUE; /* it's valid! */
1566 }
1567
1568
1569
1570 gboolean
1571 modest_text_utils_validate_domain_name (const gchar *domain)
1572 {
1573         gboolean valid = FALSE;
1574         regex_t rx;
1575         const gchar* domain_regex = "^([a-z0-9-]*[a-z0-9]\\.)+[a-z0-9-]*[a-z0-9]$";
1576
1577         g_return_val_if_fail (domain, FALSE);
1578         
1579         if (!domain)
1580                 return FALSE;
1581         
1582         memset (&rx, 0, sizeof(regex_t)); /* coverity wants this... */
1583                 
1584         /* domain name: all alphanum or '-' or '.',
1585          * but beginning/ending in alphanum */  
1586         if (regcomp (&rx, domain_regex, REG_ICASE|REG_EXTENDED|REG_NOSUB)) {
1587                 g_warning ("BUG: error in regexp");
1588                 return FALSE;
1589         }
1590         
1591         valid = (regexec (&rx, domain, 1, NULL, 0) == 0);
1592         regfree (&rx);
1593                 
1594         return valid;
1595 }
1596
1597
1598
1599 gboolean
1600 modest_text_utils_validate_email_address (const gchar *email_address,
1601                                           const gchar **invalid_char_position)
1602 {
1603         int count = 0;
1604         const gchar *c = NULL, *domain = NULL;
1605         static gchar *rfc822_specials = "()<>@,;:\\\"[]&";
1606         
1607         if (invalid_char_position)
1608                 *invalid_char_position = NULL;
1609         
1610         g_return_val_if_fail (email_address, FALSE);
1611         
1612         /* check that the email adress contains exactly one @ */
1613         if (!strstr(email_address, "@") || 
1614                         (strstr(email_address, "@") != g_strrstr(email_address, "@"))) 
1615                 return FALSE;
1616         
1617         /* first we validate the name portion (name@domain) */
1618         for (c = email_address;  *c;  c++) {
1619                 if (*c == '\"' && 
1620                     (c == email_address || 
1621                      *(c - 1) == '.' || 
1622                      *(c - 1) == '\"')) {
1623                         while (*++c) {
1624                                 if (*c == '\"') 
1625                                         break;
1626                                 if (*c == '\\' && (*++c == ' ')) 
1627                                         continue;
1628                                 if (*c <= ' ' || *c >= 127) 
1629                                         return FALSE;
1630                         }
1631                         if (!*c++) 
1632                                 return FALSE;
1633                         if (*c == '@') 
1634                                 break;
1635                         if (*c != '.') 
1636                                 return FALSE;
1637                         continue;
1638                 }
1639                 if (*c == '@') 
1640                         break;
1641                 if (*c <= ' ' || *c >= 127) 
1642                         return FALSE;
1643                 if (strchr(rfc822_specials, *c)) {
1644                         if (invalid_char_position)
1645                                 *invalid_char_position = c;
1646                         return FALSE;
1647                 }
1648         }
1649         if (c == email_address || *(c - 1) == '.') 
1650                 return FALSE;
1651
1652         /* next we validate the domain portion (name@domain) */
1653         if (!*(domain = ++c)) 
1654                 return FALSE;
1655         do {
1656                 if (*c == '.') {
1657                         if (c == domain || *(c - 1) == '.' || *(c + 1) == '\0') 
1658                                 return FALSE;
1659                         count++;
1660                 }
1661                 if (*c <= ' ' || *c >= 127) 
1662                         return FALSE;
1663                 if (strchr(rfc822_specials, *c)) {
1664                         if (invalid_char_position)
1665                                 *invalid_char_position = c;
1666                         return FALSE;
1667                 }
1668         } while (*++c);
1669
1670         return (count >= 1) ? TRUE : FALSE;
1671 }
1672
1673 gboolean 
1674 modest_text_utils_validate_recipient (const gchar *recipient, const gchar **invalid_char_position)
1675 {
1676         gchar *stripped, *current;
1677         gchar *right_part;
1678         gboolean has_error = FALSE;
1679
1680         if (invalid_char_position)
1681                 *invalid_char_position = NULL;
1682         
1683         g_return_val_if_fail (recipient, FALSE);
1684         
1685         if (modest_text_utils_validate_email_address (recipient, invalid_char_position))
1686                 return TRUE;
1687
1688         stripped = g_strdup (recipient);
1689         stripped = g_strstrip (stripped);
1690         current = stripped;
1691
1692         if (*current == '\0') {
1693                 g_free (stripped);
1694                 return FALSE;
1695         }
1696
1697         /* quoted string */
1698         if (*current == '\"') {
1699                 current = g_utf8_next_char (current);
1700                 has_error = TRUE;
1701                 for (; *current != '\0'; current = g_utf8_next_char (current)) {
1702                         if (*current == '\\') {
1703                                 /* TODO: This causes a warning, which breaks the build, 
1704                                  * because a gchar cannot be < 0.
1705                                  * murrayc. 
1706                                 if (current[1] <0) {
1707                                         has_error = TRUE;
1708                                         break;
1709                                 }
1710                                 */
1711                         } else if (*current == '\"') {
1712                                 has_error = FALSE;
1713                                 current = g_utf8_next_char (current);
1714                                 break;
1715                         }
1716                 }
1717         } else {
1718                 has_error = TRUE;
1719                 for (current = stripped ; *current != '\0'; current = g_utf8_next_char (current)) {
1720                         if (*current == '<') {
1721                                 has_error = FALSE;
1722                                 break;
1723                         }
1724                 }
1725         }
1726                 
1727         if (has_error) {
1728                 g_free (stripped);
1729                 return FALSE;
1730         }
1731
1732         right_part = g_strdup (current);
1733         g_free (stripped);
1734         right_part = g_strstrip (right_part);
1735
1736         if (g_str_has_prefix (right_part, "<") &&
1737             g_str_has_suffix (right_part, ">")) {
1738                 gchar *address;
1739                 gboolean valid;
1740
1741                 address = g_strndup (right_part+1, strlen (right_part) - 2);
1742                 g_free (right_part);
1743                 valid = modest_text_utils_validate_email_address (address, invalid_char_position);
1744                 g_free (address);
1745                 return valid;
1746         } else {
1747                 g_free (right_part);
1748                 return FALSE;
1749         }
1750 }
1751
1752
1753 gchar *
1754 modest_text_utils_get_display_size (guint64 size)
1755 {
1756         const guint KB=1024;
1757         const guint MB=1024 * KB;
1758         const guint GB=1024 * MB;
1759
1760         if (size == 0)
1761                 return g_strdup_printf (_FM("sfil_li_size_kb"), (int) 0);
1762         if (0 <= size && size < KB)
1763                 return g_strdup_printf (_FM("sfil_li_size_1kb_99kb"), (int) 1);
1764         else if (KB <= size && size < 100 * KB)
1765                 return g_strdup_printf (_FM("sfil_li_size_1kb_99kb"), (int) size / KB);
1766         else if (100*KB <= size && size < MB)
1767                 return g_strdup_printf (_FM("sfil_li_size_100kb_1mb"), (int) size / KB);
1768         else if (MB <= size && size < 10*MB)
1769                 return g_strdup_printf (_FM("sfil_li_size_1mb_10mb"), (float) size / MB);
1770         else if (10*MB <= size && size < GB)
1771                 return g_strdup_printf (_FM("sfil_li_size_10mb_1gb"), (float) size / MB);
1772         else
1773                 return g_strdup_printf (_FM("sfil_li_size_1gb_or_greater"), (float) size / GB);
1774 }
1775
1776 static gchar *
1777 get_email_from_address (const gchar * address)
1778 {
1779         gchar *left_limit, *right_limit;
1780
1781         left_limit = strstr (address, "<");
1782         right_limit = g_strrstr (address, ">");
1783
1784         if ((left_limit == NULL)||(right_limit == NULL)|| (left_limit > right_limit))
1785                 return g_strdup (address);
1786         else
1787                 return g_strndup (left_limit + 1, (right_limit - left_limit) - 1);
1788 }
1789
1790 gchar *
1791 modest_text_utils_get_color_string (GdkColor *color)
1792 {
1793         g_return_val_if_fail (color, NULL);
1794
1795         return g_strdup_printf ("#%x%x%x%x%x%x%x%x%x%x%x%x",
1796                                 (color->red >> 12)   & 0xf, (color->red >> 8)   & 0xf,
1797                                 (color->red >>  4)   & 0xf, (color->red)        & 0xf,
1798                                 (color->green >> 12) & 0xf, (color->green >> 8) & 0xf,
1799                                 (color->green >>  4) & 0xf, (color->green)      & 0xf,
1800                                 (color->blue >> 12)  & 0xf, (color->blue >> 8)  & 0xf,
1801                                 (color->blue >>  4)  & 0xf, (color->blue)       & 0xf);
1802 }
1803
1804 gchar *
1805 modest_text_utils_text_buffer_get_text (GtkTextBuffer *buffer)
1806 {
1807         GtkTextIter start, end;
1808         gchar *slice, *current;
1809         GString *result = g_string_new ("");
1810
1811         g_return_val_if_fail (buffer && GTK_IS_TEXT_BUFFER (buffer), NULL);
1812         
1813         gtk_text_buffer_get_start_iter (buffer, &start);
1814         gtk_text_buffer_get_end_iter (buffer, &end);
1815
1816         slice = gtk_text_buffer_get_slice (buffer, &start, &end, FALSE);
1817         current = slice;
1818
1819         while (current && current != '\0') {
1820                 if (g_utf8_get_char (current) == 0xFFFC) {
1821                         result = g_string_append_c (result, ' ');
1822                         current = g_utf8_next_char (current);
1823                 } else {
1824                         gchar *next = g_utf8_strchr (current, -1, 0xFFFC);
1825                         if (next == NULL) {
1826                                 result = g_string_append (result, current);
1827                         } else {
1828                                 result = g_string_append_len (result, current, next - current);
1829                         }
1830                         current = next;
1831                 }
1832         }
1833         g_free (slice);
1834
1835         return g_string_free (result, FALSE);
1836         
1837 }
1838
1839 gboolean
1840 modest_text_utils_is_forbidden_char (const gchar character,
1841                                      ModestTextUtilsForbiddenCharType type)
1842 {
1843         gint i, len;
1844         const gchar *forbidden_chars = NULL;
1845         
1846         /* We need to get the length in the switch because the
1847            compiler needs to know the size at compile time */
1848         switch (type) {
1849         case ACCOUNT_TITLE_FORBIDDEN_CHARS:
1850                 forbidden_chars = account_title_forbidden_chars;
1851                 len = G_N_ELEMENTS (account_title_forbidden_chars);
1852                 break;
1853         case FOLDER_NAME_FORBIDDEN_CHARS:
1854                 forbidden_chars = folder_name_forbidden_chars;
1855                 len = G_N_ELEMENTS (folder_name_forbidden_chars);
1856                 break;
1857         case USER_NAME_FORBIDDEN_NAMES:
1858                 forbidden_chars = user_name_forbidden_chars;
1859                 len = G_N_ELEMENTS (user_name_forbidden_chars);
1860                 break;
1861         default:
1862                 g_return_val_if_reached (TRUE);
1863         }
1864
1865         for (i = 0; i < len ; i++)
1866                 if (forbidden_chars[i] == character)
1867                         return TRUE;
1868
1869         return FALSE; /* it's valid! */
1870 }
1871
1872 gchar *      
1873 modest_text_utils_label_get_selection (GtkLabel *label)
1874 {
1875         gint start, end;
1876         gchar *selection;
1877
1878         if (gtk_label_get_selection_bounds (GTK_LABEL (label), &start, &end)) {
1879                 const gchar *start_offset;
1880                 const gchar *end_offset;
1881                 start_offset = gtk_label_get_text (GTK_LABEL (label));
1882                 start_offset = g_utf8_offset_to_pointer (start_offset, start);
1883                 end_offset = gtk_label_get_text (GTK_LABEL (label));
1884                 end_offset = g_utf8_offset_to_pointer (end_offset, end);
1885                 selection = g_strndup (start_offset, end_offset - start_offset);
1886                 return selection;
1887         } else {
1888                 return g_strdup ("");
1889         }
1890 }
1891
1892 static gboolean
1893 _forward_search_image_char (gunichar ch,
1894                             gpointer userdata)
1895 {
1896         return (ch == 0xFFFC);
1897 }
1898
1899 gboolean
1900 modest_text_utils_buffer_selection_is_valid (GtkTextBuffer *buffer)
1901 {
1902         gboolean result;
1903         GtkTextIter start, end;
1904
1905         g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), FALSE);
1906
1907         result = gtk_text_buffer_get_has_selection (GTK_TEXT_BUFFER (buffer));
1908
1909         /* check there are no images in selection */
1910         if (result) {
1911                 gtk_text_buffer_get_selection_bounds (buffer, &start, &end);
1912                 if (gtk_text_iter_get_char (&start)== 0xFFFC)
1913                         result = FALSE;
1914                 else {
1915                         gtk_text_iter_backward_char (&end);
1916                         if (gtk_text_iter_forward_find_char (&start, _forward_search_image_char,
1917                                                              NULL, &end))
1918                                 result = FALSE;
1919                 }
1920                                     
1921         }
1922
1923         return result;
1924 }
1925
1926 static void
1927 remove_quotes (gchar **quotes)
1928 {
1929         if (g_str_has_prefix (*quotes, "\"") && g_str_has_suffix (*quotes, "\"")) {
1930                 gchar *result;
1931                 result = g_strndup ((*quotes)+1, strlen (*quotes) - 2);
1932                 g_free (*quotes);
1933                 *quotes = result;
1934         }
1935 }
1936
1937 gchar *
1938 modest_text_utils_escape_mnemonics (const gchar *text)
1939 {
1940         const gchar *p;
1941         GString *result = NULL;
1942
1943         if (text == NULL)
1944                 return NULL;
1945
1946         result = g_string_new ("");
1947         for (p = text; *p != '\0'; p++) {
1948                 if (*p == '_')
1949                         result = g_string_append (result, "__");
1950                 else
1951                         result = g_string_append_c (result, *p);
1952         }
1953         
1954         return g_string_free (result, FALSE);
1955 }
1956
1957 gchar *
1958 modest_text_utils_simplify_recipients (const gchar *recipients)
1959 {
1960         GSList *addresses, *node;
1961         GString *result;
1962         gboolean is_first = TRUE;
1963
1964         if (recipients == NULL)
1965                 return g_strdup ("");
1966
1967         addresses = modest_text_utils_split_addresses_list (recipients);
1968         result = g_string_new ("");
1969
1970         for (node = addresses; node != NULL; node = g_slist_next (node)) {
1971                 const gchar *address = (const gchar *) node->data;
1972                 gchar *left_limit, *right_limit;
1973
1974                 left_limit = strstr (address, "<");
1975                 right_limit = g_strrstr (address, ">");
1976
1977                 if (is_first)
1978                         is_first = FALSE;
1979                 else
1980                         result = g_string_append (result, ", ");
1981
1982                 if ((left_limit == NULL)||(right_limit == NULL)|| (left_limit > right_limit)) {
1983                         result = g_string_append (result, address);
1984                 } else {
1985                         gchar *name_side;
1986                         gchar *email_side;
1987                         name_side = g_strndup (address, left_limit - address);
1988                         name_side = g_strstrip (name_side);
1989                         remove_quotes (&name_side);
1990                         email_side = get_email_from_address (address);
1991                         if (name_side && email_side && !strcmp (name_side, email_side)) {
1992                                 result = g_string_append (result, email_side);
1993                         } else {
1994                                 result = g_string_append (result, address);
1995                         }
1996                         g_free (name_side);
1997                         g_free (email_side);
1998                 }
1999
2000         }
2001         g_slist_foreach (addresses, (GFunc)g_free, NULL);
2002         g_slist_free (addresses);
2003
2004         return g_string_free (result, FALSE);
2005
2006 }
2007
2008 GSList *
2009 modest_text_utils_remove_duplicate_addresses_list (GSList *address_list)
2010 {
2011         GSList *new_list, *iter;
2012         GHashTable *table;
2013
2014         g_return_val_if_fail (address_list, NULL);
2015
2016         table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
2017
2018         new_list = address_list;
2019         iter = address_list;
2020         while (iter) {
2021                 const gchar* address = (const gchar*)iter->data;
2022
2023                 /* We need only the email to just compare it and not
2024                    the full address which would make "a <a@a.com>"
2025                    different from "a@a.com" */
2026                 const gchar *email = get_email_from_address (address);
2027
2028                 /* ignore the address if already seen */
2029                 if (g_hash_table_lookup (table, email) == 0) {
2030                         g_hash_table_insert (table, (gchar*)email, GINT_TO_POINTER(1));
2031                         iter = g_slist_next (iter);
2032                 } else {
2033                         GSList *tmp = g_slist_next (iter);
2034                         new_list = g_slist_delete_link (new_list, iter);
2035                         iter = tmp;
2036                 }
2037         }
2038
2039         g_hash_table_unref (table);
2040
2041         return new_list;
2042 }
2043
2044 gchar *
2045 modest_text_utils_get_secure_header (const gchar *value,
2046                                      const gchar *header)
2047 {
2048         const gint max_len = 128;
2049         gchar *new_value = NULL;
2050         gchar *needle = g_strrstr (value, header);
2051
2052         if (needle && value != needle)
2053                 new_value = g_strdup (needle + strlen (header));
2054
2055         if (!new_value)
2056                 new_value = g_strdup (value);
2057
2058         /* Do a max length check to prevent DoS attacks caused by huge
2059            malformed headers */
2060         if (g_utf8_validate (new_value, -1, NULL)) {
2061                 if (g_utf8_strlen (new_value, -1) > max_len) {
2062                         gchar *tmp = g_malloc0 (max_len * 4);
2063                         g_utf8_strncpy (tmp, (const gchar *) new_value, max_len);
2064                         g_free (new_value);
2065                         new_value = tmp;
2066                 }
2067         } else {
2068                 if (strlen (new_value) > max_len) {
2069                         gchar *tmp = g_malloc0 (max_len);
2070                         strncpy (new_value, tmp, max_len);
2071                         g_free (new_value);
2072                         new_value = tmp;
2073                 }
2074         }
2075
2076         return new_value;
2077 }