feat: 拆分 feishu lark

apps/authentication/api/__init__.py

@@ -6,6 +6,7 @@ from .common import *
 from .confirm import *
 from .connection_token import *
 from .feishu import *
+from .lark import *
 from .login_confirm import *
 from .mfa import *
 from .password import *

apps/authentication/api/common.py

@@ -12,7 +12,6 @@ from common.permissions import IsValidUser, OnlySuperUser
 from common.utils import get_logger
 from users.models import User
 
-
 logger = get_logger(__file__)
 
 
@@ -24,6 +23,7 @@ class QRUnBindBase(APIView):
             'wecom': {'user_field': 'wecom_id', 'not_bind_err': errors.WeComNotBound},
             'dingtalk': {'user_field': 'dingtalk_id', 'not_bind_err': errors.DingTalkNotBound},
             'feishu': {'user_field': 'feishu_id', 'not_bind_err': errors.FeiShuNotBound},
+            'lark': {'user_field': 'lark_id', 'not_bind_err': errors.LarkNotBound},
             'slack': {'user_field': 'slack_id', 'not_bind_err': errors.SlackNotBound},
         }
         user = self.user

apps/authentication/api/lark.py

@@ -0,0 +1,8 @@
+from common.utils import get_logger
+from .feishu import FeiShuEventSubscriptionCallback
+
+logger = get_logger(__name__)
+
+
+class LarkEventSubscriptionCallback(FeiShuEventSubscriptionCallback):
+    pass

apps/authentication/backends/sso.py

@@ -55,6 +55,12 @@ class FeiShuAuthentication(JMSModelBackend):
         pass
 
 
+class LarkAuthentication(FeiShuAuthentication):
+    @staticmethod
+    def is_enabled():
+        return settings.AUTH_LARK
+
+
 class SlackAuthentication(JMSModelBackend):
     """
     什么也不做呀😺
@@ -72,5 +78,6 @@ class AuthorizationTokenAuthentication(JMSModelBackend):
     """
     什么也不做呀😺
     """
+
     def authenticate(self, request, **kwargs):
         pass

apps/authentication/errors/mfa.py

@@ -33,6 +33,11 @@ class FeiShuNotBound(JMSException):
     default_detail = _('FeiShu is not bound')
 
 
+class LarkNotBound(JMSException):
+    default_code = 'lark_not_bound'
+    default_detail = _('Lark is not bound')
+
+
 class SlackNotBound(JMSException):
     default_code = 'slack_not_bound'
     default_detail = _('Slack is not bound')

apps/authentication/urls/api_urls.py

@@ -22,6 +22,9 @@ urlpatterns = [
     path('feishu/event/subscription/callback/', api.FeiShuEventSubscriptionCallback.as_view(),
          name='feishu-event-subscription-callback'),
 
+    path('lark/event/subscription/callback/', api.LarkEventSubscriptionCallback.as_view(),
+         name='lark-event-subscription-callback'),
+
     path('auth/', api.TokenCreateApi.as_view(), name='user-auth'),
     path('confirm-oauth/', api.ConfirmBindORUNBindOAuth.as_view(), name='confirm-oauth'),
     path('tokens/', api.TokenCreateApi.as_view(), name='auth-token'),

apps/authentication/urls/view_urls.py

@@ -49,6 +49,12 @@ urlpatterns = [
     path('feishu/qr/bind/callback/', views.FeiShuQRBindCallbackView.as_view(), name='feishu-qr-bind-callback'),
     path('feishu/qr/login/callback/', views.FeiShuQRLoginCallbackView.as_view(), name='feishu-qr-login-callback'),
 
+    path('lark/bind/start/', views.LarkEnableStartView.as_view(), name='lark-bind-start'),
+    path('lark/qr/bind/', views.LarkQRBindView.as_view(), name='lark-qr-bind'),
+    path('lark/qr/login/', views.LarkQRLoginView.as_view(), name='lark-qr-login'),
+    path('lark/qr/bind/callback/', views.LarkQRBindCallbackView.as_view(), name='lark-qr-bind-callback'),
+    path('lark/qr/login/callback/', views.LarkQRLoginCallbackView.as_view(), name='lark-qr-login-callback'),
+
     path('slack/bind/start/', views.SlackEnableStartView.as_view(), name='slack-bind-start'),
     path('slack/qr/bind/', views.SlackQRBindView.as_view(), name='slack-qr-bind'),
     path('slack/qr/login/', views.SlackQRLoginView.as_view(), name='slack-qr-login'),

apps/authentication/views/__init__.py

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 #
-from .login import *
-from .mfa import *
-from .wecom import *
 from .dingtalk import *
 from .feishu import *
+from .lark import *
+from .login import *
+from .mfa import *
 from .slack import *
+from .wecom import *

apps/authentication/views/feishu.py

@@ -21,24 +21,45 @@ from .mixins import FlashMessageMixin
 
 logger = get_logger(__file__)
 
-FEISHU_STATE_SESSION_KEY = '_feishu_state'
+
+class FeiShuEnableStartView(UserVerifyPasswordView):
+    category = 'feishu'
+
+    def get_success_url(self):
+        referer = self.request.META.get('HTTP_REFERER')
+        redirect_url = self.request.GET.get("redirect_url")
+
+        success_url = reverse(f'authentication:{self.category}-qr-bind')
+
+        success_url += '?' + urlencode({
+            'redirect_url': redirect_url or referer
+        })
+
+        return success_url
 
 
 class FeiShuQRMixin(UserConfirmRequiredExceptionMixin, PermissionsMixin, FlashMessageMixin, View):
+    category = 'feishu'
+    error = _('FeiShu Error')
+    error_msg = _('FeiShu is already bound')
+    state_session_key = f'_{category}_state'
+
+    @property
+    def url_object(self):
+        return URL()
+
     def dispatch(self, request, *args, **kwargs):
         try:
             return super().dispatch(request, *args, **kwargs)
         except APIException as e:
             msg = str(e.detail)
             return self.get_failed_response(
-                '/',
-                _('FeiShu Error'),
-                msg
+                '/', self.error, msg
             )
 
     def verify_state(self):
         state = self.request.GET.get('state')
-        session_state = self.request.session.get(FEISHU_STATE_SESSION_KEY)
+        session_state = self.request.session.get(self.state_session_key)
         if state != session_state:
             return False
         return True
@@ -49,19 +70,18 @@ class FeiShuQRMixin(UserConfirmRequiredExceptionMixin, PermissionsMixin, FlashMe
 
     def get_qr_url(self, redirect_uri):
         state = random_string(16)
-        self.request.session[FEISHU_STATE_SESSION_KEY] = state
+        self.request.session[self.state_session_key] = state
 
         params = {
-            'app_id': settings.FEISHU_APP_ID,
+            'app_id': getattr(settings, f'{self.category}_APP_ID'.upper()),
             'state': state,
             'redirect_uri': redirect_uri,
         }
-        url = URL().authen + '?' + urlencode(params)
+        url = self.url_object.authen + '?' + urlencode(params)
         return url
 
     def get_already_bound_response(self, redirect_url):
-        msg = _('FeiShu is already bound')
-        response = self.get_failed_response(redirect_url, msg, msg)
+        response = self.get_failed_response(redirect_url, self.error_msg, self.error_msg)
         return response
 
 
@@ -71,7 +91,7 @@ class FeiShuQRBindView(FeiShuQRMixin, View):
     def get(self, request: HttpRequest):
         redirect_url = request.GET.get('redirect_url')
 
-        redirect_uri = reverse('authentication:feishu-qr-bind-callback', external=True)
+        redirect_uri = reverse(f'authentication:{self.category}-qr-bind-callback', external=True)
         redirect_uri += '?' + urlencode({'redirect_url': redirect_url})
 
         url = self.get_qr_url(redirect_uri)
@@ -81,25 +101,16 @@ class FeiShuQRBindView(FeiShuQRMixin, View):
 class FeiShuQRBindCallbackView(FeiShuQRMixin, BaseBindCallbackView):
     permission_classes = (IsAuthenticated,)
 
-    client_type_path = 'common.sdk.im.feishu.FeiShu'
-    client_auth_params = {'app_id': 'FEISHU_APP_ID', 'app_secret': 'FEISHU_APP_SECRET'}
     auth_type = 'feishu'
     auth_type_label = _('FeiShu')
+    client_type_path = f'common.sdk.im.{auth_type}.FeiShu'
 
-
-class FeiShuEnableStartView(UserVerifyPasswordView):
-
-    def get_success_url(self):
-        referer = self.request.META.get('HTTP_REFERER')
-        redirect_url = self.request.GET.get("redirect_url")
-
-        success_url = reverse('authentication:feishu-qr-bind')
-
-        success_url += '?' + urlencode({
-            'redirect_url': redirect_url or referer
-        })
-
-        return success_url
+    @property
+    def client_auth_params(self):
+        return {
+            'app_id': f'{self.auth_type}_APP_ID'.upper(),
+            'app_secret': f'{self.auth_type}_APP_SECRET'.upper()
+        }
 
 
 class FeiShuQRLoginView(FeiShuQRMixin, View):
@@ -107,7 +118,7 @@ class FeiShuQRLoginView(FeiShuQRMixin, View):
 
     def get(self, request: HttpRequest):
         redirect_url = request.GET.get('redirect_url') or reverse('index')
-        redirect_uri = reverse('authentication:feishu-qr-login-callback', external=True)
+        redirect_uri = reverse(f'authentication:{self.category}-qr-login-callback', external=True)
         redirect_uri += '?' + urlencode({
             'redirect_url': redirect_url,
         })
@@ -119,11 +130,19 @@ class FeiShuQRLoginView(FeiShuQRMixin, View):
 class FeiShuQRLoginCallbackView(FeiShuQRMixin, BaseLoginCallbackView):
     permission_classes = (AllowAny,)
 
-    client_type_path = 'common.sdk.im.feishu.FeiShu'
-    client_auth_params = {'app_id': 'FEISHU_APP_ID', 'app_secret': 'FEISHU_APP_SECRET'}
     user_type = 'feishu'
-    auth_backend = 'AUTH_BACKEND_FEISHU'
+    auth_type = user_type
+    client_type_path = f'common.sdk.im.{auth_type}.FeiShu'
 
     msg_client_err = _('FeiShu Error')
     msg_user_not_bound_err = _('FeiShu is not bound')
     msg_not_found_user_from_client_err = _('Failed to get user from FeiShu')
+
+    auth_backend = f'AUTH_BACKEND_{auth_type}'.upper()
+
+    @property
+    def client_auth_params(self):
+        return {
+            'app_id': f'{self.auth_type}_APP_ID'.upper(),
+            'app_secret': f'{self.auth_type}_APP_SECRET'.upper()
+        }

apps/authentication/views/lark.py

@@ -0,0 +1,49 @@
+from django.utils.translation import gettext_lazy as _
+
+from common.sdk.im.lark import URL
+from common.utils import get_logger
+from .feishu import (
+    FeiShuEnableStartView, FeiShuQRBindView, FeiShuQRBindCallbackView,
+    FeiShuQRLoginView, FeiShuQRLoginCallbackView
+)
+
+logger = get_logger(__file__)
+
+
+class LarkEnableStartView(FeiShuEnableStartView):
+    category = 'lark'
+
+
+class BaseLarkQRMixin:
+    category = 'lark'
+    error = _('Lark Error')
+    error_msg = _('Lark is already bound')
+    state_session_key = f'_{category}_state'
+
+    @property
+    def url_object(self):
+        return URL()
+
+
+class LarkQRBindView(BaseLarkQRMixin, FeiShuQRBindView):
+    pass
+
+
+class LarkQRBindCallbackView(BaseLarkQRMixin, FeiShuQRBindCallbackView):
+    auth_type = 'lark'
+    auth_type_label = auth_type.capitalize()
+    client_type_path = f'common.sdk.im.{auth_type}.Lark'
+
+
+class LarkQRLoginView(BaseLarkQRMixin, FeiShuQRLoginView):
+    pass
+
+
+class LarkQRLoginCallbackView(BaseLarkQRMixin, FeiShuQRLoginCallbackView):
+    user_type = 'lark'
+    auth_type = user_type
+    client_type_path = f'common.sdk.im.{auth_type}.Lark'
+
+    msg_client_err = _('Lark Error')
+    msg_user_not_bound_err = _('Lark is not bound')
+    msg_not_found_user_from_client_err = _('Failed to get user from Lark')

apps/authentication/views/login.py

@@ -91,6 +91,12 @@ class UserLoginContextMixin:
                 'url': reverse('authentication:feishu-qr-login'),
                 'logo': static('img/login_feishu_logo.png')
             },
+            {
+                'name': 'Lark',
+                'enabled': settings.AUTH_LARK,
+                'url': reverse('authentication:lark-qr-login'),
+                'logo': static('img/login_feishu_logo.png')
+            },
             {
                 'name': _('Slack'),
                 'enabled': settings.AUTH_SLACK,