001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2011 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 java.io.IOException;
023 import java.nio.charset.Charset;
024
025 import net.sourceforge.pmd.cpd.AbstractLanguage;
026 import net.sourceforge.pmd.cpd.TokenEntry;
027
028 import org.apache.commons.configuration.Configuration;
029 import org.sonar.api.CoreProperties;
030 import org.sonar.api.batch.CpdMapping;
031 import org.sonar.api.batch.SensorContext;
032 import org.sonar.api.resources.Language;
033 import org.sonar.api.resources.Project;
034 import org.sonar.duplications.cpd.CPD;
035
036 public class PmdEngine extends CpdEngine {
037
038 private CpdMapping[] mappings;
039
040 public PmdEngine(CpdMapping[] mappings) {
041 this.mappings = mappings;
042 }
043
044 @Override
045 public boolean isLanguageSupported(Language language) {
046 return getMapping(language) != null;
047 }
048
049 private CpdMapping getMapping(Language language) {
050 for (CpdMapping cpdMapping : mappings) {
051 if (cpdMapping.getLanguage().equals(language)) {
052 return cpdMapping;
053 }
054 }
055 return null;
056 }
057
058 @Override
059 public void analyse(Project project, SensorContext context) {
060 CpdMapping mapping = getMapping(project.getLanguage());
061 CPD cpd = executeCPD(project, mapping, project.getFileSystem().getSourceCharset());
062 saveResults(cpd, mapping, project, context);
063 }
064
065 private void saveResults(CPD cpd, CpdMapping mapping, Project project, SensorContext context) {
066 CpdAnalyser cpdAnalyser = new CpdAnalyser(project, context, mapping);
067 cpdAnalyser.analyse(cpd.getMatches());
068 }
069
070 private CPD executeCPD(Project project, CpdMapping mapping, Charset encoding) {
071 try {
072 CPD cpd = configureCPD(project, mapping, encoding);
073 cpd.go();
074 return cpd;
075
076 } catch (Exception e) {
077 throw new CpdException(e);
078 }
079 }
080
081 private CPD configureCPD(Project project, CpdMapping mapping, Charset encoding) throws IOException {
082 // To avoid a cpd bug generating error as "java.lang.IndexOutOfBoundsException: Index: 259, Size: 248"
083 // See http://sourceforge.net/tracker/?func=detail&atid=479921&aid=1947823&group_id=56262 for more details
084 TokenEntry.clearImages();
085
086 int minTokens = getMinimumTokens(project);
087 AbstractLanguage cpdLanguage = new AbstractLanguage(mapping.getTokenizer()) {
088 };
089
090 CPD cpd = new CPD(minTokens, cpdLanguage);
091 cpd.setEncoding(encoding.name());
092 cpd.setLoadSourceCodeSlices(false);
093 cpd.add(project.getFileSystem().getSourceFiles(project.getLanguage()));
094 return cpd;
095 }
096
097 int getMinimumTokens(Project project) {
098 Configuration conf = project.getConfiguration();
099 return conf.getInt("sonar.cpd." + project.getLanguageKey() + ".minimumTokens",
100 conf.getInt("sonar.cpd.minimumTokens", CoreProperties.CPD_MINIMUM_TOKENS_DEFAULT_VALUE));
101 }
102
103 }