Author: Lars Hjemli <hjemli@gmail.com>
cgit.c: add 'clone-url' setting with support for macro expansion The current 'clone-prefix' setting has some known issues: * All repos get the same 'clone-prefix' value since the setting is not adopted during repo registration (in cgitrc, or during scan-path traversal), but only when the setting is used. * The generated clone-urls for a repo is a combination of 'clone-prefix', a slash and the repo url. This doesn't work well with e.g. ssh-style urls like 'git@example.org:repo.git', since the inserted slash will make the repo relative to the filesystem root. * If 'remove-suffix' is enabled, the generated clone-urls will not work for cloning (except for http-urls to cgit itself) since they miss the '.git' suffix. The new 'clone-url' setting is designed to avoid the mentioned issues: * Each repo adopts the default 'clone-url' when the repo is defined. This allows different groups of repos to adopt different values. * The clone-urls for a repo is generated by expanding environment variables in a string template without inserting arbitrary characters, hence any kind of clone-url can be generated. * Macro expansion also eases the 'remove-suffix' pain since it's now possible to define e.g. 'clone-url=git://foo.org/$CGIT_REPO_URL.git' for a set of repos. A furter improvement would be to define e.g. $CGIT_REPO_SUFFIX to '.git' for all repos which had their url prettified, or to store the original $CGIT_REPO_URL in e.g. $CGIT_REPO_REAL_URL before suffix removal. Reviewed-by: Ferry Huberts <mailings@hupie.com> Signed-off-by: Lars Hjemli <hjemli@gmail.com>
cgit.c | 2 ++ cgit.h | 1 + cgitrc.5.txt | 17 ++++++++++++++--- shared.c | 1 + tests/setup.sh | 1 + tests/t0102-summary.sh | 6 ++++++ ui-summary.c | 2 +-
diff --git a/cgit.c b/cgit.c index dd40893de6f582f422abd301f20a91e9c67237c6..51ca78a6cd56cc1f9c338636c70dcb139f8cf47f 100644 --- a/cgit.c +++ b/cgit.c @@ -244,6 +244,8 @@ else if (!strcmp(name, "robots")) ctx.cfg.robots = xstrdup(value); else if (!strcmp(name, "clone-prefix")) ctx.cfg.clone_prefix = xstrdup(value); + else if (!strcmp(name, "clone-url")) + ctx.cfg.clone_url = xstrdup(value); else if (!strcmp(name, "local-time")) ctx.cfg.local_time = atoi(value); else if (!prefixcmp(name, "mimetype.")) diff --git a/cgit.h b/cgit.h index df7ee5dbf6f036cec41ba7081095b5907e1961ef..bad66f0e24849d97d2630ac779792b1388c20494 100644 --- a/cgit.h +++ b/cgit.h @@ -165,6 +165,7 @@ struct cgit_config { char *agefile; char *cache_root; char *clone_prefix; + char *clone_url; char *css; char *favicon; char *footer; diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 9a9965b479f38fa7b2947a7ee90087304781daae..5ba81345dda303e9c1147810befee86273e2e4ff 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -76,6 +76,11 @@ repository url, generates valid clone urls for the repository. This setting is only used if `repo.clone-url` is unspecified. Default value: none. +clone-url:: + Space-separated list of clone-url templates. This setting is only + used if `repo.clone-url` is unspecified. Default value: none. See + also: "MACRO EXPANSION", "FILTER API". + commit-filter:: Specifies a command which will be invoked to format commit messages. The command will get the message on its STDIN, and the STDOUT from the @@ -363,7 +368,7 @@ "enable-filter-overrides". See also: "FILTER API". repo.clone-url:: A list of space-separated urls which can be used to clone this repo. - Default value: none. + Default value: none. See also: "MACRO EXPANSION". repo.commit-filter:: Override the default commit-filter. Default value: none. See also: @@ -511,6 +516,12 @@ can be accomplished by adding the following line to /etc/cgitrc: include=/etc/cgitrc.d/$HTTP_HOST +The following options are expanded during request processing, and support +the environment variables defined in "FILTER API": + +- clone-url +- repo.clone-url + EXAMPLE CGITRC FILE ------------------- @@ -520,8 +531,8 @@ # Enable caching of up to 1000 output entriess cache-size=1000 -# Specify some default clone prefixes -clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git +# Specify some default clone urls using macro expansion +clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL # Specify the css url css=/css/cgit.css diff --git a/shared.c b/shared.c index 4adeaa83a968bc87db1ccc25c71f29582a2629be..699c3624b1d67b28b8c111b6479df4c9bad43477 100644 --- a/shared.c +++ b/shared.c @@ -70,6 +70,7 @@ ret->mtime = -1; ret->about_filter = ctx.cfg.about_filter; ret->commit_filter = ctx.cfg.commit_filter; ret->source_filter = ctx.cfg.source_filter; + ret->clone_url = ctx.cfg.clone_url; return ret; } diff --git a/tests/setup.sh b/tests/setup.sh index b2f1169c789846abc912c7429dee19dfb3c1487c..1e061078a2584b0b74eaa6976cf126896851a231 100755 --- a/tests/setup.sh +++ b/tests/setup.sh @@ -62,6 +62,7 @@ enable-log-linecount=1 summary-log=5 summary-branches=5 summary-tags=5 +clone-url=git://example.org/\$CGIT_REPO_URL.git repo.url=foo repo.path=$PWD/trash/repos/foo/.git diff --git a/tests/t0102-summary.sh b/tests/t0102-summary.sh index f0b0d9a700beea9d0754febbe79c17b1c324501d..f299c5a4d4440b1b1d66519f16828c8754505f1c 100755 --- a/tests/t0102-summary.sh +++ b/tests/t0102-summary.sh @@ -9,6 +9,9 @@ run_test 'find commit 1' 'grep -e "commit 1" trash/tmp' run_test 'find commit 5' 'grep -e "commit 5" trash/tmp' run_test 'find branch master' 'grep -e "master" trash/tmp' run_test 'no tags' '! grep -e "tags" trash/tmp' +run_test 'clone-url expanded correctly' ' + grep -e "git://example.org/foo.git" trash/tmp +' run_test 'generate bar summary' 'cgit_url "bar" >trash/tmp' run_test 'no commit 45' '! grep -e "commit 45" trash/tmp' @@ -16,5 +19,8 @@ run_test 'find commit 46' 'grep -e "commit 46" trash/tmp' run_test 'find commit 50' 'grep -e "commit 50" trash/tmp' run_test 'find branch master' 'grep -e "master" trash/tmp' run_test 'no tags' '! grep -e "tags" trash/tmp' +run_test 'clone-url expanded correctly' ' + grep -e "git://example.org/bar.git" trash/tmp +' tests_done diff --git a/ui-summary.c b/ui-summary.c index 5be2545c398ca7f7ac715991e58b90b52f32e636..227ed276d453c951174a815747674f8993f6a337 100644 --- a/ui-summary.c +++ b/ui-summary.c @@ -62,7 +62,7 @@ cgit_print_log(ctx.qry.head, 0, ctx.cfg.summary_log, NULL, NULL, NULL, 0, 0); } if (ctx.repo->clone_url) - print_urls(ctx.repo->clone_url, NULL); + print_urls(expand_macros(ctx.repo->clone_url), NULL); else if (ctx.cfg.clone_prefix) print_urls(ctx.cfg.clone_prefix, ctx.repo->url); html("</table>");