KOReader插件开发：自定义导出高亮文件名格式的实现

背景介绍

KOReader作为一款开源的电子书阅读器，其插件系统为用户提供了丰富的扩展功能。其中，Exporter插件允许用户将书籍中的高亮和笔记导出为外部文件。然而，默认的文件命名格式可能无法满足所有用户的需求，这就引出了对文件名格式自定义功能的需求。

技术实现原理

KOReader的插件系统基于Lua语言开发，通过修改插件代码可以实现功能定制。对于Exporter插件，其核心文件名生成逻辑位于base.lua文件中。默认情况下，插件会使用"yyyy-mm-dd-hh-mm-ss-Book Title.txt"这样的格式生成文件名。

自定义文件名格式的实现方法

要实现自定义文件名格式，可以通过以下两种方式：

1. 直接修改插件源码：找到base.lua文件中负责生成文件名的函数，直接修改其字符串格式化逻辑。但这种方式在插件更新时需要重新修改，维护成本较高。

2. 使用用户补丁机制：KOReader提供了用户补丁系统，可以在不修改原始插件代码的情况下实现功能扩展。通过创建一个补丁文件（如2-exporter-file-format.lua），可以覆盖插件的文件名生成逻辑。

具体实现代码

以下是一个实现自定义文件名格式的用户补丁示例：

local userpatch = require("userpatch")
local util = require("util")

userpatch.registerPatchPluginFunc("exporter", function(plugin)
    local init_orig = plugin.init
    plugin.init = function(self)
        init_orig(self)
        for _, v in pairs(self.targets) do
            v.getFilePath = function(v_self, t)
                if v_self.is_remote then return end
                local plugin_settings = G_reader_settings:readSetting("exporter") or {}
                local clipping_dir = plugin_settings.clipping_dir or v_self.clipping_dir
                local filename
                if #t == 1 then
                    if plugin_settings.clipping_dir_book then
                        clipping_dir = util.splitFilePathName(t[1].file):sub(1, -2)
                    end
                    -- 单本书籍导出文件名格式
                    filename = string.format("%s %s - %s.%s", 
                        os.date("%Y-%m-%d"), 
                        t[1].author, 
                        t[1].title, 
                        v_self.extension)
                else
                    -- 多本书籍导出文件名格式
                    local title = v_self.all_books_title or "all-books"
                    filename = string.format("%s-%s.%s", 
                        v_self:getTimeStamp(), 
                        title, 
                        v_self.extension)
                end
                return clipping_dir .. "/" .. util.getSafeFilename(filename)
            end
        end
    end
end)

使用说明

1. 在KOReader的patches目录下创建上述补丁文件
2. 重启KOReader使补丁生效
3. 使用Exporter插件导出高亮时，将按照补丁中定义的格式生成文件名

格式自定义建议

用户可以根据需要修改string.format中的格式字符串，常见的可用变量包括：

• t[1].title：书籍标题
• t[1].author：书籍作者
• os.date("%Y-%m-%d")：当前日期
• v_self.extension：文件扩展名

例如，要实现"作者 - 日期.扩展名"的格式，可以修改为：

filename = string.format("%s - %s.%s", t[1].title, os.date("%Y-%m-%d"), v_self.extension)

注意事项

1. 补丁文件需要放置在正确的目录下才能生效
2. 某些情况下可能需要重启KOReader多次才能使补丁完全生效
3. 如果插件有重大更新，可能需要调整补丁代码以适应新版本
4. 文件名中会使用util.getSafeFilename函数确保文件名有效性

通过这种用户补丁机制，KOReader用户可以在不修改核心代码的情况下，灵活定制各种导出功能，满足个性化需求。