mirror of https://github.com/koreader/koreader
Refactor exporter.koplugin (#8944)
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>reviewable/pr9075/r1
parent
2de2a8ab76
commit
bc0a55f093
@ -1,154 +0,0 @@
|
|||||||
local http = require("socket.http")
|
|
||||||
local json = require("json")
|
|
||||||
local ltn12 = require("ltn12")
|
|
||||||
local socketutil = require("socketutil")
|
|
||||||
|
|
||||||
local JoplinClient = {
|
|
||||||
server_ip = "localhost",
|
|
||||||
server_port = 41184,
|
|
||||||
auth_token = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
function JoplinClient:new(o)
|
|
||||||
o = o or {}
|
|
||||||
self.__index = self
|
|
||||||
setmetatable(o, self)
|
|
||||||
return o
|
|
||||||
end
|
|
||||||
|
|
||||||
function JoplinClient:_makeRequest(url, method, request_body)
|
|
||||||
local sink = {}
|
|
||||||
local request_body_json = json.encode(request_body)
|
|
||||||
local source = ltn12.source.string(request_body_json)
|
|
||||||
socketutil:set_timeout(socketutil.LARGE_BLOCK_TIMEOUT, socketutil.LARGE_TOTAL_TIMEOUT)
|
|
||||||
http.request{
|
|
||||||
url = url,
|
|
||||||
method = method,
|
|
||||||
sink = ltn12.sink.table(sink),
|
|
||||||
source = source,
|
|
||||||
headers = {
|
|
||||||
["Content-Length"] = #request_body_json,
|
|
||||||
["Content-Type"] = "application/json"
|
|
||||||
},
|
|
||||||
}
|
|
||||||
socketutil:reset_timeout()
|
|
||||||
|
|
||||||
if not sink[1] then
|
|
||||||
error("No response from Joplin Server")
|
|
||||||
end
|
|
||||||
|
|
||||||
local response = json.decode(sink[1])
|
|
||||||
|
|
||||||
if response.error then
|
|
||||||
error(response.error)
|
|
||||||
end
|
|
||||||
|
|
||||||
return response
|
|
||||||
end
|
|
||||||
|
|
||||||
function JoplinClient:ping()
|
|
||||||
local sink = {}
|
|
||||||
|
|
||||||
http.request{
|
|
||||||
url = "http://"..self.server_ip..":"..self.server_port.."/ping",
|
|
||||||
method = "GET",
|
|
||||||
sink = ltn12.sink.table(sink)
|
|
||||||
}
|
|
||||||
|
|
||||||
if sink[1] == "JoplinClipperServer" then
|
|
||||||
return true
|
|
||||||
else
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
-- If successful returns id of found note.
|
|
||||||
function JoplinClient:findNoteByTitle(title, notebook_id)
|
|
||||||
local url_base = "http://"..self.server_ip..":"..self.server_port.."/notes?".."token="..self.auth_token.."&fields=id,title,parent_id&page="
|
|
||||||
|
|
||||||
local url
|
|
||||||
local page = 1
|
|
||||||
local has_more
|
|
||||||
|
|
||||||
repeat
|
|
||||||
url = url_base..page
|
|
||||||
local notes = self:_makeRequest(url, "GET")
|
|
||||||
has_more = notes.has_more
|
|
||||||
for _, note in ipairs(notes.items) do
|
|
||||||
if note.title == title then
|
|
||||||
if notebook_id == nil or note.parent_id == notebook_id then
|
|
||||||
return note.id
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
page = page + 1
|
|
||||||
until not has_more
|
|
||||||
return false
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
-- If successful returns id of found notebook (folder).
|
|
||||||
function JoplinClient:findNotebookByTitle(title)
|
|
||||||
local url_base = "http://"..self.server_ip..":"..self.server_port.."/folders?".."token="..self.auth_token.."&".."query="..title.."&page="
|
|
||||||
|
|
||||||
|
|
||||||
local url
|
|
||||||
local page = 1
|
|
||||||
local has_more
|
|
||||||
|
|
||||||
repeat
|
|
||||||
url = url_base..page
|
|
||||||
local folders = self:_makeRequest(url, "GET")
|
|
||||||
has_more = folders.has_more
|
|
||||||
for _, folder in ipairs(folders.items) do
|
|
||||||
if folder.title == title then
|
|
||||||
return folder.id
|
|
||||||
end
|
|
||||||
end
|
|
||||||
page = page + 1
|
|
||||||
until not has_more
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
|
|
||||||
-- If successful returns id of created notebook (folder).
|
|
||||||
function JoplinClient:createNotebook(title, created_time)
|
|
||||||
local request_body = {
|
|
||||||
title = title,
|
|
||||||
created_time = created_time
|
|
||||||
}
|
|
||||||
|
|
||||||
local url = "http://"..self.server_ip..":"..self.server_port.."/folders?".."token="..self.auth_token
|
|
||||||
local response = self:_makeRequest(url, "POST", request_body)
|
|
||||||
|
|
||||||
return response.id
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
-- If successful returns id of created note.
|
|
||||||
function JoplinClient:createNote(title, note, parent_id, created_time)
|
|
||||||
local request_body = {
|
|
||||||
title = title,
|
|
||||||
body = note,
|
|
||||||
parent_id = parent_id,
|
|
||||||
created_time = created_time
|
|
||||||
}
|
|
||||||
local url = "http://"..self.server_ip..":"..self.server_port.."/notes?".."token="..self.auth_token
|
|
||||||
local response = self:_makeRequest(url, "POST", request_body)
|
|
||||||
|
|
||||||
return response.id
|
|
||||||
end
|
|
||||||
|
|
||||||
-- If successful returns id of updated note.
|
|
||||||
function JoplinClient:updateNote(note_id, note, title, parent_id)
|
|
||||||
local request_body = {
|
|
||||||
body = note,
|
|
||||||
title = title,
|
|
||||||
parent_id = parent_id
|
|
||||||
}
|
|
||||||
|
|
||||||
local url = "http://"..self.server_ip..":"..self.server_port.."/notes/"..note_id.."?token="..self.auth_token
|
|
||||||
local response = self:_makeRequest(url, "PUT", request_body)
|
|
||||||
return response.id
|
|
||||||
end
|
|
||||||
|
|
||||||
return JoplinClient
|
|
@ -1,70 +0,0 @@
|
|||||||
local http = require("socket.http")
|
|
||||||
local json = require("json")
|
|
||||||
local logger = require("logger")
|
|
||||||
local ltn12 = require("ltn12")
|
|
||||||
local socket = require("socket")
|
|
||||||
local socketutil = require("socketutil")
|
|
||||||
|
|
||||||
local ReadwiseClient = {
|
|
||||||
auth_token = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
function ReadwiseClient:new(o)
|
|
||||||
o = o or {}
|
|
||||||
self.__index = self
|
|
||||||
setmetatable(o, self)
|
|
||||||
return o
|
|
||||||
end
|
|
||||||
|
|
||||||
function ReadwiseClient:_makeRequest(endpoint, method, request_body)
|
|
||||||
local sink = {}
|
|
||||||
local request_body_json = json.encode(request_body)
|
|
||||||
local source = ltn12.source.string(request_body_json)
|
|
||||||
socketutil:set_timeout(socketutil.LARGE_BLOCK_TIMEOUT, socketutil.LARGE_TOTAL_TIMEOUT)
|
|
||||||
local request = {
|
|
||||||
url = "https://readwise.io/api/v2/" .. endpoint,
|
|
||||||
method = method,
|
|
||||||
sink = ltn12.sink.table(sink),
|
|
||||||
source = source,
|
|
||||||
headers = {
|
|
||||||
["Content-Length"] = #request_body_json,
|
|
||||||
["Content-Type"] = "application/json",
|
|
||||||
["Authorization"] = "Token " .. self.auth_token
|
|
||||||
},
|
|
||||||
}
|
|
||||||
local code, _, status = socket.skip(1, http.request(request))
|
|
||||||
socketutil:reset_timeout()
|
|
||||||
|
|
||||||
if code ~= 200 then
|
|
||||||
logger.warn("ReadwiseClient: HTTP response code <> 200. Response status: ", status)
|
|
||||||
error("ReadwiseClient: HTTP response code <> 200.")
|
|
||||||
end
|
|
||||||
|
|
||||||
local response = json.decode(sink[1])
|
|
||||||
|
|
||||||
return response
|
|
||||||
end
|
|
||||||
|
|
||||||
function ReadwiseClient:createHighlights(booknotes)
|
|
||||||
local highlights = {}
|
|
||||||
for _, chapter in ipairs(booknotes) do
|
|
||||||
for _, clipping in ipairs(chapter) do
|
|
||||||
local highlight = {
|
|
||||||
text = clipping.text,
|
|
||||||
title = booknotes.title,
|
|
||||||
author = booknotes.author ~= "" and booknotes.author or nil, -- optional author
|
|
||||||
source_type = "koreader",
|
|
||||||
category = "books",
|
|
||||||
note = clipping.note,
|
|
||||||
location = clipping.page,
|
|
||||||
location_type = "page",
|
|
||||||
highlighted_at = os.date("!%Y-%m-%dT%TZ", clipping.time),
|
|
||||||
}
|
|
||||||
table.insert(highlights, highlight)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
local result = self:_makeRequest("highlights", "POST", { highlights = highlights })
|
|
||||||
logger.dbg("ReadwiseClient createHighlights result", result)
|
|
||||||
end
|
|
||||||
|
|
||||||
return ReadwiseClient
|
|
@ -0,0 +1,135 @@
|
|||||||
|
--[[--
|
||||||
|
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
|
@ -0,0 +1,62 @@
|
|||||||
|
local logger = require("logger")
|
||||||
|
local slt2 = require("template/slt2")
|
||||||
|
|
||||||
|
-- html exporter
|
||||||
|
local HtmlExporter = require("base"):new {
|
||||||
|
name = "html",
|
||||||
|
}
|
||||||
|
|
||||||
|
local function format(booknotes)
|
||||||
|
local chapters = {}
|
||||||
|
local curr_chapter = nil
|
||||||
|
for _, booknote in ipairs(booknotes) do
|
||||||
|
if curr_chapter == nil then
|
||||||
|
curr_chapter = {
|
||||||
|
title = booknote[1].chapter,
|
||||||
|
entries = {}
|
||||||
|
}
|
||||||
|
elseif curr_chapter.title ~= booknote[1].chapter then
|
||||||
|
table.insert(chapters, curr_chapter)
|
||||||
|
curr_chapter = {
|
||||||
|
title = booknote[1].chapter,
|
||||||
|
entries = {}
|
||||||
|
}
|
||||||
|
end
|
||||||
|
table.insert(curr_chapter.entries, booknote[1])
|
||||||
|
end
|
||||||
|
if curr_chapter ~= nil then
|
||||||
|
table.insert(chapters, curr_chapter)
|
||||||
|
end
|
||||||
|
booknotes.chapters = chapters
|
||||||
|
booknotes.entries = nil
|
||||||
|
return booknotes
|
||||||
|
end
|
||||||
|
|
||||||
|
function HtmlExporter:export(t)
|
||||||
|
local title
|
||||||
|
local path = self:getFilePath(t)
|
||||||
|
if #t == 1 then
|
||||||
|
title = t[1].title
|
||||||
|
else
|
||||||
|
title = "All Books"
|
||||||
|
end
|
||||||
|
local file = io.open(path, "w")
|
||||||
|
local template = slt2.loadfile(self.path .. "/template/note.tpl")
|
||||||
|
local clipplings = {}
|
||||||
|
for _, booknotes in ipairs(t) do
|
||||||
|
table.insert(clipplings, format(booknotes))
|
||||||
|
end
|
||||||
|
if not file then return false end
|
||||||
|
local content = slt2.render(template, {
|
||||||
|
clippings=clipplings,
|
||||||
|
document_title = title,
|
||||||
|
version = self:getVersion(),
|
||||||
|
timestamp = self:getTimeStamp(),
|
||||||
|
logger = logger
|
||||||
|
})
|
||||||
|
file:write(content)
|
||||||
|
file:close()
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
return HtmlExporter
|
@ -0,0 +1,364 @@
|
|||||||
|
local BD = require("ui/bidi")
|
||||||
|
local InfoMessage = require("ui/widget/infomessage")
|
||||||
|
local InputDialog = require("ui/widget/inputdialog")
|
||||||
|
local UIManager = require("ui/uimanager")
|
||||||
|
local http = require("socket.http")
|
||||||
|
local json = require("json")
|
||||||
|
local logger = require("logger")
|
||||||
|
local ltn12 = require("ltn12")
|
||||||
|
local socketutil = require("socketutil")
|
||||||
|
local T = require("ffi/util").template
|
||||||
|
local _ = require("gettext")
|
||||||
|
|
||||||
|
-- joplin exporter
|
||||||
|
local JoplinExporter = require("base"):new {
|
||||||
|
name = "joplin",
|
||||||
|
is_remote = true,
|
||||||
|
notebook_name = _("KOReader Notes"),
|
||||||
|
}
|
||||||
|
|
||||||
|
local function makeRequest(url, method, request_body)
|
||||||
|
local sink = {}
|
||||||
|
local request_body_json = json.encode(request_body)
|
||||||
|
local source = ltn12.source.string(request_body_json)
|
||||||
|
socketutil:set_timeout(socketutil.LARGE_BLOCK_TIMEOUT, socketutil.LARGE_TOTAL_TIMEOUT)
|
||||||
|
http.request{
|
||||||
|
url = url,
|
||||||
|
method = method,
|
||||||
|
sink = ltn12.sink.table(sink),
|
||||||
|
source = source,
|
||||||
|
headers = {
|
||||||
|
["Content-Length"] = #request_body_json,
|
||||||
|
["Content-Type"] = "application/json"
|
||||||
|
},
|
||||||
|
}
|
||||||
|
socketutil:reset_timeout()
|
||||||
|
|
||||||
|
if not sink[1] then
|
||||||
|
return nil, "No response from Joplin Server"
|
||||||
|
end
|
||||||
|
|
||||||
|
local response = json.decode(sink[1])
|
||||||
|
|
||||||
|
if not response then
|
||||||
|
return nil, "Unknown response from Joplin Server"
|
||||||
|
elseif response.error then
|
||||||
|
return nil, response.error
|
||||||
|
end
|
||||||
|
|
||||||
|
return response
|
||||||
|
end
|
||||||
|
|
||||||
|
local function ping(ip, port)
|
||||||
|
local sink = {}
|
||||||
|
http.request{
|
||||||
|
url = "http://"..ip..":"..port.."/ping",
|
||||||
|
method = "GET",
|
||||||
|
sink = ltn12.sink.table(sink)
|
||||||
|
}
|
||||||
|
|
||||||
|
if sink[1] == "JoplinClipperServer" then
|
||||||
|
return true
|
||||||
|
else
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local function prepareNote(booknotes)
|
||||||
|
local note = ""
|
||||||
|
for _, clipping in ipairs(booknotes) do
|
||||||
|
local entry = clipping[1]
|
||||||
|
if entry.chapter then
|
||||||
|
note = note .. "\n\t*" .. entry.chapter .. "*\n\n * * *"
|
||||||
|
end
|
||||||
|
|
||||||
|
note = note .. os.date("%Y-%m-%d %H:%M:%S \n", entry.time)
|
||||||
|
note = note .. entry.text
|
||||||
|
if entry.note then
|
||||||
|
note = note .. "\n---\n" .. entry.note
|
||||||
|
end
|
||||||
|
note = note .. "\n * * *\n"
|
||||||
|
end
|
||||||
|
return note
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If successful returns id of found note.
|
||||||
|
function JoplinExporter:findNoteByTitle(title, notebook_id)
|
||||||
|
local url_base = string.format("http://%s:%s/notes?token=%s&fields=id,title,parent_id&page=",
|
||||||
|
self.settings.ip, self.settings.port, self.settings.token)
|
||||||
|
|
||||||
|
local page = 1
|
||||||
|
local url, has_more
|
||||||
|
|
||||||
|
repeat
|
||||||
|
url = url_base..page
|
||||||
|
local notes, err = makeRequest(url, "GET")
|
||||||
|
if not notes then
|
||||||
|
logger.warn("Joplin findNoteByTitle error", err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
has_more = notes.has_more
|
||||||
|
for _, note in ipairs(notes.items) do
|
||||||
|
if note.title == title and note.parent_id == notebook_id then
|
||||||
|
return note.id
|
||||||
|
end
|
||||||
|
end
|
||||||
|
page = page + 1
|
||||||
|
until not has_more
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If successful returns id of found notebook (folder).
|
||||||
|
function JoplinExporter:findNotebookByTitle(title)
|
||||||
|
local url_base = string.format("http://%s:%s/folders?token=%s&query=title&page=",
|
||||||
|
self.settings.ip, self.settings.port, self.settings.token, title)
|
||||||
|
|
||||||
|
local page = 1
|
||||||
|
local url, has_more
|
||||||
|
|
||||||
|
repeat
|
||||||
|
url = url_base .. page
|
||||||
|
local folders, err = makeRequest(url, "GET")
|
||||||
|
if not folders then
|
||||||
|
logger.warn("Joplin findNotebookByTitle error", err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
has_more = folders.has_more
|
||||||
|
for _, folder in ipairs(folders.items) do
|
||||||
|
if folder.title == title then
|
||||||
|
return folder.id
|
||||||
|
end
|
||||||
|
end
|
||||||
|
page = page + 1
|
||||||
|
until not has_more
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
-- returns true if the notebook exists
|
||||||
|
function JoplinExporter:notebookExist(title)
|
||||||
|
local url = string.format("http://%s:%s/folders?token=%s",
|
||||||
|
self.settings.ip, self.settings.port, self.settings.token)
|
||||||
|
local response, err = makeRequest(url, "GET")
|
||||||
|
if not response then
|
||||||
|
logger.warn("Joplin notebookExist error", err)
|
||||||
|
end
|
||||||
|
|
||||||
|
if not response.items or type(response.items) ~= "table" then
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
for i, notebook in ipairs(response.items) do
|
||||||
|
if notebook.title == title then return true end
|
||||||
|
end
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If successful returns id of created notebook (folder).
|
||||||
|
function JoplinExporter:createNotebook(title, created_time)
|
||||||
|
local request_body = {
|
||||||
|
title = title,
|
||||||
|
created_time = created_time
|
||||||
|
}
|
||||||
|
local url = string.format("http://%s:%s/folders?token=%s",
|
||||||
|
self.settings.ip, self.settings.port, self.settings.token)
|
||||||
|
|
||||||
|
local response, err = makeRequest(url, "POST", request_body)
|
||||||
|
if not response then
|
||||||
|
logger.warn("Joplin createNotebook error", err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
return response.id
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If successful returns id of created note.
|
||||||
|
function JoplinExporter:createNote(title, note, parent_id, created_time)
|
||||||
|
local request_body = {
|
||||||
|
title = title,
|
||||||
|
body = note,
|
||||||
|
parent_id = parent_id,
|
||||||
|
created_time = created_time
|
||||||
|
}
|
||||||
|
local url = string.format("http://%s:%s/notes?token=%s",
|
||||||
|
self.settings.ip, self.settings.port, self.settings.token)
|
||||||
|
|
||||||
|
local response, err = makeRequest(url, "POST", request_body)
|
||||||
|
if not response then
|
||||||
|
logger.warn("Joplin createNote error", err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
return response.id
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If successful returns id of updated note.
|
||||||
|
function JoplinExporter:updateNote(note, note_id)
|
||||||
|
local request_body = {
|
||||||
|
body = note
|
||||||
|
}
|
||||||
|
|
||||||
|
local url = string.format("http://%s:%s/notes/%s?token=%s",
|
||||||
|
self.settings.ip, self.settings.port, note_id, self.settings.token)
|
||||||
|
|
||||||
|
local response, err = makeRequest(url, "PUT", request_body)
|
||||||
|
if not response then
|
||||||
|
logger.warn("Joplin updateNote error", err)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
return response.id
|
||||||
|
end
|
||||||
|
|
||||||
|
function JoplinExporter:isReadyToExport()
|
||||||
|
return self.settings.ip and self.settings.port and self.settings.token
|
||||||
|
end
|
||||||
|
|
||||||
|
function JoplinExporter:getMenuTable()
|
||||||
|
return {
|
||||||
|
text = _("Joplin"),
|
||||||
|
checked_func = function() return self:isEnabled() end,
|
||||||
|
sub_item_table = {
|
||||||
|
{
|
||||||
|
text = _("Set Joplin IP and Port"),
|
||||||
|
keep_menu_open = true,
|
||||||
|
callback = function()
|
||||||
|
local MultiInputDialog = require("ui/widget/multiinputdialog")
|
||||||
|
local url_dialog
|
||||||
|
url_dialog = MultiInputDialog:new {
|
||||||
|
title = _("Set Joplin IP and port number"),
|
||||||
|
fields = {
|
||||||
|
{
|
||||||
|
text = self.settings.ip,
|
||||||
|
input_type = "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = self.settings.port,
|
||||||
|
input_type = "number"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
buttons = {
|
||||||
|
{
|
||||||
|
{
|
||||||
|
text = _("Cancel"),
|
||||||
|
callback = function()
|
||||||
|
UIManager:close(url_dialog)
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("OK"),
|
||||||
|
callback = function()
|
||||||
|
local fields = url_dialog:getFields()
|
||||||
|
local ip = fields[1]
|
||||||
|
local port = tonumber(fields[2])
|
||||||
|
if ip ~= "" then
|
||||||
|
if port and port < 65355 then
|
||||||
|
self.settings.ip = ip
|
||||||
|
self.settings.port = port
|
||||||
|
self:saveSettings()
|
||||||
|
end
|
||||||
|
end
|
||||||
|
UIManager:close(url_dialog)
|
||||||
|
end
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
UIManager:show(url_dialog)
|
||||||
|
url_dialog:onShowKeyboard()
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Set authorization token"),
|
||||||
|
keep_menu_open = true,
|
||||||
|
callback = function()
|
||||||
|
local auth_dialog
|
||||||
|
auth_dialog = InputDialog:new {
|
||||||
|
title = _("Set authorization token for Joplin"),
|
||||||
|
input = self.settings.token,
|
||||||
|
buttons = {
|
||||||
|
{
|
||||||
|
{
|
||||||
|
text = _("Cancel"),
|
||||||
|
callback = function()
|
||||||
|
UIManager:close(auth_dialog)
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Set token"),
|
||||||
|
callback = function()
|
||||||
|
self.settings.token = auth_dialog:getInputText()
|
||||||
|
self:saveSettings()
|
||||||
|
UIManager:close(auth_dialog)
|
||||||
|
end
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
UIManager:show(auth_dialog)
|
||||||
|
auth_dialog:onShowKeyboard()
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Export to Joplin"),
|
||||||
|
checked_func = function() return self:isEnabled() end,
|
||||||
|
callback = function() self:toggleEnabled() end,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Help"),
|
||||||
|
keep_menu_open = true,
|
||||||
|
callback = function()
|
||||||
|
UIManager:show(InfoMessage:new {
|
||||||
|
text = T(_([[You can enter your auth token on your computer by saving an empty token. Then quit KOReader, edit the exporter.joplin_token field in %1/settings.reader.lua after creating a backup, and restart KOReader once you're done.
|
||||||
|
|
||||||
|
To export to Joplin, you must forward the IP and port used by this plugin to the localhost:port on which Joplin is listening. This can be done with socat or a similar program. For example:
|
||||||
|
|
||||||
|
For Windows: netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=41185 connectaddress=localhost connectport=41184
|
||||||
|
|
||||||
|
For Linux: $socat tcp-listen:41185,reuseaddr,fork tcp:localhost:41184
|
||||||
|
|
||||||
|
For more information, please visit https://github.com/koreader/koreader/wiki/Highlight-export.]])
|
||||||
|
, BD.dirpath("example"))
|
||||||
|
})
|
||||||
|
end
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
function JoplinExporter:export(t)
|
||||||
|
if not self:isReadyToExport() then return false end
|
||||||
|
|
||||||
|
if not ping(self.settings.ip, self.settings.port) then
|
||||||
|
logger.warn("Cannot reach Joplin server")
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
if not self:notebookExist(self.notebook_name) then
|
||||||
|
local notebook = self:createNotebook(self.notebook_name)
|
||||||
|
if notebook then
|
||||||
|
logger.info("Joplin: created new notebook",
|
||||||
|
"name", self.notebook_name, "id", notebook)
|
||||||
|
self.settings.notebook_guid = notebook
|
||||||
|
self:saveSettings()
|
||||||
|
else
|
||||||
|
logger.warn("Joplin: unable to create new notebook")
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local notebook_id = self.settings.notebook_guid
|
||||||
|
for _, booknotes in pairs(t) do
|
||||||
|
local note = prepareNote(booknotes)
|
||||||
|
local note_id = self:findNoteByTitle(booknotes.title, notebook_id)
|
||||||
|
local response
|
||||||
|
if note_id then
|
||||||
|
response = self:updateNote(note, note_id)
|
||||||
|
else
|
||||||
|
response = self:createNote(booknotes.title, note, notebook_id)
|
||||||
|
end
|
||||||
|
if not response then
|
||||||
|
logger.warn("Cannot export to Joplin")
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
return JoplinExporter
|
@ -0,0 +1,49 @@
|
|||||||
|
local json = require("json")
|
||||||
|
|
||||||
|
-- json exporter
|
||||||
|
local JsonExporter = require("base"):new {
|
||||||
|
name = "json",
|
||||||
|
}
|
||||||
|
|
||||||
|
local function format(booknotes)
|
||||||
|
local t = {
|
||||||
|
title = booknotes.title,
|
||||||
|
author = booknotes.author,
|
||||||
|
entries = {},
|
||||||
|
exported = booknotes.exported,
|
||||||
|
file = booknotes.file
|
||||||
|
}
|
||||||
|
for _, entry in ipairs(booknotes) do
|
||||||
|
table.insert(t.entries, entry[1])
|
||||||
|
end
|
||||||
|
return t
|
||||||
|
end
|
||||||
|
|
||||||
|
function JsonExporter:export(t)
|
||||||
|
local exportable
|
||||||
|
local timestamp = self.timestamp or os.time()
|
||||||
|
local path = self:getFilePath(t)
|
||||||
|
if #t == 1 then
|
||||||
|
exportable = format(t[1])
|
||||||
|
exportable.created_on = timestamp
|
||||||
|
exportable.version = self:getVersion()
|
||||||
|
else
|
||||||
|
local documents = {}
|
||||||
|
for _, booknotes in ipairs(t) do
|
||||||
|
table.insert(documents, format(booknotes))
|
||||||
|
end
|
||||||
|
exportable = {
|
||||||
|
created_on = timestamp,
|
||||||
|
version = self:getVersion(),
|
||||||
|
documents = documents
|
||||||
|
}
|
||||||
|
end
|
||||||
|
local file = io.open(path, "w")
|
||||||
|
if not file then return false end
|
||||||
|
file:write(json.encode(exportable))
|
||||||
|
file:write("\n")
|
||||||
|
file:close()
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
return JsonExporter
|
@ -0,0 +1,135 @@
|
|||||||
|
local InputDialog = require("ui/widget/inputdialog")
|
||||||
|
local UIManager = require("ui/uimanager")
|
||||||
|
local http = require("socket.http")
|
||||||
|
local json = require("json")
|
||||||
|
local logger = require("logger")
|
||||||
|
local ltn12 = require("ltn12")
|
||||||
|
local socket = require("socket")
|
||||||
|
local socketutil = require("socketutil")
|
||||||
|
local _ = require("gettext")
|
||||||
|
|
||||||
|
-- readwise exporter
|
||||||
|
local ReadwiseExporter = require("base"):new {
|
||||||
|
name = "readwise",
|
||||||
|
is_remote = true,
|
||||||
|
}
|
||||||
|
|
||||||
|
local function makeRequest(endpoint, method, request_body, token)
|
||||||
|
local sink = {}
|
||||||
|
local request_body_json = json.encode(request_body)
|
||||||
|
local source = ltn12.source.string(request_body_json)
|
||||||
|
socketutil:set_timeout(socketutil.LARGE_BLOCK_TIMEOUT, socketutil.LARGE_TOTAL_TIMEOUT)
|
||||||
|
local request = {
|
||||||
|
url = "https://readwise.io/api/v2/" .. endpoint,
|
||||||
|
method = method,
|
||||||
|
sink = ltn12.sink.table(sink),
|
||||||
|
source = source,
|
||||||
|
headers = {
|
||||||
|
["Content-Length"] = #request_body_json,
|
||||||
|
["Content-Type"] = "application/json",
|
||||||
|
["Authorization"] = "Token " .. token
|
||||||
|
},
|
||||||
|
}
|
||||||
|
local code, _, status = socket.skip(1, http.request(request))
|
||||||
|
socketutil:reset_timeout()
|
||||||
|
|
||||||
|
if code ~= 200 then
|
||||||
|
logger.warn("Readwise: HTTP response code <> 200. Response status: ", status)
|
||||||
|
return nil, status
|
||||||
|
end
|
||||||
|
|
||||||
|
local response = json.decode(sink[1])
|
||||||
|
return response
|
||||||
|
end
|
||||||
|
|
||||||
|
function ReadwiseExporter:isReadyToExport()
|
||||||
|
if self.settings.token then return true end
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
function ReadwiseExporter:getMenuTable()
|
||||||
|
return {
|
||||||
|
text = _("Readwise"),
|
||||||
|
checked_func = function() return self:isEnabled() end,
|
||||||
|
sub_item_table = {
|
||||||
|
{
|
||||||
|
text = _("Set authorization token"),
|
||||||
|
keep_menu_open = true,
|
||||||
|
callback = function()
|
||||||
|
local auth_dialog
|
||||||
|
auth_dialog = InputDialog:new {
|
||||||
|
title = _("Set authorization token for Readwise"),
|
||||||
|
input = self.settings.token,
|
||||||
|
buttons = {
|
||||||
|
{
|
||||||
|
{
|
||||||
|
text = _("Cancel"),
|
||||||
|
callback = function()
|
||||||
|
UIManager:close(auth_dialog)
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Set token"),
|
||||||
|
callback = function()
|
||||||
|
self.settings.token = auth_dialog:getInputText()
|
||||||
|
self:saveSettings()
|
||||||
|
UIManager:close(auth_dialog)
|
||||||
|
end
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
UIManager:show(auth_dialog)
|
||||||
|
auth_dialog:onShowKeyboard()
|
||||||
|
end
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text = _("Export to Readwise"),
|
||||||
|
checked_func = function() return self:isEnabled() end,
|
||||||
|
callback = function() self:toggleEnabled() end,
|
||||||
|
},
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
function ReadwiseExporter:createHighlights(booknotes)
|
||||||
|
local highlights = {}
|
||||||
|
for _, chapter in ipairs(booknotes) do
|
||||||
|
for _, clipping in ipairs(chapter) do
|
||||||
|
local highlight = {
|
||||||
|
text = clipping.text,
|
||||||
|
title = booknotes.title,
|
||||||
|
author = booknotes.author ~= "" and booknotes.author or nil, -- optional author
|
||||||
|
source_type = "koreader",
|
||||||
|
category = "books",
|
||||||
|
note = clipping.note,
|
||||||
|
location = clipping.page,
|
||||||
|
location_type = "page",
|
||||||
|
highlighted_at = os.date("!%Y-%m-%dT%TZ", clipping.time),
|
||||||
|
}
|
||||||
|
table.insert(highlights, highlight)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local result, err = makeRequest("highlights", "POST", { highlights = highlights }, self.settings.token)
|
||||||
|
if not result then
|
||||||
|
logger.warn("error creating highlights", err)
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
logger.dbg("createHighlights result", result)
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
function ReadwiseExporter:export(t)
|
||||||
|
if not self:isReadyToExport() then return false end
|
||||||
|
|
||||||
|
for _, booknotes in ipairs(t) do
|
||||||
|
local ok = self:createHighlights(booknotes)
|
||||||
|
if not ok then return false end
|
||||||
|
end
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
return ReadwiseExporter
|
@ -0,0 +1,46 @@
|
|||||||
|
local util = require("ffi/util")
|
||||||
|
local T = util.template
|
||||||
|
local _ = require("gettext")
|
||||||
|
|
||||||
|
-- text exporter
|
||||||
|
local TextExporter = require("base"):new {
|
||||||
|
name = "text",
|
||||||
|
extension = "txt",
|
||||||
|
}
|
||||||
|
|
||||||
|
function TextExporter:export(t)
|
||||||
|
-- Use wide_space to avoid crengine to treat it specially.
|
||||||
|
local wide_space = "\227\128\128"
|
||||||
|
local path = self:getFilePath(t)
|
||||||
|
local file = io.open(path, "a")
|
||||||
|
if not file then return false end
|
||||||
|
for __, booknotes in ipairs(t) do
|
||||||
|
if booknotes.title then
|
||||||
|
file:write(wide_space .. booknotes.title .. "\n" .. wide_space .. "\n")
|
||||||
|
end
|
||||||
|
for ___, entry in ipairs(booknotes) do
|
||||||
|
for ____, clipping in ipairs(entry) do
|
||||||
|
if clipping.chapter then
|
||||||
|
file:write(wide_space .. clipping.chapter .. "\n" .. wide_space .. "\n")
|
||||||
|
end
|
||||||
|
local text = T(_("-- Page: %1, added on %2\n"), clipping.page, os.date("%c", clipping.time))
|
||||||
|
file:write(wide_space .. wide_space .. text)
|
||||||
|
if clipping.text then
|
||||||
|
file:write(clipping.text)
|
||||||
|
end
|
||||||
|
if clipping.note then
|
||||||
|
file:write("\n---\n" .. clipping.note)
|
||||||
|
end
|
||||||
|
if clipping.image then
|
||||||
|
file:write(_("<An image>"))
|
||||||
|
end
|
||||||
|
file:write("\n-=-=-=-=-=-\n")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
file:write("\n")
|
||||||
|
end
|
||||||
|
file:close()
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
return TextExporter
|
Loading…
Reference in New Issue