common

var AllowableAPIs = ArrayToLower([]string{
	"/capabilities", "/capabilitiesoffered", "/export",
	"/model", "/modelsource"})

var AllowableFlags = ArrayToLower([]string{
	"binary", "collections", "doc", "epoch", "filter", "ignore", "inline",
	"setdefaultversionid", "sort", "specversion"})

var AllowableIgnores = ArrayToLower([]string{
	"capabilities", "defaultversionid", "defaultversionsticky", "epoch",
	"modelsource", "readonly"})

var AllowableMutable = ArrayToLower([]string{
	"capabilities", "entities", "model"})

var AllowableSpecVersions = ArrayToLower([]string{"1.0-rc2", SPECVERSION})

var DefaultCapabilities = &Capabilities{
	APIs:           AllowableAPIs,
	Flags:          SupportedFlags,
	Ignores:        SupportedIgnores,
	Mutable:        AllowableMutable,
	Pagination:     false,
	ShortSelf:      false,
	SpecVersions:   AllowableSpecVersions,
	StickyVersions: PtrBool(true),
}

var GitCommit = ""

var JPtrEsc0 = regexp.MustCompile(`~0`)

var JPtrEsc1 = regexp.MustCompile(`~1`)

var MASK_SERVER = "MaskServer"

var NOMASK_INSTANCE = "NoMaskInstance"

var NOMASK_TS = "NoMaskTS"

var PanicLogSet = (os.Getenv("PANICLOG") != "")

var REG_COMMIT = `GitCommit: [0-9a-f]*\n`

var REG_DBHOST = `DB server: .*`

var REG_INSTANCE = `"source": "[^"]*"`

var REG_RFC3339 = `\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})`

var REG_TSSLASH = `\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}`

var SavedREs = map[string]*regexp.Regexp{
	REG_RFC3339:  regexp.MustCompile(REG_RFC3339),
	REG_TSSLASH:  regexp.MustCompile(REG_TSSLASH),
	REG_COMMIT:   regexp.MustCompile(REG_COMMIT),
	REG_DBHOST:   regexp.MustCompile(REG_DBHOST),
	REG_INSTANCE: regexp.MustCompile(REG_INSTANCE),
}

var ShortChars = "" +
	"abcdefghijklmnopqrstuvwxyz" +
	"ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
	"0123456789" +

	"-@" // 62-63

var SupportedFlags = ArrayToLower([]string{
	"binary", "collections", "doc", "epoch", "filter", "ignore", "inline",
	"setdefaultversionid", "sort", "specversion"})

var SupportedIgnores = ArrayToLower([]string{
	"capabilities", "defaultversionid", "defaultversionsticky", "epoch",
	"modelsource", "readonly"})

var Type2Error = map[string]*XRError{

	"action_not_supported": &XRError{
		Code:  405,
		Title: `The specified action (<action>) is not supported for: <subject>.`,
	},
	"ancestor_circular_reference": &XRError{
		Code:  400,
		Title: `For "<subject>", the request would create a circular list of ancestors: <list>.`,
	},
	"bad_defaultversionid": &XRError{
		Code:  400,
		Title: `An error was found in the "defaultversionid" value specified (<value>): <error_detail>.`,
	},
	"bad_details": &XRError{
		Code:  400,
		Title: `Use of "$details" in this context is not allowed: <subject>.`,
	},
	"bad_filter": &XRError{
		Code:  400,
		Title: `An error was found in "filter" value (<value>): <error_detail>.`,
	},
	"bad_flag": &XRError{
		Code:  400,
		Title: `The specified flag (<flag>) is not allowed in this context: <subject>.`,
	},
	"bad_ignore": &XRError{
		Code:  400,
		Title: `An error was found in "ignore" value (<value>): <error_detail>.`,
	},
	"bad_inline": &XRError{
		Code:  400,
		Title: `An error was found in "inline" value (<value>): <error_detail>.`,
	},
	"bad_request": &XRError{
		Code:  400,
		Title: `<error_detail>.`,
	},
	"bad_sort": &XRError{
		Code:  400,
		Title: `An error was found in "sort" value (<value>): <error_detail>.`,
	},
	"cannot_doc_xref": &XRError{
		Code:  400,
		Title: `Retrieving the document view of a Version for "<subject>" is not allowed because it uses "xref".`,
	},
	"capability_error": &XRError{
		Code:  400,
		Title: `There was an error in the capabilities provided: <error_detail>.`,
	},
	"capability_missing_specversion": &XRError{
		Code:  400,
		Title: `The "specversions" capability needs to contain "<value>".`,
	},
	"capability_unknown": &XRError{
		Code:  400,
		Title: `Unknown capability specified: <field>.`,
	},
	"capability_value": &XRError{
		Code:  400,
		Title: `Invalid value (<value>) specified for capability "<field>". Allowable values include: <list>.`,
	},
	"capability_wildcard": &XRError{
		Code:  400,
		Title: `When "<field>" includes a value of "*" then no other values are allowed.`,
	},
	"compatibility_violation": &XRError{
		Code:  400,
		Title: `The request would cause one or more Versions of "<subject>" to violate its compatibility rule (<value>).`,
	},
	"data_retrieval_error": &XRError{
		Code:  500,
		Title: `The server was unable to retrieve all of the requested data.`,
	},
	"defaultversionid_request": &XRError{
		Code:  400,
		Title: `Processing "<subject>", the "defaultversionid" attribute is not allowed to be "request" since a Version wasn't processed.`,
	},
	"extra_xref_attribute": &XRError{
		Code:  400,
		Title: `Attribute "<name>" is not allowed to be present since the Resource (<subject>) uses "xref".`,
	},
	"groups_only": &XRError{
		Code:  400,
		Title: `Attribute "<name>" is invalid. Only Group types are allowed to be specified on this request: <subject>.`,
	},
	"inline_noninlineable": &XRError{
		Code:  400,
		Title: `Attempting to inline a non-inlineable attribute (<name>) on: <subject>.`,
	},
	"invalid_attribute": &XRError{
		Code:  400,
		Title: `The attribute "<name>" for "<subject>" is not valid: <error_detail>.`,
	},
	"malformed_id": &XRError{
		Code:  400,
		Title: `The specified ID value (<id>) is malformed: <error_detail>.`,
	},
	"malformed_xid": &XRError{
		Code:  400,
		Title: `The specified XID value (<xid>) is malformed: <error_detail>.`,
	},
	"malformed_xref": &XRError{
		Code:  400,
		Title: `The specified xref value (<xref>) is malformed: <error_detail>.`,
	},
	"mismatched_epoch": &XRError{
		Code:  400,
		Title: `The specified epoch value (<bad_epoch>) for "<subject>" does not match its current value (<epoch>).`,
	},
	"mismatched_id": &XRError{
		Code:  400,
		Title: `The specified "<singular>id" value (<invalid_id>) for "<subject>" needs to be "<expected_id>".`,
	},
	"misplaced_epoch": &XRError{
		Code:  400,
		Title: `The specified "epoch" value for "<subject>" needs to be within a "meta" entity.`,
	},
	"missing_versions": &XRError{
		Code:  400,
		Title: `At least one Version needs to be included in the request to process "<subject>".`,
	},
	"model_compliance_error": &XRError{
		Code:  400,
		Title: `The model provided would cause one or more entities in the Registry to become non-compliant.`,
	},
	"model_error": &XRError{
		Code:  400,
		Title: `There was an error in the model definition provided: <error_detail>.`,
	},
	"model_required_true": &XRError{
		Code:  400,
		Title: `Model attribute "<name>" needs to have a "required" value of "true" since a default value is provided.`,
	},
	"model_scalar_default": &XRError{
		Code:  400,
		Title: `Model attribute "<name>" is not allowed to have a default value since it is not a scalar.`,
	},
	"multiple_roots": &XRError{
		Code:  400,
		Title: `The operation would result in multiple root Versions for "<subject>", which is not allowed for "<plural>".`,
	},
	"not_found": &XRError{
		Code:  404,
		Title: `The targeted entity (<subject>) cannot be found.`,
	},
	"one_resource": &XRError{
		Code:  400,
		Title: `Only one attribute from "<list>" can be present at a time for: <subject>.`,
	},
	"parsing_data": &XRError{
		Code:  400,
		Title: `There was an error parsing the data: <error_detail>.`,
	},
	"readonly": &XRError{
		Code:  400,
		Title: `Updating a read-only entity (<subject>) is not allowed.`,
	},
	"required_attribute_missing": &XRError{
		Code:  400,
		Title: `One or more mandatory attributes for "<subject>" are missing: <list>.`,
	},
	"server_error": &XRError{
		Code:  500,
		Title: `An unexpected error occurred, please try again later.`,
	},
	"setdefaultversionid_not_allowed": &XRError{
		Code:  400,
		Title: `Processing "<subject>", the "setdefaultversionid" flag is not allowed to be specified for entities of type "<singular>".`,
	},
	"setdefaultversionsticky_false": &XRError{
		Code:  400,
		Title: `The model attribute "setdefaultversionsticky" needs to be "false" since "maxversions" is "1".`,
	},
	"sort_noncollection": &XRError{
		Code:  400,
		Title: `Can't sort on a non-collection result set. Query path: <subject>.`,
	},
	"too_large": &XRError{
		Code:  406,
		Title: `The size of the response is too large to return in a single response.`,
	},
	"too_many_versions": &XRError{
		Code:  400,
		Title: `When the "setdefaultversionid" flag is set to "request", only one Version is allowed to be specified in the request message.`,
	},
	"unknown_attribute": &XRError{
		Code:  400,
		Title: `An unknown attribute (<name>) was specified for "<subject>".`,
	},
	"unknown_group_type": &XRError{
		Code:  400,
		Title: `An unknown Group type (<name>) was specified in "<subject>".`,
	},
	"unknown_id": &XRError{
		Code:  400,
		Title: `While processing "<subject>", the "<singular>" with a "<singular>id" value of "<id>" cannot be found.`,
	},
	"unknown_resource_type": &XRError{
		Code:  400,
		Title: `An unknown Resource type (<name>) was specified for Group type "<group>".`,
	},
	"unsupported_specversion": &XRError{
		Code:  400,
		Title: `The specified "specversion" value (<specversion>) is not supported. Supported versions: <list>.`,
	},
	"versionid_not_allowed": &XRError{
		Code:  400,
		Title: `While creating a new Version for "<subject>", a "versionid" was specified but the "setversionid" model aspect for entities of type "<plural>" is "false".`,
	},
	"wrong_defaultversionid": &XRError{
		Code:  400,
		Title: `For "<subject>", the "defaultversionid" needs to be "<id>" since "defaultversionsticky" is "false".`,
	},

	"api_not_found": &XRError{
		Code:  404,
		Title: `The specified API is not supported: <subject>.`,
	},
	"details_required": &XRError{
		Code:  405,
		Title: `$details suffix is needed when using PATCH for the entity: <subject>.`,
	},
	"extra_xregistry_header": &XRError{
		Code:  400,
		Title: `xRegistry HTTP header "<name>" is not allowed on this request: <error_detail>.`,
	},
	"header_error": &XRError{
		Code:  400,
		Title: `There was an error processing HTTP header "<name>": <error_detail>.`,
	},
	"missing_body": &XRError{
		Code:  400,
		Title: `The request is missing an HTTP body - try '{}'.`,
	},

	"exists": &XRError{
		Code:  400,
		Title: `"<subject>" already exists.`,
	},
	"client_error": &XRError{

		Code:  400,
		Title: `<error_detail>.`,
	},
	"parsing_response": &XRError{
		Code:  400,
		Title: `There was an error parsing the response from the server: <error_detail>.`,
	},
	"talking_to_server": &XRError{
		Code:  400,
		Title: `There was an error talking to the server (<subject>): <error_detail>.`,
	},
}