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 char *repolink(char *title, char *class, char *page, char *head,
 118                       char *path)
 119 {
 120         char *delim = "?";
 121
 122         html("<a");
 123         if (title) {
 124                 html(" title='");
 125                 html_attr(title);
 126                 html("'");
 127         }
 128         if (class) {
 129                 html(" class='");
 130                 html_attr(class);
 131                 html("'");
 132         }
 133         html(" href='");
 134         if (ctx.cfg.virtual_root) {
 135                 html_attr(ctx.cfg.virtual_root);
 136                 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
 137                         html("/");
 138                 html_attr(ctx.repo->url);
 139                 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
 140                         html("/");
 141                 if (page) {
 142                         html(page);
 143                         html("/");
 144                         if (path)
 145                                 html_attr(path);
 146                 }
 147         } else {
 148                 html(ctx.cfg.script_name);
 149                 html("?url=");
 150                 html_attr(ctx.repo->url);
 151                 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
 152                         html("/");
 153                 if (page) {
 154                         html(page);
 155                         html("/");
 156                         if (path)
 157                                 html_attr(path);
 158                 }
 159                 delim = "&amp;";
 160         }
 161         if (head && strcmp(head, ctx.repo->defbranch)) {
 162                 html(delim);
 163                 html("h=");
 164                 html_attr(head);
 165                 delim = "&amp;";
 166         }
 167         return fmt("%s", delim);
 168 }
 169
 170 static void reporevlink(char *page, char *name, char *title, char *class,
 171                         char *head, char *rev, char *path)
 172 {
 173         char *delim;
 174
 175         delim = repolink(title, class, page, head, path);
 176         if (rev && strcmp(rev, ctx.qry.head)) {
 177                 html(delim);
 178                 html("id=");
 179                 html_attr(rev);
 180         }
 181         html("'>");
 182         html_txt(name);
 183         html("</a>");
 184 }
 185
 186 void cgit_tree_link(char *name, char *title, char *class, char *head,
 187                     char *rev, char *path)
 188 {
 189         reporevlink("tree", name, title, class, head, rev, path);
 190 }
 191
 192 void cgit_log_link(char *name, char *title, char *class, char *head,
 193                    char *rev, char *path, int ofs, char *grep, char *pattern)
 194 {
 195         char *delim;
 196
 197         delim = repolink(title, class, "log", head, path);
 198         if (rev && strcmp(rev, ctx.qry.head)) {
 199                 html(delim);
 200                 html("id=");
 201                 html_attr(rev);
 202                 delim = "&";
 203         }
 204         if (grep && pattern) {
 205                 html(delim);
 206                 html("qt=");
 207                 html_attr(grep);
 208                 delim = "&";
 209                 html(delim);
 210                 html("q=");
 211                 html_attr(pattern);
 212         }
 213         if (ofs > 0) {
 214                 html(delim);
 215                 html("ofs=");
 216                 htmlf("%d", ofs);
 217         }
 218         html("'>");
 219         html_txt(name);
 220         html("</a>");
 221 }
 222
 223 void cgit_commit_link(char *name, char *title, char *class, char *head,
 224                       char *rev)
 225 {
 226         if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
 227                 name[ctx.cfg.max_msg_len] = '\0';
 228                 name[ctx.cfg.max_msg_len - 1] = '.';
 229                 name[ctx.cfg.max_msg_len - 2] = '.';
 230                 name[ctx.cfg.max_msg_len - 3] = '.';
 231         }
 232         reporevlink("commit", name, title, class, head, rev, NULL);
 233 }
 234
 235 void cgit_refs_link(char *name, char *title, char *class, char *head,
 236                     char *rev, char *path)
 237 {
 238         reporevlink("refs", name, title, class, head, rev, path);
 239 }
 240
 241 void cgit_snapshot_link(char *name, char *title, char *class, char *head,
 242                         char *rev, char *archivename)
 243 {
 244         reporevlink("snapshot", name, title, class, head, rev, archivename);
 245 }
 246
 247 void cgit_diff_link(char *name, char *title, char *class, char *head,
 248                     char *new_rev, char *old_rev, char *path)
 249 {
 250         char *delim;
 251
 252         delim = repolink(title, class, "diff", head, path);
 253         if (new_rev && strcmp(new_rev, ctx.qry.head)) {
 254                 html(delim);
 255                 html("id=");
 256                 html_attr(new_rev);
 257                 delim = "&amp;";
 258         }
 259         if (old_rev) {
 260                 html(delim);
 261                 html("id2=");
 262                 html_attr(old_rev);
 263         }
 264         html("'>");
 265         html_txt(name);
 266         html("</a>");
 267 }
 268
 269 void cgit_patch_link(char *name, char *title, char *class, char *head,
 270                      char *rev)
 271 {
 272         reporevlink("patch", name, title, class, head, rev, NULL);
 273 }
 274
 275 void cgit_object_link(struct object *obj)
 276 {
 277         char *page, *arg, *url;
 278
 279         if (obj->type == OBJ_COMMIT) {
 280                 cgit_commit_link(fmt("commit %s", sha1_to_hex(obj->sha1)), NULL, NULL,
 281                                  ctx.qry.head, sha1_to_hex(obj->sha1));
 282                 return;
 283         } else if (obj->type == OBJ_TREE) {
 284                 page = "tree";
 285                 arg = "id";
 286         } else if (obj->type == OBJ_TAG) {
 287                 page = "tag";
 288                 arg = "id";
 289         } else {
 290                 page = "blob";
 291                 arg = "id";
 292         }
 293
 294         url = cgit_pageurl(ctx.qry.repo, page,
 295                            fmt("%s=%s", arg, sha1_to_hex(obj->sha1)));
 296         html_link_open(url, NULL, NULL);
 297         htmlf("%s %s", typename(obj->type),
 298               sha1_to_hex(obj->sha1));
 299         html_link_close();
 300 }
 301
 302 void cgit_print_date(time_t secs, char *format)
 303 {
 304         char buf[64];
 305         struct tm *time;
 306
 307         if (!secs)
 308                 return;
 309         time = gmtime(&secs);
 310         strftime(buf, sizeof(buf)-1, format, time);
 311         html_txt(buf);
 312 }
 313
 314 void cgit_print_age(time_t t, time_t max_relative, char *format)
 315 {
 316         time_t now, secs;
 317
 318         if (!t)
 319                 return;
 320         time(&now);
 321         secs = now - t;
 322
 323         if (secs > max_relative && max_relative >= 0) {
 324                 cgit_print_date(t, format);
 325                 return;
 326         }
 327
 328         if (secs < TM_HOUR * 2) {
 329                 htmlf("<span class='age-mins'>%.0f min.</span>",
 330                       secs * 1.0 / TM_MIN);
 331                 return;
 332         }
 333         if (secs < TM_DAY * 2) {
 334                 htmlf("<span class='age-hours'>%.0f hours</span>",
 335                       secs * 1.0 / TM_HOUR);
 336                 return;
 337         }
 338         if (secs < TM_WEEK * 2) {
 339                 htmlf("<span class='age-days'>%.0f days</span>",
 340                       secs * 1.0 / TM_DAY);
 341                 return;
 342         }
 343         if (secs < TM_MONTH * 2) {
 344                 htmlf("<span class='age-weeks'>%.0f weeks</span>",
 345                       secs * 1.0 / TM_WEEK);
 346                 return;
 347         }
 348         if (secs < TM_YEAR * 2) {
 349                 htmlf("<span class='age-months'>%.0f months</span>",
 350                       secs * 1.0 / TM_MONTH);
 351                 return;
 352         }
 353         htmlf("<span class='age-years'>%.0f years</span>",
 354               secs * 1.0 / TM_YEAR);
 355 }
 356
 357 void cgit_print_http_headers(struct cgit_context *ctx)
 358 {
 359         if (ctx->page.mimetype && ctx->page.charset)
 360                 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
 361                       ctx->page.charset);
 362         else if (ctx->page.mimetype)
 363                 htmlf("Content-Type: %s\n", ctx->page.mimetype);
 364         if (ctx->page.filename)
 365                 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
 366                       ctx->page.filename);
 367         htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
 368         htmlf("Expires: %s\n", http_date(ctx->page.expires));
 369         html("\n");
 370 }
 371
 372 void cgit_print_docstart(struct cgit_context *ctx)
 373 {
 374         html(cgit_doctype);
 375         html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
 376         html("<head>\n");
 377         html("<title>");
 378         html_txt(ctx->page.title);
 379         html("</title>\n");
 380         htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
 381         if (ctx->cfg.robots && *ctx->cfg.robots)
 382                 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
 383         html("<link rel='stylesheet' type='text/css' href='");
 384         html_attr(ctx->cfg.css);
 385         html("'/>\n");
 386         html("</head>\n");
 387         html("<body>\n");
 388 }
 389
 390 void cgit_print_docend()
 391 {
 392         html("</td>\n</tr>\n</table>\n</body>\n</html>\n");
 393 }
 394
 395 int print_branch_option(const char *refname, const unsigned char *sha1,
 396                         int flags, void *cb_data)
 397 {
 398         char *name = (char *)refname;
 399         html_option(name, name, ctx.qry.head);
 400         return 0;
 401 }
 402
 403 int print_archive_ref(const char *refname, const unsigned char *sha1,
 404                        int flags, void *cb_data)
 405 {
 406         struct tag *tag;
 407         struct taginfo *info;
 408         struct object *obj;
 409         char buf[256], *url;
 410         unsigned char fileid[20];
 411         int *header = (int *)cb_data;
 412
 413         if (prefixcmp(refname, "refs/archives"))
 414                 return 0;
 415         strncpy(buf, refname+14, sizeof(buf));
 416         obj = parse_object(sha1);
 417         if (!obj)
 418                 return 1;
 419         if (obj->type == OBJ_TAG) {
 420                 tag = lookup_tag(sha1);
 421                 if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
 422                         return 0;
 423                 hashcpy(fileid, tag->tagged->sha1);
 424         } else if (obj->type != OBJ_BLOB) {
 425                 return 0;
 426         } else {
 427                 hashcpy(fileid, sha1);
 428         }
 429         if (!*header) {
 430                 html("<h1>download</h1>\n");
 431                 *header = 1;
 432         }
 433         url = cgit_pageurl(ctx.qry.repo, "blob",
 434                            fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
 435                                buf));
 436         html_link_open(url, NULL, "menu");
 437         html_txt(strlpart(buf, 20));
 438         html_link_close();
 439         return 0;
 440 }
 441
 442 void add_hidden_formfields(int incl_head, int incl_search, char *page)
 443 {
 444         char *url;
 445
 446         if (!ctx.cfg.virtual_root) {
 447                 url = fmt("%s/%s", ctx.qry.repo, page);
 448                 if (ctx.qry.path)
 449                         url = fmt("%s/%s", url, ctx.qry.path);
 450                 html_hidden("url", url);
 451         }
 452
 453         if (incl_head && strcmp(ctx.qry.head, ctx.repo->defbranch))
 454                 html_hidden("h", ctx.qry.head);
 455
 456         if (ctx.qry.sha1)
 457                 html_hidden("id", ctx.qry.sha1);
 458         if (ctx.qry.sha2)
 459                 html_hidden("id2", ctx.qry.sha2);
 460
 461         if (incl_search) {
 462                 if (ctx.qry.grep)
 463                         html_hidden("qt", ctx.qry.grep);
 464                 if (ctx.qry.search)
 465                         html_hidden("q", ctx.qry.search);
 466         }
 467 }
 468
 469 char *hc(struct cgit_cmd *cmd, const char *page)
 470 {
 471         return (strcmp(cmd->name, page) ? NULL : "active");
 472 }
 473
 474 void cgit_print_pageheader(struct cgit_context *ctx)
 475 {
 476         struct cgit_cmd *cmd = cgit_get_cmd(ctx);
 477
 478         html("<table id='header'>\n");
 479         html("<tr>\n");
 480         html("<td class='logo' rowspan='2'><a href='");
 481         if (ctx->cfg.logo_link)
 482                 html_attr(ctx->cfg.logo_link);
 483         else
 484                 html_attr(cgit_rooturl());
 485         html("'><img src='");
 486         html_attr(ctx->cfg.logo);
 487         html("'/></a></td>\n");
 488         html("<td class='main'>");
 489         if (ctx->repo) {
 490                 html("<a href='");
 491                 html_attr(cgit_rooturl());
 492                 html("'>index</a> / ");
 493                 html_txt(ctx->repo->name);
 494         } else
 495                 html_txt(ctx->cfg.root_title);
 496         html("</td></tr>\n");
 497         html("<tr><td class='sub'>");
 498         if (ctx->repo)
 499                 html_txt(ctx->repo->desc);
 500         else
 501                 html_txt(ctx->cfg.index_info);
 502         html("</td></tr>\n");
 503         html("</table>\n");
 504
 505         html("<table class='tabs'><tr><td>\n");
 506         if (ctx->repo) {
 507                 reporevlink(NULL, "summary", NULL, hc(cmd, "summary"),
 508                             ctx->qry.head, NULL, NULL);
 509                 cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
 510                                ctx->qry.sha1, NULL);
 511                 cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
 512                               NULL, NULL, 0, NULL, NULL);
 513                 cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
 514                                ctx->qry.sha1, NULL);
 515                 cgit_commit_link("commit", NULL, hc(cmd, "commit"),
 516                                  ctx->qry.head, ctx->qry.sha1);
 517                 cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
 518                                ctx->qry.sha1, ctx->qry.sha2, NULL);
 519                 cgit_patch_link("patch", NULL, hc(cmd, "patch"), ctx->qry.head,
 520                                 ctx->qry.sha1);
 521                 html("</td><td class='branch'>");
 522                 html("<form method='get' action=''>\n");
 523                 add_hidden_formfields(0, 1, ctx->qry.page);
 524                 html("<select name='h' onchange='this.form.submit();'>\n");
 525                 for_each_branch_ref(print_branch_option, ctx->qry.head);
 526                 html("</select> ");
 527                 html("<input type='submit' name='' value='switch'/>");
 528         } else {
 529                 html("<a class='active' href='");
 530                 html_attr(cgit_rooturl());
 531                 html("'>index</a>\n");
 532         }
 533         html("</td></tr></table>\n");
 534         html("<div class='content'>");
 535 }
 536
 537 void cgit_print_filemode(unsigned short mode)
 538 {
 539         if (S_ISDIR(mode))
 540                 html("d");
 541         else if (S_ISLNK(mode))
 542                 html("l");
 543         else if (S_ISGITLINK(mode))
 544                 html("m");
 545         else
 546                 html("-");
 547         html_fileperm(mode >> 6);
 548         html_fileperm(mode >> 3);
 549         html_fileperm(mode);
 550 }
 551
 552 void cgit_print_snapshot_links(const char *repo, const char *head,
 553                                const char *hex, int snapshots)
 554 {
 555         const struct cgit_snapshot_format* f;
 556         char *filename;
 557
 558         for (f = cgit_snapshot_formats; f->suffix; f++) {
 559                 if (!(snapshots & f->bit))
 560                         continue;
 561                 filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
 562                                f->suffix);
 563                 cgit_snapshot_link(filename, NULL, NULL, (char *)head,
 564                                    (char *)hex, filename);
 565                 html("<br/>");
 566         }
 567 }