require 'akephalos/configuration' if RUBY_PLATFORM != "java" require 'akephalos/remote_client' Akephalos::Client = Akephalos::RemoteClient else require 'akephalos/htmlunit' require 'akephalos/htmlunit/ext/http_method' require 'akephalos/htmlunit/ext/confirm_handler' require 'akephalos/page' require 'akephalos/node' require 'akephalos/client/cookies' require 'akephalos/client/filter' module Akephalos # Akephalos::Client wraps HtmlUnit's WebClient class. It is the main entry # point for all interaction with the browser, exposing its current page and # allowing navigation. class Client # @return [Akephalos::Page] the current page attr_reader :page # @return [HtmlUnit::BrowserVersion] the configured browser version attr_reader :browser_version # @return [true/false] whether to raise errors on javascript failures attr_reader :validate_scripts # @return [true/false] whether to ignore insecure ssl certificates attr_reader :use_insecure_ssl # @return ["trace" / "debug" / "info" / "warn" / "error" or "fatal"] which points the htmlunit log level attr_reader :htmlunit_log_level # The default configuration options for a new Client. DEFAULT_OPTIONS = { :browser => :firefox_3_6, :validate_scripts => true, :use_insecure_ssl => false, :htmlunit_log_level => 'fatal' } # Map of browser version symbols to their HtmlUnit::BrowserVersion # instances. BROWSER_VERSIONS = { :ie6 => HtmlUnit::BrowserVersion::INTERNET_EXPLORER_6, :ie7 => HtmlUnit::BrowserVersion::INTERNET_EXPLORER_7, :ie8 => HtmlUnit::BrowserVersion::INTERNET_EXPLORER_8, :firefox_3_6 => HtmlUnit::BrowserVersion::FIREFOX_3_6 } # @param [Hash] options the configuration options for this client # # @option options [Symbol] :browser (:firefox_3_6) the browser version ( # see BROWSER_VERSIONS) # # @option options [true, false] :validate_scripts (true) whether to raise # errors on javascript errors def initialize(options = {}) process_options!(options) @_client = java.util.concurrent.FutureTask.new do if @http_proxy.nil? or @http_proxy_port.nil? client = HtmlUnit::WebClient.new(browser_version) else client = HtmlUnit::WebClient.new(browser_version, @http_proxy, @http_proxy_port) end client.setThrowExceptionOnFailingStatusCode(false) client.setAjaxController(HtmlUnit::NicelyResynchronizingAjaxController.new) client.setCssErrorHandler(HtmlUnit::SilentCssErrorHandler.new) client.setThrowExceptionOnScriptError(validate_scripts) client.setUseInsecureSSL(use_insecure_ssl) client.setRefreshHandler(HtmlUnit::WaitingRefreshHandler.new) Filter.new(client) client end Thread.new { @_client.run } end # Visit the requested URL and return the page. # # @param [String] url the URL to load # @return [Page] the loaded page def visit(url) client.getPage(url) page end # @return [Cookies] the cookies for this session def cookies @cookies ||= Cookies.new(client.getCookieManager) end # @return [String] the current user agent string def user_agent @user_agent || client.getBrowserVersion.getUserAgent end # Set the User-Agent header for this session. If :default is given, the # User-Agent header will be reset to the default browser's user agent. # # @param [:default] user_agent the default user agent # @param [String] user_agent the user agent string to use def user_agent=(user_agent) if user_agent == :default @user_agent = nil client.removeRequestHeader("User-Agent") else @user_agent = user_agent client.addRequestHeader("User-Agent", user_agent) end end # @return [Page] the current page def page self.page = client.getCurrentWindow.getTopWindow.getEnclosedPage @page end # Update the current page. # # @param [HtmlUnit::HtmlPage] _page the new page # @return [Page] the new page def page=(_page) if @page != _page @page = Page.new(_page) end @page end # @return [true, false] whether javascript errors will raise exceptions def validate_scripts? !!validate_scripts end # @return [true, false] whether to ignore insecure ssl certificates def use_insecure_ssl? !!use_insecure_ssl end # Merges the DEFAULT_OPTIONS with those provided to initialize the Client # state, namely, its browser version, whether it should # validate scripts, and htmlunit log level. # # @param [Hash] options the options to process def process_options!(options) options = DEFAULT_OPTIONS.merge(options) @browser_version = BROWSER_VERSIONS.fetch(options.delete(:browser)) @validate_scripts = options.delete(:validate_scripts) @use_insecure_ssl = options.delete(:use_insecure_ssl) @htmlunit_log_level = options.delete(:htmlunit_log_level) @http_proxy = options.delete(:http_proxy) @http_proxy_port = options.delete(:http_proxy_port) java.lang.System.setProperty("org.apache.commons.logging.simplelog.defaultlog", @htmlunit_log_level) end # Confirm or cancel the dialog, returning the text of the dialog def confirm_dialog(confirm = true, &block) handler = HtmlUnit::ConfirmHandler.new handler.handleConfirmValue = confirm client.setConfirmHandler(handler) yield if block_given? return handler.text end def close_all_windows() @client.closeAllWindows() end private # Call the future set up in #initialize and return the WebCLient # instance. # # @return [HtmlUnit::WebClient] the WebClient instance def client @client ||= @_client.get.tap do |client| client.getCurrentWindow.getHistory.ignoreNewPages_.set(true) end end end end end