mirror of
https://codeberg.org/scip/epuppy.git
synced 2026-02-04 09:40:57 +01:00
Compare commits
16 Commits
main
...
woodpecker
| Author | SHA1 | Date | |
|---|---|---|---|
| ee26834054 | |||
| cce26c562b | |||
| 6ceed77fd0 | |||
| 60a1d545ed | |||
| 3a72204915 | |||
| 0516534526 | |||
| d260f5299f | |||
| 1f93d2d37d | |||
| 55addf2a77 | |||
| 06dec42e83 | |||
| fceee7bc04 | |||
| 8edca6d367 | |||
| 1ab65e69a0 | |||
| 7a62b2d19d | |||
| 030c1ba495 | |||
| 9b6f062c65 |
38
README.md
38
README.md
@@ -1,5 +1,5 @@
|
||||
[](https://ci.codeberg.org/repos/15473)
|
||||
[](https://codeberg.org/scip/epuppy/raw/branch/main/LICENSE)
|
||||
[](https://ci.codeberg.org/repos/15473)
|
||||
[](https://codeberg.org/scip/epuppy/raw/branch/master/LICENSE)
|
||||
[](https://goreportcard.com/report/codeberg.org/scip/epuppy)
|
||||
|
||||
|
||||
@@ -20,20 +20,16 @@ long run.
|
||||
|
||||
## 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
|
||||
|
||||
- You can interactively adjust text width
|
||||

|
||||
|
||||
### Showing the help
|
||||
|
||||
- Showing the help
|
||||

|
||||
|
||||
## Usage
|
||||
@@ -46,7 +42,7 @@ progress.
|
||||
Sometimes you may be unhappy with the colors. Depending on your
|
||||
terminal style you can enable dark mode with `-D`, light mode is the
|
||||
default. You can also configure custom colors in a config file in
|
||||
`$HOME/.config/epuppy/config.toml`:
|
||||
`$HOME/.config/epuppy/confit.toml`:
|
||||
|
||||
```toml
|
||||
# color setting for dark mode
|
||||
@@ -96,24 +92,6 @@ Options:
|
||||
-v --version show program version
|
||||
```
|
||||
|
||||
## Reading mobi files
|
||||
|
||||
`epuppy` doesn't support mobi files, but you can easily
|
||||
convert them to epub format using calibre, which contains a tool named
|
||||
`ebook-convert`. You can install it on Ubuntu with:
|
||||
|
||||
`apt install calibre`
|
||||
|
||||
On Fedora use:
|
||||
|
||||
`dnf install ebook-tools`
|
||||
|
||||
To convert, execute:
|
||||
|
||||
```default
|
||||
ebook-convert somebook.mobi somebook.epub
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
The tool does not have any dependencies. Just download the binary for
|
||||
@@ -126,7 +104,7 @@ You can use [stew](https://github.com/marwanhawari/stew) to install epuppy:
|
||||
stew install https://codeberg.org/scip/epuppy
|
||||
```
|
||||
|
||||
Or go to the [latest release page](https://codeberg.org/scip/epuppy/releases/)
|
||||
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:
|
||||
|
||||
Directly download the binary for your platform,
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
Copyright © 2025-2026 Thomas von Dein
|
||||
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
|
||||
@@ -27,13 +27,12 @@ import (
|
||||
"github.com/knadh/koanf/parsers/toml"
|
||||
"github.com/knadh/koanf/providers/file"
|
||||
"github.com/knadh/koanf/providers/posflag"
|
||||
"github.com/knadh/koanf/providers/structs"
|
||||
"github.com/knadh/koanf/v2"
|
||||
flag "github.com/spf13/pflag"
|
||||
)
|
||||
|
||||
const (
|
||||
Version string = `v0.0.8`
|
||||
Version string = `v0.0.7`
|
||||
Usage string = `This is epuppy, a terminal ui ebook viewer.
|
||||
|
||||
Usage: epuppy [options] <epub file>
|
||||
@@ -43,7 +42,6 @@ Options:
|
||||
-s --store-progress remember reading position
|
||||
-n --line-numbers add line numbers
|
||||
-c --config <file> use config <file>
|
||||
--create-config create a default config file
|
||||
-i --cover-image display cover image
|
||||
-t --txt dump readable content to STDOUT
|
||||
-x --xml dump source xml to STDOUT
|
||||
@@ -53,31 +51,6 @@ Options:
|
||||
-v --version show program version`
|
||||
)
|
||||
|
||||
var (
|
||||
DefaultDark = ColorSetting{
|
||||
Title: "#ff4500",
|
||||
Chapter: "#ff4500",
|
||||
Body: "#cdb79e",
|
||||
}
|
||||
|
||||
DefaultLight = ColorSetting{
|
||||
Title: "#ff0000",
|
||||
Chapter: "#8b0000",
|
||||
Body: "#696969",
|
||||
}
|
||||
)
|
||||
|
||||
// used for config writing, it's a subset of the Config struct
|
||||
// add fields as you add user configurable fields to Config
|
||||
type UserConfig struct {
|
||||
StoreProgress bool `koanf:"store-progress"`
|
||||
Darkmode bool `koanf:"dark"`
|
||||
LineNumbers bool `koanf:"line-numbers"`
|
||||
NoColor bool `koanf:"no-color"`
|
||||
ColorDark ColorSetting `koanf:"colordark"`
|
||||
ColorLight ColorSetting `koanf:"colorlight"`
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
Showversion bool `koanf:"version"` // -v
|
||||
Debug bool `koanf:"debug"` // -d
|
||||
@@ -91,15 +64,13 @@ type Config struct {
|
||||
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
|
||||
CreateConfig bool `koanf:"create-config"` // --create-config
|
||||
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) {
|
||||
conf := &Config{}
|
||||
var kloader = koanf.New(".")
|
||||
|
||||
// setup custom usage
|
||||
@@ -122,7 +93,6 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
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.BoolP("create-config", "", false, "create a config file with default settings")
|
||||
flagset.StringP("config", "c", "", "read config from file")
|
||||
|
||||
if err := flagset.Parse(os.Args[1:]); err != nil {
|
||||
@@ -134,13 +104,14 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
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(conf.GetConfigDir(), "config.toml"),
|
||||
filepath.Join(home, ".config", "epuppy", "config.toml"),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -161,6 +132,7 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
}
|
||||
|
||||
// fetch values
|
||||
conf := &Config{}
|
||||
if err := kloader.Unmarshal("", &conf); err != nil {
|
||||
return nil, fmt.Errorf("error unmarshalling: %w", err)
|
||||
}
|
||||
@@ -169,7 +141,7 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
if len(flagset.Args()) > 0 {
|
||||
conf.Document = flagset.Args()[0]
|
||||
} else {
|
||||
if !conf.Showversion && !conf.ShowHelp && !conf.CreateConfig {
|
||||
if !conf.Showversion && !conf.ShowHelp {
|
||||
flagset.Usage()
|
||||
os.Exit(1)
|
||||
}
|
||||
@@ -180,7 +152,18 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
}
|
||||
|
||||
// setup color config
|
||||
conf.Colors = SetColorconfig(DefaultDark, DefaultLight, conf)
|
||||
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 {
|
||||
@@ -190,41 +173,7 @@ func InitConfig(output io.Writer) (*Config, error) {
|
||||
return conf, nil
|
||||
}
|
||||
|
||||
func (conf *Config) GetConfigDir() string {
|
||||
func (c *Config) GetConfigDir() string {
|
||||
home, _ := os.UserHomeDir()
|
||||
return filepath.Join(home, ".config", "epuppy")
|
||||
}
|
||||
|
||||
func (conf *Config) WriteConfigFile() (string, error) {
|
||||
cfgfile := filepath.Join(conf.GetConfigDir(), "config.toml")
|
||||
|
||||
if FileExists(cfgfile) {
|
||||
return "", fmt.Errorf("config file %s already exists", cfgfile)
|
||||
}
|
||||
|
||||
var kloader = koanf.New(".")
|
||||
|
||||
userconf := UserConfig{
|
||||
StoreProgress: conf.StoreProgress,
|
||||
Darkmode: conf.Darkmode,
|
||||
LineNumbers: conf.LineNumbers,
|
||||
NoColor: conf.NoColor,
|
||||
ColorDark: DefaultDark,
|
||||
ColorLight: DefaultLight,
|
||||
}
|
||||
|
||||
if err := kloader.Load(structs.Provider(userconf, "koanf"), nil); err != nil {
|
||||
return "", fmt.Errorf("error loading config struct: %w", err)
|
||||
}
|
||||
|
||||
toml, err := kloader.Marshal(toml.Parser())
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("error unmarshalling config: %w", err)
|
||||
}
|
||||
|
||||
if err := WriteFile(cfgfile, toml); err != nil {
|
||||
return "", fmt.Errorf("error writing config file %s: %w", cfgfile, err)
|
||||
}
|
||||
|
||||
return fmt.Sprintf("new config file %s created.", cfgfile), nil
|
||||
}
|
||||
|
||||
14
cmd/root.go
14
cmd/root.go
@@ -52,20 +52,6 @@ func Execute(output io.Writer) int {
|
||||
return 0
|
||||
}
|
||||
|
||||
if conf.CreateConfig {
|
||||
msg, err := conf.WriteConfigFile()
|
||||
if err != nil {
|
||||
return Die(err)
|
||||
}
|
||||
|
||||
_, err = fmt.Fprintln(output, msg)
|
||||
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 {
|
||||
|
||||
30
cmd/store.go
30
cmd/store.go
@@ -102,37 +102,9 @@ func Mkdir(dir string) error {
|
||||
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, "")
|
||||
}
|
||||
|
||||
func FileExists(filename string) bool {
|
||||
info, err := os.Stat(filename)
|
||||
|
||||
if err != nil {
|
||||
// return false on any error
|
||||
return false
|
||||
}
|
||||
|
||||
return !info.IsDir()
|
||||
}
|
||||
|
||||
func WriteFile(filename string, content []byte) error {
|
||||
var err error
|
||||
|
||||
fd, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to open file %s for writing: %w", filename, err)
|
||||
}
|
||||
defer func() {
|
||||
if err := fd.Close(); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
}()
|
||||
|
||||
_, err = fd.Write(content)
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
2
go.mod
2
go.mod
@@ -44,12 +44,10 @@ require (
|
||||
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/fatih/structs v1.1.0 // 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/knadh/koanf/providers/structs v1.0.0 // 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
|
||||
|
||||
4
go.sum
4
go.sum
@@ -33,8 +33,6 @@ 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/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
|
||||
github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
|
||||
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=
|
||||
@@ -50,8 +48,6 @@ github.com/knadh/koanf/providers/file v1.2.0 h1:hrUJ6Y9YOA49aNu/RSYzOTFlqzXSCpmY
|
||||
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/providers/structs v1.0.0 h1:DznjB7NQykhqCar2LvNug3MuxEQsZ5KvfgMbio+23u4=
|
||||
github.com/knadh/koanf/providers/structs v1.0.0/go.mod h1:kjo5TFtgpaZORlpoJqcbeLowM2cINodv8kX+oFAeQ1w=
|
||||
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=
|
||||
|
||||
@@ -8,12 +8,11 @@ import (
|
||||
)
|
||||
|
||||
var (
|
||||
cleanenTitles = regexp.MustCompile(`&[a-z]+;`)
|
||||
isEmpty = regexp.MustCompile(`(?s)^[\s ]*$`)
|
||||
cleanNewlines = regexp.MustCompile(`[\r\n\s]+`)
|
||||
cleanSVG = regexp.MustCompile(`(<svg.+</svg>|<!\[CDATA\[.+\]\]>)`)
|
||||
cleanMarkup = regexp.MustCompile(`<[^<>]+>`)
|
||||
cleanMobiPageBreaks = regexp.MustCompile(`<mbp:pagebreak/>`)
|
||||
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
|
||||
@@ -26,28 +25,13 @@ type Content struct {
|
||||
}
|
||||
|
||||
// parse XML, look for title and <p>.*</p> stuff
|
||||
func (c *Content) Extract(content []byte) error {
|
||||
rawXML := cleanSVG.ReplaceAllString(
|
||||
cleanenTitles.ReplaceAllString(string(content), " "), "")
|
||||
|
||||
var doc *xmlquery.Node
|
||||
var err error
|
||||
|
||||
doc, err = xmlquery.Parse(strings.NewReader(rawXML))
|
||||
func (c *Content) String(content []byte) error {
|
||||
doc, err := xmlquery.Parse(
|
||||
strings.NewReader(
|
||||
cleansvg.ReplaceAllString(
|
||||
cleanentitles.ReplaceAllString(string(content), " "), "")))
|
||||
if err != nil {
|
||||
if strings.Contains(err.Error(), `namespace mbp is missing`) {
|
||||
fixedmbp := strings.NewReader(
|
||||
cleanMobiPageBreaks.ReplaceAllString(
|
||||
rawXML, `<span style="page-break-after: always" />`))
|
||||
|
||||
doc, err = xmlquery.Parse(fixedmbp)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
} else {
|
||||
return err
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
if c.Title == "" {
|
||||
@@ -63,9 +47,9 @@ func (c *Content) Extract(content []byte) error {
|
||||
txt := strings.Builder{}
|
||||
var have_p bool
|
||||
for _, item := range xmlquery.Find(doc, "//p") {
|
||||
if !isEmpty.MatchString(item.InnerText()) {
|
||||
if !empty.MatchString(item.InnerText()) {
|
||||
have_p = true
|
||||
txt.WriteString(cleanNewlines.ReplaceAllString(item.InnerText(), " ") + "\n\n")
|
||||
txt.WriteString(newlines.ReplaceAllString(item.InnerText(), " ") + "\n\n")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -73,9 +57,9 @@ func (c *Content) Extract(content []byte) error {
|
||||
// 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 !isEmpty.MatchString(item.InnerText()) {
|
||||
cleaned := cleanMarkup.ReplaceAllString(item.InnerText(), "")
|
||||
txt.WriteString(cleanNewlines.ReplaceAllString(cleaned, " ") + "\n\n")
|
||||
if !empty.MatchString(item.InnerText()) {
|
||||
cleaned := cleanmarkup.ReplaceAllString(item.InnerText(), "")
|
||||
txt.WriteString(newlines.ReplaceAllString(cleaned, " ") + "\n\n")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -112,8 +112,6 @@ func (bk *Book) getSections() error {
|
||||
|
||||
// we have ncx points from the TOC, try those
|
||||
if len(bk.Ncx.Points) > 0 {
|
||||
known := map[string]int{}
|
||||
|
||||
for _, block := range bk.Ncx.Points {
|
||||
sect := Section{
|
||||
File: "OEBPS/" + block.Content.Src,
|
||||
@@ -130,13 +128,7 @@ func (bk *Book) getSections() error {
|
||||
}
|
||||
}
|
||||
|
||||
if _, haveFile := known[sect.File]; !haveFile {
|
||||
// sometimes epub's have many sections but they all
|
||||
// point to the same file. To avoid duplicate content
|
||||
// we ignore sections (thus files) we have already seen.
|
||||
sections = append(sections, sect)
|
||||
known[sect.File] = 1
|
||||
}
|
||||
sections = append(sections, sect)
|
||||
}
|
||||
|
||||
if len(sections) < manifestcount {
|
||||
@@ -197,7 +189,7 @@ func (bk *Book) readSectionContent() error {
|
||||
ct := Content{Src: section.File, Title: section.Title}
|
||||
|
||||
if types.MatchString(section.MediaType) {
|
||||
if err := ct.Extract(content); err != nil {
|
||||
if err := ct.String(content); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user