/*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.vcs.log.ui.frame;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.VerticalFlowLayout;
import com.intellij.openapi.util.Comparing;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vcs.changes.issueLinks.IssueLinkHtmlRenderer;
import com.intellij.openapi.vcs.ui.FontUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.ui.ColorUtil;
import com.intellij.ui.JBColor;
import com.intellij.ui.UI;
import com.intellij.ui.components.JBPanel;
import com.intellij.ui.components.JBScrollPane;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.text.DateFormatUtil;
import com.intellij.util.ui.*;
import com.intellij.vcs.log.VcsFullCommitDetails;
import com.intellij.vcs.log.VcsRef;
import com.intellij.vcs.log.VcsUser;
import com.intellij.vcs.log.data.LoadingDetails;
import com.intellij.vcs.log.data.VcsLogData;
import com.intellij.vcs.log.ui.VcsLogColorManager;
import com.intellij.vcs.log.ui.render.RectanglePainter;
import com.intellij.vcs.log.ui.table.VcsLogGraphTable;
import com.intellij.vcs.log.util.VcsUserUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import javax.swing.event.HyperlinkEvent;
import javax.swing.text.DefaultCaret;
import javax.swing.text.Document;
import javax.swing.text.html.HTMLDocument;
import javax.swing.text.html.StyleSheet;
import java.awt.*;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
import static com.intellij.openapi.vcs.history.VcsHistoryUtil.getCommitDetailsFont;
public class CommitPanel extends JBPanel {
public static final int BOTTOM_BORDER = 2;
private static final int REFERENCES_BORDER = 12;
private static final int TOP_BORDER = 4;
@NotNull private final VcsLogData myLogData;
@NotNull private final ReferencesPanel myBranchesPanel;
@NotNull private final ReferencesPanel myTagsPanel;
@NotNull private final DataPanel myDataPanel;
@NotNull private final BranchesPanel myContainingBranchesPanel;
@NotNull private final RootPanel myRootPanel;
@NotNull private final VcsLogColorManager myColorManager;
@Nullable private VcsFullCommitDetails myCommit;
public CommitPanel(@NotNull VcsLogData logData, @NotNull VcsLogColorManager colorManager) {
myLogData = logData;
myColorManager = colorManager;
setLayout(new VerticalFlowLayout(VerticalFlowLayout.TOP, 0, 0, true, false));
setOpaque(false);
myRootPanel = new RootPanel();
myBranchesPanel = new ReferencesPanel();
myBranchesPanel.setBorder(JBUI.Borders.empty(REFERENCES_BORDER, 0, 0, 0));
myTagsPanel = new ReferencesPanel();
myTagsPanel.setBorder(JBUI.Borders.empty(REFERENCES_BORDER, 0, 0, 0));
myDataPanel = new DataPanel(myLogData.getProject());
myContainingBranchesPanel = new BranchesPanel();
add(myRootPanel);
add(myDataPanel);
add(myBranchesPanel);
add(myTagsPanel);
add(myContainingBranchesPanel);
setBorder(getDetailsBorder());
}
public void setCommit(@NotNull VcsFullCommitDetails commitData) {
if (!Comparing.equal(myCommit, commitData)) {
if (commitData instanceof LoadingDetails) {
myDataPanel.setData(null);
myRootPanel.setRoot("", null);
}
else {
myDataPanel.setData(commitData);
VirtualFile root = commitData.getRoot();
if (myColorManager.isMultipleRoots()) {
myRootPanel.setRoot(root.getName(), VcsLogGraphTable.getRootBackgroundColor(root, myColorManager));
}
else {
myRootPanel.setRoot("", null);
}
}
myCommit = commitData;
}
List<String> branches = null;
if (!(commitData instanceof LoadingDetails)) {
branches = myLogData.getContainingBranchesGetter().requestContainingBranches(commitData.getRoot(), commitData.getId());
}
myContainingBranchesPanel.setBranches(branches);
myDataPanel.update();
myContainingBranchesPanel.update();
revalidate();
}
public void setRefs(@NotNull Collection<VcsRef> refs) {
List<VcsRef> references = sortRefs(refs);
myBranchesPanel.setReferences(references.stream().filter(ref -> ref.getType().isBranch()).collect(Collectors.toList()));
myTagsPanel.setReferences(references.stream().filter(ref -> !ref.getType().isBranch()).collect(Collectors.toList()));
}
public void update() {
myDataPanel.update();
myRootPanel.update();
myBranchesPanel.update();
myTagsPanel.update();
myContainingBranchesPanel.update();
}
public void updateBranches() {
if (myCommit != null) {
myContainingBranchesPanel
.setBranches(myLogData.getContainingBranchesGetter().getContainingBranchesFromCache(myCommit.getRoot(), myCommit.getId()));
}
else {
myContainingBranchesPanel.setBranches(null);
}
myContainingBranchesPanel.update();
}
@NotNull
private List<VcsRef> sortRefs(@NotNull Collection<VcsRef> refs) {
VcsRef ref = ContainerUtil.getFirstItem(refs);
if (ref == null) return ContainerUtil.emptyList();
return ContainerUtil.sorted(refs, myLogData.getLogProvider(ref.getRoot()).getReferenceManager().getLabelsOrderComparator());
}
@NotNull
public static JBEmptyBorder getDetailsBorder() {
return JBUI.Borders.empty();
}
@Override
public Color getBackground() {
return getCommitDetailsBackground();
}
public boolean isExpanded() {
return myContainingBranchesPanel.isExpanded();
}
@NotNull
public static Color getCommitDetailsBackground() {
return UIUtil.getTableBackground();
}
@NotNull
public static String formatDateTime(long time) {
return " on " + DateFormatUtil.formatDate(time) + " at " + DateFormatUtil.formatTime(time);
}
private static class DataPanel extends HtmlPanel {
@NotNull private final Project myProject;
@Nullable private String myMainText;
DataPanel(@NotNull Project project) {
myProject = project;
DefaultCaret caret = (DefaultCaret)getCaret();
caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
setBorder(JBUI.Borders.empty(0, ReferencesPanel.H_GAP, BOTTOM_BORDER, 0));
}
@Override
public void updateUI() {
super.updateUI();
update();
}
void setData(@Nullable VcsFullCommitDetails commit) {
if (commit == null) {
myMainText = null;
}
else {
String hash = commit.getId().toShortString();
String hashAndAuthor = getHtmlWithFonts(hash + " " + getAuthorText(commit, hash.length() + 1));
String messageText = getMessageText(commit);
myMainText = messageText + "<br/><br/>" + hashAndAuthor;
}
}
private void customizeLinksStyle() {
Document document = getDocument();
if (document instanceof HTMLDocument) {
StyleSheet styleSheet = ((HTMLDocument)document).getStyleSheet();
String linkColor = "#" + ColorUtil.toHex(UI.getColor("link.foreground"));
styleSheet.addRule("a { color: " + linkColor + "; text-decoration: none;}");
}
}
@NotNull
private static String getHtmlWithFonts(@NotNull String input) {
return getHtmlWithFonts(input, getCommitDetailsFont().getStyle());
}
@NotNull
private static String getHtmlWithFonts(@NotNull String input, int style) {
return FontUtil.getHtmlWithFonts(input, style, getCommitDetailsFont());
}
void update() {
if (myMainText == null) {
setText("");
}
else {
setText("<html><head>" +
UIUtil.getCssFontDeclaration(getCommitDetailsFont()) +
"</head><body>" +
myMainText +
"</body></html>");
}
customizeLinksStyle();
revalidate();
repaint();
}
@NotNull
private String getMessageText(@NotNull VcsFullCommitDetails commit) {
String fullMessage = commit.getFullMessage();
int separator = fullMessage.indexOf("\n\n");
String subject = separator > 0 ? fullMessage.substring(0, separator) : fullMessage;
String description = fullMessage.substring(subject.length());
return "<b>" +
getHtmlWithFonts(escapeMultipleSpaces(IssueLinkHtmlRenderer.formatTextWithLinks(myProject, subject)), Font.BOLD) +
"</b>" +
getHtmlWithFonts(escapeMultipleSpaces(IssueLinkHtmlRenderer.formatTextWithLinks(myProject, description)));
}
@NotNull
private static String escapeMultipleSpaces(@NotNull String text) {
StringBuilder result = new StringBuilder();
for (int i = 0; i < text.length(); i++) {
if (text.charAt(i) == ' ') {
if (i == text.length() - 1 || text.charAt(i + 1) != ' ') {
result.append(' ');
}
else {
result.append(" ");
}
}
else {
result.append(text.charAt(i));
}
}
return result.toString();
}
@NotNull
private static String getAuthorText(@NotNull VcsFullCommitDetails commit, int offset) {
long authorTime = commit.getAuthorTime();
long commitTime = commit.getCommitTime();
String authorText = getAuthorName(commit.getAuthor()) + formatDateTime(authorTime);
if (!VcsUserUtil.isSamePerson(commit.getAuthor(), commit.getCommitter())) {
String commitTimeText;
if (authorTime != commitTime) {
commitTimeText = formatDateTime(commitTime);
}
else {
commitTimeText = "";
}
authorText += getCommitterText(commit.getCommitter(), commitTimeText, offset);
}
else if (authorTime != commitTime) {
authorText += getCommitterText(null, formatDateTime(commitTime), offset);
}
return authorText;
}
@NotNull
private static String getCommitterText(@Nullable VcsUser committer, @NotNull String commitTimeText, int offset) {
String alignment = "<br/>" + StringUtil.repeat(" ", offset);
String gray = ColorUtil.toHex(JBColor.GRAY);
String graySpan = "<span style='color:#" + gray + "'>";
String text = alignment + graySpan + "committed";
if (committer != null) {
text += " by " + VcsUserUtil.getShortPresentation(committer);
if (!committer.getEmail().isEmpty()) {
text += "</span>" + getEmailText(committer) + graySpan;
}
}
text += commitTimeText + "</span>";
return text;
}
@NotNull
private static String getAuthorName(@NotNull VcsUser user) {
String username = VcsUserUtil.getShortPresentation(user);
return user.getEmail().isEmpty() ? username : username + getEmailText(user);
}
@NotNull
private static String getEmailText(@NotNull VcsUser user) {
return " <a href='mailto:" + user.getEmail() + "'><" + user.getEmail() + "></a>";
}
@Override
public Color getBackground() {
return getCommitDetailsBackground();
}
}
private static class BranchesPanel extends HtmlPanel {
private static final int PER_ROW = 2;
private static final String LINK_HREF = "show-hide-branches";
@Nullable private List<String> myBranches;
private boolean myExpanded = false;
BranchesPanel() {
DefaultCaret caret = (DefaultCaret)getCaret();
caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);
setBorder(JBUI.Borders.empty(REFERENCES_BORDER, ReferencesPanel.H_GAP, BOTTOM_BORDER, 0));
}
@Override
public void hyperlinkUpdate(HyperlinkEvent e) {
if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED && LINK_HREF.equals(e.getDescription())) {
myExpanded = !myExpanded;
update();
}
}
@Override
public void updateUI() {
super.updateUI();
update();
}
void setBranches(@Nullable List<String> branches) {
if (branches == null) {
myBranches = null;
}
else {
myBranches = branches;
}
myExpanded = false;
}
void update() {
setText("<html><head>" +
UIUtil.getCssFontDeclaration(getCommitDetailsFont()) +
"</head><body>" +
getBranchesText() +
"</body></html>");
revalidate();
repaint();
}
@NotNull
private String getBranchesText() {
if (myBranches == null) {
return "<i>In branches: loading...</i>";
}
if (myBranches.isEmpty()) return "<i>Not in any branch</i>";
if (myExpanded) {
int rowCount = (int)Math.ceil((double)myBranches.size() / PER_ROW);
int[] means = new int[PER_ROW - 1];
int[] max = new int[PER_ROW - 1];
for (int i = 0; i < rowCount; i++) {
for (int j = 0; j < PER_ROW - 1; j++) {
int index = rowCount * j + i;
if (index < myBranches.size()) {
means[j] += myBranches.get(index).length();
max[j] = Math.max(myBranches.get(index).length(), max[j]);
}
}
}
for (int j = 0; j < PER_ROW - 1; j++) {
means[j] /= rowCount;
}
HtmlTableBuilder builder = new HtmlTableBuilder();
for (int i = 0; i < rowCount; i++) {
builder.startRow();
for (int j = 0; j < PER_ROW; j++) {
int index = rowCount * j + i;
if (index >= myBranches.size()) {
builder.append("");
}
else {
String branch = myBranches.get(index);
if (index != myBranches.size() - 1) {
int space = 0;
if (j < PER_ROW - 1 && branch.length() == max[j]) {
space = Math.max(means[j] + 20 - max[j], 5);
}
builder.append(branch + StringUtil.repeat(" ", space), "left");
}
else {
builder.append(branch, "left");
}
}
}
builder.endRow();
}
return "<i>In " + myBranches.size() + " branches:</i> " +
"<a href=\"" + LINK_HREF + "\"><i>(click to hide)</i></a><br>" +
builder.build();
}
else {
int totalMax = 0;
int charCount = 0;
for (String b : myBranches) {
totalMax++;
charCount += b.length();
if (charCount >= 50) break;
}
String branchText;
if (myBranches.size() <= totalMax) {
branchText = StringUtil.join(myBranches, ", ");
}
else {
branchText = StringUtil.join(ContainerUtil.getFirstItems(myBranches, totalMax), ", ") +
"… <a href=\"" +
LINK_HREF +
"\"><i>(click to show all)</i></a>";
}
return "<i>In " + myBranches.size() + StringUtil.pluralize(" branch", myBranches.size()) + ":</i> " + branchText;
}
}
@Override
public Color getBackground() {
return getCommitDetailsBackground();
}
public boolean isExpanded() {
return myExpanded;
}
}
private static class RootPanel extends JPanel {
private static final int RIGHT_BORDER = Math.max(UIUtil.getScrollBarWidth(), JBUI.scale(14));
@NotNull private final RectanglePainter myLabelPainter;
@NotNull private String myText = "";
@NotNull private Color myColor = getCommitDetailsBackground();
RootPanel() {
myLabelPainter = new RectanglePainter(true) {
@Override
protected Font getLabelFont() {
return RootPanel.getLabelFont();
}
};
setOpaque(false);
}
@NotNull
private static Font getLabelFont() {
Font font = getCommitDetailsFont();
return font.deriveFont(font.getSize() - 2f);
}
public void setRoot(@NotNull String text, @Nullable Color color) {
myText = text;
if (text.isEmpty() || color == null) {
myColor = getCommitDetailsBackground();
}
else {
myColor = color;
}
}
public void update() {
revalidate();
repaint();
}
@Override
protected void paintComponent(Graphics g) {
if (!myText.isEmpty()) {
Dimension painterSize = myLabelPainter.calculateSize(myText, getFontMetrics(getLabelFont()));
JBScrollPane scrollPane = UIUtil.getParentOfType(JBScrollPane.class, this);
int width;
if (scrollPane == null) {
width = getWidth();
}
else {
width = scrollPane.getViewport().getViewRect().x + scrollPane.getWidth();
}
myLabelPainter.paint((Graphics2D)g, myText, width - painterSize.width - RIGHT_BORDER, 0, myColor);
}
}
@Override
public Color getBackground() {
return getCommitDetailsBackground();
}
@Override
public Dimension getMinimumSize() {
return getPreferredSize();
}
@Override
public Dimension getPreferredSize() {
if (myText.isEmpty()) return new JBDimension(0, TOP_BORDER);
Dimension size = myLabelPainter.calculateSize(myText, getFontMetrics(getLabelFont()));
return new Dimension(size.width + JBUI.scale(RIGHT_BORDER), size.height);
}
@Override
public Dimension getMaximumSize() {
return getPreferredSize();
}
}
}