1 /* modest-tny-msg-view.c */
3 /* insert (c)/licensing information) */
5 #include "modest-tny-msg-view.h"
6 #include "modest-tny-stream-gtkhtml.h"
7 #include "modest-tny-msg-actions.h"
9 #include <tny-text-buffer-stream.h>
13 #include <glib/gi18n.h>
14 #include <gtkhtml/gtkhtml.h>
15 #include <gtkhtml/gtkhtml-stream.h>
17 /* 'private'/'protected' functions */
18 static void modest_tny_msg_view_class_init (ModestTnyMsgViewClass *klass);
19 static void modest_tny_msg_view_init (ModestTnyMsgView *obj);
20 static void modest_tny_msg_view_finalize (GObject *obj);
23 static GSList* get_url_matches (GString *txt);
24 static gboolean fill_gtkhtml_with_txt (ModestTnyMsgView *self, GtkHTML* gtkhtml, const gchar* txt, TnyMsgIface *msg);
26 static gboolean on_link_clicked (GtkWidget *widget, const gchar *uri,
27 ModestTnyMsgView *msg_view);
28 static gboolean on_url_requested (GtkWidget *widget, const gchar *uri,
29 GtkHTMLStream *stream,
30 ModestTnyMsgView *msg_view);
31 static gchar *construct_virtual_filename(const gchar *filename, const gint position, const gchar *id, const gboolean active);
32 static gchar *construct_virtual_filename_from_mime_part(TnyMsgMimePartIface *msg, const gint position);
33 gint virtual_filename_get_pos(const gchar *filename);
35 * we need these regexps to find URLs in plain text e-mails
37 typedef struct _UrlMatchPattern UrlMatchPattern;
38 struct _UrlMatchPattern {
44 #define MAIL_VIEWER_URL_MATCH_PATTERNS {\
45 { "(file|http|ftp|https)://[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]+[-A-Za-z0-9_$%&=?/~#]",\
47 { "www\\.[-a-z0-9.]+[-a-z0-9](:[0-9]*)?(/[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]*[^]}\\),?!;:\"]?)?",\
49 { "ftp\\.[-a-z0-9.]+[-a-z0-9](:[0-9]*)?(/[-A-Za-z0-9_$.+!*(),;:@%&=?/~#]*[^]}\\),?!;:\"]?)?",\
51 { "(voipto|callto|chatto|jabberto|xmpp):[-_a-z@0-9.\\+]+", \
53 { "mailto:[-_a-z0-9.\\+]+@[-_a-z0-9.]+", \
55 { "[-_a-z0-9.\\+]+@[-_a-z0-9.]+",\
67 typedef struct _ModestTnyMsgViewPrivate ModestTnyMsgViewPrivate;
68 struct _ModestTnyMsgViewPrivate {
73 #define MODEST_TNY_MSG_VIEW_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
74 MODEST_TYPE_TNY_MSG_VIEW, \
75 ModestTnyMsgViewPrivate))
77 static GtkContainerClass *parent_class = NULL;
79 /* uncomment the following if you have defined any signals */
80 /* static guint signals[LAST_SIGNAL] = {0}; */
83 modest_tny_msg_view_get_type (void)
85 static GType my_type = 0;
87 static const GTypeInfo my_info = {
88 sizeof(ModestTnyMsgViewClass),
90 NULL, /* base finalize */
91 (GClassInitFunc) modest_tny_msg_view_class_init,
92 NULL, /* class finalize */
93 NULL, /* class data */
94 sizeof(ModestTnyMsgView),
96 (GInstanceInitFunc) modest_tny_msg_view_init,
98 my_type = g_type_register_static (GTK_TYPE_SCROLLED_WINDOW,
106 modest_tny_msg_view_class_init (ModestTnyMsgViewClass *klass)
108 GObjectClass *gobject_class;
109 gobject_class = (GObjectClass*) klass;
111 parent_class = g_type_class_peek_parent (klass);
112 gobject_class->finalize = modest_tny_msg_view_finalize;
114 g_type_class_add_private (gobject_class, sizeof(ModestTnyMsgViewPrivate));
118 modest_tny_msg_view_init (ModestTnyMsgView *obj)
120 ModestTnyMsgViewPrivate *priv;
122 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(obj);
126 priv->gtkhtml = gtk_html_new();
130 gtk_html_set_editable (GTK_HTML(priv->gtkhtml), FALSE);
131 gtk_html_allow_selection (GTK_HTML(priv->gtkhtml), TRUE);
132 gtk_html_set_caret_mode (GTK_HTML(priv->gtkhtml), FALSE);
133 gtk_html_set_blocking (GTK_HTML(priv->gtkhtml), FALSE);
134 gtk_html_set_images_blocking (GTK_HTML(priv->gtkhtml), FALSE);
136 g_signal_connect (G_OBJECT(priv->gtkhtml), "link_clicked",
137 G_CALLBACK(on_link_clicked), obj);
139 g_signal_connect (G_OBJECT(priv->gtkhtml), "url_requested",
140 G_CALLBACK(on_url_requested), obj);
145 modest_tny_msg_view_finalize (GObject *obj)
151 modest_tny_msg_view_new (TnyMsgIface *msg, ModestConf *conf)
154 ModestTnyMsgView* self;
155 ModestTnyMsgViewPrivate *priv;
157 obj = G_OBJECT(g_object_new(MODEST_TYPE_TNY_MSG_VIEW, NULL));
158 self = MODEST_TNY_MSG_VIEW(obj);
159 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE (self);
161 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(self),
162 GTK_POLICY_AUTOMATIC,
163 GTK_POLICY_AUTOMATIC);
166 gtk_container_add (GTK_CONTAINER(obj), priv->gtkhtml);
169 modest_tny_msg_view_set_message (self, msg);
173 return GTK_WIDGET(self);
179 on_link_clicked (GtkWidget *widget, const gchar *uri,
180 ModestTnyMsgView *msg_view)
182 ModestTnyMsgViewPrivate *priv;
185 if (g_str_has_prefix(uri, "attachment:")) {
186 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(msg_view);
187 /* toggle ...SHOW_ATTACHMENTS_INLINE */
188 modest_conf_set_bool(priv->conf,
189 MODEST_CONF_MSG_VIEW_SHOW_ATTACHMENTS_INLINE,
190 !modest_conf_get_bool(priv->conf,
191 MODEST_CONF_MSG_VIEW_SHOW_ATTACHMENTS_INLINE,
195 modest_tny_msg_view_set_message(msg_view, priv->msg);
198 g_message ("link clicked: %s", uri); /* FIXME */
205 static TnyMsgMimePartIface *
206 find_cid_image (TnyMsgIface *msg, const gchar *cid)
208 TnyMsgMimePartIface *part = NULL;
211 g_return_val_if_fail (msg, NULL);
212 g_return_val_if_fail (cid, NULL);
214 parts = (GList*) tny_msg_iface_get_parts (msg);
215 while (parts && !part) {
216 const gchar *part_cid;
217 part = TNY_MSG_MIME_PART_IFACE(parts->data);
218 part_cid = tny_msg_mime_part_iface_get_content_id (part);
219 printf("CMP:%s:%s\n", cid, part_cid);
220 if (part_cid && strcmp (cid, part_cid) == 0)
221 return part; /* we found it! */
231 static TnyMsgMimePartIface *
232 find_attachment_by_filename (TnyMsgIface *msg, const gchar *fn)
234 TnyMsgMimePartIface *part = NULL;
239 g_return_val_if_fail (msg, NULL);
240 g_return_val_if_fail (fn, NULL);
242 parts = (GList*) tny_msg_iface_get_parts (msg);
243 pos = virtual_filename_get_pos(fn);
245 g_return_val_if_fail(((pos >= 0) && (pos < g_list_length(parts))), NULL);
247 part = g_list_nth_data(parts, pos);
249 dummy = construct_virtual_filename_from_mime_part(part, pos);
250 if (strcmp(dummy, fn) == 0)
258 on_url_requested (GtkWidget *widget, const gchar *uri,
259 GtkHTMLStream *stream,
260 ModestTnyMsgView *msg_view)
263 ModestTnyMsgViewPrivate *priv;
264 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE (msg_view);
266 g_message ("url requested: %s", uri);
268 if (g_str_has_prefix (uri, "cid:")) {
269 /* +4 ==> skip "cid:" */
271 TnyMsgMimePartIface *part = find_cid_image (priv->msg, uri + 4);
273 g_message ("%s not found", uri + 4);
274 gtk_html_stream_close (stream, GTK_HTML_STREAM_ERROR);
276 TnyStreamIface *tny_stream =
277 TNY_STREAM_IFACE(modest_tny_stream_gtkhtml_new(stream));
278 tny_msg_mime_part_iface_decode_to_stream (part,tny_stream);
279 gtk_html_stream_close (stream, GTK_HTML_STREAM_OK);
281 } else if (g_str_has_prefix (uri, "Attachment:")) {
282 TnyMsgMimePartIface *part = find_attachment_by_filename (priv->msg, uri);
284 g_message ("%s not found", uri);
285 gtk_html_stream_close (stream, GTK_HTML_STREAM_ERROR);
287 TnyStreamIface *tny_stream =
288 TNY_STREAM_IFACE(modest_tny_stream_gtkhtml_new(stream));
289 tny_msg_mime_part_iface_decode_to_stream (part,tny_stream);
290 gtk_html_stream_close (stream, GTK_HTML_STREAM_OK);
308 construct_virtual_filename(const gchar *filename, const gint position, const gchar *id, const gboolean active)
311 g_return_val_if_fail((position >= 0), "AttachmentInvalid");
313 s = g_string_new("");
315 g_string_append(s, "Attachment:");
317 g_string_append(s, "attachment:");
318 g_string_append_printf(s, "%d:", position);
320 g_string_append(s, id);
321 g_string_append_c(s, ':');
323 g_string_append(s, filename);
324 g_string_append_c(s, ':');
325 return g_string_free(s, FALSE);
330 construct_virtual_filename_from_mime_part(TnyMsgMimePartIface *msg, const gint position)
332 const gchar *id, *filename;
333 const gboolean active = TRUE;
335 filename = tny_msg_mime_part_iface_get_filename(
336 TNY_MSG_MIME_PART_IFACE(msg));
338 filename = "[unknown]";
339 id = tny_msg_mime_part_iface_get_content_id(
340 TNY_MSG_MIME_PART_IFACE(msg));
342 return construct_virtual_filename(filename, position, id, active);
346 get_next_token(const gchar *s, gint *len)
363 /* maybe I should use libregexp */
365 virtual_filename_get_pos(const gchar *filename)
367 const gchar *i1, *i2;
375 i2 = get_next_token(i2, &len);
376 if (strncmp(i1, "Attachment", len) != 0)
381 i2 = get_next_token(i2, &len);
384 dummy = g_string_new_len(i1, len);
385 pos = atoi(dummy->str);
386 g_string_free(dummy, FALSE);
392 attachments_as_html(ModestTnyMsgView *self, TnyMsgIface *msg)
394 ModestTnyMsgViewPrivate *priv;
395 gboolean attachments_found = FALSE;
397 const GList *attachment_list, *attachment;
398 const gchar *content_type, *filename, *id;
399 gchar *virtual_filename;
400 gboolean show_attachments_inline;
405 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE (self);
407 /* CLEANUP: starting a new HTML may be unsupported */
408 appendix = g_string_new("<HTML><BODY>\n<hr><h5>Attachments:</h5>\n");
410 attachment_list = tny_msg_iface_get_parts(msg);
411 attachment = attachment_list;
414 content_type = tny_msg_mime_part_iface_get_content_type(
415 TNY_MSG_MIME_PART_IFACE(attachment->data));
416 g_return_val_if_fail(content_type, NULL);
417 if ( tny_msg_mime_part_iface_content_type_is(
418 TNY_MSG_MIME_PART_IFACE(attachment->data),
420 || tny_msg_mime_part_iface_content_type_is(
421 TNY_MSG_MIME_PART_IFACE(attachment->data),
423 filename = tny_msg_mime_part_iface_get_filename(
424 TNY_MSG_MIME_PART_IFACE(attachment->data));
426 filename = "[unknown]";
428 attachments_found = TRUE;
429 id = tny_msg_mime_part_iface_get_content_id(
430 TNY_MSG_MIME_PART_IFACE(attachment->data));
431 show_attachments_inline = modest_conf_get_bool(priv->conf, MODEST_CONF_MSG_VIEW_SHOW_ATTACHMENTS_INLINE, NULL);
432 virtual_filename = construct_virtual_filename(filename,
433 g_list_position((GList *)attachment_list, (GList *) attachment),
434 id, show_attachments_inline);
435 printf("VF:%s\n", virtual_filename);
436 if (show_attachments_inline) {
437 g_string_append_printf(appendix, "<IMG src=\"%s\">\n<BR><A href=\"attachment:%s\">%s</A>\n", virtual_filename, filename, filename);
439 g_string_append_printf(appendix, "<A href=\"attachment:%s\">%s</A>: %s<BR>\n", filename, filename, content_type);
442 attachment = attachment->next;
444 g_string_append(appendix, "</BODY></HTML>");
445 if (!attachments_found)
446 g_string_assign(appendix, "");
447 return g_string_free(appendix, FALSE);
451 hyperlinkify_plain_text (GString *txt)
454 GSList *match_list = get_url_matches (txt);
456 /* we will work backwards, so the offsets stay valid */
457 for (cursor = match_list; cursor; cursor = cursor->next) {
459 url_match_t *match = (url_match_t*) cursor->data;
460 gchar *url = g_strndup (txt->str + match->offset, match->len);
461 gchar *repl = NULL; /* replacement */
463 /* the prefix is NULL: use the one that is already there */
464 repl = g_strdup_printf ("<a href=\"%s%s\">%s</a>",
465 match->prefix ? match->prefix : "", url, url);
467 /* replace the old thing with our hyperlink
468 * replacement thing */
469 g_string_erase (txt, match->offset, match->len);
470 g_string_insert (txt, match->offset, repl);
475 g_free (cursor->data);
478 g_slist_free (match_list);
484 convert_to_html (const gchar *data)
487 gboolean first_space = TRUE;
495 html = g_string_sized_new (len + 100); /* just a guess... */
497 g_string_append_printf (html,
500 "<meta http-equiv=\"content-type\""
501 " content=\"text/html; charset=utf8\">"
505 /* replace with special html chars where needed*/
506 for (i = 0; i != len; ++i) {
510 case 0: break; /* ignore embedded \0s */
511 case '<' : g_string_append (html, "<"); break;
512 case '>' : g_string_append (html, ">"); break;
513 case '&' : g_string_append (html, """); break;
514 case '\n': g_string_append (html, "<br>\n"); break;
517 g_string_append (html, first_space ? " " : " ");
519 } else if (kar == '\t')
520 g_string_append (html, " ");
524 /* optimization trick: accumulate 'normal' chars, then copy */
526 kar = data [++charnum + i];
528 } while ((i + charnum < len) &&
529 (kar > '>' || (kar != '<' && kar != '>'
530 && kar != '&' && kar != ' '
531 && kar != '\n' && kar != '\t')));
532 g_string_append_len (html, &data[i], charnum);
538 g_string_append (html, "</tt></body></html>");
539 hyperlinkify_plain_text (html);
541 return g_string_free (html, FALSE);
548 cmp_offsets_reverse (const url_match_t *match1, const url_match_t *match2)
550 return match2->offset - match1->offset;
556 * check if the match is inside an existing match... */
558 chk_partial_match (const url_match_t *match, int* offset)
560 if (*offset >= match->offset && *offset < match->offset + match->len)
565 get_url_matches (GString *txt)
568 int rv, i, offset = 0;
569 GSList *match_list = NULL;
571 static UrlMatchPattern patterns[] = MAIL_VIEWER_URL_MATCH_PATTERNS;
572 const size_t pattern_num = sizeof(patterns)/sizeof(UrlMatchPattern);
574 /* initalize the regexps */
575 for (i = 0; i != pattern_num; ++i) {
576 patterns[i].preg = g_new0 (regex_t,1);
577 g_assert(regcomp (patterns[i].preg, patterns[i].regex,
578 REG_ICASE|REG_EXTENDED|REG_NEWLINE) == 0);
580 /* find all the matches */
581 for (i = 0; i != pattern_num; ++i) {
585 if ((rv = regexec (patterns[i].preg, txt->str + offset, 1, &rm, 0)) != 0) {
586 g_assert (rv == REG_NOMATCH); /* this should not happen */
587 break; /* try next regexp */
592 /* FIXME: optimize this */
593 /* to avoid partial matches on something that was already found... */
594 /* check_partial_match will put -1 in the data ptr if that is the case */
595 test_offset = offset + rm.rm_so;
596 g_slist_foreach (match_list, (GFunc)chk_partial_match, &test_offset);
598 /* make a list of our matches (<offset, len, prefix> tupels)*/
599 if (test_offset != -1) {
600 url_match_t *match = g_new (url_match_t,1);
601 match->offset = offset + rm.rm_so;
602 match->len = rm.rm_eo - rm.rm_so;
603 match->prefix = patterns[i].prefix;
604 match_list = g_slist_prepend (match_list, match);
610 for (i = 0; i != pattern_num; ++i) {
611 regfree (patterns[i].preg);
612 g_free (patterns[i].preg);
613 } /* don't free patterns itself -- it's static */
615 /* now sort the list, so the matches are in reverse order of occurence.
616 * that way, we can do the replacements starting from the end, so we don't need
617 * to recalculate the offsets
619 match_list = g_slist_sort (match_list,
620 (GCompareFunc)cmp_offsets_reverse);
625 fill_gtkhtml_with_txt (ModestTnyMsgView *self, GtkHTML* gtkhtml, const gchar* txt, TnyMsgIface *msg)
628 gchar *html_attachments;
630 g_return_val_if_fail (gtkhtml, FALSE);
631 g_return_val_if_fail (txt, FALSE);
633 html = g_string_new(convert_to_html (txt));
634 html_attachments = attachments_as_html(self, msg);
635 g_string_append(html, html_attachments);
637 gtk_html_load_from_string (gtkhtml, html->str, html->len);
638 g_string_free (html, TRUE);
639 g_free(html_attachments);
647 set_html_message (ModestTnyMsgView *self, TnyMsgMimePartIface *tny_body, TnyMsgIface *msg)
649 gchar *html_attachments;
650 TnyStreamIface *gtkhtml_stream;
651 ModestTnyMsgViewPrivate *priv;
653 g_return_val_if_fail (self, FALSE);
654 g_return_val_if_fail (tny_body, FALSE);
656 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(self);
659 TNY_STREAM_IFACE(modest_tny_stream_gtkhtml_new
660 (gtk_html_begin(GTK_HTML(priv->gtkhtml))));
662 tny_stream_iface_reset (gtkhtml_stream);
663 tny_msg_mime_part_iface_decode_to_stream (tny_body, gtkhtml_stream);
664 html_attachments = attachments_as_html(self, msg);
666 gtkhtml_write(gtkhtml_stream, html_attachments, strlen(html_attachments));
667 tny_stream_iface_reset (gtkhtml_stream);
669 g_object_unref (G_OBJECT(gtkhtml_stream));
670 g_free (html_attachments);
676 /* this is a hack --> we use the tny_text_buffer_stream to
677 * get the message text, then write to gtkhtml 'by hand' */
679 set_text_message (ModestTnyMsgView *self, TnyMsgMimePartIface *tny_body, TnyMsgIface *msg)
682 GtkTextIter begin, end;
683 TnyStreamIface* txt_stream;
685 ModestTnyMsgViewPrivate *priv;
687 g_return_val_if_fail (self, FALSE);
688 g_return_val_if_fail (tny_body, FALSE);
690 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(self);
692 buf = gtk_text_buffer_new (NULL);
693 txt_stream = TNY_STREAM_IFACE(tny_text_buffer_stream_new (buf));
695 tny_stream_iface_reset (txt_stream);
696 tny_msg_mime_part_iface_decode_to_stream (tny_body, txt_stream);
697 tny_stream_iface_reset (txt_stream);
699 gtk_text_buffer_get_bounds (buf, &begin, &end);
700 txt = gtk_text_buffer_get_text (buf, &begin, &end, FALSE);
702 fill_gtkhtml_with_txt (self, GTK_HTML(priv->gtkhtml), txt, msg);
704 g_object_unref (G_OBJECT(txt_stream));
705 g_object_unref (G_OBJECT(buf));
712 modest_tny_msg_view_get_selected_text (ModestTnyMsgView *self)
714 ModestTnyMsgViewPrivate *priv;
720 g_return_val_if_fail (self, NULL);
721 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(self);
722 html = priv->gtkhtml;
724 /* I'm sure there is a better way to check for selected text */
725 sel = gtk_html_get_selection_html(GTK_HTML(html), &len);
731 clip = gtk_widget_get_clipboard(html, GDK_SELECTION_PRIMARY);
732 return gtk_clipboard_wait_for_text(clip);
736 modest_tny_msg_view_set_message (ModestTnyMsgView *self, TnyMsgIface *msg)
738 TnyMsgMimePartIface *body;
739 ModestTnyMsgViewPrivate *priv;
741 g_return_if_fail (self);
743 priv = MODEST_TNY_MSG_VIEW_GET_PRIVATE(self);
747 fill_gtkhtml_with_txt (self, GTK_HTML(priv->gtkhtml), "", msg);
752 body = modest_tny_msg_actions_find_body_part (msg, "text/html");
754 set_html_message (self, body, msg);
758 body = modest_tny_msg_actions_find_body_part (msg, "text/plain");
760 set_text_message (self, body, msg);
765 fill_gtkhtml_with_txt (self, GTK_HTML(priv->gtkhtml),
766 _("Unsupported message type"), msg);