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,'/');
126 if (!ctx.cfg.virtual_root)
127 return ctx.cfg.script_name;
128 else if (ctx.qry.page)
129 return fmt("%s/%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo, ctx.qry.page);
130 else if (ctx.qry.repo)
131 return fmt("%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo);
133 return fmt("%s/", ctx.cfg.virtual_root);
136 static void site_url(const char *page, const char *search, int ofs)
140 if (ctx.cfg.virtual_root) {
141 html_attr(ctx.cfg.virtual_root);
142 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
145 html(ctx.cfg.script_name);
148 htmlf("?p=%s", page);
159 htmlf("ofs=%d", ofs);
163 static void site_link(const char *page, const char *name, const char *title,
164 const char *class, const char *search, int ofs)
178 site_url(page, search, ofs);
184 void cgit_index_link(const char *name, const char *title, const char *class,
185 const char *pattern, int ofs)
187 site_link(NULL, name, title, class, pattern, ofs);
190 static char *repolink(const char *title, const char *class, const char *page,
191 const char *head, const char *path)
207 if (ctx.cfg.virtual_root) {
208 html_url_path(ctx.cfg.virtual_root);
209 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
211 html_url_path(ctx.repo->url);
212 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
221 html(ctx.cfg.script_name);
223 html_url_arg(ctx.repo->url);
224 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
234 if (head && strcmp(head, ctx.repo->defbranch)) {
240 return fmt("%s", delim);
243 static void reporevlink(const char *page, const char *name, const char *title,
244 const char *class, const char *head, const char *rev,
249 delim = repolink(title, class, page, head, path);
250 if (rev && ctx.qry.head != NULL && strcmp(rev, ctx.qry.head)) {
260 void cgit_summary_link(const char *name, const char *title, const char *class,
263 reporevlink(NULL, name, title, class, head, NULL, NULL);
266 void cgit_tag_link(const char *name, const char *title, const char *class,
267 const char *head, const char *rev)
269 reporevlink("tag", name, title, class, head, rev, NULL);
272 void cgit_tree_link(const char *name, const char *title, const char *class,
273 const char *head, const char *rev, const char *path)
275 reporevlink("tree", name, title, class, head, rev, path);
278 void cgit_plain_link(const char *name, const char *title, const char *class,
279 const char *head, const char *rev, const char *path)
281 reporevlink("plain", name, title, class, head, rev, path);
284 void cgit_log_link(const char *name, const char *title, const char *class,
285 const char *head, const char *rev, const char *path,
286 int ofs, const char *grep, const char *pattern, int showmsg)
290 delim = repolink(title, class, "log", head, path);
291 if (rev && strcmp(rev, ctx.qry.head)) {
297 if (grep && pattern) {
304 html_url_arg(pattern);
321 void cgit_commit_link(char *name, const char *title, const char *class,
322 const char *head, const char *rev, const char *path,
325 if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
326 name[ctx.cfg.max_msg_len] = '\0';
327 name[ctx.cfg.max_msg_len - 1] = '.';
328 name[ctx.cfg.max_msg_len - 2] = '.';
329 name[ctx.cfg.max_msg_len - 3] = '.';
334 delim = repolink(title, class, "commit", head, path);
335 if (rev && strcmp(rev, ctx.qry.head)) {
341 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
350 void cgit_refs_link(const char *name, const char *title, const char *class,
351 const char *head, const char *rev, const char *path)
353 reporevlink("refs", name, title, class, head, rev, path);
356 void cgit_snapshot_link(const char *name, const char *title, const char *class,
357 const char *head, const char *rev,
358 const char *archivename)
360 reporevlink("snapshot", name, title, class, head, rev, archivename);
363 void cgit_diff_link(const char *name, const char *title, const char *class,
364 const char *head, const char *new_rev, const char *old_rev,
365 const char *path, int toggle_ssdiff)
369 delim = repolink(title, class, "diff", head, path);
370 if (new_rev && ctx.qry.head != NULL && strcmp(new_rev, ctx.qry.head)) {
373 html_url_arg(new_rev);
379 html_url_arg(old_rev);
382 if ((ctx.qry.ssdiff && !toggle_ssdiff) || (!ctx.qry.ssdiff && toggle_ssdiff)) {
391 void cgit_patch_link(const char *name, const char *title, const char *class,
392 const char *head, const char *rev, const char *path)
394 reporevlink("patch", name, title, class, head, rev, path);
397 void cgit_stats_link(const char *name, const char *title, const char *class,
398 const char *head, const char *path)
400 reporevlink("stats", name, title, class, head, NULL, path);
403 void cgit_self_link(char *name, const char *title, const char *class,
404 struct cgit_context *ctx)
406 if (!strcmp(ctx->qry.page, "repolist"))
407 return cgit_index_link(name, title, class, ctx->qry.search,
409 else if (!strcmp(ctx->qry.page, "summary"))
410 return cgit_summary_link(name, title, class, ctx->qry.head);
411 else if (!strcmp(ctx->qry.page, "tag"))
412 return cgit_tag_link(name, title, class, ctx->qry.head,
413 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL);
414 else if (!strcmp(ctx->qry.page, "tree"))
415 return cgit_tree_link(name, title, class, ctx->qry.head,
416 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
418 else if (!strcmp(ctx->qry.page, "plain"))
419 return cgit_plain_link(name, title, class, ctx->qry.head,
420 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
422 else if (!strcmp(ctx->qry.page, "log"))
423 return cgit_log_link(name, title, class, ctx->qry.head,
424 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
425 ctx->qry.path, ctx->qry.ofs,
426 ctx->qry.grep, ctx->qry.search,
428 else if (!strcmp(ctx->qry.page, "commit"))
429 return cgit_commit_link(name, title, class, ctx->qry.head,
430 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
432 else if (!strcmp(ctx->qry.page, "patch"))
433 return cgit_patch_link(name, title, class, ctx->qry.head,
434 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
436 else if (!strcmp(ctx->qry.page, "refs"))
437 return cgit_refs_link(name, title, class, ctx->qry.head,
438 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
440 else if (!strcmp(ctx->qry.page, "snapshot"))
441 return cgit_snapshot_link(name, title, class, ctx->qry.head,
442 ctx->qry.has_sha1 ? ctx->qry.sha1 : NULL,
444 else if (!strcmp(ctx->qry.page, "diff"))
445 return cgit_diff_link(name, title, class, ctx->qry.head,
446 ctx->qry.sha1, ctx->qry.sha2,
448 else if (!strcmp(ctx->qry.page, "stats"))
449 return cgit_stats_link(name, title, class, ctx->qry.head,
452 /* Don't known how to make link for this page */
453 repolink(title, class, ctx->qry.page, ctx->qry.head, ctx->qry.path);
454 html("><!-- cgit_self_link() doesn't know how to make link for page '");
455 html_txt(ctx->qry.page);
461 void cgit_object_link(struct object *obj)
463 char *page, *shortrev, *fullrev, *name;
465 fullrev = sha1_to_hex(obj->sha1);
466 shortrev = xstrdup(fullrev);
468 if (obj->type == OBJ_COMMIT) {
469 cgit_commit_link(fmt("commit %s...", shortrev), NULL, NULL,
470 ctx.qry.head, fullrev, NULL, 0);
472 } else if (obj->type == OBJ_TREE)
474 else if (obj->type == OBJ_TAG)
478 name = fmt("%s %s...", typename(obj->type), shortrev);
479 reporevlink(page, name, NULL, NULL, ctx.qry.head, fullrev, NULL);
482 void cgit_print_date(time_t secs, const char *format, int local_time)
490 time = localtime(&secs);
492 time = gmtime(&secs);
493 strftime(buf, sizeof(buf)-1, format, time);
497 void cgit_print_age(time_t t, time_t max_relative, const char *format)
506 if (secs > max_relative && max_relative >= 0) {
507 cgit_print_date(t, format, ctx.cfg.local_time);
511 if (secs < TM_HOUR * 2) {
512 htmlf("<span class='age-mins'>%.0f min.</span>",
513 secs * 1.0 / TM_MIN);
516 if (secs < TM_DAY * 2) {
517 htmlf("<span class='age-hours'>%.0f hours</span>",
518 secs * 1.0 / TM_HOUR);
521 if (secs < TM_WEEK * 2) {
522 htmlf("<span class='age-days'>%.0f days</span>",
523 secs * 1.0 / TM_DAY);
526 if (secs < TM_MONTH * 2) {
527 htmlf("<span class='age-weeks'>%.0f weeks</span>",
528 secs * 1.0 / TM_WEEK);
531 if (secs < TM_YEAR * 2) {
532 htmlf("<span class='age-months'>%.0f months</span>",
533 secs * 1.0 / TM_MONTH);
536 htmlf("<span class='age-years'>%.0f years</span>",
537 secs * 1.0 / TM_YEAR);
540 void cgit_print_http_headers(struct cgit_context *ctx)
542 if (ctx->env.no_http && !strcmp(ctx->env.no_http, "1"))
545 if (ctx->page.status)
546 htmlf("Status: %d %s\n", ctx->page.status, ctx->page.statusmsg);
547 if (ctx->page.mimetype && ctx->page.charset)
548 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
550 else if (ctx->page.mimetype)
551 htmlf("Content-Type: %s\n", ctx->page.mimetype);
553 htmlf("Content-Length: %ld\n", ctx->page.size);
554 if (ctx->page.filename)
555 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
557 htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
558 htmlf("Expires: %s\n", http_date(ctx->page.expires));
560 htmlf("ETag: \"%s\"\n", ctx->page.etag);
562 if (ctx->env.request_method && !strcmp(ctx->env.request_method, "HEAD"))
566 void cgit_print_docstart(struct cgit_context *ctx)
568 if (ctx->cfg.embedded) {
570 html_include(ctx->cfg.header);
574 char *host = cgit_hosturl();
576 html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
579 html_txt(ctx->page.title);
581 htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
582 if (ctx->cfg.robots && *ctx->cfg.robots)
583 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
584 html("<link rel='stylesheet' type='text/css' href='");
585 html_attr(ctx->cfg.css);
587 if (ctx->cfg.favicon) {
588 html("<link rel='shortcut icon' href='");
589 html_attr(ctx->cfg.favicon);
592 if (host && ctx->repo) {
593 html("<link rel='alternate' title='Atom feed' href='");
594 html(cgit_httpscheme());
595 html_attr(cgit_hosturl());
596 html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.vpath,
597 fmt("h=%s", ctx->qry.head)));
598 html("' type='application/atom+xml'/>\n");
600 if (ctx->cfg.head_include)
601 html_include(ctx->cfg.head_include);
605 html_include(ctx->cfg.header);
608 void cgit_print_docend()
610 html("</div> <!-- class=content -->\n");
611 if (ctx.cfg.embedded) {
612 html("</div> <!-- id=cgit -->\n");
614 html_include(ctx.cfg.footer);
618 html_include(ctx.cfg.footer);
620 htmlf("<div class='footer'>generated by cgit %s at ",
622 cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
625 html("</div> <!-- id=cgit -->\n");
626 html("</body>\n</html>\n");
629 int print_branch_option(const char *refname, const unsigned char *sha1,
630 int flags, void *cb_data)
632 char *name = (char *)refname;
633 html_option(name, name, ctx.qry.head);
637 int print_archive_ref(const char *refname, const unsigned char *sha1,
638 int flags, void *cb_data)
641 struct taginfo *info;
644 unsigned char fileid[20];
645 int *header = (int *)cb_data;
647 if (prefixcmp(refname, "refs/archives"))
649 strncpy(buf, refname+14, sizeof(buf));
650 obj = parse_object(sha1);
653 if (obj->type == OBJ_TAG) {
654 tag = lookup_tag(sha1);
655 if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
657 hashcpy(fileid, tag->tagged->sha1);
658 } else if (obj->type != OBJ_BLOB) {
661 hashcpy(fileid, sha1);
664 html("<h1>download</h1>\n");
667 url = cgit_pageurl(ctx.qry.repo, "blob",
668 fmt("id=%s&path=%s", sha1_to_hex(fileid),
670 html_link_open(url, NULL, "menu");
671 html_txt(strlpart(buf, 20));
676 void cgit_add_hidden_formfields(int incl_head, int incl_search,
681 if (!ctx.cfg.virtual_root) {
682 url = fmt("%s/%s", ctx.qry.repo, page);
684 url = fmt("%s/%s", url, ctx.qry.vpath);
685 html_hidden("url", url);
688 if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
689 strcmp(ctx.qry.head, ctx.repo->defbranch))
690 html_hidden("h", ctx.qry.head);
693 html_hidden("id", ctx.qry.sha1);
695 html_hidden("id2", ctx.qry.sha2);
697 html_hidden("showmsg", "1");
701 html_hidden("qt", ctx.qry.grep);
703 html_hidden("q", ctx.qry.search);
707 static const char *hc(struct cgit_context *ctx, const char *page)
709 return strcmp(ctx->qry.page, page) ? NULL : "active";
712 static void cgit_print_path_crumbs(struct cgit_context *ctx, char *path)
714 char *old_path = ctx->qry.path;
715 char *p = path, *q, *end = path + strlen(path);
717 ctx->qry.path = NULL;
718 cgit_self_link("root", NULL, NULL, ctx);
719 ctx->qry.path = p = path;
721 if (!(q = strchr(p, '/')))
725 cgit_self_link(p, NULL, NULL, ctx);
730 ctx->qry.path = old_path;
733 static void print_header(struct cgit_context *ctx)
735 html("<table id='header'>\n");
738 if (ctx->cfg.logo && ctx->cfg.logo[0] != 0) {
739 html("<td class='logo' rowspan='2'><a href='");
740 if (ctx->cfg.logo_link)
741 html_attr(ctx->cfg.logo_link);
743 html_attr(cgit_rooturl());
744 html("'><img src='");
745 html_attr(ctx->cfg.logo);
746 html("' alt='cgit logo'/></a></td>\n");
749 html("<td class='main'>");
751 cgit_index_link("index", NULL, NULL, NULL, 0);
753 cgit_summary_link(ctx->repo->name, ctx->repo->name, NULL, NULL);
754 html("</td><td class='form'>");
755 html("<form method='get' action=''>\n");
756 cgit_add_hidden_formfields(0, 1, ctx->qry.page);
757 html("<select name='h' onchange='this.form.submit();'>\n");
758 for_each_branch_ref(print_branch_option, ctx->qry.head);
760 html("<input type='submit' name='' value='switch'/>");
763 html_txt(ctx->cfg.root_title);
764 html("</td></tr>\n");
766 html("<tr><td class='sub'>");
768 html_txt(ctx->repo->desc);
769 html("</td><td class='sub right'>");
770 html_txt(ctx->repo->owner);
772 if (ctx->cfg.root_desc)
773 html_txt(ctx->cfg.root_desc);
774 else if (ctx->cfg.index_info)
775 html_include(ctx->cfg.index_info);
777 html("</td></tr></table>\n");
780 void cgit_print_pageheader(struct cgit_context *ctx)
782 html("<div id='cgit'>");
783 if (!ctx->cfg.noheader)
786 html("<table class='tabs'><tr><td>\n");
788 cgit_summary_link("summary", NULL, hc(ctx, "summary"),
790 cgit_refs_link("refs", NULL, hc(ctx, "refs"), ctx->qry.head,
791 ctx->qry.sha1, NULL);
792 cgit_log_link("log", NULL, hc(ctx, "log"), ctx->qry.head,
793 NULL, NULL, 0, NULL, NULL, ctx->qry.showmsg);
794 cgit_tree_link("tree", NULL, hc(ctx, "tree"), ctx->qry.head,
795 ctx->qry.sha1, NULL);
796 cgit_commit_link("commit", NULL, hc(ctx, "commit"),
797 ctx->qry.head, ctx->qry.sha1, NULL, 0);
798 cgit_diff_link("diff", NULL, hc(ctx, "diff"), ctx->qry.head,
799 ctx->qry.sha1, ctx->qry.sha2, NULL, 0);
800 if (ctx->repo->max_stats)
801 cgit_stats_link("stats", NULL, hc(ctx, "stats"),
802 ctx->qry.head, NULL);
803 if (ctx->repo->readme)
804 reporevlink("about", "about", NULL,
805 hc(ctx, "about"), ctx->qry.head, NULL,
807 html("</td><td class='form'>");
808 html("<form class='right' method='get' action='");
809 if (ctx->cfg.virtual_root)
810 html_url_path(cgit_fileurl(ctx->qry.repo, "log",
811 ctx->qry.vpath, NULL));
813 cgit_add_hidden_formfields(1, 0, "log");
814 html("<select name='qt'>\n");
815 html_option("grep", "log msg", ctx->qry.grep);
816 html_option("author", "author", ctx->qry.grep);
817 html_option("committer", "committer", ctx->qry.grep);
819 html("<input class='txt' type='text' size='10' name='q' value='");
820 html_attr(ctx->qry.search);
822 html("<input type='submit' value='search'/>\n");
825 site_link(NULL, "index", NULL, hc(ctx, "repolist"), NULL, 0);
826 if (ctx->cfg.root_readme)
827 site_link("about", "about", NULL, hc(ctx, "about"),
829 html("</td><td class='form'>");
830 html("<form method='get' action='");
831 html_attr(cgit_rooturl());
833 html("<input type='text' name='q' size='10' value='");
834 html_attr(ctx->qry.search);
836 html("<input type='submit' value='search'/>\n");
839 html("</td></tr></table>\n");
840 if (ctx->qry.vpath) {
841 html("<div class='path'>");
843 cgit_print_path_crumbs(ctx, ctx->qry.vpath);
846 html("<div class='content'>");
849 void cgit_print_filemode(unsigned short mode)
853 else if (S_ISLNK(mode))
855 else if (S_ISGITLINK(mode))
859 html_fileperm(mode >> 6);
860 html_fileperm(mode >> 3);
864 void cgit_print_snapshot_links(const char *repo, const char *head,
865 const char *hex, int snapshots)
867 const struct cgit_snapshot_format* f;
870 unsigned char sha1[20];
872 if (get_sha1(fmt("refs/tags/%s", hex), sha1) == 0 &&
873 (hex[0] == 'v' || hex[0] == 'V') && isdigit(hex[1]))
875 prefix = xstrdup(fmt("%s-%s", cgit_repobasename(repo), hex));
876 for (f = cgit_snapshot_formats; f->suffix; f++) {
877 if (!(snapshots & f->bit))
879 filename = fmt("%s%s", prefix, f->suffix);
880 cgit_snapshot_link(filename, NULL, NULL, NULL, NULL, filename);