desktop/src/os40.h

   1 ///
   2 /// \file       os40.h
   3 ///             Wrapper class for opensync 0.4x syncing behaviour
   4 ///
   5
   6 /*
   7     Copyright (C) 2009-2012, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRYDESKTOP_OS40_H__
  23 #define __BARRYDESKTOP_OS40_H__
  24
  25 #include "dlopen.h"
  26 #include "osbase.h"
  27 #include <memory>
  28
  29 namespace OpenSync {
  30
  31 class OpenSync40Private;
  32 class OS40PluginConfigPrivate;
  33 class OS40ConfigResourcePrivate;
  34
  35 class OS40PluginConfig;
  36 class OpenSync40;
  37
  38 class OS40ConfigResource
  39 {
  40         friend class OS40PluginConfig;
  41
  42 private:
  43         OS40ConfigResourcePrivate *m_priv;
  44         bool m_exists;                  // true if this resources exists
  45                                         // in the plugin config.
  46                                         // AddResource() sets this to true
  47
  48 private:
  49         OS40ConfigResource(const OS40PluginConfig &parent, void *resource,
  50                 bool existing_resource);
  51         OS40ConfigResource(const OS40ConfigResource &other);//disabled copy
  52         OS40ConfigResource& operator=(const OS40ConfigResource &other);
  53
  54 public:
  55         ~OS40ConfigResource();
  56
  57         /// Returns true if this instance represents an existing
  58         /// resource in the config.  If this is false, then
  59         /// AddResource() must be called, otherwise any changes
  60         /// will not be saved to the config object.
  61         bool IsExistingResource() const;
  62         void AddResource();     // safe to call multiple times
  63
  64         bool IsEnabled() const;
  65         OS40ConfigResource& Enable(bool enabled = true);
  66
  67         // searches for the objformat, and fills in config with its config
  68         // value if it exists and returns true... otherwise returns false
  69         bool FindObjFormat(const std::string &objformat, std::string &config);
  70         OS40ConfigResource& SetObjFormat(const std::string &objformat,
  71                 const std::string &config = "");
  72
  73         std::string GetName() const;
  74         OS40ConfigResource& SetName(const std::string &name);
  75
  76         std::string GetPreferredFormat() const;
  77         OS40ConfigResource& SetPreferredFormat(const std::string &format);
  78
  79         std::string GetMime() const;
  80         OS40ConfigResource& SetMime(const std::string &mime);
  81
  82         std::string GetObjType() const;
  83 private:OS40ConfigResource& SetObjType(const std::string &objtype); // objtype is set
  84                 // automatically when this object is created with GetResource()
  85
  86 public:
  87         std::string GetPath() const;
  88         OS40ConfigResource& SetPath(const std::string &path);
  89
  90         std::string GetUrl() const;
  91         OS40ConfigResource& SetUrl(const std::string &url);
  92 };
  93
  94 class OS40PluginConfig
  95 {
  96         friend class OS40ConfigResource;
  97         friend class OpenSync40;
  98
  99 public:
 100         typedef std::auto_ptr<OS40ConfigResource>       OS40ConfigResourcePtr;
 101
 102         enum {
 103                 NONE_TYPE,
 104                 BOOL_TYPE,
 105                 CHAR_TYPE,
 106                 DOUBLE_TYPE,
 107                 INT_TYPE,
 108                 LONG_TYPE,
 109                 LONGLONG_TYPE,
 110                 UINT_TYPE,
 111                 ULONG_TYPE,
 112                 ULONGLONG_TYPE,
 113                 STRING_TYPE
 114         };
 115
 116 private:
 117         OpenSync40Private *m_privapi;   // external pointer to OpenSync40
 118         std::tr1::shared_ptr<OS40PluginConfigPrivate> m_priv;
 119
 120 private:
 121         OS40PluginConfig(OpenSync40Private *privapi, void *member, void *config);
 122
 123 public:
 124         std::string GetAdvanced(const std::string &name);
 125         void SetAdvanced(const std::string &name,
 126                 const std::string &display_name, const std::string &val);
 127         void SetAdvanced(const std::string &name,
 128                 const std::string &display_name,
 129                 int val_type, const std::string &val);
 130
 131         OS40ConfigResourcePtr GetResource(const std::string &objtype);
 132
 133         std::string GetUsername() const;
 134         void SetUsername(const std::string &username);
 135
 136         std::string GetPassword() const;
 137         void SetPassword(const std::string &password);
 138
 139         void Save();
 140 };
 141
 142 class OpenSync40 : public DlOpen, public OpenSync::API
 143 {
 144 public:
 145
 146 private:
 147         // private opensync 0.40 function pointers and data
 148         OpenSync40Private *m_priv;
 149
 150 protected:
 151         void SetupEnvironment(OpenSync40Private *p);
 152
 153 public:
 154         OpenSync40();
 155         ~OpenSync40();
 156
 157         //
 158         // Virtual API overrides
 159         //
 160
 161         // Functional abilities information... this does not come from
 162         // the engine itself, but is information the osbase library
 163         // determines useful for applications to know
 164         bool IsSlowSyncSupported() const { return true; } // FIXME - is this right?
 165
 166         // General engine information
 167         const char* GetVersion() const;
 168         const char* GetEngineName() const;
 169         void GetPluginNames(string_list_type &plugins);
 170         void GetFormats(format_list_type &formats);
 171
 172         // Information about configured groups
 173         void GetGroupNames(string_list_type &groups);
 174         void GetMembers(const std::string &group_name,
 175                 member_list_type &members);
 176
 177         // Group configuration
 178         void AddGroup(const std::string &group_name);
 179         void DeleteGroup(const std::string &group_name);
 180
 181         // Plugin configuration helper
 182         Converter& GetConverter();
 183
 184         // Member configuration
 185         long AddMember(const std::string &group_name,
 186                 const std::string &plugin_name,
 187                 const std::string &member_name);
 188         void DeleteMember(const std::string &group_name, long member_id);
 189         void DeleteMember(const std::string &group_name,
 190                 const std::string &plugin_name);
 191         bool IsConfigurable(const std::string &group_name,
 192                 long member_id);
 193         std::string GetConfiguration(const std::string &group_name,
 194                 long member_id);
 195         OS40PluginConfig GetConfigurationObj(const std::string &group_name,
 196                 long member_id);
 197         void SetConfiguration(const std::string &group_name,
 198                 long member_id, const std::string &config_data);
 199         void Discover(const std::string &group_name);
 200
 201         // Syncing
 202         void Sync(const std::string &group_name, SyncStatus &status_callback,
 203                 Config::pst_type sync_types/* = PST_DO_NOT_SET*/);
 204 };
 205
 206 } // namespace OpenSync
 207
 208 #endif
 209