git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
blob ed02c88eb6a275894ecbea4b3280e6b07a817faf 10355 bytes (raw)
name: list-objects-filter-options.c 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
#include "cache.h"
#include "commit.h"
#include "config.h"
#include "revision.h"
#include "argv-array.h"
#include "list-objects.h"
#include "list-objects-filter.h"
#include "list-objects-filter-options.h"
#include "trace.h"

static int parse_combine_filter(
	struct list_objects_filter_options *filter_options,
	const char *arg,
	struct strbuf *errbuf);

/*
 * Parse value of the argument to the "filter" keyword.
 * On the command line this looks like:
 *       --filter=<arg>
 * and in the pack protocol as:
 *       "filter" SP <arg>
 *
 * The filter keyword will be used by many commands.
 * See Documentation/rev-list-options.txt for allowed values for <arg>.
 *
 * Capture the given arg as the "filter_spec".  This can be forwarded to
 * subordinate commands when necessary (although it's better to pass it through
 * expand_list_objects_filter_spec() first).  We also "intern" the arg for the
 * convenience of the current command.
 */
static int gently_parse_list_objects_filter(
	struct list_objects_filter_options *filter_options,
	const char *arg,
	struct strbuf *errbuf)
{
	const char *v0;

	if (filter_options->choice)
		BUG("filter_options already populated");

	if (!strcmp(arg, "blob:none")) {
		filter_options->choice = LOFC_BLOB_NONE;
		return 0;

	} else if (skip_prefix(arg, "blob:limit=", &v0)) {
		if (git_parse_ulong(v0, &filter_options->blob_limit_value)) {
			filter_options->choice = LOFC_BLOB_LIMIT;
			return 0;
		}

	} else if (skip_prefix(arg, "tree:", &v0)) {
		if (!git_parse_ulong(v0, &filter_options->tree_exclude_depth)) {
			strbuf_addstr(errbuf, _("expected 'tree:<depth>'"));
			return 1;
		}
		filter_options->choice = LOFC_TREE_DEPTH;
		return 0;

	} else if (skip_prefix(arg, "sparse:oid=", &v0)) {
		struct object_context oc;
		struct object_id sparse_oid;

		/*
		 * Try to parse <oid-expression> into an OID for the current
		 * command, but DO NOT complain if we don't have the blob or
		 * ref locally.
		 */
		if (!get_oid_with_context(the_repository, v0, GET_OID_BLOB,
					  &sparse_oid, &oc))
			filter_options->sparse_oid_value = oiddup(&sparse_oid);
		filter_options->choice = LOFC_SPARSE_OID;
		return 0;

	} else if (skip_prefix(arg, "sparse:path=", &v0)) {
		filter_options->choice = LOFC_SPARSE_PATH;
		filter_options->sparse_path_value = strdup(v0);
		return 0;

	} else if (skip_prefix(arg, "combine:", &v0)) {
		return parse_combine_filter(filter_options, v0, errbuf);

	}
	/*
	 * Please update _git_fetch() in git-completion.bash when you
	 * add new filters
	 */

	strbuf_addf(errbuf, "invalid filter-spec '%s'", arg);

	memset(filter_options, 0, sizeof(*filter_options));
	return 1;
}

static int url_decode(struct strbuf *s, struct strbuf *errbuf)
{
	char *dest = s->buf;
	char *src = s->buf;
	size_t new_len;

	while (*src) {
		if (src[0] != '%') {
			*dest++ = *src++;
			continue;
		}

		if (hex_to_bytes((unsigned char *)dest, src + 1, 1)) {
			strbuf_addstr(errbuf,
				      "error in filter-spec - "
				      "invalid hex sequence after %");
			return 1;
		}

		if (!*dest) {
			strbuf_addstr(errbuf,
				      "error in filter-spec - unexpected %00");
			return 1;
		}

		src += 3;
		dest++;
	}
	new_len = dest - s->buf;
	strbuf_remove(s, new_len, s->len - new_len);

	return 0;
}

static const char *RESERVED_NON_WS = "~`!@#$^&*()[]{}\\;'\",<>?";

static int has_reserved_character(
	struct strbuf *sub_spec, struct strbuf *errbuf)
{
	const char *c = sub_spec->buf;
	while (*c) {
		if (*c <= ' ' || strchr(RESERVED_NON_WS, *c)) {
			strbuf_addf(errbuf,
				    "must escape char in sub-filter-spec: '%c'",
				    *c);
			return 1;
		}
		c++;
	}

	return 0;
}

static int parse_combine_subfilter(
	struct list_objects_filter_options *filter_options,
	struct strbuf *subspec,
	struct strbuf *errbuf)
{
	size_t new_index = filter_options->sub_nr;

	ALLOC_GROW_BY(filter_options->sub, filter_options->sub_nr, 1,
		      filter_options->sub_alloc);

	return has_reserved_character(subspec, errbuf) ||
		url_decode(subspec, errbuf) ||
		gently_parse_list_objects_filter(
			&filter_options->sub[new_index], subspec->buf, errbuf);
}

static int parse_combine_filter(
	struct list_objects_filter_options *filter_options,
	const char *arg,
	struct strbuf *errbuf)
{
	struct strbuf **subspecs = strbuf_split_str(arg, '+', 0);
	size_t sub;
	int result;

	if (!subspecs[0]) {
		strbuf_addf(errbuf,
			    _("expected something after combine:"));
		result = 1;
		goto cleanup;
	}

	for (sub = 0; subspecs[sub]; sub++) {
		if (subspecs[sub + 1]) {
			/*
			 * This is not the last subspec. Remove trailing "+" so
			 * we can parse it.
			 */
			size_t last = subspecs[sub]->len - 1;
			assert(subspecs[sub]->buf[last] == '+');
			strbuf_remove(subspecs[sub], last, 1);
		}
		result = parse_combine_subfilter(
			filter_options, subspecs[sub], errbuf);
		if (result)
			goto cleanup;
	}

	filter_options->choice = LOFC_COMBINE;

cleanup:
	strbuf_list_free(subspecs);
	if (result) {
		list_objects_filter_release(filter_options);
		memset(filter_options, 0, sizeof(*filter_options));
	}
	return result;
}

static void add_url_encoded(struct strbuf *dest, const char *s)
{
	while (*s) {
		if (*s <= ' ' || strchr(RESERVED_NON_WS, *s) ||
			*s == '%' || *s == '+')
			strbuf_addf(dest, "%%%02X", (int)*s);
		else
			strbuf_addf(dest, "%c", *s);
		s++;
	}
}

/*
 * Changes filter_options into an equivalent LOFC_COMBINE filter options
 * instance. Does not do anything if filter_options is already LOFC_COMBINE.
 */
static void transform_to_combine_type(
	struct list_objects_filter_options *filter_options)
{
	assert(filter_options->choice);
	if (filter_options->choice == LOFC_COMBINE)
		return;
	{
		const int initial_sub_alloc = 2;
		struct list_objects_filter_options *sub_array =
			xcalloc(initial_sub_alloc, sizeof(*sub_array));
		sub_array[0] = *filter_options;
		memset(filter_options, 0, sizeof(*filter_options));
		filter_options->sub = sub_array;
		filter_options->sub_alloc = initial_sub_alloc;
	}
	filter_options->sub_nr = 1;
	filter_options->choice = LOFC_COMBINE;
	strbuf_init(&filter_options->filter_spec, 0);
	strbuf_addstr(&filter_options->filter_spec, "combine:");
	add_url_encoded(&filter_options->filter_spec,
			filter_options->sub[0].filter_spec.buf);
	/*
	 * We don't need the filter_spec strings for subfilter specs, only the
	 * top level.
	 */
	strbuf_release(&filter_options->sub[0].filter_spec);
}

void list_objects_filter_die_if_populated(
	struct list_objects_filter_options *filter_options)
{
	if (filter_options->choice)
		die(_("multiple filter-specs cannot be combined"));
}

void parse_list_objects_filter(
	struct list_objects_filter_options *filter_options,
	const char *arg)
{
	struct strbuf errbuf = STRBUF_INIT;
	int parse_error;

	if (!filter_options->choice) {
		strbuf_init(&filter_options->filter_spec, 0);
		strbuf_addstr(&filter_options->filter_spec, arg);

		parse_error = gently_parse_list_objects_filter(
			filter_options, arg, &errbuf);
	} else {
		/*
		 * Make filter_options an LOFC_COMBINE spec so we can trivially
		 * add subspecs to it.
		 */
		transform_to_combine_type(filter_options);

		strbuf_addstr(&filter_options->filter_spec, "+");
		add_url_encoded(&filter_options->filter_spec, arg);
		trace_printf("Generated composite filter-spec: %s\n",
			     filter_options->filter_spec.buf);
		ALLOC_GROW_BY(filter_options->sub, filter_options->sub_nr, 1,
			      filter_options->sub_alloc);

		parse_error = gently_parse_list_objects_filter(
			&filter_options->sub[filter_options->sub_nr - 1], arg,
			&errbuf);
	}
	if (parse_error)
		die("%s", errbuf.buf);
}

int opt_parse_list_objects_filter(const struct option *opt,
				  const char *arg, int unset)
{
	struct list_objects_filter_options *filter_options = opt->value;

	if (unset || !arg)
		list_objects_filter_set_no_filter(filter_options);
	else
		parse_list_objects_filter(filter_options, arg);
	return 0;
}

void expand_list_objects_filter_spec(
	const struct list_objects_filter_options *filter,
	struct strbuf *expanded_spec)
{
	strbuf_init(expanded_spec, 0);
	if (filter->choice == LOFC_BLOB_LIMIT)
		strbuf_addf(expanded_spec, "blob:limit=%lu",
			    filter->blob_limit_value);
	else if (filter->choice == LOFC_TREE_DEPTH)
		strbuf_addf(expanded_spec, "tree:%lu",
			    filter->tree_exclude_depth);
	else
		strbuf_addstr(expanded_spec, filter->filter_spec.buf);
}

void list_objects_filter_release(
	struct list_objects_filter_options *filter_options)
{
	size_t sub;

	if (!filter_options)
		return;
	strbuf_release(&filter_options->filter_spec);
	free(filter_options->sparse_oid_value);
	free(filter_options->sparse_path_value);
	for (sub = 0; sub < filter_options->sub_nr; sub++)
		list_objects_filter_release(&filter_options->sub[sub]);
	free(filter_options->sub);
	memset(filter_options, 0, sizeof(*filter_options));
}

void partial_clone_register(
	const char *remote,
	const struct list_objects_filter_options *filter_options)
{
	/*
	 * Record the name of the partial clone remote in the
	 * config and in the global variable -- the latter is
	 * used throughout to indicate that partial clone is
	 * enabled and to expect missing objects.
	 */
	if (repository_format_partial_clone &&
	    *repository_format_partial_clone &&
	    strcmp(remote, repository_format_partial_clone))
		die(_("cannot change partial clone promisor remote"));

	git_config_set("core.repositoryformatversion", "1");
	git_config_set("extensions.partialclone", remote);

	repository_format_partial_clone = xstrdup(remote);

	/*
	 * Record the initial filter-spec in the config as
	 * the default for subsequent fetches from this remote.
	 */
	core_partial_clone_filter_default =
		xstrdup(filter_options->filter_spec.buf);
	git_config_set("core.partialclonefilter",
		       core_partial_clone_filter_default);
}

void partial_clone_get_default_filter_spec(
	struct list_objects_filter_options *filter_options)
{
	struct strbuf errbuf = STRBUF_INIT;

	/*
	 * Parse default value, but silently ignore it if it is invalid.
	 */
	if (!core_partial_clone_filter_default)
		return;

	if (!filter_options->filter_spec.buf)
		strbuf_init(&filter_options->filter_spec, 0);
	strbuf_addstr(&filter_options->filter_spec,
		      core_partial_clone_filter_default);
	gently_parse_list_objects_filter(filter_options,
					 core_partial_clone_filter_default,
					 &errbuf);
	strbuf_release(&errbuf);
}

debug log:

solving ed02c88eb6 ...
found ed02c88eb6 in https://public-inbox.org/git/20190601003603.90794-10-matvore@google.com/
found d8abe6cfcf in https://public-inbox.org/git/20190601003603.90794-9-matvore@google.com/
found 5e98e4a309 in https://public-inbox.org/git/20190601003603.90794-8-matvore@google.com/
found 5687425847 in https://public-inbox.org/git/20190601003603.90794-7-matvore@google.com/
found e8132b811e in https://public-inbox.org/git/20190601003603.90794-6-matvore@google.com/
found 0f1d4181cb in https://public-inbox.org/git/20190601003603.90794-5-matvore@google.com/
found aef24ddae3 in https://public-inbox.org/git/20190601003603.90794-4-matvore@google.com/ ||
	https://public-inbox.org/git/a0f5671d4865f5325b7a75de57b30a5ac4e611a8.1560462201.git.matvore@google.com/
found c0036f7378 in https://80x24.org/mirrors/git.git
preparing index
index prepared:
100644 c0036f73789d1a6a3ff88a76c3838241e65ca868	list-objects-filter-options.c

applying [1/7] https://public-inbox.org/git/20190601003603.90794-4-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index c0036f7378..aef24ddae3 100644

Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.

skipping https://public-inbox.org/git/a0f5671d4865f5325b7a75de57b30a5ac4e611a8.1560462201.git.matvore@google.com/ for aef24ddae3
index at:
100644 aef24ddae3d82df8004ffeeafd3c115a91e9323b	list-objects-filter-options.c

applying [2/7] https://public-inbox.org/git/20190601003603.90794-5-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index aef24ddae3..0f1d4181cb 100644


applying [3/7] https://public-inbox.org/git/20190601003603.90794-6-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index 0f1d4181cb..e8132b811e 100644


applying [4/7] https://public-inbox.org/git/20190601003603.90794-7-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index e8132b811e..5687425847 100644


applying [5/7] https://public-inbox.org/git/20190601003603.90794-8-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index 5687425847..5e98e4a309 100644


applying [6/7] https://public-inbox.org/git/20190601003603.90794-9-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index 5e98e4a309..d8abe6cfcf 100644


applying [7/7] https://public-inbox.org/git/20190601003603.90794-10-matvore@google.com/
diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
index d8abe6cfcf..ed02c88eb6 100644

Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.
Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.
Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.
Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.
Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.
Checking patch list-objects-filter-options.c...
Applied patch list-objects-filter-options.c cleanly.

index at:
100644 ed02c88eb6a275894ecbea4b3280e6b07a817faf	list-objects-filter-options.c

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).