fix: use hjson instead of regex mess

This is not a required dependency. If you want to use it, install it separately

Author: faretek1

scratchattach/site/placeholder.py

@@ -1,13 +1,13 @@
 # Classes and methods for interacting with turbowarp placeholder (https://share.turbowarp.org/)
 import re
-import json
 import bs4
 
 from dataclasses import dataclass
 from typing_extensions import Optional
 from bs4 import BeautifulSoup
 
 from scratchattach.site import session
+from scratchattach.site.typed_dicts import PlaceholderProjectDataDict
 from scratchattach.utils.requests import requests
 from scratchattach import editor
 
@@ -18,17 +18,22 @@ class PlaceholderProject:
     title: Optional[str] = None
     description: Optional[str] = None
     md5exts_to_sha256: Optional[dict[str, str]] = None
+    admin_ownership_token: Optional[str] = None  # guessing it's a str
 
     _session: Optional[session.Session] = None
 
     def get_json(self):
         with requests.no_error_handling():
             return requests.get(f"https://share.turbowarp.org/api/projects/{self.id}").json()
 
-    def update_by_html(self):
+    def update_by_html(self) -> None:
         """
-        Scrape JS to update the project. Hopefully this will not be necessary in the future, as it is very error-prone.
+        Scrape JS to update the project. Requires hjson
         """
+        try:
+            import hjson  # type: ignore
+        except ImportError as e:
+            raise ImportError("Please use pip install hjson if you want to use placeholder projects!") from e
 
         with requests.no_error_handling():
             resp = requests.get(f"https://share.turbowarp.org/projects/{self.id}")
@@ -41,24 +46,16 @@ def update_by_html(self):
                 if raw_data := re.search("const data = \\[.*\"data\":{metadata:{.*},md5extsToSha256:.*];", str(script.contents[0])):
                     data = raw_data.group().removeprefix("const data = ").removesuffix(";")
                     # this data is NOT json. Therefore, we can't just JSON.parse it.
-                    # it's actually native JavaScript, but we can extract the information in a really flimsy way using regex
-                    # This flimsy method would probably break with bad input, so maybe, instead, a request should be made to GarboMuffin.
-                    # If you want full JS support, use an automated browser.
-                    print(data)
-
-                    # get title
-                    pf, sf = 'metadata:{title:"', '",description'
-                    if group := re.search(pf+'.*?'+sf, data).group():
-                        self.title = json.loads('"' + group.removeprefix(pf).removesuffix(sf) + '"')
-
-                    # Get description. It is probably very easy to break this regex
-                    pf, sf = 'description:"', '"},'
-                    if group := re.search(pf+'.*?'+sf, data).group():
-                        self.description = json.loads('"' + group.removeprefix(pf).removesuffix(sf) + '"')
-
-                    pf, sf = 'md5extsToSha256:{', '},'
-                    if group := re.search(pf+'.*?'+sf, data).group():
-                        self.md5exts_to_sha256 = json.loads('{' + group.removeprefix(pf).removesuffix(sf) + '}')
+                    # it's actually native JavaScript, but we can extract the information in a relatively stable way using hjson
+                    # maybe, instead, a request should be made to GarboMuffin.
+                    data = hjson.loads(data)
+                    # i am unsure if the other data here is of any use. It may be artifacts coming from svelte
+                    parsed_data: PlaceholderProjectDataDict = data[1]["data"]
+
+                    self.title = parsed_data["metadata"]["title"]
+                    self.description = parsed_data["metadata"]["description"]
+                    self.md5exts_to_sha256 = dict(parsed_data["md5extsToSha256"])
+                    self.admin_ownership_token = parsed_data["adminOwnershipToken"]
 
                     break
 

scratchattach/site/typed_dicts.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing_extensions import OrderedDict
+
 from scratchattach.cloud import _base
 from typing import TypedDict, Union, Optional, Required, NotRequired
 
@@ -124,3 +126,13 @@ class StudioRoleDict(TypedDict):
     curator: bool
     invited: bool
     following: bool
+
+class PlaceholderProjectDataMetadataDict(TypedDict):
+    title: str
+    description: str
+
+# https://github.com/GarboMuffin/placeholder/blob/e1e98953342a40abbd626a111f621711f74e783b/src/routes/projects/%5Bproject%5D/%2Bpage.server.ts#L19
+class PlaceholderProjectDataDict(TypedDict):
+    metadata: PlaceholderProjectDataMetadataDict
+    md5extsToSha256: OrderedDict[str, str]
+    adminOwnershipToken: Optional[str]