/*
* 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.ide.actions;
import com.intellij.execution.ExecutionException;
import com.intellij.execution.configurations.GeneralCommandLine;
import com.intellij.execution.process.CapturingProcessHandler;
import com.intellij.execution.util.ExecUtil;
import com.intellij.ide.DataManager;
import com.intellij.ide.IdeBundle;
import com.intellij.idea.ActionsBundle;
import com.intellij.notification.Notification;
import com.intellij.notification.NotificationListener;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.actionSystem.DataContext;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.ui.popup.JBPopupFactory;
import com.intellij.openapi.ui.popup.ListPopup;
import com.intellij.openapi.ui.popup.PopupStep;
import com.intellij.openapi.ui.popup.util.BaseListPopupStep;
import com.intellij.openapi.util.*;
import com.intellij.openapi.util.io.FileUtil;
import com.intellij.openapi.vfs.JarFileSystem;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.vfs.VirtualFileSystem;
import com.intellij.openapi.vfs.newvfs.ArchiveFileSystem;
import com.intellij.ui.awt.RelativePoint;
import com.intellij.util.Consumer;
import com.intellij.util.SystemProperties;
import com.intellij.util.ui.EmptyIcon;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.ide.PooledThreadExecutor;
import javax.swing.*;
import javax.swing.event.HyperlinkEvent;
import javax.swing.filechooser.FileSystemView;
import java.awt.*;
import java.awt.event.MouseEvent;
import java.io.*;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
import static com.intellij.openapi.util.text.StringUtil.defaultIfEmpty;
public class ShowFilePathAction extends AnAction {
private static final Logger LOG = Logger.getInstance("#com.intellij.ide.actions.ShowFilePathAction");
public static final NotificationListener FILE_SELECTING_LISTENER = new NotificationListener.Adapter() {
@Override
protected void hyperlinkActivated(@NotNull Notification notification, @NotNull HyperlinkEvent e) {
URL url = e.getURL();
if (url != null) openFile(new File(url.getPath()));
notification.expire();
}
};
private static final NullableLazyValue<String> fileManagerApp = new AtomicNullableLazyValue<String>() {
@Override
protected String compute() {
return readDesktopEntryKey("Exec")
.map(line -> line.split(" ")[0])
.filter(exec -> exec.endsWith("nautilus") || exec.endsWith("pantheon-files"))
.orElse(null);
}
};
private static final NotNullLazyValue<String> fileManagerName = new AtomicNotNullLazyValue<String>() {
@NotNull
@Override
protected String compute() {
if (SystemInfo.isMac) return "Finder";
if (SystemInfo.isWindows) return "Explorer";
return readDesktopEntryKey("Name").orElse("File Manager");
}
};
private static Optional<String> readDesktopEntryKey(String key) {
if (SystemInfo.hasXdgMime()) {
String appName = ExecUtil.execAndReadLine(new GeneralCommandLine("xdg-mime", "query", "default", "inode/directory"));
if (appName != null && appName.endsWith(".desktop")) {
return Stream.of(getXdgDataDirectories().split(":"))
.map(dir -> new File(dir, "applications/" + appName))
.filter(File::exists)
.findFirst()
.map(file -> readDesktopEntryKey(file, key + '='));
}
}
return Optional.empty();
}
private static String getXdgDataDirectories() {
String dataHome = System.getenv("XDG_DATA_HOME");
String dataDirs = System.getenv("XDG_DATA_DIRS");
return defaultIfEmpty(dataHome, SystemProperties.getUserHome() + "/.local/share") + ':' + defaultIfEmpty(dataDirs, "/usr/local/share:/usr/share");
}
private static String readDesktopEntryKey(File file, String key) {
try (BufferedReader reader = new BufferedReader(new FileReader(file))) {
return reader.lines().filter(l -> l.startsWith(key)).map(l -> l.substring(key.length())).findFirst().orElse(null);
}
catch (IOException | UncheckedIOException e) {
LOG.info("Cannot read: " + file, e);
return null;
}
}
@Override
public void update(@NotNull AnActionEvent e) {
boolean visible = !SystemInfo.isMac && isSupported();
e.getPresentation().setVisible(visible);
if (visible) {
VirtualFile file = getFile(e);
e.getPresentation().setEnabled(file != null);
e.getPresentation().setText(ActionsBundle.message("action.ShowFilePath.tuned", file != null && file.isDirectory() ? 1 : 0));
}
}
@Override
public void actionPerformed(@NotNull AnActionEvent e) {
VirtualFile file = getFile(e);
if (file != null) {
show(file, popup -> {
DataManager dataManager = DataManager.getInstance();
if (dataManager != null) {
dataManager.getDataContextFromFocus().doWhenDone(((Consumer<DataContext>)popup::showInBestPositionFor));
}
});
}
}
@Nullable
private static VirtualFile getFile(AnActionEvent e) {
VirtualFile[] files = CommonDataKeys.VIRTUAL_FILE_ARRAY.getData(e.getDataContext());
return files == null || files.length == 1 ? CommonDataKeys.VIRTUAL_FILE.getData(e.getDataContext()) : null;
}
public static void show(@NotNull VirtualFile file, @NotNull MouseEvent e) {
show(file, popup -> {
if (e.getComponent().isShowing()) {
popup.show(new RelativePoint(e));
}
});
}
private static void show(@NotNull VirtualFile file, @NotNull Consumer<ListPopup> action) {
if (!isSupported()) return;
List<VirtualFile> files = new ArrayList<>();
List<String> fileUrls = new ArrayList<>();
VirtualFile eachParent = file;
while (eachParent != null) {
int index = files.size();
files.add(index, eachParent);
fileUrls.add(index, getPresentableUrl(eachParent));
if (eachParent.getParent() == null && eachParent.getFileSystem() instanceof JarFileSystem) {
eachParent = JarFileSystem.getInstance().getVirtualFileForJar(eachParent);
if (eachParent == null) break;
}
eachParent = eachParent.getParent();
}
ApplicationManager.getApplication().executeOnPooledThread(() -> {
List<Icon> icons = new ArrayList<>();
for (String url : fileUrls) {
File ioFile = new File(url);
icons.add(ioFile.exists() ? FileSystemView.getFileSystemView().getSystemIcon(ioFile) : EmptyIcon.ICON_16);
}
ApplicationManager.getApplication().invokeLater(() -> action.consume(createPopup(files, icons)));
});
}
private static String getPresentableUrl(VirtualFile file) {
String url = file.getPresentableUrl();
if (file.getParent() == null && SystemInfo.isWindows) url += "\\";
return url;
}
private static ListPopup createPopup(List<VirtualFile> files, List<Icon> icons) {
BaseListPopupStep<VirtualFile> step = new BaseListPopupStep<VirtualFile>(RevealFileAction.getActionName(), files, icons) {
@NotNull
@Override
public String getTextFor(final VirtualFile value) {
return value.getPresentableName();
}
@Override
public PopupStep onChosen(final VirtualFile selectedValue, final boolean finalChoice) {
final File selectedFile = new File(getPresentableUrl(selectedValue));
if (selectedFile.exists()) {
ApplicationManager.getApplication().executeOnPooledThread(() -> openFile(selectedFile));
}
return FINAL_CHOICE;
}
};
return JBPopupFactory.getInstance().createListPopup(step);
}
public static boolean isSupported() {
return SystemInfo.isWindows || SystemInfo.isMac || SystemInfo.hasXdgOpen() ||
Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.OPEN);
}
@NotNull
public static String getFileManagerName() {
return fileManagerName.getValue();
}
/**
* Shows system file manager with given file's parent directory open and the file highlighted in it<br/>
* (note that not all platforms support highlighting).
*
* @param file a file or directory to show and highlight in a file manager.
*/
public static void openFile(@NotNull File file) {
if (!file.exists()) {
LOG.info("does not exist: " + file);
return;
}
try {
file = file.getAbsoluteFile();
File parent = file.getParentFile();
if (parent != null) {
doOpen(parent, file);
}
else {
doOpen(file, null);
}
}
catch (Exception e) {
LOG.warn(e);
}
}
/**
* Shows system file manager with given directory open in it.
*
* @param directory a directory to open in a file manager.
*/
public static void openDirectory(@NotNull File directory) {
if (!directory.isDirectory()) {
LOG.info("not a directory: " + directory);
return;
}
try {
doOpen(directory.getAbsoluteFile(), null);
}
catch (Exception e) {
LOG.warn(e);
}
}
private static void doOpen(@NotNull File _dir, @Nullable File _toSelect) throws IOException, ExecutionException {
String dir = FileUtil.toSystemDependentName(FileUtil.toCanonicalPath(_dir.getPath()));
String toSelect = _toSelect != null ? FileUtil.toSystemDependentName(FileUtil.toCanonicalPath(_toSelect.getPath())) : null;
if (SystemInfo.isWindows) {
String cmd = toSelect != null ? "explorer /select," + toSelect : "explorer /root," + dir;
Process process = Runtime.getRuntime().exec(cmd); // no quoting/escaping is needed
new CapturingProcessHandler(process, null, cmd).runProcess().checkSuccess(LOG);
}
else if (SystemInfo.isMac) {
GeneralCommandLine cmd = toSelect != null ? new GeneralCommandLine("open", "-R", toSelect) : new GeneralCommandLine("open", dir);
ExecUtil.execAndGetOutput(cmd).checkSuccess(LOG);
}
else if (fileManagerApp.getValue() != null) {
schedule(new GeneralCommandLine(fileManagerApp.getValue(), toSelect != null ? toSelect : dir));
}
else if (SystemInfo.hasXdgOpen()) {
schedule(new GeneralCommandLine("xdg-open", dir));
}
else if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Desktop.Action.OPEN)) {
Desktop.getDesktop().open(new File(dir));
}
else {
Messages.showErrorDialog("This action isn't supported on the current platform", "Cannot Open File");
}
}
private static void schedule(GeneralCommandLine cmd) {
PooledThreadExecutor.INSTANCE.submit(() -> {
try {
ExecUtil.execAndGetOutput(cmd).checkSuccess(LOG);
}
catch (Exception e) {
LOG.warn(e);
}
});
}
public static void showDialog(Project project, String message, String title, @NotNull File file, @Nullable DialogWrapper.DoNotAskOption option) {
String ok = RevealFileAction.getActionName();
String cancel = IdeBundle.message("action.close");
if (Messages.showOkCancelDialog(project, message, title, ok, cancel, Messages.getInformationIcon(), option) == Messages.OK) {
openFile(file);
}
}
@Nullable
public static VirtualFile findLocalFile(@Nullable VirtualFile file) {
if (file == null || file.isInLocalFileSystem()) {
return file;
}
VirtualFileSystem fs = file.getFileSystem();
if (fs instanceof ArchiveFileSystem && file.getParent() == null) {
return ((ArchiveFileSystem)fs).getLocalByEntry(file);
}
return null;
}
}