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