+ 171
+ INTRODUCTORY
+
+ The difficulties of classification are very apparent here, and once more it must be noted that illustrative and practical purposes rather than logical ones are served by the arrangement adopted. The modern fanciful story is here placed next to the real folk story instead of after all the groups of folk products. The Hebrew stories at the beginning belong quite as well, perhaps even better, in Section V, while the stories at the end of Section VI shade off into the more modern types of short tales.
+ The child's natural literature. The world has lost certain secrets as the price of an advancing civilization.
+ Without discussing the limits of the culture-epoch theory of human development as a complete guide in education, it is clear that the young child passes through a period when his mind looks out upon the world in a manner analogous to that of the folk as expressed in their literature.
+
+
+`
+
+func TestCSSSelector(t *testing.T) {
+ doc, err := html.Parse(strings.NewReader(testDoc))
+ if !assert.NoError(t, err) {
+ return
+ }
+
+ qf := func(query string) string {
+ n := cascadia.Query(doc, cascadia.MustCompile(query))
+ if !assert.NotNil(t, n) {
+ t.FailNow()
+ }
+ return CSSSelector(n)
+ }
+
+ assert.Equal(t, qf("body"), "body")
+ assert.Equal(t, qf("#pgepubid00498"), "#pgepubid00498")
+ assert.Equal(t, qf("#Page_171"), "#Page_171")
+ assert.Equal(t, qf("#pgepubid00498 > h3"), "#pgepubid00498 > h3")
+ assert.Equal(t, qf("#pgepubid00498 > div.center"), "#pgepubid00498 > div.center")
+ assert.Equal(t, qf("#pgepubid00498 > p:nth-child(3)"), "#pgepubid00498 > p:nth-child(3)")
+ assert.Equal(t, qf("#pgepubid00498 > p:nth-child(5)"), "#pgepubid00498 > p:nth-child(5)")
+ assert.Equal(t, qf("#pgepubid00498 > p:nth-child(4) > span"), "#pgepubid00498 > p:nth-child(4) > span")
+}
diff --git a/pkg/manifest/contributor.go b/pkg/manifest/contributor.go
index 1902990d..3e78852b 100644
--- a/pkg/manifest/contributor.go
+++ b/pkg/manifest/contributor.go
@@ -4,6 +4,7 @@ import (
"encoding/json"
"github.com/pkg/errors"
+ "github.com/readium/go-toolkit/pkg/internal/extensions"
)
// Contributor
@@ -153,8 +154,14 @@ func (c Contributors) MarshalJSON() ([]byte, error) {
if len(c) == 0 {
return []byte("null"), nil
}
- if len(c) == 1 {
- return json.Marshal(c[0])
+
+ // De-duplicate contributors before marshalling
+ marshalled, err := extensions.DeduplicateAndMarshalJSON([]Contributor(c))
+ if err != nil {
+ return nil, err
+ }
+ if len(marshalled) == 1 {
+ return json.Marshal(marshalled[0])
}
- return json.Marshal([]Contributor(c))
+ return json.Marshal(marshalled)
}
diff --git a/pkg/manifest/link.go b/pkg/manifest/link.go
index a2921450..549f8240 100644
--- a/pkg/manifest/link.go
+++ b/pkg/manifest/link.go
@@ -181,6 +181,48 @@ func (l *Link) UnmarshalJSON(b []byte) error {
return nil
}
+func (l Link) MarshalJSON() ([]byte, error) {
+ res := make(map[string]interface{})
+ res["href"] = l.Href
+ if l.Type != "" {
+ res["type"] = l.Type
+ }
+ if l.Templated {
+ res["templated"] = l.Templated
+ }
+ if l.Title != "" {
+ res["title"] = l.Title
+ }
+ if len(l.Rels) > 0 {
+ res["rel"] = l.Rels
+ }
+ if len(l.Properties) > 0 {
+ res["properties"] = l.Properties
+ }
+ if l.Height > 0 {
+ res["height"] = l.Height
+ }
+ if l.Width > 0 {
+ res["width"] = l.Width
+ }
+ if l.Bitrate > 0 {
+ res["bitrate"] = l.Bitrate
+ }
+ if l.Duration > 0 {
+ res["duration"] = l.Duration
+ }
+ if len(l.Languages) > 0 {
+ res["language"] = l.Languages
+ }
+ if len(l.Alternates) > 0 {
+ res["alternate"] = l.Alternates
+ }
+ if len(l.Children) > 0 {
+ res["children"] = l.Children
+ }
+ return json.Marshal(res)
+}
+
// Slice of links
type LinkList []Link
diff --git a/pkg/manifest/link_test.go b/pkg/manifest/link_test.go
index 12ad8b43..f34a84b6 100644
--- a/pkg/manifest/link_test.go
+++ b/pkg/manifest/link_test.go
@@ -66,17 +66,19 @@ func TestLinkUnmarshalFullJSON(t *testing.T) {
]
}`), &l))
assert.Equal(t, Link{
- Href: "http://href",
- Type: "application/pdf",
- Templated: true,
- Title: "Link Title",
- Rels: []string{"publication", "cover"},
- Properties: map[string]interface{}{"orientation": "landscape"},
- Height: 1024,
- Width: 768,
- Bitrate: 74.2,
- Duration: 45.6,
- Languages: []string{"fr"},
+ Href: "http://href",
+ Type: "application/pdf",
+ Templated: true,
+ Title: "Link Title",
+ Rels: []string{"publication", "cover"},
+ Properties: Properties{
+ "orientation": "landscape",
+ },
+ Height: 1024,
+ Width: 768,
+ Bitrate: 74.2,
+ Duration: 45.6,
+ Languages: []string{"fr"},
Alternates: []Link{
{Href: "/alternate1"},
{Href: "/alternate2"},
@@ -181,17 +183,19 @@ func TestLinkMinimalJSON(t *testing.T) {
func TestLinkFullJSON(t *testing.T) {
b, err := json.Marshal(Link{
- Href: "http://href",
- Type: "application/pdf",
- Templated: true,
- Title: "Link Title",
- Rels: []string{"publication", "cover"},
- Properties: map[string]interface{}{"orientation": "landscape"},
- Height: 1024,
- Width: 768,
- Bitrate: 74.2,
- Duration: 45.6,
- Languages: []string{"fr"},
+ Href: "http://href",
+ Type: "application/pdf",
+ Templated: true,
+ Title: "Link Title",
+ Rels: []string{"publication", "cover"},
+ Properties: Properties{
+ "orientation": "landscape",
+ },
+ Height: 1024,
+ Width: 768,
+ Bitrate: 74.2,
+ Duration: 45.6,
+ Languages: []string{"fr"},
Alternates: []Link{
{Href: "/alternate1"},
{Href: "/alternate2"},
diff --git a/pkg/manifest/locator.go b/pkg/manifest/locator.go
index e4b3a579..9225bab8 100644
--- a/pkg/manifest/locator.go
+++ b/pkg/manifest/locator.go
@@ -93,9 +93,11 @@ func (l *Locations) UnmarshalJSON(b []byte) error {
}
func (l Locations) MarshalJSON() ([]byte, error) {
- j := l.OtherLocations
- if j == nil {
- j = make(map[string]interface{})
+ j := make(map[string]interface{})
+ if l.OtherLocations != nil {
+ for k, v := range l.OtherLocations {
+ j[k] = v
+ }
}
if len(l.Fragments) > 0 {
@@ -114,6 +116,19 @@ func (l Locations) MarshalJSON() ([]byte, error) {
return json.Marshal(j)
}
+// HTML extensions for [Locations]
+
+func (l Locations) CSSSelector() string {
+ if v, ok := l.OtherLocations["cssSelector"]; ok {
+ if s, ok := v.(string); ok {
+ return s
+ }
+ }
+ return ""
+}
+
+// TODO partialCfi and domRange getters
+
// Textual context of the locator.
// A Locator Text Object contains multiple text fragments, useful to give a context to the [Locator] or for highlights.
// https://github.com/readium/architecture/tree/master/models/locators#the-text-object
@@ -137,11 +152,11 @@ func TextFromJSON(rawJson map[string]interface{}) (t Text) {
// Locator provides a precise location in a publication in a format that can be stored and shared.
//
// There are many different use cases for locators:
-// - getting back to the last position in a publication
-// - bookmarks
-// - highlights & annotations
-// - search results
-// - human-readable (and shareable) reference in a publication
+// - getting back to the last position in a publication
+// - bookmarks
+// - highlights & annotations
+// - search results
+// - human-readable (and shareable) reference in a publication
//
// https://github.com/readium/architecture/tree/master/locators
type Locator struct {
diff --git a/pkg/manifest/manifest.go b/pkg/manifest/manifest.go
index 71c12ba3..529717f8 100644
--- a/pkg/manifest/manifest.go
+++ b/pkg/manifest/manifest.go
@@ -3,6 +3,7 @@ package manifest
import (
"encoding/json"
"path"
+ "strings"
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/internal/extensions"
@@ -55,6 +56,49 @@ func (m Manifest) ConformsTo(profile Profile) bool {
return false
}
+// Finds the first [Link] with the given href in the manifest's links.
+// Searches through (in order) the reading order, resources and links recursively following alternate and children links.
+// If there's no match, tries again after removing any query parameter and anchor from the given href.
+func (m Manifest) LinkWithHref(href string) *Link {
+ var deepLinkWithHref func(ll LinkList, href string) *Link
+ deepLinkWithHref = func(ll LinkList, href string) *Link {
+ for _, l := range ll {
+ if l.Href == href {
+ return &l
+ } else {
+ if link := deepLinkWithHref(l.Alternates, href); link != nil {
+ return link
+ }
+ if link := deepLinkWithHref(l.Children, href); link != nil {
+ return link
+ }
+ }
+ }
+ return nil
+ }
+
+ find := func(href string) *Link {
+ if l := deepLinkWithHref(m.ReadingOrder, href); l != nil {
+ return l
+ }
+ if l := deepLinkWithHref(m.Resources, href); l != nil {
+ return l
+ }
+ if l := deepLinkWithHref(m.Links, href); l != nil {
+ return l
+ }
+ return nil
+ }
+
+ if l := find(href); l != nil {
+ return l
+ }
+ if l := find(strings.SplitN(strings.SplitN(href, "#", 2)[0], "?", 2)[0]); l != nil {
+ return l
+ }
+ return nil
+}
+
// Finds the first [Link] with the given relation in the manifest's links.
func (m Manifest) LinkWithRel(rel string) *Link {
for _, resource := range m.Resources {
@@ -115,6 +159,43 @@ func (m Manifest) LinksWithRel(rel string) []Link {
return res
}
+// Creates a new [Locator] object from a [Link] to a resource of this manifest.
+// Returns nil if the resource is not found in this manifest.
+func (m Manifest) LocatorFromLink(link Link) *Locator {
+ components := strings.SplitN(link.Href, "#", 2)
+ href := components[0]
+ resourceLink := m.LinkWithHref(href)
+ if resourceLink == nil {
+ return nil
+ }
+ if resourceLink.Type == "" {
+ return nil
+ }
+ var fragment string
+ if len(components) > 1 {
+ fragment = components[1]
+ }
+
+ l := &Locator{
+ Href: href,
+ Type: resourceLink.Type,
+ Title: resourceLink.Title,
+ }
+
+ if l.Title == "" {
+ l.Title = link.Title
+ }
+
+ if fragment != "" {
+ l.Locations.Fragments = []string{fragment}
+ } else {
+ var p float64
+ l.Locations.Progression = &p
+ }
+
+ return l
+}
+
// Parses a [Manifest] from its RWPM JSON representation.
//
// TODO log [warnings] ?
diff --git a/pkg/manifest/manifest_test.go b/pkg/manifest/manifest_test.go
index ee9d4ac1..8b78ee72 100644
--- a/pkg/manifest/manifest_test.go
+++ b/pkg/manifest/manifest_test.go
@@ -350,3 +350,142 @@ func TestManifestHrefResolvedToRootRemotePackage(t *testing.T) {
assert.Equal(t, "http://example.com/directory/chap1.html", m.ReadingOrder[0].Href)
}
+
+func TestManifestLocatorFromMinimalLink(t *testing.T) {
+ manifest := Manifest{
+ Metadata: Metadata{
+ LocalizedTitle: NewLocalizedStringFromString(""),
+ },
+ ReadingOrder: LinkList{{
+ Href: "/href",
+ Type: "text/html",
+ Title: "Resource",
+ }},
+ }
+
+ var z float64
+ assert.Equal(t, &Locator{
+ Href: "/href",
+ Type: "text/html",
+ Title: "Resource",
+ Locations: Locations{
+ Progression: &z,
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href",
+ }))
+}
+
+func TestManifestLocatorFromInside(t *testing.T) {
+ manifest := Manifest{
+ Metadata: Metadata{
+ LocalizedTitle: NewLocalizedStringFromString(""),
+ },
+ ReadingOrder: LinkList{{
+ Href: "/href1",
+ Type: "text/html",
+ }},
+ Resources: LinkList{{
+ Href: "/href2",
+ Type: "text/html",
+ }},
+ Links: LinkList{{
+ Href: "/href3",
+ Type: "text/html",
+ }},
+ }
+
+ var z float64
+ assert.Equal(t, &Locator{
+ Href: "/href1",
+ Type: "text/html",
+ Locations: Locations{
+ Progression: &z,
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href1",
+ }))
+ assert.Equal(t, &Locator{
+ Href: "/href2",
+ Type: "text/html",
+ Locations: Locations{
+ Progression: &z,
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href2",
+ }))
+ assert.Equal(t, &Locator{
+ Href: "/href3",
+ Type: "text/html",
+ Locations: Locations{
+ Progression: &z,
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href3",
+ }))
+}
+
+func TestManifestLocatorFromFullLinkWithFragment(t *testing.T) {
+ manifest := Manifest{
+ Metadata: Metadata{
+ LocalizedTitle: NewLocalizedStringFromString(""),
+ },
+ ReadingOrder: LinkList{{
+ Href: "/href",
+ Type: "text/html",
+ Title: "Resource",
+ }},
+ }
+
+ assert.Equal(t, &Locator{
+ Href: "/href",
+ Type: "text/html",
+ Title: "Resource",
+ Locations: Locations{
+ Fragments: []string{"page=42"},
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href#page=42",
+ Type: "text/xml",
+ Title: "My link",
+ }))
+}
+
+func TestManifestLocatorFallbackTitle(t *testing.T) {
+ manifest := Manifest{
+ Metadata: Metadata{
+ LocalizedTitle: NewLocalizedStringFromString(""),
+ },
+ ReadingOrder: LinkList{{
+ Href: "/href",
+ Type: "text/html",
+ }},
+ }
+ assert.Equal(t, &Locator{
+ Href: "/href",
+ Type: "text/html",
+ Title: "My link",
+ Locations: Locations{
+ Fragments: []string{"page=42"},
+ },
+ }, manifest.LocatorFromLink(Link{
+ Href: "/href#page=42",
+ Type: "text/xml",
+ Title: "My link",
+ }))
+}
+
+func TestManifestLocatorLinkNotFound(t *testing.T) {
+ manifest := Manifest{
+ Metadata: Metadata{
+ LocalizedTitle: NewLocalizedStringFromString(""),
+ },
+ ReadingOrder: LinkList{{
+ Href: "/href",
+ Type: "text/html",
+ }},
+ }
+ assert.Nil(t, manifest.LocatorFromLink(Link{
+ Href: "/notfound",
+ }))
+}
diff --git a/pkg/manifest/metadata.go b/pkg/manifest/metadata.go
index 596d5059..07e9457d 100644
--- a/pkg/manifest/metadata.go
+++ b/pkg/manifest/metadata.go
@@ -413,9 +413,11 @@ func (m *Metadata) UnmarshalJSON(b []byte) error {
}
func (m Metadata) MarshalJSON() ([]byte, error) {
- j := m.OtherMetadata
- if j == nil {
- j = make(map[string]interface{})
+ j := make(map[string]interface{})
+ if m.OtherMetadata != nil {
+ for k, v := range m.OtherMetadata {
+ j[k] = v
+ }
}
if m.Presentation != nil {
diff --git a/pkg/manifest/properties.go b/pkg/manifest/properties.go
index 60a0e3fc..3eee516b 100644
--- a/pkg/manifest/properties.go
+++ b/pkg/manifest/properties.go
@@ -8,7 +8,10 @@ import (
type Properties map[string]interface{}
-func (p *Properties) Add(newProperties Properties) Properties {
+// Properties should be immutable, therefore these functions have been removed.
+// The code is left here in case it's useful in a future implementation.
+
+/*func (p *Properties) Add(newProperties Properties) Properties {
if *p == nil {
*p = make(Properties)
}
@@ -18,6 +21,14 @@ func (p *Properties) Add(newProperties Properties) Properties {
return *p
}
+func (p *Properties) Delete(key string) Properties {
+ if p == nil {
+ p = &Properties{}
+ }
+ delete(*p, key)
+ return *p
+}*/
+
func (p *Properties) Get(key string) interface{} {
if p != nil {
return (*p)[key]
diff --git a/pkg/manifest/properties_test.go b/pkg/manifest/properties_test.go
index ebb920a1..e5bb5998 100644
--- a/pkg/manifest/properties_test.go
+++ b/pkg/manifest/properties_test.go
@@ -32,7 +32,7 @@ func TestPropertiesUnmarshalFullJSON(t *testing.T) {
}, p)
}
-func TestPropertiesAddGiven(t *testing.T) {
+/*func TestPropertiesAddGiven(t *testing.T) {
p2 := Properties{
"other-property1": "value",
"other-property2": []interface{}{float64(42)},
@@ -44,7 +44,7 @@ func TestPropertiesAddGiven(t *testing.T) {
}, p2.Add(Properties{
"additional": "property",
}))
-}
+}*/
// Presentation-specific properties
diff --git a/pkg/mediatype/mediatype_of.go b/pkg/mediatype/mediatype_of.go
index 1c1b4bce..4f124bf2 100644
--- a/pkg/mediatype/mediatype_of.go
+++ b/pkg/mediatype/mediatype_of.go
@@ -9,8 +9,18 @@ import (
// You can register additional sniffers globally by modifying this list.
// The sniffers order is important, because some formats are subsets of other formats.
var Sniffers = []Sniffer{
- SniffXHTML, SniffHTML, SniffOPDS, SniffLCPLicense, SniffBitmap,
- SniffWebpub, SniffW3CWPUB, SniffEPUB, SniffLPF, SniffArchive, SniffPDF,
+ SniffEPUB,
+ SniffLPF,
+ SniffArchive,
+ SniffPDF,
+ SniffXHTML,
+ SniffHTML,
+ SniffBitmap,
+ SniffAudio,
+ SniffOPDS,
+ SniffLCPLicense,
+ SniffW3CWPUB,
+ SniffWebpub,
// Note SniffSystem isn't here!
}
diff --git a/pkg/mediatype/sniffer.go b/pkg/mediatype/sniffer.go
index 971b9973..1e14646f 100644
--- a/pkg/mediatype/sniffer.go
+++ b/pkg/mediatype/sniffer.go
@@ -143,6 +143,37 @@ func SniffBitmap(context SnifferContext) *MediaType {
return nil
}
+// Sniffs audio files.
+func SniffAudio(context SnifferContext) *MediaType {
+ if context.HasFileExtension("aac") || context.HasMediaType("audio/aac") {
+ return &AAC
+ }
+ if context.HasFileExtension("aiff") || context.HasMediaType("audio/aiff") {
+ return &AIFF
+ }
+ // TODO flac, m4a
+ if context.HasFileExtension("mp3") || context.HasMediaType("audio/mpeg") {
+ return &MP3
+ }
+ if context.HasFileExtension("ogg", "oga") || context.HasMediaType("audio/ogg") {
+ return &OGG
+ }
+ if context.HasFileExtension("opus") || context.HasMediaType("audio/opus") {
+ return &OPUS
+ }
+ if context.HasFileExtension("wav") || context.HasMediaType("audio/wav") {
+ return &WAV
+ }
+ if context.HasFileExtension("webm") || context.HasMediaType("audio/webm") {
+ // Note: .webm extension could also be a video
+ return &WEBMAudio
+ }
+
+ // TODO read magic bytes?
+
+ return nil
+}
+
// Sniffs a Readium Web Publication, protected or not by LCP.
func SniffWebpub(context SnifferContext) *MediaType {
if context.HasFileExtension("audiobook") || context.HasMediaType("application/audiobook+zip") {
@@ -217,8 +248,8 @@ func SniffEPUB(context SnifferContext) *MediaType {
// Sniffs a Lightweight Packaging Format (LPF).
// References:
-// - https://www.w3.org/TR/lpf/
-// - https://www.w3.org/TR/pub-manifest/
+// - https://www.w3.org/TR/lpf/
+// - https://www.w3.org/TR/pub-manifest/
func SniffLPF(context SnifferContext) *MediaType {
if context.HasFileExtension("lpf") || context.HasMediaType("application/lpf+zip") {
return &LPF
diff --git a/pkg/parser/epub/deobfuscator.go b/pkg/parser/epub/deobfuscator.go
index 4cd5cca0..71271d25 100644
--- a/pkg/parser/epub/deobfuscator.go
+++ b/pkg/parser/epub/deobfuscator.go
@@ -39,23 +39,22 @@ func (d DeobfuscatingResource) Read(start, end int64) ([]byte, *fetcher.Resource
algorithm = penc.Algorithm
}
- for k, v := range algorithm2length {
- if k == algorithm {
- data, err := d.ProxyResource.Read(start, end)
- if err != nil {
- return nil, err
- }
- var obfuscationKey []byte
- switch algorithm {
- case "http://ns.adobe.com/pdf/enc#RC":
- obfuscationKey = d.getHashKeyAdobe()
- default:
- shasum := sha1.Sum([]byte(d.identifier))
- obfuscationKey = shasum[:]
- }
- deobfuscateFont(data, start, obfuscationKey, v)
- return data, nil
+ v, ok := algorithm2length[algorithm]
+ if ok {
+ data, err := d.ProxyResource.Read(start, end)
+ if err != nil {
+ return nil, err
}
+ var obfuscationKey []byte
+ switch algorithm {
+ case "http://ns.adobe.com/pdf/enc#RC":
+ obfuscationKey = d.getHashKeyAdobe()
+ default:
+ shasum := sha1.Sum([]byte(d.identifier))
+ obfuscationKey = shasum[:]
+ }
+ deobfuscateFont(data, start, obfuscationKey, v)
+ return data, nil
}
// Algorithm not in known, so skip deobfuscation
@@ -69,74 +68,73 @@ func (d DeobfuscatingResource) Stream(w io.Writer, start int64, end int64) (int6
algorithm = penc.Algorithm
}
- for k, v := range algorithm2length {
- if k == algorithm {
- if start >= v {
- // We're past the obfuscated part, just proxy it
- return d.ProxyResource.Stream(w, start, end)
- }
+ v, ok := algorithm2length[algorithm]
+ if ok {
+ if start >= v {
+ // We're past the obfuscated part, just proxy it
+ return d.ProxyResource.Stream(w, start, end)
+ }
- // Create a pipe to proxy the stream for deobfuscation
- pr, pw := io.Pipe()
-
- // Start piping the resource's stream in a goroutine
- go func() {
- _, err := d.ProxyResource.Stream(pw, start, end)
- if err != nil {
- pw.CloseWithError(err)
- } else {
- pw.Close()
- }
- }()
-
- // First, we just read the obfuscated portion (1040 or 1024 first bytes)
- obfuscatedPortion := make([]byte, v)
- on, err := pr.Read(obfuscatedPortion)
- if err != nil && err != io.EOF {
- if fre, ok := err.(*fetcher.ResourceError); ok {
- return 0, fre
- } else {
- return 0, fetcher.Other(errors.Wrap(err, "error reading obfuscated portion of font"))
- }
- }
+ // Create a pipe to proxy the stream for deobfuscation
+ pr, pw := io.Pipe()
- // Handle filesize <= the obfuscated portion's length or the requested length
- atEnd := false
- if err == io.EOF || (end != 0 && end <= start+int64(on)) {
- obfuscatedPortion = obfuscatedPortion[:on]
- atEnd = true
- pr.Close()
+ // Start piping the resource's stream in a goroutine
+ go func() {
+ _, err := d.ProxyResource.Stream(pw, start, end)
+ if err != nil {
+ pw.CloseWithError(err)
+ } else {
+ pw.Close()
}
-
- // Deobfuscate just the obfuscated portion
- var obfuscationKey []byte
- switch algorithm {
- case "http://ns.adobe.com/pdf/enc#RC":
- obfuscationKey = d.getHashKeyAdobe()
- default:
- shasum := sha1.Sum([]byte(d.identifier))
- obfuscationKey = shasum[:]
+ }()
+
+ // First, we just read the obfuscated portion (1040 or 1024 first bytes)
+ obfuscatedPortion := make([]byte, v)
+ on, err := pr.Read(obfuscatedPortion)
+ if err != nil && err != io.EOF {
+ if fre, ok := err.(*fetcher.ResourceError); ok {
+ return 0, fre
+ } else {
+ return 0, fetcher.Other(errors.Wrap(err, "error reading obfuscated portion of font"))
}
- deobfuscateFont(obfuscatedPortion, start, obfuscationKey, v)
+ }
- defer pr.Close()
+ // Handle filesize <= the obfuscated portion's length or the requested length
+ atEnd := false
+ if on < len(obfuscatedPortion) || (end != 0 && end <= start+int64(on)) {
+ obfuscatedPortion = obfuscatedPortion[:on]
+ atEnd = true
+ pr.Close()
+ }
- // And write it to the stream
- _, err = w.Write(obfuscatedPortion)
- if err != nil {
- return 0, fetcher.Other(errors.Wrap(err, "error writing obfuscated portion of font"))
- }
+ // Deobfuscate just the obfuscated portion
+ var obfuscationKey []byte
+ switch algorithm {
+ case "http://ns.adobe.com/pdf/enc#RC":
+ obfuscationKey = d.getHashKeyAdobe()
+ default:
+ shasum := sha1.Sum([]byte(d.identifier))
+ obfuscationKey = shasum[:]
+ }
+ deobfuscateFont(obfuscatedPortion, start, obfuscationKey, v)
- // The rest of the font is not obfuscated, so it's "copied" directly using a 32KB buffer
- var wn int64
- if !atEnd {
- wn, err = io.Copy(w, pr)
- if err != nil {
- return 0, fetcher.Other(errors.Wrap(err, "error writing unobfuscated portion of font"))
- }
+ defer pr.Close()
+
+ // And write it to the stream
+ _, err = w.Write(obfuscatedPortion)
+ if err != nil {
+ return 0, fetcher.Other(errors.Wrap(err, "error writing obfuscated portion of font"))
+ }
+
+ // The rest of the font is not obfuscated, so it's "copied" directly using a 32KB buffer
+ var wn int64
+ if !atEnd {
+ wn, err = io.Copy(w, pr)
+ if err != nil {
+ return 0, fetcher.Other(errors.Wrap(err, "error writing unobfuscated portion of font"))
}
- return int64(on) + wn, nil
}
+ return int64(on) + wn, nil
}
// Algorithm not in known, so skip deobfuscation
diff --git a/pkg/parser/epub/deobfuscator_test.go b/pkg/parser/epub/deobfuscator_test.go
index 0e88753f..ba30d42f 100644
--- a/pkg/parser/epub/deobfuscator_test.go
+++ b/pkg/parser/epub/deobfuscator_test.go
@@ -28,11 +28,11 @@ func withDeobfuscator(t *testing.T, href string, algorithm string, start, end in
Href: href,
}
if algorithm != "" {
- link.Properties.Add(manifest.Properties{
+ link.Properties = manifest.Properties{
"encrypted": map[string]interface{}{
"algorithm": algorithm,
},
- })
+ }
}
obfu, err := NewDeobfuscator(identifier).Transform(ft.Get(link)).Read(start, end)
if !assert.Nil(t, err) {
diff --git a/pkg/parser/epub/parser.go b/pkg/parser/epub/parser.go
index b53002e0..02ba8ee4 100644
--- a/pkg/parser/epub/parser.go
+++ b/pkg/parser/epub/parser.go
@@ -3,6 +3,7 @@ package epub
import (
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/asset"
+ "github.com/readium/go-toolkit/pkg/content/iterator"
"github.com/readium/go-toolkit/pkg/fetcher"
"github.com/readium/go-toolkit/pkg/manifest"
"github.com/readium/go-toolkit/pkg/mediatype"
@@ -69,6 +70,9 @@ func (p Parser) Parse(asset asset.PublicationAsset, f fetcher.Fetcher) (*pub.Bui
builder := pub.NewServicesBuilder(map[string]pub.ServiceFactory{
pub.PositionsService_Name: PositionsServiceFactory(p.reflowablePositionsStrategy),
+ pub.ContentService_Name: pub.DefaultContentServiceFactory([]iterator.ResourceContentIteratorFactory{
+ iterator.HTMLFactory(),
+ }),
})
return pub.NewBuilder(manifest, ffetcher, builder), nil
}
@@ -160,7 +164,7 @@ func parseDisplayOptions(fetcher fetcher.Fetcher) (ret map[string]string) {
}
}
- if platform := displayOptionsXml.SelectElement("platform"); platform != nil {
+ if platform := displayOptionsXml.SelectElement("//platform"); platform != nil {
for _, option := range platform.SelectElements("option") {
optName := option.SelectAttr("name")
optValue := option.InnerText()
diff --git a/pkg/parser/epub/positions_service.go b/pkg/parser/epub/positions_service.go
index 0da84cff..cbb345e8 100644
--- a/pkg/parser/epub/positions_service.go
+++ b/pkg/parser/epub/positions_service.go
@@ -171,9 +171,9 @@ type ArchiveEntryLength struct {
// PositionCount implements ReflowableStrategy
func (l ArchiveEntryLength) PositionCount(resource fetcher.Resource) uint {
var length uint64
- props := resource.Link().Properties
+ props := resource.Properties()
if p := props.Get("https://readium.org/webpub-manifest/properties#archive"); p != nil {
- if pm, ok := p.(manifest.Properties); ok {
+ if pm, ok := p.(map[string]interface{}); ok {
if el, ok := pm["entryLength"].(uint64); ok {
length = el
}
diff --git a/pkg/parser/pdf/parser.go b/pkg/parser/pdf/parser.go
index 34b11e9e..69133ee8 100644
--- a/pkg/parser/pdf/parser.go
+++ b/pkg/parser/pdf/parser.go
@@ -2,6 +2,7 @@ package pdf
import (
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu"
+ "github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model"
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu/validate"
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/asset"
@@ -20,7 +21,7 @@ func NewParser() Parser {
func init() {
// Disable this feature of pdfcpu
- pdfcpu.ConfigPath = "disable"
+ model.ConfigPath = "disable"
}
// Parse implements PublicationParser
@@ -43,8 +44,8 @@ func (p Parser) Parse(asset asset.PublicationAsset, f fetcher.Fetcher) (*pub.Bui
return nil, errors.New("unable to find PDF file: no matching link found")
}
- conf := pdfcpu.NewDefaultConfiguration()
- conf.ValidationMode = pdfcpu.ValidationRelaxed
+ conf := model.NewDefaultConfiguration()
+ conf.ValidationMode = model.ValidationRelaxed
ctx, err := pdfcpu.Read(fetcher.NewResourceReadSeeker(f.Get(*link)), conf)
if err != nil {
return nil, errors.Wrap(err, "failed opening PDF")
diff --git a/pkg/parser/pdf/parser_metadata.go b/pkg/parser/pdf/parser_metadata.go
index 213df989..653daaf4 100644
--- a/pkg/parser/pdf/parser_metadata.go
+++ b/pkg/parser/pdf/parser_metadata.go
@@ -7,6 +7,7 @@ import (
"strings"
"github.com/pdfcpu/pdfcpu/pkg/pdfcpu"
+ "github.com/pdfcpu/pdfcpu/pkg/pdfcpu/model"
"github.com/pkg/errors"
"github.com/readium/go-toolkit/pkg/internal/extensions"
"github.com/readium/go-toolkit/pkg/manifest"
@@ -29,7 +30,7 @@ func loadDecoder(meta pdfcpu.Metadata) (*xmp.Document, []byte, error) {
return doc, metabin, nil
}
-func ParseMetadata(ctx *pdfcpu.Context, link *manifest.Link) (m manifest.Manifest, err error) {
+func ParseMetadata(ctx *model.Context, link *manifest.Link) (m manifest.Manifest, err error) {
if link != nil {
m.ReadingOrder = manifest.LinkList{{
Href: strings.TrimPrefix(link.Href, "/"),
@@ -45,7 +46,7 @@ func ParseMetadata(ctx *pdfcpu.Context, link *manifest.Link) (m manifest.Manifes
m.Metadata.ConformsTo = manifest.Profiles{manifest.ProfilePDF}
// hashmaterial := make([]string, 0, 64)
- metas, _ := ctx.ExtractMetadata()
+ metas, _ := pdfcpu.ExtractMetadata(ctx)
for _, meta := range metas {
doc, _, derr := loadDecoder(meta)
if derr != nil {
@@ -129,7 +130,7 @@ func ParseXMPMetadata(doc *xmp.Document, metadata *manifest.Metadata) error {
return nil
}
-func ParsePDFMetadata(ctx *pdfcpu.Context, m *manifest.Manifest) error {
+func ParsePDFMetadata(ctx *model.Context, m *manifest.Manifest) error {
// Page count
if ctx.PageCount > 0 && m.Metadata.NumberOfPages == nil {
pc := uint(ctx.PageCount)
@@ -182,7 +183,7 @@ func ParsePDFMetadata(ctx *pdfcpu.Context, m *manifest.Manifest) error {
}
// Bookmarks (TOC)
- if bookmarks, err := ctx.BookmarksForOutline(); err == nil {
+ if bookmarks, err := pdfcpu.Bookmarks(ctx); err == nil {
rootLink := m.ReadingOrder.FirstWithMediaType(&mediatype.PDF)
root := ""
if rootLink != nil {
@@ -196,8 +197,8 @@ func ParsePDFMetadata(ctx *pdfcpu.Context, m *manifest.Manifest) error {
Title: b.Title,
Type: mediatype.PDF.String(),
}
- if len(b.Children) > 0 {
- bf(lnk.Children, b.Children)
+ if len(b.Kids) > 0 {
+ bf(lnk.Children, b.Kids)
}
m.TableOfContents = append(m.TableOfContents, lnk)
}
diff --git a/pkg/pub/publication.go b/pkg/pub/publication.go
index 3b842fc5..4d4b5de5 100644
--- a/pkg/pub/publication.go
+++ b/pkg/pub/publication.go
@@ -3,6 +3,7 @@ package pub
import (
"encoding/json"
"path"
+ "strings"
"github.com/readium/go-toolkit/pkg/fetcher"
"github.com/readium/go-toolkit/pkg/manifest"
@@ -22,6 +23,29 @@ func (p Publication) ConformsTo(profile manifest.Profile) bool {
return p.Manifest.ConformsTo(profile)
}
+// Finds the first [Link] with the given href in the publication's links.
+// Searches through (in order) the reading order, resources and links recursively following alternate and children links.
+// If there's no match, tries again after removing any query parameter and anchor from the given href.
+func (p Publication) LinkWithHref(href string) *manifest.Link {
+ return p.Manifest.LinkWithHref(href)
+}
+
+// Finds the first [Link] having the given [rel] in the publications's links.
+func (p Publication) LinkWithRel(rel string) *manifest.Link {
+ return p.Manifest.LinkWithRel(rel)
+}
+
+// Finds all [Link]s having the given [rel] in the publications's links.
+func (p Publication) LinksWithRel(rel string) []manifest.Link {
+ return p.Manifest.LinksWithRel(rel)
+}
+
+// Creates a new [Locator] object from a [Link] to a resource of this publication.
+// Returns nil if the resource is not found in this publication.
+func (p Publication) LocatorFromLink(link manifest.Link) *manifest.Locator {
+ return p.Manifest.LocatorFromLink(link)
+}
+
// Returns the RWPM JSON representation for this [Publication]'s manifest, as a string.
func (p Publication) JSONManifest() (string, error) {
bin, err := json.Marshal(p.Manifest)
@@ -89,7 +113,9 @@ func (p Publication) Find(path string) *manifest.Link {
}
}
- link.Href = "/" + link.Href
+ if !strings.HasPrefix(link.Href, "/") {
+ link.Href = "/" + link.Href
+ }
return link
}
diff --git a/pkg/pub/service.go b/pkg/pub/service.go
index 8ca17e6a..29b40adf 100644
--- a/pkg/pub/service.go
+++ b/pkg/pub/service.go
@@ -11,6 +11,7 @@ const (
LocatorService_Name = "LocatorService"
PositionsService_Name = "PositionsService"
SearchService_Name = "SearchService"
+ ContentService_Name = "ContentService"
)
// Base interface to be implemented by all publication services.
diff --git a/pkg/pub/service_content.go b/pkg/pub/service_content.go
new file mode 100644
index 00000000..5bd2f905
--- /dev/null
+++ b/pkg/pub/service_content.go
@@ -0,0 +1,101 @@
+package pub
+
+import (
+ "encoding/json"
+
+ "github.com/readium/go-toolkit/pkg/content"
+ "github.com/readium/go-toolkit/pkg/content/element"
+ "github.com/readium/go-toolkit/pkg/content/iterator"
+ "github.com/readium/go-toolkit/pkg/fetcher"
+ "github.com/readium/go-toolkit/pkg/manifest"
+)
+
+// TODO content iterator special ~readium link
+
+var ContentLink = manifest.Link{
+ Href: "/~readium/content.json",
+ Type: "application/vnd.readium.content+json",
+}
+
+// TODO uri template or something so we're not just dumping entire content
+// progression, href, cssselector, text context
+
+// PositionsService implements Service
+// Provides a way to extract the raw [Content] of a [Publication].
+type ContentService interface {
+ Service
+ Content(start *manifest.Locator) content.Content // Creates a [Content] starting from the given [start] location.
+}
+
+// Implements ContentService
+type DefaultContentService struct {
+ context Context
+ resourceContentIteratorFactories []iterator.ResourceContentIteratorFactory
+}
+
+func GetForContentService(service ContentService, link manifest.Link) (fetcher.Resource, bool) {
+ if link.Href != ContentLink.Href {
+ return nil, false
+ }
+
+ elements, err := content.ContentElements(service.Content(nil))
+ if err != nil {
+ return fetcher.NewFailureResource(ContentLink, fetcher.Other(err)), false
+ }
+
+ return fetcher.NewBytesResource(ContentLink, func() []byte {
+ // Warning: this can be a massive payload since it's the entire content of the publication right now
+ bin, _ := json.Marshal(elements)
+ return bin
+ }), true
+}
+
+func (s DefaultContentService) Close() {}
+
+func (s DefaultContentService) Links() manifest.LinkList {
+ return manifest.LinkList{ContentLink}
+}
+
+func (s DefaultContentService) Get(link manifest.Link) (fetcher.Resource, bool) {
+ return GetForContentService(s, link)
+}
+
+func (s DefaultContentService) Content(start *manifest.Locator) content.Content {
+ return contentImplementation{
+ context: s.context,
+ start: start,
+ resourceContentIteratorFactories: s.resourceContentIteratorFactories,
+ }
+}
+
+type contentImplementation struct {
+ context Context
+ start *manifest.Locator
+ resourceContentIteratorFactories []iterator.ResourceContentIteratorFactory
+}
+
+func (c contentImplementation) Iterator() iterator.Iterator {
+ return iterator.NewPublicationContent(
+ c.context.Manifest,
+ c.context.Fetcher,
+ c.start,
+ c.resourceContentIteratorFactories,
+ )
+}
+
+func (c contentImplementation) Elements() ([]element.Element, error) {
+ return content.ContentElements(c)
+}
+
+func (c contentImplementation) Text(separator *string) (string, error) {
+ return content.ContentText(c, separator)
+}
+
+func DefaultContentServiceFactory(resourceContentIteratorFactories []iterator.ResourceContentIteratorFactory) ServiceFactory {
+ return func(context Context) Service {
+ return DefaultContentService{
+ context: context,
+ resourceContentIteratorFactories: resourceContentIteratorFactories,
+ }
+ }
+}
diff --git a/pkg/streamer/a11y_infer_test.go b/pkg/streamer/a11y_infer_test.go
index f0312eb7..440b7b42 100644
--- a/pkg/streamer/a11y_infer_test.go
+++ b/pkg/streamer/a11y_infer_test.go
@@ -303,7 +303,7 @@ func TestInferFeaturePageList(t *testing.T) {
// "resources" in RWPM)
func TestInferFeatureMathML(t *testing.T) {
link := newLink(mediatype.HTML, "html")
- link.Properties = map[string]interface{}{
+ link.Properties = manifest.Properties{
"contains": []string{"mathml"},
}
m := manifest.Manifest{