Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix encoding non-UTF8 values in String field #298

Closed
wants to merge 1 commit into from
Closed

Fix encoding non-UTF8 values in String field #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions field/string.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,28 @@ func (f *String) SetValue(v string) {
}

func (f *String) Pack() ([]byte, error) {
data := []byte(f.value)
utf8Data := []byte(f.value)

if f.spec.Pad != nil {
data = f.spec.Pad.Pad(data, f.spec.Length)
// The length of the encoded data may differ from the UTF-8 encoded length.
// Use the difference to ensure the correct padded length.
unpaddedPacked, err := f.spec.Enc.Encode(utf8Data)
if err != nil {
return nil, fmt.Errorf("failed to encode content: %w", err)
}
diff := len(utf8Data) - len(unpaddedPacked)
if diff < 0 {
diff = -diff
}
utf8Data = f.spec.Pad.Pad(utf8Data, diff+f.spec.Length)
}

packed, err := f.spec.Enc.Encode(data)
packed, err := f.spec.Enc.Encode(utf8Data)
if err != nil {
return nil, fmt.Errorf("failed to encode content: %w", err)
}

packedLength, err := f.spec.Pref.EncodeLength(f.spec.Length, len(data))
packedLength, err := f.spec.Pref.EncodeLength(f.spec.Length, len(packed))
if err != nil {
return nil, fmt.Errorf("failed to encode length: %w", err)
}
Expand All @@ -95,18 +105,15 @@ func (f *String) Unpack(data []byte) (int, error) {
return 0, fmt.Errorf("failed to decode length: %w", err)
}

raw, read, err := f.spec.Enc.Decode(data[prefBytes:], dataLen)
utf8Bytes, read, err := f.spec.Enc.Decode(data[prefBytes:], dataLen)
if err != nil {
return 0, fmt.Errorf("failed to decode content: %w", err)
}

if f.spec.Pad != nil {
raw = f.spec.Pad.Unpad(raw)
}

if err := f.SetBytes(raw); err != nil {
return 0, fmt.Errorf("failed to set bytes: %w", err)
utf8Bytes = f.spec.Pad.Unpad(utf8Bytes)
}
f.value = string(utf8Bytes)

return read + prefBytes, nil
}
Expand Down Expand Up @@ -214,5 +221,6 @@ func (f *String) UnmarshalJSON(b []byte) error {
if err != nil {
return utils.NewSafeError(err, "failed to JSON unmarshal bytes to string")
}
return f.SetBytes([]byte(v))
f.value = v
return nil
}
54 changes: 54 additions & 0 deletions field/string_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,60 @@ func TestStringField(t *testing.T) {
require.Equal(t, "hello", str.Value())
}

func TestStringWithNonUTF8Encoding(t *testing.T) {
spec := &Spec{
Length: 10,
Description: "Field",
Enc: encoding.EBCDIC1047,
Pref: prefix.EBCDIC1047.Fixed,
Pad: padding.Left(' '),
}
str := NewString(spec)

hullo := []byte{0x88, 0xDC, 0x93, 0x93, 0x96}
olluh := []byte{0x96, 0x93, 0x93, 0xDC, 0x88}

// SetBytes takes UTF-8 encoded bytes
str.SetBytes([]byte("hüllo"))
require.Equal(t, "hüllo", str.Value())

packed, err := str.Pack()
require.NoError(t, err)
require.Equal(t, append([]byte{0x40, 0x40, 0x40, 0x40, 0x40}, hullo...), packed)

length, err := str.Unpack(append([]byte{0x40, 0x40, 0x40, 0x40, 0x40}, olluh...))
require.NoError(t, err)
require.Equal(t, 10, length)

// Bytes returns the UTF-8 encoding of the value
b, err := str.Bytes()
require.NoError(t, err)
require.Equal(t, []byte("ollüh"), b)

require.Equal(t, "ollüh", str.Value())

str = NewString(spec)
str.Marshal(NewStringValue("hüllo"))
packed, err = str.Pack()
require.NoError(t, err)
require.Equal(t, append([]byte{0x40, 0x40, 0x40, 0x40, 0x40}, hullo...), packed)

str = NewString(spec)
length, err = str.Unpack(append([]byte{0x40, 0x40, 0x40, 0x40, 0x40}, olluh...))
require.NoError(t, err)
require.Equal(t, 10, length)
require.Equal(t, "ollüh", str.Value())

str = NewString(spec)
err = str.SetBytes([]byte("hüllo"))
require.NoError(t, err)
require.Equal(t, "hüllo", str.Value())

str = NewString(spec)
str.SetValue("hüllo")
require.Equal(t, "hüllo", str.Value())
}

func TestStringNil(t *testing.T) {
var str *String = nil

Expand Down
Loading