2
0
mirror of https://expo.survex.com/repositories/troggle/.git synced 2024-12-19 15:02:17 +00:00
troggle/core/models/logbooks.py

291 lines
11 KiB
Python
Raw Normal View History

2023-08-31 16:55:20 +01:00
import re
2023-01-29 16:47:46 +00:00
from pathlib import Path
from urllib.parse import urljoin
from django.db import models
2023-08-31 16:55:20 +01:00
from django.template import loader
2024-12-15 18:54:47 +00:00
from django.urls import reverse
2023-01-29 16:47:46 +00:00
import settings
2023-01-30 23:04:11 +00:00
from troggle.core.models.troggle import Expedition, TroggleModel
2023-01-29 16:47:46 +00:00
"""The model declarations LogBookEntry, PersonLogEntry, QM
"""
todo = """
"""
2023-01-29 16:47:46 +00:00
2023-01-29 16:47:46 +00:00
class LogbookEntry(TroggleModel):
2023-03-06 16:37:38 +00:00
"""Single parsed entry from Logbook
Gets deleted if the Expedition gets deleted"""
date = (
models.DateField()
2023-10-21 20:31:33 +01:00
)
expedition = models.ForeignKey(Expedition, blank=True, null=True, on_delete=models.CASCADE)
title = models.CharField(max_length=200)
cave = models.ForeignKey("Cave", blank=True, null=True, on_delete=models.SET_NULL)
place = models.CharField(
max_length=100, blank=True, null=True, help_text="Only use this if you haven't chosen a cave"
)
2023-09-02 12:49:43 +01:00
other_people = models.CharField(max_length=200, blank=True, null=True) # foreign_friends and *guests
text = models.TextField()
2023-08-31 16:55:20 +01:00
slug = models.SlugField(max_length=50) # this is tripid
time_underground = models.FloatField(null=True, help_text="In decimal hours")
2023-01-29 16:47:46 +00:00
class Meta:
verbose_name_plural = "Logbook Entries"
2023-01-30 16:18:19 +00:00
# several PersonLogEntrys point in to this object
ordering = ("-date",)
2023-01-29 16:47:46 +00:00
def isLogbookEntry(self): # Function used in templates
2023-01-29 16:47:46 +00:00
return True
def get_absolute_url(self):
# we do not use URL_ROOT any more.
return reverse("logbookentry", kwargs={"date": self.date, "slug": self.slug})
2023-01-29 16:47:46 +00:00
def __str__(self):
return f"{self.date}: {self.title}"
2023-01-29 16:47:46 +00:00
def get_participants(self):
'''the string that goes into an edited or rewritten logbook entry
which replaces this horrendous Django template code:
<div class="trippeople">{% for personlogentry in logbook_entry.personlogentry_set.all %}{% if personlogentry.is_logbook_entry_author %}<u>{% if personlogentry.nickname_used %}{{personlogentry.nickname_used|safe}}{% else %}{{personlogentry.personexpedition.person|safe}}{% endif %}</u>,{% endif %}{% endfor %}{% for personlogentry in logbook_entry.personlogentry_set.all %}{% if personlogentry.is_logbook_entry_author %}{% else %}{% if personlogentry.nickname_used %}{{personlogentry.nickname_used|safe}}{% else %}{{personlogentry.personexpedition.person|safe}}{% endif %},{% endif %}{% endfor %}{% if logbook_entry.other_people %}, {{logbook_entry.other_people}}{% endif %}</div>
'''
author = (
PersonLogEntry.objects.filter(logbook_entry=self, is_logbook_entry_author=True)
.first()
)
if author.nickname_used:
expoer = author.nickname_used
else:
expoer = author.personexpedition.person.name()
names = f"<u>{expoer}</u>"
participants = (
PersonLogEntry.objects.filter(logbook_entry=self, is_logbook_entry_author=False)
.order_by("personexpedition__person__slug")
.all()
)
for p in participants:
if p.nickname_used:
expoer = p.nickname_used
else:
expoer = p.personexpedition.person.name()
names += f", {expoer}"
if self.other_people:
names += f", {self.other_people}"
return names
2023-01-29 16:47:46 +00:00
def get_next_by_id(self):
LogbookEntry.objects.get(id=self.id + 1)
2023-01-29 16:47:46 +00:00
def get_previous_by_id(self):
LogbookEntry.objects.get(id=self.id - 1)
2023-01-29 16:47:46 +00:00
def DayIndex(self):
"""This is used to set different colours for the different trips on
the calendar view of the expedition"""
2023-01-30 15:28:11 +00:00
mx = 10
todays = list(LogbookEntry.objects.filter(date=self.date))
if self in todays:
index = todays.index(self)
else:
2023-07-14 10:13:06 +01:00
print(f"DayIndex: Synchronization error in logbook entries. Restart server or do full reset. {self}")
index = 0
2023-01-30 15:28:11 +00:00
if index not in range(0, mx):
2023-07-14 10:13:06 +01:00
print(f"DayIndex: More than {mx-1} LogbookEntry items on one day '{index}' {self}, restarting colour sequence.")
index = index % mx
return index
2023-08-31 16:55:20 +01:00
def writelogbook(year, filename):
"""Writes all the database logbook entries into a new logbook.html file
"""
2023-08-31 16:55:20 +01:00
current_expedition = Expedition.objects.get(year=year)
logbook_entries = LogbookEntry.objects.filter(expedition=current_expedition).order_by(
"slug"
) # now that slug, aka tripid, is in our standard date form, this will preserve ordering.
2023-09-02 17:23:22 +01:00
print(f" - Logbook to be exported has {len(logbook_entries)} entries in it.")
2023-08-31 16:55:20 +01:00
2023-09-02 17:23:22 +01:00
try:
t = loader.get_template("logbook2005style.html")
2023-09-02 17:23:22 +01:00
logbookfile = t.render({"logbook_entries": logbook_entries})
except:
print(" ! Very Bad Error RENDERING template " + template)
raise
# print(" - template rendered")
2023-09-02 17:23:22 +01:00
try:
2023-08-31 16:55:20 +01:00
try:
endpath = Path(settings.EXPOWEB, "years", str(year), "endmatter.html")
2023-08-31 16:55:20 +01:00
except:
2023-09-02 17:23:22 +01:00
print(" ! FAIL Path " + {(settings.EXPOWEB, "years", year, "endmatter.html")})
raise
# print(f" - endpath {endpath}")
2023-09-02 17:23:22 +01:00
endmatter = ""
if endpath.is_file():
# print(" - endpath")
2023-09-02 17:23:22 +01:00
try:
with open(endpath, "r") as end:
endmatter = end.read()
except:
print(" ! Very Bad Error opening " + endpath)
raise
2023-09-02 17:23:22 +01:00
except:
print(" ! FAIL endpath " + endpath)
raise
# print(" - endpath opened")
2023-08-31 16:55:20 +01:00
frontpath = Path(settings.EXPOWEB, "years", str(year), "frontmatter.html")
2023-08-31 16:55:20 +01:00
if frontpath.is_file():
try:
with open(frontpath, "r") as front:
frontmatter = front.read()
except:
print(" ! Very Bad Error opening " + frontpath)
logbookfile = re.sub(r"<body>", "<body>\n" + frontmatter + endmatter, logbookfile)
else:
logbookfile = re.sub(r"<body>", f"<body>\n<h1>Expo {year}</h1>\n" + endmatter, logbookfile)
dir = Path(settings.EXPOWEB) / "years" / str(year)
2023-08-31 16:55:20 +01:00
filepath = Path(dir, filename)
2023-09-02 17:23:22 +01:00
try:
with (open(filepath, "w")) as lb:
lb.writelines(logbookfile)
except:
print(" ! Very Bad Error writing to " + filepath)
raise
2023-08-31 16:55:20 +01:00
# print(f'Logbook exported to {filepath}')
2023-01-30 16:18:19 +00:00
class PersonLogEntry(TroggleModel):
"""Single Person going on a trip.
In future it could account for different T/U for people in same logbook entry.
2023-03-06 16:37:38 +00:00
CASCADE means that if the personexpedition or the logbookentry is deleted,
then this PersonLogEntry is deleted too
2023-01-29 16:47:46 +00:00
"""
personexpedition = models.ForeignKey("PersonExpedition", null=True, on_delete=models.CASCADE)
2023-01-29 16:47:46 +00:00
time_underground = models.FloatField(help_text="In decimal hours")
logbook_entry = models.ForeignKey(LogbookEntry, on_delete=models.CASCADE)
2023-01-29 16:47:46 +00:00
is_logbook_entry_author = models.BooleanField(default=False)
2023-08-26 16:39:29 +01:00
nickname_used = models.CharField(max_length=100,default="") # e.g. "Animal" or "Zonker", as it appears in the original logbook
2023-01-29 16:47:46 +00:00
class Meta:
ordering = ("nickname_used", "-personexpedition")
# order_with_respect_to = 'personexpedition' and then with nickname
# within the same logbook entry (which will always be the same expedition) this will
# now not re-order the participants in a trip every time we save the logbook.
# but this does not work.. need a function
2023-01-30 16:07:44 +00:00
def next_personlog(self):
futurePTs = (
PersonLogEntry.objects.filter(
personexpedition=self.personexpedition, logbook_entry__date__gt=self.logbook_entry.date
)
.order_by("logbook_entry__date")
.all()
)
2023-01-29 16:47:46 +00:00
if len(futurePTs) > 0:
return futurePTs[0]
else:
return None
2023-01-30 16:07:44 +00:00
def prev_personlog(self):
pastPTs = (
PersonLogEntry.objects.filter(
personexpedition=self.personexpedition, logbook_entry__date__lt=self.logbook_entry.date
)
.order_by("-logbook_entry__date")
.all()
)
2023-01-29 16:47:46 +00:00
if len(pastPTs) > 0:
return pastPTs[0]
else:
return None
def place(self):
return self.logbook_entry.cave and self.logbook_entry.cave or self.logbook_entry.place
def __str__(self):
return f"{self.personexpedition} ({self.logbook_entry.date})"
2023-01-29 16:47:46 +00:00
class QM(TroggleModel):
"""This is based on qm.csv in trunk/expoweb/1623/204 which has the fields:
"Number","Grade","Area","Description","Page reference","Nearest station","Completion description","Comment"
2023-03-14 16:11:37 +00:00
All the stuff handling TICK QMs is INCOMPLETE
2023-01-29 16:47:46 +00:00
"""
2023-03-16 21:06:52 +00:00
number = models.IntegerField(
help_text="this is the sequential number in the year, only unique for CSV imports",
)
2023-03-17 20:01:52 +00:00
grade = models.CharField(max_length=1, blank=True, null=True, help_text="A/B/C/D/X")
cave = models.ForeignKey("Cave", related_name="QMs", blank=True, null=True, on_delete=models.SET_NULL)
block = models.ForeignKey("SurvexBlock", null=True, on_delete=models.SET_NULL) # only for QMs from survex files
blockname = models.TextField(blank=True, null=True) # NB truncated copy of survexblock name with last char added
2023-03-17 20:01:52 +00:00
expoyear = models.CharField(max_length=4, blank=True, null=True)
ticked = models.BooleanField(default=False)
2023-03-18 03:03:06 +00:00
location_description = models.TextField(blank=True, null=True)
completion_description = models.TextField(blank=True, null=True)
2023-03-17 20:01:52 +00:00
completion_date = models.DateField(blank=True, null=True)
2023-03-16 21:06:52 +00:00
nearest_station_name = models.CharField(max_length=200, blank=True, null=True)
resolution_station_name = models.CharField(max_length=200, blank=True, null=True)
area = models.CharField(max_length=100, blank=True, null=True)
2023-03-17 20:01:52 +00:00
page_ref = models.TextField(blank=True, null=True)
comment = models.TextField(blank=True, null=True)
2023-01-29 16:47:46 +00:00
def __str__(self):
return f"{self.code()}"
2023-01-29 16:47:46 +00:00
def code(self):
if self.cave:
cavestr = str(self.cave.slug())[5:]
else:
cavestr = ""
if self.expoyear:
expoyearstr = str(self.expoyear)
else:
expoyearstr = str(self.cave.slug())[5:9]
if self.blockname:
blocknamestr = "-" + str(self.blockname)
else:
blocknamestr = ""
return f"{cavestr}-{expoyearstr}-{self.number}{self.grade}{blocknamestr}"
2023-01-29 16:47:46 +00:00
def newslug(self):
qmslug = f"{str(self.cave)}-{self.expoyear}-{self.blockname}{self.number}{self.grade}"
2023-01-29 16:47:46 +00:00
return qmslug
2023-01-29 16:47:46 +00:00
def get_absolute_url(self):
# This reverse resolution stuff is pure magic. Just change the regex in urls.py and everything changes to suit. Whacky.
return urljoin(
settings.URL_ROOT,
reverse(
"qm",
kwargs={
"cave_id": self.cave.slug(),
"year": self.expoyear,
"blockname": self.blockname,
"qm_id": self.number,
"grade": self.grade,
},
),
)
2023-03-17 20:01:52 +00:00
def get_next_by_id(self): # called in template
2023-03-17 14:33:30 +00:00
return QM.objects.get(id=self.id + 1)
2023-01-29 16:47:46 +00:00
2023-03-17 20:01:52 +00:00
def get_previous_by_id(self): # called in template
2023-03-17 14:33:30 +00:00
return QM.objects.get(id=self.id - 1)