org.sonar.server.issue.index.IssueResultSetIterator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.server.issue.index;

import com.google.common.base.CharMatcher;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterators;
import com.google.common.collect.Maps;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Date;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.resources.Scopes;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.rules.RuleType;
import org.sonar.db.DatabaseUtils;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.ResultSetIterator;

import static org.sonar.api.utils.DateUtils.longToDate;
import static org.sonar.db.DatabaseUtils.getLong;

/**
 * Scrolls over table ISSUES and reads documents to populate
 * the issues index
 */
class IssueResultSetIterator extends ResultSetIterator {

  private static final String[] FIELDS = {
    // column 1
    "i.kee",
    "root.uuid",
    "i.updated_at",
    "i.assignee",
    "i.gap",
    "i.issue_attributes",
    "i.line",
    "i.message",
    "i.resolution",
    "i.severity",

    // column 11
    "i.manual_severity",
    "i.checksum",
    "i.status",
    "i.effort",
    "i.author_login",
    "i.issue_close_date",
    "i.issue_creation_date",
    "i.issue_update_date",
    "r.plugin_name",
    "r.plugin_rule_key",

    // column 21
    "r.language",
    "p.uuid",
    "p.module_uuid_path",
    "p.path",
    "p.scope",
    "i.tags",
    "i.issue_type"
  };

  private static final String SQL_ALL = "select " + StringUtils.join(FIELDS, ",") + " from issues i " +
    "inner join rules r on r.id=i.rule_id " +
    "inner join projects p on p.uuid=i.component_uuid " +
    "inner join projects root on root.uuid=i.project_uuid";

  private static final String SQL_AFTER_DATE = SQL_ALL + " where i.updated_at>?";

  private static final String PROJECT_FILTER = " AND root.uuid=?";

  private static final Splitter TAGS_SPLITTER = Splitter.on(',').trimResults().omitEmptyStrings();

  private static final Splitter MODULE_PATH_SPLITTER = Splitter.on('.').trimResults().omitEmptyStrings();

  private IssueResultSetIterator(PreparedStatement stmt) throws SQLException {
    super(stmt);
  }

  static IssueResultSetIterator create(DbClient dbClient, DbSession session, long afterDate, @Nullable String projectUuid) {
    try {
      String sql = afterDate > 0L ? SQL_AFTER_DATE : SQL_ALL;
      sql += projectUuid == null ? "" : PROJECT_FILTER;
      PreparedStatement stmt = dbClient.getMyBatis().newScrollingSelectStatement(session, sql);
      int index = 1;
      if (afterDate > 0L) {
        stmt.setLong(index, afterDate);
        index++;
      }
      if (projectUuid != null) {
        stmt.setString(index, projectUuid);
      }
      return new IssueResultSetIterator(stmt);
    } catch (SQLException e) {
      throw new IllegalStateException("Fail to prepare SQL request to select all issues", e);
    }
  }

  @CheckForNull
  private static String extractDirPath(@Nullable String filePath, String scope) {
    if (filePath != null) {
      if (Scopes.DIRECTORY.equals(scope)) {
        return filePath;
      }
      int lastSlashIndex = CharMatcher.anyOf("/").lastIndexIn(filePath);
      if (lastSlashIndex > 0) {
        return filePath.substring(0, lastSlashIndex);
      }
      return "/";
    }
    return null;
  }

  @CheckForNull
  private static String extractFilePath(@Nullable String filePath, String scope) {
    // On modules, the path contains the relative path of the module starting from its parent, and in E/S we're only interested in the path
    // of files and directories.
    // That's why the file path should be null on modules and projects.
    if (filePath != null && !Scopes.PROJECT.equals(scope)) {
      return filePath;
    }
    return null;
  }

  private static String extractModule(String moduleUuidPath) {
    return Iterators.getLast(MODULE_PATH_SPLITTER.split(moduleUuidPath).iterator());
  }

  @Override
  protected IssueDoc read(ResultSet rs) throws SQLException {
    IssueDoc doc = new IssueDoc(Maps.newHashMapWithExpectedSize(30));

    String key = rs.getString(1);
    String projectUuid = rs.getString(2);

    // all the fields must be present, even if value is null
    doc.setKey(key);
    doc.setProjectUuid(projectUuid);
    doc.setTechnicalUpdateDate(new Date(rs.getLong(3)));
    doc.setAssignee(rs.getString(4));
    doc.setGap(DatabaseUtils.getDouble(rs, 5));
    doc.setAttributes(rs.getString(6));
    doc.setLine(DatabaseUtils.getInt(rs, 7));
    doc.setMessage(rs.getString(8));
    doc.setResolution(rs.getString(9));
    doc.setSeverity(rs.getString(10));
    doc.setManualSeverity(rs.getBoolean(11));
    doc.setChecksum(rs.getString(12));
    doc.setStatus(rs.getString(13));
    doc.setEffort(getLong(rs, 14));
    doc.setAuthorLogin(rs.getString(15));
    doc.setFuncCloseDate(longToDate(getLong(rs, 16)));
    doc.setFuncCreationDate(longToDate(getLong(rs, 17)));
    doc.setFuncUpdateDate(longToDate(getLong(rs, 18)));
    String ruleRepo = rs.getString(19);
    String ruleKey = rs.getString(20);
    doc.setRuleKey(RuleKey.of(ruleRepo, ruleKey).toString());
    doc.setLanguage(rs.getString(21));
    doc.setComponentUuid(rs.getString(22));
    String moduleUuidPath = rs.getString(23);
    doc.setModuleUuid(extractModule(moduleUuidPath));
    doc.setModuleUuidPath(moduleUuidPath);
    String scope = rs.getString(25);
    String filePath = extractFilePath(rs.getString(24), scope);
    doc.setFilePath(filePath);
    doc.setDirectoryPath(extractDirPath(doc.filePath(), scope));
    String tags = rs.getString(26);
    doc.setTags(ImmutableList.copyOf(TAGS_SPLITTER.split(tags == null ? "" : tags)));
    doc.setType(RuleType.valueOf(rs.getInt(27)));
    return doc;
  }
}