wicked_pdf 1.0.3 → 2.6.3

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -1,118 +1,242 @@
-require 'open-uri'
+require 'net/http'
+require 'delegate'
 
-module WickedPdfHelper
-  module Assets
-    ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
+class WickedPdf
+  module WickedPdfHelper
+    module Assets
+      ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
 
-    def wicked_pdf_asset_base64(path)
-      asset = Rails.application.assets.find_asset(path)
-      throw "Could not find asset '#{path}'" if asset.nil?
-      base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
-      "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
-    end
+      class PropshaftAsset < SimpleDelegator
+        def content_type
+          super.to_s
+        end
+
+        def to_s
+          content
+        end
+
+        def filename
+          path.to_s
+        end
+      end
+
+      def wicked_pdf_asset_base64(path)
+        asset = find_asset(path)
+        raise "Could not find asset '#{path}'" if asset.nil?
 
-    def wicked_pdf_stylesheet_link_tag(*sources)
-      stylesheet_contents = sources.collect do |source|
-        source = WickedPdfHelper.add_extension(source, 'css')
-        "<style type='text/css'>#{read_asset(source)}</style>"
-      end.join("\n")
+        base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
+        "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
+      end
+
+      # Using `image_tag` with URLs when generating PDFs (specifically large PDFs with lots of pages) can cause buffer/stack overflows.
+      #
+      def wicked_pdf_url_base64(url)
+        response = Net::HTTP.get_response(URI(url))
 
-      stylesheet_contents.gsub(ASSET_URL_REGEX) do
-        if Regexp.last_match[1].starts_with?('data:')
-          "url(#{Regexp.last_match[1]})"
+        if response.is_a?(Net::HTTPSuccess)
+          base64 = Base64.encode64(response.body).gsub(/\s+/, '')
+          "data:#{response.content_type};base64,#{Rack::Utils.escape(base64)}"
         else
-          asset = Regexp.last_match[1]
-          "url(#{wicked_pdf_asset_path(asset)})" if asset_exists?(asset)
+          Rails.logger.warn("[wicked_pdf] #{response.code} #{response.message}: #{url}")
+          nil
         end
-      end.html_safe
-    end
+      end
 
-    def wicked_pdf_image_tag(img, options = {})
-      image_tag wicked_pdf_asset_path(img), options
-    end
+      def wicked_pdf_stylesheet_link_tag(*sources)
+        stylesheet_contents = sources.collect do |source|
+          source = WickedPdfHelper.add_extension(source, 'css')
+          "<style type='text/css'>#{read_asset(source)}</style>"
+        end.join("\n")
+
+        stylesheet_contents.gsub(ASSET_URL_REGEX) do
+          if Regexp.last_match[1].starts_with?('data:')
+            "url(#{Regexp.last_match[1]})"
+          else
+            "url(#{wicked_pdf_asset_path(Regexp.last_match[1])})"
+          end
+        end.html_safe
+      end
 
-    def wicked_pdf_javascript_src_tag(jsfile, options = {})
-      jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
-      javascript_include_tag wicked_pdf_asset_path(jsfile), options
-    end
+      def wicked_pdf_stylesheet_pack_tag(*sources)
+        return unless defined?(Webpacker)
 
-    def wicked_pdf_javascript_include_tag(*sources)
-      sources.collect do |source|
-        source = WickedPdfHelper.add_extension(source, 'js')
-        "<script type='text/javascript'>#{read_asset(source)}</script>"
-      end.join("\n").html_safe
-    end
+        if running_in_development?
+          stylesheet_pack_tag(*sources)
+        else
+          css_text = sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'css')
+            wicked_pdf_stylesheet_link_tag(webpacker_source_url(source))
+          end.join("\n")
+          css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+        end
+      end
+
+      def wicked_pdf_javascript_pack_tag(*sources)
+        return unless defined?(Webpacker)
 
-    def wicked_pdf_asset_path(asset)
-      if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
-        pathname
-      else
-        "file:///#{pathname}"
+        if running_in_development?
+          javascript_pack_tag(*sources)
+        else
+          sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'js')
+            "<script type='text/javascript'>#{read_asset(webpacker_source_url(source))}</script>"
+          end.join("\n").html_safe
+        end
+      end
+
+      def wicked_pdf_image_tag(img, options = {})
+        image_tag wicked_pdf_asset_path(img), options
       end
-    end
 
-    private
+      def wicked_pdf_javascript_src_tag(jsfile, options = {})
+        jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
+        javascript_include_tag wicked_pdf_asset_path(jsfile), options
+      end
 
-    # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
-    URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+      def wicked_pdf_javascript_include_tag(*sources)
+        sources.collect do |source|
+          source = WickedPdfHelper.add_extension(source, 'js')
+          "<script type='text/javascript'>#{read_asset(source)}</script>"
+        end.join("\n").html_safe
+      end
 
-    def asset_pathname(source)
-      if precompiled_asset?(source)
-        if (pathname = set_protocol(asset_path(source))) =~ URI_REGEXP
-          # asset_path returns an absolute URL using asset_host if asset_host is set
+      def wicked_pdf_asset_path(asset)
+        if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
           pathname
         else
-          File.join(Rails.public_path, asset_path(source).sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+          "file:///#{pathname}"
         end
-      else
-        Rails.application.assets.find_asset(source).pathname
       end
-    end
 
-    # will prepend a http or default_protocol to a protocol relative URL
-    # or when no protcol is set.
-    def set_protocol(source)
-      protocol = WickedPdf.config[:default_protocol] || 'http'
-      if source[0, 2] == '//'
-        source = [protocol, ':', source].join
-      elsif source[0] != '/' && !source[0, 8].include?('://')
-        source = [protocol, '://', source].join
+      def wicked_pdf_asset_pack_path(asset)
+        return unless defined?(Webpacker)
+
+        if running_in_development?
+          asset_pack_path(asset)
+        else
+          wicked_pdf_asset_path webpacker_source_url(asset)
+        end
       end
-      source
-    end
 
-    def precompiled_asset?(source)
-      Rails.configuration.assets.compile == false || source.to_s[0] == '/'
-    end
+      private
+
+      # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
+      URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+
+      def asset_pathname(source)
+        if precompiled_or_absolute_asset?(source)
+          asset = asset_path(source)
+          pathname = prepend_protocol(asset)
+          if pathname =~ URI_REGEXP
+            # asset_path returns an absolute URL using asset_host if asset_host is set
+            pathname
+          else
+            File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+          end
+        else
+          asset = find_asset(source)
+          if asset
+            # older versions need pathname, Sprockets 4 supports only filename
+            asset.respond_to?(:filename) ? asset.filename : asset.pathname
+          else
+            File.join(Rails.public_path, source)
+          end
+        end
+      end
 
-    def read_asset(source)
-      if precompiled_asset?(source)
-        if set_protocol(asset_path(source)) =~ URI_REGEXP
-          read_from_uri(source)
-        elsif asset_exists?(source)
-          IO.read(asset_pathname(source))
+      def find_asset(path)
+        if Rails.application.assets.respond_to?(:find_asset)
+          Rails.application.assets.find_asset(path, :base_path => Rails.application.root.to_s)
+        elsif defined?(Propshaft::Assembly) && Rails.application.assets.is_a?(Propshaft::Assembly)
+          PropshaftAsset.new(Rails.application.assets.load_path.find(path))
+        else
+          Sprockets::Railtie.build_environment(Rails.application).find_asset(path, :base_path => Rails.application.root.to_s)
         end
-      else
-        Rails.application.assets.find_asset(source).to_s
       end
-    end
 
-    def read_from_uri(source)
-      encoding = ':UTF-8' if RUBY_VERSION > '1.8'
-      asset = open(asset_pathname(source), "r#{encoding}") { |f| f.read }
-      asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
-      asset
-    end
+      # will prepend a http or default_protocol to a protocol relative URL
+      # or when no protcol is set.
+      def prepend_protocol(source)
+        protocol = WickedPdf.config[:default_protocol] || 'http'
+        if source[0, 2] == '//'
+          source = [protocol, ':', source].join
+        elsif source[0] != '/' && !source[0, 8].include?('://')
+          source = [protocol, '://', source].join
+        end
+        source
+      end
 
-    def gzip(asset)
-      stringified_asset = StringIO.new(asset)
-      gzipper = Zlib::GzipReader.new(stringified_asset)
-      gzipper.read
-    rescue Zlib::GzipFile::Error
-    end
+      def precompiled_or_absolute_asset?(source)
+        !Rails.configuration.respond_to?(:assets) ||
+          Rails.configuration.assets.compile == false ||
+          source.to_s[0] == '/' ||
+          source.to_s.match(/\Ahttps?\:\/\//)
+      end
+
+      def read_asset(source)
+        if precompiled_or_absolute_asset?(source)
+          pathname = asset_pathname(source)
+          if pathname =~ URI_REGEXP
+            read_from_uri(pathname)
+          elsif File.file?(pathname)
+            IO.read(pathname)
+          end
+        else
+          find_asset(source).to_s
+        end
+      end
+
+      def read_from_uri(uri)
+        asset = Net::HTTP.get(URI(uri))
+        asset.force_encoding('UTF-8') if asset
+        asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
+        asset
+      end
+
+      def gzip(asset)
+        stringified_asset = StringIO.new(asset)
+        gzipper = Zlib::GzipReader.new(stringified_asset)
+        gzipper.read
+      rescue Zlib::GzipFile::Error
+        nil
+      end
+
+      def webpacker_source_url(source)
+        return unless webpacker_version
+
+        # In Webpacker 3.2.0 asset_pack_url is introduced
+        if webpacker_version >= '3.2.0'
+          if (host = Rails.application.config.asset_host)
+            asset_pack_path(source, :host => host)
+          else
+            asset_pack_url(source)
+          end
+        else
+          source_path = asset_pack_path(source)
+          # Remove last slash from root path
+          root_url[0...-1] + source_path
+        end
+      end
 
-    def asset_exists?(source)
-      Rails.application.assets.find_asset(source).present?
+      def running_in_development?
+        return unless webpacker_version
+
+        # :dev_server method was added in webpacker 3.0.0
+        if Webpacker.respond_to?(:dev_server)
+          Webpacker.dev_server.running?
+        else
+          Rails.env.development? || Rails.env.test?
+        end
+      end
+
+      def webpacker_version
+        return unless defined?(Webpacker)
+
+        # If webpacker is used, need to check for version
+        require 'webpacker/version'
+
+        Webpacker::VERSION
+      end
     end
   end
 end

data/lib/wicked_pdf/wicked_pdf_helper.rb

@@ -1,33 +1,36 @@
-module WickedPdfHelper
-  def self.root_path
-    String === Rails.root ? Pathname.new(Rails.root) : Rails.root
-  end
+class WickedPdf
+  module WickedPdfHelper
+    def self.root_path
+      String === Rails.root ? Pathname.new(Rails.root) : Rails.root
+    end
 
-  def self.add_extension(filename, extension)
-    filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
-  end
+    def self.add_extension(filename, extension)
+      filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
+    end
 
-  def wicked_pdf_stylesheet_link_tag(*sources)
-    css_dir = WickedPdfHelper.root_path.join('public', 'stylesheets')
-    css_text = sources.collect do |source|
-      source = WickedPdfHelper.add_extension(source, 'css')
-      "<style type='text/css'>#{File.read(css_dir.join(source))}</style>"
-    end.join("\n")
-    css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
-  end
+    def wicked_pdf_stylesheet_link_tag(*sources)
+      css_dir = WickedPdfHelper.root_path.join('public', 'stylesheets')
+      css_text = sources.collect do |source|
+        source = WickedPdfHelper.add_extension(source, 'css')
+        "<style type='text/css'>#{File.read(css_dir.join(source))}</style>"
+      end.join("\n")
+      css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+    end
 
-  def wicked_pdf_image_tag(img, options = {})
-    image_tag "file:///#{WickedPdfHelper.root_path.join('public', 'images', img)}", options
-  end
+    def wicked_pdf_image_tag(img, options = {})
+      image_tag "file:///#{WickedPdfHelper.root_path.join('public', 'images', img)}", options
+    end
 
-  def wicked_pdf_javascript_src_tag(jsfile, options = {})
-    jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
-    src = "file:///#{WickedPdfHelper.root_path.join('public', 'javascripts', jsfile)}"
-    content_tag('script', '', { 'type' => Mime::JS, 'src' => path_to_javascript(src) }.merge(options))
-  end
+    def wicked_pdf_javascript_src_tag(jsfile, options = {})
+      jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
+      type = ::Mime.respond_to?(:[]) ? ::Mime[:js] : ::Mime::JS # ::Mime[:js] cannot be used in Rails 2.3.
+      src = "file:///#{WickedPdfHelper.root_path.join('public', 'javascripts', jsfile)}"
+      content_tag('script', '', { 'type' => type, 'src' => path_to_javascript(src) }.merge(options))
+    end
 
-  def wicked_pdf_javascript_include_tag(*sources)
-    js_text = sources.collect { |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
-    js_text.respond_to?(:html_safe) ? js_text.html_safe : js_text
+    def wicked_pdf_javascript_include_tag(*sources)
+      js_text = sources.collect { |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
+      js_text.respond_to?(:html_safe) ? js_text.html_safe : js_text
+    end
   end
 end