troggle-unchained/parsers/logbooks.py

866 lines
35 KiB
Python
Raw Normal View History

2011-07-11 02:10:22 +01:00
import csv
import os
2020-05-28 02:20:50 +01:00
import re
import time
2023-01-19 18:33:04 +00:00
from datetime import date, datetime
from pathlib import Path
2023-01-19 18:33:04 +00:00
from random import randint
2011-07-11 02:10:22 +01:00
2020-05-28 02:20:50 +01:00
from django.conf import settings
from django.template.defaultfilters import slugify
from django.utils.timezone import get_current_timezone, make_aware
2023-01-19 18:33:04 +00:00
from parsers.people import GetPersonExpeditionNameLookup
2023-01-19 21:18:42 +00:00
from troggle.core.models.caves import Cave, GetCaveLookup, LogbookEntry, PersonTrip
2021-04-13 00:43:57 +01:00
from troggle.core.models.troggle import DataIssue, Expedition
2021-04-13 00:11:08 +01:00
from troggle.core.utils import TROG, save_carefully
2011-07-11 02:10:22 +01:00
2023-01-19 21:18:42 +00:00
"""
2021-04-13 01:37:42 +01:00
Parses and imports logbooks in all their wonderful confusion
See detailed explanation of the complete process:
https://expo.survex.com/handbook/computing/logbooks-parsing.html
2023-01-19 21:18:42 +00:00
"""
todo = """
- refactor everything with some urgency, esp. LoadLogbookForExpedition()
- remove the TROG things since we need the database for multiuser access? Or not?
2022-08-30 15:58:49 +01:00
- profile the code to find bad repetitive things, of which there are many.
- far too many uses of Django field dereferencing to get values, which is SLOW
2022-03-24 01:05:50 +00:00
2022-08-30 15:58:49 +01:00
- Logbooks 1987, 1988, 1989 all crash on MySql - but not sqlite - with db constraint fail. Edit logbook to fix.
2021-11-05 21:01:10 +00:00
- import/parse/re-export-as-html the 'artisanal-format' old logbooks so that
2022-08-30 15:58:49 +01:00
we keep only a modern HTML05 format. Then we can retire the old parsers and reduce the
volume of code here substantially.
- rewrite to use generators rather than storing everything intermediate in lists - to reduce memory impact.
- We should ensure logbook.html is utf-8 and stop this crap:
file_in = open(logbookfile,'rb')
txt = file_in.read().decode("latin1")
- this is a slow and uncertain function: cave = getCaveByReference(caveRef)
2022-08-30 15:58:49 +01:00
2022-12-07 18:22:09 +00:00
- use Fixtures https://docs.djangoproject.com/en/4.1/ref/django-admin/#django-admin-loaddata to cache
data for old logbooks? Not worth it..
2022-12-07 18:22:09 +00:00
2023-01-19 21:18:42 +00:00
"""
MAX_LOGBOOK_ENTRY_TITLE_LENGTH = 200
BLOG_PARSER_SETTINGS = {
2023-01-19 21:18:42 +00:00
# "2022": ("ukcavingblog.html", "parser_blog"), # now folded in to logbooks.html
# "2019": ("ukcavingblog.html", "parser_blog"), # now folded in to logbooks.html
# "2018": ("ukcavingblog.html", "parser_blog"), # now folded in to logbooks.html
# "2017": ("ukcavingblog.html", "parser_blog"), # now folded in to logbooks.html
}
DEFAULT_LOGBOOK_FILE = "logbook.html"
DEFAULT_LOGBOOK_PARSER = "parser_html"
2022-12-18 21:20:30 +00:00
# All years since 2002 use the default value for Logbook parser
# dont forget to update expoweb/pubs.htm to match.
2023-01-19 21:18:42 +00:00
LOGBOOK_PARSER_SETTINGS = {
"2002": ("logbook.html", "parser_html"),
"2001": ("log.htm", "parser_html_01"),
"2000": ("log.htm", "parser_html_01"),
"1999": ("log.htm", "parser_html_01"),
"1998": ("log.htm", "parser_html_01"),
"1997": ("log.htm", "parser_html_01"),
"1996": ("log.htm", "parser_html_01"),
"1995": ("log.htm", "parser_html_01"),
"1994": ("logbook.html", "parser_html"),
"1993": ("logbook.html", "parser_html"),
"1992": ("logbook.html", "parser_html"),
"1991": ("logbook.html", "parser_html"),
"1990": ("logbook.html", "parser_html"),
"1989": ("logbook.html", "parser_html"),
"1988": ("logbook.html", "parser_html"),
"1987": ("logbook.html", "parser_html"),
"1985": ("logbook.html", "parser_html"),
"1984": ("logbook.html", "parser_html"),
"1983": ("logbook.html", "parser_html"),
"1982": ("logbook.html", "parser_html"),
}
entries = {
"2022": 89,
"2019": 55,
"2018": 95,
"2017": 74,
"2016": 86,
"2015": 80,
"2014": 65,
"2013": 52,
"2012": 75,
"2011": 71,
"2010": 22,
"2009": 53,
"2008": 49,
"2007": 113,
"2006": 60,
"2005": 55,
"2004": 76,
"2003": 42,
"2002": 31,
"2001": 49,
"2000": 54,
"1999": 79,
"1998": 43,
"1997": 53,
"1996": 95,
"1995": 42,
"1994": 32,
"1993": 41,
"1992": 62,
"1991": 39,
"1990": 87,
"1989": 63,
"1988": 61,
"1987": 34,
"1985": 24,
"1984": 32,
"1983": 52,
"1982": 42,
}
logentries = [] # the entire logbook for one year is a single object: a list of entries
noncaveplaces = ["Journey", "Loser Plateau", "UNKNOWN", "plateau", "base camp", "basecamp", "top camp", "topcamp"]
logdataissues = TROG["issues"]["logdataissues"]
trips = {}
2011-07-11 02:10:22 +01:00
#
# the logbook loading section
#
def set_trip_id(year, seq):
2023-01-19 21:18:42 +00:00
tid = f"{year}_s{seq:02d}"
return tid
2023-01-19 21:18:42 +00:00
rx_tripperson = re.compile(r"(?i)<u>(.*?)</u>$")
rx_round_bracket = re.compile(r"[\(\[].*?[\)\]]")
2023-01-19 21:18:42 +00:00
def GetTripPersons(trippeople, expedition, logtime_underground, tid=None):
2023-01-19 21:18:42 +00:00
res = []
2011-07-11 02:10:22 +01:00
author = None
# print(f'# {tid}')
# print(f" - {tid} '{trippeople}' ")
for tripperson in re.split(r",|\+|&amp;|&(?!\w+;)| and ", trippeople):
2011-07-11 02:10:22 +01:00
tripperson = tripperson.strip()
# mul = re.match(r"(?i)<u>(.*?)</u>$", tripperson)
mul = rx_tripperson.match(tripperson)
2011-07-11 02:10:22 +01:00
if mul:
tripperson = mul.group(1).strip()
2023-01-19 21:18:42 +00:00
if tripperson and tripperson[0] != "*":
tripperson = re.sub(rx_round_bracket, "", tripperson).strip()
2023-01-19 21:18:42 +00:00
2022-12-18 21:20:30 +00:00
# these aliases should be moved to people.py GetPersonExpeditionNameLookup(expedition)
2023-01-19 21:18:42 +00:00
if tripperson == "Wiggy":
2021-04-24 01:23:55 +01:00
tripperson = "Phil Wigglesworth"
2023-01-19 21:18:42 +00:00
if tripperson == "Animal":
2021-04-24 01:23:55 +01:00
tripperson = "Mike Richardson"
2023-01-19 21:18:42 +00:00
if tripperson == "MikeTA":
2022-10-07 21:47:05 +01:00
tripperson = "Mike Richardson"
2023-01-19 21:18:42 +00:00
if tripperson == "CavingPig":
tripperson = "Elaine Oliver"
2023-01-19 21:18:42 +00:00
if tripperson == "nobrotson":
tripperson = "Rob Watson"
2023-01-19 21:18:42 +00:00
if tripperson == "Tinywoman":
2022-12-17 17:05:55 +00:00
tripperson = "Nadia"
2023-01-19 21:18:42 +00:00
if tripperson == "tcacrossley":
2022-12-18 21:20:30 +00:00
tripperson = "Tom Crossley"
2023-01-19 21:18:42 +00:00
if tripperson == "Samouse1":
tripperson = "Todd Rye"
2021-04-24 01:23:55 +01:00
2011-07-11 02:10:22 +01:00
personyear = GetPersonExpeditionNameLookup(expedition).get(tripperson.lower())
if not personyear:
2023-01-19 21:18:42 +00:00
message = f" ! - {expedition.year} No name match for: '{tripperson}' in entry {tid=} for this expedition year."
2021-02-06 00:18:48 +00:00
print(message)
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2011-07-11 02:10:22 +01:00
res.append((personyear, logtime_underground))
if mul:
author = personyear
if not author:
if not res:
return "", 0
2023-01-19 21:18:42 +00:00
author = res[-1][0] # the previous valid person and a time of 0 hours
# print(f" - {tid} [{author.person}] '{res[0][0].person}'...")
2011-07-11 02:10:22 +01:00
return res, author
2023-01-19 21:18:42 +00:00
2022-08-30 15:58:49 +01:00
def EnterLogIntoDbase(date, place, title, text, trippeople, expedition, logtime_underground, tid=None):
2023-01-19 21:18:42 +00:00
"""saves a logbook entry and related persontrips
2021-05-02 15:50:20 +01:00
Does NOT save the expeditionday_id - all NULLs. why? Because we are deprecating expeditionday !
2023-01-19 21:18:42 +00:00
troggle.log shows that we are creating lots of duplicates, which is no no problem with SQL as they just overwrite but we are saving the same thing too many times..
2022-12-18 19:33:56 +00:00
Until 18 Dec.2022, this was overwriting logbook entries for the same date with the same title, because
lookupAttribs={'date':date, 'title':title}
2020-06-19 16:39:05 +01:00
"""
2023-01-19 21:18:42 +00:00
2022-12-18 19:33:56 +00:00
# Nasty hack, must tidy this up..
if logtime_underground:
try:
logtime_underground = float(logtime_underground)
except:
# print(f"logtime_underground = {logtime_underground}")
tu_match = re.match(r"(T/U:\s*)?(\d+[.]?\d*).*", logtime_underground)
if tu_match:
# print(f"logtime_underground = {tu_match.group(2)}")
logtime_underground = float(tu_match.group(2))
else:
logtime_underground = 0
else:
logtime_underground = 0
try:
trippersons, author = GetTripPersons(trippeople, expedition, logtime_underground, tid=tid)
2022-12-18 19:33:56 +00:00
# print(f" - {author} - {logtime_underground}")
except:
message = f" ! - {expedition.year} Skipping logentry: {title} - GetTripPersons FAIL"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["title"] = message
print(message)
raise
return
2023-01-19 21:18:42 +00:00
2011-07-11 02:10:22 +01:00
if not author:
2022-12-14 23:46:14 +00:00
message = f" ! - {expedition.year} Warning: logentry: {title} - no expo member author for entry '{tid}'"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["title"] = message
print(message)
2023-01-19 21:18:42 +00:00
# return
2020-06-19 16:39:05 +01:00
# This needs attention. The slug field is derived from 'title'
# both GetCaveLookup() and GetTripCave() need to work together better. None of this data is *used* though?
2023-01-19 21:18:42 +00:00
# tripCave = GetTripCave(place):
2011-07-11 02:10:22 +01:00
lplace = place.lower()
2023-01-19 21:18:42 +00:00
cave = None
2011-07-11 02:10:22 +01:00
if lplace not in noncaveplaces:
2020-06-19 16:39:05 +01:00
cave = GetCaveLookup().get(lplace)
2023-01-19 21:18:42 +00:00
2021-05-02 15:50:20 +01:00
y = str(date)[:4]
2023-01-19 21:18:42 +00:00
text = text.replace(' src="', f' src="/years/{y}/')
text = text.replace(" src='", f" src='/years/{y}/")
2023-01-19 21:18:42 +00:00
text = text.replace(f' src="/years/{y}//years/{y}/', f' src="/years/{y}/')
text = text.replace(f" src='/years/{y}//years/{y}/", f" src='/years/{y}/")
2011-07-11 02:10:22 +01:00
2023-01-19 21:18:42 +00:00
text = text.replace("\t", "")
text = text.replace("\n\n\n", "\n\n")
# Check for an existing copy of the current entry, and save
2011-07-11 02:10:22 +01:00
expeditionday = expedition.get_expedition_day(date)
2023-01-19 21:18:42 +00:00
lookupAttribs = {"date": date, "title": title}
2020-06-19 16:39:05 +01:00
# 'cave' is converted to a string doing this, which renders as the cave slug.
2020-07-01 22:49:38 +01:00
# but it is a db query which we should try to avoid - rewrite this
2023-01-19 21:18:42 +00:00
# NEW slug for a logbook entry here! Unique id + slugified title fragment
if tid is not None:
slug = tid
# slug = tid + "_" + slugify(title)[:10].replace('-','_')
2023-01-19 21:18:42 +00:00
else:
slug = str(randint(1000, 9999)) + "_" + slugify(title)[:10].replace("-", "_")
nonLookupAttribs = {
"place": place,
"text": text,
"expedition": expedition,
"time_underground": logtime_underground,
"cave_slug": str(cave),
"slug": slug,
}
2022-08-30 15:58:49 +01:00
# This creates the lbo instance of LogbookEntry
2023-01-19 21:18:42 +00:00
lbo, created = save_carefully(LogbookEntry, lookupAttribs, nonLookupAttribs)
2022-12-18 19:33:56 +00:00
# for PersonTrip time_underground is float (decimal hours)
2011-07-11 02:10:22 +01:00
for tripperson, time_underground in trippersons:
# print(f" - {tid} '{tripperson}' author:{tripperson == author}")
2023-01-19 21:18:42 +00:00
lookupAttribs = {"personexpedition": tripperson, "logbook_entry": lbo}
nonLookupAttribs = {"time_underground": time_underground, "is_logbook_entry_author": (tripperson == author)}
# this creates the PersonTrip instance.
save_carefully(PersonTrip, lookupAttribs, nonLookupAttribs)
2011-07-11 02:10:22 +01:00
2023-01-19 21:18:42 +00:00
2011-07-11 02:10:22 +01:00
def ParseDate(tripdate, year):
2023-01-19 21:18:42 +00:00
"""Interprets dates in the expo logbooks and returns a correct datetime.date object"""
2022-07-15 13:11:49 +01:00
dummydate = date(1970, 1, 1)
2022-08-25 13:54:00 +01:00
month = 1
day = 1
2022-09-21 22:22:09 +01:00
# message = f" ! - Trying to parse date in logbook: {tripdate} - {year}"
# print(message)
try:
mdatestandard = re.match(r"(\d\d\d\d)-(\d\d)-(\d\d)", tripdate)
mdategoof = re.match(r"(\d\d?)/0?(\d)/(20|19)?(\d\d)", tripdate)
if mdatestandard:
if not (mdatestandard.group(1) == year):
2022-07-08 23:30:49 +01:00
message = f" ! - Bad date (year) in logbook: {tripdate} - {year}"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["tripdate"] = message
2022-07-15 13:11:49 +01:00
return dummydate
else:
year, month, day = int(mdatestandard.group(1)), int(mdatestandard.group(2)), int(mdatestandard.group(3))
elif mdategoof:
if not (not mdategoof.group(3) or mdategoof.group(3) == year[:2]):
message = " ! - Bad date mdategoof.group(3) in logbook: " + tripdate + " - " + mdategoof.group(3)
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["tripdate"] = message
2022-07-15 13:11:49 +01:00
return dummydate
else:
yadd = int(year[:2]) * 100
day, month, year = int(mdategoof.group(1)), int(mdategoof.group(2)), int(mdategoof.group(4)) + yadd
else:
2022-08-25 13:54:00 +01:00
year = 1970
2022-07-08 23:30:49 +01:00
message = f" ! - Bad date in logbook: {tripdate} - {year}"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["tripdate"] = message
return date(year, month, day)
except:
2022-07-08 23:30:49 +01:00
message = f" ! - Failed to parse date in logbook: {tripdate} - {year}"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues["tripdate"] = message
2022-07-08 23:55:11 +01:00
return datetime.date(1970, 1, 1)
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
# 2002 - now
def parser_html(year, expedition, txt, seq=""):
2023-01-19 21:18:42 +00:00
"""This uses some of the more obscure capabilities of regular expressions,
see https://docs.python.org/3/library/re.html
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
You can't see it here, but a round-trip export-then-import will move
the endmatter up to the frontmatter. This makes sense when moving
from parser_html_01 format logfiles, believe me.
2023-01-19 21:18:42 +00:00
"""
2020-06-08 21:33:32 +01:00
global logentries
global logdataissues
# extract front material and stash for later use when rebuilding from list of entries
headmatch = re.match(r"(?i)(?s).*<body[^>]*>(.*?)<hr.*", txt)
headpara = headmatch.groups()[0].strip()
2023-01-19 21:18:42 +00:00
# print(f" - headpara:\n'{headpara}'")
2023-01-19 21:18:42 +00:00
if len(headpara) > 0:
frontpath = Path(settings.EXPOWEB, "years", year, "frontmatter.html")
2023-01-19 21:18:42 +00:00
with open(frontpath, "w") as front:
front.write(headpara + "\n")
2022-12-21 02:05:26 +00:00
# extract END material and stash for later use when rebuilding from list of entries
endmatch = re.match(r"(?i)(?s).*<hr\s*/>([\s\S]*?)(?=</body)", txt)
endpara = endmatch.groups()[0].strip()
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
# print(f" - endpara:\n'{endpara}'")
2023-01-19 21:18:42 +00:00
if len(endpara) > 0:
2022-12-21 02:05:26 +00:00
endpath = Path(settings.EXPOWEB, "years", year, "endmatter.html")
2023-01-19 21:18:42 +00:00
with open(endpath, "w") as end:
end.write(endpara + "\n")
tripparas = re.findall(r"<hr\s*/>([\s\S]*?)(?=<hr)", txt)
logbook_entry_count = 0
2011-07-11 02:10:22 +01:00
for trippara in tripparas:
logbook_entry_count += 1
2023-01-19 21:18:42 +00:00
tid = set_trip_id(year, logbook_entry_count)
2022-03-24 01:16:43 +00:00
# print(f' - new tid:{tid} lbe count: {logbook_entry_count}')
2023-01-19 21:18:42 +00:00
s = re.match(
r"""(?x)(?:\s*<div\sclass="tripdate"\sid=".*?">.*?</div>\s*<p>)? # second date
2011-07-11 02:10:22 +01:00
\s*(?:<a\s+id="(.*?)"\s*/>\s*</a>)?
\s*<div\s+class="tripdate"\s*(?:id="(.*?)")?>(.*?)</div>(?:<p>)?
\s*<div\s+class="trippeople">\s*(.*?)</div>
\s*<div\s+class="triptitle">\s*(.*?)</div>
([\s\S]*?)
\s*(?:<div\s+class="timeug">\s*(.*?)</div>)?
\s*$
2023-01-19 21:18:42 +00:00
""",
trippara,
)
2022-08-25 14:12:13 +01:00
if s:
tripid, tripid1, tripdate, trippeople, triptitle, triptext, tu = s.groups()
2023-01-19 21:18:42 +00:00
else: # allow title and people to be swapped in order
msg = f" !- {year} Can't parse:{logbook_entry_count} '{trippara[:50]}'..."
print(msg)
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=msg)
logdataissues[tid] = msg
2023-01-19 21:18:42 +00:00
s2 = re.match(
r"""(?x)(?:\s*<div\sclass="tripdate"\sid=".*?">.*?</div>\s*<p>)? # second date
2022-08-25 13:54:00 +01:00
\s*(?:<a\s+id="(.*?)"\s*/>\s*</a>)?
\s*<div\s+class="tripdate"\s*(?:id="(.*?)")?>(.*?)</div>(?:<p>)?
\s*<div\s+class="triptitle">\s*(.*?)</div>
\s*<div\s+class="trippeople">\s*(.*?)</div>
([\s\S]*?)
\s*(?:<div\s+class="timeug">\s*(.*?)</div>)?
\s*$
2023-01-19 21:18:42 +00:00
""",
trippara,
)
2022-08-25 14:12:13 +01:00
if s2:
tripid, tripid1, tripdate, triptitle, trippeople, triptext, tu = s2.groups()
else:
# if not re.search(r"Rigging Guide", trippara):
msg = f" !- Logbook. Can't parse entry on 2nd pass:{logbook_entry_count} '{trippara[:50]}'..."
print(msg)
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=msg)
logdataissues[tid] = msg
2022-08-25 14:12:13 +01:00
continue
2023-01-19 21:18:42 +00:00
2011-07-11 02:10:22 +01:00
ldate = ParseDate(tripdate.strip(), year)
triptitles = triptitle.split(" - ")
if len(triptitles) >= 2:
tripcave = triptitles[0]
else:
tripcave = "UNKNOWN"
ltriptext = re.sub(r"</p>", "", triptext)
2023-01-19 21:18:42 +00:00
# ltriptext = re.sub(r"\s*?\n\s*", " ", ltriptext)
ltriptext = re.sub(r"<p>", "<br /><br />", ltriptext).strip()
2023-01-19 21:18:42 +00:00
2022-12-18 20:36:11 +00:00
triptitle = triptitle.strip()
2023-01-19 21:18:42 +00:00
entrytuple = (ldate, tripcave, triptitle, ltriptext, trippeople, expedition, tu, tripid1)
2020-06-08 21:33:32 +01:00
logentries.append(entrytuple)
2023-01-19 21:18:42 +00:00
# main parser for 1991 - 2001. simpler because the data has been hacked so much to fit it
def parser_html_01(year, expedition, txt, seq=""):
2022-12-20 19:59:36 +00:00
global logentries
global logdataissues
errorcount = 0
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
# extract front material and stash for later use when rebuilding from list of entries
headmatch = re.match(r"(?i)(?s).*<body[^>]*>(.*?)<hr.*", txt)
headpara = headmatch.groups()[0].strip()
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
# print(f" - headpara:\n'{headpara}'")
2023-01-19 21:18:42 +00:00
if len(headpara) > 0:
2022-12-21 02:05:26 +00:00
frontpath = Path(settings.EXPOWEB, "years", year, "frontmatter.html")
2023-01-19 21:18:42 +00:00
with open(frontpath, "w") as front:
front.write(headpara + "\n")
2022-12-20 19:59:36 +00:00
2022-12-21 02:05:26 +00:00
# extract END material and stash for later use when rebuilding from list of entries
endmatch = re.match(r"(?i)(?s).*<hr\s*/>([\s\S]*?)(?=</body)", txt)
if endmatch:
endpara = endmatch.groups()[0].strip()
else:
print(f" ! - {year} NO endmatch")
endpara = ""
2023-01-19 21:18:42 +00:00
2022-12-21 02:05:26 +00:00
# print(f" - endpara:\n'{endpara}'")
2023-01-19 21:18:42 +00:00
if len(endpara) > 0:
2022-12-21 02:05:26 +00:00
endpath = Path(settings.EXPOWEB, "years", year, "endmatter.html")
2023-01-19 21:18:42 +00:00
with open(endpath, "w") as end:
end.write(endpara + "\n")
2022-12-20 19:59:36 +00:00
tripparas = re.findall(r"<hr[\s/]*>([\s\S]*?)(?=<hr)", txt)
logbook_entry_count = 0
for trippara in tripparas:
logbook_entry_count += 1
2023-01-19 21:18:42 +00:00
tid = set_trip_id(year, logbook_entry_count)
2022-12-20 19:59:36 +00:00
# print(f" #0 - tid: {tid}")
try:
2023-01-19 21:18:42 +00:00
# print(f" #1 - tid: {tid}")
2022-12-20 19:59:36 +00:00
s = re.match(r"(?i)(?s)\s*(?:<p>)?(.*?)</?p>(.*)$", trippara)
if not s:
message = " ! - Skipping logentry {year} failure to parse header: " + tid + trippara[:300] + "..."
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
break
try:
tripheader, triptext = s.group(1), s.group(2)
except:
2023-01-19 21:18:42 +00:00
message = f" ! - Fail to set tripheader, triptext. trip:<{tid}> s:'{s}'"
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
# mtripid = re.search(r'<a id="(.*?)"', tripheader)
# if not mtripid:
2023-01-19 21:18:42 +00:00
# message = f" ! - A tag id not found. Never mind. Not needed. trip:<{tid}> header:'{tripheader}'"
# DataIssue.objects.create(parser='logbooks', message=message)
# logdataissues[tid]=message
# print(message)
2022-12-20 19:59:36 +00:00
# tripid = mtripid and mtripid.group(1) or ""
# print(f" # - mtripid: {mtripid}")
tripheader = re.sub(r"</?(?:[ab]|span)[^>]*>", "", tripheader)
2023-01-19 21:18:42 +00:00
# print(f" #2 - tid: {tid}")
2022-12-20 19:59:36 +00:00
try:
tripdate, triptitle, trippeople = tripheader.split("|")
except:
2023-01-19 21:18:42 +00:00
message = f" ! - Fail 3 to split out date|title|people. trip:<{tid}> '{tripheader.split('|')}'"
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
try:
tripdate, triptitle = tripheader.split("|")
trippeople = "GUESS ANON"
except:
2023-01-19 21:18:42 +00:00
message = f" ! - Skipping logentry {year} Fail 2 to split out date|title (anon). trip:<{tid}> '{tripheader.split('|')}' CRASHES MySQL !"
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
break
2023-01-19 21:18:42 +00:00
# print(f" #3 - tid: {tid}")
2022-12-20 19:59:36 +00:00
ldate = ParseDate(tripdate.strip(), year)
2023-01-19 21:18:42 +00:00
# print(f" # - tid: {tid} <{tripdate}> <{triptitle}> <{trippeople}>")
# print(f" #4 - tid: {tid}")
2022-12-20 19:59:36 +00:00
2023-01-19 21:18:42 +00:00
mtu = re.search(r"<p[^>]*>(T/?U.*)", triptext)
2022-12-20 19:59:36 +00:00
if mtu:
tu = mtu.group(1)
2023-01-19 21:18:42 +00:00
triptext = triptext[: mtu.start(0)] + triptext[mtu.end() :]
2022-12-20 19:59:36 +00:00
else:
tu = ""
triptitles = triptitle.split(" - ")
tripcave = triptitles[0].strip()
ltriptext = triptext
2023-01-19 21:18:42 +00:00
2022-12-20 19:59:36 +00:00
mtail = re.search(r'(?:<a href="[^"]*">[^<]*</a>|\s|/|-|&amp;|</?p>|\((?:same day|\d+)\))*$', ltriptext)
if mtail:
2023-01-19 21:18:42 +00:00
ltriptext = ltriptext[: mtail.start(0)]
2022-12-20 19:59:36 +00:00
ltriptext = re.sub(r"</p>", "", ltriptext)
ltriptext = re.sub(r"\s*?\n\s*", " ", ltriptext)
ltriptext = re.sub(r"</?u>", "_", ltriptext)
ltriptext = re.sub(r"</?i>", "''", ltriptext)
ltriptext = re.sub(r"</?b>", "'''", ltriptext)
ltriptext = re.sub(r"<p>", "<br /><br />", ltriptext).strip()
2023-01-19 21:18:42 +00:00
2022-12-20 19:59:36 +00:00
if ltriptext == "":
2023-01-19 21:18:42 +00:00
message = " ! - Zero content for logbook entry!: " + tid
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
2023-01-19 21:18:42 +00:00
entrytuple = (ldate, tripcave, triptitle, ltriptext, trippeople, expedition, tu, tid)
2022-12-20 19:59:36 +00:00
logentries.append(entrytuple)
2023-01-19 21:18:42 +00:00
2022-12-20 19:59:36 +00:00
except:
message = f" ! - Skipping logentry {year} due to exception in: {tid}"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
errorcount += 1
raise
2023-01-19 21:18:42 +00:00
if errorcount > 5:
2022-12-20 19:59:36 +00:00
message = f" !!- TOO MANY ERRORS - aborting at '{tid}' logbook: {year}"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-20 19:59:36 +00:00
print(message)
return
2023-01-19 21:18:42 +00:00
def parser_blog(year, expedition, txt, sq=""):
2023-01-19 21:18:42 +00:00
"""Parses the format of web pages collected as 'Save As HTML" from the UK Caving blog website.
2022-12-14 23:46:14 +00:00
Note that the entries have dates and authors, but no titles.
See detailed explanation of the complete process:
https://expo.survex.com/handbook/computing/logbooks-parsing.html
https://expo.survex.com/handbook/computing/log-blog-parsing.html
2023-01-19 21:18:42 +00:00
This uses some of the more obscure capabilities of regular expressions,
see https://docs.python.org/3/library/re.html
2023-01-19 21:18:42 +00:00
BLOG entries have this structure:
<article ... data-author="Tinywoman" data-content="post-298780" id="js-post-298780">
<article class="message-body js-selectToQuote">
</article>
2023-01-19 21:18:42 +00:00
</article>
So the content is nested inside the header. Attachments (images) come after the content.
2023-01-19 21:18:42 +00:00
"""
2022-12-14 23:46:14 +00:00
global logentries
global logdataissues
errorcount = 0
2020-06-08 21:33:32 +01:00
2023-01-19 21:18:42 +00:00
tripheads = re.findall(
r"<article class=\"message message--post js-post js-inlineModContainer\s*\"\s*([\s\S]*?)(?=</article)", txt
)
if not (tripheads):
2022-12-14 23:46:14 +00:00
message = f" ! - Skipping on failure to parse article header: {txt[:500]}"
print(message)
2020-06-08 21:33:32 +01:00
# (?= is a non-consuming match, see https://docs.python.org/3/library/re.html
2023-01-19 21:18:42 +00:00
tripparas = re.findall(
r"<article class=\"message-body js-selectToQuote\"\>\s*([\s\S]*?)(</article[^>]*>)([\s\S]*?)(?=</article)", txt
)
if not (tripparas):
2022-12-14 23:46:14 +00:00
message = f" ! - Skipping on failure to parse article content: {txt[:500]}"
print(message)
2023-01-19 21:18:42 +00:00
if len(tripheads) != len(tripparas):
2022-12-14 23:46:14 +00:00
print(f"{len(tripheads)} != {len(tripparas)}")
print(f"{len(tripheads)} - {len(tripparas)}")
2022-12-14 23:46:14 +00:00
2023-01-19 21:18:42 +00:00
location = "Plateau" # best guess, fix manually later
2022-12-14 23:46:14 +00:00
tu = 0
logbook_entry_count = 0
for i in range(0, len(tripparas)):
tripstuff = tripparas[i]
attach = tripstuff[2]
# note use on non-greedy *? regex idiom here
2023-01-19 21:18:42 +00:00
attach = re.sub(r"<div class=\"file-content\">[\s\S]*?(?=</li>)", "", attach)
attach = re.sub(r"<footer[\s\S]*(</footer>)", "", attach)
tripcontent = tripstuff[0] + attach
2023-01-19 21:18:42 +00:00
# print(f"{i} - {len(tripstuff)} - {tripstuff[1]}")
2022-12-14 23:46:14 +00:00
triphead = tripheads[i]
logbook_entry_count += 1
2023-01-19 21:18:42 +00:00
tid = set_trip_id(year, logbook_entry_count) + "_blog" + sq
2022-12-14 23:46:14 +00:00
# print(f" - tid: {tid}")
2023-01-19 21:18:42 +00:00
2022-12-14 23:46:14 +00:00
# data-author="tcacrossley"
match_author = re.search(r".*data-author=\"([^\"]*)\" data-content=.*", triphead)
2023-01-19 21:18:42 +00:00
if not (match_author):
2022-12-14 23:46:14 +00:00
message = f" ! - Skipping logentry {year}:{logbook_entry_count} on failure to parse data-author {tid} {triphead[:400]}..."
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-14 23:46:14 +00:00
print(message)
break
trippeople = match_author.group(1)
# print(f" - tid: {tid} {trippeople}")
# datetime="2019-07-11T13:16:18+0100"
2022-12-14 23:46:14 +00:00
match_datetime = re.search(r".*datetime=\"([^\"]*)\" data-time=.*", triphead)
2023-01-19 21:18:42 +00:00
if not (match_datetime):
2022-12-14 23:46:14 +00:00
message = f" ! - Skipping logentry {year}:{logbook_entry_count} on failure to parse datetime {tid} {triphead[:400]}..."
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
2022-12-14 23:46:14 +00:00
print(message)
break
datestamp = match_datetime.group(1)
2023-01-19 21:18:42 +00:00
2022-12-15 01:06:54 +00:00
try:
tripdate = datetime.fromisoformat(datestamp)
except:
message = f" ! - FROMISOFORMAT fail logentry {year}:{logbook_entry_count} {tid} '{datestamp}'"
2023-01-19 21:18:42 +00:00
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[tid] = message
print(message)
# fallback, ignore the timestamp bits:
2022-12-15 01:06:54 +00:00
tripdate = datetime.fromisoformat(datestamp[0:10])
# print(f" - tid: {tid} '{trippeople}' '{tripdate}'")
2023-01-19 21:18:42 +00:00
# tripname must have the location then a hyphen at the beginning as it is ignored by export function
location = "Unknown"
2023-01-19 21:18:42 +00:00
tripname = f"Expo - UK Caving Blog{sq} post {logbook_entry_count}" # must be unique for a given date
tripcontent = re.sub(r"(width=\"\d+\")", "", tripcontent)
tripcontent = re.sub(r"height=\"\d+\"", "", tripcontent)
tripcontent = re.sub(r"width: \d+px", "", tripcontent)
tripcontent = re.sub(r"\n\n+", "\n\n", tripcontent)
tripcontent = re.sub(r"<hr\s*>", "", tripcontent)
tripcontent = f"\n\n<!-- Content parsed from UK Caving Blog -->\nBlog Author: {trippeople}" + tripcontent
entrytuple = (tripdate, location, tripname, tripcontent, trippeople, expedition, tu, tid)
2022-12-14 23:46:14 +00:00
logentries.append(entrytuple)
2023-01-19 21:18:42 +00:00
2022-12-15 00:35:48 +00:00
def LoadLogbookForExpedition(expedition, clean=True):
2023-01-19 21:18:42 +00:00
"""Parses all logbook entries for one expedition
if clean==True then it deletes all entries for this year first.
2020-05-30 20:31:20 +01:00
"""
global logentries
# absolutely horrid. REFACTOR THIS (all my fault..)
global logdataissues
2022-03-24 01:05:50 +00:00
global entries
logbook_parseable = False
2023-01-19 21:18:42 +00:00
yearlinks = LOGBOOK_PARSER_SETTINGS
2020-05-30 20:31:20 +01:00
expologbase = os.path.join(settings.EXPOWEB, "years")
2023-01-19 21:18:42 +00:00
logentries = []
2022-03-24 01:05:50 +00:00
year = expedition.year
expect = entries[year]
# print(" - Logbook for: " + year)
def cleanerrors(year):
global logdataissues
2023-01-19 21:18:42 +00:00
dataissues = DataIssue.objects.filter(parser="logbooks")
for di in dataissues:
ph = year
if re.search(ph, di.message) is not None:
2023-01-19 21:18:42 +00:00
# print(f' - CLEANING dataissue {di.message}')
di.delete()
2023-01-19 21:18:42 +00:00
# print(f' - CLEAN {year} {len(logdataissues)} {type(logdataissues)} data issues for this year')
dellist = []
for key, value in logdataissues.items():
2023-01-19 21:18:42 +00:00
# print(f' - CLEANING logdataissues [{key}]: {value}')
if key.startswith(year):
2023-01-19 21:18:42 +00:00
# print(f' - CLEANING logdataissues [{key:12}]: {value} ')
dellist.append(key)
for i in dellist:
del logdataissues[i]
2023-01-19 21:18:42 +00:00
if clean:
2022-12-15 00:35:48 +00:00
cleanerrors(year)
2022-03-24 01:05:50 +00:00
if year in yearlinks:
2022-12-14 23:46:14 +00:00
yearfile, yearparser = yearlinks[year]
2023-01-19 21:18:42 +00:00
logbookpath = Path(yearfile)
expedition.logbookfile = yearfile
parsefunc = yearparser
2022-12-15 00:35:48 +00:00
# print(f" - Logbook file {yearfile} using parser {yearparser}")
2022-12-14 23:46:14 +00:00
2020-05-30 20:31:20 +01:00
else:
logbookpath = Path(DEFAULT_LOGBOOK_FILE)
expedition.logbookfile = DEFAULT_LOGBOOK_FILE
2023-01-19 21:18:42 +00:00
parsefunc = DEFAULT_LOGBOOK_PARSER
2020-05-30 20:31:20 +01:00
expedition.save()
2023-01-19 21:18:42 +00:00
lbes = LogbookEntry.objects.filter(expedition=expedition)
2023-01-19 21:18:42 +00:00
if clean:
2022-12-15 00:35:48 +00:00
for lbe in lbes:
lbe.delete()
2023-01-19 21:18:42 +00:00
for sq in ["", "2", "3", "4"]: # cope with blog saved as many separate files
lb = Path(expologbase, year, logbookpath.stem + sq + logbookpath.suffix)
if not (lb.is_file()):
# print(f" ! End of blog. Next blog file in sequence not there:{lb}")
break
2022-08-30 15:58:49 +01:00
try:
2023-01-19 21:18:42 +00:00
with open(lb, "rb") as file_in:
txt = file_in.read().decode("utf-8")
logbook_parseable = True
except (IOError):
logbook_parseable = False
print(f" ! Couldn't open logbook as UTF-8 {lb}")
except:
logbook_parseable = False
print(f" ! Very Bad Error opening {lb}")
if logbook_parseable:
2023-01-19 21:18:42 +00:00
# --------------------
parser = globals()[parsefunc]
2023-01-19 21:18:42 +00:00
print(f" - {year} parsing with {parsefunc} - {lb}")
parser(year, expedition, txt, sq) # this launches the right parser for this year
# --------------------
2022-12-18 19:33:56 +00:00
dupl = {}
for entrytuple in logentries:
2022-12-18 19:33:56 +00:00
date, tripcave, triptitle, text, trippeople, expedition, logtime_underground, tripid1 = entrytuple
check = (date, triptitle)
if check in dupl:
dupl[check] += 1
triptitle = f"{triptitle} #{dupl[check]}"
2023-01-19 21:18:42 +00:00
print(f" - {triptitle} -- {date}")
2022-12-18 19:33:56 +00:00
else:
dupl[check] = 1
2023-01-19 21:18:42 +00:00
EnterLogIntoDbase(date, tripcave, triptitle, text, trippeople, expedition, logtime_underground, tripid1)
2022-03-24 01:05:50 +00:00
if len(logentries) == expect:
# print(f"OK {year} {len(logentries):5d} is {expect}\n")
pass
else:
2022-12-20 15:18:07 +00:00
print(f"Mismatch in number of log entries: {year} {len(logentries):5d} is not {expect}\n")
2022-03-24 01:05:50 +00:00
2020-06-06 22:51:55 +01:00
return len(logentries)
2023-01-19 21:18:42 +00:00
2022-12-18 19:33:56 +00:00
def LoadLogbook(year):
2023-01-19 21:18:42 +00:00
"""One off logbook for testing purposes"""
2022-12-18 19:33:56 +00:00
global LOGBOOK_PARSER_SETTINGS
2023-01-19 21:18:42 +00:00
nlbe = {}
TROG["pagecache"]["expedition"][year] = None # clear cache
expo = Expedition.objects.get(year=year)
year = expo.year # some type funny
2022-12-18 19:33:56 +00:00
nlbe[expo] = LoadLogbookForExpedition(expo) # this actually loads the logbook for one expo
if year in BLOG_PARSER_SETTINGS:
print("BLOG parsing")
2023-01-19 21:18:42 +00:00
LOGBOOK_PARSER_SETTINGS[year] = BLOG_PARSER_SETTINGS[year]
nlbe[expo] = LoadLogbookForExpedition(expo, clean=False) # this loads the blog logbook for one expo
else:
2023-01-19 21:18:42 +00:00
print(
f"Not a year with extant blog entries to import: '{year}' not in BLOG_PARSER_SETTINGS {BLOG_PARSER_SETTINGS}"
)
2022-12-14 23:46:14 +00:00
2011-07-11 02:10:22 +01:00
def LoadLogbooks():
2023-01-19 21:18:42 +00:00
"""This is the master function for parsing all logbooks into the Troggle database.
2022-11-21 16:26:30 +00:00
This should be rewritten to use coroutines to load all logbooks from disc in parallel,
but must be serialised to write to database as sqlite is single-user.
2020-05-30 20:31:20 +01:00
"""
2020-06-08 21:33:32 +01:00
global logdataissues
2022-03-24 01:05:50 +00:00
global entries
2020-06-08 21:33:32 +01:00
logdataissues = {}
2023-01-19 21:18:42 +00:00
DataIssue.objects.filter(parser="logbooks").delete()
2020-05-30 12:35:15 +01:00
expos = Expedition.objects.all()
2020-06-06 22:51:55 +01:00
if len(expos) <= 1:
2023-01-19 21:18:42 +00:00
message = f" ! - No expeditions found. Load 'people' first"
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[f"sqlfail 0000"] = message
2022-03-18 10:21:25 +00:00
print(message)
2022-12-15 00:35:48 +00:00
return
2022-03-18 10:21:25 +00:00
2023-01-19 21:18:42 +00:00
noexpo = [
"1986",
"2020",
"2021",
] # no expo
2022-03-02 21:15:24 +00:00
lostlogbook = ["1976", "1977", "1978", "1979", "1980", "1981"]
2023-01-19 21:18:42 +00:00
sqlfail = [""] # breaks mysql with db constraint fail - all now fixed.]
2022-03-02 21:15:24 +00:00
nologbook = noexpo + lostlogbook + sqlfail
2022-03-24 01:05:50 +00:00
2023-01-19 21:18:42 +00:00
nlbe = {}
expd = {}
2022-12-15 00:35:48 +00:00
loglist = []
bloglist = []
2023-01-19 21:18:42 +00:00
for expo in expos: # pointless as we explicitly know the years in this code.
2022-03-24 01:05:50 +00:00
year = expo.year
2023-01-19 21:18:42 +00:00
TROG["pagecache"]["expedition"][year] = None # clear cache
2022-03-24 01:05:50 +00:00
if year in sqlfail:
print(" - Logbook for: " + year + " NO parsing attempted - known sql failures")
2023-01-19 21:18:42 +00:00
message = f" ! - Not even attempting to parse logbook for {year} until code fixed"
DataIssue.objects.create(parser="logbooks", message=message)
logdataissues[f"sqlfail {year}"] = message
2022-03-24 01:05:50 +00:00
print(message)
2022-03-02 21:15:24 +00:00
2022-03-24 01:05:50 +00:00
if year not in nologbook:
if year in entries:
2022-12-15 00:35:48 +00:00
loglist.append(expo)
2022-03-24 01:05:50 +00:00
else:
2023-01-19 21:18:42 +00:00
print(" - No Logbook yet for: " + year) # catch case when preparing for next expo
if year in BLOG_PARSER_SETTINGS:
2022-12-15 00:35:48 +00:00
bloglist.append(expo)
2022-03-24 01:05:50 +00:00
2022-12-15 00:35:48 +00:00
for ex in loglist:
nlbe[ex] = LoadLogbookForExpedition(ex) # this loads the logbook for one expo
2022-12-15 00:35:48 +00:00
for b in bloglist:
if str(b) in LOGBOOK_PARSER_SETTINGS:
orig = LOGBOOK_PARSER_SETTINGS[str(b)]
else:
orig = (DEFAULT_LOGBOOK_FILE, DEFAULT_LOGBOOK_PARSER)
2023-01-19 21:18:42 +00:00
LOGBOOK_PARSER_SETTINGS[str(b)] = BLOG_PARSER_SETTINGS[str(b)]
print(f" - BLOG: {b}")
nlbe[b] = LoadLogbookForExpedition(b, clean=False) # this loads the blog logbook for one expo
2022-12-15 00:35:48 +00:00
LOGBOOK_PARSER_SETTINGS[str(b)] = orig
2022-03-24 01:05:50 +00:00
# tried to use map with concurrent threads - but sqlite database is not concurrent, so failed with database lock
# yt = 0
2023-01-19 21:18:42 +00:00
# for r in map(LoadLogbookForExpedition, loglist):
# yt = r
2022-03-24 01:05:50 +00:00
yt = 0
for e in nlbe:
yt += nlbe[e]
print(f"total {yt:,} log entries parsed in all expeditions")
2022-03-02 21:15:24 +00:00
# dateRegex = re.compile(r'<span\s+class="date">(\d\d\d\d)-(\d\d)-(\d\d)</span>', re.S)
# expeditionYearRegex = re.compile(r'<span\s+class="expeditionyear">(.*?)</span>', re.S)
# titleRegex = re.compile(r'<H1>(.*?)</H1>', re.S)
# reportRegex = re.compile(r'<div\s+class="report">(.*)</div>\s*</body>', re.S)
# personRegex = re.compile(r'<div\s+class="person">(.*?)</div>', re.S)
# nameAuthorRegex = re.compile(r'<span\s+class="name(,author|)">(.*?)</span>', re.S)
# TURegex = re.compile(r'<span\s+class="TU">([0-9]*\.?[0-9]+)</span>', re.S)
# locationRegex = re.compile(r'<span\s+class="location">(.*?)</span>', re.S)
# caveRegex = re.compile(r'<span\s+class="cave">(.*?)</span>', re.S)