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 add_mimetype(const char *name, const char *value)
22 struct string_list_item *item;
24 item = string_list_insert(xstrdup(name), &ctx.cfg.mimetypes);
25 item->util = xstrdup(value);
28 struct cgit_filter *new_filter(const char *cmd, int extra_args)
30 struct cgit_filter *f;
35 f = xmalloc(sizeof(struct cgit_filter));
36 f->cmd = xstrdup(cmd);
37 f->argv = xmalloc((2 + extra_args) * sizeof(char *));
43 static void process_cached_repolist(const char *path);
45 void repo_config(struct cgit_repo *repo, const char *name, const char *value)
47 if (!strcmp(name, "name"))
48 repo->name = xstrdup(value);
49 else if (!strcmp(name, "clone-url"))
50 repo->clone_url = xstrdup(value);
51 else if (!strcmp(name, "desc"))
52 repo->desc = xstrdup(value);
53 else if (!strcmp(name, "owner"))
54 repo->owner = xstrdup(value);
55 else if (!strcmp(name, "defbranch"))
56 repo->defbranch = xstrdup(value);
57 else if (!strcmp(name, "snapshots"))
58 repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value);
59 else if (!strcmp(name, "enable-log-filecount"))
60 repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
61 else if (!strcmp(name, "enable-log-linecount"))
62 repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
63 else if (!strcmp(name, "max-stats"))
64 repo->max_stats = cgit_find_stats_period(value, NULL);
65 else if (!strcmp(name, "module-link"))
66 repo->module_link= xstrdup(value);
67 else if (!strcmp(name, "section"))
68 repo->section = xstrdup(value);
69 else if (!strcmp(name, "about-filter"))
70 repo->about_filter = new_filter(value, 0);
71 else if (!strcmp(name, "commit-filter"))
72 repo->commit_filter = new_filter(value, 0);
73 else if (!strcmp(name, "source-filter"))
74 repo->source_filter = new_filter(value, 1);
75 else if (!strcmp(name, "readme") && value != NULL) {
77 ctx.repo->readme = xstrdup(value);
79 ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
83 void config_cb(const char *name, const char *value)
85 if (!strcmp(name, "section") || !strcmp(name, "repo.group"))
86 ctx.cfg.section = xstrdup(value);
87 else if (!strcmp(name, "repo.url"))
88 ctx.repo = cgit_add_repo(value);
89 else if (ctx.repo && !strcmp(name, "repo.path"))
90 ctx.repo->path = trim_end(value, '/');
91 else if (ctx.repo && !prefixcmp(name, "repo."))
92 repo_config(ctx.repo, name + 5, value);
93 else if (!strcmp(name, "root-title"))
94 ctx.cfg.root_title = xstrdup(value);
95 else if (!strcmp(name, "root-desc"))
96 ctx.cfg.root_desc = xstrdup(value);
97 else if (!strcmp(name, "root-readme"))
98 ctx.cfg.root_readme = xstrdup(value);
99 else if (!strcmp(name, "css"))
100 ctx.cfg.css = xstrdup(value);
101 else if (!strcmp(name, "favicon"))
102 ctx.cfg.favicon = xstrdup(value);
103 else if (!strcmp(name, "footer"))
104 ctx.cfg.footer = xstrdup(value);
105 else if (!strcmp(name, "head-include"))
106 ctx.cfg.head_include = xstrdup(value);
107 else if (!strcmp(name, "header"))
108 ctx.cfg.header = xstrdup(value);
109 else if (!strcmp(name, "logo"))
110 ctx.cfg.logo = xstrdup(value);
111 else if (!strcmp(name, "index-header"))
112 ctx.cfg.index_header = xstrdup(value);
113 else if (!strcmp(name, "index-info"))
114 ctx.cfg.index_info = xstrdup(value);
115 else if (!strcmp(name, "logo-link"))
116 ctx.cfg.logo_link = xstrdup(value);
117 else if (!strcmp(name, "module-link"))
118 ctx.cfg.module_link = xstrdup(value);
119 else if (!strcmp(name, "virtual-root")) {
120 ctx.cfg.virtual_root = trim_end(value, '/');
121 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
122 ctx.cfg.virtual_root = "";
123 } else if (!strcmp(name, "nocache"))
124 ctx.cfg.nocache = atoi(value);
125 else if (!strcmp(name, "noplainemail"))
126 ctx.cfg.noplainemail = atoi(value);
127 else if (!strcmp(name, "noheader"))
128 ctx.cfg.noheader = atoi(value);
129 else if (!strcmp(name, "snapshots"))
130 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
131 else if (!strcmp(name, "enable-index-links"))
132 ctx.cfg.enable_index_links = atoi(value);
133 else if (!strcmp(name, "enable-log-filecount"))
134 ctx.cfg.enable_log_filecount = atoi(value);
135 else if (!strcmp(name, "enable-log-linecount"))
136 ctx.cfg.enable_log_linecount = atoi(value);
137 else if (!strcmp(name, "max-stats"))
138 ctx.cfg.max_stats = cgit_find_stats_period(value, NULL);
139 else if (!strcmp(name, "cache-size"))
140 ctx.cfg.cache_size = atoi(value);
141 else if (!strcmp(name, "cache-root"))
142 ctx.cfg.cache_root = xstrdup(value);
143 else if (!strcmp(name, "cache-root-ttl"))
144 ctx.cfg.cache_root_ttl = atoi(value);
145 else if (!strcmp(name, "cache-repo-ttl"))
146 ctx.cfg.cache_repo_ttl = atoi(value);
147 else if (!strcmp(name, "cache-scanrc-ttl"))
148 ctx.cfg.cache_scanrc_ttl = atoi(value);
149 else if (!strcmp(name, "cache-static-ttl"))
150 ctx.cfg.cache_static_ttl = atoi(value);
151 else if (!strcmp(name, "cache-dynamic-ttl"))
152 ctx.cfg.cache_dynamic_ttl = atoi(value);
153 else if (!strcmp(name, "about-filter"))
154 ctx.cfg.about_filter = new_filter(value, 0);
155 else if (!strcmp(name, "commit-filter"))
156 ctx.cfg.commit_filter = new_filter(value, 0);
157 else if (!strcmp(name, "embedded"))
158 ctx.cfg.embedded = atoi(value);
159 else if (!strcmp(name, "max-message-length"))
160 ctx.cfg.max_msg_len = atoi(value);
161 else if (!strcmp(name, "max-repodesc-length"))
162 ctx.cfg.max_repodesc_len = atoi(value);
163 else if (!strcmp(name, "max-repo-count"))
164 ctx.cfg.max_repo_count = atoi(value);
165 else if (!strcmp(name, "max-commit-count"))
166 ctx.cfg.max_commit_count = atoi(value);
167 else if (!strcmp(name, "scan-path"))
168 if (!ctx.cfg.nocache && ctx.cfg.cache_size)
169 process_cached_repolist(value);
171 scan_tree(value, repo_config);
172 else if (!strcmp(name, "source-filter"))
173 ctx.cfg.source_filter = new_filter(value, 1);
174 else if (!strcmp(name, "summary-log"))
175 ctx.cfg.summary_log = atoi(value);
176 else if (!strcmp(name, "summary-branches"))
177 ctx.cfg.summary_branches = atoi(value);
178 else if (!strcmp(name, "summary-tags"))
179 ctx.cfg.summary_tags = atoi(value);
180 else if (!strcmp(name, "agefile"))
181 ctx.cfg.agefile = xstrdup(value);
182 else if (!strcmp(name, "renamelimit"))
183 ctx.cfg.renamelimit = atoi(value);
184 else if (!strcmp(name, "robots"))
185 ctx.cfg.robots = xstrdup(value);
186 else if (!strcmp(name, "clone-prefix"))
187 ctx.cfg.clone_prefix = xstrdup(value);
188 else if (!strcmp(name, "local-time"))
189 ctx.cfg.local_time = atoi(value);
190 else if (!prefixcmp(name, "mimetype."))
191 add_mimetype(name + 9, value);
192 else if (!strcmp(name, "include"))
193 parse_configfile(value, config_cb);
196 static void querystring_cb(const char *name, const char *value)
201 if (!strcmp(name,"r")) {
202 ctx.qry.repo = xstrdup(value);
203 ctx.repo = cgit_get_repoinfo(value);
204 } else if (!strcmp(name, "p")) {
205 ctx.qry.page = xstrdup(value);
206 } else if (!strcmp(name, "url")) {
207 ctx.qry.url = xstrdup(value);
208 cgit_parse_url(value);
209 } else if (!strcmp(name, "qt")) {
210 ctx.qry.grep = xstrdup(value);
211 } else if (!strcmp(name, "q")) {
212 ctx.qry.search = xstrdup(value);
213 } else if (!strcmp(name, "h")) {
214 ctx.qry.head = xstrdup(value);
215 ctx.qry.has_symref = 1;
216 } else if (!strcmp(name, "id")) {
217 ctx.qry.sha1 = xstrdup(value);
218 ctx.qry.has_sha1 = 1;
219 } else if (!strcmp(name, "id2")) {
220 ctx.qry.sha2 = xstrdup(value);
221 ctx.qry.has_sha1 = 1;
222 } else if (!strcmp(name, "ofs")) {
223 ctx.qry.ofs = atoi(value);
224 } else if (!strcmp(name, "path")) {
225 ctx.qry.path = trim_end(value, '/');
226 } else if (!strcmp(name, "name")) {
227 ctx.qry.name = xstrdup(value);
228 } else if (!strcmp(name, "mimetype")) {
229 ctx.qry.mimetype = xstrdup(value);
230 } else if (!strcmp(name, "s")){
231 ctx.qry.sort = xstrdup(value);
232 } else if (!strcmp(name, "showmsg")) {
233 ctx.qry.showmsg = atoi(value);
234 } else if (!strcmp(name, "period")) {
235 ctx.qry.period = xstrdup(value);
239 char *xstrdupn(const char *str)
241 return (str ? xstrdup(str) : NULL);
244 static void prepare_context(struct cgit_context *ctx)
246 memset(ctx, 0, sizeof(ctx));
247 ctx->cfg.agefile = "info/web/last-modified";
248 ctx->cfg.nocache = 0;
249 ctx->cfg.cache_size = 0;
250 ctx->cfg.cache_dynamic_ttl = 5;
251 ctx->cfg.cache_max_create_time = 5;
252 ctx->cfg.cache_repo_ttl = 5;
253 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
254 ctx->cfg.cache_root_ttl = 5;
255 ctx->cfg.cache_scanrc_ttl = 15;
256 ctx->cfg.cache_static_ttl = -1;
257 ctx->cfg.css = "/cgit.css";
258 ctx->cfg.logo = "/cgit.png";
259 ctx->cfg.local_time = 0;
260 ctx->cfg.max_repo_count = 50;
261 ctx->cfg.max_commit_count = 50;
262 ctx->cfg.max_lock_attempts = 5;
263 ctx->cfg.max_msg_len = 80;
264 ctx->cfg.max_repodesc_len = 80;
265 ctx->cfg.max_stats = 0;
266 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
267 ctx->cfg.renamelimit = -1;
268 ctx->cfg.robots = "index, nofollow";
269 ctx->cfg.root_title = "Git repository browser";
270 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
271 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
272 ctx->cfg.summary_branches = 10;
273 ctx->cfg.summary_log = 10;
274 ctx->cfg.summary_tags = 10;
275 ctx->env.cgit_config = xstrdupn(getenv("CGIT_CONFIG"));
276 ctx->env.http_host = xstrdupn(getenv("HTTP_HOST"));
277 ctx->env.https = xstrdupn(getenv("HTTPS"));
278 ctx->env.no_http = xstrdupn(getenv("NO_HTTP"));
279 ctx->env.path_info = xstrdupn(getenv("PATH_INFO"));
280 ctx->env.query_string = xstrdupn(getenv("QUERY_STRING"));
281 ctx->env.request_method = xstrdupn(getenv("REQUEST_METHOD"));
282 ctx->env.script_name = xstrdupn(getenv("SCRIPT_NAME"));
283 ctx->env.server_name = xstrdupn(getenv("SERVER_NAME"));
284 ctx->env.server_port = xstrdupn(getenv("SERVER_PORT"));
285 ctx->page.mimetype = "text/html";
286 ctx->page.charset = PAGE_ENCODING;
287 ctx->page.filename = NULL;
289 ctx->page.modified = time(NULL);
290 ctx->page.expires = ctx->page.modified;
291 ctx->page.etag = NULL;
292 memset(&ctx->cfg.mimetypes, 0, sizeof(struct string_list));
293 if (ctx->env.script_name)
294 ctx->cfg.script_name = ctx->env.script_name;
295 if (ctx->env.query_string)
296 ctx->qry.raw = ctx->env.query_string;
297 if (!ctx->env.cgit_config)
298 ctx->env.cgit_config = CGIT_CONFIG;
307 int find_current_ref(const char *refname, const unsigned char *sha1,
308 int flags, void *cb_data)
310 struct refmatch *info;
312 info = (struct refmatch *)cb_data;
313 if (!strcmp(refname, info->req_ref))
315 if (!info->first_ref)
316 info->first_ref = xstrdup(refname);
320 char *find_default_branch(struct cgit_repo *repo)
322 struct refmatch info;
325 info.req_ref = repo->defbranch;
326 info.first_ref = NULL;
328 for_each_branch_ref(find_current_ref, &info);
332 ref = info.first_ref;
338 static int prepare_repo_cmd(struct cgit_context *ctx)
341 unsigned char sha1[20];
344 setenv("GIT_DIR", ctx->repo->path, 1);
345 setup_git_directory_gently(&nongit);
347 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
349 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
351 cgit_print_http_headers(ctx);
352 cgit_print_docstart(ctx);
353 cgit_print_pageheader(ctx);
354 cgit_print_error(tmp);
358 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
360 if (!ctx->qry.head) {
362 ctx->qry.head = find_default_branch(ctx->repo);
363 ctx->repo->defbranch = ctx->qry.head;
366 if (!ctx->qry.head) {
367 cgit_print_http_headers(ctx);
368 cgit_print_docstart(ctx);
369 cgit_print_pageheader(ctx);
370 cgit_print_error("Repository seems to be empty");
375 if (get_sha1(ctx->qry.head, sha1)) {
376 tmp = xstrdup(ctx->qry.head);
377 ctx->qry.head = ctx->repo->defbranch;
378 ctx->page.status = 404;
379 ctx->page.statusmsg = "not found";
380 cgit_print_http_headers(ctx);
381 cgit_print_docstart(ctx);
382 cgit_print_pageheader(ctx);
383 cgit_print_error(fmt("Invalid branch: %s", tmp));
390 static void process_request(void *cbdata)
392 struct cgit_context *ctx = cbdata;
393 struct cgit_cmd *cmd;
395 cmd = cgit_get_cmd(ctx);
397 ctx->page.title = "cgit error";
398 cgit_print_http_headers(ctx);
399 cgit_print_docstart(ctx);
400 cgit_print_pageheader(ctx);
401 cgit_print_error("Invalid request");
406 if (cmd->want_repo && !ctx->repo) {
407 cgit_print_http_headers(ctx);
408 cgit_print_docstart(ctx);
409 cgit_print_pageheader(ctx);
410 cgit_print_error(fmt("No repository selected"));
415 if (ctx->repo && prepare_repo_cmd(ctx))
418 if (cmd->want_layout) {
419 cgit_print_http_headers(ctx);
420 cgit_print_docstart(ctx);
421 cgit_print_pageheader(ctx);
426 if (cmd->want_layout)
430 int cmp_repos(const void *a, const void *b)
432 const struct cgit_repo *ra = a, *rb = b;
433 return strcmp(ra->url, rb->url);
436 void print_repo(FILE *f, struct cgit_repo *repo)
438 fprintf(f, "repo.url=%s\n", repo->url);
439 fprintf(f, "repo.name=%s\n", repo->name);
440 fprintf(f, "repo.path=%s\n", repo->path);
442 fprintf(f, "repo.owner=%s\n", repo->owner);
444 fprintf(f, "repo.desc=%s\n", repo->desc);
446 fprintf(f, "repo.readme=%s\n", repo->readme);
450 void print_repolist(FILE *f, struct cgit_repolist *list, int start)
454 for(i = start; i < list->count; i++)
455 print_repo(f, &list->repos[i]);
458 /* Scan 'path' for git repositories, save the resulting repolist in 'cached_rc'
459 * and return 0 on success.
461 static int generate_cached_repolist(const char *path, const char *cached_rc)
467 locked_rc = xstrdup(fmt("%s.lock", cached_rc));
468 f = fopen(locked_rc, "wx");
470 /* Inform about the error unless the lockfile already existed,
471 * since that only means we've got concurrent requests.
474 fprintf(stderr, "[cgit] Error opening %s: %s (%d)\n",
475 locked_rc, strerror(errno), errno);
478 idx = cgit_repolist.count;
479 scan_tree(path, repo_config);
480 print_repolist(f, &cgit_repolist, idx);
481 if (rename(locked_rc, cached_rc))
482 fprintf(stderr, "[cgit] Error renaming %s to %s: %s (%d)\n",
483 locked_rc, cached_rc, strerror(errno), errno);
488 static void process_cached_repolist(const char *path)
494 cached_rc = xstrdup(fmt("%s/rc-%8x", ctx.cfg.cache_root,
497 if (stat(cached_rc, &st)) {
498 /* Nothing is cached, we need to scan without forking. And
499 * if we fail to generate a cached repolist, we need to
500 * invoke scan_tree manually.
502 if (generate_cached_repolist(path, cached_rc))
503 scan_tree(path, repo_config);
507 parse_configfile(cached_rc, config_cb);
509 /* If the cached configfile hasn't expired, lets exit now */
510 age = time(NULL) - st.st_mtime;
511 if (age <= (ctx.cfg.cache_scanrc_ttl * 60))
514 /* The cached repolist has been parsed, but it was old. So lets
515 * rescan the specified path and generate a new cached repolist
516 * in a child-process to avoid latency for the current request.
521 exit(generate_cached_repolist(path, cached_rc));
524 static void cgit_parse_args(int argc, const char **argv)
529 for (i = 1; i < argc; i++) {
530 if (!strncmp(argv[i], "--cache=", 8)) {
531 ctx.cfg.cache_root = xstrdup(argv[i]+8);
533 if (!strcmp(argv[i], "--nocache")) {
536 if (!strcmp(argv[i], "--nohttp")) {
537 ctx.env.no_http = "1";
539 if (!strncmp(argv[i], "--query=", 8)) {
540 ctx.qry.raw = xstrdup(argv[i]+8);
542 if (!strncmp(argv[i], "--repo=", 7)) {
543 ctx.qry.repo = xstrdup(argv[i]+7);
545 if (!strncmp(argv[i], "--page=", 7)) {
546 ctx.qry.page = xstrdup(argv[i]+7);
548 if (!strncmp(argv[i], "--head=", 7)) {
549 ctx.qry.head = xstrdup(argv[i]+7);
550 ctx.qry.has_symref = 1;
552 if (!strncmp(argv[i], "--sha1=", 7)) {
553 ctx.qry.sha1 = xstrdup(argv[i]+7);
554 ctx.qry.has_sha1 = 1;
556 if (!strncmp(argv[i], "--ofs=", 6)) {
557 ctx.qry.ofs = atoi(argv[i]+6);
559 if (!strncmp(argv[i], "--scan-tree=", 12) ||
560 !strncmp(argv[i], "--scan-path=", 12)) {
562 scan_tree(argv[i] + 12, repo_config);
566 qsort(cgit_repolist.repos, cgit_repolist.count,
567 sizeof(struct cgit_repo), cmp_repos);
568 print_repolist(stdout, &cgit_repolist, 0);
573 static int calc_ttl()
576 return ctx.cfg.cache_root_ttl;
579 return ctx.cfg.cache_repo_ttl;
581 if (ctx.qry.has_symref)
582 return ctx.cfg.cache_dynamic_ttl;
584 if (ctx.qry.has_sha1)
585 return ctx.cfg.cache_static_ttl;
587 return ctx.cfg.cache_repo_ttl;
590 int main(int argc, const char **argv)
596 prepare_context(&ctx);
597 cgit_repolist.length = 0;
598 cgit_repolist.count = 0;
599 cgit_repolist.repos = NULL;
601 cgit_parse_args(argc, argv);
602 parse_configfile(ctx.env.cgit_config, config_cb);
604 http_parse_querystring(ctx.qry.raw, querystring_cb);
606 /* If virtual-root isn't specified in cgitrc, lets pretend
607 * that virtual-root equals SCRIPT_NAME.
609 if (!ctx.cfg.virtual_root)
610 ctx.cfg.virtual_root = ctx.cfg.script_name;
612 /* If no url parameter is specified on the querystring, lets
613 * use PATH_INFO as url. This allows cgit to work with virtual
614 * urls without the need for rewriterules in the webserver (as
615 * long as PATH_INFO is included in the cache lookup key).
617 path = ctx.env.path_info;
618 if (!ctx.qry.url && path) {
621 ctx.qry.url = xstrdup(path);
624 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
627 ctx.qry.raw = xstrdup(ctx.qry.url);
628 cgit_parse_url(ctx.qry.url);
632 ctx.page.expires += ttl*60;
633 if (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD"))
636 ctx.cfg.cache_size = 0;
637 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
638 ctx.qry.raw, ttl, process_request, &ctx);
640 cgit_print_error(fmt("Error processing page: %s (%d)",
641 strerror(err), err));