builtin-archive.con commit manpages: use teletype font for sample command lines (db5d666)
   1/*
   2 * Copyright (c) 2006 Franck Bui-Huu
   3 * Copyright (c) 2006 Rene Scharfe
   4 */
   5#include "cache.h"
   6#include "builtin.h"
   7#include "archive.h"
   8#include "commit.h"
   9#include "tree-walk.h"
  10#include "exec_cmd.h"
  11#include "pkt-line.h"
  12#include "sideband.h"
  13#include "attr.h"
  14
  15static const char archive_usage[] = \
  16"git-archive --format=<fmt> [--prefix=<prefix>/] [--verbose] [<extra>] <tree-ish> [path...]";
  17
  18static struct archiver_desc
  19{
  20        const char *name;
  21        write_archive_fn_t write_archive;
  22        parse_extra_args_fn_t parse_extra;
  23} archivers[] = {
  24        { "tar", write_tar_archive, NULL },
  25        { "zip", write_zip_archive, parse_extra_zip_args },
  26};
  27
  28static int run_remote_archiver(const char *remote, int argc,
  29                               const char **argv)
  30{
  31        char *url, buf[LARGE_PACKET_MAX];
  32        int fd[2], i, len, rv;
  33        struct child_process *conn;
  34        const char *exec = "git-upload-archive";
  35        int exec_at = 0;
  36
  37        for (i = 1; i < argc; i++) {
  38                const char *arg = argv[i];
  39                if (!prefixcmp(arg, "--exec=")) {
  40                        if (exec_at)
  41                                die("multiple --exec specified");
  42                        exec = arg + 7;
  43                        exec_at = i;
  44                        break;
  45                }
  46        }
  47
  48        url = xstrdup(remote);
  49        conn = git_connect(fd, url, exec, 0);
  50
  51        for (i = 1; i < argc; i++) {
  52                if (i == exec_at)
  53                        continue;
  54                packet_write(fd[1], "argument %s\n", argv[i]);
  55        }
  56        packet_flush(fd[1]);
  57
  58        len = packet_read_line(fd[0], buf, sizeof(buf));
  59        if (!len)
  60                die("git-archive: expected ACK/NAK, got EOF");
  61        if (buf[len-1] == '\n')
  62                buf[--len] = 0;
  63        if (strcmp(buf, "ACK")) {
  64                if (len > 5 && !prefixcmp(buf, "NACK "))
  65                        die("git-archive: NACK %s", buf + 5);
  66                die("git-archive: protocol error");
  67        }
  68
  69        len = packet_read_line(fd[0], buf, sizeof(buf));
  70        if (len)
  71                die("git-archive: expected a flush");
  72
  73        /* Now, start reading from fd[0] and spit it out to stdout */
  74        rv = recv_sideband("archive", fd[0], 1, 2);
  75        close(fd[0]);
  76        close(fd[1]);
  77        rv |= finish_connect(conn);
  78
  79        return !!rv;
  80}
  81
  82static int init_archiver(const char *name, struct archiver *ar)
  83{
  84        int rv = -1, i;
  85
  86        for (i = 0; i < ARRAY_SIZE(archivers); i++) {
  87                if (!strcmp(name, archivers[i].name)) {
  88                        memset(ar, 0, sizeof(*ar));
  89                        ar->name = archivers[i].name;
  90                        ar->write_archive = archivers[i].write_archive;
  91                        ar->parse_extra = archivers[i].parse_extra;
  92                        rv = 0;
  93                        break;
  94                }
  95        }
  96        return rv;
  97}
  98
  99void parse_pathspec_arg(const char **pathspec, struct archiver_args *ar_args)
 100{
 101        ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
 102}
 103
 104void parse_treeish_arg(const char **argv, struct archiver_args *ar_args,
 105                       const char *prefix)
 106{
 107        const char *name = argv[0];
 108        const unsigned char *commit_sha1;
 109        time_t archive_time;
 110        struct tree *tree;
 111        const struct commit *commit;
 112        unsigned char sha1[20];
 113
 114        if (get_sha1(name, sha1))
 115                die("Not a valid object name");
 116
 117        commit = lookup_commit_reference_gently(sha1, 1);
 118        if (commit) {
 119                commit_sha1 = commit->object.sha1;
 120                archive_time = commit->date;
 121        } else {
 122                commit_sha1 = NULL;
 123                archive_time = time(NULL);
 124        }
 125
 126        tree = parse_tree_indirect(sha1);
 127        if (tree == NULL)
 128                die("not a tree object");
 129
 130        if (prefix) {
 131                unsigned char tree_sha1[20];
 132                unsigned int mode;
 133                int err;
 134
 135                err = get_tree_entry(tree->object.sha1, prefix,
 136                                     tree_sha1, &mode);
 137                if (err || !S_ISDIR(mode))
 138                        die("current working directory is untracked");
 139
 140                tree = parse_tree_indirect(tree_sha1);
 141        }
 142        ar_args->tree = tree;
 143        ar_args->commit_sha1 = commit_sha1;
 144        ar_args->commit = commit;
 145        ar_args->time = archive_time;
 146}
 147
 148int parse_archive_args(int argc, const char **argv, struct archiver *ar)
 149{
 150        const char *extra_argv[MAX_EXTRA_ARGS];
 151        int extra_argc = 0;
 152        const char *format = "tar";
 153        const char *base = "";
 154        int verbose = 0;
 155        int i;
 156
 157        for (i = 1; i < argc; i++) {
 158                const char *arg = argv[i];
 159
 160                if (!strcmp(arg, "--list") || !strcmp(arg, "-l")) {
 161                        for (i = 0; i < ARRAY_SIZE(archivers); i++)
 162                                printf("%s\n", archivers[i].name);
 163                        exit(0);
 164                }
 165                if (!strcmp(arg, "--verbose") || !strcmp(arg, "-v")) {
 166                        verbose = 1;
 167                        continue;
 168                }
 169                if (!prefixcmp(arg, "--format=")) {
 170                        format = arg + 9;
 171                        continue;
 172                }
 173                if (!prefixcmp(arg, "--prefix=")) {
 174                        base = arg + 9;
 175                        continue;
 176                }
 177                if (!strcmp(arg, "--")) {
 178                        i++;
 179                        break;
 180                }
 181                if (arg[0] == '-') {
 182                        if (extra_argc > MAX_EXTRA_ARGS - 1)
 183                                die("Too many extra options");
 184                        extra_argv[extra_argc++] = arg;
 185                        continue;
 186                }
 187                break;
 188        }
 189
 190        /* We need at least one parameter -- tree-ish */
 191        if (argc - 1 < i)
 192                usage(archive_usage);
 193        if (init_archiver(format, ar) < 0)
 194                die("Unknown archive format '%s'", format);
 195
 196        if (extra_argc) {
 197                if (!ar->parse_extra)
 198                        die("'%s' format does not handle %s",
 199                            ar->name, extra_argv[0]);
 200                ar->args.extra = ar->parse_extra(extra_argc, extra_argv);
 201        }
 202        ar->args.verbose = verbose;
 203        ar->args.base = base;
 204
 205        return i;
 206}
 207
 208static const char *extract_remote_arg(int *ac, const char **av)
 209{
 210        int ix, iy, cnt = *ac;
 211        int no_more_options = 0;
 212        const char *remote = NULL;
 213
 214        for (ix = iy = 1; ix < cnt; ix++) {
 215                const char *arg = av[ix];
 216                if (!strcmp(arg, "--"))
 217                        no_more_options = 1;
 218                if (!no_more_options) {
 219                        if (!prefixcmp(arg, "--remote=")) {
 220                                if (remote)
 221                                        die("Multiple --remote specified");
 222                                remote = arg + 9;
 223                                continue;
 224                        }
 225                        if (arg[0] != '-')
 226                                no_more_options = 1;
 227                }
 228                if (ix != iy)
 229                        av[iy] = arg;
 230                iy++;
 231        }
 232        if (remote) {
 233                av[--cnt] = NULL;
 234                *ac = cnt;
 235        }
 236        return remote;
 237}
 238
 239int cmd_archive(int argc, const char **argv, const char *prefix)
 240{
 241        struct archiver ar;
 242        int tree_idx;
 243        const char *remote = NULL;
 244
 245        remote = extract_remote_arg(&argc, argv);
 246        if (remote)
 247                return run_remote_archiver(remote, argc, argv);
 248
 249        setvbuf(stderr, NULL, _IOLBF, BUFSIZ);
 250
 251        memset(&ar, 0, sizeof(ar));
 252        tree_idx = parse_archive_args(argc, argv, &ar);
 253        if (prefix == NULL)
 254                prefix = setup_git_directory();
 255
 256        argv += tree_idx;
 257        parse_treeish_arg(argv, &ar.args, prefix);
 258        parse_pathspec_arg(argv + 1, &ar.args);
 259
 260        return ar.write_archive(&ar.args);
 261}