1 /* ui-shared.c: common web output functions
3 * Copyright (C) 2006 Lars Hjemli
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
13 const 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";
17 static char *http_date(time_t t)
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", "Nov", "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);
30 void cgit_print_error(const char *msg)
32 html("<div class='error'>");
37 char *cgit_httpscheme()
39 if (ctx.env.https && !strcmp(ctx.env.https, "on"))
47 if (ctx.env.http_host)
48 return ctx.env.http_host;
49 if (!ctx.env.server_name)
51 if (!ctx.env.server_port || atoi(ctx.env.server_port) == 80)
52 return ctx.env.server_name;
53 return xstrdup(fmt("%s:%s", ctx.env.server_name, ctx.env.server_port));
58 if (ctx.cfg.virtual_root)
59 return fmt("%s/", ctx.cfg.virtual_root);
61 return ctx.cfg.script_name;
64 char *cgit_repourl(const char *reponame)
66 if (ctx.cfg.virtual_root) {
67 return fmt("%s/%s/", ctx.cfg.virtual_root, reponame);
69 return fmt("?r=%s", reponame);
73 char *cgit_fileurl(const char *reponame, const char *pagename,
74 const char *filename, const char *query)
79 if (ctx.cfg.virtual_root) {
80 tmp = fmt("%s/%s/%s/%s", ctx.cfg.virtual_root, reponame,
81 pagename, (filename ? filename:""));
84 tmp = fmt("?url=%s/%s/%s", reponame, pagename,
85 (filename ? filename : ""));
89 tmp = fmt("%s%s%s", tmp, delim, query);
93 char *cgit_pageurl(const char *reponame, const char *pagename,
96 return cgit_fileurl(reponame, pagename, 0, query);
99 const char *cgit_repobasename(const char *reponame)
101 /* I assume we don't need to store more than one repo basename */
102 static char rvbuf[1024];
105 strncpy(rvbuf, reponame, sizeof(rvbuf));
106 if (rvbuf[sizeof(rvbuf)-1])
107 die("cgit_repobasename: truncated repository name '%s'", reponame);
109 /* strip trailing slashes */
110 while (p && rvbuf[p] == '/') rvbuf[p--] = 0;
111 /* strip trailing .git */
112 if (p >= 3 && !strncmp(&rvbuf[p-3], ".git", 4)) {
113 p -= 3; rvbuf[p--] = 0;
115 /* strip more trailing slashes if any */
116 while ( p && rvbuf[p] == '/') rvbuf[p--] = 0;
117 /* find last slash in the remaining string */
118 rv = strrchr(rvbuf,'/');
124 static void site_url(const char *page, const char *search, const char *sort, int ofs)
128 if (ctx.cfg.virtual_root) {
129 html_attr(ctx.cfg.virtual_root);
130 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
133 html(ctx.cfg.script_name);
136 htmlf("?p=%s", page);
153 htmlf("ofs=%d", ofs);
157 static void site_link(const char *page, const char *name, const char *title,
158 const char *class, const char *search, const char *sort, int ofs)
172 site_url(page, search, sort, ofs);
178 void cgit_index_link(const char *name, const char *title, const char *class,
179 const char *pattern, const char *sort, int ofs)
181 site_link(NULL, name, title, class, pattern, sort, ofs);
184 static char *repolink(const char *title, const char *class, const char *page,
185 const char *head, const char *path)
201 if (ctx.cfg.virtual_root) {
202 html_url_path(ctx.cfg.virtual_root);
203 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
205 html_url_path(ctx.repo->url);
206 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
215 html(ctx.cfg.script_name);
217 html_url_arg(ctx.repo->url);
218 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
228 if (head && strcmp(head, ctx.repo->defbranch)) {
234 return fmt("%s", delim);
237 static void reporevlink(const char *page, const char *name, const char *title,
238 const char *class, const char *head, const char *rev,
243 delim = repolink(title, class, page, head, path);
244 if (rev && ctx.qry.head != NULL && strcmp(rev, ctx.qry.head)) {
254 void cgit_summary_link(const char *name, const char *title, const char *class,
257 reporevlink(NULL, name, title, class, head, NULL, NULL);
260 void cgit_tag_link(const char *name, const char *title, const char *class,
261 const char *head, const char *rev)
263 reporevlink("tag", name, title, class, head, rev, NULL);
266 void cgit_tree_link(const char *name, const char *title, const char *class,
267 const char *head, const char *rev, const char *path)
269 reporevlink("tree", name, title, class, head, rev, path);
272 void cgit_plain_link(const char *name, const char *title, const char *class,
273 const char *head, const char *rev, const char *path)
275 reporevlink("plain", name, title, class, head, rev, path);
278 void cgit_log_link(const char *name, const char *title, const char *class,
279 const char *head, const char *rev, const char *path,
280 int ofs, const char *grep, const char *pattern, int showmsg)
284 delim = repolink(title, class, "log", head, path);
285 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
291 if (grep && pattern) {
298 html_url_arg(pattern);
315 void cgit_commit_link(char *name, const char *title, const char *class,
316 const char *head, const char *rev, const char *path,
319 if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
320 name[ctx.cfg.max_msg_len] = '\0';
321 name[ctx.cfg.max_msg_len - 1] = '.';
322 name[ctx.cfg.max_msg_len - 2] = '.';
323 name[ctx.cfg.max_msg_len - 3] = '.';
328 delim = repolink(title, class, "commit", head, path);
329 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
335 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
340 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
343 htmlf("%d", ctx.qry.context);
346 if (ctx.qry.ignorews) {
355 html_txt("(no commit message)");
359 void cgit_refs_link(const char *name, const char *title, const char *class,
360 const char *head, const char *rev, const char *path)
362 reporevlink("refs", name, title, class, head, rev, path);
365 void cgit_snapshot_link(const char *name, const char *title, const char *class,
366 const char *head, const char *rev,
367 const char *archivename)
369 reporevlink("snapshot", name, title, class, head, rev, archivename);
372 void cgit_diff_link(const char *name, const char *title, const char *class,
373 const char *head, const char *new_rev, const char *old_rev,
374 const char *path, int toggle_ssdiff)
378 delim = repolink(title, class, "diff", head, path);
379 if (new_rev && ctx.qry.head != NULL && strcmp(new_rev, ctx.qry.head)) {
382 html_url_arg(new_rev);
388 html_url_arg(old_rev);
391 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
396 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
399 htmlf("%d", ctx.qry.context);
402 if (ctx.qry.ignorews) {
412 void cgit_patch_link(const char *name, const char *title, const char *class,
413 const char *head, const char *rev, const char *path)
415 reporevlink("patch", name, title, class, head, rev, path);
418 void cgit_stats_link(const char *name, const char *title, const char *class,
419 const char *head, const char *path)
421 reporevlink("stats", name, title, class, head, NULL, path);
424 static void cgit_self_link(char *name, const char *title, const char *class,
425 struct cgit_context *ctx)
427 if (!strcmp(ctx->qry.page, "repolist"))
428 cgit_index_link(name, title, class, ctx->qry.search, ctx->qry.sort,
430 else if (!strcmp(ctx->qry.page, "summary"))
431 cgit_summary_link(name, title, class, ctx->qry.head);
432 else if (!strcmp(ctx->qry.page, "tag"))
433 cgit_tag_link(name, title, class, ctx->qry.head,
434 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL);
435 else if (!strcmp(ctx->qry.page, "tree"))
436 cgit_tree_link(name, title, class, ctx->qry.head,
437 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
439 else if (!strcmp(ctx->qry.page, "plain"))
440 cgit_plain_link(name, title, class, ctx->qry.head,
441 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
443 else if (!strcmp(ctx->qry.page, "log"))
444 cgit_log_link(name, title, class, ctx->qry.head,
445 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
446 ctx->qry.path, ctx->qry.ofs,
447 ctx->qry.grep, ctx->qry.search,
449 else if (!strcmp(ctx->qry.page, "commit"))
450 cgit_commit_link(name, title, class, ctx->qry.head,
451 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
453 else if (!strcmp(ctx->qry.page, "patch"))
454 cgit_patch_link(name, title, class, ctx->qry.head,
455 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
457 else if (!strcmp(ctx->qry.page, "refs"))
458 cgit_refs_link(name, title, class, ctx->qry.head,
459 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
461 else if (!strcmp(ctx->qry.page, "snapshot"))
462 cgit_snapshot_link(name, title, class, ctx->qry.head,
463 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
465 else if (!strcmp(ctx->qry.page, "diff"))
466 cgit_diff_link(name, title, class, ctx->qry.head,
467 ctx->qry.sha1, ctx->qry.sha2,
469 else if (!strcmp(ctx->qry.page, "stats"))
470 cgit_stats_link(name, title, class, ctx->qry.head,
473 /* Don't known how to make link for this page */
474 repolink(title, class, ctx->qry.page, ctx->qry.head, ctx->qry.path);
475 html("><!-- cgit_self_link() doesn't know how to make link for page '");
476 html_txt(ctx->qry.page);
483 void cgit_object_link(struct object *obj)
485 char *page, *shortrev, *fullrev, *name;
487 fullrev = sha1_to_hex(obj->sha1);
488 shortrev = xstrdup(fullrev);
490 if (obj->type == OBJ_COMMIT) {
491 cgit_commit_link(fmt("commit %s...", shortrev), NULL, NULL,
492 ctx.qry.head, fullrev, NULL, 0);
494 } else if (obj->type == OBJ_TREE)
496 else if (obj->type == OBJ_TAG)
500 name = fmt("%s %s...", typename(obj->type), shortrev);
501 reporevlink(page, name, NULL, NULL, ctx.qry.head, fullrev, NULL);
504 static struct string_list_item *lookup_path(struct string_list *list,
507 struct string_list_item *item;
509 while (path && path[0]) {
510 if ((item = string_list_lookup(list, path)))
512 if (!(path = strchr(path, '/')))
519 void cgit_submodule_link(const char *class, char *path, const char *rev)
521 struct string_list *list;
522 struct string_list_item *item;
527 list = &ctx.repo->submodules;
528 item = lookup_path(list, path);
531 tail = path[len - 1];
534 item = lookup_path(list, path);
539 htmlf("class='%s' ", class);
542 html_attr(fmt(item->util, rev));
543 } else if (ctx.repo->module_link) {
544 dir = strrchr(path, '/');
549 html_attr(fmt(ctx.repo->module_link, dir, rev));
556 html_txt(fmt(" @ %.7s", rev));
558 path[len - 1] = tail;
561 void cgit_print_date(time_t secs, const char *format, int local_time)
569 time = localtime(&secs);
571 time = gmtime(&secs);
572 strftime(buf, sizeof(buf)-1, format, time);
576 void cgit_print_age(time_t t, time_t max_relative, const char *format)
585 if (secs > max_relative && max_relative >= 0) {
586 cgit_print_date(t, format, ctx.cfg.local_time);
590 if (secs < TM_HOUR * 2) {
591 htmlf("<span class='age-mins'>%.0f min.</span>",
592 secs * 1.0 / TM_MIN);
595 if (secs < TM_DAY * 2) {
596 htmlf("<span class='age-hours'>%.0f hours</span>",
597 secs * 1.0 / TM_HOUR);
600 if (secs < TM_WEEK * 2) {
601 htmlf("<span class='age-days'>%.0f days</span>",
602 secs * 1.0 / TM_DAY);
605 if (secs < TM_MONTH * 2) {
606 htmlf("<span class='age-weeks'>%.0f weeks</span>",
607 secs * 1.0 / TM_WEEK);
610 if (secs < TM_YEAR * 2) {
611 htmlf("<span class='age-months'>%.0f months</span>",
612 secs * 1.0 / TM_MONTH);
615 htmlf("<span class='age-years'>%.0f years</span>",
616 secs * 1.0 / TM_YEAR);
619 void cgit_print_http_headers(struct cgit_context *ctx)
621 if (ctx->env.no_http && !strcmp(ctx->env.no_http, "1"))
624 if (ctx->page.status)
625 htmlf("Status: %d %s\n", ctx->page.status, ctx->page.statusmsg);
626 if (ctx->page.mimetype && ctx->page.charset)
627 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
629 else if (ctx->page.mimetype)
630 htmlf("Content-Type: %s\n", ctx->page.mimetype);
632 htmlf("Content-Length: %zd\n", ctx->page.size);
633 if (ctx->page.filename)
634 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
636 htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
637 htmlf("Expires: %s\n", http_date(ctx->page.expires));
639 htmlf("ETag: \"%s\"\n", ctx->page.etag);
641 if (ctx->env.request_method && !strcmp(ctx->env.request_method, "HEAD"))
645 void cgit_print_docstart(struct cgit_context *ctx)
647 if (ctx->cfg.embedded) {
649 html_include(ctx->cfg.header);
653 char *host = cgit_hosturl();
655 html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
658 html_txt(ctx->page.title);
660 htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
661 if (ctx->cfg.robots && *ctx->cfg.robots)
662 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
663 html("<link rel='stylesheet' type='text/css' href='");
664 html_attr(ctx->cfg.css);
666 if (ctx->cfg.favicon) {
667 html("<link rel='shortcut icon' href='");
668 html_attr(ctx->cfg.favicon);
671 if (host && ctx->repo && ctx->qry.head) {
672 html("<link rel='alternate' title='Atom feed' href='");
673 html(cgit_httpscheme());
674 html_attr(cgit_hosturl());
675 html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.vpath,
676 fmt("h=%s", ctx->qry.head)));
677 html("' type='application/atom+xml'/>\n");
679 if (ctx->cfg.head_include)
680 html_include(ctx->cfg.head_include);
684 html_include(ctx->cfg.header);
687 void cgit_print_docend()
689 html("</div> <!-- class=content -->\n");
690 if (ctx.cfg.embedded) {
691 html("</div> <!-- id=cgit -->\n");
693 html_include(ctx.cfg.footer);
697 html_include(ctx.cfg.footer);
699 htmlf("<div class='footer'>generated by cgit %s at ",
701 cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
704 html("</div> <!-- id=cgit -->\n");
705 html("</body>\n</html>\n");
708 static int print_branch_option(const char *refname, const unsigned char *sha1,
709 int flags, void *cb_data)
711 char *name = (char *)refname;
712 html_option(name, name, ctx.qry.head);
716 void cgit_add_hidden_formfields(int incl_head, int incl_search,
721 if (!ctx.cfg.virtual_root) {
722 url = fmt("%s/%s", ctx.qry.repo, page);
724 url = fmt("%s/%s", url, ctx.qry.vpath);
725 html_hidden("url", url);
728 if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
729 strcmp(ctx.qry.head, ctx.repo->defbranch))
730 html_hidden("h", ctx.qry.head);
733 html_hidden("id", ctx.qry.sha1);
735 html_hidden("id2", ctx.qry.sha2);
737 html_hidden("showmsg", "1");
741 html_hidden("qt", ctx.qry.grep);
743 html_hidden("q", ctx.qry.search);
747 static const char *hc(struct cgit_context *ctx, const char *page)
749 return strcmp(ctx->qry.page, page) ? NULL : "active";
752 static void cgit_print_path_crumbs(struct cgit_context *ctx, char *path)
754 char *old_path = ctx->qry.path;
755 char *p = path, *q, *end = path + strlen(path);
757 ctx->qry.path = NULL;
758 cgit_self_link("root", NULL, NULL, ctx);
759 ctx->qry.path = p = path;
761 if (!(q = strchr(p, '/')))
765 cgit_self_link(p, NULL, NULL, ctx);
770 ctx->qry.path = old_path;
773 static void print_header(struct cgit_context *ctx)
775 char *logo = NULL, *logo_link = NULL;
777 html("<table id='header'>\n");
780 if (ctx->repo && ctx->repo->logo && *ctx->repo->logo)
781 logo = ctx->repo->logo;
783 logo = ctx->cfg.logo;
784 if (ctx->repo && ctx->repo->logo_link && *ctx->repo->logo_link)
785 logo_link = ctx->repo->logo_link;
787 logo_link = ctx->cfg.logo_link;
789 html("<td class='logo' rowspan='2'><a href='");
790 if (logo_link && *logo_link)
791 html_attr(logo_link);
793 html_attr(cgit_rooturl());
794 html("'><img src='");
796 html("' alt='cgit logo'/></a></td>\n");
799 html("<td class='main'>");
801 cgit_index_link("index", NULL, NULL, NULL, NULL, 0);
803 cgit_summary_link(ctx->repo->name, ctx->repo->name, NULL, NULL);
804 html("</td><td class='form'>");
805 html("<form method='get' action=''>\n");
806 cgit_add_hidden_formfields(0, 1, ctx->qry.page);
807 html("<select name='h' onchange='this.form.submit();'>\n");
808 for_each_branch_ref(print_branch_option, ctx->qry.head);
810 html("<input type='submit' name='' value='switch'/>");
813 html_txt(ctx->cfg.root_title);
814 html("</td></tr>\n");
816 html("<tr><td class='sub'>");
818 html_txt(ctx->repo->desc);
819 html("</td><td class='sub right'>");
820 html_txt(ctx->repo->owner);
822 if (ctx->cfg.root_desc)
823 html_txt(ctx->cfg.root_desc);
824 else if (ctx->cfg.index_info)
825 html_include(ctx->cfg.index_info);
827 html("</td></tr></table>\n");
830 void cgit_print_pageheader(struct cgit_context *ctx)
832 html("<div id='cgit'>");
833 if (!ctx->cfg.noheader)
836 html("<table class='tabs'><tr><td>\n");
838 cgit_summary_link("summary", NULL, hc(ctx, "summary"),
840 cgit_refs_link("refs", NULL, hc(ctx, "refs"), ctx->qry.head,
841 ctx->qry.sha1, NULL);
842 cgit_log_link("log", NULL, hc(ctx, "log"), ctx->qry.head,
843 NULL, ctx->qry.vpath, 0, NULL, NULL,
845 cgit_tree_link("tree", NULL, hc(ctx, "tree"), ctx->qry.head,
846 ctx->qry.sha1, ctx->qry.vpath);
847 cgit_commit_link("commit", NULL, hc(ctx, "commit"),
848 ctx->qry.head, ctx->qry.sha1, ctx->qry.vpath, 0);
849 cgit_diff_link("diff", NULL, hc(ctx, "diff"), ctx->qry.head,
850 ctx->qry.sha1, ctx->qry.sha2, ctx->qry.vpath, 0);
851 if (ctx->repo->max_stats)
852 cgit_stats_link("stats", NULL, hc(ctx, "stats"),
853 ctx->qry.head, ctx->qry.vpath);
854 if (ctx->repo->readme)
855 reporevlink("about", "about", NULL,
856 hc(ctx, "about"), ctx->qry.head, NULL,
858 html("</td><td class='form'>");
859 html("<form class='right' method='get' action='");
860 if (ctx->cfg.virtual_root)
861 html_url_path(cgit_fileurl(ctx->qry.repo, "log",
862 ctx->qry.vpath, NULL));
864 cgit_add_hidden_formfields(1, 0, "log");
865 html("<select name='qt'>\n");
866 html_option("grep", "log msg", ctx->qry.grep);
867 html_option("author", "author", ctx->qry.grep);
868 html_option("committer", "committer", ctx->qry.grep);
869 html_option("range", "range", ctx->qry.grep);
871 html("<input class='txt' type='text' size='10' name='q' value='");
872 html_attr(ctx->qry.search);
874 html("<input type='submit' value='search'/>\n");
877 site_link(NULL, "index", NULL, hc(ctx, "repolist"), NULL, NULL, 0);
878 if (ctx->cfg.root_readme)
879 site_link("about", "about", NULL, hc(ctx, "about"),
881 html("</td><td class='form'>");
882 html("<form method='get' action='");
883 html_attr(cgit_rooturl());
885 html("<input type='text' name='q' size='10' value='");
886 html_attr(ctx->qry.search);
888 html("<input type='submit' value='search'/>\n");
891 html("</td></tr></table>\n");
892 if (ctx->qry.vpath) {
893 html("<div class='path'>");
895 cgit_print_path_crumbs(ctx, ctx->qry.vpath);
898 html("<div class='content'>");
901 void cgit_print_filemode(unsigned short mode)
905 else if (S_ISLNK(mode))
907 else if (S_ISGITLINK(mode))
911 html_fileperm(mode >> 6);
912 html_fileperm(mode >> 3);
916 void cgit_print_snapshot_links(const char *repo, const char *head,
917 const char *hex, int snapshots)
919 const struct cgit_snapshot_format* f;
922 unsigned char sha1[20];
924 if (get_sha1(fmt("refs/tags/%s", hex), sha1) == 0 &&
925 (hex[0] == 'v' || hex[0] == 'V') && isdigit(hex[1]))
927 prefix = xstrdup(fmt("%s-%s", cgit_repobasename(repo), hex));
928 for (f = cgit_snapshot_formats; f->suffix; f++) {
929 if (!(snapshots & f->bit))
931 filename = fmt("%s%s", prefix, f->suffix);
932 cgit_snapshot_link(filename, NULL, NULL, NULL, NULL, filename);