builtin/ls-remote.c

   1 #include "builtin.h"
   2 #include "gettext.h"
   3 #include "hex.h"
   4 #include "transport.h"
   5 #include "pkt-line.h"
   6 #include "ref-filter.h"
   7 #include "remote.h"
   8 #include "refs.h"
   9 #include "parse-options.h"
  10
  11 static const char * const ls_remote_usage[] = {
  12         N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]\n"
  13            "              [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]\n"
  14            "              [--symref] [<repository> [<patterns>...]]"),
  15         NULL
  16 };
  17
  18 /*
  19  * Is there one among the list of patterns that match the tail part
  20  * of the path?
  21  */
  22 static int tail_match(const char **pattern, const char *path)
  23 {
  24         const char *p;
  25         char *pathbuf;
  26
  27         if (!pattern)
  28                 return 1; /* no restriction */
  29
  30         pathbuf = xstrfmt("/%s", path);
  31         while ((p = *(pattern++)) != NULL) {
  32                 if (!wildmatch(p, pathbuf, 0)) {
  33                         free(pathbuf);
  34                         return 1;
  35                 }
  36         }
  37         free(pathbuf);
  38         return 0;
  39 }
  40
  41 int cmd_ls_remote(int argc, const char **argv, const char *prefix)
  42 {
  43         const char *dest = NULL;
  44         unsigned flags = 0;
  45         int get_url = 0;
  46         int quiet = 0;
  47         int status = 0;
  48         int show_symref_target = 0;
  49         const char *uploadpack = NULL;
  50         const char **pattern = NULL;
  51         struct transport_ls_refs_options transport_options =
  52                 TRANSPORT_LS_REFS_OPTIONS_INIT;
  53         int i;
  54         struct string_list server_options = STRING_LIST_INIT_DUP;
  55
  56         struct remote *remote;
  57         struct transport *transport;
  58         const struct ref *ref;
  59         struct ref_array ref_array;
  60         struct string_list sorting_options = STRING_LIST_INIT_DUP;
  61
  62         struct option options[] = {
  63                 OPT__QUIET(&quiet, N_("do not print remote URL")),
  64                 OPT_STRING(0, "upload-pack", &uploadpack, N_("exec"),
  65                            N_("path of git-upload-pack on the remote host")),
  66                 { OPTION_STRING, 0, "exec", &uploadpack, N_("exec"),
  67                            N_("path of git-upload-pack on the remote host"),
  68                            PARSE_OPT_HIDDEN },
  69                 OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS),
  70                 OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_HEADS),
  71                 OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL),
  72                 OPT_BOOL(0, "get-url", &get_url,
  73                          N_("take url.<base>.insteadOf into account")),
  74                 OPT_REF_SORT(&sorting_options),
  75                 OPT_SET_INT_F(0, "exit-code", &status,
  76                               N_("exit with exit code 2 if no matching refs are found"),
  77                               2, PARSE_OPT_NOCOMPLETE),
  78                 OPT_BOOL(0, "symref", &show_symref_target,
  79                          N_("show underlying ref in addition to the object pointed by it")),
  80                 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
  81                 OPT_END()
  82         };
  83
  84         memset(&ref_array, 0, sizeof(ref_array));
  85
  86         argc = parse_options(argc, argv, prefix, options, ls_remote_usage,
  87                              PARSE_OPT_STOP_AT_NON_OPTION);
  88         dest = argv[0];
  89
  90         packet_trace_identity("ls-remote");
  91
  92         if (argc > 1) {
  93                 int i;
  94                 CALLOC_ARRAY(pattern, argc);
  95                 for (i = 1; i < argc; i++) {
  96                         pattern[i - 1] = xstrfmt("*/%s", argv[i]);
  97                 }
  98         }
  99
 100         if (flags & REF_TAGS)
 101                 strvec_push(&transport_options.ref_prefixes, "refs/tags/");
 102         if (flags & REF_HEADS)
 103                 strvec_push(&transport_options.ref_prefixes, "refs/heads/");
 104
 105         remote = remote_get(dest);
 106         if (!remote) {
 107                 if (dest)
 108                         die("bad repository '%s'", dest);
 109                 die("No remote configured to list refs from.");
 110         }
 111         if (!remote->url_nr)
 112                 die("remote %s has no configured URL", dest);
 113
 114         if (get_url) {
 115                 printf("%s\n", *remote->url);
 116                 return 0;
 117         }
 118
 119         transport = transport_get(remote, NULL);
 120         if (uploadpack)
 121                 transport_set_option(transport, TRANS_OPT_UPLOADPACK, uploadpack);
 122         if (server_options.nr)
 123                 transport->server_options = &server_options;
 124
 125         ref = transport_get_remote_refs(transport, &transport_options);
 126         if (ref) {
 127                 int hash_algo = hash_algo_by_ptr(transport_get_hash_algo(transport));
 128                 repo_set_hash_algo(the_repository, hash_algo);
 129         }
 130
 131         if (!dest && !quiet)
 132                 fprintf(stderr, "From %s\n", *remote->url);
 133         for ( ; ref; ref = ref->next) {
 134                 struct ref_array_item *item;
 135                 if (!check_ref_type(ref, flags))
 136                         continue;
 137                 if (!tail_match(pattern, ref->name))
 138                         continue;
 139                 item = ref_array_push(&ref_array, ref->name, &ref->old_oid);
 140                 item->symref = xstrdup_or_null(ref->symref);
 141         }
 142
 143         if (sorting_options.nr) {
 144                 struct ref_sorting *sorting;
 145
 146                 sorting = ref_sorting_options(&sorting_options);
 147                 ref_array_sort(sorting, &ref_array);
 148                 ref_sorting_release(sorting);
 149         }
 150
 151         for (i = 0; i < ref_array.nr; i++) {
 152                 const struct ref_array_item *ref = ref_array.items[i];
 153                 if (show_symref_target && ref->symref)
 154                         printf("ref: %s\t%s\n", ref->symref, ref->refname);
 155                 printf("%s\t%s\n", oid_to_hex(&ref->objectname), ref->refname);
 156                 status = 0; /* we found something */
 157         }
 158
 159         ref_array_clear(&ref_array);
 160         if (transport_disconnect(transport))
 161                 status = 1;
 162         transport_ls_refs_options_release(&transport_options);
 163         return status;
 164 }