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