b36e7fcd8487da7af6c00d1b58ad4ac9123fe80a
[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 <tny-msg.h>
41 #include <tny-camel-mem-stream.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 #define UNKNOWN_FILE_ICON "qgn_list_gene_unknown_file"
71
72 #define MODEST_ATTACHMENT_VIEW_GET_PRIVATE(o)   \
73         (G_TYPE_INSTANCE_GET_PRIVATE ((o), MODEST_TYPE_ATTACHMENT_VIEW, ModestAttachmentViewPrivate))
74
75 /* TnyMimePartView functions */
76 static TnyMimePart *modest_attachment_view_get_part (TnyMimePartView *self);
77 static TnyMimePart *modest_attachment_view_get_part_default (TnyMimePartView *self);
78 static void modest_attachment_view_set_part (TnyMimePartView *self, TnyMimePart *mime_part);
79 static void modest_attachment_view_set_part_default (TnyMimePartView *self, TnyMimePart *mime_part);
80 static void modest_attachment_view_clear (TnyMimePartView *self);
81 static void modest_attachment_view_clear_default (TnyMimePartView *self);
82
83 /* Gtk events */
84 static void size_allocate (GtkWidget *widget, GtkAllocation *allocation);
85
86 /* GObject and GInterface management */
87 static void modest_attachment_view_instance_init (GTypeInstance *instance, gpointer g_class);
88 static void modest_attachment_view_finalize (GObject *object);
89 static void modest_attachment_view_class_init (ModestAttachmentViewClass *klass);
90 static void tny_mime_part_view_init (gpointer g, gpointer iface_data);
91
92
93
94 static void update_filename_request (ModestAttachmentView *self);
95
96 static void update_size_label (ModestAttachmentView *self)
97 {
98         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
99         gchar *size_str;
100         gchar *label_text;
101
102         size_str = modest_text_utils_get_display_size (priv->size);
103         label_text = g_strdup_printf (" (%s)", size_str);
104         g_free (size_str);
105         gtk_label_set_text (GTK_LABEL (priv->size_view), label_text);
106         g_free (label_text);
107 }
108
109 static gboolean
110 idle_get_mime_part_size_cb (gpointer userdata)
111 {
112         ModestAttachmentView *view = (ModestAttachmentView *) userdata;
113         gdk_threads_enter ();
114
115         if (GTK_WIDGET_VISIBLE (view)) {
116                 update_size_label (view);
117         }
118
119         gdk_threads_leave ();
120
121         g_object_unref (view);
122
123         return FALSE;
124 }
125
126 static gpointer
127 get_mime_part_size_thread (gpointer thr_user_data)
128 {
129         ModestAttachmentView *view =  (ModestAttachmentView *) thr_user_data;
130         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (view);
131         TnyStream *stream;
132         gsize total = 0;
133         gssize result = 0;
134
135         stream = modest_count_stream_new();
136         result = tny_mime_part_decode_to_stream (priv->mime_part, stream, NULL);
137         total = modest_count_stream_get_count(MODEST_COUNT_STREAM (stream));
138         if (total == 0) {
139                 modest_count_stream_reset_count(MODEST_COUNT_STREAM (stream));
140                 result = tny_mime_part_write_to_stream (priv->mime_part, stream, NULL);
141                 total = modest_count_stream_get_count(MODEST_COUNT_STREAM (stream));
142         }
143         
144         /* if there was an error, don't set the size (this is pretty uncommon) */
145         if (result < 0) {
146                 g_warning ("%s: error while writing mime part to stream\n", __FUNCTION__);
147         } else {
148                 priv->size = (guint64)total;
149                 g_idle_add (idle_get_mime_part_size_cb, g_object_ref (view));
150         }
151
152         g_object_unref (stream);
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_header_get_subject (header));
256                         if (filename == NULL || filename[0] == '\0')
257                                 filename = g_strdup (_("mail_va_no_subject"));
258                         if (priv->is_purged)
259                                 file_icon_name = modest_platform_get_file_icon_name (NULL, NULL, NULL);
260                         else
261                                 file_icon_name = 
262                                         modest_platform_get_file_icon_name (
263                                                 NULL, tny_mime_part_get_content_type (mime_part), NULL);
264                         g_object_unref (header);
265                 }
266         } else {
267                 filename = g_strdup (tny_mime_part_get_filename (mime_part));
268                 if (priv->is_purged) {
269                         file_icon_name = modest_platform_get_file_icon_name (NULL, NULL, NULL);
270                 } else {
271                         file_icon_name = modest_platform_get_file_icon_name (
272                                 filename, tny_mime_part_get_content_type (mime_part), NULL);
273                         show_size = TRUE;
274                 }
275         }
276
277         if (file_icon_name) {
278                 gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), file_icon_name, GTK_ICON_SIZE_MENU);
279                 g_free (file_icon_name);
280         } else {
281                 gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), UNKNOWN_FILE_ICON, GTK_ICON_SIZE_MENU);
282         }
283
284         if (priv->is_purged) {
285                 gchar * label_str = g_markup_printf_escaped(
286                         "<span style='italic' foreground='grey'>%s</span>",
287                         filename);
288                 gtk_label_set_markup (GTK_LABEL (priv->filename_view), label_str);
289                 g_free (label_str);
290         } else {
291                 gtk_label_set_text (GTK_LABEL (priv->filename_view), filename);
292         }
293         g_free (filename);
294         update_filename_request (MODEST_ATTACHMENT_VIEW (self));
295
296         gtk_label_set_text (GTK_LABEL (priv->size_view), "");
297
298         if (show_size && priv->detect_size) {
299                 tny_camel_mem_stream_get_type ();
300                 g_object_ref (self);
301                 g_thread_create (get_mime_part_size_thread, self, FALSE, NULL);
302         }
303
304         gtk_widget_queue_draw (GTK_WIDGET (self));
305 }
306
307 static void
308 modest_attachment_view_clear (TnyMimePartView *self)
309 {
310         MODEST_ATTACHMENT_VIEW_GET_CLASS (self)->clear_func (self);
311         return;
312 }
313
314 static void
315 modest_attachment_view_clear_default (TnyMimePartView *self)
316 {
317         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (self);
318
319         if (priv->mime_part != NULL) {
320                 g_object_unref (priv->mime_part);
321                 priv->mime_part = NULL;
322         }
323
324         if (priv->get_size_stream != NULL) {
325                 g_object_unref (priv->get_size_stream);
326                 priv->get_size_stream = NULL;
327         }
328
329         priv->size = 0;
330
331         gtk_image_set_from_icon_name (GTK_IMAGE (priv->icon), 
332                                       UNKNOWN_FILE_ICON,
333                                       GTK_ICON_SIZE_MENU);
334         gtk_label_set_text (GTK_LABEL (priv->filename_view), "");
335         update_filename_request (MODEST_ATTACHMENT_VIEW(self));
336         gtk_label_set_text (GTK_LABEL (priv->size_view), " ");
337
338         gtk_widget_queue_draw (GTK_WIDGET (self));
339 }
340
341
342 /**
343  * modest_attachment_view_new:
344  * @mime_part: a #TnyMimePart
345  *
346  * Constructor for attachment view widget.
347  *
348  * Return value: a new #ModestAttachmentView instance implemented for Gtk+
349  **/
350 GtkWidget*
351 modest_attachment_view_new (TnyMimePart *mime_part, gboolean detect_size)
352 {
353         ModestAttachmentView *self = g_object_new (MODEST_TYPE_ATTACHMENT_VIEW, 
354                                                    NULL);
355
356         modest_attachment_view_set_detect_size (self, detect_size);
357
358         modest_attachment_view_set_part (TNY_MIME_PART_VIEW (self), mime_part);
359
360         return GTK_WIDGET (self);
361 }
362
363 static void
364 modest_attachment_view_instance_init (GTypeInstance *instance, gpointer g_class)
365 {
366         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (instance);
367         PangoContext *context;
368         GtkWidget *box = NULL;
369
370         priv->mime_part = NULL;
371         priv->icon = gtk_image_new ();
372         priv->filename_view = gtk_label_new ("");
373         gtk_label_set_line_wrap (GTK_LABEL (priv->filename_view), FALSE);
374         gtk_label_set_ellipsize (GTK_LABEL (priv->filename_view), PANGO_ELLIPSIZE_END);
375         gtk_label_set_single_line_mode (GTK_LABEL (priv->filename_view), TRUE);
376         gtk_label_set_selectable (GTK_LABEL (priv->filename_view), FALSE);
377         priv->size_view = gtk_label_new (" ");
378         gtk_label_set_line_wrap (GTK_LABEL (priv->size_view), FALSE);
379         gtk_label_set_selectable (GTK_LABEL (priv->size_view), FALSE);
380         gtk_misc_set_alignment (GTK_MISC (priv->size_view), 0.0, 0.5);
381         gtk_misc_set_alignment (GTK_MISC (priv->filename_view), 0.0, 0.5);
382
383         priv->get_size_stream = NULL;
384         priv->size = 0;
385         priv->detect_size = TRUE;
386
387         box = gtk_hbox_new (FALSE, 0);
388         gtk_box_pack_start (GTK_BOX (box), priv->icon, FALSE, FALSE, 0);
389         gtk_box_pack_start (GTK_BOX (box), priv->filename_view, TRUE, TRUE, 0);
390         gtk_box_pack_start (GTK_BOX (box), priv->size_view, FALSE, FALSE, 0);
391         gtk_container_add (GTK_CONTAINER (instance), box);
392
393 /*      gtk_widget_get_style */
394 /*      gtk_widget_modify_bg (instance, GTK_STATE_SELECTED, selection_color); */
395
396         context = gtk_widget_get_pango_context (priv->filename_view);
397         priv->layout_full_filename = pango_layout_new (context);
398         
399         pango_layout_set_ellipsize (priv->layout_full_filename, PANGO_ELLIPSIZE_NONE);
400
401         gtk_event_box_set_above_child (GTK_EVENT_BOX (instance), FALSE);
402         gtk_event_box_set_visible_window (GTK_EVENT_BOX (instance), TRUE);
403         gtk_widget_set_events (GTK_WIDGET (instance), 0);
404
405         GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (instance), GTK_CAN_FOCUS);
406
407         return;
408 }
409
410 static void
411 modest_attachment_view_finalize (GObject *object)
412 {
413         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (object);
414
415         if (priv->get_size_stream != NULL) {
416                 g_object_unref (priv->get_size_stream);
417                 priv->get_size_stream = NULL;
418         }
419
420         if (G_LIKELY (priv->mime_part)) {
421                 g_object_unref (G_OBJECT (priv->mime_part));
422                 priv->mime_part = NULL;
423         }
424
425         (*parent_class->finalize) (object);
426
427         return;
428 }
429
430 static void
431 size_allocate (GtkWidget *widget, GtkAllocation *allocation)
432 {
433         ModestAttachmentViewPrivate *priv = MODEST_ATTACHMENT_VIEW_GET_PRIVATE (widget);
434         gint width, width_diff;
435
436         GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
437         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)))));
438
439         pango_layout_get_pixel_size (priv->layout_full_filename, &width, NULL);
440         width_diff = priv->filename_view->allocation.width - width;
441         if (width_diff > 0) {
442                 GtkAllocation filename_alloc, filesize_alloc;
443                 filename_alloc = priv->filename_view->allocation;
444                 filesize_alloc = priv->size_view->allocation;
445                 filename_alloc.width -= width_diff;
446                 filesize_alloc.width += width_diff;
447                 filesize_alloc.x -= width_diff;
448                 gtk_widget_size_allocate (priv->filename_view, &filename_alloc);
449                 gtk_widget_size_allocate (priv->size_view, &filesize_alloc);
450         }
451         
452 }
453
454
455 static void 
456 modest_attachment_view_class_init (ModestAttachmentViewClass *klass)
457 {
458         GObjectClass *object_class;
459         GtkWidgetClass *widget_class;
460
461         parent_class = g_type_class_peek_parent (klass);
462         object_class = (GObjectClass*) klass;
463         widget_class = GTK_WIDGET_CLASS (klass);
464
465         object_class->finalize = modest_attachment_view_finalize;
466
467         klass->get_part_func = modest_attachment_view_get_part_default;
468         klass->set_part_func = modest_attachment_view_set_part_default;
469         klass->clear_func = modest_attachment_view_clear_default;
470
471         widget_class->size_allocate = size_allocate;
472
473         g_type_class_add_private (object_class, sizeof (ModestAttachmentViewPrivate));
474
475         return;
476 }
477
478 static void
479 tny_mime_part_view_init (gpointer g, gpointer iface_data)
480 {
481         TnyMimePartViewIface *klass = (TnyMimePartViewIface *)g;
482
483         klass->get_part_func = modest_attachment_view_get_part;
484         klass->set_part_func = modest_attachment_view_set_part;
485         klass->clear_func = modest_attachment_view_clear;
486
487         return;
488 }
489
490 GType 
491 modest_attachment_view_get_type (void)
492 {
493         static GType type = 0;
494
495         if (G_UNLIKELY(type == 0))
496         {
497                 static const GTypeInfo info = 
498                 {
499                   sizeof (ModestAttachmentViewClass),
500                   NULL,   /* base_init */
501                   NULL,   /* base_finalize */
502                   (GClassInitFunc) modest_attachment_view_class_init,   /* class_init */
503                   NULL,   /* class_finalize */
504                   NULL,   /* class_data */
505                   sizeof (ModestAttachmentView),
506                   0,      /* n_preallocs */
507                   modest_attachment_view_instance_init    /* instance_init */
508                 };
509
510                 static const GInterfaceInfo tny_mime_part_view_info =
511                 {
512                         (GInterfaceInitFunc) tny_mime_part_view_init, /* interface_init */
513                         NULL,        /* interface_finalize */
514                         NULL         /* interface_data */
515                 };
516
517                 type = g_type_register_static (GTK_TYPE_EVENT_BOX,
518                         "ModestAttachmentView",
519                         &info, 0);
520
521                 g_type_add_interface_static (type, TNY_TYPE_MIME_PART_VIEW,
522                                              &tny_mime_part_view_info);
523
524         }
525
526         return type;
527 }