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.core.sensors;
021    
022    import java.util.Iterator;
023    
024    import org.apache.commons.lang.StringUtils;
025    import org.sonar.api.batch.Event;
026    import org.sonar.api.batch.Sensor;
027    import org.sonar.api.batch.SensorContext;
028    import org.sonar.api.resources.Project;
029    import org.sonar.core.NotDryRun;
030    
031    @NotDryRun
032    public class VersionEventsSensor implements Sensor {
033    
034      private static final String SNAPSHOT_SUFFIX = "-SNAPSHOT";
035    
036      public boolean shouldExecuteOnProject(Project project) {
037        return true;
038      }
039    
040      public void analyse(Project project, SensorContext context) {
041        if (StringUtils.isBlank(project.getAnalysisVersion())) {
042          return;
043        }
044        deleteDeprecatedEvents(project, context);
045        context.createEvent(project, project.getAnalysisVersion(), null, Event.CATEGORY_VERSION, null);
046      }
047    
048      private void deleteDeprecatedEvents(Project project, SensorContext context) {
049        String version = project.getAnalysisVersion();
050        String snapshotVersionToDelete = (version.endsWith(SNAPSHOT_SUFFIX) ? "" : version + SNAPSHOT_SUFFIX);
051        for (Iterator<Event> it = context.getEvents(project).iterator(); it.hasNext();) {
052          Event event = it.next();
053          if (event.isVersionCategory() && (version.equals(event.getName()) || snapshotVersionToDelete.equals(event.getName()))) {
054            it.remove();
055            context.deleteEvent(event);
056          }
057        }
058      }
059    
060      @Override
061      public String toString() {
062        return getClass().getSimpleName();
063      }
064    }