Skip to content

Strip all leading BOMs, not just the first (#390) #391

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

Open
youdie006 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Strip all leading BOMs, not just the first (#390) #391

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
50 changes: 28 additions & 22 deletions parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,36 +73,42 @@ func newParser(r io.Reader, opts parserOptions) *parser {
// BOM handles header of UTF-8, UTF-16 LE and UTF-16 BE's BOM format.
// http://en.wikipedia.org/wiki/Byte_order_mark#Representations_of_byte_order_marks_by_encoding
func (p *parser) BOM() error {
mask, err := p.buf.Peek(2)
if err != nil && err != io.EOF {
return err
} else if len(mask) < 2 {
return nil
}

switch {
case mask[0] == 254 && mask[1] == 255:
fallthrough
case mask[0] == 255 && mask[1] == 254:
_, err = p.buf.Read(mask)
if err != nil {
return err
}
case mask[0] == 239 && mask[1] == 187:
mask, err := p.buf.Peek(3)
// Strip every leading BOM: a file may accidentally carry more than one
// (e.g. a tool prepending a BOM to already-BOM'd content). Stopping after
// the first one leaves the remaining BOM on the next token and makes the
// parser fail with a misleading "key-value delimiter not found" (#390).
for {
mask, err := p.buf.Peek(2)
if err != nil && err != io.EOF {
return err
} else if len(mask) < 3 {
} else if len(mask) < 2 {
return nil
}
if mask[2] == 191 {
_, err = p.buf.Read(mask)
if err != nil {

switch {
case mask[0] == 254 && mask[1] == 255:
fallthrough
case mask[0] == 255 && mask[1] == 254:
if _, err = p.buf.Read(mask); err != nil {
return err
}
case mask[0] == 239 && mask[1] == 187:
mask, err := p.buf.Peek(3)
if err != nil && err != io.EOF {
return err
} else if len(mask) < 3 {
return nil
}
if mask[2] != 191 {
return nil
}
if _, err = p.buf.Read(mask); err != nil {
return err
}
default:
return nil
}
}
return nil
}

func (p *parser) readUntil(delim byte) ([]byte, error) {
Expand Down
8 changes: 8 additions & 0 deletions parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ func TestBOM(t *testing.T) {

t.Run("UTF-16-BE-BOM", func(t *testing.T) {
})

t.Run("multiple UTF-8-BOM", func(t *testing.T) {
f, err := Load([]byte("\xef\xbb\xbf\xef\xbb\xbf[author]\nE-MAIL = example@email.com"))
require.NoError(t, err)
require.NotNil(t, f)

assert.Equal(t, "example@email.com", f.Section("author").Key("E-MAIL").String())
})
})
}

Expand Down