| | |
|---|
| | | |
|---|
| | | import java.io.IOException; |
|---|
| | | import java.text.MessageFormat; |
|---|
| | | import java.util.HashMap; |
|---|
| | | import java.util.Map; |
|---|
| | | import java.util.ArrayList; |
|---|
| | | import java.util.List; |
|---|
| | | import java.util.regex.Matcher; |
|---|
| | | import java.util.regex.Pattern; |
|---|
| | | |
|---|
| | | import org.apache.wicket.Application; |
|---|
| | | import org.apache.wicket.Localizer; |
|---|
| | |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Generates an html snippet of a diff in Gitblit's style, tracks changed paths, and calculates diff stats. |
|---|
| | | * |
|---|
| | | * |
|---|
| | | * @author James Moger |
|---|
| | | * @author Tom <tw201207@gmail.com> |
|---|
| | | * |
|---|
| | | * |
|---|
| | | */ |
|---|
| | | public class GitBlitDiffFormatter extends DiffFormatter { |
|---|
| | | |
|---|
| | | /** Regex pattern identifying trailing whitespace. */ |
|---|
| | | private static final Pattern trailingWhitespace = Pattern.compile("(\\s+?)\r?\n?$"); |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * gitblit.properties key for the per-file limit on the number of diff lines. |
|---|
| | |
|---|
| | | private int truncateTo; |
|---|
| | | /** Whether we decided to truncate the commitdiff. */ |
|---|
| | | private boolean truncated; |
|---|
| | | /** If {@link #truncated}, contains all files skipped,possibly with a suffix message as value to be displayed. */ |
|---|
| | | private final Map<String, String> skipped = new HashMap<String, String>(); |
|---|
| | | /** If {@link #truncated}, contains all entries skipped. */ |
|---|
| | | private final List<DiffEntry> skipped = new ArrayList<DiffEntry>(); |
|---|
| | | |
|---|
| | | public GitBlitDiffFormatter(String commitId, String path) { |
|---|
| | | super(new ResettableByteArrayOutputStream()); |
|---|
| | |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Determines a limit to use for HTML diff output. |
|---|
| | | * |
|---|
| | | * |
|---|
| | | * @param key |
|---|
| | | * to use to read the value from the GitBlit settings, if available. |
|---|
| | | * @param minimum |
|---|
| | |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Returns a localized message string, if there is a localization; otherwise the given default value. |
|---|
| | | * |
|---|
| | | * |
|---|
| | | * @param key |
|---|
| | | * message key for the message |
|---|
| | | * @param defaultValue |
|---|
| | |
|---|
| | | } else { |
|---|
| | | isOff = true; |
|---|
| | | } |
|---|
| | | if (isOff) { |
|---|
| | | if (ent.getChangeType().equals(ChangeType.DELETE)) { |
|---|
| | | skipped.put(ent.getOldPath(), getMsg("gb.diffDeletedFileSkipped", "(deleted file)")); |
|---|
| | | if (truncated) { |
|---|
| | | skipped.add(ent); |
|---|
| | | } else { |
|---|
| | | // Produce a header here and now |
|---|
| | | String path; |
|---|
| | | String id; |
|---|
| | | if (ChangeType.DELETE.equals(ent.getChangeType())) { |
|---|
| | | path = ent.getOldPath(); |
|---|
| | | id = ent.getOldId().name(); |
|---|
| | | } else { |
|---|
| | | skipped.put(ent.getNewPath(), null); |
|---|
| | | path = ent.getNewPath(); |
|---|
| | | id = ent.getNewId().name(); |
|---|
| | | } |
|---|
| | | 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"); |
|---|
| | | 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()); |
|---|
| | | } |
|---|
| | | } |
|---|
| | | |
|---|
| | | @Override |
|---|
| | |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Output a hunk header |
|---|
| | | * |
|---|
| | | * |
|---|
| | | * @param aStartLine |
|---|
| | | * within first source |
|---|
| | | * @param aEndLine |
|---|
| | |
|---|
| | | os.write("<td class='diff-cell context2'>".getBytes()); |
|---|
| | | break; |
|---|
| | | } |
|---|
| | | String line = text.getString(cur); |
|---|
| | | line = StringUtils.escapeForHtml(line, false); |
|---|
| | | os.write(encode(line)); |
|---|
| | | os.write(encode(codeLineToHtml(prefix, text.getString(cur)))); |
|---|
| | | os.write("</td></tr>\n".getBytes()); |
|---|
| | | } |
|---|
| | | } |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Convert the given code line to HTML. |
|---|
| | | * |
|---|
| | | * @param prefix |
|---|
| | | * the diff prefix (+/-) indicating whether the line was added or removed. |
|---|
| | | * @param line |
|---|
| | | * the line to format as HTML |
|---|
| | | * @return the HTML-formatted line, safe for inserting as is into HTML. |
|---|
| | | */ |
|---|
| | | private String codeLineToHtml(final char prefix, final String line) { |
|---|
| | | if ((prefix == '+' || prefix == '-')) { |
|---|
| | | // 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)); |
|---|
| | | 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); |
|---|
| | | } |
|---|
| | | |
|---|
| | | /** |
|---|
| | | * Workaround function for complex private methods in DiffFormatter. This sets the html for the diff headers. |
|---|
| | | * |
|---|
| | | * |
|---|
| | | * @return |
|---|
| | | */ |
|---|
| | | public String getHtml() { |
|---|
| | | String html = RawParseUtils.decode(os.toByteArray()); |
|---|
| | | String[] lines = html.split("\n"); |
|---|
| | | StringBuilder sb = new StringBuilder(); |
|---|
| | | boolean inFile = false; |
|---|
| | | String oldnull = "a/dev/null"; |
|---|
| | | for (String line : lines) { |
|---|
| | | if (line.startsWith("index")) { |
|---|
| | | // skip index lines |
|---|
| | |
|---|
| | | } else if (line.startsWith("---") || line.startsWith("+++")) { |
|---|
| | | // skip --- +++ lines |
|---|
| | | } else if (line.startsWith("diff")) { |
|---|
| | | line = StringUtils.convertOctal(line); |
|---|
| | | if (line.indexOf(oldnull) > -1) { |
|---|
| | | // a is null, use b |
|---|
| | | line = line.substring(("diff --git " + oldnull).length()).trim(); |
|---|
| | | // trim b/ |
|---|
| | | line = line.substring(2).trim(); |
|---|
| | | } else { |
|---|
| | | // use a |
|---|
| | | line = line.substring("diff --git ".length()).trim(); |
|---|
| | | line = line.substring(line.startsWith("\"a/") ? 3 : 2); |
|---|
| | | line = line.substring(0, line.indexOf(" b/") > -1 ? line.indexOf(" b/") : line.indexOf("\"b/")).trim(); |
|---|
| | | } |
|---|
| | | |
|---|
| | | if (line.charAt(0) == '"') { |
|---|
| | | line = line.substring(1); |
|---|
| | | } |
|---|
| | | if (line.charAt(line.length() - 1) == '"') { |
|---|
| | | line = line.substring(0, line.length() - 1); |
|---|
| | | } |
|---|
| | | if (inFile) { |
|---|
| | | sb.append("</tbody></table></div>\n"); |
|---|
| | | inFile = false; |
|---|
| | | } |
|---|
| | | |
|---|
| | | sb.append(MessageFormat.format("<div class='header'><div class=\"diffHeader\" id=\"{0}\"><i class=\"icon-file\"></i> ", line)).append(line) |
|---|
| | | .append("</div></div>"); |
|---|
| | | sb.append("<div class=\"diff\">"); |
|---|
| | | sb.append("<table><tbody>"); |
|---|
| | | inFile = true; |
|---|
| | | // skip diff lines |
|---|
| | | } else { |
|---|
| | | boolean gitLinkDiff = line.length() > 0 && line.substring(1).startsWith("Subproject commit"); |
|---|
| | | if (gitLinkDiff) { |
|---|
| | |
|---|
| | | } else { |
|---|
| | | sb.append("<th class='diff-state diff-state-sub'></th><td class=\"diff-cell remove2\">"); |
|---|
| | | } |
|---|
| | | line = StringUtils.escapeForHtml(line.substring(1), false); |
|---|
| | | } |
|---|
| | | sb.append(line); |
|---|
| | | if (gitLinkDiff) { |
|---|
| | |
|---|
| | | } |
|---|
| | | } |
|---|
| | | } |
|---|
| | | sb.append("</tbody></table></div>"); |
|---|
| | | 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'>"); |
|---|
| | | String deletedSuffix = StringUtils.escapeForHtml(getMsg("gb.diffDeletedFileSkipped", "(deleted)"), false); |
|---|
| | | boolean first = true; |
|---|
| | | for (Map.Entry<String, String> s : skipped.entrySet()) { |
|---|
| | | for (DiffEntry entry : skipped) { |
|---|
| | | if (!first) { |
|---|
| | | sb.append('\n'); |
|---|
| | | } |
|---|
| | | String path = StringUtils.escapeForHtml(s.getKey(), false); |
|---|
| | | String comment = s.getValue(); |
|---|
| | | if (comment != null) { |
|---|
| | | sb.append("<span id='" + path + "'>" + path + ' ' + StringUtils.escapeForHtml(comment, false) + "</span>"); |
|---|
| | | if (ChangeType.DELETE.equals(entry.getChangeType())) { |
|---|
| | | sb.append("<span id=\"n" + entry.getOldId().name() + "\">" + StringUtils.escapeForHtml(entry.getOldPath(), false) + ' ' + deletedSuffix + "</span>"); |
|---|
| | | } else { |
|---|
| | | sb.append("<span id='" + path + "'>" + path + "</span>"); |
|---|
| | | sb.append("<span id=\"n" + entry.getNewId().name() + "\">" + StringUtils.escapeForHtml(entry.getNewPath(), false) + "</span>"); |
|---|
| | | } |
|---|
| | | first = false; |
|---|
| | | } |
|---|
| | | skipped.clear(); |
|---|
| | | sb.append("</td></tr></tbody></table></div>"); |
|---|
| | | } |
|---|
| | | return sb.toString(); |
|---|
