/**************************************************************************** * * * 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 . * * * ***************************************************************************/ #include "jsontypes.h" #include "plugin/device.h" #include #include #include bool JsonTypes::s_initialized = false; QString JsonTypes::s_lastError; QVariantList JsonTypes::s_basicTypes; QVariantList JsonTypes::s_ruleTypes; QVariantList JsonTypes::s_createMethodTypes; QVariantList JsonTypes::s_setupMethodTypes; QVariantList JsonTypes::s_operandTypes; 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_vendor; QVariantMap JsonTypes::s_deviceClass; QVariantMap JsonTypes::s_device; QVariantMap JsonTypes::s_deviceDescriptor; QVariantMap JsonTypes::s_rule; void JsonTypes::init() { // BasicTypes s_basicTypes << "uuid" << "string" << "integer" << "double" << "bool"; s_ruleTypes << "RuleTypeMatchAll" << "RuleTypeMatchAny"; s_createMethodTypes << "CreateMethodUser" << "CreateMethodAuto" << "CreateMethodDiscovery"; s_setupMethodTypes << "SetupMethodJustAdd" << "SetupMethodDisplayPin" << "SetupMethodEnterPin" << "SetupMethodPushButton"; s_operandTypes << "OperandTypeEquals" << "OperandTypeNotEquals" << "OperandTypeLess" << "OperandTypeGreater" << "OperandTypeLessThan" << "OperandTypeGreaterThan"; // ParamType s_paramType.insert("name", "string"); s_paramType.insert("type", basicTypesRef()); s_paramType.insert("o:defaultValue", "variant"); s_paramType.insert("o:minValue", "variant"); s_paramType.insert("o:maxValue", "variant"); // Param s_param.insert("name", "string"); s_param.insert("value", basicTypesRef()); s_param.insert("operand", operandTypesRef()); // StateType s_stateType.insert("id", "uuid"); s_stateType.insert("name", "string"); s_stateType.insert("type", basicTypesRef()); s_stateType.insert("defaultValue", "variant"); // 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("o: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("o:params", QVariantList() << paramRef()); // Pugin s_plugin.insert("id", "uuid"); s_plugin.insert("name", "string"); s_plugin.insert("params", QVariantList() << paramTypeRef()); // Vendor s_vendor.insert("id", "uuid"); s_vendor.insert("name", "string"); // 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()); s_deviceClass.insert("setupMethod", setupMethodTypesRef()); s_deviceClass.insert("createMethod", createMethodTypesRef()); // Device s_device.insert("id", "uuid"); s_device.insert("deviceClassId", "uuid"); s_device.insert("name", "string"); s_device.insert("params", QVariantList() << paramRef()); // DeviceDescription s_deviceDescriptor.insert("id", "uuid"); s_deviceDescriptor.insert("title", "string"); s_deviceDescriptor.insert("description", "string"); s_rule.insert("id", "uuid"); s_rule.insert("ruleType", ruleTypesRef()); s_rule.insert("events", QVariantList() << eventRef()); s_rule.insert("actions", QVariantList() << actionRef()); s_rule.insert("states", QVariantList() << stateRef()); s_initialized = true; } QPair JsonTypes::report(bool status, const QString &message) { return qMakePair(status, message); } QVariantMap JsonTypes::allTypes() { QVariantMap allTypes; allTypes.insert("BasicType", basicTypes()); allTypes.insert("ParamType", paramTypeDescription()); allTypes.insert("CreateMethodType", createMethodTypes()); allTypes.insert("SetupMethodType", setupMethodTypes()); allTypes.insert("OperandType", operandTypes()); allTypes.insert("StateType", stateTypeDescription()); allTypes.insert("EventType", eventTypeDescription()); allTypes.insert("ActionType", actionTypeDescription()); allTypes.insert("Vendor", vendorDescription()); 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("DeviceDescriptor", deviceDescriptorDescription()); 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()); QVariantList params; foreach (const Param ¶m, event.params()) { params.append(packParam(param)); } variant.insert("params", 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()); QVariantList params; foreach (const Param ¶m, action.params()) { params.append(packParam(param)); } variant.insert("params", 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::packParam(const Param ¶m) { QVariantMap variantMap; variantMap.insert("name", param.name()); variantMap.insert("value", param.value()); variantMap.insert("operand", s_operandTypes.at(param.operand())); return variantMap; } QVariantMap JsonTypes::packParamType(const ParamType ¶mType) { QVariantMap variantMap; variantMap.insert("name", paramType.name()); variantMap.insert("type", QVariant::typeToName(paramType.type())); if (paramType.defaultValue().isValid()) { variantMap.insert("defaultValue", paramType.defaultValue()); } if (paramType.minValue().isValid()) { variantMap.insert("minValue", paramType.minValue()); } if (paramType.maxValue().isValid()) { variantMap.insert("maxValue", paramType.maxValue()); } return variantMap; } QVariantMap JsonTypes::packVendor(const Vendor &vendor) { QVariantMap variantMap; variantMap.insert("id", vendor.id()); variantMap.insert("name", vendor.name()); 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)); } QVariantList paramTypes; foreach (const ParamType ¶mType, deviceClass.params()) { paramTypes.append(packParamType(paramType)); } variant.insert("params", paramTypes); variant.insert("states", stateTypes); variant.insert("events", eventTypes); variant.insert("actions", actionTypes); variant.insert("createMethod", s_createMethodTypes.at(deviceClass.createMethod())); variant.insert("setupMethod", s_setupMethodTypes.at(deviceClass.setupMethod())); return variant; } QVariantMap JsonTypes::packPlugin(DevicePlugin *plugin) { Q_UNUSED(plugin) qWarning() << "packPlugin not implemented yet!"; return QVariantMap(); } QVariantMap JsonTypes::packDevice(Device *device) { QVariantMap variant; variant.insert("id", device->id()); variant.insert("deviceClassId", device->deviceClassId()); variant.insert("name", device->name()); QVariantList params; foreach (const Param ¶m, device->params()) { params.append(packParam(param)); } variant.insert("params", params); return variant; } QVariantMap JsonTypes::packDeviceDescriptor(const DeviceDescriptor &descriptor) { QVariantMap variant; variant.insert("id", descriptor.id()); variant.insert("title", descriptor.title()); variant.insert("description", descriptor.description()); return variant; } QVariantMap JsonTypes::packRule(const Rule &rule) { QVariantMap ruleMap; ruleMap.insert("id", rule.id()); QVariantList eventList; foreach (const Event &event, rule.events()) { eventList.append(JsonTypes::packEvent(event)); } ruleMap.insert("events", eventList); 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; } Param JsonTypes::unpackParam(const QVariantMap ¶mMap) { Param param(paramMap.value("name").toString(), paramMap.value("value")); QString operandString = paramMap.value("operand").toString(); if (operandString == "OperandTypeEquals") { param.setOperand(Param::OperandTypeEquals); } else if (operandString == "OperandTypeNotEquals") { param.setOperand(Param::OperandTypeNotEquals); } else if (operandString == "OperandTypeLess") { param.setOperand(Param::OperandTypeLess); } else if (operandString == "OperandTypeGreater") { param.setOperand(Param::OperandTypeGreater); } else if (operandString == "OperandTypeLessThan") { param.setOperand(Param::OperandTypeLessThan); } else if (operandString == "OperandTypeGreaterThan") { param.setOperand(Param::OperandTypeGreaterThan); } return param; } QList JsonTypes::unpackParams(const QVariantList ¶mList) { QList params; foreach (const QVariant ¶mVariant, paramList) { params.append(unpackParam(paramVariant.toMap())); } return params; } QPair JsonTypes::validateMap(const QVariantMap &templateMap, const QVariantMap &map) { s_lastError.clear(); // Make sure all values defined in the template are around foreach (const QString &key, templateMap.keys()) { QString strippedKey = key; strippedKey.remove(QRegExp("^o:")); if (!key.startsWith("o:") && !map.contains(strippedKey)) { qDebug() << "*** missing key" << key; qDebug() << "Expected:" << templateMap; qDebug() << "Got:" << map; QJsonDocument jsonDoc = QJsonDocument::fromVariant(map); return report(false, QString("Missing key \"%1\" in %2").arg(key).arg(QString(jsonDoc.toJson()))); } if (map.contains(strippedKey)) { QPair result = validateVariant(templateMap.value(key), map.value(strippedKey)); if (!result.first) { qDebug() << "Object not matching template or object not matching" << templateMap.value(key) << map.value(strippedKey); return result; } } } // Make sure there aren't any other parameters than the allowed ones foreach (const QString &key, map.keys()) { QString optKey = "o:" + key; if (!templateMap.contains(key) && !templateMap.contains(optKey)) { qDebug() << "Forbidden param" << key << "in params"; QJsonDocument jsonDoc = QJsonDocument::fromVariant(map); return report(false, QString("Forbidden key \"%1\" in %2").arg(key).arg(QString(jsonDoc.toJson()))); } } return report(true, ""); } QPair JsonTypes::validateProperty(const QVariant &templateValue, const QVariant &value) { qDebug() << "validating property. template:" << templateValue << "got:" << value; QString strippedTemplateValue = templateValue.toString(); if (strippedTemplateValue == "variant") { return report(true, ""); } if (strippedTemplateValue == "uuid") { QString errorString = QString("Param %1 is not a uuid.").arg(value.toString()); return report(value.canConvert(QVariant::Uuid), errorString); } if (strippedTemplateValue == "string") { QString errorString = QString("Param %1 is not a string.").arg(value.toString()); return report(value.canConvert(QVariant::String), errorString); } if (strippedTemplateValue == "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(strippedTemplateValue); QString errorString = QString("Unhandled property type: %1 (expected: %2)").arg(value.toString()).arg(strippedTemplateValue); return report(false, errorString); } QPair JsonTypes::validateList(const QVariantList &templateList, const QVariantList &list) { Q_ASSERT(templateList.count() == 1); QVariant entryTemplate = templateList.first(); for (int i = 0; i < list.count(); ++i) { QVariant listEntry = list.at(i); qDebug() << "validating" << list << templateList; QPair result = validateVariant(entryTemplate, listEntry); if (!result.first) { qDebug() << "List entry not matching template"; return result; } } return report(true, ""); } QPair 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 == actionRef()) { qDebug() << "validating action"; QPair result = validateMap(actionDescription(), variant.toMap()); if (!result.first) { qDebug() << "Error validating action"; return result; } } else if (refName == eventRef()) { qDebug() << "validating event"; QPair result = validateMap(eventDescription(), variant.toMap()); if (!result.first) { qDebug() << "event not valid"; return result; } } else if (refName == paramRef()) { QPair result = validateMap(paramDescription(), variant.toMap()); if (!result.first) { qDebug() << "Param not valid"; return result; } } else if (refName == deviceRef()) { QPair result = validateMap(deviceDescription(), variant.toMap()); if (!result.first) { qDebug() << "device not valid"; return result; } } else if (refName == deviceDescriptorRef()) { QPair result = validateMap(deviceDescriptorDescription(), variant.toMap()); if (!result.first) { qDebug() << "devicedescription not valid"; return result; } } else if (refName == vendorRef()) { QPair result = validateMap(vendorDescription(), variant.toMap()); if (!result.first) { qDebug() << "value not allowed in" << vendorRef(); } } else if (refName == deviceClassRef()) { QPair result = validateMap(deviceClassDescription(), variant.toMap()); if (!result.first) { qDebug() << "device class not valid"; return result; } } else if (refName == paramTypeRef()) { QPair result = validateMap(paramTypeDescription(), variant.toMap()); if (!result.first) { qDebug() << "param types not matching"; return result; } } else if (refName == actionTypeRef()) { QPair result = validateMap(actionTypeDescription(), variant.toMap()); if (!result.first) { qDebug() << "action type not matching"; return result; } } else if (refName == eventTypeRef()) { QPair result = validateMap(eventTypeDescription(), variant.toMap()); if (!result.first) { qDebug() << "event type not matching"; return result; } } else if (refName == stateTypeRef()) { QPair result = validateMap(stateTypeDescription(), variant.toMap()); if (!result.first) { qDebug() << "state type not matching"; return result; } } else if (refName == pluginRef()) { QPair result = validateMap(pluginDescription(), variant.toMap()); if (!result.first) { qDebug() << "plugin not matching"; return result; } } else if (refName == ruleRef()) { QPair result = validateMap(ruleDescription(), variant.toMap()); if (!result.first) { qDebug() << "rule type not matching"; return result; } } else if (refName == basicTypesRef()) { QPair result = validateBasicType(variant); if (!result.first) { qDebug() << "value not allowed in" << basicTypesRef(); return result; } } else if (refName == ruleTypesRef()) { QPair result = validateRuleType(variant); if (!result.first) { qDebug() << "value not allowed in" << ruleTypesRef(); return result; } } else if (refName == createMethodTypesRef()) { QPair result = validateCreateMethodType(variant); if (!result.first) { qDebug() << "value not allowed in" << createMethodTypesRef(); return result; } } else if (refName == setupMethodTypesRef()) { QPair result = validateSetupMethodType(variant); if (!result.first) { qDebug() << "value not allowed in" << createMethodTypesRef(); return result; } } else if (refName == operandTypesRef()) { QPair result = validateOperandType(variant); if (!result.first) { qDebug() << QString("value %1 not allowed in %2").arg(variant.toString()).arg(operandTypesRef()); return result; } } else { qDebug() << "unhandled ref:" << refName; return report(false, QString("Unhandled ref %1. Server implementation incomplete.").arg(refName)); } } else { QPair result = JsonTypes::validateProperty(templateVariant, variant); if (!result.first) { qDebug() << "property not matching:" << templateVariant << "!=" << variant; return result; } } break; case QVariant::Map: { QPair result = validateMap(templateVariant.toMap(), variant.toMap()); if (!result.first) { return result; } break; } case QVariant::List: { QPair 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 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 JsonTypes::validateRuleType(const QVariant &variant) { return report(s_ruleTypes.contains(variant.toString()), QString("Unknown rules type %1").arg(variant.toString())); } QPair JsonTypes::validateCreateMethodType(const QVariant &variant) { return report(s_createMethodTypes.contains(variant.toString()), QString("Unknwon createMethod type %1").arg(variant.toString())); } QPair JsonTypes::validateSetupMethodType(const QVariant &variant) { return report(s_setupMethodTypes.contains(variant.toString()), QString("Unknwon setupMethod type %1").arg(variant.toString())); } QPair JsonTypes::validateOperandType(const QVariant &variant) { return report(s_operandTypes.contains(variant.toString()), QString("Unknown operand type %1").arg(variant.toString())); }