all repos — cgit @ d3b2933cfead688036b354238e947c12916575b6

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 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}
210
211struct refmatch {
212	char *req_ref;
213	char *first_ref;
214	int match;
215};
216
217int find_current_ref(const char *refname, const unsigned char *sha1,
218		     int flags, void *cb_data)
219{
220	struct refmatch *info;
221
222	info = (struct refmatch *)cb_data;
223	if (!strcmp(refname, info->req_ref))
224		info->match = 1;
225	if (!info->first_ref)
226		info->first_ref = xstrdup(refname);
227	return info->match;
228}
229
230char *find_default_branch(struct cgit_repo *repo)
231{
232	struct refmatch info;
233	char *ref;
234
235	info.req_ref = repo->defbranch;
236	info.first_ref = NULL;
237	info.match = 0;
238	for_each_branch_ref(find_current_ref, &info);
239	if (info.match)
240		ref = info.req_ref;
241	else
242		ref = info.first_ref;
243	if (ref)
244		ref = xstrdup(ref);
245	return ref;
246}
247
248static int prepare_repo_cmd(struct cgit_context *ctx)
249{
250	char *tmp;
251	unsigned char sha1[20];
252	int nongit = 0;
253
254	setenv("GIT_DIR", ctx->repo->path, 1);
255	setup_git_directory_gently(&nongit);
256	if (nongit) {
257		ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
258				      "config error");
259		tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
260		ctx->repo = NULL;
261		cgit_print_http_headers(ctx);
262		cgit_print_docstart(ctx);
263		cgit_print_pageheader(ctx);
264		cgit_print_error(tmp);
265		cgit_print_docend();
266		return 1;
267	}
268	ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
269
270	if (!ctx->qry.head) {
271		ctx->qry.nohead = 1;
272		ctx->qry.head = find_default_branch(ctx->repo);
273		ctx->repo->defbranch = ctx->qry.head;
274	}
275
276	if (!ctx->qry.head) {
277		cgit_print_http_headers(ctx);
278		cgit_print_docstart(ctx);
279		cgit_print_pageheader(ctx);
280		cgit_print_error("Repository seems to be empty");
281		cgit_print_docend();
282		return 1;
283	}
284
285	if (get_sha1(ctx->qry.head, sha1)) {
286		tmp = xstrdup(ctx->qry.head);
287		ctx->qry.head = ctx->repo->defbranch;
288		cgit_print_http_headers(ctx);
289		cgit_print_docstart(ctx);
290		cgit_print_pageheader(ctx);
291		cgit_print_error(fmt("Invalid branch: %s", tmp));
292		cgit_print_docend();
293		return 1;
294	}
295	return 0;
296}
297
298static void process_request(void *cbdata)
299{
300	struct cgit_context *ctx = cbdata;
301	struct cgit_cmd *cmd;
302
303	cmd = cgit_get_cmd(ctx);
304	if (!cmd) {
305		ctx->page.title = "cgit error";
306		cgit_print_http_headers(ctx);
307		cgit_print_docstart(ctx);
308		cgit_print_pageheader(ctx);
309		cgit_print_error("Invalid request");
310		cgit_print_docend();
311		return;
312	}
313
314	if (cmd->want_repo && !ctx->repo) {
315		cgit_print_http_headers(ctx);
316		cgit_print_docstart(ctx);
317		cgit_print_pageheader(ctx);
318		cgit_print_error(fmt("No repository selected"));
319		cgit_print_docend();
320		return;
321	}
322
323	if (ctx->repo && prepare_repo_cmd(ctx))
324		return;
325
326	if (cmd->want_layout) {
327		cgit_print_http_headers(ctx);
328		cgit_print_docstart(ctx);
329		cgit_print_pageheader(ctx);
330	}
331
332	cmd->fn(ctx);
333
334	if (cmd->want_layout)
335		cgit_print_docend();
336}
337
338int cmp_repos(const void *a, const void *b)
339{
340	const struct cgit_repo *ra = a, *rb = b;
341	return strcmp(ra->url, rb->url);
342}
343
344void print_repo(struct cgit_repo *repo)
345{
346	printf("repo.url=%s\n", repo->url);
347	printf("repo.name=%s\n", repo->name);
348	printf("repo.path=%s\n", repo->path);
349	if (repo->owner)
350		printf("repo.owner=%s\n", repo->owner);
351	if (repo->desc)
352		printf("repo.desc=%s\n", repo->desc);
353	if (repo->readme)
354		printf("repo.readme=%s\n", repo->readme);
355	printf("\n");
356}
357
358void print_repolist(struct cgit_repolist *list)
359{
360	int i;
361
362	for(i = 0; i < list->count; i++)
363		print_repo(&list->repos[i]);
364}
365
366
367static void cgit_parse_args(int argc, const char **argv)
368{
369	int i;
370	int scan = 0;
371
372	for (i = 1; i < argc; i++) {
373		if (!strncmp(argv[i], "--cache=", 8)) {
374			ctx.cfg.cache_root = xstrdup(argv[i]+8);
375		}
376		if (!strcmp(argv[i], "--nocache")) {
377			ctx.cfg.nocache = 1;
378		}
379		if (!strncmp(argv[i], "--query=", 8)) {
380			ctx.qry.raw = xstrdup(argv[i]+8);
381		}
382		if (!strncmp(argv[i], "--repo=", 7)) {
383			ctx.qry.repo = xstrdup(argv[i]+7);
384		}
385		if (!strncmp(argv[i], "--page=", 7)) {
386			ctx.qry.page = xstrdup(argv[i]+7);
387		}
388		if (!strncmp(argv[i], "--head=", 7)) {
389			ctx.qry.head = xstrdup(argv[i]+7);
390			ctx.qry.has_symref = 1;
391		}
392		if (!strncmp(argv[i], "--sha1=", 7)) {
393			ctx.qry.sha1 = xstrdup(argv[i]+7);
394			ctx.qry.has_sha1 = 1;
395		}
396		if (!strncmp(argv[i], "--ofs=", 6)) {
397			ctx.qry.ofs = atoi(argv[i]+6);
398		}
399		if (!strncmp(argv[i], "--scan-tree=", 12)) {
400			scan++;
401			scan_tree(argv[i] + 12);
402		}
403	}
404	if (scan) {
405		qsort(cgit_repolist.repos, cgit_repolist.count,
406			sizeof(struct cgit_repo), cmp_repos);
407		print_repolist(&cgit_repolist);
408		exit(0);
409	}
410}
411
412static int calc_ttl()
413{
414	if (!ctx.repo)
415		return ctx.cfg.cache_root_ttl;
416
417	if (!ctx.qry.page)
418		return ctx.cfg.cache_repo_ttl;
419
420	if (ctx.qry.has_symref)
421		return ctx.cfg.cache_dynamic_ttl;
422
423	if (ctx.qry.has_sha1)
424		return ctx.cfg.cache_static_ttl;
425
426	return ctx.cfg.cache_repo_ttl;
427}
428
429int main(int argc, const char **argv)
430{
431	const char *cgit_config_env = getenv("CGIT_CONFIG");
432	const char *path;
433	char *qry;
434	int err, ttl;
435
436	prepare_context(&ctx);
437	cgit_repolist.length = 0;
438	cgit_repolist.count = 0;
439	cgit_repolist.repos = NULL;
440
441	if (getenv("SCRIPT_NAME"))
442		ctx.cfg.script_name = xstrdup(getenv("SCRIPT_NAME"));
443	if (getenv("QUERY_STRING"))
444		ctx.qry.raw = xstrdup(getenv("QUERY_STRING"));
445	cgit_parse_args(argc, argv);
446	parse_configfile(cgit_config_env ? cgit_config_env : CGIT_CONFIG,
447			 config_cb);
448	ctx.repo = NULL;
449	http_parse_querystring(ctx.qry.raw, querystring_cb);
450
451	/* If virtual-root isn't specified in cgitrc, lets pretend
452	 * that virtual-root equals SCRIPT_NAME.
453	 */
454	if (!ctx.cfg.virtual_root)
455		ctx.cfg.virtual_root = ctx.cfg.script_name;
456
457	/* If no url parameter is specified on the querystring, lets
458	 * use PATH_INFO as url. This allows cgit to work with virtual
459	 * urls without the need for rewriterules in the webserver (as
460	 * long as PATH_INFO is included in the cache lookup key).
461	 */
462	path = getenv("PATH_INFO");
463	if (!ctx.qry.url && path) {
464		if (path[0] == '/')
465			path++;
466		ctx.qry.url = xstrdup(path);
467		if (ctx.qry.raw) {
468			qry = ctx.qry.raw;
469			ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
470			free(qry);
471		} else
472			ctx.qry.raw = ctx.qry.url;
473		cgit_parse_url(ctx.qry.url);
474	}
475
476	ttl = calc_ttl();
477	ctx.page.expires += ttl*60;
478	if (ctx.cfg.nocache)
479		ctx.cfg.cache_size = 0;
480	err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
481			    ctx.qry.raw, ttl, process_request, &ctx);
482	if (err)
483		cgit_print_error(fmt("Error processing page: %s (%d)",
484				     strerror(err), err));
485	return err;
486}