Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.sonar.server.ui.ws.ComponentAction Maven / Gradle / Ivy
/*
* 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.ui.ws;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.sonar.api.resources.Qualifiers;
import org.sonar.api.resources.ResourceType;
import org.sonar.api.resources.ResourceTypes;
import org.sonar.api.server.ws.Change;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService.NewAction;
import org.sonar.api.server.ws.WebService.NewController;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.api.web.UserRole;
import org.sonar.api.web.page.Page;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.component.ComponentDto;
import org.sonar.db.component.SnapshotDto;
import org.sonar.db.measure.MeasureDto;
import org.sonar.db.measure.MeasureQuery;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.permission.OrganizationPermission;
import org.sonar.db.property.PropertyDto;
import org.sonar.db.property.PropertyQuery;
import org.sonar.db.qualitygate.QualityGateDto;
import org.sonar.server.component.ComponentFinder;
import org.sonar.server.organization.BillingValidations;
import org.sonar.server.organization.BillingValidationsProxy;
import org.sonar.server.project.Visibility;
import org.sonar.server.qualitygate.QualityGateFinder;
import org.sonar.server.qualityprofile.QPMeasureData;
import org.sonar.server.qualityprofile.QualityProfile;
import org.sonar.server.ui.PageRepository;
import org.sonar.server.user.UserSession;
import static org.sonar.api.measures.CoreMetrics.QUALITY_PROFILES_KEY;
import static org.sonar.api.utils.DateUtils.formatDateTime;
import static org.sonar.api.web.UserRole.ADMIN;
import static org.sonar.api.web.UserRole.USER;
import static org.sonar.db.permission.OrganizationPermission.ADMINISTER_QUALITY_GATES;
import static org.sonar.db.permission.OrganizationPermission.ADMINISTER_QUALITY_PROFILES;
import static org.sonar.server.user.AbstractUserSession.insufficientPrivilegesException;
import static org.sonar.server.ws.KeyExamples.KEY_BRANCH_EXAMPLE_001;
import static org.sonar.server.ws.KeyExamples.KEY_PROJECT_EXAMPLE_001;
public class ComponentAction implements NavigationWsAction {
static final String PARAM_COMPONENT = "component";
static final String PARAM_BRANCH = "branch";
private static final String PROPERTY_CONFIGURABLE = "configurable";
private static final String PROPERTY_HAS_ROLE_POLICY = "hasRolePolicy";
private static final String PROPERTY_MODIFIABLE_HISTORY = "modifiable_history";
private static final String PROPERTY_UPDATABLE_KEY = "updatable_key";
/**
* The concept of "visibility" will only be configured for these qualifiers.
*/
private static final Set QUALIFIERS_WITH_VISIBILITY = ImmutableSet.of(Qualifiers.PROJECT, Qualifiers.VIEW, Qualifiers.APP);
private final DbClient dbClient;
private final PageRepository pageRepository;
private final ResourceTypes resourceTypes;
private final UserSession userSession;
private final ComponentFinder componentFinder;
private final QualityGateFinder qualityGateFinder;
private final BillingValidationsProxy billingValidations;
public ComponentAction(DbClient dbClient, PageRepository pageRepository, ResourceTypes resourceTypes, UserSession userSession,
ComponentFinder componentFinder, QualityGateFinder qualityGateFinder, BillingValidationsProxy billingValidations) {
this.dbClient = dbClient;
this.pageRepository = pageRepository;
this.resourceTypes = resourceTypes;
this.userSession = userSession;
this.componentFinder = componentFinder;
this.qualityGateFinder = qualityGateFinder;
this.billingValidations = billingValidations;
}
@Override
public void define(NewController context) {
NewAction projectNavigation = context.createAction("component")
.setDescription("Get information concerning component navigation for the current user. " +
"Requires the 'Browse' permission on the component's project.")
.setHandler(this)
.setInternal(true)
.setResponseExample(getClass().getResource("component-example.json"))
.setSince("5.2")
.setChangelog(
new Change("6.4", "The 'visibility' field is added"));
projectNavigation.createParam(PARAM_COMPONENT)
.setDescription("A component key.")
.setDeprecatedKey("componentKey", "6.4")
.setExampleValue(KEY_PROJECT_EXAMPLE_001);
projectNavigation
.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setInternal(true)
.setExampleValue(KEY_BRANCH_EXAMPLE_001);
}
@Override
public void handle(Request request, Response response) throws Exception {
String componentKey = request.mandatoryParam(PARAM_COMPONENT);
try (DbSession session = dbClient.openSession(false)) {
String branch = request.param(PARAM_BRANCH);
ComponentDto component = componentFinder.getByKeyAndOptionalBranch(session, componentKey, branch);
if (!userSession.hasComponentPermission(USER, component) &&
!userSession.hasComponentPermission(ADMIN, component) &&
!userSession.isSystemAdministrator()) {
throw insufficientPrivilegesException();
}
OrganizationDto org = componentFinder.getOrganization(session, component);
Optional analysis = dbClient.snapshotDao().selectLastAnalysisByRootComponentUuid(session, component.projectUuid());
JsonWriter json = response.newJsonWriter();
json.beginObject();
writeComponent(json, session, component, org, analysis.orElse(null));
writeProfiles(json, session, component);
writeQualityGate(json, session, component);
if (userSession.hasComponentPermission(ADMIN, component) ||
userSession.hasPermission(ADMINISTER_QUALITY_PROFILES, org) ||
userSession.hasPermission(ADMINISTER_QUALITY_GATES, org)) {
writeConfiguration(json, component, org);
}
writeBreadCrumbs(json, session, component);
json.endObject().close();
}
}
private static Consumer writeToJson(JsonWriter json) {
return profile -> json.beginObject()
.prop("key", profile.getQpKey())
.prop("name", profile.getQpName())
.prop("language", profile.getLanguageKey())
.endObject();
}
private static Function> toQualityProfiles() {
return dbMeasure -> QPMeasureData.fromJson(dbMeasure.getData()).getProfiles().stream();
}
private static void writePage(JsonWriter json, Page page) {
json.beginObject()
.prop("key", page.getKey())
.prop("name", page.getName())
.endObject();
}
private void writeComponent(JsonWriter json, DbSession session, ComponentDto component, OrganizationDto organizationDto, @Nullable SnapshotDto analysis) {
json.prop("key", component.getDbKey())
.prop("organization", organizationDto.getKey())
.prop("id", component.uuid())
.prop("name", component.name())
.prop("description", component.description())
.prop("isFavorite", isFavourite(session, component));
if (QUALIFIERS_WITH_VISIBILITY.contains(component.qualifier())) {
json.prop("visibility", Visibility.getLabel(component.isPrivate()));
}
List pages = pageRepository.getComponentPages(false, component.qualifier());
writeExtensions(json, component, pages);
if (analysis != null) {
json.prop("version", analysis.getVersion())
.prop("analysisDate", formatDateTime(new Date(analysis.getCreatedAt())));
}
}
private boolean isFavourite(DbSession session, ComponentDto component) {
PropertyQuery propertyQuery = PropertyQuery.builder()
.setUserId(userSession.getUserId())
.setKey("favourite")
.setComponentId(component.getId())
.build();
List componentFavourites = dbClient.propertiesDao().selectByQuery(propertyQuery, session);
return componentFavourites.size() == 1;
}
private void writeProfiles(JsonWriter json, DbSession session, ComponentDto component) {
json.name("qualityProfiles").beginArray();
dbClient.measureDao().selectSingle(session, MeasureQuery.builder().setComponentUuid(component.projectUuid()).setMetricKey(QUALITY_PROFILES_KEY).build())
.ifPresent(dbMeasure -> Stream.of(dbMeasure)
.flatMap(toQualityProfiles())
.forEach(writeToJson(json)));
json.endArray();
}
private void writeQualityGate(JsonWriter json, DbSession session, ComponentDto component) {
Optional qualityGateData = qualityGateFinder.getQualityGate(session, component.getId());
if (!qualityGateData.isPresent()) {
return;
}
QualityGateDto qualityGateDto = qualityGateData.get().getQualityGate();
json.name("qualityGate").beginObject()
.prop("key", qualityGateDto.getId())
.prop("name", qualityGateDto.getName())
.prop("isDefault", qualityGateData.get().isDefault())
.endObject();
}
private void writeExtensions(JsonWriter json, ComponentDto component, List pages) {
json.name("extensions").beginArray();
Predicate isAuthorized = page -> {
String requiredPermission = page.isAdmin() ? UserRole.ADMIN : UserRole.USER;
return userSession.hasComponentPermission(requiredPermission, component);
};
pages.stream()
.filter(isAuthorized)
.forEach(page -> writePage(json, page));
json.endArray();
}
private void writeConfiguration(JsonWriter json, ComponentDto component, OrganizationDto organization) {
boolean isProjectAdmin = userSession.hasComponentPermission(ADMIN, component);
json.name("configuration").beginObject();
writeConfigPageAccess(json, isProjectAdmin, component, organization);
if (isProjectAdmin) {
json.name("extensions").beginArray();
List configPages = pageRepository.getComponentPages(true, component.qualifier());
configPages.forEach(page -> writePage(json, page));
json.endArray();
}
json.endObject();
}
private void writeConfigPageAccess(JsonWriter json, boolean isProjectAdmin, ComponentDto component, OrganizationDto organization) {
boolean isProject = Qualifiers.PROJECT.equals(component.qualifier());
boolean showManualMeasures = isProjectAdmin && !Qualifiers.DIRECTORY.equals(component.qualifier());
boolean showBackgroundTasks = isProjectAdmin && (isProject || Qualifiers.VIEW.equals(component.qualifier()) || Qualifiers.APP.equals(component.qualifier()));
boolean isQualityProfileAdmin = userSession.hasPermission(OrganizationPermission.ADMINISTER_QUALITY_PROFILES, component.getOrganizationUuid());
boolean isQualityGateAdmin = userSession.hasPermission(OrganizationPermission.ADMINISTER_QUALITY_GATES, component.getOrganizationUuid());
boolean isOrganizationAdmin = userSession.hasPermission(OrganizationPermission.ADMINISTER, component.getOrganizationUuid());
json.prop("showSettings", isProjectAdmin && componentTypeHasProperty(component, PROPERTY_CONFIGURABLE));
json.prop("showQualityProfiles", isProject && (isProjectAdmin || isQualityProfileAdmin));
json.prop("showQualityGates", isProject && (isProjectAdmin || isQualityGateAdmin));
json.prop("showManualMeasures", showManualMeasures);
json.prop("showLinks", isProjectAdmin && isProject);
json.prop("showPermissions", isProjectAdmin && componentTypeHasProperty(component, PROPERTY_HAS_ROLE_POLICY));
json.prop("showHistory", isProjectAdmin && componentTypeHasProperty(component, PROPERTY_MODIFIABLE_HISTORY));
json.prop("showUpdateKey", isProjectAdmin && componentTypeHasProperty(component, PROPERTY_UPDATABLE_KEY));
json.prop("showBackgroundTasks", showBackgroundTasks);
json.prop("canApplyPermissionTemplate", isOrganizationAdmin);
json.prop("canUpdateProjectVisibilityToPrivate", isProjectAdmin &&
billingValidations.canUpdateProjectVisibilityToPrivate(new BillingValidations.Organization(organization.getKey(), organization.getUuid())));
}
private boolean componentTypeHasProperty(ComponentDto component, String resourceTypeProperty) {
ResourceType resourceType = resourceTypes.get(component.qualifier());
return resourceType != null && resourceType.getBooleanProperty(resourceTypeProperty);
}
private void writeBreadCrumbs(JsonWriter json, DbSession session, ComponentDto component) {
json.name("breadcrumbs").beginArray();
List breadcrumb = Lists.newArrayList();
breadcrumb.addAll(dbClient.componentDao().selectAncestors(session, component));
breadcrumb.add(component);
for (ComponentDto c : breadcrumb) {
json.beginObject()
.prop("key", c.getKey())
.prop("name", c.name())
.prop("qualifier", c.qualifier())
.endObject();
}
json.endArray();
}
}
