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"
16 #include "scan-tree.h"
18 const char *cgit_version = CGIT_VERSION;
20 void config_cb(const char *name, const char *value)
22 if (!strcmp(name, "root-title"))
23 ctx.cfg.root_title = xstrdup(value);
24 else if (!strcmp(name, "root-desc"))
25 ctx.cfg.root_desc = xstrdup(value);
26 else if (!strcmp(name, "root-readme"))
27 ctx.cfg.root_readme = xstrdup(value);
28 else if (!strcmp(name, "css"))
29 ctx.cfg.css = xstrdup(value);
30 else if (!strcmp(name, "favicon"))
31 ctx.cfg.favicon = xstrdup(value);
32 else if (!strcmp(name, "footer"))
33 ctx.cfg.footer = xstrdup(value);
34 else if (!strcmp(name, "logo"))
35 ctx.cfg.logo = xstrdup(value);
36 else if (!strcmp(name, "index-header"))
37 ctx.cfg.index_header = xstrdup(value);
38 else if (!strcmp(name, "index-info"))
39 ctx.cfg.index_info = xstrdup(value);
40 else if (!strcmp(name, "logo-link"))
41 ctx.cfg.logo_link = xstrdup(value);
42 else if (!strcmp(name, "module-link"))
43 ctx.cfg.module_link = xstrdup(value);
44 else if (!strcmp(name, "virtual-root")) {
45 ctx.cfg.virtual_root = trim_end(value, '/');
46 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
47 ctx.cfg.virtual_root = "";
48 } else if (!strcmp(name, "nocache"))
49 ctx.cfg.nocache = atoi(value);
50 else if (!strcmp(name, "snapshots"))
51 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
52 else if (!strcmp(name, "enable-index-links"))
53 ctx.cfg.enable_index_links = atoi(value);
54 else if (!strcmp(name, "enable-log-filecount"))
55 ctx.cfg.enable_log_filecount = atoi(value);
56 else if (!strcmp(name, "enable-log-linecount"))
57 ctx.cfg.enable_log_linecount = atoi(value);
58 else if (!strcmp(name, "max-stats"))
59 ctx.cfg.max_stats = cgit_find_stats_period(value, NULL);
60 else if (!strcmp(name, "cache-size"))
61 ctx.cfg.cache_size = atoi(value);
62 else if (!strcmp(name, "cache-root"))
63 ctx.cfg.cache_root = xstrdup(value);
64 else if (!strcmp(name, "cache-root-ttl"))
65 ctx.cfg.cache_root_ttl = atoi(value);
66 else if (!strcmp(name, "cache-repo-ttl"))
67 ctx.cfg.cache_repo_ttl = atoi(value);
68 else if (!strcmp(name, "cache-static-ttl"))
69 ctx.cfg.cache_static_ttl = atoi(value);
70 else if (!strcmp(name, "cache-dynamic-ttl"))
71 ctx.cfg.cache_dynamic_ttl = atoi(value);
72 else if (!strcmp(name, "max-message-length"))
73 ctx.cfg.max_msg_len = atoi(value);
74 else if (!strcmp(name, "max-repodesc-length"))
75 ctx.cfg.max_repodesc_len = atoi(value);
76 else if (!strcmp(name, "max-repo-count"))
77 ctx.cfg.max_repo_count = atoi(value);
78 else if (!strcmp(name, "max-commit-count"))
79 ctx.cfg.max_commit_count = atoi(value);
80 else if (!strcmp(name, "summary-log"))
81 ctx.cfg.summary_log = atoi(value);
82 else if (!strcmp(name, "summary-branches"))
83 ctx.cfg.summary_branches = atoi(value);
84 else if (!strcmp(name, "summary-tags"))
85 ctx.cfg.summary_tags = atoi(value);
86 else if (!strcmp(name, "agefile"))
87 ctx.cfg.agefile = xstrdup(value);
88 else if (!strcmp(name, "renamelimit"))
89 ctx.cfg.renamelimit = atoi(value);
90 else if (!strcmp(name, "robots"))
91 ctx.cfg.robots = xstrdup(value);
92 else if (!strcmp(name, "clone-prefix"))
93 ctx.cfg.clone_prefix = xstrdup(value);
94 else if (!strcmp(name, "local-time"))
95 ctx.cfg.local_time = atoi(value);
96 else if (!strcmp(name, "repo.group"))
97 ctx.cfg.repo_group = xstrdup(value);
98 else if (!strcmp(name, "repo.url"))
99 ctx.repo = cgit_add_repo(value);
100 else if (!strcmp(name, "repo.name"))
101 ctx.repo->name = xstrdup(value);
102 else if (ctx.repo && !strcmp(name, "repo.path"))
103 ctx.repo->path = trim_end(value, '/');
104 else if (ctx.repo && !strcmp(name, "repo.clone-url"))
105 ctx.repo->clone_url = xstrdup(value);
106 else if (ctx.repo && !strcmp(name, "repo.desc"))
107 ctx.repo->desc = xstrdup(value);
108 else if (ctx.repo && !strcmp(name, "repo.owner"))
109 ctx.repo->owner = xstrdup(value);
110 else if (ctx.repo && !strcmp(name, "repo.defbranch"))
111 ctx.repo->defbranch = xstrdup(value);
112 else if (ctx.repo && !strcmp(name, "repo.snapshots"))
113 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
114 else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
115 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
116 else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
117 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
118 else if (ctx.repo && !strcmp(name, "repo.max-stats"))
119 ctx.repo->max_stats = cgit_find_stats_period(value, NULL);
120 else if (ctx.repo && !strcmp(name, "repo.module-link"))
121 ctx.repo->module_link= xstrdup(value);
122 else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
124 ctx.repo->readme = xstrdup(value);
126 ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
127 } else if (!strcmp(name, "include"))
128 parse_configfile(value, config_cb);
131 static void querystring_cb(const char *name, const char *value)
133 if (!strcmp(name,"r")) {
134 ctx.qry.repo = xstrdup(value);
135 ctx.repo = cgit_get_repoinfo(value);
136 } else if (!strcmp(name, "p")) {
137 ctx.qry.page = xstrdup(value);
138 } else if (!strcmp(name, "url")) {
139 ctx.qry.url = xstrdup(value);
140 cgit_parse_url(value);
141 } else if (!strcmp(name, "qt")) {
142 ctx.qry.grep = xstrdup(value);
143 } else if (!strcmp(name, "q")) {
144 ctx.qry.search = xstrdup(value);
145 } else if (!strcmp(name, "h")) {
146 ctx.qry.head = xstrdup(value);
147 ctx.qry.has_symref = 1;
148 } else if (!strcmp(name, "id")) {
149 ctx.qry.sha1 = xstrdup(value);
150 ctx.qry.has_sha1 = 1;
151 } else if (!strcmp(name, "id2")) {
152 ctx.qry.sha2 = xstrdup(value);
153 ctx.qry.has_sha1 = 1;
154 } else if (!strcmp(name, "ofs")) {
155 ctx.qry.ofs = atoi(value);
156 } else if (!strcmp(name, "path")) {
157 ctx.qry.path = trim_end(value, '/');
158 } else if (!strcmp(name, "name")) {
159 ctx.qry.name = xstrdup(value);
160 } else if (!strcmp(name, "mimetype")) {
161 ctx.qry.mimetype = xstrdup(value);
162 } else if (!strcmp(name, "s")){
163 ctx.qry.sort = xstrdup(value);
164 } else if (!strcmp(name, "showmsg")) {
165 ctx.qry.showmsg = atoi(value);
166 } else if (!strcmp(name, "period")) {
167 ctx.qry.period = xstrdup(value);
171 static void prepare_context(struct cgit_context *ctx)
173 memset(ctx, 0, sizeof(ctx));
174 ctx->cfg.agefile = "info/web/last-modified";
175 ctx->cfg.nocache = 0;
176 ctx->cfg.cache_size = 0;
177 ctx->cfg.cache_dynamic_ttl = 5;
178 ctx->cfg.cache_max_create_time = 5;
179 ctx->cfg.cache_repo_ttl = 5;
180 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
181 ctx->cfg.cache_root_ttl = 5;
182 ctx->cfg.cache_static_ttl = -1;
183 ctx->cfg.css = "/cgit.css";
184 ctx->cfg.logo = "/git-logo.png";
185 ctx->cfg.local_time = 0;
186 ctx->cfg.max_repo_count = 50;
187 ctx->cfg.max_commit_count = 50;
188 ctx->cfg.max_lock_attempts = 5;
189 ctx->cfg.max_msg_len = 80;
190 ctx->cfg.max_repodesc_len = 80;
191 ctx->cfg.max_stats = 0;
192 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
193 ctx->cfg.renamelimit = -1;
194 ctx->cfg.robots = "index, nofollow";
195 ctx->cfg.root_title = "Git repository browser";
196 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
197 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
198 ctx->cfg.summary_branches = 10;
199 ctx->cfg.summary_log = 10;
200 ctx->cfg.summary_tags = 10;
201 ctx->page.mimetype = "text/html";
202 ctx->page.charset = PAGE_ENCODING;
203 ctx->page.filename = NULL;
205 ctx->page.modified = time(NULL);
206 ctx->page.expires = ctx->page.modified;
215 int find_current_ref(const char *refname, const unsigned char *sha1,
216 int flags, void *cb_data)
218 struct refmatch *info;
220 info = (struct refmatch *)cb_data;
221 if (!strcmp(refname, info->req_ref))
223 if (!info->first_ref)
224 info->first_ref = xstrdup(refname);
228 char *find_default_branch(struct cgit_repo *repo)
230 struct refmatch info;
233 info.req_ref = repo->defbranch;
234 info.first_ref = NULL;
236 for_each_branch_ref(find_current_ref, &info);
240 ref = info.first_ref;
246 static int prepare_repo_cmd(struct cgit_context *ctx)
249 unsigned char sha1[20];
252 setenv("GIT_DIR", ctx->repo->path, 1);
253 setup_git_directory_gently(&nongit);
255 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
257 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
259 cgit_print_http_headers(ctx);
260 cgit_print_docstart(ctx);
261 cgit_print_pageheader(ctx);
262 cgit_print_error(tmp);
266 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
268 if (!ctx->qry.head) {
270 ctx->qry.head = find_default_branch(ctx->repo);
271 ctx->repo->defbranch = ctx->qry.head;
274 if (!ctx->qry.head) {
275 cgit_print_http_headers(ctx);
276 cgit_print_docstart(ctx);
277 cgit_print_pageheader(ctx);
278 cgit_print_error("Repository seems to be empty");
283 if (get_sha1(ctx->qry.head, sha1)) {
284 tmp = xstrdup(ctx->qry.head);
285 ctx->qry.head = ctx->repo->defbranch;
286 cgit_print_http_headers(ctx);
287 cgit_print_docstart(ctx);
288 cgit_print_pageheader(ctx);
289 cgit_print_error(fmt("Invalid branch: %s", tmp));
296 static void process_request(void *cbdata)
298 struct cgit_context *ctx = cbdata;
299 struct cgit_cmd *cmd;
301 cmd = cgit_get_cmd(ctx);
303 ctx->page.title = "cgit error";
304 cgit_print_http_headers(ctx);
305 cgit_print_docstart(ctx);
306 cgit_print_pageheader(ctx);
307 cgit_print_error("Invalid request");
312 if (cmd->want_repo && !ctx->repo) {
313 cgit_print_http_headers(ctx);
314 cgit_print_docstart(ctx);
315 cgit_print_pageheader(ctx);
316 cgit_print_error(fmt("No repository selected"));
321 if (ctx->repo && prepare_repo_cmd(ctx))
324 if (cmd->want_layout) {
325 cgit_print_http_headers(ctx);
326 cgit_print_docstart(ctx);
327 cgit_print_pageheader(ctx);
332 if (cmd->want_layout)
336 int cmp_repos(const void *a, const void *b)
338 const struct cgit_repo *ra = a, *rb = b;
339 return strcmp(ra->url, rb->url);
342 void print_repo(struct cgit_repo *repo)
344 printf("repo.url=%s\n", repo->url);
345 printf("repo.name=%s\n", repo->name);
346 printf("repo.path=%s\n", repo->path);
348 printf("repo.owner=%s\n", repo->owner);
350 printf("repo.desc=%s\n", repo->desc);
352 printf("repo.readme=%s\n", repo->readme);
356 void print_repolist(struct cgit_repolist *list)
360 for(i = 0; i < list->count; i++)
361 print_repo(&list->repos[i]);
365 static void cgit_parse_args(int argc, const char **argv)
370 for (i = 1; i < argc; i++) {
371 if (!strncmp(argv[i], "--cache=", 8)) {
372 ctx.cfg.cache_root = xstrdup(argv[i]+8);
374 if (!strcmp(argv[i], "--nocache")) {
377 if (!strncmp(argv[i], "--query=", 8)) {
378 ctx.qry.raw = xstrdup(argv[i]+8);
380 if (!strncmp(argv[i], "--repo=", 7)) {
381 ctx.qry.repo = xstrdup(argv[i]+7);
383 if (!strncmp(argv[i], "--page=", 7)) {
384 ctx.qry.page = xstrdup(argv[i]+7);
386 if (!strncmp(argv[i], "--head=", 7)) {
387 ctx.qry.head = xstrdup(argv[i]+7);
388 ctx.qry.has_symref = 1;
390 if (!strncmp(argv[i], "--sha1=", 7)) {
391 ctx.qry.sha1 = xstrdup(argv[i]+7);
392 ctx.qry.has_sha1 = 1;
394 if (!strncmp(argv[i], "--ofs=", 6)) {
395 ctx.qry.ofs = atoi(argv[i]+6);
397 if (!strncmp(argv[i], "--scan-tree=", 12)) {
399 scan_tree(argv[i] + 12);
403 qsort(cgit_repolist.repos, cgit_repolist.count,
404 sizeof(struct cgit_repo), cmp_repos);
405 print_repolist(&cgit_repolist);
410 static int calc_ttl()
413 return ctx.cfg.cache_root_ttl;
416 return ctx.cfg.cache_repo_ttl;
418 if (ctx.qry.has_symref)
419 return ctx.cfg.cache_dynamic_ttl;
421 if (ctx.qry.has_sha1)
422 return ctx.cfg.cache_static_ttl;
424 return ctx.cfg.cache_repo_ttl;
427 int main(int argc, const char **argv)
429 const char *cgit_config_env = getenv("CGIT_CONFIG");
434 prepare_context(&ctx);
435 cgit_repolist.length = 0;
436 cgit_repolist.count = 0;
437 cgit_repolist.repos = NULL;
439 if (getenv("SCRIPT_NAME"))
440 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
441 if (getenv("QUERY_STRING"))
442 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
443 cgit_parse_args(argc, argv);
444 parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
447 http_parse_querystring(ctx.qry.raw, querystring_cb);
449 /* If virtual-root isn't specified in cgitrc, lets pretend
450 * that virtual-root equals SCRIPT_NAME.
452 if (!ctx.cfg.virtual_root)
453 ctx.cfg.virtual_root = ctx.cfg.script_name;
455 /* If no url parameter is specified on the querystring, lets
456 * use PATH_INFO as url. This allows cgit to work with virtual
457 * urls without the need for rewriterules in the webserver (as
458 * long as PATH_INFO is included in the cache lookup key).
460 path = getenv("PATH_INFO");
461 if (!ctx.qry.url && path) {
464 ctx.qry.url = xstrdup(path);
467 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
470 ctx.qry.raw = ctx.qry.url;
471 cgit_parse_url(ctx.qry.url);
475 ctx.page.expires += ttl*60;
477 ctx.cfg.cache_size = 0;
478 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
479 ctx.qry.raw, ttl, process_request, &ctx);
481 cgit_print_error(fmt("Error processing page: %s (%d)",
482 strerror(err), err));