firewatir 1.1.1 → 1.2.0

data/container.rb

@@ -816,7 +816,11 @@ module Container
         # Test the index access. 
         # puts doc[35].to_s
 	end
-       
+    
+    def jssh_socket
+      $jssh_socket || @container.jssh_socket
+    end
+
     #
     # Description:
     #  Reads the javascript execution result from the jssh socket. 
@@ -827,9 +831,10 @@ module Container
     # Output:	
     #	The javascript execution result as string.	
     #
-    def read_socket(socket = $jssh_socket)
+    def read_socket(socket = jssh_socket)
         return_value = "" 
         data = ""
+        receive = true
         #puts Thread.list
         s = nil
         while(s == nil) do
@@ -839,16 +844,22 @@ module Container
         for stream in s[0]
             data = stream.recv(1024)
             #puts "data is : #{data}"
-            while(data[data.length - 3..data.length - 1] != "\n> ")
+            while(receive)
+            #while(data.length == 1024)
                 return_value += data
-                data = stream.recv(1024)
+                if(return_value.include?("\n> "))
+                    receive = false
+                else    
+                    data = stream.recv(1024)
+                end    
+                #puts "return_value is : #{return_value}"
                 #puts "data length is : #{data.length}"
             end
         end
         
         # If received data is less than 1024 characters or for last data 
         # we read in the above loop 
-        return_value += data
+        #return_value += data
 
         # Get the command prompt inserted by JSSH
         #s = Kernel.select([socket] , nil , nil, 0.3)

data/firewatir.rb

@@ -255,6 +255,16 @@ module FireWatir
         def get_window_number()
             $jssh_socket.send("getWindows().length;\n", 0)
             @@current_window = read_socket().to_i - 1
+            
+            # Derek Berner 5/16/08 
+            # If at any time a non-browser window like the "Downloads" window 
+            #   pops up, it will become the topmost window, so make sure we 
+            #   ignore it.
+            @@current_window = js_eval("getWindows().length").to_i - 1
+            while js_eval("getWindows()[#{@@current_window}].getBrowser") == ''
+                @@current_window -= 1;
+            end
+
             # This will store the information about the window.
             #@@window_stack.push(@@current_window)
             #puts "here in get_window_number window number is #{@@current_window}"
@@ -329,6 +339,7 @@ module FireWatir
                     retry if no_of_tries < 3
                     raise UnableToStartJSShException, "Unable to connect to machine : #{MACHINE_IP} on port 9997. Make sure that JSSh is properly installed and Firefox is running with '-jssh' option"
             end
+            @error_checkers = []
         end
         private :set_defaults
  
@@ -368,7 +379,9 @@ module FireWatir
         #
         def close()
             #puts "current window number is : #{@@current_window}"
-            if @@current_window == 0
+            # Derek Berner 5/16/08
+            # Try to join thread only if there is exactly one open window
+            if js_eval("getWindows().length").to_i == 1
                 $jssh_socket.send(" getWindows()[0].close(); \n", 0)
                 @t.join if @t != nil
                 #sleep 5
@@ -576,70 +589,107 @@ module FireWatir
         # Description:
         #   Waits for the page to get loaded.
         #
-        def wait()
+        def wait(last_url = nil)
             #puts "In wait function "
             isLoadingDocument = ""
+            start = Time.now
+            
             while isLoadingDocument != "false"
-                $jssh_socket.send("#{BROWSER_VAR}=#{WINDOW_VAR}.getBrowser(); #{BROWSER_VAR}.webProgress.isLoadingDocument;\n" , 0)
-                isLoadingDocument = read_socket()
+                isLoadingDocument = js_eval("#{BROWSER_VAR}=#{WINDOW_VAR}.getBrowser(); #{BROWSER_VAR}.webProgress.isLoadingDocument;")
                 #puts "Is browser still loading page: #{isLoadingDocument}"
+                
+                 # Derek Berner 5/16/08
+                 # Raise an exception if the page fails to load
+                 if (Time.now - start) > 300
+                    raise "Page Load Timeout"
+                end
             end
-
-            # Check for Javascript redirect. As we are connected to Firefox via JSSh. JSSh
-            # doesn't detect any javascript redirects so check it here.
-            # If page redirects to itself that this code will enter in infinite loop.
-            # So we currently don't wait for such a page.
-            # wait variable in JSSh tells if we should wait more for the page to get loaded
-            # or continue. -1 means page is not redirected. Anyother positive values means wait.
-            jssh_command = "var wait = -1; var meta = null; meta = #{BROWSER_VAR}.contentDocument.getElementsByTagName('meta');
-                            if(meta != null)
-                            {
-                                var doc_url = #{BROWSER_VAR}.contentDocument.URL;
-                                for(var i=0; i< meta.length;++i)
+            # Derek Berner 5/16/08
+            # 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.
+            $jssh_socket.send("#{BROWSER_VAR}.contentDocument.URL;\n", 0)
+            url = read_socket()
+            
+            if(url != last_url)
+                # Check for Javascript redirect. As we are connected to Firefox via JSSh. JSSh
+                # doesn't detect any javascript redirects so check it here.
+                # If page redirects to itself that this code will enter in infinite loop.
+                # So we currently don't wait for such a page.
+                # wait variable in JSSh tells if we should wait more for the page to get loaded
+                # or continue. -1 means page is not redirected. Anyother positive values means wait.
+                jssh_command = "var wait = -1; var meta = null; meta = #{BROWSER_VAR}.contentDocument.getElementsByTagName('meta');
+                                if(meta != null)
                                 {
-									var content = meta[i].content;
-									var regex = new RegExp(\"^refresh$\", \"i\");
-									if(regex.test(meta[i].httpEquiv))
-									{
-										var arrContent = content.split(';');
-										var redirect_url = null;
-										if(arrContent.length > 0)
-										{
-											if(arrContent.length > 1)
-												redirect_url = arrContent[1];
-	                                        
-											if(redirect_url != null)
-											{
-												regex = new RegExp(\"^.*\" + redirect_url + \"$\");
-												if(!regex.test(doc_url))
-												{
-													wait = arrContent[0];
-												}
-											}
-											break;
-										}
-									}
-								}
-                            }
-                            wait;"
-            #puts "command in wait is : #{jssh_command}"                
-            jssh_command = jssh_command.gsub(/\n/, "")
-            $jssh_socket.send("#{jssh_command}; \n", 0)
-            wait_time = read_socket();
-            #puts "wait time is : #{wait_time}"
-            begin
-                wait_time = wait_time.to_i
-                if(wait_time != -1)
-                    sleep(wait_time)
-                    # Call wait again. In case there are multiple redirects.
-                    $jssh_socket.send("#{BROWSER_VAR} = #{WINDOW_VAR}.getBrowser(); \n",0)
-                    read_socket()
-                    wait()
-                end    
-            rescue
-            end
+                                    var doc_url = #{BROWSER_VAR}.contentDocument.URL;
+                                    for(var i=0; i< meta.length;++i)
+                                    {
+						    			var content = meta[i].content;
+							    		var regex = new RegExp(\"^refresh$\", \"i\");
+								    	if(regex.test(meta[i].httpEquiv))
+									    {
+										    var arrContent = content.split(';');
+    										var redirect_url = null;
+	    									if(arrContent.length > 0)
+		    								{
+			    								if(arrContent.length > 1)
+				    								redirect_url = arrContent[1];
+	                                            
+							    				if(redirect_url != null)
+						    					{
+								    				regex = new RegExp(\"^.*\" + redirect_url + \"$\");
+									    			if(!regex.test(doc_url))
+										    		{
+											    		wait = arrContent[0];
+												    }
+											    }
+											    break;
+										    }
+									    }
+								    }
+                                }
+                                wait;"
+                #puts "command in wait is : #{jssh_command}"                
+                jssh_command = jssh_command.gsub(/\n/, "")
+                $jssh_socket.send("#{jssh_command}; \n", 0)
+                wait_time = read_socket();
+                #puts "wait time is : #{wait_time}"
+                begin
+                    wait_time = wait_time.to_i
+                    if(wait_time != -1)
+                        sleep(wait_time)
+                        # Call wait again. In case there are multiple redirects.
+                        $jssh_socket.send("#{BROWSER_VAR} = #{WINDOW_VAR}.getBrowser(); \n",0)
+                        read_socket()
+                        wait(url)
+                    end    
+                rescue
+                end
+			end
             set_browser_document()
+            run_error_checks()
+            return self
         end
+        
+        # Add an error checker that gets called on every page load.
+        #
+        # * checker - a Proc object 
+        def add_checker(checker)
+            @error_checkers << checker
+        end
+        
+        # Disable an error checker
+        #
+        # * checker - a Proc object that is to be disabled
+        def disable_checker(checker)
+            @error_checkers.delete(checker)
+        end
+        
+        # Run the predefined error checks. This is automatically called on every page load.
+        def run_error_checks
+            @error_checkers.each { |e| e.call(self) }
+        end
+        
       
         #def jspopup_appeared(popupText = "", wait = 2)
         #    winHelper = WindowHelper.new()
@@ -1084,6 +1134,21 @@ module FireWatir
         end
         alias showFrames show_frames
 
+	    # 5/16/08 Derek Berner
+    	# Wrapper method to send JS commands concisely,
+	    # and propagate errors
+    	def js_eval(str)
+	        #puts "JS Eval: #{str}"
+    	    $jssh_socket.send("#{str};\n",0)
+	        value = read_socket()
+	        if md=/^(\w+)Error:(.*)$/.match(value) 
+	            eval "class JS#{md[1]}Error\nend"
+	            raise (eval "JS#{md[1]}Error"), md[2]
+	        end
+	        #puts "Value: #{value}"
+	        value
+	    end
+
     end # Class Firefox
  
     # 

data/firewatir/winClicker.rb

@@ -0,0 +1,122 @@
+if /linux/i.match(RUBY_PLATFORM)
+	require File.expand_path(File.join(File.dirname(__FILE__), 'x11'))
+
+	# Linux/X11 implementation of WinClicker.
+	# Not all functionality is present because of the differences between X11
+	#   and Win32.
+	class WinClicker
+
+		def clickJavaScriptDialog(button="OK")
+			click_window_button(/The page/,button)
+		end
+
+		def clickJSDialog_Thread(button="OK")
+			puts "clickJSDialog_Thread Starting waiting..."
+			sleep 3
+			puts " clickJSDialog_Thread ... resuming"
+			n = 0
+			while n < 3
+				sleep 1
+				click_window_button(/The page/,button)
+			end
+		end
+
+		def clearSecurityAlertBox
+			click_window_button(/Unknown Authority/, "OK")
+			click_window_button(/Domain Name Mismatch/, "Cancel")
+		end
+
+		def clickWindowsButton(title, button, maxWaitTime=30)
+			start = Time.now
+			w = window_by_title(title)
+			until w || (Time.now - start > maxWaitTime)
+				sleep(2) # Window search is pretty CPU intensive, so relax the requirement
+				w = window_by_title(title)
+			end
+			unless w
+				puts "clickWindowsButton: Cant make window active in specified time ( " + maxWaitTime.to_s + ") - no handle"
+				return false
+			end
+			click_button(w,button)
+		end
+
+	private
+
+		# Since it's impossible to read the button text in X11 windows,
+		#   we have to specify keystrokes for the button names given the title.
+		# TODO: A more elegant solution, or expand this list (to fill out popup text boxes for basic HTTP auth, perhaps).
+		@@window_keys = [
+			[/Unknown Authority/i, {'ok' => [:enter], 'cancel' => [:tab,:tab,:tab,:enter]}],
+			[/Domain Name Mismatch/i, {'ok' => [:tab, :enter], 'cancel' => [:enter]}],
+			[/Opening/i, {'ok' => [:sleep,:enter], 'cancel' => [:tab,:tab,:tab,:enter]}],
+			[/The page at .* says/i, {'ok' => [:enter], 'cancel' => [:tab,:enter]}]
+		]
+
+		# Collection of all current firefox windows
+		def firefox_windows(w = nil)
+			collection = []
+			windows = nil
+			if w
+				windows = [w]
+			else
+				windows = X11::Display.instance.screens.collect{|s| s.root_window}
+			end
+			windows.each do |window|
+				if window.class == 'Gecko'
+					collection << window
+				end
+				window.children.each do |c|
+					collection << firefox_windows(c)
+				end
+			end
+			return collection.flatten.compact
+		end
+
+		def window_by_title(title,windows=nil)
+			pattern = nil
+			if title.is_a?(Regexp)
+				pattern = title
+			else
+				pattern = Regexp.compile(title,Regexp::IGNORECASE)
+			end
+			windows ||= X11::Display.instance.screens.collect{|s| s.root_window}
+			if window = windows.find{|w| w.class == 'Gecko' && pattern.match(w.name)}
+				return window
+			else
+				children = windows.reject{|w| w.class == 'Gecko'}.collect{|w| w.children}.flatten.compact
+				if children.length > 0
+					return window_by_title(pattern,children)
+				end
+			end
+			return nil
+		end
+
+		def keystrokes(window,button) 
+			keys = @@window_keys.find{|wk| wk.first.match(window.name)}
+			if keys
+				return keys.last[button.downcase]
+			else
+				return false
+			end
+		end
+
+		def click_button(window, button)
+			keys = nil
+			if button.is_a?(Symbol)
+				keys = [button]
+			else
+				keys = keystrokes(window,button)
+			end
+			return unless keys
+			keys.each do |key|
+				if key == :sleep
+					@sleep_next = 1
+					next
+				end
+				window.send_key(key,@sleep_next)
+				@sleep_next = nil
+			end
+		end
+
+	end
+end

data/firewatir/x11.rb

@@ -0,0 +1,192 @@
+require 'dl/import'
+require 'dl/struct'
+
+require 'singleton'
+
+module X11
+	class << self
+		include X11 # Do this so we can call imported libraries directly on X11
+	end
+
+	# Load the X11 library
+	extend DL::Importable
+	dlload "libX11.so" 
+	
+	# Import necessary functions from X11 here.
+	import("XOpenDisplay", "unsigned long", ["char*"])
+	import("XScreenCount", "int", ["unsigned long"])
+	import("XRootWindow", "unsigned long", ["unsigned long","int"])
+
+	import("XFree", "int", ["void*"])
+
+	import("XFetchName", "int", ["unsigned long","unsigned long","char**"])
+	import("XGetClassHint", "int", ["unsigned long","unsigned long","void*"])
+	import("XQueryTree", "int", ["unsigned long","unsigned long","unsigned long*","unsigned long*","unsigned long**","unsigned int*"])
+
+	import("XSetInputFocus", "int", ["unsigned long","unsigned long","int","long"])
+	import("XSendEvent", "int", ["unsigned long","unsigned long","int","long","void*"])
+	import("XFlush", "int", ["unsigned long"])
+
+	# Structs we will use in API calls.
+	# Pointer structs are necessary when the API uses a pointer parameter for a return value.
+	ULPPointer = struct [
+		"long* value"
+	]
+	ULPointer = struct [
+		"long value"
+	]
+	CPPointer = struct [
+		"char* value"
+	]
+	UIPointer = struct [
+		"int value"
+	]
+	# Info about window class
+	XClassHint = struct [
+		"char* res_name",
+		"char* res_class"
+	]
+	# Event struct for key presses
+	XKeyEvent = struct [
+		"int type",
+		"long serial",
+		"int send_event",
+		"long display",
+		"long window",
+		"long root",
+		"long subwindow",
+		"long time",
+		"int x",
+		"int y",
+		"int x_root",
+		"int y_root",
+		"int state",
+		"int keycode",
+		"int same_screen"
+	]
+
+	# End of library imports.
+
+	# X11 Display. Singleton -- assumes single display.
+	# Assumes the current display is the same as the one running FireFox.
+	# Represented by memory pointer (which we treat in-code as an unsigned long).
+	class Display
+		include Singleton
+
+		def initialize
+			@xdisplay = X11.xOpenDisplay("");
+		end
+
+		# Array of screens associated with this display.
+		def screens
+			nScreens = X11.xScreenCount(@xdisplay);
+			(0...nScreens).collect{|n| Screen.new(n,@xdisplay)}
+		end
+	end
+
+	# A display screen, for multi-monitor displays like mine ;-)
+	# Represented by display pointer and screen number.
+	class Screen
+		def initialize(screen_num,xdisplay)
+			@screen_num = screen_num
+			@xdisplay = xdisplay
+		end
+
+		# Root window containing all other windows in this screen.
+		def root_window
+			Window.new(X11.xRootWindow(@xdisplay,@screen_num),@screen_num,@xdisplay)
+		end
+	end
+
+	# An X11 Window (toplevel window, widget, applet, etc.)
+	# Represented by its XID, an unsigned long.
+	class Window
+		attr_reader :xid, :name, :class, :hint, :parent
+
+		def initialize(xid,screen_num,xdisplay,parent=nil)
+			@xid = xid
+			@screen_num = screen_num
+			@xdisplay = xdisplay
+			@parent = parent
+			load_standard
+		end
+
+		# Child windows
+		def children
+			tree[:children].collect{|c| Window.new(c,@screen_num,@xdisplay,self)}
+		end
+
+		# XID of parent window
+		def parent_xid
+			parent ? parent.xid : nil
+		end
+
+		# Send a key press to this window
+		def send_key(key=:enter,sleep=nil)
+			# TODO expand this list out, add support for shift, etc.
+			@@keys = {:enter => 36, :tab => 23} unless defined?@@keys
+			keycode = @@keys[key]
+			X11.xSetInputFocus(@xdisplay, @xid, 1, 0)
+			sleep(sleep) if sleep
+			e = create_key_event
+			e.keycode = keycode
+			e.type = 2 # press
+			X11.xSendEvent(@xdisplay,@xid,1,1,e)
+			e.type = 3 # release
+			X11.xSendEvent(@xdisplay,@xid,1,2,e)
+			X11.xFlush(@xdisplay)
+		end
+
+		private
+
+		# Retrieve this window's portion of the window tree
+		# Includes display root, parent, and children
+		def tree
+			tree = {:children => [], :parent => 0, :root => 0}
+			children = ULPPointer.malloc
+			root = ULPointer.malloc
+			parent = ULPointer.malloc
+			n = UIPointer.malloc
+			r=X11.xQueryTree(@xdisplay,@xid,root,parent,children,n)
+			tree[:parent] = parent.value
+			tree[:root] = root.value
+			tree[:children] = children.value.to_s(4*n.value).unpack("L*") if children.value
+			tree
+		end
+
+		# Load some standard attributes (name and class)
+		def load_standard
+			name = CPPointer.malloc
+			if X11.xFetchName(@xdisplay,@xid,name) != 0
+				@name = name.value.to_s
+				X11.xFree name.value
+			end
+			classHint = XClassHint.malloc
+			res = X11.xGetClassHint(@xdisplay,@xid,classHint)
+			if res != 0 then
+				@class = classHint.res_name.to_s
+				@hint = classHint.res_class.to_s
+				X11.xFree classHint.res_name
+				X11.xFree classHint.res_class
+			end
+		end
+
+		# Create an X11 Key Event for this window and set defaults
+		def create_key_event
+			ke = XKeyEvent.malloc
+			ke.serial = 0
+			ke.send_event = 1
+			ke.display = @xdisplay
+			ke.window = @xid
+			ke.subwindow = 0
+			ke.root = tree[:root]
+			ke.time = Time.now.sec
+			ke.state = 0
+			ke.same_screen = 0
+			return ke
+		end
+
+	end
+
+end
+