1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
|
// Copyright ©2012 The bíogo Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package sam
import (
"bytes"
"encoding/binary"
"encoding/hex"
"errors"
"fmt"
"io"
"net/url"
"strconv"
"strings"
"time"
)
var (
errBadHeader = errors.New("sam: malformed header line")
errDupTag = errors.New("sam: duplicate field")
)
var bamMagic = [4]byte{'B', 'A', 'M', 0x1}
// UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
func (bh *Header) UnmarshalBinary(b []byte) error {
return bh.DecodeBinary(bytes.NewReader(b))
}
// DecodeBinary unmarshals a Header from the given io.Reader. The byte
// stream must be in the format described in the SAM specification,
// section 4.2.
func (bh *Header) DecodeBinary(r io.Reader) error {
var (
lText, nRef int32
err error
)
var magic [4]byte
err = binary.Read(r, binary.LittleEndian, &magic)
if err != nil {
return err
}
if magic != bamMagic {
return errors.New("sam: magic number mismatch")
}
err = binary.Read(r, binary.LittleEndian, &lText)
if err != nil {
return err
}
if lText < 0 {
return errors.New("sam: invalid text length")
}
text := make([]byte, lText)
n, err := r.Read(text)
if err != nil {
return err
}
if n != int(lText) {
return errors.New("sam: truncated header")
}
err = bh.UnmarshalText(text)
if err != nil {
return err
}
err = binary.Read(r, binary.LittleEndian, &nRef)
if err != nil {
return err
}
if nRef < 0 {
return errors.New("sam: invalid reference count field")
}
refs, err := readRefRecords(r, nRef)
if err != nil {
return err
}
for _, r := range refs {
err = bh.AddReference(r)
if err != nil {
return err
}
}
return nil
}
func readRefRecords(r io.Reader, n int32) ([]*Reference, error) {
// bootstrapSize is the maximum number of
// reference records to pre-allocate.
const bootstrapSize = 1000
rr := make([]*Reference, 0, min(n, bootstrapSize))
var (
lName int32
err error
)
for i := 0; i < int(n); i++ {
rr = append(rr, &Reference{id: int32(i)})
err = binary.Read(r, binary.LittleEndian, &lName)
if err != nil {
return nil, err
}
if lName < 1 {
return nil, errors.New("sam: invalid name length")
}
name := make([]byte, lName)
n, err := r.Read(name)
if err != nil {
return nil, err
}
if n != int(lName) || name[n-1] != 0 {
return nil, errors.New("sam: truncated reference name")
}
rr[i].name = string(name[:n-1])
err = binary.Read(r, binary.LittleEndian, &rr[i].lRef)
if err != nil {
return nil, err
}
}
return rr, nil
}
func min(a, b int32) int32 {
if a < b {
return a
}
return b
}
// UnmarshalText implements the encoding.TextUnmarshaler interface.
func (bh *Header) UnmarshalText(text []byte) error {
if bh.seenRefs == nil {
bh.seenRefs = set{}
}
if bh.seenGroups == nil {
bh.seenGroups = set{}
}
if bh.seenProgs == nil {
bh.seenProgs = set{}
}
var t Tag
for i, l := range bytes.Split(text, []byte{'\n'}) {
if len(l) > 0 && l[len(l)-1] == '\r' {
l = l[:len(l)-1]
}
if len(l) == 0 {
continue
}
if l[0] != '@' || len(l) < 3 {
return errBadHeader
}
copy(t[:], l[1:3])
var err error
switch t {
case headerTag:
err = headerLine(l, bh)
case refDictTag:
err = referenceLine(l, bh)
case readGroupTag:
err = readGroupLine(l, bh)
case programTag:
err = programLine(l, bh)
case commentTag:
err = commentLine(l, bh)
default:
return errBadHeader
}
if err != nil {
return fmt.Errorf("%v: line %d: %q", err, i+1, l)
}
}
return nil
}
func headerLine(l []byte, bh *Header) error {
fields := bytes.Split(l, []byte{'\t'})
if len(fields) < 2 {
return errBadHeader
}
var t Tag
for _, f := range fields[1:] {
if f[2] != ':' {
return errBadHeader
}
copy(t[:], f[:2])
fs := string(f[3:])
switch t {
case versionTag:
if bh.Version != "" {
return errBadHeader
}
bh.Version = fs
case sortOrderTag:
if bh.SortOrder != UnknownOrder {
return errBadHeader
}
bh.SortOrder = sortOrderMap[fs]
case groupOrderTag:
if bh.GroupOrder != GroupUnspecified {
return errBadHeader
}
bh.GroupOrder = groupOrderMap[fs]
default:
bh.otherTags = append(bh.otherTags, tagPair{tag: t, value: fs})
}
}
if bh.Version == "" {
return errBadHeader
}
return nil
}
func referenceLine(l []byte, bh *Header) error {
fields := bytes.Split(l, []byte{'\t'})
if len(fields) < 3 {
return errBadHeader
}
var (
t Tag
rf = &Reference{}
seen = map[Tag]struct{}{}
nok, lok bool
dupID int32
dup bool
)
for _, f := range fields[1:] {
if f[2] != ':' {
return errBadHeader
}
copy(t[:], f[:2])
if _, ok := seen[t]; ok {
return errDupTag
}
seen[t] = struct{}{}
fs := string(f[3:])
switch t {
case refNameTag:
dupID, dup = bh.seenRefs[fs]
rf.name = fs
nok = true
case refLengthTag:
l, err := strconv.Atoi(fs)
if err != nil {
return errBadHeader
}
if !validLen(l) {
return errBadLen
}
rf.lRef = int32(l)
lok = true
case assemblyIDTag:
rf.assemID = fs
case md5Tag:
hb := [16]byte{}
n, err := hex.Decode(hb[:], f[3:])
if err != nil {
return err
}
if n != 16 {
return errBadHeader
}
rf.md5 = string(hb[:])
case speciesTag:
rf.species = fs
case uriTag:
var err error
rf.uri, err = url.Parse(fs)
if err != nil {
return err
}
if rf.uri.Scheme != "http" && rf.uri.Scheme != "ftp" {
rf.uri.Scheme = "file"
}
default:
rf.otherTags = append(rf.otherTags, tagPair{tag: t, value: fs})
}
}
if dup {
if er := bh.refs[dupID]; equalRefs(er, rf) {
return nil
} else if !equalRefs(er, &Reference{id: er.id, name: er.name, lRef: er.lRef}) {
return errDupReference
}
old := bh.refs[dupID]
old.owner = nil
old.id = -1
bh.refs[dupID] = rf
rf.owner = bh
return nil
}
if !nok || !lok {
return errBadHeader
}
id := int32(len(bh.refs))
rf.owner = bh
rf.id = id
bh.seenRefs[rf.name] = id
bh.refs = append(bh.refs, rf)
return nil
}
// http://en.wikipedia.org/wiki/ISO_8601
//
// Date: 2014-08-13
// Time: 2014-08-13T16:02:01Z
// : 2014-08-13T16:02:01
// : 2014-08-13T16:02:01+00:00
// : 2014-08-13T16:02:01.000+00:00
//
const (
// This is the ISO8601 format used for output.
iso8601TimeDateN = "2006-01-02T15:04:05-0700"
// This is the set of ISO8601 formats we accept.
// The input values are first converted to a
// basic ISO8601 form by removing all ':'
// characters. We cannot do the same thing with
// '-' since this has two meanings in ISO8601,
// a separator and a negative time zone offset.
iso8601DateB = "20060102"
iso8601DateE = "2006-01-02"
iso8601TimeDateB = "20060102T150405"
iso8601TimeDateE = "2006-01-02T150405"
iso8601TimeDateZB = "20060102T150405Z"
iso8601TimeDateZE = "2006-01-02T150405Z"
iso8601TimeDateNB = "20060102T150405-0700"
iso8601TimeDateNE = "2006-01-02T150405-0700"
iso8601TimeThouDateZB = "20060102T150405.999Z"
iso8601TimeThouDateZE = "2006-01-02T150405.999Z"
iso8601TimeThouDateNB = "20060102T150405.999-0700"
iso8601TimeThouDateNE = "2006-01-02T150405.999-0700"
)
var iso8601 = []struct {
isLocal bool
format string
}{
{isLocal: true, format: iso8601DateB},
{isLocal: true, format: iso8601DateE},
{isLocal: false, format: iso8601TimeDateZB},
{isLocal: false, format: iso8601TimeDateZE},
{isLocal: false, format: iso8601TimeDateNB},
{isLocal: false, format: iso8601TimeDateNE},
{isLocal: false, format: iso8601TimeThouDateZB},
{isLocal: false, format: iso8601TimeThouDateZE},
{isLocal: false, format: iso8601TimeThouDateNB},
{isLocal: false, format: iso8601TimeThouDateNE},
{isLocal: true, format: iso8601TimeDateB},
{isLocal: true, format: iso8601TimeDateE},
}
func parseISO8601(value string) (time.Time, error) {
value = strings.Replace(value, ":", "", -1)
var err error
for _, format := range iso8601 {
loc := time.UTC
if format.isLocal {
loc = time.Local
}
var t time.Time
t, err = time.ParseInLocation(format.format, value, loc)
if err == nil {
return t, nil
}
}
return time.Time{}, err
}
func readGroupLine(l []byte, bh *Header) error {
fields := bytes.Split(l, []byte{'\t'})
if len(fields) < 2 {
return errBadHeader
}
var (
t Tag
rg = &ReadGroup{}
seen = map[Tag]struct{}{}
idok bool
)
for _, f := range fields[1:] {
if f[2] != ':' {
return errBadHeader
}
copy(t[:], f[:2])
if _, ok := seen[t]; ok {
return errDupTag
}
seen[t] = struct{}{}
fs := string(f[3:])
switch t {
case idTag:
if _, ok := bh.seenGroups[fs]; ok {
return errDupReadGroup
}
rg.name = fs
idok = true
case centerTag:
rg.center = fs
case descriptionTag:
rg.description = fs
case dateTag:
var err error
rg.date, err = parseISO8601(fs)
if err != nil {
return err
}
case flowOrderTag:
rg.flowOrder = fs
case keySequenceTag:
rg.keySeq = fs
case libraryTag:
rg.library = fs
case programTag:
rg.program = fs
case insertSizeTag:
i, err := strconv.Atoi(fs)
if err != nil {
return err
}
if !validInt32(i) {
return errBadLen
}
rg.insertSize = i
case platformTag:
rg.platform = fs
case platformUnitTag:
rg.platformUnit = fs
case sampleTag:
rg.sample = fs
default:
rg.otherTags = append(rg.otherTags, tagPair{tag: t, value: fs})
}
}
if !idok {
return errBadHeader
}
id := int32(len(bh.rgs))
rg.owner = bh
rg.id = id
bh.seenGroups[rg.name] = id
bh.rgs = append(bh.rgs, rg)
return nil
}
func programLine(l []byte, bh *Header) error {
fields := bytes.Split(l, []byte{'\t'})
if len(fields) < 2 {
return errBadHeader
}
var (
t Tag
p = &Program{}
seen = map[Tag]struct{}{}
idok bool
)
for _, f := range fields[1:] {
if f[2] != ':' {
return errBadHeader
}
copy(t[:], f[:2])
if _, ok := seen[t]; ok {
return errDupTag
}
seen[t] = struct{}{}
fs := string(f[3:])
switch t {
case idTag:
if _, ok := bh.seenProgs[fs]; ok {
return errDupProgram
}
p.uid = fs
idok = true
case programNameTag:
p.name = fs
case commandLineTag:
p.command = fs
case previousProgTag:
p.previous = fs
case versionTag:
p.version = fs
default:
p.otherTags = append(p.otherTags, tagPair{tag: t, value: fs})
}
}
if !idok {
return errBadHeader
}
id := int32(len(bh.progs))
p.owner = bh
p.id = id
bh.seenProgs[p.uid] = id
bh.progs = append(bh.progs, p)
return nil
}
func commentLine(l []byte, bh *Header) error {
fields := bytes.Split(l, []byte{'\t'})
if len(fields) < 2 {
return errBadHeader
}
bh.Comments = append(bh.Comments, string(fields[1]))
return nil
}
|