scratchattach 2.1.15b0__py3-none-any.whl → 3.0.0b1__py3-none-any.whl

{scratchattach/editor → editor}/project.py

@@ -2,20 +2,21 @@ from __future__ import annotations
 
 import json
 import os
+import string
 import warnings
 from io import BytesIO, TextIOWrapper
 from typing import Optional, Iterable, Generator, BinaryIO
+from typing_extensions import deprecated
 from zipfile import ZipFile
 
-from . import base, meta, extension, monitor, sprite, asset, vlb, twconfig, comment, commons
+from . import base, meta, extension, monitor, sprite, asset, vlb, twconfig, comment, commons, mutation
 from scratchattach.site import session
-from scratchattach.site.project import get_project
 from scratchattach.utils import exceptions
 
 
 class Project(base.JSONExtractable):
     """
-    sa.editor's equivalent of the ProjectBody. Represents the editor contents of a scratch project
+    A Project (body). Represents the editor contents of a scratch project
     """
     def __init__(self, _name: Optional[str] = None, _meta: Optional[meta.Meta] = None, _extensions: Iterable[extension.Extension] = (),
                  _monitors: Iterable[monitor.Monitor] = (), _sprites: Iterable[sprite.Sprite] = (), *,
@@ -31,7 +32,7 @@ class Project(base.JSONExtractable):
         self.name = _name
 
         self.meta = _meta
-        self.extensions = _extensions
+        self.extensions: list[extension.Extension] = list(_extensions)
         self.monitors = list(_monitors)
         self.sprites = list(_sprites)
 
@@ -69,11 +70,12 @@ class Project(base.JSONExtractable):
         return _ret
 
     @property
-    def stage(self) -> sprite.Sprite:
+    def stage(self) -> Optional[sprite.Sprite]:
         for _sprite in self.sprites:
             if _sprite.is_stage:
                 return _sprite
         warnings.warn(f"Could not find stage for {self.name}")
+        return None
 
     def to_json(self) -> dict:
         _json = {
@@ -208,22 +210,25 @@ class Project(base.JSONExtractable):
         return project
 
     @staticmethod
+    @deprecated("Use get_project(id).body() instead")
     def from_id(project_id: int, _name: Optional[str] = None):
-        _proj = get_project(project_id)
-        data = json.loads(_proj.get_json())
+        raise Exception("This method is deprecated")
+        # _proj = get_project(project_id)
+        # data = json.loads(_proj.get_json())
 
-        if _name is None:
-            _name = _proj.title
-        _name = str(_name)
+        # if _name is None:
+        #     _name = _proj.title
+        # _name = str(_name)
 
-        _proj = Project.from_json(data)
-        _proj.name = _name
-        return _proj
+        # _proj = Project.from_json(data)
+        # _proj.name = _name
+        # return _proj
 
     def find_vlb(self, value: str | None, by: str = "name",
-                 multiple: bool = False) -> vlb.Variable | vlb.List | vlb.Broadcast | list[
-        vlb.Variable | vlb.List | vlb.Broadcast]:
-        _ret = []
+                 multiple: bool = False) -> Optional[vlb.Variable | vlb.List | vlb.Broadcast | list[
+        vlb.Variable | vlb.List | vlb.Broadcast]]:
+
+        _ret: list[vlb.Variable | vlb.List | vlb.Broadcast] = []
         for _sprite in self.sprites:
             val = _sprite.find_vlb(value, by, multiple)
             if multiple:
@@ -231,9 +236,12 @@ class Project(base.JSONExtractable):
             else:
                 if val is not None:
                     return val
+
         if multiple:
             return _ret
 
+        return None
+
     def find_sprite(self, value: str | None, by: str = "name",
                  multiple: bool = False) -> sprite.Sprite | list[sprite.Sprite]:
         _ret = []
@@ -277,3 +285,97 @@ class Project(base.JSONExtractable):
         _monitor.project = self
         _monitor.reporter_id = self.new_id
         self.monitors.append(_monitor)
+        return _monitor
+
+    def obfuscate(self, *, goto_origin: bool=True) -> None:
+        """
+        Randomly set all the variable names etc. Do not upload this project to the scratch website, as it is
+        against the community guidelines.
+        """
+        # this code is an embarrassing mess. If certain features are added to sa.editor, then it could become a lot cleaner
+        chars = string.ascii_letters + string.digits + string.punctuation
+
+        def b10_to_cbase(b10: int | float):
+            ret = ''
+            new_base = len(chars)
+            while b10 >= 1:
+                ret = chars[int(b10 % new_base)] + ret
+                b10 /= new_base
+
+            return ret
+
+        used = 0
+
+        def rand():
+            nonlocal used
+            used += 1
+
+            return b10_to_cbase(used)
+
+        for _sprite in self.sprites:
+            procedure_mappings: dict[str, str] = {}
+            argument_mappings: dict[str, str] = {}
+            done_args: list[mutation.Argument] = []
+
+            for _variable in _sprite.variables:
+                _variable.name = rand()
+            for _list in _sprite.lists:
+                _list.name = rand()
+            # don't rename broadcasts as these can be dynamically called
+
+            def arg_get(name: str) -> str:
+                if name not in argument_mappings:
+                    argument_mappings[name] = rand()
+                return argument_mappings[name]
+
+            for _block in _sprite.blocks.values():
+                if goto_origin:
+                    _block.x, _block.y = 0, 0
+
+                # TODO: Add special handling for turbowarp debugger blocks
+                if _block.opcode in ("procedures_call", "procedures_prototype", "procedures_definition"):
+                    if _block.mutation is None:
+                        continue
+
+                    proccode = _block.mutation.proc_code
+                    if proccode is None:
+                        continue
+
+                    if proccode not in procedure_mappings:
+                        parsed_ppc = _block.mutation.parsed_proc_code
+
+                        if parsed_ppc is None:
+                            continue
+
+                        new: list[str | mutation.ArgumentType] = []
+                        for item in parsed_ppc:
+                            if isinstance(item, str):
+                                item = rand()
+
+                            new.append(item)
+
+                        new_proccode = mutation.construct_proccode(*new)
+                        procedure_mappings[proccode] = new_proccode
+
+                    _block.mutation.proc_code = procedure_mappings[proccode]
+
+                    assert _block.mutation.arguments is not None
+                    for arg in _block.mutation.arguments:
+                        if arg in done_args:
+                            continue
+                        done_args.append(arg)
+
+                        arg.name = arg_get(arg.name)
+
+                    # print(_block, _block.mutation)
+                elif _block.opcode in ("argument_reporter_string_number", "argument_reporter_boolean"):
+                    arg_name = _block.fields["VALUE"].value
+                    assert isinstance(arg_name, str)
+                    _block.fields["VALUE"].value = arg_get(arg_name)
+
+
+                # print(argument_mappings)
+
+            if goto_origin:
+                for _comment in _sprite.comments:
+                    _comment.x, _comment.y = 0, 0

{scratchattach/editor → editor}/sprite.py

@@ -102,6 +102,11 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
         self.link_prims()
         self.link_blocks()
         self.link_comments()
+        self.link_vlbs()
+
+    def link_vlbs(self):
+        for _vlb in self.vlbs:
+            _vlb.sprite = self
 
     def link_prims(self):
         """
@@ -278,18 +283,18 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
         _tempo, _video_state, _video_transparency, _text_to_speech_language = (None,) * 4
         _visible, _x, _y, _size, _direction, _draggable, _rotation_style = (None,) * 7
         if _is_stage:
-            _tempo = data["tempo"]
-            _video_state = data["videoState"]
-            _video_transparency = data["videoTransparency"]
-            _text_to_speech_language = data["textToSpeechLanguage"]
+            _tempo = data.get("tempo", 0)
+            _video_state = data.get("videoState", "off")
+            _video_transparency = data.get("videoTransparency", 0)
+            _text_to_speech_language = data.get("textToSpeechLanguage", "en")
         else:
             _visible = data["visible"]
-            _x = data["x"]
-            _y = data["y"]
-            _size = data["size"]
-            _direction = data["direction"]
-            _draggable = data["draggable"]
-            _rotation_style = data["rotationStyle"]
+            _x = data.get("x", 0)
+            _y = data.get("y", 0)
+            _size = data.get("size", 100)
+            _direction = data.get("direction", 90)
+            _draggable = data.get("draggable", False)
+            _rotation_style = data.get("rotationStyle", "all-around")
 
         return Sprite(_is_stage, _name, _current_costume, _layer_order, _volume, _broadcasts, _variables, _lists,
                       _costumes,
@@ -340,7 +345,7 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
         return _json
 
     # Finding/getting from list/dict attributes
-    def find_asset(self, value: str, by: str = "name", multiple: bool = False, a_type: Optional[type]=None) -> asset.Asset | asset.Sound | asset.Costume | list[asset.Asset | asset.Sound | asset.Costume]:
+    def find_asset(self, value: str, by: str = "name", multiple: bool = False, a_type: Optional[type]=None) -> None | asset.Asset | asset.Sound | asset.Costume | list[asset.Asset | asset.Sound | asset.Costume]:
         if a_type is None:
             a_type = asset.Asset
 
@@ -361,8 +366,9 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
 
         if multiple:
             return _ret
+        return None
 
-    def find_variable(self, value: str, by: str = "name", multiple: bool = False) -> vlb.Variable | list[vlb.Variable]:
+    def find_variable(self, value: str, by: str = "name", multiple: bool = False) -> None | vlb.Variable | list[vlb.Variable]:
         _ret = []
         by = by.lower()
         for _variable in self.variables + self._local_globals:
@@ -389,8 +395,9 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
 
         if multiple:
             return _ret
+        return None
 
-    def find_list(self, value: str, by: str = "name", multiple: bool = False) -> vlb.List | list[vlb.List]:
+    def find_list(self, value: str, by: str = "name", multiple: bool = False) -> None | vlb.List | list[vlb.List]:
         _ret = []
         by = by.lower()
         for _list in self.lists + self._local_globals:
@@ -416,8 +423,9 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
 
         if multiple:
             return _ret
+        return None
 
-    def find_broadcast(self, value: str, by: str = "name", multiple: bool = False) -> vlb.Broadcast | list[
+    def find_broadcast(self, value: str, by: str = "name", multiple: bool = False) -> None | vlb.Broadcast | list[
         vlb.Broadcast]:
         _ret = []
         by = by.lower()
@@ -444,6 +452,7 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
 
         if multiple:
             return _ret
+        return None
 
     def find_vlb(self, value: str, by: str = "name",
                  multiple: bool = False) -> vlb.Variable | vlb.List | vlb.Broadcast | list[
@@ -461,7 +470,7 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
                 return _ret
             return self.find_broadcast(value, by)
 
-    def find_block(self, value: str | Any, by: str, multiple: bool = False) -> block.Block | prim.Prim | list[
+    def find_block(self, value: str | Any, by: str, multiple: bool = False) -> None | block.Block | prim.Prim | list[
         block.Block | prim.Prim]:
         _ret = []
         by = by.lower()
@@ -507,6 +516,7 @@ class Sprite(base.ProjectSubcomponent, base.JSONExtractable):
 
         if multiple:
             return _ret
+        return None
 
     def export(self, fp: Optional[str] = None, *, export_as_zip: bool = True):
         if fp is None:

{scratchattach/editor → editor}/vlb.py

@@ -73,7 +73,7 @@ class List(base.NamedIDComponent):
         https://en.scratch-wiki.info/wiki/Scratch_File_Format#Targets:~:text=lists,as%20an%20array
         """
         if _value is None:
-            _value = []
+            _value: list[str | int | float] = []
 
         self.value = _value
         super().__init__(_id, _name, _sprite)
@@ -91,7 +91,7 @@ class List(base.NamedIDComponent):
 
         return List(_id, _name, _value)
 
-    def to_json(self) -> tuple[str, tuple[str, str | int | float, bool] | tuple[str, str | int | float]]:
+    def to_json(self) -> tuple[str, list[str | int | float]]:
         """
         Returns List data as a tuple
         """

{scratchattach/eventhandlers → eventhandlers}/_base.py

@@ -17,6 +17,7 @@ class BaseEventHandler(ABC):
         self.running = False
         self._events = defaultdict(list)
         self._threaded_events = defaultdict(list)
+        print(f"{self._threaded_events=}")
 
     def start(self, *, thread=True, ignore_exceptions=True):
         """

{scratchattach/eventhandlers → eventhandlers}/cloud_events.py

@@ -1,8 +1,11 @@
 """CloudEvents class"""
 from __future__ import annotations
 
+import traceback
+
 from scratchattach.cloud import _base
 from ._base import BaseEventHandler
+from scratchattach.utils import exceptions
 from scratchattach.site import cloud_activity
 import time
 import json
@@ -18,6 +21,7 @@ class CloudEvents(BaseEventHandler):
         self._session = cloud._session
         self.source_stream = cloud.create_event_stream()
         self.startup_time = time.time() * 1000
+        self.subsequent_reconnects = 0
 
     def disconnect(self):
         self.source_stream.close()
@@ -31,25 +35,34 @@ class CloudEvents(BaseEventHandler):
 
         if self.running is False:
             return
+        
+        # TODO: refactor this method. It works, but is hard to read
         while True:
             try:
                 while True:
+                    # print("Checking for more events")
                     for data in self.source_stream.read():
+                        # print(f"Got event {data}")
+                        self.subsequent_reconnects = 0
                         try:
                             _a = cloud_activity.CloudActivity(timestamp=time.time()*1000, _session=self._session, cloud=self.cloud)
                             if _a.timestamp < self.startup_time + 500: # catch the on_connect message sent by TurboWarp's (and sometimes Scratch's) cloud server
+                                # print(f"Skipped as {_a.timestamp} < {self.startup_time + 500}")
                                 continue
                             data["variable_name"] = data["name"]
                             data["name"] = data["variable_name"].replace("☁ ", "")
                             _a._update_from_dict(data)
+                            # print(f"sending event {_a}")
                             self.call_event("on_"+_a.type, [_a])
                         except Exception as e:
+                            print(f"Cloud events _updated ignored: {e} {traceback.format_exc()}")
                             pass
             except Exception:
-                print("CloudEvents: Disconnected. Reconnecting ...", time.time())
+                self.subsequent_reconnects += 1
                 time.sleep(0.1) # cooldown
 
-            print("CloudEvents: Reconnected.", time.time())
+            if self.subsequent_reconnects >= 5:
+                print(f"Warning: {self.subsequent_reconnects} subsequent cloud disconnects. Cloud may be down, causing CloudEvents to not call events.")
             self.call_event("on_reconnect", [])
 
 class ManualCloudLogEvents:
@@ -63,22 +76,25 @@ class ManualCloudLogEvents:
         self.source_cloud = cloud
         self._session = cloud._session
         self.last_timestamp = 0
-    
+        self.subsequent_failed_log_fetches = 0
+
     def update(self) -> Iterator[tuple[str, list[cloud_activity.CloudActivity]]]:
         """
         Update once and yield all packets
         """
         try:
             data = self.source_cloud.logs(limit=25)
+            self.subsequent_failed_log_fetches = 0
             for _a in data[::-1]:
                 if _a.timestamp <= self.last_timestamp:
                     continue
                 self.last_timestamp = _a.timestamp
                 yield ("on_"+_a.type, [_a])
         except Exception:
-            pass
+            self.subsequent_failed_log_fetches += 1
+            if self.subsequent_failed_log_fetches == 20:
+                print("Warning: 20 subsequent clouddata log fetches failed. Scrach's cloud logs may be down, causing CloudLogEvents to not call events.")
         
-
 class CloudLogEvents(BaseEventHandler):
     """
     Class that calls events on cloud updates that are received from a clouddata log.
@@ -95,7 +111,11 @@ class CloudLogEvents(BaseEventHandler):
         self.manual_cloud_log_events = ManualCloudLogEvents(cloud)
 
     def _updater(self):
-        logs = self.source_cloud.logs(limit=25)
+        try:
+            logs = self.source_cloud.logs(limit=25)
+        except exceptions.FetchError:
+            logs = []
+
         self.last_timestamp = 0
         if len(logs) != 0:
             self.last_timestamp = logs[0].timestamp

{scratchattach/eventhandlers → eventhandlers}/cloud_recorder.py

@@ -1,14 +1,14 @@
 """CloudRecorder class (used by ScratchCloud, TwCloud and other classes inheriting from BaseCloud to deliver cloud var values)"""
 from __future__ import annotations
 
+from typing import Optional, Any
+
 from .cloud_events import CloudEvents
-from typing import Optional
 
 
 class CloudRecorder(CloudEvents):
-    def __init__(self, cloud, *, initial_values: Optional[dict] = None):
-        if initial_values is None:
-            initial_values = {}
+    def __init__(self, cloud, *, initial_values: Optional[dict[str, Any]] = None):
+        initial_values = initial_values or {}
 
         super().__init__(cloud)
         self.cloud_values = initial_values