jsv4.php

<?php

define('JSV4_INVALID_TYPE', 0);
define('JSV4_ENUM_MISMATCH', 1);
define('JSV4_ANY_OF_MISSING', 10);
define('JSV4_ONE_OF_MISSING', 11);
define('JSV4_ONE_OF_MULTIPLE', 12);
define('JSV4_NOT_PASSED', 13);
// Numeric errors
define('JSV4_NUMBER_MULTIPLE_OF', 100);
define('JSV4_NUMBER_MINIMUM', 101);
define('JSV4_NUMBER_MINIMUM_EXCLUSIVE', 102);
define('JSV4_NUMBER_MAXIMUM', 103);
define('JSV4_NUMBER_MAXIMUM_EXCLUSIVE', 104);
// String errors
define('JSV4_STRING_LENGTH_SHORT', 200);
define('JSV4_STRING_LENGTH_LONG', 201);
define('JSV4_STRING_PATTERN', 202);
// Object errors
define('JSV4_OBJECT_PROPERTIES_MINIMUM', 300);
define('JSV4_OBJECT_PROPERTIES_MAXIMUM', 301);
define('JSV4_OBJECT_REQUIRED', 302);
define('JSV4_OBJECT_ADDITIONAL_PROPERTIES', 303);
define('JSV4_OBJECT_DEPENDENCY_KEY', 304);
// Array errors
define('JSV4_ARRAY_LENGTH_SHORT', 400);
define('JSV4_ARRAY_LENGTH_LONG', 401);
define('JSV4_ARRAY_UNIQUE', 402);
define('JSV4_ARRAY_ADDITIONAL_ITEMS', 403);

class Jsv4 {
	static public function validate($data, $schema) {
		return new Jsv4($data, $schema);
	}
	
	static public function isValid($data, $schema) {
		$result = new Jsv4($data, $schema, TRUE);
		return $result->valid;
	}
	
	static public function coerce($data, $schema) {
		if (is_object($data) || is_array($data)) {
			$data = unserialize(serialize($data));
		}
		$result = new Jsv4($data, $schema, FALSE, TRUE);
		if ($result->valid) {
			$result->value = $result->data;
		}
		return $result;
	}
	
	static public function pointerJoin($parts) {
		$result = "";
		foreach ($parts as $part) {
			$part = str_replace("~", "~0", $part);
			$part = str_replace("/", "~1", $part);
			$result .= "/".$part;
		}
		return $result;
	}
	
	static public function recursiveEqual($a, $b) {
		if (is_object($a)) {
			if (!is_object($b)) {
				return FALSE;
			}
			foreach ($a as $key => $value) {
				if (!isset($b->$key)) {
					return FALSE;
				}
				if (!recursiveEqual($value, $b->$key)) {
					return FALSE;
				}
			}
			foreach ($b as $key => $value) {
				if (!isset($a->$key)) {
					return FALSE;
				}
			}
			return TRUE;
		}
		if (is_array($a)) {
			if (!is_array($b)) {
				return FALSE;
			}
			foreach ($a as $key => $value) {
				if (!isset($b[$key])) {
					return FALSE;
				}
				if (!recursiveEqual($value, $b[$key])) {
					return FALSE;
				}
			}
			foreach ($b as $key => $value) {
				if (!isset($a[$key])) {
					return FALSE;
				}
			}
			return TRUE;
		}
		return $a === $b;
	}

	
	private $data;
	private $schema;
	private $firstErrorOnly;
	private $coerce;
	public $valid;
	public $errors;
	
	private function __construct(&$data, $schema, $firstErrorOnly=FALSE, $coerce=FALSE) {
		$this->data =& $data;
		$this->schema =& $schema;
		$this->firstErrorOnly = $firstErrorOnly;
		$this->coerce = $coerce;
		$this->valid = TRUE;
		$this->errors = array();

		try {
			$this->checkTypes();
			$this->checkEnum();
			$this->checkObject();
			$this->checkArray();
			$this->checkString();
			$this->checkNumber();
			$this->checkComposite();
		} catch (Jsv4Error $e) {
		}
	}
	
	private function fail($code, $dataPath, $schemaPath, $errorMessage, $subErrors=NULL) {
		$this->valid = FALSE;
		$error = new Jsv4Error($code, $dataPath, $schemaPath, $errorMessage, $subErrors);
		$this->errors[] = $error;
		if ($this->firstErrorOnly) {
			throw $error;
		}
	}
	
	private function subResult(&$data, $schema, $allowCoercion=TRUE) {
		return new Jsv4($data, $schema, $this->firstErrorOnly, $allowCoercion && $this->coerce);
	}
	
	private function includeSubResult($subResult, $dataPrefix, $schemaPrefix) {
		if (!$subResult->valid) {
			$this->valid = FALSE;
			foreach ($subResult->errors as $error) {
				$this->errors[] = $error->prefix($dataPrefix, $schemaPrefix);
			}
		}
	}
	
	private function checkTypes() {
		if (isset($this->schema->type)) {
			$types = $this->schema->type;
			if (!is_array($types)) {
				$types = array($types);
			}
			foreach ($types as $type) {
				if ($type == "object" && is_object($this->data)) {
					return;
				} elseif ($type == "array" && is_array($this->data)) {
					return;
				} elseif ($type == "string" && is_string($this->data)) {
					return;
				} elseif ($type == "number" && !is_string($this->data) && is_numeric($this->data)) {
					return;
				} elseif ($type == "integer" && is_int($this->data)) {
					return;
				} elseif ($type == "boolean" && is_bool($this->data)) {
					return;
				} elseif ($type == "null" && $this->data === NULL) {
					return;
				}
			}

			if ($this->coerce) {
				foreach ($types as $type) {
					if ($type == "number") {
						if (is_numeric($this->data)) {
							$this->data = (float)$this->data;
							return;
						} else if (is_bool($this->data)) {
							$this->data = $this->data ? 1 : 0;
							return;
						}
					} else if ($type == "integer") {
						if ((int)$this->data == $this->data) {
							$this->data = (int)$this->data;
							return;
						}
					} else if ($type == "string") {
						if (is_numeric($this->data)) {
							$this->data = "".$this->data;
							return;
						} else if (is_bool($this->data)) {
							$this->data = ($this->data) ? "true" : "false";
							return;
						} else if (is_null($this->data)) {
							$this->data = "";
							return;
						}
					} else if ($type == "boolean") {
						if (is_numeric($this->data)) {
							$this->data = ($this->data != "0");
							return;
						} else if ($this->data == "yes" || $this->data == "true") {
							$this->data = TRUE;
							return;
						} else if ($this->data == "no" || $this->data == "false") {
							$this->data = FALSE;
							return;
						} else if ($this->data == NULL) {
							$this->data = FALSE;
							return;
						}
					}
				}
			}

			$type = gettype($this->data);
			if ($type == "double") {
				$type = ((int)$this->data == $this->data) ? "integer" : "number";
			} else if ($type == "NULL") {
				$type = "null";
			}
			$this->fail(JSV4_INVALID_TYPE, "", "/type", "Invalid type: $type");
		}
	}
	
	private function checkEnum() {
		if (isset($this->schema->enum)) {
			foreach ($this->schema->enum as $option) {
				if (self::recursiveEqual($this->data, $option)) {
					return;
				}
			}
			$this->fail(JSV4_ENUM_MISMATCH, "", "/enum", "Value must be one of the enum options");
		}
	}
	
	private function checkObject() {
		if (!is_object($this->data)) {
			return;
		}
		if (isset($this->schema->required)) {
			foreach ($this->schema->required as $index => $key) {
				if (!isset($this->data->$key)) {
					if ($this->coerce && $this->createValueForProperty($key)) {
						continue;
					}
					$this->fail(JSV4_OBJECT_REQUIRED, "", "/required/{$index}", "Missing required property: {$key}");
				}
			}
		}
		$checkedProperties = array();
		if (isset($this->schema->properties)) {
			foreach ($this->schema->properties as $key => $subSchema) {
				$checkedProperties[$key] = TRUE;
				if (isset($this->data->$key)) {
					$subResult = $this->subResult($this->data->$key, $subSchema);
					$this->includeSubResult($subResult, self::pointerJoin(array($key)), self::pointerJoin(array("properties", $key)));
				}
			}
		}
		if (isset($this->schema->patternProperties)) {
			foreach ($this->schema->patternProperties as $pattern => $subSchema) {
				foreach ($this->data as $key => &$subValue) {
					if (preg_match("/".str_replace("/", "\\/", $pattern)."/", $key)) {
						$checkedProperties[$key] = TRUE;
						$subResult = $this->subResult($this->data->$key, $subSchema);
						$this->includeSubResult($subResult, self::pointerJoin(array($key)), self::pointerJoin(array("patternProperties", $pattern)));
					}
				}
			}
		}
		if (isset($this->schema->additionalProperties)) {
			$additionalProperties = $this->schema->additionalProperties;
			foreach ($this->data as $key => &$subValue) {
				if (isset($checkedProperties[$key])) {
					continue;
				}
				if (!$additionalProperties) {
					$this->fail(JSV4_OBJECT_ADDITIONAL_PROPERTIES, self::pointerJoin(array($key)), "/additionalProperties", "Additional properties not allowed");
				} else if (is_object($additionalProperties)) {
					$subResult = $this->subResult($subValue, $additionalProperties);
					$this->includeSubResult($subResult, self::pointerJoin(array($key)), "/additionalProperties");
				}
			}
		}
		if (isset($this->schema->dependencies)) {
			foreach ($this->schema->dependencies as $key => $dep) {
				if (!isset($this->data->$key)) {
					continue;
				}
				if (is_object($dep)) {
					$subResult = $this->subResult($this->data, $dep);
					$this->includeSubResult($subResult, "", self::pointerJoin(array("dependencies", $key)));
				} else if (is_array($dep)) {
					foreach ($dep as $index => $depKey) {
						if (!isset($this->data->$depKey)) {
							$this->fail(JSV4_OBJECT_DEPENDENCY_KEY, "", self::pointerJoin(array("dependencies", $key, $index)), "Property $key depends on $depKey");
						}
					}
				} else {
					if (!isset($this->data->$dep)) {
						$this->fail(JSV4_OBJECT_DEPENDENCY_KEY, "", self::pointerJoin(array("dependencies", $key)), "Property $key depends on $dep");
					}
				}
			}
		}
		if (isset($this->schema->minProperties)) {
			if (count(get_object_vars($this->data)) < $this->schema->minProperties) {
				$this->fail(JSV4_OBJECT_PROPERTIES_MINIMUM, "", "/minProperties", ($this->schema->minProperties == 1) ? "Object cannot be empty" : "Object must have at least {$this->schema->minProperties} defined properties");
			}
		}
		if (isset($this->schema->maxProperties)) {
			if (count(get_object_vars($this->data)) > $this->schema->maxProperties) {
				$this->fail(JSV4_OBJECT_PROPERTIES_MAXIMUM, "", "/minProperties", ($this->schema->maxProperties == 1) ? "Object must have at most one defined property" : "Object must have at most {$this->schema->maxProperties} defined properties");
			}
		}
	}
	
	private function checkArray() {
		if (!is_array($this->data)) {
			return;
		}
		if (isset($this->schema->items)) {
			$items = $this->schema->items;
			if (is_array($items)) {
				foreach ($this->data as $index => &$subData) {
					if (!is_numeric($index)) {
						throw new Exception("Arrays must only be numerically-indexed");
					}
					if (isset($items[$index])) {
						$subResult = $this->subResult($subData, $items[$index]);
						$this->includeSubResult($subResult, "/{$index}", "/items/{$index}");
					} else if (isset($this->schema->additionalItems)) {
						$additionalItems = $this->schema->additionalItems;
						if (!$additionalItems) {
							$this->fail(JSV4_ARRAY_ADDITIONAL_ITEMS, "/{$index}", "/additionalItems", "Additional items (index ".count($items)." or more) are not allowed");
						} else if ($additionalItems !== TRUE) {
							$subResult = $this->subResult($subData, $additionalItems);
							$this->includeSubResult($subResult, "/{$index}", "/additionalItems");
						}
					}
				}
			} else {
				foreach ($this->data as $index => &$subData) {
					if (!is_numeric($index)) {
						throw new Exception("Arrays must only be numerically-indexed");
					}
					$subResult = $this->subResult($subData, $items);
					$this->includeSubResult($subResult, "/{$index}", "/items");
				}
			}
		}
		if (isset($this->schema->minItems)) {
			if (count($this->data) < $this->schema->minItems) {
				$this->fail(JSV4_ARRAY_LENGTH_SHORT, "", "/minItems", "Array is too short (must have at least {$this->schema->minItems} items)");
			}
		}
		if (isset($this->schema->maxItems)) {
			if (count($this->data) > $this->schema->maxItems) {
				$this->fail(JSV4_ARRAY_LENGTH_LONG, "", "/maxItems", "Array is too long (must have at most {$this->schema->maxItems} items)");
			}
		}
		if (isset($this->schema->uniqueItems)) {
			foreach ($this->data as $indexA => $itemA) {
				foreach ($this->data as $indexB => $itemB) {
					if ($indexA < $indexB) {
						if (self::recursiveEqual($itemA, $itemB)) {
							$this->fail(JSV4_ARRAY_UNIQUE, "", "/uniqueItems", "Array items must be unique (items $indexA and $indexB)");
							break 2;
						}
					}
				}
			}
		}
	}
	
	private function checkString() {
		if (!is_string($this->data)) {
			return;
		}
		if (isset($this->schema->minLength)) {
			if (strlen($this->data) < $this->schema->minLength) {
				$this->fail(JSV4_STRING_LENGTH_SHORT, "", "/minLength", "String must be at least {$this->schema->minLength} characters long");
			}
		}
		if (isset($this->schema->maxLength)) {
			if (strlen($this->data) > $this->schema->maxLength) {
				$this->fail(JSV4_STRING_LENGTH_LONG, "", "/maxLength", "String must be at most {$this->schema->maxLength} characters long");
			}
		}
		if (isset($this->schema->pattern)) {
			$pattern = $this->schema->pattern;
			$patternFlags = isset($this->schema->patternFlags) ? $this->schema->patternFlags : '';
			$result = preg_match("/".str_replace("/", "\\/", $pattern)."/".$patternFlags, $this->data);
			if ($result === 0) {
				$this->fail(JSV4_STRING_PATTERN, "", "/pattern", "String does not match pattern: $pattern");
			}
		}
	}
	
	private function checkNumber() {
		if (is_string($this->data) || !is_numeric($this->data)) {
			return;
		}
		if (isset($this->schema->multipleOf)) {
			if (fmod($this->data, $this->schema->multipleOf) != 0) {
				$this->fail(JSV4_NUMBER_MULTIPLE_OF, "", "/multipleOf", "Number must be a multiple of {$this->schema->multipleOf}");
			}
		}
		if (isset($this->schema->minimum)) {
			$minimum = $this->schema->minimum;
			if (isset($this->schema->exclusiveMinimum) && $this->schema->exclusiveMinimum) {
				if ($this->data <= $minimum) {
					$this->fail(JSV4_NUMBER_MINIMUM_EXCLUSIVE, "", "", "Number must be > $minimum");
				}
			} else {
				if ($this->data < $minimum) {
					$this->fail(JSV4_NUMBER_MINIMUM, "", "/minimum", "Number must be >= $minimum");
				}
			}
		}
		if (isset($this->schema->maximum)) {
			$maximum = $this->schema->maximum;
			if (isset($this->schema->exclusiveMaximum) && $this->schema->exclusiveMaximum) {
				if ($this->data >= $maximum) {
					$this->fail(JSV4_NUMBER_MAXIMUM_EXCLUSIVE, "", "", "Number must be < $maximum");
				}
			} else {
				if ($this->data > $maximum) {
					$this->fail(JSV4_NUMBER_MAXIMUM, "", "/maximum", "Number must be <= $maximum");
				}
			}
		}
	}
	
	private function checkComposite() {
		if (isset($this->schema->allOf)) {
			foreach ($this->schema->allOf as $index => $subSchema) {
				$subResult = $this->subResult($this->data, $subSchema, FALSE);
				$this->includeSubResult($subResult, "", "/allOf/".(int)$index);
			}
		}
		if (isset($this->schema->anyOf)) {
			$failResults = array();
			foreach ($this->schema->anyOf as $index => $subSchema) {
				$subResult = $this->subResult($this->data, $subSchema, FALSE);
				if ($subResult->valid) {
					return;
				}
				$failResults[] = $subResult;
			}
			$this->fail(JSV4_ANY_OF_MISSING, "", "/anyOf", "Value must satisfy at least one of the options", $failResults);
		}
		if (isset($this->schema->oneOf)) {
			$failResults = array();
			$successIndex = NULL;
			foreach ($this->schema->oneOf as $index => $subSchema) {
				$subResult = $this->subResult($this->data, $subSchema, FALSE);
				if ($subResult->valid) {
					if ($successIndex === NULL) {
						$successIndex = $index;
					} else {
						$this->fail(JSV4_ONE_OF_MULTIPLE, "", "/oneOf", "Value satisfies more than one of the options ($successIndex and $index)");
					}
					continue;
				}
				$failResults[] = $subResult;
			}
			if ($successIndex === NULL) {
				$this->fail(JSV4_ONE_OF_MISSING, "", "/oneOf", "Value must satisfy one of the options", $failResults);
			}
		}
		if (isset($this->schema->not)) {
			$subResult = $this->subResult($this->data, $this->schema->not, FALSE);
			if ($subResult->valid) {
				$this->fail(JSV4_NOT_PASSED, "", "/not", "Value satisfies prohibited schema");
			}
		}
	}
	
	private function createValueForProperty($key) {
		$schema = NULL;
		if (isset($this->schema->properties->$key)) {
			$schema = $this->schema->properties->$key;
		} else if (isset($this->schema->patternProperties)) {
			foreach ($this->schema->patternProperties as $pattern => $subSchema) {
				if (preg_match("/".str_replace("/", "\\/", $pattern)."/")) {
					$schema = $subSchema;
					break;
				}
			}
		}
		if (!$schema && isset($this->schema->additionalProperties)) {
			$schema = $this->schema->additionalProperties;
		}
		if ($schema) {
			if (isset($schema->default)) {
				$this->data->$key = unserialize(serialize($schema->default));
				return TRUE;
			}
			if (isset($schema->type)) {
				$types = is_array($schema->type) ? $schema->type : array($schema->type);
				if (in_array("null", $types)) {
					$this->data->$key = NULL;
				} elseif (in_array("boolean", $types)) {
					$this->data->$key = TRUE;
				} elseif (in_array("integer", $types) || in_array("number", $types)) {
					$this->data->$key = 0;
				} elseif (in_array("string", $types)) {
					$this->data->$key = "";
				} elseif (in_array("object", $types)) {
					$this->data->$key = new StdClass;
				} elseif (in_array("array", $types)) {
					$this->data->$key = array();
				} else {
					return FALSE;
				}
			}
			return TRUE;
		}
		return FALSE;
	}
}

class Jsv4Error extends Exception {
	public $code;
	public $dataPath;
	public $schemaPath;
	public $message;

	public function __construct($code, $dataPath, $schemaPath, $errorMessage, $subResults=NULL) {
		parent::__construct($errorMessage);
		$this->code = $code;
		$this->dataPath = $dataPath;
		$this->schemaPath = $schemaPath;
		$this->message = $errorMessage;
		if ($subResults) {
			$this->subResults = $subResults;
		}
	}
	
	public function prefix($dataPrefix, $schemaPrefix) {
		return new Jsv4Error($this->code, $dataPrefix.$this->dataPath, $schemaPrefix.$this->schemaPath, $this->message);
	}
}

?>