gergely/taskwarrior-2.x
1
0
Fork 0
Code Issues Actions Packages Projects Releases 1 Wiki Activity

Relax sync.server.origin to allow paths (#3423)

Browse Source
This commit is contained in:
Hector Dearman
2024-07-05 00:17:52 +01:00
committed by GitHub
parent 85f52e3630
commit fa5604ea8d
9 changed files with 38 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/Context.cpp
View File

@@ -281,9 +281,9 @@ std::string configurationDefaults =
"\n"
"#sync.encryption_secret # Encryption secret for sync to a server\n"
"#sync.server.client_id # Client ID for sync to a server\n"
"#sync.server.origin # Origin of the sync server\n"
"#sync.server.url # URL of the sync server\n"
"#sync.local.server_dir # Directory for local sync\n"
"#sync.gcp.credential_path # Path to JSON file containing credentials to authenticate GCP Sync\n"
"#sync.gcp.credential_path # Path to JSON file containing credentials to authenticate GCP Sync\n"
"#sync.gcp.bucket # Bucket for sync to GCP\n"
"\n"
"# Aliases - alternate names for commands\n"

1
src/commands/CmdShow.cpp
View File

@@ -197,6 +197,7 @@ int CmdShow::execute (std::string& output)
" sync.gcp.bucket"
" sync.server.client_id"
" sync.encryption_secret"
" sync.server.url"
" sync.server.origin"
" tag.indicator"
" undo.style"

18
src/commands/CmdSync.cpp
View File

@@ -63,10 +63,15 @@ int CmdSync::execute (std::string& output)
// If no server is set up, quit.
std::string origin = Context::getContext ().config.get ("sync.server.origin");
std::string url = Context::getContext ().config.get ("sync.server.url");
std::string server_dir = Context::getContext ().config.get ("sync.local.server_dir");
std::string gcp_credential_path = Context::getContext ().config.get ("sync.gcp.credential_path");
std::string gcp_bucket = Context::getContext ().config.get ("sync.gcp.bucket");
std::string encryption_secret = Context::getContext ().config.get ("sync.encryption_secret");
// sync.server.origin is a deprecated synonym for sync.server.url
std::string server_url = url == "" ? origin : url;
if (server_dir != "") {
server = tc::Server::new_local (server_dir);
server_ident = server_dir;
@@ -78,23 +83,28 @@ int CmdSync::execute (std::string& output)
std::ostringstream os;
os << "GCP bucket " << gcp_bucket;
server_ident = os.str();
} else if (origin != "") {
} else if (server_url != "") {
std::string client_id = Context::getContext ().config.get ("sync.server.client_id");
if (client_id == "" || encryption_secret == "") {
throw std::string ("sync.server.client_id and sync.encryption_secret are required");
}
server = tc::Server::new_sync (origin, client_id, encryption_secret);
server = tc::Server::new_sync (server_url, client_id, encryption_secret);
std::ostringstream os;
os << "Sync server at " << origin;
os << "Sync server at " << server_url;
server_ident = os.str();
} else {
throw std::string ("No sync.* settings are configured. See task-sync(5).");
}
std::stringstream out;
if (Context::getContext ().verbose ("sync"))
if (origin != "") {
out << "sync.server.origin is deprecated. Use sync.server.url instead.\n";
}
if (Context::getContext ().verbose ("sync")) {
out << format ("Syncing with {1}", server_ident)
<< '\n';
}
Context::getContext ().tdb2.sync(std::move(server), false);

10
src/tc/Server.cpp
View File

@@ -51,24 +51,24 @@ tc::Server::new_local (const std::string &server_dir)
////////////////////////////////////////////////////////////////////////////////
tc::Server
tc::Server::new_sync (const std::string &origin, const std::string &client_id, const std::string &encryption_secret)
tc::Server::new_sync (const std::string &url, const std::string &client_id, const std::string &encryption_secret)
{
TCString tc_origin = tc_string_borrow (origin.c_str ());
TCString tc_url = tc_string_borrow (url.c_str ());
TCString tc_client_id = tc_string_borrow (client_id.c_str ());
TCString tc_encryption_secret = tc_string_borrow (encryption_secret.c_str ());
TCUuid tc_client_uuid;
if (tc_uuid_from_str(tc_client_id, &tc_client_uuid) != TC_RESULT_OK) {
tc_string_free(&tc_origin);
tc_string_free(&tc_url);
tc_string_free(&tc_encryption_secret);
throw format ("client_id '{1}' is not a valid UUID", client_id);
}
TCString error;
auto tcserver = tc_server_new_sync (tc_origin, tc_client_uuid, tc_encryption_secret, &error);
auto tcserver = tc_server_new_sync (tc_url, tc_client_uuid, tc_encryption_secret, &error);
if (!tcserver) {
std::string errmsg = format ("Could not configure connection to server at {1}: {2}",
origin, tc_string_content (&error));
url, tc_string_content (&error));
tc_string_free (&error);
throw errmsg;
}

2
src/tc/Server.h
View File

@@ -54,7 +54,7 @@ namespace tc {
static Server new_local (const std::string& server_dir);
// Construct a remote server (tc_server_new_sync).
static Server new_sync (const std::string &origin, const std::string &client_id, const std::string &encryption_secret);
static Server new_sync (const std::string &url, const std::string &client_id, const std::string &encryption_secret);
// Construct a GCP server (tc_server_new_gcp).
static Server new_gcp (const std::string &bucket, const std::string &credential_path, const std::string &encryption_secret);

10
src/tc/lib/src/server.rs
View File

@@ -108,14 +108,14 @@ pub unsafe extern "C" fn tc_server_new_local(
/// The server must be freed after it is used - tc_replica_sync does not automatically free it.
///
/// ```c
/// EXTERN_C struct TCServer *tc_server_new_sync(struct TCString origin,
/// EXTERN_C struct TCServer *tc_server_new_sync(struct TCString url,
/// struct TCUuid client_id,
/// struct TCString encryption_secret,
/// struct TCString *error_out);
/// ```
#[no_mangle]
pub unsafe extern "C" fn tc_server_new_sync(
origin: TCString,
url: TCString,
client_id: TCUuid,
encryption_secret: TCString,
error_out: *mut TCString,
@@ -123,9 +123,9 @@ pub unsafe extern "C" fn tc_server_new_sync(
wrap(
|| {
// SAFETY:
// - origin is valid (promised by caller)
// - origin ownership is transferred to this function
let url = unsafe { TCString::val_from_arg(origin) }.into_string()?;
// - url is valid (promised by caller)
// - url ownership is transferred to this function
let url = unsafe { TCString::val_from_arg(url) }.into_string()?;
// SAFETY:
// - client_id is a valid Uuid (any 8-byte sequence counts)

2
src/tc/lib/taskchampion.h
View File

@@ -433,7 +433,7 @@ EXTERN_C struct TCServer *tc_server_new_local(struct TCString server_dir, struct
// returned. The caller must free this string.
//
// The server must be freed after it is used - tc_replica_sync does not automatically free it.
EXTERN_C struct TCServer *tc_server_new_sync(struct TCString origin,
EXTERN_C struct TCServer *tc_server_new_sync(struct TCString url,
struct TCUuid client_id,
struct TCString encryption_secret,
struct TCString *error_out);