src/database/database.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include <set>
  23 #include <string>
  24 #include <vector>
  25 #include "irr_v3d.h"
  26 #include "irrlichttypes.h"
  27 #include "util/basic_macros.h"
  28
  29 class Database
  30 {
  31 public:
  32         virtual void beginSave() = 0;
  33         virtual void endSave() = 0;
  34         virtual bool initialized() const { return true; }
  35         virtual void pingDatabase() {}
  36 };
  37
  38 class MapDatabase : public Database
  39 {
  40 public:
  41         virtual ~MapDatabase() = default;
  42
  43         virtual bool saveBlock(const v3s16 &pos, const std::string &data) = 0;
  44         virtual void loadBlock(const v3s16 &pos, std::string *block) = 0;
  45         virtual bool deleteBlock(const v3s16 &pos) = 0;
  46
  47         static s64 getBlockAsInteger(const v3s16 &pos);
  48         static v3s16 getIntegerAsBlock(s64 i);
  49
  50         virtual void listAllLoadableBlocks(std::vector<v3s16> &dst) = 0;
  51 };
  52
  53 class PlayerSAO;
  54 class RemotePlayer;
  55
  56 class PlayerDatabase
  57 {
  58 public:
  59         virtual ~PlayerDatabase() = default;
  60
  61         virtual void pingDatabase() {}
  62
  63         virtual void savePlayer(RemotePlayer *player) = 0;
  64         virtual bool loadPlayer(RemotePlayer *player, PlayerSAO *sao) = 0;
  65         virtual bool removePlayer(const std::string &name) = 0;
  66         virtual void listPlayers(std::vector<std::string> &res) = 0;
  67 };
  68
  69 struct AuthEntry
  70 {
  71         u64 id;
  72         std::string name;
  73         std::string password;
  74         std::vector<std::string> privileges;
  75         s64 last_login;
  76 };
  77
  78 class AuthDatabase
  79 {
  80 public:
  81         virtual ~AuthDatabase() = default;
  82
  83         virtual bool getAuth(const std::string &name, AuthEntry &res) = 0;
  84         virtual bool saveAuth(const AuthEntry &authEntry) = 0;
  85         virtual bool createAuth(AuthEntry &authEntry) = 0;
  86         virtual bool deleteAuth(const std::string &name) = 0;
  87         virtual void listNames(std::vector<std::string> &res) = 0;
  88         virtual void reload() = 0;
  89         virtual void pingDatabase() {}
  90 };