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