opensync-plugin/src/environment.h

   1 //
   2 // \file        environment.h
   3 //              Container / environment class for the sync module.
   4 //
   5
   6 /*
   7     Copyright (C) 2006-2007, 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 __BARRY_SYNC_ENVIRONMENT_H__
  23 #define __BARRY_SYNC_ENVIRONMENT_H__
  24
  25 #include <opensync/opensync.h>
  26 #include <opensync/plugin/opensync_plugin_info.h>
  27 #include <barry/barry.h>
  28 #include <string>
  29 #include "idmap.h"
  30
  31
  32 class BarryEnvironment;
  33
  34 class DatabaseSyncState
  35 {
  36 private:
  37         BarryEnvironment *m_pEnv;
  38
  39 public:
  40         // cache is a map of record ID to bool... the bool doesn't mean
  41         // anything... the mere existence of the ID means it belongs
  42         // in the cache
  43         typedef std::map<uint32_t, bool>                        cache_type;
  44
  45 public:
  46         // cache data
  47         std::string m_CacheFilename;
  48         cache_type m_Cache;
  49
  50         // id map data
  51         std::string m_MapFilename;
  52         idmap m_IdMap;
  53
  54         // device data
  55         Barry::RecordStateTable m_Table;
  56
  57         bool m_Sync;
  58
  59         // OpenSync data
  60         OSyncObjFormat *m_pObjFormat;
  61
  62 private:
  63         std::string m_Desc;
  64         const char *m_DBName;
  65
  66 public:
  67         DatabaseSyncState(BarryEnvironment *pEnv, OSyncPluginInfo *pi,
  68                 const char *DBName, const char *description);
  69         ~DatabaseSyncState();
  70
  71         bool LoadCache();
  72         bool SaveCache();
  73
  74         bool LoadMap();
  75         bool SaveMap();
  76
  77         void CleanupMap();
  78         void ClearDirtyFlags();
  79
  80         unsigned long GetMappedRecordId(const std::string &uid);
  81
  82         const std::string& GetDesc() const { return m_Desc; }
  83         const char* GetDBName() const { return m_DBName; }
  84 };
  85
  86
  87 class BarryEnvironment
  88 {
  89 public:
  90         // user config data
  91         std::string m_ConfigData;
  92         uint32_t m_pin;
  93
  94         // device communication
  95         Barry::ProbeResult m_ProbeResult;
  96         Barry::Controller *m_pCon;
  97
  98         // sync data
  99         DatabaseSyncState m_CalendarSync, m_ContactsSync;
 100
 101 public:
 102         BarryEnvironment(OSyncPluginInfo *pi);
 103         ~BarryEnvironment();
 104
 105         // meta data
 106         bool IsConnected() { return m_pCon; }
 107
 108         // operations
 109
 110         void OpenDesktop(Barry::ProbeResult &result);
 111         void Disconnect();
 112
 113         DatabaseSyncState* GetSyncObject(OSyncChange *change);
 114
 115         void ParseConfig(const char *data);
 116         void BuildConfig();
 117
 118         void ClearDirtyFlags(Barry::RecordStateTable &table, const std::string &dbname);
 119         void ClearCalendarDirtyFlags();
 120         void ClearContactsDirtyFlags();
 121 };
 122
 123 #endif
 124