Changeset 2293

Timestamp:

07/08/07 09:23:53 (1 year ago)

Author:

abaumann

Message:

Further cleanup and updates to the kdepim plugin:

• Re-add support for event and todo object types
  
• Push more functionality into common code to reduce duplication
  between contact and event/todo modules
  
• Remove unused wrapper for "read" callback
  
• Other cleanup
  

This is only lightly tested, and still under development. Syncing
events currently results in a failed assertion in the vformat converter
and empty event data in the other sync members.

Files:

• plugins/kdepim/Makefile.am (modified) (1 diff)
• plugins/kdepim/src/datasource.cpp (modified) (5 diffs)
• plugins/kdepim/src/datasource.h (modified) (2 diffs)
• plugins/kdepim/src/kaddrbook.cpp (modified) (6 diffs)
• plugins/kdepim/src/kaddrbook.h (modified) (1 diff)
• plugins/kdepim/src/kcal.cpp (modified) (8 diffs)
• plugins/kdepim/src/kcal.h (modified) (2 diffs)
• plugins/kdepim/src/kdepim_impl.cpp (modified) (6 diffs)

plugins/kdepim/Makefile.am

@@ -50 +50 @@
-        src/kdepim_impl.cpp \
-        src/datasource.cpp \
-
-#
+ \
+
-#       src/knotes.cpp
-#nodist_kdepim_lib_la_SOURCES = KNotesIface_stub.cpp

plugins/kdepim/src/datasource.cpp

@@ +1 @@
+/**
+ * @author Andrew Baumann <andrewb@cse.unsw.edu.au>
+ */
-
-#include <stdlib.h>
@@ -36 +39 @@
-        obj->get_changes(info, ctx);
-        osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__);
-}
-
-static osync_bool read_wrapper(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg)
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p, %p, %p)", __PRETTY_FUNCTION__, userdata, info, ctx, chg);
-        OSyncDataSource *obj = (OSyncDataSource *)osync_objtype_sink_get_userdata(osync_plugin_info_get_sink(info));
-        bool ret = obj->read(info, ctx, chg);
-        osync_trace(TRACE_EXIT, "%s: %d", __PRETTY_FUNCTION__, ret);
-        return ret;
-}
-
@@ -75 +69 @@
-        NULL, // write
-        NULL, // committed_all
-read_wrapper,
+NULL, // read
-        NULL, // batch_commit
-        sync_done_wrapper};
@@ -82 +76 @@
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p)", __PRETTY_FUNCTION__, plugin, info);
-        
-        (void)plugin; // silence "unused argument" warning
-        
-        sink = osync_objtype_sink_new(objtype, error);
@@ -133 +125 @@
-}
-
+bool OSyncDataSource::report_change(OSyncPluginInfo *info, OSyncContext *ctx, QString uid, QString data, QString hash, OSyncObjFormat *objformat)
+{
+        OSyncError *error = NULL;
+        OSyncChangeType changetype;
+        OSyncData *odata;
+        OSyncChange *change;
+        char *data_str;
+
+        osync_trace(TRACE_ENTRY, "%s(%p, %p, %s, (data), (hash), %p)", __PRETTY_FUNCTION__, info, ctx, uid.data(), objformat);
+
+        change = osync_change_new(&error);
+        if (!change)
+                goto error;
+
+        osync_change_set_uid(change, uid.local8Bit());
+
+        data_str = strdup((const char *)data.utf8());
+
+        osync_trace(TRACE_SENSITIVE,"Data:\n%s", data_str);
+
+        odata = osync_data_new(data_str, strlen(data_str), objformat, &error);
+        if (!odata)
+                goto error;
+
+        osync_data_set_objtype(odata, osync_objtype_sink_get_name(sink));
+
+        //Now you can set the data for the object
+        osync_change_set_data(change, odata);
+        osync_data_unref(odata);
+
+        // Use the hash table to check if the object
+        // needs to be reported
+        osync_change_set_hash(change, hash.data());
+
+        // Report entry ... otherwise it gets deleted!
+        osync_hashtable_report(hashtable, uid);
+
+        changetype = osync_hashtable_get_changetype(hashtable, uid, hash.data());
+        osync_change_set_changetype(change, changetype);
+        if (OSYNC_CHANGE_TYPE_UNMODIFIED != changetype) {
+                osync_context_report_change(ctx, change);
+                osync_hashtable_update_hash(hashtable, changetype, uid, hash.data());
+        }
+
+        osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__);
+        return true;
+
+error:
+        if (change)
+                osync_change_unref(change);
+        osync_context_report_osyncerror(ctx, error);
+        osync_trace(TRACE_EXIT_ERROR, "%s: %s", __PRETTY_FUNCTION__, osync_error_print(&error));
+        osync_error_unref(&error);
+        return false;
+}
+
+bool OSyncDataSource::report_deleted(OSyncPluginInfo *info, OSyncContext *ctx)
+{
+        osync_trace(TRACE_ENTRY, "%s(%p, %p)", __PRETTY_FUNCTION__, info, ctx);
+        
+        int i;
+        OSyncError *error = NULL;
+        char **uids = osync_hashtable_get_deleted(hashtable);
+        OSyncChange *change;
+        
+        for (i=0; uids[i]; i++) {
+                osync_trace(TRACE_INTERNAL, "going to delete entry with uid: %s", uids[i]);
+                
+                change = osync_change_new(&error);
+                if (!change) {
+                        for (; uids[i]; i++)
+                                g_free(uids[i]);
+                        g_free(uids);
+                        osync_context_report_osyncerror(ctx, error);
+                        osync_trace(TRACE_EXIT_ERROR, "%s: %s", __PRETTY_FUNCTION__, osync_error_print(&error));
+                        osync_error_unref(&error);
+                        return false;
+                }
+
+                osync_change_set_changetype(change, OSYNC_CHANGE_TYPE_DELETED);
+                osync_change_set_uid(change, uids[i]);
+                osync_context_report_change(ctx, change);
+                osync_hashtable_update_hash(hashtable, OSYNC_CHANGE_TYPE_DELETED, uids[i], NULL);
+
+                g_free(uids[i]);
+                osync_change_unref(change);
+        }
+        g_free(uids);
+        osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__);
+        return true;
+}
+
-OSyncDataSource::~OSyncDataSource()
-{

plugins/kdepim/src/datasource.h

@@ -1 @@
-BASE_
-BASE_
+
+
-
-abstract parent class
-Base
+common parent class and shared code
+
-{
-
-
+
-
-                virtual bool initialize(OSyncPlugin *plugin, OSyncPluginInfo *info, OSyncError **error) = 0;
-
-                virtual void connect(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
-                virtual void disconnect(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
-                virtual void get_changes(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
-                virtual bool read(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg) = 0;
-                virtual void commit(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg) = 0;
-                virtual void sync_done(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
-};
-
-/* common implementation of OSyncDataSourceBase */
-class OSyncDataSource : public OSyncDataSourceBase
-{
-        protected:
-                const char *objtype;
@@ -26 +12 @@
-                OSyncObjTypeSink *sink;
-
+                /* utility functions for subclasses */
+                bool report_change(OSyncPluginInfo *info, OSyncContext *ctx, QString uid, QString data, QString hash, OSyncObjFormat *objformat);
+                bool report_deleted(OSyncPluginInfo *info, OSyncContext *ctx);
+
-        public:
-                OSyncDataSource(const char *objtype) : objtype(objtype) {}
-                virtual ~OSyncDataSource();
-                
-
+
+
+
+
-                virtual void connect(OSyncPluginInfo *info, OSyncContext *ctx);
+                virtual void disconnect(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
+                virtual void get_changes(OSyncPluginInfo *info, OSyncContext *ctx) = 0;
+                virtual void commit(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg) = 0;
-                virtual void sync_done(OSyncPluginInfo *info, OSyncContext *ctx);
-};
-
-BASE_
+

plugins/kdepim/src/kaddrbook.cpp

@@ -22 +22 @@
-*************************************************************************/
-/**
-
-
+
+
+
- */
-
@@ -92 +93 @@
-        
-        osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__);
-        return;
-}
-
@@ -121 +121 @@
-        osync_trace(TRACE_ENTRY, "%s(%p, %p)", __PRETTY_FUNCTION__, info, ctx);
-
-        OSyncError *error = NULL;
-        OSyncObjTypeSink *sink = osync_plugin_info_get_sink(info);
-
-        if (osync_objtype_sink_get_slowsync(sink)) {
-
+, resetting hashtable
-                osync_hashtable_reset(hashtable);
-        }
@@ -141 +138 @@
-        KABC::VCardConverter converter;
-        for (KABC::AddressBook::Iterator it=addressbookptr->begin(); it!=addressbookptr->end(); it++ ) {
-                QString uid = it->uid();
-
-                OSyncChange *change = osync_change_new(&error);
-
-                osync_change_set_uid(change, uid.local8Bit());
-
-                QString hash = calc_hash(*it);
-
-                // Convert the VCARD data into a string
-                // only vcard3.0 exports Categories
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-        osync_context_report_success(ctx);
-        osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__);
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p)", __PRETTY_FUNCTION__, ctx, chg);
@@ -288 +210 @@
-                                osync_context_report_error(ctx, OSYNC_ERROR_FILE_NOT_FOUND, "Trying to delete entry with empty UID");
-                                osync_trace(TRACE_EXIT_ERROR, "%s: Trying to delete but uid is empty", __PRETTY_FUNCTION__);
- FALSE
+
-                        }
-
@@ -303 +225 @@
-                        osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "Operation not supported");
-                        osync_trace(TRACE_EXIT_ERROR, "%s: Operation not supported", __PRETTY_FUNCTION__);
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-
-        osync_context_report_success(ctx);
-
-
-
-
-
-
-
-
-
+
+

plugins/kdepim/src/kaddrbook.h

@@ -35 +35 @@
-        private:
-                KABC::AddressBook* addressbookptr;
-
-                bool __vcard_access(OSyncContext *ctx, OSyncChange *chg);
-                QString calc_hash(KABC::Addressee &e);
-
-        public:
-                KContactDataSource() : OSyncDataSource("contact") {};
+                virtual ~KContactDataSource() {};
-
-virtual 
+
-                virtual void connect(OSyncPluginInfo *info, OSyncContext *ctx);
-                virtual void disconnect(OSyncPluginInfo *info, OSyncContext *ctx);
-                virtual void get_changes(OSyncPluginInfo *info, OSyncContext *ctx);
-                virtual bool read(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg);
-                virtual void commit(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg);
-};

plugins/kdepim/src/kcal.cpp

@@ -21 +21 @@
-*************************************************************************/
-/**
-
+
+
- */
-
-#include "kcal.h"
-
+#include <assert.h>
-#include <kapplication.h>
-#include <dcopclient.h>
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-        DCOPClient *dcopc = KApplication::kApplication()->dcopClient();
-        if (!dcopc) {
@@ -67 +68 @@
-#endif
-
-        //Detection mechanismn if this is the first sync
-        if (osync_member_objtype_enabled(member, "event")
-            && !osync_anchor_compare(member, "event", "true")) {
-                osync_trace(TRACE_INTERNAL, "Setting slow-sync for event");
-                osync_member_set_slow_sync(member, "event", TRUE);
-        }
-
-        if (osync_member_objtype_enabled(member, "todo")
-            && !osync_anchor_compare(member, "todo", "true")) {
-                osync_trace(TRACE_INTERNAL, "Setting slow-sync for todo");
-                osync_member_set_slow_sync(member, "todo", TRUE);
-        }
-
-//      osync_debug("kcal", 3, "Calendar: %d events", calendar->events().size());
-
-
-
-
-
-
+
+
+
+
-{
-        /* Save the changes */
-        calendar->save();
+        
+        if (--refcount > 0)
+                return true;
-
-        delete calendar;
-        calendar = NULL;
-
-
-
-
+
+
+
-static QString calc_hash(const KCal::Incidence *e)
-{
@@ -108 +97 @@
-}
-
-/** Report a list of calendar incidences (events or to-dos), with the
- * right objtype and objformat.
- *
- * This function exists because the logic for converting the events or to-dos
- * is the same, only the objtype and format is different.
- */
-bool KCalDataSource::report_incidence(OSyncContext *ctx, KCal::Incidence *e, const char *objtype, const char *objformat)
-{
-//      osync_debug("kcal", 3, "One calendar incidence (%s)", objtype);
-        QString hash = calc_hash(e);
-
-        QString uid = e->uid();
-
-        /* Build a local calendar for the incidence data */
-        KCal::CalendarLocal cal(calendar->timeZoneId());
-//      osync_debug("kcal", 3, "timezoneid: %s\n", (const char*)cal.timeZoneId().local8Bit());
-        cal.addIncidence(e->clone());
-
-        /* Convert the data to vcalendar */
-        KCal::ICalFormat format;
-        QCString datastr = format.toString(&cal).utf8();
-        const char *data = datastr;
-
-//      osync_debug("kcal", 3, "UID: %s\n", (const char*)uid.local8Bit());
-        OSyncChange *chg = osync_change_new();
-        osync_change_set_uid(chg, uid.local8Bit());
-        osync_change_set_member(chg, member);
-
-        // object type and format
-        osync_change_set_objtype_string(chg, objtype);
-        osync_change_set_objformat_string(chg, objformat);
-        osync_change_set_data(chg, strdup(data), strlen(data) +1, 1);
-
-        // Use the hash table to check if the object
-        // needs to be reported
-        osync_change_set_hash(chg, hash.data());
-        if (osync_hashtable_detect_change(hashtable, chg)) {
-                osync_context_report_change(ctx, chg);
-                osync_hashtable_update_hash(hashtable, chg);
-        }
-
-        return true;
-}
-
-bool KCalDataSource::get_changeinfo_events(OSyncContext *ctx)
-{
-        KCal::Event::List events = calendar->events();
-//      osync_debug("kcal", 3, "Number of events: %d", events.size());
-
-        if (osync_member_get_slow_sync(member, "event")) {
-//              osync_debug("kcal", 3, "Setting slow-sync for events");
-                osync_hashtable_set_slow_sync(hashtable, "event");
-        }
-
-        for (KCal::Event::List::ConstIterator i = events.begin(); i != events.end(); i++) {
-
-                /* Skip entries from birthday resource. This is just a workaround.
-                 * patch by rhuitl
-                 * FIXME: todo: add a list of resources to kdepim-sync.conf
-                 */
-                if ( (*i)->uid().contains("KABC_Birthday") || (*i)->uid().contains("KABC_Anniversary") )
-                        continue;
-
-                if (!report_incidence(ctx, *i, "event", "vevent20"))
-                        return false;
-        }
-
-        osync_hashtable_report_deleted(hashtable, ctx, "event");
-
-        return true;
-}
-
-bool KCalDataSource::get_changeinfo_todos(OSyncContext *ctx)
-{
-        KCal::Todo::List todos = calendar->todos();
-
-//      osync_debug("kcal", 3, "Number of to-dos: %d", todos.size());
-
-        if (osync_member_get_slow_sync(member, "todo")) {
-//              osync_debug("kcal", 3, "Setting slow-sync for todos");
-                osync_hashtable_set_slow_sync(hashtable, "todo");
-        }
-
-        for (KCal::Todo::List::ConstIterator i = todos.begin(); i != todos.end(); i++) {
-//              osync_debug("kcal", 3, "%p: doesFloat: %d", *i, (*i)->doesFloat());
-                if (!report_incidence(ctx, *i, "todo", "vtodo20"))
-                        return false;
-        }
-
-        osync_hashtable_report_deleted(hashtable, ctx, "todo");
-
-        return true;
-
-}
-
-void KCalDataSource::get_data(OSyncContext *ctx, OSyncChange *)
-{
-        osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "Not implemented yet");
-}
-
-/** Add or change a incidence on the calendar. This function
- * is used for events and to-dos
- */
-DataSource::__access
+SharedResource::commit
-{
-        OSyncChangeType type = osync_change_get_changetype(chg);
@@ -228 +117 @@
-                case OSYNC_CHANGE_TYPE_MODIFIED: {
-                        KCal::ICalFormat format;
+        
+                        OSyncData *odata = osync_change_get_data(chg);
+
+                        char *databuf;
+                        size_t databuf_size; 
+                        osync_data_get_data(odata, &databuf, &databuf_size);
-
-                        /* First, parse to a temporary calendar, because
@@ -234 +129 @@
-
-                        KCal::CalendarLocal cal(QString::fromLatin1( "UTC" ));
-osync_change_get_data(chg), osync_change_get_datasize(chg)
+databuf, databuf_size
-                        if (!format.fromString(&cal, data)) {
-                                osync_context_report_error(ctx, OSYNC_ERROR_CONVERT, "Couldn't import calendar data");
@@ -240 +135 @@
-                        }
-
-                        /*FIXME: The event/to-do will be overwritten. But I can't differentiate
-                                * between a field being removed and a missing field because
-                                * the other device don't support them, because OpenSync currently
-                                * doesn't have support for it. Yes, it is risky, but unfortunately
-                                * CalendarResources don't have support for changing an event
-                                * from vcard data, and not adding it.
-                                */
-                        KCal::Incidence *oldevt = calendar->incidence(osync_change_get_uid(chg));
-                        if (oldevt)
@@ -261 +149 @@
-                                        e->setUid(osync_change_get_uid(chg));
-
-/
-
+*
+ */
-
-                                QString c_uid = e->uid().utf8();
@@ -281 +169 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-{
-        // We use the same function for events and to-do
-
-
-
+
+
+
+
-        osync_context_report_success(ctx);
-
-
-
-
-
-// We use the same function for events and to-do
-if ( !__access(ctx, chg) )
-       return false;
-chg
+
+
+
+
+
+if (!kcal->commit(ctx, chg))
+       return;
+
+osync_change_get_changetype(chg), osync_change_get_uid(chg), osync_change_get_hash(chg)
-        osync_context_report_success(ctx);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+

plugins/kdepim/src/kcal.h

@@ -21 +21 @@
-*************************************************************************/
-/**
-
+
+
- */
-
@@ -31 +32 @@
-
-#include "osyncbase.h"
+#include "datasource.h"
-
-
-
-
-
+
-{
-        private:
-                KCal::CalendarResources *calendar;
+                int refcount;
+        
+                bool report_incidence(OSyncDataSource *dsobj, OSyncPluginInfo *info, OSyncContext *ctx, KCal::Incidence *e, OSyncObjFormat *objformat);
+        
+        public:
+                KCalSharedResource() {calendar = NULL; refcount = 0;};
+                bool open(OSyncContext *ctx);
+                bool close(OSyncContext *ctx);
+                bool get_event_changes(OSyncDataSource *dsobj, OSyncPluginInfo *info, OSyncContext *ctx);
+                bool get_todo_changes(OSyncDataSource *dsobj, OSyncPluginInfo *info, OSyncContext *ctx);
+                bool commit(OSyncContext *ctx, OSyncChange *chg);
+};
-
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-        public:
-
+
+
-
-
-
-
-
-
-
-
-
-