1 /* Copyright (c) 2008, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #include <tny-simple-list.h>
31 #include "modest-account-protocol.h"
32 #include "modest-account-mgr-helpers.h"
33 #include "widgets/modest-default-account-settings-dialog.h"
34 #include "modest-runtime.h"
43 typedef struct _ModestAccountProtocolPrivate ModestAccountProtocolPrivate;
44 struct _ModestAccountProtocolPrivate {
47 TnyList *account_options;
48 GHashTable *custom_auth_mechs;
51 GHashTable *account_dialogs;
54 /* 'private'/'protected' functions */
55 static void modest_account_protocol_class_init (ModestAccountProtocolClass *klass);
56 static void modest_account_protocol_finalize (GObject *obj);
57 static void modest_account_protocol_get_property (GObject *obj,
61 static void modest_account_protocol_set_property (GObject *obj,
65 static void modest_account_protocol_instance_init (ModestAccountProtocol *obj);
67 #define MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), \
68 MODEST_TYPE_ACCOUNT_PROTOCOL, \
69 ModestAccountProtocolPrivate))
71 static TnyAccount *modest_account_protocol_create_account_default (ModestAccountProtocol *self);
73 static ModestAccountSettingsDialog *modest_account_protocol_create_account_settings_dialog_default (ModestAccountProtocol *self);
75 static ModestPairList* modest_account_protocol_get_easysetupwizard_tabs_default (ModestAccountProtocol *self);
77 static void modest_account_protocol_save_settings_default (ModestAccountProtocol *self,
78 ModestAccountSettingsDialog *dialog,
79 ModestAccountSettings *settings);
81 static void modest_account_protocol_save_wizard_settings_default (ModestAccountProtocol *self,
83 ModestAccountSettings *settings);
85 static ModestWizardDialogResponseOverrideFunc
86 modest_account_protocol_get_wizard_response_override_default (ModestAccountProtocol *self);
88 static void modest_account_protocol_check_support_default (ModestAccountProtocol *self,
89 ModestAccountProtocolCheckSupportFunc func,
91 static gboolean modest_account_protocol_is_supported_default (ModestAccountProtocol *self);
92 static gchar *modest_account_protocol_get_from_default (ModestAccountProtocol *self,
93 const gchar *account_id,
94 const gchar *mailbox);
95 static ModestPairList *modest_account_protocol_get_from_list_default (ModestAccountProtocol *self,
96 const gchar *account_id);
97 static gchar *modest_account_protocol_get_signature_default (ModestAccountProtocol *self,
98 const gchar *account_id,
100 gboolean *has_signature);
101 static const GdkPixbuf *modest_account_protocol_get_icon_default (ModestAccountProtocol *self,
102 ModestAccountProtocolIconType icon_type,
108 static GObjectClass *parent_class = NULL;
111 modest_account_protocol_get_type (void)
113 static GType my_type = 0;
116 static const GTypeInfo my_info = {
117 sizeof(ModestAccountProtocolClass),
118 NULL, /* base init */
119 NULL, /* base finalize */
120 (GClassInitFunc) modest_account_protocol_class_init,
121 NULL, /* class finalize */
122 NULL, /* class data */
123 sizeof(ModestAccountProtocol),
125 (GInstanceInitFunc) modest_account_protocol_instance_init,
129 my_type = g_type_register_static (MODEST_TYPE_PROTOCOL,
130 "ModestAccountProtocol",
137 modest_account_protocol_class_init (ModestAccountProtocolClass *klass)
139 GObjectClass *object_class;
140 ModestAccountProtocolClass *account_class;
142 object_class = (GObjectClass *) klass;
143 account_class = MODEST_ACCOUNT_PROTOCOL_CLASS (klass);
144 parent_class = g_type_class_peek_parent (klass);
145 object_class->finalize = modest_account_protocol_finalize;
146 object_class->set_property = modest_account_protocol_set_property;
147 object_class->get_property = modest_account_protocol_get_property;
149 g_object_class_install_property (object_class,
151 g_param_spec_uint ("port",
153 _("The standard port for the protocol"),
155 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT));
157 g_object_class_install_property (object_class,
159 g_param_spec_uint ("alternate-port",
161 _("The alternate port for the protocol (usually used in SSL)"),
163 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT));
165 g_object_class_install_property (object_class,
167 g_param_spec_gtype ("account-g-type",
168 _("Account factory GType"),
169 _("Account factory GType used for creating new instances."),
171 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT));
173 g_type_class_add_private (object_class,
174 sizeof(ModestAccountProtocolPrivate));
176 /* Virtual methods */
177 account_class->create_account_settings_dialog =
178 modest_account_protocol_create_account_settings_dialog_default;
179 account_class->get_easysetupwizard_tabs =
180 modest_account_protocol_get_easysetupwizard_tabs_default;
181 account_class->save_settings =
182 modest_account_protocol_save_settings_default;
183 account_class->save_wizard_settings =
184 modest_account_protocol_save_wizard_settings_default;
185 account_class->create_account =
186 modest_account_protocol_create_account_default;
187 account_class->get_wizard_response_override =
188 modest_account_protocol_get_wizard_response_override_default;
189 account_class->is_supported =
190 modest_account_protocol_is_supported_default;
191 account_class->check_support =
192 modest_account_protocol_check_support_default;
193 account_class->get_from =
194 modest_account_protocol_get_from_default;
195 account_class->get_from_list =
196 modest_account_protocol_get_from_list_default;
197 account_class->get_signature =
198 modest_account_protocol_get_signature_default;
199 account_class->get_icon =
200 modest_account_protocol_get_icon_default;
204 modest_account_protocol_instance_init (ModestAccountProtocol *obj)
206 ModestAccountProtocolPrivate *priv;
208 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (obj);
211 priv->alternate_port = 0;
212 priv->account_g_type = 0;
213 priv->account_options = tny_simple_list_new ();
214 priv->custom_auth_mechs = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, g_free);
216 priv->account_dialogs = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
220 remove_account (const gchar *account_name, GObject *account, GObject *account_to_remove)
222 return (account == account_to_remove);
226 account_dialog_weak_handler (ModestAccountProtocol *self, GObject *where_the_object_was)
228 ModestAccountProtocolPrivate *priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
230 g_hash_table_foreach_remove (priv->account_dialogs, (GHRFunc) remove_account, where_the_object_was);
234 dialogs_remove (const gchar *account_name, GObject *account_dialog, ModestAccountProtocol *self)
236 g_object_weak_unref (account_dialog, (GWeakNotify) account_dialog_weak_handler, self);
242 modest_account_protocol_finalize (GObject *obj)
244 ModestAccountProtocol *protocol = MODEST_ACCOUNT_PROTOCOL (obj);
245 ModestAccountProtocolPrivate *priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (protocol);
247 if (priv->account_dialogs) {
248 g_hash_table_foreach_remove (priv->account_dialogs, (GHRFunc) dialogs_remove, obj);
249 g_hash_table_destroy (priv->account_dialogs);
252 if (priv->account_options)
253 g_object_unref (priv->account_options);
254 priv->account_options = NULL;
256 if (priv->custom_auth_mechs)
257 g_hash_table_destroy (priv->custom_auth_mechs);
258 priv->custom_auth_mechs = NULL;
260 G_OBJECT_CLASS (parent_class)->finalize (obj);
264 modest_account_protocol_get_property (GObject *obj,
269 ModestAccountProtocol *protocol = MODEST_ACCOUNT_PROTOCOL (obj);
270 ModestAccountProtocolPrivate *priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (protocol);
272 switch (property_id) {
274 g_value_set_uint (value, priv->port);
276 case PROP_ALTERNATE_PORT:
277 g_value_set_uint (value, priv->alternate_port);
279 case PROP_ACCOUNT_G_TYPE:
280 g_value_set_gtype (value, priv->account_g_type);
283 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
289 modest_account_protocol_set_property (GObject *obj,
294 ModestAccountProtocol *protocol = MODEST_ACCOUNT_PROTOCOL (obj);
296 switch (property_id) {
298 modest_account_protocol_set_port (protocol, g_value_get_uint (value));
300 case PROP_ALTERNATE_PORT:
301 modest_account_protocol_set_alternate_port (protocol, g_value_get_uint (value));
303 case PROP_ACCOUNT_G_TYPE:
304 modest_account_protocol_set_account_g_type (protocol, g_value_get_gtype (value));
307 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
314 modest_account_protocol_new (const gchar *name, const gchar *display_name,
315 guint port, guint alternate_port,
316 GType account_g_type)
318 return g_object_new (MODEST_TYPE_ACCOUNT_PROTOCOL,
319 "display-name", display_name, "name", name,
320 "port", port, "alternate-port", alternate_port,
321 "account-g-type", account_g_type,
326 modest_account_protocol_get_port (ModestAccountProtocol *self)
328 ModestAccountProtocolPrivate *priv;
330 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), 0);
332 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
337 modest_account_protocol_set_port (ModestAccountProtocol *self,
340 ModestAccountProtocolPrivate *priv;
342 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
344 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
350 modest_account_protocol_get_alternate_port (ModestAccountProtocol *self)
352 ModestAccountProtocolPrivate *priv;
354 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), 0);
356 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
357 return priv->alternate_port;
361 modest_account_protocol_set_alternate_port (ModestAccountProtocol *self,
362 guint alternate_port)
364 ModestAccountProtocolPrivate *priv;
366 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
368 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
369 priv->alternate_port = alternate_port;
373 modest_account_protocol_get_account_g_type (ModestAccountProtocol *self)
375 ModestAccountProtocolPrivate *priv;
377 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), 0);
379 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
380 return priv->account_g_type;
384 modest_account_protocol_get_account_options (ModestAccountProtocol *self)
387 ModestAccountProtocolPrivate *priv;
389 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
390 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
392 result = tny_list_copy (priv->account_options);
398 modest_account_protocol_set_account_options (ModestAccountProtocol *self,
401 ModestAccountProtocolPrivate *priv;
403 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
404 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
406 if (priv->account_options) {
407 g_object_unref (priv->account_options);
408 priv->account_options = NULL;
410 priv->account_options = tny_list_copy (list);
414 modest_account_protocol_has_custom_secure_auth_mech (ModestAccountProtocol *self,
415 ModestProtocolType auth_protocol_type)
417 ModestAccountProtocolPrivate *priv;
419 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), FALSE);
420 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
422 return g_hash_table_lookup_extended (priv->custom_auth_mechs, GINT_TO_POINTER (auth_protocol_type), NULL, NULL);
426 modest_account_protocol_get_custom_secure_auth_mech (ModestAccountProtocol *self,
427 ModestProtocolType auth_protocol_type)
429 ModestAccountProtocolPrivate *priv;
431 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
432 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
434 return (const gchar *) g_hash_table_lookup (priv->custom_auth_mechs, GINT_TO_POINTER (auth_protocol_type));
438 modest_account_protocol_set_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type, const gchar *secure_auth_mech)
440 ModestAccountProtocolPrivate *priv;
442 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
443 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
445 g_hash_table_replace (priv->custom_auth_mechs, GINT_TO_POINTER (auth_protocol_type), g_strdup (secure_auth_mech));
449 modest_account_protocol_unset_custom_secure_auth_mech (ModestAccountProtocol *self, ModestProtocolType auth_protocol_type)
451 ModestAccountProtocolPrivate *priv;
453 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
454 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
456 g_hash_table_remove (priv->custom_auth_mechs, GINT_TO_POINTER (auth_protocol_type));
461 modest_account_protocol_set_account_g_type (ModestAccountProtocol *self,
462 GType account_g_type)
464 ModestAccountProtocolPrivate *priv;
466 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
468 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
469 priv->account_g_type = account_g_type;
473 modest_account_protocol_create_account_default (ModestAccountProtocol *self)
475 ModestAccountProtocolPrivate *priv;
477 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
479 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
480 if (priv->account_g_type > 0) {
481 return g_object_new (priv->account_g_type, NULL);
488 modest_account_protocol_create_account (ModestAccountProtocol *self)
490 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
492 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->create_account (self);
495 /* This is a template method for getting the account settings
496 dialog. It calls create_account_settings that must be implemented
497 by subclasses and then perform several common operations with the
499 ModestAccountSettingsDialog *
500 modest_account_protocol_get_account_settings_dialog (ModestAccountProtocol *self,
501 const gchar *account_name)
503 ModestAccountSettingsDialog *dialog;
504 ModestAccountSettings *settings;
505 ModestAccountProtocolPrivate *priv;
507 priv = MODEST_ACCOUNT_PROTOCOL_GET_PRIVATE (self);
508 dialog = g_hash_table_lookup (priv->account_dialogs, account_name);
510 if (dialog == NULL) {
512 dialog = MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->create_account_settings_dialog (self);
515 settings = modest_account_mgr_load_account_settings (modest_runtime_get_account_mgr (),
517 modest_account_settings_dialog_load_settings (dialog, settings);
519 /* Close dialog on response */
520 g_signal_connect_swapped (dialog,
522 G_CALLBACK (gtk_widget_destroy),
525 g_hash_table_insert (priv->account_dialogs, g_strdup (account_name), dialog);
526 g_object_weak_ref (G_OBJECT (dialog), (GWeakNotify) account_dialog_weak_handler, self);
533 modest_account_protocol_get_easysetupwizard_tabs (ModestAccountProtocol *self)
535 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_easysetupwizard_tabs (self);
540 modest_account_protocol_save_settings (ModestAccountProtocol *self,
541 ModestAccountSettingsDialog *dialog,
542 ModestAccountSettings *settings)
544 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->save_settings (self, dialog, settings);
548 modest_account_protocol_save_wizard_settings (ModestAccountProtocol *self,
550 ModestAccountSettings *settings)
552 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->save_wizard_settings (self, wizard_pages, settings);
555 /* Default implementations */
556 static ModestAccountSettingsDialog *
557 modest_account_protocol_create_account_settings_dialog_default (ModestAccountProtocol *self)
559 return modest_default_account_settings_dialog_new ();
562 static ModestPairList*
563 modest_account_protocol_get_easysetupwizard_tabs_default (ModestAccountProtocol *self)
565 g_warning ("You must implement get_easysetupwizard_tabs");
570 modest_account_protocol_save_settings_default (ModestAccountProtocol *self,
571 ModestAccountSettingsDialog *dialog,
572 ModestAccountSettings *settings)
574 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
575 g_return_if_fail (MODEST_IS_ACCOUNT_SETTINGS_DIALOG (dialog));
576 g_return_if_fail (MODEST_IS_ACCOUNT_SETTINGS (settings));
578 g_warning ("You must implement save_settings");
582 modest_account_protocol_save_wizard_settings_default (ModestAccountProtocol *self,
584 ModestAccountSettings *settings)
586 g_return_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self));
587 g_return_if_fail (wizard_pages);
588 g_return_if_fail (MODEST_IS_ACCOUNT_SETTINGS (settings));
590 g_warning ("You must implement save_wizard_settings");
593 static ModestWizardDialogResponseOverrideFunc
594 modest_account_protocol_get_wizard_response_override_default (ModestAccountProtocol *self)
596 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
601 ModestWizardDialogResponseOverrideFunc
602 modest_account_protocol_get_wizard_response_override (ModestAccountProtocol *self)
604 g_return_val_if_fail (MODEST_IS_ACCOUNT_PROTOCOL (self), NULL);
606 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_wizard_response_override (self);
610 modest_account_protocol_is_supported_default (ModestAccountProtocol *self)
616 modest_account_protocol_is_supported (ModestAccountProtocol *self)
618 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->is_supported (self);
622 modest_account_protocol_check_support_default (ModestAccountProtocol *self,
623 ModestAccountProtocolCheckSupportFunc func,
627 func (self, TRUE, userdata);
631 modest_account_protocol_check_support (ModestAccountProtocol *self,
632 ModestAccountProtocolCheckSupportFunc func,
635 MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->check_support (self, func, userdata);
639 modest_account_protocol_get_from (ModestAccountProtocol *self,
640 const gchar *account_id,
641 const gchar *mailbox)
643 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_from (self, account_id, mailbox);
646 modest_account_protocol_get_from_default (ModestAccountProtocol *self,
647 const gchar *account_id,
648 const gchar *mailbox)
650 g_return_val_if_fail (MODEST_ACCOUNT_PROTOCOL (self), NULL);
656 modest_account_protocol_get_from_list (ModestAccountProtocol *self,
657 const gchar *account_id)
659 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_from_list (self, account_id);
661 static ModestPairList *
662 modest_account_protocol_get_from_list_default (ModestAccountProtocol *self,
663 const gchar *account_id)
665 g_return_val_if_fail (MODEST_ACCOUNT_PROTOCOL (self), NULL);
671 modest_account_protocol_get_signature (ModestAccountProtocol *self,
672 const gchar *account_id,
673 const gchar *mailbox,
674 gboolean *has_signature)
676 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_signature (self, account_id, mailbox, has_signature);
680 modest_account_protocol_get_signature_default (ModestAccountProtocol *self,
681 const gchar *account_id,
682 const gchar *mailbox,
683 gboolean *has_signature)
685 g_return_val_if_fail (MODEST_ACCOUNT_PROTOCOL (self), NULL);
687 *has_signature = FALSE;
693 modest_account_protocol_get_icon (ModestAccountProtocol *self,
694 ModestAccountProtocolIconType icon_type,
698 return MODEST_ACCOUNT_PROTOCOL_GET_CLASS (self)->get_icon (self, icon_type, object, icon_size);
701 static const GdkPixbuf *
702 modest_account_protocol_get_icon_default (ModestAccountProtocol *self, ModestAccountProtocolIconType icon_type,
703 GObject *object, guint icon_size)
705 g_return_val_if_fail (MODEST_ACCOUNT_PROTOCOL (self), NULL);