summaryrefslogtreecommitdiffabout
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--.gitignore5
-rw-r--r--Makefile21
-rw-r--r--cgit-doc.css3
-rw-r--r--cgit.c2
-rw-r--r--cgit.h2
-rw-r--r--cgitrc.5.txt114
-rw-r--r--ui-atom.c6
-rw-r--r--ui-blob.c8
-rw-r--r--ui-plain.c5
-rw-r--r--ui-shared.c16
-rw-r--r--ui-shared.h1
-rw-r--r--ui-snapshot.c23
-rw-r--r--ui-tree.c13
13 files changed, 144 insertions, 75 deletions
diff --git a/.gitignore b/.gitignore
index 1e016e5..487728b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,11 @@
# Files I don't care to see in git-status/commit
cgit
cgit.conf
VERSION
+cgitrc.5
+cgitrc.5.fo
+cgitrc.5.html
+cgitrc.5.pdf
+cgitrc.5.xml
*.o
*.d
diff --git a/Makefile b/Makefile
index 0f0089a..707d446 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
-CGIT_VERSION = v0.8.2
+CGIT_VERSION = v0.8.2.1
CGIT_SCRIPT_NAME = cgit.cgi
CGIT_SCRIPT_PATH = /var/www/htdocs/cgit
CGIT_DATA_PATH = $(CGIT_SCRIPT_PATH)
CGIT_CONFIG = /etc/cgitrc
CACHE_ROOT = /var/cache/cgit
SHA1_HEADER = <openssl/sha.h>
@@ -97,13 +97,14 @@ OBJECTS += ui-tree.o
ifdef NEEDS_LIBICONV
EXTLIBS += -liconv
endif
-.PHONY: all libgit test install uninstall clean force-version get-git
+.PHONY: all libgit test install uninstall clean force-version get-git \
+ doc man-doc html-doc clean-doc
all: cgit
VERSION: force-version
@./gen-version.sh "$(CGIT_VERSION)"
-include VERSION
@@ -146,11 +147,25 @@ install: all
uninstall:
rm -f $(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME)
rm -f $(CGIT_DATA_PATH)/cgit.css
rm -f $(CGIT_DATA_PATH)/cgit.png
-clean:
+doc: man-doc html-doc pdf-doc
+
+man-doc: cgitrc.5.txt
+ a2x -f manpage cgitrc.5.txt
+
+html-doc: cgitrc.5.txt
+ a2x -f xhtml --stylesheet=cgit-doc.css cgitrc.5.txt
+
+pdf-doc: cgitrc.5.txt
+ a2x -f pdf cgitrc.5.txt
+
+clean: clean-doc
rm -f cgit VERSION *.o *.d
+clean-doc:
+ rm -f cgitrc.5 cgitrc.5.html cgitrc.5.pdf cgitrc.5.xml cgitrc.5.fo
+
get-git:
curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git
diff --git a/cgit-doc.css b/cgit-doc.css
new file mode 100644
index 0000000..5a399b6
--- a/dev/null
+++ b/cgit-doc.css
@@ -0,0 +1,3 @@
+div.variablelist dt {
+ margin-top: 1em;
+}
diff --git a/cgit.c b/cgit.c
index dc1c2e4..ae20257 100644
--- a/cgit.c
+++ b/cgit.c
@@ -283,12 +283,14 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
return 1;
}
if (get_sha1(ctx->qry.head, sha1)) {
tmp = xstrdup(ctx->qry.head);
ctx->qry.head = ctx->repo->defbranch;
+ ctx->page.status = 404;
+ ctx->page.statusmsg = "not found";
cgit_print_http_headers(ctx);
cgit_print_docstart(ctx);
cgit_print_pageheader(ctx);
cgit_print_error(fmt("Invalid branch: %s", tmp));
cgit_print_docend();
return 1;
diff --git a/cgit.h b/cgit.h
index 2bfbe7b..07a277a 100644
--- a/cgit.h
+++ b/cgit.h
@@ -179,12 +179,14 @@ struct cgit_page {
size_t size;
char *mimetype;
char *charset;
char *filename;
char *etag;
char *title;
+ int status;
+ char *statusmsg;
};
struct cgit_context {
struct cgit_query qry;
struct cgit_config cfg;
struct cgit_repo *repo;
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fd299ae..7879f75 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,267 +1,268 @@
-CGITRC
-======
+CGITRC(5)
+========
NAME
----
- cgitrc - runtime configuration for cgit
+cgitrc - runtime configuration for cgit
-DESCRIPTION
------------
+SYNOPSIS
+--------
Cgitrc contains all runtime settings for cgit, including the list of git
repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
lines, and lines starting with '#', are ignored.
GLOBAL SETTINGS
---------------
-agefile
+agefile::
Specifies a path, relative to each repository path, which can be used
to specify the date and time of the youngest commit in the repository.
The first line in the file is used as input to the "parse_date"
function in libgit. Recommended timestamp-format is "yyyy-mm-dd
hh:mm:ss". Default value: "info/web/last-modified".
-cache-root
+cache-root::
Path used to store the cgit cache entries. Default value:
"/var/cache/cgit".
-cache-dynamic-ttl
+cache-dynamic-ttl::
Number which specifies the time-to-live, in minutes, for the cached
version of repository pages accessed without a fixed SHA1. Default
value: "5".
-cache-repo-ttl
+cache-repo-ttl::
Number which specifies the time-to-live, in minutes, for the cached
version of the repository summary page. Default value: "5".
-cache-root-ttl
+cache-root-ttl::
Number which specifies the time-to-live, in minutes, for the cached
version of the repository index page. Default value: "5".
-cache-size
+cache-size::
The maximum number of entries in the cgit cache. Default value: "0"
(i.e. caching is disabled).
-cache-static-ttl
+cache-static-ttl::
Number which specifies the time-to-live, in minutes, for the cached
version of repository pages accessed with a fixed SHA1. Default value:
"5".
-clone-prefix
+clone-prefix::
Space-separated list of common prefixes which, when combined with a
repository url, generates valid clone urls for the repository. This
setting is only used if `repo.clone-url` is unspecified. Default value:
none.
-css
+css::
Url which specifies the css document to include in all cgit pages.
Default value: "/cgit.css".
-enable-index-links
+enable-index-links::
Flag which, when set to "1", will make cgit generate extra links for
each repo in the repository index (specifically, to the "summary",
"commit" and "tree" pages). Default value: "0".
-enable-log-filecount
+enable-log-filecount::
Flag which, when set to "1", will make cgit print the number of
modified files for each commit on the repository log page. Default
value: "0".
-enable-log-linecount
+enable-log-linecount::
Flag which, when set to "1", will make cgit print the number of added
and removed lines for each commit on the repository log page. Default
value: "0".
-favicon
+favicon::
Url used as link to a shortcut icon for cgit. If specified, it is
suggested to use the value "/favicon.ico" since certain browsers will
ignore other values. Default value: none.
-footer
+footer::
The content of the file specified with this option will be included
verbatim at the bottom of all pages (i.e. it replaces the standard
"generated by..." message. Default value: none.
-header
+header::
The content of the file specified with this option will be included
verbatim at the top of all pages. Default value: none.
-include
+include::
Name of a configfile to include before the rest of the current config-
file is parsed. Default value: none.
-index-header
+index-header::
The content of the file specified with this option will be included
verbatim above the repository index. This setting is deprecated, and
will not be supported by cgit-1.0 (use root-readme instead). Default
value: none.
-index-info
+index-info::
The content of the file specified with this option will be included
verbatim below the heading on the repository index page. This setting
is deprecated, and will not be supported by cgit-1.0 (use root-desc
instead). Default value: none.
-local-time
+local-time::
Flag which, if set to "1", makes cgit print commit and tag times in the
servers timezone. Default value: "0".
-logo
+logo::
Url which specifies the source of an image which will be used as a logo
on all cgit pages.
-logo-link
+logo-link::
Url loaded when clicking on the cgit logo image. If unspecified the
calculated url of the repository index page will be used. Default
value: none.
-max-commit-count
+max-commit-count::
Specifies the number of entries to list per page in "log" view. Default
value: "50".
-max-message-length
+max-message-length::
Specifies the maximum number of commit message characters to display in
"log" view. Default value: "80".
-max-repo-count
+max-repo-count::
Specifies the number of entries to list per page on the repository
index page. Default value: "50".
-max-repodesc-length
+max-repodesc-length::
Specifies the maximum number of repo description characters to display
on the repository index page. Default value: "80".
-max-stats
+max-stats::
Set the default maximum statistics period. Valid values are "week",
"month", "quarter" and "year". If unspecified, statistics are
disabled. Default value: none. See also: "repo.max-stats".
-module-link
+module-link::
Text which will be used as the formatstring for a hyperlink when a
submodule is printed in a directory listing. The arguments for the
formatstring are the path and SHA1 of the submodule commit. Default
value: "./?repo=%s&page=commit&id=%s"
-nocache
+nocache::
If set to the value "1" caching will be disabled. This settings is
deprecated, and will not be honored starting with cgit-1.0. Default
value: "0".
-renamelimit
+renamelimit::
Maximum number of files to consider when detecting renames. The value
"-1" uses the compiletime value in git (for further info, look at
`man git-diff`). Default value: "-1".
-repo.group
+repo.group::
A value for the current repository group, which all repositories
specified after this setting will inherit. Default value: none.
-robots
+robots::
Text used as content for the "robots" meta-tag. Default value:
"index, nofollow".
-root-desc
+root-desc::
Text printed below the heading on the repository index page. Default
value: "a fast webinterface for the git dscm".
-root-readme:
+root-readme::
The content of the file specified with this option will be included
verbatim below the "about" link on the repository index page. Default
value: none.
-root-title
+root-title::
Text printed as heading on the repository index page. Default value:
"Git Repository Browser".
-snapshots
+snapshots::
Text which specifies the default (and allowed) set of snapshot formats
supported by cgit. The value is a space-separated list of zero or more
of the following values:
"tar" uncompressed tar-file
"tar.gz" gzip-compressed tar-file
"tar.bz2" bzip-compressed tar-file
"zip" zip-file
Default value: none.
-summary-branches
+summary-branches::
Specifies the number of branches to display in the repository "summary"
view. Default value: "10".
-summary-log
+summary-log::
Specifies the number of log entries to display in the repository
"summary" view. Default value: "10".
-summary-tags
+summary-tags::
Specifies the number of tags to display in the repository "summary"
view. Default value: "10".
-virtual-root
+virtual-root::
Url which, if specified, will be used as root for all cgit links. It
will also cause cgit to generate 'virtual urls', i.e. urls like
'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
value: none.
NOTE: cgit has recently learned how to use PATH_INFO to achieve the
same kind of virtual urls, so this option will probably be deprecated.
REPOSITORY SETTINGS
-------------------
-repo.clone-url
+repo.clone-url::
A list of space-separated urls which can be used to clone this repo.
Default value: none.
-repo.defbranch
+repo.defbranch::
The name of the default branch for this repository. If no such branch
exists in the repository, the first branch name (when sorted) is used
as default instead. Default value: "master".
-repo.desc
+repo.desc::
The value to show as repository description. Default value: none.
-repo.enable-log-filecount
+repo.enable-log-filecount::
A flag which can be used to disable the global setting
`enable-log-filecount'. Default value: none.
-repo.enable-log-linecount
+repo.enable-log-linecount::
A flag which can be used to disable the global setting
`enable-log-linecount'. Default value: none.
-repo.max-stats
+repo.max-stats::
Override the default maximum statistics period. Valid values are equal
to the values specified for the global "max-stats" setting. Default
value: none.
-repo.name
+repo.name::
The value to show as repository name. Default value: <repo.url>.
-repo.owner
+repo.owner::
A value used to identify the owner of the repository. Default value:
none.
-repo.path
+repo.path::
An absolute path to the repository directory. For non-bare repositories
this is the .git-directory. Default value: none.
-repo.readme
+repo.readme::
A path (relative to <repo.path>) which specifies a file to include
verbatim as the "About" page for this repo. Default value: none.
-repo.snapshots
+repo.snapshots::
A mask of allowed snapshot-formats for this repo, restricted by the
"snapshots" global setting. Default value: <snapshots>.
-repo.url
+repo.url::
The relative url used to access the repository. This must be the first
setting specified for each repo. Default value: none.
EXAMPLE CGITRC FILE
-------------------
+....
# Enable caching of up to 1000 output entriess
cache-size=1000
# Specify some default clone prefixes
clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
@@ -365,12 +366,13 @@ repo.snapshots=0
# Disable line-counts for this repo
repo.enable-log-linecount=0
# Restrict the max statistics period for this repo
repo.max-stats=month
+....
BUGS
----
Comments currently cannot appear on the same line as a setting; the comment
will be included as part of the value. E.g. this line:
diff --git a/ui-atom.c b/ui-atom.c
index a6ea3ee..e5c31d9 100644
--- a/ui-atom.c
+++ b/ui-atom.c
@@ -49,13 +49,14 @@ void add_entry(struct commit *commit, char *host)
}
html("</author>\n");
html("<published>");
cgit_print_date(info->author_date, FMT_ATOMDATE, ctx.cfg.local_time);
html("</published>\n");
if (host) {
- html("<link rel='alternate' type='text/html' href='http://");
+ html("<link rel='alternate' type='text/html' href='");
+ html(cgit_httpscheme());
html_attr(host);
html_attr(cgit_pageurl(ctx.repo->url, "commit", NULL));
if (ctx.cfg.virtual_root)
delim = '?';
htmlf("%cid=%s", delim, hex);
html("'/>\n");
@@ -110,13 +111,14 @@ void cgit_print_atom(char *tip, char *path, int max_count)
html_txt(ctx.repo->name);
html("</title>\n");
html("<subtitle>");
html_txt(ctx.repo->desc);
html("</subtitle>\n");
if (host) {
- html("<link rel='alternate' type='text/html' href='http://");
+ html("<link rel='alternate' type='text/html' href='");
+ html(cgit_httpscheme());
html_attr(host);
html_attr(cgit_repourl(ctx.repo->url));
html("'/>\n");
}
while ((commit = get_revision(&rev)) != NULL) {
add_entry(commit, host);
diff --git a/ui-blob.c b/ui-blob.c
index 3cda03d..2ccd31d 100644
--- a/ui-blob.c
+++ b/ui-blob.c
@@ -24,13 +24,13 @@ static int walk_tree(const unsigned char *sha1, const char *base,int baselen,
void cgit_print_blob(const char *hex, char *path, const char *head)
{
unsigned char sha1[20];
enum object_type type;
- unsigned char *buf;
+ char *buf;
unsigned long size;
struct commit *commit;
const char *paths[] = {path, NULL};
if (hex) {
if (get_sha1_hex(hex, sha1)){
@@ -64,10 +64,16 @@ void cgit_print_blob(const char *hex, char *path, const char *head)
cgit_print_error(fmt("Error reading object %s", hex));
return;
}
buf[size] = '\0';
ctx.page.mimetype = ctx.qry.mimetype;
+ if (!ctx.page.mimetype) {
+ if (buffer_is_binary(buf, size))
+ ctx.page.mimetype = "application/octet-stream";
+ else
+ ctx.page.mimetype = "text/plain";
+ }
ctx.page.filename = path;
cgit_print_http_headers(&ctx);
write(htmlfd, buf, size);
}
diff --git a/ui-plain.c b/ui-plain.c
index f73cd14..93a3a05 100644
--- a/ui-plain.c
+++ b/ui-plain.c
@@ -28,13 +28,16 @@ static void print_object(const unsigned char *sha1, const char *path)
buf = read_sha1_file(sha1, &type, &size);
if (!buf) {
html_status(404, "Not found", 0);
return;
}
- ctx.page.mimetype = "text/plain";
+ if (buffer_is_binary(buf, size))
+ ctx.page.mimetype = "application/octet-stream";
+ else
+ ctx.page.mimetype = "text/plain";
ctx.page.filename = fmt("%s", path);
ctx.page.size = size;
ctx.page.etag = sha1_to_hex(sha1);
cgit_print_http_headers(&ctx);
html_raw(buf, size);
match = 1;
diff --git a/ui-shared.c b/ui-shared.c
index 0dafc83..10be3c0 100644
--- a/ui-shared.c
+++ b/ui-shared.c
@@ -31,12 +31,23 @@ void cgit_print_error(char *msg)
{
html("<div class='error'>");
html_txt(msg);
html("</div>\n");
}
+char *cgit_httpscheme()
+{
+ char *https;
+
+ https = getenv("HTTPS");
+ if (https != NULL && strcmp(https, "on") == 0)
+ return "https://";
+ else
+ return "http://";
+}
+
char *cgit_hosturl()
{
char *host, *port;
host = getenv("HTTP_HOST");
if (host) {
@@ -455,12 +466,14 @@ void cgit_print_age(time_t t, time_t max_relative, char *format)
}
void cgit_print_http_headers(struct cgit_context *ctx)
{
const char *method = getenv("REQUEST_METHOD");
+ if (ctx->page.status)
+ htmlf("Status: %d %s\n", ctx->page.status, ctx->page.statusmsg);
if (ctx->page.mimetype && ctx->page.charset)
htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
ctx->page.charset);
else if (ctx->page.mimetype)
htmlf("Content-Type: %s\n", ctx->page.mimetype);
if (ctx->page.size)
@@ -495,13 +508,14 @@ void cgit_print_docstart(struct cgit_context *ctx)
if (ctx->cfg.favicon) {
html("<link rel='shortcut icon' href='");
html_attr(ctx->cfg.favicon);
html("'/>\n");
}
if (host && ctx->repo) {
- html("<link rel='alternate' title='Atom feed' href='http://");
+ html("<link rel='alternate' title='Atom feed' href='");
+ html(cgit_httpscheme());
html_attr(cgit_hosturl());
html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.path,
fmt("h=%s", ctx->qry.head)));
html("' type='application/atom+xml'/>");
}
html("</head>\n");
diff --git a/ui-shared.h b/ui-shared.h
index 5a3821f..bff4826 100644
--- a/ui-shared.h
+++ b/ui-shared.h
@@ -1,9 +1,10 @@
#ifndef UI_SHARED_H
#define UI_SHARED_H
+extern char *cgit_httpscheme();
extern char *cgit_hosturl();
extern char *cgit_repourl(const char *reponame);
extern char *cgit_fileurl(const char *reponame, const char *pagename,
const char *filename, const char *query);
extern char *cgit_pageurl(const char *reponame, const char *pagename,
const char *query);
diff --git a/ui-snapshot.c b/ui-snapshot.c
index f25613e..5372f5d 100644
--- a/ui-snapshot.c
+++ b/ui-snapshot.c
@@ -153,26 +153,37 @@ static const char *get_ref_from_filename(const char *url, const char *filename,
if (get_sha1(snapshot, sha1) == 0)
return snapshot;
return NULL;
}
+void show_error(char *msg)
+{
+ ctx.page.mimetype = "text/html";
+ cgit_print_http_headers(&ctx);
+ cgit_print_docstart(&ctx);
+ cgit_print_pageheader(&ctx);
+ cgit_print_error(msg);
+ cgit_print_docend();
+}
+
void cgit_print_snapshot(const char *head, const char *hex,
const char *filename, int snapshots, int dwim)
{
const struct cgit_snapshot_format* f;
char *prefix = NULL;
+ if (!filename) {
+ show_error("No snapshot name specified");
+ return;
+ }
+
f = get_format(filename);
if (!f) {
- ctx.page.mimetype = "text/html";
- cgit_print_http_headers(&ctx);
- cgit_print_docstart(&ctx);
- cgit_print_pageheader(&ctx);
- cgit_print_error(fmt("Unsupported snapshot format: %s", filename));
- cgit_print_docend();
+ show_error(xstrdup(fmt("Unsupported snapshot format: %s",
+ filename)));
return;
}
if (!hex && dwim) {
hex = get_ref_from_filename(ctx.repo->url, filename, f);
if (hex == NULL) {
diff --git a/ui-tree.c b/ui-tree.c
index c6159ec..553dbaa 100644
--- a/ui-tree.c
+++ b/ui-tree.c
@@ -22,17 +22,20 @@ static void print_text_buffer(char *buf, unsigned long size)
"<a class='no' id='n%1$d' name='n%1$d' href='#n%1$d'>%1$d</a>\n";
html("<table summary='blob content' class='blob'>\n");
html("<tr><td class='linenumbers'><pre>");
idx = 0;
lineno = 0;
- htmlf(numberfmt, ++lineno);
- while(idx < size - 1) { // skip absolute last newline
- if (buf[idx] == '\n')
- htmlf(numberfmt, ++lineno);
- idx++;
+
+ if (size) {
+ htmlf(numberfmt, ++lineno);
+ while(idx < size - 1) { // skip absolute last newline
+ if (buf[idx] == '\n')
+ htmlf(numberfmt, ++lineno);
+ idx++;
+ }
}
html("</pre></td>\n");
html("<td class='lines'><pre><code>");
html_txt(buf);
html("</code></pre></td></tr></table>\n");
}