feat: 添加ITSM上下文配置功能 (#1453)

.pre-commit-config.yaml

@@ -19,10 +19,3 @@ repos:
       - id: commitlint
         stages: [commit-msg]
         additional_dependencies: ['@commitlint/config-conventional']
-  - repo: local
-    hooks:
-      - id: check-migrate
-        name: check migrate
-        entry: python scripts/check_migrate/check_migrate.py
-        language: system
-        types: [python]

common/utils.py

@@ -22,7 +22,6 @@
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
-from django.conf import settings
 
 # 开发框架公用方法
 # 1. 页面输入内容转义（防止xss攻击）
@@ -56,7 +55,7 @@ def html_escape(html, is_json=False):
     html = html.replace(">", ">")
     # 单双引号转换
     if not is_json:
-        html = html.replace(' ', " ")
+        html = html.replace(" ", " ")
         html = html.replace('"', """)
         html = html.replace("'", "'")
     return html
@@ -65,7 +64,7 @@ def html_escape(html, is_json=False):
 def url_escape(url):
     url = url.replace("<", "")
     url = url.replace(">", "")
-    url = url.replace(' ', "")
+    url = url.replace(" ", "")
     url = url.replace('"', "")
     url = url.replace("'", "")
     return url
@@ -93,19 +92,3 @@ def texteditor_escape(str_escape, is_support_img=True):
 def cmp(a, b):
     """适配py2的cmp方法"""
     return (a > b) - (a < b)
-
-
-def notice_receiver_filter(receivers):
-    """
-    通知名单过滤
-    """
-    if not receivers:
-        return receivers
-
-    receiver_type = "list"
-    if isinstance(receivers, str):
-        receiver_type = "str"
-        receivers = receivers.strip().split(",")
-
-    receivers = [i for i in receivers if i not in settings.NOTICE_IGNORE_LIST]
-    return receivers if receiver_type == "list" else ",".join(receivers)

config/default.py

@@ -25,7 +25,6 @@
 import base64
 import datetime
 import importlib
-import os
 from urllib.parse import urljoin, urlparse
 
 from blueapps.conf.default_settings import *  # noqa
@@ -110,7 +109,8 @@
     "blueapps.opentelemetry.instrument_app",
     "itsm.plugin_service",
     "bk_notice_sdk",
-    "pipeline.contrib.engine_admin"
+    "pipeline.contrib.engine_admin",
+    "itsm.meta",
 )
 
 INSTALLED_APPS = ("itsm.helper",) + INSTALLED_APPS
@@ -350,7 +350,7 @@ def _(s):
         "rest_framework.parsers.FormParser",
         "rest_framework.parsers.MultiPartParser",
     ),
-    "DEFAULT_RENDERER_CLASSES": ("rest_framework.renderers.JSONRenderer",)
+    "DEFAULT_RENDERER_CLASSES": ("rest_framework.renderers.JSONRenderer",),
 }
 
 # ==============================================================================
@@ -959,16 +959,15 @@ def redirect_func(request):
 
 
 # 公共配置
-BK_SHARED_RES_URL = os.getenv("BKPAAS_SHARED_RES_URL") or os.getenv("BKAPP_SHARED_RES_URL")
+BK_SHARED_RES_URL = os.getenv("BKPAAS_SHARED_RES_URL") or os.getenv(
+    "BKAPP_SHARED_RES_URL"
+)
 BK_PLATFORM_NAME = os.getenv("BKAPP_PLATFORM_NAME", "")
 
-# 通知过滤
-NOTICE_IGNORE_LIST = os.getenv("BKAPP_NOTICE_IGNORE_LIST", [])
-if isinstance(NOTICE_IGNORE_LIST, str):
-    NOTICE_IGNORE_LIST = [i.lower().strip() for i in NOTICE_IGNORE_LIST.split(",")]
-
 # SMS 邀请评价限额
 TICKET_INVITE_SMS_COUNT = int(os.getenv("BKAPP_TICKET_INVITE_SMS_COUNT", 10))
 
 # eri admin
-PIPELINE_ENGINE_ADMIN_API_PERMISSION = "itsm.helper.permissions.check_permission_success"
+PIPELINE_ENGINE_ADMIN_API_PERMISSION = (
+    "itsm.helper.permissions.check_permission_success"
+)

itsm/component/bkchat/utils.py

@@ -6,11 +6,11 @@
 from django.http import JsonResponse
 
 from common.log import logger
-from common.utils import notice_receiver_filter
 from config.default import CLOSE_NOTIFY
 from itsm.component.constants import APPROVE_RESULT, API, RUNNING, SHOW_BY_CONDITION
 from itsm.component.exceptions import ComponentCallError
 from itsm.component.utils.conversion import show_conditions_validate, format_exp_value
+from itsm.meta.services.notice_filter import notice_filter_service
 from itsm.ticket.models import Ticket, Status, TicketField, SignTask
 
 # 当前运行环境
@@ -113,12 +113,22 @@ def send_fast_approval_message(title, content, receivers, ticket, state_id):
 
     # 更新详情url
     ticket.generate_ticket_url(state_id, receivers)
-
+
+    # 如果ticket的service_id在service_approval_blacklist中，则不发送bkchat快速审批通知
+    service_approval_blacklist = notice_filter_service.get_service_approval_blacklist()
+    if str(ticket.service_id) in service_approval_blacklist:
+        logger.info(
+            f"[fast_approval]Bypass due to service id is in service_approval_blacklist, ticket_id=>{ticket_id}"
+        )
+        return
+
     # 接收人过滤
-    receivers = notice_receiver_filter(receivers)
+    receivers = notice_filter_service.notice_receiver_filter(receivers)
     if not receivers:
-        logger.info(f"[fast approval] receivers is empty after filter, ticket_id=>{ticket_id}")
-        return 
+        logger.info(
+            f"[fast approval] receivers is empty after filter, ticket_id=>{ticket_id}"
+        )
+        return
 
     # 构造data信息
     data = {

itsm/component/notify.py

@@ -29,18 +29,18 @@
 from django.utils.translation import ugettext as _
 
 from common.log import logger
-from common.utils import notice_receiver_filter
 from itsm.component.constants import GENERAL_NOTICE
 from itsm.component.esb.esbclient import client_backend
 from itsm.component.exceptions import ComponentCallError
 from itsm.component.utils.basic import merge_dict_list
+from itsm.meta.services.notice_filter import notice_filter_service
 from weixin.core.settings import WEIXIN_APP_EXTERNAL_HOST
 
 
 class BaseNotifier(object):
     def __init__(self, title, receivers, message, notify_type=GENERAL_NOTICE):
         self.title = title
-        self.receivers = notice_receiver_filter(receivers)
+        self.receivers = notice_filter_service.notice_receiver_filter(receivers)
         self.message = message
         self.notify_type = notify_type
 

itsm/meta/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""

itsm/meta/admin.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+from django.contrib import admin
+from .models import Context
+
+
+class ContextAdmin(admin.ModelAdmin):
+    list_display = ("id", "key", "value", "created_at", "updated_at")
+    search_fields = ("key", "value")
+    list_filter = ("key",)
+
+
+admin.site.register(Context, ContextAdmin)

itsm/meta/apps.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+from django.apps import AppConfig
+
+
+class MetaConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "itsm.meta"

itsm/meta/migrations/0001_initial.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+# Generated by Django 3.2.25 on 2024-12-06 14:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Context",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("key", models.CharField(max_length=255, unique=True)),
+                ("value", models.TextField(blank=True)),
+            ],
+            options={
+                "db_table": "meta_context",
+            },
+        ),
+    ]

itsm/meta/migrations/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""

itsm/meta/models.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+"""
+Tencent is pleased to support the open source community by making BK-ITSM 蓝鲸流程服务 available.
+
+Copyright (C)2024 THL A29 Limited, a Tencent company.  All rights reserved.
+
+BK-ITSM 蓝鲸流程服务 is licensed under the MIT License.
+
+License for BK-ITSM 蓝鲸流程服务:
+--------------------------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+from django.core.cache import cache
+from django.db import models
+from django.db.models.signals import post_save
+from django.dispatch import receiver
+
+from itsm.component.constants import CACHE_5MIN
+
+
+class Context(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    key = models.CharField(max_length=255, unique=True)
+    value = models.TextField(blank=True)
+
+    def __str__(self):
+        return self.key
+
+    class Meta:
+        db_table = "meta_context"
+
+
+@receiver(post_save, sender=Context)
+def update_cache(sender, instance, **kwargs):
+    cache_key = f"meta_context_{instance.key}"
+    cache.set(cache_key, instance.value, CACHE_5MIN)