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