arona/PyRIGS
1
0
Fork 0
mirror of https://github.com/nottinghamtec/PyRIGS.git synced 2026-10-12 15:45:29 +00:00
Code Issues Projects Releases Wiki Activity

Port to Django 5.2 (#635)

Browse Source 
* Port to Django 5.2

* Pin pluggy to 1.2.0

Any newer and the mystery importlib metadata error appears. Weird! >_>

* Update for premailer changed default

* Update view logic for is_ajax being changed to a template context processor

* Port a few more tests to pytest proper

Having two distinct test flavours is giving me a headache

* Version 1 dockerfile

Makes a VERY big image, I suspect we can optimise this a lot...

* Optimise dockerfile a little lot a bit

* fix(users): change logout link to POST request

* fix(tests): fix some syntax errors in test code

still got lots of failed tests :(

* fix: replace deprecated Django APIs

* ci: update Dockerfile

* ci: update Dockerfile

* fix(dependencies+tests): update EoL/vulnerable dependencies and improve test stability

* Upgrade Python from 3.10 to 3.12
* Update frontend dependencies, replace node-sass with sass

* chore(logging): ignore dangling obj reference warning from pypdf

* ci: update compose.yml for prod deployment

- Add Nginx as a reverse proxy
- Add cert-selfsign.sh for generating self-signed certificates
- Add certbot-issue.sh for Let's Encrypt certificate issuance and renewal
- Add cron-install.sh and cron-uninstall.sh for system cron management
- Add .env.example as an environment variable template

* style: reformat code

* ci: add more sleep trying to pass tests

* ci: ignore browser-based tests during ci testing

* fix: create home for the new user during Dockerfile building

* chore: remove heroku conf file

* fix: RIGS not franken anymore

* fix: restore is_ajax as a boolean and split out the context processor

* test: remove Selenium interaction tests and their CI workarounds

* fix: harden production settings (CSRF origins, env casts, ADMINS) and drop dead debug toolbar code

* deploy: serve static files from nginx, pin PGDATA, and make cert scripts loud on failure

* build: switch .dockerignore to an allowlist

* build: drop unused dependencies, soft-pin the rest and target Python 3.14

* build: move image to Python 3.14 / Node 24 and force DEBUG off

* ci: add dependabot config for uv, npm, docker and actions

* build: narrow Sass deprecation silencing to @import and require Node 24

* build: provide placeholder env for collectstatic now that DEBUG is off in the image

* deploy: add plain-HTTP nginx config for local development and use it in compose

* deploy: remove self-signed cert script

* build: make the image multi-arch with official node and python base images

* ci: lint and test on PRs, build the image on PRs and push it to GHCR on master

* docs: add local running and sample data instructions

* fix: report a form error instead of crashing when big power has no Power MIC

* fix: upgrade pypdf and urllib3 to patched releases

* fix: apply non-breaking npm audit fixes

* fix: strip whitespace in ALLOWED_HOSTS and drop misleading HSTS preload

* deploy: add a pyrigs healthcheck and make nginx wait for it

* build: pin the uv image version

* fix: correct the check-in person picker condition and use BeautifulSoup's string argument

* refactor: replace unique_together with UniqueConstraint

* build: replace pycodestyle with ruff and fix what it found

Removes unused imports and variables, and fixes a few real problems it
surfaced:
- EventCheckIn.active() referenced an undefined name and raised NameError;
  it now returns whether the check-in has no end time
- RIGS.admin defined EventChecklistAdmin twice; the second is now
  PowerTestRecordAdmin
- RIGS/tests/conftest.py used date/timedelta without importing them
- the signal-registering imports in apps.py are kept with noqa

pycodestyle config in setup.cfg is dropped.

* style: format the codebase with ruff

* style: normalise line endings, trailing whitespace and end-of-file newlines

* ci: run ruff and file hygiene through prek, and document it

---------

Co-authored-by: Hang <me@hangxu.me>
Co-authored-by: Joe Banks <joe@jb3.dev>
This commit is contained in:
FreneticScribbler
2026-10-02 00:43:41 +02:00
committed by GitHub
parent 4cd68f5a0f
commit 08171767a0
148 changed files with 6573 additions and 9514 deletions
Download Patch File Download Diff File Expand all files Collapse all files

260
RIGS/views/rigboard.py
View File

@@ -8,7 +8,6 @@ import hmac
import hashlib
from envparse import env
from bs4 import BeautifulSoup
from django.conf import settings
from django.contrib import messages
@@ -17,10 +16,9 @@ from django.core import signing
from django.core.exceptions import SuspiciousOperation
from django.core.mail import EmailMultiAlternatives
from django.db.models import Q
from django.http import HttpResponse
from django.http import HttpResponse, HttpResponseForbidden
from django.shortcuts import get_object_or_404
from django.template.loader import get_template
from django.urls import reverse
from django.urls import reverse_lazy
from django.utils import timezone
from django.utils.decorators import method_decorator
@@ -31,11 +29,11 @@ from PyRIGS import decorators
from PyRIGS.views import OEmbedView, is_ajax, ModalURLMixin, PrintView, get_related
from RIGS import models, forms
__author__ = 'ghost'
__author__ = "ghost"
class RigboardIndex(generic.TemplateView):
template_name = 'rigboard.html'
template_name = "rigboard.html"
def get_context_data(self, **kwargs):
# get super context
@@ -43,28 +41,28 @@ class RigboardIndex(generic.TemplateView):
objects = models.Event.objects.current_events()
if self.request.GET.get('hide_cancelled', False):
if self.request.GET.get("hide_cancelled", False):
objects = objects.exclude(status=models.Event.CANCELLED)
# call out method to get current events
context['events'] = objects.select_related('riskassessment', 'invoice').prefetch_related('checklists')
context['page_title'] = "Rigboard"
context["events"] = objects.select_related("riskassessment", "invoice").prefetch_related("checklists")
context["page_title"] = "Rigboard"
return context
class WebCalendar(generic.TemplateView):
template_name = 'calendar.html'
template_name = "calendar.html"
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['view'] = kwargs.get('view', '')
context['date'] = kwargs.get('date', '')
context["view"] = kwargs.get("view", "")
context["date"] = kwargs.get("date", "")
# context['page_title'] = "Calendar"
return context
class EventDetail(generic.DetailView, ModalURLMixin):
template_name = 'event_detail.html'
template_name = "event_detail.html"
model = models.Event
def get_context_data(self, **kwargs):
@@ -72,36 +70,36 @@ class EventDetail(generic.DetailView, ModalURLMixin):
title = f"{self.object.display_id} | {self.object.name}"
if self.object.dry_hire:
title += " <span class='badge badge-secondary'>Dry Hire</span>"
context['page_title'] = title
context["page_title"] = title
if is_ajax(self.request):
context['override'] = "base_ajax.html"
context["override"] = "base_ajax.html"
else:
context['override'] = 'base_assets.html'
context["override"] = "base_assets.html"
return context
class EventEmbed(EventDetail):
template_name = 'event_embed.html'
template_name = "event_embed.html"
class EventOEmbed(OEmbedView):
model = models.Event
url_name = 'event_embed'
url_name = "event_embed"
class EventCreate(generic.CreateView):
model = models.Event
form_class = forms.EventForm
template_name = 'event_form.html'
template_name = "event_form.html"
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['page_title'] = "New Event"
context['edit'] = True
context['currentVAT'] = models.VatRate.objects.current_rate()
context["page_title"] = "New Event"
context["edit"] = True
context["currentVAT"] = models.VatRate.objects.current_rate()
form = context['form']
if hasattr(form, 'items_json') and re.search(r'"-\d+"', form['items_json'].value()):
form = context["form"]
if hasattr(form, "items_json") and re.search(r'"-\d+"', form["items_json"].value()):
messages.info(self.request, "Your item changes have been saved. Please fix the errors and save the event.")
get_related(form, context)
@@ -109,39 +107,43 @@ class EventCreate(generic.CreateView):
return context
def get_success_url(self):
return reverse_lazy('event_detail', kwargs={'pk': self.object.pk})
return reverse_lazy("event_detail", kwargs={"pk": self.object.pk})
class EventUpdate(generic.UpdateView):
model = models.Event
form_class = forms.EventForm
template_name = 'event_form.html'
template_name = "event_form.html"
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['page_title'] = f"Event {self.object.display_id}"
context['edit'] = True
context["page_title"] = f"Event {self.object.display_id}"
context["edit"] = True
form = context['form']
form = context["form"]
get_related(form, context)
return context
def render_to_response(self, context, **response_kwargs):
if hasattr(context, 'duplicate') and not context['duplicate']:
if hasattr(context, "duplicate") and not context["duplicate"]:
# If this event has already been emailed to a client, show a warning
if self.object.auth_request_at is not None:
messages.info(self.request,
'This event has already been sent to the client for authorisation, any changes you make will be visible to them immediately.')
messages.info(
self.request,
"This event has already been sent to the client for authorisation, any changes you make will be visible to them immediately.",
)
if hasattr(self.object, 'authorised'):
messages.warning(self.request,
'This event has already been authorised by the client, any changes to the price will require reauthorisation.')
if hasattr(self.object, "authorised"):
messages.warning(
self.request,
"This event has already been authorised by the client, any changes to the price will require reauthorisation.",
)
return super().render_to_response(context, **response_kwargs)
def get_success_url(self):
return reverse_lazy('event_detail', kwargs={'pk': self.object.pk})
return reverse_lazy("event_detail", kwargs={"pk": self.object.pk})
class EventDuplicate(EventUpdate):
@@ -158,34 +160,38 @@ class EventDuplicate(EventUpdate):
new.collector = None
# Remove all the authorisation information from the new event
new.auth_request_to = ''
new.auth_request_to = ""
new.auth_request_by = None
new.auth_request_at = None
if self.request.method in (
'POST', 'PUT'): # This only happens on save (otherwise items won't display in editor)
"POST",
"PUT",
): # This only happens on save (otherwise items won't display in editor)
new.pk = None # This means a new event will be created on save, and all items will be re-created
else:
messages.info(self.request, 'Event data duplicated but not yet saved. Click save to complete operation.')
messages.info(self.request, "Event data duplicated but not yet saved. Click save to complete operation.")
return new
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['page_title'] = f"Duplicate of Event {self.object.display_id}"
context["page_title"] = f"Duplicate of Event {self.object.display_id}"
context["duplicate"] = True
return context
class EventPrint(PrintView):
model = models.Event
template_name = 'event_print.xml'
template_name = "event_print.xml"
append_terms = True
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['quote'] = True
context['filename'] = f"Event_{context['object'].display_id}_{context['object_name']}_{context['object'].start_date}.pdf"
context["quote"] = True
context["filename"] = (
f"Event_{context['object'].display_id}_{context['object_name']}_{context['object'].start_date}.pdf"
)
return context
@@ -196,20 +202,19 @@ class EventArchive(generic.ListView):
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['start'] = self.request.GET.get('start', None)
context['end'] = self.request.GET.get('end', datetime.date.today().strftime('%Y-%m-%d'))
context['statuses'] = models.Event.EVENT_STATUS_CHOICES
context['page_title'] = 'Event Archive'
context["start"] = self.request.GET.get("start", None)
context["end"] = self.request.GET.get("end", datetime.date.today().strftime("%Y-%m-%d"))
context["statuses"] = models.Event.EVENT_STATUS_CHOICES
context["page_title"] = "Event Archive"
return context
def get_queryset(self):
start = self.request.GET.get('start', None)
end = self.request.GET.get('end', datetime.date.today())
start = self.request.GET.get("start", None)
end = self.request.GET.get("end", datetime.date.today())
# Assume idiots, always check
if start and start > end:
messages.add_message(self.request, messages.INFO,
"Muppet! Check the dates, it has been fixed for you.")
messages.add_message(self.request, messages.INFO, "Muppet! Check the dates, it has been fixed for you.")
start, end = end, start # Stop the impending fail
filter = Q()
@@ -218,21 +223,21 @@ class EventArchive(generic.ListView):
if start:
filter &= Q(start_date__gte=start)
q = self.request.GET.get('q', "")
q = self.request.GET.get("q", "")
objects = self.model.objects.all()
if q:
objects = self.model.objects.search(q)
status = self.request.GET.getlist('status', "")
status = self.request.GET.getlist("status", "")
if len(status) > 0:
filter &= Q(status__in=status)
qs = objects.filter(filter).order_by('-start_date')
qs = objects.filter(filter).order_by("-start_date")
# Preselect related for efficiency
qs.select_related('person', 'organisation', 'venue', 'mic')
qs.select_related("person", "organisation", "venue", "mic")
if not qs.exists():
messages.add_message(self.request, messages.WARNING, "No events have been found matching those criteria.")
@@ -241,49 +246,57 @@ class EventArchive(generic.ListView):
class EventAuthorise(generic.UpdateView):
template_name = 'eventauthorisation_form.html'
success_template = 'eventauthorisation_success.html'
template_name = "eventauthorisation_form.html"
success_template = "eventauthorisation_success.html"
preview = False
def form_valid(self, form):
self.object = form.save()
self.template_name = self.success_template
messages.add_message(self.request, messages.SUCCESS,
'Success! Your event has been authorised. ' +
f'You will also receive email confirmation to {self.object.email}.')
messages.add_message(
self.request,
messages.SUCCESS,
"Success! Your event has been authorised. "
+ f"You will also receive email confirmation to {self.object.email}.",
)
return self.render_to_response(self.get_context_data())
@property
def event(self):
return models.Event.objects.select_related('organisation', 'person', 'venue').get(pk=self.kwargs['pk'])
return models.Event.objects.select_related("organisation", "person", "venue").get(pk=self.kwargs["pk"])
def get_object(self, queryset=None):
return getattr(self.event, 'authorisation', None)
return getattr(self.event, "authorisation", None)
def get_form_class(self):
return forms.InternalClientEventAuthorisationForm
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['event'] = self.event
context['tos_url'] = settings.TERMS_OF_HIRE_URL
context['page_title'] = f"{self.event.display_id}: {self.event.name}"
context["event"] = self.event
context["tos_url"] = settings.TERMS_OF_HIRE_URL
context["page_title"] = f"{self.event.display_id}: {self.event.name}"
if self.event.dry_hire:
context['page_title'] += ' <span class="badge badge-secondary align-top">Dry Hire</span>'
context['preview'] = self.preview
context["page_title"] += ' <span class="badge badge-secondary align-top">Dry Hire</span>'
context["preview"] = self.preview
return context
def get(self, request, *args, **kwargs):
if self.get_object() is not None and self.get_object().pk is not None:
if self.event.authorised:
messages.add_message(self.request, messages.WARNING,
"This event has already been authorised. "
"Reauthorising is not necessary at this time.")
messages.add_message(
self.request,
messages.WARNING,
"This event has already been authorised. Reauthorising is not necessary at this time.",
)
else:
messages.add_message(self.request, messages.WARNING,
"This event has already been authorised, but the amount has changed. " +
"Please check the amount and reauthorise.")
messages.add_message(
self.request,
messages.WARNING,
"This event has already been authorised, but the amount has changed. "
+ "Please check the amount and reauthorise.",
)
return super().get(request, *args, **kwargs)
def get_form(self, **kwargs):
@@ -296,20 +309,19 @@ class EventAuthorise(generic.UpdateView):
def dispatch(self, request, *args, **kwargs):
# Verify our signature matches up and all is well with the integrity of the URL
try:
data = signing.loads(kwargs.get('hmac'))
assert int(kwargs.get('pk')) == int(data.get('pk'))
request.email = data['email']
request.sent_by = models.Profile.objects.get(pk=data['sent_by'])
except (signing.BadSignature, AssertionError, KeyError, models.Profile.DoesNotExist):
raise SuspiciousOperation(
"This URL is invalid. Please ask your TEC contact for a new URL")
data = signing.loads(kwargs.get("hmac"))
assert int(kwargs.get("pk")) == int(data.get("pk"))
request.email = data["email"]
request.sent_by = models.Profile.objects.get(pk=data["sent_by"])
except signing.BadSignature, AssertionError, KeyError, models.Profile.DoesNotExist:
raise SuspiciousOperation("This URL is invalid. Please ask your TEC contact for a new URL")
return super().dispatch(request, *args, **kwargs)
class EventAuthorisationRequest(generic.FormView, generic.detail.SingleObjectMixin):
model = models.Event
form_class = forms.EventAuthorisationRequestForm
template_name = 'eventauthorisation_request.html'
template_name = "eventauthorisation_request.html"
@method_decorator(decorators.nottinghamtec_address_required)
def dispatch(self, *args, **kwargs):
@@ -321,17 +333,20 @@ class EventAuthorisationRequest(generic.FormView, generic.detail.SingleObjectMix
def get_success_url(self):
if is_ajax(self.request):
url = reverse_lazy('closemodal')
url = reverse_lazy("closemodal")
messages.info(self.request, "location.reload()")
else:
url = reverse_lazy('event_detail', kwargs={
'pk': self.object.pk,
})
url = reverse_lazy(
"event_detail",
kwargs={
"pk": self.object.pk,
},
)
messages.add_message(self.request, messages.SUCCESS, "Authorisation request successfully sent.")
return url
def form_valid(self, form):
email = form.cleaned_data['email']
email = form.cleaned_data["email"]
event = self.object
event.auth_request_by = self.request.user
event.auth_request_at = timezone.now()
@@ -339,18 +354,20 @@ class EventAuthorisationRequest(generic.FormView, generic.detail.SingleObjectMix
event.save()
context = {
'object': self.object,
'request': self.request,
'hmac': signing.dumps({
'pk': self.object.pk,
'email': email,
'sent_by': self.request.user.pk,
}),
"object": self.object,
"request": self.request,
"hmac": signing.dumps(
{
"pk": self.object.pk,
"email": email,
"sent_by": self.request.user.pk,
}
),
}
if event.person is not None and email == event.person.email:
context['to_name'] = event.person.name
context["to_name"] = event.person.name
elif event.organisation is not None and email == event.organisation.email:
context['to_name'] = event.organisation.name
context["to_name"] = event.organisation.name
msg = EmailMultiAlternatives(
f"{self.object.display_id} | {self.object.name} - Event Authorisation Request",
@@ -358,10 +375,13 @@ class EventAuthorisationRequest(generic.FormView, generic.detail.SingleObjectMix
to=[email],
reply_to=[self.request.user.email],
)
css = finders.find('css/email.css')
html = premailer.Premailer(get_template("email/eventauthorisation_client_request.html").render(context),
external_styles=css).transform()
msg.attach_alternative(html, 'text/html')
css = finders.find("css/email.css")
html = premailer.Premailer(
get_template("email/eventauthorisation_client_request.html").render(context),
external_styles=css,
allow_loading_external_files=True,
).transform()
msg.attach_alternative(html, "text/html")
msg.send()
@@ -373,21 +393,25 @@ class EventAuthoriseRequestEmailPreview(generic.DetailView):
model = models.Event
def render_to_response(self, context, **response_kwargs):
css = finders.find('css/email.css')
css = finders.find("css/email.css")
response = super().render_to_response(context, **response_kwargs)
assert isinstance(response, HttpResponse)
response.content = premailer.Premailer(response.rendered_content, external_styles=css).transform()
response.content = premailer.Premailer(
response.rendered_content, external_styles=css, allow_loading_external_files=True
).transform()
return response
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['hmac'] = signing.dumps({
'pk': self.object.pk,
'email': self.request.GET.get('email', 'hello@world.test'),
'sent_by': self.request.user.pk,
})
context['to_name'] = self.request.GET.get('to_name', None)
context['target'] = 'event_authorise_form_preview'
context["hmac"] = signing.dumps(
{
"pk": self.object.pk,
"email": self.request.GET.get("email", "hello@world.test"),
"sent_by": self.request.user.pk,
}
)
context["to_name"] = self.request.GET.get("to_name", None)
context["target"] = "event_authorise_form_preview"
return context
@@ -395,17 +419,17 @@ class CreateForumThread(generic.base.RedirectView):
permanent = False
def get_redirect_url(self, *args, **kwargs):
event = get_object_or_404(models.Event, pk=kwargs['pk'])
event = get_object_or_404(models.Event, pk=kwargs["pk"])
if event.forum_url:
return event.forum_url
params = {
'title': str(event),
'body': f'https://rigs.nottinghamtec.co.uk/event/{event.pk}',
'category': 'rig-info'
"title": str(event),
"body": f"https://rigs.nottinghamtec.co.uk/event/{event.pk}",
"category": "rig-info",
}
return f'https://forum.nottinghamtec.co.uk/new-topic?{urllib.parse.urlencode(params)}'
return f"https://forum.nottinghamtec.co.uk/new-topic?{urllib.parse.urlencode(params)}"
class RecieveForumWebhook(generic.View):
@@ -415,12 +439,14 @@ class RecieveForumWebhook(generic.View):
def post(self, request, *args, **kwargs):
computed = f"sha256={hmac.new(env('FORUM_WEBHOOK_SECRET').encode(), request.body, hashlib.sha256).hexdigest()}"
if not hmac.compare_digest(request.headers.get('X-Discourse-Event-Signature'), computed):
return HttpResponseForbidden('Invalid signature header')
if not hmac.compare_digest(request.headers.get("X-Discourse-Event-Signature"), computed):
return HttpResponseForbidden("Invalid signature header")
# Check if this is the right kind of event. The webhook filters by category on the forum side
if request.headers.get('X-Discourse-Event') == "topic_created":
body = simplejson.loads(request.body.decode('utf-8'))
event_id = int(body['topic']['title'][1:6]) # find the ID, force convert it to an int to eliminate leading zeros
if request.headers.get("X-Discourse-Event") == "topic_created":
body = simplejson.loads(request.body.decode("utf-8"))
event_id = int(
body["topic"]["title"][1:6]
) # find the ID, force convert it to an int to eliminate leading zeros
event = models.Event.objects.filter(pk=event_id).first()
if event:
event.forum_url = f"https://forum.nottinghamtec.co.uk/t/{body['topic']['slug']}"