150 lines
6.6 KiB
Python
150 lines
6.6 KiB
Python
# +======================================================================
|
|
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
|
# +----------------------------------------------------------------------
|
|
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
|
# +----------------------------------------------------------------------
|
|
# | 开源协议: Apache-2.0
|
|
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
|
# +----------------------------------------------------------------------
|
|
# | 官方网站: https://www.djangoadmin.cn
|
|
# +----------------------------------------------------------------------
|
|
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
|
# +======================================================================
|
|
# | 版权和免责声明:
|
|
# | 一、知识产权声明
|
|
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
|
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
|
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
|
# | 二、使用限制与禁止条款
|
|
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
|
# | 1. 任何违反中华人民共和国法律法规的用途；
|
|
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
|
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
|
# | 三、责任豁免
|
|
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
|
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
|
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
|
# | 四、违约与法律责任
|
|
# | 如发现任何违反本声明的行为，本团队有权：
|
|
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
|
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
|
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
|
# | 五、许可范围说明
|
|
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
|
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
|
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
|
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
|
# | 成的一切经济损失及商誉损害。
|
|
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
|
# | 许可协议》附件为准。
|
|
# +======================================================================
|
|
|
|
"""
|
|
用户安全工具模块
|
|
=============================================================
|
|
|
|
该模块提供了用户认证和安全相关的工具函数。
|
|
用于快速获取当前登录用户的信息，简化业务代码中的用户信息获取操作。
|
|
"""
|
|
import logging
|
|
|
|
from utils.jwt import parse_token
|
|
|
|
|
|
# ============================= 用户信息获取工具 =============================
|
|
|
|
|
|
def get_user_id(request):
|
|
"""
|
|
获取当前登录用户ID
|
|
=============================================================
|
|
|
|
快速获取当前登录用户的ID，用于需要用户ID的业务场景。
|
|
基于parse_token函数实现，简化调用方式。
|
|
|
|
使用场景：
|
|
- 记录操作日志时需要记录操作人ID
|
|
- 数据查询时进行用户权限过滤
|
|
- 创建数据时自动关联当前用户
|
|
|
|
参数:
|
|
request (HttpRequest): Django请求对象，包含请求头中的token信息
|
|
|
|
返回:
|
|
int: 当前登录用户的ID，若token无效或用户不存在则返回0
|
|
|
|
异常:
|
|
可能抛出parse_token函数产生的异常（如token过期、token无效等）
|
|
建议调用方自行处理异常
|
|
|
|
示例:
|
|
>>> user_id = get_user_id(request)
|
|
>>> if user_id:
|
|
... # 执行需要用户ID的操作
|
|
... create_log(user_id, "操作内容")
|
|
"""
|
|
try:
|
|
# 解析请求中的token，获取用户信息
|
|
result = parse_token(request)
|
|
|
|
# 安全获取用户ID，避免KeyError
|
|
if result and isinstance(result, dict):
|
|
data = result.get('data', {})
|
|
if isinstance(data, dict):
|
|
return data.get('userId', 0)
|
|
|
|
return 0
|
|
except Exception as e:
|
|
# 记录异常日志（可根据需要添加日志记录）
|
|
# logger.error(f"获取用户ID失败: {str(e)}")
|
|
return 0
|
|
|
|
|
|
def get_username(request):
|
|
"""
|
|
获取当前登录用户名称
|
|
=============================================================
|
|
|
|
快速获取当前登录用户的真实姓名，用于显示用户信息。
|
|
基于parse_token函数实现，简化调用方式。
|
|
|
|
使用场景：
|
|
- 在页面中显示当前登录用户名称
|
|
- 记录操作日志时显示操作人姓名
|
|
- 发送通知时获取用户名称
|
|
|
|
参数:
|
|
request (HttpRequest): Django请求对象，包含请求头中的token信息
|
|
|
|
返回:
|
|
str: 当前登录用户的真实姓名（realname），若token无效或用户不存在则返回空字符串
|
|
|
|
异常:
|
|
可能抛出parse_token函数产生的异常（如token过期、token无效等）
|
|
建议调用方自行处理异常
|
|
|
|
示例:
|
|
>>> username = get_username(request)
|
|
>>> if username:
|
|
... print(f"当前用户: {username}")
|
|
... else:
|
|
... print("未登录或token无效")
|
|
"""
|
|
try:
|
|
# 解析请求中的token，获取用户信息
|
|
result = parse_token(request)
|
|
|
|
# 安全获取用户真实姓名，避免KeyError和None值
|
|
if result and isinstance(result, dict):
|
|
data = result.get('data', {})
|
|
if isinstance(data, dict):
|
|
username = data.get('realname')
|
|
# 如果realname为None或空字符串，返回空字符串
|
|
return username if username else ''
|
|
|
|
return ''
|
|
except Exception as e:
|
|
# 记录异常日志（可根据需要添加日志记录）
|
|
logging.error(f"获取用户名失败: {str(e)}")
|
|
return ''
|