1 /* ui-shared.c: common web output functions
3 * Copyright (C) 2006-2014 cgit Development Team <cgit@lists.zx2c4.com>
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
10 #include "ui-shared.h"
14 const char cgit_doctype[] =
15 "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n"
16 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
18 static char *http_date(time_t t)
20 static char day[][4] =
21 {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
22 static char month[][4] =
23 {"Jan", "Feb", "Mar", "Apr", "May", "Jun",
24 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
25 struct tm *tm = gmtime(&t);
26 return fmt("%s, %02d %s %04d %02d:%02d:%02d GMT", day[tm->tm_wday],
27 tm->tm_mday, month[tm->tm_mon], 1900 + tm->tm_year,
28 tm->tm_hour, tm->tm_min, tm->tm_sec);
31 void cgit_print_error(const char *fmt, ...)
35 cgit_vprint_error(fmt, ap);
39 void cgit_vprint_error(const char *fmt, va_list ap)
42 html("<div class='error'>");
49 const char *cgit_httpscheme()
51 if (ctx.env.https && !strcmp(ctx.env.https, "on"))
57 const char *cgit_hosturl()
59 if (ctx.env.http_host)
60 return ctx.env.http_host;
61 if (!ctx.env.server_name)
63 if (!ctx.env.server_port || atoi(ctx.env.server_port) == 80)
64 return ctx.env.server_name;
65 return fmtalloc("%s:%s", ctx.env.server_name, ctx.env.server_port);
68 const char *cgit_rooturl()
70 if (ctx.cfg.virtual_root)
71 return ctx.cfg.virtual_root;
73 return ctx.cfg.script_name;
76 const char *cgit_loginurl()
78 static const char *login_url = 0;
80 login_url = fmtalloc("%s?p=login", cgit_rooturl());
84 char *cgit_repourl(const char *reponame)
86 if (ctx.cfg.virtual_root)
87 return fmtalloc("%s%s/", ctx.cfg.virtual_root, reponame);
89 return fmtalloc("?r=%s", reponame);
92 char *cgit_fileurl(const char *reponame, const char *pagename,
93 const char *filename, const char *query)
95 struct strbuf sb = STRBUF_INIT;
98 if (ctx.cfg.virtual_root) {
99 strbuf_addf(&sb, "%s%s/%s/%s", ctx.cfg.virtual_root, reponame,
100 pagename, (filename ? filename:""));
103 strbuf_addf(&sb, "?url=%s/%s/%s", reponame, pagename,
104 (filename ? filename : ""));
108 strbuf_addf(&sb, "%s%s", delim, query);
109 return strbuf_detach(&sb, NULL);
112 char *cgit_pageurl(const char *reponame, const char *pagename,
115 return cgit_fileurl(reponame, pagename, 0, query);
118 const char *cgit_repobasename(const char *reponame)
120 /* I assume we don't need to store more than one repo basename */
121 static char rvbuf[1024];
124 strncpy(rvbuf, reponame, sizeof(rvbuf));
125 if (rvbuf[sizeof(rvbuf)-1])
126 die("cgit_repobasename: truncated repository name '%s'", reponame);
128 /* strip trailing slashes */
129 while (p && rvbuf[p] == '/') rvbuf[p--] = 0;
130 /* strip trailing .git */
131 if (p >= 3 && starts_with(&rvbuf[p-3], ".git")) {
132 p -= 3; rvbuf[p--] = 0;
134 /* strip more trailing slashes if any */
135 while ( p && rvbuf[p] == '/') rvbuf[p--] = 0;
136 /* find last slash in the remaining string */
137 rv = strrchr(rvbuf,'/');
143 static void site_url(const char *page, const char *search, const char *sort, int ofs)
147 if (ctx.cfg.virtual_root)
148 html_attr(ctx.cfg.virtual_root);
150 html_url_path(ctx.cfg.script_name);
153 htmlf("?p=%s", page);
170 htmlf("ofs=%d", ofs);
174 static void site_link(const char *page, const char *name, const char *title,
175 const char *class, const char *search, const char *sort, int ofs)
189 site_url(page, search, sort, ofs);
195 void cgit_index_link(const char *name, const char *title, const char *class,
196 const char *pattern, const char *sort, int ofs)
198 site_link(NULL, name, title, class, pattern, sort, ofs);
201 static char *repolink(const char *title, const char *class, const char *page,
202 const char *head, const char *path)
218 if (ctx.cfg.virtual_root) {
219 html_url_path(ctx.cfg.virtual_root);
220 html_url_path(ctx.repo->url);
221 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
230 html_url_path(ctx.cfg.script_name);
232 html_url_arg(ctx.repo->url);
233 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
243 if (head && strcmp(head, ctx.repo->defbranch)) {
249 return fmt("%s", delim);
252 static void reporevlink(const char *page, const char *name, const char *title,
253 const char *class, const char *head, const char *rev,
258 delim = repolink(title, class, page, head, path);
259 if (rev && ctx.qry.head != NULL && strcmp(rev, ctx.qry.head)) {
269 void cgit_summary_link(const char *name, const char *title, const char *class,
272 reporevlink(NULL, name, title, class, head, NULL, NULL);
275 void cgit_tag_link(const char *name, const char *title, const char *class,
276 const char *head, const char *rev)
278 reporevlink("tag", name, title, class, head, rev, NULL);
281 void cgit_tree_link(const char *name, const char *title, const char *class,
282 const char *head, const char *rev, const char *path)
284 reporevlink("tree", name, title, class, head, rev, path);
287 void cgit_plain_link(const char *name, const char *title, const char *class,
288 const char *head, const char *rev, const char *path)
290 reporevlink("plain", name, title, class, head, rev, path);
293 void cgit_log_link(const char *name, const char *title, const char *class,
294 const char *head, const char *rev, const char *path,
295 int ofs, const char *grep, const char *pattern, int showmsg)
299 delim = repolink(title, class, "log", head, path);
300 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
306 if (grep && pattern) {
313 html_url_arg(pattern);
330 void cgit_commit_link(char *name, const char *title, const char *class,
331 const char *head, const char *rev, const char *path)
333 if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
334 name[ctx.cfg.max_msg_len] = '\0';
335 name[ctx.cfg.max_msg_len - 1] = '.';
336 name[ctx.cfg.max_msg_len - 2] = '.';
337 name[ctx.cfg.max_msg_len - 3] = '.';
342 delim = repolink(title, class, "commit", head, path);
343 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
349 if (ctx.qry.ssdiff) {
354 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
357 htmlf("%d", ctx.qry.context);
360 if (ctx.qry.ignorews) {
369 html_txt("(no commit message)");
373 void cgit_refs_link(const char *name, const char *title, const char *class,
374 const char *head, const char *rev, const char *path)
376 reporevlink("refs", name, title, class, head, rev, path);
379 void cgit_snapshot_link(const char *name, const char *title, const char *class,
380 const char *head, const char *rev,
381 const char *archivename)
383 reporevlink("snapshot", name, title, class, head, rev, archivename);
386 void cgit_diff_link(const char *name, const char *title, const char *class,
387 const char *head, const char *new_rev, const char *old_rev,
388 const char *path, int toggle_ssdiff)
392 delim = repolink(title, class, "diff", head, path);
393 if (new_rev && ctx.qry.head != NULL && strcmp(new_rev, ctx.qry.head)) {
396 html_url_arg(new_rev);
402 html_url_arg(old_rev);
405 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
410 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
413 htmlf("%d", ctx.qry.context);
416 if (ctx.qry.ignorews) {
426 void cgit_patch_link(const char *name, const char *title, const char *class,
427 const char *head, const char *rev, const char *path)
429 reporevlink("patch", name, title, class, head, rev, path);
432 void cgit_stats_link(const char *name, const char *title, const char *class,
433 const char *head, const char *path)
435 reporevlink("stats", name, title, class, head, NULL, path);
438 static void cgit_self_link(char *name, const char *title, const char *class)
440 if (!strcmp(ctx.qry.page, "repolist"))
441 cgit_index_link(name, title, class, ctx.qry.search, ctx.qry.sort,
443 else if (!strcmp(ctx.qry.page, "summary"))
444 cgit_summary_link(name, title, class, ctx.qry.head);
445 else if (!strcmp(ctx.qry.page, "tag"))
446 cgit_tag_link(name, title, class, ctx.qry.head,
447 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL);
448 else if (!strcmp(ctx.qry.page, "tree"))
449 cgit_tree_link(name, title, class, ctx.qry.head,
450 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
452 else if (!strcmp(ctx.qry.page, "plain"))
453 cgit_plain_link(name, title, class, ctx.qry.head,
454 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
456 else if (!strcmp(ctx.qry.page, "log"))
457 cgit_log_link(name, title, class, ctx.qry.head,
458 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
459 ctx.qry.path, ctx.qry.ofs,
460 ctx.qry.grep, ctx.qry.search,
462 else if (!strcmp(ctx.qry.page, "commit"))
463 cgit_commit_link(name, title, class, ctx.qry.head,
464 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
466 else if (!strcmp(ctx.qry.page, "patch"))
467 cgit_patch_link(name, title, class, ctx.qry.head,
468 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
470 else if (!strcmp(ctx.qry.page, "refs"))
471 cgit_refs_link(name, title, class, ctx.qry.head,
472 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
474 else if (!strcmp(ctx.qry.page, "snapshot"))
475 cgit_snapshot_link(name, title, class, ctx.qry.head,
476 ctx.qry.has_sha1 ? ctx.qry.sha1 : NULL,
478 else if (!strcmp(ctx.qry.page, "diff"))
479 cgit_diff_link(name, title, class, ctx.qry.head,
480 ctx.qry.sha1, ctx.qry.sha2,
482 else if (!strcmp(ctx.qry.page, "stats"))
483 cgit_stats_link(name, title, class, ctx.qry.head,
486 /* Don't known how to make link for this page */
487 repolink(title, class, ctx.qry.page, ctx.qry.head, ctx.qry.path);
488 html("><!-- cgit_self_link() doesn't know how to make link for page '");
489 html_txt(ctx.qry.page);
496 void cgit_object_link(struct object *obj)
498 char *page, *shortrev, *fullrev, *name;
500 fullrev = sha1_to_hex(obj->sha1);
501 shortrev = xstrdup(fullrev);
503 if (obj->type == OBJ_COMMIT) {
504 cgit_commit_link(fmt("commit %s...", shortrev), NULL, NULL,
505 ctx.qry.head, fullrev, NULL);
507 } else if (obj->type == OBJ_TREE)
509 else if (obj->type == OBJ_TAG)
513 name = fmt("%s %s...", typename(obj->type), shortrev);
514 reporevlink(page, name, NULL, NULL, ctx.qry.head, fullrev, NULL);
517 static struct string_list_item *lookup_path(struct string_list *list,
520 struct string_list_item *item;
522 while (path && path[0]) {
523 if ((item = string_list_lookup(list, path)))
525 if (!(path = strchr(path, '/')))
532 void cgit_submodule_link(const char *class, char *path, const char *rev)
534 struct string_list *list;
535 struct string_list_item *item;
541 list = &ctx.repo->submodules;
542 item = lookup_path(list, path);
545 tail = path[len - 1];
548 item = lookup_path(list, path);
553 htmlf("class='%s' ", class);
556 html_attrf(item->util, rev);
557 } else if (ctx.repo->module_link) {
558 dir = strrchr(path, '/');
563 html_attrf(ctx.repo->module_link, dir, rev);
570 html_txtf(" @ %.7s", rev);
572 path[len - 1] = tail;
575 void cgit_print_date(time_t secs, const char *format, int local_time)
583 time = localtime(&secs);
585 time = gmtime(&secs);
586 strftime(buf, sizeof(buf)-1, format, time);
590 void cgit_print_age(time_t t, time_t max_relative, const char *format)
601 if (secs > max_relative && max_relative >= 0) {
602 cgit_print_date(t, format, ctx.cfg.local_time);
606 if (secs < TM_HOUR * 2) {
607 htmlf("<span class='age-mins'>%.0f min.</span>",
608 secs * 1.0 / TM_MIN);
611 if (secs < TM_DAY * 2) {
612 htmlf("<span class='age-hours'>%.0f hours</span>",
613 secs * 1.0 / TM_HOUR);
616 if (secs < TM_WEEK * 2) {
617 htmlf("<span class='age-days'>%.0f days</span>",
618 secs * 1.0 / TM_DAY);
621 if (secs < TM_MONTH * 2) {
622 htmlf("<span class='age-weeks'>%.0f weeks</span>",
623 secs * 1.0 / TM_WEEK);
626 if (secs < TM_YEAR * 2) {
627 htmlf("<span class='age-months'>%.0f months</span>",
628 secs * 1.0 / TM_MONTH);
631 htmlf("<span class='age-years'>%.0f years</span>",
632 secs * 1.0 / TM_YEAR);
635 void cgit_print_http_headers(void)
637 if (ctx.env.no_http && !strcmp(ctx.env.no_http, "1"))
641 htmlf("Status: %d %s\n", ctx.page.status, ctx.page.statusmsg);
642 if (ctx.page.mimetype && ctx.page.charset)
643 htmlf("Content-Type: %s; charset=%s\n", ctx.page.mimetype,
645 else if (ctx.page.mimetype)
646 htmlf("Content-Type: %s\n", ctx.page.mimetype);
648 htmlf("Content-Length: %zd\n", ctx.page.size);
649 if (ctx.page.filename)
650 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
652 if (!ctx.env.authenticated)
653 html("Cache-Control: no-cache, no-store\n");
654 htmlf("Last-Modified: %s\n", http_date(ctx.page.modified));
655 htmlf("Expires: %s\n", http_date(ctx.page.expires));
657 htmlf("ETag: \"%s\"\n", ctx.page.etag);
659 if (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD"))
663 void cgit_print_docstart(void)
665 if (ctx.cfg.embedded) {
667 html_include(ctx.cfg.header);
671 const char *host = cgit_hosturl();
673 html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
676 html_txt(ctx.page.title);
678 htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
679 if (ctx.cfg.robots && *ctx.cfg.robots)
680 htmlf("<meta name='robots' content='%s'/>\n", ctx.cfg.robots);
681 html("<link rel='stylesheet' type='text/css' href='");
682 html_attr(ctx.cfg.css);
684 if (ctx.cfg.favicon) {
685 html("<link rel='shortcut icon' href='");
686 html_attr(ctx.cfg.favicon);
689 if (host && ctx.repo && ctx.qry.head) {
690 struct strbuf sb = STRBUF_INIT;
691 strbuf_addf(&sb, "h=%s", ctx.qry.head);
693 html("<link rel='alternate' title='Atom feed' href='");
694 html(cgit_httpscheme());
695 html_attr(cgit_hosturl());
696 html_attr(cgit_fileurl(ctx.repo->url, "atom", ctx.qry.vpath,
698 html("' type='application/atom+xml'/>\n");
701 if (ctx.cfg.head_include)
702 html_include(ctx.cfg.head_include);
706 html_include(ctx.cfg.header);
709 void cgit_print_docend()
711 html("</div> <!-- class=content -->\n");
712 if (ctx.cfg.embedded) {
713 html("</div> <!-- id=cgit -->\n");
715 html_include(ctx.cfg.footer);
719 html_include(ctx.cfg.footer);
721 htmlf("<div class='footer'>generated by cgit %s at ",
723 cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
726 html("</div> <!-- id=cgit -->\n");
727 html("</body>\n</html>\n");
730 static int print_branch_option(const char *refname, const unsigned char *sha1,
731 int flags, void *cb_data)
733 char *name = (char *)refname;
734 html_option(name, name, ctx.qry.head);
738 void cgit_add_hidden_formfields(int incl_head, int incl_search,
741 if (!ctx.cfg.virtual_root) {
742 struct strbuf url = STRBUF_INIT;
744 strbuf_addf(&url, "%s/%s", ctx.qry.repo, page);
746 strbuf_addf(&url, "/%s", ctx.qry.vpath);
747 html_hidden("url", url.buf);
748 strbuf_release(&url);
751 if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
752 strcmp(ctx.qry.head, ctx.repo->defbranch))
753 html_hidden("h", ctx.qry.head);
756 html_hidden("id", ctx.qry.sha1);
758 html_hidden("id2", ctx.qry.sha2);
760 html_hidden("showmsg", "1");
764 html_hidden("qt", ctx.qry.grep);
766 html_hidden("q", ctx.qry.search);
770 static const char *hc(const char *page)
772 return strcmp(ctx.qry.page, page) ? NULL : "active";
775 static void cgit_print_path_crumbs(char *path)
777 char *old_path = ctx.qry.path;
778 char *p = path, *q, *end = path + strlen(path);
781 cgit_self_link("root", NULL, NULL);
782 ctx.qry.path = p = path;
784 if (!(q = strchr(p, '/')))
788 cgit_self_link(p, NULL, NULL);
793 ctx.qry.path = old_path;
796 static void print_header(void)
798 char *logo = NULL, *logo_link = NULL;
800 html("<table id='header'>\n");
803 if (ctx.repo && ctx.repo->logo && *ctx.repo->logo)
804 logo = ctx.repo->logo;
807 if (ctx.repo && ctx.repo->logo_link && *ctx.repo->logo_link)
808 logo_link = ctx.repo->logo_link;
810 logo_link = ctx.cfg.logo_link;
812 html("<td class='logo' rowspan='2'><a href='");
813 if (logo_link && *logo_link)
814 html_attr(logo_link);
816 html_attr(cgit_rooturl());
817 html("'><img src='");
819 html("' alt='cgit logo'/></a></td>\n");
822 html("<td class='main'>");
824 cgit_index_link("index", NULL, NULL, NULL, NULL, 0);
826 cgit_summary_link(ctx.repo->name, ctx.repo->name, NULL, NULL);
827 if (ctx.env.authenticated) {
828 html("</td><td class='form'>");
829 html("<form method='get' action=''>\n");
830 cgit_add_hidden_formfields(0, 1, ctx.qry.page);
831 html("<select name='h' onchange='this.form.submit();'>\n");
832 for_each_branch_ref(print_branch_option, ctx.qry.head);
834 html("<input type='submit' name='' value='switch'/>");
838 html_txt(ctx.cfg.root_title);
839 html("</td></tr>\n");
841 html("<tr><td class='sub'>");
843 html_txt(ctx.repo->desc);
844 html("</td><td class='sub right'>");
845 html_txt(ctx.repo->owner);
847 if (ctx.cfg.root_desc)
848 html_txt(ctx.cfg.root_desc);
849 else if (ctx.cfg.index_info)
850 html_include(ctx.cfg.index_info);
852 html("</td></tr></table>\n");
855 void cgit_print_pageheader(void)
857 html("<div id='cgit'>");
858 if (!ctx.env.authenticated || !ctx.cfg.noheader)
861 html("<table class='tabs'><tr><td>\n");
862 if (ctx.env.authenticated && ctx.repo) {
863 if (ctx.repo->readme.nr)
864 reporevlink("about", "about", NULL,
865 hc("about"), ctx.qry.head, NULL,
867 cgit_summary_link("summary", NULL, hc("summary"),
869 cgit_refs_link("refs", NULL, hc("refs"), ctx.qry.head,
871 cgit_log_link("log", NULL, hc("log"), ctx.qry.head,
872 NULL, ctx.qry.vpath, 0, NULL, NULL,
874 cgit_tree_link("tree", NULL, hc("tree"), ctx.qry.head,
875 ctx.qry.sha1, ctx.qry.vpath);
876 cgit_commit_link("commit", NULL, hc("commit"),
877 ctx.qry.head, ctx.qry.sha1, ctx.qry.vpath);
878 cgit_diff_link("diff", NULL, hc("diff"), ctx.qry.head,
879 ctx.qry.sha1, ctx.qry.sha2, ctx.qry.vpath, 0);
880 if (ctx.repo->max_stats)
881 cgit_stats_link("stats", NULL, hc("stats"),
882 ctx.qry.head, ctx.qry.vpath);
883 html("</td><td class='form'>");
884 html("<form class='right' method='get' action='");
885 if (ctx.cfg.virtual_root)
886 html_url_path(cgit_fileurl(ctx.qry.repo, "log",
887 ctx.qry.vpath, NULL));
889 cgit_add_hidden_formfields(1, 0, "log");
890 html("<select name='qt'>\n");
891 html_option("grep", "log msg", ctx.qry.grep);
892 html_option("author", "author", ctx.qry.grep);
893 html_option("committer", "committer", ctx.qry.grep);
894 html_option("range", "range", ctx.qry.grep);
896 html("<input class='txt' type='text' size='10' name='q' value='");
897 html_attr(ctx.qry.search);
899 html("<input type='submit' value='search'/>\n");
901 } else if (ctx.env.authenticated) {
902 site_link(NULL, "index", NULL, hc("repolist"), NULL, NULL, 0);
903 if (ctx.cfg.root_readme)
904 site_link("about", "about", NULL, hc("about"),
906 html("</td><td class='form'>");
907 html("<form method='get' action='");
908 html_attr(cgit_rooturl());
910 html("<input type='text' name='q' size='10' value='");
911 html_attr(ctx.qry.search);
913 html("<input type='submit' value='search'/>\n");
916 html("</td></tr></table>\n");
917 if (ctx.env.authenticated && ctx.qry.vpath) {
918 html("<div class='path'>");
920 cgit_print_path_crumbs(ctx.qry.vpath);
923 html("<div class='content'>");
926 void cgit_print_filemode(unsigned short mode)
930 else if (S_ISLNK(mode))
932 else if (S_ISGITLINK(mode))
936 html_fileperm(mode >> 6);
937 html_fileperm(mode >> 3);
941 void cgit_print_snapshot_links(const char *repo, const char *head,
942 const char *hex, int snapshots)
944 const struct cgit_snapshot_format* f;
945 struct strbuf filename = STRBUF_INIT;
947 unsigned char sha1[20];
949 if (get_sha1(fmt("refs/tags/%s", hex), sha1) == 0 &&
950 (hex[0] == 'v' || hex[0] == 'V') && isdigit(hex[1]))
952 strbuf_addf(&filename, "%s-%s", cgit_repobasename(repo), hex);
953 prefixlen = filename.len;
954 for (f = cgit_snapshot_formats; f->suffix; f++) {
955 if (!(snapshots & f->bit))
957 strbuf_setlen(&filename, prefixlen);
958 strbuf_addstr(&filename, f->suffix);
959 cgit_snapshot_link(filename.buf, NULL, NULL, NULL, NULL,
963 strbuf_release(&filename);