| package main |
| |
| import ( |
| "fmt" |
| "net/url" |
| "os" |
| "os/signal" |
| "path" |
| "path/filepath" |
| "strings" |
| "syscall" |
| "time" |
| |
| "github.com/KorAP/KoralPipe-TermMapper/config" |
| "github.com/KorAP/KoralPipe-TermMapper/mapper" |
| "github.com/alecthomas/kong" |
| "github.com/gofiber/fiber/v2" |
| "github.com/rs/zerolog" |
| "github.com/rs/zerolog/log" |
| ) |
| |
| const ( |
| maxInputLength = 1024 * 1024 // 1MB |
| maxParamLength = 1024 // 1KB |
| ) |
| |
| type appConfig struct { |
| Port *int `kong:"short='p',help='Port to listen on'"` |
| Config string `kong:"short='c',help='YAML configuration file containing mapping directives and global settings'"` |
| Mappings []string `kong:"short='m',help='Individual YAML mapping files to load (supports glob patterns like dir/*.yaml)'"` |
| LogLevel *string `kong:"short='l',help='Log level (debug, info, warn, error)'"` |
| } |
| |
| type TemplateMapping struct { |
| ID string |
| Description string |
| } |
| |
| // TemplateData holds data for the Kalamar plugin template |
| type TemplateData struct { |
| Title string |
| Version string |
| Hash string |
| Date string |
| Description string |
| Server string |
| SDK string |
| ServiceURL string |
| MapID string |
| Mappings []TemplateMapping |
| } |
| |
| type QueryParams struct { |
| Dir string |
| FoundryA string |
| FoundryB string |
| LayerA string |
| LayerB string |
| } |
| |
| // requestParams holds common request parameters |
| type requestParams struct { |
| MapID string |
| Dir string |
| FoundryA string |
| FoundryB string |
| LayerA string |
| LayerB string |
| } |
| |
| func parseConfig() *appConfig { |
| cfg := &appConfig{} |
| |
| desc := config.Description |
| desc += " [" + config.Version + "]" |
| |
| ctx := kong.Parse(cfg, |
| kong.Description(desc), |
| kong.UsageOnError(), |
| ) |
| if ctx.Error != nil { |
| fmt.Fprintln(os.Stderr, ctx.Error) |
| os.Exit(1) |
| } |
| return cfg |
| } |
| |
| func setupLogger(level string) { |
| // Parse log level |
| lvl, err := zerolog.ParseLevel(strings.ToLower(level)) |
| if err != nil { |
| log.Error().Err(err).Str("level", level).Msg("Invalid log level, defaulting to info") |
| lvl = zerolog.InfoLevel |
| } |
| |
| // Configure zerolog |
| zerolog.SetGlobalLevel(lvl) |
| log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr}) |
| } |
| |
| // setupFiberLogger configures fiber's logger middleware to integrate with zerolog |
| func setupFiberLogger() fiber.Handler { |
| // Check if HTTP request logging should be enabled based on current log level |
| currentLevel := zerolog.GlobalLevel() |
| |
| // Only enable HTTP request logging if log level is debug or info |
| if currentLevel > zerolog.InfoLevel { |
| return func(c *fiber.Ctx) error { |
| return c.Next() |
| } |
| } |
| |
| return func(c *fiber.Ctx) error { |
| // Record start time |
| start := time.Now() |
| |
| // Process request |
| err := c.Next() |
| |
| // Calculate latency |
| latency := time.Since(start) |
| status := c.Response().StatusCode() |
| |
| // Determine log level based on status code |
| logEvent := log.Info() |
| if status >= 400 && status < 500 { |
| logEvent = log.Warn() |
| } else if status >= 500 { |
| logEvent = log.Error() |
| } |
| |
| // Log the request |
| logEvent. |
| Int("status", status). |
| Dur("latency", latency). |
| Str("method", c.Method()). |
| Str("path", c.Path()). |
| Str("ip", c.IP()). |
| Str("user_agent", c.Get("User-Agent")). |
| Msg("HTTP request") |
| |
| return err |
| } |
| } |
| |
| // extractRequestParams extracts and validates common request parameters |
| func extractRequestParams(c *fiber.Ctx) (*requestParams, error) { |
| params := &requestParams{ |
| MapID: c.Params("map"), |
| Dir: c.Query("dir", "atob"), |
| FoundryA: c.Query("foundryA", ""), |
| FoundryB: c.Query("foundryB", ""), |
| LayerA: c.Query("layerA", ""), |
| LayerB: c.Query("layerB", ""), |
| } |
| |
| // Validate input parameters |
| if err := validateInput(params.MapID, params.Dir, params.FoundryA, params.FoundryB, params.LayerA, params.LayerB, c.Body()); err != nil { |
| return nil, err |
| } |
| |
| // Validate direction |
| if params.Dir != "atob" && params.Dir != "btoa" { |
| return nil, fmt.Errorf("invalid direction, must be 'atob' or 'btoa'") |
| } |
| |
| return params, nil |
| } |
| |
| // parseRequestBody parses JSON request body and direction |
| func parseRequestBody(c *fiber.Ctx, dir string) (any, mapper.Direction, error) { |
| var jsonData any |
| if err := c.BodyParser(&jsonData); err != nil { |
| return nil, mapper.BtoA, fmt.Errorf("invalid JSON in request body") |
| } |
| |
| direction, err := mapper.ParseDirection(dir) |
| if err != nil { |
| return nil, mapper.BtoA, err |
| } |
| |
| return jsonData, direction, nil |
| } |
| |
| func main() { |
| // Parse command line flags |
| cfg := parseConfig() |
| |
| // Validate command line arguments |
| if cfg.Config == "" && len(cfg.Mappings) == 0 { |
| log.Fatal().Msg("At least one configuration source must be provided: use -c for main config file or -m for mapping files") |
| } |
| |
| // Expand glob patterns in mapping files |
| expandedMappings, err := expandGlobs(cfg.Mappings) |
| if err != nil { |
| log.Fatal().Err(err).Msg("Failed to expand glob patterns in mapping files") |
| } |
| |
| // Load configuration from multiple sources |
| yamlConfig, err := config.LoadFromSources(cfg.Config, expandedMappings) |
| if err != nil { |
| log.Fatal().Err(err).Msg("Failed to load configuration") |
| } |
| |
| finalPort := yamlConfig.Port |
| finalLogLevel := yamlConfig.LogLevel |
| |
| // Use command line values if provided (they override config file) |
| if cfg.Port != nil { |
| finalPort = *cfg.Port |
| } |
| if cfg.LogLevel != nil { |
| finalLogLevel = *cfg.LogLevel |
| } |
| |
| // Set up logging with the final log level |
| setupLogger(finalLogLevel) |
| |
| // Create a new mapper instance |
| m, err := mapper.NewMapper(yamlConfig.Lists) |
| if err != nil { |
| log.Fatal().Err(err).Msg("Failed to create mapper") |
| } |
| |
| // Create fiber app |
| app := fiber.New(fiber.Config{ |
| DisableStartupMessage: true, |
| BodyLimit: maxInputLength, |
| ReadBufferSize: 64 * 1024, // 64KB - increase header size limit |
| WriteBufferSize: 64 * 1024, // 64KB - increase response buffer size |
| }) |
| |
| // Add zerolog-integrated logger middleware |
| app.Use(setupFiberLogger()) |
| |
| // Set up routes |
| setupRoutes(app, m, yamlConfig) |
| |
| // Start server |
| go func() { |
| log.Info().Int("port", finalPort).Msg("Starting server") |
| |
| for _, list := range yamlConfig.Lists { |
| log.Info().Str("id", list.ID).Str("desc", list.Description).Msg("Loaded mapping") |
| } |
| |
| if err := app.Listen(fmt.Sprintf(":%d", finalPort)); err != nil { |
| log.Fatal().Err(err).Msg("Server error") |
| } |
| }() |
| |
| // Wait for interrupt signal |
| sigChan := make(chan os.Signal, 1) |
| signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM) |
| <-sigChan |
| |
| // Graceful shutdown |
| log.Info().Msg("Shutting down server") |
| if err := app.Shutdown(); err != nil { |
| log.Error().Err(err).Msg("Error during shutdown") |
| } |
| } |
| |
| func setupRoutes(app *fiber.App, m *mapper.Mapper, yamlConfig *config.MappingConfig) { |
| // Health check endpoint |
| app.Get("/health", func(c *fiber.Ctx) error { |
| return c.SendString("OK") |
| }) |
| |
| // Transformation endpoint |
| app.Post("/:map/query", handleTransform(m)) |
| |
| // Response transformation endpoint |
| app.Post("/:map/response", handleResponseTransform(m)) |
| |
| // Kalamar plugin endpoint |
| app.Get("/", handleKalamarPlugin(yamlConfig)) |
| app.Get("/:map", handleKalamarPlugin(yamlConfig)) |
| } |
| |
| func handleTransform(m *mapper.Mapper) fiber.Handler { |
| return func(c *fiber.Ctx) error { |
| // Extract and validate parameters |
| params, err := extractRequestParams(c) |
| if err != nil { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| // Parse request body |
| jsonData, direction, err := parseRequestBody(c, params.Dir) |
| if err != nil { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| // Apply mappings |
| result, err := m.ApplyQueryMappings(params.MapID, mapper.MappingOptions{ |
| Direction: direction, |
| FoundryA: params.FoundryA, |
| FoundryB: params.FoundryB, |
| LayerA: params.LayerA, |
| LayerB: params.LayerB, |
| }, jsonData) |
| |
| if err != nil { |
| log.Error().Err(err). |
| Str("mapID", params.MapID). |
| Str("direction", params.Dir). |
| Msg("Failed to apply mappings") |
| |
| return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| return c.JSON(result) |
| } |
| } |
| |
| func handleResponseTransform(m *mapper.Mapper) fiber.Handler { |
| return func(c *fiber.Ctx) error { |
| // Extract and validate parameters |
| params, err := extractRequestParams(c) |
| if err != nil { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| // Parse request body |
| jsonData, direction, err := parseRequestBody(c, params.Dir) |
| if err != nil { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| // Apply response mappings |
| result, err := m.ApplyResponseMappings(params.MapID, mapper.MappingOptions{ |
| Direction: direction, |
| FoundryA: params.FoundryA, |
| FoundryB: params.FoundryB, |
| LayerA: params.LayerA, |
| LayerB: params.LayerB, |
| }, jsonData) |
| |
| if err != nil { |
| log.Error().Err(err). |
| Str("mapID", params.MapID). |
| Str("direction", params.Dir). |
| Msg("Failed to apply response mappings") |
| |
| return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| return c.JSON(result) |
| } |
| } |
| |
| // validateInput checks if the input parameters are valid |
| func validateInput(mapID, dir, foundryA, foundryB, layerA, layerB string, body []byte) error { |
| // Define parameter checks |
| params := []struct { |
| name string |
| value string |
| }{ |
| {"mapID", mapID}, |
| {"dir", dir}, |
| {"foundryA", foundryA}, |
| {"foundryB", foundryB}, |
| {"layerA", layerA}, |
| {"layerB", layerB}, |
| } |
| |
| for _, param := range params { |
| // Check input lengths and invalid characters in one combined condition |
| if len(param.value) > maxParamLength { |
| return fmt.Errorf("%s too long (max %d bytes)", param.name, maxParamLength) |
| } |
| if strings.ContainsAny(param.value, "<>{}[]\\") { |
| return fmt.Errorf("%s contains invalid characters", param.name) |
| } |
| } |
| |
| if len(body) > maxInputLength { |
| return fmt.Errorf("request body too large (max %d bytes)", maxInputLength) |
| } |
| |
| return nil |
| } |
| |
| func handleKalamarPlugin(yamlConfig *config.MappingConfig) fiber.Handler { |
| return func(c *fiber.Ctx) error { |
| mapID := c.Params("map") |
| |
| // Get query parameters |
| dir := c.Query("dir", "atob") |
| foundryA := c.Query("foundryA", "") |
| foundryB := c.Query("foundryB", "") |
| layerA := c.Query("layerA", "") |
| layerB := c.Query("layerB", "") |
| |
| // Validate input parameters and direction in one step |
| if err := validateInput(mapID, dir, foundryA, foundryB, layerA, layerB, []byte{}); err != nil { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": err.Error(), |
| }) |
| } |
| |
| if dir != "atob" && dir != "btoa" { |
| return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{ |
| "error": "invalid direction, must be 'atob' or 'btoa'", |
| }) |
| } |
| |
| // Get list of available mappings |
| var mappings []TemplateMapping |
| for _, list := range yamlConfig.Lists { |
| mappings = append(mappings, TemplateMapping{ |
| ID: list.ID, |
| Description: list.Description, |
| }) |
| } |
| |
| // Prepare template data |
| data := TemplateData{ |
| Title: config.Title, |
| Version: config.Version, |
| Hash: config.Buildhash, |
| Date: config.Buildtime, |
| Description: config.Description, |
| Server: yamlConfig.Server, |
| SDK: yamlConfig.SDK, |
| ServiceURL: yamlConfig.ServiceURL, |
| MapID: mapID, |
| Mappings: mappings, |
| } |
| |
| // Add query parameters to template data |
| queryParams := QueryParams{ |
| Dir: dir, |
| FoundryA: foundryA, |
| FoundryB: foundryB, |
| LayerA: layerA, |
| LayerB: layerB, |
| } |
| |
| // Generate HTML |
| html := generateKalamarPluginHTML(data, queryParams) |
| |
| c.Set("Content-Type", "text/html") |
| return c.SendString(html) |
| } |
| } |
| |
| // generateKalamarPluginHTML creates the HTML template for the Kalamar plugin page |
| // This function can be easily modified to change the appearance and content |
| func generateKalamarPluginHTML(data TemplateData, queryParams QueryParams) string { |
| html := `<!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <title>` + data.Title + `</title> |
| <script src="` + data.SDK + `" |
| data-server="` + data.Server + `"></script> |
| </head> |
| <body> |
| <div class="container"> |
| <h1>` + data.Title + `</h1> |
| <p>` + data.Description + `</p>` |
| |
| if data.MapID != "" { |
| html += `<p>Map ID: ` + data.MapID + `</p>` |
| } |
| |
| html += ` <h2>Plugin Information</h2> |
| <p><strong>Version:</strong> <tt>` + data.Version + `</tt></p> |
| <p><strong>Build Date:</strong> <tt>` + data.Date + `</tt></p> |
| <p><strong>Build Hash:</strong> <tt>` + data.Hash + `</tt></p> |
| |
| <h2>Available API Endpoints</h2> |
| <dl> |
| |
| <dt><tt><strong>GET</strong> /:map</tt></dt> |
| <dd><small>Kalamar integration</small></dd> |
| |
| <dt><tt><strong>POST</strong> /:map/query</tt></dt> |
| <dd><small>Transform JSON query objects using term mapping rules</small></dd> |
| |
| <dt><tt><strong>POST</strong> /:map/response</tt></dt> |
| <dd><small>Transform JSON response objects using term mapping rules</small></dd> |
| |
| </dl> |
| |
| <h2>Available Term Mappings</h2> |
| <dl>` |
| |
| for _, m := range data.Mappings { |
| html += `<dt><tt>` + m.ID + `</tt></dt>` |
| html += `<dd>` + m.Description + `</dd>` |
| } |
| |
| html += ` |
| </dl></div>` |
| |
| if data.MapID != "" { |
| |
| queryServiceURL, err := url.Parse(data.ServiceURL) |
| if err != nil { |
| log.Warn().Err(err).Msg("Failed to join URL path") |
| } |
| |
| // Use path.Join to normalize the path part |
| queryServiceURL.Path = path.Join(queryServiceURL.Path, data.MapID+"/query") |
| |
| // Build query parameters for query URL |
| queryParamString := buildQueryParams(queryParams.Dir, queryParams.FoundryA, queryParams.FoundryB, queryParams.LayerA, queryParams.LayerB) |
| queryServiceURL.RawQuery = queryParamString |
| |
| responseServiceURL, err := url.Parse(data.ServiceURL) |
| if err != nil { |
| log.Warn().Err(err).Msg("Failed to join URL path") |
| } |
| |
| // Use path.Join to normalize the path part |
| responseServiceURL.Path = path.Join(responseServiceURL.Path, data.MapID+"/response") |
| |
| reversedDir := "btoa" |
| if queryParams.Dir == "btoa" { |
| reversedDir = "atob" |
| } |
| |
| // Build query parameters for response URL (with reversed direction) |
| responseParamString := buildQueryParams(reversedDir, queryParams.FoundryA, queryParams.FoundryB, queryParams.LayerA, queryParams.LayerB) |
| responseServiceURL.RawQuery = responseParamString |
| |
| html += `<script> |
| <!-- activates/deactivates Mapper. --> |
| |
| let qdata = { |
| 'action' : 'pipe', |
| 'service' : '` + queryServiceURL.String() + `' |
| }; |
| |
| let rdata = { |
| 'action' : 'pipe', |
| 'service' : '` + responseServiceURL.String() + `' |
| }; |
| |
| |
| function pluginit (p) { |
| p.onMessage = function(msg) { |
| if (msg.key == 'termmapper') { |
| if (msg.value) { |
| qdata['job'] = 'add'; |
| } |
| else { |
| qdata['job'] = 'del'; |
| }; |
| KorAPlugin.sendMsg(qdata); |
| if (msg.value) { |
| rdata['job'] = 'add-after'; |
| } |
| else { |
| rdata['job'] = 'del-after'; |
| }; |
| KorAPlugin.sendMsg(rdata); |
| }; |
| }; |
| }; |
| </script>` |
| } |
| |
| html += ` </body> |
| </html>` |
| |
| return html |
| } |
| |
| // buildQueryParams builds a query string from the provided parameters |
| func buildQueryParams(dir, foundryA, foundryB, layerA, layerB string) string { |
| params := url.Values{} |
| if dir != "" { |
| params.Add("dir", dir) |
| } |
| if foundryA != "" { |
| params.Add("foundryA", foundryA) |
| } |
| if foundryB != "" { |
| params.Add("foundryB", foundryB) |
| } |
| if layerA != "" { |
| params.Add("layerA", layerA) |
| } |
| if layerB != "" { |
| params.Add("layerB", layerB) |
| } |
| return params.Encode() |
| } |
| |
| // expandGlobs expands glob patterns in the slice of file paths |
| // Returns the expanded list of files or an error if glob expansion fails |
| func expandGlobs(patterns []string) ([]string, error) { |
| var expanded []string |
| |
| for _, pattern := range patterns { |
| // Use filepath.Glob which works cross-platform |
| matches, err := filepath.Glob(pattern) |
| if err != nil { |
| return nil, fmt.Errorf("failed to expand glob pattern '%s': %w", pattern, err) |
| } |
| |
| // If no matches found, treat as literal filename (consistent with shell behavior) |
| if len(matches) == 0 { |
| log.Warn().Str("pattern", pattern).Msg("Glob pattern matched no files, treating as literal filename") |
| expanded = append(expanded, pattern) |
| } else { |
| expanded = append(expanded, matches...) |
| } |
| } |
| |
| return expanded, nil |
| } |