1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-24 22:14:36 +02:00

Fix: ID-collisions when processing large mods collections

This commit is contained in:
Dmitry Orlov 2021-04-25 15:07:06 +03:00
parent 4063ab5894
commit 8b08973283
5 changed files with 100 additions and 40 deletions

View File

@ -261,6 +261,28 @@ bool JsonNode::isCompact() const
} }
} }
bool JsonNode::TryBoolFromString(bool & success) const
{
success = true;
if(type == JsonNode::JsonType::DATA_BOOL)
return Bool();
success = type == JsonNode::JsonType::DATA_STRING;
if(success)
{
auto boolParamStr = String();
boost::algorithm::trim(boolParamStr);
boost::algorithm::to_lower(boolParamStr);
success = boolParamStr == "true";
if(success)
return true;
success = boolParamStr == "false";
}
return false;
}
void JsonNode::clear() void JsonNode::clear()
{ {
setType(JsonType::DATA_NULL); setType(JsonType::DATA_NULL);
@ -623,7 +645,17 @@ std::shared_ptr<ILimiter> JsonUtils::parseLimiter(const JsonNode & limiter)
{ {
creatureLimiter->setCreature(CreatureID(creature)); creatureLimiter->setCreature(CreatureID(creature));
}); });
creatureLimiter->includeUpgrades = parameters.size() > 1 ? parameters[1].Bool() : false; auto includeUpgrades = false;
if(parameters.size() > 1)
{
bool success = true;
includeUpgrades = parameters[1].TryBoolFromString(success);
if(!success)
logMod->error("Second parameter of '%s' limiter should be Bool", limiterType);
}
creatureLimiter->includeUpgrades = includeUpgrades;
return creatureLimiter; return creatureLimiter;
} }
else if(limiterType == "HAS_ANOTHER_BONUS_LIMITER") else if(limiterType == "HAS_ANOTHER_BONUS_LIMITER")

View File

@ -87,6 +87,9 @@ public:
/// removes all data from node and sets type to null /// removes all data from node and sets type to null
void clear(); void clear();
/// returns bool or bool equivalent of string value if 'success' is true, or false otherwise
bool TryBoolFromString(bool & success) const;
/// non-const accessors, node will change type on type mismatch /// non-const accessors, node will change type on type mismatch
bool & Bool(); bool & Bool();
double & Float(); double & Float();

View File

@ -148,30 +148,43 @@ std::vector<JsonNode> CObjectClassesHandler::loadLegacyData(size_t dataSize)
/// selects preferred ID (or subID) for new object /// selects preferred ID (or subID) for new object
template<typename Map> template<typename Map>
si32 selectNextID(const JsonNode & fixedID, const Map & map, si32 defaultID) si32 selectNextID(const JsonNode & fixedID, const Map & map, si32 fixedObjectsBound)
{ {
if (!fixedID.isNull() && (si32)fixedID.Float() < defaultID) assert(fixedObjectsBound > 0);
return static_cast<si32>(fixedID.Float()); // H3M object with fixed ID if(fixedID.isNull())
{
auto lastID = map.empty() ? 0 : map.rbegin()->first;
return lastID < fixedObjectsBound ? fixedObjectsBound : lastID + 1;
}
auto id = static_cast<si32>(fixedID.Float());
if(id >= fixedObjectsBound)
logGlobal->error("Getting next ID overflowed: %d >= %d", id, fixedObjectsBound);
if (map.empty()) return id;
return defaultID; // no objects loaded, keep gap for H3M objects
if (map.rbegin()->first >= defaultID)
return map.rbegin()->first + 1; // some modded objects loaded, return next available
return defaultID; // some H3M objects loaded, first modded found
} }
void CObjectClassesHandler::loadObjectEntry(const std::string & identifier, const JsonNode & entry, ObjectContainter * obj) void CObjectClassesHandler::loadObjectEntry(const std::string & identifier, const JsonNode & entry, ObjectContainter * obj, bool isSubobject)
{ {
if (!handlerConstructors.count(obj->handlerName)) static const si32 fixedObjectsBound = 1000; // legacy value for backward compatibilitty
static const si32 fixedSubobjectsBound = 10000000; // large enough arbitrary value to avoid ID-collisions
si32 usedBound = fixedObjectsBound;
if(!handlerConstructors.count(obj->handlerName))
{ {
logGlobal->error("Handler with name %s was not found!", obj->handlerName); logGlobal->error("Handler with name %s was not found!", obj->handlerName);
return; return;
} }
const auto convertedId = VLC->modh->normalizeIdentifier(entry.meta, "core", identifier);
const auto & entryIndex = entry["index"];
bool useSelectNextID = !isSubobject || entryIndex.isNull();
std::string convertedId = VLC->modh->normalizeIdentifier(entry.meta, "core", identifier); if(useSelectNextID && isSubobject)
{
si32 id = selectNextID(entry["index"], obj->subObjects, 1000); usedBound = fixedSubobjectsBound;
logGlobal->error("Subobject index is Null. convertedId = '%s' obj->id = %d", convertedId, obj->id);
}
si32 id = useSelectNextID ? selectNextID(entryIndex, obj->subObjects, usedBound)
: (si32)entryIndex.Float();
auto handler = handlerConstructors.at(obj->handlerName)(); auto handler = handlerConstructors.at(obj->handlerName)();
handler->setType(obj->id, id); handler->setType(obj->id, id);
@ -196,46 +209,54 @@ void CObjectClassesHandler::loadObjectEntry(const std::string & identifier, cons
//some mods redefine content handlers in the decoration.json in such way: //some mods redefine content handlers in the decoration.json in such way:
//"core:sign" : { "types" : { "forgeSign" : { ... //"core:sign" : { "types" : { "forgeSign" : { ...
static const std::vector<std::string> knownProblemObjects static const std::vector<std::string> breakersRMG
{ {
"hota.hota decorations:hotaPandoraBox" "hota.hota decorations:hotaPandoraBox"
, "hota.hota decorations:hotaSubterreanGate" , "hota.hota decorations:hotaSubterreanGate"
}; };
bool overrideForce = !obj->subObjects.count(id) || const bool isExistingKey = obj->subObjects.count(id) > 0;
std::any_of(knownProblemObjects.begin(), knownProblemObjects.end(), [obj, id](const std::string & str) const bool isBreaker = std::any_of(breakersRMG.begin(), breakersRMG.end(),
{ [&handler](const std::string & str)
return str.compare(obj->subObjects[id]->subTypeName) == 0; {
}); return str.compare(handler->subTypeName) == 0;
});
const bool passedHandler = !isExistingKey && !isBreaker;
if (overrideForce) // DO NOT override mod handlers by default if(passedHandler)
{ {
obj->subObjects[id] = handler; obj->subObjects[id] = handler;
obj->subIds[convertedId] = id; obj->subIds[convertedId] = id;
} }
else if(isExistingKey) //It's supposed that fan mods handlers are not overridden by default handlers
{
logGlobal->trace("Handler '%s' has not been overridden with handler '%s' in object %s(%d)::%s(%d)",
obj->subObjects[id]->subTypeName, obj->handlerName, obj->identifier, obj->id, convertedId, id);
}
else else
{ {
logGlobal->warn("Don't override handler %s in object %s(%d)::%s(%d) subTypeName : %s" logGlobal->warn("Handler '%s' for object %s(%d)::%s(%d) has not been activated as RMG breaker",
, obj->handlerName, obj->identifier, obj->id, convertedId, id, obj->subObjects[id]->subTypeName); obj->handlerName, obj->identifier, obj->id, convertedId, id);
} }
} }
CObjectClassesHandler::ObjectContainter * CObjectClassesHandler::loadFromJson(const JsonNode & json, const std::string & name) CObjectClassesHandler::ObjectContainter * CObjectClassesHandler::loadFromJson(const JsonNode & json, const std::string & name)
{ {
auto obj = new ObjectContainter(); auto obj = new ObjectContainter();
static const si32 fixedObjectsBound = 256; //Legacy value for backward compatibility
obj->identifier = name; obj->identifier = name;
obj->name = json["name"].String(); obj->name = json["name"].String();
obj->handlerName = json["handler"].String(); obj->handlerName = json["handler"].String();
obj->base = json["base"]; obj->base = json["base"];
obj->id = selectNextID(json["index"], objects, 256); obj->id = selectNextID(json["index"], objects, fixedObjectsBound);
if(json["defaultAiValue"].isNull()) if(json["defaultAiValue"].isNull())
obj->groupDefaultAiValue = boost::none; obj->groupDefaultAiValue = boost::none;
else else
obj->groupDefaultAiValue = static_cast<boost::optional<si32>>(json["defaultAiValue"].Integer()); obj->groupDefaultAiValue = static_cast<boost::optional<si32>>(json["defaultAiValue"].Integer());
for (auto entry : json["types"].Struct()) for (auto entry : json["types"].Struct())
{
loadObjectEntry(entry.first, entry.second, obj); loadObjectEntry(entry.first, entry.second, obj);
}
return obj; return obj;
} }
@ -257,6 +278,8 @@ void CObjectClassesHandler::loadObject(std::string scope, std::string name, cons
void CObjectClassesHandler::loadSubObject(const std::string & identifier, JsonNode config, si32 ID, boost::optional<si32> subID) void CObjectClassesHandler::loadSubObject(const std::string & identifier, JsonNode config, si32 ID, boost::optional<si32> subID)
{ {
static const bool isSubObject = true;
config.setType(JsonNode::JsonType::DATA_STRUCT); // ensure that input is not NULL config.setType(JsonNode::JsonType::DATA_STRUCT); // ensure that input is not NULL
assert(objects.count(ID)); assert(objects.count(ID));
if (subID) if (subID)
@ -265,10 +288,8 @@ void CObjectClassesHandler::loadSubObject(const std::string & identifier, JsonNo
assert(config["index"].isNull()); assert(config["index"].isNull());
config["index"].Float() = subID.get(); config["index"].Float() = subID.get();
} }
inheritNodeWithMeta(config, objects.at(ID)->base); inheritNodeWithMeta(config, objects.at(ID)->base);
loadObjectEntry(identifier, config, objects[ID], isSubObject);
loadObjectEntry(identifier, config, objects[ID]);
} }
void CObjectClassesHandler::removeSubObject(si32 ID, si32 subID) void CObjectClassesHandler::removeSubObject(si32 ID, si32 subID)

View File

@ -283,8 +283,9 @@ class DLL_LINKAGE CObjectClassesHandler : public IHandlerBase
/// format: customNames[primaryID][secondaryID] -> name /// format: customNames[primaryID][secondaryID] -> name
std::map<si32, std::vector<std::string>> customNames; std::map<si32, std::vector<std::string>> customNames;
void loadObjectEntry(const std::string & identifier, const JsonNode & entry, ObjectContainter * obj); void loadObjectEntry(const std::string & identifier, const JsonNode & entry, ObjectContainter * obj, bool isSubobject = false);
ObjectContainter * loadFromJson(const JsonNode & json, const std::string & name); ObjectContainter * loadFromJson(const JsonNode & json, const std::string & name);
public: public:
CObjectClassesHandler(); CObjectClassesHandler();
~CObjectClassesHandler(); ~CObjectClassesHandler();

View File

@ -144,21 +144,24 @@ CDwellingInstanceConstructor::CDwellingInstanceConstructor()
void CDwellingInstanceConstructor::initTypeData(const JsonNode & input) void CDwellingInstanceConstructor::initTypeData(const JsonNode & input)
{ {
const JsonVector & levels = input["creatures"].Vector(); const JsonVector & levels = input["creatures"].Vector();
availableCreatures.resize(levels.size()); const auto totalLevels = levels.size();
for (size_t i=0; i<levels.size(); i++)
availableCreatures.resize(totalLevels);
for(auto currentLevel = 0; currentLevel < totalLevels; currentLevel++)
{ {
const JsonVector & creatures = levels[i].Vector(); const JsonVector & creaturesOnLevel = levels[currentLevel].Vector();
availableCreatures[i].resize(creatures.size()); const auto creaturesNumber = creaturesOnLevel.size();
for (size_t j=0; j<creatures.size(); j++) availableCreatures[currentLevel].resize(creaturesNumber);
for(auto currentCreature = 0; currentCreature < creaturesNumber; currentCreature++)
{ {
VLC->modh->identifiers.requestIdentifier("creature", creatures[j], [=] (si32 index) VLC->modh->identifiers.requestIdentifier("creature", creaturesOnLevel[currentCreature], [=] (si32 index)
{ {
availableCreatures[i][j] = VLC->creh->creatures[index]; availableCreatures[currentLevel][currentCreature] = VLC->creh->creatures[index];
}); });
} }
assert(!availableCreatures[i].empty()); assert(!availableCreatures[currentLevel].empty());
} }
guards = input["guards"]; guards = input["guards"];
} }