6b3ea71d1aacddf8af7934db2f56345ee57f0efd
[modest] / src / widgets / modest-attachment-view.c
1 /* Copyright (c) 2007, 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 #ifdef HAVE_CONFIG_H
31 #include <config.h>
32 #endif /*HAVE_CONFIG_H*/
33
34 #include <glib/gi18n.h>
35
36 #include <string.h>
37 #include <modest-attachment-view.h>
38 #include <modest-platform.h>
39 #include <modest-text-utils.h>
40 #include <modest-tny-mime-part.h>
41 #include <tny-msg.h>
42 #include <modest-mail-operation.h>
43 #include <modest-mail-operation-queue.h>
44 #include <modest-runtime.h>
45 #include <modest-count-stream.h>
46
47 #define GET_SIZE_BUFFER_SIZE 128
48
49 static GObjectClass *parent_class = NULL;
50
51 typedef struct _ModestAttachmentViewPrivate ModestAttachmentViewPrivate;
52
53 struct _ModestAttachmentViewPrivate
54 {
55         TnyMimePart *mime_part;
56
57         GtkWidget *icon;
58         GtkWidget *filename_view;
59         GtkWidget *size_view;
60
61         gboolean detect_size;
62         TnyStream *get_size_stream;
63         guint64 size;
64
65         PangoLayout *layout_full_filename;
66         gboolean is_purged;
67
68 };
69
70 #ifdef MODEST_TOOLKIT_HILDON2
71 #define UNKNOWN_FILE_ICON "filemanager_unknown_file"
72 #else
73 #define UNKNOWN_FILE_ICON "qgn_list_gene_unknown_file"
74 #endif
75
76 #define MODEST_ATTACHMENT_VIEW_GET_PRIVATE(o)   \
77         (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_ATTACHMENT_VIEW, ModestAttachmentViewPrivate))
78
79 /* TnyMimePartView functions */
80 static TnyMimePart *modest_attachment_view_get_part (TnyMimePartView *self);
81 static TnyMimePart *modest_attachment_view_get_part_default (TnyMimePartView *self);
82 static void modest_attachment_view_set_part (TnyMimePartView *self, TnyMimePart *mime_part);
83 static void modest_attachment_view_set_part_default (TnyMimePartView *self, TnyMimePart *mime_part);
84 static void modest_attachment_view_clear (TnyMimePartView *self);
85 static void modest_attachment_view_clear_default (TnyMimePartView *self);
86
87 /* Gtk events */
88 static void size_allocate (GtkWidget *widget, GtkAllocation *allocation);
89
90 /* GObject and GInterface management */
91 static void modest_attachment_view_instance_init (GTypeInstance *instance, gpointer g_class);
92 static void modest_attachment_view_finalize (GObject *object);
93 static void modest_attachment_view_class_init (ModestAttachmentViewClass *klass);
94 static void tny_mime_part_view_init (gpointer g, gpointer iface_data);
95
96
97
98 static void update_filename_request (ModestAttachmentView *self);
99
100 static void update_size_label (ModestAttachmentView *self)
101 {
102         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
103         gchar *size_str;
104         gchar *label_text;
105
106         size_str = modest_text_utils_get_display_size (priv->size);
107         label_text = g_strdup_printf (" (%s)", size_str);
108         g_free (size_str);
109         gtk_label_set_text (GTK_LABEL (priv->size_view), label_text);
110         g_free (label_text);
111 }
112
113 static gboolean
114 idle_get_mime_part_size_cb (gpointer userdata)
115 {
116         ModestAttachmentView *view = (ModestAttachmentView *) userdata;
117         gdk_threads_enter ();
118
119         if (GTK_WIDGET_VISIBLE (view)) {
120                 update_size_label (view);
121         }
122
123         gdk_threads_leave ();
124
125         g_object_unref (view);
126
127         return FALSE;
128 }
129
130 static gpointer
131 get_mime_part_size_thread (gpointer thr_user_data)
132 {
133         ModestAttachmentView *view =  (ModestAttachmentView *) thr_user_data;
134         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (view);
135         gsize total = 0;
136         gssize result = 0;
137
138         result = tny_mime_part_decode_to_stream (priv->mime_part, priv->get_size_stream, NULL);
139         total = modest_count_stream_get_count(MODEST_COUNT_STREAM (priv->get_size_stream));
140         if (total == 0) {
141                 modest_count_stream_reset_count(MODEST_COUNT_STREAM (priv->get_size_stream));
142                 result = tny_mime_part_write_to_stream (priv->mime_part, priv->get_size_stream, NULL);
143                 total = modest_count_stream_get_count(MODEST_COUNT_STREAM (priv->get_size_stream));
144         }
145         
146         /* if there was an error, don't set the size (this is pretty uncommon) */
147         if (result < 0) {
148                 g_warning ("%s: error while writing mime part to stream\n", __FUNCTION__);
149         } else {
150                 priv->size = (guint64)total;
151                 g_idle_add (idle_get_mime_part_size_cb, g_object_ref (view));
152         }
153         g_object_unref (view);
154
155         return NULL;
156 }
157
158 void
159 modest_attachment_view_set_detect_size (ModestAttachmentView *self, gboolean detect_size)
160 {
161         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
162
163         priv->detect_size = detect_size;
164         
165 }
166
167 void
168 modest_attachment_view_set_size (ModestAttachmentView *self, guint64 size)
169 {
170         ModestAttachmentViewPrivate *priv;
171
172         g_return_if_fail (MODEST_IS_ATTACHMENT_VIEW (self));
173         priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
174
175         if (!priv->detect_size) {
176                 priv->size = size;
177                 update_size_label (self);
178         } else {
179                 g_assert ("Shouldn't set the size of the attachment view if detect size is enabled");
180         }
181 }
182
183 guint64
184 modest_attachment_view_get_size (ModestAttachmentView *self)
185 {
186         ModestAttachmentViewPrivate *priv;
187
188         g_return_val_if_fail (MODEST_IS_ATTACHMENT_VIEW (self), 0);
189         priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
190
191         return priv->size;
192 }
193
194 static TnyMimePart *
195 modest_attachment_view_get_part (TnyMimePartView *self)
196 {
197         return MODEST_ATTACHMENT_VIEW_GET_CLASS (self)->get_part_func (self);
198 }
199
200 static TnyMimePart *
201 modest_attachment_view_get_part_default (TnyMimePartView *self)
202 {
203         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
204
205         if (priv->mime_part)
206                 return TNY_MIME_PART (g_object_ref (priv->mime_part));
207         else
208                 return NULL;
209 }
210
211 static void
212 update_filename_request (ModestAttachmentView *self)
213 {
214         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
215         /* gint width, height; */
216         
217         pango_layout_set_text (PANGO_LAYOUT (priv->layout_full_filename), 
218                                gtk_label_get_text (GTK_LABEL (priv->filename_view)), -1);
219
220
221 }
222
223 static void
224 modest_attachment_view_set_part (TnyMimePartView *self, TnyMimePart *mime_part)
225 {
226         MODEST_ATTACHMENT_VIEW_GET_CLASS (self)->set_part_func (self, mime_part);
227         return;
228 }
229
230
231 static void
232 modest_attachment_view_set_part_default (TnyMimePartView *self, TnyMimePart *mime_part)
233 {
234         ModestAttachmentViewPrivate *priv = NULL;
235         gchar *filename = NULL;
236         gchar *file_icon_name = NULL;
237         gboolean show_size = FALSE;
238         
239         g_return_if_fail (TNY_IS_MIME_PART_VIEW (self));
240         g_return_if_fail (TNY_IS_MIME_PART (mime_part));
241         priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
242
243         if (priv->mime_part != NULL) {
244                 g_object_unref (priv->mime_part);
245         }
246
247         priv->mime_part = g_object_ref (mime_part);
248
249         priv->size = 0;
250         priv->is_purged = tny_mime_part_is_purged (mime_part);
251
252         if (TNY_IS_MSG (mime_part)) {
253                 TnyHeader *header = tny_msg_get_header (TNY_MSG (mime_part));
254                 if (TNY_IS_HEADER (header)) {
255                         filename = g_strdup (tny_mime_part_get_filename (mime_part));
256                         if (!filename)
257                                 filename = tny_header_dup_subject (header);
258                         if (filename == NULL || filename[0] == '\0')
259                                 filename = g_strdup (_("mail_va_no_subject"));
260                         if (priv->is_purged) {
261                                 file_icon_name = modest_platform_get_file_icon_name (NULL, NULL, NULL);
262                         } else {
263                                 gchar *header_content_type;
264                                 header_content_type = modest_tny_mime_part_get_content_type (mime_part);
265                                 if ((g_str_has_prefix (header_content_type, "message/rfc822") ||
266                                      g_str_has_prefix (header_content_type, "multipart/") ||
267                                      g_str_has_prefix (header_content_type, "text/"))) {
268                                         file_icon_name = 
269                                                 modest_platform_get_file_icon_name (
270                                                         NULL, tny_mime_part_get_content_type (mime_part), NULL);
271                                 } else {
272                                         file_icon_name = 
273                                                 modest_platform_get_file_icon_name (
274                                                         NULL, header_content_type, NULL);
275                                 }
276                                 g_free (header_content_type);
277                         }
278                         g_object_unref (header);
279                 }
280         } else {
281                 filename = g_strdup (tny_mime_part_get_filename (mime_part));
282                 if (priv->is_purged) {
283                         file_icon_name = modest_platform_get_file_icon_name (NULL, NULL, NULL);
284                 } else {
285                         file_icon_name = modest_platform_get_file_icon_name (
286                                 filename, modest_tny_mime_part_get_content_type (mime_part), NULL);
287                         show_size = TRUE;
288                 }
289         }
290
291         if (file_icon_name) {
292                 gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), file_icon_name, GTK_ICON_SIZE_MENU);
293                 g_free (file_icon_name);
294         } else {
295                 gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), UNKNOWN_FILE_ICON, GTK_ICON_SIZE_MENU);
296         }
297
298         if (priv->is_purged) {
299                 gchar * label_str = g_markup_printf_escaped(
300                         "<span style='italic' foreground='grey'>%s</span>",
301                         filename);
302                 gtk_label_set_markup (GTK_LABEL (priv->filename_view), label_str);
303                 g_free (label_str);
304         } else {
305                 gtk_label_set_text (GTK_LABEL (priv->filename_view), filename);
306         }
307         g_free (filename);
308         update_filename_request (MODEST_ATTACHMENT_VIEW (self));
309
310         gtk_label_set_text (GTK_LABEL (priv->size_view), "");
311
312         if (show_size && priv->detect_size) {
313                 g_object_ref (self);
314                 if (!priv->get_size_stream)
315                         priv->get_size_stream = modest_count_stream_new ();
316                 g_thread_create (get_mime_part_size_thread, self, FALSE, NULL);
317         }
318
319         gtk_widget_queue_draw (GTK_WIDGET (self));
320 }
321
322 static void
323 modest_attachment_view_clear (TnyMimePartView *self)
324 {
325         MODEST_ATTACHMENT_VIEW_GET_CLASS (self)->clear_func (self);
326         return;
327 }
328
329 static void
330 modest_attachment_view_clear_default (TnyMimePartView *self)
331 {
332         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
333
334         if (priv->mime_part != NULL) {
335                 g_object_unref (priv->mime_part);
336                 priv->mime_part = NULL;
337         }
338
339         if (priv->get_size_stream)
340                 modest_count_stream_reset_count(MODEST_COUNT_STREAM (priv->get_size_stream));
341
342         priv->size = 0;
343
344         gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), 
345                                       UNKNOWN_FILE_ICON,
346                                       GTK_ICON_SIZE_MENU);
347         gtk_label_set_text (GTK_LABEL (priv->filename_view), "");
348         update_filename_request (MODEST_ATTACHMENT_VIEW(self));
349         gtk_label_set_text (GTK_LABEL (priv->size_view), " ");
350
351         gtk_widget_queue_draw (GTK_WIDGET (self));
352 }
353
354
355 /**
356  * modest_attachment_view_new:
357  * @mime_part: a #TnyMimePart
358  *
359  * Constructor for attachment view widget.
360  *
361  * Return value: a new #ModestAttachmentView instance implemented for Gtk+
362  **/
363 GtkWidget*
364 modest_attachment_view_new (TnyMimePart *mime_part, gboolean detect_size)
365 {
366         ModestAttachmentView *self = g_object_new (MODEST_TYPE_ATTACHMENT_VIEW, 
367                                                    NULL);
368
369         modest_attachment_view_set_detect_size (self, detect_size);
370
371         modest_attachment_view_set_part (TNY_MIME_PART_VIEW (self), mime_part);
372
373         return GTK_WIDGET (self);
374 }
375
376 static void
377 modest_attachment_view_instance_init (GTypeInstance *instance, gpointer g_class)
378 {
379         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (instance);
380         PangoContext *context;
381         GtkWidget *box = NULL;
382
383         priv->mime_part = NULL;
384         priv->icon = gtk_image_new ();
385         priv->filename_view = gtk_label_new ("");
386         gtk_label_set_line_wrap (GTK_LABEL (priv->filename_view), FALSE);
387         gtk_label_set_ellipsize (GTK_LABEL (priv->filename_view), PANGO_ELLIPSIZE_END);
388         gtk_label_set_single_line_mode (GTK_LABEL (priv->filename_view), TRUE);
389         gtk_label_set_selectable (GTK_LABEL (priv->filename_view), FALSE);
390         priv->size_view = gtk_label_new (" ");
391         gtk_label_set_line_wrap (GTK_LABEL (priv->size_view), FALSE);
392         gtk_label_set_selectable (GTK_LABEL (priv->size_view), FALSE);
393         gtk_misc_set_alignment (GTK_MISC (priv->size_view), 0.0, 0.5);
394         gtk_misc_set_alignment (GTK_MISC (priv->filename_view), 0.0, 0.5);
395
396         priv->get_size_stream = NULL;
397         priv->size = 0;
398         priv->detect_size = TRUE;
399
400         box = gtk_hbox_new (FALSE, 0);
401         gtk_box_pack_start (GTK_BOX (box), priv->icon, FALSE, FALSE, 0);
402         gtk_box_pack_start (GTK_BOX (box), priv->filename_view, TRUE, TRUE, 0);
403         gtk_box_pack_start (GTK_BOX (box), priv->size_view, FALSE, FALSE, 0);
404         gtk_container_add (GTK_CONTAINER (instance), box);
405
406 /*      gtk_widget_get_style */
407 /*      gtk_widget_modify_bg (instance, GTK_STATE_SELECTED, selection_color); */
408
409         context = gtk_widget_get_pango_context (priv->filename_view);
410         priv->layout_full_filename = pango_layout_new (context);
411         
412         pango_layout_set_ellipsize (priv->layout_full_filename, PANGO_ELLIPSIZE_NONE);
413
414         gtk_event_box_set_above_child (GTK_EVENT_BOX (instance), FALSE);
415         gtk_event_box_set_visible_window (GTK_EVENT_BOX (instance), TRUE);
416         gtk_widget_set_events (GTK_WIDGET (instance), 0);
417
418         GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (instance), GTK_CAN_FOCUS);
419
420         return;
421 }
422
423 static void
424 modest_attachment_view_finalize (GObject *object)
425 {
426         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (object);
427
428         if (priv->get_size_stream != NULL) {
429                 g_object_unref (priv->get_size_stream);
430                 priv->get_size_stream = NULL;
431         }
432
433         if (G_LIKELY (priv->mime_part)) {
434                 g_object_unref (G_OBJECT (priv->mime_part));
435                 priv->mime_part = NULL;
436         }
437
438         (*parent_class->finalize) (object);
439
440         return;
441 }
442
443 static void
444 size_allocate (GtkWidget *widget, GtkAllocation *allocation)
445 {
446         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (widget);
447         gint width, width_diff;
448
449         GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
450         pango_layout_set_font_description (priv->layout_full_filename, pango_context_get_font_description(pango_layout_get_context (gtk_label_get_layout (GTK_LABEL (priv->filename_view)))));
451
452         pango_layout_get_pixel_size (priv->layout_full_filename, &width, NULL);
453         width_diff = priv->filename_view->allocation.width - width;
454         if (width_diff > 0) {
455                 GtkAllocation filename_alloc, filesize_alloc;
456                 filename_alloc = priv->filename_view->allocation;
457                 filesize_alloc = priv->size_view->allocation;
458                 filename_alloc.width -= width_diff;
459                 filesize_alloc.width += width_diff;
460                 filesize_alloc.x -= width_diff;
461                 gtk_widget_size_allocate (priv->filename_view, &filename_alloc);
462                 gtk_widget_size_allocate (priv->size_view, &filesize_alloc);
463         }
464         
465 }
466
467
468 static void 
469 modest_attachment_view_class_init (ModestAttachmentViewClass *klass)
470 {
471         GObjectClass *object_class;
472         GtkWidgetClass *widget_class;
473
474         parent_class = g_type_class_peek_parent (klass);
475         object_class = (GObjectClass*) klass;
476         widget_class = GTK_WIDGET_CLASS (klass);
477
478         object_class->finalize = modest_attachment_view_finalize;
479
480         klass->get_part_func = modest_attachment_view_get_part_default;
481         klass->set_part_func = modest_attachment_view_set_part_default;
482         klass->clear_func = modest_attachment_view_clear_default;
483
484         widget_class->size_allocate = size_allocate;
485
486         g_type_class_add_private (object_class, sizeof (ModestAttachmentViewPrivate));
487
488         return;
489 }
490
491 static void
492 tny_mime_part_view_init (gpointer g, gpointer iface_data)
493 {
494         TnyMimePartViewIface *klass = (TnyMimePartViewIface *)g;
495
496         klass->get_part = modest_attachment_view_get_part;
497         klass->set_part = modest_attachment_view_set_part;
498         klass->clear = modest_attachment_view_clear;
499
500         return;
501 }
502
503 GType 
504 modest_attachment_view_get_type (void)
505 {
506         static GType type = 0;
507
508         if (G_UNLIKELY(type == 0))
509         {
510                 static const GTypeInfo info = 
511                 {
512                   sizeof (ModestAttachmentViewClass),
513                   NULL,   /* base_init */
514                   NULL,   /* base_finalize */
515                   (GClassInitFunc) modest_attachment_view_class_init,   /* class_init */
516                   NULL,   /* class_finalize */
517                   NULL,   /* class_data */
518                   sizeof (ModestAttachmentView),
519                   0,      /* n_preallocs */
520                   modest_attachment_view_instance_init    /* instance_init */
521                 };
522
523                 static const GInterfaceInfo tny_mime_part_view_info =
524                 {
525                         (GInterfaceInitFunc) tny_mime_part_view_init, /* interface_init */
526                         NULL,        /* interface_finalize */
527                         NULL         /* interface_data */
528                 };
529
530                 type = g_type_register_static (GTK_TYPE_EVENT_BOX,
531                         "ModestAttachmentView",
532                         &info, 0);
533
534                 g_type_add_interface_static (type, TNY_TYPE_MIME_PART_VIEW,
535                                              &tny_mime_part_view_info);
536
537         }
538
539         return type;
540 }