aboutsummaryrefslogtreecommitdiff
path: root/src/content_nodemeta.cpp
blob: 79a32b6bf9a51755850c29db45b200c4fcaec1b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
196
197
198
199
200
/*
Minetest
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "content_nodemeta.h"
#include "nodemetadata.h"
#include "nodetimer.h"
#include "inventory.h"
#include "log.h"
#include "serialization.h"
#include "util/serialize.h"
#include "util/string.h"
#include "constants.h" // MAP_BLOCKSIZE
#include <sstream>

#define NODEMETA_GENERIC 1
#define NODEMETA_SIGN 14
#define NODEMETA_CHEST 15
#define NODEMETA_FURNACE 16
#define NODEMETA_LOCKABLE_CHEST 17

// Returns true if node timer must be set
static bool content_nodemeta_deserialize_legacy_body(
		std::istream &is, s16 id, NodeMetadata *meta)
{
	meta->clear();

	if(id == NODEMETA_GENERIC) // GenericNodeMetadata (0.4-dev)
	{
		meta->getInventory()->deSerialize(is);
		deSerializeLongString(is);  // m_text
		deSerializeString(is);  // m_owner

		meta->setString("infotext",deSerializeString(is));
		meta->setString("formspec",deSerializeString(is));
		readU8(is);  // m_allow_text_input
		readU8(is);  // m_allow_removal
		readU8(is);  // m_enforce_owner

		int num_vars = readU32(is);
		for(int i=0; i<num_vars; i++){
			std::string name = deSerializeString(is);
			std::string var = deSerializeLongString(is);
			meta->setString(name, var);
		}
		return false;
	}
	else if(id == NODEMETA_SIGN) // SignNodeMetadata
	{
		meta->setString("text", deSerializeString(is));
		//meta->setString("infotext","\"${text}\"");
		meta->setString("infotext",
				std::string("\"") + meta->getString("text") + "\"");
		meta->setString("formspec","field[text;;${text}]");
		return false;
	}
	else if(id == NODEMETA_CHEST) // ChestNodeMetadata
	{
		meta->getInventory()->deSerialize(is);

		// Rename inventory list "0" to "main"
		Inventory *inv = meta->getInventory();
		if(!inv->getList("main") && inv->getList("0")){
			inv->getList("0")->setName("main");
		}
		assert(inv->getList("main") && !inv->getList("0"));

		meta->setString("formspec","size[8,9]"
				"list[current_name;main;0,0;8,4;]"
				"list[current_player;main;0,5;8,4;]");
		return false;
	}
	else if(id == NODEMETA_LOCKABLE_CHEST) // LockingChestNodeMetadata
	{
		meta->setString("owner", deSerializeString(is));
		meta->getInventory()->deSerialize(is);

		// Rename inventory list "0" to "main"
		Inventory *inv = meta->getInventory();
		if(!inv->getList("main") && inv->getList("0")){
			inv->getList("0")->setName("main");
		}
		assert(inv->getList("main") && !inv->getList("0"));

		meta->setString("formspec","size[8,9]"
				"list[current_name;main;0,0;8,4;]"
				"list[current_player;main;0,5;8,4;]");
		return false;
	}
	else if(id == NODEMETA_FURNACE) // FurnaceNodeMetadata
	{
		meta->getInventory()->deSerialize(is);
		int temp = 0;
		is>>temp;
		meta->setString("fuel_totaltime", ftos((float)temp/10));
		temp = 0;
		is>>temp;
		meta->setString("fuel_time", ftos((float)temp/10));
		temp = 0;
		is>>temp;
		//meta->setString("src_totaltime", ftos((float)temp/10));
		temp = 0;
		is>>temp;
		meta->setString("src_time", ftos((float)temp/10));

		meta->setString("formspec","size[8,9]"
			"list[current_name;fuel;2,3;1,1;]"
			"list[current_name;src;2,1;1,1;]"
			"list[current_name;dst;5,1;2,2;]"
			"list[current_player;main;0,5;8,4;]");
		return true;
	}
	else
	{
		throw SerializationError("Unknown legacy node metadata");
	}
}

static bool content_nodemeta_deserialize_legacy_meta(
		std::istream &is, NodeMetadata *meta)
{
	// Read id
	s16 id = readS16(is);

	// Read data
	std::string data = deSerializeString(is);
	std::istringstream tmp_is(data, std::ios::binary);
	return content_nodemeta_deserialize_legacy_body(tmp_is, id, meta);
}

void content_nodemeta_deserialize_legacy(std::istream &is,
		NodeMetadataList *meta, NodeTimerList *timers,
		IItemDefManager *item_def_mgr)
{
	meta->clear();
	timers->clear();

	u16 version = readU16(is);

	if(version > 1)
	{
		infostream<<FUNCTION_NAME<<": version "<<version<<" not supported"
				<<std::endl;
		throw SerializationError(FUNCTION_NAME);
	}

	u16 count = readU16(is);

	for(u16 i=0; i<count; i++)
	{
		u16 p16 = readU16(is);

		v3s16 p(0,0,0);
		p.Z += p16 / MAP_BLOCKSIZE / MAP_BLOCKSIZE;
		p16 -= p.Z * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
		p.Y += p16 / MAP_BLOCKSIZE;
		p16 -= p.Y * MAP_BLOCKSIZE;
		p.X += p16;

		if(meta->get(p) != NULL)
		{
			warningstream<<FUNCTION_NAME<<": "
					<<"already set data at position"
					<<"("<<p.X<<","<<p.Y<<","<<p.Z<<"): Ignoring."
					<<std::endl;
			continue;
		}

		NodeMetadata *data = new NodeMetadata(item_def_mgr);
		bool need_timer = content_nodemeta_deserialize_legacy_meta(is, data);
		meta->set(p, data);

		if(need_timer)
			timers->set(NodeTimer(1., 0., p));
	}
}

void content_nodemeta_serialize_legacy(std::ostream &os, NodeMetadataList *meta)
{
	// Sorry, I was too lazy to implement this. --kahrl
	writeU16(os, 1); // version
	writeU16(os, 0); // count
}

// END
span class="hl kwd">removeEventReceiver(MapEventReceiver *event_receiver); // event shall be deleted by caller after the call. void dispatchEvent(MapEditEvent *event); // On failure returns NULL MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d); // Same as the above (there exists no lock anymore) MapSector * getSectorNoGenerateNoEx(v2s16 p2d); // On failure throws InvalidPositionException MapSector * getSectorNoGenerate(v2s16 p2d); // Gets an existing sector or creates an empty one //MapSector * getSectorCreate(v2s16 p2d); /* This is overloaded by ClientMap and ServerMap to allow their differing fetch methods. */ virtual MapSector * emergeSector(v2s16 p){ return NULL; } virtual MapSector * emergeSector(v2s16 p, std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; } // Returns InvalidPositionException if not found MapBlock * getBlockNoCreate(v3s16 p); // Returns NULL if not found MapBlock * getBlockNoCreateNoEx(v3s16 p); /* Server overrides */ virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true) { return getBlockNoCreateNoEx(p); } // Returns InvalidPositionException if not found bool isNodeUnderground(v3s16 p); bool isValidPosition(v3s16 p); // throws InvalidPositionException if not found void setNode(v3s16 p, MapNode & n); // Returns a CONTENT_IGNORE node if not found // If is_valid_position is not NULL then this will be set to true if the // position is valid, otherwise false MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL); void unspreadLight(enum LightBank bank, std::map<v3s16, u8> & from_nodes, std::set<v3s16> & light_sources, std::map<v3s16, MapBlock*> & modified_blocks); void unLightNeighbors(enum LightBank bank, v3s16 pos, u8 lightwas, std::set<v3s16> & light_sources, std::map<v3s16, MapBlock*> & modified_blocks); void spreadLight(enum LightBank bank, std::set<v3s16> & from_nodes, std::map<v3s16, MapBlock*> & modified_blocks); void lightNeighbors(enum LightBank bank, v3s16 pos, std::map<v3s16, MapBlock*> & modified_blocks); v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p); s16 propagateSunlight(v3s16 start, std::map<v3s16, MapBlock*> & modified_blocks); void updateLighting(enum LightBank bank, std::map<v3s16, MapBlock*> & a_blocks, std::map<v3s16, MapBlock*> & modified_blocks); void updateLighting(std::map<v3s16, MapBlock*> & a_blocks, std::map<v3s16, MapBlock*> & modified_blocks); /* These handle lighting but not faces. */ void addNodeAndUpdate(v3s16 p, MapNode n, std::map<v3s16, MapBlock*> &modified_blocks, bool remove_metadata = true); void removeNodeAndUpdate(v3s16 p, std::map<v3s16, MapBlock*> &modified_blocks); /* Wrappers for the latter ones. These emit events. Return true if succeeded, false if not. */ bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true); bool removeNodeWithEvent(v3s16 p); /* Takes the blocks at the edges into account */ bool getDayNightDiff(v3s16 blockpos); //core::aabbox3d<s16> getDisplayedBlockArea(); //bool updateChangedVisibleArea(); // Call these before and after saving of many blocks virtual void beginSave() { return; } virtual void endSave() { return; } virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); } // Server implements these. // Client leaves them as no-op. virtual bool saveBlock(MapBlock *block) { return false; } virtual bool deleteBlock(v3s16 blockpos) { return false; } /* Updates usage timers and unloads unused blocks and sectors. Saves modified blocks before unloading on MAPTYPE_SERVER. */ void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks, std::vector<v3s16> *unloaded_blocks=NULL); /* Unloads all blocks with a zero refCount(). Saves modified blocks before unloading on MAPTYPE_SERVER. */ void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL); // Deletes sectors and their blocks from memory // Takes cache into account // If deleted sector is in sector cache, clears cache void deleteSectors(std::vector<v2s16> &list); // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: " virtual void PrintInfo(std::ostream &out); void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks); /* Node metadata These are basically coordinate wrappers to MapBlock */ std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2); NodeMetadata *getNodeMetadata(v3s16 p); /** * Sets metadata for a node. * This method sets the metadata for a given node. * On success, it returns @c true and the object pointed to * by @p meta is then managed by the system and should * not be deleted by the caller. * * In case of failure, the method returns @c false and the * caller is still responsible for deleting the object! * * @param p node coordinates * @param meta pointer to @c NodeMetadata object * @return @c true on success, false on failure */ bool setNodeMetadata(v3s16 p, NodeMetadata *meta); void removeNodeMetadata(v3s16 p); /* Node Timers These are basically coordinate wrappers to MapBlock */ NodeTimer getNodeTimer(v3s16 p); void setNodeTimer(v3s16 p, NodeTimer t); void removeNodeTimer(v3s16 p); /* Misc. */ std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;} /* Variables */ void transforming_liquid_add(v3s16 p); s32 transforming_liquid_size(); protected: friend class LuaVoxelManip; std::ostream &m_dout; // A bit deprecated, could be removed IGameDef *m_gamedef; std::set<MapEventReceiver*> m_event_receivers; std::map<v2s16, MapSector*> m_sectors; // Be sure to set this to NULL when the cached sector is deleted MapSector *m_sector_cache; v2s16 m_sector_cache_p; // Queued transforming water nodes UniqueQueue<v3s16> m_transforming_liquid; private: f32 m_transforming_liquid_loop_count_multiplier; u32 m_unprocessed_count; u32 m_inc_trending_up_start_time; // milliseconds bool m_queue_size_timer_started; DISABLE_CLASS_COPY(Map); }; /* ServerMap This is the only map class that is able to generate map. */ class ServerMap : public Map { public: /* savedir: directory to which map data should be saved */ ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge); ~ServerMap(); s32 mapType() const { return MAPTYPE_SERVER; } /* Get a sector from somewhere. - Check memory - Check disk (doesn't load blocks) - Create blank one */ ServerMapSector *createSector(v2s16 p); /* Blocks are generated by using these and makeBlock(). */ bool initBlockMake(v3s16 blockpos, BlockMakeData *data); void finishBlockMake(BlockMakeData *data, std::map<v3s16, MapBlock*> *changed_blocks); /* Get a block from somewhere. - Memory - Create blank */ MapBlock *createBlock(v3s16 p); /* Forcefully get a block from somewhere. - Memory - Load from disk - Create blank filled with CONTENT_IGNORE */ MapBlock *emergeBlock(v3s16 p, bool create_blank=true); /* Try to get a block. If it does not exist in memory, add it to the emerge queue. - Memory - Emerge Queue (deferred disk or generate) */ MapBlock *getBlockOrEmerge(v3s16 p3d); // Carries out any initialization necessary before block is sent void prepareBlock(MapBlock *block); // Helper for placing objects on ground level s16 findGroundLevel(v2s16 p2d); /* Misc. helper functions for fiddling with directory and file names when saving */ void createDirs(std::string path); // returns something like "map/sectors/xxxxxxxx" std::string getSectorDir(v2s16 pos, int layout = 2); // dirname: final directory name v2s16 getSectorPos(std::string dirname); v3s16 getBlockPos(std::string sectordir, std::string blockfile); static std::string getBlockFilename(v3s16 p); /* Database functions */ static Database *createDatabase(const std::string &name, const std::string &savedir, Settings &conf); // Verify we can read/write to the database void verifyDatabase(); // Returns true if the database file does not exist bool loadFromFolders(); // Call these before and after saving of blocks void beginSave(); void endSave(); void save(ModifiedState save_level); void listAllLoadableBlocks(std::vector<v3s16> &dst); void listAllLoadedBlocks(std::vector<v3s16> &dst); // Saves map seed and possibly other stuff void saveMapMeta(); void loadMapMeta(); /*void saveChunkMeta(); void loadChunkMeta();*/ // The sector mutex should be locked when calling most of these // This only saves sector-specific data such as the heightmap // (no MapBlocks) // DEPRECATED? Sectors have no metadata anymore. void saveSectorMeta(ServerMapSector *sector); MapSector* loadSectorMeta(std::string dirname, bool save_after_load); bool loadSectorMeta(v2s16 p2d); // Full load of a sector including all blocks. // returns true on success, false on failure. bool loadSectorFull(v2s16 p2d); // If sector is not found in memory, try to load it from disk. // Returns true if sector now resides in memory //bool deFlushSector(v2s16 p2d); bool saveBlock(MapBlock *block); static bool saveBlock(MapBlock *block, Database *db); // This will generate a sector with getSector if not found. void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false); MapBlock* loadBlock(v3s16 p); // Database version void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false); bool deleteBlock(v3s16 blockpos); void updateVManip(v3s16 pos); // For debug printing virtual void PrintInfo(std::ostream &out); bool isSavingEnabled(){ return m_map_saving_enabled; } u64 getSeed(); s16 getWaterLevel(); private: // Emerge manager EmergeManager *m_emerge; std::string m_savedir; bool m_map_saving_enabled; #if 0 // Chunk size in MapSectors // If 0, chunks are disabled. s16 m_chunksize; // Chunks core::map<v2s16, MapChunk*> m_chunks; #endif /* Metadata is re-written on disk only if this is true. This is reset to false when written on disk. */ bool m_map_metadata_changed; Database *dbase; }; #define VMANIP_BLOCK_DATA_INEXIST 1 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2 class MMVManip : public VoxelManipulator { public: MMVManip(Map *map); virtual ~MMVManip(); virtual void clear() { VoxelManipulator::clear(); m_loaded_blocks.clear(); } void setMap(Map *map) {m_map = map;} void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max, bool load_if_inexistent = true); // This is much faster with big chunks of generated data void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks, bool overwrite_generated = true); bool m_is_dirty; protected: bool m_create_area; Map *m_map; /* key = blockpos value = flags describing the block */ std::map<v3s16, u8> m_loaded_blocks; }; #endif