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
|
/*
* SonarQube
* Copyright (C) 2009-2025 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.scanner.scan.filesystem;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.attribute.DosFileAttributes;
import org.apache.commons.lang3.SystemUtils;
import org.sonar.api.batch.fs.internal.DefaultInputModule;
import org.sonar.scanner.scan.ModuleConfiguration;
public class HiddenFilesVisitorHelper {
private static final String EXCLUDE_HIDDEN_FILES_PROPERTY = "sonar.scanner.excludeHiddenFiles";
private final HiddenFilesProjectData hiddenFilesProjectData;
private final DefaultInputModule module;
final boolean excludeHiddenFiles;
private Path moduleWorkDir;
Path rootHiddenDir;
public HiddenFilesVisitorHelper(HiddenFilesProjectData hiddenFilesProjectData, DefaultInputModule module, ModuleConfiguration moduleConfig) {
this.hiddenFilesProjectData = hiddenFilesProjectData;
this.module = module;
this.excludeHiddenFiles = moduleConfig.getBoolean(EXCLUDE_HIDDEN_FILES_PROPERTY).orElse(false);
}
public boolean shouldVisitDir(Path path) throws IOException {
boolean isHidden = isHiddenDir(path);
if (isHidden && (excludeHiddenFiles || isExcludedHiddenDirectory(path))) {
return false;
}
if (isHidden) {
enterHiddenDirectory(path);
}
return true;
}
private boolean isExcludedHiddenDirectory(Path path) throws IOException {
return getCachedModuleWorkDir().equals(path) || hiddenFilesProjectData.getCachedSonarUserHomePath().equals(path);
}
void enterHiddenDirectory(Path dir) {
if (!insideHiddenDirectory()) {
rootHiddenDir = dir;
}
}
public void exitDirectory(Path path) {
if (insideHiddenDirectory() && rootHiddenDir.equals(path)) {
resetRootHiddenDir();
}
}
void resetRootHiddenDir() {
this.rootHiddenDir = null;
}
public boolean shouldVisitFile(Path path) throws IOException {
boolean isHidden = insideHiddenDirectory() || Files.isHidden(path);
if (!excludeHiddenFiles && isHidden) {
hiddenFilesProjectData.markAsHiddenFile(path, module);
}
return !excludeHiddenFiles || !isHidden;
}
private Path getCachedModuleWorkDir() throws IOException {
if (moduleWorkDir == null) {
moduleWorkDir = hiddenFilesProjectData.resolveRealPath(module.getWorkDir());
}
return moduleWorkDir;
}
// visible for testing
boolean insideHiddenDirectory() {
return rootHiddenDir != null;
}
protected static boolean isHiddenDir(Path path) throws IOException {
if (SystemUtils.IS_OS_WINDOWS) {
try {
DosFileAttributes dosFileAttributes = Files.readAttributes(path, DosFileAttributes.class, LinkOption.NOFOLLOW_LINKS);
return dosFileAttributes.isHidden();
} catch (UnsupportedOperationException e) {
return path.toFile().isHidden();
}
} else {
return Files.isHidden(path);
}
}
}
|
