foliokit 1.4.0

data/lib/foliokit/overlay/overlay_button.rb

@@ -0,0 +1,24 @@
+module Foliokit
+  module Overlay
+    class OverlayButton < OverlayBase
+      element_base
+      element_reader :source, selector: "data > overlayAsset", text: true
+
+      def tagname
+        "a"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+        if source.present?
+          src = package.apply_asset(node, "source", source)
+          node["style"] ||= ""
+          node["style"] = [node["style"], "background-image: url(#{src})"].join(";")
+        end
+        node["swipable"] = true
+        node["touchable"] = true
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_container.rb

@@ -0,0 +1,10 @@
+module Foliokit
+  module Overlay
+    class OverlayContainer < OverlayBase
+      element_base
+      def tagname
+        "div"
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_hyperlink.rb

@@ -0,0 +1,87 @@
+module Foliokit
+  module Overlay
+    class OverlayHyperlink < OverlayBase
+      element_base
+      element_reader :url, selector: "data > url", text: true
+      element_reader :source, selector: "data > upStateURL", text: true
+      element_reader :active_source, selector: "data > downStateURL", text: true
+      element_reader :req_nav_confirm, type: "bool", selector: "data > reqNavConfirm", text: true
+      element_reader :open_in_app, type: "bool", selector: "data > openInApp", text: true
+
+      def tagname
+        "a"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+        href = parse_url(node)
+        return nil unless href
+
+        node["href"] = href
+        node["confirm"] = req_nav_confirm
+        node["external"] = !open_in_app
+        node["swipable"] = true
+        node["touchable"] = true
+
+        if source.present?
+          img = Nokogiri::XML::Node.new("img", document)
+          package.apply_asset(img, "src", source)
+          img["class"] = "source"
+          node << img
+        end
+
+        if active_source.present?
+          img = Nokogiri::XML::Node.new("img", document)
+          package.apply_asset(img, "src", active_source)
+          img["class"] = "active-source"
+          node << img
+        end
+
+        node
+      end
+
+      def parse_url(node)
+        # history navitation
+        return url if url =~ %r{^goto://}
+
+        # url navigation
+        if url =~ %r{^http://.+} || url =~ %r{^https://.+}
+          uri = Addressable::URI.parse(url)
+          if open_in_app
+            params = URI.decode_www_form(uri.normalized_query || "").to_h
+            params["referrer"] = "Baker"
+            uri.query = URI.encode_www_form(params)
+            return uri.to_s
+          else
+            node["target"] = "_blank"
+            return url
+          end
+        elsif url =~ /^mailto:/
+          return url
+        end
+
+        # page / section navitation
+        if (matches = url.match(%r{^navto://relative/current#([0-9.]+)?}))
+          page_index = matches[1].to_i
+          return "#/#{page_index}/0"
+        elsif (matches = url.match(%r{^navto://tmp#?([0-9.]+)?}))
+          page_index = matches[1].to_i
+          return "#/#{page_index}/0"
+        elsif (matches = url.match(%r{^navto://([^#]+)#?([0-9.]+)?}))
+          page_id = matches[1]
+          page_index = @package.root_package.manifest.content_stack_ids.index(page_id)
+          return false if page_index.nil?
+
+          section_index = matches[2].to_i || 0
+          current_page_index = @package.root_package.manifest.content_stack_ids.index(@package.id)
+          current_section_index = @section_index
+          return false if page_index == current_page_index and section_index == current_section_index
+
+          return "#/#{page_index}/#{section_index}"
+        end
+
+        false
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_image.rb

@@ -0,0 +1,18 @@
+module Foliokit
+  module Overlay
+    class OverlayImage < OverlayBase
+      element_base
+      element_reader :source, selector: "data > overlayAsset", text: true
+
+      def tagname
+        "img"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+        package.apply_asset(node, "src", source, "div", self.bounds.width)
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_imagepan.rb

@@ -0,0 +1,36 @@
+module Foliokit
+  module Overlay
+    class OverlayImagepan < OverlayBase
+      element_base
+      element_reader :source, selector: "data > overlayAsset", text: true
+      element_reader :source_width, type: :i, selector: "data > overlayAsset", attribute: "width"
+      element_reader :source_height, type: :i, selector: "data > overlayAsset", attribute: "height"
+      element_reader :initial_viewport, type: Types::Bounds, selector: ->(options) { "data > initialViewport > #{package.manifest.orientation}Bounds > rectangle" }
+
+      def tagname
+        "div"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+        if source.present?
+          src = package.apply_asset(node, "source", source)
+          node["style"] ||= ""
+          node["style"] = [node["style"], "background-image: url(#{src})"].join(";")
+        end
+
+        if initial_viewport.present?
+          zoom = source_width.to_f / initial_viewport.width.to_f
+          width = bounds.width * zoom
+          node["style"] ||= ""
+          node["style"] = [node["style"], "background-size: #{width}px"].join(";")
+          node["source-width"] = source_width
+          node["source-height"] = source_height
+        end
+
+        node["touchable"] = true
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_video.rb

@@ -0,0 +1,42 @@
+module Foliokit
+  module Overlay
+    class OverlayVideo < OverlayBase
+      element_base
+      element_reader :videoUrl, selector: "data > videoUrl", text: true
+      element_reader :playInContext, type: "bool", selector: "data > playInContext", text: true
+      element_reader :showControlsByDefault, type: "bool", selector: "data > showControlsByDefault", text: true
+      element_reader :allowPause, type: "bool", selector: "data > allowPause", text: true
+      element_reader :hideWhenFinishedPlaying, type: "bool", selector: "data > hideWhenFinishedPlaying", text: true
+      element_reader :autoStart, type: "bool", selector: "data > autoStart", text: true
+      element_reader :autoStartDelay, type: "f", selector: "data > autoStartDelay", text: true
+
+      def tagname
+        "div"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+
+        # process youtube videos
+        uri = Addressable::URI.parse(video_url)
+        if uri.absolute? and uri.host =~ /(youtube)/
+          node["touchable"] = true
+          node["data-type"] = "youtube"
+          node["data-src"] = uri.to_s
+          node["class"] = "overlay-webview"
+          return node
+        end
+
+        node["src"] = package.store_asset(video_url)
+        node["auto-start"] = auto_start
+        node["loop"] = hide_when_finished_playing
+        node["fullscreen"] = play_in_context ? false : true
+        node["playsinline"] = "playsinline" if play_in_context
+        node["controls"] = true if show_controls_by_default
+        node["swipable"] = true
+        node["touchable"] = true
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_webview.rb

@@ -0,0 +1,57 @@
+module Foliokit
+  module Overlay
+    class OverlayWebview < OverlayBase
+      element_base
+      element_reader :web_view_url, selector: "data > webViewUrl", text: true
+
+      def tagname
+        "div"
+      end
+
+      def export(document, options = {})
+        node = super(document, options)
+        node["touchable"] = true
+        node["data-type"] = "iframe"
+        uri = Addressable::URI.parse(web_view_url)
+
+        # Handle simple iframe embeds
+        if uri.relative?
+          file = package.dir.file(uri.to_s)
+          return nil unless file.exists?
+
+          elements = Nokogiri::HTML(file.read).css("body > *")
+          if elements.count == 1 and elements.first.name == "iframe"
+            uri = Addressable::URI.parse(elements.first["src"])
+            uri.query = "referrer=WebView"
+          end
+        end
+
+        # Process embed type
+        if uri.absolute?
+          if uri.host =~ /(youtube)/
+            node["data-type"] = "youtube"
+          end
+        else
+          file = package.dir.file(uri.to_s)
+          return nil unless file.exists?
+
+          html_dir_path = file.dir.relative_path(package.dir)
+          html_dir_hash = Digest::MD5.hexdigest(html_dir_path)
+          html_dir = package.root.dir("html").dir(html_dir_hash)
+          unless html_dir.exists?
+            puts "-- creating html dir"
+            file.dir.copy(html_dir)
+          end
+          html_file = html_dir.file(file.name)
+          uri = Addressable::URI.parse(html_file.relative_path(package.root))
+          uri.query = "referrer=WebView"
+        end
+
+        # Set source
+        node["data-src"] = uri.to_s
+
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/package.rb

@@ -0,0 +1,123 @@
+module Foliokit
+  class Package
+    attr_reader :file, :dir, :manifest, :root
+    attr_accessor :assets, :root_package
+
+    def initialize(file, dir, root, root_package = nil)
+      @file = file
+      @dir = dir
+      @root = root
+      @root_package = root_package
+      @dir.delete if @dir.exists? and !@dir.file("Folio.xml").exists?
+      file.extract(@dir) unless @dir.exists?
+      unwrap_folder! if @dir.files.none?
+      wrap_article! if root_package.nil? and @dir.file("Article.xml").exists?
+      if @dir.file("Folio.xml").exists?
+        @manifest = Foliokit::ManifestFolio.new(@dir.file("Folio.xml"), self)
+      elsif @dir.file("Article.xml").exists?
+        @manifest = Foliokit::ManifestArticle.new(@dir.file("Article.xml"), self)
+      else
+        raise "invalid folio format"
+      end
+      @assets = {}
+      @checksums = {}
+    end
+
+    def id
+      manifest.id
+    end
+
+    def content_stacks
+      manifest.content_stacks
+    end
+
+    def valid_overlay_id?(id)
+      manifest.valid_overlay_id?(id)
+    end
+
+    def subfolios(root_package)
+      manifest.subfolios.map do |element|
+        Foliokit::Package.new(dir.file(element[:subfolio]), dir.dir(element[:id]), root, root_package)
+      end
+    end
+
+    def apply_asset(node, attribute, path, fallback_tag = nil, target_width = nil)
+      src = store_asset(path, target_width)
+      if src.nil?
+        node.name = fallback_tag if fallback_tag.present?
+      else
+        node[attribute] = src
+      end
+    end
+
+    def store_asset(path, target_width = nil, bounds = nil)
+      parts = path.split("#")
+      source = parts[0]
+      index = (parts[1]&.to_i or 1) - 1
+      source_file = dir.file(source)
+      source_file.align_encoding! unless source_file.exists?
+      return "#" unless source_file.exists?
+
+      hash = Digest::MD5.hexdigest("#{dir.name}/#{source}/#{index}/#{bounds}")
+      extension = source_file.extension
+      asset_file = root.file("assets/#{hash}.#{extension}")
+      asset_file.dir.create unless asset_file.dir.exists?
+      checksum = "#{Digest::SHA256.file(source_file.to_s)}/#{index}/#{bounds}"
+      return @checksums[checksum] if @checksums.key?(checksum)
+
+      # generate image from pdf or copy file
+      if source_file.mimetype == "application/pdf"
+        # Convert PDF images
+        doc = Poppler::Document.new(source_file.to_s)
+        page = doc[index]
+        surface = Cairo::ImageSurface.new(Cairo::FORMAT_ARGB32, *page.size)
+        cr = Cairo::Context.new(surface)
+        cr.render_poppler_page(page)
+        asset_file = root.file("assets/#{hash}.png")
+        cr.target.write_to_png(asset_file.to_s)
+        cr.target.finish
+      else
+        source_file.copy(asset_file)
+      end
+
+      # Crop to bounds
+      asset_file.crop(bounds.to_h) unless bounds.nil?
+
+      # Optimize image
+      asset_file.optimize!
+
+      # Cache and return result
+      @checksums[checksum] = asset_file.relative_path(root)
+      @checksums[checksum]
+    end
+
+    private
+
+    def wrap_article!
+      article = Nokogiri::XML(dir.file("Article.xml").read).css("article").first
+      dir.clean
+      file.copy(dir.file(file.name))
+      xml = Nokogiri::XML::Builder.new do |b|
+        b.folio(version: article["version"], lastUpdated: article["lastUpdated"], date: article["lastUpdated"], orientation: article["orientation"], bindingDirection: "left", id: file.basename, targetViewer: article["targetViewer"], article: "true") do
+          b.metadata do
+            b.description file.basename.titleize
+            b.magazineTitle file.basename.titleize
+            b.folioNumber file.basename.titleize
+          end
+          b.targetDimensions do
+            b.targetDimension(wideDimension: [article["width"].to_i, article["height"].to_i].max, narrowDimension: [article["width"].to_i, article["height"].to_i].min)
+          end
+          b.contentStacks do
+            b.contentStack(id: file.basename, subfolio: file.name)
+          end
+        end
+      end
+      dir.file("Folio.xml").write(xml.doc.to_s)
+    end
+
+    def unwrap_folder!
+      dirs = dir.directories.reject { |d| (/^_/ =~ d.name) }
+      @dir = dirs.first if dirs.count == 1
+    end
+  end
+end

data/lib/foliokit/slide.rb

@@ -0,0 +1,9 @@
+module Foliokit
+  class Slide
+    attr_reader :articles
+
+    def initialize(articles = [])
+      @articles = articles
+    end
+  end
+end

data/lib/foliokit/state.rb

@@ -0,0 +1,6 @@
+module Foliokit
+  class State
+    include Modules::Element
+    element_reader :id, hash: true
+  end
+end

data/lib/foliokit/types/bounds.rb

@@ -0,0 +1,47 @@
+module Foliokit
+  module Types
+    class Bounds
+      attr_reader :x, :y, :width, :height
+
+      def self.convert(target, name, options = {})
+        self.new(target[:x].to_i, target[:y].to_i, target[:width].to_i, target[:height].to_i)
+      end
+
+      def initialize(x, y, width, height)
+        @x = x
+        @y = y
+        @width = width
+        @height = height
+      end
+
+      def translate(x = 0, y = 0)
+        @x += x
+        @y += y
+      end
+
+      def top
+        @y
+      end
+
+      def left
+        @x
+      end
+
+      def bottom
+        @y + @height
+      end
+
+      def right
+        @x + @width
+      end
+
+      def to_s
+        "#{x}-#{y}-#{width}-#{height}"
+      end
+
+      def to_h
+        { x: x, y: y, width: width, height: height }
+      end
+    end
+  end
+end