WebHost: offer combined yaml file on /check if successful (#2337)

WebHostLib/check.py

@@ -1,5 +1,6 @@
 import zipfile
-from typing import *
+import base64
+from typing import Union, Dict, Set, Tuple
 
 from flask import request, flash, redirect, url_for, render_template
 from markupsafe import Markup
@@ -30,7 +31,15 @@ def check():
                 flash(options)
             else:
                 results, _ = roll_options(options)
-                return render_template("checkResult.html", results=results)
+                if len(options) > 1:
+                    # offer combined file back
+                    combined_yaml = "---\n".join(f"# original filename: {file_name}\n{file_content.decode('utf-8-sig')}"
+                                                 for file_name, file_content in options.items())
+                    combined_yaml = base64.b64encode(combined_yaml.encode("utf-8-sig")).decode()
+                else:
+                    combined_yaml = ""
+                return render_template("checkResult.html",
+                                       results=results, combined_yaml=combined_yaml)
     return render_template("check.html")
 
 
@@ -41,31 +50,32 @@ def mysterycheck():
 
 def get_yaml_data(files) -> Union[Dict[str, str], str, Markup]:
     options = {}
-    for file in files:
+    for uploaded_file in files:
         # if user does not select file, browser also
         # submit an empty part without filename
-        if file.filename == '':
+        if uploaded_file.filename == '':
             return 'No selected file'
-        elif file.filename in options:
-            return f'Conflicting files named {file.filename} submitted'
-        elif file and allowed_file(file.filename):
-            if file.filename.endswith(".zip"):
+        elif uploaded_file.filename in options:
+            return f'Conflicting files named {uploaded_file.filename} submitted'
+        elif uploaded_file and allowed_file(uploaded_file.filename):
+            if uploaded_file.filename.endswith(".zip"):
 
-                with zipfile.ZipFile(file, 'r') as zfile:
+                with zipfile.ZipFile(uploaded_file, 'r') as zfile:
                     infolist = zfile.infolist()
 
                     if any(file.filename.endswith(".archipelago") for file in infolist):
                         return Markup("Error: Your .zip file contains an .archipelago file. "
-                                    'Did you mean to <a href="/uploads">host a game</a>?')
+                                      'Did you mean to <a href="/uploads">host a game</a>?')
 
                     for file in infolist:
                         if file.filename.endswith(banned_zip_contents):
-                            return "Uploaded data contained a rom file, which is likely to contain copyrighted material. " \
-                                "Your file was deleted."
+                            return ("Uploaded data contained a rom file, "
+                                    "which is likely to contain copyrighted material. "
+                                    "Your file was deleted.")
                         elif file.filename.endswith((".yaml", ".json", ".yml", ".txt")):
                             options[file.filename] = zfile.open(file, "r").read()
             else:
-                options[file.filename] = file.read()
+                options[uploaded_file.filename] = uploaded_file.read()
     if not options:
         return "Did not find a .yaml file to process."
     return options

WebHostLib/templates/checkResult.html

@@ -28,6 +28,10 @@
                     {% endfor %}
                 </tbody>
             </table>
+        {% if combined_yaml %}
+            <h1>Combined File Download</h1>
+            <p><a href="data:text/yaml;base64,{{ combined_yaml }}" download="combined.yaml">Download</a></p>
+        {% endif %}
         </div>
     </div>
 {% endblock %}