ls-refs.c

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