mirror of
https://codeberg.org/scip/epuppy.git
synced 2025-12-17 12:31:02 +01:00
Compare commits
12 Commits
github
...
v0.0.7-cb1
| Author | SHA1 | Date | |
|---|---|---|---|
| 3a72204915 | |||
| 0516534526 | |||
| d260f5299f | |||
| 1f93d2d37d | |||
| 55addf2a77 | |||
| 06dec42e83 | |||
| fceee7bc04 | |||
| 8edca6d367 | |||
| 1ab65e69a0 | |||
| 7a62b2d19d | |||
| 030c1ba495 | |||
| 9b6f062c65 |
BIN
.github/assets/darkmode.png
vendored
Normal file
BIN
.github/assets/darkmode.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
.github/assets/help.png
vendored
Normal file
BIN
.github/assets/help.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
.github/assets/light.png
vendored
Normal file
BIN
.github/assets/light.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
BIN
.github/assets/margin.png
vendored
Normal file
BIN
.github/assets/margin.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
10
.github/dependabot.yml
vendored
10
.github/dependabot.yml
vendored
@@ -1,10 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: "gomod"
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: "monthly"
|
|
||||||
- package-ecosystem: "github-actions"
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: "monthly"
|
|
||||||
54
.github/workflows/ci.yaml
vendored
Normal file
54
.github/workflows/ci.yaml
vendored
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
name: build-and-test
|
||||||
|
on: [push]
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
version: [1.24.9]
|
||||||
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||||
|
name: Build
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
steps:
|
||||||
|
- name: Set up Go ${{ matrix.os }}
|
||||||
|
uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: '${{ matrix.version }}'
|
||||||
|
id: go
|
||||||
|
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
|
- name: build
|
||||||
|
run: go build
|
||||||
|
|
||||||
|
test:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
version: [1.24.9]
|
||||||
|
os: [ubuntu-latest]
|
||||||
|
name: Test
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
steps:
|
||||||
|
- name: Set up Go ${{ matrix.os }}
|
||||||
|
uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: '${{ matrix.version }}'
|
||||||
|
id: go
|
||||||
|
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
|
- name: test
|
||||||
|
run: go test -cover ./...
|
||||||
|
|
||||||
|
|
||||||
|
golangci:
|
||||||
|
name: Lintercheck
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: 1.24
|
||||||
|
- uses: actions/checkout@v5
|
||||||
|
- name: golangci-lint
|
||||||
|
uses: golangci/golangci-lint-action@v8
|
||||||
87
.github/workflows/release.yaml
vendored
Normal file
87
.github/workflows/release.yaml
vendored
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
name: build-release
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*.*.*"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Build Release Assets
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: 1.24.9
|
||||||
|
|
||||||
|
- name: Build the executables
|
||||||
|
run: ./mkrel.sh epuppy ${{ github.ref_name}}
|
||||||
|
|
||||||
|
- name: List the executables
|
||||||
|
run: ls -l ./releases
|
||||||
|
|
||||||
|
- name: Upload the binaries
|
||||||
|
uses: svenstaro/upload-release-action@v2
|
||||||
|
with:
|
||||||
|
repo_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
tag: ${{ github.ref_name }}
|
||||||
|
file: ./releases/*
|
||||||
|
file_glob: true
|
||||||
|
|
||||||
|
- name: Build Changelog
|
||||||
|
id: github_release
|
||||||
|
uses: mikepenz/release-changelog-builder-action@v5
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
mode: "PR"
|
||||||
|
configurationJson: |
|
||||||
|
{
|
||||||
|
"template": "#{{CHANGELOG}}\n\n**Full Changelog**: #{{RELEASE_DIFF}}",
|
||||||
|
"pr_template": "- #{{TITLE}} (##{{NUMBER}}) by #{{AUTHOR}}\n#{{BODY}}",
|
||||||
|
"empty_template": "- no changes",
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"title": "## New Features",
|
||||||
|
"labels": ["add", "feature"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "## Bug Fixes",
|
||||||
|
"labels": ["fix", "bug", "revert"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "## Documentation Enhancements",
|
||||||
|
"labels": ["doc"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "## Refactoring Efforts",
|
||||||
|
"labels": ["refactor"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "## Miscellaneus Changes",
|
||||||
|
"labels": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"ignore_labels": [
|
||||||
|
"duplicate", "good first issue", "help wanted", "invalid", "question", "wontfix"
|
||||||
|
],
|
||||||
|
"label_extractor": [
|
||||||
|
{
|
||||||
|
"pattern": "(.) (.+)",
|
||||||
|
"target": "$1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "(.) (.+)",
|
||||||
|
"target": "$1",
|
||||||
|
"on_property": "title"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
- name: Create Release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
body: ${{steps.github_release.outputs.changelog}}
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
|
|
||||||
|
|
||||||
version: 2
|
|
||||||
|
|
||||||
before:
|
|
||||||
hooks:
|
|
||||||
- go mod tidy
|
|
||||||
|
|
||||||
gitea_urls:
|
|
||||||
api: https://codeberg.org/api/v1
|
|
||||||
download: https://codeberg.org
|
|
||||||
|
|
||||||
builds:
|
|
||||||
- env:
|
|
||||||
- CGO_ENABLED=0
|
|
||||||
goos:
|
|
||||||
- linux
|
|
||||||
- windows
|
|
||||||
- darwin
|
|
||||||
- freebsd
|
|
||||||
|
|
||||||
archives:
|
|
||||||
- formats: [tar.gz]
|
|
||||||
# this name template makes the OS and Arch compatible with the results of `uname`.
|
|
||||||
name_template: >-
|
|
||||||
{{ .ProjectName }}_
|
|
||||||
{{- title .Os }}_
|
|
||||||
{{- if eq .Arch "amd64" }}x86_64
|
|
||||||
{{- else if eq .Arch "386" }}i386
|
|
||||||
{{- else }}{{ .Arch }}{{ end }}
|
|
||||||
{{- if .Arm }}v{{ .Arm }}{{ end }}_{{ .Tag }}
|
|
||||||
# use zip for windows archives
|
|
||||||
format_overrides:
|
|
||||||
- goos: windows
|
|
||||||
formats: [zip]
|
|
||||||
- goos: linux
|
|
||||||
formats: [tar.gz,binary]
|
|
||||||
files:
|
|
||||||
- src: "*.md"
|
|
||||||
strip_parent: true
|
|
||||||
- src: "docs/*"
|
|
||||||
strip_parent: true
|
|
||||||
- src: Makefile.dist
|
|
||||||
dst: Makefile
|
|
||||||
wrap_in_directory: true
|
|
||||||
|
|
||||||
changelog:
|
|
||||||
sort: asc
|
|
||||||
filters:
|
|
||||||
exclude:
|
|
||||||
- "^docs:"
|
|
||||||
- "^test:"
|
|
||||||
groups:
|
|
||||||
- title: Improved
|
|
||||||
regexp: '^.*?(feat|add|new)(\([[:word:]]+\))??!?:.+$'
|
|
||||||
order: 0
|
|
||||||
- title: Fixed
|
|
||||||
regexp: '^.*?(bug|fix)(\([[:word:]]+\))??!?:.+$'
|
|
||||||
order: 1
|
|
||||||
- title: Changed
|
|
||||||
order: 999
|
|
||||||
|
|
||||||
release:
|
|
||||||
header: "# Release Notes"
|
|
||||||
footer: >-
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Full Changelog: [{{ .PreviousTag }}...{{ .Tag }}](https://codeberg.org/scip/epuppy/compare/{{ .PreviousTag }}...{{ .Tag }})
|
|
||||||
28
.woodpecker/build.yaml
Normal file
28
.woodpecker/build.yaml
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
matrix:
|
||||||
|
platform:
|
||||||
|
- linux/amd64
|
||||||
|
goversion:
|
||||||
|
- 1.24
|
||||||
|
|
||||||
|
labels:
|
||||||
|
platform: ${platform}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
build:
|
||||||
|
when:
|
||||||
|
event: [push]
|
||||||
|
image: golang:${goversion}
|
||||||
|
commands:
|
||||||
|
- go get
|
||||||
|
- go build
|
||||||
|
- go test
|
||||||
|
|
||||||
|
linter:
|
||||||
|
when:
|
||||||
|
event: [push]
|
||||||
|
image: golang:${goversion}
|
||||||
|
commands:
|
||||||
|
#- go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.5.0
|
||||||
|
- curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.5.0
|
||||||
|
- golangci-lint --version
|
||||||
|
- golangci-lint run ./...
|
||||||
24
.woodpecker/release.yaml
Normal file
24
.woodpecker/release.yaml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# build release
|
||||||
|
|
||||||
|
labels:
|
||||||
|
platform: linux/amd64
|
||||||
|
|
||||||
|
steps:
|
||||||
|
build:
|
||||||
|
when:
|
||||||
|
event: [push]
|
||||||
|
image: golang:1.24
|
||||||
|
commands:
|
||||||
|
- go get
|
||||||
|
- ./mkrel.sh epuppy v1-${CI_COMMIT_SHA:0:8}
|
||||||
|
#- ./mkrel.sh epuppy ${CI_COMMIT_TAG}
|
||||||
|
|
||||||
|
publish:
|
||||||
|
when:
|
||||||
|
event: [push]
|
||||||
|
image: woodpeckerci/plugin-release
|
||||||
|
settings:
|
||||||
|
files:
|
||||||
|
- 'releases/epuppy-*-v1-${CI_COMMIT_SHA:0:8}'
|
||||||
|
api_key:
|
||||||
|
from_secret: DEPLOY_TOKEN
|
||||||
18
CODE_OF_CONDUCT.md
Normal file
18
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CODE_OF_CONDUCT.md (compact model)
|
||||||
|
|
||||||
|
Purpose: Maintain a collaborative, harassment-free environment focused
|
||||||
|
on shipping quality software.
|
||||||
|
|
||||||
|
Standards: Be respectful; assume good intent; no harassment; no
|
||||||
|
discrimination; keep critiques technical.
|
||||||
|
|
||||||
|
Scope: All project spaces (issues, PRs, forums, events).
|
||||||
|
|
||||||
|
Reporting: Email tom AT vondein DOT org. Acknowledge within 72 hours.
|
||||||
|
|
||||||
|
Enforcement: Two maintainers review, one recuses on
|
||||||
|
conflict. Sanctions range from warning to removal. Summary posted (no
|
||||||
|
personal details).
|
||||||
|
|
||||||
|
Escalation: If you believe maintainers handled a report in bad faith,
|
||||||
|
escalate to our foundation committee (link) for independent review.
|
||||||
94
CONTRIBUTING.md
Normal file
94
CONTRIBUTING.md
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
## Project Goals
|
||||||
|
|
||||||
|
The idea behind this project is to build a small TUI tool to be able
|
||||||
|
to just take a look into some epub file without the need to leave the
|
||||||
|
shell. It has to be fast enough to just peak into an ebook and should
|
||||||
|
be small and easy to understand.
|
||||||
|
|
||||||
|
There will be no GUI, no web interface, no public API of some sort, no
|
||||||
|
builtin interpreter. It is not intended to build a full blown ebook
|
||||||
|
reader.
|
||||||
|
|
||||||
|
The programming language used for this project will always be
|
||||||
|
[GOLANG](https://go.dev/) with the exception of the documentation
|
||||||
|
([Perl POD](https://perldoc.perl.org/perlpod)) and the Makefile.
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
You can contribute to this project in various ways:
|
||||||
|
|
||||||
|
## Open an issue
|
||||||
|
|
||||||
|
If you encounter a problem or don't understand how the program works
|
||||||
|
or if you think the documentation is unclear, please don't hesitate to
|
||||||
|
open an issue.
|
||||||
|
|
||||||
|
Please add as much information about the case as possible, such as:
|
||||||
|
|
||||||
|
- Your environment (operating system etc)
|
||||||
|
- program version
|
||||||
|
- Input data. Please replace sensitive information with mock data!
|
||||||
|
- Actual program output.
|
||||||
|
- Expected program output.
|
||||||
|
- Error message - if any.
|
||||||
|
|
||||||
|
Be aware that I am working on this (and some other) project in my
|
||||||
|
spare time which is scarce. Therefore please don't expect me to
|
||||||
|
respond to your query within hours or even days. Be patient, but I
|
||||||
|
WILL respond.
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
Code and documentation help is always much appreciated! Please follow
|
||||||
|
thes guidelines to successfully contribute:
|
||||||
|
|
||||||
|
- Every pull request shall be based on latest `development`
|
||||||
|
branch. `main` is only used for releases.
|
||||||
|
|
||||||
|
- Execute the unit tests before committing: `make test`. There shall
|
||||||
|
be no errors.
|
||||||
|
|
||||||
|
- Strive to be backwards compatible so that users who are already
|
||||||
|
using the program don't have to change their habits - unless it is
|
||||||
|
really neccessary.
|
||||||
|
|
||||||
|
- Try to add a unit test for your addition.
|
||||||
|
|
||||||
|
- Don't ever change existing unit tests!
|
||||||
|
|
||||||
|
- Add a meaningful and comprehensive rationale about your contribution:
|
||||||
|
- Why do you think it might be useful for others?
|
||||||
|
- What did you actually change or add?
|
||||||
|
- Is there an open issue which this PR fixes and if so, please link
|
||||||
|
to that issue.
|
||||||
|
|
||||||
|
- [Re-]format your code with `gofmt -s`.
|
||||||
|
|
||||||
|
- Avoid unneccesary dependencies, especially for very small functions.
|
||||||
|
|
||||||
|
- **If** a new dependency is being added, it must be compatible with
|
||||||
|
our [license agreement](LICENSE).
|
||||||
|
|
||||||
|
- You need to accept that the code or documentation you contribute
|
||||||
|
will be redistributed under the terms of said license agreement. If
|
||||||
|
your contribution is considerably large or if you contribute
|
||||||
|
regularly, then feel free to add your name and if you want your
|
||||||
|
email address to the *AUTHORS* section of the
|
||||||
|
manual page.
|
||||||
|
|
||||||
|
- Adhere to the above mentioned project goals.
|
||||||
|
|
||||||
|
- If you are unsure if your addition or change will be accepted,
|
||||||
|
better ask before starting coding. Open an issue about your proposal
|
||||||
|
and let's discuss it! That way we avoid doing unnessesary work on
|
||||||
|
both sides.
|
||||||
|
|
||||||
|
Each pull request will be carefully reviewed and if it is a useful
|
||||||
|
addition it will be accepted. However, please be prepared that
|
||||||
|
sometimes a PR will be rejected. The reasons may vary and will be
|
||||||
|
documented. Perhaps the above guidelines are not matched, or the
|
||||||
|
addition seems to be not so useful from my perspective, maybe there
|
||||||
|
are too much changes or there might be changes I don't even
|
||||||
|
understand.
|
||||||
|
|
||||||
|
But whatever happens: your contribution is always welcome!
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
87
Makefile
Normal file
87
Makefile
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
# Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# no need to modify anything below
|
||||||
|
tool = epuppy
|
||||||
|
VERSION = $(shell grep VERSION config.go | head -1 | cut -d '"' -f2)
|
||||||
|
archs = darwin freebsd linux windows
|
||||||
|
PREFIX = /usr/local
|
||||||
|
UID = root
|
||||||
|
GID = 0
|
||||||
|
HAVE_POD := $(shell pod2text -h 2>/dev/null)
|
||||||
|
|
||||||
|
all: buildlocal
|
||||||
|
|
||||||
|
|
||||||
|
buildlocal:
|
||||||
|
CGO_LDFLAGS='-static' go build -tags osusergo,netgo -ldflags "-extldflags=-static" -o $(tool)
|
||||||
|
|
||||||
|
install: buildlocal
|
||||||
|
install -d -o $(UID) -g $(GID) $(PREFIX)/bin
|
||||||
|
install -d -o $(UID) -g $(GID) $(PREFIX)/man/man1
|
||||||
|
install -o $(UID) -g $(GID) -m 555 $(tool) $(PREFIX)/sbin/
|
||||||
|
install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf $(tool) coverage.out testdata t/out
|
||||||
|
|
||||||
|
test: clean
|
||||||
|
mkdir -p t/out
|
||||||
|
go test ./... $(ARGS)
|
||||||
|
|
||||||
|
testlint: test lint
|
||||||
|
|
||||||
|
lint:
|
||||||
|
golangci-lint run
|
||||||
|
|
||||||
|
lint-full:
|
||||||
|
golangci-lint run --enable-all --exclude-use-default --disable exhaustivestruct,exhaustruct,depguard,interfacer,deadcode,golint,structcheck,scopelint,varcheck,ifshort,maligned,nosnakecase,godot,funlen,gofumpt,cyclop,noctx,gochecknoglobals,paralleltest
|
||||||
|
|
||||||
|
testfuzzy: clean
|
||||||
|
go test -fuzz ./... $(ARGS)
|
||||||
|
|
||||||
|
singletest:
|
||||||
|
@echo "Call like this: make singletest TEST=TestPrepareColumns ARGS=-v"
|
||||||
|
go test -run $(TEST) $(ARGS)
|
||||||
|
|
||||||
|
cover-report:
|
||||||
|
go test ./... -cover -coverprofile=coverage.out
|
||||||
|
go tool cover -html=coverage.out
|
||||||
|
|
||||||
|
goupdate:
|
||||||
|
go get -t -u=patch ./...
|
||||||
|
|
||||||
|
buildall:
|
||||||
|
./mkrel.sh $(tool) $(VERSION)
|
||||||
|
|
||||||
|
release:
|
||||||
|
gh release create v$(VERSION) --generate-notes
|
||||||
|
|
||||||
|
show-versions: buildlocal
|
||||||
|
@echo "### epuppy version:"
|
||||||
|
@./gfn -V
|
||||||
|
|
||||||
|
@echo
|
||||||
|
@echo "### go module versions:"
|
||||||
|
@go list -m all
|
||||||
|
|
||||||
|
@echo
|
||||||
|
@echo "### go version used for building:"
|
||||||
|
@grep -m 1 go go.mod
|
||||||
|
|
||||||
|
# lint:
|
||||||
|
# golangci-lint run -p bugs -p unused
|
||||||
36
README.md
36
README.md
@@ -1,12 +1,10 @@
|
|||||||
[](https://ci.codeberg.org/repos/15473)
|
[](https://ci.codeberg.org/repos/15473)
|
||||||
[](https://codeberg.org/scip/epuppy/raw/branch/master/LICENSE)
|
[](https://github.com/tlinden/epuppy/blob/master/LICENSE)
|
||||||
[](https://goreportcard.com/report/codeberg.org/scip/epuppy)
|
[](https://goreportcard.com/report/github.com/tlinden/epuppy)
|
||||||
|
|
||||||
|
|
||||||
# epuppy - terminal epub reader
|
# epuppy - terminal epub reader
|
||||||
|
|
||||||
> [!IMPORTANT]
|
|
||||||
> This app is now being maintained on [Codeberg](https://codeberg.org/scip/epuppy/).
|
|
||||||
|
|
||||||
This is a little TUI epub ebook reader. This is a work in progress and
|
This is a little TUI epub ebook reader. This is a work in progress and
|
||||||
may not work for all EPUB files yet. It uses a modified version of the
|
may not work for all EPUB files yet. It uses a modified version of the
|
||||||
[epub module](https://github.com/kapmahc/epub/), which seems to be
|
[epub module](https://github.com/kapmahc/epub/), which seems to be
|
||||||
@@ -22,21 +20,17 @@ long run.
|
|||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
### Viewing an ebook in dark mode
|
- Viewing an ebook in dark mode
|
||||||
|
|
||||||
|
|
||||||
|
- Viewing an ebook in light mode
|
||||||
|
|
||||||
|
|
||||||
### Viewing an ebook in light mode
|
- You can interactively adjust text width
|
||||||
|
|
||||||
|
|
||||||
|
- Showing the help
|
||||||
|
|
||||||
### You can interactively adjust text width
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Showing the help
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -107,10 +101,10 @@ your platform from the releases page and you're good to go.
|
|||||||
|
|
||||||
You can use [stew](https://github.com/marwanhawari/stew) to install epuppy:
|
You can use [stew](https://github.com/marwanhawari/stew) to install epuppy:
|
||||||
```default
|
```default
|
||||||
stew install https://codeberg.org/scip/epuppy
|
stew install tlinden/epuppy
|
||||||
```
|
```
|
||||||
|
|
||||||
Or go to the [latest release page](https://codeberg.org/scip/epuppy/releases/)
|
Or go to the [latest release page](https://github.com/TLINDEN/epuppy/releases/latest)
|
||||||
and look for your OS and platform. There are two options to install the binary:
|
and look for your OS and platform. There are two options to install the binary:
|
||||||
|
|
||||||
Directly download the binary for your platform,
|
Directly download the binary for your platform,
|
||||||
@@ -150,7 +144,7 @@ sudo make install
|
|||||||
|
|
||||||
# Report bugs
|
# Report bugs
|
||||||
|
|
||||||
[Please open an issue](https://codeberg.org/scip/epuppy/issues). Thanks!
|
[Please open an issue](https://github.com/TLINDEN/epuppy/issues). Thanks!
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
|
|||||||
79
cmd/colors.go
Normal file
79
cmd/colors.go
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/charmbracelet/lipgloss"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ColorSetting struct {
|
||||||
|
Title string `koanf:"title"`
|
||||||
|
Chapter string `koanf:"chapter"`
|
||||||
|
Body string `koanf:"body"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Colors struct {
|
||||||
|
Title lipgloss.Style
|
||||||
|
Chapter lipgloss.Style
|
||||||
|
Body lipgloss.Style
|
||||||
|
}
|
||||||
|
|
||||||
|
func SetColorconfig(defaultdark, defaultlight ColorSetting, conf *Config) Colors {
|
||||||
|
var defaults, user ColorSetting
|
||||||
|
|
||||||
|
switch conf.Darkmode {
|
||||||
|
case true:
|
||||||
|
defaults = defaultdark
|
||||||
|
user = conf.ColorDark
|
||||||
|
default:
|
||||||
|
defaults = defaultlight
|
||||||
|
user = conf.ColorLight
|
||||||
|
}
|
||||||
|
|
||||||
|
var colors Colors
|
||||||
|
var fg string
|
||||||
|
|
||||||
|
border := lipgloss.RoundedBorder()
|
||||||
|
border.Right = "├"
|
||||||
|
styletitle := lipgloss.NewStyle().BorderStyle(border).Padding(0, 1)
|
||||||
|
|
||||||
|
if user.Title != "" {
|
||||||
|
fg = user.Title
|
||||||
|
} else {
|
||||||
|
fg = defaults.Title
|
||||||
|
}
|
||||||
|
|
||||||
|
colors.Title = styletitle.Foreground(lipgloss.Color(fg))
|
||||||
|
|
||||||
|
if user.Chapter != "" {
|
||||||
|
fg = user.Chapter
|
||||||
|
} else {
|
||||||
|
fg = defaults.Chapter
|
||||||
|
}
|
||||||
|
|
||||||
|
colors.Chapter = lipgloss.NewStyle().Foreground(lipgloss.Color(fg))
|
||||||
|
|
||||||
|
if user.Body != "" {
|
||||||
|
fg = user.Body
|
||||||
|
} else {
|
||||||
|
fg = defaults.Body
|
||||||
|
}
|
||||||
|
|
||||||
|
colors.Body = lipgloss.NewStyle().Foreground(lipgloss.Color(fg))
|
||||||
|
|
||||||
|
return colors
|
||||||
|
}
|
||||||
179
cmd/config.go
Normal file
179
cmd/config.go
Normal file
@@ -0,0 +1,179 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/alecthomas/repr"
|
||||||
|
"github.com/knadh/koanf/parsers/toml"
|
||||||
|
"github.com/knadh/koanf/providers/file"
|
||||||
|
"github.com/knadh/koanf/providers/posflag"
|
||||||
|
"github.com/knadh/koanf/v2"
|
||||||
|
flag "github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
Version string = `v0.0.7`
|
||||||
|
Usage string = `This is epuppy, a terminal ui ebook viewer.
|
||||||
|
|
||||||
|
Usage: epuppy [options] <epub file>
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-D --dark enable dark mode
|
||||||
|
-s --store-progress remember reading position
|
||||||
|
-n --line-numbers add line numbers
|
||||||
|
-c --config <file> use config <file>
|
||||||
|
-i --cover-image display cover image
|
||||||
|
-t --txt dump readable content to STDOUT
|
||||||
|
-x --xml dump source xml to STDOUT
|
||||||
|
-N --no-color disable colors (or use $NO_COLOR env var)
|
||||||
|
-d --debug enable debugging
|
||||||
|
-h --help show help message
|
||||||
|
-v --version show program version`
|
||||||
|
)
|
||||||
|
|
||||||
|
type Config struct {
|
||||||
|
Showversion bool `koanf:"version"` // -v
|
||||||
|
Debug bool `koanf:"debug"` // -d
|
||||||
|
StoreProgress bool `koanf:"store-progress"` // -s
|
||||||
|
Darkmode bool `koanf:"dark"` // -D
|
||||||
|
LineNumbers bool `koanf:"line-numbers"` // -n
|
||||||
|
Dump bool `koanf:"txt"` // -t
|
||||||
|
XML bool `koanf:"xml"` // -x
|
||||||
|
NoColor bool `koanf:"no-color"` // -n
|
||||||
|
Config string `koanf:"config"` // -c
|
||||||
|
ColorDark ColorSetting `koanf:"colordark"` // comes from config file only
|
||||||
|
ColorLight ColorSetting `koanf:"colorlight"` // comes from config file only
|
||||||
|
ShowHelp bool `koanf:"help"`
|
||||||
|
ShowCover bool `koanf:"cover-image"` // -i
|
||||||
|
Colors Colors // generated from user config file or internal defaults, respects dark mode
|
||||||
|
Document string
|
||||||
|
InitialProgress int // lines
|
||||||
|
}
|
||||||
|
|
||||||
|
func InitConfig(output io.Writer) (*Config, error) {
|
||||||
|
var kloader = koanf.New(".")
|
||||||
|
|
||||||
|
// setup custom usage
|
||||||
|
flagset := flag.NewFlagSet("config", flag.ContinueOnError)
|
||||||
|
flagset.Usage = func() {
|
||||||
|
_, err := fmt.Fprintln(output, Usage)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("failed to print to output: %s", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parse commandline flags
|
||||||
|
flagset.BoolP("version", "v", false, "show program version")
|
||||||
|
flagset.BoolP("debug", "d", false, "enable debugging")
|
||||||
|
flagset.BoolP("dark", "D", false, "enable dark mode")
|
||||||
|
flagset.BoolP("store-progress", "s", false, "store reading progress")
|
||||||
|
flagset.BoolP("line-numbers", "n", false, "add line numbers")
|
||||||
|
flagset.BoolP("txt", "t", false, "dump readable content to STDOUT")
|
||||||
|
flagset.BoolP("xml", "x", false, "dump xml to STDOUT")
|
||||||
|
flagset.BoolP("no-color", "N", false, "disable colors")
|
||||||
|
flagset.BoolP("cover-image", "i", false, "show cover image")
|
||||||
|
flagset.BoolP("help", "h", false, "show help")
|
||||||
|
flagset.StringP("config", "c", "", "read config from file")
|
||||||
|
|
||||||
|
if err := flagset.Parse(os.Args[1:]); err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to parse program arguments: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// generate a list of config files to try to load, including the
|
||||||
|
// one provided via -c, if any
|
||||||
|
var configfiles []string
|
||||||
|
|
||||||
|
configfile, _ := flagset.GetString("config")
|
||||||
|
home, _ := os.UserHomeDir()
|
||||||
|
|
||||||
|
if configfile != "" {
|
||||||
|
configfiles = []string{configfile}
|
||||||
|
} else {
|
||||||
|
configfiles = []string{
|
||||||
|
"/etc/epuppy.toml", "/usr/local/etc/epuppy.toml", // unix variants
|
||||||
|
filepath.Join(home, ".config", "epuppy", "config.toml"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load the config file[s]
|
||||||
|
for _, cfgfile := range configfiles {
|
||||||
|
if path, err := os.Stat(cfgfile); !os.IsNotExist(err) {
|
||||||
|
if !path.IsDir() {
|
||||||
|
if err := kloader.Load(file.Provider(cfgfile), toml.Parser()); err != nil {
|
||||||
|
return nil, fmt.Errorf("error loading config file: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} // else: we ignore the file if it doesn't exists
|
||||||
|
}
|
||||||
|
|
||||||
|
// command line setup
|
||||||
|
if err := kloader.Load(posflag.Provider(flagset, ".", kloader), nil); err != nil {
|
||||||
|
return nil, fmt.Errorf("error loading flags: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetch values
|
||||||
|
conf := &Config{}
|
||||||
|
if err := kloader.Unmarshal("", &conf); err != nil {
|
||||||
|
return nil, fmt.Errorf("error unmarshalling: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// arg is the epub file
|
||||||
|
if len(flagset.Args()) > 0 {
|
||||||
|
conf.Document = flagset.Args()[0]
|
||||||
|
} else {
|
||||||
|
if !conf.Showversion && !conf.ShowHelp {
|
||||||
|
flagset.Usage()
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.Debug {
|
||||||
|
repr.Println(conf)
|
||||||
|
}
|
||||||
|
|
||||||
|
// setup color config
|
||||||
|
conf.Colors = SetColorconfig(
|
||||||
|
ColorSetting{ // Dark
|
||||||
|
Title: "#ff4500",
|
||||||
|
Chapter: "#ff4500",
|
||||||
|
Body: "#cdb79e",
|
||||||
|
},
|
||||||
|
ColorSetting{ // Light
|
||||||
|
Title: "#ff0000",
|
||||||
|
Chapter: "#8b0000",
|
||||||
|
Body: "#696969",
|
||||||
|
},
|
||||||
|
conf)
|
||||||
|
|
||||||
|
// disable colors if requested by command line
|
||||||
|
if conf.NoColor {
|
||||||
|
_ = os.Setenv("NO_COLOR", "1")
|
||||||
|
}
|
||||||
|
|
||||||
|
return conf, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Config) GetConfigDir() string {
|
||||||
|
home, _ := os.UserHomeDir()
|
||||||
|
return filepath.Join(home, ".config", "epuppy")
|
||||||
|
}
|
||||||
353
cmd/pager.go
Normal file
353
cmd/pager.go
Normal file
@@ -0,0 +1,353 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
// pager setup using bubbletea
|
||||||
|
// file shamlelessly copied from:
|
||||||
|
// https://github.com/charmbracelet/bubbletea/tree/main/examples/pager
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"image"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/blacktop/go-termimg"
|
||||||
|
"github.com/charmbracelet/bubbles/help"
|
||||||
|
"github.com/charmbracelet/bubbles/key"
|
||||||
|
"github.com/charmbracelet/bubbles/viewport"
|
||||||
|
tea "github.com/charmbracelet/bubbletea"
|
||||||
|
"github.com/charmbracelet/lipgloss"
|
||||||
|
"github.com/muesli/reflow/wordwrap"
|
||||||
|
"golang.org/x/term"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
titleStyle = func() lipgloss.Style {
|
||||||
|
b := lipgloss.RoundedBorder()
|
||||||
|
b.Right = "├"
|
||||||
|
return lipgloss.NewStyle().BorderStyle(b).Padding(0, 1)
|
||||||
|
}()
|
||||||
|
|
||||||
|
infoStyle = func() lipgloss.Style {
|
||||||
|
b := lipgloss.RoundedBorder()
|
||||||
|
b.Left = "┤"
|
||||||
|
return titleStyle.BorderStyle(b)
|
||||||
|
}()
|
||||||
|
|
||||||
|
viewstyle = lipgloss.NewStyle()
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
MarginStep = 5
|
||||||
|
MinSize = 40
|
||||||
|
)
|
||||||
|
|
||||||
|
type Meta struct {
|
||||||
|
lines int
|
||||||
|
currentline int
|
||||||
|
initialprogress int
|
||||||
|
}
|
||||||
|
|
||||||
|
type keyMap struct {
|
||||||
|
Up key.Binding
|
||||||
|
Down key.Binding
|
||||||
|
Left key.Binding
|
||||||
|
Right key.Binding
|
||||||
|
Help key.Binding
|
||||||
|
Quit key.Binding
|
||||||
|
ToggleUI key.Binding
|
||||||
|
Pad key.Binding
|
||||||
|
}
|
||||||
|
|
||||||
|
func (k keyMap) FullHelp() [][]key.Binding {
|
||||||
|
return [][]key.Binding{
|
||||||
|
// every item is one column
|
||||||
|
{k.Up, k.Down, k.Left, k.Right},
|
||||||
|
{k.Pad}, // fake key, we use it as spacing between columns
|
||||||
|
{k.Help, k.Quit, k.ToggleUI},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (k keyMap) ShortHelp() []key.Binding {
|
||||||
|
return []key.Binding{k.Help, k.Quit}
|
||||||
|
}
|
||||||
|
|
||||||
|
var keys = keyMap{
|
||||||
|
Pad: key.NewBinding(
|
||||||
|
key.WithKeys("__"),
|
||||||
|
key.WithHelp(" ", ""),
|
||||||
|
),
|
||||||
|
Up: key.NewBinding(
|
||||||
|
key.WithKeys("up", "k"),
|
||||||
|
key.WithHelp("↑", "move up"),
|
||||||
|
),
|
||||||
|
Down: key.NewBinding(
|
||||||
|
key.WithKeys("down", "j"),
|
||||||
|
key.WithHelp("↓", "move down"),
|
||||||
|
),
|
||||||
|
Left: key.NewBinding(
|
||||||
|
key.WithKeys("left"),
|
||||||
|
key.WithHelp("←", "decrease text width"),
|
||||||
|
),
|
||||||
|
Right: key.NewBinding(
|
||||||
|
key.WithKeys("right"),
|
||||||
|
key.WithHelp("→", "increase text width"),
|
||||||
|
),
|
||||||
|
Help: key.NewBinding(
|
||||||
|
key.WithKeys("?"),
|
||||||
|
key.WithHelp("?", "toggle help"),
|
||||||
|
),
|
||||||
|
Quit: key.NewBinding(
|
||||||
|
key.WithKeys("q", "esc", "ctrl+c"),
|
||||||
|
key.WithHelp("q", "quit"),
|
||||||
|
),
|
||||||
|
ToggleUI: key.NewBinding(
|
||||||
|
key.WithKeys("h"),
|
||||||
|
key.WithHelp("h", "toggle ui"),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
type Doc struct {
|
||||||
|
content string
|
||||||
|
title string
|
||||||
|
ready bool
|
||||||
|
viewport viewport.Model
|
||||||
|
initialwidth int
|
||||||
|
lastwidth int
|
||||||
|
margin int
|
||||||
|
marginMod bool
|
||||||
|
hideUi bool
|
||||||
|
meta *Meta
|
||||||
|
config *Config
|
||||||
|
Cover *termimg.ImageWidget
|
||||||
|
|
||||||
|
keys keyMap
|
||||||
|
help help.Model
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m Doc) Init() tea.Cmd {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m Doc) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
|
||||||
|
var (
|
||||||
|
cmd tea.Cmd
|
||||||
|
cmds []tea.Cmd
|
||||||
|
)
|
||||||
|
|
||||||
|
switch msg := msg.(type) {
|
||||||
|
case tea.KeyMsg:
|
||||||
|
switch {
|
||||||
|
case key.Matches(msg, m.keys.Help):
|
||||||
|
m.help.ShowAll = !m.help.ShowAll
|
||||||
|
case key.Matches(msg, m.keys.Quit):
|
||||||
|
return m, tea.Quit
|
||||||
|
case key.Matches(msg, m.keys.Left):
|
||||||
|
if m.lastwidth-(m.margin*2) >= MinSize {
|
||||||
|
m.margin += MarginStep
|
||||||
|
m.marginMod = true
|
||||||
|
}
|
||||||
|
case key.Matches(msg, m.keys.Right):
|
||||||
|
if m.margin >= MarginStep {
|
||||||
|
m.margin -= MarginStep
|
||||||
|
m.marginMod = true
|
||||||
|
}
|
||||||
|
case key.Matches(msg, m.keys.ToggleUI):
|
||||||
|
m.hideUi = !m.hideUi
|
||||||
|
}
|
||||||
|
|
||||||
|
case tea.WindowSizeMsg:
|
||||||
|
headerHeight := lipgloss.Height(m.headerView())
|
||||||
|
footerHeight := lipgloss.Height(m.footerView())
|
||||||
|
verticalMarginHeight := headerHeight + footerHeight
|
||||||
|
|
||||||
|
if !m.ready {
|
||||||
|
// Since this program is using the full size of the viewport we
|
||||||
|
// need to wait until we've received the window dimensions before
|
||||||
|
// we can initialize the viewport. The initial dimensions come in
|
||||||
|
// quickly, though asynchronously, which is why we wait for them
|
||||||
|
// here.
|
||||||
|
m.viewport = viewport.New(msg.Width, msg.Height-verticalMarginHeight)
|
||||||
|
m.viewport.YPosition = headerHeight
|
||||||
|
|
||||||
|
m.Rewrap()
|
||||||
|
m.ready = true
|
||||||
|
} else {
|
||||||
|
m.viewport.Width = msg.Width
|
||||||
|
m.viewport.Height = msg.Height - verticalMarginHeight
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m.Rewrap()
|
||||||
|
|
||||||
|
// Handle keyboard and mouse events in the viewport
|
||||||
|
m.viewport, cmd = m.viewport.Update(msg)
|
||||||
|
cmds = append(cmds, cmd)
|
||||||
|
|
||||||
|
return m, tea.Batch(cmds...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// re-calculate word wrapping, add left margin, recalculate line count
|
||||||
|
func (m *Doc) Rewrap() {
|
||||||
|
var content string
|
||||||
|
|
||||||
|
// width has changed, either because the terminal size changed or
|
||||||
|
// because the user added some margin
|
||||||
|
if m.lastwidth != m.viewport.Width || m.marginMod {
|
||||||
|
content = wordwrap.String(m.content, m.viewport.Width-(m.margin*2))
|
||||||
|
m.lastwidth = m.viewport.Width
|
||||||
|
m.marginMod = false
|
||||||
|
|
||||||
|
m.viewport.Style = viewstyle.MarginLeft(m.margin)
|
||||||
|
}
|
||||||
|
|
||||||
|
// bootstrapping, initialize with default width
|
||||||
|
if !m.ready {
|
||||||
|
content = wordwrap.String(m.content, m.initialwidth)
|
||||||
|
}
|
||||||
|
|
||||||
|
// wrapping has changed, update viewport and line count
|
||||||
|
if content != "" {
|
||||||
|
if m.Cover != nil {
|
||||||
|
cover, _ := m.Cover.Render()
|
||||||
|
m.viewport.SetContent(cover + "\n\n" + content)
|
||||||
|
} else {
|
||||||
|
m.viewport.SetContent(content)
|
||||||
|
}
|
||||||
|
m.meta.lines = len(strings.Split(content, "\n"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// during bootstrapping: jump to last remembered position, if any
|
||||||
|
if !m.ready {
|
||||||
|
m.viewport.ScrollDown(m.meta.initialprogress)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m Doc) View() string {
|
||||||
|
if !m.ready {
|
||||||
|
return "\n Initializing..."
|
||||||
|
}
|
||||||
|
|
||||||
|
// update current line for later saving
|
||||||
|
m.meta.currentline = int(float64(m.meta.lines) * m.viewport.ScrollPercent())
|
||||||
|
|
||||||
|
var helpView string
|
||||||
|
if m.help.ShowAll {
|
||||||
|
helpView = "\n" + m.help.View(m.keys)
|
||||||
|
}
|
||||||
|
|
||||||
|
if m.hideUi {
|
||||||
|
return fmt.Sprintf("%s\n%s", m.viewport.View(), helpView)
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("%s\n%s\n%s%s", m.headerView(), m.viewport.View(), m.footerView(), helpView)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m Doc) headerView() string {
|
||||||
|
title := m.config.Colors.Title.Render(m.title)
|
||||||
|
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(title)))
|
||||||
|
return lipgloss.JoinHorizontal(lipgloss.Center, title, line)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m Doc) footerView() string {
|
||||||
|
info := infoStyle.Render(fmt.Sprintf("%3.f%%", m.viewport.ScrollPercent()*100))
|
||||||
|
|
||||||
|
line := strings.Repeat("─", max(0, m.viewport.Width-lipgloss.Width(info)))
|
||||||
|
return lipgloss.JoinHorizontal(lipgloss.Center, line, info)
|
||||||
|
}
|
||||||
|
|
||||||
|
func max(a, b int) int {
|
||||||
|
if a > b {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
type Ebook struct {
|
||||||
|
Config *Config
|
||||||
|
Title string
|
||||||
|
Body string
|
||||||
|
Cover []byte
|
||||||
|
MediaType string
|
||||||
|
}
|
||||||
|
|
||||||
|
func Pager(book *Ebook) (int, error) {
|
||||||
|
width := 80
|
||||||
|
scrollto := 0
|
||||||
|
|
||||||
|
if term.IsTerminal(int(os.Stdout.Fd())) {
|
||||||
|
w, _, err := term.GetSize(0)
|
||||||
|
if err == nil {
|
||||||
|
width = w
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if book.Config.StoreProgress {
|
||||||
|
scrollto = book.Config.InitialProgress
|
||||||
|
}
|
||||||
|
|
||||||
|
if book.Config.LineNumbers {
|
||||||
|
catn := ""
|
||||||
|
for idx, line := range strings.Split(book.Body, "\n") {
|
||||||
|
catn += fmt.Sprintf("%4d: %s\n", idx, line)
|
||||||
|
}
|
||||||
|
book.Body = catn
|
||||||
|
}
|
||||||
|
|
||||||
|
meta := Meta{
|
||||||
|
initialprogress: scrollto,
|
||||||
|
lines: len(strings.Split(book.Body, "\n")),
|
||||||
|
}
|
||||||
|
|
||||||
|
doc := Doc{
|
||||||
|
content: book.Body,
|
||||||
|
title: book.Title,
|
||||||
|
initialwidth: width,
|
||||||
|
meta: &meta,
|
||||||
|
config: book.Config,
|
||||||
|
keys: keys,
|
||||||
|
}
|
||||||
|
|
||||||
|
if book.MediaType != "" && book.Config.ShowCover {
|
||||||
|
img, _, err := image.Decode(bytes.NewReader(book.Cover))
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("failed to load cover image: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
doc.Cover = termimg.NewImageWidgetFromImage(img)
|
||||||
|
doc.Cover.SetSize(width, width).SetProtocol(termimg.Auto)
|
||||||
|
}
|
||||||
|
|
||||||
|
p := tea.NewProgram(
|
||||||
|
doc,
|
||||||
|
tea.WithAltScreen(), // use the full size of the terminal in its "alternate screen buffer"
|
||||||
|
tea.WithMouseCellMotion(), // turn on mouse support so we can track the mouse wheel
|
||||||
|
)
|
||||||
|
|
||||||
|
if _, err := p.Run(); err != nil {
|
||||||
|
return 0, fmt.Errorf("could not run pager: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if book.Config.Debug {
|
||||||
|
fmt.Printf("scrollto: %d, last: %d, diff: %d\n",
|
||||||
|
scrollto, meta.currentline, scrollto-meta.currentline)
|
||||||
|
}
|
||||||
|
|
||||||
|
return meta.currentline, nil
|
||||||
|
}
|
||||||
119
cmd/prepare.go
Normal file
119
cmd/prepare.go
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/alecthomas/repr"
|
||||||
|
"github.com/tlinden/epuppy/pkg/epub"
|
||||||
|
)
|
||||||
|
|
||||||
|
func Prepare(conf *Config) (*Ebook, error) {
|
||||||
|
switch filepath.Ext(conf.Document) {
|
||||||
|
case ".epub":
|
||||||
|
return PrepareEpub(conf)
|
||||||
|
default:
|
||||||
|
return PrepareText(conf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func PrepareText(conf *Config) (*Ebook, error) {
|
||||||
|
data, err := os.ReadFile(conf.Document)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &Ebook{
|
||||||
|
Config: conf,
|
||||||
|
Title: conf.Document,
|
||||||
|
Body: string(data),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func PrepareEpub(conf *Config) (*Ebook, error) {
|
||||||
|
book, err := epub.Open(conf.Document, conf.XML)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.Debug {
|
||||||
|
repr.Println("book.Files()")
|
||||||
|
repr.Println(book.Files())
|
||||||
|
repr.Println(book.Ncx)
|
||||||
|
repr.Println(book.Sections)
|
||||||
|
repr.Println(book.Opf.Manifest)
|
||||||
|
}
|
||||||
|
|
||||||
|
buf := strings.Builder{}
|
||||||
|
head := strings.Builder{}
|
||||||
|
|
||||||
|
for _, creator := range book.Opf.Metadata.Creator {
|
||||||
|
head.WriteString(creator.Data)
|
||||||
|
head.WriteString(" ")
|
||||||
|
}
|
||||||
|
|
||||||
|
head.WriteString("- ")
|
||||||
|
|
||||||
|
for _, title := range book.Opf.Metadata.Title {
|
||||||
|
head.WriteString(title)
|
||||||
|
head.WriteString(" ")
|
||||||
|
}
|
||||||
|
|
||||||
|
fetchByContent(conf, &buf, book)
|
||||||
|
|
||||||
|
return &Ebook{
|
||||||
|
Config: conf,
|
||||||
|
Title: head.String(),
|
||||||
|
Body: buf.String(),
|
||||||
|
Cover: book.CoverImage,
|
||||||
|
MediaType: book.CoverMediaType,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fetchByContent(conf *Config, buf *strings.Builder, book *epub.Book) bool {
|
||||||
|
chapter := 1
|
||||||
|
var gotbody bool
|
||||||
|
|
||||||
|
for _, content := range book.Content {
|
||||||
|
if len(content.Body) > 0 {
|
||||||
|
if content.Title != "" {
|
||||||
|
buf.WriteString(conf.Colors.Chapter.
|
||||||
|
Render(fmt.Sprintf("──────┤ %s ├──────", content.Title)))
|
||||||
|
|
||||||
|
}
|
||||||
|
buf.WriteString("\r\n\r\n")
|
||||||
|
|
||||||
|
if conf.Dump {
|
||||||
|
// avoid excess whitespaces when printing to stdout
|
||||||
|
buf.WriteString(content.Body)
|
||||||
|
} else {
|
||||||
|
buf.WriteString(conf.Colors.Body.Render(content.Body))
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.WriteString("\r\n\r\n\r\n\r\n")
|
||||||
|
chapter++
|
||||||
|
|
||||||
|
gotbody = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return gotbody
|
||||||
|
}
|
||||||
88
cmd/root.go
Normal file
88
cmd/root.go
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
func Die(err error) int {
|
||||||
|
fmt.Fprintln(os.Stderr, "Error: ", err.Error())
|
||||||
|
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
func Execute(output io.Writer) int {
|
||||||
|
conf, err := InitConfig(output)
|
||||||
|
if err != nil {
|
||||||
|
return Die(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.Showversion {
|
||||||
|
_, err := fmt.Fprintf(output, "This is epuppy version %s\n", Version)
|
||||||
|
if err != nil {
|
||||||
|
return Die(fmt.Errorf("failed to print to output: %s", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.ShowHelp {
|
||||||
|
_, err := fmt.Fprintln(output, Usage)
|
||||||
|
if err != nil {
|
||||||
|
return Die(fmt.Errorf("failed to print to output: %s", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.StoreProgress {
|
||||||
|
progress, err := GetProgress(conf)
|
||||||
|
if err == nil {
|
||||||
|
conf.InitialProgress = int(progress)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ebook, err := Prepare(conf)
|
||||||
|
if err != nil {
|
||||||
|
return Die(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.Dump {
|
||||||
|
fmt.Println(ebook.Body)
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.Debug || conf.XML {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
progress, err := Pager(ebook)
|
||||||
|
if err != nil {
|
||||||
|
return Die(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if conf.StoreProgress {
|
||||||
|
if err := StoreProgress(conf, progress); err != nil {
|
||||||
|
return Die(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
110
cmd/store.go
Normal file
110
cmd/store.go
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
nonprintable = regexp.MustCompile(`[^a-zA-Z0-9\-\._]+`)
|
||||||
|
slugify = regexp.MustCompile(`[/\\]`)
|
||||||
|
suffix = regexp.MustCompile(`\.[a-z]+$`)
|
||||||
|
)
|
||||||
|
|
||||||
|
func StoreProgress(conf *Config, progress int) error {
|
||||||
|
cfgpath := conf.GetConfigDir()
|
||||||
|
|
||||||
|
if err := Mkdir(cfgpath); err != nil {
|
||||||
|
return fmt.Errorf("failed to mkdir config path %s: %w", cfgpath, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
filename := filepath.Join(cfgpath, Slug(conf.Document))
|
||||||
|
|
||||||
|
fd, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY, 0644)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to open state file %s: %w", filename, err)
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if err := fd.Close(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
if err := fd.Truncate(0); err != nil {
|
||||||
|
return fmt.Errorf("failed to truncate state file %s: %w", filename, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = fmt.Fprintf(fd, "%d\n", progress)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to write to state file %s: %w", filename, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func GetProgress(conf *Config) (int64, error) {
|
||||||
|
cfgpath := conf.GetConfigDir()
|
||||||
|
|
||||||
|
filename := filepath.Join(cfgpath, Slug(conf.Document))
|
||||||
|
|
||||||
|
fd, err := os.OpenFile(filename, os.O_RDONLY, 0644)
|
||||||
|
if err != nil {
|
||||||
|
return 0, nil // ignore errors and return no progress
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if err := fd.Close(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
scanner := bufio.NewScanner(fd)
|
||||||
|
var line string
|
||||||
|
|
||||||
|
for scanner.Scan() {
|
||||||
|
line = scanner.Text()
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
return strconv.ParseInt(strings.TrimSpace(line), 10, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
func Mkdir(dir string) error {
|
||||||
|
if _, err := os.Stat(dir); errors.Is(err, os.ErrNotExist) {
|
||||||
|
err := os.MkdirAll(dir, os.ModePerm)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create directory %s: %w", dir, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME: check https://github.com/gosimple/slug
|
||||||
|
func Slug(input string) string {
|
||||||
|
slug := slugify.ReplaceAllString(input, "-")
|
||||||
|
slug = suffix.ReplaceAllString(slug, "")
|
||||||
|
return nonprintable.ReplaceAllString(slug, "")
|
||||||
|
}
|
||||||
118
cmd/view_test.go
Normal file
118
cmd/view_test.go
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPrepare(t *testing.T) {
|
||||||
|
var tests = []struct {
|
||||||
|
file string
|
||||||
|
body string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
"t/epub/basic-v3plus2.epub",
|
||||||
|
`shirt court, an whinny retched a cordage offer groin-murder, picked inner windrow,`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/childrens-literature.epub",
|
||||||
|
`The child's natural literature. The world has lost certain secrets as the price of an advancing civilization. It is a commonplace of observation that no one can duplicate the success of Mother Goose, whether she be thought of as the maker of jingles or the teller of tales. The conditions of modern life preclude the generally naïve attitude that produced the folk rhymes, ballads, tales, proverbs, fables, and myths. The folk saw things simply and directly. The complex, analytic, questioning mind is not yet, either in or out of stories. The motives from which people act are to them plain and not mixed. Characters are good or bad. They feel no need of elaborately explaining their joys and sorrows. Such experiences come with the day's work. "To-morrow to fresh woods, and pastures new." The zest of life with them is emphatic. Their humor is fresh, unbounded, sincere; there is no trace of cynicism. In folk literature we do not feel the presence of a "writer" who is mightily concerned about maintaining his reputation for wisdom, originality, or style. Hence the freedom from any note of straining after effect, of artificiality. In the midst of a life limited to fundamental needs, their literature deals with fundamentals. On the whole, it was a literature for entertainment. A more learned upper class may have concerned itself then about "problems" and "purposes," as the whole world does now, but the literature of the folk had no such interests.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/cole-voyage-of-life.epub",
|
||||||
|
`Thomas Cole is regarded as the founder of the Hudson River School, an American art movement that flourished in the mid-19th century and was concerned with the realistic and detailed portrayal of nature but with a strong influence from Romanticism. This group of American landscape painters worked between about 1825 and 1870 and shared a sense of national pride as well as an interest in celebrating the unique natural beauty found in the United States. The wild, untamed nature found in America was viewed as its special character; Europe had ancient ruins, but America had the uncharted wilderness. As Cole's friend William Cullen Bryant sermonized in verse, so Cole sermonized in paint. Both men saw nature as God's work and as a refuge from the ugly materialism of cities. Cole clearly intended the Voyage of Life to be a didactic, moralizing series of paintings using the landscape as an allegory for religious faith.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/epub30-spec.epub",
|
||||||
|
`IDPF Members
|
||||||
|
|
||||||
|
Invited Experts/Observers
|
||||||
|
|
||||||
|
Version 2.0.1 of this specification was prepared by the International Digital Publishing Forum’s EPUB Maintenance Working Group under the leadership of:
|
||||||
|
|
||||||
|
Active members of the working group at the time of publication of revision 2.0.1 were:
|
||||||
|
|
||||||
|
Version 1.0 of this specification was prepared by the International Digital Publishing Forum’s Unified OEBPS Container Format Working Group under the leadership of:
|
||||||
|
|
||||||
|
Active members of the working group at the time of publication of revision 1.0 were:`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/epub_sample_file_50KB.epub",
|
||||||
|
`magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/Fundamental-Accessibility-Tests-Basic-Functionality-v2.0.0.epub",
|
||||||
|
`Open the Fundamental Accessibility Test book in the reading system.
|
||||||
|
|
||||||
|
If the test book is not available in the bookshelf, then open any other book that is available.
|
||||||
|
|
||||||
|
If the reading system also supports side loading, then please provide notes about the accessibility of the side loading feature.
|
||||||
|
|
||||||
|
Indicate Pass or Fail.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/georgia-cfi.epub",
|
||||||
|
`The Great Valley Region consists of folded sedimentary rocks, extensive erosion having removed the soft layers to form valleys, leaving the hard layers as ridges, both layers running in a N.E.-S.W. direction. In the extreme north-west corner of the state is a small part of the Cumberland Plateau, represented by Lookout and Sand Mts.
|
||||||
|
|
||||||
|
On the Blue Ridge escarpment near the N.E. corner of the state is a water-parting separating the waters which find their way respectively N.W. to the Tennessee river, S.W. to the Gulf of Mexico and S.E. to the Atlantic Ocean; indeed, according to B.M. and M.R. Hall (Water Resources of Georgia, p. 2), "there are three springs in north-east Georgia within a stone's throw of each other that send out their waters to Savannah, Ga., to Apalachicola, Fla., and to New Orleans, La." The water-parting between the waters flowing into the`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/israelsailing.epub",
|
||||||
|
` במשלוח דואר, מה שלפעמים היה נחמד כי גם חשבונות לתשלום לא היו מגיעים. 'טוב, מי`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/jlreq-in-japanese.epub",
|
||||||
|
` 2.5.1 基本版面からはみ出す例 2.5.2 基本版面で設定した行位置の適用 2.5.3 `,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/minimal-v2.epub",
|
||||||
|
`This is a paragraph.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/minimal-v3.epub",
|
||||||
|
`This is a paragraph.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/minimal-v3plus2.epub",
|
||||||
|
`This is a paragraph.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/moby-dick.epub",
|
||||||
|
`Call me Ishmael. Some years ago—never mind how long precisely—having little or no money in my purse, and nothing particular to interest me on shore, I thought I would sail about a little and see the watery part of the world. It is a way I have of driving off the spleen and regulating the circulation. Whenever I find myself growing grim about the mouth; whenever it is a damp, drizzly November in my soul; whenever I find myself involuntarily pausing before coffin warehouses, and bringing up the rear of every funeral I meet; and especially whenever my hypos get such an upper hand of me, that it requires a strong moral principle to prevent me from deliberately stepping into the street, and methodically knocking people’s hats off—then, I account it high time to get to sea as soon as I can. This is my substitute for pistol and ball. With a philosophical flourish Cato throws himself upon his sword; I quietly take to the ship. There is nothing surprising in this. If they but knew it, almost all men in their degree, some time or other, cherish very nearly the same feelings towards the ocean with me.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/sous-le-vent.epub",
|
||||||
|
`SOUS LE VENT`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"t/epub/wasteland-otf.epub",
|
||||||
|
`Line 20. Cf. Ezekiel 2:1.
|
||||||
|
|
||||||
|
23. Cf. Ecclesiastes 12:5.
|
||||||
|
|
||||||
|
31. V. Tristan und Isolde, i, verses 5-8.
|
||||||
|
|
||||||
|
42. Id. iii, verse 24.`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pkg/epub/test.epub",
|
||||||
|
`This EPUB file contains 10 hard coded page breaks. Note that these page breaks are different from the reflowed page numbers. If the total number of pages of this book in the reading app is not exactly 10, then you are looking at the reflowed pages. The app may be having a feature to switch between print page and reflowed pages for navigation. Or the print page list may be appearing in the TOC. If print page navigation feature does not exist or does not work then this test should be marked 'Fail'.`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
testname := fmt.Sprintf("prepare/%s", tt.file)
|
||||||
|
t.Run(testname, func(t *testing.T) {
|
||||||
|
conf := Config{
|
||||||
|
Document: "../" + tt.file,
|
||||||
|
}
|
||||||
|
|
||||||
|
ebook, err := Prepare(&conf)
|
||||||
|
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Contains(t, ebook.Body, tt.body, "expected text not found")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
16
config.toml
Normal file
16
config.toml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# color setting for dark mode
|
||||||
|
colordark = {
|
||||||
|
body = "#ffffff",
|
||||||
|
title = "#7cfc00",
|
||||||
|
chapter = "#ffff00"
|
||||||
|
}
|
||||||
|
|
||||||
|
# color setting for light mode
|
||||||
|
colorlight = {
|
||||||
|
body = "#000000",
|
||||||
|
title = "#8470ff",
|
||||||
|
chapter = "#00008b"
|
||||||
|
}
|
||||||
|
|
||||||
|
# always use dark mode
|
||||||
|
dark = true
|
||||||
65
go.mod
Normal file
65
go.mod
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
module github.com/tlinden/epuppy
|
||||||
|
|
||||||
|
go 1.24.0
|
||||||
|
|
||||||
|
toolchain go1.24.9
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/alecthomas/repr v0.5.2
|
||||||
|
github.com/antchfx/xmlquery v1.5.0
|
||||||
|
github.com/knadh/koanf/parsers/toml v0.1.0
|
||||||
|
github.com/knadh/koanf/providers/file v1.2.0
|
||||||
|
github.com/knadh/koanf/providers/posflag v1.0.1
|
||||||
|
github.com/knadh/koanf/v2 v2.3.0
|
||||||
|
github.com/muesli/reflow v0.3.0
|
||||||
|
github.com/spf13/pflag v1.0.10
|
||||||
|
golang.org/x/term v0.36.0
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
|
||||||
|
github.com/charmbracelet/bubbles v0.21.0
|
||||||
|
github.com/charmbracelet/bubbletea v1.3.10
|
||||||
|
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
|
||||||
|
github.com/charmbracelet/lipgloss v1.1.0
|
||||||
|
github.com/charmbracelet/x/ansi v0.10.1 // indirect
|
||||||
|
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
|
||||||
|
github.com/charmbracelet/x/term v0.2.1 // indirect
|
||||||
|
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
|
||||||
|
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||||
|
github.com/mattn/go-localereader v0.0.1 // indirect
|
||||||
|
github.com/mattn/go-runewidth v0.0.16 // indirect
|
||||||
|
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
|
||||||
|
github.com/muesli/cancelreader v0.2.2 // indirect
|
||||||
|
github.com/muesli/termenv v0.16.0 // indirect
|
||||||
|
github.com/rivo/uniseg v0.4.7 // indirect
|
||||||
|
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
|
||||||
|
golang.org/x/sys v0.37.0 // indirect
|
||||||
|
golang.org/x/text v0.30.0 // indirect
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/antchfx/xpath v1.3.5 // indirect
|
||||||
|
github.com/blacktop/go-termimg v0.1.20 // indirect
|
||||||
|
github.com/charmbracelet/x/mosaic v0.0.0-20250702191427-5bdfc8f2e4ff // indirect
|
||||||
|
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||||
|
github.com/fsnotify/fsnotify v1.9.0 // indirect
|
||||||
|
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
|
||||||
|
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
|
||||||
|
github.com/knadh/koanf/maps v0.1.2 // indirect
|
||||||
|
github.com/makeworld-the-better-one/dither/v2 v2.4.0 // indirect
|
||||||
|
github.com/mattn/go-sixel v0.0.5 // indirect
|
||||||
|
github.com/mitchellh/copystructure v1.2.0 // indirect
|
||||||
|
github.com/mitchellh/reflectwalk v1.0.2 // indirect
|
||||||
|
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect
|
||||||
|
github.com/pelletier/go-toml v1.9.5 // indirect
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||||
|
github.com/rogpeppe/go-internal v1.14.1 // indirect
|
||||||
|
github.com/soniakeys/quant v1.0.0 // indirect
|
||||||
|
github.com/stretchr/testify v1.11.1 // indirect
|
||||||
|
golang.org/x/image v0.25.0 // indirect
|
||||||
|
golang.org/x/net v0.44.0 // indirect
|
||||||
|
golang.org/x/tools v0.37.0 // indirect
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||||
|
)
|
||||||
186
go.sum
Normal file
186
go.sum
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
github.com/alecthomas/repr v0.5.2 h1:SU73FTI9D1P5UNtvseffFSGmdNci/O6RsqzeXJtP0Qs=
|
||||||
|
github.com/alecthomas/repr v0.5.2/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4=
|
||||||
|
github.com/antchfx/xmlquery v1.5.0 h1:uAi+mO40ZWfyU6mlUBxRVvL6uBNZ6LMU4M3+mQIBV4c=
|
||||||
|
github.com/antchfx/xmlquery v1.5.0/go.mod h1:lJfWRXzYMK1ss32zm1GQV3gMIW/HFey3xDZmkP1SuNc=
|
||||||
|
github.com/antchfx/xpath v1.3.5 h1:PqbXLC3TkfeZyakF5eeh3NTWEbYl4VHNVeufANzDbKQ=
|
||||||
|
github.com/antchfx/xpath v1.3.5/go.mod h1:i54GszH55fYfBmoZXapTHN8T8tkcHfRgLyVwwqzXNcs=
|
||||||
|
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
|
||||||
|
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
|
||||||
|
github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8=
|
||||||
|
github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
|
||||||
|
github.com/blacktop/go-termimg v0.1.20 h1:+EAUc3c9hwE/fUYaqRV1BSLvAlOuLySgLTEBzxGbYK4=
|
||||||
|
github.com/blacktop/go-termimg v0.1.20/go.mod h1:nwxrOjfFcBjtS358oIGBLfscSLnCpNdRlMVRxsnZwMU=
|
||||||
|
github.com/charmbracelet/bubbles v0.21.0 h1:9TdC97SdRVg/1aaXNVWfFH3nnLAwOXr8Fn6u6mfQdFs=
|
||||||
|
github.com/charmbracelet/bubbles v0.21.0/go.mod h1:HF+v6QUR4HkEpz62dx7ym2xc71/KBHg+zKwJtMw+qtg=
|
||||||
|
github.com/charmbracelet/bubbletea v1.3.10 h1:otUDHWMMzQSB0Pkc87rm691KZ3SWa4KUlvF9nRvCICw=
|
||||||
|
github.com/charmbracelet/bubbletea v1.3.10/go.mod h1:ORQfo0fk8U+po9VaNvnV95UPWA1BitP1E0N6xJPlHr4=
|
||||||
|
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
|
||||||
|
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
|
||||||
|
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
|
||||||
|
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
|
||||||
|
github.com/charmbracelet/x/ansi v0.10.1 h1:rL3Koar5XvX0pHGfovN03f5cxLbCF2YvLeyz7D2jVDQ=
|
||||||
|
github.com/charmbracelet/x/ansi v0.10.1/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE=
|
||||||
|
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8=
|
||||||
|
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
|
||||||
|
github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ=
|
||||||
|
github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
|
||||||
|
github.com/charmbracelet/x/mosaic v0.0.0-20250702191427-5bdfc8f2e4ff h1:OVBKPzoa0k5ZVMoor27BReRZxER1IEDtLHXkRjaHElg=
|
||||||
|
github.com/charmbracelet/x/mosaic v0.0.0-20250702191427-5bdfc8f2e4ff/go.mod h1:5qLP4S++M5quSc/xbvWWW8vKkgKwOqOT/IVhAas26XI=
|
||||||
|
github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
|
||||||
|
github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
|
||||||
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4=
|
||||||
|
github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
|
||||||
|
github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=
|
||||||
|
github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
|
||||||
|
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
|
||||||
|
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
||||||
|
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE=
|
||||||
|
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
|
||||||
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
|
github.com/knadh/koanf/maps v0.1.2 h1:RBfmAW5CnZT+PJ1CVc1QSJKf4Xu9kxfQgYVQSu8hpbo=
|
||||||
|
github.com/knadh/koanf/maps v0.1.2/go.mod h1:npD/QZY3V6ghQDdcQzl1W4ICNVTkohC8E73eI2xW4yI=
|
||||||
|
github.com/knadh/koanf/parsers/toml v0.1.0 h1:S2hLqS4TgWZYj4/7mI5m1CQQcWurxUz6ODgOub/6LCI=
|
||||||
|
github.com/knadh/koanf/parsers/toml v0.1.0/go.mod h1:yUprhq6eo3GbyVXFFMdbfZSo928ksS+uo0FFqNMnO18=
|
||||||
|
github.com/knadh/koanf/providers/file v1.2.0 h1:hrUJ6Y9YOA49aNu/RSYzOTFlqzXSCpmYIDXI7OJU6+U=
|
||||||
|
github.com/knadh/koanf/providers/file v1.2.0/go.mod h1:bp1PM5f83Q+TOUu10J/0ApLBd9uIzg+n9UgthfY+nRA=
|
||||||
|
github.com/knadh/koanf/providers/posflag v1.0.1 h1:EnMxHSrPkYCFnKgBUl5KBgrjed8gVFrcXDzaW4l/C6Y=
|
||||||
|
github.com/knadh/koanf/providers/posflag v1.0.1/go.mod h1:3Wn3+YG3f4ljzRyCUgIwH7G0sZ1pMjCOsNBovrbKmAk=
|
||||||
|
github.com/knadh/koanf/v2 v2.3.0 h1:Qg076dDRFHvqnKG97ZEsi9TAg2/nFTa9hCdcSa1lvlM=
|
||||||
|
github.com/knadh/koanf/v2 v2.3.0/go.mod h1:gRb40VRAbd4iJMYYD5IxZ6hfuopFcXBpc9bbQpZwo28=
|
||||||
|
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
|
||||||
|
github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
||||||
|
github.com/makeworld-the-better-one/dither/v2 v2.4.0 h1:Az/dYXiTcwcRSe59Hzw4RI1rSnAZns+1msaCXetrMFE=
|
||||||
|
github.com/makeworld-the-better-one/dither/v2 v2.4.0/go.mod h1:VBtN8DXO7SNtyGmLiGA7IsFeKrBkQPze1/iAeM95arc=
|
||||||
|
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||||
|
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||||
|
github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4=
|
||||||
|
github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88=
|
||||||
|
github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
|
||||||
|
github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
|
||||||
|
github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
|
||||||
|
github.com/mattn/go-sixel v0.0.5 h1:55w2FR5ncuhKhXrM5ly1eiqMQfZsnAHIpYNGZX03Cv8=
|
||||||
|
github.com/mattn/go-sixel v0.0.5/go.mod h1:h2Sss+DiUEHy0pUqcIB6PFXo5Cy8sTQEFr3a9/5ZLNw=
|
||||||
|
github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw=
|
||||||
|
github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s=
|
||||||
|
github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
|
||||||
|
github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
|
||||||
|
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI=
|
||||||
|
github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo=
|
||||||
|
github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA=
|
||||||
|
github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo=
|
||||||
|
github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
|
||||||
|
github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
|
||||||
|
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
|
||||||
|
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
|
||||||
|
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6Oo2LfFZAehjjQMERAvZLEDnQ=
|
||||||
|
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8=
|
||||||
|
github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
|
||||||
|
github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||||
|
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||||
|
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
|
||||||
|
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
|
||||||
|
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
||||||
|
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
||||||
|
github.com/soniakeys/quant v1.0.0 h1:N1um9ktjbkZVcywBVAAYpZYSHxEfJGzshHCxx/DaI0Y=
|
||||||
|
github.com/soniakeys/quant v1.0.0/go.mod h1:HI1k023QuVbD4H8i9YdfZP2munIHU4QpjsImz6Y6zds=
|
||||||
|
github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
|
||||||
|
github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
|
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
|
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||||
|
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||||
|
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
||||||
|
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||||
|
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
|
||||||
|
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
|
||||||
|
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||||
|
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||||
|
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||||
|
golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
|
||||||
|
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||||
|
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
|
||||||
|
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
|
||||||
|
golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
|
||||||
|
golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
|
||||||
|
golang.org/x/image v0.25.0 h1:Y6uW6rH1y5y/LK1J8BPWZtr6yZ7hrsy6hFrXjgsc2fQ=
|
||||||
|
golang.org/x/image v0.25.0/go.mod h1:tCAmOEGthTtkalusGp1g3xa2gke8J6c2N565dTyl9Rs=
|
||||||
|
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||||
|
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||||
|
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||||
|
golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||||
|
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||||
|
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||||
|
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||||
|
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||||
|
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
|
||||||
|
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
|
||||||
|
golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
|
||||||
|
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
|
||||||
|
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
|
||||||
|
golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
|
||||||
|
golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
|
||||||
|
golang.org/x/net v0.44.0 h1:evd8IRDyfNBMBTTY5XRF1vaZlD+EmWx6x8PkhR04H/I=
|
||||||
|
golang.org/x/net v0.44.0/go.mod h1:ECOoLqd5U3Lhyeyo/QDCEVQ4sNgYsqvCZ722XogGieY=
|
||||||
|
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
|
||||||
|
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||||
|
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||||
|
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||||
|
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/sys v0.37.0 h1:fdNQudmxPjkdUTPnLn5mdQv7Zwvbvpaxqs831goi9kQ=
|
||||||
|
golang.org/x/sys v0.37.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||||
|
golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
|
||||||
|
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||||
|
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||||
|
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
|
||||||
|
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
|
||||||
|
golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
|
||||||
|
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
|
||||||
|
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
|
||||||
|
golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM=
|
||||||
|
golang.org/x/term v0.36.0 h1:zMPR+aF8gfksFprF/Nc/rd1wRS1EI6nDBGyWAvDzx2Q=
|
||||||
|
golang.org/x/term v0.36.0/go.mod h1:Qu394IJq6V6dCBRgwqshf3mPF85AqzYEzofzRdZkWss=
|
||||||
|
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||||
|
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||||
|
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||||
|
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
||||||
|
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
|
||||||
|
golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
|
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
|
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||||
|
golang.org/x/text v0.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k=
|
||||||
|
golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM=
|
||||||
|
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||||
|
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
|
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
||||||
|
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
||||||
|
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
|
||||||
|
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
|
||||||
|
golang.org/x/tools v0.37.0 h1:DVSRzp7FwePZW356yEAChSdNcQo6Nsp+fex1SUW09lE=
|
||||||
|
golang.org/x/tools v0.37.0/go.mod h1:MBN5QPQtLMHVdvsbtarmTNukZDdgwdwlO5qGacAzF0w=
|
||||||
|
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
31
main.go
Normal file
31
main.go
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"github.com/tlinden/epuppy/cmd"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
os.Exit(Main())
|
||||||
|
}
|
||||||
|
|
||||||
|
func Main() int {
|
||||||
|
return cmd.Execute(os.Stdout)
|
||||||
|
}
|
||||||
38
main_test.go
Normal file
38
main_test.go
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/rogpeppe/go-internal/testscript"
|
||||||
|
)
|
||||||
|
|
||||||
|
// see https://bitfieldconsulting.com/golang/test-scripts
|
||||||
|
|
||||||
|
func TestMain(m *testing.M) {
|
||||||
|
testscript.Main(m, map[string]func(){
|
||||||
|
"epuppy": main,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEpuppy(t *testing.T) {
|
||||||
|
testscript.Run(t, testscript.Params{
|
||||||
|
Dir: "t",
|
||||||
|
})
|
||||||
|
}
|
||||||
75
mkrel.sh
Executable file
75
mkrel.sh
Executable file
@@ -0,0 +1,75 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Copyright © 2025 Thomas von Dein
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
# get list with: go tool dist list
|
||||||
|
DIST="darwin/amd64
|
||||||
|
freebsd/amd64
|
||||||
|
linux/amd64
|
||||||
|
netbsd/amd64
|
||||||
|
openbsd/amd64
|
||||||
|
windows/amd64
|
||||||
|
freebsd/arm64
|
||||||
|
linux/arm64
|
||||||
|
netbsd/arm64
|
||||||
|
openbsd/arm64
|
||||||
|
windows/arm64"
|
||||||
|
|
||||||
|
tool="$1"
|
||||||
|
version="$2"
|
||||||
|
|
||||||
|
if test -z "$version"; then
|
||||||
|
echo "Usage: $0 <tool name> <release version>"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
rm -rf releases
|
||||||
|
mkdir -p releases
|
||||||
|
|
||||||
|
|
||||||
|
for D in $DIST; do
|
||||||
|
os=${D/\/*/}
|
||||||
|
arch=${D/*\//}
|
||||||
|
binfile="releases/${tool}-${os}-${arch}-${version}"
|
||||||
|
|
||||||
|
if test "$os" = "windows"; then
|
||||||
|
binfile="${binfile}.exe"
|
||||||
|
fi
|
||||||
|
|
||||||
|
tardir="${tool}-${os}-${arch}-${version}"
|
||||||
|
tarfile="releases/${tool}-${os}-${arch}-${version}.tar.gz"
|
||||||
|
set -x
|
||||||
|
GOOS=${os} GOARCH=${arch} go build -tags osusergo,netgo -ldflags "-extldflags=-static" -o ${binfile}
|
||||||
|
mkdir -p ${tardir}
|
||||||
|
cp ${binfile} README.md LICENSE ${tardir}/
|
||||||
|
echo 'tool = epuppy
|
||||||
|
PREFIX = /usr/local
|
||||||
|
UID = root
|
||||||
|
GID = 0
|
||||||
|
|
||||||
|
install:
|
||||||
|
install -d -o $(UID) -g $(GID) $(PREFIX)/bin
|
||||||
|
install -d -o $(UID) -g $(GID) $(PREFIX)/man/man1
|
||||||
|
install -o $(UID) -g $(GID) -m 555 $(tool) $(PREFIX)/sbin/
|
||||||
|
install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/' > ${tardir}/Makefile
|
||||||
|
tar cpzf ${tarfile} ${tardir}
|
||||||
|
sha256sum ${binfile} | cut -d' ' -f1 > ${binfile}.sha256
|
||||||
|
sha256sum ${tarfile} | cut -d' ' -f1 > ${tarfile}.sha256
|
||||||
|
rm -rf ${tardir}
|
||||||
|
set +x
|
||||||
|
done
|
||||||
|
|
||||||
21
pkg/epub/README.md
Normal file
21
pkg/epub/README.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# epub module
|
||||||
|
|
||||||
|
This is a modified version of the [epub
|
||||||
|
module](https://github.com/kapmahc/epub/). I fixed a couple of issues
|
||||||
|
and I added code to retrieve the actual epub content, which the
|
||||||
|
original module doesn't implement. Since the last update on that
|
||||||
|
module was 9 years ago (as I write this), it doesn't make sense to
|
||||||
|
send a PR. And it also makes no sense to me to publish it separately.
|
||||||
|
|
||||||
|
|
||||||
|
# ORIGINAL README
|
||||||
|
|
||||||
|
## epub
|
||||||
|
A pure go implementation of epub file format.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Documents
|
||||||
|
- <http://idpf.org/epub>
|
||||||
|
- <http://www.cnblogs.com/Alex80/p/5127104.html>
|
||||||
|
- <http://www.cnblogs.com/diligenceday/p/4999315.html>
|
||||||
99
pkg/epub/book.go
Normal file
99
pkg/epub/book.go
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/zip"
|
||||||
|
"encoding/xml"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"path"
|
||||||
|
)
|
||||||
|
|
||||||
|
// a section in the book
|
||||||
|
type Section struct {
|
||||||
|
File, Title, MediaType string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Book epub book
|
||||||
|
type Book struct {
|
||||||
|
Ncx Ncx `json:"ncx"`
|
||||||
|
Opf Opf `json:"opf"`
|
||||||
|
Container Container `json:"-"`
|
||||||
|
Mimetype string `json:"-"`
|
||||||
|
Content []Content
|
||||||
|
fd *zip.ReadCloser
|
||||||
|
CoverImage []byte
|
||||||
|
CoverFile string
|
||||||
|
CoverMediaType string
|
||||||
|
Sections []Section
|
||||||
|
dumpxml bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open open resource file
|
||||||
|
func (p *Book) Open(n string) (io.ReadCloser, error) {
|
||||||
|
return p.open(p.filename(n))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Files list resource files
|
||||||
|
func (p *Book) Files() []string {
|
||||||
|
var fns []string
|
||||||
|
for _, f := range p.fd.File {
|
||||||
|
fns = append(fns, f.Name)
|
||||||
|
}
|
||||||
|
return fns
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
func (p *Book) filename(n string) string {
|
||||||
|
return path.Join(path.Dir(p.Container.Rootfile.Path), n)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Book) readXML(n string, v interface{}) error {
|
||||||
|
fd, err := p.open(n)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
if err := fd.Close(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
dec := xml.NewDecoder(fd)
|
||||||
|
|
||||||
|
if err := dec.Decode(v); err != nil {
|
||||||
|
return fmt.Errorf("XML decoder error %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Book) readBytes(n string) ([]byte, error) {
|
||||||
|
fd, err := p.open(n)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
defer func() {
|
||||||
|
if err := fd.Close(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
data, err := io.ReadAll(fd)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to read contents from %s %w", n, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return data, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Book) open(n string) (io.ReadCloser, error) {
|
||||||
|
for _, f := range p.fd.File {
|
||||||
|
if f.Name == n {
|
||||||
|
return f.Open()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("file %s not exist", n)
|
||||||
|
}
|
||||||
12
pkg/epub/container.go
Normal file
12
pkg/epub/container.go
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
// Container META-INF/container.xml file
|
||||||
|
type Container struct {
|
||||||
|
Rootfile Rootfile `xml:"rootfiles>rootfile" json:"rootfile"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rootfile root file
|
||||||
|
type Rootfile struct {
|
||||||
|
Path string `xml:"full-path,attr" json:"path"`
|
||||||
|
Type string `xml:"media-type,attr" json:"type"`
|
||||||
|
}
|
||||||
75
pkg/epub/content.go
Normal file
75
pkg/epub/content.go
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/antchfx/xmlquery"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
cleanentitles = regexp.MustCompile(`&[a-z]+;`)
|
||||||
|
empty = regexp.MustCompile(`(?s)^[\s ]*$`)
|
||||||
|
newlines = regexp.MustCompile(`[\r\n\s]+`)
|
||||||
|
cleansvg = regexp.MustCompile(`(<svg.+</svg>|<!\[CDATA\[.+\]\]>)`)
|
||||||
|
cleanmarkup = regexp.MustCompile(`<[^<>]+>`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Content nav-point content
|
||||||
|
type Content struct {
|
||||||
|
Src string `xml:"src,attr" json:"src"`
|
||||||
|
Empty bool
|
||||||
|
Body string
|
||||||
|
Title string
|
||||||
|
XML []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// parse XML, look for title and <p>.*</p> stuff
|
||||||
|
func (c *Content) String(content []byte) error {
|
||||||
|
doc, err := xmlquery.Parse(
|
||||||
|
strings.NewReader(
|
||||||
|
cleansvg.ReplaceAllString(
|
||||||
|
cleanentitles.ReplaceAllString(string(content), " "), "")))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.Title == "" {
|
||||||
|
// extract the title
|
||||||
|
for _, item := range xmlquery.Find(doc, "//title") {
|
||||||
|
c.Title = strings.TrimSpace(item.InnerText())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// extract all paragraphs, ignore any formatting and re-fill the
|
||||||
|
// paragraph, that is, we replace all newlines inside with one
|
||||||
|
// space.
|
||||||
|
txt := strings.Builder{}
|
||||||
|
var have_p bool
|
||||||
|
for _, item := range xmlquery.Find(doc, "//p") {
|
||||||
|
if !empty.MatchString(item.InnerText()) {
|
||||||
|
have_p = true
|
||||||
|
txt.WriteString(newlines.ReplaceAllString(item.InnerText(), " ") + "\n\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !have_p {
|
||||||
|
// try <div></div>, which some ebooks use, so get all divs,
|
||||||
|
// remove markup and paragraphify the parts
|
||||||
|
for _, item := range xmlquery.Find(doc, "//div") {
|
||||||
|
if !empty.MatchString(item.InnerText()) {
|
||||||
|
cleaned := cleanmarkup.ReplaceAllString(item.InnerText(), "")
|
||||||
|
txt.WriteString(newlines.ReplaceAllString(cleaned, " ") + "\n\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c.Body = strings.TrimSpace(txt.String())
|
||||||
|
c.XML = content
|
||||||
|
|
||||||
|
if len(c.Body) == 0 {
|
||||||
|
c.Empty = true
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
24
pkg/epub/epub_test.go
Normal file
24
pkg/epub/epub_test.go
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestEpub(t *testing.T) {
|
||||||
|
_, err := open(t, "test.epub")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func open(t *testing.T, f string) (*Book, error) {
|
||||||
|
bk, err := Open(f, false)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Logf("files: %+v", bk.Files())
|
||||||
|
t.Logf("book: %+v", bk)
|
||||||
|
|
||||||
|
return bk, nil
|
||||||
|
}
|
||||||
17
pkg/epub/ncx.go
Normal file
17
pkg/epub/ncx.go
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
// Ncx OPS/toc.ncx
|
||||||
|
type Ncx struct {
|
||||||
|
Points []*NavPoint `xml:"navMap>navPoint" json:"points"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NavPoint nav point
|
||||||
|
type NavPoint struct {
|
||||||
|
Text string `xml:"navLabel>text" json:"text"`
|
||||||
|
Content Content `xml:"content" json:"content"`
|
||||||
|
Points []NavPoint `xml:"navPoint" json:"points"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Title struct {
|
||||||
|
Content string `xml:"head>title"`
|
||||||
|
}
|
||||||
205
pkg/epub/open.go
Normal file
205
pkg/epub/open.go
Normal file
@@ -0,0 +1,205 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/zip"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// to find content
|
||||||
|
types = regexp.MustCompile(`application/(xml|html|xhtml|htm)`)
|
||||||
|
|
||||||
|
// cleanup regexes
|
||||||
|
deanchor = regexp.MustCompile(`#.*$`)
|
||||||
|
cleanext = regexp.MustCompile(`^\.`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Open open a epub file and return the filled Book structure
|
||||||
|
func Open(fn string, dumpxml bool) (*Book, error) {
|
||||||
|
bk, err := openFile(fn, dumpxml)
|
||||||
|
if err != nil {
|
||||||
|
return bk, err
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
if err := bk.fd.Close(); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
if err := bk.getManifest(); err != nil {
|
||||||
|
return bk, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bk.getSections(); err != nil {
|
||||||
|
return bk, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bk.readSectionContent(); err != nil {
|
||||||
|
return bk, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return bk, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// load the epub zip file
|
||||||
|
func openFile(fn string, dumpxml bool) (*Book, error) {
|
||||||
|
fd, err := zip.OpenReader(fn)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
bk := &Book{fd: fd, dumpxml: dumpxml}
|
||||||
|
|
||||||
|
return bk, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// load the manifest
|
||||||
|
func (bk *Book) getManifest() error {
|
||||||
|
mt, err := bk.readBytes("mimetype")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
bk.Mimetype = string(mt)
|
||||||
|
|
||||||
|
// contains the root path
|
||||||
|
err = bk.readXML("META-INF/container.xml", &bk.Container)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// contains the OPF data
|
||||||
|
err = bk.readXML(bk.Container.Rootfile.Path, &bk.Opf)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// look for TOC (might be incomplete, see below!)
|
||||||
|
for _, mf := range bk.Opf.Manifest {
|
||||||
|
if mf.ID == bk.Opf.Spine.Toc {
|
||||||
|
err = bk.readXML(bk.filename(mf.Href), &bk.Ncx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if mf.ID == "cover-image" {
|
||||||
|
bk.CoverFile = mf.Href
|
||||||
|
bk.CoverMediaType = mf.MediaType
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// extract the readable sections of the epub
|
||||||
|
func (bk *Book) getSections() error {
|
||||||
|
// to store our final content sections
|
||||||
|
sections := []Section{}
|
||||||
|
|
||||||
|
// count the content items in the raw manifest
|
||||||
|
var manifestcount int
|
||||||
|
for _, item := range bk.Opf.Manifest {
|
||||||
|
if types.MatchString(item.MediaType) {
|
||||||
|
manifestcount++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// we have ncx points from the TOC, try those
|
||||||
|
if len(bk.Ncx.Points) > 0 {
|
||||||
|
for _, block := range bk.Ncx.Points {
|
||||||
|
sect := Section{
|
||||||
|
File: "OEBPS/" + block.Content.Src,
|
||||||
|
Title: block.Text,
|
||||||
|
}
|
||||||
|
|
||||||
|
srcfile := deanchor.ReplaceAllString(block.Content.Src, "")
|
||||||
|
|
||||||
|
for _, file := range bk.Files() {
|
||||||
|
if strings.Contains(file, srcfile) {
|
||||||
|
sect.File = file
|
||||||
|
sect.MediaType = "application/" + cleanext.ReplaceAllString(filepath.Ext(file), "")
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sections = append(sections, sect)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(sections) < manifestcount {
|
||||||
|
// TOC was incomplete, restart from scratch but use the
|
||||||
|
// OPF Manifest directly
|
||||||
|
|
||||||
|
sections = []Section{}
|
||||||
|
|
||||||
|
for _, item := range bk.Opf.Manifest {
|
||||||
|
if types.MatchString(item.MediaType) {
|
||||||
|
sect := Section{
|
||||||
|
File: "OEBPS/" + item.Href,
|
||||||
|
MediaType: item.MediaType,
|
||||||
|
}
|
||||||
|
|
||||||
|
srcfile := deanchor.ReplaceAllString(item.Href, "")
|
||||||
|
|
||||||
|
for _, file := range bk.Files() {
|
||||||
|
if strings.Contains(file, srcfile) {
|
||||||
|
sect.File = file
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sections = append(sections, sect)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// no TOC, just pull in the files directly
|
||||||
|
for _, file := range bk.Files() {
|
||||||
|
sections = append(sections,
|
||||||
|
Section{
|
||||||
|
File: file,
|
||||||
|
MediaType: "application/" + cleanext.ReplaceAllString(filepath.Ext(file), ""),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// final sections to keep
|
||||||
|
bk.Sections = sections
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (bk *Book) readSectionContent() error {
|
||||||
|
// now read in the actual xml contents
|
||||||
|
for _, section := range bk.Sections {
|
||||||
|
content, err := bk.readBytes(section.File)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.Contains(section.File, bk.CoverFile) {
|
||||||
|
bk.CoverImage = content
|
||||||
|
}
|
||||||
|
|
||||||
|
ct := Content{Src: section.File, Title: section.Title}
|
||||||
|
|
||||||
|
if types.MatchString(section.MediaType) {
|
||||||
|
if err := ct.String(content); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if bk.dumpxml {
|
||||||
|
fmt.Println(string(ct.XML))
|
||||||
|
}
|
||||||
|
|
||||||
|
bk.Content = append(bk.Content, ct)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
80
pkg/epub/opf.go
Normal file
80
pkg/epub/opf.go
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
package epub
|
||||||
|
|
||||||
|
// Opf content.opf
|
||||||
|
type Opf struct {
|
||||||
|
Metadata Metadata `xml:"metadata" json:"metadata"`
|
||||||
|
Manifest []Manifest `xml:"manifest>item" json:"manifest"`
|
||||||
|
Spine Spine `xml:"spine" json:"spine"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Metadata metadata
|
||||||
|
type Metadata struct {
|
||||||
|
Title []string `xml:"title" json:"title"`
|
||||||
|
Language []string `xml:"language" json:"language"`
|
||||||
|
Identifier []Identifier `xml:"identifier" json:"identifier"`
|
||||||
|
Creator []Author `xml:"creator" json:"creator"`
|
||||||
|
Subject []string `xml:"subject" json:"subject"`
|
||||||
|
Description []string `xml:"description" json:"description"`
|
||||||
|
Publisher []string `xml:"publisher" json:"publisher"`
|
||||||
|
Contributor []Author `xml:"contributor" json:"contributor"`
|
||||||
|
Date []Date `xml:"date" json:"date"`
|
||||||
|
Type []string `xml:"type" json:"type"`
|
||||||
|
Format []string `xml:"format" json:"format"`
|
||||||
|
Source []string `xml:"source" json:"source"`
|
||||||
|
Relation []string `xml:"relation" json:"relation"`
|
||||||
|
Coverage []string `xml:"coverage" json:"coverage"`
|
||||||
|
Rights []string `xml:"rights" json:"rights"`
|
||||||
|
Meta []Metafield `xml:"meta" json:"meta"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Identifier identifier
|
||||||
|
type Identifier struct {
|
||||||
|
Data string `xml:",chardata" json:"data"`
|
||||||
|
ID string `xml:"id,attr" json:"id"`
|
||||||
|
Scheme string `xml:"scheme,attr" json:"scheme"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Author author
|
||||||
|
type Author struct {
|
||||||
|
Data string `xml:",chardata" json:"author"`
|
||||||
|
FileAs string `xml:"file-as,attr" json:"file_as"`
|
||||||
|
Role string `xml:"role,attr" json:"role"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Date date
|
||||||
|
type Date struct {
|
||||||
|
Data string `xml:",chardata" json:"data"`
|
||||||
|
Event string `xml:"event,attr" json:"event"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Metafield metafield
|
||||||
|
type Metafield struct {
|
||||||
|
Name string `xml:"name,attr" json:"name"`
|
||||||
|
Content string `xml:"content,attr" json:"content"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manifest manifest
|
||||||
|
type Manifest struct {
|
||||||
|
ID string `xml:"id,attr" json:"id"`
|
||||||
|
Href string `xml:"href,attr" json:"href"`
|
||||||
|
MediaType string `xml:"media-type,attr" json:"type"`
|
||||||
|
Fallback string `xml:"media-fallback,attr" json:"fallback"`
|
||||||
|
Properties string `xml:"properties,attr" json:"properties"`
|
||||||
|
MediaOverlay string `xml:"media-overlay,attr" json:"overlay"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Spine spine
|
||||||
|
type Spine struct {
|
||||||
|
ID string `xml:"id,attr" json:"id"`
|
||||||
|
Toc string `xml:"toc,attr" json:"toc"`
|
||||||
|
PageProgression string `xml:"page-progression-direction,attr" json:"progression"`
|
||||||
|
Items []SpineItem `xml:"itemref" json:"items"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SpineItem spine item
|
||||||
|
type SpineItem struct {
|
||||||
|
IDref string `xml:"idref,attr" json:"id_ref"`
|
||||||
|
Linear string `xml:"linear,attr" json:"linear"`
|
||||||
|
ID string `xml:"id,attr" json:"id"`
|
||||||
|
Properties string `xml:"properties,attr" json:"properties"`
|
||||||
|
}
|
||||||
BIN
pkg/epub/test.epub
Normal file
BIN
pkg/epub/test.epub
Normal file
Binary file not shown.
7
t/basic.txtar
Normal file
7
t/basic.txtar
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# no args shall fail
|
||||||
|
! exec epuppy
|
||||||
|
|
||||||
|
# help
|
||||||
|
exec epuppy -h
|
||||||
|
stdout 'This is epuppy'
|
||||||
|
|
||||||
Binary file not shown.
BIN
t/epub/basic-v3plus2.epub
Normal file
BIN
t/epub/basic-v3plus2.epub
Normal file
Binary file not shown.
BIN
t/epub/childrens-literature.epub
Normal file
BIN
t/epub/childrens-literature.epub
Normal file
Binary file not shown.
BIN
t/epub/cole-voyage-of-life.epub
Normal file
BIN
t/epub/cole-voyage-of-life.epub
Normal file
Binary file not shown.
BIN
t/epub/epub30-spec.epub
Normal file
BIN
t/epub/epub30-spec.epub
Normal file
Binary file not shown.
BIN
t/epub/epub_sample_file_50KB.epub
Normal file
BIN
t/epub/epub_sample_file_50KB.epub
Normal file
Binary file not shown.
BIN
t/epub/georgia-cfi.epub
Normal file
BIN
t/epub/georgia-cfi.epub
Normal file
Binary file not shown.
BIN
t/epub/israelsailing.epub
Normal file
BIN
t/epub/israelsailing.epub
Normal file
Binary file not shown.
BIN
t/epub/jlreq-in-japanese.epub
Normal file
BIN
t/epub/jlreq-in-japanese.epub
Normal file
Binary file not shown.
BIN
t/epub/minimal-v2.epub
Normal file
BIN
t/epub/minimal-v2.epub
Normal file
Binary file not shown.
BIN
t/epub/minimal-v3.epub
Normal file
BIN
t/epub/minimal-v3.epub
Normal file
Binary file not shown.
BIN
t/epub/minimal-v3plus2.epub
Normal file
BIN
t/epub/minimal-v3plus2.epub
Normal file
Binary file not shown.
BIN
t/epub/moby-dick.epub
Normal file
BIN
t/epub/moby-dick.epub
Normal file
Binary file not shown.
BIN
t/epub/sous-le-vent.epub
Normal file
BIN
t/epub/sous-le-vent.epub
Normal file
Binary file not shown.
BIN
t/epub/wasteland-otf.epub
Normal file
BIN
t/epub/wasteland-otf.epub
Normal file
Binary file not shown.
1698
t/read-parse.txtar
Normal file
1698
t/read-parse.txtar
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user