lix/src/libstore/download.hh

110 lines
2.9 KiB
C++
Raw Normal View History

2015-04-09 10:12:50 +00:00
#pragma once
#include "types.hh"
#include "hash.hh"
#include "globals.hh"
2015-04-09 10:12:50 +00:00
#include <string>
#include <future>
2015-04-09 10:12:50 +00:00
namespace nix {
struct DownloadRequest
{
std::string uri;
std::string expectedETag;
bool verifyTLS = true;
bool head = false;
size_t tries = 5;
unsigned int baseRetryTimeMs = 250;
ActivityId parentAct;
bool decompress = true;
std::shared_ptr<std::string> data;
std::string mimeType;
std::function<void(char *, size_t)> dataCallback;
2018-01-31 14:12:27 +00:00
DownloadRequest(const std::string & uri)
: uri(uri), parentAct(getCurActivity()) { }
2018-06-05 12:37:26 +00:00
std::string verb()
{
return data ? "upload" : "download";
}
};
2015-04-09 10:12:50 +00:00
struct DownloadResult
{
bool cached = false;
std::string etag;
std::string effectiveUrl;
std::shared_ptr<std::string> data;
uint64_t bodySize = 0;
2015-04-09 10:12:50 +00:00
};
struct CachedDownloadResult
{
// Note: 'storePath' may be different from 'path' when using a
// chroot store.
Path storePath;
Path path;
std::optional<std::string> etag;
};
class Store;
struct Downloader
{
/* Enqueue a download request, returning a future to the result of
the download. The future may throw a DownloadError
exception. */
virtual void enqueueDownload(const DownloadRequest & request,
2018-03-27 20:16:01 +00:00
Callback<DownloadResult> callback) = 0;
std::future<DownloadResult> enqueueDownload(const DownloadRequest & request);
/* Synchronously download a file. The request will be retried in
case of transient failures. */
DownloadResult download(const DownloadRequest & request);
/* Download a file, writing its data to a sink. The sink will be
invoked on the thread of the caller. The request will not be
retried in case of transient failures. */
void download(DownloadRequest && request, Sink & sink);
/* Check if the specified file is already in ~/.cache/nix/tarballs
and is more recent than tarball-ttl seconds. Otherwise,
use the recorded ETag to verify if the server has a more
recent version, and if so, download it to the Nix store. */
CachedDownloadResult downloadCached(
ref<Store> store, const string & uri, bool unpack, string name = "",
const Hash & expectedHash = Hash(), string * effectiveUri = nullptr,
int ttl = settings.tarballTtl);
2016-08-11 15:34:43 +00:00
enum Error { NotFound, Forbidden, Misc, Transient, Interrupted };
};
2015-04-09 10:12:50 +00:00
/* Return a shared Downloader object. Using this object is preferred
because it enables connection reuse and HTTP/2 multiplexing. */
ref<Downloader> getDownloader();
/* Return a new Downloader object. */
ref<Downloader> makeDownloader();
class DownloadError : public Error
{
public:
Downloader::Error error;
DownloadError(Downloader::Error error, const FormatOrString & fs)
: Error(fs), error(error)
{ }
bool isTransient() override
{
return error == Downloader::Error::Transient;
}
};
bool isUri(const string & s);
2015-04-09 10:12:50 +00:00
}