diff --git a/src/ui/builder.py b/src/ui/builder.py deleted file mode 100644 index ba4b9cbf2..000000000 --- a/src/ui/builder.py +++ /dev/null @@ -1,1170 +0,0 @@ -import base64 -import json -import copy -from typing import Union -from widgets import title_widget, table_widget, stat_widget, instance_widget - - -def home_builder(data: dict) -> str: - """ - It returns the needed format from data to render the home page in JSON format for the Vue.js builder - """ - version_card = stat_widget( - link="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=ui#pro", - containerColums={"pc": 4, "tablet": 6, "mobile": 12}, - title="home_version", - subtitle=( - "home_all_features_available" - if data.get("is_pro_version") - else ( - "home_awaiting_compliance" - if data.get("pro_status") == "active" and data.get("pro_overlapped") - else ( - "home_renew_license" - if data.get("pro_status") == "expired" - else "home_talk_to_team" if data.get("pro_status") == "suspended" else "home_upgrade_to_pro" - ) - ) - ), - subtitle_color="success" if data.get("is_pro_version") else "warning", - stat=( - "home_pro" - if data.get("is_pro_version") - else ( - "home_pro_locked" - if data.get("pro_status") == "active" and data.get("pro_overlapped") - else "home_expired" if data.get("pro_status") == "expired" else "home_suspended" if data.get("pro_status") == "suspended" else "home_free" - ) - ), - icon_name="crown" if data.get("is_pro_version") else "key", - ) - - version_num_card = stat_widget( - link="https://github.com/bunkerity/bunkerweb", - containerColums={"pc": 4, "tablet": 6, "mobile": 12}, - title="home_version_number", - subtitle=( - "home_couldnt_find_remote" - if not data.get("remote_version") - else "home_latest_version" if data.get("remote_version") and data.get("check_version") else "home_update_available" - ), - subtitle_color=("error" if not data.get("remote_version") else "success" if data.get("remote_version") and data.get("check_version") else "warning"), - stat=data.get("version"), - icon_name="wire", - ) - - instances_card = stat_widget( - link="instances", - containerColums={"pc": 4, "tablet": 6, "mobile": 12}, - title="home_instances", - subtitle="home_total_number", - subtitle_color="info", - stat=data.get("instances_number"), - icon_name="box", - ) - - services_card = stat_widget( - link="services", - containerColums={"pc": 4, "tablet": 6, "mobile": 12}, - title="home_services", - subtitle="home_all_methods_included", - subtitle_color="info", - stat=data.get("services_number"), - icon_name="disk", - ) - - plugins_card = stat_widget( - link="plugins", - containerColums={"pc": 4, "tablet": 6, "mobile": 12}, - title="home_plugins", - subtitle="home_errors_found" if data.get("plugins_errors") > 0 else "home_no_error", - subtitle_color="error" if data.get("plugins_errors") > 0 else "success", - stat=data.get("plugins_number"), - icon_name="puzzle", - ) - - builder = [version_card, version_num_card, instances_card, services_card, plugins_card] - - return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") - - -def instances_builder(instances: list) -> str: - """ - It returns the needed format from data to render the instances page in JSON format for the Vue.js builder - """ - builder = [] - - for instance in instances: - # setup actions buttons - actions = ( - ["restart", "stop"] - if instance._type == "local" and instance.health - else ( - ["reload", "stop"] - if not instance._type == "local" and instance.health - else ["start"] if instance._type == "local" and not instance.health else [] - ) - ) - - buttons = [ - { - "attrs": { - "data-submit-form": f"""{{"INSTANCE_ID" : "{instance._id}", "operation" : "{action}" }}""", - }, - "text": f"action_{action}", - "color": "success" if action == "start" else "error" if action == "stop" else "warning", - } - for action in actions - ] - - instance = instance_widget( - containerColumns={"pc": 6, "tablet": 6, "mobile": 12}, - pairs=[ - {"key": "instances_hostname", "value": instance.hostname}, - {"key": "instances_type", "value": instance._type}, - {"key": "instances_status", "value": "instances_active" if instance.health else "instances_inactive"}, - ], - status="success" if instance.health else "error", - title=instance.name, - buttons=buttons, - ) - - builder.append(instance) - - return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") - - -def get_forms(templates: list = [], plugins: list = [], settings: dict = {}, render_forms: tuple = ("advanced", "easy", "raw")) -> dict: - """ - Will generate every needed form using templates, plugins and settings. - We will run on each plugins, set template value if one, and override by the custom settings value if exists. - We will format to fit each form type (easy, advanced, raw) in case - """ - forms = {} - for form in render_forms: - forms[form] = {} - - for template in templates: - if "advanced" in forms: - forms["advanced"][template.get("name")] = set_advanced(template, plugins, settings) - - if "raw" in forms: - forms["raw"][template.get("name")] = set_raw(template, plugins, settings) - - if "easy" in forms: - forms["easy"][template.get("name")] = set_easy(template, plugins, settings) - - return forms - - -def set_easy(template: list, plugins_base: list, settings: dict) -> dict: - """ - Prepare the easy form based on the template and plugins data. - We need to loop on each steps and prepare settings and configs for each step. - """ - template_settings = template.get("settings") - plugins = copy.deepcopy(plugins_base) - steps = template.get("steps") - - for step in steps: - step_settings = step.get("settings", {}) - # Loop on step settings to set the settings value - loop_id = 0 - step_settings_output = {} - for setting in step_settings: - loop_id += 1 - # Get relate setting from plugins using setting name - plugin = next( - (plugin for plugin in plugins if setting in plugin.get("settings")), - None, - ) - - if not plugin: - continue - - if not plugin.get("settings").get(setting): - continue - - plugin_setting = copy.deepcopy(plugin.get("settings").get(setting)) - - plugin_setting = format_setting( - setting, - plugin_setting, - len(step_settings), - loop_id, - template_settings, - settings, - ) - - step_settings_output[setting] = plugin_setting - - step["settings"] = step_settings_output - - return steps - - -def set_raw(template: list, plugins_base: list, settings: dict) -> dict: - """ - Set the raw form based on the template and plugins data. - It consists of keeping only the value or default value for each plugin settings. - """ - template_settings = template.get("settings") - raw_settings = {} - # Copy of the plugins base - plugins = copy.deepcopy(plugins_base) - # Update settings with global config data - for plugin in plugins: - for setting, value in plugin.get("settings").items(): - # avoid some methods from services_settings - if setting in settings and settings[setting].get("method", "ui") not in ("ui", "default", "manual"): - continue - - raw_value = None - - # Start by setting template value if exists - if setting in template_settings: - # Update value or set default as value - raw_value = template_settings.get(setting, value.get("default")) - - # Then override by service settings - if setting in settings: - # Check if the service setting is not default value to add it - default_val = value.get("default") - val = settings[setting].get("value", value.get("value", value.get("default"))) - if val != default_val: - raw_value = val - - # Add value only if exists - if raw_value: - raw_settings[setting] = raw_value - - return raw_settings - - -def set_advanced(template: list, plugins_base: list, settings: dict) -> dict: - """ - Set the advanced form based on the template and plugins data. - It consists of formatting each plugin settings to be used in the advanced form. - """ - template_settings = template.get("settings") - # Copy of the plugins base data - plugins = copy.deepcopy(plugins_base) - # Update settings with global config data - for plugin in plugins: - loop_id = 0 - total_settings = len(plugin.get("settings")) - for setting, value in plugin.get("settings").items(): - loop_id += 1 - value = format_setting( - setting, - value, - total_settings, - loop_id, - template_settings, - settings, - ) - - set_multiples(template, plugins, settings) - - return plugins - - -def get_multiple_from_template(template, multiples): - """ - We are gonna loop on each plugins multiples group, in case a setting is matching a template setting, - we will create a group using the prefix as key (or "0" if no prefix) with default settings at first. - Then we will override by the template value in case there is one. - This will return something of this type : - {'0' : {'setting' : value, 'setting2': value2}, '1' : {'setting_1': value, 'setting2_1': value}} } - """ - # Loop on each plugin and loop on multiples key - # Check if the name us matching a template key - multiple_plugin = copy.deepcopy(multiples) - - multiple_template = {} - for setting, value in template.get("settings").items(): - # Sanitize setting name to remove prefix of type _1 if exists - # Slipt by _ and check if last element is a digit - format_setting = setting - setting_split = setting.split("_") - prefix = "0" - if setting_split[-1].isdigit(): - prefix = setting_split[-1] - format_setting = "_".join(setting_split[:-1]) - # loop on settings of a multiple group - for mult_name, mult_settings in multiple_plugin.items(): - - # Check if at least one settign is matching a multiple setting - if not format_setting in mult_settings: - continue - - # Case we have at least one multiple setting, we can check if multiple name exists or create it - if not mult_name in multiple_template: - multiple_template[mult_name] = {} - - # Case it is, we will check if already a group with the right prefix exists - # If not, we will create it - if not prefix in multiple_template[mult_name]: - # We want each settings to have the prefix if exists - # We will get the value of the setting without the prefix and create a prefix key with the same value - # And after that we can delete the original setting - new_multiple_group = {} - for multSett, multValue in mult_settings.items(): - new_multiple_group[f"{multSett}{f'_{prefix}' if prefix != '0' else ''}"] = multValue - - new_multiple_group = copy.deepcopy(new_multiple_group) - - # Update id for each settings - for multSett, multValue in new_multiple_group.items(): - multValue["id"] = f"{multValue['id']}{f'-{prefix}' if prefix != '0' else ''}" - - multiple_template[mult_name][prefix] = new_multiple_group - - # We can now add the template value to setting using the same setting name with prefix - multiple_template[mult_name][prefix][setting]["value"] = value - multiple_template[mult_name][prefix][setting]["prev_value"] = value - multiple_template[mult_name][prefix][setting]["method"] = "default" - - # Sort key incrementally - for mult_name, mult_settings in multiple_template.items(): - multiple_template[mult_name] = dict(sorted(mult_settings.items(), key=lambda item: int(item[0]))) - return multiple_template - - -def get_multiple_from_settings(settings, multiples): - """ - We are gonna loop on each plugins multiples group, in case a setting is matching a service / global config setting, - we will create a group using the prefix as key (or "0" if no prefix) with default settings at first. - Then we will override by the service / global config value in case there is one. - This will return something of this type : - {'0' : {'setting' : value, 'setting2': value2}, '1' : {'setting_1': value, 'setting2_1': value}} } - """ - - # Loop on each plugin and loop on multiples key - # Check if the name us matching a template key - multiple_plugins = copy.deepcopy(multiples) - - multiple_settings = {} - for setting, value in settings.items(): - # Sanitize setting name to remove prefix of type _1 if exists - # Slipt by _ and check if last element is a digit - format_setting = setting - setting_split = setting.split("_") - prefix = "0" - if setting_split[-1].isdigit(): - prefix = setting_split[-1] - format_setting = "_".join(setting_split[:-1]) - - # loop on settings of a multiple group - for mult_name, mult_settings in multiple_plugins.items(): - - # Check if at least one settign is matching a multiple setting - if not format_setting in mult_settings: - continue - - # Case we have at least one multiple setting, we can check if multiple name exists or create it - if not mult_name in multiple_settings: - multiple_settings[mult_name] = {} - # Now check if prefix exist for this mult - if not prefix in multiple_settings[mult_name]: - # We want each settings to have the prefix if exists - # We will get the value of the setting without the prefix and create a prefix key with the same value - # And after that we can delete the original setting - new_multiple_group = {} - for multSett, multValue in mult_settings.items(): - new_multiple_group[f"{multSett}{f'_{prefix}' if prefix != '0' else ''}"] = multValue - - new_multiple_group = copy.deepcopy(new_multiple_group) - - # Update id for each settings - for multSett, multValue in new_multiple_group.items(): - multValue["id"] = f"{multValue['id']}{f'-{prefix}' if prefix != '0' else ''}" - - multiple_settings[mult_name][prefix] = new_multiple_group - - # Update multiple template with real data - multiple_settings[mult_name][prefix][setting]["value"] = value.get("value", multiple_settings[mult_name][prefix][setting]["value"]) - multiple_settings[mult_name][prefix][setting]["prev_value"] = value.get("value", multiple_settings[mult_name][prefix][setting]["value"]) - multiple_settings[mult_name][prefix][setting]["method"] = value.get("method", "ui") - multiple_settings[mult_name][prefix][setting]["disabled"] = False if value.get("method", "ui") in ("ui", "default", "manual") else True - - # Add popovers if setting is disabled else stop - if not multiple_settings[mult_name][prefix][setting].get("disabled", False): - continue - - multiple_settings[mult_name][prefix][setting]["popovers"] = [ - { - "iconName": "trespass", - "text": "inp_popover_method_disabled", - } - ] + multiple_settings[ - mult_name - ][prefix][setting].get("popovers", []) - - return multiple_settings - - -def set_multiples(template, format_plugins, settings): - """ - Set the multiples settings for each plugin. - """ - # copy of format plugins - for plugin in format_plugins: - # Get multiples - multiples = {} - settings_to_delete = [] - total_settings = len(plugin.get("settings")) - zindex = 0 - for setting, value in plugin.get("settings").items(): - - if not value.get("multiple"): - continue - - zindex += 1 - - value["containerClass"] = f"z-{total_settings - zindex}" - - mult_name = value.get("multiple") - # Get the multiple value and set it as key if not in multiples dict - if mult_name not in multiples: - multiples[mult_name] = {} - - multiples[mult_name][setting] = value - settings_to_delete.append(setting) - - # Delete multiple settings from regular settings - for setting in settings_to_delete: - del plugin["settings"][setting] - - if len(multiples): - # Add multiple schema with default values to plugin - plugin["multiples_schema"] = multiples - # Now that we have for each plugin the multiples settings, we need to do the following - # Get all settings from template that are multiples - template_multiples = get_multiple_from_template(template, multiples) - # Get all settings from service settings / global config that are multiples - service_multiples = get_multiple_from_settings(settings, multiples) - # Get service multiples if at least one, else use template multiples - plugin["multiples"] = service_multiples if len(service_multiples) else template_multiples - - return format_plugins - - -def format_setting( - setting_name: str, - setting_value: Union[str, int], - total_settings: Union[str, int], - loop_id: Union[str, int], - template_settings: dict, - settings: dict, -) -> dict: - """ - Format a setting in order to be used with form builder. - This will only set value for none multiple settings. - Additionnel set_multiples function will handle multiple settings. - """ - # add zindex for field in case not a multiple - # Case multiple, this will be set on the group level - if not "multiple" in setting_value: - setting_value["containerClass"] = f"z-{total_settings - loop_id}" - - # regex by pattern - setting_value["pattern"] = setting_value.get("regex", "") - - # set inpType based on type define for each settings - inpType = ( - "checkbox" - if setting_value.get("type") == "check" - else ("select" if setting_value.get("type") == "select" else "datepicker" if setting_value.get("type") == "date" else "input") - ) - setting_value["inpType"] = inpType - - # set name using the label - setting_value["name"] = setting_value.get("label") - - # case select - if inpType == "select": - # replace "select" key by "values" - setting_value["values"] = setting_value.pop("select") - - # add columns - setting_value["columns"] = {"pc": 4, "tablet": 6, "mobile": 12} - - # By default, the input is enabled unless specific method - setting_value["disabled"] = False - - setting_value["value"] = setting_value.get("default") - - # Start by setting template value if exists - if setting_name in template_settings and not "multiple" in setting_value: - # Update value or set default as value - setting_value["value"] = template_settings.get(setting_name, setting_value.get("default")) - - # Then override by service settings if not a multiple - # Case multiple, we need to keep the default value and override only each multiple group - if setting_name in settings and not "multiple" in setting_value: - setting_value["value"] = settings[setting_name].get("value", setting_value.get("value", setting_value.get("default"))) - setting_value["method"] = settings[setting_name].get("method", "ui") - - # Add prev_value in order to check if value has changed to submit it - setting_value["prev_value"] = setting_value.get("value") - - # Then override by service settings - if setting_name in settings: - setting_value["disabled"] = False if settings[setting_name].get("method", "ui") in ("ui", "default", "manual") else True - - # Prepare popover checking "help", "context" - popovers = [] - - if (setting_value.get("disabled", False)) and settings[setting_name].get("method", "ui") not in ("ui", "default", "manual"): - popovers.append( - { - "iconName": "trespass", - "text": "inp_popover_method_disabled", - } - ) - - if setting_value.get("context"): - popovers.append( - { - "iconName": ("disk" if setting_value.get("context") == "multisite" else "globe"), - "text": ("inp_popover_multisite" if setting_value.get("context") == "multisite" else "inp_popover_global"), - } - ) - - if setting_value.get("help"): - popovers.append( - { - "iconName": "info", - "text": setting_value.get("help"), - } - ) - - setting_value["popovers"] = popovers - return setting_value - - -def global_config_builder(plugins: list, settings: dict) -> str: - """Render forms with global config data. - ATM we don't need templates but we need to pass at least one to the function (it will simply not override anything). - """ - - templates = [ - { - "name": "default", - "steps": [], - "configs": {}, - "settings": {}, - } - ] - - builder = [ - { - "type": "card", - "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, - "widgets": [ - { - "type": "Title", - "data": {"title": "global_config_title", "type": "container"}, - }, - { - "type": "Subtitle", - "data": {"subtitle": "global_config_subtitle", "type": "container"}, - }, - { - "type": "Templates", - "data": { - "templates": get_forms(templates, plugins, settings, ("advanced", "raw")), - }, - }, - ], - } - ] - return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") - - -def get_jobs_list(jobs): - data = [] - # loop on each dict - for key, value in jobs.items(): - item = [] - item.append({"name": key, "type": "Text", "data": {"text": key}}) - # loop on each value - for k, v in value.items(): - # override widget type for some keys - if k in ("reload", "success"): - item.append( - { - k: "success" if v else "failed", - "type": "Icons", - "data": { - "iconName": "check" if v else "cross", - }, - } - ) - continue - - if k in ("plugin_id", "every", "last_run"): - item.append({k: v, "type": "Text", "data": {"text": v}}) - continue - - if k in ("cache") and len(v) <= 0: - item.append({k: v, "type": "Text", "data": {"text": ""}}) - continue - - if k in ("cache") and len(v) > 0: - files = [] - # loop on each cache item - for cache in v: - file_name = f"{cache['file_name']} [{cache['service_id']}]" if cache["service_id"] else f"{cache['file_name']}" - files.append(file_name) - - item.append( - { - k: " ".join(files), - "type": "Fields", - "data": { - "setting": { - "attrs": { - "data-plugin-id": value.get("plugin_id", ""), - "data-job-name": key, - }, - "id": f"{key}_cache", - "label": f"{key}_cache", - "hideLabel": True, - "inpType": "select", - "name": f"{key}_cache", - "value": "download file", - "values": files, - "columns": { - "pc": 12, - "tablet": 12, - "mobile": 12, - }, - "overflowAttrEl": "data-table-body", - "containerClass": "table download-cache-file", - "maxBtnChars": 12, - "popovers": [ - { - "iconName": "info", - "text": "jobs_download_cache_file", - }, - ], - } - }, - } - ) - continue - - data.append(item) - - return data - - -def jobs_builder(jobs): - - jobs_list = get_jobs_list(jobs) - - intervals = ["all"] - - # loop on each job - for job in jobs_list: - # loop on each item - for item in job: - # get the interval if not already in intervals - if item.get("every") and item.get("every") not in intervals: - intervals.append(item.get("every")) - - builder = [ - { - "type": "card", - "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, - "widgets": [ - title_widget("jobs_title"), - table_widget( - positions=[2, 2, 1, 1, 1, 2, 3], - header=[ - "jobs_table_name", - "jobs_table_plugin_id", - "jobs_table_interval", - "jobs_table_reload", - "jobs_table_success", - "jobs_table_last_run_date", - "jobs_table_cache_downloadable", - ], - items=jobs_list, - filters=[ - { - "filter": "table", - "filterName": "keyword", - "type": "keyword", - "value": "", - "keys": ["name", "plugin_id", "last_run"], - "field": { - "id": "jobs-keyword", - "value": "", - "type": "text", - "name": "jobs-keyword", - "label": "jobs_search", - "placeholder": "inp_keyword", - "isClipboard": False, - "popovers": [ - { - "text": "jobs_search_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - { - "filter": "table", - "filterName": "every", - "type": "select", - "value": "all", - "keys": ["every"], - "field": { - "id": "jobs-every", - "value": "all", - "values": intervals, - "name": "jobs-every", - "onlyDown": True, - "label": "jobs_interval", - "popovers": [ - { - "text": "jobs_interval_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - { - "filter": "table", - "filterName": "reload", - "type": "select", - "value": "all", - "keys": ["reload"], - "field": { - "id": "jobs-last-run", - "value": "all", - "values": ["all", "success", "failed"], - "name": "jobs-last-run", - "onlyDown": True, - "label": "jobs_reload", - "popovers": [ - { - "text": "jobs_reload_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - { - "filter": "table", - "filterName": "success", - "type": "select", - "value": "all", - "keys": ["success"], - "field": { - "id": "jobs-success", - "value": "all", - "values": ["all", "success", "failed"], - "name": "jobs-success", - "onlyDown": True, - "label": "jobs_success", - "popovers": [ - { - "text": "jobs_success_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - ], - minWidth="lg", - title="jobs_table_title", - ), - ], - } - ] - - return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") - - -def services_settings(settings: dict) -> dict: - # deep copy settings dict - settings = settings.copy() - # remove "SERVER_NAME" and "IS_DRAFT" key - settings.pop("SERVER_NAME", None) - settings.pop("IS_DRAFT", None) - # Create table with settings remaining keys - settings_table_items = [] - for key, value in settings.items(): - format_key = key.replace("USE_", "").replace("_", " ") - settings_table_items.append( - [ - { - "type": "Text", - "data": {"text": format_key}, - }, - { - "type": "Icons", - "data": { - "iconName": "check" if value.get("value") == "yes" else "cross", - }, - }, - ] - ) - - table = table_widget( - positions=[8, 4], - header=["services_settings_table_name", "services_settings_table_status"], - items=settings_table_items, - filters=[], - minWidth="", - title="services_settings_table_title", - ) - - return table - - -def services_action( - server_name: str = "", - operation: str = "", - title: str = "", - subtitle: str = "", - additionnal: str = "", - is_draft: Union[bool, None] = None, - service: dict = None, -) -> dict: - - buttons = [ - { - "id": f"close-service-btn-{server_name}", - "text": "action_close", - "disabled": False, - "color": "close", - "size": "normal", - "attrs": {"data-close-modal": ""}, - }, - ] - - if operation == "delete": - buttons.append( - { - "id": f"{operation}-service-btn-{server_name}", - "text": f"action_{operation}", - "disabled": False, - "color": "delete", - "size": "normal", - "attrs": { - "data-submit-form": f"""{{"SERVER_NAME" : {server_name}, "operation" : "{operation}" }}""", - }, - }, - ) - - if operation == "draft": - draft_value = "yes" if is_draft else "no" - buttons.append( - { - "id": f"{operation}-service-btn-{server_name}", - "text": "action_switch", - "disabled": False, - "color": "success", - "size": "normal", - "attrs": { - "data-submit-form": f"""{{"SERVER_NAME" : {server_name}, "OLD_SERVER_NAME" : {server_name}, "operation" : "edit", "IS_DRAFT" : {draft_value} }}""", - }, - }, - ) - - content = [ - { - "type": "Title", - "data": { - "title": title, - }, - }, - ] - - if subtitle: - content.append( - { - "type": "Text", - "data": { - "text": subtitle, - }, - }, - ) - - if additionnal: - content.append( - { - "type": "Text", - "data": { - "bold": True, - "text": additionnal, - }, - } - ) - - if operation == "plugins": - settings = services_settings(service) - content.append(settings) - - if operation == "delete": - content.append( - { - "type": "Text", - "data": { - "text": "", - "bold": True, - "text": server_name, - }, - } - ) - - if operation == "edit" or operation == "create": - modes = ("easy", "advanced", "raw") - mode_buttons = [] - for mode in modes: - mode_buttons.append( - { - "id": f"{operation}-service-btn-{server_name}", - "text": f"services_mode_{mode}", - "disabled": False, - "color": "info", - "size": "normal", - "attrs": { - "role": "link", - "data-link": f"services/{mode}/{server_name}", - }, - }, - ) - - content.append( - { - "type": "ButtonGroup", - "data": {"buttons": mode_buttons}, - } - ) - - content.append( - { - "type": "ButtonGroup", - "data": {"buttons": buttons}, - }, - ) - - modal = { - "widgets": content, - } - - return modal - - -def get_services_list(services): - data = [] - for index, service in enumerate(services): - server_name = service["SERVER_NAME"]["value"] - server_method = service["SERVER_NAME"]["method"] - is_draft = True if service["IS_DRAFT"]["value"] == "yes" else False - is_deletable = False if server_method in ("autoconf", "scheduler") else True - - item = [] - # Get name - item.append({"name": server_name, "type": "Text", "data": {"text": server_name}}) - item.append({"method": server_method, "type": "Text", "data": {"text": server_method}}) - item.append( - { - "type": "ButtonGroup", - "data": { - "buttons": [ - { - "id": f"open-modal-plugins-{index}", - "text": "plugins", - "hideText": True, - "color": "success", - "size": "normal", - "iconName": "eye", - "iconColor": "white", - "modal": services_action( - server_name=server_name, - operation="plugins", - title="services_plugins_title", - subtitle="", - service=service, - ), - }, - { - "attrs": {"data-server-name": server_name}, - "id": f"open-modal-manage-{index}", - "text": "manage", - "hideText": True, - "color": "edit", - "size": "normal", - "iconName": "pen", - "iconColor": "white", - "modal": services_action( - server_name=server_name, - operation="edit", - title="services_edit_title", - subtitle="services_edit_subtitle", - additionnal=server_name, - ), - }, - { - "attrs": {"data-server-name": server_name, "data-is-draft": "yes" if is_draft else "no"}, - "id": f"open-modal-draft-{index}", - "text": "draft" if is_draft else "online", - "hideText": True, - "color": "blue", - "size": "normal", - "iconName": "document" if is_draft else "globe", - "iconColor": "white", - "modal": services_action( - server_name=server_name, - operation="draft", - title="services_draft_title", - subtitle="services_draft_subtitle" if is_draft else "services_online_subtitle", - additionnal="services_draft_switch_subtitle" if is_draft else "services_online_switch_subtitle", - is_draft=is_draft, - ), - }, - { - "attrs": {"data-server-name": server_name}, - "id": f"open-modal-delete-{index}", - "text": "delete", - "disabled": not is_deletable, - "hideText": True, - "color": "red", - "size": "normal", - "iconName": "trash", - "iconColor": "white", - "modal": services_action( - server_name=server_name, operation="delete", title="services_delete_title", subtitle="services_delete_subtitle" - ), - }, - ] - }, - } - ) - - data.append(item) - - return data - - -def services_builder(services): - # get method for each service["SERVER_NAME"]["method"] - methods = list(set([service["SERVER_NAME"]["method"] for service in services])) - - services_list = get_services_list(services) - - builder = [ - { - "type": "card", - "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, - "widgets": [ - title_widget("services_title"), - { - "type": "Button", - "data": { - "id": "services-new", - "text": "services_new", - "color": "success", - "size": "normal", - "iconName": "plus", - "iconColor": "white", - "modal": services_action(server_name="new", operation="create", title="services_create_title", subtitle="services_create_subtitle"), - "containerClass": "col-span-12 flex justify-center", - }, - }, - table_widget( - positions=[4, 4, 4], - header=[ - "services_table_name", - "services_table_method", - "services_table_actions", - ], - items=services_list, - filters=[ - { - "filter": "table", - "filterName": "keyword", - "type": "keyword", - "value": "", - "keys": ["name"], - "field": { - "id": "services-keyword", - "value": "", - "type": "text", - "name": "services-keyword", - "label": "services_search", - "placeholder": "inp_keyword", - "isClipboard": False, - "popovers": [ - { - "text": "services_search_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - { - "filter": "table", - "filterName": "method", - "type": "select", - "value": "all", - "keys": ["method"], - "field": { - "id": "services-methods", - "value": "all", - "values": methods, - "name": "services-methods", - "onlyDown": True, - "label": "services_methods", - "popovers": [ - { - "text": "services_methods_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - { - "filter": "table", - "filterName": "draft", - "type": "select", - "value": "all", - "keys": ["draft"], - "field": { - "id": "services-draft", - "value": "all", - "values": ["all", "online", "draft"], - "name": "services-draft", - "onlyDown": True, - "label": "services_draft", - "popovers": [ - { - "text": "services_draft_desc", - "iconName": "info", - }, - ], - "columns": {"pc": 3, "tablet": 4, "mobile": 12}, - }, - }, - ], - minWidth="md", - title="services_table_title", - ), - ], - }, - ] - - return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") diff --git a/src/ui/builder/global_config.py b/src/ui/builder/global_config.py new file mode 100644 index 000000000..96c5617d5 --- /dev/null +++ b/src/ui/builder/global_config.py @@ -0,0 +1,50 @@ +import base64 +import json +from os.path import join, sep +from sys import path as sys_path + +for deps_path in [join(sep, "usr", "share", "bunkerweb", *paths) for paths in (("deps", "python"), ("utils",), ("api",), ("db",))]: + if deps_path not in sys_path: + sys_path.append(deps_path) + + +from builder.utils.form import get_forms + + +def global_config_builder(plugins: list, settings: dict) -> str: + """Render forms with global config data. + ATM we don't need templates but we need to pass at least one to the function (it will simply not override anything). + """ + + templates = [ + { + "name": "default", + "steps": [], + "configs": {}, + "settings": {}, + } + ] + + builder = [ + { + "type": "card", + "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, + "widgets": [ + { + "type": "Title", + "data": {"title": "global_config_title", "type": "container"}, + }, + { + "type": "Subtitle", + "data": {"subtitle": "global_config_subtitle", "type": "container"}, + }, + { + "type": "Templates", + "data": { + "templates": get_forms(templates, plugins, settings, ("advanced", "raw")), + }, + }, + ], + } + ] + return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") diff --git a/src/ui/builder/home.py b/src/ui/builder/home.py new file mode 100644 index 000000000..14ea5e015 --- /dev/null +++ b/src/ui/builder/home.py @@ -0,0 +1,94 @@ +import base64 +import json + +from os.path import join, sep +from sys import path as sys_path + +for deps_path in [join(sep, "usr", "share", "bunkerweb", *paths) for paths in (("deps", "python"), ("utils",), ("api",), ("db",))]: + if deps_path not in sys_path: + sys_path.append(deps_path) + +from builder.utils.widgets import stat_widget + + +def home_builder(data: dict) -> str: + """ + It returns the needed format from data to render the home page in JSON format for the Vue.js builder + """ + version_card = stat_widget( + link="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=ui#pro", + containerColums={"pc": 4, "tablet": 6, "mobile": 12}, + title="home_version", + subtitle=( + "home_all_features_available" + if data.get("is_pro_version") + else ( + "home_awaiting_compliance" + if data.get("pro_status") == "active" and data.get("pro_overlapped") + else ( + "home_renew_license" + if data.get("pro_status") == "expired" + else "home_talk_to_team" if data.get("pro_status") == "suspended" else "home_upgrade_to_pro" + ) + ) + ), + subtitle_color="success" if data.get("is_pro_version") else "warning", + stat=( + "home_pro" + if data.get("is_pro_version") + else ( + "home_pro_locked" + if data.get("pro_status") == "active" and data.get("pro_overlapped") + else "home_expired" if data.get("pro_status") == "expired" else "home_suspended" if data.get("pro_status") == "suspended" else "home_free" + ) + ), + icon_name="crown" if data.get("is_pro_version") else "key", + ) + + version_num_card = stat_widget( + link="https://github.com/bunkerity/bunkerweb", + containerColums={"pc": 4, "tablet": 6, "mobile": 12}, + title="home_version_number", + subtitle=( + "home_couldnt_find_remote" + if not data.get("remote_version") + else "home_latest_version" if data.get("remote_version") and data.get("check_version") else "home_update_available" + ), + subtitle_color=("error" if not data.get("remote_version") else "success" if data.get("remote_version") and data.get("check_version") else "warning"), + stat=data.get("version"), + icon_name="wire", + ) + + instances_card = stat_widget( + link="instances", + containerColums={"pc": 4, "tablet": 6, "mobile": 12}, + title="home_instances", + subtitle="home_total_number", + subtitle_color="info", + stat=data.get("instances_number"), + icon_name="box", + ) + + services_card = stat_widget( + link="services", + containerColums={"pc": 4, "tablet": 6, "mobile": 12}, + title="home_services", + subtitle="home_all_methods_included", + subtitle_color="info", + stat=data.get("services_number"), + icon_name="disk", + ) + + plugins_card = stat_widget( + link="plugins", + containerColums={"pc": 4, "tablet": 6, "mobile": 12}, + title="home_plugins", + subtitle="home_errors_found" if data.get("plugins_errors") > 0 else "home_no_error", + subtitle_color="error" if data.get("plugins_errors") > 0 else "success", + stat=data.get("plugins_number"), + icon_name="puzzle", + ) + + builder = [version_card, version_num_card, instances_card, services_card, plugins_card] + + return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") diff --git a/src/ui/builder/instances.py b/src/ui/builder/instances.py new file mode 100644 index 000000000..636f1a492 --- /dev/null +++ b/src/ui/builder/instances.py @@ -0,0 +1,57 @@ +import base64 +import json + +from os.path import join, sep +from sys import path as sys_path + +for deps_path in [join(sep, "usr", "share", "bunkerweb", *paths) for paths in (("deps", "python"), ("utils",), ("api",), ("db",))]: + if deps_path not in sys_path: + sys_path.append(deps_path) + +from builder.utils.widgets import instance_widget + + +def instances_builder(instances: list) -> str: + """ + It returns the needed format from data to render the instances page in JSON format for the Vue.js builder + """ + builder = [] + + for instance in instances: + # setup actions buttons + actions = ( + ["restart", "stop"] + if instance._type == "local" and instance.health + else ( + ["reload", "stop"] + if not instance._type == "local" and instance.health + else ["start"] if instance._type == "local" and not instance.health else [] + ) + ) + + buttons = [ + { + "attrs": { + "data-submit-form": f"""{{"INSTANCE_ID" : "{instance._id}", "operation" : "{action}" }}""", + }, + "text": f"action_{action}", + "color": "success" if action == "start" else "error" if action == "stop" else "warning", + } + for action in actions + ] + + instance = instance_widget( + containerColumns={"pc": 6, "tablet": 6, "mobile": 12}, + pairs=[ + {"key": "instances_hostname", "value": instance.hostname}, + {"key": "instances_type", "value": instance._type}, + {"key": "instances_status", "value": "instances_active" if instance.health else "instances_inactive"}, + ], + status="success" if instance.health else "error", + title=instance.name, + buttons=buttons, + ) + + builder.append(instance) + + return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") diff --git a/src/ui/builder/jobs.py b/src/ui/builder/jobs.py new file mode 100644 index 000000000..3e30ed01f --- /dev/null +++ b/src/ui/builder/jobs.py @@ -0,0 +1,222 @@ +import base64 +import json + +from os.path import join, sep +from sys import path as sys_path + +for deps_path in [join(sep, "usr", "share", "bunkerweb", *paths) for paths in (("deps", "python"), ("utils",), ("api",), ("db",))]: + if deps_path not in sys_path: + sys_path.append(deps_path) + +from builder.utils.widgets import title_widget, table_widget + + +def jobs_builder(jobs): + + jobs_list = get_jobs_list(jobs) + + intervals = ["all"] + + # loop on each job + for job in jobs_list: + # loop on each item + for item in job: + # get the interval if not already in intervals + if item.get("every") and item.get("every") not in intervals: + intervals.append(item.get("every")) + + builder = [ + { + "type": "card", + "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, + "widgets": [ + title_widget("jobs_title"), + table_widget( + positions=[2, 2, 1, 1, 1, 2, 3], + header=[ + "jobs_table_name", + "jobs_table_plugin_id", + "jobs_table_interval", + "jobs_table_reload", + "jobs_table_success", + "jobs_table_last_run_date", + "jobs_table_cache_downloadable", + ], + items=jobs_list, + filters=[ + { + "filter": "table", + "filterName": "keyword", + "type": "keyword", + "value": "", + "keys": ["name", "plugin_id", "last_run"], + "field": { + "id": "jobs-keyword", + "value": "", + "type": "text", + "name": "jobs-keyword", + "label": "jobs_search", + "placeholder": "inp_keyword", + "isClipboard": False, + "popovers": [ + { + "text": "jobs_search_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + { + "filter": "table", + "filterName": "every", + "type": "select", + "value": "all", + "keys": ["every"], + "field": { + "id": "jobs-every", + "value": "all", + "values": intervals, + "name": "jobs-every", + "onlyDown": True, + "label": "jobs_interval", + "popovers": [ + { + "text": "jobs_interval_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + { + "filter": "table", + "filterName": "reload", + "type": "select", + "value": "all", + "keys": ["reload"], + "field": { + "id": "jobs-last-run", + "value": "all", + "values": ["all", "success", "failed"], + "name": "jobs-last-run", + "onlyDown": True, + "label": "jobs_reload", + "popovers": [ + { + "text": "jobs_reload_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + { + "filter": "table", + "filterName": "success", + "type": "select", + "value": "all", + "keys": ["success"], + "field": { + "id": "jobs-success", + "value": "all", + "values": ["all", "success", "failed"], + "name": "jobs-success", + "onlyDown": True, + "label": "jobs_success", + "popovers": [ + { + "text": "jobs_success_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + ], + minWidth="lg", + title="jobs_table_title", + ), + ], + } + ] + + return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") + + +def get_jobs_list(jobs): + data = [] + # loop on each dict + for key, value in jobs.items(): + item = [] + item.append({"name": key, "type": "Text", "data": {"text": key}}) + # loop on each value + for k, v in value.items(): + # override widget type for some keys + if k in ("reload", "success"): + item.append( + { + k: "success" if v else "failed", + "type": "Icons", + "data": { + "iconName": "check" if v else "cross", + }, + } + ) + continue + + if k in ("plugin_id", "every", "last_run"): + item.append({k: v, "type": "Text", "data": {"text": v}}) + continue + + if k in ("cache") and len(v) <= 0: + item.append({k: v, "type": "Text", "data": {"text": ""}}) + continue + + if k in ("cache") and len(v) > 0: + files = [] + # loop on each cache item + for cache in v: + file_name = f"{cache['file_name']} [{cache['service_id']}]" if cache["service_id"] else f"{cache['file_name']}" + files.append(file_name) + + item.append( + { + k: " ".join(files), + "type": "Fields", + "data": { + "setting": { + "attrs": { + "data-plugin-id": value.get("plugin_id", ""), + "data-job-name": key, + }, + "id": f"{key}_cache", + "label": f"{key}_cache", + "hideLabel": True, + "inpType": "select", + "name": f"{key}_cache", + "value": "download file", + "values": files, + "columns": { + "pc": 12, + "tablet": 12, + "mobile": 12, + }, + "overflowAttrEl": "data-table-body", + "containerClass": "table download-cache-file", + "maxBtnChars": 12, + "popovers": [ + { + "iconName": "info", + "text": "jobs_download_cache_file", + }, + ], + } + }, + } + ) + continue + + data.append(item) + + return data diff --git a/src/ui/builder/services.py b/src/ui/builder/services.py new file mode 100644 index 000000000..d25726aaf --- /dev/null +++ b/src/ui/builder/services.py @@ -0,0 +1,389 @@ +import base64 +import json +from typing import Union + + +from os.path import join, sep +from sys import path as sys_path + +for deps_path in [join(sep, "usr", "share", "bunkerweb", *paths) for paths in (("deps", "python"), ("utils",), ("api",), ("db",))]: + if deps_path not in sys_path: + sys_path.append(deps_path) + +from builder.utils.widgets import title_widget, table_widget + + +def services_builder(services): + # get method for each service["SERVER_NAME"]["method"] + methods = list(set([service["SERVER_NAME"]["method"] for service in services])) + + services_list = get_services_list(services) + + builder = [ + { + "type": "card", + "containerColumns": {"pc": 12, "tablet": 12, "mobile": 12}, + "widgets": [ + title_widget("services_title"), + { + "type": "Button", + "data": { + "id": "services-new", + "text": "services_new", + "color": "success", + "size": "normal", + "iconName": "plus", + "iconColor": "white", + "modal": services_action(server_name="new", operation="create", title="services_create_title", subtitle="services_create_subtitle"), + "containerClass": "col-span-12 flex justify-center", + }, + }, + table_widget( + positions=[4, 4, 4], + header=[ + "services_table_name", + "services_table_method", + "services_table_actions", + ], + items=services_list, + filters=[ + { + "filter": "table", + "filterName": "keyword", + "type": "keyword", + "value": "", + "keys": ["name"], + "field": { + "id": "services-keyword", + "value": "", + "type": "text", + "name": "services-keyword", + "label": "services_search", + "placeholder": "inp_keyword", + "isClipboard": False, + "popovers": [ + { + "text": "services_search_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + { + "filter": "table", + "filterName": "method", + "type": "select", + "value": "all", + "keys": ["method"], + "field": { + "id": "services-methods", + "value": "all", + "values": methods, + "name": "services-methods", + "onlyDown": True, + "label": "services_methods", + "popovers": [ + { + "text": "services_methods_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + { + "filter": "table", + "filterName": "draft", + "type": "select", + "value": "all", + "keys": ["draft"], + "field": { + "id": "services-draft", + "value": "all", + "values": ["all", "online", "draft"], + "name": "services-draft", + "onlyDown": True, + "label": "services_draft", + "popovers": [ + { + "text": "services_draft_desc", + "iconName": "info", + }, + ], + "columns": {"pc": 3, "tablet": 4, "mobile": 12}, + }, + }, + ], + minWidth="md", + title="services_table_title", + ), + ], + }, + ] + + return base64.b64encode(bytes(json.dumps(builder), "utf-8")).decode("ascii") + + +def services_settings(settings: dict) -> dict: + # deep copy settings dict + settings = settings.copy() + # remove "SERVER_NAME" and "IS_DRAFT" key + settings.pop("SERVER_NAME", None) + settings.pop("IS_DRAFT", None) + # Create table with settings remaining keys + settings_table_items = [] + for key, value in settings.items(): + format_key = key.replace("USE_", "").replace("_", " ") + settings_table_items.append( + [ + { + "type": "Text", + "data": {"text": format_key}, + }, + { + "type": "Icons", + "data": { + "iconName": "check" if value.get("value") == "yes" else "cross", + }, + }, + ] + ) + + table = table_widget( + positions=[8, 4], + header=["services_settings_table_name", "services_settings_table_status"], + items=settings_table_items, + filters=[], + minWidth="", + title="services_settings_table_title", + ) + + return table + + +def services_action( + server_name: str = "", + operation: str = "", + title: str = "", + subtitle: str = "", + additionnal: str = "", + is_draft: Union[bool, None] = None, + service: dict = None, +) -> dict: + + buttons = [ + { + "id": f"close-service-btn-{server_name}", + "text": "action_close", + "disabled": False, + "color": "close", + "size": "normal", + "attrs": {"data-close-modal": ""}, + }, + ] + + if operation == "delete": + buttons.append( + { + "id": f"{operation}-service-btn-{server_name}", + "text": f"action_{operation}", + "disabled": False, + "color": "delete", + "size": "normal", + "attrs": { + "data-submit-form": f"""{{"SERVER_NAME" : {server_name}, "operation" : "{operation}" }}""", + }, + }, + ) + + if operation == "draft": + draft_value = "yes" if is_draft else "no" + buttons.append( + { + "id": f"{operation}-service-btn-{server_name}", + "text": "action_switch", + "disabled": False, + "color": "success", + "size": "normal", + "attrs": { + "data-submit-form": f"""{{"SERVER_NAME" : {server_name}, "OLD_SERVER_NAME" : {server_name}, "operation" : "edit", "IS_DRAFT" : {draft_value} }}""", + }, + }, + ) + + content = [ + { + "type": "Title", + "data": { + "title": title, + }, + }, + ] + + if subtitle: + content.append( + { + "type": "Text", + "data": { + "text": subtitle, + }, + }, + ) + + if additionnal: + content.append( + { + "type": "Text", + "data": { + "bold": True, + "text": additionnal, + }, + } + ) + + if operation == "plugins": + settings = services_settings(service) + content.append(settings) + + if operation == "delete": + content.append( + { + "type": "Text", + "data": { + "text": "", + "bold": True, + "text": server_name, + }, + } + ) + + if operation == "edit" or operation == "create": + modes = ("easy", "advanced", "raw") + mode_buttons = [] + for mode in modes: + mode_buttons.append( + { + "id": f"{operation}-service-btn-{server_name}", + "text": f"services_mode_{mode}", + "disabled": False, + "color": "info", + "size": "normal", + "attrs": { + "role": "link", + "data-link": f"services/{mode}/{server_name}", + }, + }, + ) + + content.append( + { + "type": "ButtonGroup", + "data": {"buttons": mode_buttons}, + } + ) + + content.append( + { + "type": "ButtonGroup", + "data": {"buttons": buttons}, + }, + ) + + modal = { + "widgets": content, + } + + return modal + + +def get_services_list(services): + data = [] + for index, service in enumerate(services): + server_name = service["SERVER_NAME"]["value"] + server_method = service["SERVER_NAME"]["method"] + is_draft = True if service["IS_DRAFT"]["value"] == "yes" else False + is_deletable = False if server_method in ("autoconf", "scheduler") else True + + item = [] + # Get name + item.append({"name": server_name, "type": "Text", "data": {"text": server_name}}) + item.append({"method": server_method, "type": "Text", "data": {"text": server_method}}) + item.append( + { + "type": "ButtonGroup", + "data": { + "buttons": [ + { + "id": f"open-modal-plugins-{index}", + "text": "plugins", + "hideText": True, + "color": "success", + "size": "normal", + "iconName": "eye", + "iconColor": "white", + "modal": services_action( + server_name=server_name, + operation="plugins", + title="services_plugins_title", + subtitle="", + service=service, + ), + }, + { + "attrs": {"data-server-name": server_name}, + "id": f"open-modal-manage-{index}", + "text": "manage", + "hideText": True, + "color": "edit", + "size": "normal", + "iconName": "pen", + "iconColor": "white", + "modal": services_action( + server_name=server_name, + operation="edit", + title="services_edit_title", + subtitle="services_edit_subtitle", + additionnal=server_name, + ), + }, + { + "attrs": {"data-server-name": server_name, "data-is-draft": "yes" if is_draft else "no"}, + "id": f"open-modal-draft-{index}", + "text": "draft" if is_draft else "online", + "hideText": True, + "color": "blue", + "size": "normal", + "iconName": "document" if is_draft else "globe", + "iconColor": "white", + "modal": services_action( + server_name=server_name, + operation="draft", + title="services_draft_title", + subtitle="services_draft_subtitle" if is_draft else "services_online_subtitle", + additionnal="services_draft_switch_subtitle" if is_draft else "services_online_switch_subtitle", + is_draft=is_draft, + ), + }, + { + "attrs": {"data-server-name": server_name}, + "id": f"open-modal-delete-{index}", + "text": "delete", + "disabled": not is_deletable, + "hideText": True, + "color": "red", + "size": "normal", + "iconName": "trash", + "iconColor": "white", + "modal": services_action( + server_name=server_name, operation="delete", title="services_delete_title", subtitle="services_delete_subtitle" + ), + }, + ] + }, + } + ) + + data.append(item) + + return data diff --git a/src/ui/builder/utils/form.py b/src/ui/builder/utils/form.py new file mode 100644 index 000000000..ee36ee0bb --- /dev/null +++ b/src/ui/builder/utils/form.py @@ -0,0 +1,412 @@ +import copy +from typing import Union + + +def get_forms(templates: list = [], plugins: list = [], settings: dict = {}, render_forms: tuple = ("advanced", "easy", "raw")) -> dict: + """ + Will generate every needed form using templates, plugins and settings. + We will run on each plugins, set template value if one, and override by the custom settings value if exists. + We will format to fit each form type (easy, advanced, raw) in case + """ + forms = {} + for form in render_forms: + forms[form] = {} + + for template in templates: + if "advanced" in forms: + forms["advanced"][template.get("name")] = set_advanced(template, plugins, settings) + + if "raw" in forms: + forms["raw"][template.get("name")] = set_raw(template, plugins, settings) + + if "easy" in forms: + forms["easy"][template.get("name")] = set_easy(template, plugins, settings) + + return forms + + +def set_easy(template: list, plugins_base: list, settings: dict) -> dict: + """ + Prepare the easy form based on the template and plugins data. + We need to loop on each steps and prepare settings and configs for each step. + """ + template_settings = template.get("settings") + plugins = copy.deepcopy(plugins_base) + steps = template.get("steps") + + for step in steps: + step_settings = step.get("settings", {}) + # Loop on step settings to set the settings value + loop_id = 0 + step_settings_output = {} + for setting in step_settings: + loop_id += 1 + # Get relate setting from plugins using setting name + plugin = next( + (plugin for plugin in plugins if setting in plugin.get("settings")), + None, + ) + + if not plugin: + continue + + if not plugin.get("settings").get(setting): + continue + + plugin_setting = copy.deepcopy(plugin.get("settings").get(setting)) + + plugin_setting = format_setting( + setting, + plugin_setting, + len(step_settings), + loop_id, + template_settings, + settings, + ) + + step_settings_output[setting] = plugin_setting + + step["settings"] = step_settings_output + + return steps + + +def set_raw(template: list, plugins_base: list, settings: dict) -> dict: + """ + Set the raw form based on the template and plugins data. + It consists of keeping only the value or default value for each plugin settings. + """ + template_settings = template.get("settings") + raw_settings = {} + # Copy of the plugins base + plugins = copy.deepcopy(plugins_base) + # Update settings with global config data + for plugin in plugins: + for setting, value in plugin.get("settings").items(): + # avoid some methods from services_settings + if setting in settings and settings[setting].get("method", "ui") not in ("ui", "default", "manual"): + continue + + raw_value = None + + # Start by setting template value if exists + if setting in template_settings: + # Update value or set default as value + raw_value = template_settings.get(setting, value.get("default")) + + # Then override by service settings + if setting in settings: + # Check if the service setting is not default value to add it + default_val = value.get("default") + val = settings[setting].get("value", value.get("value", value.get("default"))) + if val != default_val: + raw_value = val + + # Add value only if exists + if raw_value: + raw_settings[setting] = raw_value + + return raw_settings + + +def set_advanced(template: list, plugins_base: list, settings: dict) -> dict: + """ + Set the advanced form based on the template and plugins data. + It consists of formatting each plugin settings to be used in the advanced form. + """ + template_settings = template.get("settings") + # Copy of the plugins base data + plugins = copy.deepcopy(plugins_base) + # Update settings with global config data + for plugin in plugins: + loop_id = 0 + total_settings = len(plugin.get("settings")) + for setting, value in plugin.get("settings").items(): + loop_id += 1 + value = format_setting( + setting, + value, + total_settings, + loop_id, + template_settings, + settings, + ) + + set_multiples(template, plugins, settings) + + return plugins + + +def get_multiple_from_template(template, multiples): + """ + We are gonna loop on each plugins multiples group, in case a setting is matching a template setting, + we will create a group using the prefix as key (or "0" if no prefix) with default settings at first. + Then we will override by the template value in case there is one. + This will return something of this type : + {'0' : {'setting' : value, 'setting2': value2}, '1' : {'setting_1': value, 'setting2_1': value}} } + """ + # Loop on each plugin and loop on multiples key + # Check if the name us matching a template key + multiple_plugin = copy.deepcopy(multiples) + + multiple_template = {} + for setting, value in template.get("settings").items(): + # Sanitize setting name to remove prefix of type _1 if exists + # Slipt by _ and check if last element is a digit + format_setting = setting + setting_split = setting.split("_") + prefix = "0" + if setting_split[-1].isdigit(): + prefix = setting_split[-1] + format_setting = "_".join(setting_split[:-1]) + # loop on settings of a multiple group + for mult_name, mult_settings in multiple_plugin.items(): + + # Check if at least one settign is matching a multiple setting + if not format_setting in mult_settings: + continue + + # Case we have at least one multiple setting, we can check if multiple name exists or create it + if not mult_name in multiple_template: + multiple_template[mult_name] = {} + + # Case it is, we will check if already a group with the right prefix exists + # If not, we will create it + if not prefix in multiple_template[mult_name]: + # We want each settings to have the prefix if exists + # We will get the value of the setting without the prefix and create a prefix key with the same value + # And after that we can delete the original setting + new_multiple_group = {} + for multSett, multValue in mult_settings.items(): + new_multiple_group[f"{multSett}{f'_{prefix}' if prefix != '0' else ''}"] = multValue + + new_multiple_group = copy.deepcopy(new_multiple_group) + + # Update id for each settings + for multSett, multValue in new_multiple_group.items(): + multValue["id"] = f"{multValue['id']}{f'-{prefix}' if prefix != '0' else ''}" + + multiple_template[mult_name][prefix] = new_multiple_group + + # We can now add the template value to setting using the same setting name with prefix + multiple_template[mult_name][prefix][setting]["value"] = value + multiple_template[mult_name][prefix][setting]["prev_value"] = value + multiple_template[mult_name][prefix][setting]["method"] = "default" + + # Sort key incrementally + for mult_name, mult_settings in multiple_template.items(): + multiple_template[mult_name] = dict(sorted(mult_settings.items(), key=lambda item: int(item[0]))) + return multiple_template + + +def get_multiple_from_settings(settings, multiples): + """ + We are gonna loop on each plugins multiples group, in case a setting is matching a service / global config setting, + we will create a group using the prefix as key (or "0" if no prefix) with default settings at first. + Then we will override by the service / global config value in case there is one. + This will return something of this type : + {'0' : {'setting' : value, 'setting2': value2}, '1' : {'setting_1': value, 'setting2_1': value}} } + """ + + # Loop on each plugin and loop on multiples key + # Check if the name us matching a template key + multiple_plugins = copy.deepcopy(multiples) + + multiple_settings = {} + for setting, value in settings.items(): + # Sanitize setting name to remove prefix of type _1 if exists + # Slipt by _ and check if last element is a digit + format_setting = setting + setting_split = setting.split("_") + prefix = "0" + if setting_split[-1].isdigit(): + prefix = setting_split[-1] + format_setting = "_".join(setting_split[:-1]) + + # loop on settings of a multiple group + for mult_name, mult_settings in multiple_plugins.items(): + + # Check if at least one settign is matching a multiple setting + if not format_setting in mult_settings: + continue + + # Case we have at least one multiple setting, we can check if multiple name exists or create it + if not mult_name in multiple_settings: + multiple_settings[mult_name] = {} + # Now check if prefix exist for this mult + if not prefix in multiple_settings[mult_name]: + # We want each settings to have the prefix if exists + # We will get the value of the setting without the prefix and create a prefix key with the same value + # And after that we can delete the original setting + new_multiple_group = {} + for multSett, multValue in mult_settings.items(): + new_multiple_group[f"{multSett}{f'_{prefix}' if prefix != '0' else ''}"] = multValue + + new_multiple_group = copy.deepcopy(new_multiple_group) + + # Update id for each settings + for multSett, multValue in new_multiple_group.items(): + multValue["id"] = f"{multValue['id']}{f'-{prefix}' if prefix != '0' else ''}" + + multiple_settings[mult_name][prefix] = new_multiple_group + + # Update multiple template with real data + multiple_settings[mult_name][prefix][setting]["value"] = value.get("value", multiple_settings[mult_name][prefix][setting]["value"]) + multiple_settings[mult_name][prefix][setting]["prev_value"] = value.get("value", multiple_settings[mult_name][prefix][setting]["value"]) + multiple_settings[mult_name][prefix][setting]["method"] = value.get("method", "ui") + multiple_settings[mult_name][prefix][setting]["disabled"] = False if value.get("method", "ui") in ("ui", "default", "manual") else True + + # Add popovers if setting is disabled else stop + if not multiple_settings[mult_name][prefix][setting].get("disabled", False): + continue + + multiple_settings[mult_name][prefix][setting]["popovers"] = [ + { + "iconName": "trespass", + "text": "inp_popover_method_disabled", + } + ] + multiple_settings[ + mult_name + ][prefix][setting].get("popovers", []) + + return multiple_settings + + +def set_multiples(template, format_plugins, settings): + """ + Set the multiples settings for each plugin. + """ + # copy of format plugins + for plugin in format_plugins: + # Get multiples + multiples = {} + settings_to_delete = [] + total_settings = len(plugin.get("settings")) + zindex = 0 + for setting, value in plugin.get("settings").items(): + + if not value.get("multiple"): + continue + + zindex += 1 + + value["containerClass"] = f"z-{total_settings - zindex}" + + mult_name = value.get("multiple") + # Get the multiple value and set it as key if not in multiples dict + if mult_name not in multiples: + multiples[mult_name] = {} + + multiples[mult_name][setting] = value + settings_to_delete.append(setting) + + # Delete multiple settings from regular settings + for setting in settings_to_delete: + del plugin["settings"][setting] + + if len(multiples): + # Add multiple schema with default values to plugin + plugin["multiples_schema"] = multiples + # Now that we have for each plugin the multiples settings, we need to do the following + # Get all settings from template that are multiples + template_multiples = get_multiple_from_template(template, multiples) + # Get all settings from service settings / global config that are multiples + service_multiples = get_multiple_from_settings(settings, multiples) + # Get service multiples if at least one, else use template multiples + plugin["multiples"] = service_multiples if len(service_multiples) else template_multiples + + return format_plugins + + +def format_setting( + setting_name: str, + setting_value: Union[str, int], + total_settings: Union[str, int], + loop_id: Union[str, int], + template_settings: dict, + settings: dict, +) -> dict: + """ + Format a setting in order to be used with form builder. + This will only set value for none multiple settings. + Additionnel set_multiples function will handle multiple settings. + """ + # add zindex for field in case not a multiple + # Case multiple, this will be set on the group level + if not "multiple" in setting_value: + setting_value["containerClass"] = f"z-{total_settings - loop_id}" + + # regex by pattern + setting_value["pattern"] = setting_value.get("regex", "") + + # set inpType based on type define for each settings + inpType = ( + "checkbox" + if setting_value.get("type") == "check" + else ("select" if setting_value.get("type") == "select" else "datepicker" if setting_value.get("type") == "date" else "input") + ) + setting_value["inpType"] = inpType + + # set name using the label + setting_value["name"] = setting_value.get("label") + + # case select + if inpType == "select": + # replace "select" key by "values" + setting_value["values"] = setting_value.pop("select") + + # add columns + setting_value["columns"] = {"pc": 4, "tablet": 6, "mobile": 12} + + # By default, the input is enabled unless specific method + setting_value["disabled"] = False + + setting_value["value"] = setting_value.get("default") + + # Start by setting template value if exists + if setting_name in template_settings and not "multiple" in setting_value: + # Update value or set default as value + setting_value["value"] = template_settings.get(setting_name, setting_value.get("default")) + + # Then override by service settings if not a multiple + # Case multiple, we need to keep the default value and override only each multiple group + if setting_name in settings and not "multiple" in setting_value: + setting_value["value"] = settings[setting_name].get("value", setting_value.get("value", setting_value.get("default"))) + setting_value["method"] = settings[setting_name].get("method", "ui") + + # Add prev_value in order to check if value has changed to submit it + setting_value["prev_value"] = setting_value.get("value") + + # Then override by service settings + if setting_name in settings: + setting_value["disabled"] = False if settings[setting_name].get("method", "ui") in ("ui", "default", "manual") else True + + # Prepare popover checking "help", "context" + popovers = [] + + if (setting_value.get("disabled", False)) and settings[setting_name].get("method", "ui") not in ("ui", "default", "manual"): + popovers.append( + { + "iconName": "trespass", + "text": "inp_popover_method_disabled", + } + ) + + if setting_value.get("context"): + popovers.append( + { + "iconName": ("disk" if setting_value.get("context") == "multisite" else "globe"), + "text": ("inp_popover_multisite" if setting_value.get("context") == "multisite" else "inp_popover_global"), + } + ) + + if setting_value.get("help"): + popovers.append( + { + "iconName": "info", + "text": setting_value.get("help"), + } + ) + + setting_value["popovers"] = popovers + return setting_value diff --git a/src/ui/widgets.py b/src/ui/builder/utils/widgets.py similarity index 97% rename from src/ui/widgets.py rename to src/ui/builder/utils/widgets.py index 5ac7ba74f..871a72a20 100644 --- a/src/ui/widgets.py +++ b/src/ui/builder/utils/widgets.py @@ -1,6 +1,3 @@ -import base64 -import json -import copy from typing import Union diff --git a/src/ui/client/build.py b/src/ui/client/build.py index 3239bb179..f10730a8c 100644 --- a/src/ui/client/build.py +++ b/src/ui/client/build.py @@ -105,13 +105,14 @@ def move_template(folder: Path, target_folder: Path): return replace for file in folder.rglob("index.html"): + file_html = base_html if "global-config" in file.parts or "jobs" in file.parts or "services" in file.parts: - base_html = base_html.replace("data_server_builder[1:-1]", "data_server_builder") + file_html = base_html.replace("data_server_builder[1:-1]", "data_server_builder") content = file.read_text() content = sub(r'(href|src)="\/(css|js|img|favicon|assets|js)\/[^<]*?(?=<|\/>)', format_template, content) # get the content before - content = content[: content.index("")] + base_html + content = content[: content.index("")] + file_html # write the new content file.write_text(content) diff --git a/src/ui/client/dashboard/components/Builder/Raw.vue b/src/ui/client/dashboard/components/Builder/Raw.vue new file mode 100644 index 000000000..022b19881 --- /dev/null +++ b/src/ui/client/dashboard/components/Builder/Raw.vue @@ -0,0 +1,76 @@ + + +