sensors added to settings
This commit is contained in:
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,94 @@
|
||||
from django import forms
|
||||
from django.contrib import messages
|
||||
from django.contrib.auth.decorators import login_required
|
||||
from django.shortcuts import get_object_or_404, redirect, render
|
||||
from django.utils.translation import gettext as _
|
||||
from django.views.decorators.http import require_POST
|
||||
from django.views.decorators.cache import never_cache
|
||||
|
||||
from fireworks_detect.models import Sensor
|
||||
|
||||
|
||||
class SensorForm(forms.ModelForm):
|
||||
class Meta:
|
||||
model = Sensor
|
||||
fields = ("name",)
|
||||
|
||||
|
||||
def owned_sensor(request, pk):
|
||||
return get_object_or_404(Sensor, pk=pk, owner=request.user, archived_at__isnull=True)
|
||||
|
||||
|
||||
def render_sensor(request, sensor, form=None, token=None):
|
||||
return render(request, "members/sensor_manage.html", {
|
||||
"sensor": sensor,
|
||||
"form": form or SensorForm(instance=sensor),
|
||||
"token": token,
|
||||
"heartbeat": sensor.heartbeat_status(),
|
||||
})
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
@never_cache
|
||||
def create_sensor(request):
|
||||
form = SensorForm(request.POST)
|
||||
if not form.is_valid():
|
||||
messages.error(request, _("Enter a valid sensor name. Names must be unique."))
|
||||
return redirect("user_settings")
|
||||
sensor = form.save(commit=False)
|
||||
sensor.owner = request.user
|
||||
sensor.save()
|
||||
token = sensor.issue_token()
|
||||
return render_sensor(request, sensor, token=token)
|
||||
|
||||
|
||||
@login_required
|
||||
def manage_sensor(request, pk):
|
||||
sensor = owned_sensor(request, pk)
|
||||
return render_sensor(request, sensor)
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
def rename_sensor(request, pk):
|
||||
sensor = owned_sensor(request, pk)
|
||||
form = SensorForm(request.POST, instance=sensor)
|
||||
if form.is_valid():
|
||||
form.save()
|
||||
messages.success(request, _("Sensor renamed."))
|
||||
return redirect("manage_sensor", pk=pk)
|
||||
return render_sensor(request, sensor, form=form)
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
def toggle_sensor(request, pk):
|
||||
sensor = owned_sensor(request, pk)
|
||||
sensor.is_active = not sensor.is_active
|
||||
sensor.save(update_fields=["is_active"])
|
||||
return redirect("manage_sensor", pk=pk)
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
@never_cache
|
||||
def rotate_sensor(request, pk):
|
||||
sensor = owned_sensor(request, pk)
|
||||
if request.POST.get("confirm") != "rotate":
|
||||
messages.error(request, _("Confirm token rotation first."))
|
||||
return redirect("manage_sensor", pk=pk)
|
||||
token = sensor.issue_token()
|
||||
return render_sensor(request, sensor, token=token)
|
||||
|
||||
|
||||
@login_required
|
||||
@require_POST
|
||||
def remove_sensor(request, pk):
|
||||
sensor = owned_sensor(request, pk)
|
||||
if request.POST.get("confirm") != "remove":
|
||||
messages.error(request, _("Confirm sensor removal first."))
|
||||
return redirect("manage_sensor", pk=pk)
|
||||
sensor.archive()
|
||||
messages.success(request, _("Sensor removed. Historical events were preserved."))
|
||||
return redirect("user_settings")
|
||||
@@ -1,9 +1,16 @@
|
||||
from django.urls import path
|
||||
|
||||
from . import views
|
||||
from . import sensor_views
|
||||
|
||||
|
||||
urlpatterns = [
|
||||
path("", views.user_settings, name="user_settings"),
|
||||
path("notifications/ntfy/test/", views.test_ntfy_notification, name="ntfy_test_notification"),
|
||||
path("sensors/create/", sensor_views.create_sensor, name="create_sensor"),
|
||||
path("sensors/<int:pk>/", sensor_views.manage_sensor, name="manage_sensor"),
|
||||
path("sensors/<int:pk>/rename/", sensor_views.rename_sensor, name="rename_sensor"),
|
||||
path("sensors/<int:pk>/toggle/", sensor_views.toggle_sensor, name="toggle_sensor"),
|
||||
path("sensors/<int:pk>/rotate/", sensor_views.rotate_sensor, name="rotate_sensor"),
|
||||
path("sensors/<int:pk>/remove/", sensor_views.remove_sensor, name="remove_sensor"),
|
||||
]
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
{% load i18n vite %}
|
||||
<!doctype html>
|
||||
<html lang="{{ request.LANGUAGE_CODE }}" data-theme="dark">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>{{ sensor.name }} · {% trans "Settings" %}</title>
|
||||
{% vite_asset "frontend/src/entries/settings.js" %}
|
||||
</head>
|
||||
<body><main class="card">
|
||||
<a href="{% url 'user_settings' %}">← {% trans "Settings" %}</a>
|
||||
<h1>{{ sensor.name }}</h1>
|
||||
{% if messages %}<ul class="messages">{% for message in messages %}<li class="alert alert--error">{{ message }}</li>{% endfor %}</ul>{% endif %}
|
||||
{% if token %}<section class="token-once" aria-label="{% trans 'New API token' %}">
|
||||
<strong>{% trans "Copy this token now. For security reasons it will not be shown again." %}</strong>
|
||||
<code id="sensor-token">{{ token }}</code>
|
||||
<button class="button button--secondary" type="button" onclick="navigator.clipboard.writeText(document.getElementById('sensor-token').textContent)">{% trans "Copy token" %}</button>
|
||||
</section>{% endif %}
|
||||
<section class="section">
|
||||
{% with status=heartbeat %}<p class="sensor-status sensor-status--{{ status.0 }}">● {{ status.1 }}</p>{% endwith %}
|
||||
<p>{% trans "Last heartbeat" %}: {{ sensor.last_heartbeat|date:"j M Y, H:i"|default:"—" }}</p>
|
||||
<p>{% trans "Last submission" %}: {{ sensor.last_submission|date:"j M Y, H:i"|default:"—" }}</p>
|
||||
<p>{% trans "Token prefix" %}: {{ sensor.token_prefix|default:"—" }}</p>
|
||||
<p>{% trans "Created" %}: {{ sensor.created_at|date:"j M Y, H:i" }}</p>
|
||||
</section>
|
||||
<section class="section"><h2>{% trans "Rename" %}</h2>
|
||||
<form method="post" action="{% url 'rename_sensor' sensor.pk %}">{% csrf_token %}
|
||||
<label for="id_name">{% trans "Device name" %}</label>{{ form.name }}{{ form.name.errors }}
|
||||
<button class="button" type="submit">{% trans "Save name" %}</button>
|
||||
</form>
|
||||
</section>
|
||||
<section class="section"><h2>{% trans "Device access" %}</h2>
|
||||
<p>{% if sensor.is_active %}{% trans "Enabled" %}{% else %}{% trans "Disabled" %}{% endif %}</p>
|
||||
<form method="post" action="{% url 'toggle_sensor' sensor.pk %}">{% csrf_token %}
|
||||
<button class="button button--secondary" type="submit">{% if sensor.is_active %}{% trans "Disable sensor" %}{% else %}{% trans "Enable sensor" %}{% endif %}</button>
|
||||
</form>
|
||||
</section>
|
||||
<section class="section"><h2>{% trans "Reissue API token" %}</h2>
|
||||
<p class="help">{% trans "The old token will immediately stop authenticating." %}</p>
|
||||
<form method="post" action="{% url 'rotate_sensor' sensor.pk %}">{% csrf_token %}
|
||||
<div class="check"><input type="checkbox" id="confirm-rotate" name="confirm" value="rotate" required><label for="confirm-rotate">{% trans "I understand the old token will stop working" %}</label></div>
|
||||
<button class="button" type="submit">{% trans "Reissue token" %}</button>
|
||||
</form>
|
||||
</section>
|
||||
<section class="section"><h2>{% trans "Remove sensor" %}</h2>
|
||||
<p class="help">{% trans "This disables the device and revokes its token. Historical events remain linked to it." %}</p>
|
||||
<form method="post" action="{% url 'remove_sensor' sensor.pk %}">{% csrf_token %}
|
||||
<div class="check"><input type="checkbox" id="confirm-remove" name="confirm" value="remove" required><label for="confirm-remove">{% trans "I understand this device will be removed" %}</label></div>
|
||||
<button class="button button--danger" type="submit">{% trans "Remove sensor" %}</button>
|
||||
</form>
|
||||
</section>
|
||||
</main></body></html>
|
||||
@@ -37,6 +37,27 @@
|
||||
</section>
|
||||
<button class="button" type="submit">{% trans "Save settings" %}</button>
|
||||
</form>
|
||||
<section class="section" aria-labelledby="sensors-title">
|
||||
<h2 id="sensors-title">{% trans "My sensors" %}</h2>
|
||||
<p class="help">{% trans "Manage the devices that authenticate with BoomCast." %}</p>
|
||||
{% for sensor in sensors %}
|
||||
<div class="sensor-card">
|
||||
<strong>{{ sensor.name }}</strong>
|
||||
{% with status=sensor.heartbeat_status %}<span class="sensor-status sensor-status--{{ status.0 }}">● {{ status.1 }}</span>{% endwith %}
|
||||
<p>{% if sensor.is_active %}{% trans "Enabled" %}{% else %}{% trans "Disabled" %}{% endif %} · {% trans "Token prefix" %}: {{ sensor.token_prefix|default:"—" }}</p>
|
||||
<p>{% trans "Last heartbeat" %}: {{ sensor.last_heartbeat|date:"j M Y, H:i"|default:"—" }} · {% trans "Created" %}: {{ sensor.created_at|date:"j M Y" }}</p>
|
||||
<a class="button button--secondary" href="{% url 'manage_sensor' sensor.pk %}">{% trans "Manage" %}</a>
|
||||
</div>
|
||||
{% empty %}
|
||||
<p class="help">{% trans "No sensors yet. Add a device to receive an API token for hardware submissions." %}</p>
|
||||
{% endfor %}
|
||||
<form method="post" action="{% url 'create_sensor' %}">
|
||||
{% csrf_token %}
|
||||
<label for="new-sensor-name">{% trans "Device name" %}</label>
|
||||
<input id="new-sensor-name" name="name" type="text" maxlength="100" required>
|
||||
<button class="button" type="submit">{% trans "Add sensor" %}</button>
|
||||
</form>
|
||||
</section>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.core.files.uploadedfile import SimpleUploadedFile
|
||||
from django.test import Client, TestCase
|
||||
from django.urls import reverse
|
||||
|
||||
from fireworks_detect.models import Event, PendingEvent, Sensor
|
||||
|
||||
|
||||
class SensorSettingsTests(TestCase):
|
||||
def setUp(self):
|
||||
self.alice = get_user_model().objects.create_user(username="sensor_alice", password="pass")
|
||||
self.bob = get_user_model().objects.create_user(username="sensor_bob", password="pass")
|
||||
self.client.force_login(self.alice)
|
||||
|
||||
def test_create_list_and_existing_api(self):
|
||||
response = self.client.post(reverse("create_sensor"), {"name": "Balcony"})
|
||||
sensor = Sensor.objects.get(name="Balcony")
|
||||
self.assertEqual(sensor.owner, self.alice)
|
||||
token = response.context["token"]
|
||||
self.assertNotIn(token, sensor.token_hash)
|
||||
self.assertTrue(sensor.token_matches(token))
|
||||
self.assertContains(response, token)
|
||||
self.assertNotContains(self.client.get(reverse("manage_sensor", args=[sensor.pk])), token)
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_AUTHORIZATION=f"Bearer {token}").status_code, 200)
|
||||
self.client.post(reverse("create_sensor"), {"name": "Portable"})
|
||||
self.assertEqual(Sensor.objects.filter(owner=self.alice).count(), 2)
|
||||
|
||||
Sensor.objects.create(name="System")
|
||||
Sensor.objects.create(name="Bob's device", owner=self.bob)
|
||||
listing = self.client.get(reverse("user_settings"))
|
||||
self.assertContains(listing, "Balcony")
|
||||
self.assertContains(listing, "Portable")
|
||||
self.assertNotContains(listing, "System")
|
||||
self.assertNotContains(listing, "Bob's device")
|
||||
self.client.force_login(self.bob)
|
||||
listing = self.client.get(reverse("user_settings"))
|
||||
self.assertContains(listing, "Bob's device")
|
||||
self.assertNotContains(listing, "Balcony")
|
||||
|
||||
def test_owner_can_manage_rotate_and_archive_preserving_history(self):
|
||||
sensor = Sensor.objects.create(name="Balcony", owner=self.alice)
|
||||
old_token = sensor.issue_token()
|
||||
pending = PendingEvent.objects.create(sensor=sensor, original_filename="test.wav", classifier_response={})
|
||||
event = Event.objects.create(sensor=sensor, original_filename="test.wav", classifier_response={})
|
||||
self.assertEqual(self.client.post(reverse("rename_sensor", args=[sensor.pk]), {"name": "Roof"}).status_code, 302)
|
||||
sensor.refresh_from_db()
|
||||
self.assertEqual(sensor.name, "Roof")
|
||||
self.client.post(reverse("toggle_sensor", args=[sensor.pk]))
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_AUTHORIZATION=f"Bearer {old_token}").status_code, 401)
|
||||
self.client.post(reverse("toggle_sensor", args=[sensor.pk]))
|
||||
response = self.client.post(reverse("rotate_sensor", args=[sensor.pk]), {"confirm": "rotate"})
|
||||
new_token = response.context["token"]
|
||||
self.assertNotEqual(old_token, new_token)
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_AUTHORIZATION=f"Bearer {old_token}").status_code, 401)
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_AUTHORIZATION=f"Bearer {new_token}").status_code, 200)
|
||||
self.assertNotContains(self.client.get(reverse("manage_sensor", args=[sensor.pk])), new_token)
|
||||
self.client.post(reverse("remove_sensor", args=[sensor.pk]), {"confirm": "remove"})
|
||||
sensor.refresh_from_db()
|
||||
self.assertIsNotNone(sensor.archived_at)
|
||||
self.assertFalse(sensor.is_active)
|
||||
self.assertFalse(sensor.token_hash)
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_AUTHORIZATION=f"Bearer {new_token}").status_code, 401)
|
||||
self.assertEqual(PendingEvent.objects.get(pk=pending.pk).sensor_id, sensor.pk)
|
||||
self.assertEqual(Event.objects.get(pk=event.pk).sensor_id, sensor.pk)
|
||||
self.assertEqual(self.client.get(reverse("manage_sensor", args=[sensor.pk])).status_code, 404)
|
||||
|
||||
def test_cross_user_id_tampering_is_404_and_does_not_change_sensor(self):
|
||||
sensor = Sensor.objects.create(name="Bob's device", owner=self.bob)
|
||||
token = sensor.issue_token()
|
||||
self.assertEqual(self.client.get(reverse("manage_sensor", args=[sensor.pk])).status_code, 404)
|
||||
actions = [
|
||||
("rename_sensor", {"name": "Stolen"}),
|
||||
("toggle_sensor", {}),
|
||||
("rotate_sensor", {"confirm": "rotate"}),
|
||||
("remove_sensor", {"confirm": "remove"}),
|
||||
]
|
||||
for route, data in actions:
|
||||
self.assertEqual(self.client.post(reverse(route, args=[sensor.pk]), data).status_code, 404)
|
||||
sensor.refresh_from_db()
|
||||
self.assertEqual(sensor.name, "Bob's device")
|
||||
self.assertTrue(sensor.is_active)
|
||||
self.assertTrue(sensor.token_matches(token))
|
||||
self.assertIsNone(sensor.archived_at)
|
||||
|
||||
def test_unowned_sensor_token_still_authenticates(self):
|
||||
sensor = Sensor.objects.create(name="System")
|
||||
token = sensor.issue_token()
|
||||
self.assertEqual(self.client.post(reverse("fireworks_detect:sensor_heartbeat"), HTTP_X_SENSOR_TOKEN=token).status_code, 200)
|
||||
|
||||
@patch("fireworks_detect.views.urlopen")
|
||||
def test_user_sensor_classification_keeps_sensor_relationship(self, urlopen):
|
||||
sensor = Sensor.objects.create(name="Balcony", owner=self.alice)
|
||||
token = sensor.issue_token()
|
||||
reply = MagicMock()
|
||||
reply.read.return_value = b'{"top_class":"Fireworks"}'
|
||||
urlopen.return_value.__enter__.return_value = reply
|
||||
audio = SimpleUploadedFile("sample.wav", b"RIFF0000WAVEdata", content_type="audio/wav")
|
||||
response = self.client.post(reverse("fireworks_detect:classify"), {"file": audio}, HTTP_AUTHORIZATION=f"Bearer {token}")
|
||||
self.assertEqual(response.status_code, 201)
|
||||
self.assertEqual(PendingEvent.objects.get(pk=response.json()["pending_event_id"]).sensor_id, sensor.pk)
|
||||
|
||||
def test_mutating_forms_require_csrf(self):
|
||||
sensor = Sensor.objects.create(name="Balcony", owner=self.alice)
|
||||
client = Client(enforce_csrf_checks=True)
|
||||
client.force_login(self.alice)
|
||||
for route, data in [
|
||||
("create_sensor", {"name": "Portable"}),
|
||||
("rename_sensor", {"name": "Roof"}),
|
||||
("toggle_sensor", {}),
|
||||
("rotate_sensor", {"confirm": "rotate"}),
|
||||
("remove_sensor", {"confirm": "remove"}),
|
||||
]:
|
||||
args = [] if route == "create_sensor" else [sensor.pk]
|
||||
self.assertEqual(client.post(reverse(route, args=args), data).status_code, 403)
|
||||
sensor.refresh_from_db()
|
||||
self.assertEqual(sensor.name, "Balcony")
|
||||
self.assertTrue(sensor.is_active)
|
||||
self.assertIsNone(sensor.archived_at)
|
||||
+3
-2
@@ -10,6 +10,7 @@ from django.utils.translation import gettext as _
|
||||
from django.views.decorators.http import require_POST
|
||||
|
||||
from notifications.services import NotificationError, send_ntfy_notification
|
||||
from fireworks_detect.models import Sensor
|
||||
from .forms import LanguageSettingsForm, MemberForm, UserSettingsForm
|
||||
from .models import Member, UserSettings
|
||||
|
||||
@@ -75,7 +76,7 @@ def user_settings(request):
|
||||
messages.success(request, _("Language preference saved."))
|
||||
return redirect("user_settings")
|
||||
form = UserSettingsForm(instance=settings)
|
||||
return render(request, "members/user_settings.html", {"form": form, "language_form": language_form})
|
||||
return render(request, "members/user_settings.html", {"form": form, "language_form": language_form, "sensors": Sensor.objects.filter(owner=request.user, archived_at__isnull=True)})
|
||||
saved_ntfy_url = settings.ntfy_url
|
||||
if request.method == "POST":
|
||||
form = UserSettingsForm(request.POST, instance=settings)
|
||||
@@ -98,7 +99,7 @@ def user_settings(request):
|
||||
return redirect("user_settings")
|
||||
else:
|
||||
form = UserSettingsForm(instance=settings)
|
||||
return render(request, "members/user_settings.html", {"form": form, "language_form": language_form})
|
||||
return render(request, "members/user_settings.html", {"form": form, "language_form": language_form, "sensors": Sensor.objects.filter(owner=request.user, archived_at__isnull=True)})
|
||||
|
||||
|
||||
@login_required
|
||||
|
||||
Reference in New Issue
Block a user