fetch-pack: put shallow info in output parameter
[gitweb.git] / submodule-config.c
index 2b83c2319fbf5af69383cf188980e7787c767ab3..388ef1f892bdd63a485d9c93810a945fc3eab46f 100644 (file)
@@ -9,7 +9,7 @@
 /*
  * submodule cache lookup structure
  * There is one shared set of 'struct submodule' entries which can be
- * looked up by their sha1 blob id of the .gitmodule file and either
+ * looked up by their sha1 blob id of the .gitmodules file and either
  * using path or name as key.
  * for_path stores submodule entries with path as key
  * for_name stores submodule entries with name as key
@@ -18,6 +18,7 @@ struct submodule_cache {
        struct hashmap for_path;
        struct hashmap for_name;
        unsigned initialized:1;
+       unsigned gitmodules_read:1;
 };
 
 /*
@@ -43,7 +44,7 @@ static int config_path_cmp(const void *unused_cmp_data,
        const struct submodule_entry *b = entry_or_key;
 
        return strcmp(a->config->path, b->config->path) ||
-              hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
+              oidcmp(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
 }
 
 static int config_name_cmp(const void *unused_cmp_data,
@@ -55,7 +56,7 @@ static int config_name_cmp(const void *unused_cmp_data,
        const struct submodule_entry *b = entry_or_key;
 
        return strcmp(a->config->name, b->config->name) ||
-              hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
+              oidcmp(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
 }
 
 static struct submodule_cache *submodule_cache_alloc(void)
@@ -90,7 +91,7 @@ static void submodule_cache_clear(struct submodule_cache *cache)
        /*
         * We iterate over the name hash here to be symmetric with the
         * allocation of struct submodule entries. Each is allocated by
-        * their .gitmodule blob sha1 and submodule name.
+        * their .gitmodules blob sha1 and submodule name.
         */
        hashmap_iter_init(&cache->for_name, &iter);
        while ((entry = hashmap_iter_next(&iter)))
@@ -99,6 +100,7 @@ static void submodule_cache_clear(struct submodule_cache *cache)
        hashmap_free(&cache->for_path, 1);
        hashmap_free(&cache->for_name, 1);
        cache->initialized = 0;
+       cache->gitmodules_read = 0;
 }
 
 void submodule_cache_free(struct submodule_cache *cache)
@@ -107,17 +109,17 @@ void submodule_cache_free(struct submodule_cache *cache)
        free(cache);
 }
 
-static unsigned int hash_sha1_string(const unsigned char *sha1,
-                                    const char *string)
+static unsigned int hash_oid_string(const struct object_id *oid,
+                                   const char *string)
 {
-       return memhash(sha1, 20) + strhash(string);
+       return memhash(oid->hash, the_hash_algo->rawsz) + strhash(string);
 }
 
 static void cache_put_path(struct submodule_cache *cache,
                           struct submodule *submodule)
 {
-       unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
-                                            submodule->path);
+       unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
+                                           submodule->path);
        struct submodule_entry *e = xmalloc(sizeof(*e));
        hashmap_entry_init(e, hash);
        e->config = submodule;
@@ -127,8 +129,8 @@ static void cache_put_path(struct submodule_cache *cache,
 static void cache_remove_path(struct submodule_cache *cache,
                              struct submodule *submodule)
 {
-       unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
-                                            submodule->path);
+       unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
+                                           submodule->path);
        struct submodule_entry e;
        struct submodule_entry *removed;
        hashmap_entry_init(&e, hash);
@@ -140,8 +142,8 @@ static void cache_remove_path(struct submodule_cache *cache,
 static void cache_add(struct submodule_cache *cache,
                      struct submodule *submodule)
 {
-       unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
-                                            submodule->name);
+       unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
+                                           submodule->name);
        struct submodule_entry *e = xmalloc(sizeof(*e));
        hashmap_entry_init(e, hash);
        e->config = submodule;
@@ -149,14 +151,14 @@ static void cache_add(struct submodule_cache *cache,
 }
 
 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
-               const unsigned char *gitmodules_sha1, const char *path)
+               const struct object_id *gitmodules_oid, const char *path)
 {
        struct submodule_entry *entry;
-       unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
+       unsigned int hash = hash_oid_string(gitmodules_oid, path);
        struct submodule_entry key;
        struct submodule key_config;
 
-       hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
+       oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
        key_config.path = path;
 
        hashmap_entry_init(&key, hash);
@@ -169,14 +171,14 @@ static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
 }
 
 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
-               const unsigned char *gitmodules_sha1, const char *name)
+               const struct object_id *gitmodules_oid, const char *name)
 {
        struct submodule_entry *entry;
-       unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
+       unsigned int hash = hash_oid_string(gitmodules_oid, name);
        struct submodule_entry key;
        struct submodule key_config;
 
-       hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
+       oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
        key_config.name = name;
 
        hashmap_entry_init(&key, hash);
@@ -188,6 +190,31 @@ static struct submodule *cache_lookup_name(struct submodule_cache *cache,
        return NULL;
 }
 
+int check_submodule_name(const char *name)
+{
+       /* Disallow empty names */
+       if (!*name)
+               return -1;
+
+       /*
+        * Look for '..' as a path component. Check both '/' and '\\' as
+        * separators rather than is_dir_sep(), because we want the name rules
+        * to be consistent across platforms.
+        */
+       goto in_component; /* always start inside component */
+       while (*name) {
+               char c = *name++;
+               if (c == '/' || c == '\\') {
+in_component:
+                       if (name[0] == '.' && name[1] == '.' &&
+                           (!name[2] || name[2] == '/' || name[2] == '\\'))
+                               return -1;
+               }
+       }
+
+       return 0;
+}
+
 static int name_and_item_from_var(const char *var, struct strbuf *name,
                                  struct strbuf *item)
 {
@@ -199,18 +226,24 @@ static int name_and_item_from_var(const char *var, struct strbuf *name,
                return 0;
 
        strbuf_add(name, subsection, subsection_len);
+       if (check_submodule_name(name->buf) < 0) {
+               warning(_("ignoring suspicious submodule name: %s"), name->buf);
+               strbuf_release(name);
+               return 0;
+       }
+
        strbuf_addstr(item, key);
 
        return 1;
 }
 
 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
-               const unsigned char *gitmodules_sha1, const char *name)
+               const struct object_id *gitmodules_oid, const char *name)
 {
        struct submodule *submodule;
        struct strbuf name_buf = STRBUF_INIT;
 
-       submodule = cache_lookup_name(cache, gitmodules_sha1, name);
+       submodule = cache_lookup_name(cache, gitmodules_oid, name);
        if (submodule)
                return submodule;
 
@@ -228,7 +261,7 @@ static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
        submodule->branch = NULL;
        submodule->recommend_shallow = -1;
 
-       hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);
+       oidcpy(&submodule->gitmodules_oid, gitmodules_oid);
 
        cache_add(cache, submodule);
 
@@ -238,7 +271,7 @@ static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
 static int parse_fetch_recurse(const char *opt, const char *arg,
                               int die_on_error)
 {
-       switch (git_config_maybe_bool(opt, arg)) {
+       switch (git_parse_maybe_bool(arg)) {
        case 1:
                return RECURSE_SUBMODULES_ON;
        case 0:
@@ -291,7 +324,7 @@ int option_fetch_parse_recurse_submodules(const struct option *opt,
 static int parse_update_recurse(const char *opt, const char *arg,
                                int die_on_error)
 {
-       switch (git_config_maybe_bool(opt, arg)) {
+       switch (git_parse_maybe_bool(arg)) {
        case 1:
                return RECURSE_SUBMODULES_ON;
        case 0:
@@ -311,7 +344,7 @@ int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
 static int parse_push_recurse(const char *opt, const char *arg,
                               int die_on_error)
 {
-       switch (git_config_maybe_bool(opt, arg)) {
+       switch (git_parse_maybe_bool(arg)) {
        case 1:
                /* There's no simple "on" value when pushing */
                if (die_on_error)
@@ -339,12 +372,12 @@ int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
        return parse_push_recurse(opt, arg, 1);
 }
 
-static void warn_multiple_config(const unsigned char *treeish_name,
+static void warn_multiple_config(const struct object_id *treeish_name,
                                 const char *name, const char *option)
 {
        const char *commit_string = "WORKTREE";
        if (treeish_name)
-               commit_string = sha1_to_hex(treeish_name);
+               commit_string = oid_to_hex(treeish_name);
        warning("%s:.gitmodules, multiple configurations found for "
                        "'submodule.%s.%s'. Skipping second one!",
                        commit_string, name, option);
@@ -352,8 +385,8 @@ static void warn_multiple_config(const unsigned char *treeish_name,
 
 struct parse_config_parameter {
        struct submodule_cache *cache;
-       const unsigned char *treeish_name;
-       const unsigned char *gitmodules_sha1;
+       const struct object_id *treeish_name;
+       const struct object_id *gitmodules_oid;
        int overwrite;
 };
 
@@ -369,7 +402,7 @@ static int parse_config(const char *var, const char *value, void *data)
                return 0;
 
        submodule = lookup_or_create_by_name(me->cache,
-                                            me->gitmodules_sha1,
+                                            me->gitmodules_oid,
                                             name.buf);
 
        if (!strcmp(item.buf, "path")) {
@@ -387,7 +420,7 @@ static int parse_config(const char *var, const char *value, void *data)
                }
        } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
                /* when parsing worktree configurations we can die early */
-               int die_on_error = is_null_sha1(me->gitmodules_sha1);
+               int die_on_error = is_null_oid(me->gitmodules_oid);
                if (!me->overwrite &&
                    submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
                        warn_multiple_config(me->treeish_name, submodule->name,
@@ -455,9 +488,9 @@ static int parse_config(const char *var, const char *value, void *data)
        return ret;
 }
 
-int gitmodule_oid_from_commit(const struct object_id *treeish_name,
-                                     struct object_id *gitmodules_oid,
-                                     struct strbuf *rev)
+static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
+                                    struct object_id *gitmodules_oid,
+                                    struct strbuf *rev)
 {
        int ret = 0;
 
@@ -509,23 +542,23 @@ static const struct submodule *config_from(struct submodule_cache *cache,
 
        switch (lookup_type) {
        case lookup_name:
-               submodule = cache_lookup_name(cache, oid.hash, key);
+               submodule = cache_lookup_name(cache, &oid, key);
                break;
        case lookup_path:
-               submodule = cache_lookup_path(cache, oid.hash, key);
+               submodule = cache_lookup_path(cache, &oid, key);
                break;
        }
        if (submodule)
                goto out;
 
-       config = read_sha1_file(oid.hash, &type, &config_size);
+       config = read_object_file(&oid, &type, &config_size);
        if (!config || type != OBJ_BLOB)
                goto out;
 
        /* fill the submodule config into the cache */
        parameter.cache = cache;
-       parameter.treeish_name = treeish_name->hash;
-       parameter.gitmodules_sha1 = oid.hash;
+       parameter.treeish_name = treeish_name;
+       parameter.gitmodules_oid = &oid;
        parameter.overwrite = 0;
        git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
                        config, config_size, &parameter);
@@ -534,9 +567,9 @@ static const struct submodule *config_from(struct submodule_cache *cache,
 
        switch (lookup_type) {
        case lookup_name:
-               return cache_lookup_name(cache, oid.hash, key);
+               return cache_lookup_name(cache, &oid, key);
        case lookup_path:
-               return cache_lookup_path(cache, oid.hash, key);
+               return cache_lookup_path(cache, &oid, key);
        default:
                return NULL;
        }
@@ -558,51 +591,83 @@ static void submodule_cache_check_init(struct repository *repo)
        submodule_cache_init(repo->submodule_cache);
 }
 
-int submodule_config_option(struct repository *repo,
-                           const char *var, const char *value)
+static int gitmodules_cb(const char *var, const char *value, void *data)
 {
+       struct repository *repo = data;
        struct parse_config_parameter parameter;
 
-       submodule_cache_check_init(repo);
-
        parameter.cache = repo->submodule_cache;
        parameter.treeish_name = NULL;
-       parameter.gitmodules_sha1 = null_sha1;
+       parameter.gitmodules_oid = &null_oid;
        parameter.overwrite = 1;
 
        return parse_config(var, value, &parameter);
 }
 
-int parse_submodule_config_option(const char *var, const char *value)
+void repo_read_gitmodules(struct repository *repo)
 {
-       return submodule_config_option(the_repository, var, value);
+       submodule_cache_check_init(repo);
+
+       if (repo->worktree) {
+               char *gitmodules;
+
+               if (repo_read_index(repo) < 0)
+                       return;
+
+               gitmodules = repo_worktree_path(repo, GITMODULES_FILE);
+
+               if (!is_gitmodules_unmerged(repo->index))
+                       git_config_from_file(gitmodules_cb, gitmodules, repo);
+
+               free(gitmodules);
+       }
+
+       repo->submodule_cache->gitmodules_read = 1;
 }
 
-const struct submodule *submodule_from_name(const struct object_id *treeish_name,
-               const char *name)
+void gitmodules_config_oid(const struct object_id *commit_oid)
 {
+       struct strbuf rev = STRBUF_INIT;
+       struct object_id oid;
+
        submodule_cache_check_init(the_repository);
-       return config_from(the_repository->submodule_cache, treeish_name, name, lookup_name);
+
+       if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
+               git_config_from_blob_oid(gitmodules_cb, rev.buf,
+                                        &oid, the_repository);
+       }
+       strbuf_release(&rev);
+
+       the_repository->submodule_cache->gitmodules_read = 1;
 }
 
-const struct submodule *submodule_from_path(const struct object_id *treeish_name,
-               const char *path)
+static void gitmodules_read_check(struct repository *repo)
 {
-       submodule_cache_check_init(the_repository);
-       return config_from(the_repository->submodule_cache, treeish_name, path, lookup_path);
+       submodule_cache_check_init(repo);
+
+       /* read the repo's .gitmodules file if it hasn't been already */
+       if (!repo->submodule_cache->gitmodules_read)
+               repo_read_gitmodules(repo);
+}
+
+const struct submodule *submodule_from_name(struct repository *r,
+                                           const struct object_id *treeish_name,
+               const char *name)
+{
+       gitmodules_read_check(r);
+       return config_from(r->submodule_cache, treeish_name, name, lookup_name);
 }
 
-const struct submodule *submodule_from_cache(struct repository *repo,
-                                            const struct object_id *treeish_name,
-                                            const char *key)
+const struct submodule *submodule_from_path(struct repository *r,
+                                           const struct object_id *treeish_name,
+               const char *path)
 {
-       submodule_cache_check_init(repo);
-       return config_from(repo->submodule_cache, treeish_name,
-                          key, lookup_path);
+       gitmodules_read_check(r);
+       return config_from(r->submodule_cache, treeish_name, path, lookup_path);
 }
 
-void submodule_free(void)
+void submodule_free(struct repository *r)
 {
-       if (the_repository->submodule_cache)
-               submodule_cache_clear(the_repository->submodule_cache);
+       if (r->submodule_cache)
+               submodule_cache_clear(r->submodule_cache);
 }