mirror of
https://github.com/koreader/koreader.git
synced 2025-08-10 00:52:38 +00:00
bc0a55f093
Changed: - select multiple targets and export to them in a single click. - local targets (html, json and text) now are timestamped. Exporting booknotes on already exported documents will generate a new file with all the highlights present at export time. Previous files won't be deleted. Fixed: - chapters are now correctly represented in html output. - json issues when exporting the whole history. - joplin and readwise crashes when they're unable to reach the server - joplin update notes mechanism. - joplin is able to recreate the notebook if the user deletes or renames its current one. - highlights of read-only documents are also added when exporting the whole history (affects mostly android, might affect desktop targets) Co-authored-by: Utsob Roy <roy@utsob.me>
136 lines
2.9 KiB
Lua
136 lines
2.9 KiB
Lua
--[[--
|
|
Base for highlight exporters.
|
|
|
|
Each target should inherit from this class and implement *at least* an `export` function.
|
|
|
|
@module baseexporter
|
|
]]
|
|
|
|
local BaseExporter = {
|
|
clipping_dir = require("datastorage"):getDataDir() .. "/clipboard"
|
|
}
|
|
|
|
function BaseExporter:new(o)
|
|
o = o or {}
|
|
assert(type(o.name) == "string", "name is mandatory")
|
|
setmetatable(o, self)
|
|
self.__index = self
|
|
return o:_init()
|
|
end
|
|
|
|
function BaseExporter:_init()
|
|
self.extension = self.extension or self.name
|
|
self.is_remote = self.is_remote or false
|
|
self.version = self.version or "1.0.0"
|
|
self:loadSettings()
|
|
return self
|
|
end
|
|
|
|
--[[--
|
|
Export timestamp
|
|
|
|
@treturn string timestamp
|
|
]]
|
|
function BaseExporter:getTimeStamp()
|
|
local ts = self.timestamp or os.time()
|
|
return os.date("%Y-%m-%d %H:%M:%S", ts)
|
|
end
|
|
|
|
--[[--
|
|
Exporter version
|
|
|
|
@treturn string version
|
|
]]
|
|
function BaseExporter:getVersion()
|
|
return self.name .. "/" .. self.version
|
|
end
|
|
|
|
--[[--
|
|
Loads settings for the exporter
|
|
]]
|
|
function BaseExporter:loadSettings()
|
|
local plugin_settings = G_reader_settings:readSetting("exporter") or {}
|
|
self.settings = plugin_settings[self.name] or {}
|
|
end
|
|
|
|
--[[--
|
|
Saves settings for the exporter
|
|
]]
|
|
function BaseExporter:saveSettings()
|
|
local plugin_settings = G_reader_settings:readSetting("exporter") or {}
|
|
plugin_settings[self.name] = self.settings
|
|
G_reader_settings:saveSetting("exporter", plugin_settings)
|
|
self.new_settings = true
|
|
end
|
|
|
|
--[[--
|
|
Exports a table of booknotes to local format or remote service
|
|
|
|
@param t table of booknotes
|
|
@treturn bool success
|
|
]]
|
|
function BaseExporter:export(t) end
|
|
|
|
--[[--
|
|
File path where the exporter writes its output
|
|
|
|
@param t table of booknotes
|
|
@treturn string absolute path or nil
|
|
]]
|
|
function BaseExporter:getFilePath(t)
|
|
if not self.is_remote then
|
|
return string.format("%s/%s-%s.%s",
|
|
self.clipping_dir,
|
|
self:getTimeStamp(),
|
|
#t == 1 and t[1].title or "all-books",
|
|
self.extension)
|
|
end
|
|
end
|
|
|
|
--[[--
|
|
Configuration menu for the exporter
|
|
|
|
@treturn table menu with exporter settings
|
|
]]
|
|
function BaseExporter:getMenuTable()
|
|
return {
|
|
text = self.name:gsub("^%l", string.upper),
|
|
checked_func = function()
|
|
return self:isEnabled()
|
|
end,
|
|
callback = function()
|
|
self:toggleEnabled()
|
|
end,
|
|
}
|
|
end
|
|
|
|
--[[--
|
|
Checks if the exporter is ready to export
|
|
|
|
@treturn bool ready
|
|
]]
|
|
function BaseExporter:isReadyToExport()
|
|
return true
|
|
end
|
|
|
|
--[[--
|
|
Checks if the exporter was enabled by the user and it is ready to export
|
|
|
|
@treturn bool enabled
|
|
]]
|
|
function BaseExporter:isEnabled()
|
|
return self.settings.enabled and self:isReadyToExport()
|
|
end
|
|
|
|
--[[--
|
|
Toggles exporter enabled state if it's ready to export
|
|
]]
|
|
function BaseExporter:toggleEnabled()
|
|
if self:isReadyToExport() then
|
|
self.settings.enabled = not self.settings.enabled
|
|
self:saveSettings()
|
|
end
|
|
end
|
|
|
|
return BaseExporter
|