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.
/*
* SonarQube
* Copyright (C) 2009-2018 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.qualitygate.ws;
import com.google.common.io.Resources;
import java.util.Collection;
import java.util.List;
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.Paging;
import org.sonar.api.web.UserRole;
import org.sonar.core.util.stream.MoreCollectors;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.organization.OrganizationDto;
import org.sonar.db.qualitygate.ProjectQgateAssociation;
import org.sonar.db.qualitygate.ProjectQgateAssociationDto;
import org.sonar.db.qualitygate.ProjectQgateAssociationQuery;
import org.sonar.db.qualitygate.QGateWithOrgDto;
import org.sonar.server.qualitygate.QualityGateFinder;
import org.sonar.server.user.UserSession;
import org.sonarqube.ws.Qualitygates;
import static org.sonar.api.server.ws.WebService.Param.SELECTED;
import static org.sonar.api.utils.Paging.forPageIndex;
import static org.sonar.db.qualitygate.ProjectQgateAssociationQuery.ANY;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_GATE_ID;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_PAGE;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_PAGE_SIZE;
import static org.sonar.server.qualitygate.ws.QualityGatesWsParameters.PARAM_QUERY;
import static org.sonar.server.ws.WsUtils.writeProtobuf;
public class SearchAction implements QualityGatesWsAction {
private final DbClient dbClient;
private final UserSession userSession;
private QualityGateFinder qualityGateFinder;
private final QualityGatesWsSupport wsSupport;
public SearchAction(DbClient dbClient, UserSession userSession, QualityGateFinder qualityGateFinder, QualityGatesWsSupport wsSupport) {
this.dbClient = dbClient;
this.userSession = userSession;
this.qualityGateFinder = qualityGateFinder;
this.wsSupport = wsSupport;
}
@Override
public void define(WebService.NewController controller) {
WebService.NewAction action = controller.createAction("search")
.setDescription("Search for projects associated (or not) to a quality gate. " +
"Only authorized projects for current user will be returned.")
.setSince("4.3")
.setResponseExample(Resources.getResource(this.getClass(), "search-example.json"))
.setHandler(this);
action.createParam(PARAM_GATE_ID)
.setDescription("Quality Gate ID")
.setRequired(true)
.setExampleValue("1");
action.createParam(PARAM_QUERY)
.setDescription("To search for projects containing this string. If this parameter is set, \"selected\" is set to \"all\".")
.setExampleValue("abc");
action.addSelectionModeParam();
action.createParam(PARAM_PAGE)
.setDescription("Page number")
.setDefaultValue("1")
.setExampleValue("2");
action.createParam(PARAM_PAGE_SIZE)
.setDescription("Page size")
.setExampleValue("10");
wsSupport.createOrganizationParam(action);
}
@Override
public void handle(Request request, Response response) {
try (DbSession dbSession = dbClient.openSession(false)) {
OrganizationDto organization = wsSupport.getOrganization(dbSession, request);
QGateWithOrgDto qualityGate = qualityGateFinder.getByOrganizationAndId(dbSession, organization, request.mandatoryParamAsLong(PARAM_GATE_ID));
Association associations = find(dbSession,
ProjectQgateAssociationQuery.builder()
.qualityGate(qualityGate)
.membership(request.param(PARAM_QUERY) == null ? request.param(SELECTED) : ANY)
.projectSearch(request.param(PARAM_QUERY))
.pageIndex(request.paramAsInt(PARAM_PAGE))
.pageSize(request.paramAsInt(PARAM_PAGE_SIZE))
.build());
Qualitygates.SearchResponse.Builder createResponse = Qualitygates.SearchResponse.newBuilder()
.setMore(associations.hasMoreResults());
for (ProjectQgateAssociation project : associations.projects()) {
createResponse.addResultsBuilder()
.setId(project.id())
.setName(project.name())
.setSelected(project.isMember());
}
writeProtobuf(createResponse.build(), request, response);
}
}
private SearchAction.Association find(DbSession dbSession, ProjectQgateAssociationQuery query) {
List projects = dbClient.projectQgateAssociationDao().selectProjects(dbSession, query);
List authorizedProjects = keepAuthorizedProjects(dbSession, projects);
Paging paging = forPageIndex(query.pageIndex())
.withPageSize(query.pageSize())
.andTotal(authorizedProjects.size());
return new SearchAction.Association(toProjectAssociations(getPaginatedProjects(authorizedProjects, paging)), paging.hasNextPage());
}
private static List getPaginatedProjects(List projects, Paging paging) {
return projects.stream().skip(paging.offset()).limit(paging.pageSize()).collect(MoreCollectors.toList());
}
private static List toProjectAssociations(List dtos) {
return dtos.stream().map(ProjectQgateAssociationDto::toQgateAssociation).collect(MoreCollectors.toList());
}
private List keepAuthorizedProjects(DbSession dbSession, List projects) {
if (userSession.isRoot()) {
// the method AuthorizationDao#keepAuthorizedProjectIds() should be replaced by
// a call to UserSession, which would transparently support roots.
// Meanwhile root is explicitly handled.
return projects;
}
List projectIds = projects.stream().map(ProjectQgateAssociationDto::getId).collect(MoreCollectors.toList());
Collection authorizedProjectIds = dbClient.authorizationDao().keepAuthorizedProjectIds(dbSession, projectIds, userSession.getUserId(), UserRole.USER);
return projects.stream().filter(project -> authorizedProjectIds.contains(project.getId())).collect(MoreCollectors.toList());
}
private static class Association {
private List projects;
private boolean hasMoreResults;
private Association(List projects, boolean hasMoreResults) {
this.projects = projects;
this.hasMoreResults = hasMoreResults;
}
public List projects() {
return projects;
}
public boolean hasMoreResults() {
return hasMoreResults;
}
}
}
