| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 1 | package config |
| 2 | |
| 3 | import ( |
| 4 | "fmt" |
| 5 | "os" |
| 6 | |
| Akron | 2ef703c | 2025-07-03 15:57:42 +0200 | [diff] [blame] | 7 | "github.com/KorAP/Koral-Mapper/ast" |
| 8 | "github.com/KorAP/Koral-Mapper/parser" |
| Akron | 7e8da93 | 2025-07-01 11:56:46 +0200 | [diff] [blame] | 9 | "github.com/rs/zerolog/log" |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 10 | "gopkg.in/yaml.v3" |
| 11 | ) |
| 12 | |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 13 | const ( |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 14 | defaultServer = "https://korap.ids-mannheim.de/" |
| 15 | defaultSDK = "https://korap.ids-mannheim.de/js/korap-plugin-latest.js" |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 16 | defaultStylesheet = "https://korap.ids-mannheim.de/css/kalamar-plugin-latest.css" |
| Akron | 2ef703c | 2025-07-03 15:57:42 +0200 | [diff] [blame] | 17 | defaultServiceURL = "https://korap.ids-mannheim.de/plugin/koralmapper" |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 18 | defaultCookieName = "km-config" |
| Akron | 14c13a5 | 2025-06-06 15:36:23 +0200 | [diff] [blame] | 19 | defaultPort = 5725 |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 20 | defaultLogLevel = "warn" |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 21 | ) |
| 22 | |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 23 | // MappingRule represents a single mapping rule in the configuration |
| 24 | type MappingRule string |
| 25 | |
| 26 | // MappingList represents a list of mapping rules with metadata |
| 27 | type MappingList struct { |
| Akron | dab2711 | 2025-06-05 13:52:43 +0200 | [diff] [blame] | 28 | ID string `yaml:"id"` |
| Akron | 2f93c58 | 2026-02-19 16:49:13 +0100 | [diff] [blame] | 29 | Type string `yaml:"type,omitempty"` // "annotation" (default) or "corpus" |
| Akron | dab2711 | 2025-06-05 13:52:43 +0200 | [diff] [blame] | 30 | Description string `yaml:"desc,omitempty"` |
| 31 | FoundryA string `yaml:"foundryA,omitempty"` |
| 32 | LayerA string `yaml:"layerA,omitempty"` |
| 33 | FoundryB string `yaml:"foundryB,omitempty"` |
| 34 | LayerB string `yaml:"layerB,omitempty"` |
| 35 | Mappings []MappingRule `yaml:"mappings"` |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 36 | } |
| 37 | |
| Akron | 2f93c58 | 2026-02-19 16:49:13 +0100 | [diff] [blame] | 38 | // IsCorpus returns true if the mapping list type is "corpus". |
| 39 | func (list *MappingList) IsCorpus() bool { |
| 40 | return list.Type == "corpus" |
| 41 | } |
| 42 | |
| 43 | // ParseCorpusMappings parses all mapping rules as corpus rules. |
| 44 | func (list *MappingList) ParseCorpusMappings() ([]*parser.CorpusMappingResult, error) { |
| 45 | corpusParser := parser.NewCorpusParser() |
| 46 | results := make([]*parser.CorpusMappingResult, len(list.Mappings)) |
| 47 | for i, rule := range list.Mappings { |
| 48 | if rule == "" { |
| 49 | return nil, fmt.Errorf("empty corpus mapping rule at index %d in list '%s'", i, list.ID) |
| 50 | } |
| 51 | result, err := corpusParser.ParseMapping(string(rule)) |
| 52 | if err != nil { |
| 53 | return nil, fmt.Errorf("failed to parse corpus mapping rule %d in list '%s': %w", i, list.ID, err) |
| 54 | } |
| 55 | results[i] = result |
| 56 | } |
| 57 | return results, nil |
| 58 | } |
| 59 | |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 60 | // MappingConfig represents the root configuration containing multiple mapping lists |
| 61 | type MappingConfig struct { |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 62 | SDK string `yaml:"sdk,omitempty"` |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 63 | Stylesheet string `yaml:"stylesheet,omitempty"` |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 64 | Server string `yaml:"server,omitempty"` |
| 65 | ServiceURL string `yaml:"serviceURL,omitempty"` |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 66 | CookieName string `yaml:"cookieName,omitempty"` |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 67 | Port int `yaml:"port,omitempty"` |
| 68 | LogLevel string `yaml:"loglevel,omitempty"` |
| 69 | Lists []MappingList `yaml:"lists,omitempty"` |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 70 | } |
| 71 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 72 | // LoadFromSources loads configuration from multiple sources and merges them: |
| 73 | // - A main configuration file (optional) containing global settings and lists |
| 74 | // - Individual mapping files (optional) containing single mapping lists each |
| 75 | // At least one source must be provided |
| 76 | func LoadFromSources(configFile string, mappingFiles []string) (*MappingConfig, error) { |
| 77 | var allLists []MappingList |
| 78 | var globalConfig MappingConfig |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 79 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 80 | // Track seen IDs across all sources to detect duplicates |
| 81 | seenIDs := make(map[string]bool) |
| Akron | a5d8814 | 2025-05-22 14:42:09 +0200 | [diff] [blame] | 82 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 83 | // Load main configuration file if provided |
| 84 | if configFile != "" { |
| 85 | data, err := os.ReadFile(configFile) |
| 86 | if err != nil { |
| 87 | return nil, fmt.Errorf("failed to read config file '%s': %w", configFile, err) |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 88 | } |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 89 | |
| 90 | if len(data) == 0 { |
| 91 | return nil, fmt.Errorf("EOF: config file '%s' is empty", configFile) |
| 92 | } |
| 93 | |
| 94 | // Try to unmarshal as new format first (object with optional sdk/server and lists) |
| Akron | 813780f | 2025-06-05 15:44:28 +0200 | [diff] [blame] | 95 | if err := yaml.Unmarshal(data, &globalConfig); err == nil { |
| 96 | // Successfully parsed as new format - accept it regardless of whether it has lists |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 97 | for _, list := range globalConfig.Lists { |
| 98 | if seenIDs[list.ID] { |
| 99 | return nil, fmt.Errorf("duplicate mapping list ID found: %s", list.ID) |
| 100 | } |
| 101 | seenIDs[list.ID] = true |
| 102 | } |
| 103 | allLists = append(allLists, globalConfig.Lists...) |
| 104 | } else { |
| 105 | // Fall back to old format (direct list) |
| 106 | var lists []MappingList |
| 107 | if err := yaml.Unmarshal(data, &lists); err != nil { |
| 108 | return nil, fmt.Errorf("failed to parse YAML config file '%s': %w", configFile, err) |
| 109 | } |
| 110 | |
| 111 | for _, list := range lists { |
| 112 | if seenIDs[list.ID] { |
| 113 | return nil, fmt.Errorf("duplicate mapping list ID found: %s", list.ID) |
| 114 | } |
| 115 | seenIDs[list.ID] = true |
| 116 | } |
| 117 | allLists = append(allLists, lists...) |
| 118 | // Clear the lists from globalConfig since we got them from the old format |
| 119 | globalConfig.Lists = nil |
| 120 | } |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 121 | } |
| 122 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 123 | // Load individual mapping files |
| 124 | for _, file := range mappingFiles { |
| 125 | data, err := os.ReadFile(file) |
| 126 | if err != nil { |
| Akron | 7e8da93 | 2025-07-01 11:56:46 +0200 | [diff] [blame] | 127 | log.Error().Err(err).Str("file", file).Msg("Failed to read mapping file") |
| 128 | continue |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | if len(data) == 0 { |
| Akron | 7e8da93 | 2025-07-01 11:56:46 +0200 | [diff] [blame] | 132 | log.Error().Err(err).Str("file", file).Msg("EOF: mapping file is empty") |
| 133 | continue |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | var list MappingList |
| 137 | if err := yaml.Unmarshal(data, &list); err != nil { |
| Akron | 7e8da93 | 2025-07-01 11:56:46 +0200 | [diff] [blame] | 138 | log.Error().Err(err).Str("file", file).Msg("Failed to parse YAML mapping file") |
| 139 | continue |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | if seenIDs[list.ID] { |
| Akron | 7e8da93 | 2025-07-01 11:56:46 +0200 | [diff] [blame] | 143 | log.Error().Err(err).Str("file", file).Str("list-id", list.ID).Msg("Duplicate mapping list ID found") |
| 144 | continue |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 145 | } |
| 146 | seenIDs[list.ID] = true |
| 147 | allLists = append(allLists, list) |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 148 | } |
| 149 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 150 | // Ensure we have at least some configuration |
| 151 | if len(allLists) == 0 { |
| 152 | return nil, fmt.Errorf("no mapping lists found: provide either a config file (-c) with lists or mapping files (-m)") |
| 153 | } |
| 154 | |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 155 | // Validate all mapping lists (skip duplicate ID check since we already did it) |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 156 | if err := validateMappingLists(allLists); err != nil { |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 157 | return nil, err |
| 158 | } |
| 159 | |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 160 | // Create final configuration |
| 161 | result := &MappingConfig{ |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 162 | SDK: globalConfig.SDK, |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 163 | Stylesheet: globalConfig.Stylesheet, |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 164 | Server: globalConfig.Server, |
| 165 | ServiceURL: globalConfig.ServiceURL, |
| 166 | Port: globalConfig.Port, |
| 167 | LogLevel: globalConfig.LogLevel, |
| 168 | Lists: allLists, |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 169 | } |
| 170 | |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 171 | // Apply defaults if not specified |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 172 | ApplyDefaults(result) |
| Akron | e1cff7c | 2025-06-04 18:43:32 +0200 | [diff] [blame] | 173 | |
| 174 | return result, nil |
| 175 | } |
| 176 | |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 177 | // ApplyDefaults sets default values for configuration fields if they are empty |
| Akron | 2ac2ec0 | 2025-06-05 15:26:42 +0200 | [diff] [blame] | 178 | func ApplyDefaults(config *MappingConfig) { |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 179 | defaults := map[*string]string{ |
| 180 | &config.SDK: defaultSDK, |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 181 | &config.Stylesheet: defaultStylesheet, |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 182 | &config.Server: defaultServer, |
| 183 | &config.ServiceURL: defaultServiceURL, |
| Akron | 43fb102 | 2026-02-20 11:38:49 +0100 | [diff] [blame^] | 184 | &config.CookieName: defaultCookieName, |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 185 | &config.LogLevel: defaultLogLevel, |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 186 | } |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 187 | |
| 188 | for field, defaultValue := range defaults { |
| 189 | if *field == "" { |
| 190 | *field = defaultValue |
| 191 | } |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 192 | } |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 193 | |
| Akron | a8a66ce | 2025-06-05 10:50:17 +0200 | [diff] [blame] | 194 | if config.Port == 0 { |
| 195 | config.Port = defaultPort |
| 196 | } |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 197 | } |
| 198 | |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 199 | // validateMappingLists validates a slice of mapping lists (without duplicate ID checking) |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 200 | func validateMappingLists(lists []MappingList) error { |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 201 | for i, list := range lists { |
| 202 | if list.ID == "" { |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 203 | return fmt.Errorf("mapping list at index %d is missing an ID", i) |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 204 | } |
| Akron | a5d8814 | 2025-05-22 14:42:09 +0200 | [diff] [blame] | 205 | |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 206 | if len(list.Mappings) == 0 { |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 207 | return fmt.Errorf("mapping list '%s' has no mapping rules", list.ID) |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | // Validate each mapping rule |
| 211 | for j, rule := range list.Mappings { |
| 212 | if rule == "" { |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 213 | return fmt.Errorf("mapping list '%s' rule at index %d is empty", list.ID, j) |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 214 | } |
| 215 | } |
| 216 | } |
| Akron | 06d21f0 | 2025-06-04 14:36:07 +0200 | [diff] [blame] | 217 | return nil |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 218 | } |
| 219 | |
| 220 | // ParseMappings parses all mapping rules in a list and returns a slice of parsed rules |
| 221 | func (list *MappingList) ParseMappings() ([]*parser.MappingResult, error) { |
| 222 | // Create a grammar parser with the list's default foundries and layers |
| 223 | grammarParser, err := parser.NewGrammarParser("", "") |
| 224 | if err != nil { |
| 225 | return nil, fmt.Errorf("failed to create grammar parser: %w", err) |
| 226 | } |
| 227 | |
| 228 | results := make([]*parser.MappingResult, len(list.Mappings)) |
| 229 | for i, rule := range list.Mappings { |
| Akron | a5d8814 | 2025-05-22 14:42:09 +0200 | [diff] [blame] | 230 | // Check for empty rules first |
| 231 | if rule == "" { |
| 232 | return nil, fmt.Errorf("empty mapping rule at index %d in list '%s'", i, list.ID) |
| 233 | } |
| 234 | |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 235 | // Parse the mapping rule |
| 236 | result, err := grammarParser.ParseMapping(string(rule)) |
| 237 | if err != nil { |
| 238 | return nil, fmt.Errorf("failed to parse mapping rule %d in list '%s': %w", i, list.ID, err) |
| 239 | } |
| 240 | |
| 241 | // Apply default foundries and layers if not specified in the rule |
| 242 | if list.FoundryA != "" { |
| 243 | applyDefaultFoundryAndLayer(result.Upper.Wrap, list.FoundryA, list.LayerA) |
| 244 | } |
| 245 | if list.FoundryB != "" { |
| 246 | applyDefaultFoundryAndLayer(result.Lower.Wrap, list.FoundryB, list.LayerB) |
| 247 | } |
| 248 | |
| 249 | results[i] = result |
| 250 | } |
| 251 | |
| 252 | return results, nil |
| 253 | } |
| 254 | |
| 255 | // applyDefaultFoundryAndLayer recursively applies default foundry and layer to terms that don't have them specified |
| 256 | func applyDefaultFoundryAndLayer(node ast.Node, defaultFoundry, defaultLayer string) { |
| 257 | switch n := node.(type) { |
| 258 | case *ast.Term: |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 259 | if n.Foundry == "" && defaultFoundry != "" { |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 260 | n.Foundry = defaultFoundry |
| 261 | } |
| Akron | 585f50f | 2025-07-03 13:55:47 +0200 | [diff] [blame] | 262 | if n.Layer == "" && defaultLayer != "" { |
| Akron | 57ee558 | 2025-05-21 15:25:13 +0200 | [diff] [blame] | 263 | n.Layer = defaultLayer |
| 264 | } |
| 265 | case *ast.TermGroup: |
| 266 | for _, op := range n.Operands { |
| 267 | applyDefaultFoundryAndLayer(op, defaultFoundry, defaultLayer) |
| 268 | } |
| 269 | } |
| 270 | } |