add ReaderAnnotations module

frontend/apps/reader/modules/readerannotation.lua

@@ -0,0 +1,158 @@
+local WidgetContainer = require("ui/widget/container/widgetcontainer")
+
+local ReaderAnnotation = WidgetContainer:extend{}
+
+function ReaderAnnotation:buildAnnotation(bm, highlights, update_pageno)
+    -- bm - corresponding bookmark, highlights - all highlights
+    local hl, pageno = self:getHighlightByDatetime(highlights, bm.datetime)
+    if update_pageno then -- cannot be done in onReadSettings()
+        pageno = self.ui.paging and bm.page or self.document:getPageFromXPointer(bm.page)
+    end
+    if not hl then -- page bookmark or orphaned bookmark
+        hl = {}
+        if bm.highlighted then -- orphaned bookmark
+            hl.drawer = self.view.highlight.saved_drawer
+            if self.ui.paging then
+                if bm.pos0.page == bm.pos1.page then
+                    hl.pboxes = self.document:getPageBoxesFromPositions(bm.page, bm.pos0, bm.pos1)
+                else -- multi-page highlight, restore the first box only
+                    hl.pboxes = self.document:getPageBoxesFromPositions(bm.page, bm.pos0, bm.pos0)
+                end
+            end
+        end
+    end
+
+    return { -- annotation structure
+        datetime    = bm.datetime,
+        drawer      = hl.drawer,
+        text        = bm.notes,
+        text_edited = hl.edited,
+        note        = bm.text,
+        chapter     = bm.chapter,
+        page        = bm.page,
+        pageno      = pageno,
+        pos0        = bm.pos0,
+        pos1        = bm.pos1,
+        pboxes      = hl.pboxes,
+        ext         = hl.ext,
+    }
+end
+
+function ReaderAnnotation.buildBookmark(an)
+    return {
+        datetime    = an.datetime,
+        highlighted = an.drawer and true or nil,
+        notes       = an.text,
+        text        = an.note,
+        chapter     = an.chapter,
+        page        = an.page,
+        pos0        = an.pos0,
+        pos1        = an.pos1,
+    }
+end
+
+function ReaderAnnotation.buildHighlight(an)
+    return {
+        datetime    = an.datetime,
+        drawer      = an.drawer,
+        text        = an.text,
+        edited      = an.text_edited,
+        chapter     = an.chapter,
+        page        = an.page,
+        pos0        = an.pos0,
+        pos1        = an.pos1,
+        pboxes      = an.pboxes,
+        ext         = an.ext,
+    }
+end
+
+function ReaderAnnotation:getHighlightByDatetime(highlights, datetime)
+    for pageno, page_highlights in pairs(highlights) do
+        for i, highlight in ipairs(page_highlights) do
+            if highlight.datetime == datetime then
+                return highlight, pageno
+            end
+        end
+    end
+end
+
+function ReaderAnnotation:getAnnotationsFromBookmarksHighlights(bookmarks, highlights, update_pageno)
+    local annotations = {}
+    for i = #bookmarks, 1, -1 do
+        table.insert(annotations, self:buildAnnotation(bookmarks[i], highlights, update_pageno))
+    end
+    return annotations
+end
+
+function ReaderAnnotation:onReadSettings(config)
+    local bookmarks, highlights
+    local annotations = config:readSetting("annotations")
+    if annotations then
+        local has_annotations = #annotations > 0
+        local annotations_type = has_annotations and type(annotations[1].page)
+        -- Annotation formats in crengine and mupdf are incompatible.
+        -- Backup annotations when the document is opened with incompatible engine.
+        if self.ui.rolling and annotations_type ~= "string" then
+            if has_annotations then
+                config:saveSetting("annotations_paging", annotations)
+            end
+            annotations = config:readSetting("annotations_rolling") or {}
+            config:delSetting("annotations_rolling")
+        elseif self.ui.paging and annotations_type ~= "number" then
+            if has_annotations then
+                config:saveSetting("annotations_rolling", annotations)
+            end
+            annotations = config:readSetting("annotations_paging") or {}
+            config:delSetting("annotations_paging")
+        end
+        -- Build bookmarks/highlights
+        bookmarks, highlights = {}, {}
+        if #annotations > 0 then
+            local n = #annotations + 1
+            for i, an in ipairs(annotations) do
+                bookmarks[n - i] = self.buildBookmark(an)
+                if an.drawer then
+                    if highlights[an.pageno] == nil then
+                        highlights[an.pageno] = {}
+                    end
+                    table.insert(highlights[an.pageno], self.buildHighlight(an))
+                end
+            end
+        end
+    else -- old bookmarks/highlights
+        bookmarks = config:readSetting("bookmarks") or {}
+        highlights = config:readSetting("highlight") or {}
+        local has_bookmarks = #bookmarks > 0
+        local bookmarks_type = has_bookmarks and type(bookmarks[1].page)
+        if self.ui.rolling and bookmarks_type ~= "string" then
+            if has_bookmarks then
+                annotations = self:getAnnotationsFromBookmarksHighlights(bookmarks, highlights)
+                config:saveSetting("annotations_paging", annotations)
+            end
+            bookmarks = config:readSetting("bookmarks_rolling") or {}
+            highlights = config:readSetting("highlight_rolling") or {}
+            config:delSetting("bookmarks_rolling")
+            config:delSetting("highlight_rolling")
+        elseif self.ui.paging and bookmarks_type ~= "number" then
+            if has_bookmarks then
+                annotations = self:getAnnotationsFromBookmarksHighlights(bookmarks, highlights)
+                config:saveSetting("annotations_rolling", annotations)
+            end
+            bookmarks = config:readSetting("bookmarks_paging") or {}
+            highlights = config:readSetting("highlight_paging") or {}
+            config:delSetting("bookmarks_paging")
+            config:delSetting("highlight_paging")
+        end
+    end
+    self.ui.bookmark.bookmarks = bookmarks
+    self.view.highlight.saved = highlights
+end
+
+function ReaderAnnotation:onCloseDocument()
+    local annotations = self:getAnnotationsFromBookmarksHighlights(self.ui.bookmark.bookmarks, self.view.highlight.saved, true)
+    self.ui.doc_settings:saveSetting("annotations", annotations)
+    self.ui.doc_settings:delSetting("bookmarks")
+    self.ui.doc_settings:delSetting("highlight")
+end
+
+return ReaderAnnotation