fastled 1.3.0__py3-none-any.whl → 1.3.2__py3-none-any.whl

fastled/project_init.py

@@ -1,129 +1,129 @@
-import _thread
-import threading
-import time
-import zipfile
-from pathlib import Path
-
-import httpx
-
-from fastled.settings import DEFAULT_URL
-from fastled.spinner import Spinner
-
-DEFAULT_EXAMPLE = "wasm"
-
-
-def get_examples(host: str | None = None) -> list[str]:
-    host = host or DEFAULT_URL
-    url_info = f"{host}/info"
-    response = httpx.get(url_info, timeout=4)
-    response.raise_for_status()
-    examples: list[str] = response.json()["examples"]
-    return sorted(examples)
-
-
-def _prompt_for_example() -> str:
-    examples = get_examples()
-    while True:
-        print("Available examples:")
-        for i, example in enumerate(examples):
-            print(f"  [{i+1}]: {example}")
-        answer = input("Enter the example number or name: ").strip()
-        if answer.isdigit():
-            example_num = int(answer) - 1
-            if example_num < 0 or example_num >= len(examples):
-                print("Invalid example number")
-                continue
-            return examples[example_num]
-        elif answer in examples:
-            return answer
-
-
-class DownloadThread(threading.Thread):
-    def __init__(self, url: str, json: str):
-        super().__init__(daemon=True)
-        self.url = url
-        self.json = json
-        self.bytes_downloaded = 0
-        self.content: bytes | None = None
-        self.error: Exception | None = None
-        self.success = False
-
-    def run(self) -> None:
-        timeout = httpx.Timeout(5.0, connect=5.0, read=120.0, write=30.0)
-        try:
-            with httpx.Client(timeout=timeout) as client:
-                with client.stream("POST", self.url, json=self.json) as response:
-                    response.raise_for_status()
-                    content = b""
-                    for chunk in response.iter_bytes():
-                        content += chunk
-                        self.bytes_downloaded += len(chunk)
-                    self.content = content
-                    self.success = True
-        except KeyboardInterrupt:
-            self.error = RuntimeError("Download cancelled")
-            _thread.interrupt_main()
-        except Exception as e:
-            self.error = e
-
-
-def project_init(
-    example: str | None = "PROMPT",  # prompt for example
-    outputdir: Path | None = None,
-    host: str | None = None,
-) -> Path:
-    """
-    Initialize a new FastLED project.
-    """
-    host = host or DEFAULT_URL
-    outputdir = Path(outputdir) if outputdir is not None else Path("fastled")
-    outputdir.mkdir(exist_ok=True, parents=True)
-    if example == "PROMPT" or example is None:
-        try:
-            example = _prompt_for_example()
-        except httpx.HTTPStatusError:
-            print(
-                f"Failed to fetch examples, using default example '{DEFAULT_EXAMPLE}'"
-            )
-            example = DEFAULT_EXAMPLE
-    assert example is not None
-    endpoint_url = f"{host}/project/init"
-    json = example
-    print(f"Initializing project with example '{example}', url={endpoint_url}")
-
-    # Start download thread
-    download_thread = DownloadThread(endpoint_url, json)
-    # spinner = Spinner("Downloading project...")
-    with Spinner(f"Downloading project {example}..."):
-        download_thread.start()
-        while download_thread.is_alive():
-            time.sleep(0.1)
-
-    print()  # New line after progress
-    download_thread.join()
-
-    # Check for errors
-    if not download_thread.success:
-        assert download_thread.error is not None
-        raise download_thread.error
-
-    content = download_thread.content
-    assert content is not None
-    tmpzip = outputdir / "fastled.zip"
-    outputdir.mkdir(exist_ok=True)
-    tmpzip.write_bytes(content)
-    with zipfile.ZipFile(tmpzip, "r") as zip_ref:
-        zip_ref.extractall(outputdir)
-    tmpzip.unlink()
-    out = outputdir / example
-    print(f"Project initialized at {out}")
-    assert out.exists()
-    return out
-
-
-def unit_test() -> None:
-    project_init()
-
-
-if __name__ == "__main__":
-    unit_test()
+import _thread
+import threading
+import time
+import zipfile
+from pathlib import Path
+
+import httpx
+
+from fastled.settings import DEFAULT_URL
+from fastled.spinner import Spinner
+
+DEFAULT_EXAMPLE = "wasm"
+
+
+def get_examples(host: str | None = None) -> list[str]:
+    host = host or DEFAULT_URL
+    url_info = f"{host}/info"
+    response = httpx.get(url_info, timeout=4)
+    response.raise_for_status()
+    examples: list[str] = response.json()["examples"]
+    return sorted(examples)
+
+
+def _prompt_for_example() -> str:
+    examples = get_examples()
+    while True:
+        print("Available examples:")
+        for i, example in enumerate(examples):
+            print(f"  [{i+1}]: {example}")
+        answer = input("Enter the example number or name: ").strip()
+        if answer.isdigit():
+            example_num = int(answer) - 1
+            if example_num < 0 or example_num >= len(examples):
+                print("Invalid example number")
+                continue
+            return examples[example_num]
+        elif answer in examples:
+            return answer
+
+
+class DownloadThread(threading.Thread):
+    def __init__(self, url: str, json: str):
+        super().__init__(daemon=True)
+        self.url = url
+        self.json = json
+        self.bytes_downloaded = 0
+        self.content: bytes | None = None
+        self.error: Exception | None = None
+        self.success = False
+
+    def run(self) -> None:
+        timeout = httpx.Timeout(5.0, connect=5.0, read=120.0, write=30.0)
+        try:
+            with httpx.Client(timeout=timeout) as client:
+                with client.stream("POST", self.url, json=self.json) as response:
+                    response.raise_for_status()
+                    content = b""
+                    for chunk in response.iter_bytes():
+                        content += chunk
+                        self.bytes_downloaded += len(chunk)
+                    self.content = content
+                    self.success = True
+        except KeyboardInterrupt:
+            self.error = RuntimeError("Download cancelled")
+            _thread.interrupt_main()
+        except Exception as e:
+            self.error = e
+
+
+def project_init(
+    example: str | None = "PROMPT",  # prompt for example
+    outputdir: Path | None = None,
+    host: str | None = None,
+) -> Path:
+    """
+    Initialize a new FastLED project.
+    """
+    host = host or DEFAULT_URL
+    outputdir = Path(outputdir) if outputdir is not None else Path("fastled")
+    outputdir.mkdir(exist_ok=True, parents=True)
+    if example == "PROMPT" or example is None:
+        try:
+            example = _prompt_for_example()
+        except httpx.HTTPStatusError:
+            print(
+                f"Failed to fetch examples, using default example '{DEFAULT_EXAMPLE}'"
+            )
+            example = DEFAULT_EXAMPLE
+    assert example is not None
+    endpoint_url = f"{host}/project/init"
+    json = example
+    print(f"Initializing project with example '{example}', url={endpoint_url}")
+
+    # Start download thread
+    download_thread = DownloadThread(endpoint_url, json)
+    # spinner = Spinner("Downloading project...")
+    with Spinner(f"Downloading project {example}..."):
+        download_thread.start()
+        while download_thread.is_alive():
+            time.sleep(0.1)
+
+    print()  # New line after progress
+    download_thread.join()
+
+    # Check for errors
+    if not download_thread.success:
+        assert download_thread.error is not None
+        raise download_thread.error
+
+    content = download_thread.content
+    assert content is not None
+    tmpzip = outputdir / "fastled.zip"
+    outputdir.mkdir(exist_ok=True)
+    tmpzip.write_bytes(content)
+    with zipfile.ZipFile(tmpzip, "r") as zip_ref:
+        zip_ref.extractall(outputdir)
+    tmpzip.unlink()
+    out = outputdir / example
+    print(f"Project initialized at {out}")
+    assert out.exists()
+    return out
+
+
+def unit_test() -> None:
+    project_init()
+
+
+if __name__ == "__main__":
+    unit_test()

fastled/server_flask.py

@@ -26,6 +26,16 @@ else:
     logger.disabled = True
 
 
+def _is_dwarf_source(path: str) -> bool:
+    """Check if the path is a dwarf source file."""
+    # Check if the path starts with "fastledsource/" or "sketchsource/"
+    return (
+        path.startswith("fastledsource/")
+        or path.startswith("sketchsource/")
+        or path.startswith("dwarfsource")
+    )
+
+
 def _run_flask_server(
     fastled_js: Path,
     port: int,
@@ -125,20 +135,18 @@ def _run_flask_server(
                 logger.error(f"Error forwarding request: {e}", exc_info=True)
                 return Response(f"Error: {str(e)}", status=500)
 
-        def handle_dwarfsource(path: str) -> Response:
-            """Handle requests to /drawfsource/js/fastled/src/
-            or /drawfsource/js/drawfsource/emsdk/*"""
+        def handle_fastledsource(path: str) -> Response:
+            """Handle requests to
+            /fastledsource/js/fastledsource/git/fastled/src/
+            or
+            /sketchsource/js/src/Blink.ino
+
+            The names are a bit mangled due to the way C++ prefixing works near the root directory.
+            """
             from flask import request
 
             start_time = time.time()
             logger.info(f"Processing request: {request.method} {request.url}")
-
-            if "../" in path:
-                # Prevent directory traversal attacks
-                error_msg = "Directory traversal attack detected"
-                logger.error(error_msg)
-                return Response(error_msg, status=400)
-
             # Forward the request to the compile server
             target_url = f"http://localhost:{compile_server_port}/{path}"
             logger.info(f"Requesting: {target_url}")
@@ -314,9 +322,10 @@ def _run_flask_server(
             logger.info(f"Received request for path: {path}")
 
             try:
-                if path.startswith("drawfsource/"):
+                is_debug_src_code_request = _is_dwarf_source(path)
+                if is_debug_src_code_request:
                     logger.info(f"Handling as drawfsource: {path}")
-                    return handle_dwarfsource(path)
+                    return handle_fastledsource(path)
                 elif path.startswith("sourcefiles/"):
                     logger.info(f"Handling as sourcefiles: {path}")
                     return handle_sourcefile(path)