[feat] Open with: choose which engine to use for file (#3653)

Fixes #3345

* Add SVG to MuPDF filetypes

frontend/document/documentregistry.lua

@@ -2,7 +2,13 @@
 This is a registry for document providers
 ]]--
 
+local ButtonDialogTitle = require("ui/widget/buttondialogtitle")
+local ConfirmBox = require("ui/widget/confirmbox")
+local UIManager = require("ui/uimanager")
+local gettext = require("gettext")
 local logger = require("logger")
+local util = require("util")
+local T = require("ffi/util").template
 
 local DocumentRegistry = {
     registry = {},
@@ -20,11 +26,35 @@ end
 
 --- Returns the preferred registered document handler.
 -- @string file
--- @treturn string provider, or nil
+-- @treturn table provider, or nil
 function DocumentRegistry:getProvider(file)
     local providers = self:getProviders(file)
 
     if providers then
+        -- provider for document
+        local doc_settings_provider = require("docsettings"):open(file):readSetting("provider")
+
+        if doc_settings_provider then
+            for _, provider in ipairs(providers) do
+                if provider.provider.provider == doc_settings_provider then
+                    return provider.provider
+                end
+            end
+        end
+
+        -- global provider for filetype
+        local filename_suffix = util.getFileNameSuffix(file)
+        local g_settings_provider = G_reader_settings:readSetting("provider")
+
+        if g_settings_provider and g_settings_provider[filename_suffix] then
+            for _, provider in ipairs(providers) do
+                if provider.provider.provider == g_settings_provider[filename_suffix] then
+                    return provider.provider
+                end
+            end
+        end
+
+        -- highest weighted provider
         return providers[1].provider
     end
 end
@@ -54,14 +84,108 @@ function DocumentRegistry:getProviders(file)
     end
 end
 
-function DocumentRegistry:openDocument(file)
+--- Sets the preferred registered document handler.
+-- @string file
+-- @bool all
+function DocumentRegistry:setProvider(file, provider, all)
+    local _, filename_suffix = util.splitFileNameSuffix(file)
+
+    -- per-document
+    if not all then
+        local DocSettings = require("docsettings"):open(file)
+        DocSettings:saveSetting("provider", provider.provider)
+        DocSettings:flush()
+    -- global
+    else
+        local filetype_provider = G_reader_settings:readSetting("provider") or {}
+        filetype_provider[filename_suffix] = provider.provider
+        G_reader_settings:saveSetting("provider", filetype_provider)
+    end
+end
+
+function DocumentRegistry:showSetProviderButtons(file, filemanager_instance,  ui, reader_ui)
+    local _, filename_pure = util.splitFilePathName(file)
+    local filename_suffix = util.getFileNameSuffix(file)
+
+    local buttons = {}
+    local providers = self:getProviders(file)
+
+    for _, provider in ipairs(providers) do
+        -- we have no need for extension, mimetype, weights, etc. here
+        provider = provider.provider
+        table.insert(buttons, {
+            {
+                text = string.format("** %s **", provider.provider_name),
+            },
+        })
+        table.insert(buttons, {
+            {
+                text = gettext("Just once"),
+                callback = function()
+                    filemanager_instance:onClose()
+                    reader_ui:showReader(file, provider)
+                    UIManager:close(self.set_provider_dialog)
+                end,
+            },
+        })
+        table.insert(buttons, {
+            {
+                text = gettext("This document"),
+                callback = function()
+                    UIManager:show(ConfirmBox:new{
+                        text = T(gettext("Always open '%2' with %1?"),
+                                         provider.provider_name, filename_pure),
+                        ok_text = gettext("Always"),
+                        ok_callback = function()
+                            self:setProvider(file, provider, false)
+
+                            filemanager_instance:onClose()
+                            reader_ui:showReader(file, provider)
+                            UIManager:close(self.set_provider_dialog)
+                        end,
+                    })
+                end,
+            },
+        })
+        table.insert(buttons, {
+            {
+                text = gettext("All documents"),
+                callback = function()
+                    UIManager:show(ConfirmBox:new{
+                        text = T(gettext("Always open %2 files with %1?"),
+                                         provider.provider_name, filename_suffix),
+                        ok_text = gettext("Always"),
+                        ok_callback = function()
+                            self:setProvider(file, provider, true)
+
+                            filemanager_instance:onClose()
+                            reader_ui:showReader(file, provider)
+                            UIManager:close(self.set_provider_dialog)
+                        end,
+                    })
+                end,
+            },
+        })
+        -- little trick for visual separation
+        table.insert(buttons, {})
+    end
+
+    self.set_provider_dialog = ButtonDialogTitle:new{
+        title = T(gettext("Open %1 with:"), filename_pure),
+        buttons = buttons,
+    }
+    UIManager:show(self.set_provider_dialog)
+end
+
+function DocumentRegistry:openDocument(file, provider)
     -- force a GC, so that any previous document used memory can be reused
     -- immediately by this new document without having to wait for the
     -- next regular gc. The second call may help reclaming more memory.
     collectgarbage()
     collectgarbage()
     if not self.registry[file] then
-        local provider = self:getProvider(file)
+        provider = provider or self:getProvider(file)
+
         if provider ~= nil then
             local ok, doc = pcall(provider.new, provider, {file = file})
             if ok then