1 /* cgit.c: cgi for the git scm
3 * Copyright (C) 2006 Lars Hjemli
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
12 #include "configfile.h"
14 #include "ui-shared.h"
15 #include "scan-tree.h"
17 const char *cgit_version = CGIT_VERSION;
19 void config_cb(const char *name, const char *value)
21 if (!strcmp(name, "root-title"))
22 ctx.cfg.root_title = xstrdup(value);
23 else if (!strcmp(name, "root-desc"))
24 ctx.cfg.root_desc = xstrdup(value);
25 else if (!strcmp(name, "root-readme"))
26 ctx.cfg.root_readme = xstrdup(value);
27 else if (!strcmp(name, "css"))
28 ctx.cfg.css = xstrdup(value);
29 else if (!strcmp(name, "favicon"))
30 ctx.cfg.favicon = xstrdup(value);
31 else if (!strcmp(name, "footer"))
32 ctx.cfg.footer = xstrdup(value);
33 else if (!strcmp(name, "logo"))
34 ctx.cfg.logo = xstrdup(value);
35 else if (!strcmp(name, "index-header"))
36 ctx.cfg.index_header = xstrdup(value);
37 else if (!strcmp(name, "index-info"))
38 ctx.cfg.index_info = xstrdup(value);
39 else if (!strcmp(name, "logo-link"))
40 ctx.cfg.logo_link = xstrdup(value);
41 else if (!strcmp(name, "module-link"))
42 ctx.cfg.module_link = xstrdup(value);
43 else if (!strcmp(name, "virtual-root")) {
44 ctx.cfg.virtual_root = trim_end(value, '/');
45 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
46 ctx.cfg.virtual_root = "";
47 } else if (!strcmp(name, "nocache"))
48 ctx.cfg.nocache = atoi(value);
49 else if (!strcmp(name, "snapshots"))
50 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
51 else if (!strcmp(name, "enable-index-links"))
52 ctx.cfg.enable_index_links = atoi(value);
53 else if (!strcmp(name, "enable-log-filecount"))
54 ctx.cfg.enable_log_filecount = atoi(value);
55 else if (!strcmp(name, "enable-log-linecount"))
56 ctx.cfg.enable_log_linecount = atoi(value);
57 else if (!strcmp(name, "cache-size"))
58 ctx.cfg.cache_size = atoi(value);
59 else if (!strcmp(name, "cache-root"))
60 ctx.cfg.cache_root = xstrdup(value);
61 else if (!strcmp(name, "cache-root-ttl"))
62 ctx.cfg.cache_root_ttl = atoi(value);
63 else if (!strcmp(name, "cache-repo-ttl"))
64 ctx.cfg.cache_repo_ttl = atoi(value);
65 else if (!strcmp(name, "cache-static-ttl"))
66 ctx.cfg.cache_static_ttl = atoi(value);
67 else if (!strcmp(name, "cache-dynamic-ttl"))
68 ctx.cfg.cache_dynamic_ttl = atoi(value);
69 else if (!strcmp(name, "max-message-length"))
70 ctx.cfg.max_msg_len = atoi(value);
71 else if (!strcmp(name, "max-repodesc-length"))
72 ctx.cfg.max_repodesc_len = atoi(value);
73 else if (!strcmp(name, "max-repo-count"))
74 ctx.cfg.max_repo_count = atoi(value);
75 else if (!strcmp(name, "max-commit-count"))
76 ctx.cfg.max_commit_count = atoi(value);
77 else if (!strcmp(name, "summary-log"))
78 ctx.cfg.summary_log = atoi(value);
79 else if (!strcmp(name, "summary-branches"))
80 ctx.cfg.summary_branches = atoi(value);
81 else if (!strcmp(name, "summary-tags"))
82 ctx.cfg.summary_tags = atoi(value);
83 else if (!strcmp(name, "agefile"))
84 ctx.cfg.agefile = xstrdup(value);
85 else if (!strcmp(name, "renamelimit"))
86 ctx.cfg.renamelimit = atoi(value);
87 else if (!strcmp(name, "robots"))
88 ctx.cfg.robots = xstrdup(value);
89 else if (!strcmp(name, "clone-prefix"))
90 ctx.cfg.clone_prefix = xstrdup(value);
91 else if (!strcmp(name, "local-time"))
92 ctx.cfg.local_time = atoi(value);
93 else if (!strcmp(name, "repo.group"))
94 ctx.cfg.repo_group = xstrdup(value);
95 else if (!strcmp(name, "repo.url"))
96 ctx.repo = cgit_add_repo(value);
97 else if (!strcmp(name, "repo.name"))
98 ctx.repo->name = xstrdup(value);
99 else if (ctx.repo && !strcmp(name, "repo.path"))
100 ctx.repo->path = trim_end(value, '/');
101 else if (ctx.repo && !strcmp(name, "repo.clone-url"))
102 ctx.repo->clone_url = xstrdup(value);
103 else if (ctx.repo && !strcmp(name, "repo.desc"))
104 ctx.repo->desc = xstrdup(value);
105 else if (ctx.repo && !strcmp(name, "repo.owner"))
106 ctx.repo->owner = xstrdup(value);
107 else if (ctx.repo && !strcmp(name, "repo.defbranch"))
108 ctx.repo->defbranch = xstrdup(value);
109 else if (ctx.repo && !strcmp(name, "repo.snapshots"))
110 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
111 else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
112 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
113 else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
114 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
115 else if (ctx.repo && !strcmp(name, "repo.module-link"))
116 ctx.repo->module_link= xstrdup(value);
117 else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
119 ctx.repo->readme = xstrdup(value);
121 ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
122 } else if (!strcmp(name, "include"))
123 parse_configfile(value, config_cb);
126 static void querystring_cb(const char *name, const char *value)
128 if (!strcmp(name,"r")) {
129 ctx.qry.repo = xstrdup(value);
130 ctx.repo = cgit_get_repoinfo(value);
131 } else if (!strcmp(name, "p")) {
132 ctx.qry.page = xstrdup(value);
133 } else if (!strcmp(name, "url")) {
134 ctx.qry.url = xstrdup(value);
135 cgit_parse_url(value);
136 } else if (!strcmp(name, "qt")) {
137 ctx.qry.grep = xstrdup(value);
138 } else if (!strcmp(name, "q")) {
139 ctx.qry.search = xstrdup(value);
140 } else if (!strcmp(name, "h")) {
141 ctx.qry.head = xstrdup(value);
142 ctx.qry.has_symref = 1;
143 } else if (!strcmp(name, "id")) {
144 ctx.qry.sha1 = xstrdup(value);
145 ctx.qry.has_sha1 = 1;
146 } else if (!strcmp(name, "id2")) {
147 ctx.qry.sha2 = xstrdup(value);
148 ctx.qry.has_sha1 = 1;
149 } else if (!strcmp(name, "ofs")) {
150 ctx.qry.ofs = atoi(value);
151 } else if (!strcmp(name, "path")) {
152 ctx.qry.path = trim_end(value, '/');
153 } else if (!strcmp(name, "name")) {
154 ctx.qry.name = xstrdup(value);
155 } else if (!strcmp(name, "mimetype")) {
156 ctx.qry.mimetype = xstrdup(value);
160 static void prepare_context(struct cgit_context *ctx)
162 memset(ctx, 0, sizeof(ctx));
163 ctx->cfg.agefile = "info/web/last-modified";
164 ctx->cfg.nocache = 0;
165 ctx->cfg.cache_size = 0;
166 ctx->cfg.cache_dynamic_ttl = 5;
167 ctx->cfg.cache_max_create_time = 5;
168 ctx->cfg.cache_repo_ttl = 5;
169 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
170 ctx->cfg.cache_root_ttl = 5;
171 ctx->cfg.cache_static_ttl = -1;
172 ctx->cfg.css = "/cgit.css";
173 ctx->cfg.logo = "/git-logo.png";
174 ctx->cfg.local_time = 0;
175 ctx->cfg.max_repo_count = 50;
176 ctx->cfg.max_commit_count = 50;
177 ctx->cfg.max_lock_attempts = 5;
178 ctx->cfg.max_msg_len = 80;
179 ctx->cfg.max_repodesc_len = 80;
180 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
181 ctx->cfg.renamelimit = -1;
182 ctx->cfg.robots = "index, nofollow";
183 ctx->cfg.root_title = "Git repository browser";
184 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
185 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
186 ctx->cfg.summary_branches = 10;
187 ctx->cfg.summary_log = 10;
188 ctx->cfg.summary_tags = 10;
189 ctx->page.mimetype = "text/html";
190 ctx->page.charset = PAGE_ENCODING;
191 ctx->page.filename = NULL;
193 ctx->page.modified = time(NULL);
194 ctx->page.expires = ctx->page.modified;
203 int find_current_ref(const char *refname, const unsigned char *sha1,
204 int flags, void *cb_data)
206 struct refmatch *info;
208 info = (struct refmatch *)cb_data;
209 if (!strcmp(refname, info->req_ref))
211 if (!info->first_ref)
212 info->first_ref = xstrdup(refname);
216 char *find_default_branch(struct cgit_repo *repo)
218 struct refmatch info;
221 info.req_ref = repo->defbranch;
222 info.first_ref = NULL;
224 for_each_branch_ref(find_current_ref, &info);
228 ref = info.first_ref;
234 static int prepare_repo_cmd(struct cgit_context *ctx)
237 unsigned char sha1[20];
240 setenv("GIT_DIR", ctx->repo->path, 1);
241 setup_git_directory_gently(&nongit);
243 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
245 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
247 cgit_print_http_headers(ctx);
248 cgit_print_docstart(ctx);
249 cgit_print_pageheader(ctx);
250 cgit_print_error(tmp);
254 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
256 if (!ctx->qry.head) {
257 ctx->qry.head = find_default_branch(ctx->repo);
258 ctx->repo->defbranch = ctx->qry.head;
261 if (!ctx->qry.head) {
262 cgit_print_http_headers(ctx);
263 cgit_print_docstart(ctx);
264 cgit_print_pageheader(ctx);
265 cgit_print_error("Repository seems to be empty");
270 if (get_sha1(ctx->qry.head, sha1)) {
271 tmp = xstrdup(ctx->qry.head);
272 ctx->qry.head = ctx->repo->defbranch;
273 cgit_print_http_headers(ctx);
274 cgit_print_docstart(ctx);
275 cgit_print_pageheader(ctx);
276 cgit_print_error(fmt("Invalid branch: %s", tmp));
283 static void process_request(void *cbdata)
285 struct cgit_context *ctx = cbdata;
286 struct cgit_cmd *cmd;
288 cmd = cgit_get_cmd(ctx);
290 ctx->page.title = "cgit error";
292 cgit_print_http_headers(ctx);
293 cgit_print_docstart(ctx);
294 cgit_print_pageheader(ctx);
295 cgit_print_error("Invalid request");
300 if (cmd->want_repo && !ctx->repo) {
301 cgit_print_http_headers(ctx);
302 cgit_print_docstart(ctx);
303 cgit_print_pageheader(ctx);
304 cgit_print_error(fmt("No repository selected"));
309 if (ctx->repo && prepare_repo_cmd(ctx))
312 if (cmd->want_layout) {
313 cgit_print_http_headers(ctx);
314 cgit_print_docstart(ctx);
315 cgit_print_pageheader(ctx);
320 if (cmd->want_layout)
324 int cmp_repos(const void *a, const void *b)
326 const struct cgit_repo *ra = a, *rb = b;
327 return strcmp(ra->url, rb->url);
330 void print_repo(struct cgit_repo *repo)
332 printf("repo.url=%s\n", repo->url);
333 printf("repo.name=%s\n", repo->name);
334 printf("repo.path=%s\n", repo->path);
336 printf("repo.owner=%s\n", repo->owner);
338 printf("repo.desc=%s\n", repo->desc);
340 printf("repo.readme=%s\n", repo->readme);
344 void print_repolist(struct cgit_repolist *list)
348 for(i = 0; i < list->count; i++)
349 print_repo(&list->repos[i]);
353 static void cgit_parse_args(int argc, const char **argv)
358 for (i = 1; i < argc; i++) {
359 if (!strncmp(argv[i], "--cache=", 8)) {
360 ctx.cfg.cache_root = xstrdup(argv[i]+8);
362 if (!strcmp(argv[i], "--nocache")) {
365 if (!strncmp(argv[i], "--query=", 8)) {
366 ctx.qry.raw = xstrdup(argv[i]+8);
368 if (!strncmp(argv[i], "--repo=", 7)) {
369 ctx.qry.repo = xstrdup(argv[i]+7);
371 if (!strncmp(argv[i], "--page=", 7)) {
372 ctx.qry.page = xstrdup(argv[i]+7);
374 if (!strncmp(argv[i], "--head=", 7)) {
375 ctx.qry.head = xstrdup(argv[i]+7);
376 ctx.qry.has_symref = 1;
378 if (!strncmp(argv[i], "--sha1=", 7)) {
379 ctx.qry.sha1 = xstrdup(argv[i]+7);
380 ctx.qry.has_sha1 = 1;
382 if (!strncmp(argv[i], "--ofs=", 6)) {
383 ctx.qry.ofs = atoi(argv[i]+6);
385 if (!strncmp(argv[i], "--scan-tree=", 12)) {
387 scan_tree(argv[i] + 12);
391 qsort(cgit_repolist.repos, cgit_repolist.count,
392 sizeof(struct cgit_repo), cmp_repos);
393 print_repolist(&cgit_repolist);
398 static int calc_ttl()
401 return ctx.cfg.cache_root_ttl;
404 return ctx.cfg.cache_repo_ttl;
406 if (ctx.qry.has_symref)
407 return ctx.cfg.cache_dynamic_ttl;
409 if (ctx.qry.has_sha1)
410 return ctx.cfg.cache_static_ttl;
412 return ctx.cfg.cache_repo_ttl;
415 int main(int argc, const char **argv)
417 const char *cgit_config_env = getenv("CGIT_CONFIG");
422 prepare_context(&ctx);
423 cgit_repolist.length = 0;
424 cgit_repolist.count = 0;
425 cgit_repolist.repos = NULL;
427 if (getenv("SCRIPT_NAME"))
428 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
429 if (getenv("QUERY_STRING"))
430 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
431 cgit_parse_args(argc, argv);
432 parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
435 http_parse_querystring(ctx.qry.raw, querystring_cb);
437 /* If virtual-root isn't specified in cgitrc and no url
438 * parameter is specified on the querystring, lets pretend
439 * that virtualroot equals SCRIPT_NAME and use PATH_INFO as
440 * url. This allows cgit to work with virtual urls without
441 * the need for rewriterules in the webserver (as long as
442 * PATH_INFO is included in the cache lookup key).
444 if (!ctx.cfg.virtual_root && !ctx.qry.url) {
445 ctx.cfg.virtual_root = ctx.cfg.script_name;
446 path = getenv("PATH_INFO");
450 ctx.qry.url = xstrdup(path);
453 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
456 ctx.qry.raw = ctx.qry.url;
457 cgit_parse_url(ctx.qry.url);
462 ctx.page.expires += ttl*60;
464 ctx.cfg.cache_size = 0;
465 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
466 ctx.qry.raw, ttl, process_request, &ctx);
468 cgit_print_error(fmt("Error processing page: %s (%d)",
469 strerror(err), err));