* tiny optimization for the header view: avoid one needless
[modest] / src / widgets / modest-header-view-render.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 #include <tny-simple-list.h>
31 #include <modest-header-view.h>
32 #include <modest-header-view-priv.h>
33 #include <modest-icon-names.h>
34 #include <modest-text-utils.h>
35 #include <modest-tny-account-store.h>
36 #include <modest-tny-send-queue.h>
37 #include <modest-tny-folder.h>
38 #include <modest-tny-account.h>
39 #include <modest-runtime.h>
40 #include <glib/gi18n.h>
41 #include <modest-platform.h>
42 #include <string.h>
43
44
45 static void 
46 fill_list_of_caches (gpointer key, gpointer value, gpointer userdata)
47 {
48         GSList **send_queues = (GSList **) userdata;
49         *send_queues = g_slist_prepend (*send_queues, value);
50 }
51
52 static ModestTnySendQueueStatus
53 get_status_of_uid (TnyHeader *header)
54 {
55         ModestCacheMgr *cache_mgr = NULL;
56         GHashTable     *send_queue_cache = NULL;
57         ModestTnyAccountStore *accounts_store = NULL;
58         TnyList *accounts = NULL;
59         TnyIterator *iter = NULL;
60         TnyTransportAccount *account = NULL;
61         GSList *send_queues = NULL, *node;
62         /* get_msg_status returns suspended by default, so we want to detect changes */
63         ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
64         ModestTnySendQueueStatus queue_status = MODEST_TNY_SEND_QUEUE_SUSPENDED;
65         gchar *msg_uid = NULL;
66         ModestTnySendQueue *send_queue = NULL;
67         
68         msg_uid = modest_tny_send_queue_get_msg_id (header);
69         cache_mgr = modest_runtime_get_cache_mgr ();
70         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
71                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
72         
73         g_hash_table_foreach (send_queue_cache, (GHFunc) fill_list_of_caches, &send_queues);
74         if (send_queues == NULL) {
75                 accounts = tny_simple_list_new (); 
76                 accounts_store = modest_runtime_get_account_store ();
77                 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(accounts_store), 
78                                                 accounts, 
79                                                 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
80                 
81                 iter = tny_list_create_iterator (accounts);
82                 while (!tny_iterator_is_done (iter)) {                  
83                         account = TNY_TRANSPORT_ACCOUNT(tny_iterator_get_current (iter));
84                         send_queue = modest_runtime_get_send_queue(TNY_TRANSPORT_ACCOUNT(account));
85                         g_object_unref(account);
86
87                         queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
88                         if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNONW) {
89                                 status = queue_status;
90                                 break;
91                         }
92                         tny_iterator_next (iter);
93                 }
94                 g_object_unref (iter);
95                 g_object_unref (accounts);
96         }
97         else {
98                 for (node = send_queues; node != NULL; node = g_slist_next (node)) {
99                         send_queue = MODEST_TNY_SEND_QUEUE (node->data);
100                         
101                         queue_status = modest_tny_send_queue_get_msg_status (send_queue, msg_uid);
102                         if (queue_status != MODEST_TNY_SEND_QUEUE_UNKNONW) {
103                                 status = queue_status;
104                                 break;
105                         }
106                 }
107         }
108
109         g_free(msg_uid);
110         g_slist_free (send_queues);
111         return status;
112 }
113
114 static const gchar *
115 get_status_string (ModestTnySendQueueStatus status)
116 {
117         switch (status) {
118         case MODEST_TNY_SEND_QUEUE_WAITING:
119                 return _("mcen_li_outbox_waiting");
120                 break;
121         case MODEST_TNY_SEND_QUEUE_SENDING:
122                 return _("mcen_li_outbox_sending");
123                 break;
124         case MODEST_TNY_SEND_QUEUE_SUSPENDED:
125                 return _("mcen_li_outbox_suspended");
126                 break;
127         case MODEST_TNY_SEND_QUEUE_FAILED:
128                 return _("mcen_li_outbox_failed");
129                 break;
130         default:
131                 return "";
132                 break;
133         }
134 }
135
136 static GdkPixbuf*
137 get_pixbuf_for_flag (TnyHeaderFlags flag)
138 {
139         /* optimization */
140         static GdkPixbuf *deleted_pixbuf          = NULL;
141         static GdkPixbuf *seen_pixbuf             = NULL;
142         static GdkPixbuf *unread_pixbuf           = NULL;
143         static GdkPixbuf *attachments_pixbuf      = NULL;
144         static GdkPixbuf *high_pixbuf             = NULL;
145         static GdkPixbuf *low_pixbuf             = NULL;
146         
147         switch (flag) {
148         case TNY_HEADER_FLAG_DELETED:
149                 if (G_UNLIKELY(!deleted_pixbuf))
150                         deleted_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_DELETED);
151                 return deleted_pixbuf;
152         case TNY_HEADER_FLAG_SEEN:
153                 if (G_UNLIKELY(!seen_pixbuf))
154                         seen_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_READ);
155                 return seen_pixbuf;
156         case TNY_HEADER_FLAG_ATTACHMENTS:
157                 if (G_UNLIKELY(!attachments_pixbuf))
158                         attachments_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_ATTACH);
159                 return attachments_pixbuf;
160         case TNY_HEADER_FLAG_HIGH_PRIORITY:
161                 if (G_UNLIKELY(!high_pixbuf))
162                         high_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_HIGH);
163                 return high_pixbuf;
164         case TNY_HEADER_FLAG_LOW_PRIORITY:
165                 if (G_UNLIKELY(!low_pixbuf))
166                         low_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_LOW);
167                 return low_pixbuf;
168         default:
169                 if (G_UNLIKELY(!unread_pixbuf))
170                         unread_pixbuf = modest_platform_get_icon (MODEST_HEADER_ICON_UNREAD);
171                 return unread_pixbuf;
172         }
173 }
174
175 static void
176 set_common_flags (GtkCellRenderer *renderer, TnyHeaderFlags flags)
177 {
178         g_object_set (G_OBJECT(renderer),
179                       "weight", (flags & TNY_HEADER_FLAG_SEEN) ? PANGO_WEIGHT_NORMAL: PANGO_WEIGHT_ULTRABOLD,
180                       "strikethrough",  (flags & TNY_HEADER_FLAG_DELETED) ?  TRUE:FALSE,
181                       NULL);    
182 }
183
184
185 void
186 _modest_header_view_msgtype_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
187                    GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer user_data)
188 {
189         TnyHeaderFlags flags;
190                 
191         gtk_tree_model_get (tree_model, iter, TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN,
192                             &flags, -1);
193
194         if (flags & TNY_HEADER_FLAG_DELETED)
195                 g_object_set (G_OBJECT (renderer), "pixbuf",
196                               get_pixbuf_for_flag (TNY_HEADER_FLAG_DELETED), NULL);           
197         else if (flags & TNY_HEADER_FLAG_SEEN)
198                 g_object_set (G_OBJECT (renderer), "pixbuf",
199                               get_pixbuf_for_flag (TNY_HEADER_FLAG_SEEN), NULL);              
200         else 
201                 g_object_set (G_OBJECT (renderer), "pixbuf",
202                               get_pixbuf_for_flag (0), NULL); /* ughh, FIXME */               
203 }
204
205 void
206 _modest_header_view_attach_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
207                                       GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer user_data)
208 {
209         TnyHeaderFlags flags;
210
211         gtk_tree_model_get (tree_model, iter, TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN,
212                             &flags, -1);
213
214         if (flags & TNY_HEADER_FLAG_ATTACHMENTS)
215                 g_object_set (G_OBJECT (renderer), "pixbuf",
216                               get_pixbuf_for_flag (TNY_HEADER_FLAG_ATTACHMENTS),
217                               NULL);
218 }
219
220 void
221 _modest_header_view_header_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
222                   GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer user_data)
223 {
224         TnyHeaderFlags flags;
225         
226         gtk_tree_model_get (tree_model, iter, TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN,
227                             &flags, -1);
228         set_common_flags (renderer, flags);
229 }
230
231
232 void
233 _modest_header_view_date_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
234                                      GtkTreeModel *tree_model,  GtkTreeIter *iter,
235                                      gpointer user_data)
236 {
237         TnyHeaderFlags flags;
238         guint date, date_col;
239         gchar *display_date = NULL;
240         gboolean received = GPOINTER_TO_INT(user_data);
241
242         if (received)
243                 date_col = TNY_GTK_HEADER_LIST_MODEL_DATE_RECEIVED_TIME_T_COLUMN;
244         else
245                 date_col = TNY_GTK_HEADER_LIST_MODEL_DATE_SENT_TIME_T_COLUMN;
246
247         gtk_tree_model_get (tree_model, iter,
248                             TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
249                             date_col, &date,
250                             -1);
251         
252         display_date = modest_text_utils_get_display_date (date);
253         g_object_set (G_OBJECT(renderer), "text", display_date, NULL);  
254
255         set_common_flags (renderer, flags);
256         g_free (display_date);
257 }
258
259 void
260 _modest_header_view_sender_receiver_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
261                             GtkTreeModel *tree_model,  GtkTreeIter *iter,  gboolean is_sender)
262 {
263         TnyHeaderFlags flags;
264         gchar *address;
265         gint sender_receiver_col;
266
267         if (is_sender)
268                 sender_receiver_col = TNY_GTK_HEADER_LIST_MODEL_FROM_COLUMN;
269         else
270                 sender_receiver_col = TNY_GTK_HEADER_LIST_MODEL_TO_COLUMN;
271                 
272         gtk_tree_model_get (tree_model, iter,
273                             sender_receiver_col,  &address,
274                             TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
275                             -1);
276         
277         g_object_set (G_OBJECT(renderer),
278                       "text",
279                       modest_text_utils_get_display_address (address),
280                       NULL);
281         g_free (address);
282         set_common_flags (renderer, flags);
283 }
284 /*
285  * this for both incoming and outgoing mail, depending on the the user_data
286  * parameter. in the incoming case, show 'From' and 'Received date', in the
287  * outgoing case, show 'To' and 'Sent date'
288  */
289 void
290 _modest_header_view_compact_header_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
291                                                GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer user_data)
292 {
293         g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (column));
294         g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
295         g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
296         
297         /* Note that GtkTreeModel is a GtkTreeModelFilter. */
298         
299         /* printf ("DEBUG: %s: tree_model gtype=%s\n", __FUNCTION__, G_OBJECT_TYPE_NAME (tree_model)); */
300         
301         TnyHeaderFlags flags = 0;
302         TnyHeaderFlags prior_flags = 0;
303         gchar *address = NULL;
304         gchar *subject = NULL;
305         gchar *header = NULL;
306         time_t date = 0;
307         
308         GtkCellRenderer *recipient_cell, *date_or_status_cell, *subject_cell,
309                 *attach_cell, *priority_cell,
310                 *recipient_box, *subject_box = NULL;
311         TnyHeader *msg_header = NULL;
312         gchar *display_date = NULL, *tmp_date = NULL;
313
314         recipient_box = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (renderer), "recpt-box-renderer"));
315         subject_box = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (renderer), "subject-box-renderer"));
316         priority_cell = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (subject_box), "priority-renderer"));
317         subject_cell = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (subject_box), "subject-renderer"));
318         attach_cell = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (recipient_box), "attach-renderer"));
319         recipient_cell = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (recipient_box), "recipient-renderer"));
320         date_or_status_cell = GTK_CELL_RENDERER (g_object_get_data (G_OBJECT (recipient_box), "date-renderer"));
321
322         ModestHeaderViewCompactHeaderMode header_mode = GPOINTER_TO_INT (user_data); 
323
324         if (header_mode == MODEST_HEADER_VIEW_COMPACT_HEADER_MODE_IN)
325                 gtk_tree_model_get (tree_model, iter,
326                                     TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
327                                     TNY_GTK_HEADER_LIST_MODEL_FROM_COLUMN,  &address,
328                                     TNY_GTK_HEADER_LIST_MODEL_SUBJECT_COLUMN, &subject,
329                                     TNY_GTK_HEADER_LIST_MODEL_DATE_RECEIVED_TIME_T_COLUMN, &date,   
330                                     -1);
331         else
332                 gtk_tree_model_get (tree_model, iter,
333                                     TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
334                                     TNY_GTK_HEADER_LIST_MODEL_TO_COLUMN,  &address,
335                                     TNY_GTK_HEADER_LIST_MODEL_SUBJECT_COLUMN, &subject,
336                                     TNY_GTK_HEADER_LIST_MODEL_DATE_SENT_TIME_T_COLUMN, &date,
337                                     TNY_GTK_HEADER_LIST_MODEL_INSTANCE_COLUMN, &msg_header,
338                                     -1);        
339         /* flags */
340         /* FIXME: we might gain something by doing all the g_object_set's at once */
341         prior_flags = flags & TNY_HEADER_FLAG_PRIORITY;
342         if (flags & TNY_HEADER_FLAG_ATTACHMENTS)
343                 g_object_set (G_OBJECT (attach_cell), "pixbuf",
344                               get_pixbuf_for_flag (TNY_HEADER_FLAG_ATTACHMENTS),
345                               NULL);
346         else
347                 g_object_set (G_OBJECT (attach_cell), "pixbuf",
348                               NULL, NULL);
349         if (flags & TNY_HEADER_FLAG_PRIORITY)
350                 g_object_set (G_OBJECT (priority_cell), "pixbuf",
351                               get_pixbuf_for_flag (prior_flags),
352 /*                            get_pixbuf_for_flag (flags & TNY_HEADER_FLAG_PRIORITY), */
353                               NULL);
354         else
355                 g_object_set (G_OBJECT (priority_cell), "pixbuf",
356                               NULL, NULL);
357
358
359         g_object_set (G_OBJECT (subject_cell), "markup",
360                       (subject && strlen (subject)) ? subject : _("mail_va_no_subject"),
361                       NULL);
362         g_free (subject);
363         set_common_flags (subject_cell, flags);
364
365         /* FIXME: we hardcode the color to #666666; instead we should use SecondaryTextColour from the
366          * theme (gtkrc file) */
367         header = g_markup_printf_escaped ("<span size='small' foreground='#666666'>%s</span>",
368                                           modest_text_utils_get_display_address (address));
369         g_free (address);
370         address = NULL;
371         g_object_set (G_OBJECT (recipient_cell),
372                       "markup", header,
373                       NULL);
374         g_free (header);
375         header = NULL;
376         set_common_flags (recipient_cell, flags);
377
378         if (header_mode == MODEST_HEADER_VIEW_COMPACT_HEADER_MODE_OUTBOX) {
379                 ModestTnySendQueueStatus status = MODEST_TNY_SEND_QUEUE_WAITING;
380                 const gchar *status_str = "";
381                 if (msg_header != NULL) {
382                         status = get_status_of_uid (msg_header);
383                         if (status == MODEST_TNY_SEND_QUEUE_SUSPENDED) {
384                                 tny_header_unset_flags (msg_header, TNY_HEADER_FLAG_PRIORITY);
385                                 tny_header_set_flags (msg_header, TNY_HEADER_FLAG_SUSPENDED_PRIORITY);
386                         }
387 /*                      if (prior_flags == TNY_HEADER_FLAG_SUSPENDED_PRIORITY) */
388 /*                              status = MODEST_TNY_SEND_QUEUE_SUSPENDED; */
389                 }
390                 
391                 status_str = get_status_string (status);
392                 display_date = g_strdup_printf("<span size='small' foreground='#666666'>%s</span>", status_str);
393                 g_object_set (G_OBJECT (date_or_status_cell),
394                               "markup", display_date,
395                               NULL);
396                 g_free (display_date);
397                 display_date = NULL;
398         } else {
399                 /* in some rare cases, mail might have no Date: field. it case,
400                  * don't show the date, instead of bogus 1/1/1970
401                  */
402                 if (date)
403                         tmp_date = modest_text_utils_get_display_date (date);
404                 else
405                         tmp_date = g_strdup ("");
406                 
407                 display_date = g_strdup_printf ("<span size='small' foreground='#666666'>%s</span>", tmp_date);
408                 g_object_set (G_OBJECT (date_or_status_cell),
409                               "markup", display_date,
410                               NULL);
411                 g_free (tmp_date);
412                 tmp_date = NULL;
413                 g_free (display_date);
414                 display_date = NULL;
415         }
416         
417         if (msg_header != NULL)
418                 g_object_unref (msg_header);
419                 
420         set_common_flags (date_or_status_cell, flags);
421 }
422
423
424 void
425 _modest_header_view_size_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
426                                      GtkTreeModel *tree_model,  GtkTreeIter *iter,
427                                      gpointer user_data)
428 {
429         TnyHeaderFlags flags;
430         guint size;
431         gchar *size_str;
432         
433         gtk_tree_model_get (tree_model, iter,
434                            TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
435                            TNY_GTK_HEADER_LIST_MODEL_MESSAGE_SIZE_COLUMN, &size,
436                             -1);
437         
438         size_str = modest_text_utils_get_display_size (size);
439         
440         g_object_set (G_OBJECT(renderer), "text", size_str, NULL);
441         set_common_flags (renderer, flags);
442
443         g_free (size_str);
444  }
445
446 void
447 _modest_header_view_status_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
448                                        GtkTreeModel *tree_model,  GtkTreeIter *iter,
449                                        gpointer user_data)
450 {
451         TnyHeaderFlags flags, prior_flags;
452         //guint status;
453         gchar *status_str;
454         
455         gtk_tree_model_get (tree_model, iter,
456                             TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN, &flags,
457                             -1);
458         
459        prior_flags = flags & TNY_HEADER_FLAG_PRIORITY;
460        if (prior_flags == TNY_HEADER_FLAG_SUSPENDED_PRIORITY)
461                status_str = g_strdup(_("mcen_li_outbox_suspended"));
462        else            
463                status_str = g_strdup(_("mcen_li_outbox_waiting"));
464        
465         g_object_set (G_OBJECT(renderer), "text", status_str, NULL);
466         set_common_flags (renderer, flags);
467
468         g_free (status_str);
469  }
470