git.maemo.org Git - modest/blob - src/widgets/modest-folder-view.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 <glib/gi18n.h>
  31 #include <string.h>
  32
  33 #include <tny-account-tree-model.h>
  34 #include <tny-account-store-iface.h>
  35 #include <tny-account-iface.h>
  36 #include <tny-folder-iface.h>
  37 #include <modest-icon-names.h>
  38 #include <modest-icon-factory.h>
  39 #include <modest-tny-account-store.h>
  40
  41 #include "modest-folder-view.h"
  42
  43
  44 /* 'private'/'protected' functions */
  45 static void modest_folder_view_class_init  (ModestFolderViewClass *klass);
  46 static void modest_folder_view_init        (ModestFolderView *obj);
  47 static void modest_folder_view_finalize    (GObject *obj);
  48
  49 static gboolean update_model (ModestFolderView *self,
  50                               ModestTnyAccountStore *account_store);
  51 static gboolean update_model_empty (ModestFolderView *self);
  52 static void on_selection_changed (GtkTreeSelection *sel, gpointer data);
  53 static gboolean modest_folder_view_update_model (ModestFolderView *self,
  54                                                  TnyAccountStoreIface *account_store);
  55
  56 enum {
  57         FOLDER_SELECTED_SIGNAL,
  58         LAST_SIGNAL
  59 };
  60
  61 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
  62 struct _ModestFolderViewPrivate {
  63
  64         TnyAccountStoreIface *account_store;
  65         TnyFolderIface       *cur_folder;
  66         gboolean             view_is_empty;
  67
  68         gulong               sig1, sig2;
  69         GMutex               *lock;
  70 };
  71 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o)                               \
  72         (G_TYPE_INSTANCE_GET_PRIVATE((o),                               \
  73                                      MODEST_TYPE_FOLDER_VIEW,           \
  74                                      ModestFolderViewPrivate))
  75 /* globals */
  76 static GObjectClass *parent_class = NULL;
  77
  78 static guint signals[LAST_SIGNAL] = {0};
  79
  80 GType
  81 modest_folder_view_get_type (void)
  82 {
  83         static GType my_type = 0;
  84         if (!my_type) {
  85                 static const GTypeInfo my_info = {
  86                         sizeof(ModestFolderViewClass),
  87                         NULL,           /* base init */
  88                         NULL,           /* base finalize */
  89                         (GClassInitFunc) modest_folder_view_class_init,
  90                         NULL,           /* class finalize */
  91                         NULL,           /* class data */
  92                         sizeof(ModestFolderView),
  93                         1,              /* n_preallocs */
  94                         (GInstanceInitFunc) modest_folder_view_init,
  95                         NULL
  96                 };
  97
  98                 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
  99                                                   "ModestFolderView",
 100                                                   &my_info, 0);
 101         }
 102         return my_type;
 103 }
 104
 105 static void
 106 modest_folder_view_class_init (ModestFolderViewClass *klass)
 107 {
 108         GObjectClass *gobject_class;
 109         gobject_class = (GObjectClass*) klass;
 110
 111         parent_class            = g_type_class_peek_parent (klass);
 112         gobject_class->finalize = modest_folder_view_finalize;
 113
 114         klass->update_model = modest_folder_view_update_model;
 115
 116         g_type_class_add_private (gobject_class,
 117                                   sizeof(ModestFolderViewPrivate));
 118
 119         signals[FOLDER_SELECTED_SIGNAL] =
 120                 g_signal_new ("folder_selected",
 121                               G_TYPE_FROM_CLASS (gobject_class),
 122                               G_SIGNAL_RUN_FIRST,
 123                               G_STRUCT_OFFSET (ModestFolderViewClass,
 124                                                folder_selected),
 125                               NULL, NULL,
 126                               g_cclosure_marshal_VOID__POINTER,
 127                               G_TYPE_NONE, 1, G_TYPE_POINTER);
 128 }
 129
 130
 131
 132 static void
 133 text_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
 134                  GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer data)
 135 {
 136         GObject *rendobj;
 137         gchar *fname;
 138         gint unread;
 139         TnyFolderType type;
 140
 141         gtk_tree_model_get (tree_model, iter,
 142                             TNY_ACCOUNT_TREE_MODEL_NAME_COLUMN, &fname,
 143                             TNY_ACCOUNT_TREE_MODEL_TYPE_COLUMN, &type,
 144                             TNY_ACCOUNT_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
 145         rendobj = G_OBJECT(renderer);
 146
 147         if (unread > 0) {
 148                 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
 149                 g_object_set (rendobj,"text", folder_title,  "weight", 800, NULL);
 150                 g_free (folder_title);
 151         } else
 152                 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
 153
 154         g_free (fname);
 155 }
 156
 157 /* FIXME: move these to TnyMail */
 158 enum {
 159
 160         TNY_FOLDER_TYPE_NOTES = TNY_FOLDER_TYPE_SENT + 1, /* urgh */
 161         TNY_FOLDER_TYPE_DRAFTS,
 162         TNY_FOLDER_TYPE_CONTACTS,
 163         TNY_FOLDER_TYPE_CALENDAR
 164 };
 165
 166 static TnyFolderType
 167 guess_folder_type (const gchar* name)
 168 {
 169         TnyFolderType type;
 170         gchar *folder;
 171
 172         g_return_val_if_fail (name, TNY_FOLDER_TYPE_NORMAL);
 173
 174         type = TNY_FOLDER_TYPE_NORMAL;
 175         folder = g_utf8_strdown (name, strlen(name));
 176
 177         if (strcmp (folder, "inbox") == 0 ||
 178             strcmp (folder, _("inbox")) == 0)
 179                 type = TNY_FOLDER_TYPE_INBOX;
 180         else if (strcmp (folder, "outbox") == 0 ||
 181                  strcmp (folder, _("outbox")) == 0)
 182                 type = TNY_FOLDER_TYPE_OUTBOX;
 183         else if (g_str_has_prefix(folder, "junk") ||
 184                  g_str_has_prefix(folder, _("junk")))
 185                 type = TNY_FOLDER_TYPE_JUNK;
 186         else if (g_str_has_prefix(folder, "trash") ||
 187                  g_str_has_prefix(folder, _("trash")))
 188                 type = TNY_FOLDER_TYPE_JUNK;
 189         else if (g_str_has_prefix(folder, "sent") ||
 190                  g_str_has_prefix(folder, _("sent")))
 191                 type = TNY_FOLDER_TYPE_SENT;
 192
 193         /* these are not *really* TNY_ types */
 194         else if (g_str_has_prefix(folder, "draft") ||
 195                  g_str_has_prefix(folder, _("draft")))
 196                 type = TNY_FOLDER_TYPE_DRAFTS;
 197         else if (g_str_has_prefix(folder, "notes") ||
 198                  g_str_has_prefix(folder, _("notes")))
 199                 type = TNY_FOLDER_TYPE_NOTES;
 200         else if (g_str_has_prefix(folder, "contacts") ||
 201                  g_str_has_prefix(folder, _("contacts")))
 202                 type = TNY_FOLDER_TYPE_CONTACTS;
 203         else if (g_str_has_prefix(folder, "calendar") ||
 204                  g_str_has_prefix(folder, _("calendar")))
 205                 type = TNY_FOLDER_TYPE_CALENDAR;
 206
 207         g_free (folder);
 208         return type;
 209 }
 210
 211
 212 static void
 213 icon_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
 214                  GtkTreeModel *tree_model,  GtkTreeIter *iter, gpointer data)
 215 {
 216         GObject *rendobj;
 217         GdkPixbuf *pixbuf;
 218         TnyFolderType type;
 219         gchar *fname = NULL;
 220         gint unread;
 221
 222         rendobj = G_OBJECT(renderer);
 223         gtk_tree_model_get (tree_model, iter,
 224                             TNY_ACCOUNT_TREE_MODEL_TYPE_COLUMN, &type,
 225                             TNY_ACCOUNT_TREE_MODEL_NAME_COLUMN, &fname,
 226                             TNY_ACCOUNT_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
 227         rendobj = G_OBJECT(renderer);
 228
 229         if (type == TNY_FOLDER_TYPE_NORMAL)
 230                 type = guess_folder_type (fname);
 231
 232         if (fname)
 233                 g_free (fname);
 234
 235         switch (type) {
 236         case TNY_FOLDER_TYPE_INBOX:
 237                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_INBOX);
 238                 break;
 239         case TNY_FOLDER_TYPE_OUTBOX:
 240                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_OUTBOX);
 241                 break;
 242         case TNY_FOLDER_TYPE_JUNK:
 243                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_JUNK);
 244                 break;
 245         case TNY_FOLDER_TYPE_SENT:
 246                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_SENT);
 247                 break;
 248         case TNY_FOLDER_TYPE_DRAFTS:
 249                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_DRAFTS);
 250                 break;
 251         case TNY_FOLDER_TYPE_NOTES:
 252                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NOTES);
 253                 break;
 254         case TNY_FOLDER_TYPE_CALENDAR:
 255                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CALENDAR);
 256                 break;
 257         case TNY_FOLDER_TYPE_CONTACTS:
 258                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CONTACTS);
 259                 break;
 260         case TNY_FOLDER_TYPE_NORMAL:
 261         default:
 262                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NORMAL);
 263                 break;
 264         }
 265
 266         g_object_set (rendobj,
 267                       "pixbuf-expander-open",
 268                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
 269                       "pixbuf-expander-closed",
 270                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
 271                       "pixbuf", pixbuf,
 272                       NULL);
 273 }
 274
 275 static void
 276 modest_folder_view_init (ModestFolderView *obj)
 277 {
 278         ModestFolderViewPrivate *priv;
 279         GtkTreeViewColumn *column;
 280         GtkCellRenderer *renderer;
 281         GtkTreeSelection *sel;
 282
 283         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
 284
 285         priv->view_is_empty     = TRUE;
 286         priv->account_store = NULL;
 287         priv->cur_folder = NULL;
 288
 289         priv->lock = g_mutex_new ();
 290
 291         column = gtk_tree_view_column_new ();
 292         gtk_tree_view_column_set_title (column,
 293                                         _("All Mail Folders"));
 294
 295         gtk_tree_view_append_column (GTK_TREE_VIEW(obj),
 296                                      column);
 297
 298         renderer = gtk_cell_renderer_pixbuf_new();
 299         gtk_tree_view_column_pack_start (column, renderer, FALSE);
 300         gtk_tree_view_column_set_cell_data_func(column, renderer,
 301                                                 icon_cell_data, NULL, NULL);
 302
 303         renderer = gtk_cell_renderer_text_new();
 304         gtk_tree_view_column_pack_start (column, renderer, FALSE);
 305         gtk_tree_view_column_set_cell_data_func(column, renderer,
 306                                                 text_cell_data, NULL, NULL);
 307
 308         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
 309         gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
 310
 311         gtk_tree_view_column_set_spacing (column, 2);
 312         gtk_tree_view_column_set_resizable (column, TRUE);
 313         gtk_tree_view_column_set_fixed_width (column, TRUE);
 314         gtk_tree_view_set_headers_visible   (GTK_TREE_VIEW(obj), TRUE);
 315         gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
 316
 317 }
 318
 319
 320 static void
 321 modest_folder_view_finalize (GObject *obj)
 322 {
 323         ModestFolderViewPrivate *priv;
 324         GtkTreeSelection    *sel;
 325
 326         g_return_if_fail (obj);
 327
 328         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
 329         if (priv->account_store) {
 330                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
 331                                              priv->sig1);
 332                 g_object_unref (G_OBJECT(priv->account_store));
 333                 priv->account_store = NULL;
 334         }
 335
 336         if (priv->lock) {
 337                 g_mutex_free (priv->lock);
 338                 priv->lock = NULL;
 339         }
 340
 341         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
 342         if (sel)
 343                 g_signal_handler_disconnect (G_OBJECT(sel), priv->sig2);
 344
 345         G_OBJECT_CLASS(parent_class)->finalize (obj);
 346 }
 347
 348
 349 static void
 350 on_account_update (TnyAccountStoreIface *account_store, const gchar *account,
 351                    gpointer user_data)
 352 {
 353         update_model_empty (MODEST_FOLDER_VIEW(user_data));
 354
 355         if (!update_model (MODEST_FOLDER_VIEW(user_data),
 356                            MODEST_TNY_ACCOUNT_STORE(account_store)))
 357                 g_printerr ("modest: failed to update model for changes in '%s'",
 358                             account);
 359 }
 360
 361
 362 GtkWidget*
 363 modest_folder_view_new (ModestTnyAccountStore *account_store)
 364 {
 365         GObject *self;
 366         ModestFolderViewPrivate *priv;
 367         GtkTreeSelection *sel;
 368
 369         g_return_val_if_fail (account_store, NULL);
 370
 371         self = G_OBJECT(g_object_new(MODEST_TYPE_FOLDER_VIEW, NULL));
 372         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
 373
 374         if (!update_model (MODEST_FOLDER_VIEW(self),
 375                            MODEST_TNY_ACCOUNT_STORE(account_store)))
 376                 g_printerr ("modest: failed to update model");
 377
 378         priv->sig1 = g_signal_connect (G_OBJECT(account_store), "account_update",
 379                                        G_CALLBACK (on_account_update), self);
 380
 381         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
 382         priv->sig2 = g_signal_connect (sel, "changed",
 383                                        G_CALLBACK(on_selection_changed), self);
 384
 385         return GTK_WIDGET(self);
 386 }
 387
 388
 389
 390
 391 static gboolean
 392 update_model_empty (ModestFolderView *self)
 393 {
 394         GtkTreeIter  iter;
 395         GtkTreeStore *store;
 396         ModestFolderViewPrivate *priv;
 397
 398         g_return_val_if_fail (self, FALSE);
 399
 400         store = gtk_tree_store_new (1, G_TYPE_STRING);
 401         gtk_tree_store_append (store, &iter, NULL);
 402
 403         gtk_tree_store_set (store, &iter, 0,
 404                             _("(empty)"), -1);
 405
 406         gtk_tree_view_set_model (GTK_TREE_VIEW(self),
 407                                  GTK_TREE_MODEL(store));
 408         g_object_unref (store);
 409
 410         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
 411         priv->view_is_empty = TRUE;
 412
 413         g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTED_SIGNAL], 0,
 414                        NULL);
 415
 416         return TRUE;
 417 }
 418
 419
 420 static gboolean
 421 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
 422 {
 423         ModestFolderViewPrivate *priv;
 424         TnyListIface     *account_list;
 425         GtkTreeModel     *model, *sortable;
 426
 427         g_return_val_if_fail (account_store, FALSE);
 428
 429         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
 430
 431         model        = GTK_TREE_MODEL(tny_account_tree_model_new ());
 432         account_list = TNY_LIST_IFACE(model);
 433
 434         update_model_empty (self); /* cleanup */
 435         priv->view_is_empty = TRUE;
 436
 437         tny_account_store_iface_get_accounts (TNY_ACCOUNT_STORE_IFACE(account_store),
 438                                               account_list,
 439                                               TNY_ACCOUNT_STORE_IFACE_STORE_ACCOUNTS);
 440         if (!account_list) /* no store accounts found */
 441                 return TRUE;
 442
 443         sortable = gtk_tree_model_sort_new_with_model (model);
 444         gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
 445
 446         priv->view_is_empty = FALSE;
 447         g_object_unref (model);
 448
 449         return TRUE;
 450 }
 451
 452
 453 static void
 454 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
 455 {
 456         GtkTreeModel            *model;
 457         TnyFolderIface       *folder = NULL;
 458         GtkTreeIter             iter;
 459         ModestFolderView *tree_view;
 460         ModestFolderViewPrivate *priv;
 461
 462         g_return_if_fail (sel);
 463         g_return_if_fail (user_data);
 464
 465         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
 466
 467         /* is_empty means that there is only the 'empty' item */
 468         if (priv->view_is_empty)
 469                 return;
 470
 471         /* folder was _un_selected if true */
 472         if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
 473                 priv->cur_folder = NULL; /* FIXME: need this? */
 474                 return;
 475         }
 476
 477         tree_view = MODEST_FOLDER_VIEW (user_data);
 478
 479         gtk_tree_model_get (model, &iter,
 480                             TNY_ACCOUNT_TREE_MODEL_INSTANCE_COLUMN,
 481                             &folder, -1);
 482
 483         if (priv->cur_folder)
 484                 tny_folder_iface_expunge (priv->cur_folder);
 485         priv->cur_folder = folder;
 486
 487         /* folder will not be defined if you click eg. on the root node */
 488         if (folder)
 489                 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTED_SIGNAL], 0,
 490                                folder);
 491 }
 492
 493
 494 static gboolean
 495 modest_folder_view_update_model (ModestFolderView *self, TnyAccountStoreIface *account_store)
 496 {
 497         gboolean retval;
 498
 499         g_return_val_if_fail (MODEST_IS_FOLDER_VIEW (self), FALSE);
 500         retval = update_model (self, MODEST_TNY_ACCOUNT_STORE(account_store)); /* ugly */
 501
 502         g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTED_SIGNAL],
 503                        0, NULL);
 504
 505         return retval;
 506 }