Created new models to replicate out of and split coord app

Moved helpers and views to their respective new apps
This commit is contained in:
st01765
2026-02-05 11:18:08 +11:00
parent ad4fd19cc7
commit b695dd8054
26 changed files with 1536 additions and 10 deletions
+109 -1
View File
@@ -1,3 +1,111 @@
from django.contrib import admin
from django.utils.html import format_html
from rangefilter.filters import DateRangeFilterBuilder
# Register your models here.
from common.admin import MyImportExportModelAdmin
from traveller.adminClone import CloneModelAdmin
from traveller.admin_mixins import SchoolRollMixin, TravellerRollMixin
from traveller.models import Family, TravellerRoute, Traveller, School
class FamilyInline(admin.StackedInline):
model = Family
classes = ['collapse']
extra = 0
clone_parent = "traveller"
class TravellerRouteInline(admin.TabularInline):
model = TravellerRoute
extra = 0
clone_parent = "traveller"
@admin.register(Traveller)
class TravellerAdmin(MyImportExportModelAdmin, CloneModelAdmin, TravellerRollMixin):
list_display = ["first_name", "last_name", "school", "year_level", "is_active", "address", "stop_route", "shuttle", "travel_start_date", "travel_end_date"]
list_filter = [
"is_active", "school", "year_level", "eligibility_status", "bus_stops__bus", "shuttle",
("travel_start_date", DateRangeFilterBuilder(
title="Start date"
)),
("travel_end_date", DateRangeFilterBuilder(
title="End date"
))
]
cloneable_fields = ["last_name"]
search_fields = ["first_name", "last_name", "address"]
inlines = [FamilyInline, TravellerRouteInline]
readonly_fields = ["travel_start_date", "travel_end_date", "created_on", "last_edit", "is_active", "address"]
actions = ["export_to_csv", "send_sms", "confirmation_letter", "letter_creator"]
fieldsets = [
(None, {
'fields': [
"is_active",
"school",
"first_name",
"last_name",
"year_level",
"dob",
"address",
]
}),
('Office Use', {
'classes': ('collapse',),
'fields': [
"distance_to_school",
"travel_start_date",
"travel_end_date",
"eligibility_status",
"term_1_paid",
"term_2_paid",
"term_3_paid",
"term_4_paid",
"assessment_date",
"application_form_completed",
"parent_notified",
"seat_number",
"created_on",
"last_edit",
]
}),
(None, {'fields': ["notes", "shuttle"]})
]
# list_display_links = None
def stop_route(self, obj):
from transport.models import BusStop
stops = BusStop.objects.filter(traveller__id__exact=obj.id)
if stops.count() == 0:
return ""
if stops.count() == 1:
return stops.first()
return "Multiple"
# def save_model(self, request, obj, form, change):
# if obj.is_archived and obj.travel_end_date is None:
# obj.is_archived = False
# super().save_model(request, obj, form, change)
# @admin.register(Family)
class FamilyAdmin(MyImportExportModelAdmin, admin.ModelAdmin):
list_display = ["traveller", "__str__",
"parent_A_firstname", "parent_A_lastname", "parent_A_phone",
"parent_B_firstname", "parent_B_lastname", "parent_B_phone",
"emergency_contact_A_firstname", "emergency_contact_A_lastname", "emergency_contact_A_phone",
"emergency_contact_B_firstname", "emergency_contact_B_lastname", "emergency_contact_B_phone"]
# @admin.register(TravellerRoute)
class TravellerRouteAdmin(MyImportExportModelAdmin, admin.ModelAdmin):
list_display = ["traveller", "busStop"]
@admin.register(School)
class SchoolAdmin(MyImportExportModelAdmin, admin.ModelAdmin, SchoolRollMixin):
list_display = ["__str__", "address", "suburb", "school_email", "phone"]
actions = ["email_travellers_to_school", "show_school_travellers", "export_travellers_to_csv"]
def school_email(self, obj):
return format_html('<a href="mailto:{}">{}</a>', obj.email, obj.email)
+161
View File
@@ -0,0 +1,161 @@
from functools import update_wrapper
from django.contrib.admin import ModelAdmin, helpers
from django.contrib.admin.exceptions import DisallowedModelAdminToField
from django.contrib.admin.options import TO_FIELD_VAR
from django.contrib.admin.utils import flatten_fieldsets, unquote
from django.shortcuts import redirect
from django.urls import reverse, path
from django.core.exceptions import PermissionDenied, FieldDoesNotExist
class CloneModelAdmin(ModelAdmin):
clone_verbose_name = "Clone"
change_form_template = 'admin/admin_change_form.html'
cloneable_fields = []
def get_urls(self):
# Not certain what this wrap() function is exactly. Just copied it from the django admin get_urls function
def wrap(view):
def wrapper(*args, **kwargs):
return self.admin_site.admin_view(view)(*args, **kwargs)
wrapper.model_admin = self
return update_wrapper(wrapper, view)
info = self.opts.app_label, self.opts.model_name
new_urlpatterns = [
path(
"<path:object_id>/clone/",
wrap(self.clone_view),
name="%s_%s_clone" % info,
),
]
original_urlpatterns = super(CloneModelAdmin, self).get_urls()
# Important to add custom urls before the existing ones.
# Last entry is <URLPattern '<path:object_id>/'> which will catch everything not already picked up
return new_urlpatterns + original_urlpatterns
def change_view(self, request, object_id, form_url='', extra_context=None):
url = reverse("admin:{0}_{1}_clone".format(self.opts.app_label, self.opts.model_name), args=[object_id])
extra_context = extra_context or {}
extra_context.update({
'clone_verbose_name': self.clone_verbose_name,
'clone_link': url,
})
return super(CloneModelAdmin, self).change_view(request, object_id, form_url, extra_context)
def clone_view(self, request, object_id, form_url='', extra_context=None):
to_field = request.POST.get(TO_FIELD_VAR, request.GET.get(TO_FIELD_VAR))
if to_field:
print("To field in clone_view. What is this? ",to_field)
if to_field and not self.to_field_allowed(request, to_field):
raise DisallowedModelAdminToField(
"The field %s cannot be referenced." % to_field
)
if not self.has_add_permission(request):
raise PermissionDenied
original_obj = self.get_object(request, unquote(object_id), to_field)
if original_obj is None:
return self._get_obj_does_not_exist_redirect(request, self.opts, object_id)
if not self.has_view_or_change_permission(request, original_obj):
raise PermissionDenied
fieldsets = self.get_fieldsets(request, original_obj)
model_form = self.get_form(request, original_obj, change=False, fields=flatten_fieldsets(fieldsets))
if request.method == "POST":
form = model_form(request.POST)
formsets, inline_instances = self._create_formsets(
request,
original_obj,
change=False,
)
form_validated = form.is_valid()
if form_validated:
new_object = self.save_form(request, form, change=False)
self.save_model(request, new_object, form, False)
self.clone_related(request, original_obj, new_object)
return redirect(reverse("admin:{0}_{1}_change".format(self.opts.app_label, self.opts.model_name), args=[new_object.pk]))
else:
new_obj = self.model()
for field in self.cloneable_fields:
setattr(new_obj, field, getattr(original_obj, field))
form = model_form(instance=new_obj)
formsets, inline_instances = self._create_formsets(request, original_obj, change=False)
admin_form = helpers.AdminForm(
form,
list(self.get_fieldsets(request)),
self.get_prepopulated_fields(request),
self.readonly_fields,
model_admin=self
)
media = self.media
inline_formsets = self.get_inline_formsets(request, formsets, inline_instances)
for inline_formset in inline_formsets:
media += inline_formset.media
title = u'{0} {1}'.format(self.clone_verbose_name, original_obj)
context = {
**self.admin_site.each_context(request),
"title": title,
"original": title,
"adminform": admin_form,
"is_popup": "_popup" in request.POST or "_popup" in request.GET,
"show_delete": False,
"media": media,
"inline_admin_formsets": inline_formsets,
"errors": helpers.AdminErrorList(form, formsets),
**(extra_context or {}),
}
context.update(extra_context or {})
return self.render_change_form(
request,
context,
form_url=form_url,
change=False,
add=True
)
def clone_related(self, request, original_obj, new_obj):
for inline in self.inlines:
if not inline.clone_parent:
continue
try:
inline.model._meta.get_field(inline.clone_parent)
except FieldDoesNotExist:
continue
inline_objects = inline.model.objects.filter(**{inline.clone_parent: original_obj})
for inline_object in inline_objects:
inline_object.pk = None
setattr(inline_object, inline.clone_parent, new_obj)
inline_object.save()
class InlineAdminFormSetFakeOriginal(helpers.InlineAdminFormSet):
def __iter__(self):
# the template requires the AdminInlineForm to have an `original`
# attribute, which is the model instance, in order to display the
# 'Delete' checkbox
# we don't have `original` because we are just providing initial
# data to the form, so we attach a "fake original" (something that
# evaluates to True) to fool the template and make is display
# the 'Delete' checkbox
# needless to say this is a terrible hack and will break in future
# django versions :)
for inline_form in super(InlineAdminFormSetFakeOriginal, self).__iter__():
if inline_form.form.initial:
inline_form.original = True
yield inline_form
+60
View File
@@ -0,0 +1,60 @@
import csv
from datetime import date
from django.http import HttpResponse
from common.documents import render_to_pdf
from messaging.services.email import email_school_roll
from messaging.services.sms import send_sms
from traveller.context_helpers import school_roll_context, traveller_route_context, confirmation_letter_context, \
traveller_roll_context
from traveller.models import TravellerRoute
class SchoolRollMixin:
def email_travellers_to_school(self, request, queryset):
return email_school_roll(request, queryset)
def show_school_travellers(self, request, queryset):
return render_to_pdf('reports/school_roll.html', school_roll_context(queryset))
def show_school_travellers_on_date(self, request, queryset):
return render_to_pdf('reports/school_roll.html', school_roll_context(queryset))
def export_travellers_to_csv(self, request, queryset):
traveller_list = []
for school in queryset:
for travellerRoute in TravellerRoute.objects.filter(traveller__school=school):
if not travellerRoute.traveller._is_active():
continue
traveller_list.append(traveller_route_context(travellerRoute))
response = HttpResponse(content_type="text/csv")
response["Content-Disposition"] = f"attachment; filename=traveller_list_{date.today()}.csv"
writer = csv.DictWriter(response, fieldnames=traveller_list[0].keys())
writer.writeheader()
writer.writerows(traveller_list)
return response
class TravellerRollMixin:
def confirmation_letter(self, request, queryset):
return render_to_pdf('mail/confirmation_letter.html', confirmation_letter_context(queryset))
def send_sms(self, request, queryset):
return send_sms(self, request, queryset)
def export_to_csv(self, request, queryset):
traveller_list = traveller_roll_context(queryset)
response = HttpResponse(content_type="text/csv")
response["Content-Disposition"] = f"attachment; filename=traveller_list_{date.today()}.csv"
writer = csv.DictWriter(response, fieldnames=traveller_list[0].keys())
writer.writeheader()
writer.writerows(traveller_list)
return response
+90
View File
@@ -0,0 +1,90 @@
from django.db.models import Q
from transport.models import Bus
from traveller.models import TravellerRoute
def school_roll_context(queryset, date=None):
school_list = []
for school in queryset:
school_routes = []
query = Q(traveller__school=school) | Q(traveller__shuttle__school=school)
for bus in Bus.objects.all():
travellers = []
for trav_route in TravellerRoute.objects.filter(query).filter(busStop__bus=bus).order_by('busStop__am_time'):
traveller = trav_route.traveller
if not traveller._is_active(date):
continue
bus_stop = trav_route.busStop
display_name = f"{traveller} ({traveller.get_year_level_display()})"
if traveller.school != school:
display_name = f"{traveller} ({traveller.get_year_level_display()}, {traveller.school.shortName})"
is_fared = "---"
if traveller.eligibility_status == "2":
is_fared = "Y"
shuttle_name = " "
if traveller.shuttle:
shuttle_name = traveller.shuttle.bus
travellers.append({
'display': display_name,
'isFared': is_fared,
'shuttle': shuttle_name,
'stop': f"#{bus_stop.get_stop_number()} - {bus_stop.address}",
'am_time': bus_stop.am_time,
'pm_time': bus_stop.pm_time
})
if travellers:
school_routes.append({
'bus': bus,
'travellers': travellers
})
school_list.append({"name": school.name, "routes": school_routes})
return {"schools": school_list}
def traveller_route_context(traveller_route):
traveller = traveller_route.traveller
bus_stop = traveller_route.busStop
families = traveller.get_families()
address = ""
for family in families:
if address:
address += ";"
address = address + f"{family.residential_address} {family.residential_suburb}"
return {
'first_name': traveller.first_name,
'last_name': traveller.last_name,
'active': traveller.is_active,
'school': traveller.school,
'dob': traveller.dob,
'year_level': traveller.year_level,
'address': address,
'start_date': traveller.travel_start_date,
'end_date': traveller.travel_end_date,
'eligibility': traveller.get_eligibility_status_display(),
'shuttle': traveller.shuttle,
'route': traveller_route.busStop.bus,
'stop': f"#{bus_stop.get_stop_number()} - {bus_stop.address}",
'pickup': bus_stop.am_time,
'drop-off': bus_stop.pm_time
}
def traveller_roll_context(queryset):
travellers = []
for traveller in queryset:
for traveller_route in TravellerRoute.objects.filter(traveller=traveller):
travellers.append(traveller_route_context(traveller_route))
return travellers
def confirmation_letter_context(queryset):
travellers = []
for traveller in queryset:
for travellerRoute in TravellerRoute.objects.filter(traveller=traveller):
travellers.append({
'traveller': traveller,
'stop': travellerRoute.busStop,
'shuttle': traveller.shuttle,
})
return {'travellers': travellers}
+292 -1
View File
@@ -1,3 +1,294 @@
from datetime import datetime
import phonenumbers
from django.core.exceptions import ValidationError
from django.db import models
# Create your models here.
from common.models import Suburb
class School(models.Model):
name = models.CharField(max_length=30, unique=True)
shortName = models.CharField(max_length=10, unique=True)
address = models.CharField(max_length=50)
suburb = models.ForeignKey(Suburb, on_delete=models.CASCADE)
email = models.CharField(max_length=50, blank=True)
phone = models.CharField(max_length=15, blank=True)
principal_name = models.CharField(max_length=50, blank=True)
principal_phone = models.CharField(max_length=15, blank=True)
notes = models.TextField(blank=True)
def __str__(self):
return self.name
class Traveller(models.Model):
YEAR = [
("PS", "PreSchool"),
("00", "Year 00"),
("01", "Year 01"),
("02", "Year 02"),
("03", "Year 03"),
("04", "Year 04"),
("05", "Year 05"),
("06", "Year 06"),
("07", "Year 07"),
("08", "Year 08"),
("09", "Year 09"),
("10", "Year 10"),
("11", "Year 11"),
("12", "Year 12"),
("AL", "Adult Learner"),
]
ELIGIBILITY_STATUS = [
("1", "Eligible"),
("2", "Ineligible"),
("3", "<4.8 Exemption"),
("4", "Eligible waitlisted"),
("5", "Ineligible waitlisted"),
("6", "Kinder Exemption"),
("7", "Tafe/Post Secondary Exemption"),
("8", "Other Exemption"),
]
school = models.ForeignKey(School, on_delete=models.PROTECT)
first_name = models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
dob = models.DateField(blank=True, null=True)
year_level = models.CharField(max_length=2, choices=YEAR)
bus_stops = models.ManyToManyField("transport.BusStop", through='TravellerRoute', blank=True)
distance_to_school = models.PositiveSmallIntegerField(blank=True, null=True)
address = models.CharField(max_length=100, default="")
travel_start_date = models.DateField(blank=True, null=True)
travel_end_date = models.DateField(blank=True, null=True)
eligibility_status = models.CharField(max_length=1, choices=ELIGIBILITY_STATUS)
assessment_date = models.DateField(blank=True, null=True)
fee_per_term = models.DecimalField(decimal_places=2, max_digits=5, blank=True, null=True)
term_1_paid = models.BooleanField(default=False)
term_2_paid = models.BooleanField(default=False)
term_3_paid = models.BooleanField(default=False)
term_4_paid = models.BooleanField(default=False)
application_form_completed = models.BooleanField()
parent_notified = models.BooleanField()
seat_number = models.CharField(max_length=5, blank=True)
created_on = models.DateTimeField(auto_now_add=True, blank=True, null=True)
last_edit = models.DateTimeField(auto_now=True, blank=True, null=True)
is_archived = models.BooleanField(default=False, verbose_name="Archived")
is_active = models.BooleanField(default=False, verbose_name='Active')
notes = models.TextField(blank=True, verbose_name='Admin Notes')
shuttle = models.ForeignKey("transport.Shuttle", on_delete=models.SET_NULL, blank=True, null=True)
class Meta:
ordering = ["last_name", "first_name"]
def __str__(self):
return f"{self.first_name} {self.last_name}"
def save(self, *args, **kwargs):
self._update_active_status()
self._repopulate_address()
super(Traveller, self).save(*args, **kwargs)
def _is_active(self, date=None):
if date is None:
today = datetime.today()
date = datetime(today.year, today.month, today.day)
if not self.travel_start_date or datetime(self.travel_start_date.year, self.travel_start_date.month, self.travel_start_date.day) > date:
return False
if not self.travel_end_date:
return True
end_date = datetime(self.travel_end_date.year, self.travel_end_date.month, self.travel_end_date.day)
return end_date >= date
def _update_active_status(self):
new_start_date = None
new_end_date = None
for travellerRoute in TravellerRoute.objects.filter(traveller=self.id):
route_start = travellerRoute.travel_start_date
route_end = travellerRoute.travel_end_date
if route_start is not None:
if new_start_date is None or new_start_date > route_start:
new_start_date = route_start
if route_end is not None:
if new_end_date is None or new_end_date < route_end:
new_end_date = route_end
self.travel_start_date = new_start_date
self.travel_end_date = new_end_date
self.is_active = self._is_active()
def fare_paying(self):
if self.eligibility_status != "2":
return
cost_setting = 0
if not cost_setting.exists():
return "TERM_TRAVEL_COST not configured"
cost = int(cost_setting.get().value)
stops = 0
for stop in TravellerRoute.objects.filter(traveller=self.id):
stops += stop.active_stops()
if stops > 1:
stops = 1
return f"${round(cost*stops)}"
def _repopulate_address(self):
families = self.get_families()
if families.count() == 0:
self.address = ""
elif families.count() == 1:
family = families.first()
self.address = f"{family.residential_address} {family.residential_suburb}"
else:
self.address = "Multiple"
def get_families(self):
return Family.objects.filter(traveller__id__exact=self.id)
class Family(models.Model):
RELATIONS = [
("1", "Parent"),
("2", "Step-Parent"),
("3", "Foster Parent"),
("4", "Host Family"),
("5", "Sibling"),
("6", "Grandparent"),
("7", "Aunt/Uncle"),
("8", "Cousin"),
("9", "Carer"),
("10", "Case Worker"),
("11", "Friend/Other"),
]
traveller = models.ForeignKey(Traveller, on_delete=models.CASCADE)
residential_address = models.CharField(max_length=50, blank=True)
residential_suburb = models.ForeignKey(Suburb, on_delete=models.PROTECT, blank=True, null=True,
related_name='family_residential_suburb')
postal_address = models.CharField(max_length=50, blank=True)
postal_suburb = models.ForeignKey(Suburb, on_delete=models.PROTECT, blank=True, null=True,
related_name='family_postal_suburb')
parent_A_firstname = models.CharField(max_length=50, blank=True)
parent_A_lastname = models.CharField(max_length=50, blank=True)
parent_A_phone = models.CharField(max_length=15, blank=True)
parent_A_email = models.CharField(max_length=50, blank=True)
parent_B_firstname = models.CharField(max_length=50, blank=True)
parent_B_lastname = models.CharField(max_length=50, blank=True)
parent_B_phone = models.CharField(max_length=15, blank=True)
parent_B_email = models.CharField(max_length=50, blank=True)
emergency_contact_A_firstname = models.CharField(max_length=50, blank=True)
emergency_contact_A_lastname = models.CharField(max_length=50, blank=True)
emergency_contact_A_phone = models.CharField(max_length=15, blank=True)
emergency_contact_A_relation = models.CharField(max_length=50, choices=RELATIONS, blank=True)
emergency_contact_B_firstname = models.CharField(max_length=50, blank=True)
emergency_contact_B_lastname = models.CharField(max_length=50, blank=True)
emergency_contact_B_phone = models.CharField(max_length=15, blank=True)
emergency_contact_B_relation = models.CharField(max_length=50, choices=RELATIONS, blank=True)
created_on = models.DateTimeField(auto_now_add=True, blank=True, null=True)
last_edit = models.DateTimeField(auto_now=True, blank=True, null=True)
class Meta:
verbose_name_plural = "Families"
def __str__(self):
return self.parent_names()
def clean(self):
valid_numbers, failed_numbers = self.get_parsed_numbers(True, True)
if len(failed_numbers) > 0:
raise ValidationError(f"Phone number {failed_numbers[0]} not valid")
def parent_names(self):
a_name = self.parent_A_firstname
b_name = self.parent_B_firstname
if a_name:
if b_name:
return f"{a_name} and {b_name}"
return a_name
elif b_name:
return b_name
return ""
def get_parsed_numbers(self, parents=False, emergency=False):
numbers = []
if parents:
if self.parent_A_phone:
numbers.append(self.parent_A_phone)
if self.parent_B_phone:
numbers.append(self.parent_B_phone)
if emergency:
if self.emergency_contact_A_phone:
numbers.append(self.emergency_contact_A_phone)
if self.emergency_contact_B_phone:
numbers.append(self.emergency_contact_B_phone)
valid_numbers = []
failed_numbers = []
for number in numbers:
try:
num = phonenumbers.parse(number, "AU")
if phonenumbers.is_valid_number(num):
valid_numbers.append(f"+{num.country_code}{num.national_number}")
else:
failed_numbers.append(number)
except:
failed_numbers.append(number)
return valid_numbers, failed_numbers
class TravellerRoute(models.Model):
traveller = models.ForeignKey(Traveller, on_delete=models.CASCADE)
busStop = models.ForeignKey("transport.BusStop", on_delete=models.CASCADE)
travel_start_date = models.DateField(blank=True, null=True)
travel_end_date = models.DateField(blank=True, null=True)
mon_am = models.BooleanField(default=True)
mon_pm = models.BooleanField(default=True)
tue_am = models.BooleanField(default=True)
tue_pm = models.BooleanField(default=True)
wen_am = models.BooleanField(default=True)
wen_pm = models.BooleanField(default=True)
thu_am = models.BooleanField(default=True)
thu_pm = models.BooleanField(default=True)
fri_am = models.BooleanField(default=True)
fri_pm = models.BooleanField(default=True)
notes = models.TextField(blank=True, verbose_name="Driver Notes")
created_on = models.DateTimeField(auto_now_add=True, blank=True, null=True)
last_edit = models.DateTimeField(auto_now=True, blank=True, null=True)
def __str__(self):
return f"{self.busStop}"
def save(self, *args, **kwargs):
super(TravellerRoute, self).save(*args, **kwargs)
self.traveller.save()
def active_stops(self):
stops = 0
if self.mon_am:
stops += 1
if self.mon_pm:
stops += 1
if self.tue_am:
stops += 1
if self.tue_pm:
stops += 1
if self.wen_am:
stops += 1
if self.wen_pm:
stops += 1
if self.thu_am:
stops += 1
if self.thu_pm:
stops += 1
if self.fri_am:
stops += 1
if self.fri_pm:
stops += 1
return stops * 0.1
+15 -1
View File
@@ -1,3 +1,17 @@
from django.contrib.admin.views.decorators import staff_member_required
from django.http import HttpResponseRedirect
from django.shortcuts import render
# Create your views here.
from messaging.services.sms import SMSForm
@staff_member_required
def sms_message(request, queryset):
if request.method == 'POST':
form = SMSForm(request.POST)
if form.is_valid():
HttpResponseRedirect(request.get_full_path())
else:
form = SMSForm()
return render(request, 'admin/sms_form.html', context={'form': form, 'travellers': queryset})