minetest/src/rollback_interface.cpp

238 lines
7.0 KiB
C++
Raw Normal View History

/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 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 "rollback_interface.h"
#include <sstream>
#include "util/serialize.h"
#include "util/string.h"
#include "util/numeric.h"
#include "map.h"
#include "gamedef.h"
#include "nodedef.h"
#include "nodemetadata.h"
#include "exceptions.h"
#include "log.h"
#include "inventorymanager.h"
#include "inventory.h"
#include "mapblock.h"
#define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
2014-06-26 02:28:41 +02:00
RollbackNode::RollbackNode(Map *map, v3s16 p, IGameDef *gamedef)
{
INodeDefManager *ndef = gamedef->ndef();
MapNode n = map->getNodeNoEx(p);
name = ndef->get(n).name;
param1 = n.param1;
param2 = n.param2;
NodeMetadata *metap = map->getNodeMetadata(p);
2014-06-26 02:28:41 +02:00
if (metap) {
std::ostringstream os(std::ios::binary);
metap->serialize(os);
meta = os.str();
}
}
2014-06-26 02:28:41 +02:00
std::string RollbackAction::toString() const
{
2014-06-26 02:28:41 +02:00
std::ostringstream os(std::ios::binary);
switch (type) {
case TYPE_SET_NODE:
os << "set_node " << PP(p);
os << ": (" << serializeJsonString(n_old.name);
os << ", " << itos(n_old.param1);
os << ", " << itos(n_old.param2);
os << ", " << serializeJsonString(n_old.meta);
os << ") -> (" << serializeJsonString(n_new.name);
os << ", " << itos(n_new.param1);
os << ", " << itos(n_new.param2);
os << ", " << serializeJsonString(n_new.meta);
os << ')';
case TYPE_MODIFY_INVENTORY_STACK:
os << "modify_inventory_stack (";
os << serializeJsonString(inventory_location);
os << ", " << serializeJsonString(inventory_list);
os << ", " << inventory_index;
os << ", " << (inventory_add ? "add" : "remove");
os << ", " << serializeJsonString(inventory_stack.getItemString());
os << ')';
default:
2014-06-26 02:28:41 +02:00
return "<unknown action>";
}
2014-06-26 02:28:41 +02:00
return os.str();
}
bool RollbackAction::isImportant(IGameDef *gamedef) const
{
2014-06-26 02:28:41 +02:00
if (type != TYPE_SET_NODE)
return true;
2014-06-26 02:28:41 +02:00
// If names differ, action is always important
if(n_old.name != n_new.name)
return true;
// If metadata differs, action is always important
if(n_old.meta != n_new.meta)
return true;
INodeDefManager *ndef = gamedef->ndef();
// Both are of the same name, so a single definition is needed
const ContentFeatures &def = ndef->get(n_old.name);
// If the type is flowing liquid, action is not important
if (def.liquid_type == LIQUID_FLOWING)
return false;
// Otherwise action is important
return true;
}
2014-06-26 02:28:41 +02:00
bool RollbackAction::getPosition(v3s16 *dst) const
{
2014-06-26 02:28:41 +02:00
switch (type) {
case TYPE_SET_NODE:
if (dst) *dst = p;
return true;
2014-06-26 02:28:41 +02:00
case TYPE_MODIFY_INVENTORY_STACK: {
InventoryLocation loc;
loc.deSerialize(inventory_location);
2014-06-26 02:28:41 +02:00
if (loc.type != InventoryLocation::NODEMETA) {
return false;
2014-06-26 02:28:41 +02:00
}
if (dst) *dst = loc.p;
return true; }
default:
return false;
}
}
2014-06-26 02:28:41 +02:00
bool RollbackAction::applyRevert(Map *map, InventoryManager *imgr, IGameDef *gamedef) const
{
2014-06-26 02:28:41 +02:00
try {
switch (type) {
case TYPE_NOTHING:
return true;
case TYPE_SET_NODE: {
INodeDefManager *ndef = gamedef->ndef();
// Make sure position is loaded from disk
map->emergeBlock(getContainerPos(p, MAP_BLOCKSIZE), false);
// Check current node
MapNode current_node = map->getNodeNoEx(p);
std::string current_name = ndef->get(current_node).name;
// If current node not the new node, it's bad
2014-06-26 02:28:41 +02:00
if (current_name != n_new.name) {
return false;
2014-06-26 02:28:41 +02:00
}
// Create rollback node
MapNode n(ndef, n_old.name, n_old.param1, n_old.param2);
// Set rollback node
2014-06-26 02:28:41 +02:00
try {
if (!map->addNodeWithEvent(p, n)) {
infostream << "RollbackAction::applyRevert(): "
<< "AddNodeWithEvent failed at "
<< PP(p) << " for " << n_old.name
<< std::endl;
return false;
}
2014-06-26 02:28:41 +02:00
if (n_old.meta.empty()) {
map->removeNodeMetadata(p);
} else {
NodeMetadata *meta = map->getNodeMetadata(p);
if (!meta) {
meta = new NodeMetadata(gamedef);
2014-06-26 02:28:41 +02:00
if (!map->setNodeMetadata(p, meta)) {
delete meta;
2014-06-26 02:28:41 +02:00
infostream << "RollbackAction::applyRevert(): "
<< "setNodeMetadata failed at "
<< PP(p) << " for " << n_old.name
<< std::endl;
return false;
}
}
std::istringstream is(n_old.meta, std::ios::binary);
meta->deSerialize(is);
}
2014-06-26 02:28:41 +02:00
// Inform other things that the meta data has changed
v3s16 blockpos = getContainerPos(p, MAP_BLOCKSIZE);
MapEditEvent event;
event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
event.p = blockpos;
map->dispatchEvent(&event);
// Set the block to be saved
MapBlock *block = map->getBlockNoCreateNoEx(blockpos);
2014-06-26 02:28:41 +02:00
if (block) {
block->raiseModified(MOD_STATE_WRITE_NEEDED,
2014-06-26 02:28:41 +02:00
"NodeMetaRef::reportMetadataChange");
}
} catch (InvalidPositionException &e) {
infostream << "RollbackAction::applyRevert(): "
<< "InvalidPositionException: " << e.what()
<< std::endl;
return false;
}
// Success
return true; }
case TYPE_MODIFY_INVENTORY_STACK: {
InventoryLocation loc;
loc.deSerialize(inventory_location);
2014-06-26 02:28:41 +02:00
std::string real_name = gamedef->idef()->getAlias(inventory_stack.name);
Inventory *inv = imgr->getInventory(loc);
2014-06-26 02:28:41 +02:00
if (!inv) {
infostream << "RollbackAction::applyRevert(): Could not get "
"inventory at " << inventory_location << std::endl;
return false;
}
InventoryList *list = inv->getList(inventory_list);
2014-06-26 02:28:41 +02:00
if (!list) {
infostream << "RollbackAction::applyRevert(): Could not get "
"inventory list \"" << inventory_list << "\" in "
<< inventory_location << std::endl;
return false;
}
2014-06-26 02:28:41 +02:00
if (list->getSize() <= inventory_index) {
infostream << "RollbackAction::applyRevert(): List index "
<< inventory_index << " too large in "
<< "inventory list \"" << inventory_list << "\" in "
<< inventory_location << std::endl;
}
// If item was added, take away item, otherwise add removed item
2014-06-26 02:28:41 +02:00
if (inventory_add) {
// Silently ignore different current item
2014-06-26 02:28:41 +02:00
if (list->getItem(inventory_index).name != real_name)
return false;
2014-06-26 02:28:41 +02:00
list->takeItem(inventory_index, inventory_stack.count);
} else {
2014-06-26 02:28:41 +02:00
list->addItem(inventory_index, inventory_stack);
}
// Inventory was modified; send to clients
imgr->setInventoryModified(loc);
return true; }
default:
2014-06-26 02:28:41 +02:00
errorstream << "RollbackAction::applyRevert(): type not handled"
<< std::endl;
return false;
}
2014-06-26 02:28:41 +02:00
} catch(SerializationError &e) {
errorstream << "RollbackAction::applyRevert(): n_old.name=" << n_old.name
<< ", SerializationError: " << e.what() << std::endl;
}
return false;
}