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