001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.batch.issue.ignore;
021    
022    import org.sonar.batch.issue.ignore.pattern.IssueInclusionPatternInitializer;
023    import org.sonar.batch.issue.ignore.pattern.IssuePattern;
024    
025    import org.slf4j.Logger;
026    import org.slf4j.LoggerFactory;
027    import org.sonar.api.issue.Issue;
028    import org.sonar.api.issue.batch.IssueFilter;
029    import org.sonar.api.issue.batch.IssueFilterChain;
030    
031    public class EnforceIssuesFilter implements IssueFilter {
032    
033      private IssueInclusionPatternInitializer patternInitializer;
034    
035      private static final Logger LOG = LoggerFactory.getLogger(EnforceIssuesFilter.class);
036    
037      public EnforceIssuesFilter(IssueInclusionPatternInitializer patternInitializer) {
038        this.patternInitializer = patternInitializer;
039      }
040    
041      @Override
042      public boolean accept(Issue issue, IssueFilterChain chain) {
043        boolean atLeastOneRuleMatched = false;
044        boolean atLeastOnePatternFullyMatched = false;
045        IssuePattern matchingPattern = null;
046    
047        for (IssuePattern pattern : patternInitializer.getMulticriteriaPatterns()) {
048          if (pattern.getRulePattern().match(issue.ruleKey().toString())) {
049            atLeastOneRuleMatched = true;
050            String pathForComponent = patternInitializer.getPathForComponent(issue.componentKey());
051            if (pathForComponent != null && pattern.getResourcePattern().match(pathForComponent)) {
052              atLeastOnePatternFullyMatched = true;
053              matchingPattern = pattern;
054            }
055          }
056        }
057    
058        if (atLeastOneRuleMatched) {
059          if (atLeastOnePatternFullyMatched) {
060            LOG.debug("Issue {} enforced by pattern {}", issue, matchingPattern);
061          }
062          return atLeastOnePatternFullyMatched;
063        } else {
064          return chain.accept(issue);
065        }
066      }
067    }