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
|
/*
* SonarQube
* Copyright (C) 2009-2017 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program 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.
*
* This program 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.application;
import java.io.File;
import java.io.IOException;
import java.nio.file.FileVisitOption;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.EnumSet;
import java.util.Objects;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.process.AllProcessesCommands;
import org.sonar.process.Props;
import org.sonar.process.monitor.FileSystem;
import static java.lang.String.format;
import static java.nio.file.FileVisitResult.CONTINUE;
import static org.apache.commons.io.FileUtils.forceMkdir;
import static org.sonar.process.FileUtils.deleteDirectory;
import static org.sonar.process.ProcessProperties.PATH_DATA;
import static org.sonar.process.ProcessProperties.PATH_HOME;
import static org.sonar.process.ProcessProperties.PATH_LOGS;
import static org.sonar.process.ProcessProperties.PATH_TEMP;
import static org.sonar.process.ProcessProperties.PATH_WEB;
public class AppFileSystem implements FileSystem {
private static final Logger LOG = LoggerFactory.getLogger(AppFileSystem.class);
private static final EnumSet<FileVisitOption> FOLLOW_LINKS = EnumSet.of(FileVisitOption.FOLLOW_LINKS);
private static final String DEFAULT_DATA_DIRECTORY_NAME = "data";
private static final String DEFAULT_WEB_DIRECTORY_NAME = "web";
private static final String DEFAULT_LOGS_DIRECTORY_NAME = "logs";
private static final String DEFAULT_TEMP_DIRECTORY_NAME = "temp";
private final Props props;
private final File homeDir;
private boolean initialized = false;
public AppFileSystem(Props props) {
this.props = props;
this.homeDir = props.nonNullValueAsFile(PATH_HOME);
}
public void verifyProps() {
ensurePropertyIsAbsolutePath(props, PATH_DATA, DEFAULT_DATA_DIRECTORY_NAME);
ensurePropertyIsAbsolutePath(props, PATH_WEB, DEFAULT_WEB_DIRECTORY_NAME);
ensurePropertyIsAbsolutePath(props, PATH_LOGS, DEFAULT_LOGS_DIRECTORY_NAME);
ensurePropertyIsAbsolutePath(props, PATH_TEMP, DEFAULT_TEMP_DIRECTORY_NAME);
this.initialized = true;
}
/**
* Must be called after {@link #verifyProps()}
*/
@Override
public void reset() throws IOException {
if (!initialized) {
throw new IllegalStateException("method verifyProps must be called first");
}
createDirectory(props, PATH_DATA);
createDirectory(props, PATH_WEB);
createDirectory(props, PATH_LOGS);
File tempDir = createOrCleanTempDirectory(props, PATH_TEMP);
try (AllProcessesCommands allProcessesCommands = new AllProcessesCommands(tempDir)) {
allProcessesCommands.clean();
}
}
@Override
public File getTempDir() {
return props.nonNullValueAsFile(PATH_TEMP);
}
private File ensurePropertyIsAbsolutePath(Props props, String propKey, String defaultRelativePath) {
String path = props.value(propKey, defaultRelativePath);
File d = new File(path);
if (!d.isAbsolute()) {
d = new File(homeDir, path);
LOG.trace("Overriding property {} from relative path '{}' to absolute path '{}'", path, d.getAbsolutePath());
props.set(propKey, d.getAbsolutePath());
}
return d;
}
private static boolean createDirectory(Props props, String propKey) throws IOException {
File dir = props.nonNullValueAsFile(propKey);
if (dir.exists()) {
ensureIsNotAFile(propKey, dir);
return false;
} else {
LOG.trace("forceMkdir {}", dir.getAbsolutePath());
forceMkdir(dir);
ensureIsNotAFile(propKey, dir);
return true;
}
}
private static void ensureIsNotAFile(String propKey, File dir) {
if (!dir.isDirectory()) {
throw new IllegalStateException(format("Property '%s' is not valid, not a directory: %s",
propKey, dir.getAbsolutePath()));
}
}
private static File createOrCleanTempDirectory(Props props, String propKey) throws IOException {
File dir = props.nonNullValueAsFile(propKey);
LOG.info("Cleaning or creating temp directory {}", dir.getAbsolutePath());
if (!createDirectory(props, propKey)) {
Files.walkFileTree(dir.toPath(), FOLLOW_LINKS, CleanTempDirFileVisitor.VISIT_MAX_DEPTH, new CleanTempDirFileVisitor(dir.toPath()));
}
return dir;
}
public void ensureUnchangedConfiguration(Props newProps) {
verifyUnchanged(newProps, PATH_DATA, DEFAULT_DATA_DIRECTORY_NAME);
verifyUnchanged(newProps, PATH_WEB, DEFAULT_WEB_DIRECTORY_NAME);
verifyUnchanged(newProps, PATH_LOGS, DEFAULT_LOGS_DIRECTORY_NAME);
verifyUnchanged(newProps, PATH_TEMP, DEFAULT_TEMP_DIRECTORY_NAME);
}
private void verifyUnchanged(Props newProps, String propKey, String defaultRelativePath) {
String initialValue = props.value(propKey, defaultRelativePath);
String newValue = newProps.value(propKey, defaultRelativePath);
if (!Objects.equals(newValue, initialValue)) {
throw new IllegalStateException(format("Change of property '%s' is not supported ('%s'=> '%s')", propKey, initialValue, newValue));
}
}
private static class CleanTempDirFileVisitor extends SimpleFileVisitor<Path> {
private static final Path SHAREDMEMORY_FILE = Paths.get("sharedmemory");
public static final int VISIT_MAX_DEPTH = 1;
private final Path path;
private final boolean symLink;
public CleanTempDirFileVisitor(Path path) {
this.path = path;
this.symLink = Files.isSymbolicLink(path);
}
@Override
public FileVisitResult visitFile(Path filePath, BasicFileAttributes attrs) throws IOException {
File file = filePath.toFile();
if (file.isDirectory()) {
deleteDirectory(file);
} else if (filePath.getFileName().equals(SHAREDMEMORY_FILE)) {
return CONTINUE;
} else if (!symLink || !filePath.equals(path)) {
Files.delete(filePath);
}
return CONTINUE;
}
@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
if (!dir.equals(path)) {
deleteDirectory(dir.toFile());
}
return CONTINUE;
}
}
}
|
