org.apache.kylin.rest.service.UserService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kylin-common-service
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.kylin.rest.service;

import static org.apache.kylin.rest.constant.Constant.ROLE_ADMIN;

import java.io.IOException;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.apache.commons.lang3.StringUtils;
import org.apache.kylin.common.KylinConfig;
import org.apache.kylin.common.annotation.ThirdPartyDependencies;
import org.apache.kylin.common.util.CaseInsensitiveStringSet;
import org.apache.kylin.metadata.user.ManagedUser;
import org.apache.kylin.rest.request.CachedUserUpdateRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.provisioning.UserDetailsManager;

@ThirdPartyDependencies({ @ThirdPartyDependencies.ThirdPartyDependent(repository = "static-user-manager", classes = {
        "StaticUserGroupService" }) })
public interface UserService extends UserDetailsManager {

    Logger logger = LoggerFactory.getLogger(UserService.class);

    List listUsers() throws IOException;

    default List listUsers(boolean needSort) throws IOException {
        return listUsers();
    }

    List listAdminUsers() throws IOException;

    default List listSuperAdminUsers() {
        String superAdminUsername = KylinConfig.getInstanceFromEnv().getSuperAdminUsername();
        if (StringUtils.isEmpty(superAdminUsername)) {
            return Collections.emptyList();
        }
        List superAdmins = Collections.emptyList();
        try {
            superAdmins = listAdminUsers().stream().filter(user -> user.equalsIgnoreCase(superAdminUsername))
                    .collect(Collectors.toList());
        } catch (IOException e) {
            logger.error("listSuperAdminUsers error", e);
        }
        return superAdmins;
    }

    default List listNormalUsers() throws IOException {
        List adminUserNames = listAdminUsers();

        return listUsers().stream().map(ManagedUser::getUsername).filter(username -> !adminUserNames.contains(username))
                .collect(Collectors.toList());
    }

    //For performance consideration, list all users may be incomplete(
    // e.g. not load user's authorities until authorities has benn used).
    //So it's an extension point that can complete user's information latter.
    //loadUserByUsername() has guarantee that the return user is complete.
    void completeUserInfo(ManagedUser user);

    default List getManagedUsersByFuzzMatching(String userName, boolean isCaseSensitive)
            throws IOException {
        return listUsers().stream().filter(managedUser -> {
            if (StringUtils.isEmpty(userName)) {
                return true;
            } else if (isCaseSensitive) {
                return managedUser.getUsername().contains(userName);
            } else {
                return StringUtils.containsIgnoreCase(managedUser.getUsername(), userName);
            }
        }).collect(Collectors.toList());
    }

    default Set getGlobalAdmin() throws IOException {
        Set adminUsers = new CaseInsensitiveStringSet();
        adminUsers.addAll(listAdminUsers());
        return adminUsers;
    }

    default boolean containsGlobalAdmin(Set usernames) throws IOException {
        Set adminUsers = getGlobalAdmin();
        for (String name : usernames) {
            if (adminUsers.contains(name)) {
                return true;
            }
        }
        return false;
    }

    default boolean isGlobalAdmin(String username) throws IOException {
        try {
            UserDetails userDetails = loadUserByUsername(username);
            return isGlobalAdmin(userDetails);
        } catch (Exception e) {
            logger.debug("Cat not load user by username {}", username, e);
        }
        return false;
    }

    default boolean isGlobalAdmin(UserDetails userDetails) throws IOException {
        return userDetails != null && (userDetails.getAuthorities().stream()
                .anyMatch(grantedAuthority -> grantedAuthority.getAuthority().equals(ROLE_ADMIN))
                || getGlobalAdmin().contains(userDetails.getUsername()));
    }

    default Set retainsNormalUser(Set usernames) throws IOException {
        Set results = new HashSet<>(usernames);
        Set globalAdmin = getGlobalAdmin();
        results.removeIf(globalAdmin::contains);
        return results;
    }

    default void refresh(CachedUserUpdateRequest request) {

    }
}