database.hpp 8.74 KB
Newer Older
1 2
#pragma once

3 4 5
#include <biboumi.h>
#ifdef USE_DATABASE

6 7 8
#include <database/table.hpp>
#include <database/column.hpp>
#include <database/count_query.hpp>
9

louiz’'s avatar
louiz’ committed
10 11
#include <database/engine.hpp>

12 13
#include <utils/optional_bool.hpp>

14
#include <chrono>
15 16 17
#include <string>

#include <memory>
18
#include <map>
19

20 21 22

class Database
{
23
 public:
24
  using time_point = std::chrono::system_clock::time_point;
25
  struct RecordNotFound: public std::exception {};
26
  enum class Paging { first, last };
27

28
  struct Uuid: Column<std::string> { static constexpr auto name = "uuid_"; };
29

30
  struct Owner: Column<std::string> { static constexpr auto name = "owner_"; };
31

louiz’'s avatar
louiz’ committed
32
  struct IrcChanName: Column<std::string> { static constexpr auto name = "ircchanname_"; };
33

34
  struct Channel: Column<std::string> { static constexpr auto name = "channel_"; };
35

louiz’'s avatar
louiz’ committed
36
  struct IrcServerName: Column<std::string> { static constexpr auto name = "ircservername_"; };
37

38
  struct Server: Column<std::string> { static constexpr auto name = "server_"; };
39

40
  struct Date: Column<time_point::rep> { static constexpr auto name = "date_"; };
41

42
  struct Body: Column<std::string> { static constexpr auto name = "body_"; };
43

44
  struct Nick: Column<std::string> { static constexpr auto name = "nick_"; };
45

46
  struct Pass: Column<std::string> { static constexpr auto name = "pass_"; };
47

48 49
  struct Ports: Column<std::string> { static constexpr auto name = "ports_";
    Ports(): Column<std::string>("6667") {} };
50

louiz’'s avatar
louiz’ committed
51
  struct TlsPorts: Column<std::string> { static constexpr auto name = "tlsports_";
52
    TlsPorts(): Column<std::string>("6697;6670") {} };
53

54
  struct Username: Column<std::string> { static constexpr auto name = "username_"; };
55

56
  struct Realname: Column<std::string> { static constexpr auto name = "realname_"; };
57

louiz’'s avatar
louiz’ committed
58
  struct AfterConnectionCommand: Column<std::string> { static constexpr auto name = "afterconnectioncommand_"; };
59

louiz’'s avatar
louiz’ committed
60
  struct TrustedFingerprint: Column<std::string> { static constexpr auto name = "trustedfingerprint_"; };
61

louiz’'s avatar
louiz’ committed
62
  struct EncodingOut: Column<std::string> { static constexpr auto name = "encodingout_"; };
63

louiz’'s avatar
louiz’ committed
64
  struct EncodingIn: Column<std::string> { static constexpr auto name = "encodingin_"; };
65

louiz’'s avatar
louiz’ committed
66
  struct MaxHistoryLength: Column<int> { static constexpr auto name = "maxhistorylength_";
67
    MaxHistoryLength(): Column<int>(20) {} };
68

louiz’'s avatar
louiz’ committed
69
  struct RecordHistory: Column<bool> { static constexpr auto name = "recordhistory_";
70
    RecordHistory(): Column<bool>(true) {}};
71

louiz’'s avatar
louiz’ committed
72
  struct RecordHistoryOptional: Column<OptionalBool> { static constexpr auto name = "recordhistory_"; };
73

louiz’'s avatar
louiz’ committed
74
  struct VerifyCert: Column<bool> { static constexpr auto name = "verifycert_";
75
    VerifyCert(): Column<bool>(true) {} };
76 77

  struct Persistent: Column<bool> { static constexpr auto name = "persistent_";
78
    Persistent(): Column<bool>(false) {} };
79

80 81 82
  struct GlobalPersistent: Column<bool> { static constexpr auto name = "persistent_";
    GlobalPersistent(); };

83 84 85 86
  struct LocalJid: Column<std::string> { static constexpr auto name = "local"; };

  struct RemoteJid: Column<std::string> { static constexpr auto name = "remote"; };

87
  struct Address: Column<std::string> { static constexpr auto name = "hostname_"; };
88

89 90 91
  using MucLogLineTable = Table<Id, Uuid, Owner, IrcChanName, IrcServerName, Date, Body, Nick>;
  using MucLogLine = MucLogLineTable::RowType;

92
  using GlobalOptionsTable = Table<Id, Owner, MaxHistoryLength, RecordHistory, GlobalPersistent>;
93 94
  using GlobalOptions = GlobalOptionsTable::RowType;

95
  using IrcServerOptionsTable = Table<Id, Owner, Server, Pass, AfterConnectionCommand, TlsPorts, Ports, Username, Realname, VerifyCert, TrustedFingerprint, EncodingOut, EncodingIn, MaxHistoryLength, Address>;
96 97
  using IrcServerOptions = IrcServerOptionsTable::RowType;

98
  using IrcChannelOptionsTable = Table<Id, Owner, Server, Channel, EncodingOut, EncodingIn, MaxHistoryLength, Persistent, RecordHistoryOptional>;
99 100
  using IrcChannelOptions = IrcChannelOptionsTable::RowType;

101 102 103
  using RosterTable = Table<LocalJid, RemoteJid>;
  using RosterItem = RosterTable::RowType;

104 105 106
  Database() = default;
  ~Database() = default;

louiz’'s avatar
louiz’ committed
107 108 109 110 111
  Database(const Database&) = delete;
  Database(Database&&) = delete;
  Database& operator=(const Database&) = delete;
  Database& operator=(Database&&) = delete;

112 113
  static GlobalOptions get_global_options(const std::string& owner);
  static IrcServerOptions get_irc_server_options(const std::string& owner,
114
                                                     const std::string& server);
115 116 117 118 119 120 121 122 123
  static IrcChannelOptions get_irc_channel_options(const std::string& owner,
                                                   const std::string& server,
                                                   const std::string& channel);
  static IrcChannelOptions get_irc_channel_options_with_server_default(const std::string& owner,
                                                                       const std::string& server,
                                                                       const std::string& channel);
  static IrcChannelOptions get_irc_channel_options_with_server_and_global_default(const std::string& owner,
                                                                                  const std::string& server,
                                                                                  const std::string& channel);
124 125
  /**
   * Get all the lines between (optional) start and end dates, with a (optional) limit.
126
   * If after_id is set, only the records after it will be returned.
127
   */
128
  static std::vector<MucLogLine> get_muc_logs(const std::string& owner, const std::string& chan_name, const std::string& server,
129
                                              int limit=-1, const std::string& start="", const std::string& end="",
130
                                              const Id::real_type reference_record_id=Id::unset_value, Paging=Paging::first);
131

132 133 134 135 136
  /**
   * Get just one single record matching the given uuid, between (optional) end and start.
   * If it does not exist (or is not between end and start), throw a RecordNotFound exception.
   */
  static MucLogLine get_muc_log(const std::string& owner, const std::string& chan_name, const std::string& server, const std::string& uuid, const std::string& start="", const std::string& end="");
137 138
  static std::string store_muc_message(const std::string& owner, const std::string& chan_name, const std::string& server_name,
                                       time_point date, const std::string& body, const std::string& nick);
139

140 141 142 143 144 145
  static void add_roster_item(const std::string& local, const std::string& remote);
  static bool has_roster_item(const std::string& local, const std::string& remote);
  static void delete_roster_item(const std::string& local, const std::string& remote);
  static std::vector<Database::RosterItem> get_contact_list(const std::string& local);
  static std::vector<Database::RosterItem> get_full_roster();

146
  static void close();
147
  static void open(const std::string& filename);
148

149
  template <typename TableType>
150
  static int64_t count(const TableType& table)
151 152
  {
    CountQuery query{table.get_name()};
louiz’'s avatar
louiz’ committed
153
    return query.execute(*Database::db);
154 155 156 157 158 159
  }

  static MucLogLineTable muc_log_lines;
  static GlobalOptionsTable global_options;
  static IrcServerOptionsTable irc_server_options;
  static IrcChannelOptionsTable irc_channel_options;
160
  static RosterTable roster;
louiz’'s avatar
louiz’ committed
161
  static std::unique_ptr<DatabaseEngine> db;
162

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
  /**
   * Some caches, to avoid doing very frequent query requests for a few options.
   */
  using CacheKey = std::tuple<std::string, std::string, std::string>;

  static EncodingIn::real_type get_encoding_in(const std::string& owner,
                                        const std::string& server,
                                        const std::string& channel)
  {
    CacheKey channel_key{owner, server, channel};
    auto it = Database::encoding_in_cache.find(channel_key);
    if (it == Database::encoding_in_cache.end())
      {
        auto options = Database::get_irc_channel_options_with_server_default(owner, server, channel);
        EncodingIn::real_type result = options.col<Database::EncodingIn>();
        if (result.empty())
          result = "ISO-8859-1";
        it = Database::encoding_in_cache.insert(std::make_pair(channel_key, result)).first;
      }
    return it->second;
  }
  static void invalidate_encoding_in_cache(const std::string& owner,
                                           const std::string& server,
                                           const std::string& channel)
  {
    CacheKey channel_key{owner, server, channel};
    Database::encoding_in_cache.erase(channel_key);
  }
  static void invalidate_encoding_in_cache()
  {
    Database::encoding_in_cache.clear();
  }

louiz’'s avatar
louiz’ committed
196 197 198 199 200
  static auto raw_exec(const std::string& query)
  {
    Database::db->raw_exec(query);
  }

201
 private:
202
  static std::string gen_uuid();
203
  static std::map<CacheKey, EncodingIn::real_type> encoding_in_cache;
204 205
};
#endif /* USE_DATABASE */