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