Merge pull request #112 from livMatS/2022-03-01-break-out-of-sandbox

MAINT: Outsourced launch of OS application by URI to utils/subprocess.py

dtool_lookup_gui/utils/subprocess.py

@@ -0,0 +1,54 @@
+import logging
+import os
+import platform
+import subprocess
+
+from dtoolcore.utils import generous_parse_uri
+
+from ..utils.environ import TemporaryOSEnviron
+
+
+from gi.repository import Gio
+
+
+logger = logging.getLogger(__name__)
+
+
+def launch_default_app_for_uri(uri):
+
+    parsed_uri = generous_parse_uri(uri)
+    if parsed_uri.scheme != 'file':
+        logger.warning("Only meant to open local resources. URI scheme '%s' not supported.")
+
+    filepath = parsed_uri.path
+    logger.debug("URI '%s' corresponds to local path '%s'.", uri, filepath)
+
+    # This workaround for launching external system applications from
+    # within a frozen app as suggested on
+    # https://pyinstaller.readthedocs.io/en/stable/runtime-information.html#ld-library-path-libpath-considerations
+    # likely not be necessary here. It may, however, be necessary for
+    # opening arbitrary file types.
+    lp_key = 'LD_LIBRARY_PATH'
+    lp_mod = os.environ.get(lp_key + '_ORIG', None)
+    if lp_mod is not None:
+        logger.debug("Modfify environment with '%s=%s.'", lp_key, lp_mod)
+    else:
+        lp_mod = os.environ.get(lp_key, "")
+    with TemporaryOSEnviron(env={lp_key: lp_mod}):
+        logger.debug("Open %s.", uri)
+        if platform.system() == 'Darwin':  # macOS
+            logger.debug("On macOS, launch 'open %s'", filepath)
+            subprocess.call(('open', filepath))
+        elif platform.system() == 'Windows':
+            if filepath[0] == '/':
+                # remove leading slash from path such as /C:/Users/admin/...
+                filepath = filepath[:1]
+            # convert / to \
+            filepath = os.abspath(filepath)
+            logger.debug("On Windows, launch 'start %s'", filepath)
+            subprocess.call(('start', filepath))
+        else:  # linux variants
+            logger.debug("On Linux, launch with Gio.AppInfo.launch_default_for_uri_async('%s')", uri)
+            # On Linux, use the Gio.AppInfo mechanism instead of direct xdg-open
+            Gio.AppInfo.launch_default_for_uri_async(uri)
+            # subprocess.call(('xdg-open', filepath))

dtool_lookup_gui/views/main_window.py

@@ -49,9 +49,9 @@
 from ..utils.copy_manager import CopyManager
 from ..utils.date import date_to_string
 from ..utils.dependency_graph import DependencyGraph
-from ..utils.environ import TemporaryOSEnviron
 from ..utils.logging import FormattedSingleMessageGtkInfoBarHandler, DefaultFilter, _log_nested
 from ..utils.query import (is_valid_query, dump_single_line_query_text)
+from ..utils.subprocess import launch_default_app_for_uri
 from ..widgets.base_uri_list_box import LOOKUP_BASE_URI
 from ..widgets.base_uri_row import DtoolBaseURIRow
 from ..widgets.search_popover import DtoolSearchPopover
@@ -646,21 +646,8 @@ def on_refresh_clicked(self, widget):
 
     @Gtk.Template.Callback()
     def on_show_clicked(self, widget):
-        # This workaround for launching external system applications from
-        # within a frozen app as suggested on
-        # https://pyinstaller.readthedocs.io/en/stable/runtime-information.html#ld-library-path-libpath-considerations
-        # likely not be necessary here. It may, however, be necessary for
-        # opening arbitrary file types.
-        lp_key = 'LD_LIBRARY_PATH'
-        lp_mod = os.environ.get(lp_key + '_ORIG', None)
-        if lp_mod is not None:
-            _logger.debug("Modfify environment with '%s=%s.'", lp_key, lp_mod)
-        else:
-            lp_mod = os.environ.get(lp_key, "")
-        with TemporaryOSEnviron(env={lp_key: lp_mod}):
-            uri = str(self.dataset_list_box.get_selected_row().dataset)
-            _logger.debug("Open %s.", uri)
-            Gio.AppInfo.launch_default_for_uri_async(uri)
+        uri = str(self.dataset_list_box.get_selected_row().dataset)
+        launch_default_app_for_uri(uri)
 
     @Gtk.Template.Callback()
     def on_add_items_clicked(self, widget):