mirror of
https://expo.survex.com/repositories/troggle/.git
synced 2024-11-24 16:21:53 +00:00
936 lines
39 KiB
Python
936 lines
39 KiB
Python
import os
|
|
import re
|
|
import subprocess
|
|
import tempfile
|
|
import zipfile
|
|
import urllib
|
|
from bs4 import BeautifulSoup
|
|
|
|
from pathlib import Path
|
|
|
|
from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist
|
|
from django.http import HttpResponse, HttpResponseNotFound, HttpResponseRedirect, FileResponse
|
|
from django.shortcuts import render, redirect
|
|
from django.urls import NoReverseMatch, reverse
|
|
|
|
import troggle.settings as settings
|
|
from troggle.core.forms import CaveAndEntranceFormSet, CaveForm, EntranceForm, EntranceLetterForm
|
|
from troggle.core.models.caves import Cave, CaveAndEntrance, Entrance, GetCaveLookup, get_cave_leniently
|
|
from troggle.core.models.logbooks import QM
|
|
from troggle.core.models.wallets import Wallet
|
|
from troggle.core.utils import write_and_commit
|
|
from troggle.core.utils import current_expo
|
|
from troggle.core.views import expo
|
|
from troggle.settings import CAVEDESCRIPTIONS, ENTRANCEDESCRIPTIONS
|
|
from troggle.parsers.caves import read_cave, read_entrance
|
|
|
|
from django.template import loader
|
|
from django.utils.safestring import mark_safe
|
|
|
|
from .auth import login_required_if_public
|
|
|
|
"""Manages the complex procedures to assemble a cave description out of the compnoents
|
|
Manages the use of cavern to parse survex files to produce 3d and pos files
|
|
"""
|
|
|
|
todo = """
|
|
- in getCaves() search GCavelookup first, which should raise a MultpleObjectsReturned
|
|
exception if no duplicates
|
|
|
|
- Learn to use Django .select_related() and .prefetch_related() to speed things up
|
|
especially on the big report pages
|
|
https://zerotobyte.com/how-to-use-django-select-related-and-prefetch-related/
|
|
|
|
- Remove all the URL rewriting which is there because we have not yet edited all the caves to use
|
|
our new (2023) standard addressing of /16xx/NNN/NNN.html where *all* caves are assumed to have their
|
|
own directory 16xx/NNN/ even if they have no images to put in it.
|
|
"""
|
|
|
|
# def cavepagefwd(request, karea=None, subpath=None):
|
|
# """archaic, just send to the caves list page
|
|
# """
|
|
# return redirect("/caves")
|
|
|
|
|
|
def get_cave_from_slug(caveslug):
|
|
"""Needs refactoring
|
|
"""
|
|
caves = []
|
|
|
|
print(f"get_cave_from_slug(): {caveslug} ...")
|
|
areacode = caveslug[:4] # e.g. 1623
|
|
id = caveslug[5:] # e.g. 161 or 2023-MM-02
|
|
thisarea = Cave.objects.filter(areacode=areacode)
|
|
|
|
caves_k = thisarea.filter(kataster_number=id)
|
|
if len(caves_k) == 1:
|
|
caves.append(caves_k[0])
|
|
print(f"get_cave_from_slug(): {caves_k=} {len(caves_k)=}")
|
|
|
|
caves_id = thisarea.filter(unofficial_number=id)
|
|
if len(caves_id) == 1:
|
|
caves.append(caves_id[0])
|
|
print(f"get_cave_from_slug(): {caves_id=} {len(caves_id)=}")
|
|
|
|
if len(caves) > 1:
|
|
print(f"get_cave_from_slug(): {caveslug} More than 1 \n{caves}")
|
|
return None
|
|
if len(caves) <1:
|
|
print(f"get_cave_from_slug(): {caveslug} Nowt found..")
|
|
return None
|
|
cave = caves[0]
|
|
print(f"get_cave_from_slug(): {caveslug} FOUND {cave}")
|
|
return cave
|
|
|
|
|
|
try:
|
|
cave_zero = Cave.objects.get(caveslug__slug=caveslug)
|
|
print(f"Getting cave from '{caveslug}'")
|
|
if cave_zero != cave:
|
|
print(f"get_cave_from_slug(): {caveslug} BAD DISCREPANCY {cave_zero=} {cave=}")
|
|
else:
|
|
print(f"get_cave_from_slug(): {caveslug} SUCCESS")
|
|
|
|
return cave_zero
|
|
except:
|
|
return None
|
|
|
|
def caveslugfwd(request, slug):
|
|
"""This is ass backwards. It would be better style to have the slug-identified request be the master, and have
|
|
other paths redirect to it, rather than what we have here.
|
|
Pending a change where we remove cave.url as a field and have an explicit fixed convention instead.
|
|
"""
|
|
if not slug:
|
|
message = f"Failed to find cave from identifier given: {slug}."
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
|
|
Gcavelookup = GetCaveLookup()
|
|
if slug in Gcavelookup:
|
|
cave = Gcavelookup[slug]
|
|
|
|
return redirect(f"/{cave.url}")
|
|
|
|
|
|
def getCaves(cave_id):
|
|
"""Only gets called if a call to getCave() raises a MultipleObjects exception
|
|
|
|
TO DO: search GCavelookup first, which should raise a MultpleObjectsReturned exception if there
|
|
are duplicates"""
|
|
try:
|
|
caves = Cave.objects.filter(kataster_number=cave_id)
|
|
caveset = set(caves)
|
|
|
|
Gcavelookup = GetCaveLookup() # dictionary makes strings to Cave objects
|
|
if cave_id in Gcavelookup:
|
|
caveset.add(Gcavelookup[cave_id])
|
|
return list(caveset)
|
|
except:
|
|
return []
|
|
|
|
|
|
def getCave(cave_id):
|
|
"""Returns a cave object when given a cave name or number.
|
|
It is used by views including cavehref, ent, wallets and qm.
|
|
|
|
TO DO: search GCavelookup first, which should raise a MultpleObjectsReturned exception if there
|
|
are duplicates"""
|
|
try:
|
|
cave = Cave.objects.get(kataster_number=cave_id)
|
|
return cave
|
|
except Cave.MultipleObjectsReturned as ex:
|
|
raise MultipleObjectsReturned("Duplicate kataster number") from ex # propagate this up
|
|
|
|
except Cave.DoesNotExist as ex:
|
|
Gcavelookup = GetCaveLookup() # dictionary makes strings to Cave objects
|
|
if cave_id in Gcavelookup:
|
|
return Gcavelookup[cave_id]
|
|
else:
|
|
raise ObjectDoesNotExist("No cave found with this identifier in any id field") from ex # propagate this up
|
|
except:
|
|
raise ObjectDoesNotExist("No cave found with this identifier in any id field")
|
|
|
|
|
|
def pad5(x):
|
|
return "0" * (5 - len(x.group(0))) + x.group(0)
|
|
|
|
|
|
def padnumber(x):
|
|
return re.sub(r"\d+", pad5, x)
|
|
|
|
|
|
def numericalcmp(x, y):
|
|
return cmp(padnumber(x), padnumber(y))
|
|
|
|
|
|
def caveKey(c):
|
|
"""This function goes into a lexicographic sort function, and the values are strings,
|
|
but we want to sort numerically on kataster number before sorting on unofficial number.
|
|
"""
|
|
if not c.kataster_number:
|
|
return "9999." + c.unofficial_number
|
|
else:
|
|
if int(c.kataster_number) >= 100:
|
|
return "99." + c.kataster_number
|
|
if int(c.kataster_number) >= 10:
|
|
return "9." + c.kataster_number
|
|
return c.kataster_number
|
|
|
|
|
|
def getnotablecaves():
|
|
notablecaves = []
|
|
for kataster_number in settings.NOTABLECAVESHREFS:
|
|
try:
|
|
cave = Cave.objects.get(kataster_number=kataster_number, areacode="1623")
|
|
notablecaves.append(cave)
|
|
except:
|
|
print(" ! Notable Caves: FAILED to get only one cave per kataster_number OR invalid number for: "+kataster_number)
|
|
|
|
try:
|
|
hc = Cave.objects.get(kataster_number=359, areacode="1626")
|
|
notablecaves.append(hc)
|
|
except:
|
|
# fails during the tests because this cave has not been loaded for tests, so catch it here.
|
|
pass
|
|
print(notablecaves)
|
|
return notablecaves
|
|
|
|
|
|
def caveindex(request):
|
|
"""Should use Django order-by for lazy sorting, not here. But only after we have a proper slug system in place for Caves
|
|
"""
|
|
# allcaves = Cave.objects.all()
|
|
# for c in allcaves:
|
|
# if c.entrances:
|
|
# pass
|
|
|
|
caves1623 = list(Cave.objects.filter(areacode="1623"))
|
|
caves1624 = list(Cave.objects.filter(areacode="1624"))
|
|
caves1626 = list(Cave.objects.filter(areacode="1626"))
|
|
caves1627 = list(Cave.objects.filter(areacode="1627"))
|
|
caves1623.sort(key=caveKey)
|
|
caves1624.sort(key=caveKey)
|
|
caves1626.sort(key=caveKey)
|
|
caves1627.sort(key=caveKey)
|
|
return render(
|
|
request,
|
|
"caveindex.html",
|
|
{"caves1623": caves1623,
|
|
"caves1626": caves1626,
|
|
"caves1627": caves1627,
|
|
"caves1624": caves1624,
|
|
"notablecaves": getnotablecaves(),
|
|
"cavepage": True, "year": current_expo()},
|
|
)
|
|
|
|
def entranceindex(request):
|
|
ents = Entrance.objects.all().order_by("slug")
|
|
|
|
return render(
|
|
request,
|
|
"entranceindex.html",
|
|
{"entrances": ents},
|
|
)
|
|
|
|
|
|
def cave3d(request, cave_id=""):
|
|
"""This is used to create a download url in templates/cave.html if anyone wants to download the .3d file
|
|
The caller template tries kataster first, then unofficial_number if that kataster number does not exist
|
|
but only if Cave.survex_file is non-empty
|
|
"""
|
|
try:
|
|
cave = getCave(cave_id)
|
|
except ObjectDoesNotExist:
|
|
return HttpResponseNotFound
|
|
except Cave.MultipleObjectsReturned:
|
|
# should really produce a better error message. This is a failure of ambiguous aliases probably.
|
|
caves = Cave.objects.filter(url=kpath)
|
|
return render(request, "svxcaveseveral.html", {"settings": settings, "caves": caves, "year": current_expo()})
|
|
else:
|
|
return file3d(request, cave, cave_id)
|
|
|
|
|
|
def file3d(request, cave, cave_id):
|
|
"""Produces a .3d file directly for download.
|
|
survex_file should be in valid path format 'caves-1623/264/264.svx' but it might be mis-entered as simply '2012-ns-10.svx'
|
|
|
|
Also the cave.survex_file may well not match the cave description path:
|
|
e.g. it might be to the whole system 'smk-system.svx' instead of just for the specific cave.
|
|
|
|
- If the expected .3d file corresponding to cave.survex_file is present, return it.
|
|
- If the cave.survex_file exists, generate the 3d file, cache it and return it
|
|
- Use the cave_id to guess what the 3d file might be and, if in the cache, return it
|
|
|
|
There is a problem as the filename is shown of all areacode information, so both 1624-161 and 1623-161
|
|
have a file called 161.svx and return a file called "161.3d" which may
|
|
get incorrectly cached by other software (i.e your browser)
|
|
"""
|
|
|
|
def runcavern(survexpath):
|
|
"""This has not yet been properly updated with respect to putting the .3d file in the same folder as the .svx filse
|
|
as done in runcavern3d() in parsers/survex.py
|
|
Needs testing.
|
|
"""
|
|
if not survexpath.is_file():
|
|
pass
|
|
try:
|
|
completed_process = subprocess.run(
|
|
[settings.CAVERN, "--log", f"--output={settings.SURVEX_DATA}", f"{survexpath}"]
|
|
)
|
|
except OSError as ex:
|
|
# propagate this to caller.
|
|
raise OSError(completed_process.stdout) from ex
|
|
|
|
op3d = (Path(settings.SURVEX_DATA) / Path(survexpath).name).with_suffix(".3d")
|
|
op3dlog = Path(op3d.with_suffix(".log"))
|
|
|
|
if not op3d.is_file():
|
|
print(f" - - Regeneration FAILED\n - - from '{survexpath}'\n - - to '{op3d}'")
|
|
print(" - - Regeneration stdout: ", completed_process.stdout)
|
|
print(" - - Regeneration cavern log output: ", op3dlog.read_text())
|
|
|
|
def return3d(threedpath, cave):
|
|
newfilename = cave.slug() + ".3d" # add the "1623-" part of the filename effectively.
|
|
if threedpath.is_file():
|
|
response = HttpResponse(content=open(threedpath, "rb"), content_type="application/3d")
|
|
response["Content-Disposition"] = f"attachment; filename={newfilename}"
|
|
return response
|
|
else:
|
|
message = f'<h1>Path provided does not correspond to any actual 3d file.</h1><p>path: "{threedpath}"'
|
|
return HttpResponseNotFound(message)
|
|
|
|
survexname = Path(cave.survex_file).name # removes directories ie 1623/161/161.svx -> 161.svx
|
|
survexpath = Path(settings.SURVEX_DATA, cave.survex_file)
|
|
survexdir = survexpath.parent
|
|
threedname = Path(survexname).with_suffix(".3d") # removes .svx, replaces with .3d AND DISCARDS PATH arrgh
|
|
threedpath = survexpath.parent / threedname
|
|
|
|
# These if statements need refactoring more cleanly
|
|
if cave.survex_file:
|
|
if threedpath.is_file():
|
|
if survexpath.is_file():
|
|
if os.path.getmtime(survexpath) > os.path.getmtime(threedpath):
|
|
runcavern(survexpath)
|
|
return return3d(threedpath, cave)
|
|
else:
|
|
if survexpath.is_file():
|
|
runcavern(survexpath)
|
|
return return3d(threedpath, cave)
|
|
|
|
# Get here if cave.survex_file was set but did not correspond to a valid svx file
|
|
if survexpath.is_file():
|
|
# a file, but invalid format
|
|
message = f'<h1>File is not valid .svx format.</h1><p>Could not generate 3d file from "{survexpath}"'
|
|
else:
|
|
# we could try to guess that 'caves-1623/' is missing,... nah.
|
|
message = f'<h1>Path provided does not correspond to any actual file.</h1><p>path: "{survexpath}"'
|
|
|
|
return HttpResponseNotFound(message)
|
|
|
|
|
|
def rendercave(request, cave, slug, cave_id=""):
|
|
"""Gets the data and files ready and then triggers Django to render the template.
|
|
The resulting html contains urls which are dispatched independently, e.g. the 'download' link
|
|
"""
|
|
|
|
if cave.non_public and settings.PUBLIC_SITE and not request.user.is_authenticated:
|
|
return render(request, "nonpublic.html", {"instance": cave, "cavepage": True, "cave_id": cave_id})
|
|
else:
|
|
# print(f" ! rendercave: slug:'{slug}' survex file:'{cave.survex_file}'")
|
|
try:
|
|
svx3d = Path(cave.survex_file).stem
|
|
svxstem = Path(settings.SURVEX_DATA) / Path(cave.survex_file)
|
|
# print(f" ! rendercave: slug:'{slug}' '' ++ '{svxstem}'")
|
|
except:
|
|
svx3d = ""
|
|
svxstem = ""
|
|
print(f" ! rendercave: slug:'{slug}' FAIL TO MANAGE survex file:'{cave.survex_file}'")
|
|
# NOTE the template itself loads the 3d file using javascript before it loads anything else.
|
|
# Django cannot see what this javascript is doing, so we need to ensure that the 3d file exists first.
|
|
# So only do this render if a valid .3d file exists. TO BE DONE
|
|
# see design docum in troggle/templates/cave.html
|
|
# see rendercave() in troggle/core/views/caves.py
|
|
templatefile = "cave.html"
|
|
|
|
wallets = Wallet.objects.filter(caves=cave)
|
|
|
|
if not cave_id:
|
|
cave_id = slug # cave.unofficial_number
|
|
context = {
|
|
"cave_editable": True,
|
|
"settings": settings,
|
|
"cave": cave,
|
|
"cavepage": True,
|
|
"cave_id": cave_id,
|
|
"svxstem": str(svxstem),
|
|
"svx3d": svx3d,
|
|
"wallets": wallets,
|
|
"year": current_expo()
|
|
}
|
|
|
|
# Do not catch any exceptions here: propagate up to caller
|
|
r = render(
|
|
request, templatefile, context
|
|
) # crashes here with NoReverseMatch if url not set up for 'edit_cave' in urls.py
|
|
return r
|
|
|
|
|
|
|
|
def cavepage(request, karea=None, subpath=None):
|
|
"""Displays a cave description page
|
|
accessed by kataster area number specifically
|
|
OR
|
|
accessed by cave.url specifically set in data, e.g.
|
|
"1623/000/000" <= cave-data/1623-000.html
|
|
"1623/41/115.htm" <= cave-data/1623-115.html
|
|
so we have to query the database to find the URL as we cannot rely on the url actually telling us the cave by inspection.
|
|
|
|
NOTE that old caves have ".html" (or ".htm") in the URL as they used to be actual files. But since 2006 these URLs
|
|
refer to virtual pages generated on the fly by troggle, so the".html" is confusing and redundant.
|
|
But this confused Becka so it was re-instated. Thus creating more confusion for future generations...
|
|
|
|
There are also A LOT OF URLS to e.g. /1623/161/l/rl89a.htm which are IMAGES and real html files
|
|
in cave descriptions. These need to be handled HERE too (accident of history).
|
|
|
|
"""
|
|
if not subpath or subpath=='/':
|
|
print(f"{karea=} {subpath=} ")
|
|
return render(request, "pagenotfound.html", {"path": f"{karea}/{subpath}"}, status=404)
|
|
# lack of validation for karea, 162x
|
|
# subpath has an initial /
|
|
kpath = karea + subpath
|
|
#print(f" ! cavepage:'{kpath}' kataster area:'{karea}' rest of path:'{subpath}'")
|
|
|
|
caves = Cave.objects.filter(url=kpath)
|
|
if len(caves) == 1:
|
|
cave = caves[0]
|
|
return rendercave(request, cave, cave.slug())
|
|
|
|
|
|
subpath = subpath.strip("//")
|
|
# re do all this using pathlib functions
|
|
parts = subpath.strip("/").split("/")
|
|
if len(parts) > 5:
|
|
# recursive loop. break out of it.
|
|
subparts = parts[0].split(".")
|
|
caveid = subparts[0]
|
|
slug = f"{karea}-{caveid}"
|
|
if cave:= get_cave_from_slug(slug): # walrus operator
|
|
return redirect(f"/{cave.url}")
|
|
else:
|
|
return redirect(f"/caves")
|
|
|
|
|
|
# epath = karea + subpath # e.g. 1623 /204
|
|
# return expo.expopage(request, epath)
|
|
|
|
# BUGGER the real problem is the the cave descript has embedded in it images like
|
|
# src="110/entrance.jpeg and since the cave url is now /1623/110/110.html
|
|
# the images try to load from /1623/110/110/entrance.jpeg and of course fail.
|
|
# THIS IS A HORRIBLE HACK
|
|
if len(parts) == 1:
|
|
# simple filename, no folders in path,
|
|
# either need to insert caveid OR leave as relative link as we are already "in" /1623/nn/
|
|
subparts = parts[0].split(".")
|
|
caveid = subparts[0] # e.g. 204.htm
|
|
k2path = karea +"/"+ caveid + subpath
|
|
return redirect(f"/{k2path}") # infinite loop
|
|
elif len(parts) >2:
|
|
# e.g. i/204.jpg, but that's ok as we are already "in" /1623/nn/
|
|
if parts[0] == parts[1]: # double caveid
|
|
epath = karea
|
|
for i in parts[1:]:
|
|
epath += "/" + i
|
|
#print(f"{subpath=}\n {epath=}")
|
|
return expo.expopage(request, epath)
|
|
|
|
# if either the first two parts are not /caveid/caveid/
|
|
# or the number of parts == 2,
|
|
# print(f"2 {subpath=}")
|
|
epath = karea + "/" + subpath
|
|
return expo.expopage(request, epath)
|
|
|
|
@login_required_if_public
|
|
def edit_cave(request, path="", slug=None):
|
|
"""This is the form that edits all the cave data and writes out an XML file in the :expoweb: repo folder
|
|
The format for the file being saved is in templates/dataformat/cave.xml
|
|
Warning. This uses Django deep magic in the CaveForm processing.
|
|
|
|
It saves the data into into the database and into the html file, which it then commits to git.
|
|
|
|
We basically ignore the <path> as the <slug> is of the format 1624-114 and contains the area code
|
|
"""
|
|
print(f"edit_cave(): {path=} {slug=}")
|
|
message = ""
|
|
if slug is None:
|
|
cave = Cave() # create a New Cave
|
|
else:
|
|
print(f"{slug=}")
|
|
if not (cave:= get_cave_from_slug(slug)): # walrus operator
|
|
return render(request, "errors/badslug.html", {"badslug": f"for cave {caveslug} - from edit_cave()"})
|
|
|
|
if request.POST:
|
|
form = CaveForm(request.POST, instance=cave)
|
|
#ceFormSet = CaveAndEntranceFormSet(request.POST)
|
|
if form.is_valid(): # and ceFormSet.is_valid():
|
|
print(f'edit_cave(): POST is valid. Editing {cave}')
|
|
cave = form.save(commit=False)
|
|
# print(cave)
|
|
if not cave.filename:
|
|
cave.filename = cave.areacode + "-" + cave.number() + ".html"
|
|
if not cave.url:
|
|
cave.url = cave.areacode + "/" + cave.number()
|
|
cave.save()
|
|
form.save_m2m() # this does the many-to-many relationship saving between caves and entrances
|
|
if slug is None:
|
|
# it is not visible on the form so it always will be None
|
|
slug = f"{cave.areacode}-{cave.number()}"
|
|
cs = CaveSlug(cave=cave, slug=slug, primary=True)
|
|
print(f"edit_cave(): New CaveSlug saved {slug}")
|
|
cs.save()
|
|
#ceinsts = ceFormSet.save(commit=False)
|
|
#for ceinst in ceinsts:
|
|
# ceinst.cave = cave
|
|
# ceinst.save()
|
|
try:
|
|
cave_file = cave.file_output()
|
|
write_and_commit([cave_file], f"Online edit of cave {cave}")
|
|
# leave other exceptions unhandled so that they bubble up to user interface
|
|
except PermissionError:
|
|
message = f"CANNOT save this file.\nPERMISSIONS incorrectly set on server for this file {cave.filename}. Ask a nerd to fix this."
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
except subprocess.SubprocessError:
|
|
message = f"CANNOT git on server for this file {cave.filename}. Edits may not be committed.\nAsk a nerd to fix this."
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
except:
|
|
raise
|
|
if cave.entrances().count() > 0:
|
|
return HttpResponseRedirect("/" + cave.url)
|
|
else:
|
|
return HttpResponseRedirect(reverse("newentrance", args = [cave.url_parent(), cave.slug()]))
|
|
|
|
else:
|
|
if slug is not None:
|
|
# re-read cave data from file.
|
|
print(f"edit_cave(): {cave=} {cave.filename=}")
|
|
print(f"edit_cave(): {cave.slug()=}")
|
|
if cave.filename:
|
|
try:
|
|
read_cave(cave.filename, cave=cave)
|
|
except Exception as e:
|
|
print(f"edit_cave(): EXCEPTION attempting to read_cave({cave.filename})\n{e}")
|
|
raise
|
|
|
|
form = CaveForm(instance=cave, initial={'cave_slug': cave.slug()})
|
|
#ceFormSet = CaveAndEntranceFormSet(queryset=cave.caveandentrance_set.all())
|
|
else:
|
|
form = CaveForm()
|
|
#ceFormSet = CaveAndEntranceFormSet(queryset=CaveAndEntrance.objects.none())
|
|
|
|
print(f"edit_cave(): returning render()")
|
|
return render(
|
|
request,
|
|
"editcave.html",
|
|
{
|
|
"form": form,
|
|
"cave": cave,
|
|
"message": message, "year": current_expo(),
|
|
#"caveAndEntranceFormSet": ceFormSet,
|
|
"path": path + "/", # used for saving images if attached
|
|
},
|
|
)
|
|
|
|
|
|
|
|
@login_required_if_public
|
|
def edit_entrance(request, path="", caveslug=None, entslug=None):
|
|
"""This is the form that edits the entrance data for a single entrance and writes out
|
|
an XML file in the :expoweb: repo folder
|
|
|
|
The format for the file being saved is in templates/dataformat/entrance.xml
|
|
|
|
Warning. This uses Django deep magic for multiple forms and the CaveAndEntrance class.
|
|
|
|
It does save the data into into the database directly, not by parsing the file.
|
|
|
|
'path' comes from the urls.py regex but is usually empty (!)
|
|
So we make the proper path for storing the images ourselves.
|
|
|
|
GET RID of all this entranceletter stuff. Far too overcomplexified.
|
|
We don't need it. Just the entrance slug is fine, then check uniqueness.
|
|
"""
|
|
def check_new_slugname_ok(slug, letter):
|
|
"""In Nov.2023 it is possible to create a 2nd entrance and not set an entrance letter,
|
|
which leads to a constraint uniqueness crash. FIX THIS.
|
|
The letter may be set to an existing letter, OR it may be unset, but there may
|
|
be an existing unlettered single entrance. Both of these will crash unless fixed.
|
|
"""
|
|
slugname = f"{slug}{letter}"
|
|
nents = Entrance.objects.filter(slug=slugname).count()
|
|
print(f"check_new_slugname_ok() {slugname=} {letter=} => {nents}")
|
|
if nents == 0:
|
|
# looks good, but we need to check the CaveaAndEntrance object too
|
|
e = entrance #Entrance.objects.get(slug=slugname) # does not exist yet!
|
|
e.save()
|
|
gcl = GetCaveLookup()
|
|
c = gcl[slug]
|
|
nce = CaveAndEntrance.objects.filter(cave=c, entrance=e).count()
|
|
if nce == 0 :
|
|
return slugname, letter
|
|
|
|
# That entrance already exists, or the CE does, OK.. do recursive call, starting at "b"
|
|
if letter =="":
|
|
return check_new_slugname_ok(slug, "b")
|
|
else:
|
|
nextletter = chr(ord(letter)+1)
|
|
return check_new_slugname_ok(slug, nextletter)
|
|
|
|
if not (cave:= get_cave_from_slug(caveslug)): # walrus operator
|
|
return render(request, "errors/badslug.html", {"badslug": f"for cave {caveslug} - from edit_entrance()"})
|
|
|
|
if entslug:
|
|
try:
|
|
entrance = Entrance.objects.get(slug=entslug)
|
|
except:
|
|
return render(request, "errors/badslug.html", {"badslug": f"for entrance {entslug} - from edit_entrance()"})
|
|
else:
|
|
# a new entrance on a cave
|
|
entrance = None
|
|
|
|
if entslug:
|
|
print(f"Edit Entrance {caveslug=} {entslug=} {path=} number of ents:{cave.entrances().count()}")
|
|
caveAndEntrance = CaveAndEntrance.objects.get(entrance=entrance, cave=cave)
|
|
entlettereditable = False
|
|
else:
|
|
caveAndEntrance = CaveAndEntrance(cave=cave, entrance=Entrance()) # creates a new Entrance object as well as a new CE object
|
|
entlettereditable = True
|
|
|
|
ce = caveAndEntrance
|
|
if ce.entranceletter == "" and cave.entrances().count() > 0 :
|
|
# this should not be blank on a multiple-entrance cave
|
|
# but it doesn't trigger the entrance letter form unless entletter has a value
|
|
entlettereditable = True # but the user has to remember to actually set it...
|
|
|
|
print(f"{entlettereditable=}")
|
|
# if the entletter is not editable, then the entletterform does not appear and so is always invalid.
|
|
|
|
print(f"{caveslug=}")
|
|
print(f"{cave=}")
|
|
imgpath = Path(path) / cave.areacode / cave.number()
|
|
print(f"Edit Entrance {imgpath=}")
|
|
|
|
if request.POST:
|
|
print(f"POST Online edit of entrance: '{entrance}' where {cave=}")
|
|
entform = EntranceForm(request.POST, instance=entrance)
|
|
|
|
if not entlettereditable:
|
|
entranceletter = ce.entranceletter
|
|
else:
|
|
entletterform = EntranceLetterForm(request.POST, instance=ce)
|
|
if entletterform.is_valid():
|
|
ce = entletterform.save(commit=False)
|
|
entranceletter = entletterform.cleaned_data["entranceletter"]
|
|
message = f"- POST valid {caveslug=} {entslug=} {path=} entletterform valid \n {entletterform=}."
|
|
print(message)
|
|
else:
|
|
# maybe this doesn't matter? It just means entranceletter unset ?
|
|
# probably because 'Cave and entrance with this Cave and Entranceletter already exists.'
|
|
message = f"- POST INVALID {caveslug=} {entslug=} {path=} entletterform invalid \n{entletterform.errors=}\n{entletterform=}."
|
|
print(message)
|
|
# if entletterform.errors:
|
|
# for field in entletterform:
|
|
# for error in field.errors:
|
|
# print(f"ERR {field=} {error=}")
|
|
# return render(request, "errors/generic.html", {"message": message})
|
|
entranceletter=""
|
|
|
|
if not entform.is_valid():
|
|
message = f"- POST INVALID {caveslug=} {entslug=} {path=} entform valid:{entform.is_valid()} entletterform valid:{entletterform.is_valid()}"
|
|
entrance = entform.save(commit=False)
|
|
print(message)
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
else:
|
|
|
|
print(f"- POST {caveslug=} {entslug=} {entranceletter=} {path=}")
|
|
if entslug is None:
|
|
# we are creating a new entrance
|
|
entrance = entform.save(commit=False)
|
|
# entrance = ce.entrance # the one we created earlier?
|
|
|
|
try:
|
|
if entranceletter:
|
|
slugname, letter = check_new_slugname_ok(cave.slug(), entranceletter)
|
|
else:
|
|
slugname, letter = check_new_slugname_ok(cave.slug(), "")
|
|
ce.entranceletter = letter
|
|
|
|
except Exception as e:
|
|
print(f"- EXCEPTION entranceletter {caveslug=} {entslug=} {entranceletter=} {path=}\n{e}")
|
|
raise
|
|
entrance.slug = slugname
|
|
entrance.cached_primary_slug = slugname
|
|
entrance.filename = slugname + ".html"
|
|
else:
|
|
# an existing entrance ?
|
|
entrance.slug = entslug
|
|
entrance.cached_primary_slug = entslug
|
|
entrance.filename = entslug + ".html"
|
|
try:
|
|
entrance.save()
|
|
print(f"- post {entrance.slug=} {entrance.tag_station=} {entrance.other_station=}")
|
|
except Exception as e:
|
|
# fails with uniqueness constraint failure. Which is on CaveAndEntrance, not just on entrance,
|
|
# which is confusing to a user who is just editing an Entrance.
|
|
# Can happen when user specifies an existing letter! (or none, when they should set one)
|
|
print(f"SAVE EXCEPTION FAIL {entrance=}")
|
|
print(f"CAVE {cave}\n{e}")
|
|
for ce in cave.entrances():
|
|
print(f"CAVE:{ce.cave} - ENT:{ce.entrance} - LETTER:'{ce.entranceletter}'")
|
|
raise
|
|
ce.entrance = entrance
|
|
# try not to invoke this:
|
|
# UNIQUE constraint failed: core_caveandentrance.cave_id, core_caveandentrance.entranceletter
|
|
ce.save()
|
|
|
|
entrance_file = entrance.file_output()
|
|
cave_file = cave.file_output()
|
|
|
|
|
|
print(f"- POST WRITE letter: '{ce}' {entrance=}")
|
|
try:
|
|
write_and_commit([entrance_file, cave_file], f"Online edit of entrance {entrance.slug}")
|
|
return HttpResponseRedirect("/" + cave.url)
|
|
except Exception as e:
|
|
efilepath, econtent, eencoding = entrance_file
|
|
cfilepath, ccontent, cencoding = cave_file
|
|
message = f"- FAIL write_and_commit \n entr:'{efilepath}'\n cave:'{cfilepath}'\n\n{e}"
|
|
print(message)
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
|
|
else: # GET the page, not POST, or if either of the forms were invalid when POSTed
|
|
entletterform = None
|
|
entletter = ""
|
|
print(f"ENTRANCE in db: entranceletter = '{ce.entranceletter}'")
|
|
if entrance:
|
|
# re-read entrance data from file.
|
|
filename = str(entrance.slug +".html")
|
|
try:
|
|
ent = read_entrance(filename, ent=entrance)
|
|
print(f"ENTRANCE from file: entranceletter = '{ce.entranceletter}'")
|
|
except:
|
|
# ent only in db not on file. Interesting, let's run with it using whatever we have in the db
|
|
print(f"ENTRANCE NOT read from file: entranceletter = '{ce.entranceletter}'")
|
|
|
|
entform = EntranceForm(instance=entrance)
|
|
if entslug is None:
|
|
entletterform = EntranceLetterForm()
|
|
# print(f" Getting entletter from EntranceLetterForm")
|
|
else:
|
|
entletter = ce.entranceletter
|
|
if entletter == "":
|
|
entletterform = EntranceLetterForm()
|
|
print(f" Blank value: getting entletter from EntranceLetterForm")
|
|
print(f"{entletter=} ")
|
|
else:
|
|
entform = EntranceForm()
|
|
entletterform = EntranceLetterForm()
|
|
|
|
return render(
|
|
request,
|
|
"editentrance.html",
|
|
{ "year": current_expo(),
|
|
"entform": entform,
|
|
"cave": cave,
|
|
"ent": entrance,
|
|
"entletter": entletter,
|
|
"entletterform": entletterform, # is unset if not being used
|
|
"entlettereditable": entlettereditable,
|
|
"path": str(imgpath) + "/", # used for saving images if attached
|
|
},
|
|
)
|
|
|
|
|
|
def ent(request, cave_id, ent_letter):
|
|
cave = Cave.objects.filter(kataster_number=cave_id)[0]
|
|
cave_and_ent = CaveAndEntrance.objects.filter(cave=cave).filter(entranceletter=ent_letter)[0]
|
|
return render(
|
|
request,
|
|
"entrance.html",
|
|
{ "year": current_expo(),
|
|
"cave": cave,
|
|
"entrance": cave_and_ent.entrance,
|
|
"letter": cave_and_ent.entranceletter,
|
|
},
|
|
)
|
|
|
|
def cave_debug(request):
|
|
ents = Entrance.objects.all().order_by('id')
|
|
caves = Cave.objects.all().order_by('id')
|
|
return render(
|
|
request,
|
|
"cave_debug.html",
|
|
{"ents": ents, "caves": caves, "year": current_expo()},
|
|
)
|
|
|
|
def caveslist(request):
|
|
caves = Cave.objects.all()
|
|
print("CAVESLIST")
|
|
return render(
|
|
request,
|
|
"caveslist.html",
|
|
{"caves": caves, "year": current_expo()},
|
|
)
|
|
def get_entrances(request, caveslug):
|
|
if not (cave:= get_cave_from_slug(caveslug)): # walrus operator
|
|
return render(request, "errors/badslug.html", {"badslug": f"{caveslug} - from get_entrances()"})
|
|
return render(
|
|
request, "options.html", {"year": current_expo(), "items": [(e.entrance.slug(), e.entrance.slug()) for e in cave.entrances()]}
|
|
)
|
|
|
|
|
|
def caveQMs(request, slug, open=False):
|
|
"""Lists all the QMs on a particular cave
|
|
relies on the template to find all the QMs for the cave specified in the slug, e.g. '1623-161'
|
|
Now working in July 2022
|
|
"""
|
|
if not (cave:= get_cave_from_slug(slug)): # walrus operator
|
|
return render(request, "errors/badslug.html", {"badslug": f"{slug} - from caveQMs()"})
|
|
|
|
if cave.non_public and settings.PUBLIC_SITE and not request.user.is_authenticated:
|
|
return render(request, "nonpublic.html", {"instance": cave})
|
|
elif open:
|
|
return render(request, "cave_open_qms.html", {"cave": cave, "year": current_expo()})
|
|
else:
|
|
return render(request, "cave_qms.html", {"cave": cave, "year": current_expo()})
|
|
|
|
|
|
def qm(request, cave_id, qm_id, year, grade=None, blockname=None):
|
|
"""Reports on one specific QM
|
|
Fixed and working July 2022, for both CSV imported QMs
|
|
|
|
Needs refactoring though! Uses extremely baroque way of getting the QMs instead of querying for QM objects
|
|
directly, presumably as a result of a baroque history.
|
|
|
|
Many caves have several QMS with the same number, grade, year (2018) and first 8 chars of the survexblock. This crashes things, so the terminal char of the survexblock name was added
|
|
"""
|
|
|
|
year = int(year)
|
|
|
|
if blockname == "" or not blockname:
|
|
# CSV import QMs, use old technique
|
|
try:
|
|
c = getCave(cave_id)
|
|
manyqms = c.get_open_QMs() | c.get_ticked_QMs() # set union operation
|
|
qm = manyqms.get(number=qm_id, expoyear=year, grade=grade)
|
|
return render(request, "qm.html", {"qm": qm})
|
|
except QM.DoesNotExist:
|
|
# raise
|
|
return render(
|
|
request,
|
|
"errors/badslug.html",
|
|
{
|
|
"badslug": f"QM.DoesNotExist blockname is empty string: {cave_id=} {year=} {qm_id=} {grade=} {blockname=}"
|
|
},
|
|
)
|
|
except QM.MultipleObjectsReturned:
|
|
# raise
|
|
qms = manyqms.filter(number=qm_id, expoyear=year)
|
|
return render(
|
|
request,
|
|
"errors/badslug.html",
|
|
{
|
|
"badslug": f"QM.MultipleObjectsReturned {cave_id=} {year=} {qm_id=} {grade=} {blockname=} {qms=}"
|
|
},
|
|
)
|
|
|
|
else:
|
|
try:
|
|
qmslug = f"{cave_id}-{year}-{blockname=}{qm_id}{grade}"
|
|
print(f"{qmslug=}")
|
|
c = getCave(cave_id)
|
|
manyqms = c.get_open_QMs() | c.get_ticked_QMs() # set union operation
|
|
qmqs = manyqms.filter(expoyear=year, blockname=blockname, number=qm_id, grade=grade)
|
|
if len(qmqs) > 1:
|
|
for q in qmqs:
|
|
print(qmqs)
|
|
message = f"Multiple QMs with the same cave, year, number, grade AND first-several+terminal chars of the survexblock name. (Could be caused by incomplete databasereset). Fix this in the survex file(s). {cave_id=} {year=} {qm_id=} {blockname=}"
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
else:
|
|
qm = qmqs.get(expoyear=year, blockname=blockname, number=qm_id, grade=grade)
|
|
if qm:
|
|
print(
|
|
qm,
|
|
f"{qmslug=}:{cave_id=} {year=} {qm_id=} {blockname=} {qm.expoyear=} {qm.completion_description=}",
|
|
)
|
|
return render(request, "qm.html", {"qm": qm, "year": current_expo()})
|
|
else:
|
|
# raise
|
|
return render(
|
|
request,
|
|
"errors/badslug.html",
|
|
{"badslug": f"Failed get {cave_id=} {year=} {qm_id=} {grade=} {blockname=}"},
|
|
)
|
|
except MultipleObjectsReturned:
|
|
message = f"Multiple QMs with the same cave, year, number, grade AND first-several+terminal chars of the survexblock name. (Could be caused by incomplete databasereset). Fix this in the survex file(s). {cave_id=} {year=} {qm_id=} {blockname=}"
|
|
return render(request, "errors/generic.html", {"message": message})
|
|
except QM.DoesNotExist:
|
|
# raise
|
|
return render(
|
|
request,
|
|
"errors/badslug.html",
|
|
{
|
|
"badslug": f"QM.DoesNotExist blockname is not empty string {cave_id=} {year=} {qm_id=} {grade=} {blockname=}"
|
|
},
|
|
)
|
|
|
|
def expo_kml(request):
|
|
return render(
|
|
request,
|
|
"expo.kml",
|
|
{
|
|
"entrances": Entrance.objects.all()
|
|
},
|
|
content_type = "application/vnd.google-earth.kml+xml"
|
|
)
|
|
|
|
def expo_kmz(request):
|
|
notablecaves = set(getnotablecaves())
|
|
#Zip file written to a file, to save this function using too much memory
|
|
with tempfile.TemporaryDirectory() as tmpdirname:
|
|
zippath = os.path.join(tmpdirname, 'expo.kmz')
|
|
with zipfile.ZipFile(zippath, 'w', compression=zipfile.ZIP_DEFLATED) as myzip:
|
|
entrances = []
|
|
for e in Entrance.objects.all():
|
|
html = loader.get_template("entrance_html.kml").render({"entrance": e}, request)
|
|
soup=BeautifulSoup(html)
|
|
for img in soup.find_all("img"):
|
|
#src_orig = img['src']
|
|
src = urllib.parse.urljoin(e.cavelist()[0].url.rpartition("/")[0] + "/", img['src'])
|
|
img['src'] = src
|
|
p = os.path.join(settings.EXPOWEB, src)
|
|
#print(e.cavelist()[0].url, e.cavelist()[0].url.rpartition("/")[0] + "/", src_orig, p)
|
|
if os.path.isfile(p):
|
|
myzip.write(p, src)
|
|
for a in soup.find_all("a"):
|
|
try:
|
|
ao = a['href']
|
|
aa = urllib.parse.urljoin(e.cavelist()[0].url.rpartition("/")[0] + "/", ao)
|
|
a['href'] = urllib.parse.urljoin("https://expo.survex.com/", aa)
|
|
print(e.cavelist()[0].url.rpartition("/")[0] + "/", ao, a['href'])
|
|
except:
|
|
pass
|
|
html = mark_safe(soup.prettify("utf-8").decode("utf-8"))
|
|
|
|
size = {True: "large", False:"small"}[bool(set(e.cavelist()) & notablecaves)]
|
|
|
|
entrances.append(loader.get_template("entrance.kml").render({"entrance": e, "html": html, "size": size}, request))
|
|
|
|
s = loader.get_template("expo.kml").render({"entrances": entrances}, request)
|
|
myzip.writestr("expo.kml", s)
|
|
for f in os.listdir(settings.KMZ_ICONS_PATH):
|
|
p = os.path.join(settings.KMZ_ICONS_PATH, f)
|
|
if os.path.isfile(p):
|
|
myzip.write(p, os.path.join("icons", f))
|
|
return FileResponse(open(zippath, 'rb'), content_type="application/vnd.google-earth.kmz .kmz")
|
|
|
|
|