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