On 06/07/2011 12:37 AM, [email protected] wrote: > From: Lars Hjemli <[email protected]> > > 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 '[email protected]: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,
I think this is a good idea > or to store the original $CGIT_REPO_URL in e.g. $CGIT_REPO_REAL_URL before > suffix removal. I prefer this less > > While at it, cgitrc.5 is expanded with a section describing the (previously > undocumented) macro expansion feature. > > Signed-off-by: Lars Hjemli <[email protected]> > --- > cgit.c | 2 ++ > cgit.h | 1 + > cgitrc.5.txt | 32 ++++++++++++++++++++++++++++++-- > shared.c | 1 + > tests/setup.sh | 1 + > tests/t0102-summary.sh | 6 ++++++ > ui-summary.c | 2 +- > 7 files changed, 42 insertions(+), 3 deletions(-) > > diff --git a/cgit.c b/cgit.c > index dd40893..51ca78a 100644 > --- a/cgit.c > +++ b/cgit.c > @@ -244,6 +244,8 @@ void config_cb(const char *name, const char *value) > 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 df7ee5d..bad66f0 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 5903a93..c2d2fad 100644 > --- a/cgitrc.5.txt > +++ b/cgitrc.5.txt > @@ -76,6 +76,11 @@ clone-prefix:: > 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 > @@ -492,6 +497,29 @@ allocated buffer within cgit then only the environment > variables that fit > in the allocated buffer are handed to the filter. > > > +MACRO EXPANSION > +--------------- > +Certain cgitrc settings supports a simple macro expansion feature, where > +tokens prefixed with '$' are replaced with the value of the environment > +variable named by the token[*]. The settings which supports this feature are > +divided in two groups: > + > +* Settings expanded prior to request processing. These settings are typically better use a '-' here, a '*' could be confusing with the [*] above > +used to implement virtual hosting based on environment variables set by the > +web-server (e.g. HTTP_HOST): so using $HTTP_HOST will be expanded? that would be awesome! > + - CGIT_CONFIG (not really a cgitrc setting...) > + - cache-root > + - project-list > + - scan-path > + - include > +* Settings expanded during request processing. These settings will typically ditto > +also support the environment variables defined in "FILTER API": > + - clone-url > + - repo.clone-url > + > +[*] A token is a sequence of alphanumeric characters and underscores. > + > + > EXAMPLE CGITRC FILE > ------------------- > > @@ -500,8 +528,8 @@ EXAMPLE CGITRC FILE > 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://example.com/$CGIT_REPO_URL.git > ssh://example.com/pub/git/$CGIT_REPO_URL.git > > # Specify the css url > css=/css/cgit.css > diff --git a/shared.c b/shared.c > index 4adeaa8..699c362 100644 > --- a/shared.c > +++ b/shared.c > @@ -70,6 +70,7 @@ struct cgit_repo *cgit_add_repo(const char *url) > 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 b2f1169..1e06107 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 f0b0d9a..f299c5a 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 5be2545..227ed27 100644 > --- a/ui-summary.c > +++ b/ui-summary.c > @@ -62,7 +62,7 @@ void cgit_print_summary() > 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>"); Reviewed-by: Ferry Huberts <[email protected]> Awesome work Lars! Thanks! -- Ferry Huberts _______________________________________________ cgit mailing list [email protected] http://hjemli.net/mailman/listinfo/cgit
