feature: add system setting service (#12408)

### What problem does this PR solve?

#12409 

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

---------

Signed-off-by: Jin Hai <haijin.chn@gmail.com>

admin/client/admin_client.py

@@ -55,6 +55,9 @@ sql_command: list_services
            | show_version
            | grant_admin
            | revoke_admin
+           | set_variable
+           | show_variable
+           | list_variables
 
 // meta command definition
 meta_command: "\\" meta_command_name [meta_args]
@@ -98,6 +101,8 @@ RESOURCES: "RESOURCES"i
 ON: "ON"i
 SET: "SET"i
 VERSION: "VERSION"i
+VAR: "VAR"i
+VARS: "VARS"i
 
 list_services: LIST SERVICES ";"
 show_service: SHOW SERVICE NUMBER ";"
@@ -129,6 +134,10 @@ show_user_permission: SHOW USER PERMISSION quoted_string ";"
 grant_admin: GRANT ADMIN quoted_string ";"
 revoke_admin: REVOKE ADMIN quoted_string ";"
 
+set_variable: SET VAR identifier identifier ";"
+show_variable: SHOW VAR identifier ";"
+list_variables: LIST VARS ";"
+
 show_version: SHOW VERSION ";"
 
 action_list: identifier ("," identifier)*
@@ -263,6 +272,18 @@ class AdminTransformer(Transformer):
         user_name = items[2]
         return {"type": "revoke_admin", "user_name": user_name}
 
+    def set_variable(self, items):
+        var_name = items[2]
+        var_value = items[3]
+        return {"type": "set_variable", "var_name": var_name, "var_value": var_value}
+
+    def show_variable(self, items):
+        var_name = items[2]
+        return {"type": "show_variable", "var_name": var_name}
+
+    def list_variables(self, items):
+        return {"type": "list_variables"}
+
     def action_list(self, items):
         return items
 
@@ -621,6 +642,12 @@ class AdminCLI(Cmd):
                 self._grant_admin(command_dict)
             case "revoke_admin":
                 self._revoke_admin(command_dict)
+            case "set_variable":
+                self._set_variable(command_dict)
+            case "show_variable":
+                self._show_variable(command_dict)
+            case "list_variables":
+                self._list_variables(command_dict)
             case "meta":
                 self._handle_meta_command(command_dict)
             case _:
@@ -780,6 +807,39 @@ class AdminCLI(Cmd):
         else:
             print(f"Fail to revoke {user_name} admin authorization, code: {res_json['code']}, message: {res_json['message']}")
 
+    def _set_variable(self, command):
+        var_name_tree: Tree = command["var_name"]
+        var_name = var_name_tree.children[0].strip("'\"")
+        var_value_tree: Tree = command["var_value"]
+        var_value = var_value_tree.children[0].strip("'\"")
+        url = f"http://{self.host}:{self.port}/api/v1/admin/variables"
+        response = self.session.put(url, json={"var_name": var_name, "var_value": var_value})
+        res_json = response.json()
+        if response.status_code == 200:
+            print(res_json["message"])
+        else:
+            print(f"Fail to set variable {var_name} to {var_value}, code: {res_json['code']}, message: {res_json['message']}")
+
+    def _show_variable(self, command):
+        var_name_tree: Tree = command["var_name"]
+        var_name = var_name_tree.children[0].strip("'\"")
+        url = f"http://{self.host}:{self.port}/api/v1/admin/variables"
+        response = self.session.get(url, json={"var_name": var_name})
+        res_json = response.json()
+        if response.status_code == 200:
+            self._print_table_simple(res_json["data"])
+        else:
+            print(f"Fail to get variable {var_name}, code: {res_json['code']}, message: {res_json['message']}")
+
+    def _list_variables(self, command):
+        url = f"http://{self.host}:{self.port}/api/v1/admin/variables"
+        response = self.session.get(url)
+        res_json = response.json()
+        if response.status_code == 200:
+            self._print_table_simple(res_json["data"])
+        else:
+            print(f"Fail to list variables, code: {res_json['code']}, message: {res_json['message']}")
+
     def _handle_list_datasets(self, command):
         username_tree: Tree = command["user_name"]
         user_name: str = username_tree.children[0].strip("'\"")

admin/server/routes.py

@@ -21,7 +21,7 @@ from flask_login import current_user, login_required, logout_user
 
 from auth import login_verify, login_admin, check_admin_auth
 from responses import success_response, error_response
-from services import UserMgr, ServiceMgr, UserServiceMgr
+from services import UserMgr, ServiceMgr, UserServiceMgr, SettingsMgr
 from roles import RoleMgr
 from api.common.exceptions import AdminException
 from common.versions import get_ragflow_version
@@ -406,6 +406,49 @@ def get_user_permission(user_name: str):
     except Exception as e:
         return error_response(str(e), 500)
 
+@admin_bp.route('/variables', methods=['PUT'])
+@login_required
+@check_admin_auth
+def set_variable():
+    try:
+        data = request.get_json()
+        if not data and 'var_name' not in data:
+            return error_response("Var name is required", 400)
+
+        if 'var_value' not in data:
+            return error_response("Var value is required", 400)
+        var_name: str = data['var_name']
+        var_value: str = data['var_value']
+
+        SettingsMgr.update_by_name(var_name, var_value)
+        return success_response(None, "Set variable successfully")
+    except AdminException as e:
+        return error_response(str(e), 400)
+    except Exception as e:
+        return error_response(str(e), 500)
+
+@admin_bp.route('/variables', methods=['GET'])
+@login_required
+@check_admin_auth
+def get_variable():
+    try:
+        if request.content_length is None or request.content_length == 0:
+            # list variables
+            res = list(SettingsMgr.get_all())
+            return success_response(res)
+
+        # get var
+        data = request.get_json()
+        if not data and 'var_name' not in data:
+            return error_response("Var name is required", 400)
+        var_name: str = data['var_name']
+        res = SettingsMgr.get_by_name(var_name)
+        return success_response(res)
+    except AdminException as e:
+        return error_response(str(e), 400)
+    except Exception as e:
+        return error_response(str(e), 500)
+
 @admin_bp.route('/version', methods=['GET'])
 @login_required
 @check_admin_auth

admin/server/services.py

@@ -24,6 +24,7 @@ from api.db.joint_services.user_account_service import create_new_user, delete_u
 from api.db.services.canvas_service import UserCanvasService
 from api.db.services.user_service import TenantService
 from api.db.services.knowledgebase_service import KnowledgebaseService
+from api.db.services.system_settings_service import SystemSettingsService
 from api.utils.crypt import decrypt
 from api.utils import health_utils
 
@@ -263,3 +264,47 @@ class ServiceMgr:
     @staticmethod
     def restart_service(service_id: int):
         raise AdminException("restart_service: not implemented")
+
+class SettingsMgr:
+    @staticmethod
+    def get_all():
+
+        settings = SystemSettingsService.get_all()
+        result = []
+        for setting in settings:
+            result.append({
+                'name': setting.name,
+                'setting_type': setting.setting_type,
+                'data_type': setting.data_type,
+                'value': setting.value,
+            })
+        return result
+
+    @staticmethod
+    def get_by_name(name: str):
+        settings = SystemSettingsService.get_by_name(name)
+        if len(settings) == 0:
+            raise AdminException(f"Can't get setting: {name}")
+        result = []
+        for setting in settings:
+            result.append({
+                'name': setting.name,
+                'setting_type': setting.setting_type,
+                'data_type': setting.data_type,
+                'value': setting.value,
+            })
+        return result
+
+    @staticmethod
+    def update_by_name(name: str, value: str):
+        settings = SystemSettingsService.get_by_name(name)
+        if len(settings) == 1:
+            setting = settings[0]
+            setting.value = value
+            setting_dict = setting.to_dict()
+            SystemSettingsService.update_by_name(name, setting_dict)
+        elif len(settings) > 1:
+            raise AdminException(f"Can't update more than 1 setting: {name}")
+        else:
+            raise AdminException(f"No sett"
+                                 f"ing: {name}")