Coal26 megabranch

.github/workflows/build_docs.yml

@@ -0,0 +1,21 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches: [ main ]
+
+
+jobs:
+  read-commit:
+    runs-on: [self-hosted]
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+        submodules: true
+
+      - name: Build Documentation
+        run: doxygen Doxyfile
+
+      - name: Deploy class documentation
+        run: cd docs-build/html && sudo /home/deploy/deploy.bash . docs/editor-class-doc

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+docs-build/
 build/
 develop-eggs/
 dist/

Project-Editor.spec

@@ -3,9 +3,11 @@
 added_files = [
          ( 'src/resources/' , 'resources'),
          ( 'src/resources/autotrack_models', 'resources/autotrack_models' ),
+         ( 'src/resources/3dmodels', 'resources/3dmodels' ),
          ( 'src/resources/data', 'resources/data' ),
          ( 'src/resources/fonts', 'resources/fonts' ),
          ( 'src/resources/icons', 'resources/icons' ),
+         ( 'src/resources/chaser_layer_help', 'resources/chaser_layer_help' ),
          ( 'src/configs','configs')
          ]
 

pyproject.toml

@@ -6,6 +6,8 @@ authors = [
     { name = "CorsCodini", email = "cors.codini@web.de" },
     { name = "Niklas Naumann", email = "niklas.naumann@student.uni-luebeck.de" },
     { name = "Doralitze", email = "doralitze@chaotikum.org" },
+    { name = "Ludwig Rahlff"},
+    { name = "Joell Keanu"},
 ]
 
 requires-python = "==3.13.*"
@@ -18,7 +20,7 @@ dependencies = [
     "xmlschema>=3.4.5",
     "requests>=2.32.3",
     "numpy>=2.2.4",
-    "ruamel-yaml>=0.18.10",
+    "ruamel-yaml>=0.18.14",
     "html2text>=2024.2.26",
     "markdown>=3.7",
     "typing-extensions>=4.13.1",
@@ -31,10 +33,12 @@ dependencies = [
     "pyjoystick>=1.2.4",
     "pyopengl>=3.1.9",
     "onnxruntime-openvino>=1.21.0",
+    "PySDL2>=0.9.17",
     "pydantic>=2.11.7",
     "defusedxml>=0.7.1",
     "tzlocal>=5.3.1",
     "jinja2>=3.1.6",
+    "pyelk>=0.3",
 ]
 
 [dependency-groups]

src/controller/cli/cli_context.py

@@ -12,6 +12,7 @@
 from controller.cli.bankset_command import BankSetCommand
 from controller.cli.connect_command import ConnectCommand
 from controller.cli.event_command import EventCommand
+from controller.cli.extract_command import ExtractCommand
 from controller.cli.fish_con_command import FishConnCommand
 from controller.cli.help_command import HelpCommand
 from controller.cli.list_command import ListCommand
@@ -106,6 +107,7 @@ def __init__(self, show: BoardConfiguration, network_manager: NetworkManager, ex
             ConnectCommand(self),
             FishConnCommand(self),
             UIPageCommand(self),
+            ExtractCommand(self),
         ]
         self._selected_bank: BankSet | None = None
         self._selected_scene: Scene | None = None

src/controller/cli/connect_command.py

@@ -29,6 +29,9 @@ def _mul(value: str, arg: str) -> str:
 def _div(value: str, arg: str) -> str:
     return str(int(int(value) / int(arg)))
 
+def _mod(value: str, arg: str) -> str:
+    return str(int(int(value) % int(arg)))
+
 class ConnectCommand(Command):
     """Command to connect filters."""
 
@@ -41,6 +44,7 @@ def __init__(self, context: CLIContext) -> None:
         self._jinja_env.filters["sub"] = _sub
         self._jinja_env.filters["mul"] = _mul
         self._jinja_env.filters["div"] = _div
+        self._jinja_env.filters["mod"] = _mod
 
     @override
     def configure_parser(self, parser: ArgumentParser) -> None:

src/controller/cli/extract_command.py

@@ -0,0 +1,67 @@
+"""Contains extract command."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, override
+
+from controller.cli.command import Command
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
+
+    from controller.cli.cli_context import CLIContext
+
+
+class ExtractCommand(Command):
+    """Command to extract element from list."""
+
+    def __init__(self, context: CLIContext) -> None:
+        """Initialize the command."""
+        super().__init__(context, "extract")
+        self._help_text = "Extract element from list"
+
+    @override
+    def configure_parser(self, parser: ArgumentParser) -> None:
+        parser.add_argument("destination", type=str, help="Destination variable.")
+        parser.add_argument("element", type=int, help="Index of element to extract.")
+        subparsers = parser.add_subparsers(dest="target", help="Extraction target.")
+        for target in ["filter-param", "filter-config"]:
+            filter_param_parser = subparsers.add_parser(
+                target,
+                help=f"Extract {target} from filter.",
+                exit_on_error=False
+            )
+            filter_param_parser.add_argument("--scene", type=int, default=-1,
+                                             help="Scene of the filter. Default: Current selected scene.")
+            filter_param_parser.add_argument("fid", type=str, help="Filter ID.")
+            filter_param_parser.add_argument("parameter", type=str, help="The parameter to extract.")
+            filter_param_parser.add_argument("delimiter", type=str, help="The delimiter to use.")
+
+    @override
+    def execute(self, args: Namespace) -> bool:
+        match args.target:
+            case "filter-param" | "filter-config":
+                scene = args.scene
+                if scene == -1:
+                    scene = self.context.selected_scene
+                if scene is None:
+                    self.context.print("Error: No scene specified.")
+                    return False
+                if isinstance(scene, int):
+                    scene = self.context.show.get_scene_by_id(scene)
+                if scene is None:
+                    self.context.print("Error: No scene with specified ID exists.")
+                    return False
+                filter_inst = scene.get_filter_by_id(args.fid)
+                if filter_inst is None:
+                    self.context.print(f"Error: No filter with ID '{args.fid}' not found.")
+                    return False
+                selected_dict = filter_inst.initial_parameters if args.target == "filter-param"\
+                    else filter_inst.filter_configurations
+                splitted_param = selected_dict.get(args.parameter, "").split(args.delimiter)
+                element = splitted_param[args.element] if abs(args.element) < len(splitted_param) else ""
+                if len(args.destination) < 0:
+                    self.context.print("Error: Invalid destination variable.")
+                    return False
+                self.context.update_variables({args.destination: element})
+                return True

src/controller/cli/help_command.py

@@ -32,6 +32,13 @@ def execute(self, args: Namespace) -> bool:
                 self.context.print("\tscene -- Select the scene to perform actions on")
                 self.context.print("\tcolumn -- Select the control desk column to perform actions on")
                 self.context.print("\tbank_set -- Select the control desk bank set to perform actions on")
+            case "extract":
+                self.context.print("Use this command to extract data from concatenated lists and store it in the "
+                                   "specified destination variable.")
+                self.context.print("Usage: extract <destination> <element> <target> <...>")
+                self.context.print("The following targets exist:")
+                self.context.print("\tfilter-param [--scene <scene>] <filter-id> <parameter> <delimiter>")
+                self.context.print("\tfilter-config [--scene <scene>] <filter-id> <parameter> <delimiter>")
             case "list":
                 self.context.print("This command displays the content of system collections.")
                 self.context.print("The following containers can be queried:")
@@ -99,6 +106,6 @@ def execute(self, args: Namespace) -> bool:
                 self.context.print(f"ERROR: The requested help topic '{args.topic}' is unknown.")
                 self.context.print("The following topics are known:")
                 self.context.print("\tevent\tselect\tlist\tpatch\tbank_set\tshowctl\tdelay\tmacro")
-                self.context.print("\tprint\tasset\tset\tif\tconnect\tfish\tuipage")
+                self.context.print("\tprint\tasset\tset\tif\tconnect\tfish\tuipage\textract")
                 return False
         return True

src/controller/cli/remote_control_port.py

@@ -146,7 +146,7 @@
         except OSError:
             pass
         except UnicodeDecodeError as e:
-            self._client.send("Unable to decode command. Exiting.")
+            self._client.send("Unable to decode command. Exiting.".encode())
             self._client.close()
             logger.exception("Failed to decode CLI command. %s", e)
         finally:

src/controller/file/read.py

@@ -6,11 +6,13 @@
 
 import xmlschema
 from defusedxml.ElementTree import parse
+from PySide6.QtWidgets import QMessageBox
 
 import proto.Console_pb2
 import proto.UniverseControl_pb2
 from controller.file.deserialization.migrations import replace_old_filter_configurations
 from controller.file.deserialization.post_load_operations import link_patched_fixtures
+from controller.file.recently_used import register_opened_file
 from controller.utils.process_notifications import get_process_notifier
 from model import BoardConfiguration, Filter, Scene, UIPage, Universe
 from model.color_hsi import ColorHSI
@@ -21,7 +23,7 @@
 from model.media_assets.asset_loading_factory import load_asset
 from model.media_assets.factory_hint import AssetFactoryObjectHint
 from model.media_assets.registry import clear as clear_media_registry
-from model.ofl.fixture import load_fixture, make_used_fixture
+from model.ofl.fixture import FixtureDefNotFoundError, load_fixture, make_used_fixture
 from model.scene import FilterPage
 from model.virtual_filters.vfilter_factory import construct_virtual_filter_instance
 from utility import resource_path
@@ -175,6 +177,7 @@ def read_document(file_name: str, board_configuration: BoardConfiguration) -> bo
         logger.exception("Unable to update show UI window count: %s", e)
         update_window_count(0, board_configuration)
     board_configuration.broadcaster.show_file_loaded.emit()
+    register_opened_file(file_name)
     pn.close()
     return True
 
@@ -265,6 +268,14 @@ def _parse_filter_page(element: ET.Element, parent_scene: Scene, instantiated_pa
     return True
 
 
+def _parse_dmx_default_value(scene: Scene, child: ET.Element) -> None:
+    scene.insert_dmx_default_value(
+        int(child.attrib["universe"]),
+        int(child.attrib["channel"]),
+        int(child.attrib["value"])
+    )
+
+
 def _parse_scene(
     scene_element: ET.Element, board_configuration: BoardConfiguration, loaded_banksets: dict[str, BankSet]
 ) -> None:
@@ -301,6 +312,8 @@ def _parse_scene(
                 filter_pages.append(child)
             case "uipage":
                 ui_page_elements.append(child)
+            case "dmxdefaultvalue":
+                _parse_dmx_default_value(scene, child)
             case _:
                 logger.warning("Scene %s contains unknown element: %s", human_readable_name, child.tag)
 
@@ -652,13 +665,21 @@ def _parse_patching(board_configuration: BoardConfiguration, location_element: E
     fixtures_path = "/var/cache/missionDMX/fixtures"  # TODO config file
 
     for child in location_element:
-        make_used_fixture(
-            board_configuration,
-            load_fixture(os.path.join(fixtures_path, child.attrib["fixture_file"])),
-            int(child.attrib["mode"]),
-            universe_id,
-            int(child.attrib["start"]),
-        )
+        try:
+            make_used_fixture(
+                board_configuration,
+                load_fixture(os.path.join(fixtures_path, child.attrib["fixture_file"])),
+                int(child.attrib["mode"]),
+                universe_id,
+                int(child.attrib["start"]),
+            )
+        except FixtureDefNotFoundError as e:
+            # Calling Dialog exec is not an issue here as we're in the process of loading the show file anyway
+            mb = QMessageBox(QMessageBox.Icon.Critical, "Failed to load fixture", str(e) +
+                             "\n\nDo not continue until this error is fixed as the show is now corrupted.\nMaybe try "
+                             "updating the fixture database.")
+            mb.exec_()
+            continue
 
     # TODO load fixture name from file
 

src/controller/file/recently_used.py

@@ -0,0 +1,47 @@
+"""Provides functions to query and update recently used files."""
+
+from __future__ import annotations
+
+import os
+
+_STORAGE_PATH = os.path.join(os.path.expanduser("~"), ".local", "share", "missionDMX")
+_STORAGE_FILE = os.path.join(_STORAGE_PATH, "recently_used.list")
+
+if not os.path.exists(_STORAGE_PATH):
+    os.makedirs(_STORAGE_PATH, mode=0o770, exist_ok=True)
+
+if not os.path.exists(_STORAGE_FILE):
+    with open(_STORAGE_FILE, "w") as f:
+        f.write("")
+    del f
+
+def get_recently_used_files() -> list[str]:
+    """Method returns the list of recently used files.
+
+    Returns:
+        A list of the recently used files in descending order.
+
+    """
+    real_entries = []
+    with open(_STORAGE_FILE, "r") as f:
+        entries = f.readlines()
+        for entry in entries:
+            if entry.strip() == "":
+                continue
+            real_entries.append(entry.replace("\n", ""))
+    return real_entries
+
+def register_opened_file(path: str) -> None:
+    """Registers a file as being opened.
+
+    Args:
+        path: The path to the file which was opened.
+
+    """
+    path = os.path.expanduser(path.strip())
+    existing_entries = get_recently_used_files()
+    new_entries = [path]
+    new_entries.extend(f"\n{entry}" for i, entry in enumerate(existing_entries) if
+                       entry.strip() != "" and entry != path and i < 10)
+    with open(_STORAGE_FILE, "w") as output_file:
+        output_file.writelines(new_entries)

src/controller/file/serializing/scene_serialization.py

@@ -107,6 +107,13 @@ def generate_scene_xml_description(
 
         for ui_page in scene.ui_pages:
             _add_ui_page_to_element(scene_element, ui_page)
+    scene.sort_dmx_default_values()
+    for default_value in scene.dmx_default_values:
+        ET.SubElement(scene_element, "dmxdefaultvalue", attrib={
+            "universe": str(default_value.universe_id),
+            "channel": str(default_value.channel),
+            "value": str(default_value.value),
+        })
 
 
 def _create_scene_element(scene: Scene, parent: ET.Element) -> ET.Element:

src/controller/file/showfile_dialogs.py

@@ -6,7 +6,7 @@
 from PySide6.QtWidgets import QFileDialog, QWidget
 
 from controller.file.read import read_document
-from controller.file.write import write_document
+from controller.file.write import export_document, write_document
 from model import BoardConfiguration
 
 
@@ -78,3 +78,13 @@ def show_load_showfile_dialog(parent: QWidget, show_data: BoardConfiguration) ->
 
     """
     _select_file(parent, _load_show_file, False, show_data)
+
+def open_show_export_dialog(parent: QWidget, show_data: BoardConfiguration) -> None:
+    """Opens a dialog to export the provided show by fish in standalone mode."""
+    file_dialog = QFileDialog(parent, "Export Show")
+    file_dialog.setNameFilter("Fish Standalone Show (*.fs)")
+    file_dialog.setAcceptMode(QFileDialog.AcceptMode.AcceptSave)
+    file_dialog.setDefaultSuffix(".fs")
+    file_dialog.setDirectory(os.path.expanduser("~"))
+    file_dialog.fileSelected.connect(lambda file_name: export_document(file_name, show_data))
+    file_dialog.show()