Support OPDS Progression

[imnotjames]

What would you like Grimmory to do?

It's difficult to provide progression storage between multiple readers (web, koreader, mobile apps) while maintaining high levels of cross-compatibility. The way we're currently supporting translation is error prone & is not compliant with the draft standard provided by our friends over at OPDS.

We should:

• Provide a new OPDS Progression 1.0 compliant retrieval endpoint
• Provide a new OPDS Progression 1.0 compliant update endpoint
• Provide a new matching progress deletion endpoint
• Fill in known progression reference "types" as possible
• Maintain backwards compatibility where possible
• Should support XPointer reference types for plugin usage

What problem does this solve for you?

The KOReader plugin cannot currently use the book progression endpoints we have. This limits us to the by-hash endpoints which are also limited in capability.

Anything else?

We should not "validate" reference strings. If we don't understand it, we should store them as-is. However, we should probably only store "unique" reference strings.

For conversion between types, the initial reference types we should support are:

• Epub CFI (example: #epubcfi(/6/24!/4/2/8:0))
• KOReader XPointer (example: #xpointer(/body/DocFragment[14]/body/div/p[25]/text().163)
• Page (example: #page=4)
• HREF (example: EPUB/ch02.xhtml#_sections_and_headings)

Each of these should be possible to parse and apply to others.

Want to help out?

Yes! I'd love to help implement this

Before submitting

• I've searched existing discussions and this hasn't been suggested yet
• I've reviewed this report and have completed it as fully as I can