perf: 优化消息通知 (#7024)

* perf: 优化系统用户列表

* stash

* perf: 优化消息通知

* perf: 修改钉钉

* perf: 修改优化消息通知

* perf: 修改requirements

* perf: 优化datetime

Co-authored-by: ibuler <ibuler@qq.com>

apps/perms/apps.py

@@ -9,3 +9,4 @@ class PermsConfig(AppConfig):
     def ready(self):
         super().ready()
         from . import signals_handler
+        from . import notifications

apps/perms/notifications.py

@@ -1,310 +1,155 @@
-from datetime import datetime
-from urllib.parse import urljoin
 
 from django.utils.translation import ugettext as _
-from django.conf import settings
+from django.template.loader import render_to_string
 
-from common.utils import reverse, get_request_ip_or_data, get_request_user_agent, lazyproperty
-from notifications.notifications import UserMessage, SystemMessage
+from common.utils import reverse as js_reverse
+from notifications.notifications import UserMessage
 
 
-class AssetPermWillExpireMsg(UserMessage):
+class BasePermMsg(UserMessage):
+    @classmethod
+    def gen_test_msg(cls):
+        return
+
+
+class PermedWillExpireUserMsg(BasePermMsg):
     def __init__(self, user, assets):
         super().__init__(user)
         self.assets = assets
 
     def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Assets may expire')
-
-        assets_text = ','.join(str(asset) for asset in self.assets)
-        message = _("""
-            Hello %(name)s:
-            <br>
-            Your permissions for the following assets may expire in three days:
-            <br>
-            %(assets)s
-            <br>
-            Please contact the administrator
-        """) % {
-            'name': user.name,
-            'assets': assets_text
+        subject = _("You permed assets is about to expire")
+        context = {
+            'name': self.user.name,
+            'items': [str(asset) for asset in self.assets],
+            'item_type': _("permed assets"),
+            'show_help': True
         }
+        message = render_to_string('perms/_msg_permed_items_expire.html', context)
         return {
             'subject': subject,
             'message': message
         }
 
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Assets may expire')
-        assets_text = ','.join(str(asset) for asset in self.assets)
-
-        message = _("""
-Hello %(name)s:
-\n
-Your permissions for the following assets may expire in three days:
-\n
-%(assets)s
-\n
-Please contact the administrator
-        """) % {
-            'name': user.name,
-            'assets': assets_text
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
+    @classmethod
+    def gen_test_msg(cls):
+        from users.models import User
+        from assets.models import Asset
+        user = User.objects.first()
+        assets = Asset.objects.all()[:10]
+        return cls(user, assets)
 
 
-class AssetPermWillExpireForOrgAdminMsg(UserMessage):
+class AssetPermsWillExpireForOrgAdminMsg(BasePermMsg):
+
     def __init__(self, user, perms, org):
         super().__init__(user)
         self.perms = perms
         self.org = org
 
-    def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Asset permission will expired')
-        perms_text = ','.join(str(perm) for perm in self.perms)
+    def get_items_with_url(self):
+        items_with_url = []
+        for perm in self.perms:
+            url = js_reverse(
+                'perms:asset-permission-detail',
+                kwargs={'pk': perm.id}, external=True,
+                api_to_ui=True
+            ) + f'?oid={perm.org_id}'
+            items_with_url.append([perm.name, url])
+        return items_with_url
 
-        message = _("""
-            Hello %(name)s:
-            <br>
-            The following asset permissions of organization %(org) will expire in three days
-            <br>
-            %(perms)s
-        """) % {
-            'name': user.name,
-            'org': self.org,
-            'perms': perms_text
+    def get_html_msg(self):
+        items_with_url = self.get_items_with_url()
+        subject = _("Asset permissions is about to expire")
+        context = {
+            'name': self.user.name,
+            'items_with_url': items_with_url,
+            'item_type': _('asset permissions of organization {}').format(self.org)
         }
+        message = render_to_string('perms/_msg_item_permissions_expire.html', context)
         return {
             'subject': subject,
             'message': message
         }
 
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Asset permission will expired')
-        perms_text = ','.join(str(perm) for perm in self.perms)
+    @classmethod
+    def gen_test_msg(cls):
+        from users.models import User
+        from perms.models import AssetPermission
+        from orgs.models import Organization
 
-        message = _("""
-Hello %(name)s:
-\n
-The following asset permissions of organization %(org) will expire in three days
-\n
-%(perms)s
-        """) % {
-            'name': user.name,
-            'org': self.org,
-            'perms': perms_text
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
+        user = User.objects.first()
+        perms = AssetPermission.objects.all()[:10]
+        org = Organization.objects.first()
+        return cls(user, perms, org)
 
 
-class AssetPermWillExpireForAdminMsg(UserMessage):
-    def __init__(self, user, org_perm_mapper: dict):
-        super().__init__(user)
-        self.org_perm_mapper = org_perm_mapper
-
-    def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Asset permission will expired')
-
-        content = ''
-        for org, perms in self.org_perm_mapper.items():
-            content += f'<br> Orgnization: {org} <br> Permissions: {",".join(str(perm) for perm in perms)} <br>'
-
-        message = _("""
-            Hello %(name)s:
-            <br>
-            The following asset permissions will expire in three days
-            <br>
-            %(content)s
-        """) % {
-            'name': user.name,
-            'content': content,
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
-
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Asset permission will expired')
-
-        content = ''
-        for org, perms in self.org_perm_mapper.items():
-            content += f'\n Orgnization: {org} \n Permissions: {perms} \n'
-
-        message = _("""
-Hello %(name)s:
-\n
-The following asset permissions of organization %(org) will expire in three days
-\n
-%(content)s
-        """) % {
-            'name': user.name,
-            'content': content,
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
-
-
-class AppPermWillExpireMsg(UserMessage):
+class PermedAppsWillExpireUserMsg(BasePermMsg):
     def __init__(self, user, apps):
         super().__init__(user)
         self.apps = apps
 
     def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Applications may expire')
-
-        apps_text = ','.join(str(app) for app in self.apps)
-        message = _("""
-            Hello %(name)s:
-            <br>
-            Your permissions for the following applications may expire in three days:
-            <br>
-            %(apps)s
-            <br>
-            Please contact the administrator
-        """) % {
-            'name': user.name,
-            'apps': apps_text
+        subject = _("Your permed applications is about to expire")
+        context = {
+            'name': self.user.name,
+            'item_type': _('permed applications'),
+            'items': [str(app) for app in self.apps]
         }
+        message = render_to_string('perms/_msg_permed_items_expire.html', context)
         return {
             'subject': subject,
             'message': message
         }
 
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Applications may expire')
-        apps_text = ','.join(str(app) for app in self.apps)
+    @classmethod
+    def gen_test_msg(cls):
+        from users.models import User
+        from applications.models import Application
 
-        message = _("""
-Hello %(name)s:
-\n
-Your permissions for the following applications may expire in three days:
-\n
-%(apps)s
-\n
-Please contact the administrator
-        """) % {
-            'name': user.name,
-            'apps': apps_text
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
+        user = User.objects.first()
+        apps = Application.objects.all()[:10]
+        return cls(user, apps)
 
 
-class AppPermWillExpireForOrgAdminMsg(UserMessage):
+class AppPermsWillExpireForOrgAdminMsg(BasePermMsg):
     def __init__(self, user, perms, org):
         super().__init__(user)
         self.perms = perms
         self.org = org
 
-    def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Application permission will expired')
-        perms_text = ','.join(str(perm) for perm in self.perms)
-
-        message = _("""
-            Hello %(name)s:
-            <br>
-            The following application permissions of organization %(org) will expire in three days
-            <br>
-            %(perms)s
-        """) % {
-            'name': user.name,
-            'org': self.org,
-            'perms': perms_text
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
-
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Application permission will expired')
-        perms_text = ','.join(str(perm) for perm in self.perms)
-
-        message = _("""
-Hello %(name)s:
-\n
-The following application permissions of organization %(org) will expire in three days
-\n
-%(perms)s
-        """) % {
-            'name': user.name,
-            'org': self.org,
-            'perms': perms_text
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
-
-
-class AppPermWillExpireForAdminMsg(UserMessage):
-    def __init__(self, user, org_perm_mapper: dict):
-        super().__init__(user)
-        self.org_perm_mapper = org_perm_mapper
+    def get_items_with_url(self):
+        items_with_url = []
+        for perm in self.perms:
+            url = js_reverse(
+                'perms:application-permission-detail',
+                kwargs={'pk': perm.id}, external=True,
+                api_to_ui=True
+            ) + f'?oid={perm.org_id}'
+            items_with_url.append([perm.name, url])
+        return items_with_url
 
     def get_html_msg(self) -> dict:
-        user = self.user
-        subject = _('Application permission will expired')
-
-        content = ''
-        for org, perms in self.org_perm_mapper.items():
-            content += f'<br>Orgnization: {org} <br> Permissions: {",".join(str(perm) for perm in perms)} <br>'
-
-        message = _("""
-            Hello %(name)s:
-            <br>
-            The following application permissions will expire in three days
-            <br>
-            %(content)s
-        """) % {
-            'name': user.name,
-            'content': content,
+        items = self.get_items_with_url()
+        subject = _('Application permissions is about to expire')
+        context = {
+            'name': self.user.name,
+            'item_type': _('application permissions of organization {}').format(self.org),
+            'items_with_url': items
         }
+        message = render_to_string('perms/_msg_item_permissions_expire.html', context)
         return {
             'subject': subject,
             'message': message
         }
 
-    def get_text_msg(self) -> dict:
-        user = self.user
-        subject = _('Application permission will expired')
+    @classmethod
+    def gen_test_msg(cls):
+        from users.models import User
+        from perms.models import ApplicationPermission
+        from orgs.models import Organization
 
-        content = ''
-        for org, perms in self.org_perm_mapper.items():
-            content += f'\n Orgnization: {org} \n Permissions: {perms} \n'
-
-        message = _("""
-Hello %(name)s:
-\n
-The following application permissions of organization %(org) will expire in three days
-\n
-%(content)s
-        """) % {
-            'name': user.name,
-            'content': content,
-        }
-        return {
-            'subject': subject,
-            'message': message
-        }
+        user = User.objects.first()
+        perms = ApplicationPermission.objects.all()[:10]
+        org = Organization.objects.first()
+        return cls(user, perms, org)

apps/perms/tasks.py

@@ -7,14 +7,13 @@ from django.db.transaction import atomic
 from django.conf import settings
 from celery import shared_task
 
-from users.models import User
 from orgs.utils import tmp_to_root_org
 from common.utils import get_logger
-from common.utils.timezone import now, dt_formater, dt_parser
+from common.utils.timezone import local_now, dt_formatter, dt_parser
 from ops.celery.decorator import register_as_period_task
 from perms.notifications import (
-    AssetPermWillExpireMsg, AssetPermWillExpireForOrgAdminMsg, AssetPermWillExpireForAdminMsg,
-    AppPermWillExpireMsg, AppPermWillExpireForOrgAdminMsg, AppPermWillExpireForAdminMsg,
+    PermedWillExpireUserMsg, AssetPermsWillExpireForOrgAdminMsg,
+    PermedAppsWillExpireUserMsg, AppPermsWillExpireForOrgAdminMsg
 )
 from perms.models import AssetPermission, ApplicationPermission
 from perms.utils.asset.user_permission import UserGrantedTreeRefreshController
@@ -34,10 +33,10 @@ def check_asset_permission_expired():
 
     setting_name = 'last_asset_perm_expired_check'
 
-    end = now()
+    end = local_now()
     default_start = end - timedelta(days=36000)  # Long long ago in china
 
-    defaults = {'value': dt_formater(default_start)}
+    defaults = {'value': dt_formatter(default_start)}
     setting, created = Setting.objects.get_or_create(
         name=setting_name, defaults=defaults
     )
@@ -45,7 +44,7 @@ def check_asset_permission_expired():
         start = default_start
     else:
         start = dt_parser(setting.value)
-    setting.value = dt_formater(end)
+    setting.value = dt_formatter(end)
     setting.save()
 
     asset_perm_ids = AssetPermission.objects.filter(
@@ -61,14 +60,15 @@ def check_asset_permission_expired():
 @atomic()
 @tmp_to_root_org()
 def check_asset_permission_will_expired():
-    start = now()
+    start = local_now()
     end = start + timedelta(days=3)
 
     user_asset_mapper = defaultdict(set)
     org_perm_mapper = defaultdict(set)
 
     asset_perms = AssetPermission.objects.filter(
-        date_expired__gte=start, date_expired__lte=end
+        date_expired__gte=start,
+        date_expired__lte=end
     ).distinct()
 
     for asset_perm in asset_perms:
@@ -83,18 +83,12 @@ def check_asset_permission_will_expired():
             user_asset_mapper[u].update(assets)
 
     for user, assets in user_asset_mapper.items():
-        AssetPermWillExpireMsg(user, assets).publish_async()
-
-    admins = User.objects.filter(role=User.ROLE.ADMIN)
-
-    if org_perm_mapper:
-        for admin in admins:
-            AssetPermWillExpireForAdminMsg(admin, org_perm_mapper).publish_async()
+        PermedWillExpireUserMsg(user, assets).publish_async()
 
     for org, perms in org_perm_mapper.items():
-        org_admins = org.admins.exclude(role=User.ROLE.ADMIN)
+        org_admins = org.admins.all()
         for org_admin in org_admins:
-            AssetPermWillExpireForOrgAdminMsg(org_admin, perms, org).publish_async()
+            AssetPermsWillExpireForOrgAdminMsg(org_admin, perms, org).publish_async()
 
 
 @register_as_period_task(crontab='0 10 * * *')
@@ -102,11 +96,12 @@ def check_asset_permission_will_expired():
 @atomic()
 @tmp_to_root_org()
 def check_app_permission_will_expired():
-    start = now()
+    start = local_now()
     end = start + timedelta(days=3)
 
     app_perms = ApplicationPermission.objects.filter(
-        date_expired__gte=start, date_expired__lte=end
+        date_expired__gte=start,
+        date_expired__lte=end
     ).distinct()
 
     user_app_mapper = defaultdict(set)
@@ -121,15 +116,9 @@ def check_app_permission_will_expired():
             user_app_mapper[u].update(apps)
 
     for user, apps in user_app_mapper.items():
-        AppPermWillExpireMsg(user, apps).publish_async()
-
-    admins = User.objects.filter(role=User.ROLE.ADMIN)
-
-    if org_perm_mapper:
-        for admin in admins:
-            AppPermWillExpireForAdminMsg(admin, org_perm_mapper).publish_async()
+        PermedAppsWillExpireUserMsg(user, apps).publish_async()
 
     for org, perms in org_perm_mapper.items():
-        org_admins = org.admins.exclude(role=User.ROLE.ADMIN)
+        org_admins = org.admins.all()
         for org_admin in org_admins:
-            AppPermWillExpireForOrgAdminMsg(org_admin, perms, org).publish_async()
+            AppPermsWillExpireForOrgAdminMsg(org_admin, perms, org).publish_async()

apps/perms/templates/perms/_msg_item_permissions_expire.html

@@ -0,0 +1,16 @@
+{% load i18n %}
+<p>
+    {% trans 'Hello' %} {{ name }},
+</p>
+
+<p>
+    {% blocktranslate %}
+        The following {{ item_type }} will expire in 3 days
+    {% endblocktranslate %}
+</p>
+
+<ul>
+    {% for item, url in items_with_url %}
+        <li><a href="{{ url }}">{{ item }}</a></li>
+    {% endfor %}
+</ul>

apps/perms/templates/perms/_msg_permed_items_expire.html

@@ -0,0 +1,24 @@
+{% load i18n %}
+<p>
+    {% trans 'Hello' %} {{ name }},
+</p>
+
+<p>
+    {% blocktranslate %}
+        The following {{ item_type }} will expire in 3 days
+    {% endblocktranslate %}
+</p>
+
+<ul>
+    {% for item in items %}
+        <li>{{ item }}</li>
+    {% endfor %}
+</ul>
+
+<br />
+<p>
+    ---<br />
+    <small>
+        {% trans 'If you have any question, please contact the administrator' %}
+    </small>
+</p>