Added to-do items for troggle

This commit is contained in:
Philip Sargent 2022-02-15 19:19:35 +00:00
parent 4228309edd
commit bb8c70f3bb

View File

@ -164,6 +164,11 @@ Click here if no todo list appears here.</div></a>
</details>
<h3>Troggle</h3>
<details><summary><!--2022-02-15 psargent--> Expo log parsing</summary>
<li>Parsing broken on several old expo logs, excluded in the source code
<li>the caching of already-parsed logfiles sems broken, troggle always re-parses all files
</details>
<details><summary><!--2021-11-06 psargent--> CaveView fixing</summary>
<li>Comment out bad CaveView on server
<li>Fix .3d files to be in right places & edit javascript to match {{svx3d}} etc.
@ -213,6 +218,19 @@ which it does at the moment.
</details>
<h3>Troggle Refactoring</h3>
<details><summary><!--2022-02-15 psargent-->STATIC is very misleading</summary>
<li>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/
</details>
<details><summary><!--2022-02-15 psargent-->MIME types and filename extensions</summary>
<li>We should use standard <a href="https://docs.python.org/3/library/mimetypes.html">https://docs.python.org/3/library/mimetypes.html</a>
to convert between mimetypes and filenames, not our own hacks
<li>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 <a href="https://github.com/ahupp/python-magic">python-magic</a> 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
</details>
<details><summary><!--2020-07-24 psargent-->Make parsers use generators to yield one line at a time</summary>
<li><!--2020-07-24 psargent-->Both recursive load and linear load parsers/survex could do this.
<li><!--2020-07-24 psargent-->In the logbooks parsing and cache loading.
@ -226,7 +244,7 @@ which it does at the moment.
<li><!--2020-07-24 psargent-->Get all trogglistas to read https://martinfowler.com/tags/refactoring.html
</details>
<details><summary><!--2020-07-24 psargent-->Flatfiles is used to deliver CSS and JS for django admin pages,</summary>
<li><!--2020-07-24 psargent-->staticfiles django plugin broken, not needed so use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working
<li><!--2020-07-24 psargent--> use flatfiles but fix awkradnesses such as /expofiles/ directory listing not working
</details>