Changeset 2277

Timestamp:

07/06/07 07:24:53 (1 year ago)

Author:

abaumann

Message:

First pass at cleaning up the kdepim plugin:

• create common class for all data sources (datasource.{cpp,h})
  
• put sink creation and callback functions here, removing all the
  call-passing that was in src/kdepim_impl.cpp and src/kdepim_sync.cpp
  
• convert existing code to use this class and do some other cleanup
  

This works for me, but has the same limited support as before (ie. only
the address book is implemented). The next step is to port the other
data sources to the new class model.

Files:

• plugins/kdepim/Makefile.am (modified) (1 diff)
• plugins/kdepim/src/datasource.cpp (added)
• plugins/kdepim/src/datasource.h (added)
• plugins/kdepim/src/kaddrbook.cpp (modified) (9 diffs)
• plugins/kdepim/src/kaddrbook.h (modified) (1 diff)
• plugins/kdepim/src/kdepim_impl.cpp (modified) (6 diffs)
• plugins/kdepim/src/kdepim_sync.cpp (modified) (9 diffs)
• plugins/kdepim/src/osyncbase.h (modified) (1 diff)

plugins/kdepim/Makefile.am

@@ -47 +47 @@
-#       dcopidl2cpp KNotesIface.kidl
-
-
-
-
-
-
+
+
+
+
+
+
-#nodist_kdepim_lib_la_SOURCES = KNotesIface_stub.cpp
-kdepim_lib_la_CXXFLAGS = -DPLUGINDIR=\"$(plugindir)\" -DKDEPIM_LIBDIR=\"$(plugindir)\" -Wall

plugins/kdepim/src/kaddrbook.cpp

@@ -31 +31 @@
-#include <qdeepcopy.h>
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
@@ -55 +65 @@
-}
-
-bool
-
-func
+void
+
+PRETTY_FUNCTION
-
-        DCOPClient *dcopc = KApplication::kApplication()->dcopClient();
-        if (!dcopc) {
-                osync_context_report_error(ctx, OSYNC_ERROR_INITIALIZATION, "Unable to initialize dcop client");
-func
- false
+PRETTY_FUNCTION
+
-        }
-
@@ -71 +81 @@
-        //is running
-        if (dcopc->isApplicationRegistered("kaddressbook")) {
-finish
-func
- false
+terminate
+PRETTY_FUNCTION
+
-        }
-
-        //get a handle to the standard KDE addressbook
-        addressbookptr = KABC::StdAddressBook::self();
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-        KABC::Ticket *ticket = addressbookptr->requestSaveTicket();
-        if ( !ticket ) {
-                osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "Unable to get save ticket");
-func
- FALSE
+PRETTY_FUNCTION
+
-        }
-
-        if ( !addressbookptr->save( ticket ) ) {
-                osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "Unable to use ticket");
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-        OSyncError *error = NULL;
@@ -131 +132 @@
-        if (!addressbookptr->load()) {
-                osync_context_report_error(ctx, OSYNC_ERROR_GENERIC, "Couldn't reload KDE addressbook");
-func
- false
+PRETTY_FUNCTION
+
-        }
-
@@ -222 +223 @@
-        g_free(uids);
-
-
-
+
+
+
-}
-
@@ -235 +237 @@
-bool KContactDataSource::__vcard_access(OSyncContext *ctx, OSyncChange *chg)
-{
-func
+PRETTY_FUNCTION
-        KABC::VCardConverter converter;
-
@@ -285 +287 @@
-                        if (uid.isEmpty()) {
-                                osync_context_report_error(ctx, OSYNC_ERROR_FILE_NOT_FOUND, "Trying to delete entry with empty UID");
-func
+PRETTY_FUNCTION
-                                return FALSE;
-                        }
@@ -300 +302 @@
-                default: {
-                        osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "Operation not supported");
-func
+PRETTY_FUNCTION
-                        return FALSE;
-                }
-        }
-
-func
+PRETTY_FUNCTION
-        return TRUE;
-}
-
-vcard_access
+read
-{
-        if (!__vcard_access(ctx, chg))
@@ -318 +320 @@
-}
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+

plugins/kdepim/src/kaddrbook.h

@@ -29 +29 @@
-
-#include "osyncbase.h"
+#include "datasource.h"
-
-
+ : public OSyncDataSource
-{
-        private:
-                KABC::AddressBook* addressbookptr;
-                OSyncHashTable *hashtable;
-
-                bool __vcard_access(OSyncContext *ctx, OSyncChange *chg);
-
+
-
-        public:
-OSyncHashTable *hashtable)
+) : OSyncDataSource("contact") {}
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-};
-

plugins/kdepim/src/kdepim_impl.cpp

@@ -25 +25 @@
- */
-
-
-
-
-#include <libkcal/resourcecalendar.h>
-#include <kinstance.h>
@@ -36 +33 @@
-
-#include <qsignal.h>
-
-
-#include <qfile.h>
-#include <dlfcn.h>
@@ -45 +40 @@
-//#include "kcal.h"
-//#include "knotes.h"
-
+
+
-
-class KdePluginImplementation: public KdePluginImplementationBase
-{
-
-
-
-
-
+
+
+
+
+
+
-
-                void initKDE()
-                {
-a
+e
-                                return;
-
@@ -63 +60 @@
-                            "libopensync-kdepim-plugin",         // internal program name
-                            "OpenSync-KDE-plugin",               // displayable program name.
-2
+3
-                            "OpenSync KDEPIM plugin",            // short porgram description
-                            KAboutData::License_GPL,             // license type
@@ -73 +70 @@
-
-                        KCmdLineArgs::init( &aboutData );
-
-
-
-
-
+
+
+
+
+
+
-                        }
-
-a
+e
-                }
-
-
+
+
-                {
-
+
+
+
+
+
+
+
-
-                        initKDE();
-
-
+
+
+
+
+
-
-QString tablepath = QString("%1/hashtable.db").arg(osync_plugin_info_get_configdir(info)
-mHashtable = osync_hashtable_new(tablepath, osync_objtype_sink_get_name(contact_sink), error)
+osync_trace(TRACE_EXIT, "%s", __PRETTY_FUNCTION__
+return true
-
-
-
-
-
+
+
+
-                }
-
-                virtual ~KdePluginImplementation()
-                {
-mN
-mA
-mApplication = 0
+n
+a
+application = NULL
-                        }
-
-                        if ( mHashtable )
-                                osync_hashtable_free(mHashtable);
-                }
-
-                virtual void connect(OSyncPluginInfo *info, OSyncContext *ctx)
-                {
-                        osync_trace(TRACE_ENTRY, "%s(%p)", __func__, ctx);
-
-//                      OSyncError *error = NULL;
-
-                        if (mKaddrbook && \
-                                !mKaddrbook->connect(info, ctx)) {
-                                osync_trace(TRACE_EXIT_ERROR, "%s: Unable to open addressbook", __func__);
-                                return;
-                        }
-
-                        osync_context_report_success(ctx);
-                        osync_trace(TRACE_EXIT, "%s", __func__);
-                }
-
-                virtual void disconnect(OSyncPluginInfo *info, OSyncContext *ctx)
-                {
-                        if (mKaddrbook && mKaddrbook->connected && !mKaddrbook->disconnect(info, ctx))
-                                return;
-
-                        osync_context_report_success(ctx);
-                }
-
-
-                virtual void sync_done(OSyncPluginInfo *info, OSyncContext *ctx)
-                {
-                        if (mKaddrbook && mKaddrbook->connected)
-                        {
-                                QString anchorpath = QString("%1/anchor.db").arg(osync_plugin_info_get_configdir(info));
-                                osync_anchor_update(anchorpath, "contact", "true");
-                        }
-                        osync_context_report_success(ctx);
-                }
-
-                virtual void get_changeinfo(OSyncPluginInfo *info, OSyncContext *ctx)
-                {
-                        if (mKaddrbook && mKaddrbook->connected && !mKaddrbook->contact_get_changeinfo(info, ctx))
-                                return;
-                        osync_context_report_success(ctx);
-                }
-
-                virtual bool vcard_access(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg)
-                {
-                        if (mKaddrbook)
-                                return mKaddrbook->vcard_access(info, ctx, chg);
-                        else {
-                                osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "No addressbook loaded");
-                                return false;
-                        }
-                        return true;
-                }
-
-                virtual bool vcard_commit_change(OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *chg)
-                {
-                        if (mKaddrbook)
-                                return mKaddrbook->vcard_commit_change(info, ctx, chg);
-                        else {
-                                osync_context_report_error(ctx, OSYNC_ERROR_NOT_SUPPORTED, "No addressbook loaded");
-                                return false;
-                        }
-                        return true;
-                }
-        private:
-                KContactDataSource *mKaddrbook;
-
-                OSyncHashTable *mHashtable;
-                OSyncMember *mMember;
-
-                KApplication *mApplication;
-                bool mNewApplication;
-};
-
@@ -187 +120 @@
-extern "C"
-{
-
-        KdePluginImplementationBase *new_KdePluginImplementation(OSyncPlugin *plugin, OSyncPluginInfo *info, OSyncError **error) {
-plugin, info, error
-(
+
+ialize(plugin, 
-                        delete imp;
-0
+NULL
-                }
-
-                return imp;
-        }
-
-}

plugins/kdepim/src/kdepim_sync.cpp

@@ -30 +30 @@
-#include "osyncbase.h"
-
-
-
+
-{
-        osync_trace(TRACE_ENTRY, "%s(%p)", __func__, userdata);
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata;
-        delete impl_object;
-        osync_trace(TRACE_EXIT, "%s(%p)", __func__, userdata);
-}
-
-static void kde_connect(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx)
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p, %p)", __func__, userdata, info, ctx);
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase*)userdata;
-        impl_object->connect(info, ctx);
-        osync_trace(TRACE_EXIT, "%s", __func__);
-}
-
-
-static void kde_disconnect(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx)
-{
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata;
-        impl_object->disconnect(info, ctx);
-}
-
-static void kde_get_changeinfo(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx)
-{
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase*)userdata;
-//      osync_debug("kde", 3, "%s",__FUNCTION__);
-
-        impl_object->get_changeinfo(info, ctx);
-}
-
-static void kde_sync_done(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx)
-{
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata;
-
-//      osync_debug("kde", 3, "%s()",__FUNCTION__);
-
-        impl_object->sync_done(info, ctx);
-}
-
-static void kde_vcard_commit_change(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *change)
-{
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata; 
-
-//      osync_debug("kde", 3, "%s()",__FUNCTION__);
-
-        impl_object->vcard_commit_change(info, ctx, change);
-}
-
-static osync_bool kde_vcard_access(void *userdata, OSyncPluginInfo *info, OSyncContext *ctx, OSyncChange *change)
-{
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata;
-
-//      osync_debug("kde", 3, "%s()",__FUNCTION__);
-
-        impl_object->vcard_access(info, ctx, change);
-}
-
-/** Load actual plugin implementation
- *
-_impl
+pim_lib
- * that is linked against the KDE libraries, and implements the plugin
- * functions
@@ -97 +41 @@
- * @see KdePluginImplementationBase
- */
-
+
+
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p, %p)", __func__, plugin, info, error);
@@ -105 +50 @@
-        void *module;
-
-//      osync_debug("kde", 3, "%s", __FUNCTION__);
-
-//      osync_debug("kde", 3, "Loading implementation module");
-        module = dlopen(KDEPIM_LIBDIR"/kdepim_lib.so", RTLD_NOW);
-        if (!module) {
@@ -114 +56 @@
-                goto error;
-        }
-
+
-        init_func = (KdeImplInitFunc)dlsym(module, "new_KdePluginImplementation");
-        if (!init_func) {
@@ -121 +63 @@
-        }
-
-//      osync_debug("kde", 3, "Initializing implementation module");
-        impl_object = init_func(plugin, info, error);
-        if (!impl_object)
-                goto error;
-
-        do {
-                impl_object->contact_sink = osync_objtype_sink_new("contact", error);
-                if (!impl_object->contact_sink)
-                        goto error;
-
-                osync_objtype_sink_add_objformat(impl_object->contact_sink, "vcard30");
-
-                /* Every sink can have different functions ... */
-                OSyncObjTypeSinkFunctions functions;
-                memset(&functions, 0, sizeof(functions));
-                functions.connect = kde_connect;
-                functions.disconnect = kde_disconnect;
-                functions.get_changes = kde_get_changeinfo;
-                functions.commit = kde_vcard_commit_change;
-                functions.sync_done = kde_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(impl_object->contact_sink, functions, impl_object);
-                osync_plugin_info_add_objtype(info, impl_object->contact_sink);
-
-        } while(0);
-
-
-        /* Return the created object to the sync engine */
+        osync_trace(TRACE_EXIT, "%s: %p", __func__, impl_object);
-        return (void*)impl_object;
-        osync_trace(TRACE_EXIT, "%s: %p", __func__, impl_object);
-
-error:
@@ -159 +76 @@
-}
-
-extern "C"
-{
-
-/* Here we actually tell opensync which sinks are available. For this plugin, we
-the list of directories and enable all, since all have been configured
+and enable all the sinks
-static osync_bool kde_discover(void *userdata, OSyncPluginInfo *info, OSyncError **error)
-{
-        osync_trace(TRACE_ENTRY, "%s(%p, %p, %p)", __func__, userdata, info, error);
-        
-        KdePluginImplementationBase *impl_object = (KdePluginImplementationBase *)userdata;
-
-
+
+
+
+
-
-        osync_trace(TRACE_EXIT, "%s", __func__);
@@ -176 +91 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-        OSyncPlugin *plugin = osync_plugin_new(error);
@@ -185 +110 @@
-        osync_plugin_set_longname(plugin, "KDE Desktop");
-        osync_plugin_set_description(plugin, "Plugin for the KDE 3.5 Desktop");
-
-        osync_plugin_set_config_type(plugin, OSYNC_PLUGIN_NO_CONFIGURATION);
-
@@ -192 +116 @@
-        osync_plugin_set_discover(plugin, kde_discover);
-
-
-        osync_plugin_env_register_plugin(env, plugin);
-        osync_plugin_unref(plugin);
+
+        osync_trace(TRACE_EXIT, "%s", __func__);
-        return TRUE;
-
-error:
-
-
+
-        return FALSE;
-}

plugins/kdepim/src/osyncbase.h

@@ -21 +21 @@
-{
-        public:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-};
-