From f9c6ecc8b21f6a374f3d8441b6a95fa2f3d22e24 Mon Sep 17 00:00:00 2001
From: black-sliver <59490463+black-sliver@users.noreply.github.com>
Date: Fri, 15 Nov 2024 17:31:03 +0100
Subject: [PATCH] Webhost: fix doc and yaml filenames / install paths (#4193)

* WebHost: use new safe yaml template filename

this mirrors the change in ArchipelagoMW/#4106 in WebHost

* WebHost: install docs into safe filename and require docs to be named safe

* Test: update doc test for safe name

* WebHost: fix import order to not break ModuleUpdate
---
 WebHost.py                                            |  3 ++-
 WebHostLib/__init__.py                                |  3 ++-
 WebHostLib/templates/gameInfo.html                    |  2 +-
 WebHostLib/templates/playerOptions/playerOptions.html |  2 +-
 WebHostLib/templates/tutorial.html                    |  2 +-
 test/webhost/test_docs.py                             | 10 ++++++++--
 6 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/WebHost.py b/WebHost.py
index e597de24763d..3bf75eb35ae0 100644
--- a/WebHost.py
+++ b/WebHost.py
@@ -12,6 +12,7 @@
 # in case app gets imported by something like gunicorn
 import Utils
 import settings
+from Utils import get_file_safe_name
 
 if typing.TYPE_CHECKING:
     from flask import Flask
@@ -71,7 +72,7 @@ def create_ordered_tutorials_file() -> typing.List[typing.Dict[str, typing.Any]]
     shutil.rmtree(base_target_path, ignore_errors=True)
     for game, world in worlds.items():
         # copy files from world's docs folder to the generated folder
-        target_path = os.path.join(base_target_path, game)
+        target_path = os.path.join(base_target_path, get_file_safe_name(game))
         os.makedirs(target_path, exist_ok=True)
 
         if world.zip_path:
diff --git a/WebHostLib/__init__.py b/WebHostLib/__init__.py
index fdf3037fe015..dbe2182b0747 100644
--- a/WebHostLib/__init__.py
+++ b/WebHostLib/__init__.py
@@ -9,7 +9,7 @@
 from pony.flask import Pony
 from werkzeug.routing import BaseConverter
 
-from Utils import title_sorted
+from Utils import title_sorted, get_file_safe_name
 
 UPLOAD_FOLDER = os.path.relpath('uploads')
 LOGS_FOLDER = os.path.relpath('logs')
@@ -20,6 +20,7 @@
 
 app.jinja_env.filters['any'] = any
 app.jinja_env.filters['all'] = all
+app.jinja_env.filters['get_file_safe_name'] = get_file_safe_name
 
 app.config["SELFHOST"] = True  # application process is in charge of running the websites
 app.config["GENERATORS"] = 8  # maximum concurrent world gens
diff --git a/WebHostLib/templates/gameInfo.html b/WebHostLib/templates/gameInfo.html
index c5ebba82848d..3b908004b1be 100644
--- a/WebHostLib/templates/gameInfo.html
+++ b/WebHostLib/templates/gameInfo.html
@@ -11,7 +11,7 @@
 
 {% block body %}
     {% include 'header/'+theme+'Header.html' %}
-    <div id="game-info" class="markdown" data-lang="{{ lang }}" data-game="{{ game }}">
+    <div id="game-info" class="markdown" data-lang="{{ lang }}" data-game="{{ game | get_file_safe_name }}">
         <!-- Populated my JS / MD -->
     </div>
 {% endblock %}
diff --git a/WebHostLib/templates/playerOptions/playerOptions.html b/WebHostLib/templates/playerOptions/playerOptions.html
index 73de5d56eb20..7e2f0ee11cb4 100644
--- a/WebHostLib/templates/playerOptions/playerOptions.html
+++ b/WebHostLib/templates/playerOptions/playerOptions.html
@@ -42,7 +42,7 @@ <h1>Player Options</h1>
             A list of all games you have generated can be found on the <a href="/user-content">User Content Page</a>.
             <br />
             You may also download the
-            <a href="/static/generated/configs/{{ world_name }}.yaml">template file for this game</a>.
+            <a href="/static/generated/configs/{{ world_name | get_file_safe_name }}.yaml">template file for this game</a>.
         </p>
 
         <form id="options-form" method="post" enctype="application/x-www-form-urlencoded" action="generate-yaml">
diff --git a/WebHostLib/templates/tutorial.html b/WebHostLib/templates/tutorial.html
index d3a7e0a05ecc..4b6622c31336 100644
--- a/WebHostLib/templates/tutorial.html
+++ b/WebHostLib/templates/tutorial.html
@@ -11,7 +11,7 @@
 {% endblock %}
 
 {% block body %}
-    <div id="tutorial-wrapper" class="markdown" data-game="{{ game }}" data-file="{{ file }}" data-lang="{{ lang }}">
+    <div id="tutorial-wrapper" class="markdown" data-game="{{ game | get_file_safe_name }}" data-file="{{ file | get_file_safe_name }}" data-lang="{{ lang }}">
         <!-- Content generated by JavaScript -->
     </div>
 {%  endblock %}
diff --git a/test/webhost/test_docs.py b/test/webhost/test_docs.py
index 68aba05f9dcc..1e6c1b88f42c 100644
--- a/test/webhost/test_docs.py
+++ b/test/webhost/test_docs.py
@@ -30,10 +30,16 @@ def test_has_tutorial(self):
     def test_has_game_info(self):
         for game_name, world_type in AutoWorldRegister.world_types.items():
             if not world_type.hidden:
-                target_path = Utils.local_path("WebHostLib", "static", "generated", "docs", game_name)
+                safe_name = Utils.get_file_safe_name(game_name)
+                target_path = Utils.local_path("WebHostLib", "static", "generated", "docs", safe_name)
                 for game_info_lang in world_type.web.game_info_languages:
                     with self.subTest(game_name):
                         self.assertTrue(
-                            os.path.isfile(Utils.local_path(target_path, f'{game_info_lang}_{game_name}.md')),
+                            safe_name == game_name or
+                            not os.path.isfile(Utils.local_path(target_path, f'{game_info_lang}_{game_name}.md')),
+                            f'Info docs have be named <lang>_{safe_name}.md for {game_name}.'
+                        )
+                        self.assertTrue(
+                            os.path.isfile(Utils.local_path(target_path, f'{game_info_lang}_{safe_name}.md')),
                             f'{game_name} missing game info file for "{game_info_lang}" language.'
                         )