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 (!value)
136 value = "";
137
138 if (!strcmp(name,"r")) {
139 ctx.qry.repo = xstrdup(value);
140 ctx.repo = cgit_get_repoinfo(value);
141 } else if (!strcmp(name, "p")) {
142 ctx.qry.page = xstrdup(value);
143 } else if (!strcmp(name, "url")) {
144 ctx.qry.url = xstrdup(value);
145 cgit_parse_url(value);
146 } else if (!strcmp(name, "qt")) {
147 ctx.qry.grep = xstrdup(value);
148 } else if (!strcmp(name, "q")) {
149 ctx.qry.search = xstrdup(value);
150 } else if (!strcmp(name, "h")) {
151 ctx.qry.head = xstrdup(value);
152 ctx.qry.has_symref = 1;
153 } else if (!strcmp(name, "id")) {
154 ctx.qry.sha1 = xstrdup(value);
155 ctx.qry.has_sha1 = 1;
156 } else if (!strcmp(name, "id2")) {
157 ctx.qry.sha2 = xstrdup(value);
158 ctx.qry.has_sha1 = 1;
159 } else if (!strcmp(name, "ofs")) {
160 ctx.qry.ofs = atoi(value);
161 } else if (!strcmp(name, "path")) {
162 ctx.qry.path = trim_end(value, '/');
163 } else if (!strcmp(name, "name")) {
164 ctx.qry.name = xstrdup(value);
165 } else if (!strcmp(name, "mimetype")) {
166 ctx.qry.mimetype = xstrdup(value);
167 } else if (!strcmp(name, "s")){
168 ctx.qry.sort = xstrdup(value);
169 } else if (!strcmp(name, "showmsg")) {
170 ctx.qry.showmsg = atoi(value);
171 } else if (!strcmp(name, "period")) {
172 ctx.qry.period = xstrdup(value);
173 }
174}
175
176static void prepare_context(struct cgit_context *ctx)
177{
178 memset(ctx, 0, sizeof(ctx));
179 ctx->cfg.agefile = "info/web/last-modified";
180 ctx->cfg.nocache = 0;
181 ctx->cfg.cache_size = 0;
182 ctx->cfg.cache_dynamic_ttl = 5;
183 ctx->cfg.cache_max_create_time = 5;
184 ctx->cfg.cache_repo_ttl = 5;
185 ctx->cfg.cache_root = CGIT_CACHE_ROOT;
186 ctx->cfg.cache_root_ttl = 5;
187 ctx->cfg.cache_static_ttl = -1;
188 ctx->cfg.css = "/cgit.css";
189 ctx->cfg.logo = "/git-logo.png";
190 ctx->cfg.local_time = 0;
191 ctx->cfg.max_repo_count = 50;
192 ctx->cfg.max_commit_count = 50;
193 ctx->cfg.max_lock_attempts = 5;
194 ctx->cfg.max_msg_len = 80;
195 ctx->cfg.max_repodesc_len = 80;
196 ctx->cfg.max_stats = 0;
197 ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
198 ctx->cfg.renamelimit = -1;
199 ctx->cfg.robots = "index, nofollow";
200 ctx->cfg.root_title = "Git repository browser";
201 ctx->cfg.root_desc = "a fast webinterface for the git dscm";
202 ctx->cfg.script_name = CGIT_SCRIPT_NAME;
203 ctx->cfg.summary_branches = 10;
204 ctx->cfg.summary_log = 10;
205 ctx->cfg.summary_tags = 10;
206 ctx->page.mimetype = "text/html";
207 ctx->page.charset = PAGE_ENCODING;
208 ctx->page.filename = NULL;
209 ctx->page.size = 0;
210 ctx->page.modified = time(NULL);
211 ctx->page.expires = ctx->page.modified;
212}
213
214struct refmatch {
215 char *req_ref;
216 char *first_ref;
217 int match;
218};
219
220int find_current_ref(const char *refname, const unsigned char *sha1,
221 int flags, void *cb_data)
222{
223 struct refmatch *info;
224
225 info = (struct refmatch *)cb_data;
226 if (!strcmp(refname, info->req_ref))
227 info->match = 1;
228 if (!info->first_ref)
229 info->first_ref = xstrdup(refname);
230 return info->match;
231}
232
233char *find_default_branch(struct cgit_repo *repo)
234{
235 struct refmatch info;
236 char *ref;
237
238 info.req_ref = repo->defbranch;
239 info.first_ref = NULL;
240 info.match = 0;
241 for_each_branch_ref(find_current_ref, &info);
242 if (info.match)
243 ref = info.req_ref;
244 else
245 ref = info.first_ref;
246 if (ref)
247 ref = xstrdup(ref);
248 return ref;
249}
250
251static int prepare_repo_cmd(struct cgit_context *ctx)
252{
253 char *tmp;
254 unsigned char sha1[20];
255 int nongit = 0;
256
257 setenv("GIT_DIR", ctx->repo->path, 1);
258 setup_git_directory_gently(&nongit);
259 if (nongit) {
260 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
261 "config error");
262 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
263 ctx->repo = NULL;
264 cgit_print_http_headers(ctx);
265 cgit_print_docstart(ctx);
266 cgit_print_pageheader(ctx);
267 cgit_print_error(tmp);
268 cgit_print_docend();
269 return 1;
270 }
271 ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
272
273 if (!ctx->qry.head) {
274 ctx->qry.nohead = 1;
275 ctx->qry.head = find_default_branch(ctx->repo);
276 ctx->repo->defbranch = ctx->qry.head;
277 }
278
279 if (!ctx->qry.head) {
280 cgit_print_http_headers(ctx);
281 cgit_print_docstart(ctx);
282 cgit_print_pageheader(ctx);
283 cgit_print_error("Repository seems to be empty");
284 cgit_print_docend();
285 return 1;
286 }
287
288 if (get_sha1(ctx->qry.head, sha1)) {
289 tmp = xstrdup(ctx->qry.head);
290 ctx->qry.head = ctx->repo->defbranch;
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 *path;
436 char *qry;
437 int err, ttl;
438
439 prepare_context(&ctx);
440 cgit_repolist.length = 0;
441 cgit_repolist.count = 0;
442 cgit_repolist.repos = NULL;
443
444 if (getenv("SCRIPT_NAME"))
445 ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
446 if (getenv("QUERY_STRING"))
447 ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
448 cgit_parse_args(argc, argv);
449 parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
450 config_cb);
451 ctx.repo = NULL;
452 http_parse_querystring(ctx.qry.raw, querystring_cb);
453
454 /* If virtual-root isn't specified in cgitrc, lets pretend
455 * that virtual-root equals SCRIPT_NAME.
456 */
457 if (!ctx.cfg.virtual_root)
458 ctx.cfg.virtual_root = ctx.cfg.script_name;
459
460 /* If no url parameter is specified on the querystring, lets
461 * use PATH_INFO as url. This allows cgit to work with virtual
462 * urls without the need for rewriterules in the webserver (as
463 * long as PATH_INFO is included in the cache lookup key).
464 */
465 path = getenv("PATH_INFO");
466 if (!ctx.qry.url && path) {
467 if (path[0] == '/')
468 path++;
469 ctx.qry.url = xstrdup(path);
470 if (ctx.qry.raw) {
471 qry = ctx.qry.raw;
472 ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
473 free(qry);
474 } else
475 ctx.qry.raw = ctx.qry.url;
476 cgit_parse_url(ctx.qry.url);
477 }
478
479 ttl = calc_ttl();
480 ctx.page.expires += ttl*60;
481 if (ctx.cfg.nocache)
482 ctx.cfg.cache_size = 0;
483 err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
484 ctx.qry.raw, ttl, process_request, &ctx);
485 if (err)
486 cgit_print_error(fmt("Error processing page: %s (%d)",
487 strerror(err), err));
488 return err;
489}