Archives/koreader
2
0
Fork 0
mirror of https://github.com/koreader/koreader synced 2024-11-13 19:11:25 +00:00
Code Issues Projects Releases Wiki Activity

Statistics: fix null terminated strings, add toggle stats (#12547)

Browse Source 
(1) Followup to koreader/koreader-base#1921, #12503: when getting a pdf book id in the stats db, check for old records with null terminated authors and title.
Discussed in #11318. There are some other reasons for disappearing old stats for pdf (md5 changes when converting/writing to pdf or something else), hence not closing the issue.
(2) Add Dispatcher action for toggling statistics. Closes #11422.
This commit is contained in:
hius07 2024-09-23 21:46:20 +03:00 committed by GitHub
parent ca569c1355
commit e15c1abe8b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 57 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
plugins/statistics.koplugin/main.lua
View File

@ -94,6 +94,7 @@ ReaderStatistics.default_settings = {
}
function ReaderStatistics:onDispatcherRegisterActions()
Dispatcher:registerAction("toggle_statistics", {category="none", event="ToggleStatistics", title=_("Toggle statistics"), general=true})
Dispatcher:registerAction("stats_calendar_view", {category="none", event="ShowCalendarView", title=_("Statistics calendar view"), general=true})
Dispatcher:registerAction("stats_calendar_day_view", {category="none", event="ShowCalendarDayView", title=_("Statistics today's timeline"), general=true})
Dispatcher:registerAction("stats_sync", {category="none", event="SyncBookStats", title=_("Synchronize book statistics"), general=true, separator=true})
@ -613,8 +614,8 @@ function ReaderStatistics:addBookStatToDB(book_stats, conn)
SELECT count(id)
FROM book
WHERE title = ?
AND authors = ?
AND md5 = ?;
AND authors = ?
AND md5 = ?;
]]
local stmt = conn:prepare(sql_stmt)
local result = stmt:reset():bind(self.data.title, self.data.authors, self.doc_md5):step()
@ -634,8 +635,8 @@ function ReaderStatistics:addBookStatToDB(book_stats, conn)
SELECT id
FROM book
WHERE title = ?
AND authors = ?
AND md5 = ?;
AND authors = ?
AND md5 = ?;
]]
stmt = conn:prepare(sql_stmt)
result = stmt:reset():bind(self.data.title, self.data.authors, self.doc_md5):step()
@ -753,12 +754,30 @@ function ReaderStatistics:getIdBookDB()
SELECT count(id)
FROM book
WHERE title = ?
AND authors = ?
AND md5 = ?;
AND authors = ?
AND md5 = ?;
]]
local stmt = conn:prepare(sql_stmt)
local result = stmt:reset():bind(self.data.title, self.data.authors, self.doc_md5):step()
local title, authors = self.data.title, self.data.authors
local result = stmt:reset():bind(title, authors, self.doc_md5):step()
local nr_id = tonumber(result[1])
if nr_id == 0 and self.ui.paging then
-- In the past, title and/or authors strings, got from MuPDF, may have been or not null terminated.
-- We need to check with all combinations if a book with these null terminated exists, and use it.
title = title .. "\0"
result = stmt:reset():bind(title, authors, self.doc_md5):step()
nr_id = tonumber(result[1])
if nr_id == 0 then
authors = authors .. "\0"
result = stmt:reset():bind(title, authors, self.doc_md5):step()
nr_id = tonumber(result[1])
if nr_id == 0 then
title = self.data.title
result = stmt:reset():bind(title, authors, self.doc_md5):step()
nr_id = tonumber(result[1])
end
end
end
if nr_id == 0 then
if not self.is_doc_not_frozen then return end
-- Not in the DB yet, initialize it
@ -775,11 +794,11 @@ function ReaderStatistics:getIdBookDB()
SELECT id
FROM book
WHERE title = ?
AND authors = ?
AND md5 = ?;
AND authors = ?
AND md5 = ?;
]]
stmt = conn:prepare(sql_stmt)
result = stmt:reset():bind(self.data.title, self.data.authors, self.doc_md5):step()
result = stmt:reset():bind(title, authors, self.doc_md5):step()
id_book = result[1]
end
stmt:close()
@ -1027,37 +1046,39 @@ function ReaderStatistics:getPageTimeTotalStats(id_book)
return total_pages, total_time
end
function ReaderStatistics:getStatisticEnabledMenuItem()
return {
text = _("Enabled"),
checked_func = function() return self.settings.is_enabled end,
callback = function()
-- if was enabled, have to save data to file
if self.settings.is_enabled then
self:insertDB()
end
self.settings.is_enabled = not self.settings.is_enabled
-- if was disabled have to get data from db
if self:isEnabled() then
self:initData()
self.start_current_period = os.time()
self.curr_page = self.ui:getCurrentPage()
self:resetVolatileStats(self.start_current_period)
end
if self.is_doc then
self.view.footer:onUpdateFooter()
end
end,
}
function ReaderStatistics:onToggleStatistics(no_notification)
if self.settings.is_enabled then -- save data to file
self:insertDB()
end
self.settings.is_enabled = not self.settings.is_enabled
if self.is_doc then
if self.settings.is_enabled then
self:initData()
self.start_current_period = os.time()
self.curr_page = self.ui:getCurrentPage()
self:resetVolatileStats(self.start_current_period)
end
self.view.footer:maybeUpdateFooter()
end
if not no_notification then
local Notification = require("ui/widget/notification")
Notification:notify(self.settings.is_enabled and _("Statistics enabled") or _("Statistics disabled"))
end
end
function ReaderStatistics:addToMainMenu(menu_items)
menu_items.statistics = {
text = _("Reading statistics"),
sub_item_table = {
self:getStatisticEnabledMenuItem(),
{
text = _("Enabled"),
checked_func = function()
return self.settings.is_enabled
end,
callback = function()
self:onToggleStatistics(true)
end,
},
{
text = _("Settings"),
sub_item_table = {
@ -2803,7 +2824,7 @@ function ReaderStatistics:onReaderReady(config)
self.doc_md5 = config:readSetting("partial_md5_checksum")
-- we have correct page count now, do the actual initialization work
self:initData()
self.view.footer:onUpdateFooter()
self.view.footer:maybeUpdateFooter()
end
function ReaderStatistics:onShowCalendarView()