hyperion.ng/include/utils/jsonschema/QJsonFactory.h
Paulchen Panther 5bd020a570 JSON Auto correction + hyperion schema split for better readability (#452)
* revoke schema split

* add "getAutoCorrectedConfig" function

* revoke schema split

* revoke schema split

* revoke schema split

* Prevent compiler error if none grabber is available

* revoke schema split

* add "getAutoCorrectedConfig" function

* revoke schema split

* remove "configMigrator"

* remove "configMigrator"

* Change TestConfigFile to show how the autocorrection works

* revoke schema split

* revoke schema split

* remove "ConfigMigrator"

* remove "ConfigMigrator"

* remove "ConfigMigratorBase"

* remove "ConfigMigratorBase"

* Add QJsonUtils.h

* added ability "ignore-required"

It has been added the ability to correct the configuration without having to pay attention to the keyword "required" in the hyperion schema

* Allow Comments in Hyperion Schema

* add ability to ignore the "required" keyword in hyperion schema

* add ability to ignore the "required" keyword in hyperion schema

* add ability to ignore the "required" keyword in hyperion schema

* //Allow Comments in Hyperion Schema

* Update jsonschema.py to version 0.8.0 to support ...

references in json schema

* add RefResolver from jsonschema.py to resolve

references in hyperion schema

* remove dupe code

* split the hyperion schema in separatly files

For better readability

* add function "resolveReferences" to resolve

references in hyperion schema.

* remove CURRENT_CONFIG_VERSION

* remove CURRENT_CONFIG_VERSION

* split the hyperion schema in separatly files

For better readability

* Create schema-backgroundEffect.json

* Add the rest of the Hyperion schema via upload

* Remove Comments in config file

* Add return variable to function writeJson().

fix function resolveReferences().
edit function load() to handle QPair result from schemaChecker.

* edit function validate() to return QPair variable

* fit function loadEffectDefinition()

* fit function checkJson()

*  Expand error check by dividing

"_error" variable in "_error" and "_schemaError".
Replace variable "bool" in validate() in QPair

* Extend function "cmd_cfg_set" to handle auto correction

* Extend function "loadConfig" to handle auto correction

* fix function loadConfig()
2017-07-30 13:32:10 +02:00

172 lines
4.1 KiB
C++

#pragma once
#include <iostream>
#include <stdexcept>
// JSON-Schema includes
#include <utils/jsonschema/QJsonSchemaChecker.h>
#include <QFile>
#include <QString>
#include <QJsonObject>
#include <QJsonDocument>
#include <QRegularExpression>
class QJsonFactory
{
public:
static int load(const QString& schema, const QString& config, QJsonObject& json)
{
// Load the schema and the config trees
QJsonObject schemaTree = readSchema(schema);
QJsonObject configTree = readConfig(config);
// create the validator
QJsonSchemaChecker schemaChecker;
schemaChecker.setSchema(schemaTree);
QStringList messages = schemaChecker.getMessages();
if (!schemaChecker.validate(configTree).first)
{
for (int i = 0; i < messages.size(); ++i)
std::cout << messages[i].toStdString() << std::endl;
std::cerr << "Validation failed for configuration file: " << config.toStdString() << std::endl;
return -3;
}
json = configTree;
return 0;
}
static QJsonObject readConfig(const QString& path)
{
QFile file(path);
QJsonParseError error;
if (!file.open(QIODevice::ReadOnly))
{
throw std::runtime_error(QString("Configuration file not found: '" + path + "' (" + file.errorString() + ")").toStdString());
}
//Allow Comments in Config
QString config = QString(file.readAll());
config.remove(QRegularExpression("([^:]?\\/\\/.*)"));
QJsonDocument doc = QJsonDocument::fromJson(config.toUtf8(), &error);
file.close();
if (error.error != QJsonParseError::NoError)
{
// report to the user the failure and their locations in the document.
int errorLine(0), errorColumn(0);
for( int i=0, count=qMin( error.offset,config.size()); i<count; ++i )
{
++errorColumn;
if(config.at(i) == '\n' )
{
errorColumn = 0;
++errorLine;
}
}
throw std::runtime_error (
QString("Failed to parse configuration: " + error.errorString() + " at Line: " + QString::number(errorLine) + ", Column: " + QString::number(errorColumn)).toStdString()
);
}
return doc.object();
}
static QJsonObject readSchema(const QString& path)
{
QFile schemaData(path);
QJsonParseError error;
if (!schemaData.open(QIODevice::ReadOnly))
{
throw std::runtime_error(QString("Schema not found: '" + path + "' (" + schemaData.errorString() + ")").toStdString());
}
QByteArray schema = schemaData.readAll();
QJsonDocument doc = QJsonDocument::fromJson(schema, &error);
schemaData.close();
if (error.error != QJsonParseError::NoError)
{
// report to the user the failure and their locations in the document.
int errorLine(0), errorColumn(0);
for( int i=0, count=qMin( error.offset,schema.size()); i<count; ++i )
{
++errorColumn;
if(schema.at(i) == '\n' )
{
errorColumn = 0;
++errorLine;
}
}
throw std::runtime_error(QString("ERROR: Json schema wrong: " + error.errorString() +
" at Line: " + QString::number(errorLine) +
", Column: " + QString::number(errorColumn)).toStdString());
}
return resolveReferences(doc.object());
}
static QJsonObject resolveReferences(const QJsonObject& schema)
{
QJsonObject result;
for (QJsonObject::const_iterator i = schema.begin(); i != schema.end(); ++i)
{
QString attribute = i.key();
const QJsonValue & attributeValue = *i;
if (attribute == "$ref" && attributeValue.isString())
{
try
{
result = readSchema(":/" + attributeValue.toString());
}
catch (std::runtime_error& error)
{
throw std::runtime_error(error.what());
}
}
else if (attributeValue.isObject())
result.insert(attribute, resolveReferences(attributeValue.toObject()));
else
result.insert(attribute, attributeValue);
}
return result;
}
static bool writeJson(const QString& filename, QJsonObject& jsonTree)
{
QJsonDocument doc;
doc.setObject(jsonTree);
QByteArray configData = doc.toJson(QJsonDocument::Indented);
QFile configFile(filename);
if (!configFile.open(QFile::WriteOnly | QFile::Truncate))
return false;
configFile.write(configData);
QFile::FileError error = configFile.error();
if (error != QFile::NoError)
return false;
configFile.close();
return true;
}
};