mirror of https://github.com/nymea/nymea.git
440 lines
16 KiB
C++
440 lines
16 KiB
C++
/****************************************************************************
|
|
* *
|
|
* This file is part of guh. *
|
|
* *
|
|
* Guh is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, version 2 of the License. *
|
|
* *
|
|
* Guh 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 General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with guh. If not, see <http://www.gnu.org/licenses/>. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
#include "jsontypes.h"
|
|
|
|
#include "device.h"
|
|
|
|
#include <QStringList>
|
|
#include <QJsonDocument>
|
|
#include <QDebug>
|
|
|
|
bool JsonTypes::s_initialized = false;
|
|
QString JsonTypes::s_lastError;
|
|
|
|
QVariantList JsonTypes::s_basicTypes;
|
|
QVariantList JsonTypes::s_ruleTypes;
|
|
|
|
QVariantMap JsonTypes::s_paramType;
|
|
QVariantMap JsonTypes::s_param;
|
|
QVariantMap JsonTypes::s_stateType;
|
|
QVariantMap JsonTypes::s_state;
|
|
QVariantMap JsonTypes::s_eventType;
|
|
QVariantMap JsonTypes::s_event;
|
|
QVariantMap JsonTypes::s_actionType;
|
|
QVariantMap JsonTypes::s_action;
|
|
QVariantMap JsonTypes::s_plugin;
|
|
QVariantMap JsonTypes::s_deviceClass;
|
|
QVariantMap JsonTypes::s_device;
|
|
QVariantMap JsonTypes::s_rule;
|
|
|
|
void JsonTypes::init()
|
|
{
|
|
// BasicTypes
|
|
s_basicTypes << "uuid" << "string" << "integer" << "double" << "bool";
|
|
s_ruleTypes << "RuleTypeMatchAll" << "RuleTypeMatchAny";
|
|
|
|
// ParamType
|
|
s_paramType.insert("name", "string");
|
|
s_paramType.insert("type", basicTypesRef());
|
|
// s_paramType.insert("default", "value");
|
|
// s_paramType.insert("value", "value");
|
|
|
|
// Param
|
|
s_param.insert("name", "string");
|
|
s_param.insert("value", basicTypesRef());
|
|
|
|
// StateType
|
|
s_stateType.insert("id", "uuid");
|
|
s_stateType.insert("name", "string");
|
|
s_stateType.insert("type", basicTypesRef());
|
|
// s_stateType.insert("default", "value");
|
|
|
|
// State
|
|
s_state.insert("stateTypeId", "uuid");
|
|
s_state.insert("deviceId", "uuid");
|
|
s_state.insert("value", "variant");
|
|
|
|
// EventType
|
|
s_eventType.insert("id", "uuid");
|
|
s_eventType.insert("name", "string");
|
|
s_eventType.insert("params", QVariantList() << paramTypeRef());
|
|
|
|
// Event
|
|
s_event.insert("eventTypeId", "uuid");
|
|
s_event.insert("deviceId", "uuid");
|
|
s_event.insert("params", QVariantList() << paramRef());
|
|
|
|
// ActionType
|
|
s_actionType.insert("id", "uuid");
|
|
s_actionType.insert("name", "string");
|
|
s_actionType.insert("params", QVariantList() << paramTypeRef());
|
|
|
|
// Action
|
|
s_action.insert("actionTypeId", "uuid");
|
|
s_action.insert("deviceId", "uuid");
|
|
s_action.insert("params", QVariantList() << paramRef());
|
|
|
|
// Pugin
|
|
s_plugin.insert("id", "uuid");
|
|
s_plugin.insert("name", "string");
|
|
s_plugin.insert("params", QVariantList() << paramTypeRef());
|
|
|
|
// DeviceClass
|
|
s_deviceClass.insert("id", "uuid");
|
|
s_deviceClass.insert("name", "string");
|
|
s_deviceClass.insert("states", QVariantList() << stateTypeRef());
|
|
s_deviceClass.insert("events", QVariantList() << eventTypeRef());
|
|
s_deviceClass.insert("actions", QVariantList() << actionTypeRef());
|
|
s_deviceClass.insert("params", QVariantList() << paramTypeRef());
|
|
|
|
// Device
|
|
s_device.insert("id", "uuid");
|
|
s_device.insert("deviceClassId", "uuid");
|
|
s_device.insert("name", "string");
|
|
s_device.insert("params", QVariantList() << paramRef());
|
|
|
|
s_rule.insert("id", "uuid");
|
|
s_rule.insert("ruleType", ruleTypesRef());
|
|
s_rule.insert("event", eventRef());
|
|
s_rule.insert("actions", QVariantList() << actionRef());
|
|
s_rule.insert("states", QVariantList() << stateRef());
|
|
|
|
s_initialized = true;
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::report(bool status, const QString &message)
|
|
{
|
|
return qMakePair<bool, QString>(status, message);
|
|
}
|
|
|
|
QVariantMap JsonTypes::allTypes()
|
|
{
|
|
QVariantMap allTypes;
|
|
allTypes.insert("BasicType", basicTypes());
|
|
allTypes.insert("ParamType", paramTypeDescription());
|
|
allTypes.insert("StateType", stateTypeDescription());
|
|
allTypes.insert("EventType", eventTypeDescription());
|
|
allTypes.insert("ActionType", actionTypeDescription());
|
|
allTypes.insert("DeviceClass", deviceClassDescription());
|
|
allTypes.insert("Plugin", pluginDescription());
|
|
allTypes.insert("Param", paramDescription());
|
|
allTypes.insert("State", stateDescription());
|
|
allTypes.insert("Event", eventDescription());
|
|
allTypes.insert("Device", deviceDescription());
|
|
allTypes.insert("Action", actionDescription());
|
|
allTypes.insert("RuleType", ruleTypes());
|
|
allTypes.insert("Rule", ruleDescription());
|
|
return allTypes;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packEventType(const EventType &eventType)
|
|
{
|
|
QVariantMap variant;
|
|
variant.insert("id", eventType.id());
|
|
variant.insert("name", eventType.name());
|
|
variant.insert("params", eventType.parameters());
|
|
return variant;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packEvent(const Event &event)
|
|
{
|
|
QVariantMap variant;
|
|
variant.insert("eventTypeId", event.eventTypeId());
|
|
variant.insert("deviceId", event.deviceId());
|
|
variant.insert("params", event.params());
|
|
return variant;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packActionType(const ActionType &actionType)
|
|
{
|
|
QVariantMap variantMap;
|
|
variantMap.insert("id", actionType.id());
|
|
variantMap.insert("name", actionType.name());
|
|
variantMap.insert("params", actionType.parameters());
|
|
return variantMap;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packAction(const Action &action)
|
|
{
|
|
QVariantMap variant;
|
|
variant.insert("actionTypeId", action.actionTypeId());
|
|
variant.insert("deviceId", action.deviceId());
|
|
variant.insert("params", action.params());
|
|
return variant;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packStateType(const StateType &stateType)
|
|
{
|
|
QVariantMap variantMap;
|
|
variantMap.insert("id", stateType.id());
|
|
variantMap.insert("name", stateType.name());
|
|
variantMap.insert("type", QVariant::typeToName(stateType.type()));
|
|
variantMap.insert("defaultValue", stateType.defaultValue());
|
|
return variantMap;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packDeviceClass(const DeviceClass &deviceClass)
|
|
{
|
|
QVariantMap variant;
|
|
variant.insert("name", deviceClass.name());
|
|
variant.insert("id", deviceClass.id());
|
|
QVariantList stateTypes;
|
|
foreach (const StateType &stateType, deviceClass.states()) {
|
|
stateTypes.append(packStateType(stateType));
|
|
}
|
|
QVariantList eventTypes;
|
|
foreach (const EventType &eventType, deviceClass.events()) {
|
|
eventTypes.append(packEventType(eventType));
|
|
}
|
|
QVariantList actionTypes;
|
|
foreach (const ActionType &actionType, deviceClass.actions()) {
|
|
actionTypes.append(packActionType(actionType));
|
|
}
|
|
variant.insert("params", deviceClass.params());
|
|
variant.insert("states", stateTypes);
|
|
variant.insert("events", eventTypes);
|
|
variant.insert("actions", actionTypes);
|
|
return variant;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packPlugin(DevicePlugin *plugin)
|
|
{
|
|
|
|
}
|
|
|
|
QVariantMap JsonTypes::packDevice(Device *device)
|
|
{
|
|
QVariantMap variant;
|
|
variant.insert("id", device->id());
|
|
variant.insert("deviceClassId", device->deviceClassId());
|
|
variant.insert("name", device->name());
|
|
variant.insert("params", device->params());
|
|
return variant;
|
|
}
|
|
|
|
QVariantMap JsonTypes::packRule(const Rule &rule)
|
|
{
|
|
QVariantMap ruleMap;
|
|
ruleMap.insert("id", rule.id());
|
|
ruleMap.insert("event", JsonTypes::packEvent(rule.event()));
|
|
ruleMap.insert("ruleType", s_ruleTypes.at(rule.ruleType()));
|
|
QVariantList actionList;
|
|
foreach (const Action &action, rule.actions()) {
|
|
actionList.append(JsonTypes::packAction(action));
|
|
}
|
|
ruleMap.insert("actions", actionList);
|
|
|
|
QVariantList states;
|
|
ruleMap.insert("states", states);
|
|
return ruleMap;
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateMap(const QVariantMap &templateMap, const QVariantMap &map)
|
|
{
|
|
s_lastError.clear();
|
|
foreach (const QString &key, templateMap.keys()) {
|
|
if (key != "params" && !map.contains(key)) {
|
|
qDebug() << "missing key" << key << templateMap << map;
|
|
QJsonDocument jsonDoc = QJsonDocument::fromVariant(map);
|
|
return report(false, QString("Missing key \"%1\" in %2").arg(key).arg(QString(jsonDoc.toJson())));
|
|
}
|
|
QPair<bool, QString> result = validateVariant(templateMap.value(key), map.value(key));
|
|
if (!result.first) {
|
|
qDebug() << "Object not matching template";
|
|
return result;
|
|
}
|
|
}
|
|
return report(true, "");
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateProperty(const QVariant &templateValue, const QVariant &value)
|
|
{
|
|
if (templateValue == "uuid") {
|
|
QString errorString = QString("Param %1 is not a uuid.").arg(value.toString());
|
|
return report(value.canConvert(QVariant::Uuid), errorString);
|
|
}
|
|
if (templateValue == "string") {
|
|
QString errorString = QString("Param %1 is not a string.").arg(value.toString());
|
|
return report(value.canConvert(QVariant::String), errorString);
|
|
}
|
|
if (templateValue == "bool") {
|
|
QString errorString = QString("Param %1 is not a bool.").arg(value.toString());
|
|
return report(value.canConvert(QVariant::Bool), errorString);
|
|
}
|
|
qWarning() << QString("Unhandled property type: %1 (expected: %2)").arg(value.toString()).arg(templateValue.toString());
|
|
QString errorString = QString("Unhandled property type: %1 (expected: %2)").arg(value.toString()).arg(templateValue.toString());
|
|
return report(false, errorString);
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateList(const QVariantList &templateList, const QVariantList &list)
|
|
{
|
|
Q_ASSERT(templateList.count() == 1);
|
|
QVariant entryTemplate = templateList.first();
|
|
|
|
qDebug() << "validating list" << templateList;
|
|
|
|
for (int i = 0; i < list.count(); ++i) {
|
|
QVariant listEntry = list.at(i);
|
|
QPair<bool, QString> result = validateVariant(entryTemplate, listEntry);
|
|
if (!result.first) {
|
|
qDebug() << "List entry not matching template";
|
|
return result;
|
|
}
|
|
}
|
|
return report(true, "");
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateVariant(const QVariant &templateVariant, const QVariant &variant)
|
|
{
|
|
switch(templateVariant.type()) {
|
|
case QVariant::String:
|
|
if (templateVariant.toString().startsWith("$ref:")) {
|
|
QString refName = templateVariant.toString();
|
|
if (refName == JsonTypes::actionRef()) {
|
|
qDebug() << "validating action";
|
|
QPair<bool, QString> result = validateMap(actionDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "Error validating action";
|
|
return result;
|
|
}
|
|
} else if (refName == JsonTypes::eventRef()) {
|
|
QPair<bool, QString> result = validateMap(eventDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "event not valid";
|
|
return result;
|
|
}
|
|
} else if (refName == deviceRef()) {
|
|
QPair<bool, QString> result = validateMap(deviceDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "device not valid";
|
|
return result;
|
|
}
|
|
} else if (refName == deviceClassRef()) {
|
|
QPair<bool, QString> result = validateMap(deviceClassDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "device class not valid";
|
|
return result;
|
|
}
|
|
} else if (refName == paramTypeRef()) {
|
|
QPair<bool, QString> result = validateMap(paramTypeDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "param types not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == actionTypeRef()) {
|
|
QPair<bool, QString> result = validateMap(actionTypeDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "action type not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == eventTypeRef()) {
|
|
QPair<bool, QString> result = validateMap(eventTypeDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "event type not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == stateTypeRef()) {
|
|
QPair<bool, QString> result = validateMap(stateTypeDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "state type not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == pluginRef()) {
|
|
QPair<bool, QString> result = validateMap(pluginDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "plugin not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == ruleRef()) {
|
|
QPair<bool, QString> result = validateMap(ruleDescription(), variant.toMap());
|
|
if (!result.first) {
|
|
qDebug() << "rule type not matching";
|
|
return result;
|
|
}
|
|
} else if (refName == basicTypesRef()) {
|
|
QPair<bool, QString> result = validateBasicType(variant);
|
|
if (!result.first) {
|
|
qDebug() << "value not allowed in" << basicTypesRef();
|
|
return result;
|
|
}
|
|
} else if (refName == ruleTypesRef()) {
|
|
QPair<bool, QString> result = validateRuleType(variant);
|
|
if (!result.first) {
|
|
qDebug() << "value not allowed in" << ruleTypesRef();
|
|
return result;
|
|
}
|
|
} else {
|
|
qDebug() << "unhandled ref:" << refName;
|
|
return report(false, QString("Unhandled ref %1. Server implementation incomplete.").arg(refName));
|
|
}
|
|
|
|
} else {
|
|
QPair<bool, QString> result = JsonTypes::validateProperty(templateVariant, variant);
|
|
if (!result.first) {
|
|
qDebug() << "property not matching:" << templateVariant << "!=" << variant;
|
|
return result;
|
|
}
|
|
}
|
|
break;
|
|
case QVariant::Map: {
|
|
QPair<bool, QString> result = validateMap(templateVariant.toMap(), variant.toMap());
|
|
if (!result.first) {
|
|
return result;
|
|
}
|
|
break;
|
|
}
|
|
case QVariant::List: {
|
|
QPair<bool, QString> result = validateList(templateVariant.toList(), variant.toList());
|
|
if (!result.first) {
|
|
return result;
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
qDebug() << "unhandled value" << templateVariant;
|
|
return report(false, QString("Unhandled value %1.").arg(templateVariant.toString()));
|
|
}
|
|
return report(true, "");
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateBasicType(const QVariant &variant)
|
|
{
|
|
if (variant.canConvert(QVariant::Uuid)) {
|
|
return report(true, "");
|
|
}
|
|
if (variant.canConvert(QVariant::String)) {
|
|
return report(true, "");
|
|
}
|
|
if (variant.canConvert(QVariant::Int)) {
|
|
return report(true, "");
|
|
}
|
|
if (variant.canConvert(QVariant::Double)) {
|
|
return report(true, "");
|
|
}
|
|
if (variant.canConvert(QVariant::Bool)) {
|
|
return report(true, "");
|
|
}
|
|
return report(false, QString("Error validating basic type %1.").arg(variant.toString()));
|
|
}
|
|
|
|
QPair<bool, QString> JsonTypes::validateRuleType(const QVariant &variant)
|
|
{
|
|
return report(s_ruleTypes.contains(variant.toString()), QString("Unknown rules type %1").arg(variant.toString()));
|
|
}
|