`promisor.acceptFromServer` config variable is not set to "None". If
set to "None", this config variable has no effect. See
linkgit:gitprotocol-v2[5].
+
+promisor.storeFields::
+ A comma or space separated list of additional remote related
+ field names. If a client accepts an advertised remote, the
+ client will store the values associated with these field names
+ taken from the remote advertisement into its configuration,
+ and then reload its remote configuration. Currently,
+ "partialCloneFilter" and "token" are the only supported field
+ names.
++
+For example if a server advertises "partialCloneFilter=blob:limit=20k"
+for remote "foo", and that remote is accepted, then "blob:limit=20k"
+will be stored for the "remote.foo.partialCloneFilter" configuration
+variable.
++
+If the new field value from an advertised remote is the same as the
+existing field value for that remote on the client side, then no
+change is made to the client configuration though.
++
+When a new value is stored, a message is printed to standard error to
+let users know about this.
++
+Note that for security reasons, if the remote is not already
+configured on the client side, nothing will be stored for that
+remote. In any case, no new remote will be created and no URL will be
+stored.
++
+Before storing a partial clone filter, it's parsed to check it's
+valid. If it's not, a warning is emitted and it's not stored.
++
+Before storing a token, a check is performed to ensure it contains no
+control character. If the check fails, a warning is emitted and it's
+not stored.
above. Clients MUST ignore fields they don't recognize to allow for
future protocol extensions.
-For now, the client can only use information transmitted through these
-fields to decide if it accepts the advertised promisor remote. In the
-future that information might be used for other purposes though.
+The client can use information transmitted through these fields to
+decide if it accepts the advertised promisor remote. Also, the client
+can be configured to store the values of these fields (see
+"promisor.storeFields" in linkgit:git-config[1]).
Field values MUST be urlencoded.
On the server side, the "promisor.advertise" and "promisor.sendFields"
configuration options can be used to control what it advertises. On
the client side, the "promisor.acceptFromServer" configuration option
-can be used to control what it accepts. See the documentation of these
-configuration options for more information.
+can be used to control what it accepts, and the "promisor.storeFields"
+option, to control what it stores. See the documentation of these
+configuration options in linkgit:git-config[1] for more information.
Note that in the future it would be nice if the "promisor-remote"
protocol capability could be used by the server, when responding to
return initialize_fields_list(&fields_list, &initialized, "promisor.checkFields");
}
+static struct string_list *fields_stored(void)
+{
+ static struct string_list fields_list = STRING_LIST_INIT_NODUP;
+ static int initialized;
+
+ return initialize_fields_list(&fields_list, &initialized, "promisor.storeFields");
+}
+
/*
* Struct for promisor remotes involved in the "promisor-remote"
* protocol capability.
return info;
}
+static bool store_one_field(struct repository *repo, const char *remote_name,
+ const char *field_name, const char *field_key,
+ const char *advertised, const char *current)
+{
+ if (advertised && (!current || strcmp(current, advertised))) {
+ char *key = xstrfmt("remote.%s.%s", remote_name, field_key);
+
+ fprintf(stderr, _("Storing new %s from server for remote '%s'.\n"
+ " '%s' -> '%s'\n"),
+ field_name, remote_name,
+ current ? current : "",
+ advertised);
+
+ repo_config_set_worktree_gently(repo, key, advertised);
+ free(key);
+
+ return true;
+ }
+
+ return false;
+}
+
+/* Check that a filter is valid by parsing it */
+static bool valid_filter(const char *filter, const char *remote_name)
+{
+ struct list_objects_filter_options filter_opts = LIST_OBJECTS_FILTER_INIT;
+ struct strbuf err = STRBUF_INIT;
+ int res = gently_parse_list_objects_filter(&filter_opts, filter, &err);
+
+ if (res)
+ warning(_("invalid filter '%s' for remote '%s' "
+ "will not be stored: %s"),
+ filter, remote_name, err.buf);
+
+ list_objects_filter_release(&filter_opts);
+ strbuf_release(&err);
+
+ return !res;
+}
+
+/* Check that a token doesn't contain any control character */
+static bool valid_token(const char *token, const char *remote_name)
+{
+ const char *c = token;
+
+ for (; *c; c++)
+ if (iscntrl(*c)) {
+ warning(_("invalid token '%s' for remote '%s' "
+ "will not be stored"),
+ token, remote_name);
+ return false;
+ }
+
+ return true;
+}
+
+struct store_info {
+ struct repository *repo;
+ struct string_list config_info;
+ bool store_filter;
+ bool store_token;
+};
+
+static struct store_info *new_store_info(struct repository *repo)
+{
+ struct string_list *fields_to_store = fields_stored();
+ struct store_info *s = xmalloc(sizeof(*s));
+
+ s->repo = repo;
+
+ string_list_init_nodup(&s->config_info);
+ promisor_config_info_list(repo, &s->config_info, fields_to_store);
+ string_list_sort(&s->config_info);
+
+ s->store_filter = !!string_list_lookup(fields_to_store, promisor_field_filter);
+ s->store_token = !!string_list_lookup(fields_to_store, promisor_field_token);
+
+ return s;
+}
+
+static void free_store_info(struct store_info *s)
+{
+ if (s) {
+ promisor_info_list_clear(&s->config_info);
+ free(s);
+ }
+}
+
+static bool promisor_store_advertised_fields(struct promisor_info *advertised,
+ struct store_info *store_info)
+{
+ struct promisor_info *p;
+ struct string_list_item *item;
+ const char *remote_name = advertised->name;
+ bool reload_config = false;
+
+ if (!(store_info->store_filter || store_info->store_token))
+ return false;
+
+ /*
+ * Get existing config info for the advertised promisor
+ * remote. This ensures the remote is already configured on
+ * the client side.
+ */
+ item = string_list_lookup(&store_info->config_info, remote_name);
+
+ if (!item)
+ return false;
+
+ p = item->util;
+
+ if (store_info->store_filter && advertised->filter &&
+ valid_filter(advertised->filter, remote_name))
+ reload_config |= store_one_field(store_info->repo, remote_name,
+ "filter", promisor_field_filter,
+ advertised->filter, p->filter);
+
+ if (store_info->store_token && advertised->token &&
+ valid_token(advertised->token, remote_name))
+ reload_config |= store_one_field(store_info->repo, remote_name,
+ "token", promisor_field_token,
+ advertised->token, p->token);
+
+ return reload_config;
+}
+
static void filter_promisor_remote(struct repository *repo,
struct strvec *accepted,
const char *info)
enum accept_promisor accept = ACCEPT_NONE;
struct string_list config_info = STRING_LIST_INIT_NODUP;
struct string_list remote_info = STRING_LIST_INIT_DUP;
+ struct store_info *store_info = NULL;
struct string_list_item *item;
+ bool reload_config = false;
if (!repo_config_get_string_tmp(the_repository, "promisor.acceptfromserver", &accept_str)) {
if (!*accept_str || !strcasecmp("None", accept_str))
string_list_sort(&config_info);
}
- if (should_accept_remote(accept, advertised, &config_info))
+ if (should_accept_remote(accept, advertised, &config_info)) {
+ if (!store_info)
+ store_info = new_store_info(repo);
+ if (promisor_store_advertised_fields(advertised, store_info))
+ reload_config = true;
+
strvec_push(accepted, advertised->name);
+ }
promisor_info_free(advertised);
}
promisor_info_list_clear(&config_info);
string_list_clear(&remote_info, 0);
+ free_store_info(store_info);
+
+ if (reload_config)
+ repo_promisor_remote_reinit(repo);
}
char *promisor_remote_reply(const char *info)
check_missing_objects server 1 "$oid"
'
+test_expect_success "clone with promisor.storeFields=partialCloneFilter" '
+ git -C server config promisor.advertise true &&
+ test_when_finished "rm -rf client" &&
+
+ git -C server remote add otherLop "https://invalid.invalid" &&
+ git -C server config remote.otherLop.token "fooBar" &&
+ git -C server config remote.otherLop.stuff "baz" &&
+ git -C server config remote.otherLop.partialCloneFilter "blob:limit=10k" &&
+ test_when_finished "git -C server remote remove otherLop" &&
+
+ git -C server config remote.lop.token "fooXXX" &&
+ git -C server config remote.lop.partialCloneFilter "blob:limit=8k" &&
+
+ test_config -C server promisor.sendFields "partialCloneFilter, token" &&
+ test_when_finished "rm trace" &&
+
+ # Clone from server to create a client
+ GIT_TRACE_PACKET="$(pwd)/trace" GIT_NO_LAZY_FETCH=0 git clone \
+ -c remote.lop.promisor=true \
+ -c remote.lop.fetch="+refs/heads/*:refs/remotes/lop/*" \
+ -c remote.lop.url="file://$(pwd)/lop" \
+ -c remote.lop.token="fooYYY" \
+ -c remote.lop.partialCloneFilter="blob:none" \
+ -c promisor.acceptfromserver=All \
+ -c promisor.storeFields=partialcloneFilter \
+ --no-local --filter="blob:limit=5k" server client 2>err &&
+
+ # Check that the filter from the server is stored
+ echo "blob:limit=8k" >expected &&
+ git -C client config remote.lop.partialCloneFilter >actual &&
+ test_cmp expected actual &&
+
+ # Check that user is notified when the filter is stored
+ test_grep "Storing new filter from server for remote '\''lop'\''" err &&
+ test_grep "'\''blob:none'\'' -> '\''blob:limit=8k'\''" err &&
+
+ # Check that the token from the server is NOT stored
+ echo "fooYYY" >expected &&
+ git -C client config remote.lop.token >actual &&
+ test_cmp expected actual &&
+ test_grep ! "Storing new token from server" err &&
+
+ # Check that the filter for an unknown remote is NOT stored
+ test_must_fail git -C client config remote.otherLop.partialCloneFilter >actual &&
+
+ # Check that the largest object is still missing on the server
+ check_missing_objects server 1 "$oid"
+'
+
test_expect_success "clone with promisor.advertise set to 'true' but don't delete the client" '
git -C server config promisor.advertise true &&
projects / thirdparty / git.git / commitdiff
