qcanvas 1.2.0a1__py3-none-any.whl → 1.2.1__py3-none-any.whl

qcanvas/ui/course_viewer/tabs/page_tab/page_tree.py

@@ -5,7 +5,9 @@ import qcanvas_backend.database.types as db
 from qcanvas_backend.net.sync.sync_receipt import SyncReceipt
 from qtpy.QtCore import Qt
 
+from qcanvas import icons
 from qcanvas.ui.course_viewer.content_tree import ContentTree
+from qcanvas.ui.course_viewer.tree_widget_data_item import TreeWidgetDataItem
 from qcanvas.ui.memory_tree import MemoryTreeWidgetItem
 
 _logger = logging.getLogger(__name__)
@@ -45,14 +47,16 @@ class PageTree(ContentTree[db.Course]):
             id=module.id, data=module, strings=[module.name]
         )
         module_widget.setFlags(Qt.ItemFlag.ItemIsEnabled)
+        module_widget.setIcon(0, icons.tree_items.module)
 
         return module_widget
 
     def _create_page_widget(
         self, page: db.ModulePage, sync_receipt: SyncReceipt
-    ) -> MemoryTreeWidgetItem:
-        page_widget = MemoryTreeWidgetItem(id=page.id, data=page, strings=[page.name])
+    ) -> TreeWidgetDataItem:
+        page_widget = TreeWidgetDataItem(id=page.id, data=page, strings=[page.name])
         page_widget.setFlags(Qt.ItemFlag.ItemIsEnabled | Qt.ItemFlag.ItemIsSelectable)
+        page_widget.setIcon(0, icons.tree_items.page)
 
         if sync_receipt.was_updated(page):
             self.mark_as_unseen(page_widget)

qcanvas/ui/course_viewer/tabs/resource_rich_browser.py

@@ -1,3 +1,4 @@
+import html
 import logging
 from typing import Optional
 
@@ -6,12 +7,11 @@ from bs4 import BeautifulSoup, Tag
 from qasync import asyncSlot
 from qcanvas_backend.net.resources.download.resource_manager import ResourceManager
 from qcanvas_backend.net.resources.extracting.no_extractor_error import NoExtractorError
-from qcanvas_backend.net.resources.scanning.resource_scanner import ResourceScanner
+from qcanvas_backend.util import is_link_invisible
 from qtpy.QtCore import QUrl, Slot
 from qtpy.QtGui import QDesktopServices
 from qtpy.QtWidgets import QTextBrowser
 
-from qcanvas import icons
 from qcanvas.backend_connectors import FrontendResourceManager
 from qcanvas.util.html_cleaner import clean_up_html
 from qcanvas.util.qurl_util import file_url
@@ -19,22 +19,6 @@ from qcanvas.util.qurl_util import file_url
 _logger = logging.getLogger(__name__)
 
 
-# class _DarkListener(QObject):
-#     theme_changed = Signal(str)
-#
-#     def __init__(self):
-#         super().__init__()
-#
-#         self._thread = threading.Thread(target=darkdetect.listener, args=(self._emit,))
-#         self._thread.daemon = True
-#         self._thread.start()
-#
-#     def _emit(self, theme: str) -> None:
-#         self.theme_changed.emit(theme)
-#
-# _dark_listener = _DarkListener()
-
-
 class ResourceRichBrowser(QTextBrowser):
     def __init__(self, downloader: ResourceManager):
         super().__init__()
@@ -85,8 +69,7 @@ class ResourceRichBrowser(QTextBrowser):
                 extractor = self._extractors.extractor_for_tag(resource_link)
                 resource_id = extractor.resource_id_from_tag(resource_link)
 
-                # FIXME private method
-                if ResourceScanner._is_link_invisible(resource_link):
+                if is_link_invisible(resource_link):
                     _logger.debug("Found dead link for %s, removing", resource_id)
                     resource_link.decompose()
                     continue
@@ -97,7 +80,7 @@ class ResourceRichBrowser(QTextBrowser):
                     continue
 
                 file_link_tag = self._create_resource_link_tag(
-                    doc, resource_id, resource_link.name == "img"
+                    resource_id, resource_link.name == "img"
                 )
                 resource_link.replace_with(file_link_tag)
             except NoExtractorError:
@@ -105,9 +88,7 @@ class ResourceRichBrowser(QTextBrowser):
 
         return str(doc)
 
-    def _create_resource_link_tag(
-        self, doc: BeautifulSoup, resource_id: str, is_image: bool
-    ) -> Tag:
+    def _create_resource_link_tag(self, resource_id: str, is_image: bool) -> Tag:
         resource = self._current_content_resources[resource_id]
 
         # todo not sure if this is a good idea or not
@@ -121,40 +102,26 @@ class ResourceRichBrowser(QTextBrowser):
         #         },
         #     )
         # else:
-        file_link_tag = doc.new_tag(
-            "a",
-            attrs={
-                "href": f"data:{resource_id}",
-            },
-        )
-
-        file_link_tag.append(self._file_icon_tag(doc, resource.download_state))
-        file_link_tag.append("\N{NO-BREAK SPACE}" + resource.file_name)
-
-        _logger.debug(str(file_link_tag))
-
-        return file_link_tag
-
-    def _file_icon_tag(
-        self, document: BeautifulSoup, download_state: db.ResourceDownloadState
-    ) -> Tag:
-        return document.new_tag(
-            "img",
-            attrs={
-                "src": self._download_state_icon(download_state),
-                "style": "vertical-align:middle",
-                "width": 18,
-            },
-        )
+
+        return BeautifulSoup(
+            markup=f"""
+            <a href="data:{html.escape(resource_id)}" style="font-weight: normal;">
+                <img height="18" src="{html.escape(self._download_state_icon(resource.download_state))}"/>
+                {html.escape(resource.file_name)}
+            </a>
+            """,
+            features="html.parser",
+        ).a
 
     def _download_state_icon(self, download_state: db.ResourceDownloadState) -> str:
+        icon_path = ":icons/universal/downloads"
         match download_state:
             case db.ResourceDownloadState.DOWNLOADED:
-                return icons.file_downloaded
+                return f"{icon_path}/downloaded.svg"
             case db.ResourceDownloadState.NOT_DOWNLOADED:
-                return icons.file_not_downloaded
+                return f"{icon_path}/not_downloaded.svg"
             case db.ResourceDownloadState.FAILED:
-                return icons.file_download_failed
+                return f"{icon_path}/download_failed.svg"
             case _:
                 raise ValueError()
 
@@ -183,4 +150,21 @@ class ResourceRichBrowser(QTextBrowser):
     @Slot(db.Resource)
     def _download_updated(self, resource: db.Resource) -> None:
         if self._content is not None and resource.id in self._current_content_resources:
+            # BANDAID FIX: In the following situation:
+            # - Download is started
+            # - Synchronisation is started
+            # - Download finishes AFTER the sync
+            # --> `resource` is NOT `self._current_content_resources[resource.id]`, because the sync will reload the
+            # resource from the DB, but the downloader will still only know about the old resource object.
+            # This causes resources not update their download state in the viewer. This line "fixes" that, but does NOT
+            # address the root cause. I think reloading the resource from the DB somewhere is the only true fix for this
+
+            if self._current_content_resources[resource.id] is not resource:
+                _logger.warning(
+                    "Resource has diverged from current loaded data, applying bandaid fix"
+                )
+                self._current_content_resources[resource.id].download_state = (
+                    resource.download_state
+                )
+
             self._show_page_content(self._content)

qcanvas/ui/course_viewer/tree_widget_data_item.py

@@ -0,0 +1,22 @@
+from typing import List, Optional
+
+from qtpy.QtWidgets import QTreeWidgetItem
+
+from qcanvas.ui.memory_tree import MemoryTreeWidgetItem
+
+
+class TreeWidgetDataItem(QTreeWidgetItem):
+    def __init__(
+        self, id: str, data: Optional[object], strings: Optional[List[str]] = None
+    ):
+        super().__init__(strings)
+        # Still needs ID because it is used to reselect the item
+        self._id = id
+        self.extra_data = data
+
+    @property
+    def id(self) -> str:
+        return self._id
+
+
+AnyTreeDataItem = TreeWidgetDataItem | MemoryTreeWidgetItem

qcanvas/ui/main_ui/course_viewer_container.py

@@ -6,7 +6,6 @@ import qcanvas_backend.database.types as db
 from qcanvas_backend.net.resources.download.resource_manager import ResourceManager
 from qcanvas_backend.net.sync.sync_receipt import SyncReceipt, empty_receipt
 from qtpy.QtCore import Qt, Slot
-from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import *
 
 from qcanvas import icons
@@ -16,7 +15,6 @@ from qcanvas.util import themes
 _logger = logging.getLogger(__name__)
 
 
-# todo needs to handle dark mode
 class _PlaceholderLogo(QLabel):
     """
     Automatically resizing logo icon for when no course is selected
@@ -24,12 +22,13 @@ class _PlaceholderLogo(QLabel):
 
     def __init__(self):
         super().__init__()
-        self._light_icon = QIcon(icons.logo_transparent_light)
-        self._dark_icon = QIcon(icons.logo_transparent_dark)
+        self._icon = icons.branding.logo_transparent
         self._old_width = -1
         self._old_height = -1
         self.setAlignment(Qt.AlignmentFlag.AlignCenter)
         self.setSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Ignored)
+        # Because we are using a pixmap for the icon, it will not get updated like a normal QIcon when the theme changes,
+        # So we need to update it ourselves
         themes.theme_changed().connect(self._theme_changed)
 
     def resizeEvent(self, event) -> None:
@@ -47,12 +46,7 @@ class _PlaceholderLogo(QLabel):
         if force or (width != self._old_width and height != self._old_height):
             self._old_width = width
             self._old_height = height
-        else:
-            return
-
-        icon = self._dark_icon if themes.is_dark_mode() else self._light_icon
-
-        self.setPixmap(icon.pixmap(width, height))
+            self.setPixmap(self._icon.pixmap(width, height))
 
 
 class CourseViewerContainer(QStackedWidget):
@@ -61,12 +55,14 @@ class CourseViewerContainer(QStackedWidget):
         self._course_viewers: dict[str, CourseViewer] = {}
         self._downloader = downloader
         self._last_course_id: Optional[str] = None
+        self._selected_course: Optional[db.Course] = None
         self._last_sync_receipt: SyncReceipt = empty_receipt()
         self._placeholder = _PlaceholderLogo()
         self.addWidget(self._placeholder)
 
     def show_blank(self) -> None:
         self._last_course_id = None
+        self._selected_course = None
         self.setCurrentWidget(self._placeholder)
 
     def load_course(self, course: db.Course) -> None:
@@ -82,6 +78,7 @@ class CourseViewerContainer(QStackedWidget):
             viewer = self._course_viewers[course.id]
 
         self.setCurrentWidget(viewer)
+        self._selected_course = course
         self._last_course_id = course.id
 
     async def reload_all(
@@ -92,3 +89,7 @@ class CourseViewerContainer(QStackedWidget):
             if course.id in self._course_viewers:
                 viewer = self._course_viewers[course.id]
                 viewer.reload(course, sync_receipt=sync_receipt)
+
+    @property
+    def selected_course(self) -> Optional[db.Course]:
+        return self._selected_course

qcanvas/ui/main_ui/options/auto_download_resources_option.py

@@ -5,6 +5,7 @@ from qtpy.QtCore import Slot
 from qtpy.QtGui import QAction
 from qtpy.QtWidgets import QMenu
 
+from qcanvas import icons
 from qcanvas.util import settings
 
 _logger = logging.getLogger(__name__)
@@ -36,6 +37,7 @@ class _EnableVideoDownloadOption(QAction):
 
 class AutoDownloadResourcesMenu(QMenu):
     def __init__(self, parent: Optional[QMenu] = None):
-        super().__init__("Download new resources", parent)
+        super().__init__("Auto download resources", parent)
         self.addAction(_EnableAutoDownloadOption(self))
         self.addAction(_EnableVideoDownloadOption(self))
+        self.setIcon(icons.options.auto_download)

qcanvas/ui/main_ui/options/theme_selection_menu.py

@@ -4,6 +4,7 @@ from qtpy.QtCore import Slot
 from qtpy.QtGui import QAction, QActionGroup
 from qtpy.QtWidgets import QMenu
 
+from qcanvas import icons
 from qcanvas.util import settings, themes
 
 _logger = logging.getLogger(__name__)
@@ -38,6 +39,7 @@ class ThemeSelectionMenu(QMenu):
         actions = [auto_theme, light_theme, dark_theme, native_theme]
 
         self.addActions(actions)
+        self.setIcon(icons.options.theme)
 
         for theme in actions:
             action_group.addAction(theme)

qcanvas/ui/main_ui/qcanvas_window.py

@@ -9,7 +9,7 @@ from qcanvas_backend.database.data_monolith import DataMonolith
 from qcanvas_backend.net.sync.sync_receipt import SyncReceipt, empty_receipt
 from qcanvas_backend.qcanvas import QCanvas
 from qtpy.QtCore import QUrl, Signal, Slot
-from qtpy.QtGui import QDesktopServices, QIcon, QKeySequence
+from qtpy.QtGui import QDesktopServices, QKeySequence
 from qtpy.QtWidgets import *
 
 from qcanvas import icons
@@ -37,7 +37,7 @@ class QCanvasWindow(QMainWindow):
         super().__init__()
 
         self.setWindowTitle("QCanvas")
-        self.setWindowIcon(QIcon(icons.main_icon))
+        self.setWindowIcon(icons.branding.main_icon)
 
         self._operation_semaphore = BoundedSemaphore()
         self._data: Optional[DataMonolith] = None
@@ -74,6 +74,7 @@ class QCanvasWindow(QMainWindow):
             shortcut=QKeySequence("Ctrl+S"),
             triggered=self._synchronise_requested,
             parent=app_menu,
+            icon=icons.actions.sync,
         )
 
         create_qaction(
@@ -81,17 +82,22 @@ class QCanvasWindow(QMainWindow):
             shortcut=QKeySequence("Ctrl+D"),
             triggered=self._open_downloads_folder,
             parent=app_menu,
+            icon=icons.actions.open_downloads,
         )
 
         create_qaction(
-            name="Quick canvas login",
+            name="Open Canvas in browser",
             shortcut=QKeySequence("Ctrl+O"),
             triggered=self._open_quick_auth_in_browser,
             parent=app_menu,
+            icon=icons.actions.quick_login,
         )
 
         create_qaction(
-            name="Mark all as seen", triggered=self._clear_new_items, parent=app_menu
+            name="Mark all as seen",
+            triggered=self._clear_new_items,
+            parent=app_menu,
+            icon=icons.actions.mark_all_read,
         )
 
         create_qaction(
@@ -99,6 +105,7 @@ class QCanvasWindow(QMainWindow):
             shortcut=QKeySequence("Ctrl+Q"),
             triggered=lambda: self.close(),
             parent=app_menu,
+            icon=icons.actions.exit,
         )
 
         options_menu = menu_bar.addMenu("Options")
@@ -229,6 +236,12 @@ class QCanvasWindow(QMainWindow):
     @Slot()
     def _open_downloads_folder(self) -> None:
         directory = self._qcanvas.resource_manager.downloads_folder
+
+        if self._course_viewer_container.selected_course is not None:
+            directory /= self._qcanvas.resource_manager.course_folder_name(
+                self._course_viewer_container.selected_course
+            )
+
         directory.mkdir(parents=True, exist_ok=True)
 
         QDesktopServices.openUrl(file_url(directory))

qcanvas/ui/memory_tree/_tree_memory.py

@@ -54,6 +54,7 @@ class TreeMemory:
     def set_expanded(self, node_id: str, expanded: bool) -> None:
         contains = node_id in self._state.collapsed_items
 
+        # fixme when using a slow usb stick, this can momentarily block the event loop.
         if expanded and contains:
             self._state.collapsed_items.remove(node_id)
             self._state.save()

qcanvas/ui/memory_tree/memory_tree_widget.py

@@ -17,7 +17,7 @@ class MemoryTreeWidget(QTreeWidget):
         parent: Optional[QWidget] = None,
     ):
         super().__init__(parent)
-        self._id_map: dict[str, MemoryTreeWidgetItem] = {}
+        self._id_map: dict[str, QTreeWidgetItem] = {}
         self._memory = TreeMemory(tree_name)
         self._suppress_expansion_signals = False
         self._suppress_selection_signal = False
@@ -100,7 +100,7 @@ class MemoryTreeWidget(QTreeWidget):
         while len(widget_stack) > 0:
             item = widget_stack.pop()
 
-            if isinstance(item, MemoryTreeWidgetItem):
+            if hasattr(item, "id"):
                 if item.id in self._id_map or item.id in map_updates:
                     raise ValueError(f"Item with ID {item.id} is already in the tree")
 

qcanvas/ui/setup/setup_dialog.py

@@ -93,7 +93,7 @@ class SetupDialog(QDialog):
         self.setWindowTitle("Configure QCanvas")
         self.setMinimumSize(550, 200)
         self.resize(550, 200)
-        self.setWindowIcon(QIcon(icons.main_icon))
+        self.setWindowIcon(QIcon(icons.branding.main_icon))
 
         self._semaphore = Semaphore()
 

qcanvas/util/file_icons.py

@@ -1,4 +1,5 @@
 import logging
+import os.path
 
 from qtpy.QtCore import QFileInfo, QMimeDatabase
 from qtpy.QtGui import QIcon
@@ -17,20 +18,37 @@ if runtime.is_running_on_windows:
 
 else:
     _mime_database = QMimeDatabase()
-    _default_icon = None
+    # This must be initialised lazily because the QApplication might not be initialised at this time
+    _default_icon: QIcon | None = None
+    _icon_for_suffix: dict[str, QIcon] = {}
 
     def icon_for_filename(file_name: str) -> QIcon:
         global _default_icon
 
+        file_suffix = os.path.splitext(file_name)[1]
+
+        # Check if we already know what icon this file type has
+        if file_suffix in _icon_for_suffix:
+            return _icon_for_suffix[file_suffix]
+
+        # Try to find an icon for this file type
         for mime_type in _mime_database.mimeTypesForFileName(file_name):
             icon = QIcon.fromTheme(mime_type.iconName())
 
             if not icon.isNull():
+                _icon_for_suffix[file_suffix] = icon
                 return icon
 
+        _lazy_init_default_icon()
+
+        # No icon for this type of file was found, return default icon
+        _icon_for_suffix[file_suffix] = _default_icon
+        return _default_icon
+
+    def _lazy_init_default_icon() -> None:
+        global _default_icon
+
         if _default_icon is None:
             _default_icon = QApplication.style().standardIcon(
                 QStyle.StandardPixmap.SP_FileIcon
             )
-
-        return _default_icon

qcanvas/util/html_cleaner.py

@@ -16,6 +16,8 @@ def clean_up_html(html: str) -> str:
     _remove_tags(doc.find_all(["link", "script"]))
     # Remove font awesome icons (which don't load anyway)
     _remove_tags(doc.find_all(["span"], class_=["dp-icon-content"]))
+    # Remove screen reader elements
+    _remove_tags(doc.find_all(class_="screenreader-only"))
 
     return str(doc)
 

qcanvas/util/layouts.py

@@ -22,11 +22,14 @@ def layout_widget(layout_type: Type[T], *items: QWidget, **kwargs) -> QWidget:
     return widget
 
 
-def layout(layout_type: Type[T], *items: QWidget, **kwargs) -> T:
+def layout(layout_type: Type[T], *items: QWidget | QLayout, **kwargs) -> T:
     result_layout: QLayout = layout_type(**kwargs)
 
     for item in items:
-        result_layout.addWidget(item)
+        if isinstance(item, QLayout):
+            result_layout.addItem(item)
+        else:
+            result_layout.addWidget(item)
 
     return result_layout
 

qcanvas/util/settings/_mapped_setting.py

@@ -53,8 +53,13 @@ class BoolSetting(MappedSetting[bool]):
         try:
             # noinspection PyTypeChecker
             value: str = super()._read()
+
+            if isinstance(value, bool):
+                return value
+
             return value.lower() == "true"
-        except:
+        except Exception as e:
+            _logger.error("Could not read setting", exc_info=e)
             return self.default
 
     # @override

qcanvas/util/themes/_theme_changer.py

@@ -2,6 +2,7 @@ import logging
 
 import qdarktheme
 from qtpy.QtCore import Slot
+from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import QApplication, QStyleFactory
 
 from qcanvas.util.themes._colour_scheme_helper import (
@@ -17,6 +18,10 @@ default_theme = "auto"
 _is_dark_mode: bool | None = None
 _selected_theme: SelectedTheme | None = None
 
+_universal_path = ":icons/universal"
+_dark_path = ":icons/dark"
+_light_path = ":icons/light"
+
 
 def apply(theme: str) -> None:
     global _is_dark_mode, _selected_theme
@@ -45,6 +50,7 @@ def apply(theme: str) -> None:
         _selected_theme = SelectedTheme.NATIVE
 
     if was_dark_mode != _is_dark_mode:
+        _set_fallback_paths()
         theme_changed().emit()
 
 
@@ -66,9 +72,15 @@ def _scheme_changed():
     if _selected_theme == SelectedTheme.AUTO:
         apply("auto")
     elif _selected_theme == SelectedTheme.NATIVE:
-        # noinspection PyTestUnpassedFixture
         _is_dark_mode = is_dark_colour_scheme()
+        _set_fallback_paths()
         theme_changed().emit()
 
 
+def _set_fallback_paths():
+    QIcon.setFallbackSearchPaths(
+        [_dark_path if _is_dark_mode else _light_path, _universal_path]
+    )
+
+
 colour_scheme_changed().connect(_scheme_changed)

qcanvas/util/ui_tools.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Any
 
-from qtpy.QtGui import QKeySequence
+from qtpy.QtGui import QIcon, QKeySequence, QPixmap
 from qtpy.QtWidgets import *
 
 _logger = logging.getLogger(__name__)
@@ -19,6 +19,7 @@ def create_qaction(
     triggered: Any = None,
     checkable: bool | None = None,
     checked: bool | None = None,
+    icon: QIcon | QPixmap | None = None
 ) -> QAction:
     action = QAction(name)
 
@@ -38,4 +39,7 @@ def create_qaction(
         if checked is not None:
             action.setChecked(checked)
 
+    if icon is not None:
+        action.setIcon(icon)
+
     return action

{qcanvas-1.2.0a1.dist-info → qcanvas-1.2.1.dist-info}/METADATA

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: qcanvas
-Version: 1.2.0a1
+Version: 1.2.1
 Summary: QCanvas is a desktop client for Canvas LMS.
 Author: QCanvas
 Author-email: QCanvas@noreply.codeberg.org
-Requires-Python: >=3.11,<3.13
+Requires-Python: >3.11.0,<3.13
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: aiosqlite (>=0.20.0,<0.21.0)
 Requires-Dist: asynctaskpool (>=0.2.1,<0.3.0)
@@ -15,7 +14,7 @@ Requires-Dist: platformdirs (>=4.2.2,<5.0.0)
 Requires-Dist: pyqtdarktheme-fork (>=2.3.2,<3.0.0)
 Requires-Dist: qasync (>=0.27.1,<0.28.0)
 Requires-Dist: qcanvas-api-clients (>=0.3.0,<0.4.0)
-Requires-Dist: qcanvas-backend (>=0.2.2,<0.3.0)
+Requires-Dist: qcanvas-backend (>=0.2.7,<0.3.0)
 Requires-Dist: qtpy (>=2.4.1,<3.0.0)
 Requires-Dist: sqlalchemy (>=2.0.31,<3.0.0)
 Requires-Dist: validators (>=0.33.0,<0.34.0)
@@ -31,7 +30,14 @@ https://github.com/QCanvas/QCanvasApp
 
 # Downloads
 
-Download it from [releases](https://github.com/QCanvas/QCanvasApp/releases)
+<a href='https://flathub.org/apps/io.github.qcanvas.QCanvasApp'>
+    <img width='240' alt='Get it on Flathub' src='https://flathub.org/api/badge?svg&locale=en'/>
+</a>
+
+You can download a **windows** version from [releases](https://github.com/QCanvas/QCanvasApp/releases)
+
+The appimage version is *not recommended* as it is not a proper portable appimage. It will only work on debian/ubuntu
+based distros.
 
 # Development/Run from source