subSchema.go

// Copyright 2015 xeipuuv ( https://github.com/xeipuuv )
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// author           xeipuuv
// author-github    https://github.com/xeipuuv
// author-mail      xeipuuv@gmail.com
//
// repository-name  gojsonschema
// repository-desc  An implementation of JSON Schema, based on IETF's draft v4 - Go language.
//
// description      Defines the structure of a sub-subSchema.
//                  A sub-subSchema can contain other sub-schemas.
//
// created          27-02-2013

package gojsonschema

import (
	"errors"
	"fmt"
	"regexp"
	"strings"

	"github.com/xeipuuv/gojsonreference"
)

const (
	KEY_SCHEMA                = "$subSchema"
	KEY_ID                    = "$id"
	KEY_REF                   = "$ref"
	KEY_TITLE                 = "title"
	KEY_DESCRIPTION           = "description"
	KEY_TYPE                  = "type"
	KEY_ITEMS                 = "items"
	KEY_ADDITIONAL_ITEMS      = "additionalItems"
	KEY_PROPERTIES            = "properties"
	KEY_PATTERN_PROPERTIES    = "patternProperties"
	KEY_ADDITIONAL_PROPERTIES = "additionalProperties"
	KEY_DEFINITIONS           = "definitions"
	KEY_MULTIPLE_OF           = "multipleOf"
	KEY_MINIMUM               = "minimum"
	KEY_MAXIMUM               = "maximum"
	KEY_EXCLUSIVE_MINIMUM     = "exclusiveMinimum"
	KEY_EXCLUSIVE_MAXIMUM     = "exclusiveMaximum"
	KEY_MIN_LENGTH            = "minLength"
	KEY_MAX_LENGTH            = "maxLength"
	KEY_PATTERN               = "pattern"
	KEY_MIN_PROPERTIES        = "minProperties"
	KEY_MAX_PROPERTIES        = "maxProperties"
	KEY_DEPENDENCIES          = "dependencies"
	KEY_REQUIRED              = "required"
	KEY_MIN_ITEMS             = "minItems"
	KEY_MAX_ITEMS             = "maxItems"
	KEY_UNIQUE_ITEMS          = "uniqueItems"
	KEY_ENUM                  = "enum"
	KEY_ONE_OF                = "oneOf"
	KEY_ANY_OF                = "anyOf"
	KEY_ALL_OF                = "allOf"
	KEY_NOT                   = "not"
)

type subSchema struct {

	// basic subSchema meta properties
	id          *string
	title       *string
	description *string

	property string

	// Types associated with the subSchema
	types jsonSchemaType

	// Reference url
	ref *gojsonreference.JsonReference
	// Schema referenced
	refSchema *subSchema
	// Json reference
	subSchema *gojsonreference.JsonReference

	// hierarchy
	parent                      *subSchema
	definitions                 map[string]*subSchema
	definitionsChildren         []*subSchema
	itemsChildren               []*subSchema
	itemsChildrenIsSingleSchema bool
	propertiesChildren          []*subSchema

	// validation : number / integer
	multipleOf       *float64
	maximum          *float64
	exclusiveMaximum *bool
	minimum          *float64
	exclusiveMinimum *bool

	// validation : string
	minLength *int
	maxLength *int
	pattern   *regexp.Regexp

	// validation : object
	minProperties *int
	maxProperties *int
	required      []string

	dependencies         map[string]interface{}
	additionalProperties interface{}
	patternProperties    map[string]*subSchema

	// validation : array
	minItems    *int
	maxItems    *int
	uniqueItems *bool

	additionalItems interface{}

	// validation : all
	enum []string

	// validation : subSchema
	oneOf []*subSchema
	anyOf []*subSchema
	allOf []*subSchema
	not   *subSchema
}

func marshalSubSchemas(subschemaList []*subSchema) (subschemas []interface{}) {
	for _, s := range subschemaList {
		subschemas = append(subschemas, marshalSubSchema(s))
	}
	return
}

// marshalSubSchema marshals a subschema into JSON
func marshalSubSchema(s *subSchema) interface{} {
	m := map[string]interface{}{
		"type": s.types.String(),
	}

	if s.types.Contains(TYPE_OBJECT) {
		if len(s.propertiesChildren) != 0 {
			p := make(map[string]interface{})
			for _, ss := range s.propertiesChildren {
				p[ss.property] = marshalSubSchema(ss)
			}
			m["properties"] = p
		}

		if s.minProperties != nil {
			m["minProperties"] = s.minProperties
		}

		if s.maxProperties != nil {
			m["maxProperties"] = s.maxProperties
		}

		if s.additionalProperties != nil {
			if ss, ok := s.additionalProperties.(*subSchema); ok {
				m["additionalProperties"] = marshalSubSchema(ss)
			} else {
				m["additionalProperties"] = s.additionalProperties
			}
		}

		if s.dependencies != nil {
			if ss, ok := s.additionalProperties.(*subSchema); ok {
				m["dependencies"] = marshalSubSchema(ss)
			} else {
				m["dependencies"] = s.dependencies
			}
		}

		if len(s.required) != 0 {
			m["required"] = s.required
		}
	}

	if s.types.Contains(TYPE_ARRAY) {
		if len(s.itemsChildren) != 0 {
			var items []interface{}
			for _, si := range s.itemsChildren {
				items = append(items, marshalSubSchema(si))
			}
			m["items"] = items
		}

		if s.minItems != nil {
			m["minItems"] = s.minItems
		}
		if s.maxItems != nil {
			m["maxItems"] = s.maxItems
		}

		if s.additionalItems != nil {
			m["additionalItems"] = s.additionalItems
		}

		if s.uniqueItems != nil {
			m["uniqueItems"] = s.uniqueItems
		}
	}

	if s.types.Contains(TYPE_STRING) {
		if s.minLength != nil {
			m["minLength"] = s.minLength
		}
		if s.maxLength != nil {
			m["maxLength"] = s.maxLength
		}
		if s.pattern != nil {
			m["pattern"] = s.pattern.String()
		}
	}

	if s.types.Contains(TYPE_INTEGER) || s.types.Contains(TYPE_NUMBER) {
		if s.multipleOf != nil {
			m["multipleOf"] = s.multipleOf
		}

		if s.maximum != nil {
			m["maximum"] = s.maximum
		}

		if s.exclusiveMaximum != nil {
			m["exclusiveMaximum"] = s.exclusiveMaximum
		}

		if s.minimum != nil {
			m["minimum"] = s.minimum
		}

		if s.exclusiveMinimum != nil {
			m["exclusiveMinimum"] = s.exclusiveMinimum
		}
	}

	if s.enum != nil {
		m["enum"] = s.enum
	}

	return m
}

func (s *subSchema) AddEnum(i interface{}) error {

	is, err := marshalToJsonString(i)
	if err != nil {
		return err
	}

	if isStringInSlice(s.enum, *is) {
		return errors.New(fmt.Sprintf(ERROR_MESSAGE_X_ITEMS_MUST_BE_UNIQUE, KEY_ENUM))
	}

	s.enum = append(s.enum, *is)

	return nil
}

func (s *subSchema) ContainsEnum(i interface{}) (bool, error) {

	is, err := marshalToJsonString(i)
	if err != nil {
		return false, err
	}

	return isStringInSlice(s.enum, *is), nil
}

func (s *subSchema) AddOneOf(subSchema *subSchema) {
	s.oneOf = append(s.oneOf, subSchema)
}

func (s *subSchema) AddAllOf(subSchema *subSchema) {
	s.allOf = append(s.allOf, subSchema)
}

func (s *subSchema) AddAnyOf(subSchema *subSchema) {
	s.anyOf = append(s.anyOf, subSchema)
}

func (s *subSchema) SetNot(subSchema *subSchema) {
	s.not = subSchema
}

func (s *subSchema) AddRequired(value string) error {

	if isStringInSlice(s.required, value) {
		return errors.New(fmt.Sprintf(ERROR_MESSAGE_X_ITEMS_MUST_BE_UNIQUE, KEY_REQUIRED))
	}

	s.required = append(s.required, value)

	return nil
}

func (s *subSchema) AddDefinitionChild(child *subSchema) {
	s.definitionsChildren = append(s.definitionsChildren, child)
}

func (s *subSchema) AddItemsChild(child *subSchema) {
	s.itemsChildren = append(s.itemsChildren, child)
}

func (s *subSchema) AddPropertiesChild(child *subSchema) {
	s.propertiesChildren = append(s.propertiesChildren, child)
}

func (s *subSchema) PatternPropertiesString() string {

	if s.patternProperties == nil || len(s.patternProperties) == 0 {
		return STRING_UNDEFINED // should never happen
	}

	patternPropertiesKeySlice := []string{}
	for pk, _ := range s.patternProperties {
		patternPropertiesKeySlice = append(patternPropertiesKeySlice, `"`+pk+`"`)
	}

	if len(patternPropertiesKeySlice) == 1 {
		return patternPropertiesKeySlice[0]
	}

	return "[" + strings.Join(patternPropertiesKeySlice, ",") + "]"

}