Coverage Report

Created: 2024-09-08 06:23

/src/git/archive.c
Line
Count
Source (jump to first uncovered line)
1
#define USE_THE_REPOSITORY_VARIABLE
2
3
#include "git-compat-util.h"
4
#include "abspath.h"
5
#include "config.h"
6
#include "convert.h"
7
#include "environment.h"
8
#include "gettext.h"
9
#include "hex.h"
10
#include "object-name.h"
11
#include "path.h"
12
#include "pretty.h"
13
#include "setup.h"
14
#include "refs.h"
15
#include "object-store-ll.h"
16
#include "commit.h"
17
#include "tree.h"
18
#include "tree-walk.h"
19
#include "attr.h"
20
#include "archive.h"
21
#include "parse-options.h"
22
#include "unpack-trees.h"
23
#include "quote.h"
24
25
static char const * const archive_usage[] = {
26
  N_("git archive [<options>] <tree-ish> [<path>...]"),
27
  "git archive --list",
28
  N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
29
  N_("git archive --remote <repo> [--exec <cmd>] --list"),
30
  NULL
31
};
32
33
static const struct archiver **archivers;
34
static int nr_archivers;
35
static int alloc_archivers;
36
static int remote_allow_unreachable;
37
38
void register_archiver(struct archiver *ar)
39
0
{
40
0
  ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
41
0
  archivers[nr_archivers++] = ar;
42
0
}
43
44
void init_archivers(void)
45
0
{
46
0
  init_tar_archiver();
47
0
  init_zip_archiver();
48
0
}
49
50
static void format_subst(const struct commit *commit,
51
       const char *src, size_t len,
52
       struct strbuf *buf, struct pretty_print_context *ctx)
53
0
{
54
0
  char *to_free = NULL;
55
0
  struct strbuf fmt = STRBUF_INIT;
56
57
0
  if (src == buf->buf)
58
0
    to_free = strbuf_detach(buf, NULL);
59
0
  for (;;) {
60
0
    const char *b, *c;
61
62
0
    b = memmem(src, len, "$Format:", 8);
63
0
    if (!b)
64
0
      break;
65
0
    c = memchr(b + 8, '$', (src + len) - b - 8);
66
0
    if (!c)
67
0
      break;
68
69
0
    strbuf_reset(&fmt);
70
0
    strbuf_add(&fmt, b + 8, c - b - 8);
71
72
0
    strbuf_add(buf, src, b - src);
73
0
    repo_format_commit_message(the_repository, commit, fmt.buf,
74
0
             buf, ctx);
75
0
    len -= c + 1 - src;
76
0
    src  = c + 1;
77
0
  }
78
0
  strbuf_add(buf, src, len);
79
0
  strbuf_release(&fmt);
80
0
  free(to_free);
81
0
}
82
83
static void *object_file_to_archive(const struct archiver_args *args,
84
            const char *path,
85
            const struct object_id *oid,
86
            unsigned int mode,
87
            enum object_type *type,
88
            unsigned long *sizep)
89
0
{
90
0
  void *buffer;
91
0
  const struct commit *commit = args->convert ? args->commit : NULL;
92
0
  struct checkout_metadata meta;
93
94
0
  init_checkout_metadata(&meta, args->refname,
95
0
             args->commit_oid ? args->commit_oid :
96
0
             (args->tree ? &args->tree->object.oid : NULL), oid);
97
98
0
  path += args->baselen;
99
0
  buffer = repo_read_object_file(the_repository, oid, type, sizep);
100
0
  if (buffer && S_ISREG(mode)) {
101
0
    struct strbuf buf = STRBUF_INIT;
102
0
    size_t size = 0;
103
104
0
    strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
105
0
    convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf, &meta);
106
0
    if (commit)
107
0
      format_subst(commit, buf.buf, buf.len, &buf, args->pretty_ctx);
108
0
    buffer = strbuf_detach(&buf, &size);
109
0
    *sizep = size;
110
0
  }
111
112
0
  return buffer;
113
0
}
114
115
struct directory {
116
  struct directory *up;
117
  struct object_id oid;
118
  int baselen, len;
119
  unsigned mode;
120
  char path[FLEX_ARRAY];
121
};
122
123
struct archiver_context {
124
  struct archiver_args *args;
125
  write_archive_entry_fn_t write_entry;
126
  struct directory *bottom;
127
};
128
129
static const struct attr_check *get_archive_attrs(struct index_state *istate,
130
              const char *path)
131
0
{
132
0
  static struct attr_check *check;
133
0
  if (!check)
134
0
    check = attr_check_initl("export-ignore", "export-subst", NULL);
135
0
  git_check_attr(istate, path, check);
136
0
  return check;
137
0
}
138
139
static int check_attr_export_ignore(const struct attr_check *check)
140
0
{
141
0
  return check && ATTR_TRUE(check->items[0].value);
142
0
}
143
144
static int check_attr_export_subst(const struct attr_check *check)
145
0
{
146
0
  return check && ATTR_TRUE(check->items[1].value);
147
0
}
148
149
static int write_archive_entry(const struct object_id *oid, const char *base,
150
    int baselen, const char *filename, unsigned mode,
151
    void *context)
152
0
{
153
0
  static struct strbuf path = STRBUF_INIT;
154
0
  struct archiver_context *c = context;
155
0
  struct archiver_args *args = c->args;
156
0
  write_archive_entry_fn_t write_entry = c->write_entry;
157
0
  int err;
158
0
  const char *path_without_prefix;
159
0
  unsigned long size;
160
0
  void *buffer;
161
0
  enum object_type type;
162
163
0
  args->convert = 0;
164
0
  strbuf_reset(&path);
165
0
  strbuf_grow(&path, PATH_MAX);
166
0
  strbuf_add(&path, args->base, args->baselen);
167
0
  strbuf_add(&path, base, baselen);
168
0
  strbuf_addstr(&path, filename);
169
0
  if (S_ISDIR(mode) || S_ISGITLINK(mode))
170
0
    strbuf_addch(&path, '/');
171
0
  path_without_prefix = path.buf + args->baselen;
172
173
0
  if (!S_ISDIR(mode)) {
174
0
    const struct attr_check *check;
175
0
    check = get_archive_attrs(args->repo->index, path_without_prefix);
176
0
    if (check_attr_export_ignore(check))
177
0
      return 0;
178
0
    args->convert = check_attr_export_subst(check);
179
0
  }
180
181
0
  if (args->prefix) {
182
0
    static struct strbuf new_path = STRBUF_INIT;
183
0
    static struct strbuf buf = STRBUF_INIT;
184
0
    const char *rel;
185
186
0
    rel = relative_path(path_without_prefix, args->prefix, &buf);
187
188
    /*
189
     * We don't add an entry for the current working
190
     * directory when we are at the root; skip it also when
191
     * we're in a subdirectory or submodule.  Skip entries
192
     * higher up as well.
193
     */
194
0
    if (!strcmp(rel, "./") || starts_with(rel, "../"))
195
0
      return S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0;
196
197
    /* rel can refer to path, so don't edit it in place */
198
0
    strbuf_reset(&new_path);
199
0
    strbuf_add(&new_path, args->base, args->baselen);
200
0
    strbuf_addstr(&new_path, rel);
201
0
    strbuf_swap(&path, &new_path);
202
0
  }
203
204
0
  if (args->verbose)
205
0
    fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
206
207
0
  if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
208
0
    err = write_entry(args, oid, path.buf, path.len, mode, NULL, 0);
209
0
    if (err)
210
0
      return err;
211
0
    return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
212
0
  }
213
214
  /* Stream it? */
215
0
  if (S_ISREG(mode) && !args->convert &&
216
0
      oid_object_info(args->repo, oid, &size) == OBJ_BLOB &&
217
0
      size > big_file_threshold)
218
0
    return write_entry(args, oid, path.buf, path.len, mode, NULL, size);
219
220
0
  buffer = object_file_to_archive(args, path.buf, oid, mode, &type, &size);
221
0
  if (!buffer)
222
0
    return error(_("cannot read '%s'"), oid_to_hex(oid));
223
0
  err = write_entry(args, oid, path.buf, path.len, mode, buffer, size);
224
0
  free(buffer);
225
0
  return err;
226
0
}
227
228
static void queue_directory(const struct object_id *oid,
229
    struct strbuf *base, const char *filename,
230
    unsigned mode, struct archiver_context *c)
231
0
{
232
0
  struct directory *d;
233
0
  size_t len = st_add4(base->len, 1, strlen(filename), 1);
234
0
  d = xmalloc(st_add(sizeof(*d), len));
235
0
  d->up    = c->bottom;
236
0
  d->baselen = base->len;
237
0
  d->mode    = mode;
238
0
  c->bottom  = d;
239
0
  d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
240
0
  oidcpy(&d->oid, oid);
241
0
}
242
243
static int write_directory(struct archiver_context *c)
244
0
{
245
0
  struct directory *d = c->bottom;
246
0
  int ret;
247
248
0
  if (!d)
249
0
    return 0;
250
0
  c->bottom = d->up;
251
0
  d->path[d->len - 1] = '\0'; /* no trailing slash */
252
0
  ret =
253
0
    write_directory(c) ||
254
0
    write_archive_entry(&d->oid, d->path, d->baselen,
255
0
            d->path + d->baselen, d->mode,
256
0
            c) != READ_TREE_RECURSIVE;
257
0
  free(d);
258
0
  return ret ? -1 : 0;
259
0
}
260
261
static int queue_or_write_archive_entry(const struct object_id *oid,
262
    struct strbuf *base, const char *filename,
263
    unsigned mode, void *context)
264
0
{
265
0
  struct archiver_context *c = context;
266
267
0
  while (c->bottom &&
268
0
         !(base->len >= c->bottom->len &&
269
0
     !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
270
0
    struct directory *next = c->bottom->up;
271
0
    free(c->bottom);
272
0
    c->bottom = next;
273
0
  }
274
275
0
  if (S_ISDIR(mode)) {
276
0
    size_t baselen = base->len;
277
0
    const struct attr_check *check;
278
279
    /* Borrow base, but restore its original value when done. */
280
0
    strbuf_addstr(base, filename);
281
0
    strbuf_addch(base, '/');
282
0
    check = get_archive_attrs(c->args->repo->index, base->buf);
283
0
    strbuf_setlen(base, baselen);
284
285
0
    if (check_attr_export_ignore(check))
286
0
      return 0;
287
0
    queue_directory(oid, base, filename, mode, c);
288
0
    return READ_TREE_RECURSIVE;
289
0
  }
290
291
0
  if (write_directory(c))
292
0
    return -1;
293
0
  return write_archive_entry(oid, base->buf, base->len, filename, mode,
294
0
           context);
295
0
}
296
297
struct extra_file_info {
298
  char *base;
299
  struct stat stat;
300
  void *content;
301
};
302
303
int write_archive_entries(struct archiver_args *args,
304
    write_archive_entry_fn_t write_entry)
305
0
{
306
0
  struct archiver_context context;
307
0
  struct unpack_trees_options opts;
308
0
  struct tree_desc t;
309
0
  int err;
310
0
  struct strbuf path_in_archive = STRBUF_INIT;
311
0
  struct strbuf content = STRBUF_INIT;
312
0
  struct object_id fake_oid;
313
0
  int i;
314
315
0
  oidcpy(&fake_oid, null_oid());
316
317
0
  if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
318
0
    size_t len = args->baselen;
319
320
0
    while (len > 1 && args->base[len - 2] == '/')
321
0
      len--;
322
0
    if (args->verbose)
323
0
      fprintf(stderr, "%.*s\n", (int)len, args->base);
324
0
    err = write_entry(args, &args->tree->object.oid, args->base,
325
0
          len, 040777, NULL, 0);
326
0
    if (err)
327
0
      return err;
328
0
  }
329
330
0
  memset(&context, 0, sizeof(context));
331
0
  context.args = args;
332
0
  context.write_entry = write_entry;
333
334
  /*
335
   * Setup index and instruct attr to read index only
336
   */
337
0
  if (!args->worktree_attributes) {
338
0
    memset(&opts, 0, sizeof(opts));
339
0
    opts.index_only = 1;
340
0
    opts.head_idx = -1;
341
0
    opts.src_index = args->repo->index;
342
0
    opts.dst_index = args->repo->index;
343
0
    opts.fn = oneway_merge;
344
0
    init_tree_desc(&t, &args->tree->object.oid,
345
0
             args->tree->buffer, args->tree->size);
346
0
    if (unpack_trees(1, &t, &opts))
347
0
      return -1;
348
0
    git_attr_set_direction(GIT_ATTR_INDEX);
349
0
  }
350
351
0
  err = read_tree(args->repo, args->tree,
352
0
      &args->pathspec,
353
0
      queue_or_write_archive_entry,
354
0
      &context);
355
0
  if (err == READ_TREE_RECURSIVE)
356
0
    err = 0;
357
0
  while (context.bottom) {
358
0
    struct directory *next = context.bottom->up;
359
0
    free(context.bottom);
360
0
    context.bottom = next;
361
0
  }
362
363
0
  for (i = 0; i < args->extra_files.nr; i++) {
364
0
    struct string_list_item *item = args->extra_files.items + i;
365
0
    char *path = item->string;
366
0
    struct extra_file_info *info = item->util;
367
368
0
    put_be64(fake_oid.hash, i + 1);
369
370
0
    if (!info->content) {
371
0
      strbuf_reset(&path_in_archive);
372
0
      if (info->base)
373
0
        strbuf_addstr(&path_in_archive, info->base);
374
0
      strbuf_addstr(&path_in_archive, basename(path));
375
376
0
      strbuf_reset(&content);
377
0
      if (strbuf_read_file(&content, path, info->stat.st_size) < 0)
378
0
        err = error_errno(_("cannot read '%s'"), path);
379
0
      else
380
0
        err = write_entry(args, &fake_oid, path_in_archive.buf,
381
0
              path_in_archive.len,
382
0
              canon_mode(info->stat.st_mode),
383
0
              content.buf, content.len);
384
0
    } else {
385
0
      err = write_entry(args, &fake_oid,
386
0
            path, strlen(path),
387
0
            canon_mode(info->stat.st_mode),
388
0
            info->content, info->stat.st_size);
389
0
    }
390
391
0
    if (err)
392
0
      break;
393
0
  }
394
0
  strbuf_release(&path_in_archive);
395
0
  strbuf_release(&content);
396
397
0
  return err;
398
0
}
399
400
static const struct archiver *lookup_archiver(const char *name)
401
0
{
402
0
  int i;
403
404
0
  if (!name)
405
0
    return NULL;
406
407
0
  for (i = 0; i < nr_archivers; i++) {
408
0
    if (!strcmp(name, archivers[i]->name))
409
0
      return archivers[i];
410
0
  }
411
0
  return NULL;
412
0
}
413
414
struct path_exists_context {
415
  struct pathspec pathspec;
416
  struct archiver_args *args;
417
};
418
419
static int reject_entry(const struct object_id *oid UNUSED,
420
      struct strbuf *base,
421
      const char *filename, unsigned mode,
422
      void *context)
423
0
{
424
0
  int ret = -1;
425
0
  struct path_exists_context *ctx = context;
426
427
0
  if (S_ISDIR(mode)) {
428
0
    struct strbuf sb = STRBUF_INIT;
429
0
    strbuf_addbuf(&sb, base);
430
0
    strbuf_addstr(&sb, filename);
431
0
    if (!match_pathspec(ctx->args->repo->index,
432
0
            &ctx->pathspec,
433
0
            sb.buf, sb.len, 0, NULL, 1))
434
0
      ret = READ_TREE_RECURSIVE;
435
0
    strbuf_release(&sb);
436
0
  }
437
0
  return ret;
438
0
}
439
440
static int reject_outside(const struct object_id *oid UNUSED,
441
        struct strbuf *base, const char *filename,
442
        unsigned mode, void *context)
443
0
{
444
0
  struct archiver_args *args = context;
445
0
  struct strbuf buf = STRBUF_INIT;
446
0
  struct strbuf path = STRBUF_INIT;
447
0
  int ret = 0;
448
449
0
  if (S_ISDIR(mode))
450
0
    return READ_TREE_RECURSIVE;
451
452
0
  strbuf_addbuf(&path, base);
453
0
  strbuf_addstr(&path, filename);
454
0
  if (starts_with(relative_path(path.buf, args->prefix, &buf), "../"))
455
0
    ret = -1;
456
0
  strbuf_release(&buf);
457
0
  strbuf_release(&path);
458
0
  return ret;
459
0
}
460
461
static int path_exists(struct archiver_args *args, const char *path)
462
0
{
463
0
  const char *paths[] = { path, NULL };
464
0
  struct path_exists_context ctx;
465
0
  int ret;
466
467
0
  ctx.args = args;
468
0
  parse_pathspec(&ctx.pathspec, 0, PATHSPEC_PREFER_CWD,
469
0
           args->prefix, paths);
470
0
  ctx.pathspec.recursive = 1;
471
0
  if (args->prefix && read_tree(args->repo, args->tree, &ctx.pathspec,
472
0
              reject_outside, args))
473
0
    die(_("pathspec '%s' matches files outside the "
474
0
          "current directory"), path);
475
0
  ret = read_tree(args->repo, args->tree,
476
0
      &ctx.pathspec,
477
0
      reject_entry, &ctx);
478
0
  clear_pathspec(&ctx.pathspec);
479
0
  return ret != 0;
480
0
}
481
482
static void parse_pathspec_arg(const char **pathspec,
483
    struct archiver_args *ar_args)
484
0
{
485
  /*
486
   * must be consistent with parse_pathspec in path_exists()
487
   * Also if pathspec patterns are dependent, we're in big
488
   * trouble as we test each one separately
489
   */
490
0
  parse_pathspec(&ar_args->pathspec, 0, PATHSPEC_PREFER_CWD,
491
0
           ar_args->prefix, pathspec);
492
0
  ar_args->pathspec.recursive = 1;
493
0
  if (pathspec) {
494
0
    while (*pathspec) {
495
0
      if (**pathspec && !path_exists(ar_args, *pathspec))
496
0
        die(_("pathspec '%s' did not match any files"), *pathspec);
497
0
      pathspec++;
498
0
    }
499
0
  }
500
0
}
501
502
static void parse_treeish_arg(const char **argv,
503
            struct archiver_args *ar_args, int remote)
504
0
{
505
0
  const char *name = argv[0];
506
0
  const struct object_id *commit_oid;
507
0
  time_t archive_time;
508
0
  struct tree *tree;
509
0
  const struct commit *commit;
510
0
  struct object_id oid;
511
0
  char *ref = NULL;
512
513
  /* Remotes are only allowed to fetch actual refs */
514
0
  if (remote && !remote_allow_unreachable) {
515
0
    const char *colon = strchrnul(name, ':');
516
0
    int refnamelen = colon - name;
517
518
0
    if (!repo_dwim_ref(the_repository, name, refnamelen, &oid, &ref, 0))
519
0
      die(_("no such ref: %.*s"), refnamelen, name);
520
0
  } else {
521
0
    repo_dwim_ref(the_repository, name, strlen(name), &oid, &ref,
522
0
            0);
523
0
  }
524
525
0
  if (repo_get_oid(the_repository, name, &oid))
526
0
    die(_("not a valid object name: %s"), name);
527
528
0
  commit = lookup_commit_reference_gently(ar_args->repo, &oid, 1);
529
0
  if (commit) {
530
0
    commit_oid = &commit->object.oid;
531
0
    archive_time = commit->date;
532
0
  } else {
533
0
    commit_oid = NULL;
534
0
    archive_time = time(NULL);
535
0
  }
536
0
  if (ar_args->mtime_option)
537
0
    archive_time = approxidate(ar_args->mtime_option);
538
539
0
  tree = parse_tree_indirect(&oid);
540
0
  if (!tree)
541
0
    die(_("not a tree object: %s"), oid_to_hex(&oid));
542
543
0
  ar_args->refname = ref;
544
0
  ar_args->tree = tree;
545
0
  ar_args->commit_oid = commit_oid;
546
0
  ar_args->commit = commit;
547
0
  ar_args->time = archive_time;
548
0
}
549
550
static void extra_file_info_clear(void *util, const char *str UNUSED)
551
0
{
552
0
  struct extra_file_info *info = util;
553
0
  free(info->base);
554
0
  free(info->content);
555
0
  free(info);
556
0
}
557
558
static int add_file_cb(const struct option *opt, const char *arg, int unset)
559
0
{
560
0
  struct archiver_args *args = opt->value;
561
0
  const char **basep = (const char **)opt->defval;
562
0
  const char *base = *basep;
563
0
  char *path;
564
0
  struct string_list_item *item;
565
0
  struct extra_file_info *info;
566
567
0
  if (unset) {
568
0
    string_list_clear_func(&args->extra_files,
569
0
               extra_file_info_clear);
570
0
    return 0;
571
0
  }
572
573
0
  if (!arg)
574
0
    return -1;
575
576
0
  info = xmalloc(sizeof(*info));
577
0
  info->base = xstrdup_or_null(base);
578
579
0
  if (!strcmp(opt->long_name, "add-file")) {
580
0
    path = prefix_filename(args->prefix, arg);
581
0
    if (stat(path, &info->stat))
582
0
      die(_("File not found: %s"), path);
583
0
    if (!S_ISREG(info->stat.st_mode))
584
0
      die(_("Not a regular file: %s"), path);
585
0
    info->content = NULL; /* read the file later */
586
0
  } else if (!strcmp(opt->long_name, "add-virtual-file")) {
587
0
    struct strbuf buf = STRBUF_INIT;
588
0
    const char *p = arg;
589
590
0
    if (*p != '"')
591
0
      p = strchr(p, ':');
592
0
    else if (unquote_c_style(&buf, p, &p) < 0)
593
0
      die(_("unclosed quote: '%s'"), arg);
594
595
0
    if (!p || *p != ':')
596
0
      die(_("missing colon: '%s'"), arg);
597
598
0
    if (p == arg)
599
0
      die(_("empty file name: '%s'"), arg);
600
601
0
    path = buf.len ?
602
0
      strbuf_detach(&buf, NULL) : xstrndup(arg, p - arg);
603
604
0
    if (args->prefix) {
605
0
      char *save = path;
606
0
      path = prefix_filename(args->prefix, path);
607
0
      free(save);
608
0
    }
609
0
    memset(&info->stat, 0, sizeof(info->stat));
610
0
    info->stat.st_mode = S_IFREG | 0644;
611
0
    info->content = xstrdup(p + 1);
612
0
    info->stat.st_size = strlen(info->content);
613
0
  } else {
614
0
    BUG("add_file_cb() called for %s", opt->long_name);
615
0
  }
616
0
  item = string_list_append_nodup(&args->extra_files, path);
617
0
  item->util = info;
618
619
0
  return 0;
620
0
}
621
622
static int number_callback(const struct option *opt, const char *arg, int unset)
623
0
{
624
0
  BUG_ON_OPT_NEG(unset);
625
0
  *(int *)opt->value = strtol(arg, NULL, 10);
626
0
  return 0;
627
0
}
628
629
static int parse_archive_args(int argc, const char **argv,
630
    const struct archiver **ar, struct archiver_args *args,
631
    const char *name_hint, int is_remote)
632
0
{
633
0
  const char *format = NULL;
634
0
  const char *base = NULL;
635
0
  const char *remote = NULL;
636
0
  const char *exec = NULL;
637
0
  const char *output = NULL;
638
0
  const char *mtime_option = NULL;
639
0
  int compression_level = -1;
640
0
  int verbose = 0;
641
0
  int i;
642
0
  int list = 0;
643
0
  int worktree_attributes = 0;
644
0
  struct option opts[] = {
645
0
    OPT_GROUP(""),
646
0
    OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
647
0
    OPT_STRING(0, "prefix", &base, N_("prefix"),
648
0
      N_("prepend prefix to each pathname in the archive")),
649
0
    { OPTION_CALLBACK, 0, "add-file", args, N_("file"),
650
0
      N_("add untracked file to archive"), 0, add_file_cb,
651
0
      (intptr_t)&base },
652
0
    { OPTION_CALLBACK, 0, "add-virtual-file", args,
653
0
      N_("path:content"), N_("add untracked file to archive"), 0,
654
0
      add_file_cb, (intptr_t)&base },
655
0
    OPT_STRING('o', "output", &output, N_("file"),
656
0
      N_("write the archive to this file")),
657
0
    OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
658
0
      N_("read .gitattributes in working directory")),
659
0
    OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
660
0
    { OPTION_STRING, 0, "mtime", &mtime_option, N_("time"),
661
0
      N_("set modification time of archive entries"),
662
0
      PARSE_OPT_NONEG },
663
0
    OPT_NUMBER_CALLBACK(&compression_level,
664
0
      N_("set compression level"), number_callback),
665
0
    OPT_GROUP(""),
666
0
    OPT_BOOL('l', "list", &list,
667
0
      N_("list supported archive formats")),
668
0
    OPT_GROUP(""),
669
0
    OPT_STRING(0, "remote", &remote, N_("repo"),
670
0
      N_("retrieve the archive from remote repository <repo>")),
671
0
    OPT_STRING(0, "exec", &exec, N_("command"),
672
0
      N_("path to the remote git-upload-archive command")),
673
0
    OPT_END()
674
0
  };
675
676
0
  argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
677
678
0
  if (remote)
679
0
    die(_("Unexpected option --remote"));
680
0
  if (exec)
681
0
    die(_("the option '%s' requires '%s'"), "--exec", "--remote");
682
0
  if (output)
683
0
    die(_("Unexpected option --output"));
684
0
  if (is_remote && args->extra_files.nr)
685
0
    die(_("options '%s' and '%s' cannot be used together"), "--add-file", "--remote");
686
687
0
  if (!base)
688
0
    base = "";
689
690
0
  if (list) {
691
0
    if (argc)
692
0
      die(_("extra command line parameter '%s'"), *argv);
693
0
    for (i = 0; i < nr_archivers; i++)
694
0
      if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
695
0
        printf("%s\n", archivers[i]->name);
696
0
    exit(0);
697
0
  }
698
699
0
  if (!format && name_hint)
700
0
    format = archive_format_from_filename(name_hint);
701
0
  if (!format)
702
0
    format = "tar";
703
704
  /* We need at least one parameter -- tree-ish */
705
0
  if (argc < 1)
706
0
    usage_with_options(archive_usage, opts);
707
0
  *ar = lookup_archiver(format);
708
0
  if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
709
0
    die(_("Unknown archive format '%s'"), format);
710
711
0
  args->compression_level = Z_DEFAULT_COMPRESSION;
712
0
  if (compression_level != -1) {
713
0
    int levels_ok = (*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS;
714
0
    int high_ok = (*ar)->flags & ARCHIVER_HIGH_COMPRESSION_LEVELS;
715
0
    if (levels_ok && (compression_level <= 9 || high_ok))
716
0
      args->compression_level = compression_level;
717
0
    else {
718
0
      die(_("Argument not supported for format '%s': -%d"),
719
0
          format, compression_level);
720
0
    }
721
0
  }
722
0
  args->verbose = verbose;
723
0
  args->base = base;
724
0
  args->baselen = strlen(base);
725
0
  args->worktree_attributes = worktree_attributes;
726
0
  args->mtime_option = mtime_option;
727
728
0
  return argc;
729
0
}
730
731
int write_archive(int argc, const char **argv, const char *prefix,
732
      struct repository *repo,
733
      const char *name_hint, int remote)
734
0
{
735
0
  const struct archiver *ar = NULL;
736
0
  struct pretty_print_describe_status describe_status = {0};
737
0
  struct pretty_print_context ctx = {0};
738
0
  struct archiver_args args;
739
0
  const char **argv_copy;
740
0
  int rc;
741
742
0
  git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
743
0
  git_config(git_default_config, NULL);
744
745
0
  describe_status.max_invocations = 1;
746
0
  ctx.date_mode.type = DATE_NORMAL;
747
0
  ctx.abbrev = DEFAULT_ABBREV;
748
0
  ctx.describe_status = &describe_status;
749
0
  args.pretty_ctx = &ctx;
750
0
  args.repo = repo;
751
0
  args.prefix = prefix;
752
0
  string_list_init_dup(&args.extra_files);
753
754
  /*
755
   * `parse_archive_args()` modifies contents of `argv`, which is what we
756
   * want. Our callers may not want it though, so we create a copy here.
757
   */
758
0
  DUP_ARRAY(argv_copy, argv, argc);
759
0
  argv = argv_copy;
760
761
0
  argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
762
0
  if (!startup_info->have_repository) {
763
    /*
764
     * We know this will die() with an error, so we could just
765
     * die ourselves; but its error message will be more specific
766
     * than what we could write here.
767
     */
768
0
    setup_git_directory();
769
0
  }
770
771
0
  parse_treeish_arg(argv, &args, remote);
772
0
  parse_pathspec_arg(argv + 1, &args);
773
774
0
  rc = ar->write_archive(ar, &args);
775
776
0
  string_list_clear_func(&args.extra_files, extra_file_info_clear);
777
0
  free(args.refname);
778
0
  clear_pathspec(&args.pathspec);
779
0
  free(argv_copy);
780
781
0
  return rc;
782
0
}
783
784
static int match_extension(const char *filename, const char *ext)
785
0
{
786
0
  int prefixlen = strlen(filename) - strlen(ext);
787
788
  /*
789
   * We need 1 character for the '.', and 1 character to ensure that the
790
   * prefix is non-empty (k.e., we don't match .tar.gz with no actual
791
   * filename).
792
   */
793
0
  if (prefixlen < 2 || filename[prefixlen - 1] != '.')
794
0
    return 0;
795
0
  return !strcmp(filename + prefixlen, ext);
796
0
}
797
798
const char *archive_format_from_filename(const char *filename)
799
0
{
800
0
  int i;
801
802
0
  for (i = 0; i < nr_archivers; i++)
803
0
    if (match_extension(filename, archivers[i]->name))
804
0
      return archivers[i]->name;
805
0
  return NULL;
806
0
}