list-objects-filter-options.c

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