chupa-text-decomposer-webkit 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0522e247250744ce0a2df3317cc3226948f152a6
-  data.tar.gz: 1162b7e926467f66728378fb4b64cb6928afef96
+  metadata.gz: b28aa0772e09cadcde4ed6a92ebe681019aac5b2
+  data.tar.gz: 12f606f199ef7593ff54aec5f11674bc90b077bf
 SHA512:
-  metadata.gz: 7f7030778edcfe73c3a7ef5211c48d7218efc7e10f38cbf6f4a6c9a1e3374c202501669503ded21b5db483b18e48b3406a0890fbb725859d3aca6338a59cd3c2
-  data.tar.gz: 0b6aa0901239e94e35d65d70054dcd5d0d58e584034f17208d989ffc51848f3782069b04e45890fb7661697511480d4d1f43fefb9565ff948c5d05cbf5a5b4a2
+  metadata.gz: b1bda3a888d92deab02ef9e51d3a8a2ef97bbc4f6d9e39b85c3310ffbe51e9f6b46cb01510cbeef793129203f7f43d0431f16e52ce04abb58f94aa22c5f3b9c6
+  data.tar.gz: e39a3397f022c2df03284f88657443f14e5940720619f2ff17b44586e0d6400d7417c349e53db3939081c54f8c3fa4024a0ac2a6769ed3fd8b3f9d33d4e90a69

data/chupa-text-decomposer-webkit.gemspec

@@ -22,7 +22,7 @@ end
 
 Gem::Specification.new do |spec|
   spec.name = "chupa-text-decomposer-webkit"
-  spec.version = "1.0.4"
+  spec.version = "1.0.5"
   spec.homepage = "https://github.com/ranguba/chupa-text-decomposer-webkit"
   spec.authors = ["Kouhei Sutou"]
   spec.email = ["kou@clear-code.com"]

data/doc/text/news.md

@@ -1,5 +1,11 @@
 # News
 
+## 1.0.5: 2017-07-12
+
+### Improvements
+
+  * Added workaround for crash.
+
 ## 1.0.4: 2017-07-12
 
 ### Improvements

data/lib/chupa-text-decomposer-webkit/screenshoter.rb

@@ -0,0 +1,216 @@
+# Copyright (C) 2017  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "webkit2-gtk"
+
+module ChupaTextDecomposerWebKit
+  class Screenshoter
+    def initialize(logger)
+      @logger = logger
+      @view_context = create_view_context
+      @view = create_view
+      @window = create_window
+      @main_loop = GLib::MainLoop.new(nil, false)
+      @timeout_second = compute_timeout_second
+      @screenshot_cancellable = nil
+      @on_snapshot = nil
+    end
+
+    def run(body, uri, output_path, width, height)
+      @on_snapshot = lambda do |snapshot_surface|
+        scaled_surface = scale_snapshot(snapshot_surface, width, height)
+        scaled_surface.write_to_png(output_path)
+      end
+
+      begin
+        timeout do
+          debug do
+            "#{log_tag}[load][HTML] #{uri}"
+          end
+          @view.load_html(body, uri)
+          @main_loop.run
+        end
+      ensure
+        @on_snapshot = nil
+      end
+    end
+
+    private
+    def create_view_context
+      context = WebKit2Gtk::WebContext.new(ephemeral: true)
+      http_proxy = ENV["http_proxy"]
+      https_proxy = ENV["https_proxy"]
+      ftp_proxy = ENV["ftp_proxy"]
+      if http_proxy or https_proxy or ftp_proxy
+        proxy_settings = WebKit2Gtk::NetworkProxySettings.new
+        if http_proxy
+          proxy_settings.add_proxy_for_scheme("http", http_proxy)
+        end
+        if https_proxy
+          proxy_settings.add_proxy_for_scheme("https", https_proxy)
+        end
+        if ftp_proxy
+          proxy_settings.add_proxy_for_scheme("ftp", ftp_proxy)
+        end
+        context.set_network_proxy_settings(:custom, proxy_settings)
+      end
+      context
+    end
+
+    def create_view
+      view = WebKit2Gtk::WebView.new(context: @view_context)
+
+      view.signal_connect("load-changed") do |_, load_event|
+        debug do
+          "#{log_tag}[load][#{load_event.nick}] #{view.uri}"
+        end
+
+        case load_event
+        when WebKit2Gtk::LoadEvent::FINISHED
+          debug do
+            "#{log_tag}[screenshot][start] #{view.uri}"
+          end
+          cancel_screenshot
+          @screenshot_cancellable = Gio::Cancellable.new
+          view.get_snapshot(:full_document,
+                            :none,
+                            @screenshot_cancellable) do |_, result|
+            @screenshot_cancellable = nil
+            @main_loop.quit
+            begin
+              snapshot_surface = view.get_snapshot_finish(result)
+            rescue
+              error do
+                message = "failed to create snapshot: #{view.uri}: "
+                message << "#{$!.class}: #{$!.message}"
+                "#{log_tag}[screenshot][failed] #{message}"
+              end
+            else
+              debug do
+                size = "#{snapshot_surface.width}x#{snapshot_surface.height}"
+                "#{log_tag}[screenshot][finish] #{view.uri}: #{size}"
+              end
+              unless snapshot_surface.width.zero?
+                @on_snapshot.call(snapshot_surface) if @on_snapshot
+              end
+            end
+          end
+        end
+      end
+
+      view.signal_connect("load-failed") do |_, _, failed_uri, error|
+        cancel_screenshot
+        @main_loop.quit
+        error do
+          message = "failed to load URI: #{failed_uri}: "
+          message << "#{error.class}(#{error.code}): #{error.message}"
+          "#{log_tag}[load][failed] #{message}"
+        end
+        true
+      end
+
+      view
+    end
+
+    def scale_snapshot(snapshot_surface, width, height)
+      scaled_surface = Cairo::ImageSurface.new(:argb32, width, height)
+
+      context = Cairo::Context.new(scaled_surface)
+      context.set_source_color(:white)
+      context.paint
+
+      ratio = width.to_f / snapshot_surface.width
+      context.scale(ratio, ratio)
+      context.set_source(snapshot_surface)
+      context.paint
+
+      scaled_surface
+    end
+
+    def create_window
+      window = Gtk::OffscreenWindow.new
+      window.set_default_size(800, 600)
+      window.add(@view)
+      window.show_all
+      window
+    end
+
+    def cancel_screenshot
+      return if @screenshot_cancellable.nil?
+
+      debug do
+        "#{log_tag}[snapshot][cancel] cancel screenshot: #{@view.uri}"
+      end
+      @screenshot_cancellable.cancel
+      @screenshot_cancellable = nil
+    end
+
+    def timeout
+      timeout_id = GLib::Timeout.add_seconds(@timeout_second) do
+        timeout_id = nil
+        error do
+          message = "timeout to load URI: #{@timeout_second}s: #{@view.uri}"
+          message << ": loading" if @view.loading?
+          "#{log_tag}[load][timeout] #{message}"
+        end
+        cancel_screenshot
+        if @view.loading?
+          close_id = @view.signal_connect("close") do
+            @view.signal_handler_disconnect(close_id)
+            @main_loop.quit
+            error do
+              "#{log_tag}[load][closed] #{@view.uri}"
+            end
+          end
+          @view.try_close
+        else
+          @main_loop.quit
+        end
+        GLib::Source::REMOVE
+      end
+
+      begin
+        yield
+      ensure
+        GLib::Source.remove(timeout_id) if timeout_id
+      end
+    end
+
+    def compute_timeout_second
+      default_timeout = 5
+      timeout_string =
+        ENV["CHUPA_TEXT_DECOMPOSER_WEBKIT_TIMEOUT"] || default_timeout.to_s
+      begin
+        Integer(timeout_string)
+      rescue ArgumentError
+        default_timeout
+      end
+    end
+
+    private
+    def log_tag
+      "[decomposer][webkit]"
+    end
+
+    def debug(*args, &block)
+      @logger.debug(*args, &block)
+    end
+
+    def error(*args, &block)
+      @logger.error(*args, &block)
+    end
+  end
+end

data/lib/chupa-text/decomposers/webkit.rb

@@ -14,7 +14,8 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-require "webkit2-gtk"
+require "English"
+require "rbconfig"
 
 module ChupaText
   module Decomposers
@@ -57,161 +58,90 @@ module ChupaText
         false
       end
 
+      IN_PROCESS = ENV["CHUPA_TEXT_DECOMPOSER_WEBKIT_IN_PROCESS"] == "yes"
+      if IN_PROCESS
+        require "chupa-text-decomposer-webkit/screenshoter"
+      end
+
       def decompose(data)
-        screenshoter = Screenshoter.new(data)
-        screenshoter.run
+        body = data.source.body
+        uri = data.source.uri.to_s
+        output = Tempfile.new(["chupa-text-decomposer-webkit", ".png"])
+        width, height = data.expected_screenshot_size
+        if IN_PROCESS
+          screenshoter = ChupaTextDecomposerWebKit::Screenshoter.new(logger)
+          screenshoter.run(body, uri, output.path, width, height)
+        else
+          screenshoter = ExternalScreenshoter.new
+          screenshoter.run(data.source.path, uri, output.path, width, height)
+        end
+        unless File.size(output.path).zero?
+          png = output.read
+          data.screenshot = Screenshot.new("image/png",
+                                           [png].pack("m*"),
+                                           "base64")
+        end
         data[AVAILABLE_ATTRIBUTE_NAME] = !data.screenshot.nil?
         yield(data)
       end
 
-      class Screenshoter
+      class ExternalScreenshoter
         include Loggable
         include LogTag
 
-        def initialize(data)
-          @data = data
-          @@view_context ||= create_view_context
-          @main_loop = GLib::MainLoop.new(nil, false)
-          @timeout_second = compute_timeout_second
-        end
-
-        def run
-          view = WebKit2Gtk::WebView.new(context: @@view_context)
-          window = Gtk::OffscreenWindow.new
-          window.set_default_size(800, 600)
-          window.add(view)
-          window.show_all
-
-          setup_callbacks(view)
-
-          timeout(view) do
-            debug do
-              "#{log_tag}[load][HTML] #{@data.uri}"
-            end
-            view.load_html(@data.source.body, @data.source.uri.to_s)
-            @main_loop.run
-          end
-
-          window.destroy
-        end
-
-        private
-        def create_view_context
-          context = WebKit2Gtk::WebContext.new(ephemeral: true)
-          http_proxy = ENV["http_proxy"]
-          https_proxy = ENV["https_proxy"]
-          ftp_proxy = ENV["ftp_proxy"]
-          if http_proxy or https_proxy or ftp_proxy
-            proxy_settings = WebKit2Gtk::NetworkProxySettings.new
-            if http_proxy
-              proxy_settings.add_proxy_for_scheme("http", http_proxy)
-            end
-            if https_proxy
-              proxy_settings.add_proxy_for_scheme("https", https_proxy)
-            end
-            if ftp_proxy
-              proxy_settings.add_proxy_for_scheme("ftp", ftp_proxy)
-            end
-            context.set_network_proxy_settings(:custom, proxy_settings)
-          end
-          context
+        def initialize
+          @screenshoter = File.join(__dir__,
+                                    "..",
+                                    "..",
+                                    "..",
+                                    "bin",
+                                    "chupa-text-decomposer-webkit-screenshoter")
+          @command = ExternalCommand.new(RbConfig.ruby)
         end
 
-        def setup_callbacks(view)
-          view.signal_connect("load-changed") do |_, load_event|
-            debug do
-              "#{log_tag}[load][#{load_event.nick}] #{view.uri}"
-            end
-
-            case load_event
-            when WebKit2Gtk::LoadEvent::FINISHED
-              debug do
-                "#{log_tag}[screenshot][start] #{view.uri}"
-              end
-              view.get_snapshot(:full_document, :none) do |_, result|
-                @main_loop.quit
-                snapshot_surface = view.get_snapshot_finish(result)
-                debug do
-                  size = "#{snapshot_surface.width}x#{snapshot_surface.height}"
-                  "#{log_tag}[screenshot][finish] #{view.uri}: #{size}"
-                end
-                unless snapshot_surface.width.zero?
-                  png = convert_snapshot_surface_to_png(snapshot_surface)
-                  @data.screenshot = Screenshot.new("image/png",
-                                                    [png].pack("m*"),
-                                                    "base64")
-                end
+        def run(html_path, uri, output_path, width, height)
+          output_read, output_write = IO.pipe
+          error_output = Tempfile.new("chupa-text-decomposer-webkit-error")
+          output_reader = Thread.new do
+            loop do
+              IO.select([output_read])
+              line = output_read.gets
+              break if line.nil?
+
+              case line.chomp
+              when /\Adebug: /
+                debug($POSTMATCH)
+              when /\Aerror: /
+                error($POSTMATCH)
               end
             end
           end
-          view.signal_connect("load-failed") do |_, _, failed_uri, error|
-            @main_loop.quit
+          successed = @command.run(@screenshoter,
+                                   html_path,
+                                   uri,
+                                   output_path,
+                                   width.to_s,
+                                   height.to_s,
+                                   {
+                                     :spawn_options => {
+                                       :out => output_write,
+                                       :err => error_output.path,
+                                     },
+                                   })
+          output_write.close
+          output_reader.join
+
+          unless successed
             error do
-              message = "failed to load URI: #{failed_uri}: "
-              message << "#{error.class}(#{error.code}): #{error.message}"
-              "#{log_tag}[load][failed] #{message}"
+              message = "failed to external screenshoter: #{uri}: "
+              message << "#{@command.path} #{@screenshoter}"
+              "#{log_tag}[external-screenshoter][run][failed] #{message}"
             end
-            true
           end
-        end
-
-        def convert_snapshot_surface_to_png(snapshot_surface)
-          screenshot_width, screenshot_height = @data.expected_screenshot_size
-
-          screenshot_surface = Cairo::ImageSurface.new(:argb32,
-                                                       screenshot_width,
-                                                       screenshot_height)
-          context = Cairo::Context.new(screenshot_surface)
-          context.set_source_color(:white)
-          context.paint
-
-          ratio = screenshot_width.to_f / snapshot_surface.width
-          context.scale(ratio, ratio)
-          context.set_source(snapshot_surface)
-          context.paint
-
-          png = StringIO.new
-          screenshot_surface.write_to_png(png)
-          png.string
-        end
-
-        def timeout(view)
-          timeout_id = GLib::Timeout.add_seconds(@timeout_second) do
-            timeout_id = nil
-            error do
-              message = "timeout to load URI: #{@timeout_second}s: #{view.uri}"
-              message << ": loading" if view.loading?
-              "#{log_tag}[load][timeout] #{message}"
+          unless error_output.size.zero?
+            error_output.each_line do |line|
+              error(line)
             end
-            if view.loading?
-              view.signal_connect("close") do
-                @main_loop.quit
-                error do
-                  "#{log_tag}[load][closed] #{view.uri}"
-                end
-              end
-              view.try_close
-            else
-              @main_loop.quit
-            end
-            GLib::Source::REMOVE
-          end
-
-          begin
-            yield
-          ensure
-            GLib::Source.remove(timeout_id) if timeout_id
-          end
-        end
-
-        def compute_timeout_second
-          default_timeout = 5
-          timeout_string =
-            ENV["CHUPA_TEXT_DECOMPOSER_WEBKIT_TIMEOUT"] || default_timeout.to_s
-          begin
-            Integer(timeout_string)
-          rescue ArgumentError
-            default_timeout
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chupa-text-decomposer-webkit
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -126,6 +126,7 @@ files:
 - Rakefile
 - chupa-text-decomposer-webkit.gemspec
 - doc/text/news.md
+- lib/chupa-text-decomposer-webkit/screenshoter.rb
 - lib/chupa-text/decomposers/webkit.rb
 - test/run-test.rb
 - test/test-webkit.rb