ui-shared.c

   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
  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";
  16
  17 static 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
  30 void cgit_print_error(char *msg)
  31 {
  32         html("<div class='error'>");
  33         html_txt(msg);
  34         html("</div>\n");
  35 }
  36
  37 char *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
  45 char *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
  54 char *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
  74 char *cgit_pageurl(const char *reponame, const char *pagename,
  75                    const char *query)
  76 {
  77         return cgit_fileurl(reponame,pagename,0,query);
  78 }
  79
  80 const 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
 105 char *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
 117 static 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
 144 static 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
 165 void 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
 171 static 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
 224 static 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
 240 void 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
 246 void 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
 277 void 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
 289 void 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
 295 void 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
 301 void 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
 323 void 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
 329 void 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
 356 void cgit_print_date(time_t secs, char *format)
 357 {
 358         char buf[64];
 359         struct tm *time;
 360
 361         if (!secs)
 362                 return;
 363         time = gmtime(&secs);
 364         strftime(buf, sizeof(buf)-1, format, time);
 365         html_txt(buf);
 366 }
 367
 368 void cgit_print_age(time_t t, time_t max_relative, char *format)
 369 {
 370         time_t now, secs;
 371
 372         if (!t)
 373                 return;
 374         time(&now);
 375         secs = now - t;
 376
 377         if (secs > max_relative && max_relative >= 0) {
 378                 cgit_print_date(t, format);
 379                 return;
 380         }
 381
 382         if (secs < TM_HOUR * 2) {
 383                 htmlf("<span class='age-mins'>%.0f min.</span>",
 384                       secs * 1.0 / TM_MIN);
 385                 return;
 386         }
 387         if (secs < TM_DAY * 2) {
 388                 htmlf("<span class='age-hours'>%.0f hours</span>",
 389                       secs * 1.0 / TM_HOUR);
 390                 return;
 391         }
 392         if (secs < TM_WEEK * 2) {
 393                 htmlf("<span class='age-days'>%.0f days</span>",
 394                       secs * 1.0 / TM_DAY);
 395                 return;
 396         }
 397         if (secs < TM_MONTH * 2) {
 398                 htmlf("<span class='age-weeks'>%.0f weeks</span>",
 399                       secs * 1.0 / TM_WEEK);
 400                 return;
 401         }
 402         if (secs < TM_YEAR * 2) {
 403                 htmlf("<span class='age-months'>%.0f months</span>",
 404                       secs * 1.0 / TM_MONTH);
 405                 return;
 406         }
 407         htmlf("<span class='age-years'>%.0f years</span>",
 408               secs * 1.0 / TM_YEAR);
 409 }
 410
 411 void cgit_print_http_headers(struct cgit_context *ctx)
 412 {
 413         if (ctx->page.mimetype && ctx->page.charset)
 414                 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
 415                       ctx->page.charset);
 416         else if (ctx->page.mimetype)
 417                 htmlf("Content-Type: %s\n", ctx->page.mimetype);
 418         if (ctx->page.filename)
 419                 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
 420                       ctx->page.filename);
 421         htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
 422         htmlf("Expires: %s\n", http_date(ctx->page.expires));
 423         html("\n");
 424 }
 425
 426 void cgit_print_docstart(struct cgit_context *ctx)
 427 {
 428         html(cgit_doctype);
 429         html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
 430         html("<head>\n");
 431         html("<title>");
 432         html_txt(ctx->page.title);
 433         html("</title>\n");
 434         htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
 435         if (ctx->cfg.robots && *ctx->cfg.robots)
 436                 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
 437         html("<link rel='stylesheet' type='text/css' href='");
 438         html_attr(ctx->cfg.css);
 439         html("'/>\n");
 440         if (ctx->cfg.favicon) {
 441                 html("<link rel='shortcut icon' href='");
 442                 html_attr(ctx->cfg.favicon);
 443                 html("'/>\n");
 444         }
 445         html("</head>\n");
 446         html("<body>\n");
 447 }
 448
 449 void cgit_print_docend()
 450 {
 451         html("</div>");
 452         if (ctx.cfg.footer)
 453                 html_include(ctx.cfg.footer);
 454         else {
 455                 html("<div class='footer'>generated ");
 456                 cgit_print_date(time(NULL), FMT_LONGDATE);
 457                 htmlf(" by cgit %s", cgit_version);
 458                 html("</div>\n");
 459         }
 460         html("</body>\n</html>\n");
 461 }
 462
 463 int print_branch_option(const char *refname, const unsigned char *sha1,
 464                         int flags, void *cb_data)
 465 {
 466         char *name = (char *)refname;
 467         html_option(name, name, ctx.qry.head);
 468         return 0;
 469 }
 470
 471 int print_archive_ref(const char *refname, const unsigned char *sha1,
 472                        int flags, void *cb_data)
 473 {
 474         struct tag *tag;
 475         struct taginfo *info;
 476         struct object *obj;
 477         char buf[256], *url;
 478         unsigned char fileid[20];
 479         int *header = (int *)cb_data;
 480
 481         if (prefixcmp(refname, "refs/archives"))
 482                 return 0;
 483         strncpy(buf, refname+14, sizeof(buf));
 484         obj = parse_object(sha1);
 485         if (!obj)
 486                 return 1;
 487         if (obj->type == OBJ_TAG) {
 488                 tag = lookup_tag(sha1);
 489                 if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
 490                         return 0;
 491                 hashcpy(fileid, tag->tagged->sha1);
 492         } else if (obj->type != OBJ_BLOB) {
 493                 return 0;
 494         } else {
 495                 hashcpy(fileid, sha1);
 496         }
 497         if (!*header) {
 498                 html("<h1>download</h1>\n");
 499                 *header = 1;
 500         }
 501         url = cgit_pageurl(ctx.qry.repo, "blob",
 502                            fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
 503                                buf));
 504         html_link_open(url, NULL, "menu");
 505         html_txt(strlpart(buf, 20));
 506         html_link_close();
 507         return 0;
 508 }
 509
 510 void add_hidden_formfields(int incl_head, int incl_search, char *page)
 511 {
 512         char *url;
 513
 514         if (!ctx.cfg.virtual_root) {
 515                 url = fmt("%s/%s", ctx.qry.repo, page);
 516                 if (ctx.qry.path)
 517                         url = fmt("%s/%s", url, ctx.qry.path);
 518                 html_hidden("url", url);
 519         }
 520
 521         if (incl_head && strcmp(ctx.qry.head, ctx.repo->defbranch))
 522                 html_hidden("h", ctx.qry.head);
 523
 524         if (ctx.qry.sha1)
 525                 html_hidden("id", ctx.qry.sha1);
 526         if (ctx.qry.sha2)
 527                 html_hidden("id2", ctx.qry.sha2);
 528
 529         if (incl_search) {
 530                 if (ctx.qry.grep)
 531                         html_hidden("qt", ctx.qry.grep);
 532                 if (ctx.qry.search)
 533                         html_hidden("q", ctx.qry.search);
 534         }
 535 }
 536
 537 char *hc(struct cgit_cmd *cmd, const char *page)
 538 {
 539         return (strcmp(cmd->name, page) ? NULL : "active");
 540 }
 541
 542 void cgit_print_pageheader(struct cgit_context *ctx)
 543 {
 544         struct cgit_cmd *cmd = cgit_get_cmd(ctx);
 545
 546         html("<table id='header'>\n");
 547         html("<tr>\n");
 548         html("<td class='logo' rowspan='2'><a href='");
 549         if (ctx->cfg.logo_link)
 550                 html_attr(ctx->cfg.logo_link);
 551         else
 552                 html_attr(cgit_rooturl());
 553         html("'><img src='");
 554         html_attr(ctx->cfg.logo);
 555         html("' alt='cgit logo'/></a></td>\n");
 556
 557         html("<td class='main'>");
 558         if (ctx->repo) {
 559                 cgit_index_link("index", NULL, NULL, NULL, 0);
 560                 html(" : ");
 561                 reporevlink(NULL, ctx->repo->name, NULL, hc(cmd, "summary"),
 562                             ctx->qry.head, NULL, NULL);
 563                 html("</td><td class='form'>");
 564                 html("<form method='get' action=''>\n");
 565                 add_hidden_formfields(0, 1, ctx->qry.page);
 566                 html("<select name='h' onchange='this.form.submit();'>\n");
 567                 for_each_branch_ref(print_branch_option, ctx->qry.head);
 568                 html("</select> ");
 569                 html("<input type='submit' name='' value='switch'/>");
 570                 html("</form>");
 571         } else
 572                 html_txt(ctx->cfg.root_title);
 573         html("</td></tr>\n");
 574
 575         html("<tr><td class='sub'");
 576         if (ctx->repo) {
 577                 html(" colspan='2'>");
 578                 html_txt(ctx->repo->desc);
 579         } else {
 580                 html(">");
 581                 if (ctx->cfg.root_desc)
 582                         html_txt(ctx->cfg.root_desc);
 583                 else if (ctx->cfg.index_info)
 584                         html_include(ctx->cfg.index_info);
 585         }
 586         html("</td></tr></table>\n");
 587
 588         html("<table class='tabs'><tr><td>\n");
 589         if (ctx->repo) {
 590                 reporevlink(NULL, "summary", NULL, hc(cmd, "summary"),
 591                             ctx->qry.head, NULL, NULL);
 592                 cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
 593                                ctx->qry.sha1, NULL);
 594                 cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
 595                               NULL, NULL, 0, NULL, NULL);
 596                 cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
 597                                ctx->qry.sha1, NULL);
 598                 cgit_commit_link("commit", NULL, hc(cmd, "commit"),
 599                                  ctx->qry.head, ctx->qry.sha1);
 600                 cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
 601                                ctx->qry.sha1, ctx->qry.sha2, NULL);
 602                 if (ctx->repo->readme)
 603                         reporevlink("about", "about", NULL,
 604                                     hc(cmd, "about"), ctx->qry.head, NULL,
 605                                     NULL);
 606                 html("</td><td class='form'>");
 607                 html("<form class='right' method='get' action='");
 608                 if (ctx->cfg.virtual_root)
 609                         html_attr(cgit_fileurl(ctx->qry.repo, "log",
 610                                                ctx->qry.path, NULL));
 611                 html("'>\n");
 612                 add_hidden_formfields(1, 0, "log");
 613                 html("<select name='qt'>\n");
 614                 html_option("grep", "log msg", ctx->qry.grep);
 615                 html_option("author", "author", ctx->qry.grep);
 616                 html_option("committer", "committer", ctx->qry.grep);
 617                 html("</select>\n");
 618                 html("<input class='txt' type='text' size='10' name='q' value='");
 619                 html_attr(ctx->qry.search);
 620                 html("'/>\n");
 621                 html("<input type='submit' value='search'/>\n");
 622                 html("</form>\n");
 623         } else {
 624                 site_link(NULL, "index", NULL, hc(cmd, "repolist"), NULL, 0);
 625                 if (ctx->cfg.root_readme)
 626                         site_link("about", "about", NULL, hc(cmd, "about"),
 627                                   NULL, 0);
 628                 html("</td><td class='form'>");
 629                 html("<form method='get' action='");
 630                 html_attr(cgit_rooturl());
 631                 html("'>\n");
 632                 html("<input type='text' name='q' size='10' value='");
 633                 html_attr(ctx->qry.search);
 634                 html("'/>\n");
 635                 html("<input type='submit' value='search'/>\n");
 636                 html("</form>");
 637         }
 638         html("</td></tr></table>\n");
 639         html("<div class='content'>");
 640 }
 641
 642 void cgit_print_filemode(unsigned short mode)
 643 {
 644         if (S_ISDIR(mode))
 645                 html("d");
 646         else if (S_ISLNK(mode))
 647                 html("l");
 648         else if (S_ISGITLINK(mode))
 649                 html("m");
 650         else
 651                 html("-");
 652         html_fileperm(mode >> 6);
 653         html_fileperm(mode >> 3);
 654         html_fileperm(mode);
 655 }
 656
 657 void cgit_print_snapshot_links(const char *repo, const char *head,
 658                                const char *hex, int snapshots)
 659 {
 660         const struct cgit_snapshot_format* f;
 661         char *filename;
 662
 663         for (f = cgit_snapshot_formats; f->suffix; f++) {
 664                 if (!(snapshots & f->bit))
 665                         continue;
 666                 filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
 667                                f->suffix);
 668                 cgit_snapshot_link(filename, NULL, NULL, (char *)head,
 669                                    (char *)hex, filename);
 670                 html("<br/>");
 671         }
 672 }