Refactoring of mail header view.
[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 <hildon/hildon-program.h>
46 #include <hildon/hildon-banner.h>
47 #include <tny-account-store-view.h>
48 #include <modest-header-window.h>
49
50 /* 'private'/'protected' functions */
51 static void modest_folder_window_class_init  (ModestFolderWindowClass *klass);
52 static void modest_folder_window_init        (ModestFolderWindow *obj);
53 static void modest_folder_window_finalize    (GObject *obj);
54
55 static void connect_signals (ModestFolderWindow *self);
56 static void modest_folder_window_disconnect_signals (ModestWindow *self);
57
58 static gboolean on_zoom_minus_plus_not_implemented (ModestWindow *window);
59 static void on_folder_activated (ModestFolderView *folder_view,
60                                  TnyFolder *folder,
61                                  gpointer userdata);
62 static void add_to_menu (ModestFolderWindow *self,
63                          HildonAppMenu *menu,
64                          gchar *label,
65                          GCallback callback);
66 static void setup_menu (ModestFolderWindow *self);
67
68 typedef struct _ModestFolderWindowPrivate ModestFolderWindowPrivate;
69 struct _ModestFolderWindowPrivate {
70
71         GtkWidget *folder_view;
72
73         /* signals */
74         GSList *sighandlers;
75
76         /* Display state */
77         osso_display_state_t display_state;
78 };
79 #define MODEST_FOLDER_WINDOW_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE((o), \
80                                                                           MODEST_TYPE_FOLDER_WINDOW, \
81                                                                           ModestFolderWindowPrivate))
82
83 /* globals */
84 static GtkWindowClass *parent_class = NULL;
85
86 /************************************************************************/
87
88 GType
89 modest_folder_window_get_type (void)
90 {
91         static GType my_type = 0;
92         if (!my_type) {
93                 static const GTypeInfo my_info = {
94                         sizeof(ModestFolderWindowClass),
95                         NULL,           /* base init */
96                         NULL,           /* base finalize */
97                         (GClassInitFunc) modest_folder_window_class_init,
98                         NULL,           /* class finalize */
99                         NULL,           /* class data */
100                         sizeof(ModestFolderWindow),
101                         1,              /* n_preallocs */
102                         (GInstanceInitFunc) modest_folder_window_init,
103                         NULL
104                 };
105                 my_type = g_type_register_static (MODEST_TYPE_WINDOW,
106                                                   "ModestFolderWindow",
107                                                   &my_info, 0);
108         }
109         return my_type;
110 }
111
112 static void
113 modest_folder_window_class_init (ModestFolderWindowClass *klass)
114 {
115         GObjectClass *gobject_class;
116         gobject_class = (GObjectClass*) klass;
117         ModestWindowClass *modest_window_class = (ModestWindowClass *) klass;
118
119         parent_class            = g_type_class_peek_parent (klass);
120         gobject_class->finalize = modest_folder_window_finalize;
121
122         g_type_class_add_private (gobject_class, sizeof(ModestFolderWindowPrivate));
123         
124         modest_window_class->zoom_minus_func = on_zoom_minus_plus_not_implemented;
125         modest_window_class->zoom_plus_func = on_zoom_minus_plus_not_implemented;
126         modest_window_class->disconnect_signals_func = modest_folder_window_disconnect_signals;
127 }
128
129 static void
130 modest_folder_window_init (ModestFolderWindow *obj)
131 {
132         ModestFolderWindowPrivate *priv;
133
134         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(obj);
135
136         priv->sighandlers = NULL;
137         priv->display_state = OSSO_DISPLAY_ON;
138         
139         priv->folder_view = NULL;
140         
141         modest_window_mgr_register_help_id (modest_runtime_get_window_mgr(),
142                                             GTK_WINDOW(obj),
143                                             "applications_email_folderview");
144 }
145
146 static void
147 modest_folder_window_finalize (GObject *obj)
148 {
149         ModestFolderWindowPrivate *priv;
150
151         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(obj);
152
153         /* Sanity check: shouldn't be needed, the window mgr should
154            call this function before */
155         modest_folder_window_disconnect_signals (MODEST_WINDOW (obj));  
156
157         G_OBJECT_CLASS(parent_class)->finalize (obj);
158 }
159
160 static void
161 modest_folder_window_disconnect_signals (ModestWindow *self)
162 {       
163         ModestFolderWindowPrivate *priv;        
164         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
165
166         modest_signal_mgr_disconnect_all_and_destroy (priv->sighandlers);
167         priv->sighandlers = NULL;       
168 }
169
170 static void
171 connect_signals (ModestFolderWindow *self)
172 {       
173         ModestFolderWindowPrivate *priv;
174         
175         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
176
177         /* folder view */
178         priv->sighandlers = modest_signal_mgr_connect (priv->sighandlers, 
179                                                        G_OBJECT (priv->folder_view), "folder-activated", 
180                                                        G_CALLBACK (on_folder_activated), self);
181
182         /* TODO: connect folder view activate */
183         
184         /* window */
185
186         /* we don't register this in sighandlers, as it should be run after disconnecting all signals,
187          * in destroy stage */
188
189         
190 }
191
192 static void 
193 osso_display_event_cb (osso_display_state_t state, 
194                        gpointer data)
195 {
196         ModestFolderWindowPrivate *priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (data);
197
198         priv->display_state = state;
199
200         /* Stop blinking if the screen becomes on */
201         if (priv->display_state == OSSO_DISPLAY_ON)
202                 modest_platform_remove_new_mail_notifications (TRUE);
203 }
204
205 ModestWindow *
206 modest_folder_window_new (TnyFolderStoreQuery *query)
207 {
208         ModestFolderWindow *self = NULL;        
209         ModestFolderWindowPrivate *priv = NULL;
210         HildonProgram *app;
211         GdkPixbuf *window_icon;
212         GtkWidget *pannable;
213         
214         self  = MODEST_FOLDER_WINDOW(g_object_new(MODEST_TYPE_FOLDER_WINDOW, NULL));
215         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE(self);
216         pannable = hildon_pannable_area_new ();
217         priv->folder_view  = modest_platform_create_folder_view (query);
218         modest_folder_view_set_cell_style (MODEST_FOLDER_VIEW (priv->folder_view),
219                                            MODEST_FOLDER_VIEW_CELL_STYLE_COMPACT);
220
221         setup_menu (self);
222
223         /* Set account store */
224         tny_account_store_view_set_account_store (TNY_ACCOUNT_STORE_VIEW (priv->folder_view),
225                                                   TNY_ACCOUNT_STORE (modest_runtime_get_account_store ()));
226
227         gtk_container_add (GTK_CONTAINER (pannable), priv->folder_view);
228         gtk_container_add (GTK_CONTAINER (self), pannable);
229
230         gtk_widget_show (priv->folder_view);
231         gtk_widget_show (pannable);
232
233         connect_signals (MODEST_FOLDER_WINDOW (self));
234
235         /* Load previous osso state, for instance if we are being restored from 
236          * hibernation:  */
237         modest_osso_load_state ();
238
239         /* Get device name */
240         modest_maemo_utils_get_device_name ();
241
242         app = hildon_program_get_instance ();
243         hildon_program_add_window (app, HILDON_WINDOW (self));
244         
245         /* Set window icon */
246         window_icon = modest_platform_get_icon (MODEST_APP_ICON, MODEST_ICON_SIZE_BIG);
247         if (window_icon) {
248                 gtk_window_set_icon (GTK_WINDOW (self), window_icon);
249                 g_object_unref (window_icon);
250         }
251
252         /* Listen for changes in the screen, we don't want to show a
253            led pattern when the display is on for example */
254         osso_hw_set_display_event_cb (modest_maemo_utils_get_osso_context (),
255                                       osso_display_event_cb,
256                                       self); 
257
258         /* Dont't restore settings here, 
259          * because it requires a gtk_widget_show(), 
260          * and we don't want to do that until later,
261          * so that the UI is not visible for non-menu D-Bus activation.
262          */
263
264         return MODEST_WINDOW(self);
265 }
266
267 static gboolean
268 on_zoom_minus_plus_not_implemented (ModestWindow *window)
269 {
270         g_return_val_if_fail (MODEST_IS_FOLDER_WINDOW (window), FALSE);
271
272         hildon_banner_show_information (NULL, NULL, dgettext("hildon-common-strings", "ckct_ib_cannot_zoom_here"));
273         return FALSE;
274
275 }
276
277 gboolean
278 modest_folder_window_screen_is_on (ModestFolderWindow *self)
279 {
280         ModestFolderWindowPrivate *priv = NULL;
281
282         g_return_val_if_fail (MODEST_IS_FOLDER_WINDOW(self), FALSE);
283
284         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
285         
286         return (priv->display_state == OSSO_DISPLAY_ON) ? TRUE : FALSE;
287 }
288
289 ModestFolderView *
290 modest_folder_window_get_folder_view (ModestFolderWindow *self)
291 {
292         ModestFolderWindowPrivate *priv = NULL;
293
294         g_return_val_if_fail (MODEST_IS_FOLDER_WINDOW(self), FALSE);
295
296         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
297         
298         return MODEST_FOLDER_VIEW (priv->folder_view);
299 }
300
301 void
302 modest_folder_window_set_account (ModestFolderWindow *self,
303                                   const gchar *account_name)
304 {
305         ModestFolderWindowPrivate *priv = NULL;
306         ModestAccountMgr *mgr;
307         ModestAccountSettings *settings = NULL;
308         ModestServerAccountSettings *store_settings = NULL;
309
310         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
311
312         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
313         
314         /* Get account data */
315         mgr = modest_runtime_get_account_mgr ();
316
317         settings = modest_account_mgr_load_account_settings (mgr, account_name);
318         if (!settings)
319                 goto free_refs;
320
321         store_settings = modest_account_settings_get_store_settings (settings);
322         if (!store_settings)
323                 goto free_refs;
324
325         modest_folder_view_set_account_id_of_visible_server_account 
326                 (MODEST_FOLDER_VIEW (priv->folder_view),
327                  modest_server_account_settings_get_account_name (store_settings));
328
329         modest_window_set_active_account (MODEST_WINDOW (self), account_name);
330         gtk_window_set_title (GTK_WINDOW (self), 
331                               modest_account_settings_get_display_name (settings));
332
333 free_refs:
334         if (store_settings) 
335                 g_object_unref (store_settings);
336         if (settings)
337                 g_object_unref (settings);
338
339 }
340
341 static void add_to_menu (ModestFolderWindow *self,
342                          HildonAppMenu *menu,
343                          gchar *label,
344                          GCallback callback)
345 {
346         GtkWidget *button;
347
348         button = gtk_button_new_with_label (label);
349         g_signal_connect_after (G_OBJECT (button), "clicked",
350                                 callback, (gpointer) self);
351         hildon_app_menu_append (menu, GTK_BUTTON (button));
352 }
353
354 static void setup_menu (ModestFolderWindow *self)
355 {
356         ModestFolderWindowPrivate *priv = NULL;
357         GtkWidget *app_menu;
358
359         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
360
361         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
362
363         app_menu = hildon_app_menu_new ();
364
365         add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_viewer_newemail"),
366                      G_CALLBACK (modest_ui_actions_on_new_msg));
367         add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_sendandreceive"),
368                      G_CALLBACK (modest_ui_actions_on_send_receive));
369
370         /* Settings menu buttons */
371         add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_options"),
372                      G_CALLBACK (modest_ui_actions_on_settings));
373         add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_accounts"),
374                      G_CALLBACK (modest_ui_actions_on_accounts));
375         add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_globalsmtpservers"),
376                      G_CALLBACK (modest_ui_actions_on_smtp_servers));
377         
378         hildon_stackable_window_set_main_menu (HILDON_STACKABLE_WINDOW (self), 
379                                                HILDON_APP_MENU (app_menu));
380 }
381
382 static void
383 on_folder_activated (ModestFolderView *folder_view,
384                      TnyFolder *folder,
385                      gpointer userdata)
386 {
387         ModestFolderWindowPrivate *priv = NULL;
388         ModestWindow *headerwin;
389         ModestFolderWindow *self = (ModestFolderWindow *) userdata;
390
391         g_return_if_fail (MODEST_IS_FOLDER_WINDOW(self));
392
393         priv = MODEST_FOLDER_WINDOW_GET_PRIVATE (self);
394
395         if (!folder)
396                 return;
397
398         headerwin = modest_header_window_new (folder);
399         modest_window_mgr_register_window (modest_runtime_get_window_mgr (), 
400                                            MODEST_WINDOW (headerwin),
401                                            MODEST_WINDOW (self));
402
403         modest_window_set_active_account (MODEST_WINDOW (headerwin), 
404                                           modest_window_get_active_account (MODEST_WINDOW (self)));
405         gtk_widget_show (GTK_WIDGET (headerwin));
406 }