diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 449166e0..159a0582 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -15,14 +15,14 @@ jobs:
runs-on: [self-hosted, arm64]
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up Go
- uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
+ uses: actions/setup-go@f111f3307d8850f501ac008e886eec1fd1932a34 # v5.3.0
with:
go-version: '>=1.23.0'
cache: false
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index 8b547115..a2e64811 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -41,7 +41,7 @@ jobs:
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
@@ -50,7 +50,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
- uses: github/codeql-action/init@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
+ uses: github/codeql-action/init@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
@@ -60,7 +60,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
- uses: github/codeql-action/autobuild@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
+ uses: github/codeql-action/autobuild@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8
# âšī¸ Command-line programs to run using the OS shell.
# đ See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -73,6 +73,6 @@ jobs:
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
+ uses: github/codeql-action/analyze@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8
with:
category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
index 21a469b1..1b495dbc 100644
--- a/.github/workflows/dependency-review.yml
+++ b/.github/workflows/dependency-review.yml
@@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index e3b6f836..20462585 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -17,7 +17,7 @@ jobs:
runs-on: [self-hosted, arm64]
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
@@ -27,12 +27,12 @@ jobs:
fetch-depth: 0
- run: git fetch --force --tags
- name: Set up Go
- uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
+ uses: actions/setup-go@f111f3307d8850f501ac008e886eec1fd1932a34 # v5.3.0
with:
go-version: '>=1.23.0'
cache: false
- name: Build release
- uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.1.0
+ uses: goreleaser/goreleaser-action@90a3faa9d0182683851fbfa97ca1a2cb983bfca3 # v6.2.1
with:
distribution: goreleaser
version: latest
@@ -43,7 +43,7 @@ jobs:
runs-on: [self-hosted, arm64]
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
@@ -53,9 +53,9 @@ jobs:
fetch-depth: 0
- run: git fetch --force --tags
- name: Set up Docker Buildx
- uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
+ uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0
- name: Build and push Docker image
- run: docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"
+ run: docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}" --build-arg NO_SNAPSHOT=true
- name: Log in to registry
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
- name: Push image
@@ -73,4 +73,5 @@ jobs:
echo VERSION=$VERSION
docker buildx build --push \
--tag $IMAGE_ID:$VERSION \
+ --build-arg NO_SNAPSHOT=true \
--platform linux/amd64,linux/arm64,linux/arm/v7 .
diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml
index c7ddeeef..de156895 100644
--- a/.github/workflows/scorecards.yml
+++ b/.github/workflows/scorecards.yml
@@ -31,7 +31,7 @@ jobs:
steps:
- name: Harden Runner
- uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+ uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
with:
egress-policy: audit
@@ -63,7 +63,7 @@ jobs:
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
# format to the repository Actions tab.
- name: "Upload artifact"
- uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+ uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
name: SARIF file
path: results.sarif
@@ -71,6 +71,6 @@ jobs:
# Upload the results to GitHub's code scanning dashboard.
- name: "Upload to code-scanning"
- uses: github/codeql-action/upload-sarif@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
+ uses: github/codeql-action/upload-sarif@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8
with:
sarif_file: results.sarif
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
index 892bcd44..159a7c1a 100644
--- a/.goreleaser.yaml
+++ b/.goreleaser.yaml
@@ -1,8 +1,11 @@
# Make sure to check the documentation at https://goreleaser.com
+version: 2
before:
hooks:
- go mod tidy
- go generate ./...
+gomod:
+ proxy: true
builds:
- main: ./cmd/rwp/
env:
@@ -13,21 +16,20 @@ builds:
- linux
- windows
- darwin
+ goarch:
+ - '386'
+ - amd64
+ - arm
+ - arm64
+ goarm:
+ - '7'
goamd64:
- v3
-
-# - main: ./cmd/server/
-# env:
-# - CGO_ENABLED=0
-# id: rwp-server
-# binary: rwp-server
-# goos:
-# - linux
-# - windows
-# - darwin
+ ldflags:
+ - -s -w
archives:
- - format: tar.gz
+ - formats: tar.gz
# this name template makes the OS and Arch compatible with the results of uname.
# Used to start with {{ .ProjectName }}
name_template: >-
@@ -40,8 +42,8 @@ archives:
# use zip for windows archives
format_overrides:
- goos: windows
- format: zip
+ formats: ['zip']
checksum:
name_template: 'checksums.txt'
snapshot:
- name_template: "{{ incpatch .Version }}-next"
+ version_template: "{{ incpatch .Version }}-next"
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d04ed03e..e4aaf43a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,4 +6,41 @@ All notable changes to this project will be documented in this file.
## [Unreleased]
-TODO
\ No newline at end of file
+## [0.8.1] - 2025-02-24
+
+### Changed
+
+- Docker containers & releases now properly build ARM (32-bit) images with v7 (not v6) support
+
+## [0.8.0] - 2025-02-24
+
+### Added
+
+- Support for [EPUB Accessibility 1.1](https://www.w3.org/TR/epub-a11y-11/) conformance values
+- `--version` flag for `rwp`
+- Output of `go-toolkit` version in WebPub metadata. [Based on the Go module pseudo-version](https://github.com/readium/go-toolkit/issues/80#issuecomment-2673888192)
+
+### Changed
+
+- A11y `conformsTo` values are now sorted from highest to lowest conformance level
+
+## [0.7.1] - 2025-02-07
+
+### Added
+
+- Add [TDMRep](https://www.w3.org/community/reports/tdmrep/CG-FINAL-tdmrep-20240510/#sec-epub3) support for EPUB 2 & 3.
+
+### Fixed
+
+- Fix typo in EAA exemption.
+
+## [0.7.0] - 2025-01-31
+
+### Added
+
+- Implement support for [EPUB accessibility exemptions](https://www.w3.org/TR/epub-a11y-exemption/), with output in WebPub manifests
+
+### Changed
+
+- The a11y feature `printPageNumbers` has been renamed to `pageNavigation` as per #92
+- Dependencies were updated to latest versions, code adjustments were made for changes in pdfcpu
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index af289cb6..03a5fedc 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,9 +1,10 @@
-FROM --platform=$BUILDPLATFORM golang:1-bookworm@sha256:ef30001eeadd12890c7737c26f3be5b3a8479ccdcdc553b999c84879875a27ce AS builder
+FROM --platform=$BUILDPLATFORM golang:1-bookworm@sha256:3149bc5043fa58cf127fd8db1fdd4e533b6aed5a40d663d4f4ae43d20386665f AS builder
ARG BUILDARCH TARGETOS TARGETARCH
+ARG NO_SNAPSHOT=false
# Install GoReleaser
-RUN wget --no-verbose "https://github.com/goreleaser/goreleaser/releases/download/v1.26.2/goreleaser_1.26.2_$BUILDARCH.deb"
-RUN dpkg -i "goreleaser_1.26.2_$BUILDARCH.deb"
+RUN wget --no-verbose "https://github.com/goreleaser/goreleaser/releases/download/v2.7.0/goreleaser_2.7.0_$BUILDARCH.deb"
+RUN dpkg -i "goreleaser_2.7.0_$BUILDARCH.deb"
# Create and change to the app directory.
WORKDIR /app
@@ -17,12 +18,15 @@ RUN go mod download
# Copy local code to the container image.
COPY . ./
+RUN git describe --tags --always
+
# RUN git lfs pull && ls -alh publications
# Run goreleaser
RUN --mount=type=cache,target=/root/.cache/go-build \
--mount=type=cache,target=/go/pkg \
- GOOS=$TARGETOS GOARCH=$TARGETARCH goreleaser build --single-target --id rwp --skip=validate --snapshot --output ./rwp
+ GOOS=$TARGETOS GOARCH=$TARGETARCH GOAMD64=v3 GOARM=7 \
+ goreleaser build --single-target --id rwp --skip=validate $(case "$NO_SNAPSHOT" in yes|true|1) ;; *) echo "--snapshot";; esac) --output ./rwp
# Run tests
# FROM builder AS tester
diff --git a/cmd/rwp/cmd/root.go b/cmd/rwp/cmd/root.go
index c26f6101..fb872c7f 100644
--- a/cmd/rwp/cmd/root.go
+++ b/cmd/rwp/cmd/root.go
@@ -3,13 +3,15 @@ package cmd
import (
"os"
+ "github.com/readium/go-toolkit/pkg/util/version"
"github.com/spf13/cobra"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
- Use: "rwp",
- Short: "Utilities for Readium Web Publications",
+ Use: "rwp",
+ Short: "Utilities for Readium Web Publications",
+ Version: version.Version,
}
// Execute adds all child commands to the root command and sets flags appropriately.
diff --git a/go.mod b/go.mod
index 1f761c28..3906b8cd 100644
--- a/go.mod
+++ b/go.mod
@@ -1,18 +1,18 @@
module github.com/readium/go-toolkit
-go 1.22
+go 1.22.0
-toolchain go1.23.4
+toolchain go1.23.5
require (
github.com/CAFxX/httpcompression v0.0.9
github.com/agext/regexp v1.3.0
- github.com/andybalholm/cascadia v1.3.2
+ github.com/andybalholm/cascadia v1.3.3
github.com/deckarep/golang-set v1.8.0
- github.com/go-viper/mapstructure/v2 v2.1.0
+ github.com/go-viper/mapstructure/v2 v2.2.1
github.com/gorilla/mux v1.8.1
github.com/gotd/contrib v0.21.0
- github.com/pdfcpu/pdfcpu v0.5.0
+ github.com/pdfcpu/pdfcpu v0.9.1
github.com/pkg/errors v0.9.1
github.com/readium/xmlquery v0.0.0-20230106230237-8f493145aef4
github.com/relvacode/iso8601 v1.6.0
@@ -21,26 +21,26 @@ require (
github.com/trimmer-io/go-xmp v1.0.0
github.com/vmihailenco/go-tinylfu v0.2.2
github.com/zeebo/xxh3 v1.0.2
- golang.org/x/exp v0.0.0-20240529005216-23cca8864a10
- golang.org/x/net v0.32.0
+ golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c
+ golang.org/x/net v0.34.0
golang.org/x/text v0.21.0
)
require (
- github.com/andybalholm/brotli v1.0.5 // indirect
- github.com/antchfx/xpath v1.2.1 // indirect
+ github.com/andybalholm/brotli v1.1.1 // indirect
+ github.com/antchfx/xpath v1.3.3 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
- github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+ github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
github.com/hhrutter/lzw v1.0.0 // indirect
github.com/hhrutter/tiff v1.0.1 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/klauspost/compress v1.17.11 // indirect
- github.com/klauspost/cpuid/v2 v2.2.8 // indirect
+ github.com/klauspost/cpuid/v2 v2.2.9 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
- github.com/spf13/pflag v1.0.5 // indirect
- golang.org/x/image v0.18.0 // indirect
- golang.org/x/sys v0.28.0 // indirect
+ github.com/spf13/pflag v1.0.6 // indirect
+ golang.org/x/image v0.23.0 // indirect
+ golang.org/x/sys v0.29.0 // indirect
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
diff --git a/go.sum b/go.sum
index 7e2e3371..35822bd4 100644
--- a/go.sum
+++ b/go.sum
@@ -2,12 +2,14 @@ github.com/CAFxX/httpcompression v0.0.9 h1:0ue2X8dOLEpxTm8tt+OdHcgA+gbDge0OqFQWG
github.com/CAFxX/httpcompression v0.0.9/go.mod h1:XX8oPZA+4IDcfZ0A71Hz0mZsv/YJOgYygkFhizVPilM=
github.com/agext/regexp v1.3.0 h1:6+9tp+S41TU48gFNV47bX+pp1q7WahGofw6JccmsCDs=
github.com/agext/regexp v1.3.0/go.mod h1:6phv1gViOJXWcTfpxOi9VMS+MaSAo+SUDf7do3ur1HA=
-github.com/andybalholm/brotli v1.0.5 h1:8uQZIdzKmjc/iuPu7O2ioW48L81FgatrcpfFmiq/cCs=
github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
-github.com/andybalholm/cascadia v1.3.2 h1:3Xi6Dw5lHF15JtdcmAHD3i1+T8plmv7BQ/nsViSLyss=
-github.com/andybalholm/cascadia v1.3.2/go.mod h1:7gtRlve5FxPPgIgX36uWBX58OdBsSS6lUvCFb+h7KvU=
-github.com/antchfx/xpath v1.2.1 h1:qhp4EW6aCOVr5XIkT+l6LJ9ck/JsUH/yyauNgTQkBF8=
+github.com/andybalholm/brotli v1.1.1 h1:PR2pgnyFznKEugtsUo0xLdDop5SKXd5Qf5ysW+7XdTA=
+github.com/andybalholm/brotli v1.1.1/go.mod h1:05ib4cKhjx3OQYUY22hTVd34Bc8upXjOLL2rKwwZBoA=
+github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM=
+github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA=
github.com/antchfx/xpath v1.2.1/go.mod h1:i54GszH55fYfBmoZXapTHN8T8tkcHfRgLyVwwqzXNcs=
+github.com/antchfx/xpath v1.3.3 h1:tmuPQa1Uye0Ym1Zn65vxPgfltWb/Lxu2jeqIGteJSRs=
+github.com/antchfx/xpath v1.3.3/go.mod h1:i54GszH55fYfBmoZXapTHN8T8tkcHfRgLyVwwqzXNcs=
github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
@@ -17,13 +19,14 @@ 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/deckarep/golang-set v1.8.0 h1:sk9/l/KqpunDwP7pSjUg0keiOOLEnOBHzykLrsPppp4=
github.com/deckarep/golang-set v1.8.0/go.mod h1:5nI87KwE7wgsBU1F4GKAw2Qod7p5kyS383rP6+o6qqo=
-github.com/go-viper/mapstructure/v2 v2.1.0 h1:gHnMa2Y/pIxElCH2GlZZ1lZSsn6XMtufpGyP1XxdC/w=
-github.com/go-viper/mapstructure/v2 v2.1.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
+github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
-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/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ=
+github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw=
github.com/google/brotli/go/cbrotli v0.0.0-20230829110029-ed738e842d2f h1:jopqB+UTSdJGEJT8tEqYyE29zN91fi2827oLET8tl7k=
github.com/google/brotli/go/cbrotli v0.0.0-20230829110029-ed738e842d2f/go.mod h1:nOPhAkwVliJdNTkj3gXpljmWhjc4wCaVqbMJcPKWP4s=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
github.com/gotd/contrib v0.21.0 h1:4Fj05jnyBE84toXZl7mVTvt7f732n5uglvztyG6nTr4=
@@ -37,15 +40,15 @@ github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLf
github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
github.com/klauspost/compress v1.17.11 h1:In6xLpyWOi1+C7tXUUWv2ot1QvBjxevKAaI6IXrJmUc=
github.com/klauspost/compress v1.17.11/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
-github.com/klauspost/cpuid/v2 v2.2.8 h1:+StwCXwm9PdpiEkPyzBXIy+M9KUb4ODm0Zarf1kS5BM=
-github.com/klauspost/cpuid/v2 v2.2.8/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws=
+github.com/klauspost/cpuid/v2 v2.2.9 h1:66ze0taIn2H33fBvCkXuv9BmCwDfafmiIVpKV9kKGuY=
+github.com/klauspost/cpuid/v2 v2.2.9/go.mod h1:rqkxqrZ1EhYM9G+hXH7YdowN5R5RGN6NK4QwQ3WMXF8=
github.com/klauspost/pgzip v1.2.6/go.mod h1:Ch1tH69qFZu15pkjo5kYi6mth2Zzwzt50oCQKQE9RUs=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/pdfcpu/pdfcpu v0.5.0 h1:F3wC4bwPbaJM+RPgm1D0Q4SAUwxElw7BhwNvL3iPgDo=
-github.com/pdfcpu/pdfcpu v0.5.0/go.mod h1:UPcHdWcMw1V6Bo5tcWHd3jZfkG8cwUwrJkQOlB6o+7g=
+github.com/pdfcpu/pdfcpu v0.9.1 h1:q8/KlBdHjkE7ZJU4ofhKG5Rjf7M6L324CVM6BMDySao=
+github.com/pdfcpu/pdfcpu v0.9.1/go.mod h1:fVfOloBzs2+W2VJCCbq60XIxc3yJHAZ0Gahv1oO0gyI=
github.com/pierrec/lz4/v4 v4.1.18 h1:xaKrnTkyoqfh1YItXl56+6KJNVYWlEEPuAQW9xsplYQ=
github.com/pierrec/lz4/v4 v4.1.18/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
@@ -61,8 +64,9 @@ github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
-github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
+github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
@@ -79,6 +83,8 @@ github.com/valyala/gozstd v1.20.1 h1:xPnnnvjmaDDitMFfDxmQ4vpx0+3CdTg2o3lALvXTU/g
github.com/valyala/gozstd v1.20.1/go.mod h1:y5Ew47GLlP37EkTB+B4s7r6A5rdaeB7ftbl9zoYiIPQ=
github.com/vmihailenco/go-tinylfu v0.2.2 h1:H1eiG6HM36iniK6+21n9LLpzx1G9R3DJa2UjUjbynsI=
github.com/vmihailenco/go-tinylfu v0.2.2/go.mod h1:CutYi2Q9puTxfcolkliPq4npPuofg9N9t8JVrjzwa3Q=
+github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU=
+github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ=
github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0=
@@ -86,23 +92,38 @@ github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0=
github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA=
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/exp v0.0.0-20240529005216-23cca8864a10 h1:vpzMC/iZhYFAjJzHU0Cfuq+w1vLLsF2vLkDrPjzKYck=
-golang.org/x/exp v0.0.0-20240529005216-23cca8864a10/go.mod h1:XtvwrStGgqGPLc4cjQfWqZHG1YFdYs6swckp8vpsjnc=
-golang.org/x/image v0.18.0 h1:jGzIakQa/ZXI1I0Fxvaa9W7yP25TqT6cHIHn+6CqvSQ=
-golang.org/x/image v0.18.0/go.mod h1:4yyo5vMFQjVjUcVk4jEQcU9MGy/rulF5WvUILseCM2E=
+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-20250128182459-e0ece0dbea4c h1:KL/ZBHXgKGVmuZBZ01Lt57yE5ws8ZPSkkihmEyq7FXc=
+golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c/go.mod h1:tujkw807nyEEAamNbDrEGzRav+ilXA7PCRAd6xsmwiU=
+golang.org/x/image v0.23.0 h1:HseQ7c2OpPKTPVzNjG5fwJsOTCiiwS4QdsYi5XU6H68=
+golang.org/x/image v0.23.0/go.mod h1:wJJBTdLfCCf3tiHa1fNxpZmUI4mmoZvwMCPP0ddoNKY=
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-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
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.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
-golang.org/x/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI=
-golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs=
+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/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
+golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0=
+golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k=
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=
@@ -110,24 +131,38 @@ golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBc
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.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
+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.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
+golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+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.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY=
+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/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 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
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/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/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
diff --git a/pkg/manifest/a11y.go b/pkg/manifest/a11y.go
index cf443064..ce703d16 100644
--- a/pkg/manifest/a11y.go
+++ b/pkg/manifest/a11y.go
@@ -2,6 +2,7 @@ package manifest
import (
"encoding/json"
+ "slices"
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/internal/extensions"
@@ -12,23 +13,25 @@ import (
// https://www.w3.org/2021/a11y-discov-vocab/latest/
// https://readium.org/webpub-manifest/schema/a11y.schema.json
type A11y struct {
- ConformsTo []A11yProfile `json:"conformsTo,omitempty"` // An established standard to which the described resource conforms.
+ ConformsTo A11yProfileList `json:"conformsTo,omitempty"` // An established standard to which the described resource conforms.
Certification *A11yCertification `json:"certification,omitempty"` // Certification of accessible publications.
Summary string `json:"summary,omitempty"` // A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
AccessModes []A11yAccessMode `json:"accessMode,omitempty"` // The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
AccessModesSufficient [][]A11yPrimaryAccessMode `json:"accessModeSufficient,omitempty"` // A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
Features []A11yFeature `json:"feature,omitempty"` // Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.
Hazards []A11yHazard `json:"hazard,omitempty"` // A characteristic of the described resource that is physiologically dangerous to some users.
+ Exemptions []A11yExemption `json:"exemption,omitempty"` // Justifications for non-conformance based on exemptions in a given jurisdiction.
}
// NewA11y creates a new empty A11y.
func NewA11y() A11y {
return A11y{
- ConformsTo: []A11yProfile{},
+ ConformsTo: A11yProfileList{},
AccessModes: []A11yAccessMode{},
AccessModesSufficient: [][]A11yPrimaryAccessMode{},
Features: []A11yFeature{},
Hazards: []A11yHazard{},
+ Exemptions: []A11yExemption{},
}
}
@@ -45,6 +48,7 @@ func (a *A11y) Merge(other *A11y) {
}
a.ConformsTo = extensions.AppendIfMissing(a.ConformsTo, other.ConformsTo...)
+ a.ConformsTo.Sort()
if other.Certification != nil {
a.Certification = other.Certification
@@ -84,6 +88,7 @@ func A11yFromJSON(rawJSON map[string]interface{}) (*A11y, error) {
return nil, errors.Wrap(err, "failed unmarshalling 'conformsTo'")
}
a.ConformsTo = A11yProfilesFromStrings(conformsTo)
+ a.ConformsTo.Sort()
if certJSON, ok := rawJSON["certification"].(map[string]interface{}); ok {
c := A11yCertification{
@@ -130,6 +135,12 @@ func A11yFromJSON(rawJSON map[string]interface{}) (*A11y, error) {
}
a.Hazards = A11yHazardsFromStrings(hazards)
+ examptions, err := parseSliceOrString(rawJSON["exemption"], true)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed unmarshalling 'exemption'")
+ }
+ a.Exemptions = A11yExemptionsFromStrings(examptions)
+
return a, nil
}
@@ -163,14 +174,70 @@ const (
EPUBA11y10WCAG20AA A11yProfile = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"
// EPUB Accessibility 1.0 - WCAG 2.0 Level AAA
EPUBA11y10WCAG20AAA A11yProfile = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"
+ // EPUB Accessibility 1.1 - WCAG 2.0 Level A
+ EPUBA11y11WCAG20A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-a"
+ // EPUB Accessibility 1.1 - WCAG 2.0 Level AA
+ EPUBA11y11WCAG20AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aa"
+ // EPUB Accessibility 1.1 - WCAG 2.0 Level AAA
+ EPUBA11y11WCAG20AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aaa"
+ // EPUB Accessibility 1.1 - WCAG 2.1 Level A
+ EPUBA11y11WCAG21A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-a"
+ // EPUB Accessibility 1.1 - WCAG 2.1 Level AA
+ EPUBA11y11WCAG21AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aa"
+ // EPUB Accessibility 1.1 - WCAG 2.1 Level AAA
+ EPUBA11y11WCAG21AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aaa"
+ // EPUB Accessibility 1.1 - WCAG 2.2 Level A
+ EPUBA11y11WCAG22A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-a"
+ // EPUB Accessibility 1.1 - WCAG 2.2 Level AA
+ EPUBA11y11WCAG22AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aa"
+ // EPUB Accessibility 1.1 - WCAG 2.2 Level AAA
+ EPUBA11y11WCAG22AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aaa"
)
+// Used for sorting. Make sure to keep it up-to-date with the consts
+var a11yProfileRanking = map[A11yProfile]int{
+ EPUBA11y10WCAG20A: 1,
+ EPUBA11y10WCAG20AA: 2,
+ EPUBA11y10WCAG20AAA: 3,
+ EPUBA11y11WCAG20A: 4,
+ EPUBA11y11WCAG20AA: 5,
+ EPUBA11y11WCAG20AAA: 6,
+ EPUBA11y11WCAG21A: 7,
+ EPUBA11y11WCAG21AA: 8,
+ EPUBA11y11WCAG21AAA: 9,
+ EPUBA11y11WCAG22A: 10,
+ EPUBA11y11WCAG22AA: 11,
+ EPUBA11y11WCAG22AAA: 12,
+}
+
func A11yProfilesFromStrings(strings []string) []A11yProfile {
return fromStrings(strings, func(str string) A11yProfile {
return A11yProfile(str)
})
}
+func (p A11yProfile) Compare(other A11yProfile) int {
+ // Compare based on the compatibility level
+ if p == other {
+ return 0
+ }
+
+ pRank := a11yProfileRanking[p]
+ oRank := a11yProfileRanking[other]
+ return oRank - pRank
+}
+
+type A11yProfileList []A11yProfile
+
+func (l A11yProfileList) Sort() {
+ if len(l) <= 1 {
+ return
+ }
+ slices.SortFunc(l, func(a, b A11yProfile) int {
+ return a.Compare(b)
+ })
+}
+
// A11yCertification represents a certification for an accessible publication.
type A11yCertification struct {
CertifiedBy string `json:"certifiedBy,omitempty"` // Identifies a party responsible for the testing and certification of the accessibility of a Publication.
@@ -275,9 +342,9 @@ const (
// The work includes an index to the content.
A11yFeatureIndex A11yFeature = "index"
- // The work includes equivalent print page numbers. This setting is most commonly used
- // with ebooks for which there is a print equivalent.
- A11yFeaturePrintPageNumbers A11yFeature = "printPageNumbers"
+ // The resource includes a means of navigating to static page break locations.
+ // The most common way of providing page navigation in digital publications is through a page list.
+ A11yFeaturePageNavigation A11yFeature = "pageNavigation"
// The reading order of the content is clearly defined in the markup
// (e.g., figures, sidebars and other secondary content has been marked up to allow it
@@ -433,6 +500,21 @@ func A11yHazardsFromStrings(strings []string) []A11yHazard {
})
}
+// A11yExemption is a justification for non-conformance based on an exemption in a given jurisdiction.
+type A11yExemption string
+
+const (
+ A11yExemptionEAADisproportionateBurden A11yExemption = "eaa-disproportionate-burden"
+ A11yExemptionEAAFundamentalAlteration A11yExemption = "eaa-fundamental-alteration"
+ A11yExemptionEAAMicroenterprise A11yExemption = "eaa-microenterprise"
+)
+
+func A11yExemptionsFromStrings(strings []string) []A11yExemption {
+ return fromStrings(strings, func(str string) A11yExemption {
+ return A11yExemption(str)
+ })
+}
+
func fromStrings[T any](strings []string, transform func(string) T) []T {
res := make([]T, 0, len(strings))
for _, s := range strings {
diff --git a/pkg/manifest/a11y_test.go b/pkg/manifest/a11y_test.go
index cb979329..59fe81f4 100644
--- a/pkg/manifest/a11y_test.go
+++ b/pkg/manifest/a11y_test.go
@@ -26,7 +26,8 @@ func TestA11yUnmarshalFullJSON(t *testing.T) {
"accessMode": ["auditory", "chartOnVisual"],
"accessModeSufficient": [["visual", "tactile"]],
"feature": ["readingOrder", "alternativeText"],
- "hazard": ["flashing", "motionSimulation"]
+ "hazard": ["flashing", "motionSimulation"],
+ "exemption": ["eaa-fundamental-alteration", "eaa-microenterprise"]
}`), &m))
assert.Equal(t, A11y{
ConformsTo: []A11yProfile{
@@ -57,6 +58,10 @@ func TestA11yUnmarshalFullJSON(t *testing.T) {
A11yHazardFlashing,
A11yHazardMotionSimulation,
},
+ Exemptions: []A11yExemption{
+ A11yExemptionEAAFundamentalAlteration,
+ A11yExemptionEAAMicroenterprise,
+ },
}, m, "unmarshalled JSON object should be equal to A11y object")
}
@@ -82,6 +87,24 @@ func TestA11yUnmarshalConformsToArray(t *testing.T) {
assert.Equal(t, e, m, "unmarshalled JSON object should be equal to A11y object")
}
+func TestA11ySortConformsTo(t *testing.T) {
+ a := A11yProfileList{
+ EPUBA11y10WCAG20A,
+ EPUBA11y11WCAG22A,
+ EPUBA11y11WCAG20AA,
+ EPUBA11y11WCAG21AA,
+ EPUBA11y11WCAG22AAA,
+ }
+ a.Sort()
+ assert.Equal(t, A11yProfileList{
+ EPUBA11y11WCAG22AAA,
+ EPUBA11y11WCAG22A,
+ EPUBA11y11WCAG21AA,
+ EPUBA11y11WCAG20AA,
+ EPUBA11y10WCAG20A,
+ }, a)
+}
+
func TestA11yUnmarshalAccessModeSufficientContainingBothStringsAndArrays(t *testing.T) {
var m A11y
assert.NoError(t, json.Unmarshal([]byte(`{"accessModeSufficient": ["auditory", ["visual", "tactile"], [], "visual"]}`), &m))
@@ -101,6 +124,7 @@ func TestA11yMarshalMinimalJSON(t *testing.T) {
AccessModesSufficient: [][]A11yPrimaryAccessMode{},
Features: []A11yFeature{},
Hazards: []A11yHazard{},
+ Exemptions: []A11yExemption{},
}
data, err := json.Marshal(m)
assert.NoError(t, err)
@@ -139,12 +163,16 @@ func TestA11yMarshalFullJSON(t *testing.T) {
A11yHazardFlashing,
A11yHazardMotionSimulation,
},
+ Exemptions: []A11yExemption{
+ A11yExemptionEAAFundamentalAlteration,
+ A11yExemptionEAAMicroenterprise,
+ },
}
data, err := json.Marshal(m)
assert.NoError(t, err)
assert.Equal(
t,
data,
- []byte(`{"conformsTo":["http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a","https://profile2"],"certification":{"certifiedBy":"company1","credential":"credential1","report":"https://report1"},"summary":"Summary","accessMode":["auditory","chartOnVisual"],"accessModeSufficient":[["auditory"],["visual","tactile"],["visual"]],"feature":["readingOrder","alternativeText"],"hazard":["flashing","motionSimulation"]}`),
+ []byte(`{"conformsTo":["http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a","https://profile2"],"certification":{"certifiedBy":"company1","credential":"credential1","report":"https://report1"},"summary":"Summary","accessMode":["auditory","chartOnVisual"],"accessModeSufficient":[["auditory"],["visual","tactile"],["visual"]],"feature":["readingOrder","alternativeText"],"hazard":["flashing","motionSimulation"],"exemption":["eaa-fundamental-alteration","eaa-microenterprise"]}`),
)
}
diff --git a/pkg/manifest/metadata.go b/pkg/manifest/metadata.go
index ebe968fe..fd2dc8be 100644
--- a/pkg/manifest/metadata.go
+++ b/pkg/manifest/metadata.go
@@ -8,6 +8,7 @@ import (
"github.com/go-viper/mapstructure/v2"
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/internal/util"
+ "github.com/readium/go-toolkit/pkg/util/version"
)
// TODO replace with generic
@@ -30,6 +31,7 @@ type Metadata struct {
LocalizedSubtitle *LocalizedString `json:"subtitle,omitempty"`
LocalizedSortAs *LocalizedString `json:"sortAs,omitempty"`
Accessibility *A11y `json:"accessibility,omitempty"`
+ TDM *TDM `json:"tdm,omitempty"`
Modified *time.Time `json:"modified,omitempty"`
Published *time.Time `json:"published,omitempty"`
Languages Strings `json:"language,omitempty" validate:"BCP47"` // TODO validator
@@ -166,6 +168,7 @@ func MetadataFromJSON(rawJson map[string]interface{}) (*Metadata, error) {
return nil, errors.Wrap(err, "failed parsing 'title'")
}
+ // Accessibility
var a11y *A11y
if a11yJSON, ok := rawJson["accessibility"].(map[string]interface{}); ok {
a11y, err = A11yFromJSON(a11yJSON)
@@ -174,11 +177,21 @@ func MetadataFromJSON(rawJson map[string]interface{}) (*Metadata, error) {
}
}
+ // TDMRep (Text & Data Mining Reservation Protocol)
+ var tdm *TDM
+ if tdmJSON, ok := rawJson["tdm"].(map[string]interface{}); ok {
+ tdm, err = TDMFromJSON(tdmJSON)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed parsing 'tdm'")
+ }
+ }
+
metadata := &Metadata{
Identifier: parseOptString(rawJson["identifier"]),
Type: parseOptString(rawJson["@type"]),
LocalizedTitle: *title,
Accessibility: a11y,
+ TDM: tdm,
Modified: parseOptTime(rawJson["modified"]),
Published: parseOptTime(rawJson["published"]),
ReadingProgression: ReadingProgression(parseOptString(rawJson["readingProgression"])),
@@ -411,6 +424,7 @@ func MetadataFromJSON(rawJson map[string]interface{}) (*Metadata, error) {
"sortAs",
"subject",
"subtitle",
+ "tdm",
"title",
"translator",
} {
@@ -439,6 +453,9 @@ func (m *Metadata) UnmarshalJSON(b []byte) error {
return nil
}
+// If you really don't want the version info in your manifest, you can blank this value.
+var ToolkitVersionKey = "https://github.com/readium/go-toolkit/releases"
+
func (m Metadata) MarshalJSON() ([]byte, error) {
j := make(map[string]interface{})
if m.OtherMetadata != nil {
@@ -447,6 +464,10 @@ func (m Metadata) MarshalJSON() ([]byte, error) {
}
}
+ if ToolkitVersionKey != "" {
+ j[ToolkitVersionKey] = version.Version
+ }
+
if m.Presentation != nil {
j["presentation"] = m.Presentation
}
@@ -470,6 +491,9 @@ func (m Metadata) MarshalJSON() ([]byte, error) {
if m.Accessibility != nil {
j["accessibility"] = *m.Accessibility
}
+ if m.TDM != nil {
+ j["tdm"] = *m.TDM
+ }
if m.Modified != nil {
j["modified"] = *m.Modified
}
diff --git a/pkg/manifest/metadata_test.go b/pkg/manifest/metadata_test.go
index 773caf2e..e5837740 100644
--- a/pkg/manifest/metadata_test.go
+++ b/pkg/manifest/metadata_test.go
@@ -8,6 +8,10 @@ import (
"github.com/stretchr/testify/assert"
)
+func init() {
+ ToolkitVersionKey = "" // Prevent injection of version during testing
+}
+
func TestMetadataUnmarshalMinimalJSON(t *testing.T) {
var m Metadata
assert.NoError(t, json.Unmarshal([]byte(`{"title": "Title"}`), &m))
@@ -40,6 +44,7 @@ func TestMetadataUnmarshalFullJSON(t *testing.T) {
"title": {"en": "Title", "fr": "Titre"},
"subtitle": {"en": "Subtitle", "fr": "Sous-titre"},
"accessibility": {"conformsTo": "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"},
+ "tdm": {"policy": "https://provider.com/policies/policy.json", "reservation": "all"},
"modified": "2001-01-01T12:36:27.000Z",
"published": "2001-01-02T12:36:27.000Z",
"language": ["en", "fr"],
@@ -80,8 +85,12 @@ func TestMetadataUnmarshalFullJSON(t *testing.T) {
"en": "Title",
"fr": "Titre",
}),
- LocalizedSubtitle: &lst,
- Accessibility: &a11y,
+ LocalizedSubtitle: &lst,
+ Accessibility: &a11y,
+ TDM: &TDM{
+ Policy: "https://provider.com/policies/policy.json",
+ Reservation: TDMReservationAll,
+ },
Modified: &modified,
Published: &published,
Languages: []string{"en", "fr"},
@@ -205,8 +214,12 @@ func TestMetadataFullJSON(t *testing.T) {
"en": "Title",
"fr": "Titre",
}),
- LocalizedSubtitle: &lst,
- Accessibility: &a11y,
+ LocalizedSubtitle: &lst,
+ Accessibility: &a11y,
+ TDM: &TDM{
+ Policy: "https://provider.com/policies/policy.json",
+ Reservation: TDMReservationAll,
+ },
Modified: &modified,
Published: &published,
Languages: []string{"en", "fr"},
@@ -255,6 +268,7 @@ func TestMetadataFullJSON(t *testing.T) {
"title": {"en": "Title", "fr": "Titre"},
"subtitle": {"en": "Subtitle", "fr": "Sous-titre"},
"accessibility": {"conformsTo": ["http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"]},
+ "tdm": {"policy": "https://provider.com/policies/policy.json", "reservation": "all"},
"modified": "2001-01-01T12:36:27.123Z",
"published": "2001-01-02T12:36:27Z",
"language": ["en", "fr"],
diff --git a/pkg/manifest/tdm.go b/pkg/manifest/tdm.go
new file mode 100644
index 00000000..7f464eb9
--- /dev/null
+++ b/pkg/manifest/tdm.go
@@ -0,0 +1,72 @@
+package manifest
+
+import (
+ "encoding/json"
+
+ "github.com/pkg/errors"
+)
+
+// TDMRep (Text & Data Mining Reservation Protocol)
+//
+// https://www.w3.org/community/reports/tdmrep/CG-FINAL-tdmrep-20240510/
+type TDM struct {
+ Policy string `json:"policy,omitempty"`
+ Reservation TDMReservation `json:"reservation,omitempty"`
+}
+
+func (t *TDM) IsEmpty() bool {
+ return t.Policy == "" && t.Reservation == ""
+}
+
+type TDMReservation string
+
+const (
+ TDMReservationAll TDMReservation = "all"
+ TDMReservationNone TDMReservation = "none"
+)
+
+func (t TDMReservation) String() string {
+ return string(t)
+}
+
+func TDMFromJSON(rawJSON map[string]interface{}) (*TDM, error) {
+ if rawJSON == nil {
+ return nil, nil
+ }
+
+ t := &TDM{}
+
+ if policy, ok := rawJSON["policy"].(string); ok {
+ t.Policy = policy
+ }
+
+ if reservation, ok := rawJSON["reservation"].(string); ok {
+ t.Reservation = TDMReservation(reservation)
+ }
+
+ if t.IsEmpty() {
+ return nil, nil
+ }
+
+ return t, nil
+}
+
+func (t *TDM) UnmarshalJSON(data []byte) error {
+ var d interface{}
+ err := json.Unmarshal(data, &d)
+ if err != nil {
+ return err
+ }
+
+ mp, ok := d.(map[string]interface{})
+ if !ok {
+ return errors.New("tdm object not a map with string keys")
+ }
+
+ ft, err := TDMFromJSON(mp)
+ if err != nil {
+ return err
+ }
+ *t = *ft
+ return nil
+}
diff --git a/pkg/manifest/tdm_test.go b/pkg/manifest/tdm_test.go
new file mode 100644
index 00000000..466a5e47
--- /dev/null
+++ b/pkg/manifest/tdm_test.go
@@ -0,0 +1,50 @@
+package manifest
+
+import (
+ "encoding/json"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+)
+
+func TestTDMFromJSON(t *testing.T) {
+ rawJSON := map[string]interface{}{
+ "policy": "https://provider.com/policies/policy.json",
+ "reservation": "all",
+ }
+ tdm, err := TDMFromJSON(rawJSON)
+ assert.NoError(t, err)
+
+ assert.Equal(t, "https://provider.com/policies/policy.json", tdm.Policy)
+ assert.Equal(t, TDMReservationAll, tdm.Reservation)
+
+ rawJSON = map[string]interface{}{
+ "reservation": "none",
+ }
+ tdm, err = TDMFromJSON(rawJSON)
+ assert.NoError(t, err)
+
+ assert.Equal(t, "", tdm.Policy)
+ assert.Equal(t, TDMReservationNone, tdm.Reservation)
+}
+
+func TestTDMMarshalJSON(t *testing.T) {
+ tdm := TDM{
+ Policy: "https://provider.com/policies/policy.json",
+ Reservation: TDMReservationAll,
+ }
+ rawJSON, err := json.Marshal(tdm)
+ assert.NoError(t, err)
+
+ expectedJSON := `{"policy":"https://provider.com/policies/policy.json","reservation":"all"}`
+ assert.JSONEq(t, expectedJSON, string(rawJSON))
+
+ tdm = TDM{
+ Reservation: TDMReservationNone,
+ }
+ rawJSON, err = json.Marshal(tdm)
+ assert.NoError(t, err)
+
+ expectedJSON = `{"reservation":"none"}`
+ assert.JSONEq(t, expectedJSON, string(rawJSON))
+}
diff --git a/pkg/parser/epub/consts.go b/pkg/parser/epub/consts.go
index f943bcbc..186b1b05 100644
--- a/pkg/parser/epub/consts.go
+++ b/pkg/parser/epub/consts.go
@@ -32,6 +32,7 @@ const (
VocabularyONIX = "http://www.editeur.org/ONIX/book/codelists/current.html#"
VocabularySchema = "http://schema.org/"
VocabularyXSD = "http://www.w3.org/2001/XMLSchema#"
+ VocabularyTDM = "http://www.w3.org/ns/tdmrep#"
VocabularyMSV = "http://www.idpf.org/epub/vocab/structure/magazine/#"
VocabularyPRISM = "http://www.prismstandard.org/specifications/3.0/PRISM_CV_Spec_3.0.htm#"
diff --git a/pkg/parser/epub/metadata.go b/pkg/parser/epub/metadata.go
index 85ffc7d2..ec32da28 100644
--- a/pkg/parser/epub/metadata.go
+++ b/pkg/parser/epub/metadata.go
@@ -481,6 +481,7 @@ func (m PubMetadataAdapter) Metadata() manifest.Metadata {
LocalizedSortAs: m.LocalizedSortAs(),
LocalizedSubtitle: m.LocalizedSubtitle(),
Accessibility: m.Accessibility(),
+ TDM: m.TDM(),
Duration: m.Duration(),
Subjects: m.Subjects(),
Description: m.Description(),
@@ -646,6 +647,7 @@ func (m PubMetadataAdapter) Accessibility() *manifest.A11y {
a11y.AccessModesSufficient = m.a11yAccessModesSufficient()
a11y.Features = m.a11yFeatures()
a11y.Hazards = m.a11yHazards()
+ a11y.Exemptions = m.a11yExemptions()
if a11y.IsEmpty() {
return nil
@@ -653,8 +655,27 @@ func (m PubMetadataAdapter) Accessibility() *manifest.A11y {
return &a11y
}
+// https://www.w3.org/community/reports/tdmrep/CG-FINAL-tdmrep-20240510/#sec-epub3
+func (m PubMetadataAdapter) TDM() *manifest.TDM {
+ tdm := &manifest.TDM{}
+ tdm.Policy = m.FirstValue(VocabularyTDM + "policy")
+
+ reservation := m.FirstValue(VocabularyTDM + "reservation")
+ switch reservation {
+ case "1":
+ tdm.Reservation = manifest.TDMReservationAll
+ case "0":
+ tdm.Reservation = manifest.TDMReservationNone
+ }
+
+ if tdm.IsEmpty() {
+ return nil
+ }
+ return tdm
+}
+
func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
- profiles := []manifest.A11yProfile{}
+ profiles := manifest.A11yProfileList{}
if items, ok := m.items[VocabularyDCTerms+"conformsto"]; ok {
for _, item := range items {
@@ -670,32 +691,41 @@ func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
}
}
+ profiles.Sort()
return profiles
}
func a11yProfile(value string) manifest.A11yProfile {
switch value {
- case "EPUB Accessibility 1.1 - WCAG 2.0 Level A",
- "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
+ case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a":
return manifest.EPUBA11y10WCAG20A
- case "EPUB Accessibility 1.1 - WCAG 2.0 Level AA",
- "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
+ case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa":
return manifest.EPUBA11y10WCAG20AA
- case "EPUB Accessibility 1.1 - WCAG 2.0 Level AAA",
- "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
+ case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa":
return manifest.EPUBA11y10WCAG20AAA
-
+ case "EPUB Accessibility 1.1 - WCAG 2.0 Level A":
+ return manifest.EPUBA11y11WCAG20A
+ case "EPUB Accessibility 1.1 - WCAG 2.0 Level AA":
+ return manifest.EPUBA11y11WCAG20AA
+ case "EPUB Accessibility 1.1 - WCAG 2.0 Level AAA":
+ return manifest.EPUBA11y11WCAG20AAA
+ case "EPUB Accessibility 1.1 - WCAG 2.1 Level A":
+ return manifest.EPUBA11y11WCAG21A
+ case "EPUB Accessibility 1.1 - WCAG 2.1 Level AA":
+ return manifest.EPUBA11y11WCAG21AA
+ case "EPUB Accessibility 1.1 - WCAG 2.1 Level AAA":
+ return manifest.EPUBA11y11WCAG21AAA
default:
return ""
}
@@ -785,6 +815,15 @@ func (m PubMetadataAdapter) a11yHazards() []manifest.A11yHazard {
return hazards
}
+func (m PubMetadataAdapter) a11yExemptions() []manifest.A11yExemption {
+ values := m.Values(VocabularyA11Y + "exemption")
+ exemptions := make([]manifest.A11yExemption, len(values))
+ for i, v := range values {
+ exemptions[i] = manifest.A11yExemption(v)
+ }
+ return exemptions
+}
+
func (m *PubMetadataAdapter) seedBelongsToData() {
if m._belongsToSeeded {
return
diff --git a/pkg/parser/epub/metadata_test.go b/pkg/parser/epub/metadata_test.go
index d04de26f..4eb95f42 100644
--- a/pkg/parser/epub/metadata_test.go
+++ b/pkg/parser/epub/metadata_test.go
@@ -309,7 +309,7 @@ func TestMetadataEPUB2Accessibility(t *testing.T) {
m, err := loadMetadata("accessibility-epub2")
assert.NoError(t, err)
e := manifest.NewA11y()
- e.ConformsTo = []manifest.A11yProfile{manifest.EPUBA11y10WCAG20A}
+ e.ConformsTo = []manifest.A11yProfile{manifest.EPUBA11y11WCAG21AA, manifest.EPUBA11y11WCAG20AAA, manifest.EPUBA11y10WCAG20A}
e.Certification = &manifest.A11yCertification{
CertifiedBy: "Accessibility Testers Group",
Credential: "DAISY OK",
@@ -323,15 +323,25 @@ func TestMetadataEPUB2Accessibility(t *testing.T) {
}
e.Features = []manifest.A11yFeature{manifest.A11yFeatureStructuralNavigation, manifest.A11yFeatureAlternativeText}
e.Hazards = []manifest.A11yHazard{manifest.A11yHazardMotionSimulation, manifest.A11yHazardNoSoundHazard}
+ e.Exemptions = []manifest.A11yExemption{manifest.A11yExemptionEAAMicroenterprise, manifest.A11yExemptionEAAFundamentalAlteration, manifest.A11yExemptionEAADisproportionateBurden}
assert.Equal(t, &e, m.Accessibility)
assert.Nil(t, m.OtherMetadata["accessibility"])
}
+func TestMetadataEPUB2TDM(t *testing.T) {
+ m, err := loadMetadata("tdm-epub2")
+ assert.NoError(t, err)
+ assert.Equal(t, &manifest.TDM{
+ Policy: "https://provider.com/policies/policy.json",
+ Reservation: manifest.TDMReservationAll,
+ }, m.TDM)
+}
+
func TestMetadataEPUB3Accessibility(t *testing.T) {
m, err := loadMetadata("accessibility-epub3")
assert.NoError(t, err)
e := manifest.NewA11y()
- e.ConformsTo = []manifest.A11yProfile{manifest.EPUBA11y10WCAG20A}
+ e.ConformsTo = []manifest.A11yProfile{manifest.EPUBA11y11WCAG21AA, manifest.EPUBA11y11WCAG20AAA, manifest.EPUBA11y10WCAG20A}
e.Certification = &manifest.A11yCertification{
CertifiedBy: "Accessibility Testers Group",
Credential: "DAISY OK",
@@ -345,10 +355,20 @@ func TestMetadataEPUB3Accessibility(t *testing.T) {
}
e.Features = []manifest.A11yFeature{manifest.A11yFeatureStructuralNavigation, manifest.A11yFeatureAlternativeText}
e.Hazards = []manifest.A11yHazard{manifest.A11yHazardMotionSimulation, manifest.A11yHazardNoSoundHazard}
+ e.Exemptions = []manifest.A11yExemption{manifest.A11yExemptionEAAMicroenterprise, manifest.A11yExemptionEAAFundamentalAlteration, manifest.A11yExemptionEAADisproportionateBurden}
assert.Equal(t, &e, m.Accessibility)
assert.Nil(t, m.OtherMetadata["accessibility"])
}
+func TestMetadataEPUB3TDM(t *testing.T) {
+ m, err := loadMetadata("tdm-epub3")
+ assert.NoError(t, err)
+ assert.Equal(t, &manifest.TDM{
+ Policy: "https://provider.com/policies/policy.json",
+ Reservation: manifest.TDMReservationAll,
+ }, m.TDM)
+}
+
func TestMetadataTitleFileAs(t *testing.T) {
m2, err := loadMetadata("titles-epub2")
assert.NoError(t, err)
diff --git a/pkg/parser/epub/property_data_type.go b/pkg/parser/epub/property_data_type.go
index 7012c051..e750ff26 100644
--- a/pkg/parser/epub/property_data_type.go
+++ b/pkg/parser/epub/property_data_type.go
@@ -15,6 +15,7 @@ var PackageReservedPrefixes = map[string]string{
"onix": VocabularyONIX,
"schema": VocabularySchema,
"xsd": VocabularyXSD,
+ "tdm": VocabularyTDM,
}
var ContentReservedPrefixes = map[string]string{
diff --git a/pkg/parser/epub/testdata/package/accessibility-epub2.opf b/pkg/parser/epub/testdata/package/accessibility-epub2.opf
index 89264313..27cf5de0 100644
--- a/pkg/parser/epub/testdata/package/accessibility-epub2.opf
+++ b/pkg/parser/epub/testdata/package/accessibility-epub2.opf
@@ -5,6 +5,8 @@
<dc:conformsTo>any profile</dc:conformsTo>
<dc:conformsTo>http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a</dc:conformsTo>
+ <dc:conformsTo>EPUB Accessibility 1.1 - WCAG 2.0 Level AAA</dc:conformsTo>
+ <dc:conformsTo>EPUB Accessibility 1.1 - WCAG 2.1 Level AA</dc:conformsTo>
<meta name="schema:accessibilitySummary" content="The publication contains structural and page navigation."/>
<meta name="schema:accessMode" content="textual"/>
@@ -20,6 +22,10 @@
<meta name="a11y:certifiedBy" content="Accessibility Testers Group"/>
<meta name="a11y:certifierCredential" content="DAISY OK"/>
<meta name="a11y:certifierReport" content="https://example.com/a11y-report/"/>
+
+ <meta name="a11y:exemption" content="eaa-microenterprise" />
+ <meta name="a11y:exemption" content="eaa-fundamental-alteration" />
+ <meta name="a11y:exemption" content="eaa-disproportionate-burden" />
</metadata>
<manifest>
<item id="titlepage" href="titlepage.xhtml"/>
diff --git a/pkg/parser/epub/testdata/package/accessibility-epub3.opf b/pkg/parser/epub/testdata/package/accessibility-epub3.opf
index 17d4db60..266d8a22 100644
--- a/pkg/parser/epub/testdata/package/accessibility-epub3.opf
+++ b/pkg/parser/epub/testdata/package/accessibility-epub3.opf
@@ -5,6 +5,8 @@
<dc:conformsTo>any profile</dc:conformsTo>
<link href="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" rel="dcterms:conformsTo"/>
+ <dc:conformsTo>EPUB Accessibility 1.1 - WCAG 2.0 Level AAA</dc:conformsTo>
+ <dc:conformsTo>EPUB Accessibility 1.1 - WCAG 2.1 Level AA</dc:conformsTo>
<meta property="schema:accessibilitySummary">The publication contains structural and page navigation.</meta>
<meta property="schema:accessMode">textual</meta>
@@ -24,6 +26,10 @@
<link rel="a11y:certifierReport" refines="#certifier2" href="https://example.com/fakereport"/>
<link rel="a11y:certifierReport" refines="#certifier" href="https://example.com/a11y-report/"/>
+ <meta property="a11y:exemption">eaa-microenterprise</meta>
+ <meta property="a11y:exemption">eaa-fundamental-alteration</meta>
+ <meta property="a11y:exemption">eaa-disproportionate-burden</meta>
+
</metadata>
<manifest>
<item id="titlepage" href="titlepage.xhtml"/>
diff --git a/pkg/parser/epub/testdata/package/tdm-epub2.opf b/pkg/parser/epub/testdata/package/tdm-epub2.opf
new file mode 100644
index 00000000..4485ddad
--- /dev/null
+++ b/pkg/parser/epub/testdata/package/tdm-epub2.opf
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<package xmlns="http://www.idpf.org/2007/opf" unique-identifier="pub-id" version="2.0" xml:lang="en">
+ <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+ <dc:title>Alice's Adventures in Wonderland</dc:title>
+
+ <meta name="tdm:reservation" content="1" />
+ <meta name="tdm:policy" content="https://provider.com/policies/policy.json" />
+ </metadata>
+ <manifest>
+ <item id="titlepage" href="titlepage.xhtml"/>
+ </manifest>
+ <spine>
+ <itemref idref="titlepage"/>
+ </spine>
+</package>
diff --git a/pkg/parser/epub/testdata/package/tdm-epub3.opf b/pkg/parser/epub/testdata/package/tdm-epub3.opf
new file mode 100644
index 00000000..544cb1a8
--- /dev/null
+++ b/pkg/parser/epub/testdata/package/tdm-epub3.opf
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<package xmlns="http://www.idpf.org/2007/opf" prefix="tdm: http://www.w3.org/ns/tdmrep#" unique-identifier="pub-id" version="3.0" xml:lang="en">
+ <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/">
+ <dc:title>Alice's Adventures in Wonderland</dc:title>
+
+ <meta property="tdm:reservation">1</meta>
+ <meta property="tdm:policy">https://provider.com/policies/policy.json</meta>
+ </metadata>
+ <manifest>
+ <item id="titlepage" href="titlepage.xhtml"/>
+ </manifest>
+ <spine>
+ <itemref idref="titlepage"/>
+ </spine>
+</package>
diff --git a/pkg/parser/pdf/parser.go b/pkg/parser/pdf/parser.go
index 69133ee8..ec8f8759 100644
--- a/pkg/parser/pdf/parser.go
+++ b/pkg/parser/pdf/parser.go
@@ -52,11 +52,14 @@ func (p Parser) Parse(asset asset.PublicationAsset, f fetcher.Fetcher) (*pub.Bui
}
// Clean up and prepare document
- validate.XRefTable(ctx.XRefTable)
+ validate.XRefTable(ctx)
pdfcpu.OptimizeXRefTable(ctx)
ctx.EnsurePageCount()
m, err := ParseMetadata(ctx, link)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed parsing PDF metadata")
+ }
// Fallback title
if m.Metadata.Title() == "" {
diff --git a/pkg/parser/pdf/parser_metadata.go b/pkg/parser/pdf/parser_metadata.go
index 96545af8..b5df1846 100644
--- a/pkg/parser/pdf/parser_metadata.go
+++ b/pkg/parser/pdf/parser_metadata.go
@@ -175,8 +175,8 @@ func ParsePDFMetadata(ctx *model.Context, m *manifest.Manifest) error {
m.Metadata.Modified = modDate
}
}
- if ctx.CreationDate != "" && m.Metadata.Published == nil {
- createDate := extensions.ParseDate(ctx.CreationDate)
+ if ctx.XRefTable.CreationDate != "" && m.Metadata.Published == nil {
+ createDate := extensions.ParseDate(ctx.XRefTable.CreationDate)
if createDate != nil {
m.Metadata.Published = createDate
}
diff --git a/pkg/streamer/a11y_infer.go b/pkg/streamer/a11y_infer.go
index b6da5d6e..690f8e99 100644
--- a/pkg/streamer/a11y_infer.go
+++ b/pkg/streamer/a11y_infer.go
@@ -114,13 +114,13 @@ func inferA11yMetadataFromManifest(mf manifest.Manifest) *manifest.A11y {
}
}
- if mf.TableOfContents != nil && len(mf.TableOfContents) > 0 {
+ if len(mf.TableOfContents) > 0 {
addFeature(manifest.A11yFeatureTableOfContents)
}
if mf.ConformsTo(manifest.ProfileEPUB) {
if _, hasPageList := mf.Subcollections["pageList"]; hasPageList {
- addFeature(manifest.A11yFeaturePrintPageNumbers)
+ addFeature(manifest.A11yFeaturePageNavigation)
}
for _, link := range allResources {
diff --git a/pkg/streamer/a11y_infer_test.go b/pkg/streamer/a11y_infer_test.go
index be20c5c5..13f9ab18 100644
--- a/pkg/streamer/a11y_infer_test.go
+++ b/pkg/streamer/a11y_infer_test.go
@@ -295,7 +295,7 @@ func TestInferFeaturePageList(t *testing.T) {
},
ReadingOrder: []manifest.Link{newLink(mediatype.HTML, "html")},
}
- assertFeature(t, m, manifest.A11yFeaturePrintPageNumbers)
+ assertFeature(t, m, manifest.A11yFeaturePageNavigation)
}
// If the publication contains any resource with MathML (check for the presence
diff --git a/pkg/util/version/version.go b/pkg/util/version/version.go
new file mode 100644
index 00000000..606c7330
--- /dev/null
+++ b/pkg/util/version/version.go
@@ -0,0 +1,67 @@
+package version
+
+import (
+ "runtime/debug"
+ "time"
+)
+
+const toolkitRepo = "github.com/readium/go-toolkit"
+
+var Version = "unknown"
+
+type vcsInfo struct {
+ VCS string
+ Revision string
+ Time string
+ Modified string
+}
+
+func init() {
+ if info, ok := debug.ReadBuildInfo(); ok {
+ if info.Main.Path == toolkitRepo && info.Main.Version != "(devel)" {
+ // This is the toolkit itself
+ Version = info.Main.Version
+ } else {
+ // This is a module that uses the toolkit
+ for _, dep := range info.Deps {
+ if dep.Path == toolkitRepo {
+ Version = dep.Version
+ break
+ }
+ }
+ }
+ if info.Main.Path == toolkitRepo && Version == "unknown" {
+ // Try instead using vcs info
+ vcs := vcsInfo{}
+ for _, v := range info.Settings {
+ switch v.Key {
+ case "vcs":
+ vcs.VCS = v.Value
+ case "vcs.revision":
+ vcs.Revision = v.Value
+ case "vcs.time":
+ vcs.Time = v.Value
+ case "vcs.modified":
+ vcs.Modified = v.Value
+ }
+ }
+ vcsToVersion(vcs)
+ }
+ }
+}
+
+func vcsToVersion(vcs vcsInfo) {
+ if vcs.VCS != "git" || vcs.Revision == "" || vcs.Time == "" {
+ return
+ }
+
+ t, err := time.Parse(time.RFC3339, vcs.Time)
+ if err != nil {
+ return
+ }
+
+ Version = "v0.0.0-" + t.UTC().Format("20060102150405") + "-" + vcs.Revision[:12]
+ if vcs.Modified == "true" {
+ Version += "+dirty"
+ }
+}