/*
* 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.jetbrains.python.configuration;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.WriteAction;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.options.ConfigurationException;
import com.intellij.openapi.options.UnnamedConfigurable;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.projectRoots.Sdk;
import com.intellij.openapi.projectRoots.SdkModel;
import com.intellij.openapi.projectRoots.impl.SdkConfigurationUtil;
import com.intellij.openapi.roots.ModuleRootManager;
import com.intellij.openapi.roots.ModuleRootModificationUtil;
import com.intellij.openapi.roots.ProjectRootManager;
import com.intellij.openapi.roots.ui.configuration.projectRoot.ProjectSdksModel;
import com.intellij.openapi.ui.ComboBox;
import com.intellij.openapi.ui.FixedSizeButton;
import com.intellij.openapi.util.Comparing;
import com.intellij.openapi.util.Disposer;
import com.intellij.openapi.vfs.LocalFileSystem;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.ui.CollectionComboBoxModel;
import com.intellij.util.NullableConsumer;
import com.intellij.webcore.packaging.PackagesNotificationPanel;
import com.jetbrains.python.PyBundle;
import com.jetbrains.python.packaging.PyPackageManagers;
import com.jetbrains.python.packaging.ui.PyInstalledPackagesPanel;
import com.jetbrains.python.psi.LanguageLevel;
import com.jetbrains.python.psi.PyUtil;
import com.jetbrains.python.sdk.*;
import com.jetbrains.python.sdk.flavors.PythonSdkFlavor;
import icons.PythonIcons;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.awt.*;
import java.awt.event.ItemEvent;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
public class PyActiveSdkConfigurable implements UnnamedConfigurable {
private final Project myProject;
@Nullable private final Module myModule;
private MySdkModelListener mySdkModelListener = new MySdkModelListener();
private PyConfigurableInterpreterList myInterpreterList;
private ProjectSdksModel myProjectSdksModel;
private NullableConsumer<Sdk> myAddSdkCallback;
private boolean mySdkSettingsWereModified = false;
private JPanel myMainPanel;
private ComboBox mySdkCombo;
private PyInstalledPackagesPanel myPackagesPanel;
private JButton myDetailsButton;
private static final String SHOW_ALL = PyBundle.message("active.sdk.dialog.show.all.item");
private Set<Sdk> myInitialSdkSet;
private Disposable myDisposable = null;
public PyActiveSdkConfigurable(@NotNull Project project) {
myModule = null;
myProject = project;
layoutPanel();
initContent();
}
public PyActiveSdkConfigurable(@NotNull Module module) {
myModule = module;
myProject = module.getProject();
layoutPanel();
initContent();
}
private void layoutPanel() {
final GridBagLayout layout = new GridBagLayout();
myMainPanel = new JPanel(layout);
final JLabel interpreterLabel = new JLabel(PyBundle.message("active.sdk.dialog.project.interpreter"));
final JLabel emptyLabel = new JLabel(" ");
mySdkCombo = new ComboBox() {
@Override
public void setSelectedItem(Object item) {
if (SHOW_ALL.equals(item)) {
ApplicationManager.getApplication().invokeLater(() -> {
PythonSdkDetailsDialog moreDialog = myModule == null
? new PythonSdkDetailsDialog(myProject, myAddSdkCallback, getSettingsModifiedCallback())
: new PythonSdkDetailsDialog(myModule, myAddSdkCallback, getSettingsModifiedCallback());
moreDialog.show();
});
return;
}
if (!PySdkListCellRenderer.SEPARATOR.equals(item))
super.setSelectedItem(item);
}
@Override
public void paint(Graphics g) {
try {
putClientProperty("JComboBox.isTableCellEditor", Boolean.FALSE);
super.paint(g);
} finally {
putClientProperty("JComboBox.isTableCellEditor", Boolean.TRUE);
}
}
};
mySdkCombo.putClientProperty("JComboBox.isTableCellEditor", Boolean.TRUE);
final PackagesNotificationPanel notificationsArea = new PackagesNotificationPanel();
final JComponent notificationsComponent = notificationsArea.getComponent();
final Dimension preferredSize = mySdkCombo.getPreferredSize();
mySdkCombo.setPreferredSize(preferredSize);
notificationsArea.hide();
myDetailsButton = new FixedSizeButton();
myDetailsButton.setIcon(PythonIcons.Python.InterpreterGear);
//noinspection SuspiciousNameCombination
myDetailsButton.setPreferredSize(new Dimension(preferredSize.height, preferredSize.height));
myPackagesPanel = new PyInstalledPackagesPanel(myProject, notificationsArea);
final GridBagConstraints c = new GridBagConstraints();
c.fill = GridBagConstraints.HORIZONTAL;
c.insets = new Insets(2,2,2,2);
c.gridx = 0;
c.gridy = 0;
myMainPanel.add(interpreterLabel, c);
c.gridx = 1;
c.gridy = 0;
c.weightx = 0.1;
myMainPanel.add(mySdkCombo, c);
c.insets = new Insets(2,0,2,2);
c.gridx = 2;
c.gridy = 0;
c.weightx = 0.0;
myMainPanel.add(myDetailsButton, c);
final PyCustomSdkUiProvider customUiProvider = PyCustomSdkUiProvider.getInstance();
if (customUiProvider != null) {
myDisposable = Disposer.newDisposable();
customUiProvider.customizeActiveSdkPanel(myProject, mySdkCombo, myMainPanel, c, myDisposable);
}
c.insets = new Insets(2,2,0,2);
c.gridx = 0;
c.gridy++;
c.gridwidth = 3;
c.weightx = 0.0;
myMainPanel.add(emptyLabel, c);
c.gridx = 0;
c.gridy++;
c.weighty = 1.;
c.gridwidth = 3;
c.gridheight = GridBagConstraints.RELATIVE;
c.fill = GridBagConstraints.BOTH;
myMainPanel.add(myPackagesPanel, c);
c.gridheight = GridBagConstraints.REMAINDER;
c.gridx = 0;
c.gridy++;
c.gridwidth = 3;
c.weighty = 0.;
c.fill = GridBagConstraints.HORIZONTAL;
c.anchor = GridBagConstraints.SOUTH;
myMainPanel.add(notificationsComponent, c);
}
@NotNull
private Runnable getSettingsModifiedCallback() {
return () -> mySdkSettingsWereModified = true;
}
private void initContent() {
myInterpreterList = PyConfigurableInterpreterList.getInstance(myProject);
myProjectSdksModel = myInterpreterList.getModel();
myInitialSdkSet = myProjectSdksModel.getProjectSdks().keySet();
myProjectSdksModel.addListener(mySdkModelListener);
mySdkCombo.addItemListener(e -> {
if (e.getStateChange() == ItemEvent.SELECTED) {
final Sdk selectedSdk = (Sdk)mySdkCombo.getSelectedItem();
final PyPackageManagers packageManagers = PyPackageManagers.getInstance();
myPackagesPanel.updatePackages(selectedSdk != null ? packageManagers.getManagementService(myProject, selectedSdk) : null);
myPackagesPanel.updateNotifications(selectedSdk);
}
});
myAddSdkCallback = new SdkAddedCallback();
myDetailsButton.addActionListener(e -> showDetails());
}
private void showDetails() {
final PythonSdkDetailsDialog moreDialog = myModule == null
? new PythonSdkDetailsDialog(myProject, myAddSdkCallback, getSettingsModifiedCallback())
: new PythonSdkDetailsDialog(myModule, myAddSdkCallback, getSettingsModifiedCallback());
PythonSdkDetailsStep.show(myProject, myProjectSdksModel.getSdks(), moreDialog, myMainPanel,
myDetailsButton.getLocationOnScreen(), myAddSdkCallback);
}
@Override
public JComponent createComponent() {
return myMainPanel;
}
@Override
public boolean isModified() {
Sdk sdk = getSdk();
final Sdk selectedSdk = getSelectedSdk();
return mySdkSettingsWereModified || selectedSdk instanceof PyDetectedSdk || !Comparing.equal(sdk, selectedSdk);
}
@Nullable
/**
* returns real sdk or detected one
*/
private Sdk getSelectedSdk() {
final Sdk selectedItem = (Sdk)mySdkCombo.getSelectedItem();
if (selectedItem instanceof PyDetectedSdk) return selectedItem;
return selectedItem == null ? null : myProjectSdksModel.findSdk(selectedItem);
}
@Nullable
protected Sdk getSdk() {
if (myModule == null) {
return ProjectRootManager.getInstance(myProject).getProjectSdk();
}
final ModuleRootManager rootManager = ModuleRootManager.getInstance(myModule);
return rootManager.getSdk();
}
@Override
public void apply() throws ConfigurationException {
mySdkSettingsWereModified = false;
Sdk selectedSdk = getSelectedSdk();
if (selectedSdk instanceof PyDetectedSdk) {
final String sdkName = selectedSdk.getName();
final VirtualFile sdkHome =
WriteAction.compute(() -> LocalFileSystem.getInstance().refreshAndFindFileByPath(sdkName));
if (sdkHome != null) {
selectedSdk = SdkConfigurationUtil.createAndAddSDK(sdkHome.getPath(), PythonSdkType.getInstance());
if (selectedSdk != null) {
myProjectSdksModel.addSdk(selectedSdk);
}
}
}
else if (myInitialSdkSet.contains(selectedSdk) && selectedSdk != null) {
PythonSdkUpdater.updateOrShowError(selectedSdk, null, myProject, null);
}
if (selectedSdk != null) {
updateSdkList(false);
myProjectSdksModel.apply();
setSelectedSdk(selectedSdk);
}
final Sdk prevSdk = getSdk();
setSdk(selectedSdk);
rehighlightVersionSpecific(selectedSdk, prevSdk);
}
private void setSelectedSdk(@Nullable final Sdk selectedSdk) {
if (selectedSdk instanceof PyDetectedSdk) {
mySdkCombo.getModel().setSelectedItem(selectedSdk);
}
else {
mySdkCombo.getModel().setSelectedItem(selectedSdk == null ? null : myProjectSdksModel.findSdk(selectedSdk.getName()));
}
}
private void rehighlightVersionSpecific(@Nullable final Sdk newSdk, @Nullable final Sdk prevSdk) {
if (prevSdk != null && newSdk != null) {
final PythonSdkFlavor flavor1 = PythonSdkFlavor.getFlavor(newSdk);
final PythonSdkFlavor flavor2 = PythonSdkFlavor.getFlavor(prevSdk);
if (flavor1 != null && flavor2 != null) {
final LanguageLevel languageLevel1 = flavor1.getLanguageLevel(newSdk);
final LanguageLevel languageLevel2 = flavor2.getLanguageLevel(prevSdk);
if ((languageLevel1.isPy3K() && !languageLevel2.isPy3K()) ||
(!languageLevel1.isPy3K()) && languageLevel2.isPy3K()) {
PyUtil.rehighlightOpenEditors(myProject);
}
}
}
}
protected void setSdk(final Sdk item) {
ApplicationManager.getApplication().runWriteAction(() -> ProjectRootManager.getInstance(myProject).setProjectSdk(item));
if (myModule != null) {
ModuleRootModificationUtil.setModuleSdk(myModule, item);
}
}
@Override
public void reset() {
updateSdkList(false);
final Sdk sdk = getSdk();
setSelectedSdk(sdk);
}
private void updateSdkList(boolean preserveSelection) {
final List<Sdk> sdkList = myInterpreterList.getAllPythonSdks(myProject);
Sdk selection = preserveSelection ? (Sdk)mySdkCombo.getSelectedItem() : null;
if (!sdkList.contains(selection)) {
selection = null;
}
VirtualEnvProjectFilter.removeNotMatching(myProject, sdkList);
// if the selection is a non-matching virtualenv, show it anyway
if (selection != null && !sdkList.contains(selection)) {
sdkList.add(0, selection);
}
List<Object> items = new ArrayList<>();
items.add(null);
boolean remoteSeparator = true;
boolean separator = true;
boolean detectedSeparator = true;
for (Sdk sdk : sdkList) {
if (!PythonSdkType.isVirtualEnv(sdk) && !PythonSdkType.isRemote(sdk) && !(sdk instanceof PyDetectedSdk) && separator) {
items.add(PySdkListCellRenderer.SEPARATOR);
separator = false;
}
if (PythonSdkType.isRemote(sdk) && remoteSeparator) {
items.add(PySdkListCellRenderer.SEPARATOR);
remoteSeparator = false;
}
if (sdk instanceof PyDetectedSdk && detectedSeparator) {
items.add(PySdkListCellRenderer.SEPARATOR);
detectedSeparator = false;
}
items.add(sdk);
}
items.add(PySdkListCellRenderer.SEPARATOR);
items.add(SHOW_ALL);
mySdkCombo.setRenderer(new PySdkListCellRenderer(false));
//noinspection unchecked
mySdkCombo.setModel(new CollectionComboBoxModel(items, selection));
}
@Override
public void disposeUIResources() {
myProjectSdksModel.removeListener(mySdkModelListener);
myInterpreterList.disposeModel();
if (myDisposable != null) {
Disposer.dispose(myDisposable);
}
}
private class MySdkModelListener implements SdkModel.Listener {
public MySdkModelListener() {
}
@Override
public void sdkAdded(Sdk sdk) {
updateSdkList(true);
}
@Override
public void beforeSdkRemove(Sdk sdk) {
updateSdkList(true);
}
@Override
public void sdkChanged(Sdk sdk, String previousName) {
updateSdkList(true);
}
@Override
public void sdkHomeSelected(Sdk sdk, String newSdkHome) {
}
}
private class SdkAddedCallback implements NullableConsumer<Sdk> {
@Override
public void consume(Sdk sdk) {
if (sdk == null) return;
if (!(sdk instanceof PyDetectedSdk) && myProjectSdksModel.findSdk(sdk.getName()) == null) {
myProjectSdksModel.addSdk(sdk);
}
updateSdkList(false);
setSelectedSdk(sdk);
}
}
}