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 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
|
// Package sevenzip provides read access to 7-zip archives.
package sevenzip
import (
"bufio"
"bytes"
"encoding/binary"
"errors"
"fmt"
"hash/crc32"
"io"
iofs "io/fs"
"path"
"path/filepath"
"sort"
"strings"
"sync"
"time"
"github.com/bodgit/plumbing"
"github.com/bodgit/sevenzip/internal/pool"
"github.com/bodgit/sevenzip/internal/util"
"github.com/spf13/afero"
"go4.org/readerutil"
)
var (
errFormat = errors.New("sevenzip: not a valid 7-zip file")
errChecksum = errors.New("sevenzip: checksum error")
errTooMuch = errors.New("sevenzip: too much data")
errNegativeSize = errors.New("sevenzip: size cannot be negative")
errOneHeaderStream = errors.New("sevenzip: expected only one folder in header stream")
)
// ReadError is used to wrap read I/O errors.
type ReadError struct {
// Encrypted is a hint that there is encryption involved.
Encrypted bool
Err error
}
func (e ReadError) Error() string {
return fmt.Sprintf("sevenzip: read error: %v", e.Err)
}
func (e ReadError) Unwrap() error {
return e.Err
}
// A Reader serves content from a 7-Zip archive.
type Reader struct {
r io.ReaderAt
start int64
end int64
si *streamsInfo
p string
File []*File
pool []pool.Pooler
fileListOnce sync.Once
fileList []fileListEntry
}
// A ReadCloser is a [Reader] that must be closed when no longer needed.
type ReadCloser struct {
f []afero.File
Reader
}
// A File is a single file in a 7-Zip archive. The file information is in the
// embedded [FileHeader]. The file content can be accessed by calling
// [File.Open].
type File struct {
FileHeader
zip *Reader
folder int
offset int64
}
type fileReader struct {
rc util.SizeReadSeekCloser
f *File
n int64
}
func (fr *fileReader) Stat() (iofs.FileInfo, error) {
return headerFileInfo{&fr.f.FileHeader}, nil
}
func (fr *fileReader) Read(p []byte) (int, error) {
if len(p) == 0 {
return 0, nil
}
if fr.n <= 0 {
return 0, io.EOF
}
if int64(len(p)) > fr.n {
p = p[0:fr.n]
}
n, err := fr.rc.Read(p)
fr.n -= int64(n)
if err != nil && !errors.Is(err, io.EOF) {
e := &ReadError{
Err: err,
}
if frc, ok := fr.rc.(*folderReadCloser); ok {
e.Encrypted = frc.hasEncryption
}
return n, e
}
return n, err //nolint:wrapcheck
}
func (fr *fileReader) Close() error {
if fr.rc == nil {
return nil
}
offset, err := fr.rc.Seek(0, io.SeekCurrent)
if err != nil {
return fmt.Errorf("sevenzip: error seeking current position: %w", err)
}
if offset == fr.rc.Size() { // EOF reached
if err := fr.rc.Close(); err != nil {
return fmt.Errorf("sevenzip: error closing: %w", err)
}
} else {
f := fr.f
if _, err := f.zip.pool[f.folder].Put(offset, fr.rc); err != nil {
return fmt.Errorf("sevenzip: error adding to pool: %w", err)
}
}
fr.rc = nil
return nil
}
// Open returns an [io.ReadCloser] that provides access to the [File]'s
// contents. Multiple files may be read concurrently.
func (f *File) Open() (io.ReadCloser, error) {
if f.FileHeader.isEmptyStream || f.FileHeader.isEmptyFile {
// Return empty reader for directory or empty file
return io.NopCloser(bytes.NewReader(nil)), nil
}
rc, _ := f.zip.pool[f.folder].Get(f.offset)
if rc == nil {
var (
encrypted bool
err error
)
rc, _, encrypted, err = f.zip.folderReader(f.zip.si, f.folder)
if err != nil {
return nil, &ReadError{
Encrypted: encrypted,
Err: err,
}
}
}
if _, err := rc.Seek(f.offset, io.SeekStart); err != nil {
e := &ReadError{
Err: err,
}
if fr, ok := rc.(*folderReadCloser); ok {
e.Encrypted = fr.hasEncryption
}
return nil, e
}
return &fileReader{
rc: rc,
f: f,
n: int64(f.UncompressedSize), //nolint:gosec
}, nil
}
func openReader(fs afero.Fs, name string) (io.ReaderAt, int64, []afero.File, error) {
f, err := fs.Open(filepath.Clean(name))
if err != nil {
return nil, 0, nil, fmt.Errorf("sevenzip: error opening: %w", err)
}
info, err := f.Stat()
if err != nil {
err = errors.Join(err, f.Close())
return nil, 0, nil, fmt.Errorf("sevenzip: error retrieving file info: %w", err)
}
var reader io.ReaderAt = f
size := info.Size()
files := []afero.File{f}
if ext := filepath.Ext(name); ext == ".001" {
sr := []readerutil.SizeReaderAt{io.NewSectionReader(f, 0, size)}
for i := 2; true; i++ {
f, err := fs.Open(fmt.Sprintf("%s.%03d", strings.TrimSuffix(name, ext), i))
if err != nil {
if errors.Is(err, iofs.ErrNotExist) {
break
}
errs := make([]error, 0, len(files)+1)
errs = append(errs, err)
for _, file := range files {
errs = append(errs, file.Close())
}
return nil, 0, nil, fmt.Errorf("sevenzip: error opening: %w", errors.Join(errs...))
}
files = append(files, f)
info, err = f.Stat()
if err != nil {
errs := make([]error, 0, len(files)+1)
errs = append(errs, err)
for _, file := range files {
errs = append(errs, file.Close())
}
return nil, 0, nil, fmt.Errorf("sevenzip: error retrieving file info: %w", errors.Join(errs...))
}
sr = append(sr, io.NewSectionReader(f, 0, info.Size()))
}
mr := readerutil.NewMultiReaderAt(sr...)
reader, size = mr, mr.Size()
}
return reader, size, files, nil
}
// OpenReaderWithPassword will open the 7-zip file specified by name using
// password as the basis of the decryption key and return a [*ReadCloser]. If
// name has a ".001" suffix it is assumed there are multiple volumes and each
// sequential volume will be opened.
func OpenReaderWithPassword(name, password string) (*ReadCloser, error) {
reader, size, files, err := openReader(afero.NewOsFs(), name)
if err != nil {
return nil, err
}
r := new(ReadCloser)
r.p = password
if err := r.init(reader, size); err != nil {
errs := make([]error, 0, len(files)+1)
errs = append(errs, err)
for _, file := range files {
errs = append(errs, file.Close())
}
return nil, fmt.Errorf("sevenzip: error initialising: %w", errors.Join(errs...))
}
r.f = files
return r, nil
}
// OpenReader will open the 7-zip file specified by name and return a
// [*ReadCloser]. If name has a ".001" suffix it is assumed there are multiple
// volumes and each sequential volume will be opened.
func OpenReader(name string) (*ReadCloser, error) {
return OpenReaderWithPassword(name, "")
}
// NewReaderWithPassword returns a new [*Reader] reading from r using password
// as the basis of the decryption key, which is assumed to have the given size
// in bytes.
func NewReaderWithPassword(r io.ReaderAt, size int64, password string) (*Reader, error) {
if size < 0 {
return nil, errNegativeSize
}
zr := new(Reader)
zr.p = password
if err := zr.init(r, size); err != nil {
return nil, err
}
return zr, nil
}
// NewReader returns a new [*Reader] reading from r, which is assumed to have
// the given size in bytes.
func NewReader(r io.ReaderAt, size int64) (*Reader, error) {
return NewReaderWithPassword(r, size, "")
}
func (z *Reader) folderReader(si *streamsInfo, f int) (*folderReadCloser, uint32, bool, error) {
// Create a SectionReader covering all of the streams data
return si.FolderReader(io.NewSectionReader(z.r, z.start, z.end-z.start), f, z.p)
}
const (
chunkSize = 4096
searchLimit = 1 << 20 // 1 MiB
)
func findSignature(r io.ReaderAt, search []byte) ([]int64, error) {
chunk := make([]byte, chunkSize+len(search))
offsets := make([]int64, 0, 2)
for offset := int64(0); offset < searchLimit; offset += chunkSize {
n, err := r.ReadAt(chunk, offset)
for i := 0; ; {
idx := bytes.Index(chunk[i:n], search)
if idx == -1 {
break
}
offsets = append(offsets, offset+int64(i+idx))
if offsets[0] == 0 {
// If signature is at the beginning, return immediately, it's a regular archive
return offsets, nil
}
i += idx + 1
}
if err != nil {
if errors.Is(err, io.EOF) {
break
}
return nil, fmt.Errorf("sevenzip: error reading chunk: %w", err)
}
}
return offsets, nil
}
//nolint:cyclop,funlen,gocognit,gocyclo,maintidx
func (z *Reader) init(r io.ReaderAt, size int64) (err error) {
h := crc32.NewIEEE()
tra := plumbing.TeeReaderAt(r, h)
var (
signature = []byte{'7', 'z', 0xbc, 0xaf, 0x27, 0x1c}
offsets []int64
)
offsets, err = findSignature(r, signature)
if err != nil {
return err
}
if len(offsets) == 0 {
return errFormat
}
var (
sr *io.SectionReader
off int64
start startHeader
)
for _, off = range offsets {
sr = io.NewSectionReader(tra, off, size-off) // Will only read first 32 bytes
var sh signatureHeader
if err = binary.Read(sr, binary.LittleEndian, &sh); err != nil {
return fmt.Errorf("sevenzip: error reading signature header: %w", err)
}
z.r = r
h.Reset()
if err = binary.Read(sr, binary.LittleEndian, &start); err != nil {
return fmt.Errorf("sevenzip: error reading start header: %w", err)
}
// CRC of the start header should match
if util.CRC32Equal(h.Sum(nil), sh.CRC) {
break
}
err = errChecksum
}
if err != nil {
return err
}
// Work out where we are in the file (32, avoiding magic numbers)
if z.start, err = sr.Seek(0, io.SeekCurrent); err != nil {
return fmt.Errorf("sevenzip: error seeking current position: %w", err)
}
// Seek over the streams
if z.end, err = sr.Seek(int64(start.Offset), io.SeekCurrent); err != nil { //nolint:gosec
return fmt.Errorf("sevenzip: error seeking over streams: %w", err)
}
z.start += off
z.end += off
h.Reset()
// Bound bufio.Reader otherwise it can read trailing garbage which screws up the CRC check
br := bufio.NewReader(io.NewSectionReader(tra, z.end, int64(start.Size))) //nolint:gosec
var (
id byte
header *header
streamsInfo *streamsInfo
)
if id, err = br.ReadByte(); err != nil {
return fmt.Errorf("sevenzip: error reading header id: %w", err)
}
switch id {
case idHeader:
if header, err = readHeader(br); err != nil {
return err
}
case idEncodedHeader:
if streamsInfo, err = readStreamsInfo(br); err != nil {
return err
}
default:
return errUnexpectedID
}
// If there's more data to read, we've not parsed this correctly. This
// won't break with trailing data as the bufio.Reader was bounded
if n, _ := io.CopyN(io.Discard, br, 1); n != 0 {
return errTooMuch
}
// CRC should match the one from the start header
if !util.CRC32Equal(h.Sum(nil), start.CRC) {
return errChecksum
}
// If the header was encoded we should have sufficient information now
// to decode it
if streamsInfo != nil {
if streamsInfo.Folders() != 1 {
return errOneHeaderStream
}
var (
fr *folderReadCloser
crc uint32
encrypted bool
)
fr, crc, encrypted, err = z.folderReader(streamsInfo, 0)
if err != nil {
return &ReadError{
Encrypted: encrypted,
Err: err,
}
}
defer func() {
err = errors.Join(err, fr.Close())
}()
if header, err = readEncodedHeader(util.ByteReadCloser(fr)); err != nil {
return &ReadError{
Encrypted: fr.hasEncryption,
Err: err,
}
}
if crc != 0 && !util.CRC32Equal(fr.Checksum(), crc) {
return errChecksum
}
}
z.si = header.streamsInfo
// spew.Dump(header)
filesPerStream := make(map[int]int, z.si.Folders())
if header.filesInfo != nil {
folder, offset := 0, int64(0)
z.File = make([]*File, 0, len(header.filesInfo.file))
j := 0
for _, fh := range header.filesInfo.file {
f := new(File)
f.zip = z
f.FileHeader = fh
if f.FileHeader.FileInfo().IsDir() && !strings.HasSuffix(f.FileHeader.Name, "/") {
f.FileHeader.Name += "/"
}
if !fh.isEmptyStream && !fh.isEmptyFile {
f.folder, _, _ = header.streamsInfo.FileFolderAndSize(j)
// Make an exported copy of the folder index
f.Stream = f.folder
filesPerStream[f.folder]++
if f.folder != folder {
offset = 0
}
f.offset = offset
offset += int64(f.UncompressedSize) //nolint:gosec
folder = f.folder
j++
}
z.File = append(z.File, f)
}
}
// spew.Dump(filesPerStream)
z.pool = make([]pool.Pooler, z.si.Folders())
for i := range z.pool {
var newPool pool.Constructor = pool.NewNoopPool
if filesPerStream[i] > 1 {
newPool = pool.NewPool
}
if z.pool[i], err = newPool(); err != nil {
return err
}
}
return nil
}
// Volumes returns the list of volumes that have been opened as part of the
// current archive.
func (rc *ReadCloser) Volumes() []string {
volumes := make([]string, len(rc.f))
for idx, f := range rc.f {
volumes[idx] = f.Name()
}
return volumes
}
// Close closes the 7-zip file or volumes, rendering them unusable for I/O.
func (rc *ReadCloser) Close() error {
errs := make([]error, 0, len(rc.f))
for _, f := range rc.f {
errs = append(errs, f.Close())
}
err := errors.Join(errs...)
if err != nil {
err = fmt.Errorf("sevenzip: error closing: %w", err)
}
return err
}
type fileListEntry struct {
name string
file *File
isDir bool
isDup bool
}
type fileInfoDirEntry interface {
iofs.FileInfo
iofs.DirEntry
}
func (e *fileListEntry) stat() (fileInfoDirEntry, error) {
if e.isDup {
return nil, errors.New(e.name + ": duplicate entries in 7-zip file") //nolint:err113
}
if !e.isDir {
return headerFileInfo{&e.file.FileHeader}, nil
}
return e, nil
}
func (e *fileListEntry) Name() string {
_, elem := split(e.name)
return elem
}
func (e *fileListEntry) Size() int64 { return 0 }
func (e *fileListEntry) Mode() iofs.FileMode { return iofs.ModeDir | 0o555 }
func (e *fileListEntry) Type() iofs.FileMode { return iofs.ModeDir }
func (e *fileListEntry) IsDir() bool { return true }
func (e *fileListEntry) Sys() interface{} { return nil }
func (e *fileListEntry) ModTime() time.Time {
if e.file == nil {
return time.Time{}
}
return e.file.FileHeader.Modified.UTC()
}
func (e *fileListEntry) Info() (iofs.FileInfo, error) { return e, nil }
func toValidName(name string) string {
name = strings.ReplaceAll(name, `\`, `/`)
p := strings.TrimPrefix(path.Clean(name), "/")
for strings.HasPrefix(p, "../") {
p = p[len("../"):]
}
return p
}
//nolint:cyclop,funlen
func (z *Reader) initFileList() {
z.fileListOnce.Do(func() {
files := make(map[string]int)
knownDirs := make(map[string]int)
dirs := make(map[string]struct{})
for _, file := range z.File {
isDir := len(file.Name) > 0 && file.Name[len(file.Name)-1] == '/'
name := toValidName(file.Name)
if name == "" {
continue
}
if idx, ok := files[name]; ok {
z.fileList[idx].isDup = true
continue
}
if idx, ok := knownDirs[name]; ok {
z.fileList[idx].isDup = true
continue
}
for dir := path.Dir(name); dir != "."; dir = path.Dir(dir) {
dirs[dir] = struct{}{}
}
idx := len(z.fileList)
entry := fileListEntry{
name: name,
file: file,
isDir: isDir,
}
z.fileList = append(z.fileList, entry)
if isDir {
knownDirs[name] = idx
} else {
files[name] = idx
}
}
for dir := range dirs {
if _, ok := knownDirs[dir]; !ok {
if idx, ok := files[dir]; ok {
z.fileList[idx].isDup = true
} else {
entry := fileListEntry{
name: dir,
file: nil,
isDir: true,
}
z.fileList = append(z.fileList, entry)
}
}
}
sort.Slice(z.fileList, func(i, j int) bool { return fileEntryLess(z.fileList[i].name, z.fileList[j].name) })
})
}
func fileEntryLess(x, y string) bool {
xdir, xelem := split(x)
ydir, yelem := split(y)
return xdir < ydir || xdir == ydir && xelem < yelem
}
// Open opens the named file in the 7-zip archive, using the semantics of
// [fs.FS.Open]: paths are always slash separated, with no leading / or ../
// elements.
func (z *Reader) Open(name string) (iofs.File, error) {
z.initFileList()
if !iofs.ValidPath(name) {
return nil, &iofs.PathError{Op: "open", Path: name, Err: iofs.ErrInvalid}
}
e := z.openLookup(name)
if e == nil {
return nil, &iofs.PathError{Op: "open", Path: name, Err: iofs.ErrNotExist}
}
if e.isDir {
return &openDir{e, z.openReadDir(name), 0}, nil
}
rc, err := e.file.Open()
if err != nil {
return nil, err
}
return rc.(iofs.File), nil //nolint:forcetypeassert
}
func split(name string) (dir, elem string) {
if len(name) > 0 && name[len(name)-1] == '/' {
name = name[:len(name)-1]
}
i := len(name) - 1
for i >= 0 && name[i] != '/' {
i--
}
if i < 0 {
return ".", name
}
return name[:i], name[i+1:]
}
//nolint:gochecknoglobals
var dotFile = &fileListEntry{name: "./", isDir: true}
func (z *Reader) openLookup(name string) *fileListEntry {
if name == "." {
return dotFile
}
dir, elem := split(name)
files := z.fileList
i := sort.Search(len(files), func(i int) bool {
idir, ielem := split(files[i].name)
return idir > dir || idir == dir && ielem >= elem
})
if i < len(files) {
fname := files[i].name
if fname == name || len(fname) == len(name)+1 && fname[len(name)] == '/' && fname[:len(name)] == name {
return &files[i]
}
}
return nil
}
func (z *Reader) openReadDir(dir string) []fileListEntry {
files := z.fileList
i := sort.Search(len(files), func(i int) bool {
idir, _ := split(files[i].name)
return idir >= dir
})
j := sort.Search(len(files), func(j int) bool {
jdir, _ := split(files[j].name)
return jdir > dir
})
return files[i:j]
}
type openDir struct {
e *fileListEntry
files []fileListEntry
offset int
}
func (d *openDir) Close() error { return nil }
func (d *openDir) Stat() (iofs.FileInfo, error) { return d.e.stat() }
var errIsDirectory = errors.New("is a directory")
func (d *openDir) Read([]byte) (int, error) {
return 0, &iofs.PathError{Op: "read", Path: d.e.name, Err: errIsDirectory}
}
func (d *openDir) ReadDir(count int) ([]iofs.DirEntry, error) {
n := len(d.files) - d.offset
if count > 0 && n > count {
n = count
}
if n == 0 {
if count <= 0 {
return nil, nil
}
return nil, io.EOF
}
list := make([]iofs.DirEntry, n)
for i := range list {
s, err := d.files[d.offset+i].stat()
if err != nil {
return nil, err
}
list[i] = s
}
d.offset += n
return list, nil
}
|