All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.dromara.jpom.service.h2db.BaseWorkspaceService Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 2019 Of Him Code Technology Studio
 * Jpom is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 * 			http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
package org.dromara.jpom.service.h2db;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.lang.Opt;
import cn.hutool.core.util.CharsetUtil;
import cn.hutool.core.util.ReflectUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.db.Entity;
import cn.hutool.db.sql.Direction;
import cn.hutool.db.sql.Order;
import cn.hutool.extra.servlet.ServletUtil;
import cn.hutool.extra.spring.SpringUtil;
import org.dromara.jpom.common.BaseServerController;
import org.dromara.jpom.common.Const;
import org.dromara.jpom.common.ServerConst;
import org.dromara.jpom.common.i18n.I18nMessageUtil;
import org.dromara.jpom.dialect.DialectUtil;
import org.dromara.jpom.exception.PermissionException;
import org.dromara.jpom.model.BaseWorkspaceModel;
import org.dromara.jpom.model.PageResultDto;
import org.dromara.jpom.model.user.UserModel;
import org.dromara.jpom.service.user.UserBindWorkspaceService;
import org.springframework.util.Assert;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

/**
 * 工作空间 通用 service
 *
 * @author bwcx_jzy
 * @since 2021/8/13
 */
public abstract class BaseWorkspaceService extends BaseDbService {
    /**
     * 是否可以进行排序
     */
    private final boolean canSort;
    /**
     * 有排序字段的默认排序规则
     */
    private static final Order[] SORT_DEFAULT_ORDERS = new Order[]{
        new Order("sortValue", Direction.DESC),
        new Order("createTimeMillis", Direction.DESC),
        new Order("modifyTimeMillis", Direction.DESC),
        new Order("id", Direction.DESC)
    };

    public BaseWorkspaceService() {
        super();
        this.canSort = ReflectUtil.hasField(this.tClass, "sortValue");
    }

    /**
     * 根据工作空间查询
     *
     * @param request 请求
     * @return list
     */
    public List listByWorkspace(HttpServletRequest request) {
        String workspaceId = this.getCheckUserWorkspace(request);
        Entity entity = Entity.create();
        entity.set("workspaceId", workspaceId);
        List entities = super.queryList(entity);
        return super.entityToBeanList(entities);
    }

    /**
     * 根据主键ID + 请信息查询
     *
     * @param keyValue ID
     * @param request  请求
     * @return data
     */
    public T getByKey(String keyValue, HttpServletRequest request) {
        String workspace = this.getCheckUserWorkspace(request);
        return super.getByKey(keyValue, true, entity -> entity.set("workspaceId", workspace));
    }

    /**
     * 根据主键ID + 请信息查询
     *
     * @param keyValue ID
     * @param request  请求
     * @return data
     */
    public List getByKey(Collection keyValue, HttpServletRequest request) {
        String workspace = this.getCheckUserWorkspace(request);
        return super.getByKey(keyValue, true, entity -> entity.set("workspaceId", workspace));
    }

    /**
     * 根据主键ID + 请信息查询
     *
     * @param keyValue ID
     * @param request  请求
     * @param fill     是否填充数据
     * @return data
     */
    public T getByKey(String keyValue, HttpServletRequest request, boolean fill) {
        String workspace = this.getCheckUserWorkspace(request);
        return super.getByKey(keyValue, fill, entity -> entity.set("workspaceId", workspace));
    }

    /**
     * 根据主键ID + 用户ID
     *
     * @param keyValue  ID
     * @param userModel 用户
     * @return data
     */
    public T getByKey(String keyValue, UserModel userModel) {
        T byKey = super.getByKey(keyValue, false);
        if (byKey == null) {
            return null;
        }
        this.checkUserWorkspace(byKey.getWorkspaceId(), userModel);
        return byKey;
    }

    @Override
    protected void fillInsert(T t) {
        super.fillInsert(t);
        if (StrUtil.isEmpty(t.getWorkspaceId())) {
            // 自动绑定 工作空间ID
            ServletRequestAttributes servletRequestAttributes = BaseServerController.tryGetRequestAttributes();
            if (servletRequestAttributes != null) {
                HttpServletRequest request = servletRequestAttributes.getRequest();
                String workspaceId = this.getCheckUserWorkspace(request);
                t.setWorkspaceId(workspaceId);
            } else {
                t.setWorkspaceId(Const.WORKSPACE_DEFAULT_ID);
            }
        } else {
            // 检查权限
            String modifyUser = t.getModifyUser();
            if (!StrUtil.equals(modifyUser, UserModel.SYSTEM_ADMIN)) {
                this.checkUserWorkspace(t.getWorkspaceId());
            }
        }
    }

    /**
     * 获取我所有的空间
     *
     * @param request 请求对象
     * @return page
     */
    @Override
    public PageResultDto listPage(HttpServletRequest request) {
        // 验证工作空间权限
        Map paramMap = ServletUtil.getParamMap(request);
        String workspaceId = this.getCheckUserWorkspace(request);
        //Assert.hasText(workspaceId, "此接口需要传workspaceId!");
        paramMap.put("workspaceId", workspaceId);
        return super.listPage(paramMap);
    }

//    /**
//     * 根据 workspaceId获取空间变量列表
//     *
//     * @param workspaceId
//     * @return
//     */
//    public List listByWorkspaceId(String workspaceId) {
//        Entity entity = Entity.create();
//        entity.set("workspaceId", workspaceId);
//        List entities = super.queryList(entity);
//        return super.entityToBeanList(entities);
//    }

    /**
     * 删除
     *
     * @param keyValue 主键
     * @param request  请求信息
     * @return 影响行数
     */
    public int delByKey(String keyValue, HttpServletRequest request) {
        String workspace = this.getCheckUserWorkspace(request);
        return super.delByKey(keyValue, entity -> entity.set("workspaceId", workspace));
    }

    /**
     * 删除,根据工作空间删除
     *
     * @param consumer 回调
     * @param request  请求信息
     * @return 影响行数
     */
    public int delByWorkspace(HttpServletRequest request, Consumer consumer) {
        String workspace = this.getCheckUserWorkspace(request);
        return super.delByKey(null, entity -> {
            entity.set("workspaceId", workspace);
            consumer.accept(entity);
            int size = entity.size();
            Assert.state(size > 1, I18nMessageUtil.get("i18n.no_parameters_added.1721"));
        });
    }

    public static String getWorkspaceId(HttpServletRequest request) {
        String workspaceId = request.getParameter(Const.WORKSPACE_ID_REQ_HEADER);
        if (StrUtil.isEmpty(workspaceId)) {
            workspaceId = ServletUtil.getHeader(request, Const.WORKSPACE_ID_REQ_HEADER, CharsetUtil.CHARSET_UTF_8);
        }
        return StrUtil.emptyToDefault(workspaceId, Const.WORKSPACE_DEFAULT_ID);
    }

    /**
     * 获取 工作空间ID 并判断是否有权限
     *
     * @param request 请求对象
     * @return 工作空间ID
     */
    public String getCheckUserWorkspace(HttpServletRequest request) {
        String workspaceId = getWorkspaceId(request);
        Assert.hasText(workspaceId, I18nMessageUtil.get("i18n.workspace_required.b3bd"));
        //
        this.checkUserWorkspace(workspaceId);
        return workspaceId;
    }

    /**
     * 判断用户是否有对应工作空间权限
     *
     * @param workspaceId 工作空间ID
     */
    public void checkUserWorkspace(String workspaceId) {
        UserModel userModel = BaseServerController.getUserByThreadLocal();
        this.checkUserWorkspace(workspaceId, userModel);
    }

    /**
     * 判断用户是否有对应工作空间权限
     *
     * @param workspaceId 工作空间ID
     */
    protected void checkUserWorkspace(String workspaceId, UserModel userModel) {
        Assert.notNull(userModel, I18nMessageUtil.get("i18n.no_user.3b69"));
        if (StrUtil.equals(userModel.getId(), UserModel.SYSTEM_ADMIN)) {
            // 系统执行,发行检查
            return;
        }
        if (userModel.isSuperSystemUser()) {
            // 超级管理员
            return;
        }
        if (StrUtil.equals(workspaceId, ServerConst.WORKSPACE_GLOBAL)) {
            // 全局 ID 忽略
            return;
        }
        // 查询绑定的权限
        UserBindWorkspaceService userBindWorkspaceService = SpringUtil.getBean(UserBindWorkspaceService.class);
        boolean exists = userBindWorkspaceService.exists(userModel, workspaceId);
        if (!exists) {
            throw new PermissionException(I18nMessageUtil.get("i18n.no_corresponding_workspace_permission.8402"));
        }
    }


    public List listById(Collection ids, HttpServletRequest request) {
        String workspaceId = this.getCheckUserWorkspace(request);
        return super.listById(ids, entity -> entity.set("workspaceId", workspaceId));
    }

    /**
     * 更新数据,根据ID+工作空间ID
     *
     * @param info    更新的数据
     * @param request 请求
     * @return 影响行数
     */
    public int updateById(T info, HttpServletRequest request) {
        String workspaceId = this.getCheckUserWorkspace(request);
        return super.updateById(info, entity -> entity.set("workspaceId", workspaceId));
    }

    // 排序相关方法 ---------


    @Override
    public Order[] defaultOrders() {
        if (canSort) {
            return SORT_DEFAULT_ORDERS;
        }
        return super.defaultOrders();
    }

    /**
     * 置顶
     *
     * @param id      数据ID
     * @param request 请求
     */
    public void sortToTop(String id, HttpServletRequest request) {
        Assert.state(canSort, I18nMessageUtil.get("i18n.data_not_supported_for_sorting.5431"));
        String workspaceId = this.getCheckUserWorkspace(request);
        String maxSql = "select max(sortValue) as sortValue from " + this.tableName + " where workspaceId=?";
        List query = this.query(maxSql, workspaceId);
        float maxSortValue = Opt.ofEmptyAble(query)
            .map(CollUtil::getFirst)
            .map(entity -> entity.getFloat("sortValue"))
            .orElse(1f);
        //
        String updateSql = "update " + this.tableName + " set sortValue=? where id=? and workspaceId=?";
        this.execute(updateSql, maxSortValue + 0.0001f, id, workspaceId);
    }

    /**
     * 向上移
     *
     * @param id       数据ID
     * @param beforeId 前面一个数据的ID
     * @param request  请求
     */
    public void sortMoveUp(String id, String beforeId, HttpServletRequest request) {
        this.sortMove(id, beforeId, request, true);
    }

    /**
     * 向下移
     *
     * @param id      数据ID
     * @param afterId 后面一个数据的ID
     * @param request 请求
     */
    public void sortMoveDown(String id, String afterId, HttpServletRequest request) {
        this.sortMove(id, afterId, request, false);
    }

    /**
     * 移动排序方法
     *
     * @param id        数据ID
     * @param compareId 比较的数据ID
     * @param request   请求
     * @param up        true 上移
     */
    private void sortMove(String id, String compareId, HttpServletRequest request, boolean up) {
        Assert.state(canSort, I18nMessageUtil.get("i18n.data_not_supported_for_sorting.5431"));
        Assert.hasText(id, I18nMessageUtil.get("i18n.data_id_does_not_exist.a566"));
        Assert.hasText(compareId, I18nMessageUtil.get("i18n.compare_id_not_exist.43be"));
        String workspaceId = this.getCheckUserWorkspace(request);
        String sql = "select sortValue as sortValue from " + this.tableName + " where id=? and workspaceId=?";
        List query = this.query(sql, compareId, workspaceId);
        float compareSortValue = Opt.ofEmptyAble(query)
            .map(CollUtil::getFirst)
            .map(entity -> entity.getFloat("sortValue"))
            .orElse(1f);
        String updateSql = "update " + this.tableName + " set sortValue=? where id=? and workspaceId=?";
        this.execute(updateSql, up ? compareSortValue + 0.0001f : compareSortValue - 0.0001f, id, workspaceId);
    }

    /**
     * load date group by group name
     *
     * @return list
     */
    public List listGroup(HttpServletRequest request) {
        String workspaceId = getCheckUserWorkspace(request);
        String group = DialectUtil.wrapField("group");
        String sql = String.format("select %s from %s where workspaceId=? group by %s", group, getTableName(), group);
        return super.listGroupByName(sql, group, workspaceId);
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy