From 3ec6b309505dc5f7ba14abe8861b02da34a9df0b Mon Sep 17 00:00:00 2001
From: Lars Hjemli
Date: Mon, 6 Jun 2011 19:29:58 +0000
Subject: cgit.c: always setup cgit repo environment variables
When cgit learned to setup environment variables for certain repo
settings before invoking a filter process, the setup occurred inside
cgit_open_filter().
This patch moves the setup out of cgit_open_filter() and into
prepare_repo_cmd() to prepare for additional uses of these variables.
Reviewed-by: Ferry Huberts <mailings@hupie.com>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
---
cgit.c | 1 +
cgit.h | 4 +++-
shared.c | 7 +++----
ui-commit.c | 6 +++---
ui-repolist.c | 2 +-
ui-snapshot.c | 2 +-
ui-summary.c | 2 +-
ui-tree.c | 2 +-
8 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/cgit.c b/cgit.c
index 6be3754..dd40893 100644
--- a/cgit.c
+++ b/cgit.c
@@ -463,6 +463,7 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
cgit_print_docend();
return 1;
}
+ cgit_prepare_repo_env(ctx->repo);
return 0;
}
diff --git a/cgit.h b/cgit.h
index caa9d8e..df7ee5d 100644
--- a/cgit.h
+++ b/cgit.h
@@ -319,9 +319,11 @@ extern const char *cgit_repobasename(const char *reponame);
extern int cgit_parse_snapshots_mask(const char *str);
-extern int cgit_open_filter(struct cgit_filter *filter, struct cgit_repo * repo);
+extern int cgit_open_filter(struct cgit_filter *filter);
extern int cgit_close_filter(struct cgit_filter *filter);
+extern void cgit_prepare_repo_env(struct cgit_repo * repo);
+
extern int readfile(const char *path, char **buf, size_t *size);
extern char *expand_macros(const char *txt);
diff --git a/shared.c b/shared.c
index be2ae59..4adeaa8 100644
--- a/shared.c
+++ b/shared.c
@@ -374,7 +374,8 @@ typedef struct {
char * value;
} cgit_env_var;
-static void prepare_env(struct cgit_repo * repo) {
+void cgit_prepare_repo_env(struct cgit_repo * repo)
+{
cgit_env_var env_vars[] = {
{ .name = "CGIT_REPO_URL", .value = repo->url },
{ .name = "CGIT_REPO_NAME", .value = repo->name },
@@ -395,7 +396,7 @@ static void prepare_env(struct cgit_repo * repo) {
fprintf(stderr, warn, p->name, p->value);
}
-int cgit_open_filter(struct cgit_filter *filter, struct cgit_repo * repo)
+int cgit_open_filter(struct cgit_filter *filter)
{
filter->old_stdout = chk_positive(dup(STDOUT_FILENO),
@@ -406,8 +407,6 @@ int cgit_open_filter(struct cgit_filter *filter, struct cgit_repo * repo)
close(filter->pipe_fh[1]);
chk_non_negative(dup2(filter->pipe_fh[0], STDIN_FILENO),
"Unable to use pipe as STDIN");
- if (repo)
- prepare_env(repo);
execvp(filter->cmd, filter->argv);
die("Unable to exec subprocess %s: %s (%d)", filter->cmd,
strerror(errno), errno);
diff --git a/ui-commit.c b/ui-commit.c
index a69dec6..536a8e8 100644
--- a/ui-commit.c
+++ b/ui-commit.c
@@ -106,7 +106,7 @@ void cgit_print_commit(char *hex, const char *prefix)
html("</table>\n");
html("<div class='commit-subject'>");
if (ctx.repo->commit_filter)
- cgit_open_filter(ctx.repo->commit_filter, ctx.repo);
+ cgit_open_filter(ctx.repo->commit_filter);
html_txt(info->subject);
if (ctx.repo->commit_filter)
cgit_close_filter(ctx.repo->commit_filter);
@@ -114,7 +114,7 @@ void cgit_print_commit(char *hex, const char *prefix)
html("</div>");
html("<div class='commit-msg'>");
if (ctx.repo->commit_filter)
- cgit_open_filter(ctx.repo->commit_filter, ctx.repo);
+ cgit_open_filter(ctx.repo->commit_filter);
html_txt(info->msg);
if (ctx.repo->commit_filter)
cgit_close_filter(ctx.repo->commit_filter);
@@ -123,7 +123,7 @@ void cgit_print_commit(char *hex, const char *prefix)
html("<div class='notes-header'>Notes</div>");
html("<div class='notes'>");
if (ctx.repo->commit_filter)
- cgit_open_filter(ctx.repo->commit_filter, ctx.repo);
+ cgit_open_filter(ctx.repo->commit_filter);
html_txt(notes.buf);
if (ctx.repo->commit_filter)
cgit_close_filter(ctx.repo->commit_filter);
diff --git a/ui-repolist.c b/ui-repolist.c
index dce2eac..25c36ce 100644
--- a/ui-repolist.c
+++ b/ui-repolist.c
@@ -300,7 +300,7 @@ void cgit_print_site_readme()
if (!ctx.cfg.root_readme)
return;
if (ctx.cfg.about_filter)
- cgit_open_filter(ctx.cfg.about_filter, NULL);
+ cgit_open_filter(ctx.cfg.about_filter);
html_include(ctx.cfg.root_readme);
if (ctx.cfg.about_filter)
cgit_close_filter(ctx.cfg.about_filter);
diff --git a/ui-snapshot.c b/ui-snapshot.c
index 126779d..07cc944 100644
--- a/ui-snapshot.c
+++ b/ui-snapshot.c
@@ -19,7 +19,7 @@ static int write_compressed_tar_archive(struct archiver_args *args,const char *f
f.argv = malloc(2 * sizeof(char *));
f.argv[0] = f.cmd;
f.argv[1] = NULL;
- cgit_open_filter(&f, NULL);
+ cgit_open_filter(&f);
rv = write_tar_archive(args);
cgit_close_filter(&f);
return rv;
diff --git a/ui-summary.c b/ui-summary.c
index 1e9a1b6..5be2545 100644
--- a/ui-summary.c
+++ b/ui-summary.c
@@ -113,7 +113,7 @@ void cgit_print_repo_readme(char *path)
*/
html("<div id='summary'>");
if (ctx.repo->about_filter)
- cgit_open_filter(ctx.repo->about_filter, ctx.repo);
+ cgit_open_filter(ctx.repo->about_filter);
if (ref)
cgit_print_file(tmp, ref);
else
diff --git a/ui-tree.c b/ui-tree.c
index 2d8d2f3..442b6be 100644
--- a/ui-tree.c
+++ b/ui-tree.c
@@ -45,7 +45,7 @@ static void print_text_buffer(const char *name, char *buf, unsigned long size)
if (ctx.repo->source_filter) {
html("<td class='lines'><pre><code>");
ctx.repo->source_filter->argv[1] = xstrdup(name);
- cgit_open_filter(ctx.repo->source_filter, ctx.repo);
+ cgit_open_filter(ctx.repo->source_filter);
html_raw(buf, size);
cgit_close_filter(ctx.repo->source_filter);
free(ctx.repo->source_filter->argv[1]);
--
cgit 1.4.1-21-gabe81
From a1429dbc89f9c0945e32cea9fd3424d2fe56aeab Mon Sep 17 00:00:00 2001
From: Lars Hjemli
Date: Mon, 6 Jun 2011 20:49:13 +0000
Subject: 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 +-
7 files changed, 26 insertions(+), 4 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 9a9965b..5ba8134 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
@@ -363,7 +368,7 @@ repo.about-filter::
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 @@ 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://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 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>");
--
cgit 1.4.1-21-gabe81