Inactive List (#489)

* Add inactive file + schema.

* Bulk add inactive servers.

Author: ThatKawaiiSam

.github/workflows/validate-upload.yml

@@ -25,7 +25,7 @@ jobs:
         run: pip install -r scripts/requirements.txt
 
       - name: Validate Server JSON
-        run: python scripts/validate_json.py --servers_dir servers --metadata_schema metadata.schema.json
+        run: python scripts/validate_json.py --servers_dir servers --metadata_schema metadata.schema.json --inactive_file inactive.json --inactive_schema inactive.schema.json
 
       - name: Validate Server Media
         run: python scripts/validate_media.py --servers_dir servers

README.md

@@ -49,6 +49,12 @@ We ask that this repository is only used to store mappings for *public* Minecraf
 
 Lunar Client also reserves the right to omit any servers that do not comply with our [Terms of Service](https://www.lunarclient.com/terms).
 
+## Inactive Server Policy
+
+If a server has closed down or has not been joinable for at least 3 months, we will add it to the `inactive.json`. This just flags our internal systems to not include the server in various place, but still retains all of the branding and other metadata you submit.
+
+If you think your server has been added to this list by mistake, please make a support ticket at the link below.
+
 ## Can I use this data for ___?
 
 Go for it.

inactive.json

@@ -0,0 +1,55 @@
+[
+    "alpharip",
+    "antique",
+    "arashimc",
+    "arcane",
+    "beepvp",
+    "betterpvp",
+    "betterpvpnt",
+    "brithnobar",
+    "cavrynetwork",
+    "chillcenter",
+    "cloudnetwork",
+    "crystal",
+    "darkmc",
+    "eclipsepvp",
+    "faithfulmc",
+    "fraze",
+    "galaxycore",
+    "glade",
+    "glancenetwork",
+    "goldzonecz",
+    "hikari",
+    "hivemc",
+    "inertianetwork",
+    "juvymc",
+    "kira",
+    "koupahgames",
+    "limaru",
+    "lynxmc",
+    "madnetwork",
+    "mcgamer",
+    "minearcade",
+    "minebox",
+    "minechaos",
+    "minedestiny",
+    "mizu",
+    "mythicalmc",
+    "ncea",
+    "neptuniummc",
+    "potpvpbrazil",
+    "ravenhub",
+    "renshu",
+    "savanapvp",
+    "skillwars",
+    "starcraftmc",
+    "starpvp",
+    "teamfightcc",
+    "tropical",
+    "valley",
+    "vealypvp",
+    "vestpvp",
+    "warfaremc",
+    "ymzc",
+    "zoltixnetwork"
+]

inactive.schema.json

@@ -0,0 +1,7 @@
+{
+    "type": "array",
+    "items": {
+        "type": "string",
+        "pattern": "^[a-z0-9_.-]+$"
+    }
+}

scripts/utils.py

@@ -4,6 +4,11 @@
 def get_all_servers(servers_dir):
     servers = []
 
+    # Open inactive.json
+    inactive = []
+    with open(f"inactive.json") as inactive_file:
+        inactive = json.load(inactive_file)
+
     # Looping over each server folder
     for root, _dirs, _files in os.walk(servers_dir):
         server_id = root.split(os.path.sep)[-1]
@@ -14,6 +19,15 @@ def get_all_servers(servers_dir):
         with open(f"{servers_dir}/{server_id}/metadata.json") as server_file:
             server = json.load(server_file)
 
+        # Images
+        logo_path = f'{servers_dir}/{server_id}/logo.png'
+        background_path = f'{servers_dir}/{server_id}/background.png'
+
+        # Enrich server data
+        server["inactive"] = server["id"] in inactive
+        server["enriched"] = os.path.isfile(logo_path) and os.path.isfile(background_path)
+
+        # Add to list
         servers.append(server)
 
     # Sort A-Z

scripts/validate_json.py

@@ -8,8 +8,28 @@ def main():
     parser = argparse.ArgumentParser()
     parser.add_argument('--servers_dir', required=True, type=str)
     parser.add_argument('--metadata_schema', required=True, type=str)
+    parser.add_argument('--inactive_file', required=True, type=str)
+    parser.add_argument('--inactive_schema', required=True, type=str)
     args = parser.parse_args()
 
+    # Validate Inactive File
+    inactive_schema = {}
+    with open(args.inactive_schema) as inactive_schema_file:
+        inactive_schema = json.load(inactive_schema_file)
+
+    inactive_file = []
+    with open(args.inactive_file) as inactive_file_file:
+        inactive_file = json.load(inactive_file_file)
+
+    print(f'Validating inactive.json file...')
+
+    try:
+        jsonschema.validate(instance=inactive_file, schema=inactive_schema)
+    except jsonschema.ValidationError:
+        raise ValueError('inactive.json does not match the schema.')
+
+    print(f'Successfully validated inactive.json file!')
+
     # Load server mappings Schema
     metadata_schema = {}
     with open(args.metadata_schema) as schema_file: