Add a way to ignore verification for unsupported games

This also fixes an issue where validation would not even trigger if a
YAML name contained one of the auto incremented fields.

Author: Eijebong

migrations/2024-05-01-130730_add_allow_unsupported_game_setting/down.sql

@@ -0,0 +1,2 @@
+-- This file should undo anything in `up.sql`
+ALTER TABLE rooms DROP COLUMN allow_unsupported;

migrations/2024-05-01-130730_add_allow_unsupported_game_setting/up.sql

@@ -0,0 +1,2 @@
+-- Your SQL goes here
+ALTER TABLE rooms ADD COLUMN allow_unsupported BOOLEAN NOT NULL DEFAULT FALSE;

src/db.rs

@@ -23,6 +23,7 @@ pub struct NewRoom<'a> {
     pub author_id: Option<i64>,
     pub private: bool,
     pub yaml_validation: bool,
+    pub allow_unsupported: bool,
 }
 
 #[derive(Insertable)]
@@ -46,6 +47,7 @@ pub struct Room {
     pub author_id: i64,
     pub private: bool,
     pub yaml_validation: bool,
+    pub allow_unsupported: bool,
 }
 
 impl Room {

src/main.rs

@@ -32,6 +32,7 @@ struct TplContext<'a> {
     cur_module: &'a str,
     user_id: Option<i64>,
     err_msg: Vec<String>,
+    warning_msg: Vec<String>,
     css_version: &'a str,
 }
 
@@ -43,6 +44,7 @@ impl<'a> TplContext<'a> {
             is_logged_in: session.is_logged_in,
             user_id: session.user_id,
             err_msg: session.err_msg.drain(..).collect(),
+            warning_msg: session.warning_msg.drain(..).collect(),
             css_version: CSS_VERSION,
         };
 

src/schema.rs

@@ -17,6 +17,7 @@ diesel::table! {
         author_id -> BigInt,
         private -> Bool,
         yaml_validation -> Bool,
+        allow_unsupported -> Bool,
     }
 }
 

src/views/auth.rs

@@ -19,6 +19,7 @@ pub struct Session {
     pub is_admin: bool,
     pub is_logged_in: bool,
     pub err_msg: Vec<String>,
+    pub warning_msg: Vec<String>,
     pub user_id: Option<i64>,
     pub redirect_on_login: Option<String>,
 }
@@ -36,6 +37,7 @@ impl Into<Session> for SessionRecovery {
             is_admin: self.is_admin,
             is_logged_in: self.is_logged_in,
             err_msg: vec![],
+            warning_msg: vec![],
             user_id: self.user_id,
             redirect_on_login: None,
         }

src/views/mod.rs

@@ -114,7 +114,8 @@ async fn upload_yaml(
     redirect_to: &RedirectTo,
     uuid: Uuid,
     yaml: Form<&[u8]>,
-    session: LoggedInSession,
+    mut session: LoggedInSession,
+    cookies: &CookieJar<'_>,
     ctx: &State<Context>,
 ) -> Result<Redirect> {
     redirect_to.set(&format!("/room/{}", uuid));
@@ -138,7 +139,9 @@ async fn upload_yaml(
                 anyhow::bail!("Invalid yaml file. Syntax error.")
             };
             let Ok(parsed) = serde_yaml::from_str(&doc) else {
-                anyhow::bail!("Invalid yaml file. This does not look like an archipelago game YAML.")
+                anyhow::bail!(
+                    "Invalid yaml file. This does not look like an archipelago game YAML."
+                )
             };
             Ok((doc, parsed))
         })
@@ -156,14 +159,12 @@ async fn upload_yaml(
 
     for (document, parsed) in documents.iter() {
         let mut player_name = parsed.name.clone();
-        player_name.truncate(16);
 
-        if player_name.contains("{NUMBER}") || player_name.contains("{number}") {
-            continue;
-        }
-        if player_name.contains("{PLAYER}") || player_name.contains("{player}") {
-            continue;
-        }
+        let ignore_dupe = player_name.contains("{NUMBER}")
+            || player_name.contains("{number}")
+            || player_name.contains("{PLAYER}")
+            || player_name.contains("{player}");
+        player_name.truncate(16);
 
         if player_name == "meta" || player_name == "Archipelago" {
             return Err(Error(anyhow::anyhow!(format!(
@@ -172,14 +173,27 @@ async fn upload_yaml(
             ))));
         }
 
-        if players_in_room.contains(&player_name) {
+        if !ignore_dupe && players_in_room.contains(&player_name) {
             return Err(Error(anyhow::anyhow!(
                 "Adding this yaml would duplicate a player name"
             )));
         }
 
         if room.yaml_validation {
-            validate_yaml(document, ctx).await?;
+            let unsupported_games = validate_yaml(document, ctx).await?;
+            if room.allow_unsupported {
+                session.0.warning_msg.push(format!(
+                    "Uploaded a YAML with unsupported games: {}. Couldn't verify it.",
+                    unsupported_games.iter().join("; ")
+                ));
+                session.0.save(cookies)?;
+            } else {
+                return Err(anyhow::anyhow!(format!(
+                    "Your YAML contains the following unsupported games: {}. Can't upload.",
+                    unsupported_games.iter().join("; ")
+                ))
+                .into());
+            }
         }
 
         players_in_room.insert(player_name);
@@ -192,14 +206,15 @@ async fn upload_yaml(
     Ok(Redirect::to(uri!(room(uuid))))
 }
 
-async fn validate_yaml(yaml: &str, ctx: &State<Context>) -> Result<()> {
+async fn validate_yaml(yaml: &str, ctx: &State<Context>) -> Result<Vec<String>> {
     if ctx.yaml_validator_url.is_none() {
-        return Ok(());
+        return Ok(vec![]);
     }
 
     #[derive(serde::Deserialize)]
     struct ValidationResponse {
         error: Option<String>,
+        unsupported: Vec<String>,
     }
 
     let client = reqwest::Client::new();
@@ -218,7 +233,7 @@ async fn validate_yaml(yaml: &str, ctx: &State<Context>) -> Result<()> {
         return Err(anyhow::anyhow!(error).into());
     }
 
-    Ok(())
+    Ok(response.unsupported)
 }
 
 #[get("/room/<room_id>/delete/<yaml_id>")]

src/views/room_manager.rs

@@ -32,6 +32,7 @@ struct CreateRoomForm<'a> {
     room_url: &'a str,
     private: bool,
     yaml_validation: bool,
+    allow_unsupported: bool,
 }
 
 #[derive(Template)]
@@ -116,6 +117,7 @@ fn create_room_submit(
         author_id: Some(author_id),
         private: room_form.private,
         yaml_validation: room_form.yaml_validation,
+        allow_unsupported: room_form.allow_unsupported,
     };
     let new_room = db::create_room(&new_room, ctx)?;
 
@@ -174,6 +176,7 @@ fn edit_room_submit(
         author_id: None, // (Skips updating that field)
         private: room_form.private,
         yaml_validation: room_form.yaml_validation,
+        allow_unsupported: room_form.allow_unsupported,
     };
 
     crate::db::update_room(&new_room, ctx)?;

static/css/base.css

@@ -167,13 +167,14 @@ form
     color: white
     text-align: center
 
+  formset
+    input + label
+      margin-left: 2em
+      width: calc(100% - 2em) !important
 
-fieldset
-  padding: 0.5em
-  margin: 1em 0em
-  border: none
-  border: 3px solid hsla(0,0%,0%,0.4)
-  box-shadow: inset 0 0 0 1px hsla(0,0%,100%,0.075), 0 0 0 1px hsla(0,0%,100%,0.075)
+      &:first-of-type
+        margin-left: 0em
+        width: 100% !important
 
 
 legend
@@ -557,8 +558,6 @@ h6
       background: linear-gradient(hsl(135, 0%, 34%), hsl(135, 0%, 26%) )
 
 
-/* == ERROR BOX == */
-
 .error
   background-color: hsl(0,75%,50%) !important
   background-image: url("../images/background.png")
@@ -569,9 +568,15 @@ h6
   text-shadow: 1px 1px black !important
   margin: 1em 0
 
-
-
-/* == Confirmation box == */
+.warning
+  background-color: hsl(30,95%,40%) !important
+  background-image: url("../images/background.png")
+  padding: 0.5em
+  box-shadow: inset 0 0 0 1px hsla(30,0%,100%,0.2), 0 0 0 1px hsl(3,75%,20%)
+  font-weight: bold !important
+  color: hsl(0,100%,95%) !important
+  text-shadow: 1px 1px black !important
+  margin: 1em 0
 
 .confirm
   background-color: hsl(125,50%,40%) !important

static/css/base.css.map

@@ -42,6 +42,9 @@
                     {% for error in base.err_msg %}
                         <p class="error">{{ error }}</p>
                     {% endfor %}
+                    {% for warning in base.warning_msg %}
+                        <p class="warning">{{ warning }}</p>
+                    {% endfor %}
                     {% block messages %}{% endblock messages %}
                 </div>
                 {% block main %}{% endblock main %}

static/sass/base.sass

@@ -46,13 +46,23 @@
     {%- endmatch -%}
     <label for="private">Private room</label>
 
-    {% match room %}
-    {% when Some with (room) %}
-    <input type="checkbox" name="yaml_validation" id="yaml_validation" {% if room.yaml_validation %} checked {% endif %}/>
-    {%- when None -%}
-    <input type="checkbox" name="yaml_validation" id="yaml_validation" checked/>
-    {%- endmatch -%}
-    <label for="yaml_validation">Validate uploaded YAML files</label>
+    <formset>
+        {% match room %}
+        {% when Some with (room) %}
+        <input type="checkbox" name="yaml_validation" id="yaml_validation" {% if room.yaml_validation %} checked {% endif %}/>
+        {%- when None -%}
+        <input type="checkbox" name="yaml_validation" id="yaml_validation" checked/>
+        {%- endmatch -%}
+        <label for="yaml_validation">Validate uploaded YAML files</label>
+
+        {% match room %}
+        {% when Some with (room) %}
+        <input type="checkbox" name="allow_unsupported" id="allow_unsupported" {% if room.allow_unsupported%} checked {% endif %}/>
+        {%- when None -%}
+        <input type="checkbox" name="allow_unsupported" id="allow_unsupported"/>
+        {%- endmatch -%}
+        <label for="allow_unsupported">Allow bypassing validation for unsupported games</label>
+    </formset>
 
     {% match room %}
     {% when Some with (room) %}
@@ -97,5 +107,40 @@
 closeDate.setSeconds(0)
 closeDateEl.value = dateToISOLikeButLocal(closeDate);
 {%- endif %}
+
+function updateFormset(formset) {
+    const inputs = Array.from(formset.getElementsByTagName("input"));
+    if (!inputs) {
+        return;
+    }
+
+    const first_input = inputs[0];
+    if (first_input.type != "checkbox") {
+        return;
+    }
+
+    inputs.splice(0, 1);
+    const display = first_input.checked ? "inline-block" : "none";
+    for (const input of inputs) {
+        if (input.type != "checkbox") {
+            input.style.display = display;
+        }
+
+        for (const label of input.labels) {
+            label.style.display = display;
+        }
+    }
+
+    return first_input;
+}
+
+const formsets = document.getElementsByTagName("formset");
+for (const formset of formsets) {
+    const first_input = updateFormset(formset);
+    if (first_input) {
+        first_input.onchange = () => updateFormset(formset);
+    }
+}
+
 </script>
 {% endblock %}