Fixed #108, added user input sanitization for interruptions

Author: co-stig

res/CHANGELOG.txt

@@ -31,12 +31,12 @@ Technical improvements:
 
 Bug fixes:
 
+- Selecting directory as log file (#108).
 - Window icon on Wayland (#110).
-- Line breaks in work items and backlogs.
+- Line breaks in work items and backlogs (#132).
 
 - TODO: [Bugfix] Application icon in DEB / GNOME (#121)
 - TODO: [Bugfix] Unhandled IndexError - Changing audio devices while Flowkeeper is running (#120)
-- TODO: [Bugfix] Unhandled IsADirectoryError (#108)
 - TODO: [Bugfix] Entry point not found - OpenSSL preinstalled on Windows (#82)
 - TODO: [Technical] Windows binaries are now built using ???, which has better tolerance to Defender (#114)
 - TODO: [Technical] Windows binaries are checked via VirusTotal every night (#109)

src/fk/core/abstract_serializer.py

@@ -24,6 +24,10 @@
 TRoot = TypeVar('TRoot')
 
 
+def sanitize_user_input(s: str) -> str:
+    return s.replace('\n', ' ').replace('\r', '')
+
+
 class AbstractSerializer(ABC, Generic[T, TRoot]):
     _settings: AbstractSettings
     _cryptograph: AbstractCryptograph

src/fk/desktop/application.py

@@ -212,6 +212,10 @@ def _initialize_logger(self):
 
         # 2. Check that the entire logger file path exists
         filename = self._settings.get('Logger.filename')
+        logfile = Path(filename)
+        if logfile.is_dir():    # Fixing #108 - a rare case when the user selects directory as log filename
+            logfile /= 'flowkeeper.log'
+            filename = logfile.absolute()
         prepare_file_for_writing(filename)
 
         # 3. Add FILE handler for whatever the user configured

src/fk/qt/abstract_drop_model.py

@@ -25,16 +25,13 @@
 
 from fk.core.abstract_data_container import AbstractDataContainer
 from fk.core.abstract_data_item import AbstractDataItem
+from fk.core.abstract_serializer import sanitize_user_input
 from fk.core.abstract_strategy import AbstractStrategy
 from fk.core.event_source_holder import EventSourceHolder
 
 logger = logging.getLogger(__name__)
 
 
-def sanitize(s: str) -> str:
-    return s.replace('\n', ' ').replace('\r', '')
-
-
 class DropPlaceholderItem(QStandardItem):
     def __init__(self, height: int):
         super().__init__()
@@ -96,7 +93,7 @@ def handle_rename(self, item: QStandardItem, strategy_class: type[AbstractStrate
         if item.data(501) == 'title':
             entity: AbstractDataContainer = item.data(500)
             old_name = entity.get_name()
-            new_name = sanitize(item.text())
+            new_name = sanitize_user_input(item.text())
             if old_name != new_name:
                 try:
                     self._source_holder.get_source().execute(strategy_class, [entity.get_uid(), new_name])

src/fk/qt/focus_widget.py

@@ -21,6 +21,7 @@
     QSpacerItem, QInputDialog, QLineEdit
 
 from fk.core.abstract_event_source import AbstractEventSource, start_workitem
+from fk.core.abstract_serializer import sanitize_user_input
 from fk.core.abstract_settings import AbstractSettings
 from fk.core.abstract_timer_display import AbstractTimerDisplay
 from fk.core.event_source_holder import EventSourceHolder
@@ -320,7 +321,7 @@ def _void_pomodoro(self) -> None:
                 dlg.setLabelText('Are you sure you want to void current pomodoro?')
                 dlg.findChild(QLineEdit).setPlaceholderText('Reason (optional)')
                 if dlg.exec_():
-                    reason = f': {dlg.textValue()}' if dlg.textValue() else ''
+                    reason = f': {sanitize_user_input(dlg.textValue())}' if dlg.textValue() else ''
                     self._source_holder.get_source().execute(AddInterruptionStrategy,
                                                              [workitem.get_uid(), f'Pomodoro voided{reason}'])
                     self._source_holder.get_source().execute(StopTimerStrategy,
@@ -338,7 +339,7 @@ def _interruption(self) -> None:
                 dlg.findChild(QLineEdit).setPlaceholderText('What happened (optional)')
                 if dlg.exec_():
                     self._source_holder.get_source().execute(AddInterruptionStrategy,
-                                                             [workitem.get_uid(), dlg.textValue()])
+                                                             [workitem.get_uid(), sanitize_user_input(dlg.textValue())])
 
     def _finish_tracking(self) -> None:
         # We don't check if there's a running workitem, as the action is only enabled while the timer is ticking