Andrew's git - gitweb.git/blob

   1#include "cache.h"
   2#include "commit.h"
   3#include "tree-walk.h"
   4#include "attr.h"
   5#include "archive.h"
   6#include "parse-options.h"
   7#include "unpack-trees.h"
   8
   9static char const * const archive_usage[] = {
  10        "git archive [options] <tree-ish> [<path>...]",
  11        "git archive --list",
  12        "git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [<path>...]",
  13        "git archive --remote <repo> [--exec <cmd>] --list",
  14        NULL
  15};
  16
  17static const struct archiver **archivers;
  18static int nr_archivers;
  19static int alloc_archivers;
  20
  21void register_archiver(struct archiver *ar)
  22{
  23        ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
  24        archivers[nr_archivers++] = ar;
  25}
  26
  27static void format_subst(const struct commit *commit,
  28                         const char *src, size_t len,
  29                         struct strbuf *buf)
  30{
  31        char *to_free = NULL;
  32        struct strbuf fmt = STRBUF_INIT;
  33        struct pretty_print_context ctx = {0};
  34        ctx.date_mode = DATE_NORMAL;
  35        ctx.abbrev = DEFAULT_ABBREV;
  36
  37        if (src == buf->buf)
  38                to_free = strbuf_detach(buf, NULL);
  39        for (;;) {
  40                const char *b, *c;
  41
  42                b = memmem(src, len, "$Format:", 8);
  43                if (!b)
  44                        break;
  45                c = memchr(b + 8, '$', (src + len) - b - 8);
  46                if (!c)
  47                        break;
  48
  49                strbuf_reset(&fmt);
  50                strbuf_add(&fmt, b + 8, c - b - 8);
  51
  52                strbuf_add(buf, src, b - src);
  53                format_commit_message(commit, fmt.buf, buf, &ctx);
  54                len -= c + 1 - src;
  55                src  = c + 1;
  56        }
  57        strbuf_add(buf, src, len);
  58        strbuf_release(&fmt);
  59        free(to_free);
  60}
  61
  62void *sha1_file_to_archive(const struct archiver_args *args,
  63                           const char *path, const unsigned char *sha1,
  64                           unsigned int mode, enum object_type *type,
  65                           unsigned long *sizep)
  66{
  67        void *buffer;
  68        const struct commit *commit = args->convert ? args->commit : NULL;
  69
  70        path += args->baselen;
  71        buffer = read_sha1_file(sha1, type, sizep);
  72        if (buffer && S_ISREG(mode)) {
  73                struct strbuf buf = STRBUF_INIT;
  74                size_t size = 0;
  75
  76                strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
  77                convert_to_working_tree(path, buf.buf, buf.len, &buf);
  78                if (commit)
  79                        format_subst(commit, buf.buf, buf.len, &buf);
  80                buffer = strbuf_detach(&buf, &size);
  81                *sizep = size;
  82        }
  83
  84        return buffer;
  85}
  86
  87static void setup_archive_check(struct git_attr_check *check)
  88{
  89        static struct git_attr *attr_export_ignore;
  90        static struct git_attr *attr_export_subst;
  91
  92        if (!attr_export_ignore) {
  93                attr_export_ignore = git_attr("export-ignore");
  94                attr_export_subst = git_attr("export-subst");
  95        }
  96        check[0].attr = attr_export_ignore;
  97        check[1].attr = attr_export_subst;
  98}
  99
 100struct archiver_context {
 101        struct archiver_args *args;
 102        write_archive_entry_fn_t write_entry;
 103};
 104
 105static int write_archive_entry(const unsigned char *sha1, const char *base,
 106                int baselen, const char *filename, unsigned mode, int stage,
 107                void *context)
 108{
 109        static struct strbuf path = STRBUF_INIT;
 110        struct archiver_context *c = context;
 111        struct archiver_args *args = c->args;
 112        write_archive_entry_fn_t write_entry = c->write_entry;
 113        struct git_attr_check check[2];
 114        const char *path_without_prefix;
 115        int err;
 116
 117        args->convert = 0;
 118        strbuf_reset(&path);
 119        strbuf_grow(&path, PATH_MAX);
 120        strbuf_add(&path, args->base, args->baselen);
 121        strbuf_add(&path, base, baselen);
 122        strbuf_addstr(&path, filename);
 123        path_without_prefix = path.buf + args->baselen;
 124
 125        setup_archive_check(check);
 126        if (!git_check_attr(path_without_prefix, ARRAY_SIZE(check), check)) {
 127                if (ATTR_TRUE(check[0].value))
 128                        return 0;
 129                args->convert = ATTR_TRUE(check[1].value);
 130        }
 131
 132        if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
 133                strbuf_addch(&path, '/');
 134                if (args->verbose)
 135                        fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 136                err = write_entry(args, sha1, path.buf, path.len, mode);
 137                if (err)
 138                        return err;
 139                return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
 140        }
 141
 142        if (args->verbose)
 143                fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 144        return write_entry(args, sha1, path.buf, path.len, mode);
 145}
 146
 147int write_archive_entries(struct archiver_args *args,
 148                write_archive_entry_fn_t write_entry)
 149{
 150        struct archiver_context context;
 151        struct unpack_trees_options opts;
 152        struct tree_desc t;
 153        struct pathspec pathspec;
 154        int err;
 155
 156        if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
 157                size_t len = args->baselen;
 158
 159                while (len > 1 && args->base[len - 2] == '/')
 160                        len--;
 161                if (args->verbose)
 162                        fprintf(stderr, "%.*s\n", (int)len, args->base);
 163                err = write_entry(args, args->tree->object.sha1, args->base,
 164                                  len, 040777);
 165                if (err)
 166                        return err;
 167        }
 168
 169        context.args = args;
 170        context.write_entry = write_entry;
 171
 172        /*
 173         * Setup index and instruct attr to read index only
 174         */
 175        if (!args->worktree_attributes) {
 176                memset(&opts, 0, sizeof(opts));
 177                opts.index_only = 1;
 178                opts.head_idx = -1;
 179                opts.src_index = &the_index;
 180                opts.dst_index = &the_index;
 181                opts.fn = oneway_merge;
 182                init_tree_desc(&t, args->tree->buffer, args->tree->size);
 183                if (unpack_trees(1, &t, &opts))
 184                        return -1;
 185                git_attr_set_direction(GIT_ATTR_INDEX, &the_index);
 186        }
 187
 188        init_pathspec(&pathspec, args->pathspec);
 189        err = read_tree_recursive(args->tree, "", 0, 0, &pathspec,
 190                                  write_archive_entry, &context);
 191        free_pathspec(&pathspec);
 192        if (err == READ_TREE_RECURSIVE)
 193                err = 0;
 194        return err;
 195}
 196
 197static const struct archiver *lookup_archiver(const char *name)
 198{
 199        int i;
 200
 201        if (!name)
 202                return NULL;
 203
 204        for (i = 0; i < nr_archivers; i++) {
 205                if (!strcmp(name, archivers[i]->name))
 206                        return archivers[i];
 207        }
 208        return NULL;
 209}
 210
 211static int reject_entry(const unsigned char *sha1, const char *base,
 212                        int baselen, const char *filename, unsigned mode,
 213                        int stage, void *context)
 214{
 215        return -1;
 216}
 217
 218static int path_exists(struct tree *tree, const char *path)
 219{
 220        const char *paths[] = { path, NULL };
 221        struct pathspec pathspec;
 222        int ret;
 223
 224        init_pathspec(&pathspec, paths);
 225        ret = read_tree_recursive(tree, "", 0, 0, &pathspec, reject_entry, NULL);
 226        free_pathspec(&pathspec);
 227        return ret != 0;
 228}
 229
 230static void parse_pathspec_arg(const char **pathspec,
 231                struct archiver_args *ar_args)
 232{
 233        ar_args->pathspec = pathspec = get_pathspec("", pathspec);
 234        if (pathspec) {
 235                while (*pathspec) {
 236                        if (!path_exists(ar_args->tree, *pathspec))
 237                                die("path not found: %s", *pathspec);
 238                        pathspec++;
 239                }
 240        }
 241}
 242
 243static void parse_treeish_arg(const char **argv,
 244                struct archiver_args *ar_args, const char *prefix,
 245                int remote)
 246{
 247        const char *name = argv[0];
 248        const unsigned char *commit_sha1;
 249        time_t archive_time;
 250        struct tree *tree;
 251        const struct commit *commit;
 252        unsigned char sha1[20];
 253
 254        /* Remotes are only allowed to fetch actual refs */
 255        if (remote) {
 256                char *ref = NULL;
 257                const char *colon = strchr(name, ':');
 258                int refnamelen = colon ? colon - name : strlen(name);
 259
 260                if (!dwim_ref(name, refnamelen, sha1, &ref))
 261                        die("no such ref: %.*s", refnamelen, name);
 262                free(ref);
 263        }
 264
 265        if (get_sha1(name, sha1))
 266                die("Not a valid object name");
 267
 268        commit = lookup_commit_reference_gently(sha1, 1);
 269        if (commit) {
 270                commit_sha1 = commit->object.sha1;
 271                archive_time = commit->date;
 272        } else {
 273                commit_sha1 = NULL;
 274                archive_time = time(NULL);
 275        }
 276
 277        tree = parse_tree_indirect(sha1);
 278        if (tree == NULL)
 279                die("not a tree object");
 280
 281        if (prefix) {
 282                unsigned char tree_sha1[20];
 283                unsigned int mode;
 284                int err;
 285
 286                err = get_tree_entry(tree->object.sha1, prefix,
 287                                     tree_sha1, &mode);
 288                if (err || !S_ISDIR(mode))
 289                        die("current working directory is untracked");
 290
 291                tree = parse_tree_indirect(tree_sha1);
 292        }
 293        ar_args->tree = tree;
 294        ar_args->commit_sha1 = commit_sha1;
 295        ar_args->commit = commit;
 296        ar_args->time = archive_time;
 297}
 298
 299#define OPT__COMPR(s, v, h, p) \
 300        { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
 301          PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
 302#define OPT__COMPR_HIDDEN(s, v, p) \
 303        { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
 304          PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
 305
 306static int parse_archive_args(int argc, const char **argv,
 307                const struct archiver **ar, struct archiver_args *args,
 308                const char *name_hint, int is_remote)
 309{
 310        const char *format = NULL;
 311        const char *base = NULL;
 312        const char *remote = NULL;
 313        const char *exec = NULL;
 314        const char *output = NULL;
 315        int compression_level = -1;
 316        int verbose = 0;
 317        int i;
 318        int list = 0;
 319        int worktree_attributes = 0;
 320        struct option opts[] = {
 321                OPT_GROUP(""),
 322                OPT_STRING(0, "format", &format, "fmt", "archive format"),
 323                OPT_STRING(0, "prefix", &base, "prefix",
 324                        "prepend prefix to each pathname in the archive"),
 325                OPT_STRING('o', "output", &output, "file",
 326                        "write the archive to this file"),
 327                OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
 328                        "read .gitattributes in working directory"),
 329                OPT__VERBOSE(&verbose, "report archived files on stderr"),
 330                OPT__COMPR('0', &compression_level, "store only", 0),
 331                OPT__COMPR('1', &compression_level, "compress faster", 1),
 332                OPT__COMPR_HIDDEN('2', &compression_level, 2),
 333                OPT__COMPR_HIDDEN('3', &compression_level, 3),
 334                OPT__COMPR_HIDDEN('4', &compression_level, 4),
 335                OPT__COMPR_HIDDEN('5', &compression_level, 5),
 336                OPT__COMPR_HIDDEN('6', &compression_level, 6),
 337                OPT__COMPR_HIDDEN('7', &compression_level, 7),
 338                OPT__COMPR_HIDDEN('8', &compression_level, 8),
 339                OPT__COMPR('9', &compression_level, "compress better", 9),
 340                OPT_GROUP(""),
 341                OPT_BOOL('l', "list", &list,
 342                        "list supported archive formats"),
 343                OPT_GROUP(""),
 344                OPT_STRING(0, "remote", &remote, "repo",
 345                        "retrieve the archive from remote repository <repo>"),
 346                OPT_STRING(0, "exec", &exec, "cmd",
 347                        "path to the remote git-upload-archive command"),
 348                OPT_END()
 349        };
 350
 351        argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
 352
 353        if (remote)
 354                die("Unexpected option --remote");
 355        if (exec)
 356                die("Option --exec can only be used together with --remote");
 357        if (output)
 358                die("Unexpected option --output");
 359
 360        if (!base)
 361                base = "";
 362
 363        if (list) {
 364                for (i = 0; i < nr_archivers; i++)
 365                        if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
 366                                printf("%s\n", archivers[i]->name);
 367                exit(0);
 368        }
 369
 370        if (!format && name_hint)
 371                format = archive_format_from_filename(name_hint);
 372        if (!format)
 373                format = "tar";
 374
 375        /* We need at least one parameter -- tree-ish */
 376        if (argc < 1)
 377                usage_with_options(archive_usage, opts);
 378        *ar = lookup_archiver(format);
 379        if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
 380                die("Unknown archive format '%s'", format);
 381
 382        args->compression_level = Z_DEFAULT_COMPRESSION;
 383        if (compression_level != -1) {
 384                if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
 385                        args->compression_level = compression_level;
 386                else {
 387                        die("Argument not supported for format '%s': -%d",
 388                                        format, compression_level);
 389                }
 390        }
 391        args->verbose = verbose;
 392        args->base = base;
 393        args->baselen = strlen(base);
 394        args->worktree_attributes = worktree_attributes;
 395
 396        return argc;
 397}
 398
 399int write_archive(int argc, const char **argv, const char *prefix,
 400                  int setup_prefix, const char *name_hint, int remote)
 401{
 402        int nongit = 0;
 403        const struct archiver *ar = NULL;
 404        struct archiver_args args;
 405
 406        if (setup_prefix && prefix == NULL)
 407                prefix = setup_git_directory_gently(&nongit);
 408
 409        git_config(git_default_config, NULL);
 410        init_tar_archiver();
 411        init_zip_archiver();
 412
 413        argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
 414        if (nongit) {
 415                /*
 416                 * We know this will die() with an error, so we could just
 417                 * die ourselves; but its error message will be more specific
 418                 * than what we could write here.
 419                 */
 420                setup_git_directory();
 421        }
 422
 423        parse_treeish_arg(argv, &args, prefix, remote);
 424        parse_pathspec_arg(argv + 1, &args);
 425
 426        return ar->write_archive(ar, &args);
 427}
 428
 429static int match_extension(const char *filename, const char *ext)
 430{
 431        int prefixlen = strlen(filename) - strlen(ext);
 432
 433        /*
 434         * We need 1 character for the '.', and 1 character to ensure that the
 435         * prefix is non-empty (k.e., we don't match .tar.gz with no actual
 436         * filename).
 437         */
 438        if (prefixlen < 2 || filename[prefixlen-1] != '.')
 439                return 0;
 440        return !strcmp(filename + prefixlen, ext);
 441}
 442
 443const char *archive_format_from_filename(const char *filename)
 444{
 445        int i;
 446
 447        for (i = 0; i < nr_archivers; i++)
 448                if (match_extension(filename, archivers[i]->name))
 449                        return archivers[i]->name;
 450        return NULL;
 451}