Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.19 KB

README.md

File metadata and controls

60 lines (42 loc) · 2.19 KB
Raw

Simple URL file cache

Simple URL fetcher & cache. Will only fetch updated resource when actually newer (using If-Modified-Since HTTP header), so suitable for large data files.

Basic Usage

import "github.com/gwillem/urlfilecache"

url := "https://google.com/robots.txt"
path, err := urlfilecache.ToPath(url)
// /home/you/.cache/<cmd>/<hash>.urlcache
data, err := os.ReadFile(path)

Available Methods

  • ToPath(url string) (path string, err error) - Caches a URL to a system-determined location without TTL
  • ToPathTTL(url string, ttl time.Duration) (path string, err error) - Same as ToPath but with TTL expiration
  • ToCustomPath(url, path string) error - Caches a URL to a specified location without TTL
  • ToCustomPathTTL(url, path string, ttl time.Duration) error - Same as ToCustomPath but with TTL expiration

The cache location is determined in this order:

  1. $XDG_CACHE_HOME (usually ~/.cache)
  2. /tmp
  3. /var/tmp
  4. /dev/shm

Cache Behavior

Webservers such as Nginx honour the If-Modified-Since header exclusively with an exact timestamp match. To mitigate this, urlfilecache will modify the mtime of the downloaded file to match the Last-Modified as given by the server.

Relevant for ToCustomPath: this means that if the local file is newer than the server copy, an extra download will be triggered. After that, the local & remote timestamps will match so caching is activated.

This may be a problem for development of self-updating binaries, because the newly built local binary is always newer than the server copy. In that case, ensure that your webserver will use caching for anything older than the given timestamp. For nginx, you can add this line to nginx.conf:

    if_modified_since before;

Alternatively, this library could be rewritten to use HEAD probe requests to discover the remote Last-Modified timestamp, and not depend on any server-side caching at all.

Example with TTL

import (
    "github.com/gwillem/urlfilecache"
    "time"
)

// Cache a file with 1 hour TTL
path, err := urlfilecache.ToPathTTL("https://example.com/file.txt", time.Hour)
if err != nil {
    log.Fatal(err)
}

// Read the cached file
data, err := os.ReadFile(path)