[Plugin] Per directory defaults (#5428)

frontend/apps/reader/readerui.lua

@@ -382,6 +382,9 @@ function ReaderUI:init()
         })
     end
 
+    -- Allow others to change settings based on external factors
+    -- Must be called after plugins are loaded & before setting are read.
+    self:handleEvent(Event:new("DocSettingsLoad", self.doc_settings, self.document))
     -- we only read settings after all the widgets are initialized
     self:handleEvent(Event:new("ReadSettings", self.doc_settings))
 

frontend/ui/elements/filemanager_menu_order.lua

@@ -108,6 +108,7 @@ local order = {
         "battery_statistics",
         "synchronize_time",
         "keep_alive",
+        "doc_setting_tweak",
         "terminal",
     },
     search = {

frontend/ui/elements/reader_menu_order.lua

@@ -128,6 +128,7 @@ local order = {
         "battery_statistics",
         "synchronize_time",
         "keep_alive",
+        "doc_setting_tweak",
         "terminal",
     },
     search = {

plugins/docsettingtweak.koplugin/_meta.lua

@@ -0,0 +1,6 @@
+local _ = require("gettext")
+return {
+    name = 'docsettingtweak',
+    fullname = _("Tweak document settings"),
+    description = _([[This plugin allows you to tweak document settings before the document is loaded based on external factors.]]),
+}

plugins/docsettingtweak.koplugin/directory_defaults_template.lua

@@ -0,0 +1,38 @@
+return {--do NOT change this line
+
+ --HELP:
+ -- You can override default settings for documents per directory in this file.
+ -- The directories must be under the home folder.
+ -- You can find settings to change in the metadata.lua in the .sdr folder.
+ -- The path must start with "/" (absolute path).
+ -- The path must not end with a "/" it must end with the folder name.
+
+ -- syntax:
+
+ --   ["path/to/folder"] = {
+ --         ["setting_to_override"] = value,
+ --    },
+
+ -- examples:
+
+ --[[
+    ["/mnt/us/documents/hebrew"] = {
+        ["inverse_reading_order"] = true
+    },
+    ["/mnt/onboard/smalltext"] = {
+        ["font_size"] = 34,
+        ["line_space_percent"] = 130,
+    },
+    ["/sdcard/Books/smalltext"] = {
+        ["font_size"] = 34,
+        ["line_space_percent"] = 130,
+    },
+--]]
+
+ -- comment out line ("--" at line start) to disable
+
+
+ -- ADD YOUR DEFAULTS HERE:
+
+
+}--do NOT change this line

plugins/docsettingtweak.koplugin/main.lua

@@ -0,0 +1,107 @@
+local DataStorage = require("datastorage")
+local FFIUtil = require("ffi/util")
+local InputDialog = require("ui/widget/inputdialog")
+local LuaSettings = require("luasettings")
+local UIManager = require("ui/uimanager")
+local WidgetContainer = require("ui/widget/container/widgetcontainer")
+local _ = require("gettext")
+local T = FFIUtil.template
+local filemanagerutil = require("apps/filemanager/filemanagerutil")
+local util = require("util")
+
+local DocSettingTweak = WidgetContainer:new{
+    name = 'docsettingtweak',
+}
+
+local directory_defaults_name = "directory_defaults.lua"
+local directory_defaults_path = FFIUtil.joinPath(DataStorage:getSettingsDir(), directory_defaults_name)
+local directory_defaults = nil
+local initialized = false
+
+function DocSettingTweak:init()
+    if not initialized then
+        -- Make sure our settings file exists
+        if not lfs.attributes(directory_defaults_path, "mode") then
+            FFIUtil.copyFile(FFIUtil.joinPath(self.path, "directory_defaults_template.lua"),
+                         directory_defaults_path)
+        end
+        initialized = true
+    end
+    DocSettingTweak:loadDefaults()
+    self.ui.menu:registerToMainMenu(self)
+end
+
+function DocSettingTweak:loadDefaults()
+    directory_defaults = LuaSettings:open(directory_defaults_path)
+end
+
+function DocSettingTweak:addToMainMenu(menu_items)
+    menu_items.doc_setting_tweak = {
+        text = _("Tweak document settings"),
+        callback = function() DocSettingTweak:editDirectoryDefaults() end,
+    }
+end
+
+function DocSettingTweak:editDirectoryDefaults()
+    local directory_defaults_file = io.open(directory_defaults_path, "rb")
+    local defaults = directory_defaults_file:read("*all")
+    directory_defaults_file:close()
+    local config_editor
+    config_editor = InputDialog:new{
+        title = T(_("Directory Defaults: %1"),directory_defaults_path),
+        input = defaults,
+        input_type = "string",
+        fullscreen = true,
+        condensed = true,
+        allow_newline = true,
+        cursor_at_end = false,
+        add_nav_bar = true,
+        reset_callback = function()
+            return defaults
+        end,
+        save_callback = function(content)
+            if content and #content > 0 then
+                local parse_error = util.checkLuaSyntax(content)
+                if not parse_error then
+                    local syntax_okay, syntax_error = pcall(loadstring(content))
+                    if syntax_okay then
+                        directory_defaults_file = io.open(directory_defaults_path, "w")
+                        directory_defaults_file:write(content)
+                        directory_defaults_file:close()
+                        DocSettingTweak:loadDefaults()
+                        return true, _("Defaults saved")
+                    else
+                        return false, T(_("Defaults invalid: %1"), syntax_error)
+                    end
+                else
+                        return false, T(_("Defaults invalid: %1"), parse_error)
+                    end
+            end
+            return false, _("Defaults empty")
+        end,
+    }
+    UIManager:show(config_editor)
+    config_editor:onShowKeyboard()
+end
+
+function DocSettingTweak:onDocSettingsLoad(doc_settings, document)
+    -- check that the documents settings are empty & and that we have defaults to customize
+    if next(doc_settings.data) == nil and directory_defaults.data ~= nil then
+        local base = G_reader_settings:readSetting("home_dir") or filemanagerutil.getDefaultDir()
+        if document.file == nil or document.file == "" then
+            return
+        end
+        local directory = FFIUtil.dirname(document.file)
+        -- check if folder matches our defaults to override
+        while directory:sub(1, #base) == base do
+            if directory_defaults:has(directory) then
+                doc_settings.data = util.tableDeepCopy(directory_defaults:readSetting(directory))
+                break
+            else
+                directory = FFIUtil.dirname(directory)
+            end
+        end
+    end
+end
+
+return DocSettingTweak