Prep admin form for production deployment

Only display Wifi Settings if raspap is installed.
Change_manager is now more standalone and can be run to monitor when settings.txt is last modified.
This commit is contained in:
Ana Custura 2026-03-06 12:26:33 +00:00
parent 0cfd475031
commit 83fd4c4ec5
5 changed files with 106 additions and 69 deletions

View file

@ -1,145 +0,0 @@
import os
import re
from subprocess import run
import json
from app import app
CHANGES_REQUIRING_RESTART = ['wifi_password', 'ssid', 'enable_access_point', 'enable_chat', 'enable_delta_chat', 'butterbox_hostname']
# 'ssh_access_settings', 'root_account_settings']
def lock_root_account():
result = run(["sudo", "passwd", "-l", "root"])
if result.returncode != 0:
return False
return True
def enable_service(service: str):
is_enabled = run(["sudo", "systemctl", "is-enabled", service], capture_output = True, text = True)
if 'disabled' in is_enabled.stdout:
enable = run(["sudo", "systemctl", "enable", service], capture_output = True, text = True)
if enable.returncode != 0:
return False
return True
def disable_service(service: str):
is_enabled = run(["sudo", "systemctl", "is-enabled", service], capture_output = True, text = True)
if 'enabled' in is_enabled.stdout:
result = run(["sudo", "systemctl", "disable", service])
if result.returncode != 0:
return False
return True
def load_setting(setting):
with open("settings.txt", "r") as f:
settings = json.load(f)
return settings[setting]
def change_service_status(setting, service):
if load_setting(setting) == "true":
enable_service(service)
else:
disable_service(service)
def change_keanu_weblite_config(new_hostname):
regex = re.compile('qdt ?= ?"([^"]*)"')
target_file = "/var/www/html/chat/assets/index-CD0QtET8.js"
with open(target_file, "r") as f:
lines = f.readlines()
for line in enumerate(lines):
match = regex.search(line)
if match:
old_hostname = match.group(1)
if old_hostname != new_hostname:
re.sub(old_hostname, new_hostname, lines[line])
def change_line_in_file(target_file: str, regex: str, replacement: str):
print(f"Changing line in file {target_file}")
regex = re.compile(regex)
if not os.path.isfile(target_file):
raise FileNotFoundError(f"File {target_file} does not exist")
else:
with open(target_file, "r") as f:
lines = f.readlines()
print(f"Existing lines are: {lines}")
for i, line in enumerate(lines):
match = re.fullmatch(replacement, line)
if match:
print("Line already exists!")
return
for i, line in enumerate(lines):
match = re.fullmatch(regex, line)
if match:
lines.pop(i)
print(f"Found a match at line {i}, {match.string}")
break
try:
lines.append(replacement)
except NameError:
raise NameError(f"File {target_file} is empty.")
print(f"Lines to be written to file are {lines}")
new_lines = "".join(lines)
with open(target_file, "w") as f:
f.write(new_lines)
def check_settings():
print(f"Checking settings...")
print(f"App config is {app.config['SETTINGS_CHANGED']}")
if app.config['SETTINGS_CHANGED']:
for s in CHANGES_REQUIRING_RESTART:
if s == "wifi_password":
regex_wpa_method = "wpa=.*?\n"
if load_setting("wifi_password") == "":
change_line_in_file("/etc/hostapd/hostapd.conf", regex_wpa_method, f"wpa=none\n")
else:
change_line_in_file("/etc/hostapd/hostapd.conf", regex_wpa_method, f"wpa=3\n")
regex_pass = "wpa_passphrase=.*?\n"
change_line_in_file("/etc/hostapd/hostapd.conf", regex_pass,
f"wpa_passphrase={load_setting("wifi_password")}\n")
if s == "ssid":
regex_ssid = "ssid=.*?\n"
change_line_in_file("/etc/hostapd/hostapd.conf", regex_ssid, f"ssid={load_setting("ssid")}\n")
if s == "enable_chat":
change_service_status("enable_chat", "dendrite")
if s == "enable_access_point":
change_service_status("enable_access_point", "raspapd")
if s == "enable_delta_chat":
change_service_status("enable_delta_chat", "madmail")
if s == "butterbox_hostname":
pass
# change in butterbox-dendrite.conf
regex_matrix_server = "server_name:.*?.lan\n"
change_line_in_file("../dendrite/butterbox-dendrite.conf", regex_matrix_server,
f"server_name: {load_setting("butterbox_hostname")}.lan\n")
# change in butterbox-dnsmasq.conf
regex_dns = "address=/.*?.lan/10.3.141.1\n"
change_line_in_file("/etc/dnsmasq.d/butterbox-dnsmasq.conf", regex_dns,
f"address=/{load_setting("butterbox_hostname")}.lan/10.3.141.1\n")
# change in keanu-weblite compiled assets
change_keanu_weblite_config(load_setting("butterbox_hostname"))
if s == "ssh_access_settings":
change_service_status("ssh_enabled", "ssh")
if load_setting("ssh_access_settings") == "enable_ssh_with_password":
regex_password_auth = "PasswordAuthentication.*?\n"
change_line_in_file("test/sshd/sshd.conf", regex_password_auth,
f"PasswordAuthentication yes\n")
regex_root_login = "PermitRootLogin.*?\n"
change_line_in_file("test/sshd/sshd.conf", regex_root_login,
f"PermitRootLogin yes\n")
elif load_setting("ssh_access_settings") == "enable_ssh_with_public_key":
regex_password_auth = "PasswordAuthentication.*?\n"
change_line_in_file("test/sshd/sshd.conf", regex_password_auth,
f"PasswordAuthentication no\n")
regex_root_login = "PermitRootLogin.*?\n"
change_line_in_file("test/sshd/sshd.conf", regex_root_login,
f"PermitRootLogin prohibit-password\n")
# append here new key!!!
if s == "root_account_settings":
if load_setting("root_account_settings") == "lock_root_account":
lock_root_account()
else:
pass

View file

@ -1,5 +1,5 @@
from app import app
from flask import render_template, flash, redirect, url_for, request, session, send_file
from flask import render_template, flash, redirect, url_for, send_file
from app.forms import LoginForm, SettingsForm
from flask_login import login_user, current_user, logout_user, login_required
import sqlalchemy as sa
@ -16,7 +16,7 @@ import string
import glob
import time
import qrcode
from app.change_manager import CHANGES_REQUIRING_RESTART, check_settings
from app.change_manager import CHANGES_REQUIRING_RESTART
def gen_username() -> str:
words = top_n_list("en", 5000)
@ -155,6 +155,7 @@ def logout():
@app.route('/admin', methods=['GET', 'POST'])
@login_required
def admin():
raspap_installed = os.path.exists("/var/www/html/raspap")
form = SettingsForm()
populate_settings = ['butterbox_name', 'wifi_password', 'ssid', 'butterbox_hostname', 'root_account_settings', 'ssh_access_settings']
bool_settings = ['enable_access_point','enable_file_viewer', 'enable_map_viewer', 'enable_app_store', 'enable_chat', 'enable_deltachat', 'enable_wifi_sharing']
@ -214,10 +215,9 @@ def admin():
if form.apply_changes.data:
set_setting('apply_changes', "true")
dump_settings("settings.txt")
check_settings()
flash(_("⚠️ Changes applied! Please wait for the box to restart."))
return render_template('admin.html', get_setting=get_setting, form=form)
return render_template('admin.html', raspap_installed=raspap_installed, get_setting=get_setting, form=form)
@app.route('/messaging', methods=['GET', 'POST'])

View file

@ -4,7 +4,9 @@
.butter-title {
text-align: center;
}
.butter-form-margin {
margin-right: 10px;
}
.butter-service {
border-radius: 20px;
}

View file

@ -16,61 +16,90 @@
{{ form.apply_changes(class="button is-warning") }}
{% endif %}
</div>
<div class="field">
{{ wtf.form_input_field(form.ssid, form.ssid.errors) }}
<p class="help"> This is the name of the advertised Wi-Fi network. Current SSID: {{ get_setting('ssid') }}</p>
<label class="label is-large">Services</label>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_map_viewer) }}
<p class="help butter-form-margin">Whether map services are enabled.</p>
</div>
<div class="password">
{{ wtf.form_input_field(form.wifi_password, form.wifi_password.errors) }}
<p class="help"> This is the secret key needed to connect to the Wi-Fi network. By default, this is not set and everyone can join.
Current password: {{ get_setting('wifi_password') or 'Not set' }}</p>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_chat) }}
<p class="help butter-form-margin">Whether Matrix chat services are enabled.</p>
</div>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_deltachat) }}
<p class="help butter-form-margin">Whether messaging using DeltaChat is enabled.</p>
</div>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_file_viewer) }}
<p class="help butter-form-margin">Whether files services via USB are enabled.</p>
</div>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_app_store) }}
<p class="help">Whether app store services are enabled.</p>
</div>
<hr>
<label class="label is-large">Branding and name</label>
<div class="field">
{{ wtf.form_input_field(form.butterbox_name, form.butterbox_name.errors) }}
<p class="help">This is the name shown in the UI.
Current name: {{ get_setting('butterbox_name') }}, accessed at {{ get_setting('butterbox_name') }}.local.</p>
</div>
<div class="field">
{{ wtf.form_input_field(form.butterbox_hostname, form.butterbox_hostname.errors) }}
<p class="help">This is used to access the box locally by adding .local or .lan in your browser.
<p class="help">This is the URL used to access the box by adding .local in your browser.
Current hostname: {{ get_setting('butterbox_hostname') }}.local.</p>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_access_point) }}
<p class="help">Whether this box will advertise a Wi-Fi network.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_wifi_sharing) }}
<p class="help">Whether a share button for the Wi-Fi network is available.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_map_viewer) }}
<p class="help">Whether map services are enabled.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_chat) }}
<p class="help">Whether chat services are enabled.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_deltachat) }}
<p class="help">Whether secure messaging using DeltaChat is enabled.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_file_viewer) }}
<p class="help">Whether files services via USB are enabled.</p>
</div>
<div class="checkbox">
{{ wtf.form_bool_field(form.enable_app_store) }}
<p class="help">Whether app store services are enabled.</p>
</div>
<div class="field">
<label class="label">{{ form.butterbox_logo.label }} </label>
<div class="control block">{{ form.butterbox_logo(class='label', style="width: 280px") }}</div>
{{ wtf.field_errors(form.butterbox_logo.errors) }}
<div class="block"><p class="help">This is the logo shown in the UI. Current logo:</p></div>
<img src="{{ get_setting('butterbox_logo') }}" style="height: 50px">
</div>
<hr>
<label class="label is-large">Wi-Fi and access point</label>
{% if raspap_installed %}
<div class="field">
{{ wtf.form_input_field(form.ssid, form.ssid.errors) }}
<p class="help"> This is the name of the advertised Wi-Fi network. Current SSID: {{ get_setting('ssid') }}</p>
</div>
<div class="field password">
{{ wtf.form_input_field(form.wifi_password, form.wifi_password.errors) }}
<p class="help"> This is the secret key needed to connect to the Wi-Fi network. By default, this is not set and everyone can join.
Current password: {{ get_setting('wifi_password') or 'Not set' }}</p>
</div>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_access_point) }}
<p class="butter-form-margin help">Whether this box will advertise a Wi-Fi network.</p>
</div>
<div class="field checkbox">
{{ wtf.form_bool_field(form.enable_wifi_sharing) }}
<p class="butter-form-margin help">Whether a share button for the Wi-Fi network is available.</p>
</div>
{% else %}
<p> Access point is only enabled when using a Raspberry Pi. </p>
{% endif %}
<hr>
<label class="label is-large">Access and security</label>
<div class="control field">
{{ wtf.form_password_field(form.admin_password, form.admin_password.errors) }}
<p class="help">Password for accessing this browser interface.</p>
</div>
<div class="field block">
<div class="control block">
<label class="label">{{ form.root_account_settings.label }} </label>
{% for subfield in form.root_account_settings %}
<label class="radio">
<label class="radio butter-form-margin">
{% if get_setting('root_account_settings') == subfield._value() %}
<input id='{{subfield.id}}' type='radio' name='{{subfield.name}}' value='{{subfield._value()}}' checked/>
{% else %}
@ -85,7 +114,7 @@
<div class="control block">
<label class="label">{{ form.ssh_access_settings.label }} </label>
{% for subfield in form.ssh_access_settings %}
<label class="radio">
<label class="radio butter-form-margin">
{% if get_setting('ssh_access_settings') == subfield._value() %}
<input id='{{subfield.id}}' type='radio' name='{{subfield.name}}' value='{{subfield._value()}}' checked/>
{% else %}
@ -96,13 +125,7 @@
{% endfor %}
{{ wtf.field_errors(form.ssh_access_settings.errors) }}
</div>
<div class="field">
<label class="label">{{ form.butterbox_logo.label }} </label>
<div class="control block">{{ form.butterbox_logo(class='label', style="width: 280px") }}</div>
{{ wtf.field_errors(form.butterbox_logo.errors) }}
<div class="block"><p class="help">This is the logo shown in the UI. Current logo:</p></div>
<img src="{{ get_setting('butterbox_logo') }}" style="height: 50px">
</div>
</form>