Skip to content

Commit

Permalink
Use separate class for Schema
Browse files Browse the repository at this point in the history
  • Loading branch information
@trasher
trasher committed Jan 21, 2025
1 parent 9e401ae commit bea9040
Show file tree
Hide file tree
Showing 7 changed files with 486 additions and 412 deletions.
2 changes: 1 addition & 1 deletion bin/convert
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ try {
}

$json = $converter->convert($xml->asXML());
$converter->validate(json_decode($json));
$converter->getSchema()->validate(json_decode($json));

if ($json_path !== null) {
file_put_contents($json_path, $json);
Expand Down
4 changes: 2 additions & 2 deletions bin/validate
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ if (!file_exists($json_path)) {
}

try {
$converter = new Glpi\Inventory\Converter;
$schema = new \Glpi\Inventory\Schema();

$json_str = file_get_contents($json_path);
$converter->validate(json_decode($json_str));
$schema->validate(json_decode($json_str));
} catch (\Exception $e) {
echo "File: $json_path\n";
echo $e->getMessage();
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"ext-curl": "*"
},
"autoload": {
"files": ["lib/php/Converter.php", "lib/php/FilesToJSON.php"]
"files": ["lib/php/Schema.php", "lib/php/Converter.php", "lib/php/FilesToJSON.php"]
},
"bin": ["bin/convert", "bin/build_hw_jsons", "bin/refresh_hw_sources","bin/validate"],
"require-dev": {
Expand Down
250 changes: 14 additions & 236 deletions lib/php/Converter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@
use DateTime;
use Exception;
use RuntimeException;
use Swaggest\JsonSchema\Context;
use Swaggest\JsonSchema\Schema;
use UnexpectedValueException;

/**
* Converts old FusionInventory XML format to new JSON schema
* for automatic inventory.
*
* @author Johan Cwiklinski <[email protected]>
* @author Johan Cwiklinski <[email protected]>
*/
class Converter
{
Expand All @@ -31,30 +29,20 @@ class Converter
/** @var ?float */
private ?float $target_version;

private Schema $schema;
/** @var bool */
private bool $debug = false;
/**
* XML a different steps. Used for debug only
* @var array<int, mixed>
*/
private array $steps;
private array $steps; //@phpstan-ignore-line

/** @var array<string, float> */
private array $mapping = [
'01' => 0.1
];

/** @var array<string, array<int, string>> */
private array $schema_patterns;
/** @var array<string, array<string, string>> */
private array $extra_properties = [];
/** @var array<string, array<string, array<string, string>>> */
private array $extra_sub_properties = [];
/** @var array<string> */
private array $extra_itemtypes = [];
/** @var bool */
private bool $strict_schema = true;

/**
* @var array<string, array<int, string>>
*
Expand Down Expand Up @@ -85,6 +73,7 @@ class Converter
*/
public function __construct($target_version = null)
{
$this->schema = new Schema();
if ($target_version === null) {
$target_version = self::LAST_VERSION;
}
Expand Down Expand Up @@ -130,168 +119,23 @@ public function isDebug(): bool
}

/**
* Get path to schema
*
* @return string
*/
public function getSchemaPath(): string
{
$schema_path = realpath(__DIR__ . '/../../inventory.schema.json');
if ($schema_path === false) {
throw new RuntimeException('Schema file not found!');
}
return $schema_path;
}

/**
* Add extra properties to schema
*
* @param array<string, array<string, string>> $properties
* @return $this
*/
public function setExtraProperties(array $properties): self
{
$this->extra_properties = $properties;
return $this;
}

/**
* Add extra sub-properties to schema
* Get Schema instance
*
* @param array<string, array<string, array<string, string>>> $properties
* @return $this
* @return Schema
*/
public function setExtraSubProperties(array $properties): self
public function getSchema(): Schema
{
$this->extra_sub_properties = $properties;
return $this;
return $this->schema;
}

/**
* Add new supported item types
* Get JSON schema
*
* @param array<string> $itemtypes
* @return $this
* @return object
*/
public function setExtraItemtypes(array $itemtypes): self
public function getJSONSchema(): object
{
$this->extra_itemtypes = $itemtypes;
return $this;
}

/**
* Build (extended) JSON schema
*
* @return mixed
*/
public function buildSchema()
{
$string = file_get_contents($this->getSchemaPath());
if ($string === false) {
throw new RuntimeException('Unable to read schema file');
}
$schema = json_decode($string);

$known_itemtypes = [];
preg_match('/\^\((.+)\)\$/', $schema->properties->itemtype->pattern, $known_itemtypes);
if (isset($known_itemtypes[1])) {
$known_itemtypes = explode('|', $known_itemtypes[1]);
foreach ($this->extra_itemtypes as $extra_itemtype) {
if (!in_array($extra_itemtype, $known_itemtypes)) {
$known_itemtypes[] = addslashes($extra_itemtype);
}
}
$schema->properties->itemtype->pattern = sprintf(
'^(%s)$',
implode('|', $known_itemtypes)
);
}

$properties = $schema->properties->content->properties;

foreach ($this->extra_properties as $extra_property => $extra_config) {
if (!property_exists($properties, $extra_property)) {
$properties->$extra_property = json_decode((string)json_encode($extra_config));
} else {
trigger_error(
sprintf('Property %1$s already exists in schema.', $extra_property),
E_USER_WARNING
);
}
}

foreach ($this->extra_sub_properties as $extra_sub_property => $extra_sub_config) {
if (property_exists($properties, $extra_sub_property)) {
foreach ($extra_sub_config as $subprop => $subconfig) {
$type = $properties->$extra_sub_property->type;
switch ($type) {
case 'array':
if (!property_exists($properties->$extra_sub_property->items->properties, $subprop)) {
$properties->$extra_sub_property->items->properties->$subprop =
json_decode((string)json_encode($subconfig));
} else {
trigger_error(
sprintf('Property %1$s already exists in schema.', $subprop),
E_USER_WARNING
);
}
break;
case 'object':
if (!property_exists($properties->$extra_sub_property->properties, $subprop)) {
$properties->$extra_sub_property->properties->$subprop =
json_decode((string)json_encode($subconfig));
} else {
trigger_error(
sprintf(
'Property %1$s/%2$s already exists in schema.',
$extra_sub_property,
$subprop
),
E_USER_WARNING
);
}
break;
default:
trigger_error('Unknown type ' . $type, E_USER_WARNING);
}
}
} else {
trigger_error(
sprintf('Property %1$s does not exists in schema.', $extra_sub_property),
E_USER_WARNING
);
}
}

if ($this->strict_schema === false) {
$this->buildFlexibleSchema($schema->properties->content);
}

return $schema;
}

/**
* Do validation (against last schema only!)
*
* @param mixed $json Converted data to validate
*
* @return boolean
*/
public function validate($json): bool
{
try {
$schema = Schema::import($this->buildSchema());

$context = new Context();
$context->tolerateStrings = (!defined('TU_USER'));
$schema->in($json, $context);
return true;
} catch (Exception $e) {
$errmsg = "JSON does not validate. Violations:\n";
$errmsg .= $e->getMessage();
$errmsg .= "\n";
throw new RuntimeException($errmsg);
}
return $this->schema->build();
}

/**
Expand Down Expand Up @@ -324,7 +168,7 @@ public function convert(string $xml)
(string)json_encode((array)$sxml),
true
);
$this->loadSchemaPatterns();
$this->schema->loadPatterns();

$methods = $this->getMethods();
foreach ($methods as $method) {
Expand Down Expand Up @@ -548,7 +392,7 @@ private function convertTo01(array $data): array
if ($network['type'] == 'local') {
$network['type'] = 'loopback';
}
if (!in_array($network['type'], $this->schema_patterns['networks_types'])) {
if (!in_array($network['type'], $this->schema->getPatterns()['networks_types'])) {
unset($network['type']);
}
}
Expand Down Expand Up @@ -1169,7 +1013,6 @@ public function convertTypes(array &$data): void
}
}


/**
* Get value casted
*
Expand Down Expand Up @@ -1257,29 +1100,6 @@ public function convertDate(string $value, string $format = 'Y-m-d'): ?string
return $value;
}

/**
* Load schema patterns that will be used to validate
*
* @return void
*/
public function loadSchemaPatterns(): void
{
$string = file_get_contents($this->getSchemaPath());
if ($string === false) {
throw new RuntimeException('Unable to read schema file');
}
$json = json_decode($string, true);

$this->schema_patterns['networks_types'] = explode(
'|',
str_replace(
['^(', ')$'],
['', ''],
$json['properties']['content']['properties']['networks']['items']['properties']['type']['pattern']
)
);
}

/**
* Convert battery capacity
*
Expand Down Expand Up @@ -1774,46 +1594,4 @@ private function isNetworkDiscovery(array $data): bool
{
return isset($data['content']['device']) && $data['action'] == 'netdiscovery';
}

/**
* Set schema validation strict (no additional properties allowed anywhere)
*
* @return self
*/
public function setStrictSchema(): self
{
$this->strict_schema = true;
return $this;
}

/**
* Set schema validation strict (no additional properties allowed anywhere)
*
* @return self
*/
public function setFlexibleSchema(): self
{
$this->strict_schema = false;
return $this;
}

/**
* Build schema flexible (remove all additionalProperties)
*
* @param mixed $schemapart
*
* @return void
*/
private function buildFlexibleSchema(&$schemapart)
{
foreach ($schemapart as $key => $value) {
if (is_object($value) || is_array($value)) {
$this->buildFlexibleSchema($value);
} else {
if ($key == 'additionalProperties') {
unset($schemapart->$key);
}
}
}
}
}
Loading

0 comments on commit bea9040

Please sign in to comment.