org.sonar.api.profiles.XMLProfileSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation
The newest version!
/*
 * SonarQube
 * Copyright (C) 2009-2022 SonarSource SA
 * mailto:info 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.api.profiles;

import java.io.IOException;
import java.io.Writer;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.ce.ComputeEngineSide;
import org.sonar.api.rules.ActiveRule;
import org.sonar.api.rules.ActiveRuleParam;
import org.sonar.api.server.ServerSide;
import org.sonar.api.utils.SonarException;

/**
 * @since 2.3
 * @deprecated since 7.8
 */
@Deprecated
@ServerSide
@ComputeEngineSide
public class XMLProfileSerializer {

  public void write(RulesProfile profile, Writer writer) {
    try {
      appendHeader(profile, writer);
      appendRules(profile, writer);
      appendFooter(writer);

    } catch (IOException e) {
      throw new SonarException("Fail to export the profile " + profile, e);
    }
  }

  private static void appendHeader(RulesProfile profile, Writer writer) throws IOException {
    writer.append(""
      + ""
      + "");
    StringEscapeUtils.escapeXml(writer, profile.getName());
    writer.append("");
    StringEscapeUtils.escapeXml(writer, profile.getLanguage());
    writer.append("");
  }

  private static void appendRules(RulesProfile profile, Writer writer) throws IOException {
    if (!profile.getActiveRules().isEmpty()) {
      writer.append("");
      for (ActiveRule activeRule : profile.getActiveRules()) {
        appendRule(activeRule, writer);
      }
      writer.append("");
    }
  }

  private static void appendRule(ActiveRule activeRule, Writer writer) throws IOException {
    writer.append("");
    writer.append(activeRule.getRepositoryKey());
    writer.append("");
    StringEscapeUtils.escapeXml(writer, activeRule.getRuleKey());
    writer.append("");
    if (activeRule.getSeverity() != null) {
      writer.append("");
      writer.append(activeRule.getSeverity().name());
      writer.append("");
    }
    appendRuleParameters(activeRule, writer);
    writer.append("");
  }

  private static void appendRuleParameters(ActiveRule activeRule, Writer writer) throws IOException {
    if (activeRule.getActiveRuleParams() != null && !activeRule.getActiveRuleParams().isEmpty()) {
      writer.append("");
      for (ActiveRuleParam activeRuleParam : activeRule.getActiveRuleParams()) {
        appendRuleParameter(writer, activeRuleParam);
      }
      writer.append("");
    }
  }

  private static void appendRuleParameter(Writer writer, ActiveRuleParam activeRuleParam) throws IOException {
    if (StringUtils.isNotBlank(activeRuleParam.getValue())) {
      writer.append("");
      StringEscapeUtils.escapeXml(writer, activeRuleParam.getKey());
      writer.append("");
      StringEscapeUtils.escapeXml(writer, activeRuleParam.getValue());
      writer.append("");
      writer.append("");
    }
  }

  private static void appendFooter(Writer writer) throws IOException {
    writer.append("");
  }
}