zip.go 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. // Copyright 2019+ Klaus Post. All rights reserved.
  2. // License information can be found in the LICENSE file.
  3. package zstd
  4. import (
  5. "errors"
  6. "io"
  7. "sync"
  8. )
  9. // ZipMethodWinZip is the method for Zstandard compressed data inside Zip files for WinZip.
  10. // See https://www.winzip.com/win/en/comp_info.html
  11. const ZipMethodWinZip = 93
  12. // ZipMethodPKWare is the original method number used by PKWARE to indicate Zstandard compression.
  13. // Deprecated: This has been deprecated by PKWARE, use ZipMethodWinZip instead for compression.
  14. // See https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT
  15. const ZipMethodPKWare = 20
  16. var zipReaderPool sync.Pool
  17. // newZipReader cannot be used since we would leak goroutines...
  18. func newZipReader(r io.Reader) io.ReadCloser {
  19. dec, ok := zipReaderPool.Get().(*Decoder)
  20. if ok {
  21. dec.Reset(r)
  22. } else {
  23. d, err := NewReader(r, WithDecoderConcurrency(1), WithDecoderLowmem(true))
  24. if err != nil {
  25. panic(err)
  26. }
  27. dec = d
  28. }
  29. return &pooledZipReader{dec: dec}
  30. }
  31. type pooledZipReader struct {
  32. mu sync.Mutex // guards Close and Read
  33. dec *Decoder
  34. }
  35. func (r *pooledZipReader) Read(p []byte) (n int, err error) {
  36. r.mu.Lock()
  37. defer r.mu.Unlock()
  38. if r.dec == nil {
  39. return 0, errors.New("Read after Close")
  40. }
  41. dec, err := r.dec.Read(p)
  42. return dec, err
  43. }
  44. func (r *pooledZipReader) Close() error {
  45. r.mu.Lock()
  46. defer r.mu.Unlock()
  47. var err error
  48. if r.dec != nil {
  49. err = r.dec.Reset(nil)
  50. zipReaderPool.Put(r.dec)
  51. r.dec = nil
  52. }
  53. return err
  54. }
  55. type pooledZipWriter struct {
  56. mu sync.Mutex // guards Close and Read
  57. enc *Encoder
  58. pool *sync.Pool
  59. }
  60. func (w *pooledZipWriter) Write(p []byte) (n int, err error) {
  61. w.mu.Lock()
  62. defer w.mu.Unlock()
  63. if w.enc == nil {
  64. return 0, errors.New("Write after Close")
  65. }
  66. return w.enc.Write(p)
  67. }
  68. func (w *pooledZipWriter) Close() error {
  69. w.mu.Lock()
  70. defer w.mu.Unlock()
  71. var err error
  72. if w.enc != nil {
  73. err = w.enc.Close()
  74. w.pool.Put(w.enc)
  75. w.enc = nil
  76. }
  77. return err
  78. }
  79. // ZipCompressor returns a compressor that can be registered with zip libraries.
  80. // The provided encoder options will be used on all encodes.
  81. func ZipCompressor(opts ...EOption) func(w io.Writer) (io.WriteCloser, error) {
  82. var pool sync.Pool
  83. return func(w io.Writer) (io.WriteCloser, error) {
  84. enc, ok := pool.Get().(*Encoder)
  85. if ok {
  86. enc.Reset(w)
  87. } else {
  88. var err error
  89. enc, err = NewWriter(w, opts...)
  90. if err != nil {
  91. return nil, err
  92. }
  93. }
  94. return &pooledZipWriter{enc: enc, pool: &pool}, nil
  95. }
  96. }
  97. // ZipDecompressor returns a decompressor that can be registered with zip libraries.
  98. // See ZipCompressor for example.
  99. func ZipDecompressor() func(r io.Reader) io.ReadCloser {
  100. return func(r io.Reader) io.ReadCloser {
  101. d, err := NewReader(r, WithDecoderConcurrency(1), WithDecoderLowmem(true))
  102. if err != nil {
  103. panic(err)
  104. }
  105. return d.IOReadCloser()
  106. }
  107. }