win32-captureie 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 / 2007-11-23
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 MIYAMUKO Katsuyuki.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,45 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+bin/prtie
+config/hoe.rb
+config/requirements.rb
+lib/win32/capture_ie.rb
+lib/win32/capture_ie/base.rb
+lib/win32/capture_ie/bitmap.rb
+lib/win32/capture_ie/browser.rb
+lib/win32/capture_ie/cli/base.rb
+lib/win32/capture_ie/cli/prt_ie.rb
+lib/win32/capture_ie/commands/base.rb
+lib/win32/capture_ie/commands/prt_ie.rb
+lib/win32/capture_ie/ffi.rb
+lib/win32/capture_ie/ffi/base.rb
+lib/win32/capture_ie/ffi/gdi32.rb
+lib/win32/capture_ie/ffi/struct.rb
+lib/win32/capture_ie/ffi/user32.rb
+lib/win32/capture_ie/screen_captor.rb
+lib/win32/capture_ie/version.rb
+lib/win32/capture_ie/window.rb
+script/destroy
+script/destroy.cmd
+script/generate
+script/generate.cmd
+script/rdoc_filter.rb
+script/txt2html
+script/txt2html.cmd
+setup.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/win32/capture_ie_spec.rb
+tasks/deployment.rake
+tasks/deployment2.rake
+tasks/environment.rake
+tasks/helper.rb
+tasks/helper/rake.rb
+tasks/helper/rake_sh_filter.rb
+tasks/helper/util.rb
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,49 @@
+== Win32::CaptureIE - Capture whole web pages using Internet Explorer
+
+=== SYNOPSIS
+
+  require "rubygems"
+  require "win32/capture_ie"
+
+  Win32::CaptureIE.start("http://www.ruby-lang.org/") do |ie|
+    ie.capture_page("ruby-lang-whole-page.bmp")
+    ie.capture_browser("ruby-lang-browser.bmp")
+    ie.capture_browser("ruby-lang-onepage.bmp", :only_drawing_area => true)
+  end
+
+
+=== COMMAND
+
+win32-captureie provies _prtie_ command.
+
+For more details, please see {prtie}[link:files/bin/prtie.html] document.
+
+
+=== INSTALL
+
+  gem install win32-captureie
+
+
+=== ACKNOWLEDGMENTS
+
+Thanks to P.Smejkal author for his Perl's <tt>Win32-CaptureIE</tt>,
+from which I borrowed a lot of code and ideas.
+
+* {Win32-CaptureIE}[http://search.cpan.org/~psme/Win32-CaptureIE/]
+* {Win32-Screenshot}[http://search.cpan.org/~psme/Win32-Screenshot/]
+
+
+=== COPYRIGHT
+
+Copyright (c) 2007 MIYAMUKO Katsuyuki.
+
+win32-captureie is released under an MIT license.
+See {License.txt}[link:files/License_txt.html] for full license.
+
+
+=== OTHER STUFF
+
+Author::          MIYAMUKO Katsuyuki <mailto:miyamuko@gmail.com>
+Home URL::        http://win32-captureie.rubyforge.org
+Project URL::     http://rubyforge.org/projects/win32-captureie
+Blog (Japanese):: {id:miyamuko}[http://d.hatena.ne.jp/miyamuko/]

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].sort.each { |rake| load rake }

data/TODO.txt

@@ -0,0 +1,78 @@
+== TODO
+
+=== lib
+
+* RMagick
+  * png, jpg, ...
+* capture_element
+* capture_page(1)
+* filter, effect
+
+=== bin/capture-ie
+
+* basic auth
+  * watir?
+
+   Usage: capture-ie [options ...] URL [ [options ...] URL ]...
+
+   -T, --type
+   -o, --output
+       --stdout
+   -N  --worker=1
+       --page
+       --area
+       --geometry
+   -V, --version                    print version information and exit
+   -h, --help                       print this help and exit
+   -E, --element
+   --thumbnail
+   --filter
+     timestamp
+     sepia
+     monochrome
+     rotate
+     frame
+     pile
+     glid
+
+   --filename=digest/md5
+   --filename=time/unixepoch
+   --filename=time/iso8859-1
+   --filename=url/encode
+   --filename=url/hierarchy
+   --filename=%M-%T
+
+   --remove-query-string
+   --allow-same-filename
+   --before-visit=URL
+   --font-size
+   --encode
+
+   -t,  --tries=NUMBER            set number of retries to NUMBER (0 unlimits).
+   --retry-connrefused       retry even if connection is refused.
+   -i,  --input-file=FILE     download URLs found in FILE.
+   -B,  --base=URL            prepends URL to relative links in -F -i file.
+   -nc, --no-clobber          skip downloads that would download to
+                              existing files.
+   -w,  --wait=SECONDS            wait SECONDS between retrievals.
+        --waitretry=SECONDS       wait 1..SECONDS between retries of a retrieval.
+        --random-wait             wait from 0...2*WAIT secs between retrievals.
+   --restrict-file-names=OS  restrict chars in file names to ones OS allows.
+   --capture-if-match
+   --capture-unless-match
+   --capture-even-if-error
+   --no-cache
+   --max-filesize
+   --max-width
+   --max-height
+   --auto-pageize
+   --max-auto-pageize
+   --log
+   --fail-on-error
+
+   --width
+   --height
+   --capture-browser
+   --capture-browser-drawing-area
+   --capture-page=N
+   --capture-whole-page

data/bin/prtie

@@ -0,0 +1,62 @@
+#!/usr/bin/ruby
+
+#
+# == NAME
+#
+# prtie - Print Internet Explorer to image file
+#
+#
+# == SYNOPSIS
+#
+#      Usage: prtie [options] URL
+#
+#
+# == DESCRIPTION
+#
+# _prtie_ is a command line tool to capture whole web page as image
+# using Internet Explorer rendering engine.
+#
+#
+# == USAGE
+#
+#     Usage: prtie [options] URL
+#     
+#         -w, --wait=SECONDS               wait SECONDS between retrievals
+#         -d, --output-directory=DIRECTORY save capture to DIRECTORY/...
+#         -o, --output=FILE                save capture to FILE
+#         -D, --output-digest=ALGORITHM    use output filename as hex-encoded version
+#                                          of a given URL
+#                                          ALGORITHM: MD5, SHA1, SHA512 ...
+#     
+#         -v, --version                    print the version
+#         -h, --help                       print this message
+#     
+#       Default options:
+#         --output-digest=MD5
+#
+
+module Win32
+  module CaptureIE
+    class Launcher #:nodoc:
+
+      def self.testing?
+        ["../Manifest.txt", "../lib"].all?{|e|
+          File.exist?(File.join(File.dirname($0), e))
+        }
+      end
+
+      def self.add_lib_to_load_path
+        $LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+      end
+
+      def self.launch
+        add_lib_to_load_path if testing?
+        require "win32/capture_ie/cli/prt_ie"
+        ::Win32::CaptureIE::CLI::PrtIE.start(ARGV)
+      end
+
+    end
+  end
+end
+
+Win32::CaptureIE::Launcher.launch

data/config/hoe.rb

@@ -0,0 +1,72 @@
+require 'win32/capture_ie/version'
+
+AUTHOR = "MIYAMUKO Katsuyuki"  # can also be an array of Authors
+EMAIL = "miyamuko@gmail.com"
+DESCRIPTION = "Win32::CaptureIE - Capture web pages using Internet Explorer"
+GEM_NAME = "win32-captureie" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "win32-captureie" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+RDOC_DIR = "html"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Win32::CaptureIE::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'win32-captureie documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'win32/capture_ie'

data/lib/win32/capture_ie/base.rb

@@ -0,0 +1,4 @@
+module Win32
+  module CaptureIE
+  end
+end

data/lib/win32/capture_ie/bitmap.rb

@@ -0,0 +1,115 @@
+require "win32/capture_ie/base"
+require "win32/capture_ie/ffi"
+
+module Win32::CaptureIE
+
+  class BitMapSizeError < StandardError #:nodoc:
+  end
+
+  class BitMap #:nodoc:
+    include Win32::CaptureIE::FFI::GDI32
+
+    attr_reader :width, :height
+    def initialize(width, height)
+      @width = width
+      @height = height
+      @data = nil
+    end
+
+    def header_size
+      BITMAPINFOHEADER.packed_size + BITMAPFILEHEADER.packed_size
+    end
+
+    def data_size
+      width * height * 4
+    end
+
+    def data
+      @data ||= "\0" * data_size
+    end
+
+    def rows
+      (0..height).map{|i| data[i * width * 4, width * 4] }
+    end
+
+    def replace(bmp)
+      @width = bmp.width
+      @height = bmp.height
+      @data = bmp.data
+    end
+
+
+    def concat_bottom!(bmp)
+      if width.zero?
+        replace(bmp)
+      else
+        check_bitmap_size(:width, @width, bmp.width)
+        @data << bmp.data
+        @height += bmp.height
+      end
+    end
+    alias << concat_bottom!
+
+    def concat_right!(bmp)
+      if height.zero?
+        replace(bmp)
+      else
+        check_bitmap_size(:height, @height, bmp.height)
+        @data = rows.zip(bmp.rows).flatten.join
+        @width += bmp.width
+      end
+    end
+
+    def check_bitmap_size(key, expected, actual)
+      if expected != actual
+        raise BitMapSizeError, "wrong bitmap #{key}: expected #{expected}px, but was #{actual}px."
+      end
+    end
+    private :check_bitmap_size
+
+
+    def create_bitmapfileheader
+      header = BITMAPFILEHEADER.new
+      header.bfType    = "BM".unpack("S")[0]
+      header.bfSize    = header_size + data_size
+      header.bfOffBits = header_size
+      header
+    end
+    alias header create_bitmapfileheader
+
+    def create_bitmapinfo
+      info = BITMAPINFO.new
+      info.bmiHeader.biSize        = BITMAPINFOHEADER.packed_size
+      info.bmiHeader.biWidth       = width
+      info.bmiHeader.biHeight      = -height # negative because we want top-down bitmap
+      info.bmiHeader.biPlanes      = 1
+      info.bmiHeader.biBitCount    = 32      # we want RGBQUAD data
+      info.bmiHeader.biCompression = BI_RGB
+      info
+    end
+    alias info create_bitmapinfo
+
+    def save(filename)
+      open(filename, "wb") do |w|
+        pack {|data|
+          w.write data
+        }
+      end
+      nil
+    end
+
+    def pack(&block)
+      v = [create_bitmapfileheader.pack, create_bitmapinfo.bmiHeader.pack, @data]
+      if block
+        v.each(&block)
+      else
+        v.join
+      end
+    end
+
+    def inspect
+      "#<%s:0x%x @width=%d @height=%d @data=...>" % [self.class, self.object_id << 1, @height, @width]
+    end
+
+  end
+end

data/lib/win32/capture_ie/browser.rb

@@ -0,0 +1,119 @@
+require "win32/capture_ie/base"
+require "win32/capture_ie/ffi"
+require "win32/capture_ie/window"
+require "win32/capture_ie/screen_captor"
+
+module Win32::CaptureIE
+  class Browser < Window
+    module ReadyState
+      UNINITIALIZED = 0
+      LOADING       = 1
+      LOADED        = 2
+      INTERACTIVE   = 3
+      COMPLETE      = 4
+    end
+
+    include Win32::CaptureIE::FFI::User32
+    include Win32::CaptureIE::Browser::ReadyState
+
+    EMBEDDING_IE_WINDOW_CLASS_NAME = "Internet Explorer_Server"
+
+    attr_reader :doc_hwnd, :browser
+
+    def initialize(toplevel_hwnd, doc_hwnd=nil, browser=nil, document=nil, window=nil)
+      super(toplevel_hwnd)
+      @doc_hwnd = doc_hwnd || toplevel_hwnd
+      @browser = browser
+      @document = document
+      @window = window
+      @body = nil
+      @embedding_ie_hwnd = nil
+    end
+
+    def document
+      @document ||= browser.document rescue nil if browser
+    end
+
+    def window
+      @window ||= document.parentWindow rescue nil if document
+    end
+
+    def body
+      @body ||= body0 if document
+    end
+
+    def body0
+      if compatible_mode?
+        document.body rescue nil
+      else
+        document.body.parentNode rescue nil
+      end
+    end
+    private :body0
+
+    def compatible_mode?
+      v = document.compatMode rescue nil
+      return (v.nil? or v == "BackCompat")
+    end
+
+    def load_error?
+      url = document.url rescue ""
+      [/\Ares:\/\//, /\bshdoclc\b/].all?{|re| re.match(url) }
+    end
+
+    def navigate(url, wait=true)
+      browser.Navigate(url)
+      wait_for_complete if wait
+    end
+
+    def wait_for_complete(interval=0.5)
+      sleep(interval) while browser.ReadyState != COMPLETE
+    end
+
+    def embedding_ie_hwnd
+      @embedding_ie_hwnd ||= find_embedding_ie_hwnd
+    end
+
+    def find_embedding_ie_hwnd #:nodoc:
+      find_child_window_by_classname(doc_hwnd, EMBEDDING_IE_WINDOW_CLASS_NAME)
+    end
+    private :find_embedding_ie_hwnd
+
+    def save_excursion
+      top, left = body.scrollTop, body.scrollLeft
+      begin
+        yield
+      ensure
+        body.scrollTop, body.scrollLeft = top, left
+      end
+    end
+
+    # call-seq:
+    #   capture_browser(filename)
+    #   capture_browser(filename, :only_drawing_area => true)
+    #
+    # capture IE window to +filename+.
+    def capture_browser(filename, opts=nil)
+      captor.capture_browser(opts).save(filename)
+    end
+
+    # capture whole web page to +filename+.
+    def capture_page(filename)
+      captor.capture_page.save(filename)
+    end
+
+    def captor
+      Win32::CaptureIE::ScreenCaptor.new(self)
+    end
+
+
+    def ==(other)
+      @doc_hwnd == other.doc_hwnd
+    end
+
+    def hash
+      @doc_hwnd.hash
+    end
+
+  end
+end

data/lib/win32/capture_ie/cli/base.rb

@@ -0,0 +1,7 @@
+module Win32
+  module CaptureIE
+    module CLI #:nodoc:
+    end
+  end
+end
+