ui-log.c

   1 /* ui-log.c: functions for log output
   2  *
   3  * Copyright (C) 2006-2014 cgit Development Team <cgit@lists.zx2c4.com>
   4  *
   5  * Licensed under GNU General Public License v2
   6  *   (see COPYING for full license text)
   7  */
   8
   9 #include "cgit.h"
  10 #include "ui-log.h"
  11 #include "html.h"
  12 #include "ui-shared.h"
  13 #include "argv-array.h"
  14
  15 static int files, add_lines, rem_lines, lines_counted;
  16
  17 /*
  18  * The list of available column colors in the commit graph.
  19  */
  20 static const char *column_colors_html[] = {
  21         "<span class='column1'>",
  22         "<span class='column2'>",
  23         "<span class='column3'>",
  24         "<span class='column4'>",
  25         "<span class='column5'>",
  26         "<span class='column6'>",
  27         "</span>",
  28 };
  29
  30 #define COLUMN_COLORS_HTML_MAX (ARRAY_SIZE(column_colors_html) - 1)
  31
  32 static void count_lines(char *line, int size)
  33 {
  34         if (size <= 0)
  35                 return;
  36
  37         if (line[0] == '+')
  38                 add_lines++;
  39
  40         else if (line[0] == '-')
  41                 rem_lines++;
  42 }
  43
  44 static void inspect_files(struct diff_filepair *pair)
  45 {
  46         unsigned long old_size = 0;
  47         unsigned long new_size = 0;
  48         int binary = 0;
  49
  50         files++;
  51         if (ctx.repo->enable_log_linecount)
  52                 cgit_diff_files(&pair->one->oid, &pair->two->oid, &old_size,
  53                                 &new_size, &binary, 0, ctx.qry.ignorews,
  54                                 count_lines);
  55 }
  56
  57 void show_commit_decorations(struct commit *commit)
  58 {
  59         const struct name_decoration *deco;
  60         static char buf[1024];
  61
  62         buf[sizeof(buf) - 1] = 0;
  63         deco = get_name_decoration(&commit->object);
  64         if (!deco)
  65                 return;
  66         html("<span class='decoration'>");
  67         while (deco) {
  68                 struct object_id peeled;
  69                 int is_annotated = 0;
  70                 strlcpy(buf, prettify_refname(deco->name), sizeof(buf));
  71                 switch(deco->type) {
  72                 case DECORATION_NONE:
  73                         /* If the git-core doesn't recognize it,
  74                          * don't display anything. */
  75                         break;
  76                 case DECORATION_REF_LOCAL:
  77                         cgit_log_link(buf, NULL, "branch-deco", buf, NULL,
  78                                 ctx.qry.vpath, 0, NULL, NULL,
  79                                 ctx.qry.showmsg, 0);
  80                         break;
  81                 case DECORATION_REF_TAG:
  82                         if (!peel_ref(deco->name, &peeled))
  83                                 is_annotated = !oidcmp(&commit->object.oid, &peeled);
  84                         cgit_tag_link(buf, NULL, is_annotated ? "tag-annotated-deco" : "tag-deco", buf);
  85                         break;
  86                 case DECORATION_REF_REMOTE:
  87                         if (!ctx.repo->enable_remote_branches)
  88                                 break;
  89                         cgit_log_link(buf, NULL, "remote-deco", NULL,
  90                                 oid_to_hex(&commit->object.oid),
  91                                 ctx.qry.vpath, 0, NULL, NULL,
  92                                 ctx.qry.showmsg, 0);
  93                         break;
  94                 default:
  95                         cgit_commit_link(buf, NULL, "deco", ctx.qry.head,
  96                                         oid_to_hex(&commit->object.oid),
  97                                         ctx.qry.vpath);
  98                         break;
  99                 }
 100                 deco = deco->next;
 101         }
 102         html("</span>");
 103 }
 104
 105 static void handle_rename(struct diff_filepair *pair)
 106 {
 107         /*
 108          * After we have seen a rename, we generate links to the previous
 109          * name of the file so that commit & diff views get fed the path
 110          * that is correct for the commit they are showing, avoiding the
 111          * need to walk the entire history leading back to every commit we
 112          * show in order detect renames.
 113          */
 114         if (0 != strcmp(ctx.qry.vpath, pair->two->path)) {
 115                 free(ctx.qry.vpath);
 116                 ctx.qry.vpath = xstrdup(pair->two->path);
 117         }
 118         inspect_files(pair);
 119 }
 120
 121 static int show_commit(struct commit *commit, struct rev_info *revs)
 122 {
 123         struct commit_list *parents = commit->parents;
 124         struct commit *parent;
 125         int found = 0, saved_fmt;
 126         struct diff_flags saved_flags = revs->diffopt.flags;
 127
 128         /* Always show if we're not in "follow" mode with a single file. */
 129         if (!ctx.qry.follow)
 130                 return 1;
 131
 132         /*
 133          * In "follow" mode, we don't show merges.  This is consistent with
 134          * "git log --follow -- <file>".
 135          */
 136         if (parents && parents->next)
 137                 return 0;
 138
 139         /*
 140          * If this is the root commit, do what rev_info tells us.
 141          */
 142         if (!parents)
 143                 return revs->show_root_diff;
 144
 145         /* When we get here we have precisely one parent. */
 146         parent = parents->item;
 147         /* If we can't parse the commit, let print_commit() report an error. */
 148         if (parse_commit(parent))
 149                 return 1;
 150
 151         files = 0;
 152         add_lines = 0;
 153         rem_lines = 0;
 154
 155         revs->diffopt.flags.recursive = 1;
 156         diff_tree_oid(&parent->maybe_tree->object.oid,
 157                       &commit->maybe_tree->object.oid,
 158                       "", &revs->diffopt);
 159         diffcore_std(&revs->diffopt);
 160
 161         found = !diff_queue_is_empty();
 162         saved_fmt = revs->diffopt.output_format;
 163         revs->diffopt.output_format = DIFF_FORMAT_CALLBACK;
 164         revs->diffopt.format_callback = cgit_diff_tree_cb;
 165         revs->diffopt.format_callback_data = handle_rename;
 166         diff_flush(&revs->diffopt);
 167         revs->diffopt.output_format = saved_fmt;
 168         revs->diffopt.flags = saved_flags;
 169
 170         lines_counted = 1;
 171         return found;
 172 }
 173
 174 static void print_commit(struct commit *commit, struct rev_info *revs)
 175 {
 176         struct commitinfo *info;
 177         int columns = revs->graph ? 4 : 3;
 178         struct strbuf graphbuf = STRBUF_INIT;
 179         struct strbuf msgbuf = STRBUF_INIT;
 180
 181         if (ctx.repo->enable_log_filecount)
 182                 columns++;
 183         if (ctx.repo->enable_log_linecount)
 184                 columns++;
 185
 186         if (revs->graph) {
 187                 /* Advance graph until current commit */
 188                 while (!graph_next_line(revs->graph, &graphbuf)) {
 189                         /* Print graph segment in otherwise empty table row */
 190                         html("<tr class='nohover'><td class='commitgraph'>");
 191                         html(graphbuf.buf);
 192                         htmlf("</td><td colspan='%d' /></tr>\n", columns);
 193                         strbuf_setlen(&graphbuf, 0);
 194                 }
 195                 /* Current commit's graph segment is now ready in graphbuf */
 196         }
 197
 198         info = cgit_parse_commit(commit);
 199         htmlf("<tr%s>", ctx.qry.showmsg ? " class='logheader'" : "");
 200
 201         if (revs->graph) {
 202                 /* Print graph segment for current commit */
 203                 html("<td class='commitgraph'>");
 204                 html(graphbuf.buf);
 205                 html("</td>");
 206                 strbuf_setlen(&graphbuf, 0);
 207         }
 208         else {
 209                 html("<td>");
 210                 cgit_print_age(info->committer_date, info->committer_tz, TM_WEEK * 2);
 211                 html("</td>");
 212         }
 213
 214         htmlf("<td%s>", ctx.qry.showmsg ? " class='logsubject'" : "");
 215         if (ctx.qry.showmsg) {
 216                 /* line-wrap long commit subjects instead of truncating them */
 217                 size_t subject_len = strlen(info->subject);
 218
 219                 if (subject_len > ctx.cfg.max_msg_len &&
 220                     ctx.cfg.max_msg_len >= 15) {
 221                         /* symbol for signaling line-wrap (in PAGE_ENCODING) */
 222                         const char wrap_symbol[] = { ' ', 0xE2, 0x86, 0xB5, 0 };
 223                         int i = ctx.cfg.max_msg_len - strlen(wrap_symbol);
 224
 225                         /* Rewind i to preceding space character */
 226                         while (i > 0 && !isspace(info->subject[i]))
 227                                 --i;
 228                         if (!i) /* Oops, zero spaces. Reset i */
 229                                 i = ctx.cfg.max_msg_len - strlen(wrap_symbol);
 230
 231                         /* add remainder starting at i to msgbuf */
 232                         strbuf_add(&msgbuf, info->subject + i, subject_len - i);
 233                         strbuf_trim(&msgbuf);
 234                         strbuf_add(&msgbuf, "\n\n", 2);
 235
 236                         /* Place wrap_symbol at position i in info->subject */
 237                         strlcpy(info->subject + i, wrap_symbol, subject_len - i + 1);
 238                 }
 239         }
 240         cgit_commit_link(info->subject, NULL, NULL, ctx.qry.head,
 241                          oid_to_hex(&commit->object.oid), ctx.qry.vpath);
 242         show_commit_decorations(commit);
 243         html("</td><td>");
 244         cgit_open_filter(ctx.repo->email_filter, info->author_email, "log");
 245         html_txt(info->author);
 246         cgit_close_filter(ctx.repo->email_filter);
 247
 248         if (revs->graph) {
 249                 html("</td><td>");
 250                 cgit_print_age(info->committer_date, info->committer_tz, TM_WEEK * 2);
 251         }
 252
 253         if (!lines_counted && (ctx.repo->enable_log_filecount ||
 254                                ctx.repo->enable_log_linecount)) {
 255                 files = 0;
 256                 add_lines = 0;
 257                 rem_lines = 0;
 258                 cgit_diff_commit(commit, inspect_files, ctx.qry.vpath);
 259         }
 260
 261         if (ctx.repo->enable_log_filecount)
 262                 htmlf("</td><td>%d", files);
 263         if (ctx.repo->enable_log_linecount)
 264                 htmlf("</td><td><span class='deletions'>-%d</span>/"
 265                         "<span class='insertions'>+%d</span>", rem_lines, add_lines);
 266
 267         html("</td></tr>\n");
 268
 269         if ((revs->graph && !graph_is_commit_finished(revs->graph))
 270                         || ctx.qry.showmsg) { /* Print a second table row */
 271                 html("<tr class='nohover-highlight'>");
 272
 273                 if (ctx.qry.showmsg) {
 274                         /* Concatenate commit message + notes in msgbuf */
 275                         if (info->msg && *(info->msg)) {
 276                                 strbuf_addstr(&msgbuf, info->msg);
 277                                 strbuf_addch(&msgbuf, '\n');
 278                         }
 279                         format_display_notes(&commit->object.oid,
 280                                              &msgbuf, PAGE_ENCODING, 0);
 281                         strbuf_addch(&msgbuf, '\n');
 282                         strbuf_ltrim(&msgbuf);
 283                 }
 284
 285                 if (revs->graph) {
 286                         int lines = 0;
 287
 288                         /* Calculate graph padding */
 289                         if (ctx.qry.showmsg) {
 290                                 /* Count #lines in commit message + notes */
 291                                 const char *p = msgbuf.buf;
 292                                 lines = 1;
 293                                 while ((p = strchr(p, '\n'))) {
 294                                         p++;
 295                                         lines++;
 296                                 }
 297                         }
 298
 299                         /* Print graph padding */
 300                         html("<td class='commitgraph'>");
 301                         while (lines > 0 || !graph_is_commit_finished(revs->graph)) {
 302                                 if (graphbuf.len)
 303                                         html("\n");
 304                                 strbuf_setlen(&graphbuf, 0);
 305                                 graph_next_line(revs->graph, &graphbuf);
 306                                 html(graphbuf.buf);
 307                                 lines--;
 308                         }
 309                         html("</td>\n");
 310                 }
 311                 else
 312                         html("<td/>"); /* Empty 'Age' column */
 313
 314                 /* Print msgbuf into remainder of table row */
 315                 htmlf("<td colspan='%d'%s>\n", columns - (revs->graph ? 1 : 0),
 316                         ctx.qry.showmsg ? " class='logmsg'" : "");
 317                 html_txt(msgbuf.buf);
 318                 html("</td></tr>\n");
 319         }
 320
 321         strbuf_release(&msgbuf);
 322         strbuf_release(&graphbuf);
 323         cgit_free_commitinfo(info);
 324 }
 325
 326 static const char *disambiguate_ref(const char *ref, int *must_free_result)
 327 {
 328         struct object_id oid;
 329         struct strbuf longref = STRBUF_INIT;
 330
 331         strbuf_addf(&longref, "refs/heads/%s", ref);
 332         if (get_oid(longref.buf, &oid) == 0) {
 333                 *must_free_result = 1;
 334                 return strbuf_detach(&longref, NULL);
 335         }
 336
 337         *must_free_result = 0;
 338         strbuf_release(&longref);
 339         return ref;
 340 }
 341
 342 static char *next_token(char **src)
 343 {
 344         char *result;
 345
 346         if (!src || !*src)
 347                 return NULL;
 348         while (isspace(**src))
 349                 (*src)++;
 350         if (!**src)
 351                 return NULL;
 352         result = *src;
 353         while (**src) {
 354                 if (isspace(**src)) {
 355                         **src = '\0';
 356                         (*src)++;
 357                         break;
 358                 }
 359                 (*src)++;
 360         }
 361         return result;
 362 }
 363
 364 void cgit_print_log(const char *tip, int ofs, int cnt, char *grep, char *pattern,
 365                     char *path, int pager, int commit_graph, int commit_sort)
 366 {
 367         struct rev_info rev;
 368         struct commit *commit;
 369         struct argv_array rev_argv = ARGV_ARRAY_INIT;
 370         int i, columns = commit_graph ? 4 : 3;
 371         int must_free_tip = 0;
 372
 373         /* rev_argv.argv[0] will be ignored by setup_revisions */
 374         argv_array_push(&rev_argv, "log_rev_setup");
 375
 376         if (!tip)
 377                 tip = ctx.qry.head;
 378         tip = disambiguate_ref(tip, &must_free_tip);
 379         argv_array_push(&rev_argv, tip);
 380
 381         if (grep && pattern && *pattern) {
 382                 pattern = xstrdup(pattern);
 383                 if (!strcmp(grep, "grep") || !strcmp(grep, "author") ||
 384                     !strcmp(grep, "committer")) {
 385                         argv_array_pushf(&rev_argv, "--%s=%s", grep, pattern);
 386                 } else if (!strcmp(grep, "range")) {
 387                         char *arg;
 388                         /* Split the pattern at whitespace and add each token
 389                          * as a revision expression. Do not accept other
 390                          * rev-list options. Also, replace the previously
 391                          * pushed tip (it's no longer relevant).
 392                          */
 393                         argv_array_pop(&rev_argv);
 394                         while ((arg = next_token(&pattern))) {
 395                                 if (*arg == '-') {
 396                                         fprintf(stderr, "Bad range expr: %s\n",
 397                                                 arg);
 398                                         break;
 399                                 }
 400                                 argv_array_push(&rev_argv, arg);
 401                         }
 402                 }
 403         }
 404
 405         if (!path || !ctx.cfg.enable_follow_links) {
 406                 /*
 407                  * If we don't have a path, "follow" is a no-op so make sure
 408                  * the variable is set to false to avoid needing to check
 409                  * both this and whether we have a path everywhere.
 410                  */
 411                 ctx.qry.follow = 0;
 412         }
 413
 414         if (commit_graph && !ctx.qry.follow) {
 415                 argv_array_push(&rev_argv, "--graph");
 416                 argv_array_push(&rev_argv, "--color");
 417                 graph_set_column_colors(column_colors_html,
 418                                         COLUMN_COLORS_HTML_MAX);
 419         }
 420
 421         if (commit_sort == 1)
 422                 argv_array_push(&rev_argv, "--date-order");
 423         else if (commit_sort == 2)
 424                 argv_array_push(&rev_argv, "--topo-order");
 425
 426         if (path && ctx.qry.follow)
 427                 argv_array_push(&rev_argv, "--follow");
 428         argv_array_push(&rev_argv, "--");
 429         if (path)
 430                 argv_array_push(&rev_argv, path);
 431
 432         init_revisions(&rev, NULL);
 433         rev.abbrev = DEFAULT_ABBREV;
 434         rev.commit_format = CMIT_FMT_DEFAULT;
 435         rev.verbose_header = 1;
 436         rev.show_root_diff = 0;
 437         rev.ignore_missing = 1;
 438         rev.simplify_history = 1;
 439         setup_revisions(rev_argv.argc, rev_argv.argv, &rev, NULL);
 440         load_ref_decorations(NULL, DECORATE_FULL_REFS);
 441         rev.show_decorations = 1;
 442         rev.grep_filter.ignore_case = 1;
 443
 444         rev.diffopt.detect_rename = 1;
 445         rev.diffopt.rename_limit = ctx.cfg.renamelimit;
 446         if (ctx.qry.ignorews)
 447                 DIFF_XDL_SET(&rev.diffopt, IGNORE_WHITESPACE);
 448
 449         compile_grep_patterns(&rev.grep_filter);
 450         prepare_revision_walk(&rev);
 451
 452         if (pager) {
 453                 cgit_print_layout_start();
 454                 html("<table class='list nowrap'>");
 455         }
 456
 457         html("<tr class='nohover'>");
 458         if (commit_graph)
 459                 html("<th></th>");
 460         else
 461                 html("<th class='left'>Age</th>");
 462         html("<th class='left'>Commit message");
 463         if (pager) {
 464                 html(" (");
 465                 cgit_log_link(ctx.qry.showmsg ? "Collapse" : "Expand", NULL,
 466                               NULL, ctx.qry.head, ctx.qry.sha1,
 467                               ctx.qry.vpath, ctx.qry.ofs, ctx.qry.grep,
 468                               ctx.qry.search, ctx.qry.showmsg ? 0 : 1,
 469                               ctx.qry.follow);
 470                 html(")");
 471         }
 472         html("</th><th class='left'>Author</th>");
 473         if (rev.graph)
 474                 html("<th class='left'>Age</th>");
 475         if (ctx.repo->enable_log_filecount) {
 476                 html("<th class='left'>Files</th>");
 477                 columns++;
 478         }
 479         if (ctx.repo->enable_log_linecount) {
 480                 html("<th class='left'>Lines</th>");
 481                 columns++;
 482         }
 483         html("</tr>\n");
 484
 485         if (ofs<0)
 486                 ofs = 0;
 487
 488         for (i = 0; i < ofs && (commit = get_revision(&rev)) != NULL; /* nop */) {
 489                 if (show_commit(commit, &rev))
 490                         i++;
 491                 free_commit_buffer(commit);
 492                 free_commit_list(commit->parents);
 493                 commit->parents = NULL;
 494         }
 495
 496         for (i = 0; i < cnt && (commit = get_revision(&rev)) != NULL; /* nop */) {
 497                 /*
 498                  * In "follow" mode, we must count the files and lines the
 499                  * first time we invoke diff on a given commit, and we need
 500                  * to do that to see if the commit touches the path we care
 501                  * about, so we do it in show_commit.  Hence we must clear
 502                  * lines_counted here.
 503                  *
 504                  * This has the side effect of avoiding running diff twice
 505                  * when we are both following renames and showing file
 506                  * and/or line counts.
 507                  */
 508                 lines_counted = 0;
 509                 if (show_commit(commit, &rev)) {
 510                         i++;
 511                         print_commit(commit, &rev);
 512                 }
 513                 free_commit_buffer(commit);
 514                 free_commit_list(commit->parents);
 515                 commit->parents = NULL;
 516         }
 517         if (pager) {
 518                 html("</table><ul class='pager'>");
 519                 if (ofs > 0) {
 520                         html("<li>");
 521                         cgit_log_link("[prev]", NULL, NULL, ctx.qry.head,
 522                                       ctx.qry.sha1, ctx.qry.vpath,
 523                                       ofs - cnt, ctx.qry.grep,
 524                                       ctx.qry.search, ctx.qry.showmsg,
 525                                       ctx.qry.follow);
 526                         html("</li>");
 527                 }
 528                 if ((commit = get_revision(&rev)) != NULL) {
 529                         html("<li>");
 530                         cgit_log_link("[next]", NULL, NULL, ctx.qry.head,
 531                                       ctx.qry.sha1, ctx.qry.vpath,
 532                                       ofs + cnt, ctx.qry.grep,
 533                                       ctx.qry.search, ctx.qry.showmsg,
 534                                       ctx.qry.follow);
 535                         html("</li>");
 536                 }
 537                 html("</ul>");
 538                 cgit_print_layout_end();
 539         } else if ((commit = get_revision(&rev)) != NULL) {
 540                 htmlf("<tr class='nohover'><td colspan='%d'>", columns);
 541                 cgit_log_link("[...]", NULL, NULL, ctx.qry.head, NULL,
 542                               ctx.qry.vpath, 0, NULL, NULL, ctx.qry.showmsg,
 543                               ctx.qry.follow);
 544                 html("</td></tr>\n");
 545         }
 546
 547         /* If we allocated tip then it is safe to cast away const. */
 548         if (must_free_tip)
 549                 free((char*) tip);
 550 }