Add a comment that explains why we can't add all variables that we read
[idea/community.git] / python / python-terminal / src / com / jetbrains / python / sdk / PyVirtualEnvTerminalCustomizer.kt
1 /*
2  * Copyright 2000-2016 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.jetbrains.python.sdk
17
18 import com.intellij.openapi.components.PersistentStateComponent
19 import com.intellij.openapi.components.ServiceManager
20 import com.intellij.openapi.components.State
21 import com.intellij.openapi.components.Storage
22 import com.intellij.openapi.module.ModuleManager
23 import com.intellij.openapi.options.UnnamedConfigurable
24 import com.intellij.openapi.project.Project
25 import com.intellij.openapi.projectRoots.Sdk
26 import com.intellij.openapi.util.SystemInfo
27 import com.jetbrains.python.run.PyVirtualEnvReader
28 import com.jetbrains.python.run.findActivateScript
29 import org.jetbrains.plugins.terminal.LocalTerminalCustomizer
30 import java.io.File
31 import javax.swing.JCheckBox
32
33 /**
34  * @author traff
35  */
36
37
38 class PyVirtualEnvTerminalCustomizer : LocalTerminalCustomizer() {
39   override fun customizeCommandAndEnvironment(project: Project,
40                                               command: Array<out String>,
41                                               envs: MutableMap<String, String>): Array<out String> {
42     val sdk: Sdk? = findSdk(project)
43
44     if (sdk != null && (PythonSdkType.isVirtualEnv(sdk) || PythonSdkType.isCondaVirtualEnv(
45       sdk)) && PyVirtualEnvTerminalSettings.getInstance(project).virtualEnvActivate) {
46       // in case of virtualenv sdk on unix we activate virtualenv
47       val path = sdk.homePath
48
49       if (path != null) {
50
51         val shellPath = command[0]
52         val shellName = File(shellPath).name
53
54         if (shellName == "bash" || (SystemInfo.isMac && shellName == "sh") || (shellName == "zsh") ||
55           ((shellName == "fish") && PythonSdkType.isVirtualEnv(sdk))) { //fish shell works only for virtualenv and not for conda
56           //for bash we pass activate script to jediterm shell integration (see jediterm-bash.in) to source it there
57           findActivateScript(path, shellPath)?.let { activate -> envs.put("JEDITERM_SOURCE", activate) }
58         }
59         else {
60           //for other shells we read envs from activate script by the default shell and pass them to the process
61           val reader = PyVirtualEnvReader(path)
62           reader.activate?.let {
63             // we add only envs that are setup by the activate script, because adding other variables from the different shell
64             // can break the actual shell
65             envs.putAll(reader.readShellEnv().mapKeys { k -> k.key.toUpperCase() }.filterKeys { k ->
66               k in arrayOf("PATH", "PS1", "VIRTUAL_ENV", "PYTHONHOME", "PROMPT", "_OLD_VIRTUAL_PROMPT", "_OLD_VIRTUAL_PYTHONHOME", "_OLD_VIRTUAL_PATH")
67             })
68           }
69         }
70       }
71     }
72
73     // for some reason virtualenv isn't activated in the rcfile for the login shell, so we make it non-login
74     return command.filter { arg -> arg != "--login" && arg != "-l" }.toTypedArray()
75   }
76
77
78   private fun findSdk(project: Project): Sdk? {
79     for (m in ModuleManager.getInstance(project).modules) {
80       val sdk: Sdk? = PythonSdkType.findPythonSdk(m)
81       if (sdk != null && !PythonSdkType.isRemote(sdk)) {
82         return sdk
83       }
84     }
85
86     return null
87   }
88
89
90   override fun getDefaultFolder(): String? {
91     return null
92   }
93
94   override fun getConfigurable(project: Project) = object : UnnamedConfigurable {
95     val settings = PyVirtualEnvTerminalSettings.getInstance(project)
96
97     var myCheckbox: JCheckBox = JCheckBox("Activate virtualenv")
98
99     override fun createComponent() = myCheckbox
100
101     override fun isModified() = myCheckbox.isSelected != settings.virtualEnvActivate
102
103     override fun apply() {
104       settings.virtualEnvActivate = myCheckbox.isSelected
105     }
106
107     override fun reset() {
108       myCheckbox.isSelected = settings.virtualEnvActivate
109     }
110   }
111
112
113 }
114
115 class SettingsState {
116   var virtualEnvActivate = true
117 }
118
119 @State(name = "PyVirtualEnvTerminalCustomizer", storages = arrayOf(Storage("python-terminal.xml")))
120 class PyVirtualEnvTerminalSettings : PersistentStateComponent<SettingsState> {
121   var myState = SettingsState()
122
123   var virtualEnvActivate: Boolean
124     get() = myState.virtualEnvActivate
125     set(value) {
126       myState.virtualEnvActivate = value
127     }
128
129   override fun getState() = myState
130
131   override fun loadState(state: SettingsState) {
132     myState.virtualEnvActivate = state.virtualEnvActivate
133   }
134
135   companion object {
136     fun getInstance(project: Project): PyVirtualEnvTerminalSettings {
137       return ServiceManager.getService(project, PyVirtualEnvTerminalSettings::class.java)
138     }
139   }
140
141 }
142