src/configfile.h

   1 ///
   2 /// \file       configfile.h
   3 ///             Barry configuraion class, for one device PIN
   4 ///
   5
   6 /*
   7     Copyright (C) 2007-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 __BARRY_CONFIGFILE_H__
  23 #define __BARRY_CONFIGFILE_H__
  24
  25 #include "dll.h"
  26 #include "record.h"
  27 #include "pin.h"
  28 #include <string>
  29 #include <iosfwd>
  30
  31 namespace Barry {
  32
  33 /// Creates a tar.gz filename using PIN + date + time + label.
  34 /// Does not include any path, just returns a new filename.
  35 BXEXPORT std::string MakeBackupFilename(const Barry::Pin &pin,
  36                                         const std::string &label);
  37
  38 class BXEXPORT ConfigFile
  39 {
  40 public:
  41         class BXEXPORT DBListType : public std::vector<std::string>
  42         {
  43         public:
  44                 bool IsSelected(const std::string &dbname) const;
  45
  46                 DBListType& operator=(const DatabaseDatabase &dbdb);
  47         };
  48
  49 private:
  50         // meta data
  51         Barry::Pin m_pin;
  52         std::string m_path;             // /path/to/config/dir  without trailing slash
  53         std::string m_filename;         // /path/to/config/dir/filename
  54         bool m_loaded;
  55         std::string m_last_error;
  56
  57         // configuration data
  58         DBListType m_backupList;
  59         DBListType m_restoreList;
  60         std::string m_deviceName;
  61         bool m_promptBackupLabel;       // if true, prompt the user on every
  62                                         // backup for a string to label the
  63                                         // backup file with
  64         bool m_autoSelectAll;           // if true, automatically select all
  65                                         // databases on every backup
  66
  67 protected:
  68         void BuildFilename();
  69         void BuildDefaultPath();
  70         void Clear();
  71         void Load();
  72
  73 public:
  74         /// Loads config file for the given pin, and ends up in an
  75         /// unenlightened state.  Throws ConfigFileError on error,
  76         /// but it is not an error if the config does not exist.
  77         /// Never use this if you have a DatabaseDatabase object!
  78         /// This ctor is only for temporary loading of config data.
  79         explicit ConfigFile(Barry::Pin pin);
  80
  81         /// Opens and loads config file for given pin, and calls Enlighten
  82         /// Throws ConfigFileError on error.  Should never fail unless
  83         /// passed a bad pin, or if unable to get current user info.
  84         ConfigFile(Barry::Pin pin, const Barry::DatabaseDatabase &db);
  85
  86         ~ConfigFile();
  87
  88         //
  89         // data access
  90         //
  91
  92         const std::string& get_last_error() const { return m_last_error; }
  93         bool IsConfigLoaded() const { return m_loaded; }
  94
  95         const std::string& GetPath() const { return m_path; }
  96 //      const std::string& GetDeviceConfigFilename() const { return m_device_filename; }
  97
  98         //
  99         // per-Device Configuration
 100         //
 101         const DBListType& GetBackupList() const { return m_backupList; }
 102         const DBListType& GetRestoreList() const { return m_restoreList; }
 103         const std::string& GetDeviceName() const { return m_deviceName; }
 104         bool HasDeviceName() const { return m_deviceName.size(); }
 105         bool PromptBackupLabel() const { return m_promptBackupLabel; }
 106         bool AutoSelectAll() const { return m_autoSelectAll; }
 107
 108         //
 109         // operations
 110         //
 111
 112         /// Saves current device's config, overwriting or creating a
 113         /// config file
 114         bool Save();
 115
 116         /// Compares a given databasedatabase from a real device with the
 117         /// current config.  If not yet configured, initialize with valid
 118         /// defaults.
 119         void Enlighten(const Barry::DatabaseDatabase &db);
 120
 121         //
 122         // per-Device Configuration setting
 123         //
 124
 125         /// Sets list with new config
 126         void SetBackupList(const DBListType &list);
 127         void SetRestoreList(const DBListType &list);
 128
 129         void SetDeviceName(const std::string &name);
 130         void SetBackupPath(const std::string &path);
 131         void SetPromptBackupLabel(bool prompt = true);
 132         void SetAutoSelectAll(bool asa = true);
 133
 134         //
 135         // Utility functions
 136         //
 137
 138         /// Checks that the path in path exists, and if not, creates it.
 139         /// Returns false if unable to create path, true if ok.
 140         static bool CheckPath(const std::string &path, std::string *perr = 0);
 141 };
 142
 143 class BXEXPORT GlobalConfigFile
 144 {
 145 private:
 146         typedef std::map<std::string, std::string>              keymap_type;
 147
 148         // meta data
 149         std::string m_path;     // /path/to/.barry   without trailing slash
 150         std::string m_filename; // /path/to/.barry/config
 151         bool m_loaded;
 152         std::string m_last_error;
 153         std::string m_appname;
 154
 155         // global configuration data
 156         Barry::Pin m_lastDevice;        // the last selected device in a GUI
 157         bool m_verboseLogging;
 158
 159         // set/get key data
 160         keymap_type m_keymap;
 161
 162 protected:
 163         void BuildFilename();
 164         void Clear();
 165         void Load();
 166
 167 public:
 168         /// Loads the global config file.
 169         /// Throws ConfigFileError on error, but it is not an error
 170         /// if the config does not exist.
 171         GlobalConfigFile();
 172
 173         /// Loads the global config file, as well as any application-specific
 174         /// keywords and variables.  Use this if you wish to make use of
 175         /// SetKey() and GetKey(), otherwise these functions will throw
 176         /// and exception since they don't have an application name.
 177         GlobalConfigFile(const std::string &appname);
 178
 179         ~GlobalConfigFile();
 180
 181         //
 182         // data access
 183         //
 184
 185         const std::string& get_last_error() const { return m_last_error; }
 186         bool IsConfigLoaded() const { return m_loaded; }
 187         const std::string& GetPath() const { return m_path; }
 188
 189         //
 190         // Global Configuration data access
 191         //
 192         Barry::Pin GetLastDevice() const { return m_lastDevice; }
 193         bool VerboseLogging() const { return m_verboseLogging; }
 194
 195         //
 196         // operations
 197         //
 198
 199         /// Save the current global config, overwriting or creating as needed
 200         bool Save();
 201
 202         /// Throws std::logic_error if not constructed with an appname
 203         void SetKey(const std::string &key, const std::string &value);
 204
 205         /// Returns value for key, and returns default_value if key does not
 206         /// exist in the config file.
 207         /// Throws std::logic_error if not constructed with an appname
 208         std::string GetKey(const std::string &key,
 209                 const std::string &default_value = "") const;
 210
 211         //
 212         // Global Configuration setting
 213         //
 214         void SetLastDevice(const Barry::Pin &pin);
 215         void SetVerboseLogging(bool verbose = true);
 216 };
 217
 218 BXEXPORT std::ostream& operator<< (std::ostream &os, const ConfigFile::DBListType &list);
 219
 220 } // namespace Barry
 221
 222 #endif
 223