Add 'yahoo-backend' module.
authorMatthew Barnes <mbarnes@redhat.com>
Fri, 6 Apr 2012 16:41:57 +0000 (12:41 -0400)
committerMatthew Barnes <mbarnes@redhat.com>
Sun, 3 Jun 2012 23:51:10 +0000 (19:51 -0400)
configure.ac
modules/Makefile.am
modules/yahoo-backend/Makefile.am [new file with mode: 0644]
modules/yahoo-backend/module-yahoo-backend.c [new file with mode: 0644]

index 2489184..bc07026 100644 (file)
@@ -1665,6 +1665,7 @@ libedataserverui/libedataserverui.pc
 modules/Makefile
 modules/google-backend/Makefile
 modules/online-accounts/Makefile
+modules/yahoo-backend/Makefile
 private/Makefile
 services/Makefile
 services/evolution-addressbook-factory/Makefile
index 5c84f5b..47a2e70 100644 (file)
@@ -6,6 +6,7 @@ endif
 
 SUBDIRS = \
        google-backend \
+       yahoo-backend \
        $(ONLINE_ACCOUNTS_DIR) \
        $(NULL)
 
diff --git a/modules/yahoo-backend/Makefile.am b/modules/yahoo-backend/Makefile.am
new file mode 100644 (file)
index 0000000..002df0d
--- /dev/null
@@ -0,0 +1,29 @@
+NULL =
+
+module_LTLIBRARIES = module-yahoo-backend.la
+
+module_yahoo_backend_la_CPPFLAGS = \
+       $(AM_CPPFLAGS) \
+       -I$(top_srcdir) \
+       -DG_LOG_DOMAIN=\"module-yahoo-backend\" \
+       $(E_BACKEND_CFLAGS) \
+       $(E_DATA_SERVER_CFLAGS) \
+       $(NULL)
+
+module_yahoo_backend_la_SOURCES = \
+       module-yahoo-backend.c \
+       $(NULL)
+
+module_yahoo_backend_la_LIBADD = \
+       $(top_builddir)/libebackend/libebackend-1.2.la \
+       $(top_builddir)/libedataserver/libedataserver-1.2.la \
+       $(top_builddir)/camel/libcamel-1.2.la \
+       $(E_BACKEND_LIBS) \
+       $(E_DATA_SERVER_LIBS) \
+       $(NULL)
+
+module_yahoo_backend_la_LDFLAGS = \
+       -module -avoid-version $(NO_UNDEFINED) \
+       $(NULL)
+
+-include $(top_srcdir)/git.mk
diff --git a/modules/yahoo-backend/module-yahoo-backend.c b/modules/yahoo-backend/module-yahoo-backend.c
new file mode 100644 (file)
index 0000000..bff98f3
--- /dev/null
@@ -0,0 +1,461 @@
+/*
+ * module-yahoo-backend.c
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+#include <config.h>
+#include <glib/gi18n-lib.h>
+
+#include <libedataserver/e-uid.h>
+#include <libedataserver/e-source-address-book.h>
+#include <libedataserver/e-source-authentication.h>
+#include <libedataserver/e-source-calendar.h>
+#include <libedataserver/e-source-camel.h>
+#include <libedataserver/e-source-collection.h>
+#include <libedataserver/e-source-mail-account.h>
+#include <libedataserver/e-source-mail-identity.h>
+#include <libedataserver/e-source-mail-transport.h>
+#include <libedataserver/e-source-security.h>
+#include <libedataserver/e-source-webdav.h>
+
+#include <libebackend/e-collection-backend.h>
+#include <libebackend/e-collection-backend-factory.h>
+#include <libebackend/e-server-side-source.h>
+#include <libebackend/e-source-registry-server.h>
+
+/* Standard GObject macros */
+#define E_TYPE_YAHOO_BACKEND \
+       (e_yahoo_backend_get_type ())
+#define E_YAHOO_BACKEND(obj) \
+       (G_TYPE_CHECK_INSTANCE_CAST \
+       ((obj), E_TYPE_YAHOO_BACKEND, EYahooBackend))
+
+/* Just for readability... */
+#define METHOD(x) (CAMEL_NETWORK_SECURITY_METHOD_##x)
+
+/* IMAP Configuration Details */
+#define YAHOO_IMAP_BACKEND_NAME                "imapx"
+#define YAHOO_IMAP_HOST                        "imap.mail.yahoo.com"
+#define YAHOO_IMAP_PORT                        993
+#define YAHOO_IMAP_SECURITY_METHOD     METHOD (SSL_ON_ALTERNATE_PORT)
+
+/* SMTP Configuration Details */
+#define YAHOO_SMTP_BACKEND_NAME                "smtp"
+#define YAHOO_SMTP_HOST                        "smtp.mail.yahoo.com"
+#define YAHOO_SMTP_PORT                        465
+#define YAHOO_SMTP_SECURITY_METHOD     METHOD (SSL_ON_ALTERNATE_PORT)
+
+/* Calendar Configuration Details */
+#define YAHOO_CALENDAR_BACKEND_NAME    "caldav"
+#define YAHOO_CALENDAR_HOST            "caldav.calendar.yahoo.com"
+#define YAHOO_CALENDAR_CALDAV_PATH     "/dav/%s/Calendar/%s"
+
+typedef struct _EYahooBackend EYahooBackend;
+typedef struct _EYahooBackendClass EYahooBackendClass;
+
+typedef struct _EYahooBackendFactory EYahooBackendFactory;
+typedef struct _EYahooBackendFactoryClass EYahooBackendFactoryClass;
+
+struct _EYahooBackend {
+       ECollectionBackend parent;
+       GWeakRef mail_identity_source;
+};
+
+struct _EYahooBackendClass {
+       ECollectionBackendClass parent_class;
+};
+
+struct _EYahooBackendFactory {
+       ECollectionBackendFactory parent;
+};
+
+struct _EYahooBackendFactoryClass {
+       ECollectionBackendFactoryClass parent_class;
+};
+
+/* Module Entry Points */
+void e_module_load (GTypeModule *type_module);
+void e_module_unload (GTypeModule *type_module);
+
+/* Forward Declarations */
+GType e_yahoo_backend_get_type (void);
+GType e_yahoo_backend_factory_get_type (void);
+
+G_DEFINE_DYNAMIC_TYPE (
+       EYahooBackend,
+       e_yahoo_backend,
+       E_TYPE_COLLECTION_BACKEND)
+
+G_DEFINE_DYNAMIC_TYPE (
+       EYahooBackendFactory,
+       e_yahoo_backend_factory,
+       E_TYPE_COLLECTION_BACKEND_FACTORY)
+
+static void
+yahoo_backend_config_calendar_child (ECollectionBackend *backend,
+                                     ESource *source)
+{
+       EYahooBackend *yahoo_backend;
+       ESource *collection_source;
+       ESource *mail_identity_source;
+       ESourceExtension *extension;
+       ESourceCollection *collection_extension;
+       const gchar *extension_name;
+       const gchar *identity;
+       gchar *display_name = NULL;
+
+       /* FIXME As a future enhancement, we should query Yahoo!
+        *       for a list of user calendars and add them to the
+        *       collection with matching display names and colors. */
+
+       yahoo_backend = E_YAHOO_BACKEND (backend);
+
+       collection_source = e_backend_get_source (E_BACKEND (backend));
+
+       collection_extension = e_source_get_extension (
+               collection_source, E_SOURCE_EXTENSION_COLLECTION);
+
+       identity = e_source_collection_get_identity (collection_extension);
+
+       /* XXX Assume the calendar's display name can be derived from
+        *     the user's mail identity.  As mentioned above, we should
+        *     really just query Yahoo! for a list of user calendars. */
+       mail_identity_source =
+               g_weak_ref_get (&yahoo_backend->mail_identity_source);
+       if (mail_identity_source != NULL) {
+               extension = e_source_get_extension (
+                       mail_identity_source,
+                       E_SOURCE_EXTENSION_MAIL_IDENTITY);
+               display_name = e_source_mail_identity_dup_name (
+                       E_SOURCE_MAIL_IDENTITY (extension));
+               if (display_name != NULL)
+                       g_strdelimit (display_name, " ", '_');
+               g_object_unref (mail_identity_source);
+       }
+
+       extension_name = E_SOURCE_EXTENSION_AUTHENTICATION;
+       extension = e_source_get_extension (source, extension_name);
+
+       e_source_authentication_set_host (
+               E_SOURCE_AUTHENTICATION (extension),
+               YAHOO_CALENDAR_HOST);
+
+       g_object_bind_property (
+               collection_extension, "identity",
+               extension, "user",
+               G_BINDING_SYNC_CREATE);
+
+       extension_name = E_SOURCE_EXTENSION_SECURITY;
+       extension = e_source_get_extension (source, extension_name);
+
+       e_source_security_set_secure (
+               E_SOURCE_SECURITY (extension), TRUE);
+
+       extension_name = E_SOURCE_EXTENSION_WEBDAV_BACKEND;
+       extension = e_source_get_extension (source, extension_name);
+
+       e_source_webdav_set_display_name (
+               E_SOURCE_WEBDAV (extension), display_name);
+
+       if (identity != NULL && display_name != NULL) {
+               gchar *resource_path;
+
+               resource_path = g_strdup_printf (
+                       YAHOO_CALENDAR_CALDAV_PATH, identity, display_name);
+               e_source_webdav_set_resource_path (
+                       E_SOURCE_WEBDAV (extension), resource_path);
+               g_free (resource_path);
+       }
+
+       g_free (display_name);
+}
+
+static void
+yahoo_backend_add_calendar (ECollectionBackend *backend)
+{
+       ESource *source;
+       ESourceBackend *extension;
+       ESourceRegistryServer *server;
+       const gchar *backend_name;
+       const gchar *extension_name;
+
+       /* XXX We could just stick a [Calendar] and [Task List] extension
+        *     into the same ESource since all other settings are exactly
+        *     the same.  But it might be confusing if tweaking a setting
+        *     in your Yahoo! Calendar also gets applied to your Yahoo!
+        *     Task List in Evolution. */
+
+       backend_name = YAHOO_CALENDAR_BACKEND_NAME;
+
+       server = e_collection_backend_ref_server (backend);
+
+       /* Add Yahoo! Calendar */
+
+       source = e_collection_backend_new_child (backend, "Calendar");
+       e_source_set_display_name (source, _("Calendar"));
+
+       extension_name = E_SOURCE_EXTENSION_CALENDAR;
+       extension = e_source_get_extension (source, extension_name);
+       e_source_backend_set_backend_name (extension, backend_name);
+
+       yahoo_backend_config_calendar_child (backend, source);
+       e_source_registry_server_add_source (server, source);
+
+       g_object_unref (source);
+
+       /* Add Yahoo! Tasks */
+
+       source = e_collection_backend_new_child (backend, "Tasks");
+       e_source_set_display_name (source, _("Tasks"));
+
+       extension_name = E_SOURCE_EXTENSION_TASK_LIST;
+       extension = e_source_get_extension (source, extension_name);
+       e_source_backend_set_backend_name (extension, backend_name);
+
+       yahoo_backend_config_calendar_child (backend, source);
+       e_source_registry_server_add_source (server, source);
+
+       g_object_unref (source);
+
+       g_object_unref (server);
+}
+
+static void
+yahoo_backend_populate (ECollectionBackend *backend)
+{
+       GList *list;
+
+       /* Chain up to parent's populate() method. */
+       E_COLLECTION_BACKEND_CLASS (e_yahoo_backend_parent_class)->
+               populate (backend);
+
+       /* Chain up first so we pick up the mail identity source. */
+       list = e_collection_backend_list_calendar_sources (backend);
+       if (list == NULL)
+               yahoo_backend_add_calendar (backend);
+       g_list_free_full (list, (GDestroyNotify) g_object_unref);
+}
+
+static void
+yahoo_backend_child_added (ECollectionBackend *backend,
+                           ESource *child_source)
+{
+       EYahooBackend *yahoo_backend;
+       ESource *collection_source;
+       const gchar *extension_name;
+       gboolean is_mail = FALSE;
+
+       yahoo_backend = E_YAHOO_BACKEND (backend);
+       collection_source = e_backend_get_source (E_BACKEND (backend));
+
+       extension_name = E_SOURCE_EXTENSION_MAIL_ACCOUNT;
+       is_mail |= e_source_has_extension (child_source, extension_name);
+
+       /* Take special note of the mail identity source.
+        * We need it to build the calendar CalDAV path. */
+       extension_name = E_SOURCE_EXTENSION_MAIL_IDENTITY;
+       if (e_source_has_extension (child_source, extension_name)) {
+               GWeakRef *weak_ref;
+
+               weak_ref = &yahoo_backend->mail_identity_source;
+               g_weak_ref_set (weak_ref, child_source);
+               is_mail = TRUE;
+       }
+
+       extension_name = E_SOURCE_EXTENSION_MAIL_TRANSPORT;
+       is_mail |= e_source_has_extension (child_source, extension_name);
+
+       /* Synchronize mail-related display names with the collection. */
+       if (is_mail)
+               g_object_bind_property (
+                       collection_source, "display-name",
+                       child_source, "display-name",
+                       G_BINDING_SYNC_CREATE);
+
+       /* Synchronize mail-related user with the collection identity. */
+       extension_name = E_SOURCE_EXTENSION_AUTHENTICATION;
+       if (is_mail && e_source_has_extension (child_source, extension_name)) {
+               ESourceAuthentication *auth_child_extension;
+               ESourceCollection *collection_extension;
+
+               extension_name = E_SOURCE_EXTENSION_COLLECTION;
+               collection_extension = e_source_get_extension (
+                       collection_source, extension_name);
+
+               extension_name = E_SOURCE_EXTENSION_AUTHENTICATION;
+               auth_child_extension = e_source_get_extension (
+                       child_source, extension_name);
+
+               g_object_bind_property (
+                       collection_extension, "identity",
+                       auth_child_extension, "user",
+                       G_BINDING_SYNC_CREATE);
+       }
+
+       /* Chain up to parent's child_added() method. */
+       E_COLLECTION_BACKEND_CLASS (e_yahoo_backend_parent_class)->
+               child_added (backend, child_source);
+}
+
+static void
+e_yahoo_backend_class_init (EYahooBackendClass *class)
+{
+       ECollectionBackendClass *backend_class;
+
+       backend_class = E_COLLECTION_BACKEND_CLASS (class);
+       backend_class->populate = yahoo_backend_populate;
+       backend_class->child_added = yahoo_backend_child_added;
+}
+
+static void
+e_yahoo_backend_class_finalize (EYahooBackendClass *class)
+{
+}
+
+static void
+e_yahoo_backend_init (EYahooBackend *backend)
+{
+}
+
+static void
+yahoo_backend_prepare_mail_account_source (ESource *source)
+{
+       ESourceCamel *camel_extension;
+       ESourceExtension *extension;
+       CamelSettings *settings;
+       const gchar *backend_name;
+       const gchar *extension_name;
+
+       backend_name = YAHOO_IMAP_BACKEND_NAME;
+
+       extension_name = E_SOURCE_EXTENSION_MAIL_ACCOUNT;
+       extension = e_source_get_extension (source, extension_name);
+
+       e_source_backend_set_backend_name (
+               E_SOURCE_BACKEND (extension), backend_name);
+
+       extension_name = e_source_camel_get_extension_name (backend_name);
+       camel_extension = e_source_get_extension (source, extension_name);
+       settings = e_source_camel_get_settings (camel_extension);
+
+       /* The "auth-mechanism" should be determined elsewhere. */
+
+       camel_network_settings_set_host (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_IMAP_HOST);
+
+       camel_network_settings_set_port (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_IMAP_PORT);
+
+       camel_network_settings_set_security_method (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_IMAP_SECURITY_METHOD);
+}
+
+static void
+yahoo_backend_prepare_mail_transport_source (ESource *source)
+{
+       ESourceCamel *camel_extension;
+       ESourceExtension *extension;
+       CamelSettings *settings;
+       const gchar *backend_name;
+       const gchar *extension_name;
+
+       /* Configure the mail transport source. */
+
+       backend_name = YAHOO_SMTP_BACKEND_NAME;
+
+       extension_name = E_SOURCE_EXTENSION_MAIL_TRANSPORT;
+       extension = e_source_get_extension (source, extension_name);
+
+       e_source_backend_set_backend_name (
+               E_SOURCE_BACKEND (extension), backend_name);
+
+       extension_name = e_source_camel_get_extension_name (backend_name);
+       camel_extension = e_source_get_extension (source, extension_name);
+       settings = e_source_camel_get_settings (camel_extension);
+
+       /* The "auth-mechanism" should be determined elsewhere. */
+
+       camel_network_settings_set_host (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_SMTP_HOST);
+
+       camel_network_settings_set_port (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_SMTP_PORT);
+
+       camel_network_settings_set_security_method (
+               CAMEL_NETWORK_SETTINGS (settings),
+               YAHOO_SMTP_SECURITY_METHOD);
+}
+
+static void
+yahoo_backend_factory_prepare_mail (ECollectionBackendFactory *factory,
+                                    ESource *mail_account_source,
+                                    ESource *mail_identity_source,
+                                    ESource *mail_transport_source)
+{
+       ECollectionBackendFactoryClass *parent_class;
+
+       /* Chain up to parent's prepare_mail() method. */
+       parent_class =
+               E_COLLECTION_BACKEND_FACTORY_CLASS (
+               e_yahoo_backend_factory_parent_class);
+       parent_class->prepare_mail (
+               factory,
+               mail_account_source,
+               mail_identity_source,
+               mail_transport_source);
+
+       yahoo_backend_prepare_mail_account_source (mail_account_source);
+       yahoo_backend_prepare_mail_transport_source (mail_transport_source);
+}
+
+static void
+e_yahoo_backend_factory_class_init (EYahooBackendFactoryClass *class)
+{
+       ECollectionBackendFactoryClass *factory_class;
+
+       factory_class = E_COLLECTION_BACKEND_FACTORY_CLASS (class);
+       factory_class->factory_name = "yahoo";
+       factory_class->backend_type = E_TYPE_YAHOO_BACKEND;
+       factory_class->prepare_mail = yahoo_backend_factory_prepare_mail;
+}
+
+static void
+e_yahoo_backend_factory_class_finalize (EYahooBackendFactoryClass *class)
+{
+}
+
+static void
+e_yahoo_backend_factory_init (EYahooBackendFactory *factory)
+{
+}
+
+G_MODULE_EXPORT void
+e_module_load (GTypeModule *type_module)
+{
+       e_yahoo_backend_register_type (type_module);
+       e_yahoo_backend_factory_register_type (type_module);
+}
+
+G_MODULE_EXPORT void
+e_module_unload (GTypeModule *type_module)
+{
+}
+