imgproxy/options/parser/errors.go

package optionsparser

import (
	"context"
	"fmt"
	"net/http"
	"strings"

	"github.com/imgproxy/imgproxy/v4/errctx"
)

const defaultDocsUrl = "https://docs.imgproxy.net/usage/processing"

type (
	InvalidURLError      struct{ *errctx.TextError }
	UnknownOptionError   struct{ *errctx.TextError }
	ForbiddenOptionError struct{ *errctx.TextError }
	OptionArgumentError  struct{ *errctx.TextError }
	SecurityOptionsError struct{ *errctx.TextError }
)

func newInvalidURLError(ctx context.Context, format string, args ...any) error {
	return InvalidURLError{errctx.NewTextError(
		fmt.Sprintf(format, args...),
		1,
		errctx.WithStatusCode(http.StatusNotFound),
		errctx.WithPublicMessage("Invalid URL"),
		errctx.WithDocsURL(errctx.DocsBaseURL(ctx, defaultDocsUrl)),
		errctx.WithShouldReport(false),
	)}
}

func newUnknownOptionError(ctx context.Context, kind, opt string) error {
	return UnknownOptionError{errctx.NewTextError(
		fmt.Sprintf("Unknown %s option %s", kind, opt),
		1,
		errctx.WithStatusCode(http.StatusNotFound),
		errctx.WithPublicMessage("Invalid URL"),
		errctx.WithDocsURL(errctx.DocsBaseURL(ctx, defaultDocsUrl)),
		errctx.WithShouldReport(false),
	)}
}

func newForbiddenOptionError(ctx context.Context, kind, opt string) error {
	return ForbiddenOptionError{errctx.NewTextError(
		fmt.Sprintf("Forbidden %s option %s", kind, opt),
		1,
		errctx.WithStatusCode(http.StatusNotFound),
		errctx.WithPublicMessage("Invalid URL"),
		errctx.WithShouldReport(false),
		errctx.WithDocsURL(errctx.DocsBaseURL(ctx, defaultDocsUrl)),
	)}
}

func newOptionArgumentError(ctx context.Context, key, format string, args ...any) error {
	url := errctx.DocsBaseURL(ctx, defaultDocsUrl)
	if key != "" {
		url = url + "#" + errorKey(key)
	}

	return OptionArgumentError{errctx.NewTextError(
		fmt.Sprintf(format, args...),
		1,
		errctx.WithStatusCode(http.StatusNotFound),
		errctx.WithPublicMessage("Invalid URL"),
		errctx.WithDocsURL(url),
		errctx.WithShouldReport(false),
	)}
}

func newSecurityOptionsError(ctx context.Context) error {
	return SecurityOptionsError{errctx.NewTextError(
		"Security processing options are not allowed",
		1,
		errctx.WithStatusCode(http.StatusForbidden),
		errctx.WithPublicMessage("Invalid URL"),
		errctx.WithDocsURL(errctx.DocsBaseURL(ctx, defaultDocsUrl)),
		errctx.WithShouldReport(false),
	)}
}

// newInvalidArgsError creates a standardized error for invalid arguments
func newInvalidArgsError(ctx context.Context, key string, args []string) error {
	return newOptionArgumentError(ctx, key, "Invalid %s arguments: %s", key, args)
}

// newInvalidArgumentError creates a standardized error for an invalid single argument
func newInvalidArgumentError(ctx context.Context, key, arg string, expected ...string) error {
	msg := "Invalid %s: %s"
	if len(expected) > 0 {
		msg += " (expected " + strings.Join(expected, ", ") + ")"
	}

	return newOptionArgumentError(ctx, key, msg, key, arg)
}

func errorKey(key string) string {
	k, _, _ := strings.Cut(strings.ReplaceAll(key, "_", "-"), ".")
	return k
}