vapir-firefox 1.9.0 → 1.10.0

data/lib/vapir-firefox/browser.rb

@@ -187,7 +187,7 @@ module Vapir
     # socket may be dead, and you want a new one. a warning will be printed if this occurs. 
     def self.firefox_socket(options={}) # :nodoc:
       if options[:reset] || !(class_variable_defined?('@@firefox_socket') && @@firefox_socket)
-        initialize_firefox_socket(options[:socket_class], options[:socket_options])
+        initialize_firefox_socket(options[:socket_class] || firefox_socket_class, options[:socket_options] || firefox_socket_class_options)
       end
       if options[:reset_if_dead]
         begin
@@ -268,7 +268,7 @@ module Vapir
       
       @pid = begin
         self.pid
-      rescue NotImplementedError
+      rescue CannotHandlePid
         nil
       end
       
@@ -282,7 +282,6 @@ module Vapir
             find_window(how, what)
           end
         end
-        set_browser_document
       else
         open_window
       end
@@ -294,8 +293,8 @@ module Vapir
       wait if options[:wait]
     end
     
-    def mozilla_window_class_name
-      'MozillaUIWindowClass'
+    def mozilla_window_class_names
+      ['MozillaUIWindowClass', 'MozillaWindowClass']
     end
 
     def browser
@@ -413,7 +412,6 @@ module Vapir
       @document_object=browser_object.contentDocument
       @content_window_object=browser_object.contentWindow
         # note that browser_window_object.content is the same thing, but simpler to refer to stuff on browser_object since that is updated by the nsIWebProgressListener below
-      @body_object=document_object.body
       @browser_objects[:requests_in_progress]=[]
       @requests_in_progress=@browser_objects[:requests_in_progress].to_array
       @browser_objects[:unmatched_stopped_requests_count]=0
@@ -481,7 +479,9 @@ module Vapir
     attr_reader :content_window_object
     attr_reader :browser_object
     attr_reader :document_object
-    attr_reader :body_object
+    def body_object
+      document_object.body
+    end
     
     def updated_at
       Time.at(@updated_at_epoch_ms.val/1000.0)+@updated_at_offset
@@ -517,7 +517,7 @@ module Vapir
         end
       end
 
-      @browser_window_object=@browser_object=@document_object=@content_window_object=@body_object=nil
+      @browser_window_object=@browser_object=@document_object=@content_window_object=nil
       if @self_launched_browser && firefox_socket && !self.class.window_objects.any?{ true }
         quit_browser(:force => false)
       end
@@ -540,7 +540,7 @@ module Vapir
         
         pid = @pid || begin
           self.pid
-        rescue NotImplementedError
+        rescue CannotHandlePid
           nil
         end
         
@@ -557,20 +557,24 @@ module Vapir
         
         wait_for_process_exit(pid)
         
-        @browser_window_object=@browser_object=@document_object=@content_window_object=@body_object=nil
+        @browser_window_object=@browser_object=@document_object=@content_window_object=nil
         nil
       end
       
+      # class representing an inability to either retrieve or check the status of firefox's pid 
+      class CannotHandlePid < StandardError; end
+      
       # returns the pid of the currently-attached Firefox process. 
       #
       # This only works on Firefox >= 3.6, on platforms supported (see #current_os), and raises 
-      # NotImplementedError if it can't get the pid. 
+      # CannotHandlePid if it can't get the pid. 
       def pid
         begin
+          raise CannotHandlePid unless firefox_socket.host == 'localhost'
           begin
             ctypes = firefox_socket.Components.utils.import("resource://gre/modules/ctypes.jsm").ctypes
           rescue FirefoxSocketJavascriptError
-            raise NotImplementedError, "Firefox 3.6 or greater is required for this method.\n\nOriginal error from firefox: #{$!.class}: #{$!.message}", $!.backtrace
+            raise CannotHandlePid, "Firefox 3.6 or greater is required for this method.\n\nOriginal error from firefox: #{$!.class}: #{$!.message}", $!.backtrace
           end
           lib, pidfunction, abi = *case current_os
           when :macosx
@@ -588,7 +592,7 @@ module Vapir
             # see https://bugzilla.mozilla.org/show_bug.cgi?id=585175
             ['kernel32', 'GetCurrentProcessId', ctypes['winapi_abi'] || ctypes['stdcall_abi']]
           else
-            raise NotImplementedError, "don't know how to get pid for #{current_os}"
+            raise CannotHandlePid, "don't know how to get pid for #{current_os}"
           end
            lib = ctypes.open(lib)
           begin
@@ -600,9 +604,16 @@ module Vapir
         end
       end
       
+      # returns the host which will be configured for a socket. same as firefox_socket.host, 
+      # if that exist, but this is correct even if firefox_socket isn't initialized. 
+      def firefox_socket_host
+        firefox_socket_class_options['host'] || firefox_socket_class.config.host
+      end
+      
       # attempts to determine whether the given process is still running. will raise 
-      # NotImplementedError if it can't determine this. 
+      # CannotHandlePid if it can't determine this. 
       def process_running?(pid)
+        raise CannotHandlePid unless firefox_socket_host == 'localhost'
         case current_os
         when :windows
           kernel32 = Vapir::Firefox.instance_eval do # define this on the class for reuse 
@@ -630,7 +641,7 @@ module Vapir
           `ps -p #{pid}`
           $? == 0
         else
-          raise NotImplementedError
+          raise CannotHandlePid
         end
       end
 
@@ -800,12 +811,36 @@ module Vapir
 
     # the HTTP response status code for the currently loaded document 
     def response_status_code
+      current_document_channel_object.responseStatus
+    end
+    # a hash of the response headers returned for the currently loaded document 
+    def response_headers
+      firefox_socket.call_function(:channel => current_document_channel_object) do %Q{
+        var headers={};
+        channel.visitResponseHeaders({visitHeader: function(header, value){ headers[header]=value; }});
+        return headers;
+      }
+      end.val.freeze
+    end
+    # a hash of the request headers the browser sent for the currently loaded document 
+    def request_headers
+      firefox_socket.call_function(:channel => current_document_channel_object) do %Q{
+        var headers={};
+        channel.visitRequestHeaders({visitHeader: function(header, value){ headers[header]=value; }});
+        return headers;
+      }
+      end.val.freeze
+    end
+    # a nsIHttpChannel for the currently loaded document - the browser's docShell.currentDocumentChannel 
+    #
+    # see https://developer.mozilla.org/en/XPCOM_Interface_Reference/nsIHttpChannel
+    def current_document_channel_object
       channel = nil
       ::Waiter.try_for(8, :exception => nil) do
         channel=browser.browser_object.docShell.currentDocumentChannel
         channel.is_a?(JavascriptObject) && channel.instanceof(browser.firefox_socket.Components.interfaces.nsIHttpChannel) && channel.respond_to?(:responseStatus)
       end || raise(RuntimeError, "expected currentDocumentChannel to exist and be a nsIHttpChannel but it wasn't; was #{channel.is_a?(JavascriptObject) ? channel.toString : channel.inspect}")
-      status = channel.responseStatus
+      channel
     end
     
     # Maximize the current browser window.
@@ -820,6 +855,7 @@ module Vapir
 
     # Waits for the page to get loaded.
     def wait(options={})
+      return unless config.wait
       return unless exists?
       unless options.is_a?(Hash)
         raise ArgumentError, "given options should be a Hash, not #{options.inspect} (#{options.class})\nold conflicting arguments of no_sleep or last_url are gone"
@@ -833,9 +869,9 @@ module Vapir
       # If the redirect is to a download attachment that does not reload this page, this
       # method will loop forever. Therefore, we need to ensure that if this method is called
       # twice with the same URL, we simply accept that we're done.
-      url= document_object.URL
+      url= document_object['URL']
 
-      if(url != options[:last_url])
+      if(url && url != options[:last_url])
         # check for meta redirects, except for redirects back to the same page (infinite
         # loop redirects). 
         metas=document_object.getElementsByTagName 'meta'
@@ -876,7 +912,11 @@ module Vapir
     # - :format => a valid format. if :dc is :window, the default is 'png' ('jpeg' is also supported); if :dc is anything else, 'bmp' is both the
     #   default and the only supported format. 
     def screen_capture(filename, options = {})
-      options = handle_options(options, :format => nil, :dc => :page)
+      if filename =~ /\.(\w+)\z/
+        extension = $1
+        file_format = %w(jpeg png).inject({'jpg' => 'jpeg'}){|h,f| h.merge(f => f) }[extension]
+      end
+      options = handle_options(options, :format => file_format, :dc => :page)
       
       if options[:dc] == :page
         options[:format] ||= 'png'
@@ -929,9 +969,8 @@ module Vapir
             fileOutputStream.init(nsFile, writeFlag | createFlag | truncateFlag, 0664, null);
             fileOutputStream.write(bytes, numBytes);
             fileOutputStream.close();
-            document_element.removeChild(canvas);
           }
-          catch(e)
+          finally
           { document_element.removeChild(canvas);
           }
         )
@@ -984,10 +1023,19 @@ module Vapir
       raise NotImplementedError, "(need to know how to access windows registry on JRuby)" if RUBY_PLATFORM =~ /java/
       require 'win32/registry'
       lm = ::Win32::Registry::HKEY_LOCAL_MACHINE
-      lm.open('SOFTWARE\Mozilla\Mozilla Firefox') do |reg|
-        reg1 = lm.open("SOFTWARE\\Mozilla\\Mozilla Firefox\\#{reg.keys[0]}\\Main")
-        if entry = reg1.find { |key, type, data| key =~ /pathtoexe/i }
-          return entry.last
+      lm.open('SOFTWARE\Mozilla\Mozilla Firefox') do |firefox_reg|
+        firefox_reg.keys.map do |firefox_version_key|
+          firefox_reg.open(firefox_version_key) do |firefox_version_reg|
+            if firefox_version_reg.keys.include?('Main')
+              firefox_version_reg.open('Main') do |firefox_version_main_reg|
+                firefox_version_main_reg.map do |key, type, data|
+                  if key=='PathToExe'
+                    return data
+                  end
+                end
+              end
+            end
+          end
         end
       end
     end

data/lib/vapir-firefox/element.rb

@@ -60,7 +60,7 @@ module Vapir
     # TODO: Provide ability to specify event parameters like keycode for key events, and click screen
     #       coordinates for mouse events.
     def fire_event(event_type, options={})
-      options={:wait => true, :highlight => true}.merge(options)
+      options={:wait => config.wait, :highlight => true}.merge(options)
       with_highlight(options) do
         event=create_event_object(event_type, options)
         if !options[:wait]
@@ -159,10 +159,10 @@ module Vapir
     # Options:
     # - :wait => true or false. If true, waits for the javascript call to return, and calls the #wait method. 
     #   If false, does not wait for the javascript to return and does not call #wait.
-    #   Default is true.
+    #   Default is the current config.wait value (which is by default true).
     # - :highlight => true or false. Highlights the element while clicking if true. Default is true. 
     def click(options={})
-      options={:wait => true, :highlight => true}.merge(options)
+      options={:wait => config.wait, :highlight => true}.merge(options)
       result=nil
       with_highlight(options) do
         assert_enabled if respond_to?(:assert_enabled)
@@ -196,12 +196,12 @@ module Vapir
     # Takes options:
     # - :highlight => true or false. Highlights the element while clicking if true. Default is true. 
     def click_no_wait(options={})
-      click(options.merge(:wait => false))
+      with_config(:wait => false) { click(options) }
     end
 
     # Waits for the browser to finish loading, if it is loading. See Firefox#wait. 
     def wait(options={})
-      @container.wait(options)
+      @container.wait(options) if config.wait
     end
     
     # Checks this element and its parents for display: none or visibility: hidden, these are 

data/lib/vapir-firefox/firefox_socket/base.rb

@@ -240,7 +240,7 @@ class FirefoxSocket
   # immediately. 
   def read_value(options={})
     options=options_from_config(options, {:timeout => :default_timeout, :read_size => :read_size}, [:length_before_value])
-    received_data = []
+#    received_data = []
     value_string = ""
     size_to_read=options[:read_size]
     timeout=options[:timeout]
@@ -249,7 +249,13 @@ class FirefoxSocket
 #    logger.add(-1) { "RECV_SOCKET is starting. timeout=#{timeout}" }
     while size_to_read > 0 && ensuring_extra_handled { @socket.ready_to_recv?(timeout) }
       data = ensuring_extra_handled { @socket.recv(size_to_read) }
-      received_data << data
+
+      # if the peer has performed an orderly shutdown, recv returns a 0-length string. 
+      if data.size==0
+        raise FirefoxSocketConnectionError, "The connection to Firefox has been closed."
+      end
+
+#      received_data << data
       value_string << data
       if @prompt && @expecting_prompt && utf8_length_safe(value_string) > @prompt.length
         if value_string =~ /\A#{Regexp.escape(@prompt)}/
@@ -280,11 +286,6 @@ class FirefoxSocket
           timeout=config.short_timeout
         end
       end
-      
-      # Kernel.select seems to indicate that a dead socket is ready to read, and returns endless blank strings to recv. rather irritating. 
-      if received_data.length >= 3 && received_data[-3..-1].all?{|rd| rd==''}
-        raise FirefoxSocketConnectionError, "Socket seems to no longer be connected"
-      end
 #      logger.add(-1) { "RECV_SOCKET is continuing. timeout=#{timeout}; data=#{data.inspect}" }
     end
 #    logger.debug { "RECV_SOCKET is done. received_data=#{received_data.inspect}; value_string=#{value_string.inspect}" }

data/lib/vapir-firefox/javascript_object.rb

@@ -143,7 +143,7 @@ class JavascriptObject
   def val_or_object(options={})
     options={:error_on_undefined=>true, :define_methods => self.class.always_define_methods}.merge(options)
     if function_result # calling functions multiple times is bad, so store in temp before figuring out what to do with it
-      store_rand_object_key(firefox_socket.temp_object).val_or_object(options.merge(:error_on_undefined => false))
+      store_rand_temp.val_or_object(options.merge(:error_on_undefined => false))
     else
       # if we don't know our type, stick everything into one call to avoid multiple socket calls 
       types_to_convert = ['boolean', 'number', 'string', 'null']
@@ -192,7 +192,7 @@ class JavascriptObject
     end
   end
   # does the work of #method_missing to determine whether to call a function what to return based 
-  # on the defined behavior of the given suffix. see #method_missing for more. information. 
+  # on the defined behavior of the given suffix. see #method_missing for more information. 
   def assign_or_call_or_val_or_object_by_suffix(suffix, *args)
     if suffix=='='
       assign(*args)
@@ -472,7 +472,9 @@ class JavascriptObject
   # in irb, mostly. 
   def define_methods! # :nodoc:
     metaclass=(class << self; self; end)
-    keys=firefox_socket.object("function(obj) { var keys=[]; for(var key in obj) { keys.push(key); } return keys; }").pass(self).val
+    # the following needs the try/catch because sometimes it raises NS_ERROR_NOT_AVAILABLE: Component is not available
+    # bug: https://bugzilla.mozilla.org/show_bug.cgi?id=683978
+    keys=firefox_socket.object("function(obj) { var keys=[]; try { for(var key in obj) { keys.push(key); } } catch(e) {} return keys; }").pass(self).val
     
     keys.grep(/\A[a-z_][a-z0-9_]*\z/i).reject{|k| self.class.method_defined?(k)}.each do |key|
       metaclass.send(:define_method, key) do |*args|
@@ -545,6 +547,9 @@ class JavascriptObject
   def to_function
     JavascriptFunction.new(self.ref, self.firefox_socket, :debug_name => debug_name)
   end
+  def to_simple_enumerator
+    JavascriptSimpleEnumerator.new(self.ref, self.firefox_socket, :debug_name => debug_name)
+  end
 
   # returns a ruby Hash. each key/value pair of this object
   # is represented in the returned hash. 
@@ -649,6 +654,7 @@ class JavascriptDOMNode < JavascriptObject
   # call #dump(:recurse => n) to recurse down only n levels. default is to recurse all the way down the dom tree. 
   def dump(options={})
     options={:recurse => nil, :level => 0}.merge(options)
+    options[:document] ||= self.ownerDocument
     next_options=options.merge(:recurse => options[:recurse] && (options[:recurse]-1), :level => options[:level]+1)
     result=(" "*options[:level]*2)+self.inspect+"\n"
     if options[:recurse]==0
@@ -657,6 +663,13 @@ class JavascriptDOMNode < JavascriptObject
       self.childNodes.to_array.each do |child|
         result+=child.to_dom.dump(next_options)
       end
+      anons = self.nodeType == 1 && options[:document].getAnonymousNodes(self)
+      if anons
+        result+=(" "*next_options[:level]*2)+"ANONYMOUS:\n"
+        anons.to_array.each do |child|
+          result+=child.to_dom.dump(next_options)
+        end
+      end
     end
     result
   end
@@ -734,3 +747,13 @@ class JavascriptFunction < JavascriptObject
     end
   end
 end
+
+class JavascriptSimpleEnumerator < JavascriptObject
+  def each
+    stored = store_rand_temp
+    while stored.hasMoreElements
+      yield stored.getNext
+    end
+  end
+  include Enumerable
+end

data/lib/vapir-firefox/modal_dialog.rb

@@ -51,7 +51,7 @@ module Vapir
       # raise if no anonymous nodes are found (this is where the buttons are) 
       anonymous_dialog_nodes=@modal_window.document.getAnonymousNodes(@modal_window.document.documentElement) || raise("Could not find anonymous nodes on which to look for buttons")
       xul_buttons=[]
-      anonymous_dialog_nodes.to_array.each do |node|
+      anonymous_dialog_nodes.to_array.select{|node| node.nodeType == 1 }.each do |node|
         xul_buttons+=node.getElementsByTagName('xul:button').to_array.select do |button|
           Vapir::fuzzy_match(button.label, button_text)
         end
@@ -74,8 +74,8 @@ module Vapir
       assert_exists
       modal_window
     end
-    def mozilla_window_class_name
-      'MozillaDialogClass'
+    def mozilla_window_class_names
+      ['MozillaDialogClass']
     end
   end
 
@@ -134,7 +134,8 @@ module Vapir
     end
     
     def wait(options=nil)
-      ::Waiter.try_for(Firefox::ARBITRARY_TIMEOUT) do
+      return unless config.wait
+      ::Waiter.try_for(config.wait_timeout) do
         !browser_object.webProgress.isLoadingDocument
       end
     end

data/lib/vapir-firefox/page_container.rb

@@ -11,10 +11,12 @@ module Vapir
     end
     
     # evaluates a given javascript string in the context of the browser's content window. anything 
-    # that is a top-level variable on the window will be seen as a top-level variable in the
-    # evaluated script.
+    # that is a top-level variable on the window (such as document or alert) will be seen as a 
+    # top-level variable in the evaluated script.
     #
-    # returns the last evaluated expression. 
+    # returns the last evaluated expression. WARNING! DO NOT RUN #execute_script AGAINST UNTRUSTED 
+    # PAGES! the resulting value has no security wrappers and could execute malicious code in a 
+    # privileged context. 
     #
     # raises an error if the given javascript errors. 
     #
@@ -43,8 +45,17 @@ module Vapir
     #  >> browser.execute_script('element.PercentLoaded()', :element => browser.element(:tag_name => 'embed').element_object)
     #  => 100
     def execute_script(javascript, other_variables={})
-      sandbox=firefox_socket.Components.utils.Sandbox(content_window_object)
-      sandbox.window=content_window_object.window
+      # TODO: add tests for cross-context expando properties 
+      xpcNativeWrapper = firefox_socket.root['XPCNativeWrapper']
+      unwrapped_window = if xpcNativeWrapper.respond_to?('unwrap')
+        xpcNativeWrapper.unwrap(content_window_object)
+      elsif content_window_object.respond_to?('wrappedJSObject')
+        content_window_object.wrappedJSObject
+      else
+        content_window_object.window
+      end
+      sandbox=firefox_socket.Components.utils.Sandbox(unwrapped_window, :wantXrays => false)
+      sandbox.window = unwrapped_window
       other_variables.each do |name, var|
         sandbox[name]=var
       end

data/lib/vapir-firefox/version.rb

@@ -1,5 +1,5 @@
 module Vapir
   class Firefox
-    VERSION = '1.9.0'
+    VERSION = '1.10.0'
   end
 end

data/lib/vapir-firefox/window.rb

@@ -18,7 +18,7 @@ module Vapir
         begin
           candidates=::Waiter.try_for(2, :condition => proc{|ret| ret.size > 0}, :exception => nil) do
             WinWindow::All.select do |win|
-              [mozilla_window_class_name].include?(win.class_name) && win.text==browser_window_object.document.title
+              mozilla_window_class_names.include?(win.class_name) && win.text==browser_window_object.document.title
             end
           end
           unless candidates.size==1

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: vapir-firefox
 version: !ruby/object:Gem::Version 
-  hash: 51
   prerelease: false
   segments: 
   - 1
-  - 9
+  - 10
   - 0
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors: 
 - Ethan
@@ -15,34 +14,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-04 00:00:00 -04:00
+date: 2011-09-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: vapir-common
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 51
         segments: 
         - 1
-        - 9
+        - 10
         - 0
-        version: 1.9.0
+        version: 1.10.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -109,27 +104,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: 
 - Firefox browser with MozRepl or JSSH extension installed
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Library for automating the Firefox browser in Ruby