Merge branch 'jc/receive-pack-hook-doc'
[git] / builtin / ls-remote.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "transport.h"
4 #include "remote.h"
5
6 static const char * const ls_remote_usage[] = {
7         N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]\n"
8            "                     [-q | --quiet] [--exit-code] [--get-url]\n"
9            "                     [--symref] [<repository> [<refs>...]]"),
10         NULL
11 };
12
13 /*
14  * Is there one among the list of patterns that match the tail part
15  * of the path?
16  */
17 static int tail_match(const char **pattern, const char *path)
18 {
19         const char *p;
20         char *pathbuf;
21
22         if (!pattern)
23                 return 1; /* no restriction */
24
25         pathbuf = xstrfmt("/%s", path);
26         while ((p = *(pattern++)) != NULL) {
27                 if (!wildmatch(p, pathbuf, 0)) {
28                         free(pathbuf);
29                         return 1;
30                 }
31         }
32         free(pathbuf);
33         return 0;
34 }
35
36 int cmd_ls_remote(int argc, const char **argv, const char *prefix)
37 {
38         const char *dest = NULL;
39         unsigned flags = 0;
40         int get_url = 0;
41         int quiet = 0;
42         int status = 0;
43         int show_symref_target = 0;
44         const char *uploadpack = NULL;
45         const char **pattern = NULL;
46
47         struct remote *remote;
48         struct transport *transport;
49         const struct ref *ref;
50
51         struct option options[] = {
52                 OPT__QUIET(&quiet, N_("do not print remote URL")),
53                 OPT_STRING(0, "upload-pack", &uploadpack, N_("exec"),
54                            N_("path of git-upload-pack on the remote host")),
55                 { OPTION_STRING, 0, "exec", &uploadpack, N_("exec"),
56                            N_("path of git-upload-pack on the remote host"),
57                            PARSE_OPT_HIDDEN },
58                 OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS),
59                 OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_HEADS),
60                 OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL),
61                 OPT_BOOL(0, "get-url", &get_url,
62                          N_("take url.<base>.insteadOf into account")),
63                 OPT_SET_INT(0, "exit-code", &status,
64                             N_("exit with exit code 2 if no matching refs are found"), 2),
65                 OPT_BOOL(0, "symref", &show_symref_target,
66                          N_("show underlying ref in addition to the object pointed by it")),
67                 OPT_END()
68         };
69
70         argc = parse_options(argc, argv, prefix, options, ls_remote_usage,
71                              PARSE_OPT_STOP_AT_NON_OPTION);
72         dest = argv[0];
73
74         if (argc > 1) {
75                 int i;
76                 pattern = xcalloc(argc, sizeof(const char *));
77                 for (i = 1; i < argc; i++)
78                         pattern[i - 1] = xstrfmt("*/%s", argv[i]);
79         }
80
81         remote = remote_get(dest);
82         if (!remote) {
83                 if (dest)
84                         die("bad repository '%s'", dest);
85                 die("No remote configured to list refs from.");
86         }
87         if (!remote->url_nr)
88                 die("remote %s has no configured URL", dest);
89
90         if (get_url) {
91                 printf("%s\n", *remote->url);
92                 return 0;
93         }
94
95         transport = transport_get(remote, NULL);
96         if (uploadpack != NULL)
97                 transport_set_option(transport, TRANS_OPT_UPLOADPACK, uploadpack);
98
99         ref = transport_get_remote_refs(transport);
100         if (transport_disconnect(transport))
101                 return 1;
102
103         if (!dest && !quiet)
104                 fprintf(stderr, "From %s\n", *remote->url);
105         for ( ; ref; ref = ref->next) {
106                 if (!check_ref_type(ref, flags))
107                         continue;
108                 if (!tail_match(pattern, ref->name))
109                         continue;
110                 if (show_symref_target && ref->symref)
111                         printf("ref: %s\t%s\n", ref->symref, ref->name);
112                 printf("%s\t%s\n", oid_to_hex(&ref->old_oid), ref->name);
113                 status = 0; /* we found something */
114         }
115         return status;
116 }