2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
koreader/plugins/statistics.koplugin/readerprogress.lua

516 lines
18 KiB
Lua
Raw Normal View History

2017-04-29 08:38:09 +00:00
local Blitbuffer = require("ffi/blitbuffer")
local CenterContainer = require("ui/widget/container/centercontainer")
local Device = require("device")
2017-04-29 08:38:09 +00:00
local Font = require("ui/font")
local FrameContainer = require("ui/widget/container/framecontainer")
2017-08-29 15:34:49 +00:00
local Geom = require("ui/geometry")
local GestureRange = require("ui/gesturerange")
local HorizontalGroup = require("ui/widget/horizontalgroup")
local HorizontalSpan = require("ui/widget/horizontalspan")
2017-04-29 08:38:09 +00:00
local InputContainer = require("ui/widget/container/inputcontainer")
local LeftContainer = require("ui/widget/container/leftcontainer")
local LineWidget = require("ui/widget/linewidget")
2017-04-29 08:38:09 +00:00
local ProgressWidget = require("ui/widget/progresswidget")
2017-09-13 14:56:20 +00:00
local Size = require("ui/size")
local TextWidget = require("ui/widget/textwidget")
local TextBoxWidget = require("ui/widget/textboxwidget")
2022-02-02 15:18:43 +00:00
local TitleBar = require("ui/widget/titlebar")
local UIManager = require("ui/uimanager")
2017-04-29 08:38:09 +00:00
local VerticalGroup = require("ui/widget/verticalgroup")
local VerticalSpan = require("ui/widget/verticalspan")
local util = require("util")
2017-04-29 08:38:09 +00:00
local _ = require("gettext")
local Screen = Device.screen
local LINE_COLOR = Blitbuffer.COLOR_WEB_GRAY
local BG_COLOR = Blitbuffer.COLOR_LIGHT_GRAY
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
-- Oh, hey, this one actually *is* an InputContainer!
local ReaderProgress = InputContainer:extend{
2017-09-13 14:56:20 +00:00
padding = Size.padding.fullscreen,
}
local dayOfWeekTranslation = {
["Monday"] = _("Monday"),
["Tuesday"] = _("Tuesday"),
["Wednesday"] = _("Wednesday"),
["Thursday"] = _("Thursday"),
["Friday"] = _("Friday"),
["Saturday"] = _("Saturday"),
["Sunday"] = _("Sunday"),
}
function ReaderProgress:init()
self.current_pages = tostring(self.current_pages)
self.today_pages = tostring(self.today_pages)
2017-04-29 08:38:09 +00:00
self.small_font_face = Font:getFace("smallffont")
self.medium_font_face = Font:getFace("ffont")
self.large_font_face = Font:getFace("largeffont")
2017-09-13 14:56:20 +00:00
self.screen_width = Screen:getWidth()
self.screen_height = Screen:getHeight()
if self.screen_width < self.screen_height then
self.header_span = 25
self.stats_span = 20
else
self.header_span = 0
self.stats_span = 10
end
UIManager:setDirty(self, function()
return "ui", self.dimen
end)
if Device:hasKeys() then
self.key_events = {
--don't get locked in on non touch devices
AnyKeyPressed = { { Device.input.group.Any },
seqtext = "any key", doc = "close dialog" }
}
end
if Device:isTouchDevice() then
self.ges_events.Swipe = {
GestureRange:new{
ges = "swipe",
range = function() return self.dimen end,
}
}
self.ges_events.MultiSwipe = {
GestureRange:new{
ges = "multiswipe",
range = function() return self.dimen end,
}
}
end
Revamp "flash_ui" handling (#7118) * Wherever possible, do an actual dumb invert on the Screen BB instead of repainting the widget, *then* inverting it (which is what the "invert" flag does). * Instead of playing with nextTick/tickAfterNext delays, explicitly fence stuff with forceRePaint * And, in the few cases where said Mk. 7 quirk kicks in, make the fences more marked by using a well-placed WAIT_FOR_UPDATE_COMPLETE * Fix an issue in Button where show/hide & enable/disable where actually all toggles, which meant that duplicate calls or timing issues would do the wrong thing. (This broke dimming some icons, and mistakenly dropped the background from FM chevrons, for example). * Speaking of, fix Button's hide/show to actually restore the background properly (there was a stupid typo in the variable name) * Still in Button, fix the insanity of the double repaint on rounded buttons. Turns out it made sense, after all (and was related to said missing background, and bad interaction with invert & text with no background). * KeyValuePage suffered from a similar issue with broken highlights (all black) because of missing backgrounds. * In ConfigDialog, only instanciate IconButtons once (because every tab switch causes a full instantiation; and the initial display implies a full instanciation and an initial tab switch). Otherwise, both instances linger, and catch taps, and as such, double highlights. * ConfigDialog: Restore the "don't repaint ReaderUI" when switching between similarly sized tabs (re #6131). I never could reproduce that on eInk, and I can't now on the emulator, so I'm assuming @poire-z fixed it during the swap to SVG icons. * KeyValuePage: Only instanciate Buttons once (again, this is a widget that goes through a full init every page). Again, caused highlight/dimming issues because buttons were stacked. * Menu: Ditto. * TouchMenu: Now home of the gnarliest unhilight heuristics, because of the sheer amount of different things that can happen (and/or thanks to stuff not flagged covers_fullscreen properly ;p). * Bump base https://github.com/koreader/koreader-base/pull/1280 https://github.com/koreader/koreader-base/pull/1282 https://github.com/koreader/koreader-base/pull/1283 https://github.com/koreader/koreader-base/pull/1284 * Bump android-luajit-launcher https://github.com/koreader/android-luajit-launcher/pull/284 https://github.com/koreader/android-luajit-launcher/pull/285 https://github.com/koreader/android-luajit-launcher/pull/286 https://github.com/koreader/android-luajit-launcher/pull/287
2021-01-10 00:51:09 +00:00
self.covers_fullscreen = true -- hint for UIManager:_repaint()
self[1] = FrameContainer:new{
width = self.width,
height = self.height,
background = Blitbuffer.COLOR_WHITE,
bordersize = 0,
padding = 0,
self:getStatusContent(self.screen_width),
}
end
2017-08-29 15:34:49 +00:00
function ReaderProgress:getTotalStats(stats_day)
local total_time = 0
local total_pages = 0
2017-08-29 15:34:49 +00:00
for i=1, stats_day do
total_pages = total_pages + self.dates[i][1]
total_time = total_time + self.dates[i][2]
end
return total_time, total_pages
end
function ReaderProgress:getStatusContent(width)
2022-02-02 15:18:43 +00:00
local title_bar = TitleBar:new{
width = width,
bottom_v_padding = 0,
close_callback = not self.readonly and function() self:onClose() end,
show_parent = self,
}
return VerticalGroup:new{
align = "left",
2022-02-02 15:18:43 +00:00
title_bar,
self:genSingleHeader(_("Last week")),
self:genSummaryWeek(width),
self:genSingleHeader(_("Week progress")),
self:genWeekStats(7),
self:genDoubleHeader(_("Current"), _("Today") ),
self:genSummaryDay(width),
}
end
function ReaderProgress:genSingleHeader(title)
local header_title = TextWidget:new{
text = title,
face = self.medium_font_face,
fgcolor = LINE_COLOR,
}
local padding_span = HorizontalSpan:new{ width = self.padding }
local line_width = (self.screen_width - header_title:getSize().w) / 2 - self.padding * 2
local line_container = LeftContainer:new{
dimen = Geom:new{ w = line_width, h = self.screen_height * (1/25) },
LineWidget:new{
background = BG_COLOR,
dimen = Geom:new{
w = line_width,
2017-09-13 14:56:20 +00:00
h = Size.line.thick,
}
}
}
return VerticalGroup:new{
VerticalSpan:new{ width = Screen:scaleBySize(self.header_span), height = self.screen_height * (1/25) },
HorizontalGroup:new{
align = "center",
padding_span,
line_container,
padding_span,
header_title,
padding_span,
line_container,
padding_span,
},
VerticalSpan:new{ width = Size.span.vertical_large, height = self.screen_height * (1/25) },
}
end
function ReaderProgress:genDoubleHeader(title_left, title_right)
local header_title_left = TextWidget:new{
text = title_left,
face = self.medium_font_face,
fgcolor = LINE_COLOR,
}
local header_title_right = TextWidget:new{
text = title_right,
face = self.medium_font_face,
fgcolor = LINE_COLOR,
}
local padding_span = HorizontalSpan:new{ width = self.padding }
local line_width = (self.screen_width - header_title_left:getSize().w - header_title_right:getSize().w - self.padding * 7) / 4
local line_container = LeftContainer:new{
dimen = Geom:new{ w = line_width, h = self.screen_height * (1/25) },
LineWidget:new{
background = BG_COLOR,
dimen = Geom:new{
w = line_width,
2017-09-13 14:56:20 +00:00
h = Size.line.thick,
}
}
}
return VerticalGroup:new{
VerticalSpan:new{ width = Screen:scaleBySize(25), height = self.screen_height * (1/25) },
HorizontalGroup:new{
align = "center",
padding_span,
line_container,
padding_span,
header_title_left,
padding_span,
line_container,
padding_span,
line_container,
padding_span,
header_title_right,
padding_span,
line_container,
padding_span,
},
VerticalSpan:new{ width = Size.span.vertical_large, height = self.screen_height * (1/25) },
}
end
function ReaderProgress:genWeekStats(stats_day)
local second_in_day = 86400
local date_format_show
local select_day_time
local diff_time
local now_time = os.time()
local user_duration_format = G_reader_settings:readSetting("duration_format")
local height = Screen:scaleBySize(60)
local statistics_container = CenterContainer:new{
dimen = Geom:new{ w = self.screen_width , h = height },
}
local statistics_group = VerticalGroup:new{ align = "left" }
local max_week_time = -1
2017-08-29 15:34:49 +00:00
local day_time
for i=1, stats_day do
day_time = self.dates[i][2]
if day_time > max_week_time then max_week_time = day_time end
end
local top_padding_span = HorizontalSpan:new{ width = Screen:scaleBySize(15) }
local top_span_group = HorizontalGroup:new{
align = "center",
LeftContainer:new{
dimen = Geom:new{ h = Screen:scaleBySize(30) },
top_padding_span
},
}
table.insert(statistics_group, top_span_group)
local padding_span = HorizontalSpan:new{ width = Screen:scaleBySize(15) }
local span_group = HorizontalGroup:new{
align = "center",
LeftContainer:new{
dimen = Geom:new{ h = Screen:scaleBySize(self.stats_span) },
padding_span
},
}
2017-08-29 15:34:49 +00:00
local j = 1
for i = 1, stats_day do
diff_time = now_time - second_in_day * (i - 1)
2017-08-29 15:34:49 +00:00
if self.dates[j][3] == os.date("%Y-%m-%d", diff_time) then
select_day_time = self.dates[j][2]
j = j + 1
else
select_day_time = 0
end
date_format_show = dayOfWeekTranslation[os.date("%A", diff_time)] .. os.date(" (%d.%m)", diff_time)
local total_group = HorizontalGroup:new{
align = "center",
2017-09-13 14:56:20 +00:00
padding = Size.padding.small,
LeftContainer:new{
dimen = Geom:new{ w = self.screen_width , h = height * (1/3) },
TextWidget:new{
2017-09-13 14:56:20 +00:00
padding = Size.padding.small,
text = date_format_show .. " - " .. util.secondsToClockDuration(user_duration_format, select_day_time, true),
2017-04-29 08:38:09 +00:00
face = Font:getFace("smallffont"),
},
},
}
local titles_group = HorizontalGroup:new{
align = "center",
LeftContainer:new{
dimen = Geom:new{ w = self.screen_width , h = height * (1/3) },
ProgressWidget:new{
width = math.floor((self.screen_width * 0.005) + (self.screen_width * 0.9 * select_day_time / max_week_time)),
height = Screen:scaleBySize(14),
percentage = 1.0,
ticks = nil,
last = nil,
margin_h = 0,
margin_v = 0,
}
},
}
table.insert(statistics_group, total_group)
table.insert(statistics_group, titles_group)
table.insert(statistics_group, span_group)
end --for i=1
table.insert(statistics_container, statistics_group)
return CenterContainer:new{
dimen = Geom:new{ w = math.floor(self.screen_width * 1.1), h = math.floor(self.screen_height * 0.5) },
statistics_container,
}
end
function ReaderProgress:genSummaryDay(width)
local height = Screen:scaleBySize(60)
local statistics_container = CenterContainer:new{
dimen = Geom:new{ w = width, h = height },
}
local statistics_group = VerticalGroup:new{ align = "left" }
local tile_width = width * (1/4)
local tile_height = height * (1/3)
local user_duration_format = G_reader_settings:readSetting("duration_format")
local titles_group = HorizontalGroup:new{
align = "center",
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = _("Pages"),
face = self.small_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = _("Time"),
face = self.small_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = _("Pages"),
face = self.small_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = _("Time"),
face = self.small_font_face,
},
},
}
local padding_span = HorizontalSpan:new{ width = Screen:scaleBySize(15) }
local span_group = HorizontalGroup:new{
align = "center",
LeftContainer:new{
2017-09-13 14:56:20 +00:00
dimen = Geom:new{ h = Size.span.horizontal_default },
padding_span
},
}
local data_group = HorizontalGroup:new{
align = "center",
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = self.current_pages,
face = self.medium_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = util.secondsToClockDuration(user_duration_format, self.current_duration, true),
face = self.medium_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
2017-08-29 15:34:49 +00:00
text = self.today_pages,
face = self.medium_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = util.secondsToClockDuration(user_duration_format, self.today_duration, true),
face = self.medium_font_face,
},
},
}
table.insert(statistics_group, titles_group)
table.insert(statistics_group, span_group)
table.insert(statistics_group, data_group)
table.insert(statistics_group, span_group)
table.insert(statistics_group, span_group)
table.insert(statistics_container, statistics_group)
return CenterContainer:new{
dimen = Geom:new{ w = self.screen_width , h = math.floor(self.screen_height * 0.13) },
statistics_container,
}
end
function ReaderProgress:genSummaryWeek(width)
local height = Screen:scaleBySize(60)
2017-08-29 15:34:49 +00:00
local total_time, total_pages = self:getTotalStats(#self.dates)
local statistics_container = CenterContainer:new{
dimen = Geom:new{ w = width, h = height },
}
local statistics_group = VerticalGroup:new{ align = "left" }
local tile_width = width * (1/4)
local tile_height = height * (1/3)
local user_duration_format = G_reader_settings:readSetting("duration_format")
local total_group = HorizontalGroup:new{
align = "center",
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextBoxWidget:new{
alignment = "center",
text = _("Total\npages"),
face = self.small_font_face,
width = tile_width * 0.95,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextBoxWidget:new{
alignment = "center",
text = _("Total\ntime"),
face = self.small_font_face,
width = tile_width * 0.95,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextBoxWidget:new{
alignment = "center",
text = _("Average\npages"),
face = self.small_font_face,
width = tile_width * 0.95,
}
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextBoxWidget:new{
alignment = "center",
text = _("Average\ntime"),
face = self.small_font_face,
width = tile_width * 0.95,
}
}
}
local padding_span = HorizontalSpan:new{ width = Screen:scaleBySize(15) }
local span_group = HorizontalGroup:new{
align = "center",
LeftContainer:new{
2017-09-13 14:56:20 +00:00
dimen = Geom:new{ h = Size.span.horizontal_default },
padding_span
},
}
local data_group = HorizontalGroup:new{
align = "center",
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = tostring(total_pages),
face = self.medium_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = util.secondsToClockDuration(user_duration_format, math.floor(total_time), true),
face = self.medium_font_face,
},
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = tostring(math.floor(total_pages * (1/7))),
face = self.medium_font_face,
}
},
CenterContainer:new{
dimen = Geom:new{ w = tile_width, h = tile_height },
TextWidget:new{
text = util.secondsToClockDuration(user_duration_format, math.floor(total_time) * (1/7), true),
face = self.medium_font_face,
}
}
}
table.insert(statistics_group, total_group)
table.insert(statistics_group, span_group)
table.insert(statistics_group, data_group)
table.insert(statistics_container, statistics_group)
return CenterContainer:new{
dimen = Geom:new{ w = self.screen_width , h = math.floor(self.screen_height * 0.10) },
statistics_container,
}
end
function ReaderProgress:onAnyKeyPressed()
return self:onClose()
end
function ReaderProgress:onSwipe(arg, ges_ev)
if ges_ev.direction == "south" then
-- Allow easier closing with swipe up/down
self:onClose()
elseif ges_ev.direction == "east" or ges_ev.direction == "west" or ges_ev.direction == "north" then
-- no use for now
do end -- luacheck: ignore 541
else -- diagonal swipe
-- trigger full refresh
UIManager:setDirty(nil, "full")
-- a long diagonal swipe may also be used for taking a screenshot,
-- so let it propagate
return false
end
end
function ReaderProgress:onMultiSwipe(arg, ges_ev)
-- For consistency with other fullscreen widgets where swipe south can't be
-- used to close and where we then allow any multiswipe to close, allow any
-- multiswipe to close this widget too.
self:onClose()
return true
end
function ReaderProgress:onClose()
UIManager:close(self)
return true
end
return ReaderProgress