001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2009 SonarSource SA
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.jpa.dao;
021
022 import org.sonar.api.database.DatabaseSession;
023 import org.sonar.api.database.model.RuleFailureModel;
024 import org.sonar.api.database.model.Snapshot;
025 import org.sonar.api.profiles.RulesProfile;
026 import org.sonar.api.rules.ActiveRule;
027 import org.sonar.api.rules.ActiveRuleParam;
028 import org.sonar.api.rules.Rule;
029 import org.sonar.api.rules.RuleParam;
030
031 import java.util.Iterator;
032 import java.util.List;
033
034 public class RulesDao extends BaseDao {
035
036 public RulesDao(DatabaseSession session) {
037 super(session);
038 }
039
040 public List<Rule> getRules() {
041 return getSession().getResults(Rule.class, "enabled", true);
042 }
043
044 public List<Rule> getRulesByRepository(String repositoryKey) {
045 return getSession().getResults(Rule.class, "pluginName", repositoryKey, "enabled", true);
046 }
047
048 /**
049 * @deprecated since 2.5 use {@link #getRulesByRepository(String)} instead.
050 */
051 @Deprecated
052 public List<Rule> getRulesByPlugin(String pluginKey) {
053 return getRulesByRepository(pluginKey);
054 }
055
056 public Rule getRuleByKey(String repositoryKey, String ruleKey) {
057 return getSession().getSingleResult(Rule.class, "key", ruleKey, "pluginName", repositoryKey, "enabled", true);
058 }
059
060 public Long countRules(List<String> plugins) {
061 return (Long) getSession().createQuery(
062 "SELECT COUNT(r) FROM Rule r WHERE r.pluginName IN (:pluginNames) AND r.enabled=true").
063 setParameter("pluginNames", plugins).
064 getSingleResult();
065 }
066
067 public List<RuleParam> getRuleParams() {
068 return getSession().getResults(RuleParam.class);
069 }
070
071 public RuleParam getRuleParam(Rule rule, String paramKey) {
072 return getSession().getSingleResult(RuleParam.class, "rule", rule, "key", paramKey);
073 }
074
075 public void addActiveRulesToProfile(List<ActiveRule> activeRules, int profileId, String pluginKey) {
076 RulesProfile rulesProfile = getProfileById(profileId);
077 for (ActiveRule activeRule : activeRules) {
078 synchronizeRuleOfActiveRule(activeRule, pluginKey);
079 activeRule.setRulesProfile(rulesProfile);
080 getSession().save(activeRule);
081 }
082 }
083
084 public List<RuleFailureModel> getViolations(Snapshot snapshot) {
085 return getSession().getResults(RuleFailureModel.class, "snapshotId", snapshot.getId());
086 }
087
088 public void synchronizeRuleOfActiveRule(ActiveRule activeRule, String pluginKey) {
089 Rule rule = activeRule.getRule();
090 Rule ruleFromDataBase = getRuleByKey(pluginKey, rule.getKey());
091 activeRule.setRule(ruleFromDataBase);
092 List<RuleParam> ruleParamsFromDataBase = getRuleParams();
093 for (ActiveRuleParam activeRuleParam : activeRule.getActiveRuleParams()) {
094 boolean found = false;
095 Iterator<RuleParam> iterator = ruleParamsFromDataBase.iterator();
096 while (iterator.hasNext() && !found) {
097 RuleParam ruleParamFromDataBase = iterator.next();
098 if (isRuleParamEqual(activeRuleParam.getRuleParam(), ruleParamFromDataBase, rule.getKey(), pluginKey)) {
099 activeRuleParam.setRuleParam(ruleParamFromDataBase);
100 found = true;
101 }
102 }
103 }
104 }
105
106 public boolean isRuleParamEqual(RuleParam ruleParam, RuleParam ruleParamFromDatabase, String ruleKey, String pluginKey) {
107 return ruleParam.getKey().equals(ruleParamFromDatabase.getKey()) &&
108 ruleKey.equals(ruleParamFromDatabase.getRule().getKey()) &&
109 ruleParamFromDatabase.getRule().getPluginName().equals(pluginKey);
110 }
111
112 public RulesProfile getProfileById(int profileId) {
113 return getSession().getEntityManager().getReference(RulesProfile.class, profileId);
114 }
115
116 }