2015-04-09 12:12:50 +02:00
|
|
|
|
#pragma once
|
|
|
|
|
|
2016-09-14 16:00:40 +02:00
|
|
|
|
#include <future>
|
2015-04-09 12:12:50 +02:00
|
|
|
|
#include <string>
|
2020-05-19 16:54:39 +02:00
|
|
|
|
|
2020-05-27 22:56:34 +02:00
|
|
|
|
#include "libstore/globals.hh"
|
|
|
|
|
#include "libutil/hash.hh"
|
|
|
|
|
#include "libutil/types.hh"
|
2015-04-09 12:12:50 +02:00
|
|
|
|
|
|
|
|
|
namespace nix {
|
|
|
|
|
|
2019-06-17 08:43:45 +02:00
|
|
|
|
struct DownloadSettings : Config {
|
|
|
|
|
Setting<bool> enableHttp2{this, true, "http2",
|
|
|
|
|
"Whether to enable HTTP/2 support."};
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2019-06-17 08:43:45 +02:00
|
|
|
|
Setting<std::string> userAgentSuffix{
|
|
|
|
|
this, "", "user-agent-suffix",
|
|
|
|
|
"String appended to the user agent in HTTP requests."};
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2019-06-17 08:43:45 +02:00
|
|
|
|
Setting<size_t> httpConnections{this,
|
|
|
|
|
25,
|
|
|
|
|
"http-connections",
|
|
|
|
|
"Number of parallel HTTP connections.",
|
|
|
|
|
{"binary-caches-parallel-connections"}};
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2019-06-17 08:43:45 +02:00
|
|
|
|
Setting<unsigned long> connectTimeout{
|
|
|
|
|
this, 0, "connect-timeout",
|
|
|
|
|
"Timeout for connecting to servers during downloads. 0 means use curl's "
|
|
|
|
|
"builtin default."};
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2019-08-07 21:14:40 +02:00
|
|
|
|
Setting<unsigned long> stalledDownloadTimeout{
|
|
|
|
|
this, 300, "stalled-download-timeout",
|
|
|
|
|
"Timeout (in seconds) for receiving data from servers during download. "
|
|
|
|
|
"Nix cancels idle downloads after this timeout's duration."};
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2019-06-17 08:43:45 +02:00
|
|
|
|
Setting<unsigned int> tries{
|
|
|
|
|
this, 5, "download-attempts",
|
|
|
|
|
"How often Nix will attempt to download a file before giving up."};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
extern DownloadSettings downloadSettings;
|
|
|
|
|
|
2016-09-14 16:00:40 +02:00
|
|
|
|
struct DownloadRequest {
|
|
|
|
|
std::string uri;
|
2016-08-10 16:06:33 +02:00
|
|
|
|
std::string expectedETag;
|
|
|
|
|
bool verifyTLS = true;
|
|
|
|
|
bool head = false;
|
2019-06-17 08:43:45 +02:00
|
|
|
|
size_t tries = downloadSettings.tries;
|
2016-09-14 16:00:40 +02:00
|
|
|
|
unsigned int baseRetryTimeMs = 250;
|
2017-09-18 11:07:28 +02:00
|
|
|
|
bool decompress = true;
|
2018-01-26 20:12:30 +01:00
|
|
|
|
std::shared_ptr<std::string> data;
|
|
|
|
|
std::string mimeType;
|
2018-03-28 00:01:47 +02:00
|
|
|
|
std::function<void(char*, size_t)> dataCallback;
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2020-05-19 02:02:44 +02:00
|
|
|
|
DownloadRequest(const std::string& uri) : uri(uri) {}
|
2020-05-17 17:31:57 +02:00
|
|
|
|
|
2018-06-05 14:37:26 +02:00
|
|
|
|
std::string verb() { return data ? "upload" : "download"; }
|
2015-10-21 14:59:01 +02:00
|
|
|
|
};
|
|
|
|
|
|
2015-04-09 12:12:50 +02:00
|
|
|
|
struct DownloadResult {
|
2017-02-14 14:20:00 +01:00
|
|
|
|
bool cached = false;
|
2016-09-14 16:00:40 +02:00
|
|
|
|
std::string etag;
|
2019-05-22 23:36:29 +02:00
|
|
|
|
std::string effectiveUri;
|
2016-04-15 15:11:34 +02:00
|
|
|
|
std::shared_ptr<std::string> data;
|
2018-08-06 11:31:14 +02:00
|
|
|
|
uint64_t bodySize = 0;
|
2015-04-09 12:12:50 +02:00
|
|
|
|
};
|
|
|
|
|
|
2019-05-22 23:36:29 +02:00
|
|
|
|
struct CachedDownloadRequest {
|
|
|
|
|
std::string uri;
|
|
|
|
|
bool unpack = false;
|
|
|
|
|
std::string name;
|
|
|
|
|
Hash expectedHash;
|
|
|
|
|
unsigned int ttl = settings.tarballTtl;
|
|
|
|
|
|
|
|
|
|
CachedDownloadRequest(const std::string& uri) : uri(uri) {}
|
|
|
|
|
};
|
|
|
|
|
|
2019-02-25 16:20:50 +01:00
|
|
|
|
struct CachedDownloadResult {
|
2019-05-15 15:38:24 +02:00
|
|
|
|
// Note: 'storePath' may be different from 'path' when using a
|
|
|
|
|
// chroot store.
|
|
|
|
|
Path storePath;
|
2019-02-25 16:20:50 +01:00
|
|
|
|
Path path;
|
|
|
|
|
std::optional<std::string> etag;
|
2019-05-22 23:36:29 +02:00
|
|
|
|
std::string effectiveUri;
|
2019-02-25 16:20:50 +01:00
|
|
|
|
};
|
|
|
|
|
|
2016-02-04 14:48:42 +01:00
|
|
|
|
class Store;
|
Eliminate the "store" global variable
Also, move a few free-standing functions into StoreAPI and Derivation.
Also, introduce a non-nullable smart pointer, ref<T>, which is just a
wrapper around std::shared_ptr ensuring that the pointer is never
null. (For reference-counted values, this is better than passing a
"T&", because the latter doesn't maintain the refcount. Usually, the
caller will have a shared_ptr keeping the value alive, but that's not
always the case, e.g., when passing a reference to a std::thread via
std::bind.)
2016-02-04 14:28:26 +01:00
|
|
|
|
|
2016-02-29 18:15:20 +01:00
|
|
|
|
struct Downloader {
|
2019-09-20 13:48:53 +02:00
|
|
|
|
virtual ~Downloader() {}
|
|
|
|
|
|
2016-09-14 16:00:40 +02:00
|
|
|
|
/* Enqueue a download request, returning a future to the result of
|
|
|
|
|
the download. The future may throw a DownloadError
|
|
|
|
|
exception. */
|
2016-09-16 18:54:14 +02:00
|
|
|
|
virtual void enqueueDownload(const DownloadRequest& request,
|
2018-03-27 22:16:01 +02:00
|
|
|
|
Callback<DownloadResult> callback) = 0;
|
2016-09-16 18:54:14 +02:00
|
|
|
|
|
|
|
|
|
std::future<DownloadResult> enqueueDownload(const DownloadRequest& request);
|
2016-09-14 16:00:40 +02:00
|
|
|
|
|
2019-07-10 19:46:15 +02:00
|
|
|
|
/* Synchronously download a file. */
|
2016-09-14 16:00:40 +02:00
|
|
|
|
DownloadResult download(const DownloadRequest& request);
|
2016-02-29 18:15:20 +01:00
|
|
|
|
|
2018-03-28 00:01:47 +02:00
|
|
|
|
/* Download a file, writing its data to a sink. The sink will be
|
2019-07-10 19:46:15 +02:00
|
|
|
|
invoked on the thread of the caller. */
|
2018-03-28 00:01:47 +02:00
|
|
|
|
void download(DownloadRequest&& request, Sink& sink);
|
|
|
|
|
|
2016-09-14 16:00:40 +02:00
|
|
|
|
/* Check if the specified file is already in ~/.cache/nix/tarballs
|
2016-11-26 00:37:43 +01:00
|
|
|
|
and is more recent than ‘tarball-ttl’ seconds. Otherwise,
|
2016-09-14 16:00:40 +02:00
|
|
|
|
use the recorded ETag to verify if the server has a more
|
|
|
|
|
recent version, and if so, download it to the Nix store. */
|
2020-05-20 23:58:43 +02:00
|
|
|
|
CachedDownloadResult downloadCached(const ref<Store>& store,
|
2019-05-22 23:36:29 +02:00
|
|
|
|
const CachedDownloadRequest& request);
|
2016-08-11 17:34:43 +02:00
|
|
|
|
|
2016-09-16 18:54:14 +02:00
|
|
|
|
enum Error { NotFound, Forbidden, Misc, Transient, Interrupted };
|
2016-02-29 18:15:20 +01:00
|
|
|
|
};
|
2015-04-09 12:12:50 +02:00
|
|
|
|
|
2016-09-14 16:00:40 +02: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. */
|
2016-02-29 18:15:20 +01:00
|
|
|
|
ref<Downloader> makeDownloader();
|
2015-05-05 17:09:42 +02:00
|
|
|
|
|
2016-02-29 18:15:20 +01:00
|
|
|
|
class DownloadError : public Error {
|
|
|
|
|
public:
|
|
|
|
|
Downloader::Error error;
|
|
|
|
|
DownloadError(Downloader::Error error, const FormatOrString& fs)
|
|
|
|
|
: Error(fs), error(error) {}
|
|
|
|
|
};
|
2015-04-09 12:49:13 +02:00
|
|
|
|
|
2020-05-24 23:29:21 +02:00
|
|
|
|
bool isUri(const std::string& s);
|
2015-05-06 14:54:31 +02:00
|
|
|
|
|
2015-04-09 12:12:50 +02:00
|
|
|
|
} // namespace nix
|