/*
* SonarQube
* Copyright (C) 2009-2017 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.server.qualityprofile.ws;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import org.apache.commons.io.IOUtils;
import org.sonar.api.resources.Language;
import org.sonar.api.resources.Languages;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.qualityprofile.QualityProfileDto;
import org.sonar.server.qualityprofile.BulkChangeResult;
import org.sonar.server.qualityprofile.QProfileBackuper;
import org.sonar.server.qualityprofile.QProfileRestoreSummary;
import org.sonar.server.user.UserSession;
import org.sonar.server.ws.WsAction;
import static com.google.common.base.Preconditions.checkArgument;
import static org.sonar.db.permission.OrganizationPermission.ADMINISTER_QUALITY_PROFILES;
/**
* @deprecated will be deleted once Orchestrator do not rely on this WS
* It is duplicated to enable
*/
@Deprecated
public class OldRestoreAction implements WsAction {
private static final String PARAM_BACKUP = "backup";
private final DbClient dbClient;
private final QProfileBackuper backuper;
private final Languages languages;
private final QProfileWsSupport qProfileWsSupport;
private final UserSession userSession;
public OldRestoreAction(DbClient dbClient, QProfileBackuper backuper, Languages languages, QProfileWsSupport qProfileWsSupport, UserSession userSession) {
this.dbClient = dbClient;
this.backuper = backuper;
this.languages = languages;
this.qProfileWsSupport = qProfileWsSupport;
this.userSession = userSession;
}
@Override
public void define(WebService.NewController controller) {
controller.createAction("restore")
.setSince("5.2")
.setDescription("Restore a quality profile using an XML file. The restored profile name is taken from the backup file, " +
"so if a profile with the same name and language already exists, it will be overwritten. " +
"Require Administer Quality Profiles permission.")
.setPost(true)
.setInternal(true)
.setHandler(this)
.createParam(PARAM_BACKUP)
.setDescription("A profile backup file in XML format, as generated by api/qualityprofiles/backup " +
"or the former api/profiles/backup.")
.setRequired(true);
}
@Override
public void handle(Request request, Response response) throws Exception {
userSession.checkLoggedIn();
InputStream backup = request.paramAsInputStream(PARAM_BACKUP);
checkArgument(backup != null, "A backup file must be provided");
InputStreamReader reader = null;
try (DbSession dbSession = dbClient.openSession(false)) {
OrganizationDto defaultOrg = qProfileWsSupport.getOrganizationByKey(dbSession, null);
userSession.checkPermission(ADMINISTER_QUALITY_PROFILES, defaultOrg);
reader = new InputStreamReader(backup, StandardCharsets.UTF_8);
QProfileRestoreSummary result = backuper.restore(dbSession, reader, defaultOrg, null);
writeResponse(response.newJsonWriter(), result);
} finally {
IOUtils.closeQuietly(reader);
IOUtils.closeQuietly(backup);
}
}
private void writeResponse(JsonWriter json, QProfileRestoreSummary result) {
QualityProfileDto profile = result.getProfile();
String languageKey = profile.getLanguage();
Language language = languages.get(languageKey);
JsonWriter jsonProfile = json.beginObject().name("profile").beginObject();
jsonProfile
.prop("key", profile.getKey())
.prop("name", profile.getName())
.prop("language", languageKey)
.prop("isDefault", false)
.prop("isInherited", false);
if (language != null) {
jsonProfile.prop("languageName", language.getName());
}
jsonProfile.endObject();
BulkChangeResult ruleChanges = result.getRuleChanges();
json.prop("ruleSuccesses", ruleChanges.countSucceeded());
json.prop("ruleFailures", ruleChanges.countFailed());
json.endObject().close();
}
}