Elgato_dark/bunkerweb
1
0
Fork 0
mirror of https://github.com/bunkerity/bunkerweb synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

enhance bans format

Browse source
This commit is contained in:
Jordan Blasenhauer 2024-08-12 13:24:40 +02:00
parent a9ea59c74c
commit 52c5c89d15
4 changed files with 307 additions and 238 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

238
src/ui/client/builder/bans2.py
View file

@ -1,234 +1,36 @@
import json
import base64
# TODO : REMOVE operation by custom endpoint
from builder.bans2 import bans_builder
from builder.utils.widgets import button, button_group, title, text, tabulator, fields, upload, datepicker, input, select
bans_columns = [
{"title": "IP", "field": "ip", "formatter": "text"},
{"title": "Reason", "field": "reason", "formatter": "text"},
{"title": "Ban start date", "field": "ban_start_date", "formatter": "fields"},
{"title": "Ban end date", "field": "ban_end_date", "formatter": "fields"},
{"title": "Remain", "field": "remain", "formatter": "text"},
]
bans_filters = [
bans = [
{
"type": "like",
"fields": ["ip"],
"setting": {
"id": "input-search-ip",
"name": "input-search-ip",
"label": "bans_search_ip", # keep it (a18n)
"value": "",
"inpType": "input",
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
"ip": "127.0.0.1",
"reason": "antibot",
"ban_start_date": "",
"ban_end_date": "",
"remain": "hour(s)",
},
{
"type": "=",
"fields": ["reason"],
"setting": {
"id": "select-ban-reason",
"name": "select-ban-reason",
"label": "bans_select_reason", # keep it (a18n)
"value": "all", # keep "all"
"values": ["all", "antibot"], # keep "all" and add your reasons dynamically
"inpType": "select",
"onlyDown": True,
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
"ip": "127.0.0.1",
"reason": "test",
"ban_start_date": "",
"ban_end_date": "",
"remain": "day(s)",
},
{
"type": "=",
"fields": ["remain"],
"setting": {
"id": "select-ban-remain",
"name": "select-ban-remain",
"label": "bans_select_remain", # keep it (a18n)
"value": "all", # keep "all"
"values": ["all", "hour(s)" "day(s)", "week(s)", "month(s)", "year(s)"], # keep everything and format bans to fit in one remain category
"inpType": "select",
"onlyDown": True,
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
"ip": "127.0.0.1",
"reason": "antibot",
"ban_start_date": "",
"ban_end_date": "",
"remain": "hour(s)",
},
]
bans_items = [
{
"ip": text(text="ban_ip")["data"], # replace ban_ip by real ip
"reason": text(text="Reason")["data"], # replace Reason by real reason
"ban_start_date": datepicker(
id="datepicker-ban-start-id", # replace id by value to use on a form
name="datepicker-ban-start-id", # replace by value to use on a form
label="bans_ban_start_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value="ban_start_date", # replace ban_start_date by timestamp value
disabled=True, # Readonly
columns={"pc": 12, "tablet": 12, " mobile": 12},
)["data"],
"ban_end_date": datepicker(
id="datepicker-ban-end-id", # replace id by value to use on a form
name="datepicker-ban-end-id", # replace by value to use on a form
label="bans_ban_end_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value="ban_end_date", # replace ban_end_date by timestamp value
disabled=True, # Readonly
)["data"],
"remain": text(text="Remain")["data"], # replace Remain by one of the remain categories ["hour(s)" "day(s)", "week(s)", "month(s)", "year(s)"]
},
]
reasons = ["all", "antibot", "test"]
remains = ["all", "hour(s)", "day(s)"]
bans_add_columns = [
{"title": "ip", "field": "ip", "formatter": "fields"}, # input
{"title": "Ban end", "field": "ban_end", "formatter": "fields"},
]
# add one default ban
bans_add_items = [
{
"id": 1,
"ip": datepicker(
id="datepicker-add-ban-ip-1",
name="datepicker-add-ban-ip-1",
label="bans_add_ban_ip", # keep it (a18n)
hideLabel=True,
value="",
type="text",
pattern="", # replace by ip pattern
inputType="input",
columns={"pc": 12, "tablet": 12, " mobile": 12},
)["data"],
"ban_end": datepicker(
id="datepicker-add-ban-end-1",
name="datepicker-add-ban-end-1",
label="bans_add_end_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value="ban_end_date", # replace ban_end_date by default timestamp value (one week ?)
)["data"],
# Need to create a script on Page.vue level to retrive table data and remove by id
"delete": button_group(
buttons=[
button(
id="delete-ban-1",
type="button",
text="action_delete", # keep it (a18n)
hideLabel=True,
iconName="trash",
iconColor="white",
color="error",
size="normal",
attrs={"data-delete-row": "1"}, # we will use this attrs to remove the row
),
]
),
}
]
bans_add_table_actions = button_group(
buttons=[
# Need to create a script on Page.vue level to add a row on click
# + We need to retrieve from the first item a schema to add any new row
button(
id="add-bans-entry-btn",
type="button",
text="action_entry", # keep it (a18n)
color="success",
iconColor="white",
iconName="plus",
size="normal",
attrs={"data-add-row": ""}, # we will use this attrs to add a new row
),
# Need to create a script on Page.vue level to delete all rows
button(
id="add-bans-delete-all-btn",
type="button",
text="action_delete_all", # keep it (a18n)
color="error",
iconColor="white",
iconName="trash",
size="normal",
attrs={"data-delete-all": ""}, # we will use this attrs to add a new row
),
]
)
builder = [
{
"type": "card",
"display": ["main", 1],
"widgets": [
tabulator(
id="table-bans-list",
columns=bans_columns,
items=bans_items,
filters=bans_filters,
),
# Need to create a script on Page.vue level to handle the unban form submission
# Need to retrieve table data, format it to send to the server
# We need to execute only when modal confirm is click (id="unban-btn-confirm")
button(
id="unban-btn",
type="button",
text="action_unban", # keep it (a18n)
color="success",
size="normal",
modal={
"widgets": [
title(title="bans_unban_title"), # keep it (a18n)
text(text="bans_unban_subtitle"), # keep it (a18n)
button_group(
buttons=[
button(
id="close-unban-btn",
text="action_close", # keep it (a18n)
color="close",
size="normal",
attrs={"data-close-modal": ""}, # a11y
)["data"],
button(
id="unban-btn-confirm",
text="action_unban", # keep it (a18n)
color="success",
size="normal",
)["data"],
]
),
],
},
),
],
},
{
"type": "card",
"display": ["main", 2],
"widgets": [
bans_add_table_actions,
tabulator(
id="table-register-plugins",
columns=bans_add_columns,
items=bans_add_items,
),
# Need to create a script on Page.vue level to handle the form submission
# Need to retrieve table data, format it to send to the server
button(
id="add-bans-btn",
type="button",
text="action_add_bans", # keep it (a18n)
color="success",
size="normal",
),
],
},
]
builder = bans_builder(bans, reasons, remains)
with open("bans2.json", "w") as f:

272
src/ui/client/builder/pages/bans2.py Normal file
View file

@ -0,0 +1,272 @@
import json
import base64
from builder.utils.widgets import button, button_group, title, text, tabulator, datepicker
from builder.utils.table import add_column
bans_columns = [
{"title": "IP", "field": "ip", "formatter": "text"},
{"title": "Reason", "field": "reason", "formatter": "text"},
{"title": "Ban start date", "field": "ban_start_date", "formatter": "fields"},
{"title": "Ban end date", "field": "ban_end_date", "formatter": "fields"},
{"title": "Remain", "field": "remain", "formatter": "text"},
]
def bans_filters(reasons: list = ["all"], remains: list = ["all"]) -> list:
filters = [
{
"type": "like",
"fields": ["ip"],
"setting": {
"id": "input-search-ip",
"name": "input-search-ip",
"label": "bans_search_ip", # keep it (a18n)
"value": "",
"inpType": "input",
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
},
]
# Case "all" ans
if len(reasons) >= 3:
filters.append(
{
"type": "=",
"fields": ["reason"],
"setting": {
"id": "select-ban-reason",
"name": "select-ban-reason",
"label": "bans_select_reason", # keep it (a18n)
"value": "all", # keep "all"
"values": reasons, # keep "all" and add your reasons dynamically
"inpType": "select",
"onlyDown": True,
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
},
)
if len(reasons) >= 3:
filters.append(
{
"type": "=",
"fields": ["remain"],
"setting": {
"id": "select-ban-remain",
"name": "select-ban-remain",
"label": "bans_select_remain", # keep it (a18n)
"value": "all", # keep "all"
"values": remains, # keep everything and format bans to fit in one remain category
"inpType": "select",
"onlyDown": True,
"columns": {"pc": 3, "tablet": 4, " mobile": 12},
},
},
)
return filters
def ban_item(id: str, ip: str, reason: str, ban_start_date: int, ban_end_date: int, remain: str) -> dict:
return (
{
"ip": text(text=ip)["data"],
"reason": text(text=reason)["data"],
"ban_start_date": datepicker(
id=f"datepicker-ban-start-{id}",
name=f"datepicker-ban-start-{id}",
label="bans_ban_start_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value=ban_start_date,
disabled=True, # Readonly
columns={"pc": 12, "tablet": 12, " mobile": 12},
)["data"],
"ban_end_date": datepicker(
id=f"datepicker-ban-end-{id}",
name=f"datepicker-ban-end-{id}",
label="bans_ban_end_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value=ban_end_date,
disabled=True, # Readonly
)["data"],
"remain": text(text=remain)["data"],
},
)
def bans_items(items: list) -> list:
items = []
for item in items:
items.append(
ban_item(
id=item.get("id"),
ip=item.get("ip"),
reason=item.get("reason"),
ban_start_date=item.get("ban_start_date"),
ban_end_date=item.get("ban_end_date"),
remain=item.get("remain"),
)
)
return items
bans_add_columns = [
{"title": "ip", "field": "ip", "formatter": "fields"}, # input
{"title": "Ban end", "field": "ban_end", "formatter": "fields"},
]
default_add_ban = [
{
"id": 1,
"ip": datepicker(
id="datepicker-add-ban-ip-1",
name="datepicker-add-ban-ip-1",
label="bans_add_ban_ip", # keep it (a18n)
hideLabel=True,
value="",
type="text",
pattern="", # replace by ip pattern
inputType="input",
columns={"pc": 12, "tablet": 12, " mobile": 12},
)["data"],
"ban_end": datepicker(
id="datepicker-add-ban-end-1",
name="datepicker-add-ban-end-1",
label="bans_add_end_date", # keep it (a18n)
hideLabel=True,
inputType="datepicker",
value="",
)["data"],
# Need to create a script on Page.vue level to retrive table data and remove by id
"delete": button_group(
buttons=[
button(
id="delete-ban-1",
type="button",
text="action_delete", # keep it (a18n)
hideLabel=True,
iconName="trash",
iconColor="white",
color="error",
size="normal",
attrs={"data-delete-row": "1"}, # we will use this attrs to remove the row
),
]
),
}
]
bans_add_table_actions = button_group(
buttons=[
# Need to create a script on Page.vue level to add a row on click
# + We need to retrieve from the first item a schema to add any new row
button(
id="add-bans-entry-btn",
type="button",
text="action_entry", # keep it (a18n)
color="success",
iconColor="white",
iconName="plus",
size="normal",
attrs={"data-add-row": ""}, # we will use this attrs to add a new row
),
# Need to create a script on Page.vue level to delete all rows
button(
id="add-bans-delete-all-btn",
type="button",
text="action_delete_all", # keep it (a18n)
color="error",
iconColor="white",
iconName="trash",
size="normal",
attrs={"data-delete-all": ""}, # we will use this attrs to add a new row
),
]
)
# Need to create a script on Page.vue level to handle the unban form submission
# Need to retrieve table data, format it to send to the server
# We need to execute only when modal confirm is click (id="unban-btn-confirm")
unban_action = (
button(
id="unban-btn",
type="button",
text="action_unban", # keep it (a18n)
color="success",
size="normal",
modal={
"widgets": [
title(title="bans_unban_title"), # keep it (a18n)
text(text="bans_unban_subtitle"), # keep it (a18n)
button_group(
buttons=[
button(
id="close-unban-btn",
text="action_close", # keep it (a18n)
color="close",
size="normal",
attrs={"data-close-modal": ""}, # a11y
)["data"],
button(
id="unban-btn-confirm",
text="action_unban", # keep it (a18n)
color="success",
size="normal",
)["data"],
]
),
],
},
),
)
# Need to create a script on Page.vue level to handle the form submission
# Need to retrieve table data, format it to send to the serve
add_ban_action = (
button(
id="add-bans-btn",
type="button",
text="action_add_bans", # keep it (a18n)
color="success",
size="normal",
),
)
def bans_builder(bans: list, reasons: list, remains: list) -> list:
return [
{
"type": "card",
"display": ["main", 1],
"widgets": [
tabulator(
id="table-bans-list",
columns=bans_columns,
items=bans_items(bans),
filters=bans_filters(reasons=reasons, remains=remains),
),
unban_action,
],
},
{
"type": "card",
"display": ["main", 2],
"widgets": [
bans_add_table_actions,
tabulator(
id="table-register-plugins",
columns=bans_add_columns,
items=default_add_ban,
),
add_ban_action,
],
},
]

6
src/ui/client/builder/utils/table.py Normal file
View file

@ -0,0 +1,6 @@
def add_column(title, field, formatter=""):
# don"t return formatter if ""
if formatter:
return {"title": title, "field": field, "formatter": formatter}
return {"title": title, "field": field}

29
src/ui/client/widgets_generator.py
View file

@ -1,4 +1,4 @@
from os import cpu_count, getpid
from os import cpu_count
from os.path import abspath
from pathlib import Path
from threading import Semaphore, Thread
@ -73,23 +73,15 @@ def js2md():
def convert_json_to_md(file: Path):
semaphore.acquire()
print(f"Acquiring Semaphore for: {getpid()} (file {file})", flush=True)
try:
# Run the command
output = run_command(["documentation", "build", file.as_posix(), "-f", "md"], with_output=True)
if output == 1:
print("Error while running command", flush=True)
exit(1)
# Create a new file with the same name but with .md extension
file.with_suffix(".md").write_text(output)
except BaseException:
print(format_exc(), flush=True)
print("Error while running documentation", str(file.name), flush=True)
# Run the command
output = run_command(["documentation", "build", file.as_posix(), "-f", "md"], with_output=True)
if output == 1:
print("Error while running command", flush=True)
exit(1)
finally:
print(f"Releasing Semaphore for: {getpid()} (file {file})", flush=True)
semaphore.release()
# Create a new file with the same name but with .md extension
file.with_suffix(".md").write_text(output)
semaphore.release()
threads = []
# Create a markdown file for each JS file
@ -133,9 +125,6 @@ def formatMd():
if line.startswith("#") and ".vue" in line and "\\.vue" in line:
line = line.replace("\\.vue", ".vue")
# Escape the \ character
line = line.replace("\\", "\\\\")
# Case not a param, keep the line as is
if not line.startswith("*"):
line_result.append(line)