org.sonar.batch.scan.filesystem.DefaultModuleFileSystem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-scanner-engine Show documentation
Show all versions of sonar-scanner-engine Show documentation
Open source platform for continuous inspection of code quality
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact 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.batch.scan.filesystem;
import org.sonar.api.batch.fs.InputFile.Status;
import org.sonar.batch.analysis.DefaultAnalysisMode;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import java.io.File;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.CoreProperties;
import org.sonar.api.batch.fs.FilePredicate;
import org.sonar.api.batch.fs.internal.DefaultFileSystem;
import org.sonar.api.config.Settings;
import org.sonar.api.resources.Project;
import org.sonar.api.scan.filesystem.FileQuery;
import org.sonar.api.scan.filesystem.ModuleFileSystem;
import org.sonar.api.utils.MessageException;
/**
* @since 3.5
*/
public class DefaultModuleFileSystem extends DefaultFileSystem implements ModuleFileSystem {
private String moduleKey;
private FileIndexer indexer;
private Settings settings;
private File buildDir;
private List sourceDirsOrFiles = Lists.newArrayList();
private List testDirsOrFiles = Lists.newArrayList();
private List binaryDirs = Lists.newArrayList();
private ComponentIndexer componentIndexer;
private boolean initialized;
public DefaultModuleFileSystem(ModuleInputFileCache moduleInputFileCache, Project project,
Settings settings, FileIndexer indexer, ModuleFileSystemInitializer initializer, ComponentIndexer componentIndexer, DefaultAnalysisMode mode) {
super(initializer.baseDir(), moduleInputFileCache);
setFields(project, settings, indexer, initializer, componentIndexer, mode);
}
@VisibleForTesting
public DefaultModuleFileSystem(Project project,
Settings settings, FileIndexer indexer, ModuleFileSystemInitializer initializer, ComponentIndexer componentIndexer, DefaultAnalysisMode mode) {
super(initializer.baseDir().toPath());
setFields(project, settings, indexer, initializer, componentIndexer, mode);
}
private void setFields(Project project,
Settings settings, FileIndexer indexer, ModuleFileSystemInitializer initializer, ComponentIndexer componentIndexer, DefaultAnalysisMode mode) {
this.componentIndexer = componentIndexer;
this.moduleKey = project.getKey();
this.settings = settings;
this.indexer = indexer;
setWorkDir(initializer.workingDir());
this.buildDir = initializer.buildDir();
this.sourceDirsOrFiles = initializer.sources();
this.testDirsOrFiles = initializer.tests();
this.binaryDirs = initializer.binaryDirs();
// filter the files sensors have access to
if (!mode.scanAllFiles()) {
setDefaultPredicate(predicates.not(predicates.hasStatus(Status.SAME)));
}
}
public boolean isInitialized() {
return initialized;
}
public String moduleKey() {
return moduleKey;
}
@Override
@CheckForNull
public File buildDir() {
return buildDir;
}
@Override
public List sourceDirs() {
return keepOnlyDirs(sourceDirsOrFiles);
}
public List sources() {
return sourceDirsOrFiles;
}
@Override
public List testDirs() {
return keepOnlyDirs(testDirsOrFiles);
}
public List tests() {
return testDirsOrFiles;
}
private static List keepOnlyDirs(List dirsOrFiles) {
List result = new ArrayList<>();
for (File f : dirsOrFiles) {
if (f.isDirectory()) {
result.add(f);
}
}
return result;
}
@Override
public List binaryDirs() {
return binaryDirs;
}
@Override
public Charset encoding() {
final Charset charset;
String encoding = settings.getString(CoreProperties.ENCODING_PROPERTY);
if (StringUtils.isNotEmpty(encoding)) {
charset = Charset.forName(StringUtils.trim(encoding));
} else {
charset = Charset.defaultCharset();
}
return charset;
}
@Override
public boolean isDefaultJvmEncoding() {
return !settings.hasKey(CoreProperties.ENCODING_PROPERTY);
}
/**
* Should not be used - only for old plugins
*
* @deprecated since 4.0
*/
@Deprecated
void addSourceDir(File dir) {
throw modificationNotPermitted();
}
/**
* Should not be used - only for old plugins
*
* @deprecated since 4.0
*/
@Deprecated
void addTestDir(File dir) {
throw modificationNotPermitted();
}
private static UnsupportedOperationException modificationNotPermitted() {
return new UnsupportedOperationException("Modifications of the file system are not permitted");
}
/**
* @return
* @deprecated in 4.2. Replaced by {@link #encoding()}
*/
@Override
@Deprecated
public Charset sourceCharset() {
return encoding();
}
/**
* @deprecated in 4.2. Replaced by {@link #workDir()}
*/
@Deprecated
@Override
public File workingDir() {
return workDir();
}
@Override
public List files(FileQuery query) {
doPreloadFiles();
Collection predicates = Lists.newArrayList();
for (Map.Entry> entry : query.attributes().entrySet()) {
predicates.add(fromDeprecatedAttribute(entry.getKey(), entry.getValue()));
}
return ImmutableList.copyOf(files(predicates().and(predicates)));
}
@Override
protected void doPreloadFiles() {
if (!initialized) {
throw MessageException.of("Accessing the filesystem before the Sensor phase is not supported. Please update your plugin.");
}
}
public void index() {
if (initialized) {
throw MessageException.of("Module filesystem can only be indexed once");
}
initialized = true;
indexer.index(this);
if (componentIndexer != null) {
componentIndexer.execute(this);
}
}
private FilePredicate fromDeprecatedAttribute(String key, Collection value) {
if ("TYPE".equals(key)) {
return predicates().or(Collections2.transform(value, new Function() {
@Override
public FilePredicate apply(@Nullable String s) {
return s == null ? predicates().all() : predicates().hasType(org.sonar.api.batch.fs.InputFile.Type.valueOf(s));
}
}));
}
if ("STATUS".equals(key)) {
return predicates().or(Collections2.transform(value, new Function() {
@Override
public FilePredicate apply(@Nullable String s) {
return s == null ? predicates().all() : predicates().hasStatus(org.sonar.api.batch.fs.InputFile.Status.valueOf(s));
}
}));
}
if ("LANG".equals(key)) {
return predicates().or(Collections2.transform(value, new Function() {
@Override
public FilePredicate apply(@Nullable String s) {
return s == null ? predicates().all() : predicates().hasLanguage(s);
}
}));
}
if ("CMP_KEY".equals(key)) {
return predicates().or(Collections2.transform(value, new Function() {
@Override
public FilePredicate apply(@Nullable String s) {
return s == null ? predicates().all() : new AdditionalFilePredicates.KeyPredicate(s);
}
}));
}
throw new IllegalArgumentException("Unsupported file attribute: " + key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
DefaultModuleFileSystem that = (DefaultModuleFileSystem) o;
return moduleKey.equals(that.moduleKey);
}
@Override
public int hashCode() {
return moduleKey.hashCode();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy