source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube, open source software quality management tool.
   3  * Copyright (C) 2008-2014 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * SonarQube 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.
  10  *
  11  * SonarQube 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.
  15  *
  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.
  19  */
  20
  21 package org.sonar.server.permission.ws;
  22
  23 import com.google.common.base.Optional;
  24 import org.sonar.api.i18n.I18n;
  25 import org.sonar.api.server.ws.Request;
  26 import org.sonar.api.server.ws.Response;
  27 import org.sonar.api.server.ws.WebService;
  28 import org.sonar.api.server.ws.WebService.Param;
  29 import org.sonar.api.utils.Paging;
  30 import org.sonar.core.permission.ProjectPermissions;
  31 import org.sonar.db.DbClient;
  32 import org.sonar.db.DbSession;
  33 import org.sonar.db.component.ComponentDto;
  34 import org.sonar.server.user.UserSession;
  35 import org.sonarqube.ws.Common;
  36 import org.sonarqube.ws.WsPermissions.Permission;
  37 import org.sonarqube.ws.WsPermissions.SearchProjectPermissionsWsResponse;
  38 import org.sonarqube.ws.WsPermissions.SearchProjectPermissionsWsResponse.Project;
  39 import org.sonarqube.ws.client.permission.SearchProjectPermissionsWsRequest;
  40
  41 import static org.sonar.server.permission.PermissionPrivilegeChecker.checkGlobalAdminUser;
  42 import static org.sonar.server.permission.PermissionPrivilegeChecker.checkProjectAdminUserByComponentKey;
  43 import static org.sonar.server.permission.PermissionPrivilegeChecker.checkProjectAdminUserByComponentUuid;
  44 import static org.sonar.server.permission.ws.PermissionsWsParametersBuilder.createProjectParameter;
  45 import static org.sonar.server.permission.ws.WsProjectRef.newOptionalWsProjectRef;
  46 import static org.sonar.server.ws.WsUtils.writeProtobuf;
  47 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_PROJECT_ID;
  48 import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_PROJECT_KEY;
  49
  50 public class SearchProjectPermissionsAction implements PermissionsWsAction {
  51   private static final String PROPERTY_PREFIX = "projects_role.";
  52   private static final String DESCRIPTION_SUFFIX = ".desc";
  53
  54   private final DbClient dbClient;
  55   private final UserSession userSession;
  56   private final I18n i18n;
  57   private final SearchProjectPermissionsDataLoader dataLoader;
  58
  59   public SearchProjectPermissionsAction(DbClient dbClient, UserSession userSession, I18n i18n, SearchProjectPermissionsDataLoader dataLoader) {
  60     this.dbClient = dbClient;
  61     this.userSession = userSession;
  62     this.i18n = i18n;
  63     this.dataLoader = dataLoader;
  64   }
  65
  66   @Override
  67   public void define(WebService.NewController context) {
  68     WebService.NewAction action = context.createAction("search_project_permissions")
  69       .setDescription("List project permissions. A project can be a technical project, a view or a developer.<br />" +
  70         "Requires 'Administer System' permission or 'Administer' rights on the specified project.")
  71       .setResponseExample(getClass().getResource("search_project_permissions-example.json"))
  72       .setSince("5.2")
  73       .addPagingParams(25)
  74       .addSearchQuery("sonarq", "project names", "project keys")
  75       .setHandler(this);
  76
  77     createProjectParameter(action);
  78   }
  79
  80   @Override
  81   public void handle(Request wsRequest, Response wsResponse) throws Exception {
  82     SearchProjectPermissionsWsResponse searchProjectPermissionsWsResponse = doHandle(toSearchProjectPermissionsWsRequest(wsRequest));
  83     writeProtobuf(searchProjectPermissionsWsResponse, wsRequest, wsResponse);
  84   }
  85
  86   private SearchProjectPermissionsWsResponse doHandle(SearchProjectPermissionsWsRequest request) {
  87     checkRequestAndPermissions(request);
  88     DbSession dbSession = dbClient.openSession(false);
  89     try {
  90       SearchProjectPermissionsData data = dataLoader.load(request);
  91       return buildResponse(data);
  92     } finally {
  93       dbClient.closeSession(dbSession);
  94     }
  95   }
  96
  97   private static SearchProjectPermissionsWsRequest toSearchProjectPermissionsWsRequest(Request request) {
  98     return new SearchProjectPermissionsWsRequest()
  99       .setProjectId(request.param(PARAM_PROJECT_ID))
 100       .setProjectKey(request.param(PARAM_PROJECT_KEY))
 101       .setPage(request.mandatoryParamAsInt(Param.PAGE))
 102       .setPageSize(request.mandatoryParamAsInt(Param.PAGE_SIZE))
 103       .setQuery(request.param(Param.TEXT_QUERY));
 104   }
 105
 106   private void checkRequestAndPermissions(SearchProjectPermissionsWsRequest request) {
 107     Optional<WsProjectRef> project = newOptionalWsProjectRef(request.getProjectId(), request.getProjectKey());
 108     boolean hasProject = project.isPresent();
 109     boolean hasProjectUuid = hasProject && project.get().uuid() != null;
 110     boolean hasProjectKey = hasProject && project.get().key() != null;
 111
 112     if (hasProjectUuid) {
 113       checkProjectAdminUserByComponentUuid(userSession, project.get().uuid());
 114     } else if (hasProjectKey) {
 115       checkProjectAdminUserByComponentKey(userSession, project.get().key());
 116     } else {
 117       checkGlobalAdminUser(userSession);
 118     }
 119   }
 120
 121   private SearchProjectPermissionsWsResponse buildResponse(SearchProjectPermissionsData data) {
 122     SearchProjectPermissionsWsResponse.Builder response = SearchProjectPermissionsWsResponse.newBuilder();
 123     Permission.Builder permissionResponse = Permission.newBuilder();
 124
 125     Project.Builder rootComponentBuilder = Project.newBuilder();
 126     for (ComponentDto rootComponent : data.rootComponents()) {
 127       rootComponentBuilder
 128         .clear()
 129         .setId(rootComponent.uuid())
 130         .setKey(rootComponent.key())
 131         .setQualifier(rootComponent.qualifier())
 132         .setName(rootComponent.name());
 133       for (String permission : data.permissions(rootComponent.getId())) {
 134         rootComponentBuilder.addPermissions(
 135           permissionResponse
 136             .clear()
 137             .setKey(permission)
 138             .setUsersCount(data.userCount(rootComponent.getId(), permission))
 139             .setGroupsCount(data.groupCount(rootComponent.getId(), permission)));
 140       }
 141       response.addProjects(rootComponentBuilder);
 142     }
 143
 144     for (String permissionKey : ProjectPermissions.ALL) {
 145       response.addPermissions(
 146         permissionResponse
 147           .clear()
 148           .setKey(permissionKey)
 149           .setName(i18nName(permissionKey))
 150           .setDescription(i18nDescriptionMessage(permissionKey)));
 151     }
 152
 153     Paging paging = data.paging();
 154     response.setPaging(
 155       Common.Paging.newBuilder()
 156         .setPageIndex(paging.pageIndex())
 157         .setPageSize(paging.pageSize())
 158         .setTotal(paging.total()));
 159
 160     return response.build();
 161   }
 162
 163   private String i18nDescriptionMessage(String permissionKey) {
 164     return i18n.message(userSession.locale(), PROPERTY_PREFIX + permissionKey + DESCRIPTION_SUFFIX, "");
 165   }
 166
 167   private String i18nName(String permissionKey) {
 168     return i18n.message(userSession.locale(), PROPERTY_PREFIX + permissionKey, permissionKey);
 169   }
 170 }