Andrew's git / gitweb.git / archive.c
?
archive.con commit sequencer: make the todo_list structure public (5d94d54)
   1#include "cache.h"
   2#include "config.h"
   3#include "refs.h"
   4#include "object-store.h"
   5#include "commit.h"
   6#include "tree-walk.h"
   7#include "attr.h"
   8#include "archive.h"
   9#include "parse-options.h"
  10#include "unpack-trees.h"
  11#include "dir.h"
  12
  13static char const * const archive_usage[] = {
  14        N_("git archive [<options>] <tree-ish> [<path>...]"),
  15        N_("git archive --list"),
  16        N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
  17        N_("git archive --remote <repo> [--exec <cmd>] --list"),
  18        NULL
  19};
  20
  21static const struct archiver **archivers;
  22static int nr_archivers;
  23static int alloc_archivers;
  24static int remote_allow_unreachable;
  25
  26void register_archiver(struct archiver *ar)
  27{
  28        ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
  29        archivers[nr_archivers++] = ar;
  30}
  31
  32void init_archivers(void)
  33{
  34        init_tar_archiver();
  35        init_zip_archiver();
  36}
  37
  38static void format_subst(const struct commit *commit,
  39                         const char *src, size_t len,
  40                         struct strbuf *buf)
  41{
  42        char *to_free = NULL;
  43        struct strbuf fmt = STRBUF_INIT;
  44        struct pretty_print_context ctx = {0};
  45        ctx.date_mode.type = DATE_NORMAL;
  46        ctx.abbrev = DEFAULT_ABBREV;
  47
  48        if (src == buf->buf)
  49                to_free = strbuf_detach(buf, NULL);
  50        for (;;) {
  51                const char *b, *c;
  52
  53                b = memmem(src, len, "$Format:", 8);
  54                if (!b)
  55                        break;
  56                c = memchr(b + 8, '$', (src + len) - b - 8);
  57                if (!c)
  58                        break;
  59
  60                strbuf_reset(&fmt);
  61                strbuf_add(&fmt, b + 8, c - b - 8);
  62
  63                strbuf_add(buf, src, b - src);
  64                format_commit_message(commit, fmt.buf, buf, &ctx);
  65                len -= c + 1 - src;
  66                src  = c + 1;
  67        }
  68        strbuf_add(buf, src, len);
  69        strbuf_release(&fmt);
  70        free(to_free);
  71}
  72
  73void *object_file_to_archive(const struct archiver_args *args,
  74                             const char *path, const struct object_id *oid,
  75                             unsigned int mode, enum object_type *type,
  76                             unsigned long *sizep)
  77{
  78        void *buffer;
  79        const struct commit *commit = args->convert ? args->commit : NULL;
  80
  81        path += args->baselen;
  82        buffer = read_object_file(oid, type, sizep);
  83        if (buffer && S_ISREG(mode)) {
  84                struct strbuf buf = STRBUF_INIT;
  85                size_t size = 0;
  86
  87                strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
  88                convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf);
  89                if (commit)
  90                        format_subst(commit, buf.buf, buf.len, &buf);
  91                buffer = strbuf_detach(&buf, &size);
  92                *sizep = size;
  93        }
  94
  95        return buffer;
  96}
  97
  98struct directory {
  99        struct directory *up;
 100        struct object_id oid;
 101        int baselen, len;
 102        unsigned mode;
 103        int stage;
 104        char path[FLEX_ARRAY];
 105};
 106
 107struct archiver_context {
 108        struct archiver_args *args;
 109        write_archive_entry_fn_t write_entry;
 110        struct directory *bottom;
 111};
 112
 113static const struct attr_check *get_archive_attrs(struct index_state *istate,
 114                                                  const char *path)
 115{
 116        static struct attr_check *check;
 117        if (!check)
 118                check = attr_check_initl("export-ignore", "export-subst", NULL);
 119        git_check_attr(istate, path, check);
 120        return check;
 121}
 122
 123static int check_attr_export_ignore(const struct attr_check *check)
 124{
 125        return check && ATTR_TRUE(check->items[0].value);
 126}
 127
 128static int check_attr_export_subst(const struct attr_check *check)
 129{
 130        return check && ATTR_TRUE(check->items[1].value);
 131}
 132
 133static int write_archive_entry(const struct object_id *oid, const char *base,
 134                int baselen, const char *filename, unsigned mode, int stage,
 135                void *context)
 136{
 137        static struct strbuf path = STRBUF_INIT;
 138        struct archiver_context *c = context;
 139        struct archiver_args *args = c->args;
 140        write_archive_entry_fn_t write_entry = c->write_entry;
 141        int err;
 142        const char *path_without_prefix;
 143
 144        args->convert = 0;
 145        strbuf_reset(&path);
 146        strbuf_grow(&path, PATH_MAX);
 147        strbuf_add(&path, args->base, args->baselen);
 148        strbuf_add(&path, base, baselen);
 149        strbuf_addstr(&path, filename);
 150        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 151                strbuf_addch(&path, '/');
 152        path_without_prefix = path.buf + args->baselen;
 153
 154        if (!S_ISDIR(mode)) {
 155                const struct attr_check *check;
 156                check = get_archive_attrs(args->repo->index, path_without_prefix);
 157                if (check_attr_export_ignore(check))
 158                        return 0;
 159                args->convert = check_attr_export_subst(check);
 160        }
 161
 162        if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
 163                if (args->verbose)
 164                        fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 165                err = write_entry(args, oid, path.buf, path.len, mode);
 166                if (err)
 167                        return err;
 168                return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
 169        }
 170
 171        if (args->verbose)
 172                fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 173        return write_entry(args, oid, path.buf, path.len, mode);
 174}
 175
 176static void queue_directory(const unsigned char *sha1,
 177                struct strbuf *base, const char *filename,
 178                unsigned mode, int stage, struct archiver_context *c)
 179{
 180        struct directory *d;
 181        size_t len = st_add4(base->len, 1, strlen(filename), 1);
 182        d = xmalloc(st_add(sizeof(*d), len));
 183        d->up      = c->bottom;
 184        d->baselen = base->len;
 185        d->mode    = mode;
 186        d->stage   = stage;
 187        c->bottom  = d;
 188        d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
 189        hashcpy(d->oid.hash, sha1);
 190}
 191
 192static int write_directory(struct archiver_context *c)
 193{
 194        struct directory *d = c->bottom;
 195        int ret;
 196
 197        if (!d)
 198                return 0;
 199        c->bottom = d->up;
 200        d->path[d->len - 1] = '\0'; /* no trailing slash */
 201        ret =
 202                write_directory(c) ||
 203                write_archive_entry(&d->oid, d->path, d->baselen,
 204                                    d->path + d->baselen, d->mode,
 205                                    d->stage, c) != READ_TREE_RECURSIVE;
 206        free(d);
 207        return ret ? -1 : 0;
 208}
 209
 210static int queue_or_write_archive_entry(const struct object_id *oid,
 211                struct strbuf *base, const char *filename,
 212                unsigned mode, int stage, void *context)
 213{
 214        struct archiver_context *c = context;
 215
 216        while (c->bottom &&
 217               !(base->len >= c->bottom->len &&
 218                 !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
 219                struct directory *next = c->bottom->up;
 220                free(c->bottom);
 221                c->bottom = next;
 222        }
 223
 224        if (S_ISDIR(mode)) {
 225                size_t baselen = base->len;
 226                const struct attr_check *check;
 227
 228                /* Borrow base, but restore its original value when done. */
 229                strbuf_addstr(base, filename);
 230                strbuf_addch(base, '/');
 231                check = get_archive_attrs(c->args->repo->index, base->buf);
 232                strbuf_setlen(base, baselen);
 233
 234                if (check_attr_export_ignore(check))
 235                        return 0;
 236                queue_directory(oid->hash, base, filename,
 237                                mode, stage, c);
 238                return READ_TREE_RECURSIVE;
 239        }
 240
 241        if (write_directory(c))
 242                return -1;
 243        return write_archive_entry(oid, base->buf, base->len, filename, mode,
 244                                   stage, context);
 245}
 246
 247int write_archive_entries(struct archiver_args *args,
 248                write_archive_entry_fn_t write_entry)
 249{
 250        struct archiver_context context;
 251        struct unpack_trees_options opts;
 252        struct tree_desc t;
 253        int err;
 254
 255        if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
 256                size_t len = args->baselen;
 257
 258                while (len > 1 && args->base[len - 2] == '/')
 259                        len--;
 260                if (args->verbose)
 261                        fprintf(stderr, "%.*s\n", (int)len, args->base);
 262                err = write_entry(args, &args->tree->object.oid, args->base,
 263                                  len, 040777);
 264                if (err)
 265                        return err;
 266        }
 267
 268        memset(&context, 0, sizeof(context));
 269        context.args = args;
 270        context.write_entry = write_entry;
 271
 272        /*
 273         * Setup index and instruct attr to read index only
 274         */
 275        if (!args->worktree_attributes) {
 276                memset(&opts, 0, sizeof(opts));
 277                opts.index_only = 1;
 278                opts.head_idx = -1;
 279                opts.src_index = args->repo->index;
 280                opts.dst_index = args->repo->index;
 281                opts.fn = oneway_merge;
 282                init_tree_desc(&t, args->tree->buffer, args->tree->size);
 283                if (unpack_trees(1, &t, &opts))
 284                        return -1;
 285                git_attr_set_direction(GIT_ATTR_INDEX);
 286        }
 287
 288        err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
 289                                  queue_or_write_archive_entry,
 290                                  &context);
 291        if (err == READ_TREE_RECURSIVE)
 292                err = 0;
 293        while (context.bottom) {
 294                struct directory *next = context.bottom->up;
 295                free(context.bottom);
 296                context.bottom = next;
 297        }
 298        return err;
 299}
 300
 301static const struct archiver *lookup_archiver(const char *name)
 302{
 303        int i;
 304
 305        if (!name)
 306                return NULL;
 307
 308        for (i = 0; i < nr_archivers; i++) {
 309                if (!strcmp(name, archivers[i]->name))
 310                        return archivers[i];
 311        }
 312        return NULL;
 313}
 314
 315struct path_exists_context {
 316        struct pathspec pathspec;
 317        struct archiver_args *args;
 318};
 319
 320static int reject_entry(const struct object_id *oid, struct strbuf *base,
 321                        const char *filename, unsigned mode,
 322                        int stage, void *context)
 323{
 324        int ret = -1;
 325        struct path_exists_context *ctx = context;
 326
 327        if (S_ISDIR(mode)) {
 328                struct strbuf sb = STRBUF_INIT;
 329                strbuf_addbuf(&sb, base);
 330                strbuf_addstr(&sb, filename);
 331                if (!match_pathspec(ctx->args->repo->index,
 332                                    &ctx->pathspec,
 333                                    sb.buf, sb.len, 0, NULL, 1))
 334                        ret = READ_TREE_RECURSIVE;
 335                strbuf_release(&sb);
 336        }
 337        return ret;
 338}
 339
 340static int path_exists(struct archiver_args *args, const char *path)
 341{
 342        const char *paths[] = { path, NULL };
 343        struct path_exists_context ctx;
 344        int ret;
 345
 346        ctx.args = args;
 347        parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
 348        ctx.pathspec.recursive = 1;
 349        ret = read_tree_recursive(args->tree, "", 0, 0, &ctx.pathspec,
 350                                  reject_entry, &ctx);
 351        clear_pathspec(&ctx.pathspec);
 352        return ret != 0;
 353}
 354
 355static void parse_pathspec_arg(const char **pathspec,
 356                struct archiver_args *ar_args)
 357{
 358        /*
 359         * must be consistent with parse_pathspec in path_exists()
 360         * Also if pathspec patterns are dependent, we're in big
 361         * trouble as we test each one separately
 362         */
 363        parse_pathspec(&ar_args->pathspec, 0,
 364                       PATHSPEC_PREFER_FULL,
 365                       "", pathspec);
 366        ar_args->pathspec.recursive = 1;
 367        if (pathspec) {
 368                while (*pathspec) {
 369                        if (**pathspec && !path_exists(ar_args, *pathspec))
 370                                die(_("pathspec '%s' did not match any files"), *pathspec);
 371                        pathspec++;
 372                }
 373        }
 374}
 375
 376static void parse_treeish_arg(const char **argv,
 377                struct archiver_args *ar_args, const char *prefix,
 378                int remote)
 379{
 380        const char *name = argv[0];
 381        const unsigned char *commit_sha1;
 382        time_t archive_time;
 383        struct tree *tree;
 384        const struct commit *commit;
 385        struct object_id oid;
 386
 387        /* Remotes are only allowed to fetch actual refs */
 388        if (remote && !remote_allow_unreachable) {
 389                char *ref = NULL;
 390                const char *colon = strchrnul(name, ':');
 391                int refnamelen = colon - name;
 392
 393                if (!dwim_ref(name, refnamelen, &oid, &ref))
 394                        die(_("no such ref: %.*s"), refnamelen, name);
 395                free(ref);
 396        }
 397
 398        if (get_oid(name, &oid))
 399                die(_("not a valid object name: %s"), name);
 400
 401        commit = lookup_commit_reference_gently(ar_args->repo, &oid, 1);
 402        if (commit) {
 403                commit_sha1 = commit->object.oid.hash;
 404                archive_time = commit->date;
 405        } else {
 406                commit_sha1 = NULL;
 407                archive_time = time(NULL);
 408        }
 409
 410        tree = parse_tree_indirect(&oid);
 411        if (tree == NULL)
 412                die(_("not a tree object: %s"), oid_to_hex(&oid));
 413
 414        if (prefix) {
 415                struct object_id tree_oid;
 416                unsigned int mode;
 417                int err;
 418
 419                err = get_tree_entry(&tree->object.oid, prefix, &tree_oid,
 420                                     &mode);
 421                if (err || !S_ISDIR(mode))
 422                        die(_("current working directory is untracked"));
 423
 424                tree = parse_tree_indirect(&tree_oid);
 425        }
 426        ar_args->tree = tree;
 427        ar_args->commit_sha1 = commit_sha1;
 428        ar_args->commit = commit;
 429        ar_args->time = archive_time;
 430}
 431
 432#define OPT__COMPR(s, v, h, p) \
 433        OPT_SET_INT_F(s, NULL, v, h, p, PARSE_OPT_NONEG)
 434#define OPT__COMPR_HIDDEN(s, v, p) \
 435        OPT_SET_INT_F(s, NULL, v, "", p, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN)
 436
 437static int parse_archive_args(int argc, const char **argv,
 438                const struct archiver **ar, struct archiver_args *args,
 439                const char *name_hint, int is_remote)
 440{
 441        const char *format = NULL;
 442        const char *base = NULL;
 443        const char *remote = NULL;
 444        const char *exec = NULL;
 445        const char *output = NULL;
 446        int compression_level = -1;
 447        int verbose = 0;
 448        int i;
 449        int list = 0;
 450        int worktree_attributes = 0;
 451        struct option opts[] = {
 452                OPT_GROUP(""),
 453                OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
 454                OPT_STRING(0, "prefix", &base, N_("prefix"),
 455                        N_("prepend prefix to each pathname in the archive")),
 456                OPT_STRING('o', "output", &output, N_("file"),
 457                        N_("write the archive to this file")),
 458                OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
 459                        N_("read .gitattributes in working directory")),
 460                OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
 461                OPT__COMPR('0', &compression_level, N_("store only"), 0),
 462                OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
 463                OPT__COMPR_HIDDEN('2', &compression_level, 2),
 464                OPT__COMPR_HIDDEN('3', &compression_level, 3),
 465                OPT__COMPR_HIDDEN('4', &compression_level, 4),
 466                OPT__COMPR_HIDDEN('5', &compression_level, 5),
 467                OPT__COMPR_HIDDEN('6', &compression_level, 6),
 468                OPT__COMPR_HIDDEN('7', &compression_level, 7),
 469                OPT__COMPR_HIDDEN('8', &compression_level, 8),
 470                OPT__COMPR('9', &compression_level, N_("compress better"), 9),
 471                OPT_GROUP(""),
 472                OPT_BOOL('l', "list", &list,
 473                        N_("list supported archive formats")),
 474                OPT_GROUP(""),
 475                OPT_STRING(0, "remote", &remote, N_("repo"),
 476                        N_("retrieve the archive from remote repository <repo>")),
 477                OPT_STRING(0, "exec", &exec, N_("command"),
 478                        N_("path to the remote git-upload-archive command")),
 479                OPT_END()
 480        };
 481
 482        argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
 483
 484        if (remote)
 485                die(_("Unexpected option --remote"));
 486        if (exec)
 487                die(_("Option --exec can only be used together with --remote"));
 488        if (output)
 489                die(_("Unexpected option --output"));
 490
 491        if (!base)
 492                base = "";
 493
 494        if (list) {
 495                for (i = 0; i < nr_archivers; i++)
 496                        if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
 497                                printf("%s\n", archivers[i]->name);
 498                exit(0);
 499        }
 500
 501        if (!format && name_hint)
 502                format = archive_format_from_filename(name_hint);
 503        if (!format)
 504                format = "tar";
 505
 506        /* We need at least one parameter -- tree-ish */
 507        if (argc < 1)
 508                usage_with_options(archive_usage, opts);
 509        *ar = lookup_archiver(format);
 510        if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
 511                die(_("Unknown archive format '%s'"), format);
 512
 513        args->compression_level = Z_DEFAULT_COMPRESSION;
 514        if (compression_level != -1) {
 515                if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
 516                        args->compression_level = compression_level;
 517                else {
 518                        die(_("Argument not supported for format '%s': -%d"),
 519                                        format, compression_level);
 520                }
 521        }
 522        args->verbose = verbose;
 523        args->base = base;
 524        args->baselen = strlen(base);
 525        args->worktree_attributes = worktree_attributes;
 526
 527        return argc;
 528}
 529
 530int write_archive(int argc, const char **argv, const char *prefix,
 531                  struct repository *repo,
 532                  const char *name_hint, int remote)
 533{
 534        const struct archiver *ar = NULL;
 535        struct archiver_args args;
 536
 537        git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
 538        git_config(git_default_config, NULL);
 539
 540        args.repo = repo;
 541        argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
 542        if (!startup_info->have_repository) {
 543                /*
 544                 * We know this will die() with an error, so we could just
 545                 * die ourselves; but its error message will be more specific
 546                 * than what we could write here.
 547                 */
 548                setup_git_directory();
 549        }
 550
 551        parse_treeish_arg(argv, &args, prefix, remote);
 552        parse_pathspec_arg(argv + 1, &args);
 553
 554        return ar->write_archive(ar, &args);
 555}
 556
 557static int match_extension(const char *filename, const char *ext)
 558{
 559        int prefixlen = strlen(filename) - strlen(ext);
 560
 561        /*
 562         * We need 1 character for the '.', and 1 character to ensure that the
 563         * prefix is non-empty (k.e., we don't match .tar.gz with no actual
 564         * filename).
 565         */
 566        if (prefixlen < 2 || filename[prefixlen - 1] != '.')
 567                return 0;
 568        return !strcmp(filename + prefixlen, ext);
 569}
 570
 571const char *archive_format_from_filename(const char *filename)
 572{
 573        int i;
 574
 575        for (i = 0; i < nr_archivers; i++)
 576                if (match_extension(filename, archivers[i]->name))
 577                        return archivers[i]->name;
 578        return NULL;
 579}