Skip to content

fix: apply rename function to compression-only formats (fixes #31) #35

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
AruneshDwivedi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: apply rename function to compression-only formats (fixes #31) #35

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
108 changes: 64 additions & 44 deletions extractor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,26 @@ import (
// rather than directly on the filesystem
type Extractor struct {
FS interface {
// Link creates newname as a hard link to the oldname file. If there is an error, it will be of type *LinkError.
// Link creates newname as a hard link to the oldname file. If there is an error, it will be of type *LinkError.
Link(oldname, newname string) error

// MkdirAll creates the directory path and all his parents if needed.
// MkdirAll creates the directory path and all his parents if needed.
MkdirAll(path string, perm os.FileMode) error

// OpenFile opens the named file with specified flag (O_RDONLY etc.).
// OpenFile opens the named file with specified flag (O_RDONLY etc.).
OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)

// Symlink creates newname as a symbolic link to oldname.
// Symlink creates newname as a symbolic link to oldname.
Symlink(oldname, newname string) error

// Remove removes the named file or (empty) directory.
// Remove removes the named file or (empty) directory.
Remove(path string) error

// Stat returns a FileInfo describing the named file.
// Stat returns a FileInfo describing the named file.
Stat(name string) (os.FileInfo, error)

// Chmod changes the mode of the named file to mode.
// If the file is a symbolic link, it changes the mode of the link's target.
// Chmod changes the mode of the named file to mode.
// If the file is a symbolic link, it changes the mode of the link's target.
Chmod(name string, mode os.FileMode) error
}
}
Expand Down Expand Up @@ -91,6 +91,11 @@ func (e *Extractor) Zstd(ctx context.Context, body io.Reader, location string, r
return e.Tar(ctx, body, location, rename)
}

// For compression-only formats, apply rename to location before extracting
if rename != nil {
location = rename(location)
}

err = e.copy(ctx, location, 0666, body)
if err != nil {
return err
Expand All @@ -113,6 +118,11 @@ func (e *Extractor) Xz(ctx context.Context, body io.Reader, location string, ren
return e.Tar(ctx, body, location, rename)
}

// For compression-only formats, apply rename to location before extracting
if rename != nil {
location = rename(location)
}

err = e.copy(ctx, location, 0666, body)
if err != nil {
return err
Expand All @@ -134,6 +144,11 @@ func (e *Extractor) Bz2(ctx context.Context, body io.Reader, location string, re
return e.Tar(ctx, body, location, rename)
}

// For compression-only formats, apply rename to location before extracting
if rename != nil {
location = rename(location)
}

err = e.copy(ctx, location, 0666, body)
if err != nil {
return err
Expand All @@ -157,6 +172,11 @@ func (e *Extractor) Gz(ctx context.Context, body io.Reader, location string, ren
if kind.Extension == "tar" {
return e.Tar(ctx, body, location, rename)
}
// For compression-only formats, apply rename to location before extracting
if rename != nil {
location = rename(location)
}

err = e.copy(ctx, location, 0666, body)
if err != nil {
return err
Expand Down Expand Up @@ -186,46 +206,46 @@ func (e *Extractor) Tar(ctx context.Context, body io.Reader, location string, re
}

header, err := tr.Next()
if err == io.EOF {
if err == io.EOF {
break
}

if err != nil {
if err != nil {
return errors.Annotatef(err, "Read tar stream")
}

path := header.Name
if rename != nil {
if rename != nil {
path = rename(path)
}

if path == "" {
if path == "" {
continue
}

if path, err = safeJoin(location, path); err != nil {
if path, err = safeJoin(location, path); err != nil {
continue
}

info := header.FileInfo()

switch header.Typeflag {
case tar.TypeDir:
if err := e.FS.MkdirAll(path, info.Mode()); err != nil {
if err := e.FS.MkdirAll(path, info.Mode()); err != nil {
return errors.Annotatef(err, "Create directory %s", path)
}
case tar.TypeReg, tar.TypeRegA:
if err := e.copy(ctx, path, info.Mode(), tr); err != nil {
if err := e.copy(ctx, path, info.Mode(), tr); err != nil {
return errors.Annotatef(err, "Create file %s", path)
}
case tar.TypeLink:
name := header.Linkname
if rename != nil {
if rename != nil {
name = rename(name)
}

name, err = safeJoin(location, name)
if err != nil {
if err != nil {
continue
}
links = append(links, &link{Path: path, Name: name})
Expand All @@ -242,7 +262,7 @@ func (e *Extractor) Tar(ctx context.Context, body io.Reader, location string, re
default:
}
_ = e.FS.Remove(links[i].Path)
if err := e.FS.Link(links[i].Name, links[i].Path); err != nil {
if err := e.FS.Link(links[i].Name, links[i].Path); err != nil {
return errors.Annotatef(err, "Create link %s", links[i].Path)
}
}
Expand All @@ -262,13 +282,13 @@ func (e *Extractor) extractSymlinks(ctx context.Context, symlinks []*link) error
default:
}

// Make a placeholder and replace it after unpacking everything
// Make a placeholder and replace it after unpacking everything
_ = e.FS.Remove(symlink.Path)
f, err := e.FS.OpenFile(symlink.Path, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, os.FileMode(0666))
if err != nil {
if err != nil {
return fmt.Errorf("creating symlink placeholder %s: %w", symlink.Path, err)
}
if err := f.Close(); err != nil {
if err := f.Close(); err != nil {
return fmt.Errorf("creating symlink placeholder %s: %w", symlink.Path, err)
}
}
Expand All @@ -280,7 +300,7 @@ func (e *Extractor) extractSymlinks(ctx context.Context, symlinks []*link) error
default:
}
_ = e.FS.Remove(symlink.Path)
if err := e.FS.Symlink(symlink.Name, symlink.Path); err != nil {
if err := e.FS.Symlink(symlink.Name, symlink.Path); err != nil {
return errors.Annotatef(err, "Create link %s", symlink.Path)
}
}
Expand All @@ -294,18 +314,18 @@ func (e *Extractor) Zip(ctx context.Context, body io.Reader, location string, re
var bodySize int64
bodyReaderAt, isReaderAt := (body).(io.ReaderAt)
if bodySeeker, isSeeker := (body).(io.Seeker); isReaderAt && isSeeker {
// get the size by seeking to the end
// get the size by seeking to the end
endPos, err := bodySeeker.Seek(0, io.SeekEnd)
if err != nil {
if err != nil {
return fmt.Errorf("failed to seek to the end of the body: %s", err)
}
// reset the reader to the beginning
if _, err := bodySeeker.Seek(0, io.SeekStart); err != nil {
// reset the reader to the beginning
if _, err := bodySeeker.Seek(0, io.SeekStart); err != nil {
return fmt.Errorf("failed to seek to the beginning of the body: %w", err)
}
bodySize = endPos
} else {
// read the whole body into a buffer. Not sure this is the best way to do it
// read the whole body into a buffer. Not sure this is the best way to do it
buffer := bytes.NewBuffer([]byte{})
copyCancel(ctx, buffer, body)
bodyReaderAt = bytes.NewReader(buffer.Bytes())
Expand All @@ -329,23 +349,23 @@ func (e *Extractor) Zip(ctx context.Context, body io.Reader, location string, re

path := header.Name

// Replace backslash with forward slash. There are archives in the wild made with
// buggy compressors that use backslash as path separator. The ZIP format explicitly
// denies the use of "\" so we just replace it with slash "/".
// Moreover it seems that folders are stored as "files" but with a final "\" in the
// filename... oh, well...
// Replace backslash with forward slash. There are archives in the wild made with
// buggy compressors that use backslash as path separator. The ZIP format explicitly
// denies the use of "\" so we just replace it with slash "/".
// Moreover it seems that folders are stored as "files" but with a final "\" in the
// filename... oh, well...
forceDir := strings.HasSuffix(path, "\\")
path = strings.Replace(path, "\\", "/", -1)

if rename != nil {
if rename != nil {
path = rename(path)
}

if path == "" {
if path == "" {
continue
}

if path, err = safeJoin(location, path); err != nil {
if path, err = safeJoin(location, path); err != nil {
continue
}

Expand All @@ -354,17 +374,17 @@ func (e *Extractor) Zip(ctx context.Context, body io.Reader, location string, re
switch {
case info.IsDir() || forceDir:
dirMode := info.Mode() | os.ModeDir | 0100
if _, err := e.FS.Stat(path); err == nil {
// directory already created, update permissions
if err := e.FS.Chmod(path, dirMode); err != nil {
if _, err := e.FS.Stat(path); err == nil {
// directory already created, update permissions
if err := e.FS.Chmod(path, dirMode); err != nil {
return errors.Annotatef(err, "Set permissions %s", path)
}
} else if err := e.FS.MkdirAll(path, dirMode); err != nil {
return errors.Annotatef(err, "Create directory %s", path)
}
// We only check for symlinks because hard links aren't possible
// We only check for symlinks because hard links aren't possible
case info.Mode()&os.ModeSymlink != 0:
if f, err := header.Open(); err != nil {
if f, err := header.Open(); err != nil {
return errors.Annotatef(err, "Open link %s", path)
} else if name, err := io.ReadAll(f); err != nil {
return errors.Annotatef(err, "Read address of link %s", path)
Expand All @@ -373,7 +393,7 @@ func (e *Extractor) Zip(ctx context.Context, body io.Reader, location string, re
f.Close()
}
default:
if f, err := header.Open(); err != nil {
if f, err := header.Open(); err != nil {
return errors.Annotatef(err, "Open file %s", path)
} else if err := e.copy(ctx, path, info.Mode(), f); err != nil {
return errors.Annotatef(err, "Create file %s", path)
Expand Down Expand Up @@ -417,12 +437,12 @@ func match(r io.Reader) (io.Reader, types.Type, error) {
}

if seeker, ok := r.(io.Seeker); ok {
// if the stream is seekable, we just rewind it
if _, err := seeker.Seek(0, io.SeekStart); err != nil {
// if the stream is seekable, we just rewind it
if _, err := seeker.Seek(0, io.SeekStart); err != nil {
return nil, types.Unknown, err
}
} else {
// otherwise we create a new reader that will prepend the buffer
// otherwise we create a new reader that will prepend the buffer
r = io.MultiReader(bytes.NewBuffer(buffer[:n]), r)
}

Expand Down