Aliases appear in Entity Tree

Author: davidfstr

src/crystal/browser/__init__.py

@@ -11,7 +11,7 @@
 from crystal.browser.preferences import PreferencesDialog
 from crystal.browser.tasktree import TaskTree, TaskTreeNode
 from crystal.model import (
-    Project, ProjectReadOnlyError, Resource, ResourceGroup, ResourceGroupSource, RootResource,
+    Alias, Project, ProjectReadOnlyError, Resource, ResourceGroup, ResourceGroupSource, RootResource,
 )
 from crystal.progress import (
     CancelLoadUrls, CancelSaveAs, DummyOpenProjectProgressListener,
@@ -815,7 +815,8 @@ def _update_entity_pane_empty_state_visibility(self) -> bool:
         """
         is_project_empty = (
             is_iterable_empty(self.project.root_resources) and
-            is_iterable_empty(self.project.resource_groups)
+            is_iterable_empty(self.project.resource_groups) and
+            is_iterable_empty(self.project.aliases)
         )
 
         sizer_index = self._entity_tree_sizer_index  # cache
@@ -1498,6 +1499,7 @@ def _on_forget_entity(self, event) -> None:
     def _on_download_entity(self, event) -> None:
         selected_entity = self.entity_tree.selected_entity
         assert selected_entity is not None
+        assert not isinstance(selected_entity, Alias)
 
         # Show progress dialog in advance if will need to load all project URLs
         if isinstance(selected_entity, ResourceGroup):
@@ -1612,21 +1614,33 @@ def resource_group_did_instantiate(self, group: ResourceGroup) -> None:
     def resource_group_did_forget(self, group: ResourceGroup) -> None:
         self._update_entity_pane_empty_state_visibility()
 
+    # NOTE: Can't capture to the Entity Tree itself reliably since may not be visible
+    @capture_crashes_to_stderr
+    @cloak
+    def alias_did_instantiate(self, alias: Alias) -> None:
+        self._update_entity_pane_empty_state_visibility()
+    
+    # NOTE: Can't capture to the Entity Tree itself reliably since may not be visible
+    @capture_crashes_to_stderr
+    @cloak
+    def alias_did_forget(self, alias: Alias) -> None:
+        self._update_entity_pane_empty_state_visibility()
+    
     def _on_selected_entity_changed(self, event: wx.TreeEvent | None=None) -> None:
         selected_entity = self.entity_tree.selected_entity  # cache
 
         readonly = self._readonly  # cache
         self._edit_action.enabled = (
-            isinstance(selected_entity, (ResourceGroup, RootResource)))
+            isinstance(selected_entity, (Alias, ResourceGroup, RootResource)))
         self._forget_action.enabled = (
             (not readonly) and
-            isinstance(selected_entity, (ResourceGroup, RootResource)))
+            isinstance(selected_entity, (Alias, ResourceGroup, RootResource)))
         self._update_members_action.enabled = (
             (not readonly) and
             isinstance(selected_entity, ResourceGroup))
         self._download_action.enabled = (
             (not readonly) and
-            selected_entity is not None)
+            isinstance(selected_entity, (Resource, ResourceGroup, RootResource)))
         self._view_action.enabled = (
             isinstance(selected_entity, (Resource, RootResource)))
 

src/crystal/browser/entitytree.py

@@ -7,7 +7,7 @@
 from crystal.doc.generic import Link
 from crystal.doc.html.soup import TEXT_LINK_TYPE_TITLE
 from crystal.model import (
-    Project, ProjectHasTooManyRevisionsError, Resource, ResourceGroup,
+    Alias, Project, ProjectHasTooManyRevisionsError, Resource, ResourceGroup,
     ResourceGroupSource, ResourceRevision, RevisionBodyMissingError,
     RevisionDeletedError, RootResource,
 )
@@ -306,6 +306,39 @@ def resource_group_did_forget(self, group: ResourceGroup) -> None:
         # may need to be updated
         self.root.update_icon_set_of_descendants_in_group(group)
 
+    # === Events: Alias Lifecycle ===
+    
+    @capture_crashes_to_self
+    def alias_did_instantiate(self, alias: Alias) -> None:
+        selection_was_empty = self.view.selected_node in [None, self.view.root]  # capture
+        
+        self.update()
+        
+        if selection_was_empty:
+            # Select the newly-created entity
+            for child in self.root.children:
+                if child.entity == alias:
+                    child.view.peer.SelectItem()
+                    break
+    
+    @capture_crashes_to_self
+    # TODO: Do not recommend asserting that a listener method will be called
+    #       from any particular thread
+    @fg_affinity
+    def alias_did_change(self, alias: Alias) -> None:
+        # Update the title of the AliasNode
+        for child in self.root.children:
+            if isinstance(child, AliasNode) and child.alias == alias:
+                child.view.title = child.calculate_title()
+                break
+    
+    @capture_crashes_to_self
+    # TODO: Do not recommend asserting that a listener method will be called
+    #       from any particular thread
+    @fg_affinity
+    def alias_did_forget(self, alias: Alias) -> None:
+        self.update()
+    
     # === Event: Min Fetch Date Did Change ===
 
     @capture_crashes_to_self
@@ -524,7 +557,7 @@ def _sequence_with_matching_elements_replaced(new_seq, old_seq):
     return [old_seq_selfdict.get(x, x) for x in new_seq]
 
 
-NodeEntity: TypeAlias = Union['RootResource', 'Resource', 'ResourceGroup']
+NodeEntity: TypeAlias = Union['RootResource', 'Resource', 'ResourceGroup', 'Alias']
 
 
 class Node(Bulkhead):
@@ -771,6 +804,9 @@ def update_children(self,
         for (index, rg) in enumerate(self._project.resource_groups):
             children.append(ResourceGroupNode(rg))
 
+        for alias in self._project.aliases:
+            children.append(AliasNode(alias))
+        
         self.set_children(children, progress_listener)
 
 
@@ -1013,7 +1049,7 @@ def update_children(self) -> None:
         if self.resource_links:
             for link in self.resource_links:
                 url = urljoin(self.resource.url, link.relative_url)
-                resource = Resource(self._project, url)
+                resource = Resource(self._project, url, _external_ok=True)
                 resources_2_links[resource].append(link)
 
         linked_root_resources = []
@@ -1556,6 +1592,80 @@ def __hash__(self) -> int:
         return hash(self.resource_group)
 
 
+class AliasNode(Node):
+    """Node representing an Alias in the entity tree."""
+    entity_tooltip = 'alias'
+    
+    ICON = '🔗'
+    ICON_TRUNCATION_FIX = '' 
+    
+    def __init__(self, alias: Alias) -> None:
+        super().__init__(source=None)
+        self.alias = alias
+        
+        self.view = NodeView()
+        # NOTE: Defer expensive calculation until if/when the icon_set is used
+        self.view.icon_set = self.calculate_icon_set
+        self.view.title = self.calculate_title()
+        self.view.expandable = False
+        
+        # Aliases have no children
+        self.children = []
+    
+    # === Properties ===
+    
+    @override
+    def calculate_icon_set(self) -> IconSet | None:
+        return (
+            (wx.TreeItemIcon_Normal, TREE_NODE_ICONS()['entitytree_alias']),
+        )
+    
+    @override
+    @property
+    def icon_tooltip(self) -> str | None:
+        return self.entity_tooltip.capitalize()
+    
+    @override
+    def calculate_title(self) -> str:
+        return self.calculate_title_of(self.alias)
+    
+    @staticmethod
+    def calculate_title_of(alias: Alias) -> str:
+        target_url_prefix = alias.target_url_prefix
+        if alias.target_is_external:
+            target_url_prefix = Alias.format_external_url_for_display(target_url_prefix)
+        assert alias.source_url_prefix.endswith('/')
+        assert target_url_prefix.endswith('/')
+        return f'{alias.source_url_prefix}** → {target_url_prefix}**'
+    
+    @override
+    @property
+    def label_tooltip(self) -> str:
+        tooltip = (
+            f'Source: {self.alias.source_url_prefix}**\n'
+            f'Target: {self.alias.target_url_prefix}**'
+        )
+        if self.alias.target_is_external:
+            tooltip += '\nExternal: Yes (on internet, outside project)'
+        return tooltip
+    
+    @override
+    @property
+    def entity(self) -> Alias:
+        return self.alias
+    
+    # === Comparison ===
+    
+    def __eq__(self, other):
+        return (
+            isinstance(other, AliasNode) and
+            self.alias == other.alias
+        )
+    
+    def __hash__(self):
+        return hash(self.alias)
+
+
 class GroupedLinkedResourcesNode(_GroupedNode):
     entity_tooltip = 'grouped URLs'
 

src/crystal/browser/icons.py

@@ -13,6 +13,7 @@ def TREE_NODE_ICONS() -> dict[str, wx.Bitmap]:
         (icon_name, _load_png_resource(f'treenodeicon_{icon_name}.png'))
         for icon_name in [
             # Entity Tree Icons
+            'entitytree_alias',
             'entitytree_cluster_embedded',
             'entitytree_cluster_offsite',
             'entitytree_loading',

src/crystal/model.py

@@ -1164,8 +1164,17 @@ def _set_entity_title_format(self, value: EntityTitleFormat) -> None:
     def get_display_url(self, url):
         """
         Returns a displayable version of the provided URL.
-        If the URL lies under the configured `default_url_prefix`, that prefix will be stripped.
+        
+        - If the URL is an external URL (pointing to a live resource on the internet),
+          it will be formatted with an icon prefix.
+        - If the URL is not external and lies under the configured `default_url_prefix`, 
+          that prefix will be stripped.
         """
+        # Check if this is an external URL first
+        if (external_url := Alias.parse_external_url(url)) is not None:
+            return Alias.format_external_url_for_display(external_url)
+        
+        # Apply default URL prefix shortening for non-external URLs
         default_url_prefix = self.default_url_prefix
         if default_url_prefix is None:
             return url
@@ -1989,6 +1998,27 @@ def _resource_group_did_forget(self, group: ResourceGroup) -> None:
             if hasattr(lis, 'resource_group_did_forget'):
                 run_bulkhead_call(lis.resource_group_did_forget, group)  # type: ignore[attr-defined]
 
+    # === Events: Alias Lifecycle ===
+    
+    # Called when a new Alias is created after the project has loaded
+    def _alias_did_instantiate(self, alias: Alias) -> None:
+        # Notify normal listeners
+        for lis in self.listeners:
+            if hasattr(lis, 'alias_did_instantiate'):
+                run_bulkhead_call(lis.alias_did_instantiate, alias)  # type: ignore[attr-defined]
+    
+    def _alias_did_change(self, alias: Alias) -> None:
+        # Notify normal listeners
+        for lis in self.listeners:
+            if hasattr(lis, 'alias_did_change'):
+                run_bulkhead_call(lis.alias_did_change, alias)  # type: ignore[attr-defined]
+    
+    def _alias_did_forget(self, alias: Alias) -> None:
+        # Notify normal listeners
+        for lis in self.listeners:
+            if hasattr(lis, 'alias_did_forget'):
+                run_bulkhead_call(lis.alias_did_forget, alias)  # type: ignore[attr-defined]
+    
     # === Events: Root Task Lifecycle ===
 
     def _root_task_did_change(self, old_root_task: 'RootTask', new_root_task: 'RootTask') -> None:
@@ -4806,6 +4836,10 @@ def __init__(self,
                 project._db.commit()
                 self._id = c.lastrowid
         project._aliases.append(self)
+        
+        # Notify listeners if not loading
+        if not project._loading:
+            project._alias_did_instantiate(self)
 
     # === Delete ===
 
@@ -4825,6 +4859,8 @@ def delete(self) -> None:
         self._id = None
 
         self.project._aliases.remove(self)
+        
+        self.project._alias_did_forget(self)
 
     # === Properties ===
 
@@ -4852,6 +4888,8 @@ def _set_target_url_prefix(self, target_url_prefix: str) -> None:
         self.project._db.commit()
 
         self._target_url_prefix = target_url_prefix
+        
+        self.project._alias_did_change(self)
     target_url_prefix = cast(str, property(_get_target_url_prefix, _set_target_url_prefix))
 
     def _get_target_is_external(self) -> bool:
@@ -4873,6 +4911,8 @@ def _set_target_is_external(self, target_is_external: bool) -> None:
         self.project._db.commit()
 
         self._target_is_external = target_is_external
+        
+        self.project._alias_did_change(self)
     target_is_external = cast(bool, property(_get_target_is_external, _set_target_is_external))
 
     # === External URLs ===
@@ -4908,6 +4948,10 @@ def parse_external_url(archive_url: str) -> str | None:
         else:
             return None
 
+    @staticmethod
+    def format_external_url_for_display(external_url: str) -> str:
+        return f'🌐 {external_url}'
+    
     # === Utility ===
 
     def __repr__(self):

src/crystal/resources/treenodeicon_entitytree_alias.png

@@ -8,6 +8,7 @@
     test_do_not_download_groups,
     test_download,
     test_download_body,
+    test_edit_alias,
     test_edit_group,
     test_edit_root_url,
     test_entitytree,
@@ -20,6 +21,7 @@
     test_log_drawer,
     test_main_window,
     test_menus,
+    test_new_alias,
     test_new_group,
     test_new_root_url,
     test_open_project,
@@ -70,6 +72,7 @@ def _test_functions_in_module(mod) -> list[Callable]:
     _test_functions_in_module(test_do_not_download_groups) +
     _test_functions_in_module(test_download) +
     _test_functions_in_module(test_download_body) +
+    _test_functions_in_module(test_edit_alias) +
     _test_functions_in_module(test_edit_group) +
     _test_functions_in_module(test_edit_root_url) +
     _test_functions_in_module(test_entitytree) +
@@ -82,6 +85,7 @@ def _test_functions_in_module(mod) -> list[Callable]:
     _test_functions_in_module(test_log_drawer) +
     _test_functions_in_module(test_main_window) +
     _test_functions_in_module(test_menus) +
+    _test_functions_in_module(test_new_alias) +
     _test_functions_in_module(test_new_group) +
     _test_functions_in_module(test_new_root_url) +
     _test_functions_in_module(test_open_project) +