react-native-readium 1.0.0-alpha.1

package/ios/Reader/Common/ReaderViewController.swift

@@ -0,0 +1,309 @@
+import Combine
+import SafariServices
+import UIKit
+import R2Navigator
+import R2Shared
+import SwiftSoup
+import WebKit
+
+
+/// This class is meant to be subclassed by each publication format view controller. It contains the shared behavior, eg. navigation bar toggling.
+class ReaderViewController: UIViewController, Loggable {
+
+  weak var moduleDelegate: ReaderFormatModuleDelegate?
+
+  let navigator: UIViewController & Navigator
+  let publication: Publication
+  let bookId: String
+
+  private(set) var stackView: UIStackView!
+  private lazy var positionLabel = UILabel()
+  private var subscriptions = Set<AnyCancellable>()
+  private var subject = PassthroughSubject<Locator, Never>()
+  lazy var publisher = subject.eraseToAnyPublisher()
+
+  /// This regex matches any string with at least 2 consecutive letters (not limited to ASCII).
+  /// It's used when evaluating whether to display the body of a noteref referrer as the note's title.
+  /// I.e. a `*` or `1` would not be used as a title, but `on` or `好書` would.
+  private static var noterefTitleRegex: NSRegularExpression = {
+    return try! NSRegularExpression(pattern: "[\\p{Ll}\\p{Lu}\\p{Lt}\\p{Lo}]{2}")
+  }()
+
+  init(
+    navigator: UIViewController & Navigator,
+    publication: Publication,
+    bookId: String
+  ) {
+    self.navigator = navigator
+    self.publication = publication
+    self.bookId = bookId
+
+    super.init(nibName: nil, bundle: nil)
+
+    NotificationCenter.default.addObserver(
+      self,
+      selector: #selector(voiceOverStatusDidChange),
+      name: UIAccessibility.voiceOverStatusDidChangeNotification,
+      object: nil
+    )
+  }
+
+  @available(*, unavailable)
+  required init?(coder aDecoder: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
+
+  deinit {
+    NotificationCenter.default.removeObserver(self)
+  }
+
+  override func viewDidLoad() {
+    super.viewDidLoad()
+
+    view.backgroundColor = .white
+
+    updateNavigationBar(animated: false)
+
+    stackView = UIStackView(frame: view.bounds)
+    stackView.distribution = .fill
+    stackView.axis = .vertical
+    view.addSubview(stackView)
+    stackView.translatesAutoresizingMaskIntoConstraints = false
+    let topConstraint = stackView.topAnchor.constraint(equalTo: view.topAnchor)
+    // `accessibilityTopMargin` takes precedence when VoiceOver is enabled.
+    topConstraint.priority = .defaultHigh
+    NSLayoutConstraint.activate([
+      topConstraint,
+      stackView.rightAnchor.constraint(equalTo: view.rightAnchor),
+      stackView.bottomAnchor.constraint(equalTo: view.bottomAnchor),
+      stackView.leftAnchor.constraint(equalTo: view.leftAnchor)
+    ])
+
+    addChild(navigator)
+    stackView.addArrangedSubview(navigator.view)
+    navigator.didMove(toParent: self)
+
+    stackView.addArrangedSubview(accessibilityToolbar)
+
+    positionLabel.translatesAutoresizingMaskIntoConstraints = false
+    positionLabel.font = .systemFont(ofSize: 12)
+    positionLabel.textColor = .darkGray
+    view.addSubview(positionLabel)
+    NSLayoutConstraint.activate([
+      positionLabel.centerXAnchor.constraint(equalTo: view.centerXAnchor),
+      positionLabel.bottomAnchor.constraint(equalTo: navigator.view.bottomAnchor, constant: -20)
+    ])
+  }
+
+  override func willMove(toParent parent: UIViewController?) {
+    // Restore library's default UI colors
+    navigationController?.navigationBar.tintColor = .black
+    navigationController?.navigationBar.barTintColor = .white
+  }
+
+
+  // MARK: - Navigation bar
+
+  private var navigationBarHidden: Bool = true {
+    didSet {
+      updateNavigationBar()
+    }
+  }
+
+  func toggleNavigationBar() {
+    navigationBarHidden = !navigationBarHidden
+  }
+
+  func updateNavigationBar(animated: Bool = true) {
+    let hidden = navigationBarHidden && !UIAccessibility.isVoiceOverRunning
+    navigationController?.setNavigationBarHidden(hidden, animated: animated)
+    setNeedsStatusBarAppearanceUpdate()
+  }
+
+  override var preferredStatusBarUpdateAnimation: UIStatusBarAnimation {
+    return .slide
+  }
+
+  override var prefersStatusBarHidden: Bool {
+    return navigationBarHidden && !UIAccessibility.isVoiceOverRunning
+  }
+
+
+  // MARK: - Locations
+  /// FIXME: This should be implemented in a shared Navigator interface, using Locators.
+
+  var currentBookmark: Bookmark? {
+    fatalError("Not implemented")
+  }
+
+  // MARK: - Bookmarks
+
+  @objc func bookmarkCurrentPosition() {
+    // guard let bookmark = currentBookmark else {
+    //   return
+    // }
+
+    // TODO: this should call a react callback
+    // bookmarks.add(bookmark)
+    //   .sink { completion in
+    //     switch completion {
+    //     case .finished:
+    //       toast(NSLocalizedString("reader_bookmark_success_message", comment: "Success message when adding a bookmark"), on: self.view, duration: 1)
+    //     case .failure(let error):
+    //       print(error)
+    //       toast(NSLocalizedString("reader_bookmark_failure_message", comment: "Error message when adding a new bookmark failed"), on: self.view, duration: 2)
+    //     }
+    //   } receiveValue: { _ in }
+    //   .store(in: &subscriptions)
+  }
+
+  // MARK: - Accessibility
+
+  /// Constraint used to shift the content under the navigation bar, since it is always visible when VoiceOver is running.
+  private lazy var accessibilityTopMargin: NSLayoutConstraint = {
+    let topAnchor: NSLayoutYAxisAnchor = {
+      if #available(iOS 11.0, *) {
+        return self.view.safeAreaLayoutGuide.topAnchor
+      } else {
+        return self.topLayoutGuide.bottomAnchor
+      }
+    }()
+    return self.stackView.topAnchor.constraint(equalTo: topAnchor)
+  }()
+
+  private lazy var accessibilityToolbar: UIToolbar = {
+    func makeItem(_ item: UIBarButtonItem.SystemItem, label: String? = nil, action: UIKit.Selector? = nil) -> UIBarButtonItem {
+      let button = UIBarButtonItem(barButtonSystemItem: item, target: (action != nil) ? self : nil, action: action)
+      button.accessibilityLabel = label
+      return button
+    }
+
+    let toolbar = UIToolbar(frame: .zero)
+    toolbar.items = [
+      makeItem(.flexibleSpace),
+      makeItem(.rewind, label: NSLocalizedString("reader_backward_a11y_label", comment: "Accessibility label to go backward in the publication"), action: #selector(goBackward)),
+      makeItem(.flexibleSpace),
+      makeItem(.fastForward, label: NSLocalizedString("reader_forward_a11y_label", comment: "Accessibility label to go forward in the publication"), action: #selector(goForward)),
+      makeItem(.flexibleSpace),
+    ]
+    toolbar.isHidden = !UIAccessibility.isVoiceOverRunning
+    toolbar.tintColor = UIColor.black
+    return toolbar
+  }()
+
+  private var isVoiceOverRunning = UIAccessibility.isVoiceOverRunning
+
+  @objc private func voiceOverStatusDidChange() {
+    let isRunning = UIAccessibility.isVoiceOverRunning
+    // Avoids excessive settings refresh when the status didn't change.
+    guard isVoiceOverRunning != isRunning else {
+      return
+    }
+    isVoiceOverRunning = isRunning
+    accessibilityTopMargin.isActive = isRunning
+    accessibilityToolbar.isHidden = !isRunning
+    updateNavigationBar()
+  }
+
+  @objc private func goBackward() {
+    navigator.goBackward()
+  }
+
+  @objc private func goForward() {
+    navigator.goForward()
+  }
+
+}
+
+extension ReaderViewController: NavigatorDelegate {
+  func navigator(_ navigator: Navigator, locationDidChange locator: Locator) {
+    subject.send(locator)
+    positionLabel.text = {
+      if let position = locator.locations.position {
+        return "\(position) / \(publication.positions.count)"
+      } else if let progression = locator.locations.totalProgression {
+        return "\(progression)%"
+      } else {
+        return nil
+      }
+    }()
+  }
+
+  func navigator(_ navigator: Navigator, presentExternalURL url: URL) {
+    // SFSafariViewController crashes when given an URL without an HTTP scheme.
+    guard ["http", "https"].contains(url.scheme?.lowercased() ?? "") else {
+      return
+    }
+    present(SFSafariViewController(url: url), animated: true)
+  }
+
+  func navigator(_ navigator: Navigator, presentError error: NavigatorError) {
+    moduleDelegate?.presentError(error, from: self)
+  }
+
+  func navigator(_ navigator: Navigator, shouldNavigateToNoteAt link: Link, content: String, referrer: String?) -> Bool {
+
+    var title = referrer
+    if let t = title {
+      title = try? clean(t, .none())
+    }
+    if !suitableTitle(title) {
+      title = nil
+    }
+
+    let content = (try? clean(content, .none())) ?? ""
+    let page =
+    """
+    <html>
+      <head>
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      </head>
+      <body>
+        \(content)
+      </body>
+    </html>
+    """
+
+    let wk = WKWebView()
+    wk.loadHTMLString(page, baseURL: nil)
+
+    let vc = UIViewController()
+    vc.view = wk
+    vc.navigationItem.title = title
+
+    let nav = UINavigationController(rootViewController: vc)
+    nav.modalPresentationStyle = .formSheet
+    self.present(nav, animated: true, completion: nil)
+
+    return false
+  }
+
+  /// Checks to ensure the title is non-nil and contains at least 2 letters.
+  func suitableTitle(_ title: String?) -> Bool {
+    guard let title = title else { return false }
+    let range = NSRange(location: 0, length: title.utf16.count)
+    let match = ReaderViewController.noterefTitleRegex.firstMatch(in: title, range: range)
+    return match != nil
+  }
+
+}
+
+extension ReaderViewController: VisualNavigatorDelegate {
+
+  func navigator(_ navigator: VisualNavigator, didTapAt point: CGPoint) {
+    let viewport = navigator.view.bounds
+    // Skips to previous/next pages if the tap is on the content edges.
+    let thresholdRange = 0...(0.2 * viewport.width)
+    var moved = false
+    if thresholdRange ~= point.x {
+      moved = navigator.goLeft(animated: false)
+    } else if thresholdRange ~= (viewport.maxX - point.x) {
+      moved = navigator.goRight(animated: false)
+    }
+
+    if !moved {
+      toggleNavigationBar()
+    }
+  }
+
+}

package/ios/Reader/EPUB/AssociatedColors.swift

@@ -0,0 +1,27 @@
+import UIKit
+import R2Shared
+
+class AssociatedColors {
+
+    /// Get associated colors for a specific appearance setting
+    /// - parameter appearance: The selected appearance
+    /// - Returns: A tuple with a main color and a text color
+    static func getColors(for appearance: UserProperty) -> (mainColor: UIColor, textColor: UIColor) {
+        var mainColor, textColor: UIColor
+
+        switch appearance.toString() {
+        case "readium-sepia-on":
+            mainColor = UIColor.init(red: 250/255, green: 244/255, blue: 232/255, alpha: 1)
+            textColor = UIColor.init(red: 18/255, green: 18/255, blue: 18/255, alpha: 1)
+        case "readium-night-on":
+            mainColor = UIColor.black
+            textColor = UIColor.init(red: 254/255, green: 254/255, blue: 254/255, alpha: 1)
+        default:
+            mainColor = UIColor.white
+            textColor = UIColor.black
+        }
+
+        return (mainColor, textColor)
+    }
+
+}

package/ios/Reader/EPUB/EPUBModule.swift

@@ -0,0 +1,38 @@
+import Foundation
+import UIKit
+import R2Shared
+
+
+final class EPUBModule: ReaderFormatModule {
+
+    weak var delegate: ReaderFormatModuleDelegate?
+
+    init(delegate: ReaderFormatModuleDelegate?) {
+        self.delegate = delegate
+    }
+
+    var publicationFormats: [Publication.Format] {
+        return [.epub, .webpub]
+    }
+
+    func makeReaderViewController(
+      for publication: Publication,
+      locator: Locator?,
+      bookId: String,
+      resourcesServer: ResourcesServer
+    ) throws -> ReaderViewController {
+        guard publication.metadata.identifier != nil else {
+            throw ReaderError.epubNotValid
+        }
+
+        let epubViewController = EPUBViewController(
+            publication: publication,
+            locator: locator,
+            bookId: bookId,
+            resourcesServer: resourcesServer
+        )
+        epubViewController.moduleDelegate = delegate
+        return epubViewController
+    }
+
+}

package/ios/Reader/EPUB/EPUBViewController.swift

@@ -0,0 +1,79 @@
+import UIKit
+import R2Shared
+import R2Navigator
+
+class EPUBViewController: ReaderViewController {
+
+    init(
+      publication: Publication,
+      locator: Locator?,
+      bookId: String,
+      resourcesServer: ResourcesServer
+    ) {
+      let navigator = EPUBNavigatorViewController(
+        publication: publication,
+        initialLocation: locator,
+        resourcesServer: resourcesServer
+      )
+
+      super.init(
+        navigator: navigator,
+        publication: publication,
+        bookId: bookId
+      )
+
+      navigator.delegate = self
+    }
+
+    var epubNavigator: EPUBNavigatorViewController {
+      return navigator as! EPUBNavigatorViewController
+    }
+
+    override func viewDidLoad() {
+      super.viewDidLoad()
+
+      /// Set initial UI appearance.
+      if let appearance = publication.userProperties.getProperty(reference: ReadiumCSSReference.appearance.rawValue) {
+        setUIColor(for: appearance)
+      }
+    }
+
+    internal func setUIColor(for appearance: UserProperty) {
+      let colors = AssociatedColors.getColors(for: appearance)
+
+      navigator.view.backgroundColor = colors.mainColor
+      view.backgroundColor = colors.mainColor
+      //
+      navigationController?.navigationBar.barTintColor = colors.mainColor
+      navigationController?.navigationBar.tintColor = colors.textColor
+
+      navigationController?.navigationBar.titleTextAttributes = [NSAttributedString.Key.foregroundColor: colors.textColor]
+    }
+
+    override var currentBookmark: Bookmark? {
+      guard let locator = navigator.currentLocation else {
+        return nil
+      }
+
+      return Bookmark(bookId: bookId, locator: locator)
+    }
+
+}
+
+extension EPUBViewController: EPUBNavigatorDelegate {}
+
+extension EPUBViewController: UIGestureRecognizerDelegate {
+
+  func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldRecognizeSimultaneouslyWith otherGestureRecognizer: UIGestureRecognizer) -> Bool {
+    return true
+  }
+
+}
+
+extension EPUBViewController: UIPopoverPresentationControllerDelegate {
+  // Prevent the popOver to be presented fullscreen on iPhones.
+  func adaptivePresentationStyle(for controller: UIPresentationController, traitCollection: UITraitCollection) -> UIModalPresentationStyle
+  {
+    return .none
+  }
+}

package/ios/Reader/ReaderError.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+enum ReaderError: LocalizedError {
+  case formatNotSupported
+  case epubNotValid
+  case openFailed(Error)
+  case fileNotFound(Error)
+  case cancelled
+
+  var errorDescription: String? {
+    switch self {
+    case .formatNotSupported:
+      return NSLocalizedString("reader_error_formatNotSupported", comment: "Error message when trying to read a publication with a unsupported format")
+    case .epubNotValid:
+      return NSLocalizedString("reader_error_epubNotValid", comment: "Error message when trying to read an EPUB that is invalid")
+    case .openFailed(let error):
+      return String(format: NSLocalizedString("reader_error_openFailed", comment: "Error message used when a low-level error occured while opening a publication"), error.localizedDescription)
+    case .fileNotFound(let error):
+      return String(format: NSLocalizedString("reader_error_openFailed", comment: "Error message used when a low-level error occured while attempting to open the specified file"), error.localizedDescription)
+    default:
+      return nil
+    }
+  }
+
+}

package/ios/Reader/ReaderFormatModule.swift

@@ -0,0 +1,27 @@
+import Foundation
+import UIKit
+import R2Shared
+
+
+/// A ReaderFormatModule is a sub-module of ReaderModule that handles publication of a given format (eg. EPUB, CBZ).
+protocol ReaderFormatModule {
+
+  var delegate: ReaderFormatModuleDelegate? { get }
+
+  /// Publication types handled by this sub-module.
+  var publicationFormats: [Publication.Format] { get }
+
+  /// Creates the view controller to present the publication.
+  func makeReaderViewController(
+    for publication: Publication,
+    locator: Locator?,
+    bookId: String,
+    resourcesServer: ResourcesServer
+  ) throws -> ReaderViewController
+
+}
+
+protocol ReaderFormatModuleDelegate: AnyObject {
+  func presentAlert(_ title: String, message: String, from viewController: UIViewController)
+  func presentError(_ error: Error?, from viewController: UIViewController)
+}

package/ios/Reader/ReaderModule.swift

@@ -0,0 +1,84 @@
+import Foundation
+import UIKit
+import R2Shared
+
+
+/// The ReaderModule handles the presentation of publications to be read by the user.
+/// It contains sub-modules implementing ReaderFormatModule to handle each format of publication (eg. CBZ, EPUB).
+protocol ReaderModuleAPI {
+  var delegate: ReaderModuleDelegate? { get }
+
+  func getViewController(
+    for publication: Publication,
+    bookId: String,
+    locator: Locator?
+  ) -> ReaderViewController?
+}
+
+protocol ReaderModuleDelegate: ModuleDelegate {}
+
+
+final class ReaderModule: ReaderModuleAPI {
+  weak var delegate: ReaderModuleDelegate?
+  private let resourcesServer: ResourcesServer
+
+  /// Sub-modules to handle different publication formats (eg. EPUB, CBZ)
+  var formatModules: [ReaderFormatModule] = []
+
+  init(
+    delegate: ReaderModuleDelegate?,
+    resourcesServer: ResourcesServer
+  ) {
+    self.delegate = delegate
+    self.resourcesServer = resourcesServer
+
+    formatModules = [
+      // CBZModule(delegate: self),
+      EPUBModule(delegate: self),
+    ]
+
+    // TODO: add PDF reader later
+    // if #available(iOS 11.0, *) {
+    //   formatModules.append(PDFModule(delegate: self))
+    // }
+  }
+
+  func getViewController(
+    for publication: Publication,
+    bookId: String,
+    locator: Locator?
+  ) -> ReaderViewController? {
+    guard let module = self.formatModules.first(
+      where:{ $0.publicationFormats.contains(publication.format) }
+    ) else {
+      print("Unable to display the publication due to an unsupported format.")
+      return nil
+    }
+
+    do {
+      return try module.makeReaderViewController(
+        for: publication,
+        locator: locator,
+        bookId: bookId,
+        resourcesServer: resourcesServer
+      )
+    } catch {
+      print("An unexpected error occurred when attempting to build the reader view.")
+      print(error)
+      return nil
+    }
+  }
+
+}
+
+
+extension ReaderModule: ReaderFormatModuleDelegate {
+  func presentAlert(_ title: String, message: String, from viewController: UIViewController) {
+    delegate?.presentAlert(title, message: message, from: viewController)
+  }
+
+  func presentError(_ error: Error?, from viewController: UIViewController) {
+    delegate?.presentError(error, from: viewController)
+  }
+
+}