src/database/database-files.h

   1 /*
   2 Minetest
   3 Copyright (C) 2017 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   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 // !!! WARNING !!!
  23 // This backend is intended to be used on Minetest 0.4.16 only for the transition backend
  24 // for player files
  25
  26 #include "database.h"
  27 #include <unordered_map>
  28 #include <unordered_set>
  29 #include <json/json.h>
  30
  31 class PlayerDatabaseFiles : public PlayerDatabase
  32 {
  33 public:
  34         PlayerDatabaseFiles(const std::string &savedir);
  35         virtual ~PlayerDatabaseFiles() = default;
  36
  37         void savePlayer(RemotePlayer *player);
  38         bool loadPlayer(RemotePlayer *player, PlayerSAO *sao);
  39         bool removePlayer(const std::string &name);
  40         void listPlayers(std::vector<std::string> &res);
  41
  42 private:
  43         void deSerialize(RemotePlayer *p, std::istream &is, const std::string &playername,
  44                         PlayerSAO *sao);
  45         /*
  46                 serialize() writes a bunch of text that can contain
  47                 any characters except a '\0', and such an ending that
  48                 deSerialize stops reading exactly at the right point.
  49         */
  50         void serialize(RemotePlayer *p, std::ostream &os);
  51
  52         std::string m_savedir;
  53 };
  54
  55 class AuthDatabaseFiles : public AuthDatabase
  56 {
  57 public:
  58         AuthDatabaseFiles(const std::string &savedir);
  59         virtual ~AuthDatabaseFiles() = default;
  60
  61         virtual bool getAuth(const std::string &name, AuthEntry &res);
  62         virtual bool saveAuth(const AuthEntry &authEntry);
  63         virtual bool createAuth(AuthEntry &authEntry);
  64         virtual bool deleteAuth(const std::string &name);
  65         virtual void listNames(std::vector<std::string> &res);
  66         virtual void reload();
  67
  68 private:
  69         std::unordered_map<std::string, AuthEntry> m_auth_list;
  70         std::string m_savedir;
  71         bool readAuthFile();
  72         bool writeAuthFile();
  73 };
  74
  75 class ModMetadataDatabaseFiles : public ModMetadataDatabase
  76 {
  77 public:
  78         ModMetadataDatabaseFiles(const std::string &savedir);
  79         virtual ~ModMetadataDatabaseFiles() = default;
  80
  81         virtual bool getModEntries(const std::string &modname, StringMap *storage);
  82         virtual bool setModEntry(const std::string &modname,
  83                 const std::string &key, const std::string &value);
  84         virtual bool removeModEntry(const std::string &modname, const std::string &key);
  85         virtual void listMods(std::vector<std::string> *res);
  86
  87         virtual void beginSave();
  88         virtual void endSave();
  89
  90 private:
  91         Json::Value *getOrCreateJson(const std::string &modname);
  92         bool writeJson(const std::string &modname, const Json::Value &json);
  93
  94         std::string m_storage_dir;
  95         std::unordered_map<std::string, Json::Value> m_mod_meta;
  96         std::unordered_set<std::string> m_modified;
  97 };