application.go

package api

import (
	"crypto/sha256"
	"encoding/hex"
	"encoding/json"
	"html/template"
)

// SectionInformation represents a structure to quickly organize the different
// sections and subsections with the payload type(s).
type SectionInformation struct {
	Name       string
	Subsection string
	Payload    string
	hashable   bool
}

var (
	catalogue = []SectionInformation{
		{
			Name:       "Identification",
			Subsection: "ApplicantName",
			Payload:    "identification.name",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "Contacts",
			Payload:    "identification.contacts",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "OtherNames",
			Payload:    "identification.othernames",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "ApplicantBirthDate",
			Payload:    "identification.birthdate",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "ApplicantBirthPlace",
			Payload:    "identification.birthplace",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "ApplicantSSN",
			Payload:    "identification.ssn",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "Physical",
			Payload:    "identification.physical",
			hashable:   true,
		},
		{
			Name:       "Identification",
			Subsection: "Comments",
			Payload:    "identification.comments",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Bankruptcy",
			Payload:    "financial.bankruptcy",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Gambling",
			Payload:    "financial.gambling",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Taxes",
			Payload:    "financial.taxes",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Card",
			Payload:    "financial.card",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Credit",
			Payload:    "financial.credit",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Delinquent",
			Payload:    "financial.delinquent",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Nonpayment",
			Payload:    "financial.nonpayment",
			hashable:   true,
		},
		{
			Name:       "Financial",
			Subsection: "Comments",
			Payload:    "financial.comments",
			hashable:   true,
		},
		{
			Name:       "History",
			Subsection: "Residence",
			Payload:    "history.residence",
			hashable:   true,
		},
		{
			Name:       "History",
			Subsection: "Employment",
			Payload:    "history.employment",
			hashable:   true,
		},
		{
			Name:       "History",
			Subsection: "Education",
			Payload:    "history.education",
			hashable:   true,
		},
		{
			Name:       "History",
			Subsection: "Federal",
			Payload:    "history.federal",
			hashable:   true,
		},
		{
			Name:       "History",
			Subsection: "Comments",
			Payload:    "history.comments",
			hashable:   true,
		},
		{
			Name:       "Relationships",
			Subsection: "Marital",
			Payload:    "relationships.status.marital",
			hashable:   true,
		},
		{
			Name:       "Relationships",
			Subsection: "Cohabitants",
			Payload:    "relationships.status.cohabitant",
			hashable:   true,
		},
		{
			Name:       "Relationships",
			Subsection: "People",
			Payload:    "relationships.people",
			hashable:   true,
		},
		{
			Name:       "Relationships",
			Subsection: "Relatives",
			Payload:    "relationships.relatives",
			hashable:   true,
		},
		{
			Name:       "Relationships",
			Subsection: "Comments",
			Payload:    "relationships.comments",
			hashable:   true,
		},
		{
			Name:       "Citizenship",
			Subsection: "Status",
			Payload:    "citizenship.status",
			hashable:   true,
		},
		{
			Name:       "Citizenship",
			Subsection: "Multiple",
			Payload:    "citizenship.multiple",
			hashable:   true,
		},
		{
			Name:       "Citizenship",
			Subsection: "Passports",
			Payload:    "citizenship.passports",
			hashable:   true,
		},
		{
			Name:       "Citizenship",
			Subsection: "Comments",
			Payload:    "citizenship.comments",
			hashable:   true,
		},
		{
			Name:       "Military",
			Subsection: "Selective",
			Payload:    "military.selective",
			hashable:   true,
		},
		{
			Name:       "Military",
			Subsection: "History",
			Payload:    "military.history",
			hashable:   true,
		},
		{
			Name:       "Military",
			Subsection: "Disciplinary",
			Payload:    "military.disciplinary",
			hashable:   true,
		},
		{
			Name:       "Military",
			Subsection: "Foreign",
			Payload:    "military.foreign",
			hashable:   true,
		},
		{
			Name:       "Military",
			Subsection: "Comments",
			Payload:    "military.comments",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Passport",
			Payload:    "foreign.passport",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Contacts",
			Payload:    "foreign.contacts",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Travel",
			Payload:    "foreign.travel",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "BenefitActivity",
			Payload:    "foreign.activities.benefits",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "DirectActivity",
			Payload:    "foreign.activities.direct",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "IndirectActivity",
			Payload:    "foreign.activities.indirect",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "RealEstateActivity",
			Payload:    "foreign.activities.realestate",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Support",
			Payload:    "foreign.activities.support",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Advice",
			Payload:    "foreign.business.advice",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Conferences",
			Payload:    "foreign.business.conferences",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Contact",
			Payload:    "foreign.business.contact",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Employment",
			Payload:    "foreign.business.employment",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Family",
			Payload:    "foreign.business.family",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Political",
			Payload:    "foreign.business.political",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Sponsorship",
			Payload:    "foreign.business.sponsorship",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Ventures",
			Payload:    "foreign.business.ventures",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Voting",
			Payload:    "foreign.business.voting",
			hashable:   true,
		},
		{
			Name:       "Foreign",
			Subsection: "Comments",
			Payload:    "foreign.comments",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "DrugClearanceUses",
			Payload:    "substance.drugs.clearance",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "PrescriptionUses",
			Payload:    "substance.drugs.misuse",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "OrderedTreatments",
			Payload:    "substance.drugs.ordered",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "DrugPublicSafetyUses",
			Payload:    "substance.drugs.publicsafety",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "DrugInvolvements",
			Payload:    "substance.drugs.purchase",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "DrugUses",
			Payload:    "substance.drugs.usage",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "VoluntaryTreatments",
			Payload:    "substance.drugs.voluntary",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "NegativeImpacts",
			Payload:    "substance.alcohol.negative",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "OrderedCounselings",
			Payload:    "substance.alcohol.ordered",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "VoluntaryCounselings",
			Payload:    "substance.alcohol.voluntary",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "ReceivedCounselings",
			Payload:    "substance.alcohol.additional",
			hashable:   true,
		},
		{
			Name:       "Substance",
			Subsection: "Comments",
			Payload:    "substance.comments",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "ActivitiesToOverthrow",
			Payload:    "legal.associations.activities-to-overthrow",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Advocating",
			Payload:    "legal.associations.advocating",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "EngagedInTerrorism",
			Payload:    "legal.associations.engaged-in-terrorism",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "MembershipOverthrow",
			Payload:    "legal.associations.membership-overthrow",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "MembershipViolence",
			Payload:    "legal.associations.membership-violence-or-force",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "TerrorismAssociation",
			Payload:    "legal.associations.terrorism-association",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "TerroristOrganization",
			Payload:    "legal.associations.terrorist-organization",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "NonCriminalCourtActions",
			Payload:    "legal.court",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Debarred",
			Payload:    "legal.investigations.debarred",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "History",
			Payload:    "legal.investigations.history",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Revoked",
			Payload:    "legal.investigations.revoked",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "PoliceOtherOffenses",
			Payload:    "legal.police.additionaloffenses",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "PoliceDomesticViolence",
			Payload:    "legal.police.domesticviolence",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "PoliceOffenses",
			Payload:    "legal.police.offenses",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Manipulating",
			Payload:    "legal.technology.manipulating",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Unauthorized",
			Payload:    "legal.technology.unauthorized",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Unlawful",
			Payload:    "legal.technology.unlawful",
			hashable:   true,
		},
		{
			Name:       "Legal",
			Subsection: "Comments",
			Payload:    "legal.comments",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "Competence",
			Payload:    "psychological.competence",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "Consultations",
			Payload:    "psychological.consultations",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "Diagnoses",
			Payload:    "psychological.diagnoses",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "ExistingConditions",
			Payload:    "psychological.conditions",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "Hospitalizations",
			Payload:    "psychological.hospitalizations",
			hashable:   true,
		},
		{
			Name:       "Psychological",
			Subsection: "Comments",
			Payload:    "psychological.comments",
			hashable:   true,
		},
		{
			Name:       "Submission",
			Subsection: "Releases",
			Payload:    "submission.releases",
			hashable:   false,
		},
	}
)

// FormMetadata represents extra information associated with the application
// regarding its current state.
type FormMetadata struct {
	Locked bool
	Hash   string
}

// Metadata returns the application metadata.
func Metadata(context DatabaseService, account int, locked bool) []byte {
	meta := &FormMetadata{
		Locked: locked,
		Hash:   Hash(context, account),
	}
	js, _ := json.Marshal(meta)
	return js
}

// Application returns the application state in JSON format.
func Application(context DatabaseService, account int, hashable bool) []byte {
	application := make(map[string]map[string]Payload)

	for _, section := range catalogue {
		// If we only want hashable content but the section is not
		// considered hashable then go to the next item.
		if hashable && !section.hashable {
			continue
		}

		payload := &Payload{
			Type: section.Payload,
		}

		entity, err := payload.Entity()
		if err != nil {
			continue
		}

		if _, err = entity.Get(context, account); err != nil {
			continue
		}

		// application[section.name] = subsection(section.subsection, entity.Marshal())
		if _, ok := application[section.Name]; !ok {
			application[section.Name] = make(map[string]Payload)
		}
		application[section.Name][section.Subsection] = entity.Marshal()
	}

	js, _ := json.Marshal(application)
	return js
}

// Package an application for transmitting to cold storage
func Package(context DatabaseService, xml XMLService, account int, hashable bool) (template.HTML, error) {
	jsonBytes := Application(context, account, hashable)
	var js map[string]interface{}
	if err := json.Unmarshal(jsonBytes, &js); err != nil {
		return template.HTML(""), err
	}
	return xml.DefaultTemplate("application.xml", js)
}

// ApplicationData returns the entire application in a JSON structure.
func ApplicationData(context DatabaseService, account int, hashable bool) (map[string]interface{}, error) {
	jsonBytes := Application(context, account, hashable)
	var js map[string]interface{}
	if err := json.Unmarshal(jsonBytes, &js); err != nil {
		return nil, err
	}
	return js, nil
}

// PurgeAccountStorage removes all data associated with an account
func PurgeAccountStorage(context DatabaseService, account int) {
	for _, section := range catalogue {
		payload := &Payload{
			Type: section.Payload,
		}

		entity, err := payload.Entity()
		if err != nil {
			continue
		}

		if _, err = entity.Delete(context, account); err != nil {
			continue
		}
	}
}

// Hash returns the SHA256 hash of the application state in hexadecimal
func Hash(context DatabaseService, account int) string {
	hash := sha256.Sum256(Application(context, account, true))
	return hex.EncodeToString(hash[:])
}

// Catalogue eturns an array of the sub-sections of the form
func Catalogue() []SectionInformation {
	c := make([]SectionInformation, len(catalogue))
	copy(c, catalogue)
	return c
}

// subsection is a helper function to transform a payload in to a type easily
// converted to JSON.
func subsection(name string, payload Payload) map[string]Payload {
	simple := make(map[string]Payload)
	simple[name] = payload
	return simple
}