* Fixes NB#97657, replace "TODO" strings by the proper logical ids
[modest] / src / hildon2 / modest-folder-window.c
1 /* Copyright (c) 2008, 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 <modest-folder-window.h>
31 #include <modest-osso-state-saving.h>
32 #include <libosso.h>
33 #include <hildon/hildon-pannable-area.h>
34 #include <modest-window-mgr.h>
35 #include <modest-signal-mgr.h>
36 #include <modest-runtime.h>
37 #include <modest-platform.h>
38 #include <modest-maemo-utils.h>
39 #include <modest-icon-names.h>
40 #include <modest-ui-constants.h>
41 #include <modest-account-mgr.h>
42 #include <modest-account-mgr-helpers.h>
43 #include <modest-defs.h>
44 #include <modest-ui-actions.h>
45 #include <modest-window.h>
46 #include <hildon/hildon-program.h>
47 #include <hildon/hildon-banner.h>
48 #include <tny-account-store-view.h>
49 #include <modest-header-window.h>
50 #include <modest-ui-dimming-rules.h>
51 #include <modest-ui-dimming-manager.h>
52 #include <modest-window-priv.h>
53
54 typedef enum {
55         EDIT_MODE_COMMAND_MOVE = 1,
56         EDIT_MODE_COMMAND_DELETE = 2,
57         EDIT_MODE_COMMAND_RENAME = 3,
58 } EditModeCommand;
59
60 /* 'private'/'protected' functions */
61 static void modest_folder_window_class_init  (ModestFolderWindowClass *klass);
62 static void modest_folder_window_init        (ModestFolderWindow *obj);
63 static void modest_folder_window_finalize    (GObject *obj);
64
65 static void connect_signals (ModestFolderWindow *self);
66 static void modest_folder_window_disconnect_signals (ModestWindow *self);
67
68 static void on_folder_activated (ModestFolderView *folder_view,
69                                  TnyFolder *folder,
70                                  gpointer userdata);
71 static void setup_menu (ModestFolderWindow *self);
72
73 static void set_delete_edit_mode (GtkButton *button,
74                                   ModestFolderWindow *self);
75 static void set_moveto_edit_mode (GtkButton *button,
76                                   ModestFolderWindow *self);
77 static void set_rename_edit_mode (GtkButton *button,
78                                   ModestFolderWindow *self);
79 static void modest_folder_window_pack_toolbar (ModestHildon2Window *self,
80                                                GtkPackType pack_type,
81                                                GtkWidget *toolbar);
82
83 typedef struct _ModestFolderWindowPrivate ModestFolderWindowPrivate;
84 struct _ModestFolderWindowPrivate {
85
86         GtkWidget *folder_view;
87         GtkWidget *top_vbox;
88
89         /* signals */
90         GSList *sighandlers;
91
92         /* Display state */
93         osso_display_state_t display_state;
94 };
95 #define MODEST_FOLDER_WINDOW_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE((o), \
96                                                                           MODEST_TYPE_FOLDER_WINDOW, \
97                                                                           ModestFolderWindowPrivate))
98
99 /* globals */
100 static GtkWindowClass *parent_class = NULL;
101
102 /************************************************************************/
103
104 GType
105 modest_folder_window_get_type (void)
106 {
107         static GType my_type = 0;
108         if (!my_type) {
109                 static const GTypeInfo my_info = {
110                         sizeof(ModestFolderWindowClass),
111                         NULL,           /* base init */
112                         NULL,           /* base finalize */
113                         (GClassInitFunc) modest_folder_window_class_init,
114                         NULL,           /* class finalize */
115                         NULL,           /* class data */
116                         sizeof(ModestFolderWindow),
117                         1,              /* n_preallocs */
118                         (GInstanceInitFunc) modest_folder_window_init,
119                         NULL
120                 };
121                 my_type = g_type_register_static (MODEST_TYPE_HILDON2_WINDOW,
122                                                   "ModestFolderWindow",
123                                                   &my_info, 0);
124         }
125         return my_type;
126 }
127
128 static void
129 modest_folder_window_class_init (ModestFolderWindowClass *klass)
130 {
131         GObjectClass *gobject_class;
132         gobject_class = (GObjectClass*) klass;
133         ModestWindowClass *modest_window_class = (ModestWindowClass *) klass;
134         ModestHildon2WindowClass *modest_hildon2_window_class = (ModestHildon2WindowClass *) klass;
135
136         parent_class            = g_type_class_peek_parent (klass);
137         gobject_class->finalize = modest_folder_window_finalize;
138
139         g_type_class_add_private (gobject_class, sizeof(ModestFolderWindowPrivate));
140         
141         modest_window_class->disconnect_signals_func = modest_folder_window_disconnect_signals;
142         modest_hildon2_window_class->pack_toolbar_func = modest_folder_window_pack_toolbar;
143 }
144
145 static void
146 modest_folder_window_init (ModestFolderWindow *obj)
147 {
148         ModestFolderWindowPrivate *priv;
149
150         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(obj);
151
152         priv->sighandlers = NULL;
153         priv->display_state = OSSO_DISPLAY_ON;
154         
155         priv->folder_view = NULL;
156
157         priv->top_vbox = NULL;
158
159         modest_window_mgr_register_help_id (modest_runtime_get_window_mgr(),
160                                             GTK_WINDOW(obj),
161                                             "applications_email_folderview");
162 }
163
164 static void
165 modest_folder_window_finalize (GObject *obj)
166 {
167         ModestFolderWindowPrivate *priv;
168
169         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(obj);
170
171         /* Sanity check: shouldn't be needed, the window mgr should
172            call this function before */
173         modest_folder_window_disconnect_signals (MODEST_WINDOW (obj));  
174
175         G_OBJECT_CLASS(parent_class)->finalize (obj);
176 }
177
178 static void
179 modest_folder_window_disconnect_signals (ModestWindow *self)
180 {       
181         ModestFolderWindowPrivate *priv;        
182         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
183
184         modest_signal_mgr_disconnect_all_and_destroy (priv->sighandlers);
185         priv->sighandlers = NULL;       
186 }
187
188 static void
189 connect_signals (ModestFolderWindow *self)
190 {       
191         ModestFolderWindowPrivate *priv;
192         
193         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
194
195         /* folder view */
196         priv->sighandlers = modest_signal_mgr_connect (priv->sighandlers, 
197                                                        G_OBJECT (priv->folder_view), "folder-activated", 
198                                                        G_CALLBACK (on_folder_activated), self);
199
200         /* TODO: connect folder view activate */
201         
202         /* window */
203
204         /* we don't register this in sighandlers, as it should be run after disconnecting all signals,
205          * in destroy stage */
206
207         
208 }
209
210 static void 
211 osso_display_event_cb (osso_display_state_t state, 
212                        gpointer data)
213 {
214         ModestFolderWindowPrivate *priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (data);
215
216         priv->display_state = state;
217
218         /* Stop blinking if the screen becomes on */
219         if (priv->display_state == OSSO_DISPLAY_ON)
220                 modest_platform_remove_new_mail_notifications (TRUE);
221 }
222
223 ModestWindow *
224 modest_folder_window_new (TnyFolderStoreQuery *query)
225 {
226         ModestFolderWindow *self = NULL;        
227         ModestFolderWindowPrivate *priv = NULL;
228         HildonProgram *app;
229         GdkPixbuf *window_icon;
230         GtkWidget *pannable;
231         
232         self  = MODEST_FOLDER_WINDOW(g_object_new(MODEST_TYPE_FOLDER_WINDOW, NULL));
233         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
234
235         pannable = hildon_pannable_area_new ();
236         priv->folder_view  = modest_platform_create_folder_view (query);
237         modest_folder_view_set_cell_style (MODEST_FOLDER_VIEW (priv->folder_view),
238                                            MODEST_FOLDER_VIEW_CELL_STYLE_COMPACT);
239
240         setup_menu (self);
241
242         /* Set account store */
243         tny_account_store_view_set_account_store (TNY_ACCOUNT_STORE_VIEW (priv->folder_view),
244                                                   TNY_ACCOUNT_STORE (modest_runtime_get_account_store ()));
245
246         priv->top_vbox = gtk_vbox_new (0, FALSE);
247
248         gtk_container_add (GTK_CONTAINER (pannable), priv->folder_view);
249         gtk_box_pack_end (GTK_BOX (priv->top_vbox), pannable, TRUE, TRUE, 0);
250         gtk_container_add (GTK_CONTAINER (self), priv->top_vbox);
251
252         gtk_widget_show (priv->folder_view);
253         gtk_widget_show (pannable);
254         gtk_widget_show (priv->top_vbox);
255
256         connect_signals (MODEST_FOLDER_WINDOW (self));
257
258         /* Load previous osso state, for instance if we are being restored from 
259          * hibernation:  */
260         modest_osso_load_state ();
261
262         /* Get device name */
263         modest_maemo_utils_get_device_name ();
264
265         app = hildon_program_get_instance ();
266         hildon_program_add_window (app, HILDON_WINDOW (self));
267         
268         /* Set window icon */
269         window_icon = modest_platform_get_icon (MODEST_APP_ICON, MODEST_ICON_SIZE_BIG);
270         if (window_icon) {
271                 gtk_window_set_icon (GTK_WINDOW (self), window_icon);
272                 g_object_unref (window_icon);
273         }
274
275         /* Listen for changes in the screen, we don't want to show a
276            led pattern when the display is on for example */
277         osso_hw_set_display_event_cb (modest_maemo_utils_get_osso_context (),
278                                       osso_display_event_cb,
279                                       self); 
280
281         /* Dont't restore settings here, 
282          * because it requires a gtk_widget_show(), 
283          * and we don't want to do that until later,
284          * so that the UI is not visible for non-menu D-Bus activation.
285          */
286
287         /* Register edit modes */
288         modest_hildon2_window_register_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_DELETE,
289                                                   _("mcen_ti_edit_folder_delete"), _HL("wdgt_bd_delete"),
290                                                   GTK_TREE_VIEW (priv->folder_view),
291                                                   GTK_SELECTION_SINGLE,
292                                                   EDIT_MODE_CALLBACK (modest_ui_actions_on_edit_mode_delete_folder));
293         modest_hildon2_window_register_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_MOVE,
294                                                   _("mcen_ti_edit_move_folder"), _("mcen_me_move"),
295                                                   GTK_TREE_VIEW (priv->folder_view),
296                                                   GTK_SELECTION_SINGLE,
297                                                   EDIT_MODE_CALLBACK (modest_ui_actions_on_edit_mode_move_to)); 
298         modest_hildon2_window_register_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_RENAME,
299                                                   _("mcen_ti_edit_rename_folde"), _HL("wdgt_bd_rename"),
300                                                   GTK_TREE_VIEW (priv->folder_view),
301                                                   GTK_SELECTION_SINGLE,
302                                                   EDIT_MODE_CALLBACK (modest_ui_actions_on_edit_mode_rename_folder));
303         
304         return MODEST_WINDOW(self);
305 }
306
307 gboolean
308 modest_folder_window_screen_is_on (ModestFolderWindow *self)
309 {
310         ModestFolderWindowPrivate *priv = NULL;
311
312         g_return_val_if_fail (MODEST_IS_FOLDER_WINDOW(self), FALSE);
313
314         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
315         
316         return (priv->display_state == OSSO_DISPLAY_ON) ? TRUE : FALSE;
317 }
318
319 ModestFolderView *
320 modest_folder_window_get_folder_view (ModestFolderWindow *self)
321 {
322         ModestFolderWindowPrivate *priv = NULL;
323
324         g_return_val_if_fail (MODEST_IS_FOLDER_WINDOW(self), FALSE);
325
326         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
327         
328         return MODEST_FOLDER_VIEW (priv->folder_view);
329 }
330
331 void
332 modest_folder_window_set_account (ModestFolderWindow *self,
333                                   const gchar *account_name)
334 {
335         ModestFolderWindowPrivate *priv = NULL;
336         ModestAccountMgr *mgr;
337         ModestAccountSettings *settings = NULL;
338         ModestServerAccountSettings *store_settings = NULL;
339
340         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
341
342         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
343         
344         /* Get account data */
345         mgr = modest_runtime_get_account_mgr ();
346
347         settings = modest_account_mgr_load_account_settings (mgr, account_name);
348         if (!settings)
349                 goto free_refs;
350
351         store_settings = modest_account_settings_get_store_settings (settings);
352         if (!store_settings)
353                 goto free_refs;
354
355         modest_folder_view_set_account_id_of_visible_server_account 
356                 (MODEST_FOLDER_VIEW (priv->folder_view),
357                  modest_server_account_settings_get_account_name (store_settings));
358
359         modest_window_set_active_account (MODEST_WINDOW (self), account_name);
360         gtk_window_set_title (GTK_WINDOW (self), 
361                               modest_account_settings_get_display_name (settings));
362
363 free_refs:
364         if (store_settings) 
365                 g_object_unref (store_settings);
366         if (settings)
367                 g_object_unref (settings);
368
369 }
370
371 static void setup_menu (ModestFolderWindow *self)
372 {
373         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
374
375         /* folders actions */
376         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_new_folder"),
377                                            APP_MENU_CALLBACK (modest_ui_actions_on_new_folder),
378                                            NULL);
379         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_user_renamefolder"),
380                                            APP_MENU_CALLBACK (set_rename_edit_mode),
381                                            NULL);
382         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_move_folder"),
383                                            APP_MENU_CALLBACK (set_moveto_edit_mode),
384                                            NULL);
385         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_delete_folder"),
386                                            APP_MENU_CALLBACK (set_delete_edit_mode),
387                                            NULL);
388
389         /* new message */
390         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_viewer_newemail"),
391                                            APP_MENU_CALLBACK (modest_ui_actions_on_new_msg),
392                                            NULL);
393
394         /* send receive actions should be only one visible always */
395         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_inbox_sendandreceive"),
396                                            APP_MENU_CALLBACK (modest_ui_actions_on_send_receive),
397                                            MODEST_DIMMING_CALLBACK (modest_ui_dimming_rules_on_send_receive_all));
398         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_outbox_cancelsend"),
399                                            APP_MENU_CALLBACK (modest_ui_actions_cancel_send),
400                                            MODEST_DIMMING_CALLBACK (modest_ui_dimming_rules_on_cancel_sending_all));
401
402         /* Settings menu buttons */
403         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_new_accounts"),
404                                            APP_MENU_CALLBACK (modest_ui_actions_on_new_account),
405                                            NULL);
406         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_edit_accounts"),
407                                            APP_MENU_CALLBACK (modest_ui_actions_on_accounts),
408                                            NULL);
409         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_inbox_options"),
410                                            APP_MENU_CALLBACK (modest_ui_actions_on_settings),
411                                            NULL);
412         modest_hildon2_window_add_to_menu (MODEST_HILDON2_WINDOW (self), _("mcen_me_inbox_globalsmtpservers"),
413                                            APP_MENU_CALLBACK (modest_ui_actions_on_smtp_servers),
414                                            MODEST_DIMMING_CALLBACK (modest_ui_dimming_rules_on_tools_smtp_servers));
415         
416 }
417
418 static void
419 on_folder_activated (ModestFolderView *folder_view,
420                      TnyFolder *folder,
421                      gpointer userdata)
422 {
423         ModestFolderWindowPrivate *priv = NULL;
424         ModestWindow *headerwin;
425         ModestFolderWindow *self = (ModestFolderWindow *) userdata;
426
427         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
428
429         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
430
431         if (!folder)
432                 return;
433
434         if (!TNY_IS_FOLDER (folder))
435                 return;
436
437         headerwin = modest_header_window_new (folder);
438         modest_window_mgr_register_window (modest_runtime_get_window_mgr (), 
439                                            MODEST_WINDOW (headerwin),
440                                            MODEST_WINDOW (self));
441
442         modest_window_set_active_account (MODEST_WINDOW (headerwin), 
443                                           modest_window_get_active_account (MODEST_WINDOW (self)));
444         gtk_widget_show (GTK_WIDGET (headerwin));
445 }
446
447 static void
448 set_delete_edit_mode (GtkButton *button,
449                       ModestFolderWindow *self)
450 {
451         modest_hildon2_window_set_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_DELETE);
452 }
453
454 static void
455 set_moveto_edit_mode (GtkButton *button,
456                       ModestFolderWindow *self)
457 {
458         modest_hildon2_window_set_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_MOVE);
459 }
460
461 static void
462 set_rename_edit_mode (GtkButton *button,
463                       ModestFolderWindow *self)
464 {
465         modest_hildon2_window_set_edit_mode (MODEST_HILDON2_WINDOW (self), EDIT_MODE_COMMAND_RENAME);
466 }
467
468 static void
469 modest_folder_window_pack_toolbar (ModestHildon2Window *self,
470                                    GtkPackType pack_type,
471                                    GtkWidget *toolbar)
472 {
473         ModestFolderWindowPrivate *priv;
474
475         g_return_if_fail (MODEST_IS_FOLDER_WINDOW (self));
476         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
477
478         if (pack_type == GTK_PACK_START) {
479                 gtk_box_pack_start (GTK_BOX (priv->top_vbox), toolbar, FALSE, FALSE, 0);
480         } else {
481                 gtk_box_pack_end (GTK_BOX (priv->top_vbox), toolbar, FALSE, FALSE, 0);
482         }
483 }