Add WikiReader plugin

frontend/apps/reader/modules/readerlink.lua

@@ -666,6 +666,11 @@ function ReaderLink:onGotoLink(link, neglect_current_location, allow_footnote_po
         return true
     end
 
+    -- Check for local WikiReader links
+    if link_url:find("^kolocalwiki://") ~= nil then
+        self.ui:handleEvent(Event:new("OpenLocalWikiPage", link_url)) -- Parsing of the URL handled in the plugin
+        return true
+    end
     -- Not supported
     UIManager:show(InfoMessage:new{
         text = T(_("Invalid or external link:\n%1"), BD.url(link_url)),

plugins/wikireader.koplugin/_meta.lua

@@ -0,0 +1,6 @@
+local _ = require("gettext")
+return {
+    name = "wikireader",
+    fullname = _("WikiReader"),
+    description = _([[Reads wikipedia articles from the local storage]]),
+}

plugins/wikireader.koplugin/main.lua

@@ -0,0 +1,190 @@
+--[[--
+This plugin reads wikipedia articles from the local storage.
+
+@module koplugin.wikireader
+--]]--
+
+local WidgetContainer = require("ui/widget/container/widgetcontainer")
+local WikiReaderWidget = dofile('./plugins/wikireader.koplugin/reader-widget.lua')
+local UIManager = require("ui/uimanager")
+local InfoMessage = require("ui/widget/infomessage")
+local PathChooser = require("ui/widget/pathchooser")
+local Device = require("device")
+local escape = require("turbo.escape")
+local util = require("util")
+
+local _ = require("gettext")
+local logger = require("logger")
+local log = logger.dbg
+local WikiReader = WidgetContainer:new{
+    name = "wikireader",
+    widget = nil
+}
+
+function WikiReader:init()
+    self.ui.menu:registerToMainMenu(self)
+end
+
+local function file_exists(name)
+    local f=io.open(name,"r")
+    if f~=nil then io.close(f) return true else return false end
+end
+
+function WikiReader:onOpenLocalWikiPage(url)
+    log("Caught onLookupWikipedia", url)
+    local poundLocation = url:find("#")
+    if url:find("^kolocalwiki://") == nil or poundLocation == nil then
+        UIManager:show(InfoMessage:new{
+            text = _("Got passed an invalid WikiReader URL"),
+            timeout = 2
+        })
+        return
+    end
+    local encoded_db_path = url:sub(15, poundLocation - 1)
+    local db_path = escape.base64_decode(encoded_db_path)
+    local title = url:sub(poundLocation + 1)
+    local widget = self:startWidget(db_path)
+    widget:gotoTitle(title)
+end
+
+function WikiReader:start()
+    self:startWidget(nil, "Ebook")
+end
+
+function WikiReader:startWidget(db_path, title)
+    log("Start widget with:", db_path, title, G_reader_settings:readSetting("wikireader_db_path"))
+
+    if self.widget ~= nil then
+        if title ~= nil then
+            self.widget:gotoTitle(title)
+        end
+        return self.widget
+    end
+    -- Init a new widget because we lost a reference to the old one
+    local wikireader_db_path = db_path or G_reader_settings:readSetting("wikireader_db_path")
+    if wikireader_db_path == nil then
+        UIManager:show(InfoMessage:new{
+            text = _("Could not find database, set it in the plugin menu first"),
+            timeout = 2
+        })
+    elseif wikireader_db_path:match('%.db$') == nil then
+        UIManager:show(InfoMessage:new{
+            text = _("Invalid database path (does not end in .db), please set it"),
+            timeout = 2
+        })
+    else
+        log("Got wikireader_db_path: ", wikireader_db_path)
+        local db_file = wikireader_db_path
+        if file_exists(db_file) then
+            local widget = WikiReaderWidget:new(db_file, title)
+            self.widget = widget
+            return widget
+        else
+            UIManager:show(InfoMessage:new{
+                text = _("Did not find database at: ") .. db_file,
+                timeout = 5
+            })
+        end
+    end
+end
+
+function WikiReader:onSearchRequest ()
+    local widget = self:startWidget()
+    widget:showSearchBox()
+end
+
+function WikiReader:showDBfilePicker()
+    local home_dir = G_reader_settings:readSetting("home_dir") or Device.home_dir or "/"
+
+    local path_chooser = PathChooser:new{
+        title = _("Find and long press zim_articles.db"),
+        select_directory = false,
+        select_file = true,
+        file_filter = function(filename)
+            local suffix = util.getFileNameSuffix(filename)
+            return suffix == 'db'
+        end,
+
+        path = home_dir,
+        onConfirm = function(path)
+            G_reader_settings:saveSetting("wikireader_db_path", path)
+            UIManager:show(InfoMessage:new{
+                text = _("Set WikiReader database path to: ") .. path,
+            })
+        end
+    }
+    UIManager:show(path_chooser)
+
+end
+
+function WikiReader:getFavoritesTable ()
+    local favorites_table = {{
+        text = _("Add current page to favorites"),
+        separator = true,
+        callback = function(touchmenu_instance)
+            if self.widget == nil then
+                UIManager:show(InfoMessage:new{
+                    text = "WikiReader is not openend",
+                    timeout = 2
+                })
+            else
+                self.widget:addCurrentTitleToFavorites()
+            end
+        end
+    }}
+
+    local favorite_titles = G_reader_settings:readSetting("wikireader-favorites") or {}
+
+    for i = 1, #favorite_titles do
+        local title = favorite_titles[i]
+        table.insert(favorites_table, {
+            text = title,
+            callback = function()
+                local widget = self:startWidget()
+                widget:gotoTitle(title)
+            end
+        })
+    end
+    log("Got favorites table:", favorites_table)
+    return favorites_table
+end
+
+
+
+function WikiReader:addToMainMenu(menu_items)
+    log("WIKI: Adding to menu: " .. _("WikiReader"))
+
+    menu_items.wikireader = {
+        text = _("WikiReader (Unstable)"),
+        sorting_hint = "tools",
+        {
+            text = _("Open WikiReader"),
+            callback = function () WikiReader:start() end,
+        },
+        {
+            text = _("Search WikiReader"),
+            callback = function () WikiReader:onSearchRequest() end,
+        },
+        {
+            text = _("Select database"),
+            callback = function () WikiReader:showDBfilePicker() end,
+        },
+        {
+            text = _("Favorites"),
+            sub_item_table_func = function () return WikiReader:getFavoritesTable() end
+        },
+        {
+            text = _("About"),
+            callback = function ()
+                UIManager:show(InfoMessage:new{
+                    text = _("WikiReader allows KOReader to read an offline webpages database, most commonly for WikiPedia.\n" ..
+                        "This database is a converted ZIM file, as it is used by for example the Kiwix software.\n\n" ..
+                        "Build by Bart Grosman")
+                })
+            end
+        }
+    }
+end
+
+
+return WikiReader