From bb8c70f3bbb8a2ec90ed102fab2664bb3b00bf64 Mon Sep 17 00:00:00 2001 From: Philip Sargent Date: Tue, 15 Feb 2022 19:19:35 +0000 Subject: [PATCH] Added to-do items for troggle --- handbook/computing/todo.html | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/handbook/computing/todo.html b/handbook/computing/todo.html index 3668ff2a8..990a35307 100644 --- a/handbook/computing/todo.html +++ b/handbook/computing/todo.html @@ -164,6 +164,11 @@ Click here if no todo list appears here.

Troggle

+
Expo log parsing +
  • Parsing broken on several old expo logs, excluded in the source code +
  • the caching of already-parsed logfiles sems broken, troggle always re-parses all files +
    • +
    CaveView fixing
  • Comment out bad CaveView on server
  • Fix .3d files to be in right places & edit javascript to match {{svx3d}} etc. @@ -213,6 +218,19 @@ which it does at the moment.

    • Troggle Refactoring

    +
    STATIC is very misleading +
  • we don't use the Django package 'staticfiles' but we do have url path re_path(r'^static/ and STATIC-ROOT parameter +from when old troggle was set up to appear to use it. Anyone reading Django documentation would be seriously confused so we +should rename STATIC everywhere as /resources/ or just re-use /site-media/ +
    • +
    MIME types and filename extensions +
  • We should use standard https://docs.python.org/3/library/mimetypes.html +to convert between mimetypes and filenames, not our own hacks +
  • We should not be relying on filenames to accurately describe the format of the files. This is not robus and may also be a bit insecure. +We should use python-magic or some other wrapper around Linux libmagic1 C library. +But note that there are TWO packages called python-magic, see https://stackoverflow.com/questions/436220/how-to-determine-the-encoding-of-text/16203777#16203777 +
    • +
    Make parsers use generators to yield one line at a time
  • Both recursive load and linear load parsers/survex could do this.
  • In the logbooks parsing and cache loading. @@ -226,7 +244,7 @@ which it does at the moment.
  • Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
    • Flatfiles is used to deliver CSS and JS for django admin pages, -
  • staticfiles django plugin broken, not needed so use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working +
  • use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working