001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
019 */
020 package org.sonar.plugins.cpd;
021
022 import com.google.common.annotations.VisibleForTesting;
023 import net.sourceforge.pmd.cpd.AbstractLanguage;
024 import net.sourceforge.pmd.cpd.TokenEntry;
025 import org.apache.commons.configuration.Configuration;
026 import org.sonar.api.CoreProperties;
027 import org.sonar.api.batch.CpdMapping;
028 import org.sonar.api.batch.SensorContext;
029 import org.sonar.api.resources.Language;
030 import org.sonar.api.resources.Project;
031 import org.sonar.duplications.cpd.CPD;
032
033 import java.io.IOException;
034 import java.nio.charset.Charset;
035
036 public class PmdEngine extends CpdEngine {
037
038 private final CpdMapping[] mappings;
039
040 public PmdEngine() {
041 this.mappings = null;
042 }
043
044 public PmdEngine(CpdMapping[] mappings) {
045 this.mappings = mappings;
046 }
047
048 @Override
049 public boolean isLanguageSupported(Language language) {
050 return getMapping(language) != null;
051 }
052
053 private CpdMapping getMapping(Language language) {
054 if (mappings != null) {
055 for (CpdMapping cpdMapping : mappings) {
056 if (cpdMapping.getLanguage().equals(language)) {
057 return cpdMapping;
058 }
059 }
060 }
061 return null;
062 }
063
064 @Override
065 public void analyse(Project project, SensorContext context) {
066 CpdMapping mapping = getMapping(project.getLanguage());
067 CPD cpd = executeCPD(project, mapping, project.getFileSystem().getSourceCharset());
068 saveResults(cpd, mapping, project, context);
069 }
070
071 private void saveResults(CPD cpd, CpdMapping mapping, Project project, SensorContext context) {
072 CpdAnalyser cpdAnalyser = new CpdAnalyser(project, context, mapping);
073 cpdAnalyser.analyse(cpd.getMatches());
074 }
075
076 private CPD executeCPD(Project project, CpdMapping mapping, Charset encoding) {
077 try {
078 CPD cpd = configureCPD(project, mapping, encoding);
079 cpd.go();
080 return cpd;
081
082 } catch (Exception e) {
083 throw new CpdException(e);
084 }
085 }
086
087 private CPD configureCPD(Project project, CpdMapping mapping, Charset encoding) throws IOException {
088 // To avoid a cpd bug generating error as "java.lang.IndexOutOfBoundsException: Index: 259, Size: 248"
089 // See http://sourceforge.net/tracker/?func=detail&atid=479921&aid=1947823&group_id=56262 for more details
090 TokenEntry.clearImages();
091
092 int minTokens = getMinimumTokens(project);
093 AbstractLanguage cpdLanguage = new AbstractLanguage(mapping.getTokenizer()) {
094 };
095
096 CPD cpd = new CPD(minTokens, cpdLanguage);
097 cpd.setEncoding(encoding.name());
098 cpd.setLoadSourceCodeSlices(false);
099 cpd.add(project.getFileSystem().getSourceFiles(project.getLanguage()));
100 return cpd;
101 }
102
103 @VisibleForTesting
104 static int getMinimumTokens(Project project) {
105 Configuration conf = project.getConfiguration();
106 return conf.getInt("sonar.cpd." + project.getLanguageKey() + ".minimumTokens",
107 conf.getInt("sonar.cpd.minimumTokens", CoreProperties.CPD_MINIMUM_TOKENS_DEFAULT_VALUE));
108 }
109
110 }