cgit.c (view raw)
1/* cgit.c: cgi for the git scm
2 *
3 * Copyright (C) 2006 Lars Hjemli
4 *
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
7 */
8
9#include "cgit.h"
10#include "cache.h"
11#include "cmd.h"
12#include "configfile.h"
13#include "html.h"
14#include "ui-shared.h"
15#include "ui-stats.h"
16#include "scan-tree.h"
17
18const char *cgit_version = CGIT_VERSION;
19
20void add_mimetype(const char *name, const char *value)
21{
22 struct string_list_item *item;
23
24 item = string_list_insert(xstrdup(name), &ctx.cfg.mimetypes);
25 item->util = xstrdup(value);
26}
27
28struct cgit_filter *new_filter(const char *cmd, int extra_args)
29{
30 struct cgit_filter *f;
31
32 if (!cmd || !cmd[0])
33 return NULL;
34
35 f = xmalloc(sizeof(struct cgit_filter));
36 f->cmd = xstrdup(cmd);
37 f->argv = xmalloc((2 + extra_args) * sizeof(char *));
38 f->argv[0] = f->cmd;
39 f->argv[1] = NULL;
40 return f;
41}
42
43void config_cb(const char *name, const char *value)
44{
45 if (!strcmp(name, "root-title"))
46 ctx.cfg.root_title = xstrdup(value);
47 else if (!strcmp(name, "root-desc"))
48 ctx.cfg.root_desc = xstrdup(value);
49 else if (!strcmp(name, "root-readme"))
50 ctx.cfg.root_readme = xstrdup(value);
51 else if (!strcmp(name, "css"))
52 ctx.cfg.css = xstrdup(value);
53 else if (!strcmp(name, "favicon"))
54 ctx.cfg.favicon = xstrdup(value);
55 else if (!strcmp(name, "footer"))
56 ctx.cfg.footer = xstrdup(value);
57 else if (!strcmp(name, "head-include"))
58 ctx.cfg.head_include = xstrdup(value);
59 else if (!strcmp(name, "header"))
60 ctx.cfg.header = xstrdup(value);
61 else if (!strcmp(name, "logo"))
62 ctx.cfg.logo = xstrdup(value);
63 else if (!strcmp(name, "index-header"))
64 ctx.cfg.index_header = xstrdup(value);
65 else if (!strcmp(name, "index-info"))
66 ctx.cfg.index_info = xstrdup(value);
67 else if (!strcmp(name, "logo-link"))
68 ctx.cfg.logo_link = xstrdup(value);
69 else if (!strcmp(name, "module-link"))
70 ctx.cfg.module_link = xstrdup(value);
71 else if (!strcmp(name, "virtual-root")) {
72 ctx.cfg.virtual_root = trim_end(value, '/');
73 if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
74 ctx.cfg.virtual_root = "";
75 } else if (!strcmp(name, "nocache"))
76 ctx.cfg.nocache = atoi(value);
77 else if (!strcmp(name, "noplainemail"))
78 ctx.cfg.noplainemail = atoi(value);
79 else if (!strcmp(name, "noheader"))
80 ctx.cfg.noheader = atoi(value);
81 else if (!strcmp(name, "snapshots"))
82 ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
83 else if (!strcmp(name, "enable-index-links"))
84 ctx.cfg.enable_index_links = atoi(value);
85 else if (!strcmp(name, "enable-log-filecount"))
86 ctx.cfg.enable_log_filecount = atoi(value);
87 else if (!strcmp(name, "enable-log-linecount"))
88 ctx.cfg.enable_log_linecount = atoi(value);
89 else if (!strcmp(name, "max-stats"))
90 ctx.cfg.max_stats = cgit_find_stats_period(value, NULL);
91 else if (!strcmp(name, "cache-size"))
92 ctx.cfg.cache_size = atoi(value);
93 else if (!strcmp(name, "cache-root"))
94 ctx.cfg.cache_root = xstrdup(value);
95 else if (!strcmp(name, "cache-root-ttl"))
96 ctx.cfg.cache_root_ttl = atoi(value);
97 else if (!strcmp(name, "cache-repo-ttl"))
98 ctx.cfg.cache_repo_ttl = atoi(value);
99 else if (!strcmp(name, "cache-static-ttl"))
100 ctx.cfg.cache_static_ttl = atoi(value);
101 else if (!strcmp(name, "cache-dynamic-ttl"))
102 ctx.cfg.cache_dynamic_ttl = atoi(value);
103 else if (!strcmp(name, "commit-filter"))
104 ctx.cfg.commit_filter = new_filter(value, 0);
105 else if (!strcmp(name, "embedded"))
106 ctx.cfg.embedded = atoi(value);
107 else if (!strcmp(name, "max-message-length"))
108 ctx.cfg.max_msg_len = atoi(value);
109 else if (!strcmp(name, "max-repodesc-length"))
110 ctx.cfg.max_repodesc_len = atoi(value);
111 else if (!strcmp(name, "max-repo-count"))
112 ctx.cfg.max_repo_count = atoi(value);
113 else if (!strcmp(name, "max-commit-count"))
114 ctx.cfg.max_commit_count = atoi(value);
115 else if (!strcmp(name, "source-filter"))
116 ctx.cfg.source_filter = new_filter(value, 1);
117 else if (!strcmp(name, "summary-log"))
118 ctx.cfg.summary_log = atoi(value);
119 else if (!strcmp(name, "summary-branches"))
120 ctx.cfg.summary_branches = atoi(value);
121 else if (!strcmp(name, "summary-tags"))
122 ctx.cfg.summary_tags = atoi(value);
123 else if (!strcmp(name, "agefile"))
124 ctx.cfg.agefile = xstrdup(value);
125 else if (!strcmp(name, "renamelimit"))
126 ctx.cfg.renamelimit = atoi(value);
127 else if (!strcmp(name, "robots"))
128 ctx.cfg.robots = xstrdup(value);
129 else if (!strcmp(name, "clone-prefix"))
130 ctx.cfg.clone_prefix = xstrdup(value);
131 else if (!strcmp(name, "local-time"))
132 ctx.cfg.local_time = atoi(value);
133 else if (!prefixcmp(name, "mimetype."))
134 add_mimetype(name + 9, value);
135 else if (!strcmp(name, "repo.group"))
136 ctx.cfg.repo_group = xstrdup(value);
137 else if (!strcmp(name, "repo.url"))
138 ctx.repo = cgit_add_repo(value);
139 else if (!strcmp(name, "repo.name"))
140 ctx.repo->name = xstrdup(value);
141 else if (ctx.repo && !strcmp(name, "repo.path"))
142 ctx.repo->path = trim_end(value, '/');
143 else if (ctx.repo && !strcmp(name, "repo.clone-url"))
144 ctx.repo->clone_url = xstrdup(value);
145 else if (ctx.repo && !strcmp(name, "repo.desc"))
146 ctx.repo->desc = xstrdup(value);
147 else if (ctx.repo && !strcmp(name, "repo.owner"))
148 ctx.repo->owner = xstrdup(value);
149 else if (ctx.repo && !strcmp(name, "repo.defbranch"))
150 ctx.repo->defbranch = xstrdup(value);
151 else if (ctx.repo && !strcmp(name, "repo.snapshots"))
152 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
153 else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
154 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
155 else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
156 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
157 else if (ctx.repo && !strcmp(name, "repo.max-stats"))
158 ctx.repo->max_stats = cgit_find_stats_period(value, NULL);
159 else if (ctx.repo && !strcmp(name, "repo.module-link"))
160 ctx.repo->module_link= xstrdup(value);
161 else if (ctx.repo && !strcmp(name, "repo.commit-filter"))
162 ctx.repo->commit_filter = new_filter(value, 0);
163 else if (ctx.repo && !strcmp(name, "repo.source-filter"))
164 ctx.repo->source_filter = new_filter(value, 1);
165 else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
166 if (*value == '/')
167 ctx.repo->readme = xstrdup(value);
168 else
169 ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
170 } else if (!strcmp(name, "include"))
171 parse_configfile(value, config_cb);
172}
173
174static void querystring_cb(const char *name, const char *value)
175{
176 if (!strcmp(name,"r")) {
177 ctx.qry.repo = xstrdup(value);
178 ctx.repo = cgit_get_repoinfo(value);
179 } else if (!strcmp(name, "p")) {
180 ctx.qry.page = xstrdup(value);
181 } else if (!strcmp(name, "url")) {
182 ctx.qry.url = xstrdup(value);
183 cgit_parse_url(value);
184 } else if (!strcmp(name, "qt")) {
185 ctx.qry.grep = xstrdup(value);
186 } else if (!strcmp(name, "q")) {
187 ctx.qry.search = xstrdup(value);
188 } else if (!strcmp(name, "h")) {
189 ctx.qry.head = xstrdup(value);
190 ctx.qry.has_symref = 1;
191 } else if (!strcmp(name, "id")) {
192 ctx.qry.sha1 = xstrdup(value);
193 ctx.qry.has_sha1 = 1;
194 } else if (!strcmp(name, "id2")) {
195 ctx.qry.sha2 = xstrdup(value);
196 ctx.qry.has_sha1 = 1;
197 } else if (!strcmp(name, "ofs")) {
198 ctx.qry.ofs = atoi(value);
199 } else if (!strcmp(name, "path")) {
200 ctx.qry.path = trim_end(value, '/');
201 } else if (!strcmp(name, "name")) {
202 ctx.qry.name = xstrdup(value);
203 } else if (!strcmp(name, "mimetype")) {
204 ctx.qry.mimetype = xstrdup(value);
205 } else if (!strcmp(name, "s")){
206 ctx.qry.sort = xstrdup(value);
207 } else if (!strcmp(name, "showmsg")) {
208 ctx.qry.showmsg = atoi(value);
209 } else if (!strcmp(name, "period")) {
210 ctx.qry.period = xstrdup(value);
211 }
212}
213
214static void prepare_context(struct cgit_context *ctx)
215{
216 memset(ctx, 0, sizeof(ctx));
217 ctx->cfg.agefile = "info/web/last-modified";
218 ctx->cfg.nocache = 0;
219 ctx->cfg.cache_size = 0;
220 ctx->cfg.cache_dynamic_ttl = 5;
221 ctx->cfg.cache_max_create_time = 5;
222 ctx->cfg.cache_repo_ttl = 5;
223 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
224 ctx->cfg.cache_root_ttl = 5;
225 ctx->cfg.cache_static_ttl = -1;
226 ctx->cfg.css = "/cgit.css";
227 ctx->cfg.logo = "/git-logo.png";
228 ctx->cfg.local_time = 0;
229 ctx->cfg.max_repo_count = 50;
230 ctx->cfg.max_commit_count = 50;
231 ctx->cfg.max_lock_attempts = 5;
232 ctx->cfg.max_msg_len = 80;
233 ctx->cfg.max_repodesc_len = 80;
234 ctx->cfg.max_stats = 0;
235 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
236 ctx->cfg.renamelimit = -1;
237 ctx->cfg.robots = "index, nofollow";
238 ctx->cfg.root_title = "Git repository browser";
239 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
240 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
241 ctx->cfg.summary_branches = 10;
242 ctx->cfg.summary_log = 10;
243 ctx->cfg.summary_tags = 10;
244 ctx->page.mimetype = "text/html";
245 ctx->page.charset = PAGE_ENCODING;
246 ctx->page.filename = NULL;
247 ctx->page.size = 0;
248 ctx->page.modified = time(NULL);
249 ctx->page.expires = ctx->page.modified;
250 ctx->page.etag = NULL;
251 memset(&ctx->cfg.mimetypes, 0, sizeof(struct string_list));
252}
253
254struct refmatch {
255 char *req_ref;
256 char *first_ref;
257 int match;
258};
259
260int find_current_ref(const char *refname, const unsigned char *sha1,
261 int flags, void *cb_data)
262{
263 struct refmatch *info;
264
265 info = (struct refmatch *)cb_data;
266 if (!strcmp(refname, info->req_ref))
267 info->match = 1;
268 if (!info->first_ref)
269 info->first_ref = xstrdup(refname);
270 return info->match;
271}
272
273char *find_default_branch(struct cgit_repo *repo)
274{
275 struct refmatch info;
276 char *ref;
277
278 info.req_ref = repo->defbranch;
279 info.first_ref = NULL;
280 info.match = 0;
281 for_each_branch_ref(find_current_ref, &info);
282 if (info.match)
283 ref = info.req_ref;
284 else
285 ref = info.first_ref;
286 if (ref)
287 ref = xstrdup(ref);
288 return ref;
289}
290
291static int prepare_repo_cmd(struct cgit_context *ctx)
292{
293 char *tmp;
294 unsigned char sha1[20];
295 int nongit = 0;
296
297 setenv("GIT_DIR", ctx->repo->path, 1);
298 setup_git_directory_gently(&nongit);
299 if (nongit) {
300 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
301 "config error");
302 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
303 ctx->repo = NULL;
304 cgit_print_http_headers(ctx);
305 cgit_print_docstart(ctx);
306 cgit_print_pageheader(ctx);
307 cgit_print_error(tmp);
308 cgit_print_docend();
309 return 1;
310 }
311 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
312
313 if (!ctx->qry.head) {
314 ctx->qry.nohead = 1;
315 ctx->qry.head = find_default_branch(ctx->repo);
316 ctx->repo->defbranch = ctx->qry.head;
317 }
318
319 if (!ctx->qry.head) {
320 cgit_print_http_headers(ctx);
321 cgit_print_docstart(ctx);
322 cgit_print_pageheader(ctx);
323 cgit_print_error("Repository seems to be empty");
324 cgit_print_docend();
325 return 1;
326 }
327
328 if (get_sha1(ctx->qry.head, sha1)) {
329 tmp = xstrdup(ctx->qry.head);
330 ctx->qry.head = ctx->repo->defbranch;
331 ctx->page.status = 404;
332 ctx->page.statusmsg = "not found";
333 cgit_print_http_headers(ctx);
334 cgit_print_docstart(ctx);
335 cgit_print_pageheader(ctx);
336 cgit_print_error(fmt("Invalid branch: %s", tmp));
337 cgit_print_docend();
338 return 1;
339 }
340 return 0;
341}
342
343static void process_request(void *cbdata)
344{
345 struct cgit_context *ctx = cbdata;
346 struct cgit_cmd *cmd;
347
348 cmd = cgit_get_cmd(ctx);
349 if (!cmd) {
350 ctx->page.title = "cgit error";
351 cgit_print_http_headers(ctx);
352 cgit_print_docstart(ctx);
353 cgit_print_pageheader(ctx);
354 cgit_print_error("Invalid request");
355 cgit_print_docend();
356 return;
357 }
358
359 if (cmd->want_repo && !ctx->repo) {
360 cgit_print_http_headers(ctx);
361 cgit_print_docstart(ctx);
362 cgit_print_pageheader(ctx);
363 cgit_print_error(fmt("No repository selected"));
364 cgit_print_docend();
365 return;
366 }
367
368 if (ctx->repo && prepare_repo_cmd(ctx))
369 return;
370
371 if (cmd->want_layout) {
372 cgit_print_http_headers(ctx);
373 cgit_print_docstart(ctx);
374 cgit_print_pageheader(ctx);
375 }
376
377 cmd->fn(ctx);
378
379 if (cmd->want_layout)
380 cgit_print_docend();
381}
382
383int cmp_repos(const void *a, const void *b)
384{
385 const struct cgit_repo *ra = a, *rb = b;
386 return strcmp(ra->url, rb->url);
387}
388
389void print_repo(struct cgit_repo *repo)
390{
391 printf("repo.url=%s\n", repo->url);
392 printf("repo.name=%s\n", repo->name);
393 printf("repo.path=%s\n", repo->path);
394 if (repo->owner)
395 printf("repo.owner=%s\n", repo->owner);
396 if (repo->desc)
397 printf("repo.desc=%s\n", repo->desc);
398 if (repo->readme)
399 printf("repo.readme=%s\n", repo->readme);
400 printf("\n");
401}
402
403void print_repolist(struct cgit_repolist *list)
404{
405 int i;
406
407 for(i = 0; i < list->count; i++)
408 print_repo(&list->repos[i]);
409}
410
411
412static void cgit_parse_args(int argc, const char **argv)
413{
414 int i;
415 int scan = 0;
416
417 for (i = 1; i < argc; i++) {
418 if (!strncmp(argv[i], "--cache=", 8)) {
419 ctx.cfg.cache_root = xstrdup(argv[i]+8);
420 }
421 if (!strcmp(argv[i], "--nocache")) {
422 ctx.cfg.nocache = 1;
423 }
424 if (!strncmp(argv[i], "--query=", 8)) {
425 ctx.qry.raw = xstrdup(argv[i]+8);
426 }
427 if (!strncmp(argv[i], "--repo=", 7)) {
428 ctx.qry.repo = xstrdup(argv[i]+7);
429 }
430 if (!strncmp(argv[i], "--page=", 7)) {
431 ctx.qry.page = xstrdup(argv[i]+7);
432 }
433 if (!strncmp(argv[i], "--head=", 7)) {
434 ctx.qry.head = xstrdup(argv[i]+7);
435 ctx.qry.has_symref = 1;
436 }
437 if (!strncmp(argv[i], "--sha1=", 7)) {
438 ctx.qry.sha1 = xstrdup(argv[i]+7);
439 ctx.qry.has_sha1 = 1;
440 }
441 if (!strncmp(argv[i], "--ofs=", 6)) {
442 ctx.qry.ofs = atoi(argv[i]+6);
443 }
444 if (!strncmp(argv[i], "--scan-tree=", 12)) {
445 scan++;
446 scan_tree(argv[i] + 12);
447 }
448 }
449 if (scan) {
450 qsort(cgit_repolist.repos, cgit_repolist.count,
451 sizeof(struct cgit_repo), cmp_repos);
452 print_repolist(&cgit_repolist);
453 exit(0);
454 }
455}
456
457static int calc_ttl()
458{
459 if (!ctx.repo)
460 return ctx.cfg.cache_root_ttl;
461
462 if (!ctx.qry.page)
463 return ctx.cfg.cache_repo_ttl;
464
465 if (ctx.qry.has_symref)
466 return ctx.cfg.cache_dynamic_ttl;
467
468 if (ctx.qry.has_sha1)
469 return ctx.cfg.cache_static_ttl;
470
471 return ctx.cfg.cache_repo_ttl;
472}
473
474int main(int argc, const char **argv)
475{
476 const char *cgit_config_env = getenv("CGIT_CONFIG");
477 const char *method = getenv("REQUEST_METHOD");
478 const char *path;
479 char *qry;
480 int err, ttl;
481
482 prepare_context(&ctx);
483 cgit_repolist.length = 0;
484 cgit_repolist.count = 0;
485 cgit_repolist.repos = NULL;
486
487 if (getenv("SCRIPT_NAME"))
488 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
489 if (getenv("QUERY_STRING"))
490 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
491 cgit_parse_args(argc, argv);
492 parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
493 config_cb);
494 ctx.repo = NULL;
495 http_parse_querystring(ctx.qry.raw, querystring_cb);
496
497 /* If virtual-root isn't specified in cgitrc, lets pretend
498 * that virtual-root equals SCRIPT_NAME.
499 */
500 if (!ctx.cfg.virtual_root)
501 ctx.cfg.virtual_root = ctx.cfg.script_name;
502
503 /* If no url parameter is specified on the querystring, lets
504 * use PATH_INFO as url. This allows cgit to work with virtual
505 * urls without the need for rewriterules in the webserver (as
506 * long as PATH_INFO is included in the cache lookup key).
507 */
508 path = getenv("PATH_INFO");
509 if (!ctx.qry.url && path) {
510 if (path[0] == '/')
511 path++;
512 ctx.qry.url = xstrdup(path);
513 if (ctx.qry.raw) {
514 qry = ctx.qry.raw;
515 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
516 free(qry);
517 } else
518 ctx.qry.raw = ctx.qry.url;
519 cgit_parse_url(ctx.qry.url);
520 }
521
522 ttl = calc_ttl();
523 ctx.page.expires += ttl*60;
524 if (method && !strcmp(method, "HEAD"))
525 ctx.cfg.nocache = 1;
526 if (ctx.cfg.nocache)
527 ctx.cfg.cache_size = 0;
528 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
529 ctx.qry.raw, ttl, process_request, &ctx);
530 if (err)
531 cgit_print_error(fmt("Error processing page: %s (%d)",
532 strerror(err), err));
533 return err;
534}