feat: support system variable

Author: XiaJunjie2020

backend/alembic/versions/062_system_variable.py

@@ -0,0 +1,82 @@
+"""062_system_variable
+
+Revision ID: ed947895d470
+Revises: 547df942eb90
+Create Date: 2026-01-26 10:16:59.877303
+
+"""
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+from alembic import op
+from sqlalchemy import String, BigInteger, DateTime
+from sqlalchemy.dialects import postgresql
+from sqlalchemy.dialects.postgresql import JSONB
+from sqlalchemy.sql import table, column
+
+# revision identifiers, used by Alembic.
+revision = 'ed947895d470'
+down_revision = '547df942eb90'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('system_variable',
+                    sa.Column('id', sa.BigInteger(), sa.Identity(always=True), nullable=False),
+                    sa.Column('name', sqlmodel.sql.sqltypes.AutoString(length=128), nullable=False),
+                    sa.Column('var_type', sqlmodel.sql.sqltypes.AutoString(length=128), nullable=False),
+                    sa.Column('type', sqlmodel.sql.sqltypes.AutoString(length=128), nullable=False),
+                    sa.Column('value', postgresql.JSONB(astext_type=sa.Text()), nullable=True),
+                    sa.Column('create_time', sa.DateTime(), nullable=True),
+                    sa.Column('create_by', sa.BigInteger(), nullable=True),
+                    sa.PrimaryKeyConstraint('id')
+                    )
+
+    variable_table = table(
+        "system_variable",
+        column("id", BigInteger),
+        column("name", String),
+        column("var_type", String),
+        column("type", String),
+        column("value", JSONB),
+        column("create_time", DateTime),
+        column("create_by", BigInteger),
+    )
+
+    op.bulk_insert(
+        variable_table,
+        [
+            {
+                "name": "i18n_variable.name",
+                "var_type": "text",
+                "type": "system",
+                "value": ["name"],
+                "create_time": None,
+                "create_by": None
+            },
+            {
+                "name": "i18n_variable.account",
+                "var_type": "text",
+                "type": "system",
+                "value": ["account"],
+                "create_time": None,
+                "create_by": None
+            },
+            {
+                "name": "i18n_variable.email",
+                "var_type": "text",
+                "type": "system",
+                "value": ["email"],
+                "create_time": None,
+                "create_by": None
+            }
+        ]
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('system_variable')
+    # ### end Alembic commands ###

backend/alembic/versions/063_user_bind_var.py

@@ -0,0 +1,29 @@
+"""063_user
+
+Revision ID: 8ff90df7871d
+Revises: ed947895d470
+Create Date: 2026-01-26 15:30:11.348083
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = '8ff90df7871d'
+down_revision = 'ed947895d470'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('sys_user', sa.Column('system_variables', postgresql.JSONB(astext_type=sa.Text()), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('sys_user', 'system_variables')
+    # ### end Alembic commands ###

backend/apps/api.py

@@ -5,7 +5,7 @@
 from apps.data_training.api import data_training
 from apps.datasource.api import datasource, table_relation, recommended_problem
 from apps.mcp import mcp
-from apps.system.api import login, user, aimodel, workspace, assistant, parameter, apikey
+from apps.system.api import login, user, aimodel, workspace, assistant, parameter, apikey, variable_api
 from apps.terminology.api import terminology
 from apps.settings.api import base
 #from audit.api import audit_api
@@ -30,4 +30,6 @@
 
 api_router.include_router(recommended_problem.router)
 
+api_router.include_router(variable_api.router)
+
 #api_router.include_router(audit_api.router)

backend/apps/datasource/crud/permission.py

@@ -40,7 +40,7 @@ def get_row_permission_filters(session: SessionDep, current_user: CurrentUser, d
                             break
                     if flag:
                         res.append(transRecord2DTO(session, permission))
-            where_str = transFilterTree(session, res, ds)
+            where_str = transFilterTree(session, current_user, res, ds)
             filters.append({"table": table.table_name, "filter": where_str})
     return filters
 

backend/apps/datasource/crud/row_permission.py

@@ -4,24 +4,26 @@
 from typing import List, Dict
 from apps.datasource.models.datasource import CoreField, CoreDatasource
 from apps.db.constant import DB
-from common.core.deps import SessionDep
+from apps.system.models.system_variable_model import SystemVariable
+from common.core.deps import SessionDep, CurrentUser
 
 
-def transFilterTree(session: SessionDep, tree_list: List[any], ds: CoreDatasource) -> str | None:
+def transFilterTree(session: SessionDep, current_user: CurrentUser, tree_list: List[any],
+                    ds: CoreDatasource) -> str | None:
     if tree_list is None:
         return None
     res: List[str] = []
     for dto in tree_list:
         tree = dto.tree
         if tree is None:
             continue
-        tree_exp = transTreeToWhere(session, tree, ds)
+        tree_exp = transTreeToWhere(session, current_user, tree, ds)
         if tree_exp is not None:
             res.append(tree_exp)
     return " AND ".join(res)
 
 
-def transTreeToWhere(session: SessionDep, tree: any, ds: CoreDatasource) -> str | None:
+def transTreeToWhere(session: SessionDep, current_user: CurrentUser, tree: any, ds: CoreDatasource) -> str | None:
     if tree is None:
         return None
     logic = tree['logic']
@@ -32,23 +34,25 @@ def transTreeToWhere(session: SessionDep, tree: any, ds: CoreDatasource) -> str
         for item in items:
             exp: str = None
             if item['type'] == 'item':
-                exp = transTreeItem(session, item, ds)
+                exp = transTreeItem(session, current_user, item, ds)
             elif item['type'] == 'tree':
-                exp = transTreeToWhere(session, item['sub_tree'], ds)
+                exp = transTreeToWhere(session, current_user, item['sub_tree'], ds)
 
             if exp is not None:
                 list.append(exp)
     return '(' + f' {logic} '.join(list) + ')' if len(list) > 0 else None
 
 
-def transTreeItem(session: SessionDep, item: Dict, ds: CoreDatasource) -> str | None:
+def transTreeItem(session: SessionDep, current_user: CurrentUser, item: Dict, ds: CoreDatasource) -> str | None:
     res: str = None
     field = session.query(CoreField).filter(CoreField.id == int(item['field_id'])).first()
     if field is None:
         return None
 
     db = DB.get_db(ds.type)
     whereName = db.prefix + field.field_name + db.suffix
+    whereTerm = transFilterTerm(item['term'])
+
     if item['filter_type'] == 'enum':
         if len(item['enum_value']) > 0:
             if ds['type'] == 'sqlServer' and (
@@ -57,38 +61,113 @@ def transTreeItem(session: SessionDep, item: Dict, ds: CoreDatasource) -> str |
             else:
                 res = "(" + whereName + " IN ('" + "','".join(item['enum_value']) + "'))"
     else:
-        value = item['value']
-        whereTerm = transFilterTerm(item['term'])
-        whereValue = ''
+        # if system variable, do check and get value
+        # new field: value_type(variable or normal), variable_id
+        value_type = item.get('value_type')
+        if value_type and value_type == 'variable':
+            # get system variable
+            variable_id = item.get('variable_id')
+            if variable_id is not None:
+                sys_variable = session.query(SystemVariable).filter(SystemVariable.id == variable_id).first()
+                # do inner system variable
+                if sys_variable.type == 'system':
+                    res = whereName + whereTerm + getSysVariableValue(sys_variable, current_user)
+                else:
+                    # check user variable
+                    user_variables = current_user.system_variables
+                    if user_variables is None or len(user_variables) == 0 or not userHaveVariable(user_variables,
+                                                                                                  sys_variable):
+                        return None
+                    else:
+                        # get user variable
+                        u_variable = None
+                        for u in user_variables:
+                            if u.get('variableId') == sys_variable.id:
+                                u_variable = u
+                                break
+                        if u_variable is None:
+                            return None
 
-        if item['term'] == 'null':
-            whereValue = ''
-        elif item['term'] == 'not_null':
-            whereValue = ''
-        elif item['term'] == 'empty':
-            whereValue = "''"
-        elif item['term'] == 'not_empty':
-            whereValue = "''"
-        elif item['term'] == 'in' or item['term'] == 'not in':
-            if ds.type == 'sqlServer' and (
-                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
-                whereValue = "(N'" + "', N'".join(value.split(",")) + "')"
-            else:
-                whereValue = "('" + "', '".join(value.split(",")) + "')"
-        elif item['term'] == 'like' or item['term'] == 'not like':
-            if ds.type == 'sqlServer' and (
-                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
-                whereValue = f"N'%{value}%'"
+                        # check value
+                        values = u_variable.get('variableValues')
+                        if sys_variable.var_type == 'text':
+                            set_sys = set(sys_variable.value)
+                            values = [x for x in values if x in set_sys]
+                            if values is None or len(values) == 0:
+                                return None
+                        elif sys_variable.var_type == 'number':
+                            if (sys_variable.value[0] is not None and values[0] < sys_variable.value[0]) or (
+                                    sys_variable.value[1] is not None and values[0] > sys_variable.value[1]):
+                                return None
+                        elif sys_variable.var_type == 'datetime':
+                            if (sys_variable.value[0] is not None and values[0] < sys_variable.value[0]) or (
+                                    sys_variable.value[1] is not None and values[0] > sys_variable.value[1]):
+                                return None
+
+                        # build exp
+                        whereValue = ''
+                        if item['term'] == 'null':
+                            whereValue = ''
+                        elif item['term'] == 'not_null':
+                            whereValue = ''
+                        elif item['term'] == 'empty':
+                            whereValue = "''"
+                        elif item['term'] == 'not_empty':
+                            whereValue = "''"
+                        elif item['term'] == 'in' or item['term'] == 'not in':
+                            if ds.type == 'sqlServer' and (
+                                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                                whereValue = "(N'" + "', N'".join(values) + "')"
+                            else:
+                                whereValue = "('" + "', '".join(values) + "')"
+                        elif item['term'] == 'like' or item['term'] == 'not like':
+                            if ds.type == 'sqlServer' and (
+                                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                                whereValue = f"N'%{values[0]}%'"
+                            else:
+                                whereValue = f"'%{values[0]}%'"
+                        else:
+                            if ds.type == 'sqlServer' and (
+                                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                                whereValue = f"N'{values[0]}'"
+                            else:
+                                whereValue = f"'{values[0]}'"
+
+                        res = whereName + whereTerm + whereValue
             else:
-                whereValue = f"'%{value}%'"
+                return None
         else:
-            if ds.type == 'sqlServer' and (
-                    field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
-                whereValue = f"N'{value}'"
+            value = item['value']
+            whereValue = ''
+
+            if item['term'] == 'null':
+                whereValue = ''
+            elif item['term'] == 'not_null':
+                whereValue = ''
+            elif item['term'] == 'empty':
+                whereValue = "''"
+            elif item['term'] == 'not_empty':
+                whereValue = "''"
+            elif item['term'] == 'in' or item['term'] == 'not in':
+                if ds.type == 'sqlServer' and (
+                        field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                    whereValue = "(N'" + "', N'".join(value.split(",")) + "')"
+                else:
+                    whereValue = "('" + "', '".join(value.split(",")) + "')"
+            elif item['term'] == 'like' or item['term'] == 'not like':
+                if ds.type == 'sqlServer' and (
+                        field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                    whereValue = f"N'%{value}%'"
+                else:
+                    whereValue = f"'%{value}%'"
             else:
-                whereValue = f"'{value}'"
+                if ds.type == 'sqlServer' and (
+                        field.field_type == 'nchar' or field.field_type == 'NCHAR' or field.field_type == 'nvarchar' or field.field_type == 'NVARCHAR'):
+                    whereValue = f"N'{value}'"
+                else:
+                    whereValue = f"'{value}'"
 
-        res = whereName + whereTerm + whereValue
+            res = whereName + whereTerm + whereValue
     return res
 
 
@@ -124,3 +203,19 @@ def transFilterTerm(term: str) -> str:
     if term == "between":
         return " BETWEEN "
     return ""
+
+
+def userHaveVariable(user_variables: List, sys_variable: SystemVariable):
+    for u in user_variables:
+        if sys_variable.id == u.get('variableId'):
+            return True
+    return False
+
+
+def getSysVariableValue(sys_variable: SystemVariable, current_user: CurrentUser):
+    if sys_variable.value[0] == 'name':
+        return current_user.name
+    if sys_variable.value[0] == 'account':
+        return current_user.account
+    if sys_variable.value[0] == 'email':
+        return current_user.email

backend/apps/swagger/i18n.py

@@ -107,6 +107,10 @@ def load_translation(lang: str) -> Dict[str, str]:
     {
         "name": "Audit",
         "description": f"{PLACEHOLDER_PREFIX}audit_api"
+    },
+    {
+        "name": "System_variable",
+        "description": f"{PLACEHOLDER_PREFIX}variable_api"
     }
 ]
 

backend/apps/swagger/locales/en.json

@@ -188,5 +188,11 @@
   "delete_resource_api": "Delete Resource",
   "create_canvas_api": "Create Dashboard",
   "update_canvas_api": "Update Dashboard",
-  "check_name_api": "Name Validation"
+  "check_name_api": "Name Validation",
+
+  "variable_api": "System Variable",
+  "variable_save": "Save",
+  "variable_delete": "Delete",
+  "variable_list": "List",
+  "variable_page": "Pager"
 }

backend/apps/swagger/locales/zh.json

@@ -188,5 +188,11 @@
   "delete_resource_api": "删除资源",
   "create_canvas_api": "新建仪表板",
   "update_canvas_api": "更新仪表板",
-  "check_name_api": "名称校验"
+  "check_name_api": "名称校验",
+
+  "variable_api": "系统变量",
+  "variable_save": "保存变量",
+  "variable_delete": "删除变量",
+  "variable_list": "获取变量",
+  "variable_page": "获取变量分页"
 }