bzf / archivefs Goto Github PK

View Code? Open in Web Editor NEW

8.0 2.0 0.0 114 KB

Mount your archives and browse them as regular files

Makefile 1.83% Rust 88.29% C 6.78% Ruby 0.09% Dockerfile 2.24% Shell 0.65% C++ 0.11%

libarchive fuse-filesystem rust-lang osxfuse

archivefs's Introduction

archivefs

archivefs - mount your archives and browse them as regular files

Usage

archivefs [-sdf] --directory=/some/absolute/path /mountpoint

Features

Expand archives as directories
Reads files from an archive as a regular file
Shows non-archive files and directories as normal

Quick example

$ tree .
.
├── archives
│   └── maskinen.tar.gz
└── mountpoint

2 directories, 1 file
$ archivefs --directory=$HOME/example/archives mountpoint/
$ tree .
.
├── archives
│   └── maskinen.tar.gz
└── mountpoint
    └── maskinen
        ├── pengar.txt
        └── segertaget.txt

3 directories, 3 files
$ cat mountpoint/maskinen/segertaget.txt | head -n5
[Vers 1]
He-he-hej, här kommer segertåget
Rullar in som teknodromen
Tryck på play, du sätter på den
Dansar som på, äh, vi kör igen

Description

archivefs is a FUSE file system for mounting and reading from archive files instead of unpacking them to read the content.

Building

To build archivefs there are some packages that are required to be installed on the system:

libfuse (or osxfuse)
libarchive
Rust
A C compiler
Homebrew

To build the project you run the make command:

$ brew bundle # Installs dependencies for building the project
$ make

Bugs

archivefs does not handle nested directories inside an archive file properly. For now only flat archvies are compatiable.

If you get the following error message you can try setting the LD_LIBRARY_PATH environment variable to the path of the libarchivefs library:

$ ./archivefs
./archivefs: error while loading shared libraries: libarchivefs.so: cannot open shared object file: No such file or directory
$ LD_LIBRARY_PATH=./target/release/deps ./archivefs
Need to set which archive you want to mount

Good links

https://fossies.org/dox/fuse-2.9.7/fuse__compat_8h_source.html

archivefs's People

Contributors

Stargazers

Watchers

archivefs's Issues

Can we port this to Rust?

Make it work without the -s flag

Having it being written in Rust, we should be able to use it without the single thread option.

Could this program run in a Docker container?

It seems like a cool idea to have the full fuse and libarchive dependencies inside a Docker container which could be downloaded an manage the streaming part (and maybe it will be easier to have Docker as a dependency than install Fuse?).

Can you mount a fuse filesystem on a mounted directory through Docker?
Will it be fast enough?

I'm imagining running a command simliar to

$ docker run --rm -v /where/my/archives/live:/archives -v ./mountpoint:/mountpoint archivefs

which, on start, would scan for archives in /archives and mount the filesystem in /mountpoint.

Handle non-RAR archives

Add man pages

Handle directories in archives

How to test for memory leaks

Could we run valgrind in a Github Action and read some files from an archive and see if something got leaked?

Watch for new files in directory

Fix permission handling

Browse non-archives as regular files

Only replace archives with a folder and browse other files as regular files.

Before:

$ tree mounted/
mounted
├── files.rar
└── foo.txt

0 directories, 2 files

After:

$ tree mounted/
mounted
├── files
│   └── debian-9.0.0-amd64-netinst.iso
└── foo.txt

1 directory, 3 files