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