3 * Copyright (C) 2009-2017 SonarSource SA
4 * mailto:info AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.server.permission.ws.template;
22 import org.sonar.api.server.ws.Request;
23 import org.sonar.api.server.ws.Response;
24 import org.sonar.api.server.ws.WebService;
25 import org.sonar.api.utils.System2;
26 import org.sonar.db.DbClient;
27 import org.sonar.db.DbSession;
28 import org.sonar.db.permission.template.PermissionTemplateCharacteristicDao;
29 import org.sonar.db.permission.template.PermissionTemplateCharacteristicDto;
30 import org.sonar.db.permission.template.PermissionTemplateDto;
31 import org.sonar.server.permission.ws.PermissionWsSupport;
32 import org.sonar.server.permission.ws.PermissionsWsAction;
33 import org.sonar.server.user.UserSession;
34 import org.sonarqube.ws.client.permission.RemoveProjectCreatorFromTemplateWsRequest;
36 import static org.sonar.server.permission.PermissionPrivilegeChecker.checkGlobalAdmin;
37 import static org.sonar.server.permission.ws.PermissionRequestValidator.validateProjectPermission;
38 import static org.sonar.server.permission.ws.PermissionsWsParametersBuilder.createProjectPermissionParameter;
39 import static org.sonar.server.permission.ws.PermissionsWsParametersBuilder.createTemplateParameters;
40 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_ORGANIZATION;
41 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_PERMISSION;
42 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_ID;
43 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_NAME;
45 public class RemoveProjectCreatorFromTemplateAction implements PermissionsWsAction {
46 private final DbClient dbClient;
47 private final PermissionWsSupport wsSupport;
48 private final UserSession userSession;
49 private final System2 system;
51 public RemoveProjectCreatorFromTemplateAction(DbClient dbClient, PermissionWsSupport wsSupport, UserSession userSession, System2 system) {
52 this.dbClient = dbClient;
53 this.wsSupport = wsSupport;
54 this.userSession = userSession;
58 private static RemoveProjectCreatorFromTemplateWsRequest toWsRequest(Request request) {
59 RemoveProjectCreatorFromTemplateWsRequest wsRequest = RemoveProjectCreatorFromTemplateWsRequest.builder()
60 .setPermission(request.mandatoryParam(PARAM_PERMISSION))
61 .setTemplateId(request.param(PARAM_TEMPLATE_ID))
62 .setOrganization(request.param(PARAM_ORGANIZATION))
63 .setTemplateName(request.param(PARAM_TEMPLATE_NAME))
65 validateProjectPermission(wsRequest.getPermission());
70 public void define(WebService.NewController context) {
71 WebService.NewAction action = context.createAction("remove_project_creator_from_template")
72 .setDescription("Remove a project creator from a permission template.<br>" +
73 "Requires the following permission: 'Administer System'.")
78 createTemplateParameters(action);
79 createProjectPermissionParameter(action);
83 public void handle(Request request, Response response) throws Exception {
84 doHandle(toWsRequest(request));
88 private void doHandle(RemoveProjectCreatorFromTemplateWsRequest request) {
89 try (DbSession dbSession = dbClient.openSession(false)) {
90 PermissionTemplateDto template = wsSupport.findTemplate(dbSession, WsTemplateRef.newTemplateRef(
91 request.getTemplateId(), request.getOrganization(), request.getTemplateName()));
92 checkGlobalAdmin(userSession, template.getOrganizationUuid());
94 PermissionTemplateCharacteristicDao dao = dbClient.permissionTemplateCharacteristicDao();
95 dao.selectByPermissionAndTemplateId(dbSession, request.getPermission(), template.getId())
96 .ifPresent(permissionTemplateCharacteristicDto -> updateTemplateCharacteristic(dbSession, permissionTemplateCharacteristicDto));
100 private void updateTemplateCharacteristic(DbSession dbSession, PermissionTemplateCharacteristicDto templatePermission) {
101 PermissionTemplateCharacteristicDto targetTemplatePermission = templatePermission
102 .setUpdatedAt(system.now())
103 .setWithProjectCreator(false);
104 dbClient.permissionTemplateCharacteristicDao().update(dbSession, targetTemplatePermission);