eldritch horrors
982d049d3b
return it as a separate item in a pair instead. this will let us remove enqueueDownload() in favor of returning metadata from download() itself Change-Id: I74fad2ca15f920da1eefabc950c2baa2c360f2ba
136 lines
4.2 KiB
C++
136 lines
4.2 KiB
C++
#pragma once
|
||
///@file
|
||
|
||
#include "box_ptr.hh"
|
||
#include "ref.hh"
|
||
#include "logging.hh"
|
||
#include "serialise.hh"
|
||
#include "types.hh"
|
||
#include "config.hh"
|
||
|
||
#include <string>
|
||
#include <future>
|
||
|
||
namespace nix {
|
||
|
||
struct FileTransferSettings : Config
|
||
{
|
||
Setting<bool> enableHttp2{this, true, "http2",
|
||
"Whether to enable HTTP/2 support."};
|
||
|
||
Setting<std::string> userAgentSuffix{this, "", "user-agent-suffix",
|
||
"String appended to the user agent in HTTP requests."};
|
||
|
||
Setting<size_t> httpConnections{
|
||
this, 25, "http-connections",
|
||
R"(
|
||
The maximum number of parallel TCP connections used to fetch
|
||
files from binary caches and by other downloads. It defaults
|
||
to 25. 0 means no limit.
|
||
)",
|
||
{"binary-caches-parallel-connections"}};
|
||
|
||
Setting<unsigned long> connectTimeout{
|
||
this, 0, "connect-timeout",
|
||
R"(
|
||
The timeout (in seconds) for establishing connections in the
|
||
binary cache substituter. It corresponds to `curl`’s
|
||
`--connect-timeout` option. A value of 0 means no limit.
|
||
)"};
|
||
|
||
Setting<unsigned long> stalledDownloadTimeout{
|
||
this, 300, "stalled-download-timeout",
|
||
R"(
|
||
The timeout (in seconds) for receiving data from servers
|
||
during download. Lix cancels idle downloads after this
|
||
timeout's duration.
|
||
)"};
|
||
|
||
Setting<unsigned int> tries{this, 5, "download-attempts",
|
||
"How often Lix will attempt to download a file before giving up."};
|
||
};
|
||
|
||
extern FileTransferSettings fileTransferSettings;
|
||
|
||
struct FileTransferResult
|
||
{
|
||
bool cached = false;
|
||
std::string etag;
|
||
std::string effectiveUri;
|
||
/* An "immutable" URL for this resource (i.e. one whose contents
|
||
will never change), as returned by the `Link: <url>;
|
||
rel="immutable"` header. */
|
||
std::optional<std::string> immutableUrl;
|
||
};
|
||
|
||
class Store;
|
||
|
||
struct FileTransfer
|
||
{
|
||
virtual ~FileTransfer() { }
|
||
|
||
/**
|
||
* Enqueues a download request, returning a future for the result of
|
||
* the download. The future may throw a FileTransferError exception.
|
||
*/
|
||
virtual std::future<std::pair<FileTransferResult, std::string>>
|
||
enqueueDownload(const std::string & uri, const Headers & headers = {}) = 0;
|
||
|
||
/**
|
||
* Upload some data. May throw a FileTransferError exception.
|
||
*/
|
||
virtual void
|
||
upload(const std::string & uri, std::string data, const Headers & headers = {}) = 0;
|
||
|
||
/**
|
||
* Checks whether the given URI exists. For historical reasons this function
|
||
* treats HTTP 403 responses like HTTP 404 responses and returns `false` for
|
||
* both. This was originally done to handle unlistable S3 buckets, which may
|
||
* return 403 (not 404) if the reuqested object doesn't exist in the bucket.
|
||
*
|
||
* ## Bugs
|
||
*
|
||
* S3 objects are downloaded completely to answer this request.
|
||
*/
|
||
virtual bool exists(const std::string & uri, const Headers & headers = {}) = 0;
|
||
|
||
/**
|
||
* Download a file, returning its contents through a source. Will not return
|
||
* before the transfer has fully started, ensuring that any errors thrown by
|
||
* the setup phase (e.g. HTTP 404 or similar errors) are not postponed to be
|
||
* thrown by the returned source. The source will only throw errors detected
|
||
* during the transfer itself (decompression errors, connection drops, etc).
|
||
*/
|
||
virtual box_ptr<Source> download(const std::string & uri, const Headers & headers = {}) = 0;
|
||
|
||
enum Error { NotFound, Forbidden, Misc, Transient, Interrupted };
|
||
};
|
||
|
||
/**
|
||
* @return a shared FileTransfer object.
|
||
*
|
||
* Using this object is preferred because it enables connection reuse
|
||
* and HTTP/2 multiplexing.
|
||
*/
|
||
ref<FileTransfer> getFileTransfer();
|
||
|
||
/**
|
||
* @return a new FileTransfer object
|
||
*
|
||
* Prefer getFileTransfer() to this; see its docs for why.
|
||
*/
|
||
ref<FileTransfer> makeFileTransfer(std::optional<unsigned int> baseRetryTimeMs = {});
|
||
|
||
class FileTransferError : public Error
|
||
{
|
||
public:
|
||
FileTransfer::Error error;
|
||
/// intentionally optional
|
||
std::optional<std::string> response;
|
||
|
||
template<typename... Args>
|
||
FileTransferError(FileTransfer::Error error, std::optional<std::string> response, const Args & ... args);
|
||
};
|
||
|
||
}
|