HTML/Epub reader

.gitignore

@@ -79,4 +79,5 @@ fastlane/test_output
 
 bundled/translators
 bundled/styles
-bundled/locales
+bundled/locales
+bundled/reader

.gitmodules

@@ -10,3 +10,6 @@
 [submodule "translators"]
 	path = translators
 	url = https://github.com/zotero/translators.git
+[submodule "reader"]
+	path = reader
+	url = https://github.com/zotero/reader.git

ZShare/Controllers/TranslationWebViewHandler.swift

@@ -136,14 +136,14 @@ final class TranslationWebViewHandler {
                    }
                    .flatMap { translators -> Single<Any> in
                        DDLogInfo("WebViewHandler: encode translators")
-                       let encodedTranslators = WKWebView.encodeAsJSONForJavascript(translators)
+                       let encodedTranslators = WebViewEncoder.encodeAsJSONForJavascript(translators)
                        return self.webViewHandler.call(javascript: "initTranslators(\(encodedTranslators));")
                    }
                    .flatMap({ _ -> Single<Any> in
                        DDLogInfo("WebViewHandler: call translate js")
-                       let encodedHtml = WKWebView.encodeForJavascript(html.data(using: .utf8))
+                       let encodedHtml = WebViewEncoder.encodeForJavascript(html.data(using: .utf8))
                        let jsonFramesData = try? JSONSerialization.data(withJSONObject: frames, options: .fragmentsAllowed)
-                       let encodedFrames = jsonFramesData.flatMap({ WKWebView.encodeForJavascript($0) }) ?? "''"
+                       let encodedFrames = jsonFramesData.flatMap({ WebViewEncoder.encodeForJavascript($0) }) ?? "''"
                        return self.webViewHandler.call(javascript: "translate('\(url.absoluteString)', \(encodedHtml), \(encodedFrames));")
                    })
                    .subscribe(onFailure: { [weak self] error in
@@ -169,8 +169,8 @@ final class TranslationWebViewHandler {
                 return Disposables.create()
             }
 
-            let encodedSchema = WKWebView.encodeForJavascript(schemaData)
-            let encodedFormats = WKWebView.encodeForJavascript(dateFormatData)
+            let encodedSchema = WebViewEncoder.encodeForJavascript(schemaData)
+            let encodedFormats = WebViewEncoder.encodeForJavascript(dateFormatData)
 
             DDLogInfo("WebViewHandler: loaded bundled files")
 

Zotero/Assets/en.lproj/Localizable.strings

@@ -479,6 +479,7 @@
 "errors.pdf.cant_update_annotation" = "Can't update annotation.";
 "errors.pdf.cant_add_annotations" = "Can't add annotations.";
 "errors.pdf.cant_delete_annotations" = "Can't delete annotations.";
+"errors.pdf.incompatible_document" = "This document is not supported.";
 "errors.pdf.page_index_not_int" = "Incorrect format of page stored for this document.";
 
 "accessibility.untitled" = "Untitled";

Zotero/Controllers/AnnotationConverter.swift

@@ -61,7 +61,7 @@ struct AnnotationConverter {
         username: String,
         displayName: String,
         boundingBoxConverter: AnnotationBoundingBoxConverter?
-    ) -> DocumentAnnotation? {
+    ) -> PdfDocumentAnnotation? {
         guard let document = annotation.document, AnnotationsConfig.supported.contains(annotation.type) else { return nil }
 
         let key = annotation.key ?? annotation.uuid
@@ -113,7 +113,7 @@ struct AnnotationConverter {
             return nil
         }
 
-        return DocumentAnnotation(
+        return PdfDocumentAnnotation(
             key: key,
             type: type,
             page: page,
@@ -191,7 +191,7 @@ struct AnnotationConverter {
     ) -> [PSPDFKit.Annotation] {
         return items.map({ item in
             return self.annotation(
-                from: DatabaseAnnotation(item: item),
+                from: PdfDatabaseAnnotation(item: item),
                 type: type,
                 interfaceStyle: interfaceStyle,
                 currentUserId: currentUserId,
@@ -204,7 +204,7 @@ struct AnnotationConverter {
     }
 
     static func annotation(
-        from zoteroAnnotation: DatabaseAnnotation,
+        from zoteroAnnotation: PdfDatabaseAnnotation,
         type: Kind,
         interfaceStyle: UIUserInterfaceStyle,
         currentUserId: Int,
@@ -260,7 +260,7 @@ struct AnnotationConverter {
 
     /// Creates corresponding `SquareAnnotation`.
     /// - parameter annotation: Zotero annotation.
-    private static func areaAnnotation(from annotation: Annotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.SquareAnnotation {
+    private static func areaAnnotation(from annotation: PdfAnnotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.SquareAnnotation {
         let square: PSPDFKit.SquareAnnotation
         switch type {
         case .export:
@@ -280,7 +280,7 @@ struct AnnotationConverter {
     /// Creates corresponding `HighlightAnnotation`.
     /// - parameter annotation: Zotero annotation.
     private static func highlightAnnotation(
-        from annotation: Annotation,
+        from annotation: PdfAnnotation,
         type: Kind,
         color: UIColor,
         alpha: CGFloat,
@@ -305,7 +305,7 @@ struct AnnotationConverter {
 
     /// Creates corresponding `NoteAnnotation`.
     /// - parameter annotation: Zotero annotation.
-    private static func noteAnnotation(from annotation: Annotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.NoteAnnotation {
+    private static func noteAnnotation(from annotation: PdfAnnotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.NoteAnnotation {
         let note: PSPDFKit.NoteAnnotation
         switch type {
         case .export:
@@ -323,7 +323,7 @@ struct AnnotationConverter {
         return note
     }
 
-    private static func inkAnnotation(from annotation: Annotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.InkAnnotation {
+    private static func inkAnnotation(from annotation: PdfAnnotation, type: Kind, color: UIColor, boundingBoxConverter: AnnotationBoundingBoxConverter) -> PSPDFKit.InkAnnotation {
         let lines = annotation.paths(boundingBoxConverter: boundingBoxConverter).map({ group in
             return group.map({ DrawingPoint(cgPoint: $0) })
         })

Zotero/Controllers/Citation/CitationController.swift

@@ -174,7 +174,7 @@ class CitationController: NSObject {
             }
             itemsData.append(data)
         }
-        return WKWebView.encodeAsJSONForJavascript(itemsData)
+        return WebViewEncoder.encodeAsJSONForJavascript(itemsData)
     }
 
     /// Bibliography happens once for selected item(s). Appropriate style and locale xmls are loaded, webView is initialized and loaded with index.html. When everything is loaded,
@@ -266,7 +266,7 @@ class CitationController: NSObject {
                 let localeData = try Data(contentsOf: localeUrl)
                 let styleData = try self.fileStorage.read(Files.style(filename: styleFilename))
 
-                subscriber(.success((WKWebView.encodeForJavascript(styleData), WKWebView.encodeForJavascript(localeData))))
+                subscriber(.success((WebViewEncoder.encodeForJavascript(styleData), WebViewEncoder.encodeForJavascript(localeData))))
             } catch let error {
                 DDLogError("CitationController: can't read locale or style - \(error)")
                 subscriber(.failure(Error.styleOrLocaleMissing))
@@ -302,7 +302,7 @@ class CitationController: NSObject {
                 return Disposables.create()
             }
 
-            subscriber(.success(WKWebView.encodeForJavascript(schemaData)))
+            subscriber(.success(WebViewEncoder.encodeForJavascript(schemaData)))
 
             return Disposables.create()
         }
@@ -323,7 +323,7 @@ class CitationController: NSObject {
 
                 items.first?.realm?.invalidate()
 
-                subscriber(.success(WKWebView.encodeAsJSONForJavascript(data)))
+                subscriber(.success(WebViewEncoder.encodeAsJSONForJavascript(data)))
             } catch let error {
                 DDLogError("CitationController: can't read items - \(error)")
                 subscriber(.failure(error))
@@ -498,7 +498,7 @@ extension CitationController: WKScriptMessageHandler {
 
         case .csl:
             if let csl = jsResult as? [[String: Any]] {
-                result = .success(WKWebView.encodeAsJSONForJavascript(csl))
+                result = .success(WebViewEncoder.encodeAsJSONForJavascript(csl))
             } else {
                 DDLogError("CitationController: CSL got unknown response - \(jsResult)")
                 result = .failure(Error.missingResponse)

Zotero/Controllers/Database/Requests/CreateHtmlEpubAnnotationsDbRequest.swift

@@ -0,0 +1,126 @@
+//
+//  CreateHtmlEpubAnnotationsDbRequest.swift
+//  Zotero
+//
+//  Created by Michal Rentka on 28.09.2023.
+//  Copyright © 2023 Corporation for Digital Scholarship. All rights reserved.
+//
+
+import Foundation
+
+import RealmSwift
+
+struct CreateHtmlEpubAnnotationsDbRequest: DbRequest {
+    let attachmentKey: String
+    let libraryId: LibraryIdentifier
+    let annotations: [HtmlEpubAnnotation]
+    let userId: Int
+
+    unowned let schemaController: SchemaController
+
+    var needsWrite: Bool { return true }
+
+    func process(in database: Realm) throws {
+        guard let parent = database.objects(RItem.self).filter(.key(self.attachmentKey, in: self.libraryId)).first else { return }
+
+        for annotation in self.annotations {
+            self.create(annotation: annotation, parent: parent, in: database)
+        }
+    }
+
+    private func create(annotation: HtmlEpubAnnotation, parent: RItem, in database: Realm) {
+        let item: RItem
+
+        if let _item = database.objects(RItem.self).filter(.key(annotation.key, in: self.libraryId)).first {
+            if !_item.deleted {
+                // If item exists and is not deleted locally, we can ignore this request
+                return
+            }
+
+            // If item exists and was already deleted locally and not yet synced, we re-add the item
+            item = _item
+            item.deleted = false
+        } else {
+            // If item didn't exist, create it
+            item = RItem()
+            item.key = annotation.key
+            item.rawType = ItemTypes.annotation
+            item.localizedType = self.schemaController.localized(itemType: ItemTypes.annotation) ?? ""
+            item.libraryId = self.libraryId
+            item.dateAdded = annotation.dateCreated
+            database.add(item)
+        }
+
+        item.syncState = .synced
+        item.changeType = .user
+        item.htmlFreeContent = annotation.comment.isEmpty ? nil : annotation.comment.strippedRichTextTags
+        item.dateModified = annotation.dateModified
+        item.parent = parent
+
+        if annotation.isAuthor {
+            item.createdBy = database.object(ofType: RUser.self, forPrimaryKey: self.userId)
+        }
+
+        // We need to submit tags on creation even if they are empty, so we need to mark them as changed
+        self.addFields(for: annotation, to: item, database: database)
+        let changes: RItemChanges = [.parent, .fields, .type, .tags]
+        item.changes.append(RObjectChange.create(changes: changes))
+    }
+
+    private func addFields(for annotation: HtmlEpubAnnotation, to item: RItem, database: Realm) {
+        for field in FieldKeys.Item.Annotation.allHtmlEpubFields(for: annotation.type) {
+            let rField = RItemField()
+            rField.key = field.key
+            rField.baseKey = field.baseKey
+            rField.changed = true
+
+            switch (field.key, field.baseKey) {
+            case (FieldKeys.Item.Annotation.type, nil):
+                rField.value = annotation.type.rawValue
+
+            case (FieldKeys.Item.Annotation.color, nil):
+                rField.value = annotation.color
+
+            case (FieldKeys.Item.Annotation.comment, nil):
+                rField.value = annotation.comment
+
+            case (FieldKeys.Item.Annotation.pageLabel, nil):
+                rField.value = annotation.pageLabel
+
+            case (FieldKeys.Item.Annotation.sortIndex, nil):
+                rField.value = annotation.sortIndex
+                item.annotationSortIndex = annotation.sortIndex
+
+            case (FieldKeys.Item.Annotation.text, nil):
+                rField.value = annotation.text ?? ""
+
+            case (FieldKeys.Item.Annotation.Position.htmlEpubType, FieldKeys.Item.Annotation.position):
+                guard let value = annotation.position[FieldKeys.Item.Annotation.Position.htmlEpubType] as? String else { continue }
+                rField.value = value
+
+            case (FieldKeys.Item.Annotation.Position.htmlEpubValue, FieldKeys.Item.Annotation.position):
+                guard let value = annotation.position[FieldKeys.Item.Annotation.Position.htmlEpubValue] as? String else { continue }
+                rField.value = value
+
+            default: break
+            }
+
+            item.fields.append(rField)
+        }
+    }
+
+    private func addTags(for annotation: HtmlEpubAnnotation, to item: RItem, database: Realm) {
+        let allTags = database.objects(RTag.self)
+
+        for tag in annotation.tags {
+            guard let rTag = allTags.filter(.name(tag.name)).first else { continue }
+
+            let rTypedTag = RTypedTag()
+            rTypedTag.type = .manual
+            database.add(rTypedTag)
+
+            rTypedTag.item = item
+            rTypedTag.tag = rTag
+        }
+    }
+}

Zotero/Controllers/Database/Requests/CreateAnnotationsDbRequest.swift → Zotero/Controllers/Database/Requests/CreatePdfAnnotationsDbRequest.swift

@@ -1,5 +1,5 @@
 //
-//  CreateAnnotationsDbRequest.swift
+//  CreatePdfAnnotationsDbRequest.swift
 //  Zotero
 //
 //  Created by Michal Rentka on 31.08.2022.
@@ -10,10 +10,10 @@ import UIKit
 
 import RealmSwift
 
-struct CreateAnnotationsDbRequest: DbRequest {
+struct CreatePdfAnnotationsDbRequest: DbRequest {
     let attachmentKey: String
     let libraryId: LibraryIdentifier
-    let annotations: [DocumentAnnotation]
+    let annotations: [PdfDocumentAnnotation]
     let userId: Int
 
     unowned let schemaController: SchemaController
@@ -29,7 +29,7 @@ struct CreateAnnotationsDbRequest: DbRequest {
         }
     }
 
-    private func create(annotation: DocumentAnnotation, parent: RItem, in database: Realm) {
+    private func create(annotation: PdfDocumentAnnotation, parent: RItem, in database: Realm) {
         let item: RItem
 
         if let _item = database.objects(RItem.self).filter(.key(annotation.key, in: self.libraryId)).first {
@@ -70,8 +70,8 @@ struct CreateAnnotationsDbRequest: DbRequest {
         item.changes.append(RObjectChange.create(changes: changes))
     }
 
-    private func addFields(for annotation: Annotation, to item: RItem, database: Realm) {
-        for field in FieldKeys.Item.Annotation.allFields(for: annotation.type) {
+    private func addFields(for annotation: PdfDocumentAnnotation, to item: RItem, database: Realm) {
+        for field in FieldKeys.Item.Annotation.allPdfFields(for: annotation.type) {
             let rField = RItemField()
             rField.key = field.key
             rField.baseKey = field.baseKey
@@ -110,7 +110,7 @@ struct CreateAnnotationsDbRequest: DbRequest {
     private func add(rects: [CGRect], to item: RItem, changes: inout RItemChanges, database: Realm) {
         guard !rects.isEmpty else { return }
 
-        let page = UInt(DatabaseAnnotation(item: item).page)
+        let page = UInt(PdfDatabaseAnnotation(item: item).page)
 
         for rect in rects {
             let dbRect = self.boundingBoxConverter.convertToDb(rect: rect, page: page) ?? rect
@@ -128,7 +128,7 @@ struct CreateAnnotationsDbRequest: DbRequest {
     private func add(paths: [[CGPoint]], to item: RItem, changes: inout RItemChanges, database: Realm) {
         guard !paths.isEmpty else { return }
 
-        let page = UInt(DatabaseAnnotation(item: item).page)
+        let page = UInt(PdfDatabaseAnnotation(item: item).page)
 
         for (idx, path) in paths.enumerated() {
             let rPath = RPath()

Zotero/Controllers/Database/Requests/EditAnnotationPathsDbRequest.swift

@@ -20,7 +20,7 @@ struct EditAnnotationPathsDbRequest: DbRequest {
 
     func process(in database: Realm) throws {
         guard let item = database.objects(RItem.self).filter(.key(self.key, in: self.libraryId)).first else { return }
-        let page = UInt(DatabaseAnnotation(item: item).page)
+        let page = UInt(PdfDatabaseAnnotation(item: item).page)
         let dbPaths = self.paths.map { path in
             return path.map({ self.boundingBoxConverter.convertToDb(point: $0, page: page) ?? $0 })
         }

Zotero/Controllers/Database/Requests/EditAnnotationRectsDbRequest.swift

@@ -20,7 +20,7 @@ struct EditAnnotationRectsDbRequest: DbRequest {
 
     func process(in database: Realm) throws {
         guard let item = database.objects(RItem.self).filter(.key(self.key, in: self.libraryId)).first else { return }
-        let page = UInt(DatabaseAnnotation(item: item).page)
+        let page = UInt(PdfDatabaseAnnotation(item: item).page)
         let dbRects = self.rects.map({ self.boundingBoxConverter.convertToDb(rect: $0, page: page) ?? $0 })
         guard self.rects(dbRects, differFrom: item.rects) else { return }
         self.sync(rects: dbRects, in: item, database: database)

Zotero/Controllers/Database/Requests/EditItemFieldsDbRequest.swift

@@ -59,6 +59,7 @@ struct EditItemFieldsDbRequest: DbRequest {
         if didChange {
             item.changes.append(RObjectChange.create(changes: RItemChanges.fields))
             item.changeType = .user
+            item.dateModified = Date()
         }
     }
 }

Zotero/Controllers/Database/Requests/EditTagsForItemDbRequest.swift

@@ -62,6 +62,7 @@ struct EditTagsForItemDbRequest: DbRequest {
             item.rawType = item.rawType
             item.changeType = .user
             item.changes.append(RObjectChange.create(changes: RItemChanges.tags))
+            item.dateModified = Date()
         }
     }
 }