org.sonar.db.permission.UserPermissionDao.java Source code

Introduction

Here is the source code for org.sonar.db.permission.UserPermissionDao.java

Source

/*
 * 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.db.permission;

import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;
import org.apache.ibatis.session.RowBounds;
import org.sonar.core.util.stream.Collectors;
import org.sonar.db.Dao;
import org.sonar.db.DatabaseUtils;
import org.sonar.db.DbSession;
import org.sonar.db.component.ComponentMapper;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Collections.emptyList;
import static org.sonar.db.DatabaseUtils.executeLargeInputs;

public class UserPermissionDao implements Dao {

    /**
     * List of user permissions ordered by alphabetical order of user names
     *  @param query non-null query including optional filters.
     * @param userLogins if null, then filter on all active users. If not null, then filter on logins, including disabled users.
     *                   Must not be empty. If not null then maximum size is {@link DatabaseUtils#PARTITION_SIZE_FOR_ORACLE}.
     */
    public List<UserPermissionDto> select(DbSession dbSession, PermissionQuery query,
            @Nullable Collection<String> userLogins) {
        if (userLogins != null) {
            if (userLogins.isEmpty()) {
                return emptyList();
            }
            checkArgument(userLogins.size() <= DatabaseUtils.PARTITION_SIZE_FOR_ORACLE,
                    "Maximum 1'000 users are accepted");
        }

        RowBounds rowBounds = new RowBounds(query.getPageOffset(), query.getPageSize());
        return mapper(dbSession).selectByQuery(query, userLogins, rowBounds);
    }

    /**
     * Shortcut over {@link #select(DbSession, PermissionQuery, Collection)} to return only distinct user
     * ids, keeping the same order.
     */
    public List<Integer> selectUserIds(DbSession dbSession, PermissionQuery query) {
        List<UserPermissionDto> dtos = select(dbSession, query, null);
        return dtos.stream().map(UserPermissionDto::getUserId).distinct().collect(Collectors.toList(dtos.size()));
    }

    /**
     * @see UserPermissionMapper#countUsersByQuery(String, PermissionQuery, Collection)
     */
    public int countUsers(DbSession dbSession, String organizationUuid, PermissionQuery query) {
        return mapper(dbSession).countUsersByQuery(organizationUuid, query, null);
    }

    /**
     * Count the number of users per permission for a given list of projects
     *
     * @param projectIds a non-null list of project ids to filter on. If empty then an empty list is returned.
     */
    public List<CountPerProjectPermission> countUsersByProjectPermission(DbSession dbSession,
            Collection<Long> projectIds) {
        return executeLargeInputs(projectIds, mapper(dbSession)::countUsersByProjectPermission);
    }

    /**
     * Gets all the global permissions granted to user for the specified organization.
     *
     * @return the global permissions. An empty list is returned if user or organization do not exist.
     */
    public List<String> selectGlobalPermissionsOfUser(DbSession dbSession, int userId, String organizationUuid) {
        return mapper(dbSession).selectGlobalPermissionsOfUser(userId, organizationUuid);
    }

    /**
     * Gets all the project permissions granted to user for the specified project.
     *
     * @return the project permissions. An empty list is returned if project or user do not exist.
     */
    public List<String> selectProjectPermissionsOfUser(DbSession dbSession, int userId, long projectId) {
        return mapper(dbSession).selectProjectPermissionsOfUser(userId, projectId);
    }

    public void insert(DbSession dbSession, UserPermissionDto dto) {
        ensureComponentPermissionConsistency(dbSession, dto);
        mapper(dbSession).insert(dto);
    }

    private static void ensureComponentPermissionConsistency(DbSession dbSession, UserPermissionDto dto) {
        if (dto.getComponentId() == null) {
            return;
        }
        ComponentMapper componentMapper = dbSession.getMapper(ComponentMapper.class);
        checkArgument(
                componentMapper.countComponentByOrganizationAndId(dto.getOrganizationUuid(),
                        dto.getComponentId()) == 1,
                "Can't insert permission '%s' for component with id '%s' in organization with uuid '%s' because this component does not belong to organization with uuid '%s'",
                dto.getPermission(), dto.getComponentId(), dto.getOrganizationUuid(), dto.getOrganizationUuid());
    }

    /**
     * Removes a single global permission from user
     */
    public void deleteGlobalPermission(DbSession dbSession, int userId, String permission,
            String organizationUuid) {
        mapper(dbSession).deleteGlobalPermission(userId, permission, organizationUuid);
    }

    /**
     * Removes a single project permission from user
     */
    public void deleteProjectPermission(DbSession dbSession, int userId, String permission, long projectId) {
        mapper(dbSession).deleteProjectPermission(userId, permission, projectId);
    }

    /**
     * Deletes all the permissions defined on a project
     */
    public void deleteProjectPermissions(DbSession dbSession, long projectId) {
        mapper(dbSession).deleteProjectPermissions(projectId);
    }

    public void deleteByOrganization(DbSession dbSession, String organizationUuid) {
        mapper(dbSession).deleteByOrganization(organizationUuid);
    }

    public void deleteOrganizationMemberPermissions(DbSession dbSession, String organizationUuid, int userId) {
        mapper(dbSession).deleteOrganizationMemberPermissions(organizationUuid, userId);
    }

    private static UserPermissionMapper mapper(DbSession dbSession) {
        return dbSession.getMapper(UserPermissionMapper.class);
    }
}