mirror of
https://github.com/koreader/koreader
synced 2024-11-16 06:12:56 +00:00
22b9396696
There have been a couple of these this month, and keeping stuff that should only ever run once piling up in their respective module was getting ugly, especially when it's usually simple stuff (settings, files). So, move everything to a dedicated module, run by reader.lua on startup, and that will actually only do things once, when necessary.
56 lines
2.5 KiB
Lua
56 lines
2.5 KiB
Lua
--[[
|
|
Centralizes migration concerns for LuaSettings & DocSettings
|
|
--]]
|
|
|
|
local DocSettings = require("docsettings")
|
|
local LuaSettings = require("luasettings")
|
|
local logger = require("logger")
|
|
|
|
local SettingsMigration = {}
|
|
|
|
-- Shockingly, handles settings migration
|
|
-- NOTE: supports LuaSettings & DocSettings objects as input, as both implement the same API
|
|
function SettingsMigration:migrateSettings(config)
|
|
-- Figure out what kind of object we were passed, to make the logging more precise
|
|
local cfg_mt_idx = getmetatable(config).__index
|
|
local cfg_class
|
|
if cfg_mt_idx == DocSettings then
|
|
cfg_class = "book"
|
|
elseif cfg_mt_idx == LuaSettings then
|
|
cfg_class = "global"
|
|
else
|
|
-- Input object isn't a supported *Settings class, warn & abort instead of going kablooey.
|
|
logger.warn("Passed an unsupported object class to SettingsMigration!")
|
|
return
|
|
end
|
|
|
|
-- Fine-grained CRe margins (https://github.com/koreader/koreader/pull/4945)
|
|
if config:has("copt_page_margins") then
|
|
local old_margins = config:readSetting("copt_page_margins")
|
|
logger.info("Migrating old", cfg_class, "CRe margin settings: L", old_margins[1], "T", old_margins[2], "R", old_margins[3], "B", old_margins[4])
|
|
-- Format was: {left, top, right, bottom}
|
|
config:saveSetting("copt_h_page_margins", {old_margins[1], old_margins[3]})
|
|
config:saveSetting("copt_t_page_margin", old_margins[2])
|
|
config:saveSetting("copt_b_page_margin", old_margins[4])
|
|
-- Wipe it
|
|
config:delSetting("copt_page_margins")
|
|
end
|
|
|
|
-- Space condensing to Word spacing (https://github.com/koreader/koreader/pull/5655)
|
|
-- From a single number (space condensing) to a table of 2 numbers ({space width scale, space condensing}).
|
|
-- Be conservative and don't change space width scale: use 100%
|
|
if config:hasNot("copt_word_spacing") and config:has("copt_space_condensing") then
|
|
local space_condensing = config:readSetting("copt_space_condensing")
|
|
logger.info("Migrating old", cfg_class, "CRe space condensing:", space_condensing)
|
|
config:saveSetting("copt_word_spacing", { 100, space_condensing })
|
|
if cfg_class == "book" then
|
|
-- a bit messy that some settings are saved twice in DocSettings, with
|
|
-- and without a copt_ prefix, and they must be in sync
|
|
config:saveSetting("word_spacing", { 100, space_condensing })
|
|
end
|
|
end
|
|
|
|
end
|
|
|
|
return SettingsMigration
|