The r2-navigator-kotlin has a click handler that is bridged from JS that checks for <a epub:type="noteref"> and displays the target content in a modal.

Relevant code:=

var handleClick = function(event) {
    Android.handleClick(event.target.outerHTML)
};

and

@android.webkit.JavascriptInterface
fun handleClick(html: String) {
    val doc = Jsoup.parse(html)
    val link = doc.select("a[epub:type=noteref]")?.first()
    link?.let { noteref ->
        val href = noteref.attr("href")
        if (href.indexOf("#") > 0) {
            val id = href.substring(href.indexOf('#') + 1)
            var absolute = getAbsolute(href, resourceUrl!!)
            absolute = absolute.substring(0, absolute.indexOf("#"))
            val document = Jsoup.connect(absolute).get()
            val aside = document.select("aside#$id").first()?.html()
            aside?.let {
                val safe = Jsoup.clean(aside, Whitelist.relaxed())

                // Initialize a new instance of LayoutInflater service
                val inflater = activity.getSystemService(Context.LAYOUT_INFLATER_SERVICE) as LayoutInflater

                // Inflate the custom layout/view
                val customView = inflater.inflate(R.layout.popup_footnote, null)

                // Initialize a new instance of popup window
                val mPopupWindow = PopupWindow(
                    customView,
                    ListPopupWindow.WRAP_CONTENT,
                    ListPopupWindow.WRAP_CONTENT
                )
                mPopupWindow.isOutsideTouchable = true
                mPopupWindow.isFocusable = true

                // Set an elevation value for popup window
                // Call requires API level 21
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                    mPopupWindow.elevation = 5.0f
                }

                val textView = customView.findViewById(R.id.footnote) as TextView
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
                    textView.text = Html.fromHtml(safe, Html.FROM_HTML_MODE_COMPACT)
                } else {
                    textView.text = Html.fromHtml(safe)
                }

                // Get a reference for the custom view close button
                val closeButton = customView.findViewById(R.id.ib_close) as ImageButton

                // Set a click listener for the popup window close button
                closeButton.setOnClickListener {
                    // Dismiss the popup window
                    mPopupWindow.dismiss()
                }

                // Finally, show the popup window at the center location of root relative layout
                mPopupWindow.showAtLocation(this, Gravity.CENTER, 0, 0)

                overrideUrlLoading = false
            }
        }
    }
}

The same could be implemented for iOS.

Current click handling:

function onClick(event) {
  if (event.defaultPrevented || isInteractiveElement(event.target)) {
    return;
  }

  if (!window.getSelection().isCollapsed) {
    // There's an on-going selection, the tap will dismiss it so we don't forward it.
    return;
  }

  webkit.messageHandlers.tap.postMessage({
    "screenX": event.screenX,
    "screenY": event.screenY,
    "clientX": event.clientX,
    "clientY": event.clientY,
  });

In terms of implementation, I'll start with comparing to the Android version.

In reading through the behavior, it appears that all taps (on any element) call the Kotlin function before the event is propagated through the DOM. The Kotlin checks to see if the tapped element is a[epub:type=noteref] and if so, identifies the target material. It's important to do this in the host code, rather than JS, so that you can access whatever file is being targeted. If the Kotlin func successfully displays the modal, it does a little semaphore action (so to speak) to the WebView delegate to cancel the navigation. (That last bit is a little convoluted since shouldOverrideUrlLoading appears to be employed in reverse, but that's what I gather.)

In contrast, the iOS click handler explicitly avoids calling across the JS bridge to Swift for any interactive elements, including <a> tags. The recursive isInteractiveElement JS function references this https://github.com/JayPanoz/architecture/tree/touch-handling/misc/touch-handling regarding don't-mess-up-the-author's-scripts.

Links

This test contains 3 links with different behaviors:

1. normal link, which should take the user to the previous test;
2. scripted link, which should display a hidden element below the second paragraph;
3. scripted link, which is using window.location to send the user to the next test.

The test is here and looks like:

<a href="../Text/test-005.xhtml">I’m a simple link to the previous chapter (Audio controls with buttons)</a>
<a id="anchor-hook" href="#note">I’m a link which will be used to display something below this paragraph</a>
<a id="anchor-programmatic" href="#anchor-programmatic">I’m a link using window.location to the next chapter (DOM Storage)</a>

along with

var hook = document.getElementById("anchor-hook"),
    prog = document.getElementById("anchor-programmatic"),
    note = document.getElementById("note");

hook.addEventListener("click", function(e) {
  e.preventDefault();
  if (note.style.display === "none") {
    note.style.display = "block";
  } else {
	note.style.display = "none";
  }
}, false);

prog.addEventListener("click", function(e) {
  e.preventDefault();
  window.location = "../Text/test-007.xhtml";
}, false);

I am tempted to check for epub:type=noteref in the JS and call a new, special Swift handler specifically for this purpose. I think that links of that type should be handled by the app and any user scripts are forfeit.

The other question in my mind is what to do on the targeted content, because typically (in my understanding of things) it should be hidden. Not sure if the author should have to display:none it or if that should be part of the styles injected by the app...I lean towards the latter.

I intend to do this work over the next day or two, but I wanted to ask for feedback before my PR leaps full-armed from the brow of Jove.

EDIT: We talked about this issue on the last dev meeting, and agreed on dropping support for iOS 9. Unfortunately, we don't have the resources to maintain the toolkit on such older versions. Apple is not making it easy.

The next tagged release will be the last one supporting iOS 9.

I'm testing the waters.

Right now, Readium supports down to iOS 9, but:

• the PDF navigator requires iOS 11
• the audiobook navigator will require iOS 10

Personally, I think it's time to raise the minimum requirement to iOS 10.

3.3% of iPads are < iOS 10, and only 0.1% on iPhones. https://david-smith.org/iosversionstats/

Any disagreement?

Hey, I want to get Highlighted text in EPUBViewController. So I have added custom editAction
var config = EPUBNavigatorViewController.Configuration() config.editingActions.append(EditingAction(title: "Highlight", action: #selector(highlight)))

@objc func highlight(_ sender: Any) { print(epubNavigator.currentLocation?.text.highlight) }

but I am getting nil in highlight.

Is there something else that I am missing here ?

Xcode 11 finally brought native support for SPM, including iOS!

As the official package manager for iOS development, this should be the default choice used in Readium projects.

I think this could also simplify the build settings of the test app, that are right now split between Carthage and submodules. We could maybe use only SPM, setup either with a direct path to the submodules or with the URLs to the Git repositories.

There are two questions: I try to set full-screen background image to each page of one chapter and the cover page. To do so, I set the Navigator full-screen, then the top bar and bottom bar just cover the Navigator. The first question is how to set the top/bottom margin of each page, since the top/bottom line of text is covered by the top/bottom bar content. Another question is about the background image. I use the css style "background-repeat: repeat-y;". It work well in Android with Readium SDK, but not work in iOS with R2.

Overview

Reopening an EPUB trying to restore the last read position seem to work inconsistently, sometimes opening the book to the beginning of the chapter. This bug is currently blocking our transition to R2 which otherwise is complete.

I am unable to reproduce the issue on iOS 14. However I can reproduce it roughly one time out of 5 attempts using the same steps, book, build and device on iOS 13, 12 and 10. (I never tried on 11.) It is easier to reproduce with long books trying to restore a position toward the end of one of the last chapters, but it's pretty random.

I can't reproduce this in the r2-testapp but I'll try to explain what I tried in detail what I am observing.

Build / Test Set-up

• Xcode 11.5 toolchain
• carthage 0.36.0
• R2 version 2.0.0-beta.1
• test devices: iPhone 11 iOS 14.4 / iPhone 6 iOS 12.5.1
• simulators: iPads / iPhones iOS 13.5, 12.4, 10.3.1
• Focusing on epubs without DRM (e.g. Treasure Island, which is also present in the testapp). DRM'ed books exhibit same behavior though.

R2 Set-up

The way R2 is integrated in our app (SimplyE) matches the r2-testapp's -- as a matter of fact I copied its architecture. As far as restoring the reading position is concerned, my understanding is that one simply has to pass the desired Locator to the initialLocation parameter in the EPUBNavigatorViewController initializer. Is this correct or is there more to it?

I also verified the locator i am passing is always the same, with or without experiencing the bug.

Investigation

I've tried to follow how the initialLocation locator is propagated at runtime inside the R2 navigator code, to try to understand where it is getting lost. I see that it is passed to the reloadSpreads(at:) function, and there i verified a non-zero initialIndex is always found.

The code then flows to PaginationView::setCurrentIndex(_:location:) and then loadView(at:location:completion:). I verified the guards in those functions are not triggered.

From there control passes to EPUBReflowableSpreadView::go(to:completion:), which may be called multiple times during initialization from many places. I assume this is expected?

This is where things get confusing. When the bug happens the last go(to:completion:) call is for a Locator with progression == 0. This seems to come from a polling timer, for updating the user setting style. In this last function invocation we call go(to:) with the currentLocation value, which is incorrect because its progression is 0. Shouldn't that still be the initialLocation i passed in in the navigator's initializer, since the reader is still setting itself up? (There's a spinner on the screen at this time.) I just can't figure out where that initialLocation ends up going, or why/if it's being overwritten.

From another POV, I noticed that on the r2-testapp navigator(_:locationDidChange:) is called twice (once with progression==0, then with the correct locator) but on our app it's only called once, and when the bug happens the locator.progression is 0. That callback is also called from another polling timer, which makes me think order of execution is not guaranteed to be identical across 2 identical instantiations of the navigator.

I also noticed that if i start putting a lot of breakpoints with debugger output (which slows down execution), the bug is more likely to be triggered. This hints at possible race conditions, but it's just a conjecture.

Long write-up, sorry... final thoughts

I've tried many other approaches (e.g. trying to follow the spreads set-up, or how the Locator progression property is being set) but probably i should stop here since I'm rambling at this point.

Thanks in advance for any help/pointers/suggestions. I realize the fact that the r2-testapp is fine probably means I have a bug in my set-up, but on the other hand this random behavior could mean something is off inside r2-navigator, but I ran out of things to look into.

(Please respond in this issue if you want to contribute this feature and have any question)

The PR https://github.com/readium/r2-shared-swift/pull/135 adds a new SearchService feature to search through the content of a publication. We need to expose this in the user interface of the test app.

Here are some general guidelines:

• SearchService is described in this proposal.
• The search interface needs to be added for the ReaderViewController if publication.isSearchable is true.
• It would be best to load the next page of results (iterator.next() when scrolling to the end of the results table view)

Starting a search

To start a new search, use publication.search(). It will asynchronously return a SearchIterator if the search is valid. This iterator can be used to get the search results.

let cancellable = publication.search(query: "banana") { result in
    switch result {
        case .success(let iterator):
            // show results using iterator
        case .failure(let error):
            // display error
    }
}

Showing the results

The results will be displayed in a table view. Every time the user scrolls to the end of the scroll view, you need to request the next page of results with iterator.next(). It will return a LocatorCollection, or nil if the search is finished.

let cancellable = iterator.next { result in
    switch result {
        case .success(let collection):
            if let collection = collection {
                // append `collection.locators` to the table view
            } else {
                // search is finished
            }
        case .failure(let error):
            // display error
    }
}

For each Locator cell:

• If locator.title is different from the previous locator.title, create a new section with this title in the table view
• Display the locator.locations.totalProgression in the cell
• Display the search snippet with locator.text.before + locator.text.highlight + locator.text.after, putting emphasis on the locator.text.highlight portion.

Cancelling the search

When the user cancels the search, you need to dispose of the search properly:

• If publication.search() didn't return an iterator yet, call cancel() on the Cancellable returned by publication.search().
• If a SearchIterator was received:
  • call cancel() on the Cancellable returned by the last iterator.next() call
  • call iterator.close()

Thanks for all your work on this project.

Could you please publish the packages to CocoaPods? podspec's currently don't support specifying a dependency that isn't published on CocoaPods.org, so currently you can't install these packages as a dependency of another package.

Thanks!

I'm trying to add readium to a Swift project using Xcode 11.3.1. I've added the following two lines to my Podfile

  pod 'R2Navigator', :git => 'https://github.com/readium/r2-navigator-swift.git'
  pod 'R2Streamer', :git => 'https://github.com/readium/r2-streamer-swift.git'

When I build the project I get the following error:

R2Streamer Group Swift Compiler Error Group /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator13.2.sdk/usr/include/libxml2/libxml/HTMLparser.h:15:10: 'libxml/xmlversion.h' file not found Could not build Objective-C module 'libxml2'

How can I get the pod for R2Streamer to find the libxml2 header?

Thanks, Jeff

I tried to install r2-streamer-swift using CocoaPods and saw that it has GCDWebServer as a dependency.

The issue is that the Cartfile uses a forked ( and working ) version of GCDWebServer ( erdlab/GCDWebServer ), meaning that the Cocoapods installs can't work without that exact dependency.

Is there any reason why the forked version of GCDWebServer isn't available on CocoaPods ? If no, can we publish the forker server on CocoaPods to then update the podspec file of this project ?

My main issue is that I'm using this package as a dependency on a React Native project, which is only compatible with Cocoapods dependencies.

When serializing a Publication, a lot of properties from the JSON schema specification are missing. The JSON serialization should be reviewed and completed, adapting the existing unit tests.

Core specification: https://readium.org/webpub-manifest/ Default metadata context: https://readium.org/webpub-manifest/contexts/default/ JSON Schema: https://readium.org/webpub-manifest/schema/publication.schema.json The JSON Schema is used more and more as the reference document these days.

There was an issue while trying to open PDF with CGPDFDocumentFactory open function (line 304). If the PDF was encrypted but already unlocked, it would try to open it anyway with an empty password, then failing.

Add code to check if PDF is encrypted but not already unlocked.

Here are 3 PDF samples you can use to test cases (non-encrypted, encrypted, and encrypted but unlocked) Password for encrypted files is 1234

Bug Report

What happened?

Highlight decorations (background color or underline) are not being drawn over text in cases where the text is rendered over fullscreen images. These are fixed layout EPUBs.

Expected behavior

Highlight decorations should work.

How to reproduce?

Open the attached epub and try to add a highlight.

Environment

• Readium version: 2.4.0

Development environment

macOS: 12.6 platform: arm64 zsh: command not found: carthage carthage: Xcode 13.4.1 Build version 13F100

Testing device

• iOS version: 16.0.2 9780062432155.epub.zip

• Model (e.g. iPhone 11 Pro Max): iPhone 12

• Is it an emulator? No

Additional context

• Are you willing to fix the problem and contribute a pull request? Yes or No

No

9780062432155.epub.zip

Bug Report

What happened?

While the a book is open, toggling the VoiceOver will freeze the app in a few seconds and the app will be unresponsive, and multiple attempt will also cause the device to get very hot.

https://user-images.githubusercontent.com/3314171/201693659-8fe4a098-8dbd-4157-90fe-38fb02e93d51.MP4

Environment

• Readium version: 2.4.0

Development environment

macOS: 13.0 platform: x86_64 carthage: 0.38.0 Xcode 14.1 Build version 14B47b

Testing device

• iOS version: 16.0.3(20A392)
• Model (e.g. iPhone 11 Pro Max): iPhone 11
• Is it an emulator? No

Bug Report

What happened?

We tried to open PDF (LCP) file both in our App(with Swift-toolkit integration) and Test app. We were able to successfully open it. However, we experienced an empty Table of Contents for pdf files.

mediaType : application/pdf+lcp Extension: lcpdf Sample PDF LCP https://tuxedo-preprod-icdp.yondu.net/api/ebook/mobile/lcp/get-book-lcp/be7ec450-4617-4b53-bc92-d910951636ea/293 [passphrase: 293]

We tried to view the PDF with LCP in other Ebook Reader like Thorium and it can fetch the publication's table contents. However in the Test app and our app, we can't retrieve it. Hope you can assist us on how to fetch it thanks!

Expected behavior

We expected to view the table of contents list like the one we are using on .epub files.

How to reproduce?

Using Test App:

1. Press the "+" button on the right navigation bar and select From a URL.
2. Enter https://tuxedo-preprod-icdp.yondu.net/api/ebook/mobile/lcp/get-book-lcp/be7ec450-4617-4b53-bc92-d910951636ea/293
3. Enter 293 as passphrase.
4. Open Book
5. View Table of Contents (from the Option Hamburger menu).

Result on Test App:

Logs upon Opening PDF

vs

Logs on .epub Files

Environment

• Readium version: Using Swift Package Manager: { "identity" : "swift-toolkit", "kind" : "remoteSourceControl", "location" : "https://github.com/readium/swift-toolkit.git", "state" : { "branch" : "main", "revision" : "2e0c647221612f923f9888851c848c88d14f7679" } }

Development environment

Testing device

• iOS version: 15.5
• Model (e.g. iPhone 11 Pro Max): iPhone 13 Pro Max
• Is it an emulator? Yes

Tried it also on actual device. Problem also occurs.

Additional context

• Are you willing to fix the problem and contribute a pull request? No

This PR aims to open a book somehow.

Changes:

• extracted new services BookOpener, BookImporter , BookRemover from the LibraryService
• added a wrapper over the ReaderViewController
• improved navigation - when we open a book, a bottom tab bar disappears
• refactored Container, as now it has more responsibilities

Out of scope (coming soon in the next PRs):

• Highlights, Search, and any other Reader supporting views

Bug Report

I was trying to add annotations to image only means I selected only image no text and was unable to add annotation as locator was giving null

What happened?

Select any image by dragging (no text only image )try to add annotation to it. It will not work

Expected behavior

One should be able to add annotations to image only content

How to reproduce?

Environment

• Readium version:

Development environment

• Open epub having image in its content
• Go to place where image is present
• Select only image and no text
• try to add annotation
• you will not be able to add annotation
• PFB scrrenshot for more understanding

Testing device

• iOS version: any
• Model (e.g. iPhone 11 Pro Max): any
• Is it an emulator? Yes