2017-08-17 17:34:36 +00:00
|
|
|
local UIManager = require("ui/uimanager")
|
Clarify our OOP semantics across the codebase (#9586)
Basically:
* Use `extend` for class definitions
* Use `new` for object instantiations
That includes some minor code cleanups along the way:
* Updated `Widget`'s docs to make the semantics clearer.
* Removed `should_restrict_JIT` (it's been dead code since https://github.com/koreader/android-luajit-launcher/pull/283)
* Minor refactoring of LuaSettings/LuaData/LuaDefaults/DocSettings to behave (mostly, they are instantiated via `open` instead of `new`) like everything else and handle inheritance properly (i.e., DocSettings is now a proper LuaSettings subclass).
* Default to `WidgetContainer` instead of `InputContainer` for stuff that doesn't actually setup key/gesture events.
* Ditto for explicit `*Listener` only classes, make sure they're based on `EventListener` instead of something uselessly fancier.
* Unless absolutely necessary, do not store references in class objects, ever; only values. Instead, always store references in instances, to avoid both sneaky inheritance issues, and sneaky GC pinning of stale references.
* ReaderUI: Fix one such issue with its `active_widgets` array, with critical implications, as it essentially pinned *all* of ReaderUI's modules, including their reference to the `Document` instance (i.e., that was a big-ass leak).
* Terminal: Make sure the shell is killed on plugin teardown.
* InputText: Fix Home/End/Del physical keys to behave sensibly.
* InputContainer/WidgetContainer: If necessary, compute self.dimen at paintTo time (previously, only InputContainers did, which might have had something to do with random widgets unconcerned about input using it as a baseclass instead of WidgetContainer...).
* OverlapGroup: Compute self.dimen at *init* time, because for some reason it needs to do that, but do it directly in OverlapGroup instead of going through a weird WidgetContainer method that it was the sole user of.
* ReaderCropping: Under no circumstances should a Document instance member (here, self.bbox) risk being `nil`ed!
* Kobo: Minor code cleanups.
2022-10-06 00:14:48 +00:00
|
|
|
local WidgetContainer = require("ui/widget/container/widgetcontainer")
|
2017-08-17 17:34:36 +00:00
|
|
|
local logger = require("logger")
|
|
|
|
local _ = require("gettext")
|
|
|
|
local BookInfoManager = require("bookinfomanager")
|
|
|
|
|
|
|
|
--[[
|
|
|
|
This plugin provides additional display modes to file browsers (File Manager
|
|
|
|
and History).
|
|
|
|
It does that by dynamically replacing some methods code to their classes
|
|
|
|
or instances.
|
|
|
|
--]]
|
|
|
|
|
|
|
|
-- We need to save the original methods early here as locals.
|
|
|
|
-- For some reason, saving them as attributes in init() does not allow
|
|
|
|
-- us to get back to classic mode
|
|
|
|
local FileChooser = require("ui/widget/filechooser")
|
|
|
|
local _FileChooser__recalculateDimen_orig = FileChooser._recalculateDimen
|
|
|
|
local _FileChooser_updateItems_orig = FileChooser.updateItems
|
|
|
|
local _FileChooser_onCloseWidget_orig = FileChooser.onCloseWidget
|
|
|
|
|
|
|
|
local FileManagerHistory = require("apps/filemanager/filemanagerhistory")
|
|
|
|
local _FileManagerHistory_updateItemTable_orig = FileManagerHistory.updateItemTable
|
|
|
|
|
2019-11-05 23:17:28 +00:00
|
|
|
local FileManagerCollection = require("apps/filemanager/filemanagercollection")
|
|
|
|
local _FileManagerCollection_updateItemTable_orig = FileManagerCollection.updateItemTable
|
|
|
|
|
2018-03-14 17:14:52 +00:00
|
|
|
local FileManager = require("apps/filemanager/filemanager")
|
|
|
|
local _FileManager_tapPlus_orig = FileManager.tapPlus
|
|
|
|
|
2017-08-17 17:34:36 +00:00
|
|
|
-- Available display modes
|
|
|
|
local DISPLAY_MODES = {
|
|
|
|
-- nil or "" -- classic : filename only
|
|
|
|
mosaic_image = true, -- 3x3 grid covers with images
|
|
|
|
mosaic_text = true, -- 3x3 grid covers text only
|
|
|
|
list_image_meta = true, -- image with metadata (title/authors)
|
|
|
|
list_only_meta = true, -- metadata with no image
|
|
|
|
list_image_filename = true, -- image with filename (no metadata)
|
|
|
|
}
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
-- Store some states as locals, to be permanent across instantiations
|
|
|
|
local init_done = false
|
|
|
|
local filemanager_display_mode = false -- not initialized yet
|
|
|
|
local history_display_mode = false -- not initialized yet
|
2019-11-05 23:17:28 +00:00
|
|
|
local collection_display_mode = false -- not initialized yet
|
2019-10-22 21:49:04 +00:00
|
|
|
local series_mode = nil -- defaults to not display series
|
2017-10-21 17:55:29 +00:00
|
|
|
|
Clarify our OOP semantics across the codebase (#9586)
Basically:
* Use `extend` for class definitions
* Use `new` for object instantiations
That includes some minor code cleanups along the way:
* Updated `Widget`'s docs to make the semantics clearer.
* Removed `should_restrict_JIT` (it's been dead code since https://github.com/koreader/android-luajit-launcher/pull/283)
* Minor refactoring of LuaSettings/LuaData/LuaDefaults/DocSettings to behave (mostly, they are instantiated via `open` instead of `new`) like everything else and handle inheritance properly (i.e., DocSettings is now a proper LuaSettings subclass).
* Default to `WidgetContainer` instead of `InputContainer` for stuff that doesn't actually setup key/gesture events.
* Ditto for explicit `*Listener` only classes, make sure they're based on `EventListener` instead of something uselessly fancier.
* Unless absolutely necessary, do not store references in class objects, ever; only values. Instead, always store references in instances, to avoid both sneaky inheritance issues, and sneaky GC pinning of stale references.
* ReaderUI: Fix one such issue with its `active_widgets` array, with critical implications, as it essentially pinned *all* of ReaderUI's modules, including their reference to the `Document` instance (i.e., that was a big-ass leak).
* Terminal: Make sure the shell is killed on plugin teardown.
* InputText: Fix Home/End/Del physical keys to behave sensibly.
* InputContainer/WidgetContainer: If necessary, compute self.dimen at paintTo time (previously, only InputContainers did, which might have had something to do with random widgets unconcerned about input using it as a baseclass instead of WidgetContainer...).
* OverlapGroup: Compute self.dimen at *init* time, because for some reason it needs to do that, but do it directly in OverlapGroup instead of going through a weird WidgetContainer method that it was the sole user of.
* ReaderCropping: Under no circumstances should a Document instance member (here, self.bbox) risk being `nil`ed!
* Kobo: Minor code cleanups.
2022-10-06 00:14:48 +00:00
|
|
|
local CoverBrowser = WidgetContainer:extend{
|
2018-08-17 18:54:11 +00:00
|
|
|
name = "coverbrowser",
|
|
|
|
}
|
2017-08-17 17:34:36 +00:00
|
|
|
|
|
|
|
function CoverBrowser:init()
|
2017-08-25 15:01:18 +00:00
|
|
|
self.ui.menu:registerToMainMenu(self)
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
if init_done then -- things already patched according to current modes
|
|
|
|
return
|
|
|
|
end
|
2017-08-17 17:34:36 +00:00
|
|
|
|
2018-04-06 16:14:49 +00:00
|
|
|
-- Set up default display modes on first launch
|
|
|
|
if not G_reader_settings:isTrue("coverbrowser_initial_default_setup_done") then
|
|
|
|
-- Only if no display mode has been set yet
|
|
|
|
if not BookInfoManager:getSetting("filemanager_display_mode")
|
|
|
|
and not BookInfoManager:getSetting("history_display_mode") then
|
|
|
|
logger.info("CoverBrowser: setting default display modes")
|
|
|
|
BookInfoManager:saveSetting("filemanager_display_mode", "list_image_meta")
|
|
|
|
BookInfoManager:saveSetting("history_display_mode", "mosaic_image")
|
|
|
|
end
|
2021-03-06 21:44:18 +00:00
|
|
|
G_reader_settings:makeTrue("coverbrowser_initial_default_setup_done")
|
2018-04-06 16:14:49 +00:00
|
|
|
end
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
self:setupFileManagerDisplayMode(BookInfoManager:getSetting("filemanager_display_mode"))
|
|
|
|
self:setupHistoryDisplayMode(BookInfoManager:getSetting("history_display_mode"))
|
2019-11-05 23:17:28 +00:00
|
|
|
self:setupCollectionDisplayMode(BookInfoManager:getSetting("collection_display_mode"))
|
2019-10-22 21:49:04 +00:00
|
|
|
series_mode = BookInfoManager:getSetting("series_mode")
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
init_done = true
|
2018-04-19 15:06:36 +00:00
|
|
|
BookInfoManager:closeDbConnection() -- will be re-opened if needed
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
function CoverBrowser:addToMainMenu(menu_items)
|
2017-08-25 15:01:18 +00:00
|
|
|
-- We add it only to FileManager menu
|
|
|
|
if self.ui.view then -- Reader
|
|
|
|
return
|
|
|
|
end
|
|
|
|
|
2023-03-13 07:53:09 +00:00
|
|
|
local modes = {
|
|
|
|
{ _("Classic (filename only)") },
|
|
|
|
{ _("Mosaic with cover images"), "mosaic_image" },
|
|
|
|
{ _("Mosaic with text covers"), "mosaic_text" },
|
|
|
|
{ _("Detailed list with cover images and metadata"), "list_image_meta" },
|
|
|
|
{ _("Detailed list with metadata, no images"), "list_only_meta" },
|
|
|
|
{ _("Detailed list with cover images and filenames"), "list_image_filename" },
|
|
|
|
}
|
|
|
|
local sub_item_table, history_sub_item_table, collection_sub_item_table = {}, {}, {}
|
|
|
|
for i, v in ipairs(modes) do
|
|
|
|
local text, mode = unpack(v)
|
|
|
|
table.insert(sub_item_table, {
|
|
|
|
text = text,
|
|
|
|
checked_func = function()
|
|
|
|
return mode == filemanager_display_mode
|
|
|
|
end,
|
|
|
|
callback = function()
|
|
|
|
self:setupFileManagerDisplayMode(mode)
|
|
|
|
if BookInfoManager:getSetting("unified_display_mode") then
|
|
|
|
self:setupHistoryDisplayMode(mode)
|
|
|
|
self:setupCollectionDisplayMode(mode)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
separator = i == #modes,
|
|
|
|
})
|
|
|
|
table.insert(history_sub_item_table, {
|
|
|
|
text = text,
|
|
|
|
checked_func = function()
|
|
|
|
return mode == history_display_mode
|
|
|
|
end,
|
|
|
|
callback = function()
|
|
|
|
self:setupHistoryDisplayMode(mode)
|
|
|
|
end,
|
|
|
|
})
|
|
|
|
table.insert(collection_sub_item_table, {
|
|
|
|
text = text,
|
|
|
|
checked_func = function()
|
|
|
|
return mode == collection_display_mode
|
|
|
|
end,
|
|
|
|
callback = function()
|
|
|
|
self:setupCollectionDisplayMode(mode)
|
|
|
|
end,
|
|
|
|
})
|
|
|
|
end
|
|
|
|
table.insert(sub_item_table, {
|
|
|
|
text = _("Use this mode everywhere"),
|
|
|
|
checked_func = function()
|
|
|
|
return BookInfoManager:getSetting("unified_display_mode")
|
|
|
|
end,
|
|
|
|
callback = function()
|
|
|
|
local do_sync = not BookInfoManager:getSetting("unified_display_mode")
|
|
|
|
BookInfoManager:saveSetting("unified_display_mode", do_sync)
|
|
|
|
if do_sync then
|
|
|
|
self:setupHistoryDisplayMode(filemanager_display_mode)
|
|
|
|
self:setupCollectionDisplayMode(filemanager_display_mode)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
})
|
|
|
|
table.insert(sub_item_table, {
|
|
|
|
text = _("History display mode"),
|
|
|
|
enabled_func = function()
|
|
|
|
return not BookInfoManager:getSetting("unified_display_mode")
|
|
|
|
end,
|
|
|
|
sub_item_table = history_sub_item_table,
|
|
|
|
})
|
|
|
|
table.insert(sub_item_table, {
|
|
|
|
text = _("Favorites display mode"),
|
|
|
|
enabled_func = function()
|
|
|
|
return not BookInfoManager:getSetting("unified_display_mode")
|
|
|
|
end,
|
|
|
|
sub_item_table = collection_sub_item_table,
|
|
|
|
})
|
2017-08-25 15:01:18 +00:00
|
|
|
menu_items.filemanager_display_mode = {
|
|
|
|
text = _("Display mode"),
|
2023-03-13 07:53:09 +00:00
|
|
|
sub_item_table = sub_item_table,
|
2021-07-23 13:47:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
-- add Mosaic / Detailed list mode settings to File browser Settings submenu
|
|
|
|
-- next to Classic mode settings
|
|
|
|
if menu_items.filebrowser_settings == nil then return end
|
|
|
|
table.insert (menu_items.filebrowser_settings.sub_item_table, 4, {
|
|
|
|
text = _("Mosaic and detailed list settings"),
|
|
|
|
separator = true,
|
|
|
|
sub_item_table = {
|
2019-11-05 23:17:28 +00:00
|
|
|
{
|
2021-07-23 13:47:02 +00:00
|
|
|
text = _("Items per page"),
|
|
|
|
help_text = _([[This sets the number of files and folders per page in display modes other than classic.]]),
|
|
|
|
-- Best to not "keep_menu_open = true", to see how this apply on the full view
|
|
|
|
callback = function()
|
|
|
|
local SpinWidget = require("ui/widget/spinwidget")
|
|
|
|
-- "files_per_page" should have been saved with an adequate value
|
|
|
|
-- the first time Detailed list was shown. Fallback to a start
|
|
|
|
-- value of 10 if it hasn't.
|
|
|
|
local curr_items = BookInfoManager:getSetting("files_per_page") or 10
|
|
|
|
local items = SpinWidget:new{
|
|
|
|
value = curr_items,
|
|
|
|
value_min = 4,
|
|
|
|
value_max = 20,
|
|
|
|
default_value = 10,
|
|
|
|
keep_shown_on_apply = true,
|
|
|
|
title_text = _("Items per page"),
|
|
|
|
callback = function(spin)
|
|
|
|
BookInfoManager:saveSetting("files_per_page", spin.value)
|
|
|
|
self.ui:onRefresh()
|
|
|
|
end
|
|
|
|
}
|
|
|
|
UIManager:show(items)
|
|
|
|
end,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Display hints"),
|
2019-11-05 23:17:28 +00:00
|
|
|
sub_item_table = {
|
|
|
|
{
|
2021-07-23 13:47:02 +00:00
|
|
|
text = _("Show hint for books with description"),
|
|
|
|
checked_func = function() return not BookInfoManager:getSetting("no_hint_description") end,
|
|
|
|
callback = function()
|
|
|
|
if BookInfoManager:getSetting("no_hint_description") then
|
|
|
|
BookInfoManager:saveSetting("no_hint_description", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("no_hint_description", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
2017-08-17 17:34:36 +00:00
|
|
|
},
|
2019-10-22 21:49:04 +00:00
|
|
|
{
|
2023-02-17 20:29:53 +00:00
|
|
|
text = _("Show hint for book status in history"),
|
2021-07-23 13:47:02 +00:00
|
|
|
checked_func = function() return BookInfoManager:getSetting("history_hint_opened") end,
|
|
|
|
callback = function()
|
|
|
|
if BookInfoManager:getSetting("history_hint_opened") then
|
|
|
|
BookInfoManager:saveSetting("history_hint_opened", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("history_hint_opened", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
2019-10-22 21:49:04 +00:00
|
|
|
},
|
|
|
|
{
|
2023-02-17 20:29:53 +00:00
|
|
|
text = _("Show hint for book status in favorites"),
|
2021-07-23 13:47:02 +00:00
|
|
|
checked_func = function() return BookInfoManager:getSetting("collections_hint_opened") end,
|
2019-10-22 21:49:04 +00:00
|
|
|
callback = function()
|
2021-07-23 13:47:02 +00:00
|
|
|
if BookInfoManager:getSetting("collections_hint_opened") then
|
|
|
|
BookInfoManager:saveSetting("collections_hint_opened", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("collections_hint_opened", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Series"),
|
|
|
|
sub_item_table = {
|
|
|
|
{
|
|
|
|
text = _("Append series metadata to authors"),
|
|
|
|
checked_func = function() return series_mode == "append_series_to_authors" end,
|
|
|
|
callback = function()
|
|
|
|
if series_mode == "append_series_to_authors" then
|
|
|
|
series_mode = nil
|
|
|
|
else
|
|
|
|
series_mode = "append_series_to_authors"
|
|
|
|
end
|
|
|
|
BookInfoManager:saveSetting("series_mode", series_mode)
|
|
|
|
self:refreshFileManagerInstance()
|
2019-10-22 21:49:04 +00:00
|
|
|
end,
|
|
|
|
},
|
2019-01-01 08:45:44 +00:00
|
|
|
{
|
2021-07-23 13:47:02 +00:00
|
|
|
text = _("Append series metadata to title"),
|
|
|
|
checked_func = function() return series_mode == "append_series_to_title" end,
|
2019-01-01 08:45:44 +00:00
|
|
|
callback = function()
|
2021-07-23 13:47:02 +00:00
|
|
|
if series_mode == "append_series_to_title" then
|
|
|
|
series_mode = nil
|
2019-01-01 08:45:44 +00:00
|
|
|
else
|
2021-07-23 13:47:02 +00:00
|
|
|
series_mode = "append_series_to_title"
|
2019-01-01 08:45:44 +00:00
|
|
|
end
|
2021-07-23 13:47:02 +00:00
|
|
|
BookInfoManager:saveSetting("series_mode", series_mode)
|
2019-01-01 08:45:44 +00:00
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
|
|
|
},
|
|
|
|
{
|
2021-07-23 13:47:02 +00:00
|
|
|
text = _("Show series metadata in separate line"),
|
|
|
|
checked_func = function() return series_mode == "series_in_separate_line" end,
|
2019-01-01 08:45:44 +00:00
|
|
|
callback = function()
|
2021-07-23 13:47:02 +00:00
|
|
|
if series_mode == "series_in_separate_line" then
|
|
|
|
series_mode = nil
|
2019-01-01 08:45:44 +00:00
|
|
|
else
|
2021-07-23 13:47:02 +00:00
|
|
|
series_mode = "series_in_separate_line"
|
2019-01-01 08:45:44 +00:00
|
|
|
end
|
2021-07-23 13:47:02 +00:00
|
|
|
BookInfoManager:saveSetting("series_mode", series_mode)
|
2019-01-01 08:45:44 +00:00
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
2017-08-25 15:01:18 +00:00
|
|
|
},
|
2017-08-17 17:34:36 +00:00
|
|
|
},
|
2021-07-23 13:47:02 +00:00
|
|
|
separator = true
|
|
|
|
},
|
2022-03-19 10:15:22 +00:00
|
|
|
{
|
|
|
|
text = _("Show progress % in mosaic mode"),
|
|
|
|
checked_func = function() return BookInfoManager:getSetting("show_progress_in_mosaic") end,
|
|
|
|
callback = function()
|
|
|
|
if BookInfoManager:getSetting("show_progress_in_mosaic") then
|
|
|
|
BookInfoManager:saveSetting("show_progress_in_mosaic", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("show_progress_in_mosaic", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
|
|
|
},
|
2021-07-23 13:47:02 +00:00
|
|
|
{
|
|
|
|
text = _("Show number of pages read instead of progress %"),
|
|
|
|
checked_func = function() return BookInfoManager:getSetting("show_pages_read_as_progress") end,
|
|
|
|
callback = function()
|
|
|
|
if BookInfoManager:getSetting("show_pages_read_as_progress") then
|
|
|
|
BookInfoManager:saveSetting("show_pages_read_as_progress", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("show_pages_read_as_progress", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Show number of pages left to read"),
|
|
|
|
checked_func = function() return BookInfoManager:getSetting("show_pages_left_in_progress") end,
|
|
|
|
callback = function()
|
|
|
|
if BookInfoManager:getSetting("show_pages_left_in_progress") then
|
|
|
|
BookInfoManager:saveSetting("show_pages_left_in_progress", false)
|
|
|
|
else
|
|
|
|
BookInfoManager:saveSetting("show_pages_left_in_progress", true)
|
|
|
|
end
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
end,
|
|
|
|
separator = true,
|
2017-08-25 15:01:18 +00:00
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Book info cache management"),
|
|
|
|
sub_item_table = {
|
|
|
|
{
|
|
|
|
text_func = function() -- add current db size to menu text
|
|
|
|
local sstr = BookInfoManager:getDbSize()
|
|
|
|
return _("Current cache size: ") .. sstr
|
|
|
|
end,
|
2021-01-06 22:12:40 +00:00
|
|
|
keep_menu_open = true,
|
|
|
|
callback = function() end, -- no callback, only for information
|
2017-08-25 15:01:18 +00:00
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Prune cache of removed books"),
|
2018-09-04 21:55:58 +00:00
|
|
|
keep_menu_open = true,
|
2017-08-25 15:01:18 +00:00
|
|
|
callback = function()
|
|
|
|
local ConfirmBox = require("ui/widget/confirmbox")
|
|
|
|
UIManager:close(self.file_dialog)
|
|
|
|
UIManager:show(ConfirmBox:new{
|
|
|
|
-- Checking file existences is quite fast, but deleting entries is slow.
|
|
|
|
text = _("Are you sure that you want to prune cache of removed books?\n(This may take a while.)"),
|
|
|
|
ok_text = _("Prune cache"),
|
|
|
|
ok_callback = function()
|
|
|
|
local InfoMessage = require("ui/widget/infomessage")
|
|
|
|
local msg = InfoMessage:new{ text = _("Pruning cache of removed books…") }
|
|
|
|
UIManager:show(msg)
|
|
|
|
UIManager:nextTick(function()
|
|
|
|
local summary = BookInfoManager:removeNonExistantEntries()
|
|
|
|
UIManager:close(msg)
|
|
|
|
UIManager:show( InfoMessage:new{ text = summary } )
|
|
|
|
end)
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
2017-08-25 15:01:18 +00:00
|
|
|
})
|
|
|
|
end,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
text = _("Compact cache database"),
|
2018-09-04 21:55:58 +00:00
|
|
|
keep_menu_open = true,
|
2017-08-25 15:01:18 +00:00
|
|
|
callback = function()
|
|
|
|
local ConfirmBox = require("ui/widget/confirmbox")
|
|
|
|
UIManager:close(self.file_dialog)
|
|
|
|
UIManager:show(ConfirmBox:new{
|
|
|
|
text = _("Are you sure that you want to compact cache database?\n(This may take a while.)"),
|
|
|
|
ok_text = _("Compact database"),
|
|
|
|
ok_callback = function()
|
|
|
|
local InfoMessage = require("ui/widget/infomessage")
|
|
|
|
local msg = InfoMessage:new{ text = _("Compacting cache database…") }
|
|
|
|
UIManager:show(msg)
|
|
|
|
UIManager:nextTick(function()
|
|
|
|
local summary = BookInfoManager:compactDb()
|
|
|
|
UIManager:close(msg)
|
|
|
|
UIManager:show( InfoMessage:new{ text = summary } )
|
|
|
|
end)
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
2017-08-25 15:01:18 +00:00
|
|
|
})
|
|
|
|
end,
|
2017-08-17 17:34:36 +00:00
|
|
|
},
|
2017-08-25 15:01:18 +00:00
|
|
|
{
|
|
|
|
text = _("Delete cache database"),
|
2018-09-04 21:55:58 +00:00
|
|
|
keep_menu_open = true,
|
2017-08-25 15:01:18 +00:00
|
|
|
callback = function()
|
|
|
|
local ConfirmBox = require("ui/widget/confirmbox")
|
|
|
|
UIManager:close(self.file_dialog)
|
|
|
|
UIManager:show(ConfirmBox:new{
|
|
|
|
text = _("Are you sure that you want to delete cover and metadata cache?\n(This will also reset your display mode settings.)"),
|
|
|
|
ok_text = _("Purge"),
|
|
|
|
ok_callback = function()
|
|
|
|
BookInfoManager:deleteDb()
|
|
|
|
end
|
|
|
|
})
|
|
|
|
end,
|
2017-08-17 17:34:36 +00:00
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
2017-08-25 15:01:18 +00:00
|
|
|
},
|
2021-07-23 13:47:02 +00:00
|
|
|
})
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
function CoverBrowser:refreshFileManagerInstance(cleanup, post_init)
|
2017-08-17 17:34:36 +00:00
|
|
|
local fm = FileManager.instance
|
|
|
|
if fm then
|
|
|
|
local fc = fm.file_chooser
|
|
|
|
if cleanup then -- clean instance properties we may have set
|
2022-10-04 11:44:17 +00:00
|
|
|
if fc.showFileDialog_orig then
|
|
|
|
-- remove our showFileDialog that extended file_dialog with new buttons
|
|
|
|
fc.showFileDialog = fc.showFileDialog_orig
|
|
|
|
fc.showFileDialog_orig = nil
|
|
|
|
fc.showFileDialog_ours = nil
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
end
|
2017-10-21 17:55:29 +00:00
|
|
|
if filemanager_display_mode then
|
|
|
|
if post_init then
|
|
|
|
-- FileBrowser was initialized in classic mode, but we changed
|
|
|
|
-- display mode: items per page may have changed, and we want
|
|
|
|
-- to re-position on the focused_file
|
|
|
|
fc:_recalculateDimen()
|
|
|
|
fc:changeToPath(fc.path, fc.prev_focused_path)
|
|
|
|
else
|
|
|
|
fc:updateItems()
|
|
|
|
end
|
2017-08-25 15:01:18 +00:00
|
|
|
else -- classic file_chooser needs this for a full redraw
|
|
|
|
fc:refreshPath()
|
|
|
|
end
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
function CoverBrowser:setupFileManagerDisplayMode(display_mode)
|
|
|
|
if not DISPLAY_MODES[display_mode] then
|
2017-10-21 17:55:29 +00:00
|
|
|
display_mode = nil -- unknow mode, fallback to classic
|
|
|
|
end
|
|
|
|
if init_done and display_mode == filemanager_display_mode then -- no change
|
|
|
|
return
|
|
|
|
end
|
|
|
|
if init_done then -- save new mode in db
|
|
|
|
BookInfoManager:saveSetting("filemanager_display_mode", display_mode)
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
2017-10-21 17:55:29 +00:00
|
|
|
-- remember current mode in module variable
|
|
|
|
filemanager_display_mode = display_mode
|
2017-08-17 17:34:36 +00:00
|
|
|
logger.dbg("CoverBrowser: setting FileManager display mode to:", display_mode or "classic")
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
if not init_done and not display_mode then
|
|
|
|
return -- starting in classic mode, nothing to patch
|
|
|
|
end
|
|
|
|
|
2017-08-17 17:34:36 +00:00
|
|
|
if not display_mode then -- classic mode
|
|
|
|
-- Put back original methods
|
|
|
|
FileChooser.updateItems = _FileChooser_updateItems_orig
|
|
|
|
FileChooser.onCloseWidget = _FileChooser_onCloseWidget_orig
|
|
|
|
FileChooser._recalculateDimen = _FileChooser__recalculateDimen_orig
|
2018-03-14 17:14:52 +00:00
|
|
|
FileManager.tapPlus = _FileManager_tapPlus_orig
|
2017-08-17 17:34:36 +00:00
|
|
|
-- Also clean-up what we added, even if it does not bother original code
|
|
|
|
FileChooser._updateItemsBuildUI = nil
|
|
|
|
FileChooser._do_cover_images = nil
|
|
|
|
FileChooser._do_filename_only = nil
|
|
|
|
FileChooser._do_hint_opened = nil
|
2019-11-25 13:31:50 +00:00
|
|
|
FileChooser._do_center_partial_rows = nil
|
2017-08-17 17:34:36 +00:00
|
|
|
self:refreshFileManagerInstance(true)
|
|
|
|
return
|
|
|
|
end
|
|
|
|
|
|
|
|
-- In both mosaic and list modes, replace original methods with those from
|
|
|
|
-- our generic CoverMenu
|
|
|
|
local CoverMenu = require("covermenu")
|
2023-02-10 06:45:01 +00:00
|
|
|
FileChooser.updateCache = CoverMenu.updateCache
|
2017-08-17 17:34:36 +00:00
|
|
|
FileChooser.updateItems = CoverMenu.updateItems
|
|
|
|
FileChooser.onCloseWidget = CoverMenu.onCloseWidget
|
|
|
|
|
|
|
|
if display_mode == "mosaic_image" or display_mode == "mosaic_text" then -- mosaic mode
|
|
|
|
-- Replace some other original methods with those from our MosaicMenu
|
|
|
|
local MosaicMenu = require("mosaicmenu")
|
|
|
|
FileChooser._recalculateDimen = MosaicMenu._recalculateDimen
|
|
|
|
FileChooser._updateItemsBuildUI = MosaicMenu._updateItemsBuildUI
|
|
|
|
-- Set MosaicMenu behaviour:
|
|
|
|
FileChooser._do_cover_images = display_mode ~= "mosaic_text"
|
|
|
|
FileChooser._do_hint_opened = true -- dogear at bottom
|
2019-11-25 13:31:50 +00:00
|
|
|
-- Don't have "../" centered in empty directories
|
|
|
|
FileChooser._do_center_partial_rows = false
|
2017-08-17 17:34:36 +00:00
|
|
|
-- One could override default 3x3 grid here (put that as settings ?)
|
|
|
|
-- FileChooser.nb_cols_portrait = 4
|
|
|
|
-- FileChooser.nb_rows_portrait = 4
|
|
|
|
-- FileChooser.nb_cols_landscape = 6
|
|
|
|
-- FileChooser.nb_rows_landscape = 3
|
|
|
|
|
|
|
|
elseif display_mode == "list_image_meta" or display_mode == "list_only_meta" or
|
|
|
|
display_mode == "list_image_filename" then -- list modes
|
|
|
|
-- Replace some other original methods with those from our ListMenu
|
|
|
|
local ListMenu = require("listmenu")
|
|
|
|
FileChooser._recalculateDimen = ListMenu._recalculateDimen
|
|
|
|
FileChooser._updateItemsBuildUI = ListMenu._updateItemsBuildUI
|
|
|
|
-- Set ListMenu behaviour:
|
|
|
|
FileChooser._do_cover_images = display_mode ~= "list_only_meta"
|
|
|
|
FileChooser._do_filename_only = display_mode == "list_image_filename"
|
|
|
|
FileChooser._do_hint_opened = true -- dogear at bottom
|
|
|
|
end
|
|
|
|
|
2019-11-25 13:31:50 +00:00
|
|
|
|
2018-03-14 17:14:52 +00:00
|
|
|
-- Replace this FileManager method with the one from CoverMenu
|
|
|
|
-- (but first, make the original method saved here as local available
|
|
|
|
-- to CoverMenu)
|
|
|
|
CoverMenu._FileManager_tapPlus_orig = _FileManager_tapPlus_orig
|
|
|
|
FileManager.tapPlus = CoverMenu.tapPlus
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
if init_done then
|
|
|
|
self:refreshFileManagerInstance()
|
|
|
|
else
|
|
|
|
-- If KOReader has started directly to FileManager, the FileManager
|
|
|
|
-- instance is being init()'ed and there is no FileManager.instance yet,
|
|
|
|
-- but there'll be one at next tick.
|
|
|
|
UIManager:nextTick(function()
|
|
|
|
self:refreshFileManagerInstance(false, true)
|
|
|
|
end)
|
|
|
|
end
|
|
|
|
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
local function _FileManagerHistory_updateItemTable(self)
|
|
|
|
-- 'self' here is the single FileManagerHistory instance
|
|
|
|
-- FileManagerHistory has just created a new instance of Menu as 'hist_menu'
|
|
|
|
-- at each display of History. Soon after instantiation, this method
|
|
|
|
-- is called. The first time it is called, we replace some methods.
|
|
|
|
local display_mode = self.display_mode
|
|
|
|
local hist_menu = self.hist_menu
|
|
|
|
|
|
|
|
if not hist_menu._coverbrowser_overridden then
|
|
|
|
hist_menu._coverbrowser_overridden = true
|
|
|
|
|
|
|
|
-- In both mosaic and list modes, replace original methods with those from
|
|
|
|
-- our generic CoverMenu
|
|
|
|
local CoverMenu = require("covermenu")
|
2023-02-10 06:45:01 +00:00
|
|
|
hist_menu.updateCache = CoverMenu.updateCache
|
2017-08-17 17:34:36 +00:00
|
|
|
hist_menu.updateItems = CoverMenu.updateItems
|
|
|
|
hist_menu.onCloseWidget = CoverMenu.onCloseWidget
|
|
|
|
-- Also replace original onMenuHold (it will use original method, so remember it)
|
|
|
|
hist_menu.onMenuHold_orig = hist_menu.onMenuHold
|
|
|
|
hist_menu.onMenuHold = CoverMenu.onHistoryMenuHold
|
|
|
|
|
|
|
|
if display_mode == "mosaic_image" or display_mode == "mosaic_text" then -- mosaic mode
|
|
|
|
-- Replace some other original methods with those from our MosaicMenu
|
|
|
|
local MosaicMenu = require("mosaicmenu")
|
|
|
|
hist_menu._recalculateDimen = MosaicMenu._recalculateDimen
|
|
|
|
hist_menu._updateItemsBuildUI = MosaicMenu._updateItemsBuildUI
|
|
|
|
-- Set MosaicMenu behaviour:
|
|
|
|
hist_menu._do_cover_images = display_mode ~= "mosaic_text"
|
2019-11-25 13:31:50 +00:00
|
|
|
hist_menu._do_center_partial_rows = true -- nicer looking when few elements
|
2017-08-17 17:34:36 +00:00
|
|
|
|
|
|
|
elseif display_mode == "list_image_meta" or display_mode == "list_only_meta" or
|
|
|
|
display_mode == "list_image_filename" then -- list modes
|
|
|
|
-- Replace some other original methods with those from our ListMenu
|
|
|
|
local ListMenu = require("listmenu")
|
|
|
|
hist_menu._recalculateDimen = ListMenu._recalculateDimen
|
|
|
|
hist_menu._updateItemsBuildUI = ListMenu._updateItemsBuildUI
|
|
|
|
-- Set ListMenu behaviour:
|
|
|
|
hist_menu._do_cover_images = display_mode ~= "list_only_meta"
|
|
|
|
hist_menu._do_filename_only = display_mode == "list_image_filename"
|
|
|
|
|
|
|
|
end
|
|
|
|
hist_menu._do_hint_opened = BookInfoManager:getSetting("history_hint_opened")
|
|
|
|
end
|
|
|
|
|
2017-09-22 16:24:38 +00:00
|
|
|
-- And do now what the original does
|
|
|
|
_FileManagerHistory_updateItemTable_orig(self)
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
function CoverBrowser:setupHistoryDisplayMode(display_mode)
|
|
|
|
if not DISPLAY_MODES[display_mode] then
|
2017-10-21 17:55:29 +00:00
|
|
|
display_mode = nil -- unknow mode, fallback to classic
|
2017-08-17 17:34:36 +00:00
|
|
|
end
|
2017-10-21 17:55:29 +00:00
|
|
|
if init_done and display_mode == history_display_mode then -- no change
|
|
|
|
return
|
|
|
|
end
|
|
|
|
if init_done then -- save new mode in db
|
|
|
|
BookInfoManager:saveSetting("history_display_mode", display_mode)
|
|
|
|
end
|
|
|
|
-- remember current mode in module variable
|
|
|
|
history_display_mode = display_mode
|
2017-08-17 17:34:36 +00:00
|
|
|
logger.dbg("CoverBrowser: setting History display mode to:", display_mode or "classic")
|
|
|
|
|
2017-10-21 17:55:29 +00:00
|
|
|
if not init_done and not display_mode then
|
|
|
|
return -- starting in classic mode, nothing to patch
|
|
|
|
end
|
|
|
|
|
2017-08-17 17:34:36 +00:00
|
|
|
-- We only need to replace one FileManagerHistory method
|
|
|
|
if not display_mode then -- classic mode
|
|
|
|
-- Put back original methods
|
|
|
|
FileManagerHistory.updateItemTable = _FileManagerHistory_updateItemTable_orig
|
|
|
|
FileManagerHistory.display_mode = nil
|
|
|
|
else
|
|
|
|
-- Replace original method with the one defined above
|
|
|
|
FileManagerHistory.updateItemTable = _FileManagerHistory_updateItemTable
|
|
|
|
-- And let it know which display_mode we should use
|
|
|
|
FileManagerHistory.display_mode = display_mode
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-11-05 23:17:28 +00:00
|
|
|
local function _FileManagerCollections_updateItemTable(self)
|
|
|
|
-- 'self' here is the single FileManagerCollections instance
|
|
|
|
-- FileManagerCollections has just created a new instance of Menu as 'coll_menu'
|
|
|
|
-- at each display of Collection/Favorites. Soon after instantiation, this method
|
|
|
|
-- is called. The first time it is called, we replace some methods.
|
|
|
|
local display_mode = self.display_mode
|
|
|
|
local coll_menu = self.coll_menu
|
|
|
|
|
|
|
|
if not coll_menu._coverbrowser_overridden then
|
|
|
|
coll_menu._coverbrowser_overridden = true
|
|
|
|
|
|
|
|
-- In both mosaic and list modes, replace original methods with those from
|
|
|
|
-- our generic CoverMenu
|
|
|
|
local CoverMenu = require("covermenu")
|
2023-02-10 06:45:01 +00:00
|
|
|
coll_menu.updateCache = CoverMenu.updateCache
|
2019-11-05 23:17:28 +00:00
|
|
|
coll_menu.updateItems = CoverMenu.updateItems
|
|
|
|
coll_menu.onCloseWidget = CoverMenu.onCloseWidget
|
|
|
|
-- Also replace original onMenuHold (it will use original method, so remember it)
|
|
|
|
coll_menu.onMenuHold_orig = coll_menu.onMenuHold
|
|
|
|
coll_menu.onMenuHold = CoverMenu.onCollectionsMenuHold
|
|
|
|
|
|
|
|
if display_mode == "mosaic_image" or display_mode == "mosaic_text" then -- mosaic mode
|
|
|
|
-- Replace some other original methods with those from our MosaicMenu
|
|
|
|
local MosaicMenu = require("mosaicmenu")
|
|
|
|
coll_menu._recalculateDimen = MosaicMenu._recalculateDimen
|
|
|
|
coll_menu._updateItemsBuildUI = MosaicMenu._updateItemsBuildUI
|
|
|
|
-- Set MosaicMenu behaviour:
|
|
|
|
coll_menu._do_cover_images = display_mode ~= "mosaic_text"
|
2019-11-25 13:31:50 +00:00
|
|
|
coll_menu._do_center_partial_rows = true -- nicer looking when few elements
|
2019-11-05 23:17:28 +00:00
|
|
|
|
|
|
|
elseif display_mode == "list_image_meta" or display_mode == "list_only_meta" or
|
|
|
|
display_mode == "list_image_filename" then -- list modes
|
|
|
|
-- Replace some other original methods with those from our ListMenu
|
|
|
|
local ListMenu = require("listmenu")
|
|
|
|
coll_menu._recalculateDimen = ListMenu._recalculateDimen
|
|
|
|
coll_menu._updateItemsBuildUI = ListMenu._updateItemsBuildUI
|
|
|
|
-- Set ListMenu behaviour:
|
|
|
|
coll_menu._do_cover_images = display_mode ~= "list_only_meta"
|
|
|
|
coll_menu._do_filename_only = display_mode == "list_image_filename"
|
|
|
|
|
|
|
|
end
|
|
|
|
coll_menu._do_hint_opened = BookInfoManager:getSetting("collections_hint_opened")
|
|
|
|
end
|
|
|
|
|
|
|
|
-- And do now what the original does
|
|
|
|
_FileManagerCollection_updateItemTable_orig(self)
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
function CoverBrowser:setupCollectionDisplayMode(display_mode)
|
|
|
|
if not DISPLAY_MODES[display_mode] then
|
|
|
|
display_mode = nil -- unknow mode, fallback to classic
|
|
|
|
end
|
|
|
|
if init_done and display_mode == collection_display_mode then -- no change
|
|
|
|
return
|
|
|
|
end
|
|
|
|
if init_done then -- save new mode in db
|
|
|
|
BookInfoManager:saveSetting("collection_display_mode", display_mode)
|
|
|
|
end
|
|
|
|
-- remember current mode in module variable
|
|
|
|
collection_display_mode = display_mode
|
|
|
|
logger.dbg("CoverBrowser: setting Collection display mode to:", display_mode or "classic")
|
|
|
|
|
|
|
|
if not init_done and not display_mode then
|
|
|
|
return -- starting in classic mode, nothing to patch
|
|
|
|
end
|
|
|
|
|
|
|
|
-- We only need to replace one FileManagerCollection method
|
|
|
|
if not display_mode then -- classic mode
|
|
|
|
-- Put back original methods
|
|
|
|
FileManagerCollection.updateItemTable = _FileManagerCollection_updateItemTable_orig
|
|
|
|
FileManagerCollection.display_mode = nil
|
|
|
|
else
|
|
|
|
-- Replace original method with the one defined above
|
|
|
|
FileManagerCollection.updateItemTable = _FileManagerCollections_updateItemTable
|
|
|
|
-- And let it know which display_mode we should use
|
|
|
|
FileManagerCollection.display_mode = display_mode
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2023-03-28 13:16:53 +00:00
|
|
|
function CoverBrowser:getBookInfo(file)
|
|
|
|
return BookInfoManager:getBookInfo(file)
|
|
|
|
end
|
|
|
|
|
2023-05-03 12:43:05 +00:00
|
|
|
function CoverBrowser:deleteBookInfo(file)
|
|
|
|
BookInfoManager:deleteBookInfo(file)
|
|
|
|
end
|
|
|
|
|
2023-03-28 13:16:53 +00:00
|
|
|
function CoverBrowser:extractBooksInDirectory(path)
|
|
|
|
local Trapper = require("ui/trapper")
|
|
|
|
Trapper:wrap(function()
|
|
|
|
BookInfoManager:extractBooksInDirectory(path)
|
|
|
|
end)
|
|
|
|
end
|
|
|
|
|
2017-08-17 17:34:36 +00:00
|
|
|
return CoverBrowser
|