all repos — cgit @ db8b8cb9467625cb8d9ecb67863aa67590e59cc0

a hyperfast web frontend for git written in c

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