19 Commits

Author SHA1 Message Date
ee26834054 switch to codeberg 2025-10-30 23:32:53 +01:00
cce26c562b try target main 2025-10-29 10:26:19 +01:00
6ceed77fd0 add target 2025-10-29 10:06:00 +01:00
60a1d545ed fix event 2025-10-29 09:22:51 +01:00
3a72204915 +comment 2025-10-29 09:06:12 +01:00
0516534526 fix token 2025-10-29 09:03:30 +01:00
d260f5299f add when clause 2025-10-29 09:03:09 +01:00
1f93d2d37d fix indend 2025-10-29 08:57:58 +01:00
55addf2a77 add release pipeline 2025-10-29 08:46:57 +01:00
06dec42e83 add branch (test only) 2025-10-28 23:04:25 +01:00
fceee7bc04 badges to codeberg 2025-10-28 22:58:04 +01:00
8edca6d367 use lint binary 2025-10-28 22:47:05 +01:00
1ab65e69a0 try with freebsd 2025-10-28 22:43:32 +01:00
7a62b2d19d add linter 2025-10-28 22:38:13 +01:00
030c1ba495 use matrix 2025-10-28 22:21:06 +01:00
9b6f062c65 CB ci test 2025-10-28 21:33:46 +01:00
7a12e8e8b0 add stew 2025-10-25 21:49:26 +02:00
T.v.Dein
238972f11f Parserfixes std (#11)
* clean svg and cdata
* refactored ebook preparation, separated from calling the pager
* added better unit tests
* add free ebooks for testing
2025-10-21 21:57:12 +02:00
T.v.Dein
f524083210 Fix more parser failures (#10)
* stabilize section parsing, now seems to read all ebooks I tested with
* refactored Open() into smaller funcs
* bump version
2025-10-20 18:54:49 +00:00
40 changed files with 445 additions and 207 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

BIN
.codeberg/assets/help.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

BIN
.codeberg/assets/light.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

BIN
.codeberg/assets/margin.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

View File

@@ -1,54 +0,0 @@
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

69
.goreleaser.yaml Normal file
View File

@@ -0,0 +1,69 @@
# 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 }})

27
.woodpecker/build.yaml Normal file
View File

@@ -0,0 +1,27 @@
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:
- 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 ./...

15
.woodpecker/release.yaml Normal file
View File

@@ -0,0 +1,15 @@
# build release
labels:
platform: linux/amd64
steps:
goreleaser:
image: goreleaser/goreleaser
when:
event: [tag]
environment:
GITEA_TOKEN:
from_secret: DEPLOY_TOKEN
commands:
- goreleaser release --clean --verbose

20
Makefile.dist Normal file
View File

@@ -0,0 +1,20 @@
# -*-make-*-
.PHONY: install all
tool = epuppy
PREFIX = /usr/local
UID = root
GID = 0
all:
@echo "Type 'sudo make install' to install the tool."
@echo "To change prefix, type 'sudo make install PREFIX=/opt'"
install:
install -d -o $(UID) -g $(GID) $(PREFIX)/bin
install -d -o $(UID) -g $(GID) $(PREFIX)/man/man1
install -d -o $(UID) -g $(GID) $(PREFIX)/share/doc
install -o $(UID) -g $(GID) -m 555 $(tool) $(PREFIX)/sbin/
install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/
install -o $(UID) -g $(GID) -m 444 *.md Documentation.txt $(PREFIX)/share/doc/

View File

@@ -1,6 +1,6 @@
[![Actions](https://github.com/tlinden/epuppy/actions/workflows/ci.yaml/badge.svg)](https://github.com/tlinden/epuppy/actions) [![status-badge](https://ci.codeberg.org/api/badges/15473/status.svg?branch=woodpecker)](https://ci.codeberg.org/repos/15473)
[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/epuppy/blob/master/LICENSE) [![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://codeberg.org/scip/epuppy/raw/branch/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/epuppy)](https://goreportcard.com/report/github.com/tlinden/epuppy) [![Go Report Card](https://goreportcard.com/badge/codeberg.org/scip/epuppy)](https://goreportcard.com/report/codeberg.org/scip/epuppy)
# epuppy - terminal epub reader # epuppy - terminal epub reader
@@ -21,16 +21,16 @@ long run.
## Screenshots ## Screenshots
- Viewing an ebook in dark mode - Viewing an ebook in dark mode
![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/darkmode.png) ![Screenshot](https://codeberg.org/scip/epuppy/raw/branch/main/.codeberg/assets/darkmode.png)
- Viewing an ebook in light mode - Viewing an ebook in light mode
![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/light.png) ![Screenshot](https://codeberg.org/scip/epuppy/raw/branch/main/.codeberg/assets/light.png)
- You can interactively adjust text width - You can interactively adjust text width
![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/margin.png) ![Screenshot](https://codeberg.org/scip/epuppy/raw/branch/main/.codeberg/assets/margin.png)
- Showing the help - Showing the help
![Screenshot](https://github.com/TLINDEN/epuppy/blob/main/.github/assets/help.png) ![Screenshot](https://codeberg.org/scip/epuppy/raw/branch/main/.codeberg/assets/help.png)
## Usage ## Usage
@@ -99,7 +99,12 @@ your platform from the releases page and you're good to go.
### Installation using a pre-compiled binary ### Installation using a pre-compiled binary
Go to the [latest release page](https://github.com/TLINDEN/epuppy/releases/latest) You can use [stew](https://github.com/marwanhawari/stew) to install epuppy:
```default
stew install https://codeberg.org/scip/epuppy
```
Or go to the [latest release page](https://codeberg.org/scip/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,
@@ -139,7 +144,7 @@ sudo make install
# Report bugs # Report bugs
[Please open an issue](https://github.com/TLINDEN/epuppy/issues). Thanks! [Please open an issue](https://codeberg.org/scip/epuppy/issues). Thanks!
# License # License

View File

@@ -32,7 +32,7 @@ import (
) )
const ( const (
Version string = `v0.0.5` Version string = `v0.0.7`
Usage string = `This is epuppy, a terminal ui ebook viewer. Usage string = `This is epuppy, a terminal ui ebook viewer.
Usage: epuppy [options] <epub file> Usage: epuppy [options] <epub file>

View File

@@ -22,45 +22,44 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"codeberg.org/scip/epuppy/pkg/epub"
"github.com/alecthomas/repr" "github.com/alecthomas/repr"
"github.com/tlinden/epuppy/pkg/epub"
) )
func View(conf *Config) (int, error) { func Prepare(conf *Config) (*Ebook, error) {
switch filepath.Ext(conf.Document) { switch filepath.Ext(conf.Document) {
case ".epub": case ".epub":
return ViewEpub(conf) return PrepareEpub(conf)
default: default:
return ViewText(conf) return PrepareText(conf)
} }
} }
func ViewText(conf *Config) (int, error) { func PrepareText(conf *Config) (*Ebook, error) {
data, err := os.ReadFile(conf.Document) data, err := os.ReadFile(conf.Document)
if err != nil { if err != nil {
return 0, err return nil, err
} }
if conf.Dump { return &Ebook{
return fmt.Println(string(data))
}
return Pager(&Ebook{
Config: conf, Config: conf,
Title: conf.Document, Title: conf.Document,
Body: string(data), Body: string(data),
}) }, nil
} }
func ViewEpub(conf *Config) (int, error) { func PrepareEpub(conf *Config) (*Ebook, error) {
book, err := epub.Open(conf.Document, conf.XML) book, err := epub.Open(conf.Document, conf.XML)
if err != nil { if err != nil {
return 0, err return nil, err
} }
if conf.Debug { if conf.Debug {
repr.Println("book.Files()")
repr.Println(book.Files()) repr.Println(book.Files())
repr.Println(book.Ncx) repr.Println(book.Ncx)
repr.Println(book.Sections)
repr.Println(book.Opf.Manifest)
} }
buf := strings.Builder{} buf := strings.Builder{}
@@ -80,21 +79,13 @@ func ViewEpub(conf *Config) (int, error) {
fetchByContent(conf, &buf, book) fetchByContent(conf, &buf, book)
if conf.Dump { return &Ebook{
return fmt.Println(buf.String())
}
if conf.Debug {
return 0, nil
}
return Pager(&Ebook{
Config: conf, Config: conf,
Title: head.String(), Title: head.String(),
Body: buf.String(), Body: buf.String(),
Cover: book.CoverImage, Cover: book.CoverImage,
MediaType: book.CoverMediaType, MediaType: book.CoverMediaType,
}) }, nil
} }
func fetchByContent(conf *Config, buf *strings.Builder, book *epub.Book) bool { func fetchByContent(conf *Config, buf *strings.Builder, book *epub.Book) bool {

View File

@@ -59,7 +59,21 @@ func Execute(output io.Writer) int {
} }
} }
progress, err := View(conf) 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 { if err != nil {
return Die(err) return Die(err)
} }

118
cmd/view_test.go Normal file
View 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 Forums 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 Forums 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 peoples 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")
})
}
}

6
go.mod
View File

@@ -1,4 +1,4 @@
module github.com/tlinden/epuppy module codeberg.org/scip/epuppy
go 1.24.0 go 1.24.0
@@ -43,6 +43,7 @@ require (
github.com/antchfx/xpath v1.3.5 // indirect github.com/antchfx/xpath v1.3.5 // indirect
github.com/blacktop/go-termimg v0.1.20 // indirect github.com/blacktop/go-termimg v0.1.20 // indirect
github.com/charmbracelet/x/mosaic v0.0.0-20250702191427-5bdfc8f2e4ff // 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/fsnotify/fsnotify v1.9.0 // indirect
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
@@ -53,9 +54,12 @@ require (
github.com/mitchellh/reflectwalk v1.0.2 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect
github.com/pelletier/go-toml v1.9.5 // 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/rogpeppe/go-internal v1.14.1 // indirect
github.com/soniakeys/quant v1.0.0 // 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/image v0.25.0 // indirect
golang.org/x/net v0.44.0 // indirect golang.org/x/net v0.44.0 // indirect
golang.org/x/tools v0.37.0 // indirect golang.org/x/tools v0.37.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
) )

2
go.sum
View File

@@ -95,6 +95,8 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 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 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= 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 h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= 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= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=

View File

@@ -19,7 +19,7 @@ package main
import ( import (
"os" "os"
"github.com/tlinden/epuppy/cmd" "codeberg.org/scip/epuppy/cmd"
) )
func main() { func main() {

View File

@@ -1,75 +0,0 @@
#!/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

View File

@@ -9,6 +9,11 @@ import (
"path" "path"
) )
// a section in the book
type Section struct {
File, Title, MediaType string
}
// Book epub book // Book epub book
type Book struct { type Book struct {
Ncx Ncx `json:"ncx"` Ncx Ncx `json:"ncx"`
@@ -20,6 +25,8 @@ type Book struct {
CoverImage []byte CoverImage []byte
CoverFile string CoverFile string
CoverMediaType string CoverMediaType string
Sections []Section
dumpxml bool
} }
// Open open resource file // Open open resource file

View File

@@ -10,7 +10,8 @@ import (
var ( var (
cleanentitles = regexp.MustCompile(`&[a-z]+;`) cleanentitles = regexp.MustCompile(`&[a-z]+;`)
empty = regexp.MustCompile(`(?s)^[\s ]*$`) empty = regexp.MustCompile(`(?s)^[\s ]*$`)
newlines = regexp.MustCompile(`[\r\n]+`) newlines = regexp.MustCompile(`[\r\n\s]+`)
cleansvg = regexp.MustCompile(`(<svg.+</svg>|<!\[CDATA\[.+\]\]>)`)
cleanmarkup = regexp.MustCompile(`<[^<>]+>`) cleanmarkup = regexp.MustCompile(`<[^<>]+>`)
) )
@@ -27,7 +28,8 @@ type Content struct {
func (c *Content) String(content []byte) error { func (c *Content) String(content []byte) error {
doc, err := xmlquery.Parse( doc, err := xmlquery.Parse(
strings.NewReader( strings.NewReader(
cleanentitles.ReplaceAllString(string(content), " "))) cleansvg.ReplaceAllString(
cleanentitles.ReplaceAllString(string(content), " "), "")))
if err != nil { if err != nil {
return err return err
} }

View File

@@ -4,48 +4,87 @@ import (
"archive/zip" "archive/zip"
"fmt" "fmt"
"log" "log"
"os" "path/filepath"
"regexp"
"strings" "strings"
"github.com/alecthomas/repr"
) )
// Open open a epub file 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) { 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) fd, err := zip.OpenReader(fn)
if err != nil { if err != nil {
return nil, err return nil, err
} }
defer func() { bk := &Book{fd: fd, dumpxml: dumpxml}
if err := fd.Close(); err != nil {
log.Fatal(err)
}
}()
bk := Book{fd: fd} return bk, nil
}
// load the manifest
func (bk *Book) getManifest() error {
mt, err := bk.readBytes("mimetype") mt, err := bk.readBytes("mimetype")
if err != nil { if err != nil {
return &bk, err return err
} }
bk.Mimetype = string(mt) bk.Mimetype = string(mt)
// contains the root path
err = bk.readXML("META-INF/container.xml", &bk.Container) err = bk.readXML("META-INF/container.xml", &bk.Container)
if err != nil { if err != nil {
return &bk, err return err
} }
// contains the OPF data
err = bk.readXML(bk.Container.Rootfile.Path, &bk.Opf) err = bk.readXML(bk.Container.Rootfile.Path, &bk.Opf)
if err != nil { if err != nil {
return &bk, err return err
} }
// look for TOC (might be incomplete, see below!)
for _, mf := range bk.Opf.Manifest { for _, mf := range bk.Opf.Manifest {
if mf.ID == bk.Opf.Spine.Toc { if mf.ID == bk.Opf.Spine.Toc {
err = bk.readXML(bk.filename(mf.Href), &bk.Ncx) err = bk.readXML(bk.filename(mf.Href), &bk.Ncx)
if err != nil { if err != nil {
return &bk, err return err
} }
} }
@@ -55,58 +94,112 @@ func Open(fn string, dumpxml bool) (*Book, error) {
} }
} }
type section struct { return nil
file, title string
} }
sections := []section{} // 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 { if len(bk.Ncx.Points) > 0 {
for _, block := range bk.Ncx.Points { for _, block := range bk.Ncx.Points {
sections = append(sections, sect := Section{
section{ File: "OEBPS/" + block.Content.Src,
file: "OEBPS/" + block.Content.Src, Title: block.Text,
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 { } else {
// no TOC, just pull in the files directly
for _, file := range bk.Files() { for _, file := range bk.Files() {
sections = append(sections, sections = append(sections,
section{ Section{
file: file, File: file,
MediaType: "application/" + cleanext.ReplaceAllString(filepath.Ext(file), ""),
}) })
} }
} }
for _, section := range sections { // final sections to keep
content, err := bk.readBytes(section.file) bk.Sections = sections
if err != nil {
return &bk, err return nil
} }
if strings.Contains(section.file, bk.CoverFile) { 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 bk.CoverImage = content
} }
ct := Content{Src: section.file, Title: section.title} ct := Content{Src: section.File, Title: section.Title}
if strings.Contains(string(content), "<?xml") || strings.Contains(string(content), "<!DOCTYPE") { if types.MatchString(section.MediaType) {
if err := ct.String(content); err != nil { if err := ct.String(content); err != nil {
return &bk, err return err
} }
} }
if dumpxml { if bk.dumpxml {
fmt.Println(string(ct.XML)) fmt.Println(string(ct.XML))
} }
bk.Content = append(bk.Content, ct) bk.Content = append(bk.Content, ct)
} }
if dumpxml { return nil
repr.Println(sections)
os.Exit(0)
}
return &bk, nil
} }

BIN
t/epub/basic-v3plus2.epub Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
t/epub/epub30-spec.epub Normal file

Binary file not shown.

Binary file not shown.

BIN
t/epub/georgia-cfi.epub Normal file

Binary file not shown.

BIN
t/epub/israelsailing.epub Normal file

Binary file not shown.

Binary file not shown.

BIN
t/epub/minimal-v2.epub Normal file

Binary file not shown.

BIN
t/epub/minimal-v3.epub Normal file

Binary file not shown.

BIN
t/epub/minimal-v3plus2.epub Normal file

Binary file not shown.

BIN
t/epub/moby-dick.epub Normal file

Binary file not shown.

BIN
t/epub/sous-le-vent.epub Normal file

Binary file not shown.

BIN
t/epub/wasteland-otf.epub Normal file

Binary file not shown.