225 lines
7.7 KiB
Python
225 lines
7.7 KiB
Python
from typing import Iterable, AnyStr
|
||
from urllib.parse import urlencode
|
||
|
||
from django.conf import settings
|
||
from django.core.cache import cache
|
||
from django.utils.translation import gettext_lazy as _
|
||
from rest_framework.exceptions import APIException
|
||
|
||
from common.sdk.im.mixin import RequestMixin, BaseRequest
|
||
from common.sdk.im.utils import digest
|
||
from common.utils import reverse, random_string, get_logger, lazyproperty
|
||
from users.utils import construct_user_email, flatten_dict, map_attributes
|
||
|
||
logger = get_logger(__name__)
|
||
|
||
|
||
class WeComError(APIException):
|
||
default_code = 'wecom_error'
|
||
default_detail = _('WeCom error, please contact system administrator')
|
||
|
||
|
||
class URL:
|
||
GET_TOKEN = 'https://qyapi.weixin.qq.com/cgi-bin/gettoken'
|
||
SEND_MESSAGE = 'https://qyapi.weixin.qq.com/cgi-bin/message/send'
|
||
QR_CONNECT = 'https://login.work.weixin.qq.com/wwlogin/sso/login'
|
||
OAUTH_CONNECT = 'https://open.weixin.qq.com/connect/oauth2/authorize'
|
||
|
||
# https://open.work.weixin.qq.com/api/doc/90000/90135/91437
|
||
GET_USER_ID_BY_CODE = 'https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo'
|
||
GET_USER_DETAIL = 'https://qyapi.weixin.qq.com/cgi-bin/user/get'
|
||
|
||
|
||
class ErrorCode:
|
||
# https://open.work.weixin.qq.com/api/doc/90000/90139/90313#%E9%94%99%E8%AF%AF%E7%A0%81%EF%BC%9A81013
|
||
RECIPIENTS_INVALID = 81013 # UserID、部门ID、标签ID全部非法或无权限。
|
||
|
||
# https: // open.work.weixin.qq.com / devtool / query?e = 82001
|
||
RECIPIENTS_EMPTY = 82001 # 指定的成员/部门/标签全部为空
|
||
|
||
# https://open.work.weixin.qq.com/api/doc/90000/90135/91437
|
||
INVALID_CODE = 40029
|
||
|
||
INVALID_TOKEN = 40014 # 无效的 access_token
|
||
|
||
|
||
class WeComRequests(BaseRequest):
|
||
"""
|
||
处理系统级错误，抛出 API 异常，直接生成 HTTP 响应，业务代码无需关心这些错误
|
||
- 确保 status_code == 200
|
||
- 确保 access_token 无效时重试
|
||
"""
|
||
invalid_token_errcodes = (ErrorCode.INVALID_TOKEN,)
|
||
|
||
def __init__(self, corpid, corpsecret, agentid, timeout=None):
|
||
self._corpid = corpid or ''
|
||
self._corpsecret = corpsecret or ''
|
||
self._agentid = agentid or ''
|
||
|
||
super().__init__(timeout=timeout)
|
||
|
||
def get_access_token_cache_key(self):
|
||
return digest(self._corpid, self._corpsecret)
|
||
|
||
def request_access_token(self):
|
||
params = {'corpid': self._corpid, 'corpsecret': self._corpsecret}
|
||
data = self.raw_request('get', url=URL.GET_TOKEN, params=params)
|
||
|
||
access_token = data['access_token']
|
||
expires_in = data['expires_in']
|
||
return access_token, expires_in
|
||
|
||
def add_token(self, kwargs: dict):
|
||
params = kwargs.get('params')
|
||
if params is None:
|
||
params = {}
|
||
kwargs['params'] = params
|
||
|
||
params['access_token'] = self.access_token
|
||
|
||
|
||
class WeCom(RequestMixin):
|
||
"""
|
||
非业务数据导致的错误直接抛异常，说明是系统配置错误，业务代码不用理会
|
||
"""
|
||
|
||
def __init__(self, corpid, corpsecret, agentid, timeout=None):
|
||
self._corpid = corpid or ''
|
||
self._corpsecret = corpsecret or ''
|
||
self._agentid = agentid or ''
|
||
|
||
self._requests = WeComRequests(
|
||
corpid=corpid,
|
||
corpsecret=corpsecret,
|
||
agentid=agentid,
|
||
timeout=timeout
|
||
)
|
||
|
||
@property
|
||
def attributes(self):
|
||
return settings.WECOM_RENAME_ATTRIBUTES
|
||
|
||
def send_markdown(self, users: Iterable, msg: AnyStr, **kwargs):
|
||
pass
|
||
|
||
def send_text(self, users: Iterable, msg: AnyStr, markdown=False, **kwargs):
|
||
"""
|
||
https://open.work.weixin.qq.com/api/doc/90000/90135/90236
|
||
|
||
对于业务代码，只需要关心由 用户id 或 消息不对 导致的错误，其他错误不予理会
|
||
"""
|
||
users = tuple(users)
|
||
body = {
|
||
"touser": '|'.join(users),
|
||
"msgtype": "text",
|
||
"agentid": self._agentid,
|
||
"text": {
|
||
"content": msg
|
||
},
|
||
**kwargs
|
||
}
|
||
if markdown:
|
||
body['msgtype'] = 'markdown'
|
||
body["markdown"] = {
|
||
"content": msg
|
||
}
|
||
body.pop('text', '')
|
||
|
||
logger.info(f'Wecom send text: users={users} msg={msg}')
|
||
data = self._requests.post(URL.SEND_MESSAGE, json=body, check_errcode_is_0=False)
|
||
|
||
errcode = data['errcode']
|
||
if errcode in (ErrorCode.RECIPIENTS_INVALID, ErrorCode.RECIPIENTS_EMPTY):
|
||
# 全部接收人无权限或不存在
|
||
return users
|
||
self._requests.check_errcode_is_0(data)
|
||
|
||
if 'invaliduser' not in data:
|
||
return ()
|
||
|
||
invalid_user = data['invaliduser']
|
||
if not invalid_user:
|
||
return ()
|
||
|
||
if isinstance(invalid_user, str):
|
||
logger.error(f'WeCom send text 200, but invaliduser is not str: invaliduser={invalid_user}')
|
||
raise WeComError
|
||
|
||
invalid_users = invalid_user.split('|')
|
||
return invalid_users
|
||
|
||
def get_user_id_by_code(self, code):
|
||
# # https://open.work.weixin.qq.com/api/doc/90000/90135/91437
|
||
params = {'code': code}
|
||
data = self._requests.get(URL.GET_USER_ID_BY_CODE, params=params, check_errcode_is_0=False)
|
||
|
||
errcode = data['errcode']
|
||
if errcode == ErrorCode.INVALID_CODE:
|
||
logger.warning(f'WeCom get_user_id_by_code invalid code: code={code}')
|
||
return None, None
|
||
|
||
self._requests.check_errcode_is_0(data)
|
||
|
||
user_id = 'UserId'
|
||
open_id = 'OpenId'
|
||
if user_id in data:
|
||
return data[user_id], user_id
|
||
elif open_id in data:
|
||
return data[open_id], open_id
|
||
else:
|
||
logger.error(f'WeCom response 200 but get field from json error: fields=UserId|OpenId')
|
||
raise WeComError
|
||
|
||
@staticmethod
|
||
def default_user_detail(data, user_id):
|
||
username = data.get('userid', user_id)
|
||
name = data.get('name', username)
|
||
email = data.get('email') or data.get('biz_mail')
|
||
email = construct_user_email(username, email)
|
||
return {
|
||
'username': username, 'name': name, 'email': email
|
||
}
|
||
|
||
def get_user_detail(self, user_id, **kwargs):
|
||
# https://open.work.weixin.qq.com/api/doc/90000/90135/90196
|
||
data = self._requests.get(URL.GET_USER_DETAIL, {'userid': user_id})
|
||
info = flatten_dict(data)
|
||
default_detail = self.default_user_detail(data, user_id)
|
||
detail = map_attributes(default_detail, info, self.attributes)
|
||
return detail
|
||
|
||
|
||
class WeComTool(object):
|
||
WECOM_STATE_SESSION_KEY = '_wecom_state'
|
||
WECOM_STATE_VALUE = 'wecom'
|
||
|
||
@lazyproperty
|
||
def qr_cb_url(self):
|
||
return reverse('authentication:wecom-qr-login-callback', external=True)
|
||
|
||
def gen_state(self, request=None):
|
||
state = random_string(16)
|
||
if not request:
|
||
cache.set(state, self.WECOM_STATE_VALUE, timeout=60 * 60 * 24)
|
||
else:
|
||
request.session[self.WECOM_STATE_SESSION_KEY] = state
|
||
return state
|
||
|
||
def check_state(self, state, request=None):
|
||
return cache.get(state) == self.WECOM_STATE_VALUE or \
|
||
request.session.get(self.WECOM_STATE_SESSION_KEY) == state or \
|
||
request.GET.get('state') == state # 在企业微信桌面端打开的话，重新创建了个 session，会导致 session 校验失败
|
||
|
||
def wrap_redirect_url(self, next_url):
|
||
params = {
|
||
'appid': settings.WECOM_CORPID,
|
||
'agentid': settings.WECOM_AGENTID,
|
||
'state': self.gen_state(),
|
||
'redirect_uri': f'{self.qr_cb_url}?next={next_url}',
|
||
'response_type': 'code', 'scope': 'snsapi_base',
|
||
}
|
||
return URL.OAUTH_CONNECT + '?' + urlencode(params) + '#wechat_redirect'
|
||
|
||
|
||
wecom_tool = WeComTool()
|