1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2013 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.server.plugins;
import com.google.common.base.Joiner;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.ServerComponent;
import org.sonar.api.platform.PluginMetadata;
import org.sonar.api.platform.Server;
import org.sonar.api.utils.SonarException;
import org.sonar.api.utils.TimeProfiler;
import org.sonar.core.plugins.DefaultPluginMetadata;
import org.sonar.core.plugins.PluginInstaller;
import org.sonar.server.platform.DefaultServerFileSystem;
import org.sonar.updatecenter.common.PluginReferential;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
public class PluginDeployer implements ServerComponent {
private static final Logger LOG = LoggerFactory.getLogger(PluginDeployer.class);
private final Server server;
private final DefaultServerFileSystem fileSystem;
private final PluginInstaller installer;
private final Map<String, PluginMetadata> pluginByKeys = Maps.newHashMap();
public PluginDeployer(Server server, DefaultServerFileSystem fileSystem) {
this(server, fileSystem, new PluginInstaller());
}
PluginDeployer(Server server, DefaultServerFileSystem fileSystem, PluginInstaller installer) {
this.server = server;
this.fileSystem = fileSystem;
this.installer = installer;
}
public void start() {
TimeProfiler profiler = new TimeProfiler().start("Install plugins");
deleteUninstalledPlugins();
loadUserPlugins();
moveAndLoadDownloadedPlugins();
loadCorePlugins();
deployPlugins();
profiler.stop();
}
private void deleteUninstalledPlugins() {
File trashDir = fileSystem.getRemovedPluginsDir();
try {
if (trashDir.exists()) {
FileUtils.deleteDirectory(trashDir);
}
} catch (IOException e) {
throw new SonarException("Fail to clean the plugin trash directory: " + trashDir, e);
}
}
private void loadUserPlugins() {
for (File file : fileSystem.getUserPlugins()) {
registerPlugin(file, false, false);
}
}
private void registerPlugin(File file, boolean isCore, boolean canDelete) {
DefaultPluginMetadata metadata = installer.extractMetadata(file, isCore);
if (StringUtils.isBlank(metadata.getKey())) {
return;
}
PluginMetadata existing = pluginByKeys.put(metadata.getKey(), metadata);
if ((existing != null) && !canDelete) {
throw new IllegalStateException("Found two plugins with the same key '" + metadata.getKey() + "': " + metadata.getFile().getName() + " and "
+ existing.getFile().getName());
}
if (existing != null) {
FileUtils.deleteQuietly(existing.getFile());
LOG.info("Plugin " + metadata.getKey() + " replaced by new version");
}
}
private void moveAndLoadDownloadedPlugins() {
if (fileSystem.getDownloadedPluginsDir().exists()) {
Collection<File> jars = FileUtils.listFiles(fileSystem.getDownloadedPluginsDir(), new String[] {"jar"}, false);
for (File jar : jars) {
File movedJar = moveDownloadedFile(jar);
if (movedJar != null) {
registerPlugin(movedJar, false, true);
}
}
}
}
private File moveDownloadedFile(File jar) {
File destDir = fileSystem.getUserPluginsDir();
File destFile = new File(destDir, jar.getName());
if (destFile.exists()) {
// plugin with same filename already installed
FileUtils.deleteQuietly(jar);
return null;
}
try {
FileUtils.moveFileToDirectory(jar, destDir, true);
return destFile;
} catch (IOException e) {
LOG.error("Fail to move the downloaded file: " + jar.getAbsolutePath(), e);
return null;
}
}
private void loadCorePlugins() {
for (File file : fileSystem.getCorePlugins()) {
registerPlugin(file, true, false);
}
}
public void uninstall(String pluginKey) {
for (String key : getPluginReferential().findLastReleasesWithDependencies(pluginKey)) {
uninstallPlugin(key);
}
}
private void uninstallPlugin(String pluginKey) {
PluginMetadata metadata = pluginByKeys.get(pluginKey);
if ((metadata != null) && !metadata.isCore()) {
try {
File masterFile = new File(fileSystem.getUserPluginsDir(), metadata.getFile().getName());
FileUtils.moveFileToDirectory(masterFile, fileSystem.getRemovedPluginsDir(), true);
} catch (IOException e) {
throw new SonarException("Fail to uninstall plugin: " + pluginKey, e);
}
}
}
public List<String> getUninstalls() {
List<String> names = Lists.newArrayList();
if (fileSystem.getRemovedPluginsDir().exists()) {
List<File> files = (List<File>) FileUtils.listFiles(fileSystem.getRemovedPluginsDir(), new String[] {"jar"}, false);
for (File file : files) {
names.add(file.getName());
}
}
return names;
}
public void cancelUninstalls() {
if (fileSystem.getRemovedPluginsDir().exists()) {
List<File> files = (List<File>) FileUtils.listFiles(fileSystem.getRemovedPluginsDir(), new String[] {"jar"}, false);
for (File file : files) {
try {
FileUtils.moveFileToDirectory(file, fileSystem.getUserPluginsDir(), false);
} catch (IOException e) {
throw new SonarException("Fail to cancel plugin uninstalls", e);
}
}
}
}
private void deployPlugins() {
for (PluginMetadata metadata : pluginByKeys.values()) {
deploy((DefaultPluginMetadata) metadata);
}
}
private void deploy(DefaultPluginMetadata plugin) {
LOG.info("Deploy plugin {}", Joiner.on(" / ").skipNulls().join(plugin.getName(), plugin.getVersion(), plugin.getImplementationBuild()));
Preconditions.checkState(plugin.isCompatibleWith(server.getVersion()),
"Plugin %s needs a more recent version of SonarQube than %s. At least %s is expected",
plugin.getKey(), server.getVersion(), plugin.getSonarVersion());
try {
File pluginDeployDir = new File(fileSystem.getDeployedPluginsDir(), plugin.getKey());
FileUtils.forceMkdir(pluginDeployDir);
FileUtils.cleanDirectory(pluginDeployDir);
List<File> deprecatedExtensions = fileSystem.getExtensions(plugin.getKey());
for (File deprecatedExtension : deprecatedExtensions) {
plugin.addDeprecatedExtension(deprecatedExtension);
}
installer.install(plugin, pluginDeployDir);
} catch (IOException e) {
throw new RuntimeException("Fail to deploy the plugin " + plugin, e);
}
}
public Collection<PluginMetadata> getMetadata() {
return pluginByKeys.values();
}
public PluginMetadata getMetadata(String pluginKey) {
return pluginByKeys.get(pluginKey);
}
private PluginReferential getPluginReferential() {
return PluginReferentialMetadataConverter.getInstalledPluginReferential(getMetadata());
}
}
|
