validation

type BagValidationConfig struct {
	// FileSpecs is a map of FileSpec structures, describing
	// rules for specific files. The key is the relative path
	// to the file within the bag.
	// E.g. bag-info.txt or dpn_tags/dpn-info.txt.
	FileSpecs map[string]FileSpec
	// TagSpecs is a map of TagSpec objects. The key is the
	// tag name (e.g. Source-Organization or Internal-Sender-Description)
	// and the value is the TagSpec.
	TagSpecs map[string]TagSpec
	// AllowFetchTxt describes whether we should allow the fetch.txt file
	// to be present in a bag. APTrust prohibits this, because honoring
	// fetch.txt involves downloading remote files, validating their
	// checksums, and saving them in preservation storage.
	AllowFetchTxt bool
	// AllowMiscTopLevelFiles describes whether a valid bag can
	// contain files not specifically defined in the config.
	AllowMiscTopLevelFiles bool
	// AllowMiscDirectories describes whether a valid bag can
	// contain Directories other than the data directory.
	AllowMiscDirectories bool
	// TopLevelDirMustMatchBagName describes whether a tarred bag
	// must untar to a directory whose name matches the tar file
	// name. E.g. Must my_bag.tar untar to a directory called my_tar?
	TopLevelDirMustMatchBagName bool
	// Which fixity algorithms should we calculate on tag and
	// payload files?
	FixityAlgorithms []string
	// Regex to describe valid file and directory names.
	// This can also be set to APTRUST to use the standard APTrust
	// filename pattern defined in constants.APTrustFileNamePattern,
	// or POSIX to use POSIX file name rules.
	FileNamePattern string
	// Regex compiled internally from FileNamePattern.
	FileNameRegex *regexp.Regexp
}

type FileSpec struct {
	// Presence can be REQUIRED, OPTIONAL, or FORBIDDEN.
	Presence string
	// If this is true, the file must be parsed as a BagIt
	// tag file, using the label:value format.
	ParseAsTagFile bool
}

type TagSpec struct {
	// FilePath is the path of the file within the bag.
	// This will obviously be a relative path.
	FilePath string
	// Presence can be REQUIRED, OPTIONAL, or FORBIDDEN.
	Presence string
	// EmptyOK indicates whether its OK for the tag value
	// to be empty.
	EmptyOK bool
	// Describes which values are allowed (case-insensitive).
	AllowedValues []string
}

type Validator struct {
	PathToBag                  string
	BagValidationConfig        *BagValidationConfig
	PreserveExtendedAttributes bool
	ObjIdentifier              string
	// contains filtered or unexported fields
}