Java tutorial
/* * Sonar Flex Plugin * Copyright (C) 2010 SonarSource * dev@sonar.codehaus.org * * 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 02 */ package org.sonar.plugins.flex.cpd; import org.apache.commons.io.FileUtils; import org.apache.commons.lang.StringUtils; import org.sonar.api.batch.Sensor; import org.sonar.api.batch.SensorContext; import org.sonar.api.batch.maven.DependsUponMavenPlugin; import org.sonar.api.batch.maven.MavenPluginHandler; import org.sonar.api.measures.CoreMetrics; import org.sonar.api.measures.Measure; import org.sonar.api.resources.Project; import org.sonar.api.resources.Resource; import org.sonar.api.utils.ParsingUtils; import org.sonar.api.utils.XmlParserException; import org.sonar.api.utils.XpathParser; import org.sonar.plugins.flex.Flex; import org.sonar.plugins.flex.FlexFile; import org.w3c.dom.Element; import org.w3c.dom.NodeList; import java.io.File; import java.io.IOException; import java.text.ParseException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; public class FlexCpdMavenSensor implements Sensor, DependsUponMavenPlugin { private FlexCpdMavenPluginHandler pluginHandler; public FlexCpdMavenSensor(FlexCpdMavenPluginHandler pluginHandler) { this.pluginHandler = pluginHandler; } public MavenPluginHandler getMavenPluginHandler(Project project) { return pluginHandler; } public boolean shouldExecuteOnProject(Project project) { return Flex.KEY.equals(project.getLanguageKey()); } public void analyse(Project project, SensorContext context) { File xmlFile = new File(project.getFileSystem().getBuildDir(), "cpd.xml"); collect(xmlFile, project, context); } protected void collect(File xmlFile, Project pom, SensorContext context) { try { if (xmlFile != null && xmlFile.exists()) { XpathParser parser = new XpathParser(); String xml = readXmlWithoutEncodingErrors(xmlFile); parser.parse(xml); NodeList duplications = parser.executeXPathNodeList("/pmd-cpd/duplication"); Map<Resource, ClassDuplicationData> duplicationsData = new HashMap<Resource, ClassDuplicationData>(); for (int i = 0; i < duplications.getLength(); i++) { Element duplication = (Element) duplications.item(i); NodeList files = parser.executeXPathNodeList(duplication, "file"); Element fileA = (Element) files.item(0); Element fileB = (Element) files.item(1); processClassMeasure(context, duplicationsData, fileB, fileA, duplication, pom); processClassMeasure(context, duplicationsData, fileA, fileB, duplication, pom); } for (ClassDuplicationData data : duplicationsData.values()) { data.saveUsing(context); } } } catch (ParseException e) { throw new XmlParserException(e); } } private String readXmlWithoutEncodingErrors(File file) { try { // First step : the file is read with system charset encoding. It should resolve the problem in most cases String xml = FileUtils.readFileToString(file); // second step : remove CDATA nodes that contain wrong characters. Those nodes are not needed by the collector. return removeCDataNodes(xml); } catch (IOException e) { throw new XmlParserException("can not read the file " + file.getAbsolutePath(), e); } } String removeCDataNodes(String xml) { String result = xml; String startNode = "<codefragment>"; String endNode = "</codefragment>"; String[] subs = StringUtils.substringsBetween(xml, startNode, endNode); if (subs != null) { for (String sub : subs) { result = StringUtils.remove(result, startNode + sub + endNode); } } return result; } private void processClassMeasure(SensorContext context, Map<Resource, ClassDuplicationData> fileContainer, Element fileEl, Element targetFileEl, Element duplication, Project project) throws ParseException { Resource flexFile = FlexFile.fromAbsolutePath(fileEl.getAttribute("path"), project.getFileSystem().getSourceDirs(), false); Resource targetJavaClass = FlexFile.fromAbsolutePath(targetFileEl.getAttribute("path"), project.getFileSystem().getSourceDirs(), false); if (flexFile != null) { ClassDuplicationData data = fileContainer.get(flexFile); if (data == null) { data = new ClassDuplicationData(flexFile, context); fileContainer.put(flexFile, data); } data.cumulate(targetJavaClass, ParsingUtils.parseNumber(targetFileEl.getAttribute("line")), ParsingUtils.parseNumber(fileEl.getAttribute("line")), ParsingUtils.parseNumber(duplication.getAttribute("lines"))); } } private static final class ClassDuplicationData { private double duplicatedLines; private double duplicatedBlocks; private Resource resource; private SensorContext context; private List<StringBuilder> duplicationXMLEntries = new ArrayList<StringBuilder>(); private ClassDuplicationData(Resource resource, SensorContext context) { this.context = context; this.resource = resource; } protected void cumulate(Resource targetResource, Double targetDuplicationStartLine, Double duplicationStartLine, Double duplicatedLines) { Resource resolvedResource = context.getResource(targetResource); if (resolvedResource != null) { StringBuilder xml = new StringBuilder(); xml.append("<duplication lines=\"").append(duplicatedLines.intValue()).append("\" start=\"") .append(duplicationStartLine.intValue()).append("\" target-start=\"") .append(targetDuplicationStartLine.intValue()).append("\" target-resource=\"") .append(resolvedResource.getEffectiveKey()).append("\"/>"); duplicationXMLEntries.add(xml); this.duplicatedLines += duplicatedLines; this.duplicatedBlocks++; } } protected void saveUsing(SensorContext context) { context.saveMeasure(resource, CoreMetrics.DUPLICATED_FILES, 1d); context.saveMeasure(resource, CoreMetrics.DUPLICATED_LINES, duplicatedLines); context.saveMeasure(resource, CoreMetrics.DUPLICATED_BLOCKS, duplicatedBlocks); context.saveMeasure(resource, new Measure(CoreMetrics.DUPLICATIONS_DATA, getDuplicationXMLData())); } private String getDuplicationXMLData() { StringBuilder duplicationXML = new StringBuilder("<duplications>"); for (StringBuilder xmlEntry : duplicationXMLEntries) { duplicationXML.append(xmlEntry); } duplicationXML.append("</duplications>"); return duplicationXML.toString(); } } @Override public String toString() { return getClass().getSimpleName(); } }