package pgtype import ( "database/sql" "database/sql/driver" "encoding/json" "fmt" "reflect" ) type JSONCodec struct{} func (JSONCodec) FormatSupported(format int16) bool { return format == TextFormatCode || format == BinaryFormatCode } func (JSONCodec) PreferredFormat() int16 { return TextFormatCode } func (c JSONCodec) PlanEncode(m *Map, oid uint32, format int16, value any) EncodePlan { switch value.(type) { case string: return encodePlanJSONCodecEitherFormatString{} case []byte: return encodePlanJSONCodecEitherFormatByteSlice{} // Cannot rely on driver.Valuer being handled later because anything can be marshalled. // // https://github.com/jackc/pgx/issues/1430 // // Check for driver.Valuer must come before json.Marshaler so that it is guaranteed to beused // when both are implemented https://github.com/jackc/pgx/issues/1805 case driver.Valuer: return &encodePlanDriverValuer{m: m, oid: oid, formatCode: format} // Must come before trying wrap encode plans because a pointer to a struct may be unwrapped to a struct that can be // marshalled. // // https://github.com/jackc/pgx/issues/1681 case json.Marshaler: return encodePlanJSONCodecEitherFormatMarshal{} } // Because anything can be marshalled the normal wrapping in Map.PlanScan doesn't get a chance to run. So try the // appropriate wrappers here. for _, f := range []TryWrapEncodePlanFunc{ TryWrapDerefPointerEncodePlan, TryWrapFindUnderlyingTypeEncodePlan, } { if wrapperPlan, nextValue, ok := f(value); ok { if nextPlan := c.PlanEncode(m, oid, format, nextValue); nextPlan != nil { wrapperPlan.SetNext(nextPlan) return wrapperPlan } } } return encodePlanJSONCodecEitherFormatMarshal{} } type encodePlanJSONCodecEitherFormatString struct{} func (encodePlanJSONCodecEitherFormatString) Encode(value any, buf []byte) (newBuf []byte, err error) { jsonString := value.(string) buf = append(buf, jsonString...) return buf, nil } type encodePlanJSONCodecEitherFormatByteSlice struct{} func (encodePlanJSONCodecEitherFormatByteSlice) Encode(value any, buf []byte) (newBuf []byte, err error) { jsonBytes := value.([]byte) if jsonBytes == nil { return nil, nil } buf = append(buf, jsonBytes...) return buf, nil } type encodePlanJSONCodecEitherFormatMarshal struct{} func (encodePlanJSONCodecEitherFormatMarshal) Encode(value any, buf []byte) (newBuf []byte, err error) { jsonBytes, err := json.Marshal(value) if err != nil { return nil, err } buf = append(buf, jsonBytes...) return buf, nil } func (JSONCodec) PlanScan(m *Map, oid uint32, format int16, target any) ScanPlan { switch target.(type) { case *string: return scanPlanAnyToString{} case **string: // This is to fix **string scanning. It seems wrong to special case **string, but it's not clear what a better // solution would be. // // https://github.com/jackc/pgx/issues/1470 -- **string // https://github.com/jackc/pgx/issues/1691 -- ** anything else if wrapperPlan, nextDst, ok := TryPointerPointerScanPlan(target); ok { if nextPlan := m.planScan(oid, format, nextDst); nextPlan != nil { if _, failed := nextPlan.(*scanPlanFail); !failed { wrapperPlan.SetNext(nextPlan) return wrapperPlan } } } case *[]byte: return scanPlanJSONToByteSlice{} case BytesScanner: return scanPlanBinaryBytesToBytesScanner{} // Cannot rely on sql.Scanner being handled later because scanPlanJSONToJSONUnmarshal will take precedence. // // https://github.com/jackc/pgx/issues/1418 case sql.Scanner: return &scanPlanSQLScanner{formatCode: format} } return scanPlanJSONToJSONUnmarshal{} } type scanPlanAnyToString struct{} func (scanPlanAnyToString) Scan(src []byte, dst any) error { p := dst.(*string) *p = string(src) return nil } type scanPlanJSONToByteSlice struct{} func (scanPlanJSONToByteSlice) Scan(src []byte, dst any) error { dstBuf := dst.(*[]byte) if src == nil { *dstBuf = nil return nil } *dstBuf = make([]byte, len(src)) copy(*dstBuf, src) return nil } type scanPlanJSONToBytesScanner struct{} func (scanPlanJSONToBytesScanner) Scan(src []byte, dst any) error { scanner := (dst).(BytesScanner) return scanner.ScanBytes(src) } type scanPlanJSONToJSONUnmarshal struct{} func (scanPlanJSONToJSONUnmarshal) Scan(src []byte, dst any) error { if src == nil { dstValue := reflect.ValueOf(dst) if dstValue.Kind() == reflect.Ptr { el := dstValue.Elem() switch el.Kind() { case reflect.Ptr, reflect.Slice, reflect.Map, reflect.Interface: el.Set(reflect.Zero(el.Type())) return nil } } return fmt.Errorf("cannot scan NULL into %T", dst) } elem := reflect.ValueOf(dst).Elem() elem.Set(reflect.Zero(elem.Type())) return json.Unmarshal(src, dst) } func (c JSONCodec) DecodeDatabaseSQLValue(m *Map, oid uint32, format int16, src []byte) (driver.Value, error) { if src == nil { return nil, nil } dstBuf := make([]byte, len(src)) copy(dstBuf, src) return dstBuf, nil } func (c JSONCodec) DecodeValue(m *Map, oid uint32, format int16, src []byte) (any, error) { if src == nil { return nil, nil } var dst any err := json.Unmarshal(src, &dst) return dst, err }