Changeset 3637

Timestamp:

09/05/08 06:27:32 (3 months ago)

Author:

prahal

Message:

Upgrade of the evolution2 plugin to new API for sinks. And fix for long standing segfault
at unload (by use of "dont_free" symbol visible to opensync module loader).

Location:

plugins/evolution2/src

Files:

• evo2-sync (modified) (1 diff)
• evo2-sync.xsd (deleted)
• evolution2_ebook.c (modified) (3 diffs)
• evolution2_ecal.c (modified) (3 diffs)
• evolution2_etodo.c (modified) (3 diffs)
• evolution2_memo.c (modified) (3 diffs)
• evolution2_sync.c (modified) (9 diffs)
• evolution2_sync.h (modified) (1 diff)

plugins/evolution2/src/evo2-sync

@@ -1 +1 @@
 <?xml version="1.0"?>
-<config>
-  <address_path>default</address_path>
-  <calendar_path>default</calendar_path>
-  <memos_path>default</memos_path>
-  <tasks_path>default</tasks_path>
+<config version="1.0">
+  <Resources>
+    <Resource>
+      <Enabled>1</Enabled>
+      <Formats>
+        <Format>
+          <Config>VCARD_EXTENSION=Evolution</Config>
+          <Name>vcard21</Name>
+        </Format>
+        <Format>
+          <Config>VCARD_EXTENSION=Evolution</Config>
+          <Name>vcard30</Name>
+        </Format>
+      </Formats>
+      <ObjType>contact</ObjType>
+      <Url>default</Url> 
+    </Resource>
+    <Resource>
+      <Enabled>1</Enabled>
+      <Formats>
+        <Format>
+          <Name>vevent20</Name>
+        </Format>
+      </Formats>
+      <ObjType>event</ObjType>
+      <Url>default</Url> 
+    </Resource>
+    <Resource>
+      <Enabled>1</Enabled>
+      <Formats>
+        <Format>
+          <Name>vtodo20</Name>
+        </Format>
+      </Formats>
+      <ObjType>todo</ObjType>
+      <Url>default</Url> 
+    </Resource>
+    <Resource>
+      <Enabled>1</Enabled>
+      <Formats>
+        <Format>
+          <Name>vjournal</Name>
+        </Format>
+      </Formats>
+      <ObjType>note</ObjType>
+      <Url>default</Url> 
+    </Resource>
+  </Resources>
 </config>

plugins/evolution2/src/evolution2_ebook.c

@@ -43 +43 @@
                 }
                 
-                if (!(source = evo2_find_source(sources, env->addressbook_path))) {
+                if (!(source = evo2_find_source(sources, g_strdup(env->addressbook_path)))) {
                         osync_error_set(&error, OSYNC_ERROR_GENERIC, "Error finding source \"%s\"", env->addressbook_path);
                         goto error;
@@ -302 +302 @@
 }
 
+
 osync_bool evo2_ebook_initialize(OSyncEvoEnv *env, OSyncPluginInfo *info, OSyncError **error)
 {
-        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
-        env->contact_format = osync_format_env_find_objformat(formatenv, "vcard30");
-        if (!env->contact_format) {
-                osync_error_set(error, OSYNC_ERROR_GENERIC, "Unable to find vcard30 object format. vformat plugin installed?");
+        OSyncObjTypeSink *sink = osync_plugin_info_find_objtype(info, "contact");
+        if (!sink)
                 return FALSE;
-        }
-        osync_objformat_set_config(env->contact_format, "VCARD_EXTENSION=Evolution");
-        
-        
-        env->contact_sink = osync_objtype_sink_new("contact", error);
-        if (!env->contact_sink)
+        osync_bool sinkEnabled = osync_objtype_sink_is_enabled(sink);
+        osync_trace(TRACE_INTERNAL, "%s: enabled => %d", __func__, sinkEnabled);
+        if (!sinkEnabled)
                 return FALSE;
         
-        osync_objtype_sink_add_objformat_with_config(env->contact_sink, "vcard30", "VCARD_EXTENSION=Evolution");
-        osync_objtype_sink_add_objformat_with_config(env->contact_sink, "vcard21", "VCARD_EXTENSION=Evolution");
-        
-        /* All sinks have the same functions of course */
         OSyncObjTypeSinkFunctions functions;
         memset(&functions, 0, sizeof(functions));
@@ -328 +320 @@
         functions.commit = evo2_ebook_modify;
         functions.sync_done = evo2_ebook_sync_done;
-        
-        /* We pass the OSyncFileDir object to the sink, so we dont have to look it up
-         * again once the functions are called */
-        osync_objtype_sink_set_functions(env->contact_sink, functions, NULL);
-        osync_plugin_info_add_objtype(info, env->contact_sink);
+
+        OSyncPluginConfig *config = osync_plugin_info_get_config(info);
+        OSyncPluginResource *resource = osync_plugin_config_find_active_resource(config, "contact");
+        env->addressbook_path = osync_plugin_resource_get_url(resource);
+        if(!env->addressbook_path) {
+                osync_error_set(error,OSYNC_ERROR_GENERIC, "Addressbook url not set");
+                return FALSE;
+        }
+        OSyncList *objformatsinks = osync_plugin_resource_get_objformat_sinks(resource);
+        osync_bool hasObjFormat = FALSE;
+        OSyncList *r;
+        for(r = objformatsinks;r;r = r->next) {
+                OSyncObjFormatSink *objformatsink = r->data;
+                if(!strcmp("vcard30", osync_objformat_sink_get_objformat(objformatsink))) { hasObjFormat = TRUE; break;}
+        }
+        if (!hasObjFormat) {
+                osync_error_set(error, OSYNC_ERROR_GENERIC, "Format vcard30 not set.");
+                return FALSE;
+        }
+
+        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
+        env->contact_format = osync_format_env_find_objformat(formatenv, "vcard30");
+
+        env->contact_sink = sink;
+
+        osync_objtype_sink_set_functions(sink, functions, NULL);
         return TRUE;
 }
+

plugins/evolution2/src/evolution2_ecal.c

@@ -43 +43 @@
                 }
                 
-                if (!(source = evo2_find_source(sources, env->calendar_path))) {
+                if (!(source = evo2_find_source(sources, g_strdup(env->calendar_path)))) {
                         osync_error_set(&error, OSYNC_ERROR_GENERIC, "Error finding source \"%s\"", env->calendar_path);
                         goto error;
@@ -311 +311 @@
 osync_bool evo2_ecal_initialize(OSyncEvoEnv *env, OSyncPluginInfo *info, OSyncError **error)
 {
-        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
-        env->calendar_format = osync_format_env_find_objformat(formatenv, "vevent20");
-
-        if (!env->calendar_format) {
-                osync_error_set(error, OSYNC_ERROR_GENERIC, "Unable to find vevent20 object format. vformat plugin installed?");
+        OSyncObjTypeSink *sink = osync_plugin_info_find_objtype(info, "event");
+        if (!sink)
                 return FALSE;
-        }
-
-
-        env->calendar_sink = osync_objtype_sink_new("event", error);
-        if (!env->calendar_sink){
-                printf("calendar sink failed to initialize\n");
+        osync_bool sinkEnabled = osync_objtype_sink_is_enabled(sink);
+        osync_trace(TRACE_INTERNAL, "%s: enabled => %d", __func__, sinkEnabled);
+        if (!sinkEnabled)
                 return FALSE;
-        }
-
-        osync_objtype_sink_add_objformat(env->calendar_sink, "vevent20");
-
-        /* All sinks have the same functions of course */
+
         OSyncObjTypeSinkFunctions functions;
         memset(&functions, 0, sizeof(functions));
@@ -337 +327 @@
         functions.sync_done = evo2_ecal_sync_done;
 
-        /* We pass the OSyncFileDir object to the sink, so we dont have to look it up
-         * again once the functions are called */
+        OSyncPluginConfig *config = osync_plugin_info_get_config(info);
+        OSyncPluginResource *resource = osync_plugin_config_find_active_resource(config, "event");
+        env->calendar_path = osync_plugin_resource_get_url(resource);
+        if(!env->calendar_path) {
+                osync_error_set(error,OSYNC_ERROR_GENERIC, "Calendar url not set");
+                return FALSE;
+        }
+        OSyncList *objformatsinks = osync_plugin_resource_get_objformat_sinks(resource);
+        osync_bool hasObjFormat = FALSE;
+        OSyncList *r;
+        for(r = objformatsinks;r;r = r->next) {
+                OSyncObjFormatSink *objformatsink = r->data;
+                if(!strcmp("vevent20", osync_objformat_sink_get_objformat(objformatsink))) { hasObjFormat = TRUE; break;}
+        }
+        if (!hasObjFormat) {
+                osync_error_set(error, OSYNC_ERROR_GENERIC, "Format vevent20 not set.");
+                return FALSE;
+        }
+
+        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
+        env->calendar_format = osync_format_env_find_objformat(formatenv, "vevent20");
+
+        env->calendar_sink = sink;
+
         osync_objtype_sink_set_functions(env->calendar_sink, functions, NULL);
-        osync_plugin_info_add_objtype(info, env->calendar_sink);
         return TRUE;
 }

plugins/evolution2/src/evolution2_etodo.c

@@ -43 +43 @@
                 }
                 
-                if (!(source = evo2_find_source(sources, env->tasks_path))) {
+                if (!(source = evo2_find_source(sources, g_strdup(env->tasks_path)))) {
                         osync_error_set(&error, OSYNC_ERROR_GENERIC, "Error finding source \"%s\"", env->tasks_path);
                         goto error;
@@ -311 +311 @@
 osync_bool evo2_etodo_initialize(OSyncEvoEnv *env, OSyncPluginInfo *info, OSyncError **error)
 {
-        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
-        env->tasks_format = osync_format_env_find_objformat(formatenv, "vtodo20");
-
-        if (!env->tasks_format) {
-                osync_error_set(error, OSYNC_ERROR_GENERIC, "Unable to find vtodo20 object format. vformat plugin installed?");
+        OSyncObjTypeSink *sink = osync_plugin_info_find_objtype(info, "todo");
+        if (!sink)
                 return FALSE;
-        }
-
-
-        env->tasks_sink = osync_objtype_sink_new("todo", error);
-        if (!env->tasks_sink){
-                printf("tasks sink failed to initialize\n");
+        osync_bool sinkEnabled = osync_objtype_sink_is_enabled(sink);
+        osync_trace(TRACE_INTERNAL, "%s: enabled => %d", __func__, sinkEnabled);
+        if (!sinkEnabled)
                 return FALSE;
-        }
-
-        osync_objtype_sink_add_objformat(env->tasks_sink, "vtodo20");
-
-        /* All sinks have the same functions of course */
+
         OSyncObjTypeSinkFunctions functions;
         memset(&functions, 0, sizeof(functions));
@@ -337 +327 @@
         functions.sync_done = evo2_etodo_sync_done;
 
-        /* We pass the OSyncFileDir object to the sink, so we dont have to look it up
-         * again once the functions are called */
+        OSyncPluginConfig *config = osync_plugin_info_get_config(info);
+        OSyncPluginResource *resource = osync_plugin_config_find_active_resource(config, "todo");
+        env->tasks_path = osync_plugin_resource_get_url(resource);
+        if(!env->tasks_path) {
+                osync_error_set(error,OSYNC_ERROR_GENERIC, "Tasks url not set");
+                return FALSE;
+        }
+        OSyncList *objformatsinks = osync_plugin_resource_get_objformat_sinks(resource);
+        osync_bool hasObjFormat = FALSE;
+        OSyncList *r;
+        for(r = objformatsinks;r;r = r->next) {
+                OSyncObjFormatSink *objformatsink = r->data;
+                if(!strcmp("vtodo20", osync_objformat_sink_get_objformat(objformatsink))) { hasObjFormat = TRUE; break;}
+        }
+        if (!hasObjFormat) {
+                osync_error_set(error, OSYNC_ERROR_GENERIC, "Format vtodo20 not set.");
+                return FALSE;
+        }
+
+        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
+        env->tasks_format = osync_format_env_find_objformat(formatenv, "vtodo20");
+
+        env->tasks_sink = sink;
+
         osync_objtype_sink_set_functions(env->tasks_sink, functions, NULL);
-        osync_plugin_info_add_objtype(info, env->tasks_sink);
         return TRUE;
 }

plugins/evolution2/src/evolution2_memo.c

@@ -43 +43 @@
                 }
                 
-                if (!(source = evo2_find_source(sources, env->memos_path))) {
+                if (!(source = evo2_find_source(sources, g_strdup(env->memos_path)))) {
                         osync_error_set(&error, OSYNC_ERROR_GENERIC, "Error finding source \"%s\"", env->memos_path);
                         goto error;
@@ -311 +311 @@
 osync_bool evo2_memo_initialize(OSyncEvoEnv *env, OSyncPluginInfo *info, OSyncError **error)
 {
-        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
-        env->memos_format = osync_format_env_find_objformat(formatenv, "vjournal");
-
-        if (!env->memos_format) {
-                osync_error_set(error, OSYNC_ERROR_GENERIC, "Unable to find vjournal object format. vformat plugin installed?");
+        OSyncObjTypeSink *sink = osync_plugin_info_find_objtype(info, "note");
+        if (!sink)
                 return FALSE;
-        }
-
-
-        env->memos_sink = osync_objtype_sink_new("note", error);
-        if (!env->memos_sink){
-                printf("memos sink failed to initialize\n");
+        osync_bool sinkEnabled = osync_objtype_sink_is_enabled(sink);
+        osync_trace(TRACE_INTERNAL, "%s: enabled => %d", __func__, sinkEnabled);
+        if (!sinkEnabled)
                 return FALSE;
-        }
-
-        osync_objtype_sink_add_objformat(env->memos_sink, "vjournal");
-
-        /* All sinks have the same functions of course */
+
         OSyncObjTypeSinkFunctions functions;
         memset(&functions, 0, sizeof(functions));
@@ -337 +327 @@
         functions.sync_done = evo2_memo_sync_done;
 
-        /* We pass the OSyncFileDir object to the sink, so we dont have to look it up
-         * again once the functions are called */
+        OSyncPluginConfig *config = osync_plugin_info_get_config(info);
+        OSyncPluginResource *resource = osync_plugin_config_find_active_resource(config, "note");
+        env->memos_path = osync_plugin_resource_get_url(resource);
+        if(!env->memos_path) {
+                osync_error_set(error,OSYNC_ERROR_GENERIC, "Memo url not set");
+                return FALSE;
+        }
+        OSyncList *objformatsinks = osync_plugin_resource_get_objformat_sinks(resource);
+        osync_bool hasObjFormat = FALSE;
+        OSyncList *r;
+        for(r = objformatsinks;r;r = r->next) {
+                OSyncObjFormatSink *objformatsink = r->data;
+                if(!strcmp("vjournal", osync_objformat_sink_get_objformat(objformatsink))) { hasObjFormat = TRUE; break;}
+        }
+        if (!hasObjFormat) {
+                osync_error_set(error, OSYNC_ERROR_GENERIC, "Format vjournal not set.");
+                return FALSE;
+        }
+
+        OSyncFormatEnv *formatenv = osync_plugin_info_get_format_env(info);
+        env->memos_format = osync_format_env_find_objformat(formatenv, "vjournal");
+
+        env->memos_sink = sink;
+
         osync_objtype_sink_set_functions(env->memos_sink, functions, NULL);
-        osync_plugin_info_add_objtype(info, env->memos_sink);
         return TRUE;
 }

plugins/evolution2/src/evolution2_sync.c

@@ -24 +24 @@
 static void free_env(OSyncEvoEnv *env)
 {
-        if (env->addressbook_path)
-                g_free(env->addressbook_path);
-                
-        if (env->calendar_path)
-                g_free(env->calendar_path);
-                
-        if (env->tasks_path)
-                g_free(env->tasks_path);
-
         if (env->contact_sink)
                 osync_objtype_sink_unref(env->contact_sink);
@@ -197 +188 @@
 }
 
-/*Load the state from a xml file and return it in the conn struct*/
-static osync_bool evo2_parse_settings(OSyncEvoEnv *env, const char *data, OSyncError **error)
-{
-        xmlDocPtr doc;
-        xmlNodePtr cur;
-
-        //set defaults
-        env->addressbook_path = NULL;
-        env->calendar_path = NULL;
-        env->memos_path = NULL;
-        env->tasks_path = NULL;
-
-        doc = xmlParseMemory(data, strlen(data));
-
-        if (!doc) 
-                return FALSE;
-        
-
-        cur = xmlDocGetRootElement(doc);
-
-        if (!cur) {
-                xmlFreeDoc(doc);
-                return FALSE;
-        }
-
-        if (xmlStrcmp(cur->name, (xmlChar*)"config")) {
-                xmlFreeDoc(doc);
-                return FALSE;
-        }
-
-        cur = cur->xmlChildrenNode;
-
-        while (cur != NULL) {
-                char *str = (char*)xmlNodeGetContent(cur);
-                if (str) {
-                        if (!xmlStrcmp(cur->name, (const xmlChar *)"address_path")) {
-                                env->addressbook_path = g_strdup(str);
-                        }
-                        if (!xmlStrcmp(cur->name, (const xmlChar *)"calendar_path")) {
-                                env->calendar_path = g_strdup(str);
-                        }
-                        if (!xmlStrcmp(cur->name, (const xmlChar *)"memos_path")) {
-                                env->memos_path = g_strdup(str);        
-                        }
-                        if (!xmlStrcmp(cur->name, (const xmlChar *)"tasks_path")) {
-                                env->tasks_path = g_strdup(str);        
-                        }
-                        xmlFree(str);
-                }
-                cur = cur->next;
-        }
-
-        xmlFreeDoc(doc);
-        return TRUE;
-}
-
 /* In initialize, we get the config for the plugin. Here we also must register
  * all _possible_ objtype sinks. */
@@ -262 +197 @@
         if (!env)
                 goto error;
+
+        env->pluginInfo = info;
                 
         osync_trace(TRACE_INTERNAL, "Setting change id: %s", osync_plugin_info_get_groupname(info));
@@ -267 +204 @@
         env->change_id = g_strdup(osync_plugin_info_get_groupname(info));
         
-        osync_trace(TRACE_INTERNAL, "The config: %s", osync_plugin_info_get_config(info));
-        
-        if (!evo2_parse_settings(env, osync_plugin_info_get_config(info), error))
-                goto error_free_env;
+        osync_trace(TRACE_INTERNAL, "The config: %p", osync_plugin_info_get_config(info));
         
         if (!evo2_ebook_initialize(env, info, error))
                 goto error_free_env;
-        
+
         if (!evo2_ecal_initialize(env, info, error))
                 goto error_free_env;
@@ -299 +233 @@
         OSyncEvoEnv *env = data;
 
-        if (env->contact_sink)
-                osync_objtype_sink_unref(env->contact_sink);
-
-        if (env->calendar_sink)
-                osync_objtype_sink_unref(env->calendar_sink);
-
-        if (env->memos_sink)
-                osync_objtype_sink_unref(env->memos_sink);
-
-        if (env->tasks_sink)
-                osync_objtype_sink_unref(env->tasks_sink);
-
+        /* cleanup OpenSync stuff */
+        if (env->pluginInfo) {
+                osync_plugin_info_unref(env->pluginInfo);
+                env->pluginInfo = NULL;
+        }
+        osync_trace(TRACE_INTERNAL, "%s - plugin info cleaned", __func__);
+
+        /* Final cleanup */
         free_env(env);
         osync_trace(TRACE_EXIT, "%s", __func__);
@@ -321 +251 @@
         osync_trace(TRACE_ENTRY, "%s(%p, %p, %p)", __func__, data, info, error);
         
+/*
         GError* gerror = NULL;
         GList* fields = NULL;
         OSyncEvoEnv *env = (OSyncEvoEnv *)data;
-        
-        if (env->addressbook_path)
-                osync_objtype_sink_set_available(env->contact_sink, TRUE);
-        
-        if (env->calendar_path)
-                osync_objtype_sink_set_available(env->calendar_sink, TRUE);
-        
-        if (env->memos_path)
-                osync_objtype_sink_set_available(env->memos_sink, TRUE);
-        
-        if (env->tasks_path)
-                osync_objtype_sink_set_available(env->tasks_sink, TRUE);
-        
+*/      
+        int i, numobjs = osync_plugin_info_num_objtypes(info);
+        for (i = 0; i < numobjs; i++) {
+                OSyncObjTypeSink *sink = osync_plugin_info_nth_objtype(info, i);
+                g_assert(sink);
+
+                osync_objtype_sink_set_available(sink, TRUE);
+        }
+
         OSyncVersion *version = osync_version_new(error);
         osync_version_set_plugin(version, "Evolution");
@@ -382 +309 @@
         return TRUE;
 
+/*
 error_free_book:
                 g_object_unref(env->addressbook);
+*/
 error:
         osync_trace(TRACE_ERROR, "%s: %s", __func__, osync_error_print(error));
@@ -398 +327 @@
         osync_plugin_set_longname(plugin, "Evolution 2.x");
         osync_plugin_set_description(plugin, "Address book, calendar and task list of Evolution 2");
-        osync_plugin_set_config_type(plugin, OSYNC_PLUGIN_OPTIONAL_CONFIGURATION);
-        /**
-         * Bug 477227 – libebook isn't designed to be loaded and unloaded
-         * see: http://bugzilla.gnome.org/show_bug.cgi?id=477227
-         * see: http://mail.gnome.org/archives/evolution-hackers/2007-September/msg00027.html
-         * also the other EDS client libraries; so we start the plugin in a own process.
-         */
-        osync_plugin_set_start_type(plugin, OSYNC_START_TYPE_PROCESS);
         
         osync_plugin_set_initialize(plugin, evo2_initialize);
@@ -426 +347 @@
         return 1;
 }
+
+/**
+ * Bug 477227 – libebook isn't designed to be loaded and unloaded
+ * see: http://bugzilla.gnome.org/show_bug.cgi?id=477227
+ * see: http://mail.gnome.org/archives/evolution-hackers/2007-September/msg00027.html
+ * also the other EDS client libraries; so prevent unloading this module as the api provides 
+ * this facility which is the same as would be the g_module_make_resident that is :
+ * "Any future g_module_close() calls on the module will be ignored.".
+ */
+int dont_free(void)
+{
+        return 1;
+}

plugins/evolution2/src/evolution2_sync.h

@@ -34 +34 @@
         char *change_id;
         
-        char *addressbook_path;
+        const char *addressbook_path;
         EBook *addressbook;
         OSyncObjTypeSink *contact_sink;
         OSyncObjFormat *contact_format;
         
-        char *calendar_path;
+        const char *calendar_path;
         ECal *calendar;
         OSyncObjTypeSink *calendar_sink;
         OSyncObjFormat *calendar_format;
         
-        char *memos_path;
+        const char *memos_path;
         ECal *memos;
         OSyncObjTypeSink *memos_sink;
         OSyncObjFormat *memos_format;
         
-        char *tasks_path;
+        const char *tasks_path;
         ECal *tasks;
         OSyncObjTypeSink *tasks_sink;
         OSyncObjFormat *tasks_format;
-        
+
+        OSyncPluginInfo *pluginInfo;    
 } OSyncEvoEnv;