add linux xdg-open option

replaced webbrowser.open(uri) with subprocess.run(["xdg-open", uri]) when xdg-open option is enabled

added note to readme and help menu for xdg-open option

moved some defaults from highlight_sender.py to config.py, to avoid a circular import

Author: jm289765

h2o/__init__.py

@@ -3,7 +3,7 @@
 
 from calibre.customize import InterfaceActionBase
 
-_version = (1, 4, 0)
+_version = (1, 4, 1)
 version = ".".join([str(x) for x in _version])
 
 

h2o/button_actions.py

@@ -20,7 +20,9 @@ def help_menu(parent):
            "be sent. If this happens, you can use the \"Resend Previously Sent Highlights\" function.\n\n" + \
            "You can set keyboard shortcuts in calibre's Preferences -> Shortcuts -> H2O.\n\n" + \
            "Due to URI length limits, H2O can only send a few thousand words to a single note at once. Extra text " \
-           "will be sent to different notes with increasing numbers added to the end of the title."
+           "will be sent to different notes with increasing numbers added to the end of the title.\n\n" + \
+           "If you're using Linux and H2O opens your web browser instead of Obsidian, see the xdg-open setting " + \
+           "at the bottom of the config's Other Options."
     info_dialog(parent, title, body, show=True)
 
 

h2o/config.py

@@ -4,9 +4,6 @@
                      QPushButton, QDialog, QDialogButtonBox, QCheckBox)
 from calibre.gui2 import warning_dialog
 from calibre.utils.config import JSONConfig
-from calibre_plugins.highlights_to_obsidian.highlight_sender import (title_default_format, body_default_format,
-                                                                     vault_default_name, no_notes_default_format,
-                                                                     header_default_format, sort_key_default)
 from calibre_plugins.highlights_to_obsidian.__init__ import version
 
 # This is where all preferences for this plugin will be stored
@@ -20,6 +17,17 @@
 # set time to 2 days after unix epoch start. hopefully prevents platform-dependent invalid default
 # last_send_time when using time.mktime()
 
+sort_key_default = "location"
+
+# might be better to move these into resource files
+library_default_name = "Calibre Library"
+vault_default_name = "My Vault"
+title_default_format = "Books/{title} by {authors}"
+body_default_format = "\n[Highlighted]({url}) on {date} at {time} UTC:\n{blockquote}\n\n{notes}\n\n---\n"
+no_notes_default_format = "\n[Highlighted]({url}) on {date} at {time} UTC:\n{blockquote}\n\n---\n"
+header_default_format = "\n{booksent} highlights from \"{title}\" sent on {datenow} at {timenow} UTC.\n\n---\n"
+
+prefs.defaults['library_name'] = library_default_name
 prefs.defaults['vault_name'] = vault_default_name
 prefs.defaults['title_format'] = title_default_format
 prefs.defaults['body_format'] = body_default_format
@@ -36,11 +44,13 @@
 prefs.defaults['max_note_size'] = "20000"
 prefs.defaults['use_max_note_size'] = True  # make max_note_size easy to toggle
 prefs.defaults['copy_header'] = False  # whether to copy header when splitting a too-big note
-prefs.defaults['web_user'] = False  # whether we should send web user or local user's highlights
 prefs.defaults['web_user_name'] = "*"
+prefs.defaults['web_user'] = False  # whether we should send web user or local user's highlights
+prefs.defaults['use_xdg_open'] = False
 prefs.defaults['sleep_secs'] = 0.1
 
 
+
 class ConfigWidget(QWidget):
 
     def __init__(self):
@@ -347,6 +357,11 @@ def __init__(self):
         self.web_user_checkbox.setChecked(prefs['web_user'])
         self.l.addWidget(self.web_user_checkbox)
 
+        # checkbox for linux xdg-open
+        self.linux_xdg_checkbox = QCheckBox("Use Linux xdg-open command instead of Python webbrowser.open()")
+        self.linux_xdg_checkbox.setChecked(prefs['use_xdg_open'])
+        self.l.addWidget(self.linux_xdg_checkbox)
+
         self.l.addSpacing(self.spacing)
 
         # ok and cancel buttons
@@ -369,9 +384,10 @@ def save_settings(self):
         prefs['copy_header'] = self.copy_header_checkbox.isChecked()
         prefs['confirm_send_all'] = self.show_confirmation_checkbox.isChecked()
         prefs['highlights_sent_dialog'] = self.show_count_checkbox.isChecked()
-        prefs['web_user'] = self.web_user_checkbox.isChecked()
         username = self.web_user_name_input.text()
         prefs['web_user_name'] = "*" if username == "" else username
+        prefs['web_user'] = self.web_user_checkbox.isChecked()
+        prefs['use_xdg_open'] = self.linux_xdg_checkbox.isChecked()
 
         sleep_time = self.sleep_time_input.text()
         try:

h2o/highlight_sender.py

@@ -1,21 +1,16 @@
+import os
+import subprocess
 import time
 import webbrowser
 from typing import Dict, List, Callable, Any, Tuple, Iterable, Union
 from urllib.parse import urlencode, quote
 import datetime
+from calibre_plugins.highlights_to_obsidian.config import prefs
 
-# avoid importing anything from calibre or the highlights_to_obsidian plugin here
-
-
-# might be better to move these into resource files
-library_default_name = "Calibre Library"
-vault_default_name = "My Vault"
-title_default_format = "Books/{title} by {authors}"
-body_default_format = "\n[Highlighted]({url}) on {date} at {time} UTC:\n{blockquote}\n\n{notes}\n\n---\n"
-no_notes_default_format = "\n[Highlighted]({url}) on {date} at {time} UTC:\n{blockquote}\n\n---\n"
-header_default_format = "\n{booksent} highlights from \"{title}\" sent on {datenow} at {timenow} UTC.\n\n---\n"
-
-sort_key_default = "location"
+# avoid importing anything else from calibre or the highlights_to_obsidian plugin here.
+# this is to avoid having references to the config or the calibre database scattered
+# throughout HighlightSender. those references are in HighlightSender.__init__() and
+# in make_sender() in button_actions.py.
 
 
 def send_item_to_obsidian(obsidian_data: Dict[str, str]) -> None:
@@ -28,7 +23,18 @@ def send_item_to_obsidian(obsidian_data: Dict[str, str]) -> None:
     encoded_data = urlencode(obsidian_data, quote_via=quote)
     uri = "obsidian://new?" + encoded_data
     try:
-        webbrowser.open(uri)
+        if prefs['use_xdg_open']:
+            # this is to avoid a bug on linux, where the uri is opened in web browser instead of Obsidian
+            # on windows, this only gives a good error message if shell=True. i need to know what it
+            # does on Linux and Mac.
+            subprocess.run(['xdg-open', uri], check=True, shell=True)
+
+            # can't use os.system, since it doesn't give an error message when you try to xdg-open on windows
+            # os.system(f'xdg-open \"{uri}\"')
+        else:
+            # it might actually be better to do away with webbrowser.open() and only use os.system(). that might fix
+            #  the problem of needing to limit the max file size. would need to add support for each operating system.
+            webbrowser.open(uri)
     except ValueError as e:
         raise ValueError(f" send_item_to_obsidian: '{e}' in note '{obsidian_data['file']}'.\n\n"
                          f"If this error says that the filepath is too long, try reducing the max file size in "
@@ -506,17 +512,17 @@ class HighlightSender:
 
     def __init__(self):
         # set defaults
-        self.library_name = library_default_name
-        self.vault_name = vault_default_name
-        self.title_format = title_default_format
-        self.body_format = body_default_format
-        self.no_notes_format = no_notes_default_format
-        self.header_format = header_default_format
+        self.library_name = prefs.defaults['library_name']
+        self.vault_name = prefs.defaults['vault_name']
+        self.title_format = prefs.defaults['title_format']
+        self.body_format = prefs.defaults['body_format']
+        self.no_notes_format = prefs.defaults['no_notes_format']
+        self.header_format = prefs.defaults['header_format']
         self.book_titles_authors = {}
         self.annotations_list = []
         self.max_file_size = -1  # -1 = unlimited
         self.copy_header = False
-        self.sort_key = sort_key_default
+        self.sort_key = prefs.defaults['sort_key']
         self.sleep_time = 0
 
     def set_library(self, library_name: str):