gotosocial/vendor/codeberg.org/gruf/go-kv/v2/util.go
kim 7af9117e0d [feature + performance] add JSON logging format (#4355)
# Description

Adds JSON logging as an optional alternative log output format. In the process this moves our log formatting itself into a separate subpkg to make it more easily modular, and improves caller name getting with some calling function name caching.

## Checklist

- [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md).
- [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
- [x] I/we have not leveraged AI to create the proposed changes.
- [x] I/we have performed a self-review of added code.
- [x] I/we have written code that is legible and maintainable by others.
- [x] I/we have commented the added code, particularly in hard-to-understand areas.
- [x] I/we have made any necessary changes to documentation.
- [ ] I/we have added tests that cover new code.
- [x] I/we have run tests and they pass locally with the changes.
- [x] I/we have run `go fmt ./...` and `golangci-lint run`.

Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4355
Co-authored-by: kim <grufwub@gmail.com>
Co-committed-by: kim <grufwub@gmail.com>
2025-08-09 16:23:00 +02:00

147 lines
3.5 KiB
Go

package kv
import (
"strconv"
"strings"
"codeberg.org/gruf/go-byteutil"
"codeberg.org/gruf/go-kv/v2/format"
)
// AppendQuoteString will append (and escape/quote where necessary) a field string.
func AppendQuoteString(buf *byteutil.Buffer, str string) {
switch {
case len(str) == 0:
// Append empty quotes.
buf.B = append(buf.B, `""`...)
return
case len(str) == 1:
// Append quoted escaped single byte.
buf.B = format.AppendQuoteByte(buf.B, str[0])
return
case len(str) > format.SingleTermLine || !format.IsSafeASCII(str):
// Long line or contains non-ascii chars.
buf.B = strconv.AppendQuote(buf.B, str)
return
case !isQuoted(str):
// Not single/double quoted already.
if format.ContainsSpaceOrTab(str) {
// Quote un-enclosed spaces.
buf.B = append(buf.B, '"')
buf.B = append(buf.B, str...)
buf.B = append(buf.B, '"')
return
}
if format.ContainsDoubleQuote(str) {
// Contains double quote, double quote
// and append escaped existing.
buf.B = append(buf.B, '"')
buf.B = format.AppendEscape(buf.B, str)
buf.B = append(buf.B, '"')
return
}
}
// Double quoted, enclosed in braces, or
// literally anything else: append as-is.
buf.B = append(buf.B, str...)
return
}
// AppendQuoteValue will append (and escape/quote where necessary) a formatted value string.
func AppendQuoteValue(buf *byteutil.Buffer, str string) {
switch {
case len(str) == 0:
// Append empty quotes.
buf.B = append(buf.B, `""`...)
return
case len(str) == 1:
// Append quoted escaped single byte.
buf.B = format.AppendQuoteByte(buf.B, str[0])
return
case len(str) > format.SingleTermLine || !format.IsSafeASCII(str):
// Long line or contains non-ascii chars.
buf.B = strconv.AppendQuote(buf.B, str)
return
case !isQuoted(str):
// Not single/double quoted already.
// Get space / tab indices (if any).
s := strings.IndexByte(str, ' ')
t := strings.IndexByte(str, '\t')
// Find first whitespace.
sp0 := smallest(s, t)
if sp0 < 0 {
break
}
// Check if str is enclosed by braces.
// (but without any key-value separator).
if (enclosedBy(str, sp0, '{', '}') ||
enclosedBy(str, sp0, '[', ']') ||
enclosedBy(str, sp0, '(', ')')) &&
strings.IndexByte(str, '=') < 0 {
break
}
if format.ContainsDoubleQuote(str) {
// Contains double quote, double quote
// and append escaped existing.
buf.B = append(buf.B, '"')
buf.B = format.AppendEscape(buf.B, str)
buf.B = append(buf.B, '"')
return
}
// Quote un-enclosed spaces.
buf.B = append(buf.B, '"')
buf.B = append(buf.B, str...)
buf.B = append(buf.B, '"')
return
}
// Double quoted, enclosed in braces, or
// literally anything else: append as-is.
buf.B = append(buf.B, str...)
return
}
// isQuoted checks if string is single or double quoted.
func isQuoted(str string) bool {
return (str[0] == '"' && str[len(str)-1] == '"') ||
(str[0] == '\'' && str[len(str)-1] == '\'')
}
// smallest attempts to return the smallest positive value of those given.
func smallest(i1, i2 int) int {
if i1 >= 0 && (i2 < 0 || i1 < i2) {
return i1
}
return i2
}
// enclosedBy will check if given string is enclosed by end, and at least non-whitespace up to start.
func enclosedBy(str string, sp int, start, end byte) bool {
// Check for ending char in string.
if str[len(str)-1] != end {
return false
}
// Check for starting char in string.
i := strings.IndexByte(str, start)
if i < 0 {
return false
}
// Check before space.
return i < sp
}