From c2188a840bc4153ae92112b04b2e06a90d3944aa Mon Sep 17 00:00:00 2001 From: Paul Martin <paul@paulsputer.com> Date: Wed, 27 Apr 2016 18:58:06 -0400 Subject: [PATCH] Ticket Reference handling #1048 --- src/main/java/com/gitblit/utils/GitBlitDiffFormatter.java | 103 ++++++++++++++++++++++++++++++++++++++------------- 1 files changed, 77 insertions(+), 26 deletions(-) diff --git a/src/main/java/com/gitblit/utils/GitBlitDiffFormatter.java b/src/main/java/com/gitblit/utils/GitBlitDiffFormatter.java index b18093f..8ebadbf 100644 --- a/src/main/java/com/gitblit/utils/GitBlitDiffFormatter.java +++ b/src/main/java/com/gitblit/utils/GitBlitDiffFormatter.java @@ -19,8 +19,10 @@ import static org.eclipse.jgit.lib.Constants.encodeASCII; import java.io.IOException; +import java.nio.charset.StandardCharsets; import java.text.MessageFormat; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; @@ -31,9 +33,11 @@ import org.eclipse.jgit.diff.DiffEntry.ChangeType; import org.eclipse.jgit.diff.DiffFormatter; import org.eclipse.jgit.diff.RawText; +import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.util.RawParseUtils; import com.gitblit.models.PathModel.PathChangeModel; +import com.gitblit.utils.DiffUtils.BinaryDiffHandler; import com.gitblit.utils.DiffUtils.DiffStat; import com.gitblit.wicket.GitBlitWebApp; @@ -71,7 +75,9 @@ */ private static final int GLOBAL_DIFF_LIMIT = 20000; - private final ResettableByteArrayOutputStream os; + private static final boolean CONVERT_TABS = true; + + private final DiffOutputStream os; private final DiffStat diffStat; @@ -122,10 +128,49 @@ /** If {@link #truncated}, contains all entries skipped. */ private final List<DiffEntry> skipped = new ArrayList<DiffEntry>(); - public GitBlitDiffFormatter(String commitId, String path) { - super(new ResettableByteArrayOutputStream()); - this.os = (ResettableByteArrayOutputStream) getOutputStream(); - this.diffStat = new DiffStat(commitId); + private int tabLength; + + /** + * A {@link ResettableByteArrayOutputStream} that intercept the "Binary files differ" message produced + * by the super implementation. Unfortunately the super implementation has far too many things private; + * otherwise we'd just have re-implemented {@link GitBlitDiffFormatter#format(DiffEntry) format(DiffEntry)} + * completely without ever calling the super implementation. + */ + private static class DiffOutputStream extends ResettableByteArrayOutputStream { + + private static final String BINARY_DIFFERENCE = "Binary files differ\n"; + + private GitBlitDiffFormatter formatter; + private BinaryDiffHandler binaryDiffHandler; + + public void setFormatter(GitBlitDiffFormatter formatter, BinaryDiffHandler handler) { + this.formatter = formatter; + this.binaryDiffHandler = handler; + } + + @Override + public void write(byte[] b, int offset, int length) { + if (binaryDiffHandler != null + && RawParseUtils.decode(Arrays.copyOfRange(b, offset, offset + length)).contains(BINARY_DIFFERENCE)) + { + String binaryDiff = binaryDiffHandler.renderBinaryDiff(formatter.entry); + if (binaryDiff != null) { + byte[] bb = ("<tr><td colspan='4' align='center'>" + binaryDiff + "</td></tr>").getBytes(StandardCharsets.UTF_8); + super.write(bb, 0, bb.length); + return; + } + } + super.write(b, offset, length); + } + + } + + public GitBlitDiffFormatter(String commitId, Repository repository, String path, BinaryDiffHandler handler, int tabLength) { + super(new DiffOutputStream()); + this.os = (DiffOutputStream) getOutputStream(); + this.os.setFormatter(this, handler); + this.diffStat = new DiffStat(commitId, repository); + this.tabLength = tabLength; // If we have a full commitdiff, install maxima to avoid generating a super-long diff listing that // will only tax the browser too much. maxDiffLinesPerFile = path != null ? -1 : getLimit(DIFF_LIMIT_PER_FILE_KEY, 500, DIFF_LIMIT_PER_FILE); @@ -210,14 +255,14 @@ } StringBuilder sb = new StringBuilder(MessageFormat.format("<div class='header'><div class=\"diffHeader\" id=\"n{0}\"><i class=\"icon-file\"></i> ", id)); sb.append(StringUtils.escapeForHtml(path, false)).append("</div></div>"); - sb.append("<div class=\"diff\"><table><tbody>\n"); + sb.append("<div class=\"diff\"><table cellpadding='0'><tbody>\n"); os.write(sb.toString().getBytes()); } // Keep formatting, but if off, don't produce anything anymore. We just keep on counting. super.format(ent); if (!truncated) { // Close the table - os.write("</tbody></table></div><br />\n".getBytes()); + os.write("</tbody></table></div>\n".getBytes()); } } @@ -235,13 +280,7 @@ private void reset() { if (!isOff) { os.resetTo(startCurrent); - try { - os.write("<tr><td class='diff-cell' colspan='4'>".getBytes()); - os.write(StringUtils.escapeForHtml(getMsg("gb.diffFileDiffTooLarge", "Diff too large"), false).getBytes()); - os.write("</td></tr>\n".getBytes()); - } catch (IOException ex) { - // Cannot happen with a ByteArrayOutputStream - } + writeFullWidthLine(getMsg("gb.diffFileDiffTooLarge", "Diff too large")); totalNofLinesCurrent = totalNofLinesPrevious; isOff = true; } @@ -277,13 +316,7 @@ default: return; } - try { - os.write("<tr><td class='diff-cell' colspan='4'>".getBytes()); - os.write(StringUtils.escapeForHtml(message, false).getBytes()); - os.write("</td></tr>\n".getBytes()); - } catch (IOException ex) { - // Cannot happen with a ByteArrayOutputStream - } + writeFullWidthLine(message); } /** @@ -355,6 +388,22 @@ } } + /** + * Writes a line spanning the full width of the code view, including the gutter. + * + * @param text + * to put on that line; will be HTML-escaped. + */ + private void writeFullWidthLine(String text) { + try { + os.write("<tr><td class='diff-cell' colspan='4'>".getBytes()); + os.write(StringUtils.escapeForHtml(text, false).getBytes()); + os.write("</td></tr>\n".getBytes()); + } catch (IOException ex) { + // Cannot happen with a ByteArrayOutputStream + } + } + @Override protected void writeLine(final char prefix, final RawText text, final int cur) throws IOException { if (nofLinesCurrent++ == 0) { @@ -408,14 +457,14 @@ // Highlight trailing whitespace on deleted/added lines. Matcher matcher = trailingWhitespace.matcher(line); if (matcher.find()) { - StringBuilder result = new StringBuilder(StringUtils.escapeForHtml(line.substring(0, matcher.start()), false)); + StringBuilder result = new StringBuilder(StringUtils.escapeForHtml(line.substring(0, matcher.start()), CONVERT_TABS, tabLength)); result.append("<span class='trailingws-").append(prefix == '+' ? "add" : "sub").append("'>"); result.append(StringUtils.escapeForHtml(matcher.group(1), false)); result.append("</span>"); return result.toString(); } } - return StringUtils.escapeForHtml(line, false); + return StringUtils.escapeForHtml(line, CONVERT_TABS, tabLength); } /** @@ -428,7 +477,8 @@ String[] lines = html.split("\n"); StringBuilder sb = new StringBuilder(); for (String line : lines) { - if (line.startsWith("index")) { + if (line.startsWith("index") || line.startsWith("similarity") + || line.startsWith("rename from ") || line.startsWith("rename to ")) { // skip index lines } else if (line.startsWith("new file") || line.startsWith("deleted file")) { // skip new file lines @@ -447,19 +497,20 @@ } else { sb.append("<th class='diff-state diff-state-sub'></th><td class=\"diff-cell remove2\">"); } - line = StringUtils.escapeForHtml(line.substring(1), false); + line = StringUtils.escapeForHtml(line.substring(1), CONVERT_TABS, tabLength); } sb.append(line); if (gitLinkDiff) { sb.append("</td></tr>"); } + sb.append('\n'); } } if (truncated) { sb.append(MessageFormat.format("<div class='header'><div class='diffHeader'>{0}</div></div>", StringUtils.escapeForHtml(getMsg("gb.diffTruncated", "Diff truncated after the above file"), false))); // List all files not shown. We can be sure we do have at least one path in skipped. - sb.append("<div class='diff'><table><tbody><tr><td class='diff-cell' colspan='4'>"); + sb.append("<div class='diff'><table cellpadding='0'><tbody><tr><td class='diff-cell' colspan='4'>"); String deletedSuffix = StringUtils.escapeForHtml(getMsg("gb.diffDeletedFileSkipped", "(deleted)"), false); boolean first = true; for (DiffEntry entry : skipped) { -- Gitblit v1.9.1