/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */ #include "base/serializer.hpp" #include "base/type.hpp" #include "base/application.hpp" #include "base/objectlock.hpp" #include "base/convert.hpp" #include "base/exception.hpp" #include "base/namespace.hpp" #include #include #include using namespace icinga; struct SerializeStackEntry { String Name; Value Val; }; CircularReferenceError::CircularReferenceError(String message, std::vector path) : m_Message(message), m_Path(path) { } const char *CircularReferenceError::what(void) const throw() { return m_Message.CStr(); } std::vector CircularReferenceError::GetPath() const { return m_Path; } struct SerializeStack { std::deque Entries; inline void Push(const String& name, const Value& val) { Object::Ptr obj; if (val.IsObject()) obj = val; if (obj) { for (const auto& entry : Entries) { if (entry.Val == obj) { std::vector path; for (const auto& entry : Entries) path.push_back(entry.Name); path.push_back(name); BOOST_THROW_EXCEPTION(CircularReferenceError("Cannot serialize object which recursively refers to itself. Attribute path which leads to the cycle: " + boost::algorithm::join(path, " -> "), path)); } } } Entries.push_back({ name, obj }); } inline void Pop() { Entries.pop_back(); } }; static Value SerializeInternal(const Value& value, int attributeTypes, SerializeStack& stack, bool dryRun); static Array::Ptr SerializeArray(const Array::Ptr& input, int attributeTypes, SerializeStack& stack, bool dryRun) { ArrayData result; if (!dryRun) { result.reserve(input->GetLength()); } ObjectLock olock(input); int index = 0; for (const Value& value : input) { stack.Push(Convert::ToString(index), value); auto serialized (SerializeInternal(value, attributeTypes, stack, dryRun)); if (!dryRun) { result.emplace_back(std::move(serialized)); } stack.Pop(); index++; } return dryRun ? nullptr : new Array(std::move(result)); } static Dictionary::Ptr SerializeDictionary(const Dictionary::Ptr& input, int attributeTypes, SerializeStack& stack, bool dryRun) { DictionaryData result; if (!dryRun) { result.reserve(input->GetLength()); } ObjectLock olock(input); for (const Dictionary::Pair& kv : input) { stack.Push(kv.first, kv.second); auto serialized (SerializeInternal(kv.second, attributeTypes, stack, dryRun)); if (!dryRun) { result.emplace_back(kv.first, std::move(serialized)); } stack.Pop(); } return dryRun ? nullptr : new Dictionary(std::move(result)); } static Dictionary::Ptr SerializeNamespace(const Namespace::Ptr& input, int attributeTypes, SerializeStack& stack, bool dryRun) { DictionaryData result; if (!dryRun) { result.reserve(input->GetLength()); } ObjectLock olock(input); for (const Namespace::Pair& kv : input) { Value val = kv.second.Val; stack.Push(kv.first, val); auto serialized (SerializeInternal(val, attributeTypes, stack, dryRun)); if (!dryRun) { result.emplace_back(kv.first, std::move(serialized)); } stack.Pop(); } return dryRun ? nullptr : new Dictionary(std::move(result)); } static Object::Ptr SerializeObject(const Object::Ptr& input, int attributeTypes, SerializeStack& stack, bool dryRun) { Type::Ptr type = input->GetReflectionType(); if (!type) return nullptr; DictionaryData fields; if (!dryRun) { fields.reserve(type->GetFieldCount() + 1); } ObjectLock olock(input); for (int i = 0; i < type->GetFieldCount(); i++) { Field field = type->GetFieldInfo(i); if (attributeTypes != 0 && (field.Attributes & attributeTypes) == 0) continue; if (strcmp(field.Name, "type") == 0) continue; Value value = input->GetField(i); stack.Push(field.Name, value); auto serialized (SerializeInternal(value, attributeTypes, stack, dryRun)); if (!dryRun) { fields.emplace_back(field.Name, std::move(serialized)); } stack.Pop(); } if (!dryRun) { fields.emplace_back("type", type->GetName()); } return dryRun ? nullptr : new Dictionary(std::move(fields)); } static Array::Ptr DeserializeArray(const Array::Ptr& input, bool safe_mode, int attributeTypes) { ArrayData result; result.reserve(input->GetLength()); ObjectLock olock(input); for (const Value& value : input) { result.emplace_back(Deserialize(value, safe_mode, attributeTypes)); } return new Array(std::move(result)); } static Dictionary::Ptr DeserializeDictionary(const Dictionary::Ptr& input, bool safe_mode, int attributeTypes) { DictionaryData result; result.reserve(input->GetLength()); ObjectLock olock(input); for (const Dictionary::Pair& kv : input) { result.emplace_back(kv.first, Deserialize(kv.second, safe_mode, attributeTypes)); } return new Dictionary(std::move(result)); } static Object::Ptr DeserializeObject(const Object::Ptr& object, const Dictionary::Ptr& input, bool safe_mode, int attributeTypes) { if (!object && safe_mode) BOOST_THROW_EXCEPTION(std::runtime_error("Tried to instantiate object while safe mode is enabled.")); Type::Ptr type; if (object) type = object->GetReflectionType(); else type = Type::GetByName(input->Get("type")); if (!type) return object; Object::Ptr instance; if (object) instance = object; else instance = type->Instantiate(std::vector()); ObjectLock olock(input); for (const Dictionary::Pair& kv : input) { if (kv.first.IsEmpty()) continue; int fid = type->GetFieldId(kv.first); if (fid < 0) continue; Field field = type->GetFieldInfo(fid); if ((field.Attributes & attributeTypes) == 0) continue; try { instance->SetField(fid, Deserialize(kv.second, safe_mode, attributeTypes), true); } catch (const std::exception&) { instance->SetField(fid, Empty); } } return instance; } static Value SerializeInternal(const Value& value, int attributeTypes, SerializeStack& stack, bool dryRun) { if (!value.IsObject()) return dryRun ? Empty : value; Object::Ptr input = value; Array::Ptr array = dynamic_pointer_cast(input); if (array) return SerializeArray(array, attributeTypes, stack, dryRun); Dictionary::Ptr dict = dynamic_pointer_cast(input); if (dict) return SerializeDictionary(dict, attributeTypes, stack, dryRun); Namespace::Ptr ns = dynamic_pointer_cast(input); if (ns) return SerializeNamespace(ns, attributeTypes, stack, dryRun); return SerializeObject(input, attributeTypes, stack, dryRun); } void icinga::AssertNoCircularReferences(const Value& value) { SerializeStack stack; SerializeInternal(value, FAConfig, stack, true); } Value icinga::Serialize(const Value& value, int attributeTypes) { SerializeStack stack; return SerializeInternal(value, attributeTypes, stack, false); } Value icinga::Deserialize(const Value& value, bool safe_mode, int attributeTypes) { return Deserialize(nullptr, value, safe_mode, attributeTypes); } Value icinga::Deserialize(const Object::Ptr& object, const Value& value, bool safe_mode, int attributeTypes) { if (!value.IsObject()) return value; Object::Ptr input = value; Array::Ptr array = dynamic_pointer_cast(input); if (array) return DeserializeArray(array, safe_mode, attributeTypes); Dictionary::Ptr dict = dynamic_pointer_cast(input); ASSERT(dict); if ((safe_mode && !object) || !dict->Contains("type")) return DeserializeDictionary(dict, safe_mode, attributeTypes); else return DeserializeObject(object, dict, safe_mode, attributeTypes); }