@ -23,18 +23,41 @@ local _ = require("gettext")
local Screen = Device.screen local Screen = Device.screen
local T = require ( " ffi/util " ) . template local T = require ( " ffi/util " ) . template
local screensaver_provider = { -- Migrate old settings from 2021.02 or older.
[ " jpg " ] = true ,
if G_reader_settings : readSetting ( " screensaver_type " , " disable " ) == " message " then
[ " jpeg " ] = true ,
G_reader_settings : saveSetting ( " screensaver_type " , " disable " )
[ " png " ] = true ,
G_reader_settings : makeTrue ( " screensaver_show_message " )
[ " gif " ] = true ,
end
[ " tif " ] = true ,
if G_reader_settings : has ( " screensaver_no_background " ) then
[ " tiff " ] = true ,
if G_reader_settings : isTrue ( " screensaver_no_background " ) then
G_reader_settings : saveSetting ( " screensaver_background " , " none " )
end
G_reader_settings : delSetting ( " screensaver_no_background " )
end
if G_reader_settings : has ( " screensaver_white_background " ) then
if G_reader_settings : isTrue ( " screensaver_white_background " ) then
G_reader_settings : saveSetting ( " screensaver_background " , " white " )
end
G_reader_settings : delSetting ( " screensaver_white_background " )
end
local Screensaver = {
screensaver_provider = {
jpg = true ,
jpeg = true ,
png = true ,
gif = true ,
tif = true ,
tiff = true ,
} ,
default_screensaver_message = _ ( " Sleeping " ) ,
} }
local default_screensaver_message = _ ( " Sleeping " )
local Screensaver = { }
local function getRandomImage ( dir ) function Screensaver : _getRandomImage ( dir )
if not dir then
return nil
end
if string.sub ( dir , string.len ( dir ) ) ~= " / " then
if string.sub ( dir , string.len ( dir ) ) ~= " / " then
dir = dir .. " / "
dir = dir .. " / "
end
end
@ -46,7 +69,7 @@ local function getRandomImage(dir)
for entry in iter , dir_obj do
for entry in iter , dir_obj do
if lfs.attributes ( dir .. entry , " mode " ) == " file " then
if lfs.attributes ( dir .. entry , " mode " ) == " file " then
local extension = string.lower ( string.match ( entry , " .+%.([^.]+) " ) or " " )
local extension = string.lower ( string.match ( entry , " .+%.([^.]+) " ) or " " )
if s creensaver_provider[ extension ] then
if s elf.s creensaver_provider[ extension ] then
i = i + 1
i = i + 1
pics [ i ] = entry
pics [ i ] = entry
end
end
@ -61,6 +84,114 @@ local function getRandomImage(dir)
return dir .. pics [ math.random ( i ) ]
return dir .. pics [ math.random ( i ) ]
end end
local function expandSpecial ( message , fallback )
-- Expand special character sequences in given message.
-- %p percentage read
-- %c current page
-- %t total pages
-- %T document title
-- %A document authors
-- %S document series
if G_reader_settings : hasNot ( " lastfile " ) then
return fallback
end
local ret = message
local lastfile = G_reader_settings : readSetting ( " lastfile " )
local totalpages = 0
local percent = 0
local currentpage = 0
local title = _ ( " N/A " )
local authors = _ ( " N/A " )
local series = _ ( " N/A " )
local instance = require ( " apps/reader/readerui " ) : _getRunningInstance ( )
if instance == nil and DocSettings : hasSidecarFile ( lastfile ) then
-- If there's no ReaderUI instance, but the file has sidecar data, use that
local docinfo = DocSettings : open ( lastfile )
totalpages = docinfo.data . doc_pages or totalpages
percent = docinfo.data . percent_finished or percent
currentpage = Math.round ( percent * totalpages )
percent = Math.round ( percent * 100 )
if docinfo.data . doc_props then
title = docinfo.data . doc_props.title and docinfo.data . doc_props.title ~= " " and docinfo.data . doc_props.title or title
authors = docinfo.data . doc_props.authors and docinfo.data . doc_props.authors ~= " " and docinfo.data . doc_props.authors or authors
series = docinfo.data . doc_props.series and docinfo.data . doc_props.series ~= " " and docinfo.data . doc_props.series or series
end
docinfo : close ( )
elseif instance ~= nil and lfs.attributes ( lastfile , " mode " ) == " file " then
-- But if we have a ReaderUI instance, and the file stil exists, open it
local doc = DocumentRegistry : openDocument ( lastfile )
currentpage = instance.view . state.page or currentpage
totalpages = doc : getPageCount ( ) or totalpages
percent = Math.round ( ( currentpage * 100 ) / totalpages )
local props = doc : getProps ( )
if props then
title = props.title and props.title ~= " " and props.title or title
authors = props.authors and props.authors ~= " " and props.authors or authors
series = props.series and props.series ~= " " and props.series or series
end
doc : close ( )
end
ret = string.gsub ( ret , " %%c " , currentpage )
ret = string.gsub ( ret , " %%t " , totalpages )
ret = string.gsub ( ret , " %%p " , percent )
ret = string.gsub ( ret , " %%T " , title )
ret = string.gsub ( ret , " %%A " , authors )
ret = string.gsub ( ret , " %%S " , series )
return ret
end
local function addOverlayMessage ( widget , text )
local FrameContainer = require ( " ui/widget/container/framecontainer " )
local RightContainer = require ( " ui/widget/container/rightcontainer " )
local Size = require ( " ui/size " )
local TextWidget = require ( " ui/widget/textwidget " )
local face = Font : getFace ( " infofont " )
local screen_w , screen_h = Screen : getWidth ( ) , Screen : getHeight ( )
local textw = TextWidget : new {
text = text ,
face = face ,
}
-- Don't make our message reach full screen width
if textw : getWidth ( ) > screen_w * 0.9 then
-- Text too wide: use TextBoxWidget for multi lines display
textw = TextBoxWidget : new {
text = text ,
face = face ,
width = math.floor ( screen_w * 0.9 )
}
end
textw = FrameContainer : new {
background = Blitbuffer.COLOR_WHITE ,
bordersize = Size.border . default ,
margin = 0 ,
textw ,
}
textw = RightContainer : new {
dimen = {
w = screen_w ,
h = textw : getSize ( ) . h ,
} ,
textw ,
}
widget = OverlapGroup : new {
dimen = {
h = screen_w ,
w = screen_h ,
} ,
widget ,
textw ,
}
return widget
end
function Screensaver : chooseFolder ( ) function Screensaver : chooseFolder ( )
local buttons = { }
local buttons = { }
table.insert ( buttons , {
table.insert ( buttons , {
@ -90,9 +221,7 @@ function Screensaver:chooseFolder()
}
}
} )
} )
local screensaver_dir = G_reader_settings : readSetting ( " screensaver_dir " )
local screensaver_dir = G_reader_settings : readSetting ( " screensaver_dir " )
if screensaver_dir == nil then
or DataStorage : getDataDir ( ) .. " /screenshots/ "
screensaver_dir = DataStorage : getDataDir ( ) .. " /screenshots/ "
end
self.choose_dialog = ButtonDialogTitle : new {
self.choose_dialog = ButtonDialogTitle : new {
title = T ( _ ( " Current screensaver image folder: \n %1 " ) , BD.dirpath ( screensaver_dir ) ) ,
title = T ( _ ( " Current screensaver image folder: \n %1 " ) , BD.dirpath ( screensaver_dir ) ) ,
buttons = buttons
buttons = buttons
@ -117,7 +246,7 @@ function Screensaver:chooseFile(document_cover)
local suffix = util.getFileNameSuffix ( filename )
local suffix = util.getFileNameSuffix ( filename )
if document_cover and DocumentRegistry : hasProvider ( filename ) then
if document_cover and DocumentRegistry : hasProvider ( filename ) then
return true
return true
elseif s creensaver_provider[ suffix ] then
elseif s elf.s creensaver_provider[ suffix ] then
return true
return true
end
end
end ,
end ,
@ -152,10 +281,8 @@ function Screensaver:chooseFile(document_cover)
}
}
} )
} )
local screensaver_image = G_reader_settings : readSetting ( " screensaver_image " )
local screensaver_image = G_reader_settings : readSetting ( " screensaver_image " )
or DataStorage : getDataDir ( ) .. " /resources/koreader.png "
local screensaver_document_cover = G_reader_settings : readSetting ( " screensaver_document_cover " )
local screensaver_document_cover = G_reader_settings : readSetting ( " screensaver_document_cover " )
if screensaver_image == nil then
screensaver_image = DataStorage : getDataDir ( ) .. " /resources/koreader.png "
end
local title = document_cover and T ( _ ( " Current screensaver document cover: \n %1 " ) , BD.filepath ( screensaver_document_cover ) )
local title = document_cover and T ( _ ( " Current screensaver document cover: \n %1 " ) , BD.filepath ( screensaver_document_cover ) )
or T ( _ ( " Current screensaver image: \n %1 " ) , BD.filepath ( screensaver_image ) )
or T ( _ ( " Current screensaver image: \n %1 " ) , BD.filepath ( screensaver_image ) )
self.choose_dialog = ButtonDialogTitle : new {
self.choose_dialog = ButtonDialogTitle : new {
@ -165,38 +292,25 @@ function Screensaver:chooseFile(document_cover)
UIManager : show ( self.choose_dialog )
UIManager : show ( self.choose_dialog )
end end
function Screensaver : stretchImages ( ) function Screensaver : isExcluded ( )
return G_reader_settings : isTrue ( " screensaver_stretch_images " )
if G_reader_settings : hasNot ( " lastfile " ) then
end return false
end
function Screensaver : whiteBackground ( )
return G_reader_settings : isTrue ( " screensaver_white_background " )
end
function Screensaver : noBackground ( )
return G_reader_settings : isTrue ( " screensaver_no_background " )
end
function Screensaver : showMessage ( )
return G_reader_settings : isTrue ( " screensaver_show_message " )
end
function Screensaver : excluded ( )
local lastfile = G_reader_settings : readSetting ( " lastfile " )
local lastfile = G_reader_settings : readSetting ( " lastfile " )
local exclude_ss = false -- consider it not excluded if there's no docsetting
if DocSettings : hasSidecarFile ( lastfile ) then
if DocSettings : hasSidecarFile ( lastfile ) then
local doc_settings = DocSettings : open ( lastfile )
local doc_settings = DocSettings : open ( lastfile )
exclude_ss = doc_settings : readSetting ( " exclude_screensaver " )
return doc_settings : isTrue ( " exclude_screensaver " )
else
-- No DocSetting, not excluded
return false
end
end
return exclude_ss or false
end end
function Screensaver : setMessage ( ) function Screensaver : setMessage ( )
local InputDialog = require ( " ui/widget/inputdialog " )
local InputDialog = require ( " ui/widget/inputdialog " )
local screensaver_message = G_reader_settings : readSetting ( " screensaver_message " )
local screensaver_message = G_reader_settings : readSetting ( " screensaver_message " )
if screensaver_message == nil then
or self.default_screensaver_message
screensaver_message = default_screensaver_message
end
self.input_dialog = InputDialog : new {
self.input_dialog = InputDialog : new {
title = " Screensaver message " ,
title = " Screensaver message " ,
description = _ ( " Enter the message to be displayed by the screensaver. The following escape sequences can be used: \n %p percentage read \n %c current page number \n %t total number of pages \n %T title \n %A authors \n %S series " ) ,
description = _ ( " Enter the message to be displayed by the screensaver. The following escape sequences can be used: \n %p percentage read \n %c current page number \n %t total number of pages \n %T title \n %A authors \n %S series " ) ,
@ -224,203 +338,245 @@ function Screensaver:setMessage()
self.input_dialog : onShowKeyboard ( )
self.input_dialog : onShowKeyboard ( )
end end
function Screensaver : show ( event , fallback_message ) -- When called after setup(), may not match the saved settings, because it accounts for fallbacks that might have kicked in.
-- These 2 (optional) parameters are to support poweroff and reboot actions
function Screensaver : getMode ( )
-- on Kobo (see uimanager.lua)
return self.screensaver_type
if self.left_msg then
end
UIManager : close ( self.left_msg )
self.left_msg = nil
end
local covers_fullscreen = true -- hint for UIManager:_repaint()
local overlay_message
local prefix = event and event .. " _ " or " " -- "", "poweroff_" or "reboot_"
local screensaver_type = G_reader_settings : readSetting ( prefix .. " screensaver_type " )
if prefix and not screensaver_type then
-- No manually added setting for poweroff/reboot, fallback to using the
-- same settings as for suspend that could be set via menus
screensaver_type = G_reader_settings : readSetting ( " screensaver_type " )
prefix = " "
-- And display fallback_message over the common screensaver,
-- so user can distinguish between suspend (no message) and
-- poweroff (overlay message)
overlay_message = fallback_message
end
local show_message = self : showMessage ( )
function Screensaver : modeExpectsPortrait ( )
return self.screensaver_type ~= " message "
and self.screensaver_type ~= " disable "
and self.screensaver_type ~= " readingprogress "
and self.screensaver_type ~= " bookstatus "
end
if screensaver_type == nil then
function Screensaver : modeIsImage ( )
show_message = true
return self.screensaver_type == " cover "
end
or self.screensaver_type == " random_image "
or self.screensaver_type == " image_file "
end
if screensaver_type == " message " then
function Screensaver : withBackground ( )
-- obsolete screensaver_type: migrate to new show_message = true
return self.screensaver_background ~= " none "
screensaver_type = " disable "
end
G_reader_settings : saveSetting ( " screensaver_type " , " disable " )
G_reader_settings : saveSetting ( " screensaver_show_message " , true )
end
-- messages can still be shown over "as-is" screensaver
function Screensaver : setup ( event , fallback_message )
if screensaver_type == " disable " and show_message == false then
-- Handle user settings & defaults
return
if G_reader_settings : has ( " screensaver_show_message " ) then
self.show_message = G_reader_settings : isTrue ( " screensaver_show_message " )
else
self.screensaver_type = " disable "
self.show_message = true
end
end
if G_reader_settings : has ( " screensaver_type " ) then
local widget = nil
self.screensaver_type = G_reader_settings : readSetting ( " screensaver_type " )
local no_background = false
else
local background = Blitbuffer.COLOR_BLACK
self.screensaver_type = " disable "
if self : whiteBackground ( ) then
self.show_message = true
background = Blitbuffer.COLOR_WHITE
end
elseif self : noBackground ( ) then
if G_reader_settings : has ( " screensaver_background " ) then
background = nil
self.screensaver_background = G_reader_settings : readSetting ( " screensaver_background " )
no_background = true
else
self.screensaver_background = " black "
end
end
-- "as-is" mode obviously requires not mangling the background ;).
-- These 2 (optional) parameters are to support poweroff and reboot actions on Kobo (c.f., UIManager)
if screensaver_type == " disable " then
self.prefix = event and event .. " _ " or " " -- "", "poweroff_" or "reboot_"
-- NOTE: Ideally, "disable" mode should *honor* all the "background" options.
self.fallback_message = fallback_message
-- Unfortunately, the no background option is much more recent than the "disable" mode,
self.overlay_message = nil
-- and as such, the default assumes that in "disable" mode, the default background is nil instead of black.
if G_reader_settings : has ( self.prefix .. " screensaver_type " ) then
-- This implies that, for the same legacy reasons, we have to honor the *white* background setting here...
self.screensaver_type = G_reader_settings : readSetting ( self.prefix .. " screensaver_type " )
-- (Which means that you can have no background, a white background, but *NOT* a black background in this mode :/).
else
if not self : whiteBackground ( ) then
if event then
background = nil
-- Display the provided fallback_message over the screensaver,
no_background = true
-- so the user can distinguish between suspend (no overlay),
-- and reboot/poweroff (overlaid message).
self.overlay_message = self.fallback_message
end
end
end
end
local lastfile = G_reader_settings : readSetting ( " lastfile " )
-- Reset state
if screensaver_type == " document_cover " then
self.lastfile = nil
self.image = nil
self.image_file = nil
-- Check lastfile and setup the requested mode's resources, or a fallback mode if the required resources are unavailable.
self.lastfile = G_reader_settings : readSetting ( " lastfile " )
if self.screensaver_type == " document_cover " then
-- Set lastfile to the document of which we want to show the cover.
-- Set lastfile to the document of which we want to show the cover.
lastfile = G_reader_settings : readSetting ( " screensaver_document_cover " )
self. lastfile = G_reader_settings : readSetting ( " screensaver_document_cover " )
screensaver_type = " cover "
s elf.s creensaver_type = " cover "
end
end
if screensaver_type == " cover " then
if self.screensaver_type == " cover " then
lastfile = lastfile ~= nil and lastfile or G_reader_settings : readSetting ( " lastfile " )
self.lastfile = self.lastfile ~= nil and self.lastfile or G_reader_settings : readSetting ( " lastfile " )
local exclude = false -- consider it not excluded if there's no docsetting
local excluded
if DocSettings : hasSidecarFile ( lastfile ) then
if DocSettings : hasSidecarFile ( self.lastfile ) then
local doc_settings = DocSettings : open ( lastfile )
local doc_settings = DocSettings : open ( self.lastfile )
exclude = doc_settings : readSetting ( " exclude_screensaver " )
excluded = doc_settings : isTrue ( " exclude_screensaver " )
else
-- No DocSetting, not excluded
excluded = false
end
end
if exclude ~= true then
if not excluded then
if lastfile and lfs.attributes ( lastfile , " mode " ) == " file " then
if self. lastfile and lfs.attributes ( self. lastfile, " mode " ) == " file " then
local doc = DocumentRegistry : openDocument ( )
local doc = DocumentRegistry : openDocument ( self. lastfile)
if doc.loadDocument then -- CreDocument
if doc.loadDocument then -- CreDocument
doc : loadDocument ( false ) -- load only metadata
doc : loadDocument ( false ) -- load only metadata
end
end
local = doc : getCoverPageImage ( )
self. = doc : getCoverPageImage ( )
doc : close ( )
doc : close ( )
if image ~= nil then
if self.image == nil then
widget = ImageWidget : new {
self.screensaver_type = " random_image "
image = image ,
image_disposable = true ,
height = Screen : getHeight ( ) ,
width = Screen : getWidth ( ) ,
scale_factor = not self : stretchImages ( ) and 0 or nil ,
}
else
screensaver_type = " random_image "
end
end
else
else
s creensaver_type = " random_image "
self.screensaver_type = " random_image "
end
end
else --fallback to random images if this book cover is excluded
else
screensaver_type = " random_image "
-- Fallback to random images if this book cover is excluded
self.screensaver_type = " random_image "
end
end
end
end
if screensaver_type == " bookstatus " then
if self.screensaver_type == " bookstatus " then
if lastfile and lfs.attributes ( lastfile , " mode " ) == " file " then
if self.lastfile and lfs.attributes ( self.lastfile , " mode " ) == " file " then
local doc = DocumentRegistry : openDocument ( lastfile )
local doc_settings = DocSettings : open ( lastfile )
local instance = require ( " apps/reader/readerui " ) : _getRunningInstance ( )
local instance = require ( " apps/reader/readerui " ) : _getRunningInstance ( )
if instance ~= nil then
if instance == nil then
widget = BookStatusWidget : new {
self.screensaver_type = " disable "
thumbnail = doc : getCoverPageImage ( ) ,
self.show_message = true
props = doc : getProps ( ) ,
document = doc ,
settings = doc_settings ,
view = instance.view ,
readonly = true ,
}
else
show_message = true
end
end
doc : close ( )
else
else
show_message = true
self.screensaver_type = " disable "
self.show_message = true
end
end
end
end
if screensaver_type == " random_image " then
if self.screensaver_type == " random_image " then
local screensaver_dir = G_reader_settings : readSetting ( prefix .. " screensaver_dir " )
local screensaver_dir = G_reader_settings : readSetting ( self.prefix .. " screensaver_dir " )
if screensaver_dir == nil and prefix ~= " " then
or G_reader_settings : readSetting ( " screensaver_dir " )
screensaver_dir = G_reader_settings : readSetting ( " screensaver_dir " )
self.image_file = self : _getRandomImage ( screensaver_dir )
end
if self.image_file == nil then
if screensaver_dir == nil then
self.screensaver_type = " disable "
screensaver_dir = DataStorage : getDataDir ( ) .. " /screenshots/ "
self.show_message = true
end
local image_file = getRandomImage ( screensaver_dir )
if image_file == nil then
show_message = true
else
widget = ImageWidget : new {
file = image_file ,
file_do_cache = false ,
alpha = true ,
height = Screen : getHeight ( ) ,
width = Screen : getWidth ( ) ,
scale_factor = not self : stretchImages ( ) and 0 or nil ,
}
end
end
end
end
if screensaver_type == " image_file " then
if self.screensaver_type == " image_file " then
local screensaver_image = G_reader_settings : readSetting ( prefix .. " screensaver_image " )
self.image_file = G_reader_settings : readSetting ( self.prefix .. " screensaver_image " )
if screensaver_image == nil and prefix ~= " " then
or G_reader_settings : readSetting ( " screensaver_image " )
screensaver_image = G_reader_settings : readSetting ( " screensaver_image " )
if self.image_file == nil or lfs.attributes ( self.image_file , " mode " ) ~= " file " then
end
self.screensaver_type = " disable "
if screensaver_image == nil then
self.show_message = true
screensaver_image = DataStorage : getDataDir ( ) .. " /resources/koreader.png "
end
if lfs.attributes ( screensaver_image , " mode " ) ~= " file " then
show_message = true
else
widget = ImageWidget : new {
file = screensaver_image ,
file_do_cache = false ,
alpha = true ,
height = Screen : getHeight ( ) ,
width = Screen : getWidth ( ) ,
scale_factor = not self : stretchImages ( ) and 0 or nil ,
}
end
end
end
end
if s creensaver_type == " readingprogress " then
if self.screensaver_type == " readingprogress " then
if Screensaver.getReaderProgress ~= nil the
-- This is implemented by the Statistics plugin
widget = Screensaver.getReaderProgress ( )
if Screensaver.getReaderProgress == nil then
else
self.screensaver_type = " disable "
s how_message = true
self.show_message = true
end
end
end
end
if show_message == true then
-- Now that the fallbacks are in place, we know the *effective* screensaver mode.
local screensaver_message = G_reader_settings : readSetting ( prefix .. " screensaver_message " )
-- For non-image modes, make black (which is also the default) synonymous with none.
local message_pos = G_reader_settings : readSetting ( prefix .. " screensaver_message_position " )
-- The reasoning is that disable + show_message, which is our default and fallback,
if no_background and widget == nil then
-- looks *terrible* with a black background, which is also our default and fallback ;).
covers_fullscreen = false
if not self : modeIsImage ( ) and self.screensaver_background == " black " then
self.screensaver_background = " none "
end
end
function Screensaver : show ( )
if self.screensaver_widget then
UIManager : close ( self.screensaver_widget )
self.screensaver_widget = nil
end
-- In as-is mode with no message and no overlay, we've got nothing to show :)
if self.screensaver_type == " disable " and not self.show_message and not self.overlay_message then
return
end
-- Build the main widget for the effective mode, all the sanity checks were handled in setup
local widget = nil
if self.screensaver_type == " cover " then
widget = ImageWidget : new {
image = self.image ,
image_disposable = true ,
height = Screen : getHeight ( ) ,
width = Screen : getWidth ( ) ,
scale_factor = G_reader_settings : isTrue ( " screensaver_stretch_images " ) and nil or 0 ,
}
elseif self.screensaver_type == " bookstatus " then
local doc = DocumentRegistry : openDocument ( self.lastfile )
local doc_settings = DocSettings : open ( self.lastfile )
local instance = require ( " apps/reader/readerui " ) : _getRunningInstance ( )
widget = BookStatusWidget : new {
thumbnail = doc : getCoverPageImage ( ) ,
props = doc : getProps ( ) ,
document = doc ,
settings = doc_settings ,
view = instance.view ,
readonly = true ,
}
doc : close ( )
elseif self.screensaver_type == " random_image " or self.screensaver_type == " image_file " then
widget = ImageWidget : new {
file = self.image_file ,
file_do_cache = false ,
alpha = true ,
height = Screen : getHeight ( ) ,
width = Screen : getWidth ( ) ,
scale_factor = G_reader_settings : isTrue ( " screensaver_stretch_images " ) and nil or 0 ,
}
elseif self.screensaver_type == " readingprogress " then
widget = Screensaver.getReaderProgress ( )
end
-- Assume that we'll be covering the full-screen by default (either because of a widget, or a background fill).
local covers_fullscreen = true
-- Speaking of, set that background fill up...
local background
if self.screensaver_background == " black " then
background = Blitbuffer.COLOR_BLACK
elseif self.screensaver_background == " white " then
background = Blitbuffer.COLOR_WHITE
elseif self.screensaver_background == " none " then
background = nil
end
if self.show_message then
-- Handle user settings & fallbacks, with that prefix mess on top...
local screensaver_message
if G_reader_settings : has ( self.prefix .. " screensaver_message " ) then
screensaver_message = G_reader_settings : readSetting ( self.prefix .. " screensaver_message " )
else
if G_reader_settings : has ( " screensaver_message " ) then
-- We prefer the global user setting to the event's fallback message.
screensaver_message = G_reader_settings : readSetting ( " screensaver_message " )
else
screensaver_message = self.fallback_message or self.default_screensaver_message
end
end
end
if screensaver_message == nil and prefix ~= " " then
-- NOTE: Only attempt to expand if there are special characters in the message.
screensaver_message = G_reader_settings : readSetting ( " screensaver_message " )
if screensaver_message : find ( " %% " ) then
screensaver_message = expandSpecial ( screensaver_message , self.fallback_message or self.default_screensaver_message )
end
end
local fallback = fallback_message or default_screensaver_message
local message_pos
if screensaver_message == nil then
if G_reader_settings: has ( self.prefix .. " screensaver_message_position " ) then
screensaver_message = fallback
message_pos = G_reader_settings : readSetting ( self.prefix .. " screensaver_message_position " )
else
else
-- NOTE: Only attempt to expand if there are special characters in the message.
if G_reader_settings : has ( " screensaver_message_position " ) then
if screensaver_message : find ( " %% " ) then
message_pos = G_reader_settings : readSetting ( " screensaver_message_position " )
screensaver_message = self : expandSpecial ( screensaver_message , fallback )
else
message_pos = " middle "
end
end
end
end
-- The only case where we *won't* cover the full-screen is when we only display a message and no background.
if widget == nil and self.screensaver_background == " none " then
covers_fullscreen = false
end
local message_widget
local message_widget
if message_pos == " middle " or message_pos == nil then
if message_pos == " middle " then
message_widget = InfoMessage : new {
message_widget = InfoMessage : new {
text = screensaver_message ,
text = screensaver_message ,
readonly = true ,
readonly = true ,
@ -449,13 +605,13 @@ function Screensaver:show(event, fallback_message)
}
}
end
end
-- No overlay needed as we just displayed the message
-- No overlay needed as we just displayed *a* message (not necessarily the event's, though).
= nil
self. overlay_message = nil
-- c heck if message_widget should be overlaid on another widget
-- C heck if message_widget should be overlaid on another widget
if message_widget then
if message_widget then
if widget then -- we have a s creensaver widget
if widget then -- We have a S creensaver widget
-- s how message_widget on top of previously created widget
-- S how message_widget on top of previously created widget
local screen_w , screen_h = Screen : getWidth ( ) , Screen : getHeight ( )
local screen_w , screen_h = Screen : getWidth ( ) , Screen : getHeight ( )
widget = OverlapGroup : new {
widget = OverlapGroup : new {
dimen = {
dimen = {
@ -466,158 +622,52 @@ function Screensaver:show(event, fallback_message)
message_widget ,
message_widget ,
}
}
else
else
-- no prevously created widget so just show message widget
-- No prevously created widget, so just show message widget
widget = message_widget
widget = message_widget
end
end
end
end
end
end
if then
if self. overlay_message then
widget = self: addOverlayMessage( widget , )
widget = ( widget , self. overlay_message)
end
end
if widget then
if widget then
self. left_msg = ScreenSaverWidget : new {
self. screensaver_widget = ScreenSaverWidget : new {
widget = widget ,
widget = widget ,
background = background ,
background = background ,
covers_fullscreen = covers_fullscreen ,
covers_fullscreen = covers_fullscreen ,
}
}
self.left_msg . modal = true
self.screensaver_widget . modal = true
-- Refresh whole screen for other types
self.screensaver_widget . dithered = true
self.left_msg . dithered = true
UIManager : show ( self.screensaver_widget , " full " )
UIManager : show ( self.left_msg , " full " )
end
end
end end
function Screensaver : expandSpecial ( message , fallback ) function Screensaver : close ( )
-- Expand special character sequences in given message.
if self.screensaver_widget == nil then
-- %p percentage read
return
-- %c current page
-- %t total pages
-- %T document title
-- %A document authors
-- %S document series
local ret = message
local lastfile = G_reader_settings : readSetting ( " lastfile " )
if not lastfile then
return fallback
end
local totalpages = 0
local percent = 0
local currentpage = 0
local title = " N/A "
local authors = " N/A "
local series = " N/A "
local instance = require ( " apps/reader/readerui " ) : _getRunningInstance ( )
if instance == nil and DocSettings : hasSidecarFile ( lastfile ) then
-- If there's no ReaderUI instance, but the file has sidecar data, use that
local docinfo = DocSettings : open ( lastfile )
totalpages = docinfo.data . doc_pages or totalpages
percent = docinfo.data . percent_finished or percent
currentpage = Math.round ( percent * totalpages )
percent = Math.round ( percent * 100 )
if docinfo.data . doc_props then
title = docinfo.data . doc_props.title and docinfo.data . doc_props.title ~= " " and docinfo.data . doc_props.title or title
authors = docinfo.data . doc_props.authors and docinfo.data . doc_props.authors ~= " " and docinfo.data . doc_props.authors or authors
series = docinfo.data . doc_props.series and docinfo.data . doc_props.series ~= " " and docinfo.data . doc_props.series or series
end
docinfo : close ( )
elseif instance ~= nil and lfs.attributes ( lastfile , " mode " ) == " file " then
-- But if we have a ReaderUI instance, and the file stil exists, open it
local doc = DocumentRegistry : openDocument ( lastfile )
currentpage = instance.view . state.page or currentpage
totalpages = doc : getPageCount ( ) or totalpages
percent = Math.round ( ( currentpage * 100 ) / totalpages )
local props = doc : getProps ( )
if props then
title = props.title and props.title ~= " " and props.title or title
authors = props.authors and props.authors ~= " " and props.authors or authors
series = props.series and props.series ~= " " and props.series or series
end
doc : close ( )
end
end
ret = string.gsub ( ret , " %%c " , currentpage )
ret = string.gsub ( ret , " %%t " , totalpages )
ret = string.gsub ( ret , " %%p " , percent )
ret = string.gsub ( ret , " %%T " , title )
ret = string.gsub ( ret , " %%A " , authors )
ret = string.gsub ( ret , " %%S " , series )
return ret
end
function Screensaver : close ( )
if self.left_msg == nil then return end
local screensaver_delay = G_reader_settings : readSetting ( " screensaver_delay " )
local screensaver_delay = G_reader_settings : readSetting ( " screensaver_delay " )
local screensaver_delay_number = tonumber ( screensaver_delay )
local screensaver_delay_number = tonumber ( screensaver_delay )
if screensaver_delay_number then
if screensaver_delay_number then
UIManager : scheduleIn ( screensaver_delay_number , function ( )
UIManager : scheduleIn ( screensaver_delay_number , function ( )
logger.dbg ( " close screensaver " )
logger.dbg ( " close screensaver " )
if self. left_msg then
if self.screensaver_widget then
UIManager : close ( self. left_msg , " full " )
UIManager : close ( self.screensaver_widget , " full " )
self. left_msg = nil
self.screensaver_widget = nil
end
end
end )
end )
elseif screensaver_delay == " disable " or screensaver_delay == nil then
elseif screensaver_delay == " disable " or screensaver_delay == nil then
logger.dbg ( " close screensaver " )
logger.dbg ( " close screensaver " )
if self. left_msg then
if self.screensaver_widget then
UIManager : close ( self. left_msg , " full " )
UIManager : close ( self.screensaver_widget , " full " )
self. left_msg = nil
self.screensaver_widget = nil
end
end
else
else
logger.dbg ( " tap to exit from screensaver " )
logger.dbg ( " tap to exit from screensaver " )
end
end
end end
function Screensaver : addOverlayMessage ( widget , text )
local FrameContainer = require ( " ui/widget/container/framecontainer " )
local RightContainer = require ( " ui/widget/container/rightcontainer " )
local Size = require ( " ui/size " )
local TextWidget = require ( " ui/widget/textwidget " )
local face = Font : getFace ( " infofont " )
local screen_w , screen_h = Screen : getWidth ( ) , Screen : getHeight ( )
local textw = TextWidget : new {
text = text ,
face = face ,
}
-- Don't make our message reach full screen width
if textw : getWidth ( ) > screen_w * 0.9 then
-- Text too wide: use TextBoxWidget for multi lines display
textw = TextBoxWidget : new {
text = text ,
face = face ,
width = math.floor ( screen_w * 0.9 )
}
end
textw = FrameContainer : new {
background = Blitbuffer.COLOR_WHITE ,
bordersize = Size.border . default ,
margin = 0 ,
textw ,
}
textw = RightContainer : new {
dimen = {
w = screen_w ,
h = textw : getSize ( ) . h ,
} ,
textw ,
}
widget = OverlapGroup : new {
dimen = {
h = screen_w ,
w = screen_h ,
} ,
widget ,
textw ,
}
return widget
end
return Screensaver return Screensaver
NiLuJe
3 years ago
committed by
GitHub