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