]> git.ipfire.org Git - thirdparty/git.git/blame - list-objects-filter-options.c
transport: free filter options in disconnect_git()
[thirdparty/git.git] / list-objects-filter-options.c
CommitLineData
25ec7bca
JH
1#include "cache.h"
2#include "commit.h"
3#include "config.h"
4#include "revision.h"
dbbcd44f 5#include "strvec.h"
25ec7bca
JH
6#include "list-objects.h"
7#include "list-objects-filter.h"
8#include "list-objects-filter-options.h"
b14ed5ad 9#include "promisor-remote.h"
489fc9ee 10#include "trace.h"
e987df5f
MD
11#include "url.h"
12
13static int parse_combine_filter(
14 struct list_objects_filter_options *filter_options,
15 const char *arg,
16 struct strbuf *errbuf);
25ec7bca 17
b9ea2147
TB
18const char *list_object_filter_config_name(enum list_objects_filter_choice c)
19{
20 switch (c) {
21 case LOFC_DISABLED:
22 /* we have no name for "no filter at all" */
23 break;
24 case LOFC_BLOB_NONE:
25 return "blob:none";
26 case LOFC_BLOB_LIMIT:
27 return "blob:limit";
28 case LOFC_TREE_DEPTH:
29 return "tree";
30 case LOFC_SPARSE_OID:
31 return "sparse:oid";
b0c42a53
PS
32 case LOFC_OBJECT_TYPE:
33 return "object:type";
b9ea2147
TB
34 case LOFC_COMBINE:
35 return "combine";
36 case LOFC__COUNT:
37 /* not a real filter type; just the count of all filters */
38 break;
39 }
5a923bb1 40 BUG("list_object_filter_config_name: invalid argument '%d'", c);
b9ea2147
TB
41}
42
105c6f14 43int gently_parse_list_objects_filter(
1e1e39b3
JH
44 struct list_objects_filter_options *filter_options,
45 const char *arg,
46 struct strbuf *errbuf)
25ec7bca
JH
47{
48 const char *v0;
49
fa3d1b63
CC
50 if (!arg)
51 return 0;
52
f56f7642
MD
53 if (filter_options->choice)
54 BUG("filter_options already populated");
25ec7bca
JH
55
56 if (!strcmp(arg, "blob:none")) {
57 filter_options->choice = LOFC_BLOB_NONE;
58 return 0;
25ec7bca 59
1e1e39b3
JH
60 } else if (skip_prefix(arg, "blob:limit=", &v0)) {
61 if (git_parse_ulong(v0, &filter_options->blob_limit_value)) {
62 filter_options->choice = LOFC_BLOB_LIMIT;
63 return 0;
64 }
25ec7bca 65
bc5975d2 66 } else if (skip_prefix(arg, "tree:", &v0)) {
c813a7c3 67 if (!git_parse_ulong(v0, &filter_options->tree_exclude_depth)) {
842b0051 68 strbuf_addstr(errbuf, _("expected 'tree:<depth>'"));
bc5975d2
MD
69 return 1;
70 }
c813a7c3 71 filter_options->choice = LOFC_TREE_DEPTH;
bc5975d2
MD
72 return 0;
73
1e1e39b3 74 } else if (skip_prefix(arg, "sparse:oid=", &v0)) {
4c96a775 75 filter_options->sparse_oid_name = xstrdup(v0);
25ec7bca
JH
76 filter_options->choice = LOFC_SPARSE_OID;
77 return 0;
25ec7bca 78
1e1e39b3 79 } else if (skip_prefix(arg, "sparse:path=", &v0)) {
e693237e
CC
80 if (errbuf) {
81 strbuf_addstr(
82 errbuf,
83 _("sparse:path filters support has been dropped"));
84 }
85 return 1;
e987df5f 86
b0c42a53
PS
87 } else if (skip_prefix(arg, "object:type=", &v0)) {
88 int type = type_from_string_gently(v0, strlen(v0), 1);
89 if (type < 0) {
225f7fa8 90 strbuf_addf(errbuf, _("'%s' for 'object:type=<type>' is "
b0c42a53
PS
91 "not a valid object type"), v0);
92 return 1;
93 }
94
95 filter_options->object_type = type;
96 filter_options->choice = LOFC_OBJECT_TYPE;
97
98 return 0;
99
e987df5f
MD
100 } else if (skip_prefix(arg, "combine:", &v0)) {
101 return parse_combine_filter(filter_options, v0, errbuf);
102
25ec7bca 103 }
5a59a230
NTND
104 /*
105 * Please update _git_fetch() in git-completion.bash when you
106 * add new filters
107 */
25ec7bca 108
842b0051 109 strbuf_addf(errbuf, _("invalid filter-spec '%s'"), arg);
cc0b05a4 110
1e1e39b3
JH
111 memset(filter_options, 0, sizeof(*filter_options));
112 return 1;
113}
114
e987df5f
MD
115static const char *RESERVED_NON_WS = "~`!@#$^&*()[]{}\\;'\",<>?";
116
117static int has_reserved_character(
118 struct strbuf *sub_spec, struct strbuf *errbuf)
1e1e39b3 119{
e987df5f
MD
120 const char *c = sub_spec->buf;
121 while (*c) {
122 if (*c <= ' ' || strchr(RESERVED_NON_WS, *c)) {
123 strbuf_addf(
124 errbuf,
125 _("must escape char in sub-filter-spec: '%c'"),
126 *c);
127 return 1;
128 }
129 c++;
130 }
131
25ec7bca
JH
132 return 0;
133}
134
e987df5f
MD
135static int parse_combine_subfilter(
136 struct list_objects_filter_options *filter_options,
137 struct strbuf *subspec,
138 struct strbuf *errbuf)
139{
5a133e8a 140 size_t new_index = filter_options->sub_nr;
e987df5f
MD
141 char *decoded;
142 int result;
143
5a133e8a
MD
144 ALLOC_GROW_BY(filter_options->sub, filter_options->sub_nr, 1,
145 filter_options->sub_alloc);
e987df5f
MD
146
147 decoded = url_percent_decode(subspec->buf);
148
149 result = has_reserved_character(subspec, errbuf) ||
150 gently_parse_list_objects_filter(
151 &filter_options->sub[new_index], decoded, errbuf);
152
153 free(decoded);
154 return result;
155}
156
157static int parse_combine_filter(
158 struct list_objects_filter_options *filter_options,
159 const char *arg,
160 struct strbuf *errbuf)
161{
162 struct strbuf **subspecs = strbuf_split_str(arg, '+', 0);
163 size_t sub;
164 int result = 0;
165
166 if (!subspecs[0]) {
167 strbuf_addstr(errbuf, _("expected something after combine:"));
168 result = 1;
169 goto cleanup;
170 }
171
172 for (sub = 0; subspecs[sub] && !result; sub++) {
173 if (subspecs[sub + 1]) {
174 /*
175 * This is not the last subspec. Remove trailing "+" so
176 * we can parse it.
177 */
178 size_t last = subspecs[sub]->len - 1;
179 assert(subspecs[sub]->buf[last] == '+');
180 strbuf_remove(subspecs[sub], last, 1);
181 }
182 result = parse_combine_subfilter(
183 filter_options, subspecs[sub], errbuf);
184 }
185
186 filter_options->choice = LOFC_COMBINE;
187
188cleanup:
189 strbuf_list_free(subspecs);
190 if (result) {
191 list_objects_filter_release(filter_options);
192 memset(filter_options, 0, sizeof(*filter_options));
193 }
194 return result;
195}
196
489fc9ee
MD
197static int allow_unencoded(char ch)
198{
199 if (ch <= ' ' || ch == '%' || ch == '+')
200 return 0;
201 return !strchr(RESERVED_NON_WS, ch);
202}
203
204static void filter_spec_append_urlencode(
205 struct list_objects_filter_options *filter, const char *raw)
1e1e39b3
JH
206{
207 struct strbuf buf = STRBUF_INIT;
489fc9ee
MD
208 strbuf_addstr_urlencode(&buf, raw, allow_unencoded);
209 trace_printf("Add to combine filter-spec: %s\n", buf.buf);
210 string_list_append(&filter->filter_spec, strbuf_detach(&buf, NULL));
211}
212
213/*
214 * Changes filter_options into an equivalent LOFC_COMBINE filter options
215 * instance. Does not do anything if filter_options is already LOFC_COMBINE.
216 */
217static void transform_to_combine_type(
218 struct list_objects_filter_options *filter_options)
219{
220 assert(filter_options->choice);
221 if (filter_options->choice == LOFC_COMBINE)
222 return;
223 {
224 const int initial_sub_alloc = 2;
225 struct list_objects_filter_options *sub_array =
226 xcalloc(initial_sub_alloc, sizeof(*sub_array));
227 sub_array[0] = *filter_options;
228 memset(filter_options, 0, sizeof(*filter_options));
229 filter_options->sub = sub_array;
230 filter_options->sub_alloc = initial_sub_alloc;
231 }
232 filter_options->sub_nr = 1;
233 filter_options->choice = LOFC_COMBINE;
234 string_list_append(&filter_options->filter_spec, xstrdup("combine:"));
235 filter_spec_append_urlencode(
236 filter_options,
237 list_objects_filter_spec(&filter_options->sub[0]));
238 /*
239 * We don't need the filter_spec strings for subfilter specs, only the
240 * top level.
241 */
242 string_list_clear(&filter_options->sub[0].filter_spec, /*free_util=*/0);
243}
244
245void list_objects_filter_die_if_populated(
246 struct list_objects_filter_options *filter_options)
247{
f56f7642
MD
248 if (filter_options->choice)
249 die(_("multiple filter-specs cannot be combined"));
489fc9ee
MD
250}
251
90d21f9e 252void parse_list_objects_filter(
489fc9ee
MD
253 struct list_objects_filter_options *filter_options,
254 const char *arg)
255{
256 struct strbuf errbuf = STRBUF_INIT;
257 int parse_error;
258
259 if (!filter_options->choice) {
260 string_list_append(&filter_options->filter_spec, xstrdup(arg));
261
262 parse_error = gently_parse_list_objects_filter(
263 filter_options, arg, &errbuf);
264 } else {
265 /*
266 * Make filter_options an LOFC_COMBINE spec so we can trivially
267 * add subspecs to it.
268 */
269 transform_to_combine_type(filter_options);
270
271 string_list_append(&filter_options->filter_spec, xstrdup("+"));
272 filter_spec_append_urlencode(filter_options, arg);
5a133e8a
MD
273 ALLOC_GROW_BY(filter_options->sub, filter_options->sub_nr, 1,
274 filter_options->sub_alloc);
489fc9ee
MD
275
276 parse_error = gently_parse_list_objects_filter(
5a133e8a
MD
277 &filter_options->sub[filter_options->sub_nr - 1], arg,
278 &errbuf);
489fc9ee
MD
279 }
280 if (parse_error)
281 die("%s", errbuf.buf);
25ec7bca
JH
282}
283
284int opt_parse_list_objects_filter(const struct option *opt,
285 const char *arg, int unset)
286{
287 struct list_objects_filter_options *filter_options = opt->value;
5cb28270
ÆAB
288 opt_lof_init init = (opt_lof_init)opt->defval;
289
290 if (init)
291 filter_options = init(opt->value);
25ec7bca 292
90d21f9e 293 if (unset || !arg)
aa57b871 294 list_objects_filter_set_no_filter(filter_options);
90d21f9e
MD
295 else
296 parse_list_objects_filter(filter_options, arg);
297 return 0;
25ec7bca 298}
4875c979 299
cf9ceb5a 300const char *list_objects_filter_spec(struct list_objects_filter_options *filter)
87c2d9d3 301{
cf9ceb5a
MD
302 if (!filter->filter_spec.nr)
303 BUG("no filter_spec available for this filter");
304 if (filter->filter_spec.nr != 1) {
305 struct strbuf concatted = STRBUF_INIT;
306 strbuf_add_separated_string_list(
307 &concatted, "", &filter->filter_spec);
308 string_list_clear(&filter->filter_spec, /*free_util=*/0);
309 string_list_append(
310 &filter->filter_spec, strbuf_detach(&concatted, NULL));
4875c979 311 }
25ec7bca 312
cf9ceb5a 313 return filter->filter_spec.items[0].string;
25ec7bca 314}
4875c979 315
cf9ceb5a
MD
316const char *expand_list_objects_filter_spec(
317 struct list_objects_filter_options *filter)
87c2d9d3 318{
cf9ceb5a
MD
319 if (filter->choice == LOFC_BLOB_LIMIT) {
320 struct strbuf expanded_spec = STRBUF_INIT;
321 strbuf_addf(&expanded_spec, "blob:limit=%lu",
87c2d9d3 322 filter->blob_limit_value);
cf9ceb5a
MD
323 string_list_clear(&filter->filter_spec, /*free_util=*/0);
324 string_list_append(
325 &filter->filter_spec,
326 strbuf_detach(&expanded_spec, NULL));
327 }
328
329 return list_objects_filter_spec(filter);
87c2d9d3
JS
330}
331
4875c979
JH
332void list_objects_filter_release(
333 struct list_objects_filter_options *filter_options)
334{
e987df5f
MD
335 size_t sub;
336
337 if (!filter_options)
338 return;
cf9ceb5a 339 string_list_clear(&filter_options->filter_spec, /*free_util=*/0);
4c96a775 340 free(filter_options->sparse_oid_name);
e987df5f
MD
341 for (sub = 0; sub < filter_options->sub_nr; sub++)
342 list_objects_filter_release(&filter_options->sub[sub]);
343 free(filter_options->sub);
4875c979
JH
344 memset(filter_options, 0, sizeof(*filter_options));
345}
1e1e39b3
JH
346
347void partial_clone_register(
348 const char *remote,
cf9ceb5a 349 struct list_objects_filter_options *filter_options)
1e1e39b3 350{
23547c40 351 struct promisor_remote *promisor_remote;
b14ed5ad 352 char *cfg_name;
fa3d1b63 353 char *filter_name;
1e1e39b3 354
b14ed5ad 355 /* Check if it is already registered */
23547c40
JT
356 if ((promisor_remote = promisor_remote_find(remote))) {
357 if (promisor_remote->partial_clone_filter)
358 /*
359 * Remote is already registered and a filter is already
360 * set, so we don't need to do anything here.
361 */
362 return;
363 } else {
16af5f1a
XL
364 if (upgrade_repository_format(1) < 0)
365 die(_("unable to upgrade repository format to support partial clone"));
1e1e39b3 366
b14ed5ad
CC
367 /* Add promisor config for the remote */
368 cfg_name = xstrfmt("remote.%s.promisor", remote);
369 git_config_set(cfg_name, "true");
370 free(cfg_name);
371 }
1e1e39b3
JH
372
373 /*
374 * Record the initial filter-spec in the config as
375 * the default for subsequent fetches from this remote.
376 */
fa3d1b63 377 filter_name = xstrfmt("remote.%s.partialclonefilter", remote);
627b8268
JH
378 /* NEEDSWORK: 'expand' result leaking??? */
379 git_config_set(filter_name,
380 expand_list_objects_filter_spec(filter_options));
fa3d1b63 381 free(filter_name);
b14ed5ad
CC
382
383 /* Make sure the config info are reset */
384 promisor_remote_reinit();
1e1e39b3
JH
385}
386
387void partial_clone_get_default_filter_spec(
fa3d1b63
CC
388 struct list_objects_filter_options *filter_options,
389 const char *remote)
1e1e39b3 390{
fa3d1b63 391 struct promisor_remote *promisor = promisor_remote_find(remote);
842b0051 392 struct strbuf errbuf = STRBUF_INIT;
fa3d1b63 393
1e1e39b3
JH
394 /*
395 * Parse default value, but silently ignore it if it is invalid.
396 */
627b8268 397 if (!promisor)
cac1137d 398 return;
e987df5f 399
cf9ceb5a 400 string_list_append(&filter_options->filter_spec,
627b8268 401 promisor->partial_clone_filter);
1e1e39b3 402 gently_parse_list_objects_filter(filter_options,
627b8268 403 promisor->partial_clone_filter,
842b0051
MD
404 &errbuf);
405 strbuf_release(&errbuf);
1e1e39b3 406}
4a4c3f9b
DS
407
408void list_objects_filter_copy(
409 struct list_objects_filter_options *dest,
410 const struct list_objects_filter_options *src)
411{
412 int i;
413 struct string_list_item *item;
414
415 /* Copy everything. We will overwrite the pointers shortly. */
416 memcpy(dest, src, sizeof(struct list_objects_filter_options));
417
418 string_list_init_dup(&dest->filter_spec);
419 for_each_string_list_item(item, &src->filter_spec)
420 string_list_append(&dest->filter_spec, item->string);
3fbfbbb7 421 dest->sparse_oid_name = xstrdup_or_null(src->sparse_oid_name);
4a4c3f9b
DS
422
423 ALLOC_ARRAY(dest->sub, dest->sub_alloc);
424 for (i = 0; i < src->sub_nr; i++)
425 list_objects_filter_copy(&dest->sub[i], &src->sub[i]);
426}