ls-refs.c

   1 #include "git-compat-util.h"
   2 #include "environment.h"
   3 #include "gettext.h"
   4 #include "hex.h"
   5 #include "repository.h"
   6 #include "refs.h"
   7 #include "remote.h"
   8 #include "strvec.h"
   9 #include "ls-refs.h"
  10 #include "pkt-line.h"
  11 #include "config.h"
  12 #include "string-list.h"
  13
  14 static enum {
  15         UNBORN_IGNORE = 0,
  16         UNBORN_ALLOW,
  17         UNBORN_ADVERTISE /* implies ALLOW */
  18 } unborn_config(struct repository *r)
  19 {
  20         const char *str = NULL;
  21
  22         if (repo_config_get_string_tmp(r, "lsrefs.unborn", &str)) {
  23                 /*
  24                  * If there is no such config, advertise and allow it by
  25                  * default.
  26                  */
  27                 return UNBORN_ADVERTISE;
  28         } else {
  29                 if (!strcmp(str, "advertise")) {
  30                         return UNBORN_ADVERTISE;
  31                 } else if (!strcmp(str, "allow")) {
  32                         return UNBORN_ALLOW;
  33                 } else if (!strcmp(str, "ignore")) {
  34                         return UNBORN_IGNORE;
  35                 } else {
  36                         die(_("invalid value for '%s': '%s'"),
  37                             "lsrefs.unborn", str);
  38                 }
  39         }
  40 }
  41
  42 /*
  43  * If we see this many or more "ref-prefix" lines from the client, we consider
  44  * it "too many" and will avoid using the prefix feature entirely.
  45  */
  46 #define TOO_MANY_PREFIXES 65536
  47
  48 /*
  49  * Check if one of the prefixes is a prefix of the ref.
  50  * If no prefixes were provided, all refs match.
  51  */
  52 static int ref_match(const struct strvec *prefixes, const char *refname)
  53 {
  54         int i;
  55
  56         if (!prefixes->nr)
  57                 return 1; /* no restriction */
  58
  59         for (i = 0; i < prefixes->nr; i++) {
  60                 const char *prefix = prefixes->v[i];
  61
  62                 if (starts_with(refname, prefix))
  63                         return 1;
  64         }
  65
  66         return 0;
  67 }
  68
  69 struct ls_refs_data {
  70         unsigned peel;
  71         unsigned symrefs;
  72         struct strvec prefixes;
  73         struct strbuf buf;
  74         struct string_list hidden_refs;
  75         unsigned unborn : 1;
  76 };
  77
  78 static int send_ref(const char *refname, const struct object_id *oid,
  79                     int flag, void *cb_data)
  80 {
  81         struct ls_refs_data *data = cb_data;
  82         const char *refname_nons = strip_namespace(refname);
  83
  84         strbuf_reset(&data->buf);
  85
  86         if (ref_is_hidden(refname_nons, refname, &data->hidden_refs))
  87                 return 0;
  88
  89         if (!ref_match(&data->prefixes, refname_nons))
  90                 return 0;
  91
  92         if (oid)
  93                 strbuf_addf(&data->buf, "%s %s", oid_to_hex(oid), refname_nons);
  94         else
  95                 strbuf_addf(&data->buf, "unborn %s", refname_nons);
  96         if (data->symrefs && flag & REF_ISSYMREF) {
  97                 struct object_id unused;
  98                 const char *symref_target = resolve_ref_unsafe(refname, 0,
  99                                                                &unused,
 100                                                                &flag);
 101
 102                 if (!symref_target)
 103                         die("'%s' is a symref but it is not?", refname);
 104
 105                 strbuf_addf(&data->buf, " symref-target:%s",
 106                             strip_namespace(symref_target));
 107         }
 108
 109         if (data->peel && oid) {
 110                 struct object_id peeled;
 111                 if (!peel_iterated_oid(oid, &peeled))
 112                         strbuf_addf(&data->buf, " peeled:%s", oid_to_hex(&peeled));
 113         }
 114
 115         strbuf_addch(&data->buf, '\n');
 116         packet_fwrite(stdout, data->buf.buf, data->buf.len);
 117
 118         return 0;
 119 }
 120
 121 static void send_possibly_unborn_head(struct ls_refs_data *data)
 122 {
 123         struct strbuf namespaced = STRBUF_INIT;
 124         struct object_id oid;
 125         int flag;
 126         int oid_is_null;
 127
 128         strbuf_addf(&namespaced, "%sHEAD", get_git_namespace());
 129         if (!resolve_ref_unsafe(namespaced.buf, 0, &oid, &flag))
 130                 return; /* bad ref */
 131         oid_is_null = is_null_oid(&oid);
 132         if (!oid_is_null ||
 133             (data->unborn && data->symrefs && (flag & REF_ISSYMREF)))
 134                 send_ref(namespaced.buf, oid_is_null ? NULL : &oid, flag, data);
 135         strbuf_release(&namespaced);
 136 }
 137
 138 static int ls_refs_config(const char *var, const char *value,
 139                           void *cb_data)
 140 {
 141         struct ls_refs_data *data = cb_data;
 142         /*
 143          * We only serve fetches over v2 for now, so respect only "uploadpack"
 144          * config. This may need to eventually be expanded to "receive", but we
 145          * don't yet know how that information will be passed to ls-refs.
 146          */
 147         return parse_hide_refs_config(var, value, "uploadpack", &data->hidden_refs);
 148 }
 149
 150 int ls_refs(struct repository *r, struct packet_reader *request)
 151 {
 152         struct ls_refs_data data;
 153
 154         memset(&data, 0, sizeof(data));
 155         strvec_init(&data.prefixes);
 156         strbuf_init(&data.buf, 0);
 157         string_list_init_dup(&data.hidden_refs);
 158
 159         git_config(ls_refs_config, &data);
 160
 161         while (packet_reader_read(request) == PACKET_READ_NORMAL) {
 162                 const char *arg = request->line;
 163                 const char *out;
 164
 165                 if (!strcmp("peel", arg))
 166                         data.peel = 1;
 167                 else if (!strcmp("symrefs", arg))
 168                         data.symrefs = 1;
 169                 else if (skip_prefix(arg, "ref-prefix ", &out)) {
 170                         if (data.prefixes.nr < TOO_MANY_PREFIXES)
 171                                 strvec_push(&data.prefixes, out);
 172                 }
 173                 else if (!strcmp("unborn", arg))
 174                         data.unborn = !!unborn_config(r);
 175                 else
 176                         die(_("unexpected line: '%s'"), arg);
 177         }
 178
 179         if (request->status != PACKET_READ_FLUSH)
 180                 die(_("expected flush after ls-refs arguments"));
 181
 182         /*
 183          * If we saw too many prefixes, we must avoid using them at all; as
 184          * soon as we have any prefix, they are meant to form a comprehensive
 185          * list.
 186          */
 187         if (data.prefixes.nr >= TOO_MANY_PREFIXES)
 188                 strvec_clear(&data.prefixes);
 189
 190         send_possibly_unborn_head(&data);
 191         if (!data.prefixes.nr)
 192                 strvec_push(&data.prefixes, "");
 193         refs_for_each_fullref_in_prefixes(get_main_ref_store(r),
 194                                           get_git_namespace(), data.prefixes.v,
 195                                           send_ref, &data);
 196         packet_fflush(stdout);
 197         strvec_clear(&data.prefixes);
 198         strbuf_release(&data.buf);
 199         string_list_clear(&data.hidden_refs, 0);
 200         return 0;
 201 }
 202
 203 int ls_refs_advertise(struct repository *r, struct strbuf *value)
 204 {
 205         if (value && unborn_config(r) == UNBORN_ADVERTISE)
 206                 strbuf_addstr(value, "unborn");
 207
 208         return 1;
 209 }