all repos — cgit @ 0f0ab148c6d444316af10e6b4c7a60630fed45d3

a hyperfast web frontend for git written in c

ui-shared.c (view raw)

  1/* ui-shared.c: common web output functions
  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 "cmd.h"
 11#include "html.h"
 12
 13const char cgit_doctype[] =
 14"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n"
 15"  \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
 16
 17static char *http_date(time_t t)
 18{
 19	static char day[][4] =
 20		{"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
 21	static char month[][4] =
 22		{"Jan", "Feb", "Mar", "Apr", "May", "Jun",
 23		 "Jul", "Aug", "Sep", "Oct", "Now", "Dec"};
 24	struct tm *tm = gmtime(&t);
 25	return fmt("%s, %02d %s %04d %02d:%02d:%02d GMT", day[tm->tm_wday],
 26		   tm->tm_mday, month[tm->tm_mon], 1900+tm->tm_year,
 27		   tm->tm_hour, tm->tm_min, tm->tm_sec);
 28}
 29
 30void cgit_print_error(char *msg)
 31{
 32	html("<div class='error'>");
 33	html_txt(msg);
 34	html("</div>\n");
 35}
 36
 37char *cgit_rooturl()
 38{
 39	if (ctx.cfg.virtual_root)
 40		return fmt("%s/", ctx.cfg.virtual_root);
 41	else
 42		return ctx.cfg.script_name;
 43}
 44
 45char *cgit_repourl(const char *reponame)
 46{
 47	if (ctx.cfg.virtual_root) {
 48		return fmt("%s/%s/", ctx.cfg.virtual_root, reponame);
 49	} else {
 50		return fmt("?r=%s", reponame);
 51	}
 52}
 53
 54char *cgit_fileurl(const char *reponame, const char *pagename,
 55		   const char *filename, const char *query)
 56{
 57	char *tmp;
 58	char *delim;
 59
 60	if (ctx.cfg.virtual_root) {
 61		tmp = fmt("%s/%s/%s/%s", ctx.cfg.virtual_root, reponame,
 62			  pagename, (filename ? filename:""));
 63		delim = "?";
 64	} else {
 65		tmp = fmt("?url=%s/%s/%s", reponame, pagename,
 66			  (filename ? filename : ""));
 67		delim = "&";
 68	}
 69	if (query)
 70		tmp = fmt("%s%s%s", tmp, delim, query);
 71	return tmp;
 72}
 73
 74char *cgit_pageurl(const char *reponame, const char *pagename,
 75		   const char *query)
 76{
 77	return cgit_fileurl(reponame,pagename,0,query);
 78}
 79
 80const char *cgit_repobasename(const char *reponame)
 81{
 82	/* I assume we don't need to store more than one repo basename */
 83	static char rvbuf[1024];
 84	int p;
 85	const char *rv;
 86	strncpy(rvbuf,reponame,sizeof(rvbuf));
 87	if(rvbuf[sizeof(rvbuf)-1])
 88		die("cgit_repobasename: truncated repository name '%s'", reponame);
 89	p = strlen(rvbuf)-1;
 90	/* strip trailing slashes */
 91	while(p && rvbuf[p]=='/') rvbuf[p--]=0;
 92	/* strip trailing .git */
 93	if(p>=3 && !strncmp(&rvbuf[p-3],".git",4)) {
 94		p -= 3; rvbuf[p--] = 0;
 95	}
 96	/* strip more trailing slashes if any */
 97	while( p && rvbuf[p]=='/') rvbuf[p--]=0;
 98	/* find last slash in the remaining string */
 99	rv = strrchr(rvbuf,'/');
100	if(rv)
101		return ++rv;
102	return rvbuf;
103}
104
105char *cgit_currurl()
106{
107	if (!ctx.cfg.virtual_root)
108		return ctx.cfg.script_name;
109	else if (ctx.qry.page)
110		return fmt("%s/%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo, ctx.qry.page);
111	else if (ctx.qry.repo)
112		return fmt("%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo);
113	else
114		return fmt("%s/", ctx.cfg.virtual_root);
115}
116
117static void site_url(char *page, char *search, int ofs)
118{
119	char *delim = "?";
120
121	if (ctx.cfg.virtual_root) {
122		html_attr(ctx.cfg.virtual_root);
123		if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
124			html("/");
125	} else
126		html(ctx.cfg.script_name);
127
128	if (page) {
129		htmlf("?p=%s", page);
130		delim = "&";
131	}
132	if (search) {
133		html(delim);
134		html("q=");
135		html_attr(search);
136		delim = "&";
137	}
138	if (ofs) {
139		html(delim);
140		htmlf("ofs=%d", ofs);
141	}
142}
143
144static void site_link(char *page, char *name, char *title, char *class,
145		      char *search, int ofs)
146{
147	html("<a");
148	if (title) {
149		html(" title='");
150		html_attr(title);
151		html("'");
152	}
153	if (class) {
154		html(" class='");
155		html_attr(class);
156		html("'");
157	}
158	html(" href='");
159	site_url(page, search, ofs);
160	html("'>");
161	html_txt(name);
162	html("</a>");
163}
164
165void cgit_index_link(char *name, char *title, char *class, char *pattern,
166		     int ofs)
167{
168	site_link(NULL, name, title, class, pattern, ofs);
169}
170
171static char *repolink(char *title, char *class, char *page, char *head,
172		      char *path)
173{
174	char *delim = "?";
175
176	html("<a");
177	if (title) {
178		html(" title='");
179		html_attr(title);
180		html("'");
181	}
182	if (class) {
183		html(" class='");
184		html_attr(class);
185		html("'");
186	}
187	html(" href='");
188	if (ctx.cfg.virtual_root) {
189		html_attr(ctx.cfg.virtual_root);
190		if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
191			html("/");
192		html_attr(ctx.repo->url);
193		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
194			html("/");
195		if (page) {
196			html(page);
197			html("/");
198			if (path)
199				html_attr(path);
200		}
201	} else {
202		html(ctx.cfg.script_name);
203		html("?url=");
204		html_attr(ctx.repo->url);
205		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
206			html("/");
207		if (page) {
208			html(page);
209			html("/");
210			if (path)
211				html_attr(path);
212		}
213		delim = "&amp;";
214	}
215	if (head && strcmp(head, ctx.repo->defbranch)) {
216		html(delim);
217		html("h=");
218		html_attr(head);
219		delim = "&amp;";
220	}
221	return fmt("%s", delim);
222}
223
224static void reporevlink(char *page, char *name, char *title, char *class,
225			char *head, char *rev, char *path)
226{
227	char *delim;
228
229	delim = repolink(title, class, page, head, path);
230	if (rev && strcmp(rev, ctx.qry.head)) {
231		html(delim);
232		html("id=");
233		html_attr(rev);
234	}
235	html("'>");
236	html_txt(name);
237	html("</a>");
238}
239
240void cgit_tree_link(char *name, char *title, char *class, char *head,
241		    char *rev, char *path)
242{
243	reporevlink("tree", name, title, class, head, rev, path);
244}
245
246void cgit_log_link(char *name, char *title, char *class, char *head,
247		   char *rev, char *path, int ofs, char *grep, char *pattern)
248{
249	char *delim;
250
251	delim = repolink(title, class, "log", head, path);
252	if (rev && strcmp(rev, ctx.qry.head)) {
253		html(delim);
254		html("id=");
255		html_attr(rev);
256		delim = "&";
257	}
258	if (grep && pattern) {
259		html(delim);
260		html("qt=");
261		html_attr(grep);
262		delim = "&";
263		html(delim);
264		html("q=");
265		html_attr(pattern);
266	}
267	if (ofs > 0) {
268		html(delim);
269		html("ofs=");
270		htmlf("%d", ofs);
271	}
272	html("'>");
273	html_txt(name);
274	html("</a>");
275}
276
277void cgit_commit_link(char *name, char *title, char *class, char *head,
278		      char *rev)
279{
280	if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
281		name[ctx.cfg.max_msg_len] = '\0';
282		name[ctx.cfg.max_msg_len - 1] = '.';
283		name[ctx.cfg.max_msg_len - 2] = '.';
284		name[ctx.cfg.max_msg_len - 3] = '.';
285	}
286	reporevlink("commit", name, title, class, head, rev, NULL);
287}
288
289void cgit_refs_link(char *name, char *title, char *class, char *head,
290		    char *rev, char *path)
291{
292	reporevlink("refs", name, title, class, head, rev, path);
293}
294
295void cgit_snapshot_link(char *name, char *title, char *class, char *head,
296			char *rev, char *archivename)
297{
298	reporevlink("snapshot", name, title, class, head, rev, archivename);
299}
300
301void cgit_diff_link(char *name, char *title, char *class, char *head,
302		    char *new_rev, char *old_rev, char *path)
303{
304	char *delim;
305
306	delim = repolink(title, class, "diff", head, path);
307	if (new_rev && strcmp(new_rev, ctx.qry.head)) {
308		html(delim);
309		html("id=");
310		html_attr(new_rev);
311		delim = "&amp;";
312	}
313	if (old_rev) {
314		html(delim);
315		html("id2=");
316		html_attr(old_rev);
317	}
318	html("'>");
319	html_txt(name);
320	html("</a>");
321}
322
323void cgit_patch_link(char *name, char *title, char *class, char *head,
324		     char *rev)
325{
326	reporevlink("patch", name, title, class, head, rev, NULL);
327}
328
329void cgit_object_link(struct object *obj)
330{
331	char *page, *arg, *url;
332
333	if (obj->type == OBJ_COMMIT) {
334                cgit_commit_link(fmt("commit %s", sha1_to_hex(obj->sha1)), NULL, NULL,
335				 ctx.qry.head, sha1_to_hex(obj->sha1));
336		return;
337	} else if (obj->type == OBJ_TREE) {
338		page = "tree";
339		arg = "id";
340	} else if (obj->type == OBJ_TAG) {
341		page = "tag";
342		arg = "id";
343	} else {
344		page = "blob";
345		arg = "id";
346	}
347
348	url = cgit_pageurl(ctx.qry.repo, page,
349			   fmt("%s=%s", arg, sha1_to_hex(obj->sha1)));
350	html_link_open(url, NULL, NULL);
351	htmlf("%s %s", typename(obj->type),
352	      sha1_to_hex(obj->sha1));
353	html_link_close();
354}
355
356void cgit_print_date(time_t secs, char *format, int local_time)
357{
358	char buf[64];
359	struct tm *time;
360
361	if (!secs)
362		return;
363	if(local_time)
364		time = localtime(&secs);
365	else
366		time = gmtime(&secs);
367	strftime(buf, sizeof(buf)-1, format, time);
368	html_txt(buf);
369}
370
371void cgit_print_age(time_t t, time_t max_relative, char *format)
372{
373	time_t now, secs;
374
375	if (!t)
376		return;
377	time(&now);
378	secs = now - t;
379
380	if (secs > max_relative && max_relative >= 0) {
381		cgit_print_date(t, format, ctx.cfg.local_time);
382		return;
383	}
384
385	if (secs < TM_HOUR * 2) {
386		htmlf("<span class='age-mins'>%.0f min.</span>",
387		      secs * 1.0 / TM_MIN);
388		return;
389	}
390	if (secs < TM_DAY * 2) {
391		htmlf("<span class='age-hours'>%.0f hours</span>",
392		      secs * 1.0 / TM_HOUR);
393		return;
394	}
395	if (secs < TM_WEEK * 2) {
396		htmlf("<span class='age-days'>%.0f days</span>",
397		      secs * 1.0 / TM_DAY);
398		return;
399	}
400	if (secs < TM_MONTH * 2) {
401		htmlf("<span class='age-weeks'>%.0f weeks</span>",
402		      secs * 1.0 / TM_WEEK);
403		return;
404	}
405	if (secs < TM_YEAR * 2) {
406		htmlf("<span class='age-months'>%.0f months</span>",
407		      secs * 1.0 / TM_MONTH);
408		return;
409	}
410	htmlf("<span class='age-years'>%.0f years</span>",
411	      secs * 1.0 / TM_YEAR);
412}
413
414void cgit_print_http_headers(struct cgit_context *ctx)
415{
416	if (ctx->page.mimetype && ctx->page.charset)
417		htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
418		      ctx->page.charset);
419	else if (ctx->page.mimetype)
420		htmlf("Content-Type: %s\n", ctx->page.mimetype);
421	if (ctx->page.filename)
422		htmlf("Content-Disposition: inline; filename=\"%s\"\n",
423		      ctx->page.filename);
424	htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
425	htmlf("Expires: %s\n", http_date(ctx->page.expires));
426	html("\n");
427}
428
429void cgit_print_docstart(struct cgit_context *ctx)
430{
431	html(cgit_doctype);
432	html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
433	html("<head>\n");
434	html("<title>");
435	html_txt(ctx->page.title);
436	html("</title>\n");
437	htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
438	if (ctx->cfg.robots && *ctx->cfg.robots)
439		htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
440	html("<link rel='stylesheet' type='text/css' href='");
441	html_attr(ctx->cfg.css);
442	html("'/>\n");
443	if (ctx->cfg.favicon) {
444		html("<link rel='shortcut icon' href='");
445		html_attr(ctx->cfg.favicon);
446		html("'/>\n");
447	}
448	html("</head>\n");
449	html("<body>\n");
450}
451
452void cgit_print_docend()
453{
454	html("</div>");
455	if (ctx.cfg.footer)
456		html_include(ctx.cfg.footer);
457	else {
458		html("<div class='footer'>generated ");
459		cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
460		htmlf(" by cgit %s", cgit_version);
461		html("</div>\n");
462	}
463	html("</body>\n</html>\n");
464}
465
466int print_branch_option(const char *refname, const unsigned char *sha1,
467			int flags, void *cb_data)
468{
469	char *name = (char *)refname;
470	html_option(name, name, ctx.qry.head);
471	return 0;
472}
473
474int print_archive_ref(const char *refname, const unsigned char *sha1,
475		       int flags, void *cb_data)
476{
477	struct tag *tag;
478	struct taginfo *info;
479	struct object *obj;
480	char buf[256], *url;
481	unsigned char fileid[20];
482	int *header = (int *)cb_data;
483
484	if (prefixcmp(refname, "refs/archives"))
485		return 0;
486	strncpy(buf, refname+14, sizeof(buf));
487	obj = parse_object(sha1);
488	if (!obj)
489		return 1;
490	if (obj->type == OBJ_TAG) {
491		tag = lookup_tag(sha1);
492		if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
493			return 0;
494		hashcpy(fileid, tag->tagged->sha1);
495	} else if (obj->type != OBJ_BLOB) {
496		return 0;
497	} else {
498		hashcpy(fileid, sha1);
499	}
500	if (!*header) {
501		html("<h1>download</h1>\n");
502		*header = 1;
503	}
504	url = cgit_pageurl(ctx.qry.repo, "blob",
505			   fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
506			       buf));
507	html_link_open(url, NULL, "menu");
508	html_txt(strlpart(buf, 20));
509	html_link_close();
510	return 0;
511}
512
513void add_hidden_formfields(int incl_head, int incl_search, char *page)
514{
515	char *url;
516
517	if (!ctx.cfg.virtual_root) {
518		url = fmt("%s/%s", ctx.qry.repo, page);
519		if (ctx.qry.path)
520			url = fmt("%s/%s", url, ctx.qry.path);
521		html_hidden("url", url);
522	}
523
524	if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
525	    strcmp(ctx.qry.head, ctx.repo->defbranch))
526		html_hidden("h", ctx.qry.head);
527
528	if (ctx.qry.sha1)
529		html_hidden("id", ctx.qry.sha1);
530	if (ctx.qry.sha2)
531		html_hidden("id2", ctx.qry.sha2);
532
533	if (incl_search) {
534		if (ctx.qry.grep)
535			html_hidden("qt", ctx.qry.grep);
536		if (ctx.qry.search)
537			html_hidden("q", ctx.qry.search);
538	}
539}
540
541char *hc(struct cgit_cmd *cmd, const char *page)
542{
543	return (strcmp(cmd->name, page) ? NULL : "active");
544}
545
546void cgit_print_pageheader(struct cgit_context *ctx)
547{
548	struct cgit_cmd *cmd = cgit_get_cmd(ctx);
549
550	html("<table id='header'>\n");
551	html("<tr>\n");
552	html("<td class='logo' rowspan='2'><a href='");
553	if (ctx->cfg.logo_link)
554		html_attr(ctx->cfg.logo_link);
555	else
556		html_attr(cgit_rooturl());
557	html("'><img src='");
558	html_attr(ctx->cfg.logo);
559	html("' alt='cgit logo'/></a></td>\n");
560
561	html("<td class='main'>");
562	if (ctx->repo) {
563		cgit_index_link("index", NULL, NULL, NULL, 0);
564		html(" : ");
565		reporevlink(NULL, ctx->repo->name, NULL, hc(cmd, "summary"),
566			    ctx->qry.head, NULL, NULL);
567		html("</td><td class='form'>");
568		html("<form method='get' action=''>\n");
569		add_hidden_formfields(0, 1, ctx->qry.page);
570		html("<select name='h' onchange='this.form.submit();'>\n");
571		for_each_branch_ref(print_branch_option, ctx->qry.head);
572		html("</select> ");
573		html("<input type='submit' name='' value='switch'/>");
574		html("</form>");
575	} else
576		html_txt(ctx->cfg.root_title);
577	html("</td></tr>\n");
578
579	html("<tr><td class='sub'>");
580	if (ctx->repo) {
581		html_txt(ctx->repo->desc);
582		html("</td><td class='sub right'>");
583		html_txt(ctx->repo->owner);
584	} else {
585		if (ctx->cfg.root_desc)
586			html_txt(ctx->cfg.root_desc);
587		else if (ctx->cfg.index_info)
588			html_include(ctx->cfg.index_info);
589	}
590	html("</td></tr></table>\n");
591
592	html("<table class='tabs'><tr><td>\n");
593	if (ctx->repo) {
594		reporevlink(NULL, "summary", NULL, hc(cmd, "summary"),
595			    ctx->qry.head, NULL, NULL);
596		cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
597			       ctx->qry.sha1, NULL);
598		cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
599			      NULL, NULL, 0, NULL, NULL);
600		cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
601			       ctx->qry.sha1, NULL);
602		cgit_commit_link("commit", NULL, hc(cmd, "commit"),
603				 ctx->qry.head, ctx->qry.sha1);
604		cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
605			       ctx->qry.sha1, ctx->qry.sha2, NULL);
606		if (ctx->repo->readme)
607			reporevlink("about", "about", NULL,
608				    hc(cmd, "about"), ctx->qry.head, NULL,
609				    NULL);
610		html("</td><td class='form'>");
611		html("<form class='right' method='get' action='");
612		if (ctx->cfg.virtual_root)
613			html_attr(cgit_fileurl(ctx->qry.repo, "log",
614					       ctx->qry.path, NULL));
615		html("'>\n");
616		add_hidden_formfields(1, 0, "log");
617		html("<select name='qt'>\n");
618		html_option("grep", "log msg", ctx->qry.grep);
619		html_option("author", "author", ctx->qry.grep);
620		html_option("committer", "committer", ctx->qry.grep);
621		html("</select>\n");
622		html("<input class='txt' type='text' size='10' name='q' value='");
623		html_attr(ctx->qry.search);
624		html("'/>\n");
625		html("<input type='submit' value='search'/>\n");
626		html("</form>\n");
627	} else {
628		site_link(NULL, "index", NULL, hc(cmd, "repolist"), NULL, 0);
629		if (ctx->cfg.root_readme)
630			site_link("about", "about", NULL, hc(cmd, "about"),
631				  NULL, 0);
632		html("</td><td class='form'>");
633		html("<form method='get' action='");
634		html_attr(cgit_rooturl());
635		html("'>\n");
636		html("<input type='text' name='q' size='10' value='");
637		html_attr(ctx->qry.search);
638		html("'/>\n");
639		html("<input type='submit' value='search'/>\n");
640		html("</form>");
641	}
642	html("</td></tr></table>\n");
643	html("<div class='content'>");
644}
645
646void cgit_print_filemode(unsigned short mode)
647{
648	if (S_ISDIR(mode))
649		html("d");
650	else if (S_ISLNK(mode))
651		html("l");
652	else if (S_ISGITLINK(mode))
653		html("m");
654	else
655		html("-");
656	html_fileperm(mode >> 6);
657	html_fileperm(mode >> 3);
658	html_fileperm(mode);
659}
660
661void cgit_print_snapshot_links(const char *repo, const char *head,
662			       const char *hex, int snapshots)
663{
664	const struct cgit_snapshot_format* f;
665    	char *filename;
666
667	for (f = cgit_snapshot_formats; f->suffix; f++) {
668		if (!(snapshots & f->bit))
669			continue;
670		filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
671			       f->suffix);
672		cgit_snapshot_link(filename, NULL, NULL, (char *)head,
673				   (char *)hex, filename);
674		html("<br/>");
675	}
676}