Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

HTTPDirFS - HTTP Directory Filesystem with a permanent cache, and Airsonic / Subsonic server support!

Have you ever wanted to mount those HTTP directory listings as if it was a partition? Look no further, this is your solution. HTTPDirFS stands for Hyper Text Transfer Protocol Directory Filesystem.

The performance of the program is excellent. HTTP connections are reused due to the use of curl-multi interface. The FUSE component runs in multithreaded mode.

There is a permanent cache system which can cache all the file segments you have downloaded, so you don't need to these segments again if you access them later. This feature is triggered by the --cache flag. This makes this filesystem much faster than rclone mount.

The support for Airsonic / Subsonic server has also been added. This allows you to mount a remote music collection locally.

News

HTTPDirFS now supports mounting Airsonic / Subsonic servers! This features is dedicated the my Debian package maintainer Jerome Charaoui.

Installation

Debian 11 "Bullseye"

HTTPDirFS is available as a package in Debian 11 "Bullseye", which is the current Testing version. If you are on Debian Bullseye, you can simply run the following command as root:

apt install httpdirfs

For more information on the status of HTTDirFS in Debian, please refer to Debian package tracker

Arch Linux

HTTPDirFS is available in the Arch User Repository.

FreeBSD

HTTPDirFS is available in the FreeBSD Ports Collection.

Compilation

Ubuntu

Under Ubuntu 18.04.4 LTS, you need the following packages:

libgumbo-dev libfuse-dev libssl-dev libcurl4-openssl-dev uuid-dev

Debian 10 "Buster" and newer versions

Under Debian 10 "Buster" and newer versions, you need the following packages:

libgumbo-dev libfuse-dev libssl-dev libcurl4-openssl-dev uuid-dev

Debian 9 "Stretch"

Under Debian 9 "Stretch", you need the following packages:

libgumbo-dev libfuse-dev libssl1.0-dev libcurl4-openssl-dev

If you get the following warnings during compilation,

/usr/bin/ld: warning: libcrypto.so.1.0.2, needed by /usr/lib/gcc/x86_64-linux-gnu/6/../../../x86_64-linux-gnu/libcurl.so, may conflict with libcrypto.so.1.1

then this program will crash if you connect to HTTPS website. You need to check if you have libssl1.0-dev installed rather than libssl-dev. This is you likely have the binaries of OpenSSL 1.0.2 installed alongside with the header files for OpenSSL 1.1. The header files for OpenSSL 1.0.2 link in additional mutex related callback functions, whereas the header files for OpenSSL 1.1 do not.

You can check your SSL engine version using the --version flag.

FreeBSD

The following dependencies are required from either pkg or ports:

Packages:

gmake fusefs-libs gumbo e2fsprogs-libuuid curl expat

Ports:

devel/gmake sysutils/fusefs-libs devel/gumbo misc/e2fsprogs-libuuid ftp/curl textproc/expat2

Note: If you want brotli compression support, you will need to install curl from ports and enable the option.

You can then build + install with:

gmake
sudo gmake install

Alternatively, you may use the FreeBSD ports(7) infrastructure to build HTTPDirFS from source with the modifications you need.

macOS

You need to install macFUSE, cURL, gumbo, and OpenSSL from Homebrew:

brew install macfuse curl gumbo-parser openssl pkg-config

Build and install:

make
sudo make install

Apple's command-line build tools are usually installed as part of setting up Homebrew. HTTPDirFS will be installed in /usr/local.

Usage

./httpdirfs -f --cache $URL $MOUNT_POINT

An example URL would be Debian CD Image Server. The -f flag keeps the program in the foreground, which is useful for monitoring which URL the filesystem is visiting.

Useful options

HTTPDirFS options:

    --config            Specify a configuration file 
-u  --username          HTTP authentication username
-p  --password          HTTP authentication password
-P  --proxy             Proxy for libcurl, for more details refer to
                        https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html
    --proxy-username    Username for the proxy
    --proxy-password    Password for the proxy
    --cache             Enable cache (default: off)
    --cache-location    Set a custom cache location
                        (default: "${XDG_CACHE_HOME}/httpdirfs")
    --dl-seg-size       Set cache download segment size, in MB (default: 8)
                        Note: this setting is ignored if previously
                        cached data is found for the requested file.
    --max-seg-count     Set maximum number of download segments a file
                        can have. (default: 128*1024)
                        With the default setting, the maximum memory usage
                        per file is 128KB. This allows caching files up
                        to 1TB in size using the default segment size.
    --max-conns         Set maximum number of network connections that
                        libcurl is allowed to make. (default: 10)
    --retry-wait        Set delay in seconds before retrying an HTTP request
                        after encountering an error. (default: 5)
    --user-agent        Set user agent string (default: "HTTPDirFS")
    --no-range-check    Disable the build-in check for the server's support
                        for HTTP range requests
    --insecure_tls      Disable licurl TLS certificate verification by
                        setting CURLOPT_SSL_VERIFYHOST to 0

For mounting a Airsonic / Subsonic server:

    --sonic-username    The username for your Airsonic / Subsonic server
    --sonic-password    The password for your Airsonic / Subsonic server
    --sonic-id3         Enable ID3 mode - this present the server content in
                        Artist/Album/Song layout
    --sonic-insecure    Authenticate against your Airsonic / Subsonic server
                        using the insecure username / hex encoded password
                        scheme

FUSE options:

-d   -o debug          enable debug output (implies -f)
-f                     foreground operation
-s                     disable multi-threaded operation

Airsonic / Subsonic server support

This is a new feature to 1.2.0. Now you can mount the music collection on your Airsonic / Subsonic server (*sonic), and browse them using your favourite file browser. You simply have to supply both --sonic-username and --sonic-password to trigger the *sonic server mode. For example:

./httpdirfs -f --cache --sonic-username $USERNAME --sonic-password $PASSWORD $URL $MOUNT_POINT

You definitely want to enable the cache for this one, otherwise it is painfully slow.

There are two ways of mounting your *sonic server

  • the index mode
  • and the ID3 mode.

In the index mode, the filesystem is presented based on the listing on the Index link in your *sonic's home page.

In ID3 mode, the filesystem is presented using the following hierarchy: 0. Root

  1. Alphabetical indices of the artists' names
  2. The arists' names
  3. All of the albums by a single artist
  4. All the songs in an album.

By default, *sonic server is mounted in the index mode. If you want to mount in ID3 mode, please use the --sonic-id3 flag.

Please note that the cache feature is unaffected by how you mount your *sonic server. If you mounted your server in index mode, the cache is still valid in ID3 mode, and vice versa.

HTTPDirFS is also known to work with the following applications, which implement some or all of Subsonic API:

Permanent cache system

You can cache all the files you have looked at permanently on your hard drive by using the --cache flag. The file it caches persist across sessions.

By default, the cache files are stored under ${XDG_CACHE_HOME}/httpdirfs, which by default is ${HOME}/.cache/httpdirfs. Each HTTP directory gets its own cache folder, they are named using the escaped URL of the HTTP directory.

Once a segment of the file has been downloaded once, it won't be downloaded again.

Please note that due to the way the permanent cache system is implemented. The maximum download speed is around 15MiB/s, as measured using my localhost as the web server. However after you have accessed a file once, accessing it again will be the same speed as accessing your hard drive.

If you have any patches to make the initial download go faster, please submit a pull request.

The permanent cache system relies on sparse allocation. Please make sure your filesystem supports it. Otherwise your hard drive / SSD will get heavy I/O from cache file creation. For a list of filesystem that supports sparse allocation, please refer to Wikipedia.

Configuration file support

This program has basic support for using a configuration file. By default, the configuration file which the program reads is ${XDG_CONFIG_HOME}/httpdirfs/config, which by default is at ${HOME}/.config/httpdirfs/config. You will have to create the sub-directory and the configuration file yourself. In the configuration file, please supply one option per line. For example:

--username test
--password test
-f

Alternatively, you can specify your own configuration file by using the --config option.

Debugging Mutexes

By default the debugging output associated with mutexes are not compiled. To enable them, compile the program with the -DCACHE_LOCK_DEBUG, the -DNETWORK_LOCK_DEBUG and/or the -DLINK_LOCK_DEBUG CPPFLAGS, e.g.

make CPPFLAGS=-DCACHE_LOCK_DEBUG

The Technical Details

For the normal HTTP directories, this program downloads the HTML web pages/files using libcurl, then parses the listing pages using Gumbo, and presents them using libfuse.

For *sonic servers, rather than using the Gumbo parser, this program parse *sonic servers' XML responses using expat.

The cache system stores the metadata and the downloaded file into two separate directories. It uses uint8_t arrays to record which segments of the file had been downloaded.

Note that HTTPDirFS requires the server to support HTTP Range Request, some servers support this features, but does not present "Accept-Ranges: bytes in the header responses. HTTPDirFS by default checks for this header field. You can disable this check by using the --no-range-check flag.

Other projects which incorporate HTTPDirFS

Acknowledgement

  • First of all, I would like to thank Jerome Charaoui for being the Debian Maintainer for this piece of software. Thank you so much for packaging it!
  • I would like to thank Cosmin Gorgovan for the technical and moral support. Your wisdom is much appreciated!
  • I would like to thank Edenist for providing FreeBSD compatibility patches.
  • I would like to thank hiliev for providing macOS compatibility patches.
  • I would like to thank -Archivist for not providing FTP or WebDAV access to his server. This piece of software was written in direct response to his appalling behaviour.