Files
penracourses/generic/tables.py
T

450 lines
18 KiB
Python

from django.urls import reverse
import django_tables2 as tables
from django_tables2.utils import A
from django.utils.html import format_html
from django.utils.safestring import mark_safe
from easy_thumbnails.files import get_thumbnailer
from easy_thumbnails.exceptions import InvalidImageFormatError
from generic.models import CidUser, Examination, Supervisor, findMiddle
from django.contrib.auth.models import User
# Generic selection-enabled table base class.
# Inherit from this class to automatically get a selection checkbox
# column (input name="selection") and table attrs that client-side
# scripts can use to find selectable tables.
class SelectionTable(tables.Table):
# Provide a default selection checkbox column. Subclasses that wish to
# customise can override this attribute.
selection = tables.CheckBoxColumn(
accessor="pk",
orderable=False,
attrs={
'th': {'class': 'selection-col'},
'td': {'class': 'selection-col'},
'input': {'name': 'selection'},
},
verbose_name=''
)
class Meta:
# Defaults: add js-row-selectable class so client-side code can
# locate tables that support row selection.
attrs = {"class": "table js-row-selectable", "data-selection-name": "selection"}
def __init__(self, *args, **kwargs):
# Ensure selection column is always placed last in the column order
# so that table actions/controls appear to the right. We attempt to
# reorder columns after initialization; if django-tables2 provides
# `reorder_columns`, use it, otherwise fall back to setting
# `self.sequence`.
super().__init__(*args, **kwargs)
try:
cols = list(self.columns.names())
if 'selection' in cols:
cols.remove('selection')
cols.append('selection')
try:
# Preferred API when available
self.reorder_columns(cols)
except Exception:
# Fallback: set sequence attribute
self.sequence = tuple(cols)
except Exception:
# Defensive: don't break table rendering if introspection fails
pass
# Expose a per-instance selection token and ensure the table has the
# `js-row-selectable` class so client-side scripts (or the inline
# initializer below) can find the correct table without extra markup
# in templates.
try:
token = format(id(self), 'x')
attrs = getattr(self, 'attrs', None) or {}
classes = attrs.get('class', '')
if 'js-row-selectable' not in classes:
attrs['class'] = (classes + ' js-row-selectable').strip()
attrs['data-selection-token'] = token
self.attrs = attrs
except Exception:
# non-fatal
pass
# By default render the row selection controls above the table so
# templates don't need to include `{{ table.row_selection_controls }}`.
try:
# `row_selection_controls` is already marked safe HTML.
self.caption = self.row_selection_controls
except Exception:
pass
@property
def row_selection_controls(self):
"""Return HTML for the row-selection control bar.
Usage: render in template with `{{ table.row_selection_controls|safe }}`
The control IDs are suffixed with a small per-instance token to
avoid collisions when multiple tables are present on the same page.
"""
token = (self.attrs or {}).get('data-selection-token', format(id(self), 'x'))
html = (
"<div class=\"d-flex justify-content-between align-items-center mb-2\">"
" <div>"
" <button class=\"btn btn-outline-secondary btn-sm\" id=\"toggle-row-selection-{}\" type=\"button\">Enable row selection</button>"
" <div id=\"selection-controls-{}\" class=\"btn-group ms-2\" role=\"group\" style=\"display:none;\">"
" <button type=\"button\" class=\"btn btn-sm btn-outline-primary\" id=\"select-all-{}\">Select all</button>"
" <button type=\"button\" class=\"btn btn-sm btn-outline-secondary\" id=\"clear-selection-{}\">Clear</button>"
" </div>"
" </div>"
" <div>"
" <small class=\"text-muted\">Selected: <span id=\"selected-count-{}\">0</span></small>"
" </div>"
"</div>"
).format(token, token, token, token, token)
# Append a small inline initializer that wires the controls to the
# specific table instance. This moves the behaviour into the server
# side table class so pages don't need global wiring.
script = (
"<script>(function(){"
"var token='{t}';"
"var toggleBtn=document.getElementById('toggle-row-selection-'+token);"
"if(!toggleBtn) return;"
"var controlsEl=document.getElementById('selection-controls-'+token);"
"var selectAllBtn=document.getElementById('select-all-'+token);"
"var clearBtn=document.getElementById('clear-selection-'+token);"
"var selectedCountSpan=document.getElementById('selected-count-'+token);"
"var table=document.querySelector('table.js-row-selectable[data-selection-token=\"'+token+'\"]');"
"if(!table) return;"
"var selectionEnabled=false;"
"function findRowCheckboxes(){"
" var checks=Array.from(table.querySelectorAll('input[type=\"checkbox\"][name=\"selection\"]'));"
" if(!checks.length) checks=Array.from(table.querySelectorAll('input[type=\"checkbox\"]'));"
" return checks;"
"}"
"function updateSelectedCount(){ if(!selectedCountSpan) return; var checks=findRowCheckboxes(); var count=checks.filter(function(c){return c.checked;}).length; selectedCountSpan.textContent=count; checks.forEach(function(cb){var tr=cb.closest('tr'); if(tr) tr.classList.toggle('table-active', cb.checked);}); }"
"function setCheckboxesDisabled(disabled){ findRowCheckboxes().forEach(function(cb){ cb.disabled=disabled; }); }"
"function hideSelectionColumn(){ table.querySelectorAll('th, td').forEach(function(cell){ if(cell.querySelector && cell.querySelector('input[type=\"checkbox\"][name=\"selection\"]')) cell.style.display='none'; }); }"
"function showSelectionColumn(){ table.querySelectorAll('th, td').forEach(function(cell){ if(cell.querySelector && cell.querySelector('input[type=\"checkbox\"][name=\"selection\"]')) cell.style.display=''; }); }"
"setCheckboxesDisabled(true); hideSelectionColumn();"
"table.addEventListener('click', function(e){ if(!selectionEnabled) return; var tag=(e.target.tagName||'').toLowerCase(); if(['input','a','button','select','textarea','label'].indexOf(tag)!==-1) return; var tr=e.target.closest('tr'); if(!tr||!table.contains(tr)) return; var cb=tr.querySelector('input[type=\"checkbox\"][name=\"selection\"]')||tr.querySelector('input[type=\"checkbox\"]'); if(cb && !cb.disabled){ cb.checked=!cb.checked; tr.classList.toggle('table-active', cb.checked); updateSelectedCount(); } }, true);"
"table.addEventListener('change', function(e){ if(e.target && e.target.matches && e.target.matches('input[type=\"checkbox\"]')) updateSelectedCount(); }, true);"
"toggleBtn.addEventListener('click', function(){ selectionEnabled=!selectionEnabled; if(selectionEnabled){ toggleBtn.textContent='Disable row selection'; if(controlsEl) controlsEl.style.display=''; setCheckboxesDisabled(false); showSelectionColumn(); } else { toggleBtn.textContent='Enable row selection'; if(controlsEl) controlsEl.style.display='none'; setCheckboxesDisabled(true); hideSelectionColumn(); findRowCheckboxes().forEach(function(cb){ cb.checked=false; }); updateSelectedCount(); } });"
"if(selectAllBtn) selectAllBtn.addEventListener('click', function(){ findRowCheckboxes().forEach(function(cb){ if(!cb.disabled) cb.checked=true; }); updateSelectedCount(); });"
"if(clearBtn) clearBtn.addEventListener('click', function(){ findRowCheckboxes().forEach(function(cb){ if(!cb.disabled) cb.checked=false; }); updateSelectedCount(); });"
"updateSelectedCount();"
"})();</script>"
).format(t=token)
return mark_safe(html + script)
class SingleImageColumn(tables.Column):
def render(self, value):
try:
thumbnailer = get_thumbnailer(value)
return format_html('<img src="/media/{}" />', thumbnailer["exam-list"])
except InvalidImageFormatError:
return format_html('<span title="{}">Invalid image url<span>', value)
class BlockImageColumn(tables.Column):
def render(self, value):
blocks = []
for obj in value.all():
blocks.append(obj.get_block())
return mark_safe(
"""<span class='multi-image-block'>
{}
</span>""".format("".join(blocks))
)
class SeriesImageColumn(tables.Column):
def render(self, value):
#obj = value.first()
images = value.all()
if not images:
return mark_safe('<span>None</span><br/>')
obj = findMiddle(images)
if obj is None:
return "None"
image_object = obj.image
try:
thumbnailer = get_thumbnailer(image_object)
return format_html(
'<img src="/media/{}" /><br/>[{}]',
thumbnailer["exam-list"],
value.count(),
)
except InvalidImageFormatError:
return format_html(
'<span title="{}">Invalid image url<span><br/>[{}]',
image_object,
value.count(),
)
class FirstImageColumn(tables.Column):
def render(self, value):
obj = value.all()
if not obj:
return mark_safe('<span>No image</span>')
image_object = obj[0].image
try:
thumbnailer = get_thumbnailer(image_object)
return format_html('<img src="/media/{}" />', thumbnailer["exam-list"])
except InvalidImageFormatError:
return format_html('<span title="{}">Invalid image url<span>', image_object)
class CidUserTable(SelectionTable):
cid = tables.LinkColumn(
"cid_scores", args=[A("cid"), A("passcode")], orderable=True
)
# physics_exams = tables.ManyToManyColumn(verbose_name="Physics Exams")
# rapid_exams = tables.ManyToManyColumn(verbose_name="Rapid Exams")
# sba_exams = tables.ManyToManyColumn(verbose_name="SBA Exams")
# longs_exams = tables.ManyToManyColumn(verbose_name="Long Exams")
# anatomy_exams = tables.ManyToManyColumn(verbose_name="Anatomy Exams")
group = tables.Column(linkify=True)
#selection = tables.CheckBoxColumn(accessor="pk", orderable=False)
emails = tables.Column(empty_values=(), orderable=False)
edit = tables.LinkColumn(
"generic:update_cid", text="Edit", args=[A("pk")], orderable=True
)
class Meta(SelectionTable.Meta):
model = CidUser
template_name = "django_tables2/bootstrap4.html"
fields = (
# "cid",
"passcode",
"active",
"group",
"internal_candidate",
# "email",
)
sequence = ("cid", "passcode", "active", "internal_candidate", "emails")
def __init__(self, data=None, *args, **kwargs):
super().__init__(
data.prefetch_related("group"),
*args,
**kwargs,
)
def render_emails(self, value, record):
print(self)
if record.supervisor is not None:
return format_html("""{}\n[{}]""", record.email, record.supervisor.email)
else:
return record.email
class CidUserExamTable(SelectionTable):
cid = tables.LinkColumn(
"cid_scores", args=[A("cid"), A("passcode")], orderable=True
)
physics_exams = tables.ManyToManyColumn(verbose_name="Physics Exams")
rapid_exams = tables.ManyToManyColumn(verbose_name="Rapid Exams")
sba_exams = tables.ManyToManyColumn(verbose_name="SBA Exams")
longs_exams = tables.ManyToManyColumn(verbose_name="Long Exams")
anatomy_exams = tables.ManyToManyColumn(verbose_name="Anatomy Exams")
#selection = tables.CheckBoxColumn(accessor="pk", orderable=False)
emails = tables.Column(empty_values=(), orderable=False)
edit = tables.LinkColumn(
"generic:update_cid", text="Edit", args=[A("pk")], orderable=True
)
class Meta(SelectionTable.Meta):
model = CidUser
template_name = "django_tables2/bootstrap4.html"
fields = (
# "cid",
"passcode",
"active",
"group",
"internal_candidate",
# "email",
)
sequence = ("cid", "passcode", "active", "internal_candidate", "emails")
def __init__(self, data=None, *args, **kwargs):
super().__init__(
data.prefetch_related(
"physics_exams",
"rapid_exams",
"sba_exams",
"anatomy_exams",
"longs_exams",
"group",
),
*args,
**kwargs,
)
def render_emails(self, value, record):
if record.supervisor is not None:
return format_html("""{}\n[{}]""", record.email, record.supervisor.email)
else:
return record.email
# def render_cid(self, value, record):
# return format_html("""<a href="#" onclick="return window.create_popup_window('/longs/series/{}', 'Series')" >Popup</a>""", record.pk)
class UserUserTable(SelectionTable):
user = tables.Column(
linkify={"viewname": "account_profile", "args": [A("username")]},
orderable=True,
verbose_name="User",
empty_values=(),
)
supervisor = tables.Column(
linkify={
"viewname": "generic:supervisor_detail",
"args": [A("userprofile__supervisor__pk")],
},
orderable=True,
verbose_name="Supervisor",
accessor=A("userprofile__supervisor"),
)
#selection = tables.CheckBoxColumn(accessor="pk", orderable=False)
edit = tables.Column(
empty_values=(),
linkify={"viewname": "account_update", "args": [A("username")]},
orderable=False,
verbose_name="Edit",
)
admin_edit = tables.Column(
empty_values=(),
linkify={"viewname": "admin:auth_user_change", "args": [A("pk")]},
orderable=False,
verbose_name="Admin",
)
user_groups = tables.ManyToManyColumn(verbose_name="Groups", linkify_item=True)
date_joined = tables.DateTimeColumn(format="Y/m/d")
class Meta(SelectionTable.Meta):
model = User
template_name = "django_tables2/bootstrap4.html"
fields = (
# "cid",
# "userprofile",
"userprofile__grade",
"date_joined",
# "user_groups",
# "userprofile.supervisor",
# "email",
)
sequence = (
"user",
"userprofile__grade",
"supervisor",
"user_groups",
"date_joined",
"edit",
"admin_edit",
)
def __init__(self, data=None, *args, **kwargs):
super().__init__(
data.prefetch_related(
"userprofile",
"user_groups",
"userprofile__grade",
"supervisor",
),
*args,
**kwargs,
)
# This should be avoidable?
def render_edit(self, value, record):
return "Edit"
def render_admin_edit(self, value, record):
return "Admin"
def render_user(self, value, record):
span_class = ""
if record.userprofile.peninsula_trainee:
span_class = "peninsula-trainee"
return format_html(
"<div style='flex-flow: row wrap; display: flex;'><div class='{}'></div><div>{} {}<br/>{}<br/>{}</div></div>",
span_class,
record.first_name,
record.last_name,
record.username,
record.email,
)
class ExaminationTable(SelectionTable):
examination = tables.Column(
linkify=("generic:examination_detail", {"pk": tables.A("pk")}),
verbose_name="Condition",
)
#edit = tables.LinkColumn(
# "generic:examination_update", text="Edit", args=[A("pk")], orderable=False
#)
delete = tables.LinkColumn(
"generic:examination_delete", text="Delete", args=[A("pk")], orderable=False
)
#selection = tables.CheckBoxColumn(accessor="pk", orderable=False)
# synonym = tables.ManyToManyColumn(verbose_name="Synonyms")
#synonym = tables.Column(empty_values=())
#parent = tables.ManyToManyColumn(verbose_name="Parents")
class Meta(SelectionTable.Meta):
model = Examination
template_name = "django_tables2/bootstrap4.html"
#fields = ("primary", "subspecialty")
sequence = ("examination",)
class SupervisorTable(SelectionTable):
name = tables.Column(
linkify=("generic:supervisor_detail", {"pk": tables.A("pk")}),
verbose_name="Name",
)
# We don't use a link column as we want to add a redirect parameter
edit = tables.Column(
accessor="pk", orderable=False
)
class Meta(SelectionTable.Meta):
model = Supervisor
template_name = "django_tables2/bootstrap4.html"
sequence = ("name", "email")
exclude = ("id",)
SelectionTable.Meta.attrs.update({"id": "supervisor-table"})
def render_edit(self, value, record):
url = f"{reverse("generic:supervisor_edit", args=[record.pk])}?redirect={self.request.path}"
return format_html("<a href='{}'>Edit</a>", url)