photoprism/internal/entity/src.go

package entity

import (
	"sort"
	"strconv"
	"strings"

	"github.com/photoprism/photoprism/internal/ai/classify"
)

// Src represents a metadata source string.
type Src = string

// Priority represents a relative metadata source priority.
type Priority = int

// Priorities maps source strings to their relative priorities.
type Priorities map[Src]Priority

// SrcMap maps human-readable source names to sources.
type SrcMap map[string]Src

// Supported metadata source strings.
const (
	SrcAuto     Src = classify.SrcAuto     // Prio 1
	SrcDefault  Src = "default"            // Prio 1
	SrcEstimate Src = "estimate"           // Prio 2
	SrcFile     Src = "file"               // Prio 2
	SrcName     Src = "name"               // Prio 4
	SrcYaml     Src = "yaml"               // Prio 8
	SrcOIDC     Src = "oidc"               // Prio 8
	SrcLDAP     Src = "ldap"               // Prio 8
	SrcLocation Src = classify.SrcLocation // Prio 8
	SrcMarker   Src = "marker"             // Prio 8
	SrcImage    Src = classify.SrcImage    // Prio 8
	SrcPigo     Src = "pigo"
	SrcONNX     Src = "onnx"
	SrcOllama   Src = "ollama"
	SrcOpenAI   Src = "openai"
	SrcTitle    Src = classify.SrcTitle   // Prio 16
	SrcCaption  Src = classify.SrcCaption // Prio 16
	SrcSubject  Src = classify.SrcSubject // Prio 16
	SrcKeyword  Src = classify.SrcKeyword // Prio 16
	SrcMeta     Src = "meta"              // Prio 16
	SrcXmp      Src = "xmp"               // Prio 32
	SrcBatch    Src = "batch"             // Prio 64
	SrcVision   Src = "vision"            // Prio 64
	SrcManual   Src = "manual"            // Prio 64
	SrcAdmin    Src = "admin"             // Prio 128
)

// SrcString returns the specified source as a string for logging purposes.
func SrcString(src Src) string {
	if src == SrcAuto {
		return "auto"
	}

	return src
}

// SrcPriority maps supported source strings to their relative priorities.
var SrcPriority = Priorities{
	SrcAuto:     1,
	SrcDefault:  1,
	SrcEstimate: 2,
	SrcFile:     2,
	SrcName:     4,
	SrcYaml:     8,
	SrcOIDC:     8,
	SrcLDAP:     8,
	SrcLocation: 8,
	SrcMarker:   8,
	SrcImage:    8,
	SrcPigo:     8,
	SrcONNX:     12,
	SrcOllama:   16,
	SrcOpenAI:   16,
	SrcTitle:    16,
	SrcCaption:  16,
	SrcSubject:  16,
	SrcKeyword:  16,
	SrcMeta:     16,
	SrcXmp:      32,
	SrcBatch:    64,
	SrcVision:   64,
	SrcManual:   64,
	SrcAdmin:    128,
}

// SrcGenerated contains sources that are commonly used for data generated by computer vision models and services.
var SrcGenerated = Priorities{
	SrcMarker: SrcPriority[SrcMarker],
	SrcImage:  SrcPriority[SrcImage],
	SrcPigo:   SrcPriority[SrcPigo],
	SrcONNX:   SrcPriority[SrcONNX],
	SrcOllama: SrcPriority[SrcOllama],
	SrcOpenAI: SrcPriority[SrcOpenAI],
	SrcVision: SrcPriority[SrcVision],
}

// SrcVisionCommands maps source names to the sources that can be used as arguments for computer vision commands.
var SrcVisionCommands = SrcMap{
	SrcAuto:            SrcAuto,
	SrcString(SrcAuto): SrcAuto,
	SrcDefault:         SrcDefault,
	SrcMarker:          SrcMarker,
	SrcImage:           SrcImage,
	SrcOllama:          SrcOllama,
	SrcOpenAI:          SrcOpenAI,
	SrcVision:          SrcVision,
}

// SrcDesc maps source strings to their descriptions for documentation purposes.
var SrcDesc = map[Src]string{
	SrcAuto:     "Auto",
	SrcDefault:  "Default",
	SrcEstimate: "Estimated",
	SrcFile:     "File System",
	SrcName:     "File Name",
	SrcYaml:     "YAML Sidecar",
	SrcOIDC:     "OpenID Connect (OIDC)",
	SrcLDAP:     "LDAP / Active Directory",
	SrcLocation: "GPS Position",
	SrcMarker:   "Object Detection",
	SrcImage:    "Computer Vision (default)",
	SrcOllama:   "Computer Vision (Ollama)",
	SrcOpenAI:   "Computer Vision (OpenAI)",
	SrcTitle:    "Picture Title",
	SrcCaption:  "Picture Caption",
	SrcSubject:  "Person",
	SrcKeyword:  "Picture Keywords",
	SrcMeta:     "Embedded Metadata",
	SrcXmp:      "XMP Sidecar",
	SrcBatch:    "Batch Edit",
	SrcVision:   "Computer Vision (manual)",
	SrcManual:   "Edited Manually",
	SrcAdmin:    "Admin Override",
}

// Report generates a metadata documentation report for sources with a description.
func (p Priorities) Report() (rows [][]string, cols []string) {
	cols = []string{"Source", "Priority", "Description"}

	keys := make([]string, 0, len(SrcPriority))

	for s := range SrcPriority {
		if _, ok := SrcDesc[s]; ok {
			keys = append(keys, s)
		}
	}

	sort.Slice(keys, func(i, j int) bool {
		pi, pj := SrcPriority[keys[i]], SrcPriority[keys[j]]

		if pi != pj {
			return pi < pj
		}

		di := strings.ToLower(SrcDesc[keys[i]])
		if di == "" {
			di = strings.ToLower(keys[i])
		}

		dj := strings.ToLower(SrcDesc[keys[j]])
		if dj == "" {
			dj = strings.ToLower(keys[j])
		}

		if di != dj {
			return di < dj
		}

		return strings.ToLower(keys[i]) < strings.ToLower(keys[j])
	})

	rows = make([][]string, len(keys))

	for i, k := range keys {
		rows[i] = []string{k, strconv.Itoa(SrcPriority[k]), SrcDesc[k]}
	}

	return rows, cols
}