/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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 02110-1301, USA.
*/
package org.sonar.core.issue.db;
import org.sonar.api.issue.Issue;
import org.sonar.api.issue.IssueComment;
import org.sonar.api.issue.internal.DefaultIssue;
import org.sonar.api.issue.internal.DefaultIssueComment;
import org.sonar.api.issue.internal.FieldDiffs;
import org.sonar.api.rules.Rule;
import org.sonar.api.rules.RuleFinder;
import org.sonar.core.persistence.BatchSession;
import org.sonar.core.persistence.DbSession;
import org.sonar.core.persistence.MyBatis;
import java.util.Date;
import java.util.List;
import static com.google.common.collect.Lists.newArrayList;
/**
* Save issues into database. It is executed :
* <ul>
* <li>once at the end of scan, even on multi-module projects</li>
* <li>on each server-side action initiated by UI or web service</li>
* </ul>
*
* @since 3.6
*/
public abstract class IssueStorage {
private final MyBatis mybatis;
private final RuleFinder ruleFinder;
protected IssueStorage(MyBatis mybatis, RuleFinder ruleFinder) {
this.mybatis = mybatis;
this.ruleFinder = ruleFinder;
}
public void save(DefaultIssue issue) {
save(newArrayList(issue));
}
public void save(DbSession session, DefaultIssue issue) {
save(session, newArrayList(issue));
}
public void save(Iterable<DefaultIssue> issues) {
DbSession session = mybatis.openSession(true);
try {
save(session, issues);
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
private void save(DbSession session, Iterable<DefaultIssue> issues) {
// Batch session can not be used for updates. It does not return the number of updated rows,
// required for detecting conflicts.
Date now = new Date();
List<DefaultIssue> toBeUpdated = batchInsert(session, issues, now);
update(toBeUpdated, now);
}
private List<DefaultIssue> batchInsert(DbSession session, Iterable<DefaultIssue> issues, Date now) {
List<DefaultIssue> toBeUpdated = newArrayList();
int count = 0;
IssueChangeMapper issueChangeMapper = session.getMapper(IssueChangeMapper.class);
for (DefaultIssue issue : issues) {
if (issue.isNew()) {
doInsert(session, now, issue);
insertChanges(issueChangeMapper, issue);
if (count > BatchSession.MAX_BATCH_SIZE) {
session.commit();
}
count++;
} else if (issue.isChanged()) {
toBeUpdated.add(issue);
}
}
return toBeUpdated;
}
protected abstract void doInsert(DbSession batchSession, Date now, DefaultIssue issue);
private void update(List<DefaultIssue> toBeUpdated, Date now) {
if (!toBeUpdated.isEmpty()) {
DbSession session = mybatis.openSession(false);
try {
IssueChangeMapper issueChangeMapper = session.getMapper(IssueChangeMapper.class);
for (DefaultIssue issue : toBeUpdated) {
doUpdate(session, now, issue);
insertChanges(issueChangeMapper, issue);
}
session.commit();
} finally {
MyBatis.closeQuietly(session);
}
}
}
protected abstract void doUpdate(DbSession batchSession, Date now, DefaultIssue issue);
private void insertChanges(IssueChangeMapper mapper, DefaultIssue issue) {
for (IssueComment comment : issue.comments()) {
DefaultIssueComment c = (DefaultIssueComment) comment;
if (c.isNew()) {
IssueChangeDto changeDto = IssueChangeDto.of(c);
mapper.insert(changeDto);
}
}
FieldDiffs diffs = issue.currentChange();
if (!issue.isNew() && diffs != null) {
IssueChangeDto changeDto = IssueChangeDto.of(issue.key(), diffs);
mapper.insert(changeDto);
}
}
protected int ruleId(Issue issue) {
Rule rule = ruleFinder.findByKey(issue.ruleKey());
if (rule == null) {
throw new IllegalStateException("Rule not found: " + issue.ruleKey());
}
return rule.getId();
}
}