/*
* Copyright 2000-2015 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.dvcs.actions;
import com.intellij.dvcs.DvcsUtil;
import com.intellij.dvcs.repo.AbstractRepositoryManager;
import com.intellij.dvcs.repo.Repository;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.actionSystem.Presentation;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.progress.Task;
import com.intellij.openapi.project.DumbAwareAction;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.popup.JBPopupFactory;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vcs.VcsDataKeys;
import com.intellij.openapi.vcs.VcsException;
import com.intellij.openapi.vcs.VcsNotifier;
import com.intellij.openapi.vcs.changes.Change;
import com.intellij.openapi.vcs.history.VcsDiffUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.ui.components.JBList;
import com.intellij.util.ObjectUtils;
import com.intellij.vcsUtil.VcsUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import static com.intellij.util.containers.UtilKt.getIfSingle;
/**
* Compares selected file/folder with itself in another branch.
*/
public abstract class DvcsCompareWithBranchAction<T extends Repository> extends DumbAwareAction {
private static final Logger LOG = Logger.getInstance(DvcsCompareWithBranchAction.class.getName());
@Override
public void actionPerformed(@NotNull AnActionEvent event) {
Project project = event.getRequiredData(CommonDataKeys.PROJECT);
VirtualFile file = getAffectedFile(event);
T repository = ObjectUtils.assertNotNull(getRepositoryManager(project).getRepositoryForFile(file));
assert !repository.isFresh();
String currentBranchName = repository.getCurrentBranchName();
String presentableRevisionName = currentBranchName;
if (currentBranchName == null) {
String currentRevision = ObjectUtils.assertNotNull(repository.getCurrentRevision());
presentableRevisionName = DvcsUtil.getShortHash(currentRevision);
}
List<String> branchNames = getBranchNamesExceptCurrent(repository);
JBList list = new JBList(branchNames);
JBPopupFactory.getInstance()
.createListPopupBuilder(list)
.setTitle("Select branch to compare")
.setItemChoosenCallback(new OnBranchChooseRunnable(project, file, presentableRevisionName, list))
.setAutoselectOnMouseMove(true)
.setFilteringEnabled(o -> o.toString())
.createPopup()
.showCenteredInCurrentWindow(project);
}
@NotNull
protected abstract List<String> getBranchNamesExceptCurrent(@NotNull T repository);
private static VirtualFile getAffectedFile(@NotNull AnActionEvent event) {
final VirtualFile[] vFiles = event.getData(CommonDataKeys.VIRTUAL_FILE_ARRAY);
assert vFiles != null && vFiles.length == 1 && vFiles[0] != null : "Illegal virtual files selected: " + Arrays.toString(vFiles);
return vFiles[0];
}
@Override
public void update(@NotNull AnActionEvent e) {
Presentation presentation = e.getPresentation();
Project project = e.getProject();
VirtualFile file = getIfSingle(e.getData(VcsDataKeys.VIRTUAL_FILE_STREAM));
presentation.setVisible(project != null);
presentation.setEnabled(project != null && file != null && isEnabled(getRepositoryManager(project).getRepositoryForFileQuick(file)));
}
private boolean isEnabled(@Nullable T repository) {
return repository != null && !repository.isFresh() && !noBranchesToCompare(repository);
}
@NotNull
protected abstract AbstractRepositoryManager<T> getRepositoryManager(@NotNull Project project);
protected abstract boolean noBranchesToCompare(@NotNull T repository);
@NotNull
protected abstract Collection<Change> getDiffChanges(@NotNull Project project, @NotNull VirtualFile file,
@NotNull String branchToCompare) throws VcsException;
private class OnBranchChooseRunnable implements Runnable {
private final Project myProject;
private final VirtualFile myFile;
private final String myHead;
private final JList myList;
private OnBranchChooseRunnable(@NotNull Project project, @NotNull VirtualFile file, @NotNull String head, @NotNull JList list) {
myProject = project;
myFile = file;
myHead = head;
myList = list;
}
@Override
public void run() {
Object selectedValue = myList.getSelectedValue();
if (selectedValue == null) {
LOG.error("Selected value is unexpectedly null");
return;
}
showDiffWithBranchUnderModalProgress(myProject, myFile, myHead, selectedValue.toString());
}
}
private void showDiffWithBranchUnderModalProgress(@NotNull final Project project,
@NotNull final VirtualFile file,
@NotNull final String head,
@NotNull final String compare) {
new Task.Backgroundable(project, "Collecting Changes...", true) {
private Collection<Change> changes;
@Override
public void run(@NotNull ProgressIndicator indicator) {
try {
changes = getDiffChanges(project, file, compare);
}
catch (VcsException e) {
VcsNotifier.getInstance(project).notifyImportantWarning("Couldn't compare with branch", String
.format("Couldn't compare " + DvcsUtil.fileOrFolder(file) + " [%s] with branch [%s];\n %s", file, compare, e.getMessage()));
}
}
@Override
public void onSuccess() {
//if changes null -> then exception occurred before
if (changes != null) {
VcsDiffUtil.showDiffFor(project, changes, VcsDiffUtil.getRevisionTitle(compare, false), VcsDiffUtil.getRevisionTitle(head, true),
VcsUtil.getFilePath(file));
}
}
}.queue();
}
protected static String fileDoesntExistInBranchError(@NotNull VirtualFile file, @NotNull String branchToCompare) {
return String.format("%s <code>%s</code> doesn't exist in branch <code>%s</code>",
StringUtil.capitalize(DvcsUtil.fileOrFolder(file)), file.getPresentableUrl(),
branchToCompare);
}
}