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.pmd;
021    
022    import org.sonar.api.batch.Sensor;
023    import org.sonar.api.batch.SensorContext;
024    import org.sonar.api.profiles.RulesProfile;
025    import org.sonar.api.resources.Project;
026    import org.sonar.api.rules.RuleFinder;
027    import org.sonar.api.utils.XmlParserException;
028    
029    import java.io.File;
030    
031    public class PmdSensor implements Sensor {
032    
033      private RulesProfile profile;
034      private RuleFinder rulesFinder;
035      private PmdExecutor executor;
036    
037      public PmdSensor(RulesProfile profile, RuleFinder rulesFinder, PmdExecutor executor) {
038        this.profile = profile;
039        this.rulesFinder = rulesFinder;
040        this.executor = executor;
041      }
042    
043      public void analyse(Project project, SensorContext context) {
044        try {
045          File xmlReport = executor.execute();
046          getStaxParser(project, context).parse(xmlReport);
047    
048        } catch (Exception e) {
049          // TOFIX
050          throw new XmlParserException(e);
051        }
052      }
053    
054      public boolean shouldExecuteOnProject(Project project) {
055        return project.getFileSystem().hasJavaSourceFiles() &&
056            !profile.getActiveRulesByRepository(PmdConstants.REPOSITORY_KEY).isEmpty();
057      }
058    
059      private PmdViolationsXmlParser getStaxParser(Project project, SensorContext context) {
060        return new PmdViolationsXmlParser(project, rulesFinder, context);
061      }
062    
063      @Override
064      public String toString() {
065        return getClass().getSimpleName();
066      }
067    }