├── .stylua.toml ├── .gitmodules ├── docs ├── screenshots │ ├── more-tools.png │ └── get-comic-meta.png └── intro.md ├── .yamllint.yml ├── Makefile ├── renovate.json ├── _meta.lua ├── .github └── workflows │ ├── lua-busted.yml │ ├── publish.yml │ └── format.yml ├── README.md ├── test ├── comicmeta_spec.lua └── mocks.lua ├── main.lua └── LICENSE /.stylua.toml: -------------------------------------------------------------------------------- 1 | indent_type = "Spaces" 2 | indent_width = 4 3 | 4 | [sort_requires] 5 | enabled = true 6 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/comiclib"] 2 | path = lib/comiclib 3 | url = https://github.com/KORComic/comiclib.git 4 | -------------------------------------------------------------------------------- /docs/screenshots/more-tools.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KORComic/comicmeta.koplugin/HEAD/docs/screenshots/more-tools.png -------------------------------------------------------------------------------- /.yamllint.yml: -------------------------------------------------------------------------------- 1 | extends: default 2 | 3 | rules: 4 | document-start: disable 5 | truthy: disable 6 | line-length: disable 7 | -------------------------------------------------------------------------------- /docs/screenshots/get-comic-meta.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KORComic/comicmeta.koplugin/HEAD/docs/screenshots/get-comic-meta.png -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: test 2 | 3 | LUA_PATH := ./?.lua;./lib/?.lua;./lib/?/?.lua;./lib/comiclib/lib/?.lua;./lib/comiclib/third_party/?/?.lua"" 4 | 5 | test: 6 | LUA_PATH="$(LUA_PATH)" busted test 7 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": ["config:recommended"], 4 | "git-submodules": { 5 | "enabled": true 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /_meta.lua: -------------------------------------------------------------------------------- 1 | local _ = require("gettext") 2 | return { 3 | name = "comicmeta", 4 | fullname = _("Comic Book Metadata"), 5 | description = _([[Extracts Metadata from Comic Book files]]), 6 | } 7 | -------------------------------------------------------------------------------- /.github/workflows/lua-busted.yml: -------------------------------------------------------------------------------- 1 | name: Busted 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | branches: 8 | - main 9 | jobs: 10 | tests: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v6 15 | with: 16 | submodules: recursive 17 | - name: Run Busted 18 | uses: lunarmodules/busted@v2.2.0 19 | with: 20 | args: test 21 | env: 22 | LUA_PATH: "./?.lua;./lib/?.lua;./lib/?/?.lua;./lib/comiclib/lib/?.lua;./lib/comiclib/third_party/?/?.lua" 23 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish plugin 2 | on: 3 | release: 4 | types: [published] 5 | jobs: 6 | publish: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v6 10 | with: 11 | submodules: recursive 12 | - name: Create ZIP archive 13 | run: | 14 | mkdir -p comicmeta.koplugin 15 | cp -r lib comicmeta.koplugin/lib 16 | cp LICENSE.md README.md main.lua _meta.lua comicmeta.koplugin/ 17 | zip -r comicmeta.koplugin.zip comicmeta.koplugin 18 | - name: Upload Release Artifact 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 21 | run: gh release upload ${{ github.event.release.tag_name }} comicmeta.koplugin.zip 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # comicmeta.koplugin 2 | 3 | Plugin for KOReader to extract metadata from .cbz and .cbr files as Custom Metadata 4 | 5 | Metadata should be stored in a ComicInfo.xml at the root of the archive, as specified by [The Anansi Project](https://anansi-project.github.io/docs/category/schemas). 6 | 7 | ## Example 8 | 9 | https://github.com/user-attachments/assets/dbedf7fa-b5df-4536-8686-919342ff41ce 10 | 11 | ## Contributing 12 | 13 | ### Running Test 14 | 15 | To run test, you can run `make` in the root dir of the project. 16 | 17 | ```shell 18 | ❯ make 19 | LUA_PATH="./?.lua;./lib/?.lua;" busted . 20 | ●●●●●● 21 | 6 successes / 0 failures / 0 errors / 0 pending : 0.002076 seconds 22 | ``` 23 | 24 | To run test, [busted](https://github.com/lunarmodules/busted) is used. 25 | -------------------------------------------------------------------------------- /docs/intro.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | 5 | # Getting Started 6 | 7 | This guide will walk you through the installation and usage of ComicMeta. 8 | 9 | ## Installation 10 | 11 | Follow these simple steps to get started: 12 | 13 | 1. Head over to the [releases page](https://github.com/KORComic/comicmeta.koplugin/releases/latest) and grab the latest `.zip` file. 14 | 2. Unzip the contents into your **plugins** folder. 15 | 3. In the file browser, go to More Tools: 16 | ![More Tools](./screenshots/more-tools.png) 17 | Then tap "Get Comic Meta": 18 | ![Get Comic Meta](./screenshots/get-comic-meta.png) 19 | 20 | ## Usage 21 | 22 | When you open a directory, the plugin will ask whether to extract recursively. If you choose Yes, all comic files (`.cbz` and `.cbr`) in that directory and its subdirectories will be processed. If you choose No, only the comic files (`.cbz` and `.cbr`) in the current directory will be processed. 23 | -------------------------------------------------------------------------------- /test/comicmeta_spec.lua: -------------------------------------------------------------------------------- 1 | require("test/mocks") 2 | 3 | describe("ComicMeta utility functions", function() 4 | local test_root = "/tmp/comicmeta_test" 5 | local subdir = test_root .. "/sub" 6 | local cbz_file = test_root .. "/test.cbz" 7 | local sub_cbz_file = subdir .. "/subtest.cbz" 8 | local cbr_file = test_root .. "/test.cbr" 9 | local sub_cbr_file = subdir .. "/subtest.cbr" 10 | local ComicMeta = require("main") 11 | 12 | before_each(function() 13 | os.execute("rm -rf " .. string.format("%q", test_root)) 14 | 15 | lfs.mkdir(test_root) 16 | lfs.mkdir(subdir) 17 | 18 | -- Create dummy .cbz files 19 | local f = io.open(cbz_file, "w") 20 | f:write("dummy") 21 | f:close() 22 | 23 | local f2 = io.open(sub_cbz_file, "w") 24 | f2:write("dummy") 25 | f2:close() 26 | 27 | -- Create dummy .cbr files 28 | local f3 = io.open(cbr_file, "w") 29 | f3:write("dummy") 30 | f3:close() 31 | 32 | local f4 = io.open(sub_cbr_file, "w") 33 | f4:write("dummy") 34 | f4:close() 35 | end) 36 | 37 | after_each(function() 38 | os.execute("rm -rf " .. string.format("%q", test_root)) 39 | end) 40 | 41 | it("scanForComicFiles finds comic files", function() 42 | local files = ComicMeta:scanForComicFiles(test_root, true) 43 | local localFiles = ComicMeta:scanForComicFiles(test_root, false) 44 | 45 | assert.equals(4, #files) 46 | assert.equals(2, #localFiles) 47 | end) 48 | 49 | it("scanForComicFiles returns empty for folder with no comic files", function() 50 | os.remove(cbz_file) 51 | os.remove(sub_cbz_file) 52 | os.remove(cbr_file) 53 | os.remove(sub_cbr_file) 54 | 55 | local files = ComicMeta:scanForComicFiles(test_root, true) 56 | local localFiles = ComicMeta:scanForComicFiles(test_root, false) 57 | 58 | assert.equals(0, #files) 59 | assert.equals(0, #localFiles) 60 | end) 61 | 62 | it("hasSubdirectories detects subdirectories", function() 63 | assert.is_true(ComicMeta:hasSubdirectories(test_root)) 64 | assert.is_false(ComicMeta:hasSubdirectories(subdir)) 65 | end) 66 | end) 67 | 68 | describe("ComicMeta.writeCustomToC", function() 69 | local ComicMeta = require("main") 70 | 71 | it("saves correct ToC settings from pages data", function() 72 | -- Mock doc_settings 73 | local saved = {} 74 | local doc_settings = { 75 | saveSetting = function(_, key, value) 76 | saved[key] = value 77 | end, 78 | } 79 | 80 | -- Example pages_data as parsed from ComicInfo.xml 81 | local pages_data = { 82 | Page = { 83 | { Image = "0", Type = "FrontCover", Bookmark = "Capa" }, 84 | { Image = "1", Type = "Story", Bookmark = "Capítulo 1: Paraíso" }, 85 | { Image = "71", Type = "Story", Bookmark = "Capítulo 2: Pseudo-criaturas" }, 86 | { Image = "112", Type = "Story", Bookmark = "Capítulo 3: Hospedeiros" }, 87 | { Image = "159", Type = "Story", Bookmark = "Capítulo 4: Purgatório" }, 88 | }, 89 | } 90 | 91 | ComicMeta:writeCustomToC(doc_settings, pages_data) 92 | 93 | assert.is_true(saved.handmade_toc_enabled) 94 | assert.is_false(saved.handmade_toc_edit_enabled) 95 | assert.is_table(saved.handmade_toc) 96 | assert.equals(5, #saved.handmade_toc) 97 | assert.same({ depth = 1, page = 1, title = "Capa" }, saved.handmade_toc[1]) 98 | assert.same({ depth = 1, page = 2, title = "Capítulo 1: Paraíso" }, saved.handmade_toc[2]) 99 | assert.same({ depth = 1, page = 72, title = "Capítulo 2: Pseudo-criaturas" }, saved.handmade_toc[3]) 100 | assert.same({ depth = 1, page = 113, title = "Capítulo 3: Hospedeiros" }, saved.handmade_toc[4]) 101 | assert.same({ depth = 1, page = 160, title = "Capítulo 4: Purgatório" }, saved.handmade_toc[5]) 102 | end) 103 | end) 104 | -------------------------------------------------------------------------------- /.github/workflows/format.yml: -------------------------------------------------------------------------------- 1 | name: "Code Formatters" 2 | on: 3 | pull_request: 4 | branches: 5 | - main 6 | paths: 7 | - "**.sh" 8 | - "**.lua" 9 | - "**.yml" 10 | - "**.yaml" 11 | - "**/.github/workflows/**" 12 | - "**.json" 13 | - "**.md" 14 | permissions: 15 | contents: read 16 | pull-requests: read 17 | jobs: 18 | changes: 19 | runs-on: ubuntu-latest 20 | outputs: 21 | lua: ${{ steps.changes.outputs.lua }} 22 | yaml: ${{ steps.changes.outputs.yaml }} 23 | prettier: ${{ steps.changes.outputs.prettier }} 24 | shell: ${{ steps.changes.outputs.shell }} 25 | markdown: ${{ steps.changes.outputs.markdown }} 26 | actions: ${{ steps.changes.outputs.actions }} 27 | steps: 28 | - name: Checkout code 29 | uses: actions/checkout@v6 30 | - uses: dorny/paths-filter@v3 31 | id: changes 32 | with: 33 | filters: | 34 | shell: 35 | - '**/*.sh' 36 | lua: 37 | - '**/*.lua' 38 | yaml: 39 | - '**/*.yml' 40 | - '**/*.yaml' 41 | actions: 42 | - '**/.github/workflows/**' 43 | prettier: 44 | - '**/*.json' 45 | - '**/*.md' 46 | markdown: 47 | - '**/*.md' 48 | stylua: 49 | runs-on: ubuntu-latest 50 | needs: changes 51 | if: ${{ needs.changes.outputs.lua == 'true' }} 52 | steps: 53 | - name: Checkout code 54 | uses: actions/checkout@v6 55 | - uses: JohnnyMorganz/stylua-action@v4 56 | with: 57 | token: ${{ secrets.GITHUB_TOKEN }} 58 | version: latest 59 | # CLI arguments 60 | args: --check . 61 | yamllint: 62 | runs-on: ubuntu-latest 63 | needs: changes 64 | if: ${{ needs.changes.outputs.yaml == 'true' }} 65 | steps: 66 | - name: Checkout code 67 | uses: actions/checkout@v6 68 | - name: "Yamllint" 69 | uses: karancode/yamllint-github-action@master 70 | with: 71 | yamllint_strict: false 72 | yamllint_comment: true 73 | env: 74 | GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 75 | prettier: 76 | runs-on: ubuntu-latest 77 | needs: changes 78 | if: ${{ needs.changes.outputs.prettier == 'true' }} 79 | steps: 80 | - name: Checkout code 81 | uses: actions/checkout@v6 82 | - name: Prettify code 83 | uses: creyD/prettier_action@v4.6 84 | with: 85 | dry: True 86 | prettier_options: "--check ." 87 | shfmt: 88 | runs-on: ubuntu-latest 89 | needs: changes 90 | if: ${{ needs.changes.outputs.shell == 'true' }} 91 | steps: 92 | - name: Checkout code 93 | uses: actions/checkout@v6 94 | - name: Install shfmt 95 | run: | 96 | sudo apt-get update && sudo apt-get install -y shfmt 97 | - name: Run shfmt 98 | run: | 99 | find . -type f -name '*.sh' -print0 | xargs -0 -I {} shfmt -d {} 100 | markdownlint: 101 | runs-on: ubuntu-latest 102 | needs: changes 103 | if: ${{ needs.changes.outputs.markdown == 'true' }} 104 | steps: 105 | - name: Checkout code 106 | uses: actions/checkout@v6 107 | - name: Install markdownlint-cli 108 | run: | 109 | npm install -g markdownlint-cli 110 | - name: Run markdownlint 111 | run: | 112 | markdownlint '**/*.md' 113 | shellcheck: 114 | runs-on: ubuntu-latest 115 | needs: changes 116 | if: ${{ needs.changes.outputs.shell == 'true' }} 117 | steps: 118 | - name: Checkout code 119 | uses: actions/checkout@v6 120 | - name: Install shellcheck 121 | run: | 122 | sudo apt-get update && sudo apt-get install -y shellcheck 123 | - name: Run shellcheck 124 | run: | 125 | find . -type f -name '*.sh' -print0 | xargs -0 -I {} shellcheck {} 126 | actoinlint: 127 | runs-on: ubuntu-latest 128 | needs: changes 129 | if: ${{ needs.changes.outputs.actions == 'true' }} 130 | steps: 131 | - name: Checkout code 132 | uses: actions/checkout@v6 133 | - name: actionlint 134 | uses: raven-actions/actionlint@v2 135 | -------------------------------------------------------------------------------- /test/mocks.lua: -------------------------------------------------------------------------------- 1 | -- Mocks for KOReader modules 2 | package.preload["libs/libkoreader-lfs"] = function() 3 | return { 4 | dir = function(path) 5 | -- Returns an iterator over files and directories in the path 6 | local files = {} 7 | local handle = io.popen(string.format("ls -A %q", path)) 8 | if handle then 9 | for entry in handle:lines() do 10 | table.insert(files, entry) 11 | end 12 | handle:close() 13 | end 14 | local i = 0 15 | return function() 16 | i = i + 1 17 | return files[i] 18 | end 19 | end, 20 | attributes = function(path) 21 | -- Escape double quotes in path to prevent command injection 22 | local safe_path = path:gsub('"', '\\"') 23 | local stat = io.popen(string.format('stat -c "%%F" "%s"', safe_path)) 24 | if stat then 25 | local mode = stat:read("*l") 26 | stat:close() 27 | if mode == "directory" then 28 | return { mode = "directory" } 29 | else 30 | return { mode = "file" } 31 | end 32 | end 33 | return nil 34 | end, 35 | mkdir = function(path) 36 | os.execute(string.format("mkdir -p %q", path)) 37 | return true 38 | end, 39 | } 40 | end 41 | package.preload["ui/trapper"] = function() 42 | return { 43 | info = function() 44 | return {} 45 | end, 46 | confirm = function() 47 | return {} 48 | end, 49 | clear = function() 50 | return {} 51 | end, 52 | wrap = function() 53 | return {} 54 | end, 55 | dismissableRunInSubprocess = function() 56 | return true 57 | end, 58 | setPausedText = function() end, 59 | } 60 | end 61 | package.preload["dispatcher"] = function() 62 | return { registerAction = function() end } 63 | end 64 | package.preload["docsettings"] = function() 65 | return { 66 | openSettingsFile = function() 67 | return { 68 | readSetting = function() 69 | return {} 70 | end, 71 | saveSetting = function() end, 72 | flushCustomMetadata = function() end, 73 | } 74 | end, 75 | } 76 | end 77 | package.preload["ui/event"] = function() 78 | return { 79 | new = function() 80 | return {} 81 | end, 82 | } 83 | end 84 | package.preload["apps/filemanager/filemanager"] = function() 85 | return { 86 | instance = { 87 | file_chooser = { path = "/tmp/comicmeta_test" }, 88 | }, 89 | } 90 | end 91 | package.preload["ui/widget/infomessage"] = function() 92 | return { 93 | new = function() 94 | return {} 95 | end, 96 | } 97 | end 98 | package.preload["ui/uimanager"] = function() 99 | return { 100 | show = function() end, 101 | broadcastEvent = function() end, 102 | } 103 | end 104 | package.preload["ui/widget/container/widgetcontainer"] = function() 105 | local mt = {} 106 | mt.__index = mt 107 | function mt:extend(tbl) 108 | setmetatable(tbl, self) 109 | return tbl 110 | end 111 | return setmetatable({}, mt) 112 | end 113 | package.preload["ffi/util"] = function() 114 | return { 115 | template = function(str, ...) 116 | return str 117 | end, 118 | realpath = function(path) 119 | return path 120 | end, 121 | } 122 | end 123 | package.preload["logger"] = function() 124 | return { 125 | dbg = function(...) end, 126 | } 127 | end 128 | package.preload["util"] = function() 129 | return { 130 | splitToArray = function(str, sep, _) 131 | return {} 132 | end, 133 | htmlEntitiesToUtf8 = function(str) 134 | return str 135 | end, 136 | trim = function(str) 137 | return str 138 | end, 139 | } 140 | end 141 | package.preload["gettext"] = function() 142 | return function(str) 143 | return str 144 | end 145 | end 146 | package.preload["ffi/archiver"] = function() end 147 | -------------------------------------------------------------------------------- /main.lua: -------------------------------------------------------------------------------- 1 | --[[-- 2 | Plugin for KOReader to extract metadata from comic (.cbz and .cbr) files as Custom Metadata 3 | 4 | @module koplugin.ComicMeta 5 | --]] 6 | -- 7 | package.path = package.path .. ";plugins/comicmeta.koplugin/lib/comiclib/?.lua" 8 | package.path = package.path .. ";plugins/comicmeta.koplugin/lib/comiclib/lib/?.lua" 9 | package.path = package.path .. ";plugins/comicmeta.koplugin/lib/comiclib/third_party/?/?.lua" 10 | 11 | local ComicLib = require("comiclib") 12 | local Dispatcher = require("dispatcher") -- luacheck:ignore 13 | local DocSettings = require("docsettings") 14 | local Event = require("ui/event") 15 | local FileManager = require("apps/filemanager/filemanager") 16 | local InfoMessage = require("ui/widget/infomessage") 17 | local Trapper = require("ui/trapper") 18 | local UIManager = require("ui/uimanager") 19 | local WidgetContainer = require("ui/widget/container/widgetcontainer") 20 | local ffiUtil = require("ffi/util") 21 | local lfs = require("libs/libkoreader-lfs") 22 | local logger = require("logger") 23 | local util = require("util") 24 | local T = ffiUtil.template 25 | local _ = require("gettext") 26 | 27 | local ComicMeta = WidgetContainer:extend({ 28 | name = "comicmeta", 29 | is_doc_only = false, 30 | }) 31 | 32 | --- Register our plugin setting 33 | function ComicMeta:onDispatcherRegisterActions() 34 | Dispatcher:registerAction( 35 | "comicmeta_action", 36 | { category = "none", event = "ComicMeta", title = _("Extract Comic Meta"), general = true } 37 | ) 38 | end 39 | 40 | --- Initiate our plugin 41 | function ComicMeta:init() 42 | self:onDispatcherRegisterActions() 43 | self.ui.menu:registerToMainMenu(self) 44 | end 45 | 46 | --- Add a main menu entry to the UI 47 | function ComicMeta:addToMainMenu(menu_items) 48 | menu_items.comic_meta = { 49 | text = _("Extract Comic Meta"), 50 | -- in which menu this should be appended 51 | sorting_hint = "more_tools", 52 | -- a callback when tapping 53 | callback = function() 54 | self:onComicMeta() 55 | end, 56 | } 57 | end 58 | 59 | --- Extract metadata from a comic archive 60 | --- 61 | -- @param comic_file string: full path to the comic file 62 | -- @return boolean: true on success, false on failure 63 | function ComicMeta:processFile(comic_file) 64 | local comicInfo, ok = ComicLib.ComicInfo:new(comic_file) 65 | if not ok or comicInfo == nil then 66 | logger.dbg(_("Failed to open comic file"), comic_file) 67 | return false 68 | end 69 | 70 | logger.dbg("ComicMeta -> processFile comicInfo.metadata", comicInfo.metadata) 71 | 72 | -- Parse the XML content and create a metadata table 73 | local metadata = { 74 | title = comicInfo.metadata.Title, 75 | authors = comicInfo.metadata.Writer, 76 | series = comicInfo.metadata.Series, 77 | series_index = comicInfo.metadata.Number, 78 | description = comicInfo.metadata.Summary, 79 | keywords = comicInfo.metadata.Tags, 80 | language = comicInfo.metadata.LanguageISO, 81 | } 82 | 83 | logger.dbg("ComicMeta -> processFile metadata", metadata) 84 | 85 | -- Fixup metadata 86 | for key, value in pairs(metadata) do 87 | if key == "keywords" then 88 | local out = "" 89 | local values = util.splitToArray(value, ",", false) 90 | for __, val in ipairs(values) do 91 | if #out > 0 then 92 | out = out .. "\n" 93 | end 94 | out = out .. util.htmlEntitiesToUtf8(util.trim(val)) 95 | end 96 | 97 | metadata[key] = out 98 | else 99 | metadata[key] = util.htmlEntitiesToUtf8(value) 100 | end 101 | end 102 | 103 | -- Retrieve current metadata 104 | local custom_doc_settings = DocSettings.openSettingsFile(comic_file) 105 | local doc_settings = DocSettings:open(comic_file) 106 | if not custom_doc_settings or not doc_settings then 107 | logger.dbg(T(_("Failed to open DocSettings for file: %1"), comic_file)) 108 | return false 109 | end 110 | 111 | -- Read the existing doc_props property 112 | local doc_props = custom_doc_settings:readSetting("doc_props") or {} 113 | local original_doc_props = {} 114 | for key, __ in pairs(metadata) do 115 | original_doc_props[key] = doc_props[key] or "" 116 | end 117 | custom_doc_settings:saveSetting("doc_props", original_doc_props) 118 | 119 | -- Update the custom properties with the new metadata 120 | for key, value in pairs(metadata) do 121 | doc_props[key] = value 122 | end 123 | 124 | -- Write the updated doc_props property back to the DocSettings 125 | custom_doc_settings:saveSetting("custom_props", doc_props) 126 | 127 | local has_toc = self:writeCustomToC(doc_settings, comicInfo.metadata.Pages) 128 | 129 | -- Save the updated metadata back to the metadata file 130 | custom_doc_settings:flushCustomMetadata(comic_file) 131 | if has_toc then 132 | doc_settings:flush() 133 | end 134 | 135 | return true 136 | end 137 | 138 | --- Scans a folder and returns a list of all comic files found. 139 | --- 140 | -- @param folder string: The folder to scan. 141 | -- @param recursive boolean: Whether or not to scan recursively. 142 | -- @return table: List of comic file paths. 143 | function ComicMeta:scanForComicFiles(folder, recursive) 144 | logger.dbg("ComicMeta -> scanForComicFiles scanning folder", folder, "recursive:", recursive) 145 | 146 | local comic_files = {} 147 | 148 | for entry in lfs.dir(folder) do 149 | if entry == "." or entry == ".." then 150 | goto continue 151 | end 152 | 153 | local full_path = folder .. "/" .. entry 154 | local attr = lfs.attributes(full_path) 155 | 156 | if not attr or (attr.mode ~= "directory" and attr.mode ~= "file") then 157 | goto continue -- Skip if it's not a file or directory 158 | end 159 | 160 | if attr.mode == "directory" and recursive then 161 | if entry:lower():match("%.sdr$") then -- Skip sidecar folders 162 | goto continue 163 | end 164 | 165 | logger.dbg("ComicMeta -> scanForComicFiles entering subdirectory", full_path) 166 | 167 | local sub_comic_files = self:scanForComicFiles(full_path, recursive) 168 | 169 | for _, f in ipairs(sub_comic_files) do 170 | table.insert(comic_files, f) 171 | end 172 | elseif attr.mode == "file" and (entry:lower():match("%.cbz$") or entry:lower():match("%.cbr$")) then 173 | logger.dbg("ComicMeta -> scanForComicFiles found comic file", full_path) 174 | 175 | table.insert(comic_files, full_path) 176 | end 177 | ::continue:: 178 | end 179 | 180 | if #comic_files == 0 then 181 | logger.dbg("ComicMeta -> scanForComicFiles no comic files found") 182 | end 183 | 184 | return comic_files 185 | end 186 | 187 | --- Checks if a folder contains any subdirectories. 188 | --- 189 | -- @param folder string: The folder to check. 190 | -- @return boolean: True if subdirectories exist, false otherwise. 191 | function ComicMeta:hasSubdirectories(folder) 192 | logger.dbg("ComicMeta -> hasSubdirectories checking folder", folder) 193 | 194 | for entry in lfs.dir(folder) do 195 | if entry == "." or entry == ".." then 196 | goto continue 197 | end 198 | 199 | local attr = lfs.attributes(folder .. "/" .. entry) 200 | 201 | if attr and attr.mode == "directory" and not entry:lower():match("%.sdr$") then 202 | logger.dbg("ComicMeta -> hasSubdirectories found subdirectory", entry) 203 | return true 204 | end 205 | ::continue:: 206 | end 207 | 208 | logger.dbg("ComicMeta -> hasSubdirectories no subdirectories found") 209 | 210 | return false 211 | end 212 | 213 | --- Processes all comic files in a folder, optionally recursively. 214 | --- 215 | -- @param folder string: The folder to process. 216 | -- @param recursive boolean: Whether to process subfolders recursively. 217 | function ComicMeta:processAllComics(folder, recursive) 218 | logger.dbg("ComicMeta -> processAllComics processing folder", folder, "recursive:", recursive) 219 | 220 | Trapper:setPausedText(_("Do you want to abort extraction?"), _("Abort"), _("Don't abort")) 221 | 222 | local doNotAbort = Trapper:info(_("Scanning for comics...")) 223 | if not doNotAbort then 224 | Trapper:clear() 225 | return 226 | end 227 | ffiUtil.sleep(2) -- Pause so that the user can see it 228 | 229 | local comic_files = self:scanForComicFiles(folder, recursive) 230 | 231 | if #comic_files == 0 then 232 | logger.dbg("ComicMeta -> processAllComics no comic files found") 233 | Trapper:info(_("No comics found.")) 234 | return 235 | end 236 | 237 | logger.dbg("ComicMeta -> processAllComics found", #comic_files, "comic files to process") 238 | 239 | local successes = 0 240 | 241 | for idx, file_path in ipairs(comic_files) do 242 | local real_path = ffiUtil.realpath(file_path) 243 | 244 | logger.dbg("ComicMeta -> processAllComics processing file", real_path) 245 | doNotAbort = Trapper:info( 246 | T( 247 | _([[ 248 | Extracting metadata... 249 | %1 / %2]]), 250 | idx, 251 | #comic_files 252 | ), 253 | true 254 | ) 255 | if not doNotAbort then 256 | Trapper:clear() 257 | return 258 | end 259 | 260 | local complete, success = Trapper:dismissableRunInSubprocess(function() 261 | return self:processFile(real_path) 262 | end) 263 | if complete and success then 264 | successes = successes + 1 265 | 266 | -- Update the book info in the file manager 267 | UIManager:broadcastEvent(Event:new("InvalidateMetadataCache", real_path)) 268 | UIManager:broadcastEvent(Event:new("BookMetadataChanged")) 269 | end 270 | end 271 | 272 | Trapper:clear() 273 | UIManager:show(InfoMessage:new({ 274 | text = T( 275 | _([[ 276 | Comic metadata extraction complete. 277 | Successfully extracted %1 / %2]]), 278 | successes, 279 | #comic_files 280 | ), 281 | })) 282 | end 283 | 284 | --- Writes a custom Table of Contents based on the Pages data from ComicInfo.xml 285 | --- Example xml: 286 | --- 287 | -- 288 | -- 289 | -- 290 | -- 291 | -- 292 | -- 293 | -- 294 | -- So to access these fields: 295 | -- pages_data.Page[1].Image, pages_data.Page[1].Bookmark, etc. 296 | -- 297 | -- For the structure of the ToC entries, see: 298 | -- https://github.com/koreader/koreader/blob/7e63f91c8e74af64089cefa187a17d664e261b35/frontend/apps/reader/modules/readerhandmade.lua#L23 299 | -- 300 | -- @param doc_settings: The DocSettings object for the file, this must be DocSettings:open(file) 301 | -- @param pages_data: The Pages data from the parsed ComicInfo.xml 302 | -- @return boolean: true if ToC was written, false if not 303 | function ComicMeta:writeCustomToC(doc_settings, pages_data) 304 | if not pages_data or not pages_data.Page then 305 | logger.dbg("ComicMeta -> writeCustomToC: No pages data found") 306 | 307 | return false 308 | end 309 | 310 | logger.dbg("ComicMeta -> writeCustomToC writing ToC from pages", #pages_data.Page) 311 | 312 | local toc = {} 313 | local pages = pages_data.Page 314 | 315 | for _, page in ipairs(pages) do 316 | if page.Bookmark and page.Bookmark ~= "" then 317 | -- Convert Image attribute to page number (add 1 since it's 0-based) 318 | local page_num = tonumber(page.Image) 319 | 320 | if page_num then 321 | table.insert(toc, { 322 | depth = 1, 323 | page = page_num + 1, -- Convert from 0-based to 1-based 324 | title = page.Bookmark, 325 | }) 326 | else 327 | logger.err("ComicMeta -> writeCustomToC: Invalid Image value for page", page.Image) 328 | end 329 | end 330 | end 331 | 332 | if #toc == 0 then 333 | logger.dbg("ComicMeta -> writeCustomToC: No bookmarked pages found") 334 | return false 335 | end 336 | 337 | logger.dbg("ComicMeta -> writeCustomToC: Created ToC with", #toc, "entries") 338 | 339 | doc_settings:saveSetting("handmade_toc", toc) 340 | doc_settings:saveSetting("handmade_toc_enabled", true) 341 | doc_settings:saveSetting("handmade_toc_edit_enabled", false) 342 | return true 343 | end 344 | 345 | --- This is basically the plugin's main() 346 | function ComicMeta:onComicMeta() 347 | if not FileManager.instance then 348 | return 349 | end 350 | 351 | local current_folder = FileManager.instance.file_chooser.path 352 | 353 | Trapper:wrap(function() 354 | local has_subdirs = self:hasSubdirectories(current_folder) 355 | local recursive = false 356 | 357 | local go_on = Trapper:confirm( 358 | _([[ 359 | This will extract comic metadata from comics in the current directory. 360 | Once extraction has started, you can abort at any moment by tapping on the screen. 361 | 362 | Standby will be prevented during extraction and may take time. 363 | It's recommended to keep your device plugged in, as this can use some battery power.]]), 364 | _("Cancel"), 365 | _("Continue") 366 | ) 367 | if not go_on then 368 | return 369 | end 370 | 371 | if has_subdirs then 372 | recursive = Trapper:confirm( 373 | _([[ 374 | Subfolders detected. 375 | Also extract comic metadata from comics in subdirectories?]]), 376 | -- @translators Extract comic metadata only for comics in this directory. 377 | _("Here only"), 378 | -- @translators Extract comic metadata for comics in this directory as well as in subdirectories. 379 | _("Here and under") 380 | ) 381 | end 382 | 383 | Trapper:clear() 384 | 385 | self:processAllComics(current_folder, recursive) 386 | end) 387 | end 388 | 389 | return ComicMeta 390 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------