KOReader-Pinlock/pinpadlockscreen.koplugin/ui/pinpadbuttondialog.lua

--[[
Author: Lena2309
Description: customizes KOReader's existing ButtonDialog class solely
for aesthetic purposes (icon widget, vertical layout...),
with the primary modification in the `init` function.
]]

local Blitbuffer = require("ffi/blitbuffer")
local ButtonDialog = require("ui/widget/buttondialog")
local ButtonTable = require("ui/widget/buttontable")
local CenterContainer = require("ui/widget/container/centercontainer")
local Device = require("device")
local FrameContainer = require("ui/widget/container/framecontainer")
local Geom = require("ui/geometry")
local GestureRange = require("ui/gesturerange")
local ImageWidget = require("ui/widget/imagewidget")
local LineWidget = require("ui/widget/linewidget")
local MovableContainer = require("ui/widget/container/movablecontainer")
local ScrollTextWidget = require("ui/widget/scrolltextwidget")
local Size = require("ui/size")
local TextBoxWidget = require("ui/widget/textboxwidget")
local UIManager = require("ui/uimanager")
local VerticalGroup = require("ui/widget/verticalgroup")
local VerticalSpan = require("ui/widget/verticalspan")
local Screen = Device.screen
local util = require("util")
local RenderImage = require("ui/renderimage")

local DGENERIC_ICON_SIZE = G_defaults:readSetting("DGENERIC_ICON_SIZE")

local PinpadButtonDialog = ButtonDialog:extend {
    override_show_message = false, -- will prevent showing custom lock message even if enabled (specific for changing PIN Code)
}

function PinpadButtonDialog:init()
    if not self.width_factor then
        self.width_factor = 2 / 3
    end
    self.width = math.floor(math.min(Screen:getWidth(), Screen:getHeight()) * self.width_factor)

    if self.dismissable then
        if Device:hasKeys() then
            local back_group = util.tableDeepCopy(Device.input.group.Back)
            if Device:hasFewKeys() then
                table.insert(back_group, "Left")
                self.key_events.Close = { { back_group } }
            else
                table.insert(back_group, "Menu")
                self.key_events.Close = { { back_group } }
            end
        end
        if Device:isTouchDevice() then
            self.ges_events.TapClose = {
                GestureRange:new {
                    ges = "tap",
                    range = Geom:new {
                        x = 0, y = 0,
                        w = Screen:getWidth(),
                        h = Screen:getHeight(),
                    }
                }
            }
        end
    end

    local title_face
    if self.use_info_style then
        title_face = self.info_face
    else
        title_face = self.title_face
    end

    local currentFileSource = debug.getinfo(1, "S").source
    local plugin_dir
    if currentFileSource:find("^@") then
        plugin_dir = currentFileSource:gsub("^@(.*)/[^/]*", "%1")
    end

    self.title_widget = TextBoxWidget:new {
        text = self.title,
        face = title_face,
        width = self.width,
        alignment = self.title_align,
    }

    local aesthetic_space = VerticalSpan:new { width = Size.margin.default + Size.padding.default }
    -- Pre-render the SVG to an image to avoid inconsistent caching/rasterization across multiple shows.
    local icon_image = nil
    local icon_path = plugin_dir and (plugin_dir .. "/icons/lock.svg") or nil
    if icon_path and util.getFileNameSuffix(icon_path) == "svg" then
        icon_image = RenderImage:renderSVGImageFile(icon_path, nil, nil, 1)
    end
    local text_pin_content = VerticalGroup:new {
        align = "center",
        ImageWidget:new {
            -- Prefer a pre-rendered image object when available; fallback to file path so existing behavior is preserved.
            image = icon_image,
            file = icon_image and nil or (plugin_dir .. "/icons/lock.svg"),
            alpha = true,
            width = Screen:scaleBySize(DGENERIC_ICON_SIZE) * 1.25,
            height = Screen:scaleBySize(DGENERIC_ICON_SIZE) * 1.25,
            -- don't force raster scaling for SVGs; let renderer handle vector scaling for crisp output
            scale_factor = nil,
            original_in_nightmode = false,
        },
        aesthetic_space,
        VerticalGroup:new {
            align = "center",
            self.title_widget
        },
    }

    self.buttontable = ButtonTable:new {
        buttons = self.buttons,
        width = text_pin_content:getSize().w,
        shrink_unneeded_width = self.shrink_unneeded_width,
        shrink_min_width = self.shrink_min_width,
        show_parent = self,
    }

    local separator = LineWidget:new {
        background = Blitbuffer.COLOR_GRAY,
        dimen = Geom:new {
            w = text_pin_content:getSize().w,
            h = Size.line.medium,
        },
    }

    local content
    if G_reader_settings:isTrue("pinpadlock_show_message") and not self.override_show_message then
        local lock_message = G_reader_settings:readSetting("pinpadlock_message")
        lock_message = lock_message:gsub("\\n", "\n") -- enabling jumping lines in the message

        local lock_message_alignment = G_reader_settings:readSetting("pinpadlock_message_alignment")
        local lock_message_position = G_reader_settings:readSetting("pinpadlock_message_position")

        local lock_message_widget = TextBoxWidget:new {
            text = lock_message,
            face = title_face,
            width = self.width,
            alignment = lock_message_alignment,
        }

        -- If the custom message ends up being too tall and makes the Pin Pad taller than the screen,
        -- wrap it inside a ScrollableContainer
        local max_height = self.buttontable:getSize().h + 3 * text_pin_content:getSize().h + Size.line.medium
        local height = self.buttontable:getSize().h + text_pin_content:getSize().h + Size.line.medium +
            lock_message_widget:getSize().h
        if height > max_height then
            local scroll_height = 3 * text_pin_content:getSize().h

            lock_message_widget = ScrollTextWidget:new {
                text = lock_message,
                face = title_face,
                width = self.width,
                alignment = lock_message_alignment,
                dialog = self,
                height = scroll_height,
            }
        end

        if lock_message_position == "top" then
            content = VerticalGroup:new {
                align = "center",
                aesthetic_space,
                lock_message_widget,
                aesthetic_space,
                separator,
                aesthetic_space,
                text_pin_content,
                aesthetic_space,
                separator,
                self.buttontable,
            }
        elseif lock_message_position == "middle" then
            content = VerticalGroup:new {
                align = "center",
                aesthetic_space,
                text_pin_content,
                aesthetic_space,
                separator,
                aesthetic_space,
                lock_message_widget,
                aesthetic_space,
                separator,
                self.buttontable,
            }
        else
            content = VerticalGroup:new {
                align = "center",
                aesthetic_space,
                text_pin_content,
                aesthetic_space,
                separator,
                self.buttontable,
                separator,
                aesthetic_space,
                lock_message_widget,
                aesthetic_space,
            }
        end
    else
        content = VerticalGroup:new {
            align = "center",
            aesthetic_space,
            text_pin_content,
            aesthetic_space,
            separator,
            self.buttontable,
        }
    end

    self.movable = MovableContainer:new {
        alpha = self.alpha,
        anchor = self.anchor,
        FrameContainer:new {
            -- Restore original white window background so the dialog has a proper window appearance.
            background = Blitbuffer.COLOR_WHITE,
            bordersize = Size.border.window,
            radius = Size.radius.window,
            padding = Size.padding.default,
            padding_top = 0,
            padding_bottom = 0,
            content,
        },
        unmovable = true,
    }

    self.layout = self.buttontable.layout
    self.buttontable.layout = nil

    self[1] = CenterContainer:new {
        dimen = Screen:getSize(),
        self.movable,
    }
end

function PinpadButtonDialog:updateTitle(text)
    if self.title_widget then
        self.title = text
        self.title_widget:setText(text)
        UIManager:setDirty(self, "ui")
    end
end

return PinpadButtonDialog