A couple of fixes.

GetChildrenRecursively is no longer threaded so it's more consistent
Fixed GetFileAtPath, specifically when getting the root dir

README.md

@@ -1,44 +1,18 @@
-# GoSquashfs
+# squashfs (WIP)
 
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/CalebQ42/GoSquashfs)](https://pkg.go.dev/github.com/CalebQ42/GoSquashfs)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/CalebQ42/squashfs)](https://pkg.go.dev/github.com/CalebQ42/squashfs) [![Go Report Card](https://goreportcard.com/badge/github.com/CalebQ42/squashfs)](https://goreportcard.com/report/github.com/CalebQ42/squashfs)
 
 A PURE Go library to read and write squashfs.
 
-Currently, you can read a squashfs and extract files (only files at the moment). Many things are public that shouldn't be, but you can use it by using NewSquashfsReader and subsequent ReadFile.
+Currently has support for reading squashfs files and extracting files and folders. Supports all compression types except LZO, but additional compression options are hit or miss.
 
-Special thanks to https://dr-emann.github.io/squashfs/ for some VERY important information in an easy to understand format.
+The only major thing missing from squashfs reading is Xattr parsing.
+
+Special thanks to <https://dr-emann.github.io/squashfs/> for some VERY important information in an easy to understand format.
 Thanks also to [distri's squashfs library](https://github.com/distr1/distri/tree/master/internal/squashfs) as I referenced it to figure some things out (and double check others).
 
-# Working
+## Performane
 
-* Extracting files from string paths
+This library, decompressing the firefox AppImage and using go tests, takes about twice as long as `unsquashfs` on my quad core laptop. (~1 second with the libarary and about half a second with `unsquashfs`)
-* Reading the header
-* Reading metadata blocks (whether encrypted or not)
-* Reading inodes
-* Reading directories
-* Basic gzip compression (Shouldn't be too hard to implement other, but for right now, this works)
-* Listing all files via a string slice
 
-# Not Working (Yet). Not necessarily in order.
+## [TODO](https://github.com/CalebQ42/squashfs/projects/1?fullscreen=true)
-
-* Rename repo so it's easier to import
-* Provide an easy interface to find and list files and their properties
-    * Maybe squashfs.File
-* Extracting files
-    * from inodes.
-    * from file info.
-* Give a list of files
-    * In io.FileStat (?) form
-* Reading the UID, GUID, Xatt, Compression Options, and Export tables.
-* Implement other compression types (Should be relatively easy)
-* Squashing
-* Threading processes to speed them up
-* Reasonable tests
-
-# TODO
-
-* Go over all documentation again (especially for exported structs and functions) to make sure it's easy to understand.
-
-# Where I'm at
-
-* v0.1 is the first working version!

compress.go

@@ -0,0 +1,17 @@
+package squashfs
+
+import "reflect"
+
+func (w *Writer) compressData(data []byte) ([]byte, error) {
+	if reflect.DeepEqual(data, make([]byte, len(data))) {
+		return nil, nil
+	}
+	compressedData, err := w.compressor.Compress(data)
+	if err != nil {
+		return nil, err
+	}
+	if len(data) <= len(compressedData) {
+		return data, nil
+	}
+	return compressedData, nil
+}

compression.go

@@ -1,29 +0,0 @@
-package squashfs
-
-import (
-	"bytes"
-	"compress/zlib"
-	"io"
-)
-
-//Decompressor is a squashfs decompressor interface. Allows for easy decompression no matter the type of compression.
-type decompressor interface {
-	Decompress(io.Reader) ([]byte, error)
-}
-
-//ZlibDecompressor is a decompressor for gzip type compression
-type zlibDecompressor struct{}
-
-//Decompress reads the entirety of the given reader and returns it uncompressed as a byte slice.
-func (z *zlibDecompressor) Decompress(r io.Reader) ([]byte, error) {
-	rdr, err := zlib.NewReader(r)
-	if err != nil {
-		return nil, err
-	}
-	var data bytes.Buffer
-	_, err = io.Copy(&data, rdr)
-	if err != nil {
-		return nil, err
-	}
-	return data.Bytes(), nil
-}

datareader.go

@@ -10,47 +10,27 @@ import (
 
 var (
 	//ErrInodeNotFile is given when giving an inode, but the function requires a file inode.
-	ErrInodeNotFile = errors.New("Given inode is NOT a file type")
+	errInodeNotFile = errors.New("Given inode is NOT a file type")
 	//ErrInodeOnlyFragment is given when trying to make a DataReader from an inode, but the inode only had data in a fragment
-	ErrInodeOnlyFragment = errors.New("Given inode ONLY has fragment data")
+	errInodeOnlyFragment = errors.New("Given inode ONLY has fragment data")
 )
 
 //DataReader reads data from data blocks.
 type dataReader struct {
 	r             *Reader
-	offset        int64 //offset relative to the beginning of the squash file
-	blocks        []dataBlock
-	curBlock      int //Which block in sizes is currently cached
 	curData       []byte
+	sizes         []uint32
+	offset        int64 //offset relative to the beginning of the squash file
+	curBlock      int   //Which block in sizes is currently cached
 	curReadOffset int   //offset relative to the currently cached data
 }
 
-//DataBlock holds info about a given data block from it's size
-type dataBlock struct {
-	begOffset        int64 //The offset relative to the beginning of the squash file. Makes it easier to seek to it.
-	size             uint32
-	compressed       bool
-	uncompressedSize uint32
-}
-
-//NewDataBlock creates a new squashfs.datablock from a given size.
-func newDataBlock(raw uint32) (dbs dataBlock) {
-	dbs.compressed = raw&(1<<24) != (1 << 24)
-	dbs.size = raw &^ (1 << 24)
-	if !dbs.compressed {
-		dbs.uncompressedSize = dbs.size
-	}
-	return
-}
-
 //NewDataReader creates a new data reader at the given offset, with the blocks defined by sizes
 func (r *Reader) newDataReader(offset int64, sizes []uint32) (*dataReader, error) {
 	var dr dataReader
 	dr.r = r
 	dr.offset = offset
-	for _, size := range sizes {
+	dr.sizes = sizes
-		dr.blocks = append(dr.blocks, newDataBlock(size))
-	}
 	err := dr.readCurBlock()
 	if err != nil {
 		return nil, err
@@ -63,32 +43,32 @@ func (r *Reader) newDataReaderFromInode(i *inode.Inode) (*dataReader, error) {
 	var rdr dataReader
 	rdr.r = r
 	switch i.Type {
-	case inode.BasicFileType:
+	case inode.FileType:
-		fil := i.Info.(inode.BasicFile)
+		fil := i.Info.(inode.File)
-		if fil.Init.BlockStart == 0 {
+		if fil.BlockStart == 0 {
-			return nil, ErrInodeOnlyFragment
+			return nil, errInodeOnlyFragment
 		}
-		rdr.offset = int64(fil.Init.BlockStart)
+		rdr.offset = int64(fil.BlockStart)
 		for _, sizes := range fil.BlockSizes {
-			rdr.blocks = append(rdr.blocks, newDataBlock(sizes))
+			rdr.sizes = append(rdr.sizes, sizes)
 		}
 		if fil.Fragmented {
-			rdr.blocks = rdr.blocks[:len(rdr.blocks)-1]
+			rdr.sizes = rdr.sizes[:len(rdr.sizes)-1]
 		}
 	case inode.ExtFileType:
-		fil := i.Info.(inode.ExtendedFile)
+		fil := i.Info.(inode.ExtFile)
-		if fil.Init.BlockStart == 0 {
+		if fil.BlockStart == 0 {
-			return nil, ErrInodeOnlyFragment
+			return nil, errInodeOnlyFragment
 		}
-		rdr.offset = int64(fil.Init.BlockStart)
+		rdr.offset = int64(fil.BlockStart)
 		for _, sizes := range fil.BlockSizes {
-			rdr.blocks = append(rdr.blocks, newDataBlock(sizes))
+			rdr.sizes = append(rdr.sizes, sizes)
 		}
 		if fil.Fragmented {
-			rdr.blocks = rdr.blocks[:len(rdr.blocks)-1]
+			rdr.sizes = rdr.sizes[:len(rdr.sizes)-1]
 		}
 	default:
-		return nil, ErrInodeNotFile
+		return nil, errInodeNotFile
 	}
 	err := rdr.readCurBlock()
 	if err != nil {
@@ -97,9 +77,14 @@ func (r *Reader) newDataReaderFromInode(i *inode.Inode) (*dataReader, error) {
 	return &rdr, nil
 }
 
+//removed the compression bit from a data block size
+func actualDataSize(size uint32) uint32 {
+	return size &^ (1 << 24)
+}
+
 func (d *dataReader) readNextBlock() error {
 	d.curBlock++
-	if d.curBlock >= len(d.blocks) {
+	if d.curBlock >= len(d.sizes) {
 		d.curBlock--
 		return io.EOF
 	}
@@ -112,41 +97,57 @@ func (d *dataReader) readNextBlock() error {
 	return nil
 }
 
-func (d *dataReader) readCurBlock() error {
+func (d *dataReader) readBlockAt(offset int64, size uint32) ([]byte, error) {
-	if d.curBlock >= len(d.blocks) {
+	compressed := size&(1<<24) != (1 << 24)
-		return io.EOF
+	size = size &^ (1 << 24)
+	if d.sizes[d.curBlock] == 0 {
+		return make([]byte, d.r.super.BlockSize), nil
 	}
-	if d.blocks[d.curBlock].size == 0 {
+	sec := io.NewSectionReader(d.r.r, offset, int64(size))
-		d.curData = make([]byte, d.r.super.BlockSize)
+	if compressed {
-		d.blocks[d.curBlock].uncompressedSize = d.r.super.BlockSize
-		d.blocks[d.curBlock].begOffset = d.offset
-		return nil
-	}
-	sec := io.NewSectionReader(d.r.r, d.offset, int64(d.blocks[d.curBlock].size))
-	if d.blocks[d.curBlock].compressed {
 		btys, err := d.r.decompressor.Decompress(sec)
 		if err != nil {
-			return err
+			return nil, err
 		}
-		d.blocks[d.curBlock].uncompressedSize = uint32(len(btys))
+		return btys, nil
-		d.curData = btys
-		d.blocks[d.curBlock].begOffset = d.offset
-		d.offset += int64(d.blocks[d.curBlock].size)
-		return nil
 	}
 	var buf bytes.Buffer
 	_, err := io.Copy(&buf, sec)
+	if err != nil {
+		return nil, err
+	}
+	return buf.Bytes(), nil
+}
+
+func (d *dataReader) offsetForBlock(index int) int64 {
+	out := d.offset
+	for i := 0; i < index; i++ {
+		out += int64(actualDataSize(d.sizes[i]))
+	}
+	return out
+}
+
+func (d *dataReader) readCurBlock() error {
+	if d.curBlock >= len(d.sizes) {
+		return io.EOF
+	}
+	offset := d.offsetForBlock(d.curBlock)
+	data, err := d.readBlockAt(offset, d.sizes[d.curBlock])
 	if err != nil {
 		return err
 	}
-	d.curData = buf.Bytes()
+	d.curData = data
-	d.blocks[d.curBlock].begOffset = d.offset
+	return nil
-	d.offset += int64(d.blocks[d.curBlock].size)
-	return err
 }
 
 func (d *dataReader) Read(p []byte) (int, error) {
-	if d.curReadOffset+len(p) < len(d.curData) {
+	if d.curData == nil {
+		err := d.readCurBlock()
+		if err != nil {
+			return 0, err
+		}
+	}
+	if d.curReadOffset+len(p) <= len(d.curData) {
 		for i := 0; i < len(p); i++ {
 			p[i] = d.curData[d.curReadOffset+i]
 		}
@@ -163,12 +164,12 @@ func (d *dataReader) Read(p []byte) (int, error) {
 			d.curReadOffset = 0
 		}
 		for ; read < len(p); read++ {
-			d.curReadOffset++
 			if d.curReadOffset < len(d.curData) {
 				p[read] = d.curData[d.curReadOffset]
 			} else {
 				break
 			}
+			d.curReadOffset++
 		}
 	}
 	if read != len(p) {
@@ -176,3 +177,71 @@ func (d *dataReader) Read(p []byte) (int, error) {
 	}
 	return read, nil
 }
+
+// WriteTo writes all the data in the datablock to the writer. MUST BE USED ON A FRESH DATA READER.
+func (d *dataReader) WriteTo(w io.Writer) (int64, error) {
+	type dataCache struct {
+		err   error
+		data  []byte
+		index int
+	}
+	dataChan := make(chan *dataCache)
+	for i := range d.sizes {
+		go func(index int, c chan *dataCache) {
+			var cache dataCache
+			cache.index = index
+			defer func() {
+				c <- &cache
+			}()
+			data, err := d.readBlockAt(d.offsetForBlock(index), d.sizes[index])
+			if err != nil {
+				cache.err = err
+				return
+			}
+			cache.data = data
+			return
+		}(i, dataChan)
+	}
+	curIndex := 0
+	totalWrite := int64(0)
+	var backlog []*dataCache
+mainLoop:
+	for {
+		if curIndex == len(d.sizes) {
+			return totalWrite, nil
+		}
+		if len(backlog) > 0 {
+			for i, cache := range backlog {
+				if cache.index == curIndex {
+					writen, err := w.Write(cache.data)
+					totalWrite += int64(writen)
+					if err != nil {
+						return totalWrite, err
+					}
+					if len(backlog) > 0 {
+						backlog[i] = backlog[len(backlog)-1]
+						backlog = backlog[:len(backlog)-1]
+					} else {
+						backlog = nil
+					}
+					curIndex++
+					continue mainLoop
+				}
+			}
+		}
+		cache := <-dataChan
+		if cache.err != nil {
+			return totalWrite, cache.err
+		}
+		if cache.index == curIndex {
+			writen, err := w.Write(cache.data)
+			totalWrite += int64(writen)
+			if err != nil {
+				return totalWrite, err
+			}
+			curIndex++
+		} else {
+			backlog = append(backlog, cache)
+		}
+	}
+}

file.go

@@ -0,0 +1,541 @@
+package squashfs
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"os"
+	"path"
+	"strings"
+	"time"
+
+	"github.com/CalebQ42/squashfs/internal/directory"
+	"github.com/CalebQ42/squashfs/internal/inode"
+)
+
+var (
+	//ErrNotDirectory is returned when you're trying to do directory things with a non-directory
+	errNotDirectory = errors.New("File is not a directory")
+	//ErrNotFile is returned when you're trying to do file things with a directory
+	errNotFile = errors.New("File is not a file")
+	//ErrNotReading is returned when running functions that are only meant to be used when reading a squashfs
+	errNotReading = errors.New("Function only supported when reading a squashfs")
+	//ErrBrokenSymlink is returned when using ExtractWithOptions with the unbreakSymlink set to true, but the symlink's file cannot be extracted.
+	ErrBrokenSymlink = errors.New("Extracted symlink is probably broken")
+)
+
+//File is the main way to interact with files within squashfs, or when putting files into a squashfs.
+//File can be either a file or folder. When reading from a squashfs, it reads from the datablocks.
+//When writing, this holds the information on WHERE the file will be placed inside the archive.
+//
+//If copying data from a squashfs, the returned reader from io.Sys() implements io.WriterTo which
+//will be significantly faster then calling Read directly.
+//Ex: use io.Sys().(io.Reader) for io.Copy instead of using the File directly.
+//
+//Implements os.FileInfo and io.Reader
+type File struct {
+	reader  io.Reader
+	Parent  *File
+	r       *Reader //Underlying reader. When writing, will probably be an os.File. When reading this is kept nil UNTIL reading to save memory.
+	in      *inode.Inode
+	name    string
+	dir     string
+	filType int //The file's type, using inode types.
+
+}
+
+//get a File from a directory.entry
+func (r *Reader) newFileFromDirEntry(entry *directory.Entry) (fil *File, err error) {
+	fil = new(File)
+	fil.in, err = r.getInodeFromEntry(entry)
+	if err != nil {
+		return nil, err
+	}
+	fil.name = entry.Name
+	fil.r = r
+	fil.filType = fil.in.Type
+	return
+}
+
+//Name is the file's name
+func (f *File) Name() string {
+	return f.name
+}
+
+//Size is the complete size of the file. Zero if it's not a file.
+func (f *File) Size() int64 {
+	switch f.filType {
+	case inode.FileType:
+		return int64(f.in.Info.(inode.File).Size)
+	case inode.ExtFileType:
+		return int64(f.in.Info.(inode.ExtFile).Size)
+	default:
+		return 0
+	}
+}
+
+//ModTime is the time of last modification.
+func (f *File) ModTime() time.Time {
+	return time.Unix(int64(f.in.Header.ModifiedTime), 0)
+}
+
+//Sys returns the underlying reader. If the reader isn't initialized, it will initialize it.
+//If called on something other then a file, returns nil.
+func (f *File) Sys() interface{} {
+	if !f.IsFile() {
+		return nil
+	}
+	if f.reader == nil && f.r != nil {
+		var err error
+		f.reader, err = f.r.newFileReader(f.in)
+		if err != nil {
+			return nil
+		}
+	}
+	return f.reader
+}
+
+//GetChildren returns a *squashfs.File slice of every direct child of the directory. If the File is not a directory, will return ErrNotDirectory
+func (f *File) GetChildren() (children []*File, err error) {
+	children = make([]*File, 0)
+	if f.r == nil {
+		return nil, errNotReading
+	}
+	if !f.IsDir() {
+		return nil, errNotDirectory
+	}
+	dir, err := f.r.readDirFromInode(f.in)
+	if err != nil {
+		return
+	}
+	var fil *File
+	for _, entry := range dir.Entries {
+		fil, err = f.r.newFileFromDirEntry(&entry)
+		if err != nil {
+			return
+		}
+		fil.Parent = f
+		if f.name != "" {
+			fil.dir = f.Path()
+		}
+		children = append(children, fil)
+	}
+	return
+}
+
+//GetChildrenRecursively returns ALL children. Goes down ALL folder paths.
+func (f *File) GetChildrenRecursively() (children []*File, err error) {
+	children = make([]*File, 0)
+	if f.r == nil {
+		return nil, errNotReading
+	}
+	if !f.IsDir() {
+		return nil, errNotDirectory
+	}
+	children, err = f.GetChildren()
+	if err != nil {
+		return
+	}
+	var childFolders []*File
+	for _, child := range children {
+		if child.IsDir() {
+			childFolders = append(childFolders, child)
+		}
+	}
+	for _, folds := range childFolders {
+		var childs []*File
+		childs, err = folds.GetChildrenRecursively()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+		children = append(children, childs...)
+	}
+	return
+}
+
+//Path returns the path of the file within the archive.
+func (f *File) Path() string {
+	if f.name == "" {
+		return f.dir
+	}
+	return f.dir + "/" + f.name
+}
+
+//GetFileAtPath tries to return the File at the given path, relative to the file.
+//Returns nil if called on something other then a folder, OR if the path goes oustide the archive.
+//Allows wildcards supported by path.Match (namely * and ?) and will return the FIRST file that matches.
+func (f *File) GetFileAtPath(dirPath string) *File {
+	dirPath = path.Clean(dirPath)
+	dirPath = strings.TrimPrefix(dirPath, "/")
+	if dirPath == "" || dirPath == "." {
+		return f
+	}
+	if dirPath != "." && !f.IsDir() {
+		return nil
+	}
+	split := strings.Split(dirPath, "/")
+	if split[0] == ".." && f.name == "" {
+		return nil
+	} else if split[0] == ".." {
+		if f.Parent != nil {
+			return f.Parent.GetFileAtPath(strings.Join(split[1:], "/"))
+		}
+		return nil
+	}
+	children, err := f.GetChildren()
+	if err != nil {
+		return nil
+	}
+	for _, child := range children {
+		eq, _ := path.Match(split[0], child.name)
+		if eq {
+			return child.GetFileAtPath(strings.Join(split[1:], "/"))
+		}
+	}
+	return nil
+}
+
+//IsDir returns if the file is a directory.
+func (f *File) IsDir() bool {
+	return f.filType == inode.DirType || f.filType == inode.ExtDirType
+}
+
+//IsSymlink returns if the file is a symlink.
+func (f *File) IsSymlink() bool {
+	return f.filType == inode.SymType || f.filType == inode.ExtSymlinkType
+}
+
+//IsFile returns if the file is a file.
+func (f *File) IsFile() bool {
+	return f.filType == inode.FileType || f.filType == inode.ExtFileType
+}
+
+//SymlinkPath returns the path the symlink is pointing to. If the file ISN'T a symlink, will return an empty string.
+//If a path begins with "/" then the symlink is pointing to an absolute path (starting from root, and not a file inside the archive)
+func (f *File) SymlinkPath() string {
+	switch f.filType {
+	case inode.SymType:
+		return f.in.Info.(inode.Sym).Path
+	case inode.ExtSymlinkType:
+		return f.in.Info.(inode.Sym).Path
+	default:
+		return ""
+	}
+}
+
+//GetSymlinkFile tries to return the squashfs.File associated with the symlink. If the file isn't a symlink
+//or the symlink points to a location outside the archive, nil is returned.
+func (f *File) GetSymlinkFile() *File {
+	if !f.IsSymlink() {
+		return nil
+	}
+	if strings.HasSuffix(f.SymlinkPath(), "/") {
+		return nil
+	}
+	return f.Parent.GetFileAtPath(f.SymlinkPath())
+}
+
+//GetSymlinkFileRecursive tries to return the squasfs.File associated with the symlink. It will recursively
+//try to get the symlink's file. This will return either a non-symlink File, or nil.
+func (f *File) GetSymlinkFileRecursive() *File {
+	if !f.IsSymlink() {
+		return nil
+	}
+	if strings.HasSuffix(f.SymlinkPath(), "/") {
+		return nil
+	}
+	sym := f
+	for {
+		sym = sym.GetSymlinkFile()
+		if sym == nil {
+			return nil
+		}
+		if !sym.IsSymlink() {
+			return sym
+		}
+	}
+}
+
+//Mode returns the os.FileMode of the File. Sets mode bits for directories and symlinks.
+func (f *File) Mode() os.FileMode {
+	mode := os.FileMode(f.in.Header.Permissions)
+	switch {
+	case f.IsDir():
+		mode = mode | os.ModeDir
+	case f.IsSymlink():
+		mode = mode | os.ModeSymlink
+	}
+	return mode
+}
+
+//ExtractTo extracts the file to the given path. This is the same as ExtractWithOptions(path, false, false, os.ModePerm, false).
+//Will NOT try to keep symlinks valid, folders extracted will have the permissions set by the squashfs, but the folder to make path will have full permissions (777).
+//
+//Will try it's best to extract all files, and if any errors come up, they will be appended to the error slice that's returned.
+func (f *File) ExtractTo(path string) []error {
+	return f.ExtractWithOptions(path, false, false, os.ModePerm, false)
+}
+
+//ExtractSymlink is similar to ExtractTo, but when it extracts a symlink, it instead extracts the file associated with the symlink in it's place.
+//This is the same as ExtractWithOptions(path, true, false, os.ModePerm, false)
+func (f *File) ExtractSymlink(path string) []error {
+	return f.ExtractWithOptions(path, true, false, os.ModePerm, false)
+}
+
+//ExtractWithOptions will extract the file to the given path, while allowing customization on how it works. ExtractTo is the "default" options.
+//Will try it's best to extract all files, and if any errors come up, they will be appended to the error slice that's returned.
+//Should only return multiple errors if extracting a folder.
+//
+//If dereferenceSymlink is set, instead of extracting a symlink, it will extract the file the symlink is pointed to in it's place.
+//If both dereferenceSymlink and unbreakSymlink is set, dereferenceSymlink takes precendence.
+//
+//If unbreakSymlink is set, it will also try to extract the symlink's associated file. WARNING: the symlink's file may have to go up the directory to work.
+//If unbreakSymlink is set and the file cannot be extracted, a ErrBrokenSymlink will be appended to the returned error slice.
+//
+//folderPerm only applies to the folders created to get to path. Folders from the archive are given the correct permissions defined by the archive.
+func (f *File) ExtractWithOptions(path string, dereferenceSymlink, unbreakSymlink bool, folderPerm os.FileMode, verbose bool) (errs []error) {
+	errs = make([]error, 0)
+	err := os.MkdirAll(path, folderPerm)
+	if err != nil {
+		return []error{err}
+	}
+	switch {
+	case f.IsDir():
+		if f.name != "" {
+			//TODO: check if folder is present, and if so, try to set it's permission
+			err = os.Mkdir(path+"/"+f.name, os.ModePerm)
+			if err != nil {
+				if verbose {
+					fmt.Println("Error while making: ", path+"/"+f.name)
+					fmt.Println(err)
+				}
+				errs = append(errs, err)
+				return
+			}
+			var fil *os.File
+			fil, err = os.Open(path + "/" + f.name)
+			if err != nil {
+				if verbose {
+					fmt.Println("Error while opening:", path+"/"+f.name)
+					fmt.Println(err)
+				}
+				errs = append(errs, err)
+				return
+			}
+			fil.Chown(int(f.r.idTable[f.in.Header.UID]), int(f.r.idTable[f.in.Header.GID]))
+			//don't mention anything when it fails. Because it fails often. Probably has something to do about uid & gid 0
+			// if err != nil {
+			// 	if verbose {
+			// 		fmt.Println("Error while changing owner:", path+"/"+f.Name)
+			// 		fmt.Println(err)
+			// 	}
+			// 	errs = append(errs, err)
+			// }
+			err = fil.Chmod(f.Mode())
+			if err != nil {
+				if verbose {
+					fmt.Println("Error while changing owner:", path+"/"+f.name)
+					fmt.Println(err)
+				}
+				errs = append(errs, err)
+			}
+		}
+		var children []*File
+		children, err = f.GetChildren()
+		if err != nil {
+			if verbose {
+				fmt.Println("Error getting children for:", f.Path())
+				fmt.Println(err)
+			}
+			errs = append(errs, err)
+			return
+		}
+		finishChan := make(chan []error)
+		for _, child := range children {
+			go func(child *File) {
+				if f.name == "" {
+					finishChan <- child.ExtractWithOptions(path, dereferenceSymlink, unbreakSymlink, folderPerm, verbose)
+				} else {
+					finishChan <- child.ExtractWithOptions(path+"/"+f.name, dereferenceSymlink, unbreakSymlink, folderPerm, verbose)
+				}
+			}(child)
+		}
+		for range children {
+			errs = append(errs, (<-finishChan)...)
+		}
+		return
+	case f.IsFile():
+		var fil *os.File
+		fil, err = os.Create(path + "/" + f.name)
+		if os.IsExist(err) {
+			err = os.Remove(path + "/" + f.name)
+			if err != nil {
+				if verbose {
+					fmt.Println("Error while making:", path+"/"+f.name)
+					fmt.Println(err)
+				}
+				errs = append(errs, err)
+				return
+			}
+			fil, err = os.Create(path + "/" + f.name)
+			if err != nil {
+				if verbose {
+					fmt.Println("Error while making:", path+"/"+f.name)
+					fmt.Println(err)
+				}
+				errs = append(errs, err)
+				return
+			}
+		} else if err != nil {
+			if verbose {
+				fmt.Println("Error while making:", path+"/"+f.name)
+				fmt.Println(err)
+			}
+			errs = append(errs, err)
+			return
+		} //Since we will be reading from the file
+		_, err = io.Copy(fil, f.Sys().(io.Reader))
+		if err != nil {
+			if verbose {
+				fmt.Println("Error while Copying data to:", path+"/"+f.name)
+				fmt.Println(err)
+			}
+			errs = append(errs, err)
+			return
+		}
+		fil.Chown(int(f.r.idTable[f.in.Header.UID]), int(f.r.idTable[f.in.Header.GID]))
+		//don't mention anything when it fails. Because it fails often. Probably has something to do about uid & gid 0
+		// if err != nil {
+		// 	if verbose {
+		// 		fmt.Println("Error while changing owner:", path+"/"+f.Name)
+		// 		fmt.Println(err)
+		// 	}
+		// 	errs = append(errs, err)
+		// 	return
+		// }
+		err = fil.Chmod(f.Mode())
+		if err != nil {
+			if verbose {
+				fmt.Println("Error while setting permissions for:", path+"/"+f.name)
+				fmt.Println(err)
+			}
+			errs = append(errs, err)
+		}
+		return
+	case f.IsSymlink():
+		symPath := f.SymlinkPath()
+		if dereferenceSymlink {
+			fil := f.GetSymlinkFile()
+			if fil == nil {
+				if verbose {
+					fmt.Println("Symlink path(", symPath, ") is outside the archive:"+path+"/"+f.name)
+				}
+				return
+			}
+			fil.name = f.name
+			extracSymErrs := fil.ExtractWithOptions(path, dereferenceSymlink, unbreakSymlink, folderPerm, verbose)
+			if len(extracSymErrs) > 0 {
+				if verbose {
+					fmt.Println("Error(s) while extracting the symlink's file:", path+"/"+f.name)
+					fmt.Println(extracSymErrs)
+				}
+				errs = append(errs, extracSymErrs...)
+			}
+			return
+		} else if unbreakSymlink {
+			fil := f.GetSymlinkFile()
+			if fil != nil {
+				symPath = path + "/" + symPath
+				paths := strings.Split(symPath, "/")
+				extracSymErrs := fil.ExtractWithOptions(strings.Join(paths[:len(paths)-1], "/"), dereferenceSymlink, unbreakSymlink, folderPerm, verbose)
+				if len(extracSymErrs) > 0 {
+					if verbose {
+						fmt.Println("Error(s) while extracting the symlink's file:", path+"/"+f.name)
+						fmt.Println(extracSymErrs)
+					}
+					errs = append(errs, extracSymErrs...)
+				}
+			} else {
+				if verbose {
+					fmt.Println("Symlink path(", symPath, ") is outside the archive:"+path+"/"+f.name)
+				}
+				return
+			}
+		}
+		err = os.Symlink(f.SymlinkPath(), path+"/"+f.name)
+		if err != nil {
+			if verbose {
+				fmt.Println("Error while making symlink:", path+"/"+f.name)
+				fmt.Println(err)
+			}
+			errs = append(errs, err)
+		}
+	}
+	return
+}
+
+//Read from the file. Doesn't do anything fancy, just pases it to the underlying io.Reader. If a directory, return io.EOF.
+func (f *File) Read(p []byte) (int, error) {
+	if !f.IsFile() {
+		return 0, io.EOF
+	}
+	var err error
+	if f.reader == nil && f.r != nil {
+		f.reader, err = f.r.newFileReader(f.in)
+		if err != nil {
+			return 0, err
+		}
+	}
+	return f.reader.Read(p)
+}
+
+//ReadDirFromInode returns a fully populated Directory from a given Inode.
+//If the given inode is not a directory it returns an error.
+func (r *Reader) readDirFromInode(i *inode.Inode) (*directory.Directory, error) {
+	var offset uint32
+	var metaOffset uint16
+	var size uint32
+	switch i.Type {
+	case inode.DirType:
+		offset = i.Info.(inode.Dir).DirectoryIndex
+		metaOffset = i.Info.(inode.Dir).DirectoryOffset
+		size = uint32(i.Info.(inode.Dir).DirectorySize)
+	case inode.ExtDirType:
+		offset = i.Info.(inode.ExtDir).DirectoryIndex
+		metaOffset = i.Info.(inode.ExtDir).DirectoryOffset
+		size = i.Info.(inode.ExtDir).DirectorySize
+	default:
+		return nil, errors.New("Not a directory inode")
+	}
+	br, err := r.newMetadataReader(int64(r.super.DirTableStart + uint64(offset)))
+	if err != nil {
+		return nil, err
+	}
+	_, err = br.Seek(int64(metaOffset), io.SeekStart)
+	if err != nil {
+		return nil, err
+	}
+	dir, err := directory.NewDirectory(br, size)
+	if err != nil {
+		return dir, err
+	}
+	return dir, nil
+}
+
+//GetInodeFromEntry returns the inode associated with a given directory.Entry
+func (r *Reader) getInodeFromEntry(en *directory.Entry) (*inode.Inode, error) {
+	br, err := r.newMetadataReader(int64(r.super.InodeTableStart + uint64(en.Header.InodeOffset)))
+	if err != nil {
+		return nil, err
+	}
+	_, err = br.Seek(int64(en.Offset), io.SeekStart)
+	if err != nil {
+		return nil, err
+	}
+	i, err := inode.ProcessInode(br, r.super.BlockSize)
+	if err != nil {
+		return nil, err
+	}
+	return i, nil
+}

filereader.go

@@ -9,9 +9,10 @@ import (
 )
 
 //FileReader provides a io.Reader interface for files within a squashfs archive
-type FileReader struct {
+type fileReader struct {
 	r            *Reader
 	data         *dataReader
+	in           *inode.Inode
 	fragmentData []byte
 	fragged      bool
 	fragOnly     bool
@@ -21,32 +22,29 @@ type FileReader struct {
 
 var (
 	//ErrPathIsNotFile returns when trying to read from a file, but the given path is NOT a file.
-	ErrPathIsNotFile = errors.New("The given path is not a file")
+	errPathIsNotFile = errors.New("The given path is not a file")
 )
 
 //ReadFile provides a squashfs.FileReader for the file at the given location.
-func (r *Reader) ReadFile(location string) (*FileReader, error) {
+func (r *Reader) newFileReader(in *inode.Inode) (*fileReader, error) {
-	var rdr FileReader
+	var rdr fileReader
-	rdr.r = r
+	rdr.in = in
-	in, err := r.getInodeFromPath(location)
+	if in.Type != inode.FileType && in.Type != inode.ExtFileType {
-	if err != nil {
+		return nil, errPathIsNotFile
-		return nil, err
-	}
-	if in.Type != inode.BasicFileType && in.Type != inode.ExtFileType {
-		return nil, ErrPathIsNotFile
 	}
 	switch in.Type {
-	case inode.BasicFileType:
+	case inode.FileType:
-		fil := in.Info.(inode.BasicFile)
+		fil := in.Info.(inode.File)
 		rdr.fragged = fil.Fragmented
-		rdr.fragOnly = fil.Init.BlockStart == 0
+		rdr.fragOnly = fil.BlockStart == 0
-		rdr.FileSize = int(fil.Init.Size)
+		rdr.FileSize = int(fil.Size)
 	case inode.ExtFileType:
-		fil := in.Info.(inode.ExtendedFile)
+		fil := in.Info.(inode.ExtFile)
 		rdr.fragged = fil.Fragmented
-		rdr.fragOnly = fil.Init.BlockStart == 0
+		rdr.fragOnly = fil.BlockStart == 0
-		rdr.FileSize = int(fil.Init.Size)
+		rdr.FileSize = int(fil.Size)
 	}
+	var err error
 	if rdr.fragged {
 		rdr.fragmentData, err = r.getFragmentDataFromInode(in)
 		if err != nil {
@@ -59,7 +57,7 @@ func (r *Reader) ReadFile(location string) (*FileReader, error) {
 	return &rdr, nil
 }
 
-func (f *FileReader) Read(p []byte) (int, error) {
+func (f *fileReader) Read(p []byte) (int, error) {
 	if f.fragOnly {
 		n, err := bytes.NewBuffer(f.fragmentData[f.read:]).Read(p)
 		f.read += n
@@ -72,6 +70,9 @@ func (f *FileReader) Read(p []byte) (int, error) {
 	n, err := f.data.Read(p)
 	read += n
 	if f.fragged && err == io.EOF {
+		if f.fragmentData == nil {
+			f.fragmentData, err = f.r.getFragmentDataFromInode(f.in)
+		}
 		n, err = bytes.NewBuffer(f.fragmentData).Read(p[read:])
 		read += n
 		if err != nil {
@@ -82,3 +83,19 @@ func (f *FileReader) Read(p []byte) (int, error) {
 	}
 	return read, nil
 }
+
+func (f *fileReader) WriteTo(w io.Writer) (int64, error) {
+	if f.fragOnly {
+		n, err := w.Write(f.fragmentData)
+		return int64(n), err
+	}
+	if !f.fragged {
+		return f.data.WriteTo(w)
+	}
+	n, err := f.data.WriteTo(w)
+	if err != nil {
+		return int64(n), err
+	}
+	nn, err := w.Write(f.fragmentData)
+	return int64(nn) + n, err
+}

fragment.go

@@ -12,7 +12,7 @@ import (
 type fragmentEntry struct {
 	Start uint64
 	Size  uint32
-	Unused uint32
+	// Unused uint32
 }
 
 //GetFragmentDataFromInode returns the fragment data for a given inode.
@@ -21,30 +21,30 @@ func (r *Reader) getFragmentDataFromInode(in *inode.Inode) ([]byte, error) {
 	var size uint32
 	var fragIndex uint32
 	var fragOffset uint32
-	if in.Type == inode.BasicFileType {
+	if in.Type == inode.FileType {
-		bf := in.Info.(inode.BasicFile)
+		bf := in.Info.(inode.File)
 		if !bf.Fragmented {
 			return make([]byte, 0), nil
 		}
-		if bf.Init.BlockStart == 0 {
+		if bf.BlockStart == 0 {
-			size = bf.Init.Size
+			size = bf.Size
 		} else {
 			size = bf.BlockSizes[len(bf.BlockSizes)-1]
 		}
-		fragIndex = bf.Init.FragmentIndex
+		fragIndex = bf.FragmentIndex
-		fragOffset = bf.Init.FragmentOffset
+		fragOffset = bf.FragmentOffset
 	} else if in.Type == inode.ExtFileType {
-		bf := in.Info.(inode.ExtendedFile)
+		bf := in.Info.(inode.ExtFile)
 		if !bf.Fragmented {
 			return make([]byte, 0), nil
 		}
-		if bf.Init.BlockStart == 0 {
+		if bf.BlockStart == 0 {
-			size = bf.Init.Size
+			size = bf.Size
 		} else {
 			size = bf.BlockSizes[len(bf.BlockSizes)-1]
 		}
-		fragIndex = bf.Init.FragmentIndex
+		fragIndex = bf.FragmentIndex
-		fragOffset = bf.Init.FragmentOffset
+		fragOffset = bf.FragmentOffset
 	} else {
 		return nil, errors.New("Inode type not supported")
 	}

go.mod

@@ -3,5 +3,17 @@ module github.com/CalebQ42/squashfs
 go 1.15
 
 require (
-	github.com/CalebQ42/GoAppImage v0.4.0
+	github.com/CalebQ42/GoAppImage v0.5.0
+	github.com/adrg/xdg v0.2.3 // indirect
+	github.com/google/go-cmp v0.5.4 // indirect
+	github.com/gopherjs/gopherjs v0.0.0-20200217142428-fce0ec30dd00 // indirect
+	github.com/klauspost/compress v1.11.6
+	github.com/kr/text v0.2.0 // indirect
+	github.com/pierrec/lz4/v4 v4.1.3
+	github.com/smartystreets/assertions v1.2.0 // indirect
+	github.com/stretchr/testify v1.7.0 // indirect
+	github.com/ulikunitz/xz v0.5.9
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

go.sum

@@ -1,9 +1,10 @@
-github.com/CalebQ42/GoAppImage v0.4.0 h1:aF+Y/vyo/RGhoyZEW1CMY6WyRWrZZO4ydsRFAtIGnaY=
+github.com/CalebQ42/GoAppImage v0.5.0 h1:znoKNXtliH754tS9sYwyOIg/0wFDjFN5Twc7PAh1rSM=
-github.com/CalebQ42/GoAppImage v0.4.0/go.mod h1:qHudJKAn/dlkNWNnH4h1YKXp29EZ7Bppsn7sNP2HuvU=
+github.com/CalebQ42/GoAppImage v0.5.0/go.mod h1:qHudJKAn/dlkNWNnH4h1YKXp29EZ7Bppsn7sNP2HuvU=
-github.com/CalebQ42/GoSquashfs v0.1.0 h1:1E6oeZLxGwjFgB0M5BcDD/IpKOQq1aO0gGsN0llCFoE=
-github.com/CalebQ42/GoSquashfs v0.1.0/go.mod h1:NzAR1YC1SVKOKhRao5IiWY3GhOMI+IxBy1xeZJeVKlQ=
 github.com/adrg/xdg v0.2.2 h1:A7ZHKRz5KGOLJX/bg7IPzStryhvCzAE1wX+KWawPiAo=
 github.com/adrg/xdg v0.2.2/go.mod h1:7I2hH/IT30IsupOpKZ5ue7/qNi3CoKzD6tL3HwpaRMQ=
+github.com/adrg/xdg v0.2.3 h1:GxXngdYxNDkoUvZXjNJGwqZxWXi43MKbOOlA/00qZi4=
+github.com/adrg/xdg v0.2.3/go.mod h1:7I2hH/IT30IsupOpKZ5ue7/qNi3CoKzD6tL3HwpaRMQ=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -13,22 +14,39 @@ github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M=
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
+github.com/gopherjs/gopherjs v0.0.0-20200217142428-fce0ec30dd00 h1:l5lAOZEym3oK3SQ2HBHWsJUfbNBiTXJDeW2QDxw9AQ0=
+github.com/gopherjs/gopherjs v0.0.0-20200217142428-fce0ec30dd00/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo=
 github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
+github.com/klauspost/compress v1.11.6 h1:EgWPCW6O3n1D5n99Zq3xXBt9uCwRGvpwGOusOLNBRSQ=
+github.com/klauspost/compress v1.11.6/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/pierrec/lz4/v4 v4.1.3 h1:/dvQpkb0o1pVlSgKNQqfkavlnXaIK+hJ0LXsKRUN9D4=
+github.com/pierrec/lz4/v4 v4.1.3/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
+github.com/smartystreets/assertions v1.2.0 h1:42S6lae5dvLc7BrLu/0ugRtcFVjoJNMC/N3yZFZkDFs=
+github.com/smartystreets/assertions v1.2.0/go.mod h1:tcbTF8ujkAEcZ8TElKY+i30BzYlVhC/LOxJk7iOWnoo=
 github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s=
 github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/ulikunitz/xz v0.5.9 h1:RsKRIA2MO8x56wkkcd3LbtcE/uMszhb6DpRf+3uwa3I=
+github.com/ulikunitz/xz v0.5.9/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
 go.lsp.dev/uri v0.3.0 h1:KcZJmh6nFIBeJzTugn5JTU6OOyG0lDOo3R9KwTxTYbo=
 go.lsp.dev/uri v0.3.0/go.mod h1:P5sbO1IQR+qySTWOCnhnK7phBx+W3zbLqSMDJNTw88I=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2 h1:VklqNMn3ovrHsnt90PveolxSbWFaJdECFbxSq0Mqo2M=
@@ -48,7 +66,11 @@ golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8T
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b h1:QRR6H1YWRnHb4Y/HeNFCTJLFVxaq6wH4YuVdsUOr75U=
 gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/ini.v1 v1.62.0 h1:duBzk771uxoUuOlyRLkHsygud9+5lrlGjdFBb4mSKDU=
 gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/compression/gzip.go

@@ -0,0 +1,75 @@
+package compression
+
+import (
+	"bytes"
+	"compress/zlib"
+	"encoding/binary"
+	"io"
+)
+
+type gzipInit struct {
+	CompressionLevel int32
+	WindowSize       int16
+	Strategies       int16
+}
+
+//Gzip is a decompressor for gzip type compression. Uses zlib for compression and decompression
+type Gzip struct {
+	wrt *zlib.Writer
+	gzipInit
+	HasCustomWindow bool
+	HasStrategies   bool
+}
+
+//NewGzipCompressorWithOptions creates a new gzip compressor/decompressor with options read from the given reader.
+func NewGzipCompressorWithOptions(r io.Reader) (*Gzip, error) {
+	var gzip Gzip
+	err := binary.Read(r, binary.LittleEndian, &gzip.gzipInit)
+	if err != nil {
+		return nil, err
+	}
+	//TODO: proper support for window size and strategies
+	gzip.HasCustomWindow = gzip.WindowSize != 15
+	gzip.HasStrategies = gzip.Strategies != 0 && gzip.Strategies != 1
+	return &gzip, nil
+}
+
+//Decompress reads the entirety of the given reader and returns it uncompressed as a byte slice.
+func (g *Gzip) Decompress(r io.Reader) ([]byte, error) {
+	rdr, err := zlib.NewReader(r)
+	if err != nil {
+		return nil, err
+	}
+	var data bytes.Buffer
+	_, err = io.Copy(&data, rdr)
+	if err != nil {
+		return nil, err
+	}
+	return data.Bytes(), nil
+}
+
+//Compress compresses the given data (as a byte array) and returns the compressed data.
+func (g *Gzip) Compress(data []byte) ([]byte, error) {
+	var buf bytes.Buffer
+	var err error
+	if g.wrt == nil {
+		if g.CompressionLevel == 0 {
+			g.wrt = zlib.NewWriter(&buf)
+		} else {
+			g.wrt, err = zlib.NewWriterLevel(&buf, int(g.CompressionLevel))
+			if err != nil {
+				return nil, err
+			}
+		}
+	}
+	wrt, err := zlib.NewWriterLevel(&buf, int(g.CompressionLevel))
+	if err != nil {
+		return nil, err
+	}
+	_, err = wrt.Write(data)
+	if err != nil {
+		return nil, err
+	}
+	wrt.Close()
+	return buf.Bytes(), nil
+}

internal/compression/lz4.go

@@ -0,0 +1,55 @@
+package compression
+
+import (
+	"bytes"
+	"encoding/binary"
+	"io"
+
+	"github.com/pierrec/lz4/v4"
+)
+
+//Lz4 is a Lz4 Compressor/Decompressor
+type Lz4 struct {
+	HC bool
+}
+
+//NewLz4CompressorWithOptions creates a new lz4 compressor/decompressor with options read from the given reader.
+func NewLz4CompressorWithOptions(r io.Reader) (*Lz4, error) {
+	var lz4 Lz4
+	var init struct {
+		Version int32
+		Flags   int32
+	}
+	err := binary.Read(r, binary.LittleEndian, &init)
+	if err != nil {
+		return nil, err
+	}
+	lz4.HC = init.Flags == 1
+	return &lz4, nil
+}
+
+//Decompress decompresses all data from r and returns the uncompressed bytes
+func (l *Lz4) Decompress(r io.Reader) ([]byte, error) {
+	rdr := lz4.NewReader(r)
+	var buf bytes.Buffer
+	_, err := io.Copy(&buf, rdr)
+	return buf.Bytes(), err
+}
+
+//Compress implements compression.Compress
+func (l *Lz4) Compress(data []byte) ([]byte, error) {
+	var buf bytes.Buffer
+	w := lz4.NewWriter(&buf)
+	if l.HC {
+		err := w.Apply(lz4.CompressionLevelOption(lz4.Level9))
+		if err != nil {
+			return nil, err
+		}
+	}
+	_, err := w.Write(data)
+	if err != nil {
+		return nil, err
+	}
+	w.Close()
+	return buf.Bytes(), nil
+}

internal/compression/lzma.go

@@ -0,0 +1,40 @@
+package compression
+
+import (
+	"bytes"
+	"io"
+
+	"github.com/ulikunitz/xz/lzma"
+)
+
+//Lzma is a lzma decompressor
+type Lzma struct{}
+
+//Decompress decompresses all the data in the given reader and returns the uncompressed bytes.
+func (l *Lzma) Decompress(rdr io.Reader) ([]byte, error) {
+	r, err := lzma.NewReader(rdr)
+	if err != nil {
+		return nil, err
+	}
+	var buf bytes.Buffer
+	_, err = io.Copy(&buf, r)
+	if err != nil {
+		return nil, err
+	}
+	return buf.Bytes(), nil
+}
+
+//Compress implements compression.Compress
+func (l *Lzma) Compress(data []byte) ([]byte, error) {
+	var buf bytes.Buffer
+	w, err := lzma.NewWriter(&buf)
+	if err != nil {
+		return nil, err
+	}
+	_, err = w.Write(data)
+	if err != nil {
+		return nil, err
+	}
+	w.Close()
+	return buf.Bytes(), nil
+}

internal/compression/types.go

@@ -0,0 +1,13 @@
+package compression
+
+import "io"
+
+//Compressor is a squashfs decompressor interface. Allows for easy compression.
+type Compressor interface {
+	Compress([]byte) ([]byte, error)
+}
+
+//Decompressor is a squashfs decompressor interface. Allows for easy decompression no matter the type of compression.
+type Decompressor interface {
+	Decompress(io.Reader) ([]byte, error)
+}

internal/compression/xz.go

@@ -0,0 +1,75 @@
+package compression
+
+import (
+	"bytes"
+	"encoding/binary"
+	"io"
+
+	"github.com/ulikunitz/xz"
+)
+
+type xzInit struct {
+	DictionarySize int32
+	Filters        int32
+}
+
+//Xz is a Xz decompressor.
+type Xz struct {
+	DictionarySize int32
+	HasFilters     bool
+}
+
+//NewXzCompressorWithOptions creates a new Xz compressor/decompressor that reads the compressor options from the given reader.
+func NewXzCompressorWithOptions(rdr io.Reader) (*Xz, error) {
+	var x Xz
+	var init xzInit
+	err := binary.Read(rdr, binary.LittleEndian, &init)
+	if err != nil {
+		return nil, err
+	}
+	x.DictionarySize = init.DictionarySize
+	//TODO: When I can do filters, parse the filters
+	if init.Filters != 0 {
+		x.HasFilters = true
+	}
+	return &x, nil
+}
+
+//Decompress decompresses all the data from the rdr and returns the uncompressed bytes.
+func (x *Xz) Decompress(rdr io.Reader) ([]byte, error) {
+	r, err := xz.NewReader(rdr)
+	if err != nil {
+		return nil, err
+	}
+	r.DictCap = int(x.DictionarySize)
+	err = r.Verify()
+	if err != nil {
+		return nil, err
+	}
+	var buf bytes.Buffer
+	_, err = io.Copy(&buf, r)
+	if err != nil {
+		return nil, err
+	}
+	return buf.Bytes(), nil
+}
+
+//Compress implements compression.Compress
+func (x *Xz) Compress(data []byte) ([]byte, error) {
+	var buf bytes.Buffer
+	w, err := xz.NewWriter(&buf)
+	if err != nil {
+		return nil, err
+	}
+	w.DictCap = int(x.DictionarySize)
+	err = w.Verify()
+	if err != nil {
+		return nil, err
+	}
+	_, err = w.Write(data)
+	if err != nil {
+		return nil, err
+	}
+	w.Close()
+	return buf.Bytes(), nil
+}

internal/compression/zstd.go

@@ -0,0 +1,51 @@
+package compression
+
+import (
+	"bytes"
+	"encoding/binary"
+	"io"
+
+	"github.com/klauspost/compress/zstd"
+)
+
+//Zstd is a zstd compressor/decompressor
+type Zstd struct {
+	CompressionLevel int32
+}
+
+//NewZstdCompressorWithOptions creates a new Zstd with options read from the given reader
+func NewZstdCompressorWithOptions(r io.Reader) (*Zstd, error) {
+	var zstd Zstd
+	err := binary.Read(r, binary.LittleEndian, &zstd)
+	if err != nil {
+		return nil, err
+	}
+	return &zstd, nil
+}
+
+//Decompress decompresses all data from the reader and returns the uncompressed data
+func (z *Zstd) Decompress(r io.Reader) ([]byte, error) {
+	rdr, err := zstd.NewReader(r)
+	if err != nil {
+		return nil, err
+	}
+	defer rdr.Close()
+	var buf bytes.Buffer
+	_, err = io.Copy(&buf, rdr)
+	return buf.Bytes(), err
+}
+
+//Compress impelements compression.Compress
+func (z *Zstd) Compress(data []byte) ([]byte, error) {
+	var buf bytes.Buffer
+	w, err := zstd.NewWriter(&buf, zstd.WithEncoderLevel(zstd.EncoderLevel(z.CompressionLevel)))
+	if err != nil {
+		return nil, err
+	}
+	_, err = w.Write(data)
+	if err != nil {
+		return nil, err
+	}
+	w.Close()
+	return buf.Bytes(), nil
+}

internal/directory/directory.go

@@ -13,8 +13,8 @@ type Header struct {
 	InodeNumber uint32
 }
 
-//EntryInit is the values that can be easily decoded
+//EntryRaw is the values that can be easily decoded
-type EntryInit struct {
+type EntryRaw struct {
 	Offset      uint16
 	InodeOffset int16
 	Type        uint16
@@ -23,19 +23,19 @@ type EntryInit struct {
 
 //Entry is an entry in a directory.
 type Entry struct {
-	Init   EntryInit
+	*Header
 	Name string
-	Header *Header
+	EntryRaw
 }
 
 //NewEntry creates a new directory entry
 func NewEntry(rdr io.Reader) (Entry, error) {
 	var entry Entry
-	err := binary.Read(rdr, binary.LittleEndian, &entry.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &entry.EntryRaw)
 	if err != nil {
 		return Entry{}, err
 	}
-	tmp := make([]byte, entry.Init.NameSize+1)
+	tmp := make([]byte, entry.EntryRaw.NameSize+1)
 	err = binary.Read(rdr, binary.LittleEndian, &tmp)
 	if err != nil {
 		return Entry{}, err
@@ -52,7 +52,7 @@ type Directory struct {
 }
 
 //NewDirectory reads the directory from rdr
-func NewDirectory(base io.Reader, size uint16) (*Directory, error) {
+func NewDirectory(base io.Reader, size uint32) (*Directory, error) {
 	var dir Directory
 	var err error
 	tmp := make([]byte, size)

internal/inode/inodetypes.go

@@ -2,18 +2,18 @@ package inode
 
 import (
 	"encoding/binary"
-	"fmt"
 	"io"
 )
 
+//The different types of inodes as defined by inodetype
 const (
-	BasicDirectoryType = iota + 1
+	DirType = iota + 1
-	BasicFileType
+	FileType
-	BasicSymlinkType
+	SymType
-	BasicBlockDeviceType
+	BlockDevType
-	BasicCharDeviceType
+	CharDevType
-	BasicFifoType
+	FifoType
-	BasicSocketType
+	SocketType
 	ExtDirType
 	ExtFileType
 	ExtSymlinkType
@@ -33,8 +33,8 @@ type Header struct {
 	Number       uint32
 }
 
-//BasicDirectory is self explainatory
+//Dir is self explainatory
-type BasicDirectory struct {
+type Dir struct {
 	DirectoryIndex    uint32
 	HardLinks         uint32
 	DirectorySize     uint16
@@ -42,8 +42,8 @@ type BasicDirectory struct {
 	ParentInodeNumber uint32
 }
 
-//ExtendedDirectoryInit is the information that can be directoy decoded
+//ExtDirInit is the information that can be directoy decoded
-type ExtendedDirectoryInit struct {
+type ExtDirInit struct {
 	HardLinks         uint32
 	DirectorySize     uint32
 	DirectoryIndex    uint32
@@ -53,82 +53,83 @@ type ExtendedDirectoryInit struct {
 	XattrIndex        uint32
 }
 
-//ExtendedDirectory is a directory with extra info
+//ExtDir is a directory with extra info
-type ExtendedDirectory struct {
+type ExtDir struct {
-	Init    ExtendedDirectoryInit
+	Indexes []DirIndex
-	Indexes []DirectoryIndex
+	ExtDirInit
 }
 
 //NewExtendedDirectory creates a new ExtendedDirectory
-func NewExtendedDirectory(rdr io.Reader) (ExtendedDirectory, error) {
+func NewExtendedDirectory(rdr io.Reader) (ExtDir, error) {
-	var inode ExtendedDirectory
+	var inode ExtDir
-	err := binary.Read(rdr, binary.LittleEndian, &inode.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &inode.ExtDirInit)
 	if err != nil {
 		return inode, err
 	}
-	if inode.Init.IndexCount > 0 {
+	for i := uint16(0); i < inode.IndexCount; i++ {
-		inode.Indexes = make([]DirectoryIndex, inode.Init.IndexCount)
+		tmp, err := NewDirectoryIndex(rdr)
-		for i := uint16(0); i < inode.Init.IndexCount; i++ {
-			inode.Indexes[i], err = NewDirectoryIndex(rdr)
 		if err != nil {
-				fmt.Println("Error while reading Directory Index ", i)
 			return inode, err
 		}
-		}
+		inode.Indexes = append(inode.Indexes, tmp)
 	}
 	return inode, err
 }
 
-//DirectoryIndexInit holds the values that can be easily decoded
+//DirIndexInit holds the values that can be easily decoded
-type DirectoryIndexInit struct {
+type DirIndexInit struct {
 	Offset         uint32
 	DirTableOffset uint32
 	NameSize       uint32
 }
 
-//DirectoryIndex is a quick lookup provided by an ExtendedDirectory
+//DirIndex is a quick lookup provided by an ExtendedDirectory
-type DirectoryIndex struct {
+type DirIndex struct {
-	Init DirectoryIndexInit
+	Name string
-	Name []byte
+	DirIndexInit
 }
 
 //NewDirectoryIndex return a new DirectoryIndex
-func NewDirectoryIndex(rdr io.Reader) (DirectoryIndex, error) {
+func NewDirectoryIndex(rdr io.Reader) (DirIndex, error) {
-	var index DirectoryIndex
+	var index DirIndex
-	err := binary.Read(rdr, binary.LittleEndian, &index.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &index.DirIndexInit)
 	if err != nil {
 		return index, err
 	}
-	index.Name = make([]byte, index.Init.NameSize, index.Init.NameSize)
+	tmp := make([]byte, index.NameSize+1, index.NameSize+1)
-	err = binary.Read(rdr, binary.LittleEndian, &index.Name)
+	err = binary.Read(rdr, binary.LittleEndian, &tmp)
+	if err != nil {
 		return index, err
+	}
+	index.Name = string(tmp)
+	return index, nil
 }
 
-//BasicFileInit is the information that can be directoy decoded
+//FileInit is the information that can be directly decoded
-type BasicFileInit struct {
+type FileInit struct {
 	BlockStart     uint32
 	FragmentIndex  uint32
 	FragmentOffset uint32
 	Size           uint32
 }
 
-//BasicFile is self explainatory
+//File is self explainatory
-type BasicFile struct {
+type File struct {
-	Init       BasicFileInit
 	BlockSizes []uint32
 	Fragmented bool
+	FileInit
 }
 
-//NewBasicFile creates a new BasicFile
+//NewFile creates a new File
-func NewBasicFile(rdr io.Reader, blockSize uint32) (BasicFile, error) {
+func NewFile(rdr io.Reader, blockSize uint32) (File, error) {
-	var inode BasicFile
+	var inode File
-	err := binary.Read(rdr, binary.LittleEndian, &inode.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &inode.FileInit)
 	if err != nil {
 		return inode, err
 	}
-	inode.Fragmented = inode.Init.FragmentIndex != 0xFFFFFFFF
+	inode.Fragmented = inode.FragmentIndex != 0xFFFFFFFF
-	blocks := inode.Init.Size / blockSize
+	blocks := inode.Size / blockSize
-	if inode.Init.Size%blockSize > 0 {
+	if inode.Size%blockSize > 0 {
 		blocks++
 	}
 	inode.BlockSizes = make([]uint32, blocks, blocks)
@@ -136,8 +137,8 @@ func NewBasicFile(rdr io.Reader, blockSize uint32) (BasicFile, error) {
 	return inode, err
 }
 
-//ExtendedFileInit is the information that can be directly decoded
+//ExtFileInit is the information that can be directly decoded
-type ExtendedFileInit struct {
+type ExtFileInit struct {
 	BlockStart     uint32
 	Size           uint32
 	Sparse         uint64
@@ -147,23 +148,23 @@ type ExtendedFileInit struct {
 	XattrIndex     uint32
 }
 
-//ExtendedFile is a file with more information
+//ExtFile is a file with more information
-type ExtendedFile struct {
+type ExtFile struct {
-	Init       ExtendedFileInit
 	BlockSizes []uint32
 	Fragmented bool
+	ExtFileInit
 }
 
 //NewExtendedFile creates a new ExtendedFile
-func NewExtendedFile(rdr io.Reader, blockSize uint32) (ExtendedFile, error) {
+func NewExtendedFile(rdr io.Reader, blockSize uint32) (ExtFile, error) {
-	var inode ExtendedFile
+	var inode ExtFile
-	err := binary.Read(rdr, binary.LittleEndian, &inode.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &inode.ExtFileInit)
 	if err != nil {
 		return inode, err
 	}
-	inode.Fragmented = inode.Init.FragmentIndex != 0xFFFFFFFF
+	inode.Fragmented = inode.FragmentIndex != 0xFFFFFFFF
-	blocks := inode.Init.Size / blockSize
+	blocks := inode.Size / blockSize
-	if inode.Init.Size%blockSize > 0 {
+	if inode.Size%blockSize > 0 {
 		blocks++
 	}
 	inode.BlockSizes = make([]uint32, blocks, blocks)
@@ -171,74 +172,85 @@ func NewExtendedFile(rdr io.Reader, blockSize uint32) (ExtendedFile, error) {
 	return inode, err
 }
 
-//BasicSymlinkInit is all the values that can be directly decoded
+//SymInit is all the values that can be directly decoded
-type BasicSymlinkInit struct {
+type SymInit struct {
 	HardLinks      uint32
 	TargetPathSize uint32
 }
 
-//BasicSymlink is a symlink
+//Sym is a symlink
-type BasicSymlink struct {
+type Sym struct {
-	Init       BasicSymlinkInit
+	Path       string
 	targetPath []byte //len is TargetPathSize
+	SymInit
 }
 
-//NewBasicSymlink creates a new BasicSymlink
+//NewSymlink creates a new Symlink
-func NewBasicSymlink(rdr io.Reader) (BasicSymlink, error) {
+func NewSymlink(rdr io.Reader) (Sym, error) {
-	var inode BasicSymlink
+	var inode Sym
-	err := binary.Read(rdr, binary.LittleEndian, &inode.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &inode.SymInit)
 	if err != nil {
 		return inode, err
 	}
-	inode.targetPath = make([]byte, inode.Init.TargetPathSize, inode.Init.TargetPathSize)
+	inode.targetPath = make([]byte, inode.TargetPathSize, inode.TargetPathSize)
 	err = binary.Read(rdr, binary.LittleEndian, &inode.targetPath)
+	if err != nil {
+		return inode, err
+	}
+	inode.Path = string(inode.targetPath)
 	return inode, err
 }
 
-//ExtendedSymlinkInit is all the values that can be directly decoded
+//ExtSymInit is all the values that can be directly decoded
-type ExtendedSymlinkInit struct {
+type ExtSymInit struct {
 	HardLinks      uint32
 	TargetPathSize uint32
 }
 
-//ExtendedSymlink is a symlink with extra information
+//ExtSym is a symlink with extra information
-type ExtendedSymlink struct {
+type ExtSym struct {
-	Init       ExtendedSymlinkInit
+	Path       string
-	TargetPath []uint8
+	targetPath []uint8
+	ExtSymInit
 	XattrIndex uint32
 }
 
 //NewExtendedSymlink creates a new ExtendedSymlink
-func NewExtendedSymlink(rdr io.Reader) (ExtendedSymlink, error) {
+func NewExtendedSymlink(rdr io.Reader) (ExtSym, error) {
-	var inode ExtendedSymlink
+	var inode ExtSym
-	err := binary.Read(rdr, binary.LittleEndian, &inode.Init)
+	err := binary.Read(rdr, binary.LittleEndian, &inode.ExtSymInit)
 	if err != nil {
 		return inode, err
 	}
-	inode.TargetPath = make([]uint8, inode.Init.TargetPathSize, inode.Init.TargetPathSize)
+	inode.targetPath = make([]uint8, inode.TargetPathSize, inode.TargetPathSize)
+	err = binary.Read(rdr, binary.LittleEndian, &inode.targetPath)
+	if err != nil {
+		return inode, err
+	}
+	inode.Path = string(inode.targetPath)
 	err = binary.Read(rdr, binary.LittleEndian, &inode.XattrIndex)
 	return inode, err
 }
 
-//BasicDevice is a device
+//Device is a device
-type BasicDevice struct {
+type Device struct {
 	HardLinks uint32
 	Device    uint32
 }
 
-//ExtendedDevice is a device with more info
+//ExtDevice is a device with more info
-type ExtendedDevice struct {
+type ExtDevice struct {
-	BasicDevice
+	Device
 	XattrIndex uint32
 }
 
-//BasicIPC is a Fifo or Socket device
+//IPC is a Fifo or Socket device
-type BasicIPC struct {
+type IPC struct {
 	HardLink uint32
 }
 
-//ExtendedIPC is a IPC device with extra info
+//ExtIPC is a IPC device with extra info
-type ExtendedIPC struct {
+type ExtIPC struct {
-	BasicIPC
+	IPC
 	XattrIndex uint32
 }

internal/inode/process.go

@@ -9,9 +9,9 @@ import (
 //
 //Info holds the actual Inode. Due to each inode type being a different type, it's store as an interface{}
 type Inode struct {
-	Header Header
-	Type   int         //Type the inode type defined in the header. Here so it's easy to access
 	Info interface{} //Info is the parsed specific data. It's type is defined by Type.
+	Type int         //Type the inode type defined in the header. Here so it's easy to access
+	Header
 }
 
 //ProcessInode tries to read an inode from the BlockReader
@@ -23,48 +23,48 @@ func ProcessInode(br io.Reader, blockSize uint32) (*Inode, error) {
 	}
 	var info interface{}
 	switch head.InodeType {
-	case BasicDirectoryType:
+	case DirType:
-		var inode BasicDirectory
+		var inode Dir
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicFileType:
+	case FileType:
-		inode, err := NewBasicFile(br, blockSize)
+		inode, err := NewFile(br, blockSize)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicSymlinkType:
+	case SymType:
-		inode, err := NewBasicSymlink(br)
+		inode, err := NewSymlink(br)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicBlockDeviceType:
+	case BlockDevType:
-		var inode BasicDevice
+		var inode Device
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicCharDeviceType:
+	case CharDevType:
-		var inode BasicDevice
+		var inode Device
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicFifoType:
+	case FifoType:
-		var inode BasicIPC
+		var inode IPC
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
-	case BasicSocketType:
+	case SocketType:
-		var inode BasicIPC
+		var inode IPC
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
@@ -89,28 +89,28 @@ func ProcessInode(br io.Reader, blockSize uint32) (*Inode, error) {
 		}
 		info = inode
 	case ExtBlockDeviceType:
-		var inode ExtendedDevice
+		var inode ExtDevice
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
 	case ExtCharDeviceType:
-		var inode ExtendedDevice
+		var inode ExtDevice
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
 	case ExtFifoType:
-		var inode ExtendedIPC
+		var inode ExtIPC
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err
 		}
 		info = inode
 	case ExtSocketType:
-		var inode ExtendedIPC
+		var inode ExtIPC
 		err = binary.Read(br, binary.LittleEndian, &inode)
 		if err != nil {
 			return nil, err

metadata.go

@@ -16,9 +16,9 @@ type metadata struct {
 //MetadataReader is a block reader for metadata. It will automatically read the next block, when it reaches the end of a block.
 type metadataReader struct {
 	s          *Reader
-	offset     int64
 	headers    []*metadata
 	data       []byte
+	offset     int64
 	readOffset int
 }
 
@@ -52,6 +52,17 @@ func (s *Reader) newMetadataReaderFromInodeRef(ref uint64) (*metadataReader, err
 	return br, nil
 }
 
+//ProcessInodeRef processes an inode reference and returns two values
+//
+//The first value is the inode table offset. AKA, it's where the metadata block of the inode STARTS relative to the inode table.
+//
+//The second value is the offset of the inode, INSIDE of the metadata.
+func processInodeRef(inodeRef uint64) (tableOffset uint64, metaOffset uint64) {
+	tableOffset = inodeRef >> 16
+	metaOffset = inodeRef &^ 0xFFFFFFFF0000
+	return
+}
+
 func (br *metadataReader) parseMetadata() error {
 	var raw uint16
 	err := binary.Read(io.NewSectionReader(br.s.r, br.offset, 2), binary.LittleEndian, &raw)
@@ -59,7 +70,7 @@ func (br *metadataReader) parseMetadata() error {
 		return err
 	}
 	br.offset += 2
-	compressed := !(raw&0x8000 == 0x8000)
+	compressed := raw&0x8000 != 0x8000
 	size := raw &^ 0x8000
 	br.headers = append(br.headers, &metadata{
 		raw:        raw,
@@ -93,7 +104,7 @@ func (br *metadataReader) readNextDataBlock() error {
 
 //Read reads bytes into the given byte slice. Returns the amount of data read.
 func (br *metadataReader) Read(p []byte) (int, error) {
-	if br.readOffset+len(p) < len(br.data) {
+	if br.readOffset+len(p) <= len(br.data) {
 		for i := 0; i < len(p); i++ {
 			p[i] = br.data[br.readOffset+i]
 		}

reader.go

@@ -5,7 +5,9 @@ import (
 	"errors"
 	"io"
 	"math"
+	"time"
 
+	"github.com/CalebQ42/squashfs/internal/compression"
 	"github.com/CalebQ42/squashfs/internal/inode"
 )
 
@@ -15,28 +17,29 @@ const (
 
 var (
 	//ErrNoMagic is returned if the magic number in the superblock isn't correct.
-	ErrNoMagic = errors.New("Magic number doesn't match. Either isn't a squashfs or corrupted")
+	errNoMagic = errors.New("Magic number doesn't match. Either isn't a squashfs or corrupted")
 	//ErrIncompatibleCompression is returned if the compression type in the superblock doesn't work.
-	ErrIncompatibleCompression = errors.New("Compression type unsupported")
+	errIncompatibleCompression = errors.New("Compression type unsupported")
 	//ErrCompressorOptions is returned if compressor options is present. It's not currently supported.
-	ErrCompressorOptions = errors.New("Compressor options is not currently supported")
+	errCompressorOptions = errors.New("Compressor options is not currently supported")
-	//ErrFragmentTableIssues is returned if there's trouble reading the fragment table when creating a reader.
+	//ErrOptions is returned when compression options that I haven't tested is set. When this is returned, the Reader is also returned.
-	//When this is returned, the reader is still returned.
+	ErrOptions = errors.New("Possibly incompatible compressor options")
-	ErrFragmentTableIssues = errors.New("Trouble while reading the fragment table")
 )
 
 //Reader processes and reads a squashfs archive.
-//TODO: Give a way to actually read files :P
 type Reader struct {
 	r            io.ReaderAt
+	decompressor compression.Decompressor
+	root         *File
+	fragOffsets  []uint64
+	idTable      []uint32
 	super        superblock
 	flags        superblockFlags
-	decompressor decompressor
-	fragOffsets  []uint64
 }
 
 //NewSquashfsReader returns a new squashfs.Reader from an io.ReaderAt
 func NewSquashfsReader(r io.ReaderAt) (*Reader, error) {
+	hasUnsupportedOptions := false
 	var rdr Reader
 	rdr.r = r
 	err := binary.Read(io.NewSectionReader(rdr.r, 0, int64(binary.Size(rdr.super))), binary.LittleEndian, &rdr.super)
@@ -44,20 +47,69 @@ func NewSquashfsReader(r io.ReaderAt) (*Reader, error) {
 		return nil, err
 	}
 	if rdr.super.Magic != magic {
-		return nil, ErrNoMagic
+		return nil, errNoMagic
 	}
+	// if rdr.super.BlockLog == uint16(math.Log2(float64(rdr.super.BlockSize))) {
+	// 	return nil, errors.New("BlockSize and BlockLog doesn't match. The archive is probably corrupt")
+	// }
 	rdr.flags = rdr.super.GetFlags()
-	switch rdr.super.CompressionType {
-	case gzipCompression:
-		rdr.decompressor = &zlibDecompressor{}
-	default:
-		return nil, ErrIncompatibleCompression
-	}
 	if rdr.flags.CompressorOptions {
-		//TODO: parse compressor options
+		switch rdr.super.CompressionType {
-		return nil, ErrCompressorOptions
+		case GzipCompression:
+			var gzip *compression.Gzip
+			gzip, err = compression.NewGzipCompressorWithOptions(io.NewSectionReader(rdr.r, int64(binary.Size(rdr.super)), 8))
+			if err != nil {
+				return nil, err
 			}
-	fragBlocks := int(math.Ceil(float64(rdr.super.FragCount) / 512.0))
+			if gzip.HasCustomWindow || gzip.HasStrategies {
+				hasUnsupportedOptions = true
+			}
+			rdr.decompressor = gzip
+		case XzCompression:
+			var xz *compression.Xz
+			xz, err = compression.NewXzCompressorWithOptions(io.NewSectionReader(rdr.r, int64(binary.Size(rdr.super)), 8))
+			if err != nil {
+				return nil, err
+			}
+			if xz.HasFilters {
+				return nil, errors.New("XZ compression options has filters. These are not yet supported")
+			}
+			rdr.decompressor = xz
+		case Lz4Compression:
+			var lz4 *compression.Lz4
+			lz4, err = compression.NewLz4CompressorWithOptions(io.NewSectionReader(rdr.r, int64(binary.Size(rdr.super)), 8))
+			if err != nil {
+				return nil, err
+			}
+			rdr.decompressor = lz4
+		case ZstdCompression:
+			var zstd *compression.Zstd
+			zstd, err = compression.NewZstdCompressorWithOptions(io.NewSectionReader(rdr.r, int64(binary.Size(rdr.super)), 4))
+			if err != nil {
+				return nil, err
+			}
+			rdr.decompressor = zstd
+		default:
+			return nil, errIncompatibleCompression
+		}
+	} else {
+		switch rdr.super.CompressionType {
+		case GzipCompression:
+			rdr.decompressor = &compression.Gzip{}
+		case LzmaCompression:
+			rdr.decompressor = &compression.Lzma{}
+		case XzCompression:
+			rdr.decompressor = &compression.Xz{}
+		case Lz4Compression:
+			rdr.decompressor = &compression.Lz4{}
+		case ZstdCompression:
+			rdr.decompressor = &compression.Zstd{}
+		default:
+			//TODO: all compression types.
+			return nil, errIncompatibleCompression
+		}
+	}
+	fragBlocks := int(math.Ceil(float64(rdr.super.FragCount) / 512))
 	if fragBlocks > 0 {
 		offset := int64(rdr.super.FragTableStart)
 		for i := 0; i < fragBlocks; i++ {
@@ -70,53 +122,152 @@ func NewSquashfsReader(r io.ReaderAt) (*Reader, error) {
 			offset += 8
 		}
 	}
+	unread := rdr.super.IDCount
+	blockOffsets := make([]uint64, int(math.Ceil(float64(rdr.super.IDCount)/2048)))
+	for i := range blockOffsets {
+		secRdr := io.NewSectionReader(r, int64(rdr.super.IDTableStart)+(8*int64(i)), 8)
+		err = binary.Read(secRdr, binary.LittleEndian, &blockOffsets[i])
+		if err != nil {
+			return nil, err
+		}
+		idRdr, err := rdr.newMetadataReader(int64(blockOffsets[i]))
+		if err != nil {
+			return nil, err
+		}
+		read := uint16(math.Min(float64(unread), 2048))
+		for i := uint16(0); i < read; i++ {
+			var tmp uint32
+			err = binary.Read(idRdr, binary.LittleEndian, &tmp)
+			if err != nil {
+				return nil, err
+			}
+			rdr.idTable = append(rdr.idTable, tmp)
+		}
+		unread -= read
+	}
+	if hasUnsupportedOptions {
+		return &rdr, ErrOptions
+	}
 	return &rdr, nil
 }
 
-//GetFilesList returns a list of ALL files in the squashfs, going down every folder.
+//ModTime is the last time the file was modified/created.
-//Folders end in /
+func (r *Reader) ModTime() time.Time {
-func (r *Reader) GetFilesList() ([]string, error) {
+	return time.Unix(int64(r.super.CreationTime), 0)
-	inoderdr, err := r.newMetadataReaderFromInodeRef(r.super.RootInodeRef)
-	if err != nil {
-		return nil, err
-	}
-	i, err := inode.ProcessInode(inoderdr, r.super.BlockSize)
-	if err != nil {
-		return nil, err
-	}
-	paths, err := r.readDir(i)
-	if err != nil {
-		return nil, err
-	}
-	return paths, nil
 }
 
-//readDir returns a list of all decendents of a given inode. Inode given MUST be a directory type.
+//ExtractTo tries to extract ALL files to the given path. This is the same as getting the root folder and extracting that.
-func (r *Reader) readDir(i *inode.Inode) (paths []string, err error) {
+func (r *Reader) ExtractTo(path string) []error {
-	dir, err := r.readDirFromInode(i)
+	if r.root == nil {
+		_, err := r.GetRootFolder()
 		if err != nil {
-		return
+			return []error{err}
 		}
-	for _, entry := range dir.Entries {
+	}
-		if entry.Init.Type == inode.BasicDirectoryType {
+	return r.root.ExtractTo(path)
-			paths = append(paths)
+}
-			i, err = r.getInodeFromEntry(&entry)
+
+//GetRootFolder returns a squashfs.File that references the root directory of the squashfs archive.
+func (r *Reader) GetRootFolder() (*File, error) {
+	if r.root != nil {
+		return r.root, nil
+	}
+	mr, err := r.newMetadataReaderFromInodeRef(r.super.RootInodeRef)
 	if err != nil {
-				return
+		return nil, err
 	}
-			var subPaths []string
+	var root File
-			subPaths, err = r.readDir(i)
+	root.in, err = inode.ProcessInode(mr, r.super.BlockSize)
 	if err != nil {
-				return
+		return nil, err
 	}
-			for pathI := range subPaths {
+	root.dir = "/"
-				subPaths[pathI] = entry.Name + "/" + subPaths[pathI]
+	root.filType = root.in.Type
+	root.r = r
+	r.root = &root
+	return r.root, nil
+}
+
+//GetAllFiles returns a slice of ALL files and folders contained in the squashfs.
+func (r *Reader) GetAllFiles() (fils []*File, err error) {
+	if r.root == nil {
+		_, err := r.GetRootFolder()
+		if err != nil {
+			return nil, err
 		}
-			paths = append(paths, entry.Name+"/")
+	}
-			paths = append(paths, subPaths...)
+	return r.root.GetChildrenRecursively()
-		} else {
+}
-			paths = append(paths, entry.Name)
+
+//FindFile returns the first file (in the same order as Reader.GetAllFiles) that the given function returns true for. Returns nil if nothing is found.
+func (r *Reader) FindFile(query func(*File) bool) *File {
+	if r.root == nil {
+		_, err := r.GetRootFolder()
+		if err != nil {
+			return nil
+		}
+	}
+	fils, err := r.root.GetChildren()
+	if err != nil {
+		return nil
+	}
+	var childrenDirs []*File
+	for _, fil := range fils {
+		if query(fil) {
+			return fil
+		}
+		if fil.IsDir() {
+			childrenDirs = append(childrenDirs, fil)
+		}
+	}
+	for len(childrenDirs) != 0 {
+		var tmp []*File
+		for _, dirs := range childrenDirs {
+			chil, err := dirs.GetChildren()
+			if err != nil {
+				return nil
+			}
+			for _, child := range chil {
+				if query(child) {
+					return child
+				}
+				if child.IsDir() {
+					tmp = append(tmp, child)
+				}
+			}
+		}
+		childrenDirs = tmp
+	}
+	return nil
+}
+
+//FindAll returns all files where the given function returns true.
+func (r *Reader) FindAll(query func(*File) bool) (all []*File) {
+	if r.root == nil {
+		_, err := r.GetRootFolder()
+		if err != nil {
+			return nil
+		}
+	}
+	fils, err := r.root.GetChildrenRecursively()
+	if err != nil {
+		return nil
+	}
+	for _, fil := range fils {
+		if query(fil) {
+			all = append(all, fil)
 		}
 	}
 	return
 }
+
+//GetFileAtPath will return the file at the given path. If the file cannot be found, will return nil.
+func (r *Reader) GetFileAtPath(filepath string) *File {
+	if r.root == nil {
+		_, err := r.GetRootFolder()
+		if err != nil {
+			return nil
+		}
+	}
+	return r.root.GetFileAtPath(filepath)
+}

reader_test.go

@@ -0,0 +1,232 @@
+package squashfs
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"os/exec"
+	"strconv"
+	"testing"
+	"time"
+
+	goappimage "github.com/CalebQ42/GoAppImage"
+)
+
+const (
+	downloadURL  = "https://github.com/srevinsaju/Firefox-Appimage/releases/download/firefox-v84.0.r20201221152838/firefox-84.0.r20201221152838-x86_64.AppImage"
+	appImageName = "firefox-84.0.r20201221152838-x86_64.AppImage"
+	squashfsName = "balenaEtcher-1.5.113-x64.AppImage.sfs"
+)
+
+func TestSquashfs(t *testing.T) {
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+	squashFil, err := os.Open(wd + "/testing/" + squashfsName)
+	if err != nil {
+		t.Fatal(err)
+	}
+	rdr, err := NewSquashfsReader(squashFil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	fmt.Println("stuff", rdr.super.CompressionType)
+	fil := rdr.GetFileAtPath("*.desktop")
+	if fil == nil {
+		t.Fatal("Can't find desktop fil")
+	}
+	errs := fil.ExtractTo(wd + "/testing")
+	if len(errs) > 0 {
+		t.Fatal(errs)
+	}
+	errs = rdr.ExtractTo(wd + "/testing/" + squashfsName + ".d")
+	if len(errs) > 0 {
+		t.Fatal(errs)
+	}
+	t.Fatal("No Problems")
+}
+
+func TestAppImage(t *testing.T) {
+	t.Parallel()
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+	aiFil, err := os.Open(wd + "/testing/" + appImageName)
+	if os.IsNotExist(err) {
+		err = downloadTestAppImage(wd + "/testing")
+		if err != nil {
+			t.Fatal(err)
+		}
+		aiFil, err = os.Open(wd + "/testing/" + appImageName)
+		if err != nil {
+			t.Fatal(err)
+		}
+	} else if err != nil {
+		t.Fatal(err)
+	}
+	defer aiFil.Close()
+	stat, _ := aiFil.Stat()
+	os.RemoveAll(wd + "/testing/firefox")
+	ai := goappimage.NewAppImage(wd + "/testing/" + appImageName)
+	start := time.Now()
+	rdr, err := NewSquashfsReader(io.NewSectionReader(aiFil, ai.Offset, stat.Size()-ai.Offset))
+	if err != nil {
+		t.Fatal(err)
+	}
+	rt := rdr.GetFileAtPath("/")
+	fils, err := rt.GetChildrenRecursively()
+	if err != nil {
+		t.Fatal(err)
+	}
+	for _, fil := range fils {
+		fmt.Println(fil.Path())
+	}
+	fmt.Println(time.Since(start))
+	t.Fatal("No problemo!")
+}
+
+func TestUnsquashfs(t *testing.T) {
+	t.Parallel()
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+	aiFil, err := os.Open(wd + "/testing/" + appImageName)
+	if os.IsNotExist(err) {
+		err = downloadTestAppImage(wd + "/testing")
+		if err != nil {
+			t.Fatal(err)
+		}
+		aiFil, err = os.Open(wd + "/testing/" + appImageName)
+		if err != nil {
+			t.Fatal(err)
+		}
+	} else if err != nil {
+		t.Fatal(err)
+	}
+	os.RemoveAll(wd + "/testing/unsquashFirefox")
+	os.RemoveAll(wd + "/testing/firefox")
+	ai := goappimage.NewAppImage(wd + "/testing/" + appImageName)
+	fmt.Println("Command:", "unsquashfs", "-d", wd+"/testing/unsquashFirefox", "-o", strconv.Itoa(int(ai.Offset)), aiFil.Name())
+	cmd := exec.Command("unsquashfs", "-d", wd+"/testing/unsquashFirefox", "-o", strconv.Itoa(int(ai.Offset)), aiFil.Name())
+	start := time.Now()
+	err = cmd.Run()
+	if err != nil {
+		t.Fatal(err)
+	}
+	fmt.Println(time.Since(start))
+	t.Fatal("HI")
+}
+
+func BenchmarkDragRace(b *testing.B) {
+	wd, err := os.Getwd()
+	if err != nil {
+		b.Fatal(err)
+	}
+	aiFil, err := os.Open(wd + "/testing/" + appImageName)
+	if os.IsNotExist(err) {
+		err = downloadTestAppImage(wd + "/testing")
+		if err != nil {
+			b.Fatal(err)
+		}
+		aiFil, err = os.Open(wd + "/testing/" + appImageName)
+		if err != nil {
+			b.Fatal(err)
+		}
+	} else if err != nil {
+		b.Fatal(err)
+	}
+	stat, _ := aiFil.Stat()
+	ai := goappimage.NewAppImage(wd + "/testing/" + appImageName)
+	os.RemoveAll(wd + "/testing/unsquashFirefox")
+	os.RemoveAll(wd + "/testing/firefox")
+	cmd := exec.Command("unsquashfs", "-d", wd+"/testing/unsquashFirefox", "-o", strconv.Itoa(int(ai.Offset)), aiFil.Name())
+	start := time.Now()
+	err = cmd.Run()
+	if err != nil {
+		b.Fatal(err)
+	}
+	unsquashTime := time.Since(start)
+	start = time.Now()
+	rdr, err := NewSquashfsReader(io.NewSectionReader(aiFil, ai.Offset, stat.Size()-ai.Offset))
+	if err != nil {
+		b.Fatal(err)
+	}
+	errs := rdr.ExtractTo(wd + "/testing/firefox")
+	if len(errs) > 0 {
+		b.Fatal(errs)
+	}
+	libTime := time.Since(start)
+	b.Log("Unsqushfs:", unsquashTime.Round(time.Millisecond))
+	b.Log("Library:", libTime.Round(time.Millisecond))
+	b.Log("unsquashfs is " + strconv.FormatFloat(float64(libTime.Milliseconds())/float64(unsquashTime.Milliseconds()), 'f', 2, 64) + "x faster")
+}
+
+func downloadTestAppImage(dir string) error {
+	//seems to time out on slow connections. Might fix that at some point... or not. It's just a test...
+	os.Mkdir(dir, os.ModePerm)
+	appImage, err := os.Create(dir + "/" + appImageName)
+	if err != nil {
+		return err
+	}
+	defer appImage.Close()
+	check := http.Client{
+		CheckRedirect: func(r *http.Request, _ []*http.Request) error {
+			r.URL.Opaque = r.URL.Path
+			return nil
+		},
+	}
+	resp, err := check.Get(downloadURL)
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+	_, err = io.Copy(appImage, resp.Body)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func TestCreateSquashFromAppImage(t *testing.T) {
+	wd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = os.Mkdir(wd+"/testing", 0777)
+	if err != nil && !os.IsExist(err) {
+		t.Fatal(err)
+	}
+	_, err = os.Open(wd + "/testing/" + appImageName)
+	if os.IsNotExist(err) {
+		err = downloadTestAppImage(wd + "/testing")
+		if err != nil {
+			t.Fatal(err)
+		}
+		_, err = os.Open(wd + "/testing/" + appImageName)
+		if err != nil {
+			t.Fatal(err)
+		}
+	} else if err != nil {
+		t.Fatal(err)
+	}
+	ai := goappimage.NewAppImage(wd + "/testing/" + appImageName)
+	aiFil, err := os.Open(wd + "/testing/" + appImageName)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer aiFil.Close()
+	aiFil.Seek(ai.Offset, 0)
+	os.Remove(wd + "/testing/" + appImageName + ".squashfs")
+	aiSquash, err := os.Create(wd + "/testing/" + appImageName + ".squashfs")
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = io.Copy(aiSquash, aiFil)
+	if err != nil {
+		t.Fatal(err)
+	}
+}

squash_test.go

@@ -1,116 +0,0 @@
-package squashfs
-
-import (
-	"io"
-	"net/http"
-	"os"
-	"testing"
-
-	goappimage "github.com/CalebQ42/GoAppImage"
-)
-
-const (
-	downloadURL  = "https://github.com/zilti/code-oss.AppImage/releases/download/continuous/Code_OSS-x86_64.AppImage"
-	appImageName = "Code_OSS.AppImage"
-	squashfsName = "Code_OSS.Squashfs"
-)
-
-func TestMain(t *testing.T) {
-	t.Parallel()
-	wd, err := os.Getwd()
-	if err != nil {
-		t.Fatal(err)
-	}
-	squashFil, err := os.Open(wd + "/testing/" + squashfsName)
-	if os.IsNotExist(err) {
-		TestCreateSquashFromAppImage(t)
-		squashFil, err = os.Open(wd + "/testing/" + squashfsName)
-		if err != nil {
-			t.Fatal(err)
-		}
-	}
-	defer squashFil.Close()
-	stat, _ := squashFil.Stat()
-	rdr, err := NewSquashfsReader(io.NewSectionReader(squashFil, 0, stat.Size()))
-	if err != nil {
-		t.Fatal(err)
-	}
-	//testing code to print out the directory structure
-	// rdr.GetFileStructure()
-	extractionFil := "code-oss.desktop"
-	os.Remove(wd + "/testing/" + extractionFil)
-	desk, err := os.Create(wd + "/testing/" + extractionFil)
-	if err != nil {
-		t.Fatal(err)
-	}
-	ext, err := rdr.ReadFile(extractionFil)
-	if err != nil {
-		t.Fatal(err)
-	}
-	_, err = io.Copy(desk, ext)
-	if err != nil {
-		t.Fatal(err)
-	}
-	t.Fatal("No problems here!")
-}
-
-func TestCreateSquashFromAppImage(t *testing.T) {
-	wd, err := os.Getwd()
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = os.Mkdir(wd+"/testing", 0777)
-	if err != nil && !os.IsExist(err) {
-		t.Fatal(err)
-	}
-	_, err = os.Open(wd + "/testing/" + appImageName)
-	if os.IsNotExist(err) {
-		downloadTestAppImage(t, wd+"/testing")
-		_, err = os.Open(wd + "/testing/" + appImageName)
-		if err != nil {
-			t.Fatal(err)
-		}
-	} else if err != nil {
-		t.Fatal(err)
-	}
-	ai := goappimage.NewAppImage(wd + "/testing/" + appImageName)
-	aiFil, err := os.Open(wd + "/testing/" + appImageName)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer aiFil.Close()
-	aiFil.Seek(ai.Offset, 0)
-	os.Remove(wd + "/testing/" + squashfsName)
-	aiSquash, err := os.Create(wd + "/testing/" + squashfsName)
-	if err != nil {
-		t.Fatal(err)
-	}
-	_, err = io.Copy(aiSquash, aiFil)
-	if err != nil {
-		t.Fatal(err)
-	}
-}
-
-func downloadTestAppImage(t *testing.T, dir string) {
-	//seems to time out. Need to fix that at some point
-	appImage, err := os.Create(dir + "/" + appImageName)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer appImage.Close()
-	check := http.Client{
-		CheckRedirect: func(r *http.Request, via []*http.Request) error {
-			r.URL.Opaque = r.URL.Path
-			return nil
-		},
-	}
-	resp, err := check.Get(downloadURL)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer resp.Body.Close()
-	_, err = io.Copy(appImage, resp.Body)
-	if err != nil {
-		t.Fatal(err)
-	}
-}

superblock.go

@@ -1,12 +1,13 @@
 package squashfs
 
+//The types of compression supported by squashfs.
 const (
-	gzipCompression = 1 + iota
+	GzipCompression = 1 + iota
-	lzmaCompression
+	LzmaCompression
-	lzoCompression
+	LzoCompression
-	xzCompression
+	XzCompression
-	lz4Compression
+	Lz4Compression
-	zstdCompression
+	ZstdCompression
 )
 
 //Superblock contains important information about a squashfs file. Located at the very front of the archive.

utils.go

@@ -1,119 +0,0 @@
-package squashfs
-
-import (
-	"errors"
-	"io"
-	"strings"
-
-	"github.com/CalebQ42/squashfs/internal/directory"
-	"github.com/CalebQ42/squashfs/internal/inode"
-)
-
-var (
-	//ErrNotFound means that the given path is NOT present in the archive
-	ErrNotFound = errors.New("Path not found")
-)
-
-//ProcessInodeRef processes an inode reference and returns two values
-//
-//The first value is the inode table offset. AKA, it's where the metadata block of the inode STARTS relative to the inode table.
-//
-//The second value is the offset of the inode, INSIDE of the metadata.
-func processInodeRef(inodeRef uint64) (tableOffset uint64, metaOffset uint64) {
-	tableOffset = inodeRef >> 16
-	metaOffset = inodeRef &^ 0xFFFFFFFF0000
-	return
-}
-
-//ReadDirFromInode returns a fully populated directory.Directory from a given inode.Inode.
-//If the given inode is not a directory it returns an error.
-func (r *Reader) readDirFromInode(i *inode.Inode) (*directory.Directory, error) {
-	var offset uint32
-	var metaOffset uint16
-	var size uint16
-	switch i.Type {
-	case inode.BasicDirectoryType:
-		offset = i.Info.(inode.BasicDirectory).DirectoryIndex
-		metaOffset = i.Info.(inode.BasicDirectory).DirectoryOffset
-		size = i.Info.(inode.BasicDirectory).DirectorySize
-	case inode.ExtDirType:
-		offset = i.Info.(inode.ExtendedDirectory).Init.DirectoryIndex
-		metaOffset = i.Info.(inode.ExtendedDirectory).Init.DirectoryOffset
-		size = uint16(i.Info.(inode.ExtendedDirectory).Init.DirectorySize)
-	default:
-		return nil, errors.New("Not a directory inode")
-	}
-	br, err := r.newMetadataReader(int64(r.super.DirTableStart + uint64(offset)))
-	if err != nil {
-		return nil, err
-	}
-	_, err = br.Seek(int64(metaOffset), io.SeekStart)
-	if err != nil {
-		return nil, err
-	}
-	dir, err := directory.NewDirectory(br, size)
-	if err != nil {
-		return dir, err
-	}
-	return dir, nil
-}
-
-//GetInodeFromEntry returns the inode associated with a given directory.Entry
-func (r *Reader) getInodeFromEntry(en *directory.Entry) (*inode.Inode, error) {
-	br, err := r.newMetadataReader(int64(r.super.InodeTableStart + uint64(en.Header.InodeOffset)))
-	if err != nil {
-		return nil, err
-	}
-	_, err = br.Seek(int64(en.Init.Offset), io.SeekStart)
-	if err != nil {
-		return nil, err
-	}
-	i, err := inode.ProcessInode(br, r.super.BlockSize)
-	if err != nil {
-		return nil, err
-	}
-	return i, nil
-}
-
-//GetInodeFromPath returns the inode at the given path, relative to root.
-//The given path can start with or without "/"
-func (r *Reader) getInodeFromPath(path string) (*inode.Inode, error) {
-	path = strings.TrimSuffix(strings.TrimPrefix(path, "/"), "/")
-	pathDirs := strings.Split(path, "/")
-	rdr, err := r.newMetadataReaderFromInodeRef(r.super.RootInodeRef)
-	if err != nil {
-		return nil, err
-	}
-	curInodeDir, err := inode.ProcessInode(rdr, r.super.BlockSize)
-	if err != nil {
-		return nil, err
-	}
-	if path == "" {
-		return curInodeDir, nil
-	}
-	for depth := 0; depth < len(pathDirs); depth++ {
-		if curInodeDir.Type != inode.BasicDirectoryType && curInodeDir.Type != inode.ExtDirType {
-			return nil, ErrNotFound
-		}
-		dir, err := r.readDirFromInode(curInodeDir)
-		if err != nil {
-			return nil, err
-		}
-		for _, entry := range dir.Entries {
-			if entry.Name == pathDirs[depth] {
-				if depth == len(pathDirs)-1 {
-					in, err := r.getInodeFromEntry(&entry)
-					if err != nil {
-						return nil, err
-					}
-					return in, nil
-				}
-				curInodeDir, err = r.getInodeFromEntry(&entry)
-				if err != nil {
-					return nil, err
-				}
-			}
-		}
-	}
-	return nil, ErrNotFound
-}

writer.go

@@ -0,0 +1,326 @@
+package squashfs
+
+import (
+	"errors"
+	"io"
+	"log"
+	"os"
+	"path"
+	"sort"
+	"strings"
+	"syscall"
+
+	"github.com/CalebQ42/squashfs/internal/compression"
+)
+
+type fileHolder struct {
+	reader      io.Reader
+	path        string
+	name        string
+	symLocation string
+	UID         int
+	GUID        int
+	perm        int
+	folder      bool
+	symlink     bool
+}
+
+//Writer is used to creaste squashfs archives. Currently unusable
+//TODO: Make usable
+type Writer struct {
+	compressor      compression.Compressor
+	structure       map[string][]*fileHolder
+	symlinkTable    map[string]string //[oldpath]newpath
+	uidGUIDTable    []int
+	compressionType int
+	Flags           superblockFlags
+	allowErrors     bool
+}
+
+//NewWriter creates a new with the default options (Gzip compression and allow errors)
+func NewWriter() (*Writer, error) {
+	return NewWriterWithOptions(GzipCompression, true)
+}
+
+//NewWriterWithOptions creates a new squashfs.Writer with the given options.
+//compressionType can be of any types, except LZO (which this library doesn't have support for yet)
+//allowErrors determines if, when adding folders, it allows errors encountered with it's sub-directories and instead logs the errors.
+func NewWriterWithOptions(compressionType int, allowErrors bool) (*Writer, error) {
+	if compressionType < 0 || compressionType > 6 {
+		return nil, errors.New("Incorrect compression type")
+	}
+	if compressionType == 3 {
+		return nil, errors.New("LZO compression is not (currently) supported")
+	}
+	return &Writer{
+		structure: map[string][]*fileHolder{
+			"/": make([]*fileHolder, 0),
+		},
+		symlinkTable:    make(map[string]string),
+		compressionType: compressionType,
+		allowErrors:     allowErrors,
+	}, nil
+}
+
+//AddFile attempts to add an os.File to the archive at it's root.
+func (w *Writer) AddFile(file *os.File) error {
+	return w.AddFileToFolder("/", file)
+}
+
+//AddFileToFolder adds the given file to the squashfs archive, placing it inside the given folder.
+func (w *Writer) AddFileToFolder(folder string, file *os.File) error {
+	name := path.Base(file.Name())
+	if !strings.HasSuffix(folder, "/") {
+		folder += "/"
+	}
+	return w.AddFileTo(folder+name, file)
+}
+
+//AddFileTo adds the given file to the squashfs archive at the given filepath.
+func (w *Writer) AddFileTo(filepath string, file *os.File) error {
+	filepath = path.Clean(filepath)
+	if !strings.HasPrefix(filepath, "/") {
+		filepath = "/" + filepath
+	}
+	if w.Contains(filepath) {
+		return errors.New("File already exists at " + filepath)
+	}
+	var holder fileHolder
+	holder.path, holder.name = path.Split(filepath)
+	holder.reader = file
+	stat, err := file.Stat()
+	if err != nil {
+		return err
+	}
+	holder.folder = stat.IsDir()
+	holder.symlink = (stat.Mode()&os.ModeSymlink == os.ModeSymlink)
+	holder.perm = int(stat.Mode().Perm())
+	//Thanks to https://stackoverflow.com/questions/58179647/getting-uid-and-gid-of-a-file for uid and guid getting
+	if stat, ok := stat.Sys().(*syscall.Stat_t); ok {
+		holder.UID = int(stat.Uid)
+		holder.GUID = int(stat.Gid)
+	}
+	if sort.SearchInts(w.uidGUIDTable, holder.UID) == len(w.uidGUIDTable) {
+		w.uidGUIDTable = append(w.uidGUIDTable, holder.UID)
+		sort.Ints(w.uidGUIDTable)
+	}
+	if sort.SearchInts(w.uidGUIDTable, holder.GUID) == len(w.uidGUIDTable) {
+		w.uidGUIDTable = append(w.uidGUIDTable, holder.GUID)
+		sort.Ints(w.uidGUIDTable)
+	}
+	if holder.symlink {
+		target, err := os.Readlink(file.Name())
+		if err != nil {
+			return err
+		}
+		holder.symLocation = target
+	} else if holder.folder {
+		subDirNames, err := file.Readdirnames(-1)
+		if err != nil {
+			return err
+		}
+		dirsAdded := make([]string, 0)
+		for _, subDir := range subDirNames {
+			fil, err := os.Open(file.Name() + subDir)
+			if err != nil {
+				return err
+			}
+			err = w.AddFileToFolder(holder.path+"/"+holder.name, fil)
+			if err != nil && !w.allowErrors {
+				for _, dir := range dirsAdded {
+					w.Remove(dir)
+				}
+				return err
+			} else if err != nil {
+				log.Println("Error while adding", fil.Name())
+				log.Println(err)
+			}
+			if !w.allowErrors {
+				dirsAdded = append(dirsAdded, holder.path+"/"+holder.name)
+			}
+		}
+	} else if !stat.Mode().IsRegular() {
+		return errors.New("Unsupported file type " + file.Name())
+	}
+	w.structure[holder.path] = append(w.structure[holder.path], &holder)
+	return nil
+}
+
+//AddReaderTo adds the data from the given reader to the archive as a file located at the given filepath.
+//Data from the reader is not read until the squashfs archive is writen.
+//If the given reader implements io.Closer, it will be closed after it is fully read.
+func (w *Writer) AddReaderTo(filepath string, reader io.Reader) error {
+	filepath = path.Clean(filepath)
+	if !strings.HasPrefix(filepath, "/") {
+		filepath = "/" + filepath
+	}
+	if w.Contains(filepath) {
+		return errors.New("File already exists at " + filepath)
+	}
+	var holder fileHolder
+	holder.path, holder.name = path.Split(filepath)
+	holder.reader = reader
+	w.structure[holder.path] = append(w.structure[holder.path], &holder)
+	return nil
+}
+
+//Remove tries to remove the file(s) at the given filepath. If wildcards are used, it will remove all files that match.
+//Returns true if one or more files are removed.
+func (w *Writer) Remove(filepath string) bool {
+	var matchFound bool
+	filepath = path.Clean(filepath)
+	if !strings.HasPrefix(filepath, "/") {
+		filepath = "/" + filepath
+	}
+	dir, name := path.Split(filepath)
+	for structDir, files := range w.structure {
+		if match, _ := path.Match(dir, structDir); match {
+			for i, fil := range files {
+				if match, _ = path.Match(name, fil.name); match {
+					matchFound = true
+					if len(w.structure[structDir]) > 1 {
+						w.structure[structDir][i] = w.structure[structDir][len(w.structure[structDir])-1]
+						w.structure[structDir] = w.structure[structDir][:len(w.structure[structDir])-1]
+					} else {
+						w.structure[structDir] = nil
+					}
+				}
+			}
+		}
+	}
+	return matchFound
+}
+
+//FixSymlinks will scan through the squashfs archive and try to find broken symlinks and fix them.
+//This done by replacing the symlink with the target file and then pointing other symlinks to that file.
+//If all symlinks can be resolved, the error slice will be nil, and the bool false, otherwise all errors occured will be in the slice.
+func (w *Writer) FixSymlinks() (errs []error, problems bool) {
+	for dir, holderSlice := range w.structure {
+		for i, holder := range holderSlice {
+			if !holder.symlink {
+				continue
+			}
+			sym := holder.symLocation
+			if !path.IsAbs(holder.symLocation) {
+				sym = path.Join(dir, holder.symLocation)
+			}
+			if path, ok := w.symlinkTable[sym]; ok {
+				w.structure[dir][i].symLocation = path
+				continue
+			}
+			if path.IsAbs(sym) || strings.HasPrefix(sym, "../") {
+				var symFil *os.File
+				var err error
+				if strings.HasPrefix(sym, "../") {
+					holderFil, ok := holder.reader.(*os.File)
+					if !ok {
+						problems = true
+						errs = append(errs, errors.New("Cannot resolve symlink at "+dir+holder.name))
+						continue
+					}
+					symFilPath := path.Dir(holderFil.Name())
+					symFilPath = path.Join(symFilPath, holder.symLocation)
+					symFil, err = os.Open(symFilPath)
+				} else {
+					symFil, err = os.Open(sym)
+				}
+				if err != nil {
+					problems = true
+					errs = append(errs, err)
+					continue
+				}
+				suc := w.Remove(dir + holder.name)
+				if !suc {
+					problems = true
+					errs = append(errs, errors.New("Cannot resolve symlink at "+dir+holder.name))
+					continue
+				}
+				err = w.AddFileTo(dir+holder.name, symFil)
+				if err != nil {
+					w.structure[dir] = append(w.structure[dir], holder)
+					problems = true
+					errs = append(errs, err)
+					continue
+				}
+				w.symlinkTable[sym] = dir + holder.name
+			} else {
+				symHolder := w.holderAt(sym)
+				if symHolder != nil {
+					w.symlinkTable[sym] = sym
+					continue
+				}
+				holderFil, ok := holder.reader.(*os.File)
+				if !ok {
+					problems = true
+					errs = append(errs, errors.New("Cannot resolve symlink at "+dir+holder.name))
+					continue
+				}
+				symFilPath := path.Dir(holderFil.Name())
+				symFilPath = path.Join(symFilPath, holder.symLocation)
+				symFil, err := os.Open(symFilPath)
+				if err != nil {
+					problems = true
+					errs = append(errs, err)
+					continue
+				}
+				err = w.AddFileTo(sym, symFil)
+				if err != nil {
+					problems = true
+					errs = append(errs, err)
+					continue
+				}
+				w.symlinkTable[sym] = sym
+			}
+		}
+	}
+	return
+}
+
+func (w *Writer) holderAt(filepath string) *fileHolder {
+	filepath = path.Clean(filepath)
+	if !strings.HasPrefix(filepath, "/") {
+		filepath = "/" + filepath
+	}
+	dir, name := path.Split(filepath)
+	if holderSlice, ok := w.structure[dir]; ok {
+		for _, holder := range holderSlice {
+			if holder.name == name {
+				return holder
+			}
+		}
+	}
+	return nil
+}
+
+//Contains returns whether a file is present at the given filepath
+func (w *Writer) Contains(filepath string) bool {
+	filepath = path.Clean(filepath)
+	if !strings.HasPrefix(filepath, "/") {
+		filepath = "/" + filepath
+	}
+	dir, name := path.Split(filepath)
+	if holderSlice, ok := w.structure[dir]; ok {
+		for _, holder := range holderSlice {
+			if holder.name == name {
+				return true
+			}
+		}
+	}
+	return false
+}
+
+//WriteToFilename creates the squashfs archive with the given filepath.
+func (w *Writer) WriteToFilename(filepath string) error {
+	newFil, err := os.Create(filepath)
+	if err != nil {
+		return err
+	}
+	_, err = w.WriteTo(newFil)
+	return err
+}
+
+//WriteTo attempts to write the archive to the given io.Writer.
+func (w *Writer) WriteTo(write io.Writer) (int64, error) {
+	//TODO
+	return 0, errors.New("I SAID DON'T")
+}

writer_compression_options.go

@@ -0,0 +1,15 @@
+package squashfs
+
+//TODO: Allow settings the options
+
+// func (w *Writer) SetGzipOptions() error {}
+
+// func (w *Writer) SetLzmaOptions() error {}
+
+// func (w *Writer) SetLzoOptions() error {}
+
+// func (w *Writer) SetXzOptions() error {}
+
+// func (w *Writer) SetLz4Options() error {}
+
+// func (w *Writer) SetZstdOptions() error {}