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)
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 *msg)
33 html("<div class='error'>");
38 const char *cgit_httpscheme()
40 if (ctx.env.https && !strcmp(ctx.env.https, "on"))
46 const char *cgit_hosturl()
48 if (ctx.env.http_host)
49 return ctx.env.http_host;
50 if (!ctx.env.server_name)
52 if (!ctx.env.server_port || atoi(ctx.env.server_port) == 80)
53 return ctx.env.server_name;
54 return xstrdup(fmt("%s:%s", ctx.env.server_name, ctx.env.server_port));
57 const char *cgit_rooturl()
59 if (ctx.cfg.virtual_root)
60 return ctx.cfg.virtual_root;
62 return ctx.cfg.script_name;
65 char *cgit_repourl(const char *reponame)
67 if (ctx.cfg.virtual_root) {
68 return fmt("%s%s/", ctx.cfg.virtual_root, reponame);
70 return fmt("?r=%s", reponame);
74 char *cgit_fileurl(const char *reponame, const char *pagename,
75 const char *filename, const char *query)
80 if (ctx.cfg.virtual_root) {
81 tmp = fmt("%s%s/%s/%s", ctx.cfg.virtual_root, reponame,
82 pagename, (filename ? filename:""));
85 tmp = fmt("?url=%s/%s/%s", reponame, pagename,
86 (filename ? filename : ""));
90 tmp = fmt("%s%s%s", tmp, delim, query);
94 char *cgit_pageurl(const char *reponame, const char *pagename,
97 return cgit_fileurl(reponame, pagename, 0, query);
100 const char *cgit_repobasename(const char *reponame)
102 /* I assume we don't need to store more than one repo basename */
103 static char rvbuf[1024];
106 strncpy(rvbuf, reponame, sizeof(rvbuf));
107 if (rvbuf[sizeof(rvbuf)-1])
108 die("cgit_repobasename: truncated repository name '%s'", reponame);
110 /* strip trailing slashes */
111 while (p && rvbuf[p] == '/') rvbuf[p--] = 0;
112 /* strip trailing .git */
113 if (p >= 3 && !strncmp(&rvbuf[p-3], ".git", 4)) {
114 p -= 3; rvbuf[p--] = 0;
116 /* strip more trailing slashes if any */
117 while ( p && rvbuf[p] == '/') rvbuf[p--] = 0;
118 /* find last slash in the remaining string */
119 rv = strrchr(rvbuf,'/');
125 static void site_url(const char *page, const char *search, const char *sort, int ofs)
129 if (ctx.cfg.virtual_root)
130 html_attr(ctx.cfg.virtual_root);
132 html(ctx.cfg.script_name);
135 htmlf("?p=%s", page);
152 htmlf("ofs=%d", ofs);
156 static void site_link(const char *page, const char *name, const char *title,
157 const char *class, const char *search, const char *sort, int ofs)
171 site_url(page, search, sort, ofs);
177 void cgit_index_link(const char *name, const char *title, const char *class,
178 const char *pattern, const char *sort, int ofs)
180 site_link(NULL, name, title, class, pattern, sort, ofs);
183 static char *repolink(const char *title, const char *class, const char *page,
184 const char *head, const char *path)
200 if (ctx.cfg.virtual_root) {
201 html_url_path(ctx.cfg.virtual_root);
202 html_url_path(ctx.repo->url);
203 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
212 html(ctx.cfg.script_name);
214 html_url_arg(ctx.repo->url);
215 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
225 if (head && strcmp(head, ctx.repo->defbranch)) {
231 return fmt("%s", delim);
234 static void reporevlink(const char *page, const char *name, const char *title,
235 const char *class, const char *head, const char *rev,
240 delim = repolink(title, class, page, head, path);
241 if (rev && ctx.qry.head != NULL && strcmp(rev, ctx.qry.head)) {
251 void cgit_summary_link(const char *name, const char *title, const char *class,
254 reporevlink(NULL, name, title, class, head, NULL, NULL);
257 void cgit_tag_link(const char *name, const char *title, const char *class,
258 const char *head, const char *rev)
260 reporevlink("tag", name, title, class, head, rev, NULL);
263 void cgit_tree_link(const char *name, const char *title, const char *class,
264 const char *head, const char *rev, const char *path)
266 reporevlink("tree", name, title, class, head, rev, path);
269 void cgit_plain_link(const char *name, const char *title, const char *class,
270 const char *head, const char *rev, const char *path)
272 reporevlink("plain", name, title, class, head, rev, path);
275 void cgit_log_link(const char *name, const char *title, const char *class,
276 const char *head, const char *rev, const char *path,
277 int ofs, const char *grep, const char *pattern, int showmsg)
281 delim = repolink(title, class, "log", head, path);
282 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
288 if (grep && pattern) {
295 html_url_arg(pattern);
312 void cgit_commit_link(char *name, const char *title, const char *class,
313 const char *head, const char *rev, const char *path,
316 if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
317 name[ctx.cfg.max_msg_len] = '\0';
318 name[ctx.cfg.max_msg_len - 1] = '.';
319 name[ctx.cfg.max_msg_len - 2] = '.';
320 name[ctx.cfg.max_msg_len - 3] = '.';
325 delim = repolink(title, class, "commit", head, path);
326 if (rev && ctx.qry.head && strcmp(rev, ctx.qry.head)) {
332 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
337 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
340 htmlf("%d", ctx.qry.context);
343 if (ctx.qry.ignorews) {
352 html_txt("(no commit message)");
356 void cgit_refs_link(const char *name, const char *title, const char *class,
357 const char *head, const char *rev, const char *path)
359 reporevlink("refs", name, title, class, head, rev, path);
362 void cgit_snapshot_link(const char *name, const char *title, const char *class,
363 const char *head, const char *rev,
364 const char *archivename)
366 reporevlink("snapshot", name, title, class, head, rev, archivename);
369 void cgit_diff_link(const char *name, const char *title, const char *class,
370 const char *head, const char *new_rev, const char *old_rev,
371 const char *path, int toggle_ssdiff)
375 delim = repolink(title, class, "diff", head, path);
376 if (new_rev && ctx.qry.head != NULL && strcmp(new_rev, ctx.qry.head)) {
379 html_url_arg(new_rev);
385 html_url_arg(old_rev);
388 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
393 if (ctx.qry.context > 0 && ctx.qry.context != 3) {
396 htmlf("%d", ctx.qry.context);
399 if (ctx.qry.ignorews) {
409 void cgit_patch_link(const char *name, const char *title, const char *class,
410 const char *head, const char *rev, const char *path)
412 reporevlink("patch", name, title, class, head, rev, path);
415 void cgit_stats_link(const char *name, const char *title, const char *class,
416 const char *head, const char *path)
418 reporevlink("stats", name, title, class, head, NULL, path);
421 static void cgit_self_link(char *name, const char *title, const char *class,
422 struct cgit_context *ctx)
424 if (!strcmp(ctx->qry.page, "repolist"))
425 cgit_index_link(name, title, class, ctx->qry.search, ctx->qry.sort,
427 else if (!strcmp(ctx->qry.page, "summary"))
428 cgit_summary_link(name, title, class, ctx->qry.head);
429 else if (!strcmp(ctx->qry.page, "tag"))
430 cgit_tag_link(name, title, class, ctx->qry.head,
431 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL);
432 else if (!strcmp(ctx->qry.page, "tree"))
433 cgit_tree_link(name, title, class, ctx->qry.head,
434 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
436 else if (!strcmp(ctx->qry.page, "plain"))
437 cgit_plain_link(name, title, class, ctx->qry.head,
438 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
440 else if (!strcmp(ctx->qry.page, "log"))
441 cgit_log_link(name, title, class, ctx->qry.head,
442 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
443 ctx->qry.path, ctx->qry.ofs,
444 ctx->qry.grep, ctx->qry.search,
446 else if (!strcmp(ctx->qry.page, "commit"))
447 cgit_commit_link(name, title, class, ctx->qry.head,
448 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
450 else if (!strcmp(ctx->qry.page, "patch"))
451 cgit_patch_link(name, title, class, ctx->qry.head,
452 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
454 else if (!strcmp(ctx->qry.page, "refs"))
455 cgit_refs_link(name, title, class, ctx->qry.head,
456 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
458 else if (!strcmp(ctx->qry.page, "snapshot"))
459 cgit_snapshot_link(name, title, class, ctx->qry.head,
460 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
462 else if (!strcmp(ctx->qry.page, "diff"))
463 cgit_diff_link(name, title, class, ctx->qry.head,
464 ctx->qry.sha1, ctx->qry.sha2,
466 else if (!strcmp(ctx->qry.page, "stats"))
467 cgit_stats_link(name, title, class, ctx->qry.head,
470 /* Don't known how to make link for this page */
471 repolink(title, class, ctx->qry.page, ctx->qry.head, ctx->qry.path);
472 html("><!-- cgit_self_link() doesn't know how to make link for page '");
473 html_txt(ctx->qry.page);
480 void cgit_object_link(struct object *obj)
482 char *page, *shortrev, *fullrev, *name;
484 fullrev = sha1_to_hex(obj->sha1);
485 shortrev = xstrdup(fullrev);
487 if (obj->type == OBJ_COMMIT) {
488 cgit_commit_link(fmt("commit %s...", shortrev), NULL, NULL,
489 ctx.qry.head, fullrev, NULL, 0);
491 } else if (obj->type == OBJ_TREE)
493 else if (obj->type == OBJ_TAG)
497 name = fmt("%s %s...", typename(obj->type), shortrev);
498 reporevlink(page, name, NULL, NULL, ctx.qry.head, fullrev, NULL);
501 static struct string_list_item *lookup_path(struct string_list *list,
504 struct string_list_item *item;
506 while (path && path[0]) {
507 if ((item = string_list_lookup(list, path)))
509 if (!(path = strchr(path, '/')))
516 void cgit_submodule_link(const char *class, char *path, const char *rev)
518 struct string_list *list;
519 struct string_list_item *item;
525 list = &ctx.repo->submodules;
526 item = lookup_path(list, path);
529 tail = path[len - 1];
532 item = lookup_path(list, path);
537 htmlf("class='%s' ", class);
540 html_attr(fmt(item->util, rev));
541 } else if (ctx.repo->module_link) {
542 dir = strrchr(path, '/');
547 html_attr(fmt(ctx.repo->module_link, dir, rev));
554 html_txt(fmt(" @ %.7s", rev));
556 path[len - 1] = tail;
559 void cgit_print_date(time_t secs, const char *format, int local_time)
567 time = localtime(&secs);
569 time = gmtime(&secs);
570 strftime(buf, sizeof(buf)-1, format, time);
574 void cgit_print_age(time_t t, time_t max_relative, const char *format)
583 if (secs > max_relative && max_relative >= 0) {
584 cgit_print_date(t, format, ctx.cfg.local_time);
588 if (secs < TM_HOUR * 2) {
589 htmlf("<span class='age-mins'>%.0f min.</span>",
590 secs * 1.0 / TM_MIN);
593 if (secs < TM_DAY * 2) {
594 htmlf("<span class='age-hours'>%.0f hours</span>",
595 secs * 1.0 / TM_HOUR);
598 if (secs < TM_WEEK * 2) {
599 htmlf("<span class='age-days'>%.0f days</span>",
600 secs * 1.0 / TM_DAY);
603 if (secs < TM_MONTH * 2) {
604 htmlf("<span class='age-weeks'>%.0f weeks</span>",
605 secs * 1.0 / TM_WEEK);
608 if (secs < TM_YEAR * 2) {
609 htmlf("<span class='age-months'>%.0f months</span>",
610 secs * 1.0 / TM_MONTH);
613 htmlf("<span class='age-years'>%.0f years</span>",
614 secs * 1.0 / TM_YEAR);
617 void cgit_print_http_headers(struct cgit_context *ctx)
619 if (ctx->env.no_http && !strcmp(ctx->env.no_http, "1"))
622 if (ctx->page.status)
623 htmlf("Status: %d %s\n", ctx->page.status, ctx->page.statusmsg);
624 if (ctx->page.mimetype && ctx->page.charset)
625 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
627 else if (ctx->page.mimetype)
628 htmlf("Content-Type: %s\n", ctx->page.mimetype);
630 htmlf("Content-Length: %zd\n", ctx->page.size);
631 if (ctx->page.filename)
632 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
634 htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
635 htmlf("Expires: %s\n", http_date(ctx->page.expires));
637 htmlf("ETag: \"%s\"\n", ctx->page.etag);
639 if (ctx->env.request_method && !strcmp(ctx->env.request_method, "HEAD"))
643 void cgit_print_docstart(struct cgit_context *ctx)
645 if (ctx->cfg.embedded) {
647 html_include(ctx->cfg.header);
651 const char *host = cgit_hosturl();
653 html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
656 html_txt(ctx->page.title);
658 htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
659 if (ctx->cfg.robots && *ctx->cfg.robots)
660 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
661 html("<link rel='stylesheet' type='text/css' href='");
662 html_attr(ctx->cfg.css);
664 if (ctx->cfg.favicon) {
665 html("<link rel='shortcut icon' href='");
666 html_attr(ctx->cfg.favicon);
669 if (host && ctx->repo && ctx->qry.head) {
670 html("<link rel='alternate' title='Atom feed' href='");
671 html(cgit_httpscheme());
672 html_attr(cgit_hosturl());
673 html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.vpath,
674 fmt("h=%s", ctx->qry.head)));
675 html("' type='application/atom+xml'/>\n");
677 if (ctx->cfg.head_include)
678 html_include(ctx->cfg.head_include);
682 html_include(ctx->cfg.header);
685 void cgit_print_docend()
687 html("</div> <!-- class=content -->\n");
688 if (ctx.cfg.embedded) {
689 html("</div> <!-- id=cgit -->\n");
691 html_include(ctx.cfg.footer);
695 html_include(ctx.cfg.footer);
697 htmlf("<div class='footer'>generated by cgit %s at ",
699 cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
702 html("</div> <!-- id=cgit -->\n");
703 html("</body>\n</html>\n");
706 static int print_branch_option(const char *refname, const unsigned char *sha1,
707 int flags, void *cb_data)
709 char *name = (char *)refname;
710 html_option(name, name, ctx.qry.head);
714 void cgit_add_hidden_formfields(int incl_head, int incl_search,
719 if (!ctx.cfg.virtual_root) {
720 url = fmt("%s/%s", ctx.qry.repo, page);
722 url = fmt("%s/%s", url, ctx.qry.vpath);
723 html_hidden("url", url);
726 if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
727 strcmp(ctx.qry.head, ctx.repo->defbranch))
728 html_hidden("h", ctx.qry.head);
731 html_hidden("id", ctx.qry.sha1);
733 html_hidden("id2", ctx.qry.sha2);
735 html_hidden("showmsg", "1");
739 html_hidden("qt", ctx.qry.grep);
741 html_hidden("q", ctx.qry.search);
745 static const char *hc(struct cgit_context *ctx, const char *page)
747 return strcmp(ctx->qry.page, page) ? NULL : "active";
750 static void cgit_print_path_crumbs(struct cgit_context *ctx, char *path)
752 char *old_path = ctx->qry.path;
753 char *p = path, *q, *end = path + strlen(path);
755 ctx->qry.path = NULL;
756 cgit_self_link("root", NULL, NULL, ctx);
757 ctx->qry.path = p = path;
759 if (!(q = strchr(p, '/')))
763 cgit_self_link(p, NULL, NULL, ctx);
768 ctx->qry.path = old_path;
771 static void print_header(struct cgit_context *ctx)
773 char *logo = NULL, *logo_link = NULL;
775 html("<table id='header'>\n");
778 if (ctx->repo && ctx->repo->logo && *ctx->repo->logo)
779 logo = ctx->repo->logo;
781 logo = ctx->cfg.logo;
782 if (ctx->repo && ctx->repo->logo_link && *ctx->repo->logo_link)
783 logo_link = ctx->repo->logo_link;
785 logo_link = ctx->cfg.logo_link;
787 html("<td class='logo' rowspan='2'><a href='");
788 if (logo_link && *logo_link)
789 html_attr(logo_link);
791 html_attr(cgit_rooturl());
792 html("'><img src='");
794 html("' alt='cgit logo'/></a></td>\n");
797 html("<td class='main'>");
799 cgit_index_link("index", NULL, NULL, NULL, NULL, 0);
801 cgit_summary_link(ctx->repo->name, ctx->repo->name, NULL, NULL);
802 html("</td><td class='form'>");
803 html("<form method='get' action=''>\n");
804 cgit_add_hidden_formfields(0, 1, ctx->qry.page);
805 html("<select name='h' onchange='this.form.submit();'>\n");
806 for_each_branch_ref(print_branch_option, ctx->qry.head);
808 html("<input type='submit' name='' value='switch'/>");
811 html_txt(ctx->cfg.root_title);
812 html("</td></tr>\n");
814 html("<tr><td class='sub'>");
816 html_txt(ctx->repo->desc);
817 html("</td><td class='sub right'>");
818 html_txt(ctx->repo->owner);
820 if (ctx->cfg.root_desc)
821 html_txt(ctx->cfg.root_desc);
822 else if (ctx->cfg.index_info)
823 html_include(ctx->cfg.index_info);
825 html("</td></tr></table>\n");
828 void cgit_print_pageheader(struct cgit_context *ctx)
830 html("<div id='cgit'>");
831 if (!ctx->cfg.noheader)
834 html("<table class='tabs'><tr><td>\n");
836 cgit_summary_link("summary", NULL, hc(ctx, "summary"),
838 cgit_refs_link("refs", NULL, hc(ctx, "refs"), ctx->qry.head,
839 ctx->qry.sha1, NULL);
840 cgit_log_link("log", NULL, hc(ctx, "log"), ctx->qry.head,
841 NULL, ctx->qry.vpath, 0, NULL, NULL,
843 cgit_tree_link("tree", NULL, hc(ctx, "tree"), ctx->qry.head,
844 ctx->qry.sha1, ctx->qry.vpath);
845 cgit_commit_link("commit", NULL, hc(ctx, "commit"),
846 ctx->qry.head, ctx->qry.sha1, ctx->qry.vpath, 0);
847 cgit_diff_link("diff", NULL, hc(ctx, "diff"), ctx->qry.head,
848 ctx->qry.sha1, ctx->qry.sha2, ctx->qry.vpath, 0);
849 if (ctx->repo->max_stats)
850 cgit_stats_link("stats", NULL, hc(ctx, "stats"),
851 ctx->qry.head, ctx->qry.vpath);
852 if (ctx->repo->readme)
853 reporevlink("about", "about", NULL,
854 hc(ctx, "about"), ctx->qry.head, NULL,
856 html("</td><td class='form'>");
857 html("<form class='right' method='get' action='");
858 if (ctx->cfg.virtual_root)
859 html_url_path(cgit_fileurl(ctx->qry.repo, "log",
860 ctx->qry.vpath, NULL));
862 cgit_add_hidden_formfields(1, 0, "log");
863 html("<select name='qt'>\n");
864 html_option("grep", "log msg", ctx->qry.grep);
865 html_option("author", "author", ctx->qry.grep);
866 html_option("committer", "committer", ctx->qry.grep);
867 html_option("range", "range", ctx->qry.grep);
869 html("<input class='txt' type='text' size='10' name='q' value='");
870 html_attr(ctx->qry.search);
872 html("<input type='submit' value='search'/>\n");
875 site_link(NULL, "index", NULL, hc(ctx, "repolist"), NULL, NULL, 0);
876 if (ctx->cfg.root_readme)
877 site_link("about", "about", NULL, hc(ctx, "about"),
879 html("</td><td class='form'>");
880 html("<form method='get' action='");
881 html_attr(cgit_rooturl());
883 html("<input type='text' name='q' size='10' value='");
884 html_attr(ctx->qry.search);
886 html("<input type='submit' value='search'/>\n");
889 html("</td></tr></table>\n");
890 if (ctx->qry.vpath) {
891 html("<div class='path'>");
893 cgit_print_path_crumbs(ctx, ctx->qry.vpath);
896 html("<div class='content'>");
899 void cgit_print_filemode(unsigned short mode)
903 else if (S_ISLNK(mode))
905 else if (S_ISGITLINK(mode))
909 html_fileperm(mode >> 6);
910 html_fileperm(mode >> 3);
914 void cgit_print_snapshot_links(const char *repo, const char *head,
915 const char *hex, int snapshots)
917 const struct cgit_snapshot_format* f;
920 unsigned char sha1[20];
922 if (get_sha1(fmt("refs/tags/%s", hex), sha1) == 0 &&
923 (hex[0] == 'v' || hex[0] == 'V') && isdigit(hex[1]))
925 prefix = xstrdup(fmt("%s-%s", cgit_repobasename(repo), hex));
926 for (f = cgit_snapshot_formats; f->suffix; f++) {
927 if (!(snapshots & f->bit))
929 filename = fmt("%s%s", prefix, f->suffix);
930 cgit_snapshot_link(filename, NULL, NULL, NULL, NULL, filename);