focus_autosave.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Save document when losing focus.
# Gautier Portet <kassoulet gmail.com>

import datetime
import json
import gi

from gi.repository import GObject, Gedit, Gio, Gdk, Gtk, PeasGtk, GLib

from pathlib import Path

gi.require_version("Gtk", "3.0")

# region ############### CONSTANTs #################################
DEFAULT_TEMP_PATH = Path("~/.gedit_unsaved").expanduser()

GEDIT_CONFIG_DIR = Path(GLib.get_user_config_dir())/"gedit"
COFING_FILE = Path(GEDIT_CONFIG_DIR)/"focus_autosave_settings.json"

try:
    with open(COFING_FILE, encoding="utf-8") as conf:
        data = conf.read()
    FA_CONFIG = json.loads(data)
except (FileNotFoundError, json.JSONDecodeError):
    FA_CONFIG = dict(temp_path=None)

if FA_CONFIG["temp_path"] is not None:
    TEMP_DIR = Path(FA_CONFIG["temp_path"]).expanduser()
    Path(TEMP_DIR).mkdir(parents=True, exist_ok=True)

SOURCE_DIR = Path(__file__).parent.resolve()
# endregion ############### CONSTANTs ###############################


class FocusAutoSavePlugin(GObject.Object, Gedit.WindowActivatable, PeasGtk.Configurable):
    __gtype_name__ = "FocusAutoSavePlugin"
    window = GObject.property(type=Gedit.Window)

    def __init__(self):
        GObject.Object.__init__(self)
        self.other_action = False

    def do_activate(self):
        self.actions, self.ids = [], []
        for action in ("save", "save-as", "save-all", "close", "close-all", "open", "quickopen",
                       "config-spell", "check-spell", "inline-spell-checker", "print", "docinfo",
                       "replace", "quran"):
            if action in self.window.list_actions():
                self.actions.append(self.window.lookup_action(action))
                self.ids.append(self.actions[-1].connect("activate", self.on_action))
        self.signal = self.window.connect("focus-out-event", self.on_focus_out_event)
        self.other_action_signal = self.window.connect("key-press-event", self.on_key_press)

    def do_deactivate(self):
        self.window.disconnect(self.signal)
        self.window.disconnect(self.other_action_signal)
        del self.signal, self.other_action_signal
        for action,id_ in zip(self.actions, self.ids):
            action.disconnect(id_)
            del id_

    def on_action(self, *_):
        file = self.window.get_active_document().get_file()
        if file.get_location() is None:
            self.other_action = True

    def on_key_press(self, widget, event):
        if event.state == Gdk.ModifierType.CONTROL_MASK and event.keyval == Gdk.KEY_q:
            self.other_action = True

    def on_focus_out_event(self, widget, focus):
        if self.other_action:
            # skip to user specified file name
            self.other_action = False
            return
        for n, doc in enumerate(self.window.get_unsaved_documents()):
            if doc.is_untouched():
                # nothing to do
                continue
            if doc.get_file().is_readonly():
                # skip read-only files
                continue
            if doc.get_file().get_location() is None and FA_CONFIG["temp_path"] is not None:
                # provide a default filename
                now = datetime.datetime.now()
                Path(FA_CONFIG["temp_path"]).mkdir(parents=True, exist_ok=True)
                filename = str(Path(FA_CONFIG["temp_path"])/now.strftime(f"%Y%m%d-%H%M%S-{n+1}.txt"))
                doc.get_file().set_location(Gio.file_parse_name(filename))
            else:
                continue
            # save the document
            Gedit.commands_save_document(self.window, doc)

    def do_create_configure_widget(self):
        # Just return your box, PeasGtk will automatically pack it into a box and show it.
        builder = Gtk.Builder()
        builder.add_from_file(str(SOURCE_DIR/"focus_autosave_config.glade"))
        builder.connect_signals(Handler(self))

        window = builder.get_object("window")
        self.untitled_savecheck =builder.get_object("untitled_savecheck")
        self.folder = builder.get_object("folder")

        if FA_CONFIG["temp_path"] is None:
            self.folder.unselect_all()
            self.untitled_savecheck.set_active(False)
            self.folder.set_sensitive(False)
        else:
            self.untitled_savecheck.set_active(True)
            self.folder.set_sensitive(True)
            self.folder.set_current_folder(FA_CONFIG["temp_path"])

        # region Signals' binding to the handlers ##############################
        window.connect("destroy", Handler(self).on_window_destroy)
        self.untitled_savecheck.connect("toggled", Handler(self).on_untitled_savecheck_toggled)
        self.folder.connect("selection_changed", Handler(self).on_selection_changed)
        # endregion  ###########################################################

        return window


class Handler:
    def __init__(self, main_window):
        self.main_window = main_window

    def on_window_destroy(self, *args):
        if ( self.main_window.untitled_savecheck.get_active() and
            (folder:=self.main_window.folder.get_filename()) is not None ):
                FA_CONFIG["temp_path"] = folder
        else:
            FA_CONFIG["temp_path"] = None

        with open(COFING_FILE, mode="w", encoding="utf-8") as conf:
            json.dump(FA_CONFIG, conf)


    def on_selection_changed(self, file_chooser):
        folder = file_chooser.get_filename()
        if folder and self.main_window.untitled_savecheck.get_active():
            FA_CONFIG["temp_path"] = str(Path(folder))
        else:
            FA_CONFIG["temp_path"] = None


    def on_untitled_savecheck_toggled(self, toggle_button):
        if toggle_button.get_active():
            self.main_window.folder.set_sensitive(True)
            if (FA_CONFIG["temp_path"]) is None:
                FA_CONFIG["temp_path"] = DEFAULT_TEMP_PATH
                self.main_window.folder.set_current_folder(str(FA_CONFIG["temp_path"]))
        else:
            self.main_window.folder.unselect_all()
            self.main_window.folder.set_sensitive(False)
            FA_CONFIG["temp_path"] = None