GUI: Add configurable temporary directory in GUI (#77)

This PR adds the ability to configure a custom temporary directory where unfinished processed videos are stored during the restoration process. Previously, the system temp directory was always used.

Reviewed-on: https://codeberg.org/ladaapp/lada/pulls/77
Co-authored-by: suphamster <suphamster@noreply.codeberg.org>
Co-committed-by: suphamster <suphamster@noreply.codeberg.org>

Author: 2 people

lada/gui/config/config.py

@@ -3,6 +3,7 @@
 
 import json
 import logging
+import tempfile
 import threading
 from enum import Enum
 from pathlib import Path
@@ -44,6 +45,7 @@ class Config(GObject.Object):
         'post_export_custom_command': '',
         'preview_buffer_duration': 0,
         'show_mosaic_detections': False,
+        'temp_directory': tempfile.gettempdir(),
     }
 
     def __init__(self, style_manager: Adw.StyleManager):
@@ -64,6 +66,7 @@ def __init__(self, style_manager: Adw.StyleManager):
         self._show_mosaic_detections = self._defaults['show_mosaic_detections']
         self._post_export_action = PostExportAction.NONE
         self._post_export_custom_command = self._defaults['post_export_custom_command']
+        self._temp_directory = self._defaults['temp_directory']
 
         self.save_lock = threading.Lock()
         self._style_manager = style_manager
@@ -245,6 +248,17 @@ def post_export_custom_command(self, value):
         self._post_export_custom_command = value
         self.save()
 
+    @GObject.Property()
+    def temp_directory(self):
+        return self._temp_directory
+
+    @temp_directory.setter
+    def temp_directory(self, value):
+        if value == self._temp_directory:
+            return
+        self._temp_directory = value
+        self.save()
+
     def save(self):
         self.save_lock.acquire_lock()
         config_file_path = self.get_config_file_path()
@@ -297,6 +311,7 @@ def reset_to_default_values(self):
         self.post_export_custom_command = self._defaults['post_export_custom_command']
         self.preview_buffer_duration = self._defaults['preview_buffer_duration']
         self.show_mosaic_detections = self._defaults['show_mosaic_detections']
+        self.temp_directory = self._defaults['temp_directory']
         self.validate_and_set_device(self._defaults['device'])
         self.save()
 
@@ -325,6 +340,7 @@ def _as_dict(self) -> dict:
             'post_export_custom_command': self._post_export_custom_command,
             'preview_buffer_duration': self._preview_buffer_duration,
             'show_mosaic_detections': self._show_mosaic_detections,
+            'temp_directory': self._temp_directory,
         }
 
     def get_default_value(self, key):
@@ -357,6 +373,8 @@ def _from_dict(self, dict):
                     self.validate_and_set_export_codec(dict[key])
                 elif key == 'export_directory':
                     self.validate_and_set_export_directory(dict[key])
+                elif key == 'temp_directory':
+                    self.validate_and_set_temp_directory(dict[key])
                 elif key == 'file_name_pattern':
                     self.validate_and_set_file_name_pattern(dict[key])
                 elif key == 'initial_view':
@@ -435,6 +453,14 @@ def validate_and_set_export_directory(self, export_directory: str | None):
                 self._export_directory = None
                 logger.warning(f"Configured export directory '{export_directory}' does not exist or is not a directory on the filesystem, falling back to '{self._export_directory}'")
 
+    def validate_and_set_temp_directory(self, temp_directory: str):
+        path = Path(temp_directory)
+        if path.is_dir():
+            self._temp_directory = temp_directory
+        else:
+            self._temp_directory = self.get_default_value('temp_directory')
+            logger.warning(f"Configured temp directory '{temp_directory}' does not exist or is not a directory on the filesystem, falling back to '{self._temp_directory}'")
+
     def validate_and_set_file_name_pattern(self, file_name_pattern: str):
         if utils.validate_file_name_pattern(file_name_pattern):
             self._file_name_pattern = file_name_pattern

lada/gui/config/config_sidebar.py

@@ -35,6 +35,7 @@ class ConfigSidebar(Gtk.Box):
     action_row_export_directory: Adw.ActionRow = Gtk.Template.Child()
     check_button_export_directory_alwaysask: Gtk.CheckButton = Gtk.Template.Child()
     check_button_export_directory_defaultdir: Gtk.CheckButton = Gtk.Template.Child()
+    action_row_temp_directory: Adw.ActionRow = Gtk.Template.Child()
     entry_row_file_name_pattern: Adw.EntryRow = Gtk.Template.Child()
     toggle_button_initial_view_preview: Gtk.ToggleButton = Gtk.Template.Child()
     toggle_button_initial_view_export: Gtk.ToggleButton = Gtk.Template.Child()
@@ -117,6 +118,9 @@ def init_sidebar_from_config(self, config: Config):
 
         self.entry_row_file_name_pattern.set_text(config.file_name_pattern)
 
+        # init temp directory
+        self.action_row_temp_directory.set_subtitle(config.temp_directory)
+
         self.toggle_button_initial_view_preview.set_active(config.initial_view == "preview")
         self.toggle_button_initial_view_export.set_active(config.initial_view == "export")
 
@@ -250,6 +254,11 @@ def check_button_export_directory_defaultdir_callback(self, button_clicked):
     def toggle_button_export_directory_filepicker_callback(self, button_clicked):
         self.show_select_folder()
 
+    @Gtk.Template.Callback()
+    @skip_if_uninitialized
+    def toggle_button_temp_directory_filepicker_callback(self, button_clicked):
+        self.show_select_temp_folder()
+
     @Gtk.Template.Callback()
     @skip_if_uninitialized
     def entry_row_file_name_pattern_changed_callback(self, entry_row):
@@ -322,6 +331,25 @@ def on_select_folder(_file_dialog, result):
                 if self.check_button_export_directory_defaultdir and not self._config.export_directory:
                     self.check_button_export_directory_alwaysask.set_active(True)
         file_dialog.select_folder(callback=on_select_folder)
+
+    def show_select_temp_folder(self):
+        file_dialog = Gtk.FileDialog()
+        file_dialog.set_title(_("Select a folder for temporary files"))
+        file_dialog.set_initial_folder(Gio.File.new_for_path(self._config.temp_directory))
+        def on_select_temp_folder(_file_dialog, result):
+            try:
+                selected_folder: Gio.File = _file_dialog.select_folder_finish(result)
+                selected_folder_path = selected_folder.get_path()
+                self._config.temp_directory = selected_folder_path
+                self.action_row_temp_directory.set_subtitle(selected_folder_path)
+            except GLib.Error as error:
+                if error.message == "Dismissed by user":
+                    logger.debug("FileDialog cancelled: Dismissed by user")
+                else:
+                    logger.error(f"Error selecting folder: {error.message}")
+                    raise error
+        file_dialog.select_folder(callback=on_select_temp_folder)
+
     def update_custom_command_visibility(self, action):
         self.entry_row_post_export_custom_command.set_visible(action == "custom_command")
 

lada/gui/config/config_sidebar.ui

@@ -180,6 +180,19 @@ SPDX-License-Identifier: AGPL-3.0
                                         </child>
                                     </object>
                                 </child>
+                                <child>
+                                    <object class="AdwActionRow" id="action_row_temp_directory">
+                                        <property name="title" translatable="true">Temporary directory</property>
+                                        <property name="subtitle" translatable="true">Directory for temporary video files during restoration process</property>
+                                        <child type="suffix">
+                                            <object class="GtkButton">
+                                                <property name="icon-name">folder-open-symbolic</property>
+                                                <property name="valign">3</property>
+                                                <signal name="clicked" handler="toggle_button_temp_directory_filepicker_callback"/>
+                                            </object>
+                                        </child>
+                                    </object>
+                                </child>
                                 <child>
                                     <object class="AdwEntryRow" id="entry_row_file_name_pattern">
                                         <property name="title" translatable="true">File name pattern for restored files.&#xA;Must include placeholder &lt;span background=&quot;#D3D3D350&quot;&gt;&lt;tt&gt;{orig_file_name}&lt;/tt&gt;&lt;/span&gt;.</property>

lada/gui/export/export_view.py

@@ -408,7 +408,8 @@ def run_export():
 
             progress_update_step_size = 100
             success = True
-            video_tmp_file_output_path = os.path.join(tempfile.gettempdir(),f"{os.path.basename(os.path.splitext(restore_file_path)[0])}.tmp{os.path.splitext(restore_file_path)[1]}")
+            temp_dir = self._config.temp_directory
+            video_tmp_file_output_path = os.path.join(temp_dir, f"{os.path.basename(os.path.splitext(restore_file_path)[0])}.tmp{os.path.splitext(restore_file_path)[1]}")
             try:
                 if self.resume_info:
                     start_ns = self.resume_info.get_resume_timestamp_ns()