RWebSpec::Driver

# File lib/rwebspec/driver.rb, line 507
def absolutify_url(src, base_url, parent_url)
  if src.nil? || src.empty? || src == "//:" || src =~ /\s*http:\/\//
    return src
  end

  return "#{base_url}#{src}" if src =~ /^\s*\//
  return "#{parent_url}#{src}" if parent_url
  return src
end

# File lib/rwebspec/driver.rb, line 472
def absolutize_page_hpricot(content, base_url, parent_url)
  return absolutize_page(content, base_url, parent_url) if RUBY_PLATFORM == 'java'
  begin
    require 'hpricot'
    doc = Hpricot(content)
    base_url.slice!(-1) if ends_with?(base_url, "/")
    (doc/'link').each { |e| e['href'] = absolutify_url(e['href'], base_url, parent_url) || "" }
    (doc/'img').each { |e| e['src'] = absolutify_url(e['src'], base_url, parent_url) || "" }
    (doc/'script').each { |e| e['src'] = absolutify_url(e['src'], base_url, parent_url) || "" }
    return doc.to_html
  rescue => e
    absolutize_page(content, base_url, parent_url)
  end
end

# File lib/rwebspec/driver.rb, line 487
    def absolutize_page_nokogiri(content, base_url, parent_url)
  return absolutize_page(content, base_url, parent_url) if RUBY_PLATFORM == 'java'
  begin
    require 'nokogiri'
    doc = Nokogiri::HTML(content)
    base_url.slice!(-1) if ends_with?(base_url, "/")
    (doc/'link').each { |e| e['href'] = absolutify_url(e['href'], base_url, parent_url) || "" }
    (doc/'img').each { |e| e['src'] = absolutify_url(e['src'], base_url, parent_url) || "" }
    (doc/'script').each { |e| e['src'] = absolutify_url(e['src'], base_url, parent_url) || "" }
    return doc.to_html
  rescue => e
    absolutize_page(content, base_url, parent_url)
  end
end

# File lib/rwebspec/driver.rb, line 700
def ajax_wait_for_element(element_id, seconds, status='show', check_interval = @@default_polling_interval)
  count = 0
  check_interval = 1 if check_interval < 1 or check_interval > seconds
  while count < (seconds / check_interval) do
    search_indicator = @web_browser.element_by_id(element_id)
    search_indicator_outer_html = search_indicator.outerHtml if search_indicator
    if status == 'hide'
      return true if search_indicator_outer_html and !search_indicator_outer_html.include?('style="DISPLAY: none"')
    else
      return true if search_indicator_outer_html and search_indicator_outer_html.include?('style="DISPLAY: none"')
    end
    sleep check_interval if check_interval > 0 and check_interval < 5 * 60 # wait max 5 minutes
    count += 1
  end
  return false
end

# File lib/rwebspec/driver.rb, line 649
def allow(& block)
  yield
end

# File lib/rwebspec/driver.rb, line 213
def attach_browser(how, what, options = {})
  options.merge!(:browser => is_firefox? ? "Firefox" : "IE") unless options[:browser]
  begin
    options.merge!(:base_url => browser.context.base_url)
  rescue => e
    puts "failed to set base_url, ignore : #{e}"
  end
  WebBrowser.attach_browser(how, what, options)
end

# File lib/rwebspec/driver.rb, line 192
def background_visit(url, opts = {})
  require 'httpclient'
  begin
    client = HTTPClient.new
    if url && url =~ /^http/
        http_response = client.get(url).body
    else
        base_url = $ITEST2_PROJECT_BASE_URL || $BASE_URL
        http_response = client.get("#{base_url}#{url}").body
    end
                            
                            http_response = http_response.content if http_response.respond_to?("content")
  rescue => e
    raise e
  end
end

# File lib/rwebspec/driver.rb, line 966
def basic_authentication(username, password, options = {})
  if is_celerity?
    basic_authentication_celerity(username, password)
  elsif is_firefox?
    basic_authentication_firefox(username, password)
  else
    basic_authentication_ie(options[:title], username, password, options)
  end
end

# File lib/rwebspec/driver.rb, line 962
def basic_authentication_celerity(username, password)
  @web_browser.celerity.credentials = "#{username}:#{password}"
end

# File lib/rwebspec/driver.rb, line 937
def basic_authentication_firefox(username, password, wait = 3)
  jssh_command = "
var length = getWindows().length;
var win;
var found = false;
for (var i = 0; i < length; i++) {
  win = getWindows()[i];
  if(win.document.title == \"Authentication Required\") {
    found = true;
    break;
  }
}
if (found) {
  var jsdocument = win.document;
  var dialog = jsdocument.getElementsByTagName(\"dialog\")[0];
  jsdocument.getElementsByTagName(\"textbox\")[0].value = \"#{username}\";
  jsdocument.getElementsByTagName(\"textbox\")[1].value = \"#{password}\";
  dialog.getButton(\"accept\").click();
}
\n"
  sleep(wait)
  $jssh_socket.send(jssh_command, 0)
  # read_socket()
end

# File lib/rwebspec/driver.rb, line 914
def basic_authentication_ie(title, username, password, options = {})
  default_options = {:textctrl_username => "Edit2",
                     :textctrl_password => "Edit3",
                     :button_ok => 'Button1'
  }

  options = default_options.merge(options)

  title ||= ""      
  if title =~ /^Connect\sto/
    full_title = title
  else
    full_title = "Connect to #{title}"
  end
  require 'rformspec'
  login_win = RFormSpec::Window.new(full_title)
  login_win.send_control_text(options[:textctrl_username], username)
  login_win.send_control_text(options[:textctrl_password], password)
  login_win.click_button("OK")
end

# File lib/rwebspec/driver.rb, line 140
def begin_at(url)
  dump_caller_stack
  @web_browser.begin_at(url)
end

# File lib/rwebspec/driver.rb, line 84
def browser
  @web_browser
end

# File lib/rwebspec/driver.rb, line 578
def cell_with_id(cell_id, options = {})
  if options && options[:index] then
    cell(:id => cell_id.to_s, :index => options[:index]).text
  else
    cell(:id, cell_id).text
  end
end

# File lib/rwebspec/driver.rb, line 892
def check_ie_version
  if is_windows? && @ie_version.nil?
    begin
      cmd = 'reg query "HKLM\SOFTWARE\Microsoft\Internet Explorer" /v Version';
      result = `#{cmd}`
      version_line = nil
      result.each do |line|
        if (line =~ /Version\s+REG_SZ\s+([\d\.]+)/)
          version_line = $1
        end
      end

      if version_line =~ /^\s*(\d+)\./
        @ie_version = $1.to_i
      end
    rescue => e
    end
  end
end

# File lib/rwebspec/driver.rb, line 886
def choose_file_dialog(file_path)
  Watir.autoit.WinWaitActive("Choose File to Upload", '', 10)
  Watir.autoit.ControlSetText("Choose File to Upload", "", 1148, file_path)
  Watir.autoit.ControlClick("Choose File to Upload", "", "&Open")
end

# File lib/rwebspec/driver.rb, line 845
def clear_popup(popup_win_title, seconds = 10, yes = true)
  # commonly "Security Alert", "Security Information"
  if is_windows?
    sleep 1
    autoit = WIN32OLE.new('AutoItX3.Control')
    # Look for window with given title. Give up after 1 second.
    ret = autoit.WinWait(popup_win_title, '', seconds)
    #
    # If window found, send appropriate keystroke (e.g. {enter}, {Y}, {N}).
    if ret == 1 then
      puts "about to send click Yes" if debugging?
      button_id = yes ? "Button1" : "Button2" # Yes or No
      autoit.ControlClick(popup_win_title, '', button_id)
    end
    sleep(0.5)
  else
    raise "Currently supported only on Windows"
  end
end

# File lib/rwebspec/driver.rb, line 359
def click_button_with_image_src_contains(image_filename)
  perform_operation {
    found = nil
    raise "no buttons in this page" if buttons.length <= 0
    buttons.each { |btn|
      if btn && btn.src && btn.src.include?(image_filename) then
        found = btn
        break
      end
    }
    raise "not image button with src: #{image_filename} found" if found.nil?
    found.click
  }
end

# File lib/rwebspec/driver.rb, line 106
def close_all_browsers
                    if @web_browser
          if is_firefox?
            FireWatir::Firefox.close_all
          else
            Watir::IE.close_all
          end
                    else
                            browser_type = $ITEST2_BROWSER ? $ITEST2_BROWSER.downcase.to_sym : :ie      
          WebBrowser.close_all_browsers(browser_type)                              
                    end
end

# File lib/rwebspec/driver.rb, line 92
def close_browser
  if @web_browser
    # Old TestWise version
    # @web_browser.close_browser unless $ITEST2_LEAVE_BROWSER_OPEN_AFTER_RUN
    @web_browser.close_browser
  else
                            close_all_browsers
  end
end

# File lib/rwebspec/driver.rb, line 349
def contains(str)
  ContainsText.new(str)
end

# File lib/rwebspec/driver.rb, line 342
def contains_text(text)
  @web_browser.contains_text(text)
end

# File lib/rwebspec/driver.rb, line 132
def context
  @web_browser.context
end

# File lib/rwebspec/driver.rb, line 399
def default_dump_dir
  if $ITEST2_RUNNING_SPEC_ID && $ITEST2_WORKING_DIR

    $ITEST2_DUMP_DIR = File.join($ITEST2_WORKING_DIR, "dump")
    FileUtils.mkdir($ITEST2_DUMP_DIR) unless File.exists?($ITEST2_DUMP_DIR)

    spec_run_id = $ITEST2_RUNNING_SPEC_ID
    spec_run_dir_name = spec_run_id.to_s.rjust(4, "0") unless spec_run_id == "unknown"
    to_dir = File.join($ITEST2_DUMP_DIR, spec_run_dir_name)
  else
    to_dir = ENV['TEMP_DIR'] || (is_windows? ? "C:\\temp" : "/tmp")
  end
end

# File lib/rwebspec/driver.rb, line 395
def dump_response(stream = nil)
  @web_browser.dump_response(stream)
end

# File lib/rwebspec/driver.rb, line 388
def element_by_id(elem_id)
  @web_browser.element_by_id(elem_id)
end

# File lib/rwebspec/driver.rb, line 382
def element_text(elem_id)
  @web_browser.element_value(elem_id)
end

# File lib/rwebspec/driver.rb, line 529
def ends_with?(str, suffix)
  suffix = suffix.to_s
  str[-suffix.length, suffix.length] == suffix
end

# File lib/rwebspec/driver.rb, line 326
def enter_text_with_id(textfield_id, value)
  perform_operation { text_field(:id, textfield_id).set(value) }
end

# File lib/rwebspec/driver.rb, line 124
def expect_page(page_clazz, argument = nil)
  if argument
    @web_browser.expect_page(page_clazz, argument)
  else
    @web_browser.expect_page(page_clazz)
  end
end

# File lib/rwebspec/driver.rb, line 660
def failsafe(& block)
  begin
    yield
  rescue =>e
  end
end

# File lib/rwebspec/driver.rb, line 153
def firefox
  @web_browser.firefox
end

# File lib/rwebspec/driver.rb, line 170
def goto_page(page)
  perform_operation {
    @web_browser.goto_page(page) if @web_browser
  }
end

# File lib/rwebspec/driver.rb, line 182
def goto_url(url)
  @web_browser.goto_url url
end

# File lib/rwebspec/driver.rb, line 147
def ie
  @web_browser.ie
end

# File lib/rwebspec/driver.rb, line 161
def is_celerity? 
  RUBY_PLATFORM =~ /java/ && @web_browser
end

# File lib/rwebspec/driver.rb, line 157
def is_firefox?
  @web_browser.is_firefox? if @web_browser
end

# File lib/rwebspec/driver.rb, line 597
def is_linux?
  RUBY_PLATFORM.downcase.include?("linux")
end

# File lib/rwebspec/driver.rb, line 589
def is_mac?
  RUBY_PLATFORM.downcase.include?("darwin")
end

# File lib/rwebspec/driver.rb, line 593
def is_windows?
  RUBY_PLATFORM.downcase.include?("mswin") or RUBY_PLATFORM.downcase.include?("mingw")
end

# File lib/rwebspec/driver.rb, line 866
def javascript_dialog
        @web_browser.javascript_dialog
end

# File lib/rwebspec/driver.rb, line 554
def label_with_id(label_id, options = {})
  if options && options[:index] then
    label(:id => label_id.to_s, :index => options[:index]).text
  else
    label(:id, label_id.to_s).text
  end
end

# File lib/rwebspec/driver.rb, line 376
def new_popup_window(options)
  @web_browser.new_popup_window(options)
end

# File lib/rwebspec/driver.rb, line 625
def on(page, & block)
  yield page
end

# File lib/rwebspec/driver.rb, line 36
def open_browser(base_url = nil, options = {})

  begin
    support_unicode
  rescue => e
    puts "Unicode may not work in IE, #{e}"
  end

  base_url ||= $ITEST2_PROJECT_BASE_URL
  base_url ||= $BASE_URL
  raise "base_url must be set" if base_url.nil?

  default_options = {:speed => "fast",
                     :visible => true,
                     :highlight_colour => 'yellow',
                     :close_others => true,
                     :start_new => false, # start a new browser always
                     :go => true}

  options = default_options.merge options
  options[:firefox] = true if "Firefox" == $ITEST2_BROWSER || "Firefox" == $BROWSER
  ($ITEST2_HIDE_BROWSER) ? $HIDE_IE = true : $HIDE_IE = false

  if base_url =~ /^file:/
    uri_base = base_url
  else
    uri = URI.parse(base_url)
    uri_base = "#{uri.scheme}://#{uri.host}:#{uri.port}"
  end

  if options[:start_new] || $celerity_loaded
    @web_browser = WebBrowser.new(uri_base, nil, options)
  else
    @web_browser = WebBrowser.reuse(uri_base, options) # Reuse existing browser
  end

  if base_url =~ /^file:/
    goto_url(base_url) # for files, no base url
  else
    (uri.path.length == 0) ? begin_at("/") : begin_at(uri.path) if options[:go]
  end

  return @web_browser
end

# File lib/rwebspec/driver.rb, line 540
def page_source
  @web_browser.page_source
end

# File lib/rwebspec/driver.rb, line 545
def page_text
  @web_browser.text
end

# File lib/rwebspec/driver.rb, line 535
def page_title
  @web_browser.page_title
end

# File lib/rwebspec/driver.rb, line 330
def perform_operation(& block)
  begin
    dump_caller_stack
    operation_delay
    yield
  rescue RuntimeError => re
    raise re
    #      ensure
    #        puts "[DEBUG] ensure #{perform_ok}" unless perform_ok
  end
end

# File lib/rwebspec/driver.rb, line 770
def repeat_try(num_tries = @@default_timeout || 30, interval = @@default_polling_interval || 1, & block)
  num_tries ||= 1
  (num_tries - 1).times do |num|
    begin
      yield
      return
    rescue => e
      # puts "debug: #{num} failed: #{e}"
      sleep interval
    end
  end

  # last try, throw error if still fails
  begin
    yield
  rescue => e
    raise e.to_s + " after trying #{num_tries} times every #{interval} seconds"
  end
  yield
end

# File lib/rwebspec/driver.rb, line 416
def save_current_page(options = {})
  default_options = {:replacement => true}
  options = default_options.merge(options)
  to_dir = options[:dir] || default_dump_dir

  if options[:filename]
    file_name = options[:filename]
  else
    file_name = Time.now.strftime("%m%d%H%M%S") + ".html"
  end

  Dir.mkdir(to_dir) unless File.exists?(to_dir)
  file = File.join(to_dir, file_name)

  content = page_source
  base_url = @web_browser.context.base_url
  current_url = @web_browser.url
  current_url =~ /(.*\/).*$/
  current_url_parent = $1
  if options[:replacement] && base_url =~ /^http:/
    File.new(file, "w").puts absolutize_page_nokogiri(content, base_url, current_url_parent)
  else
    File.new(file, "w").puts content
  end

end

# File lib/rwebspec/driver.rb, line 870
def select_file_for_upload(file_field_name, file_path)
  if is_windows?
    normalized_file_path = file_path.gsub("/", "\\")
    if $support_ie8 && check_ie_version && @ie_version >= 8
      # puts "IE8"
      file_field(:name, file_field).set(normalized_file_path)
      # choose_file_dialog(normalized_file_path)
    else
      file_field(:name, file_field).set(normalized_file_path)
    end
  else
    # for firefox, just call file_field, it may fail
    file_field(:name, file_field).set(normalized_file_path)
  end
end

# File lib/rwebspec/driver.rb, line 633
def shall_not_allow(& block)
  operation_performed_ok = false
  begin
    yield
    operation_performed_ok = true
  rescue
  end
  raise "Operation shall not be allowed" if operation_performed_ok
end

# File lib/rwebspec/driver.rb, line 566
def span_with_id(span_id, options = {})
  if options && options[:index] then
    span(:id => span_id.to_s, :index => options[:index]).text
  else
    span(:id, span_id).text
  end
end

# File lib/rwebspec/driver.rb, line 518
def substitute_relative_path_in_src_line(line, script_src, host_url, page_parent_url)
  unless script_src =~ /^["']?http:/
    host_url.slice!(-1) if ends_with?(host_url, "/")
    if script_src =~ /^\s*\// # absolute_path
      line.gsub!(script_src, "#{host_url}#{script_src}")
    else #relative_path
      line.gsub!(script_src, "#{page_parent_url}#{script_src}")
    end
  end
end

# File lib/rwebspec/driver.rb, line 605
def support_utf8
  if is_windows?
    require 'win32ole'
    WIN32OLE.codepage = WIN32OLE::CP_UTF8
  end
end

# File lib/rwebspec/driver.rb, line 822
def symbol_to_sequence(symb)
  value = {:zero => 0,
           :first => 1,
           :second => 2,
           :third => 3,
           :fourth => 4,
           :fifth => 5,
           :sixth => 6,
           :seventh => 7,
           :eighth => 8,
           :ninth => 9,
           :tenth => 10}[symb]
  return value || symb.to_i
end

# File lib/rwebspec/driver.rb, line 1001
def take_screenshot
  # puts "calling new take screenshot"
  if $testwise_screenshot_supported && is_windows?
    # puts "testwise supported: #{$testwise_screenshot_supported}"
    begin
      screenshot_image_filename =  "screenshot_" + Time.now.strftime("%m%d%H%M%S") + ".jpg"
      the_dump_dir = default_dump_dir
      FileUtils.mkdir_p(the_dump_dir) unless File.exists?(the_dump_dir)
      screenshot_image_filepath = File.join(the_dump_dir, screenshot_image_filename)
      screenshot_image_filepath.gsub!("/", "\\") if is_windows?

      FileUtils.rm_f(screenshot_image_filepath) if File.exist?(screenshot_image_filepath)

      if is_firefox? then
        Win32::Screenshot::Take.of(:window, :title => /mozilla\sfirefox/).write(screenshot_image_filepath)                                 
                                    elsif ie
        Win32::Screenshot::Take.of(:window, :title => /internet\sexplorer/).write(screenshot_image_filepath)                                       
      else
        Win32::Screenshot::Take.of(:foreground).write(screenshot_image_filepath)
      end
      notify_screenshot_location(screenshot_image_filepath)
    rescue => e
      puts "error on taking screenshot: #{e}"
    end
  end
end

# File lib/rwebspec/driver.rb, line 978
def take_screenshot_old
  if is_windows? && $ITEST2_DUMP_PAGE
    begin
      puts "[DEBUG] Capturing screenshots..."
      screenshot_image_filename =  "rwebspec_" + Time.now.strftime("%m%d%H%M%S") + ".jpg"
      the_dump_dir = default_dump_dir
      FileUtils.mkdir_p(the_dump_dir) unless File.exists?(the_dump_dir)
      screenshot_image_filepath = File.join(the_dump_dir, screenshot_image_filename)

      screenshot_image_filepath.gsub!("/", "\\") if is_windows?
      screen_capture(screenshot_image_filepath, true)

      notify_screenshot_location(screenshot_image_filepath)
    rescue
      puts "error: #{Failed to capture screen}"
    end
  end
end

# File lib/rwebspec/driver.rb, line 799
def try(timeout = @@default_timeout, polling_interval = @@default_polling_interval || 1, & block)
  start_time = Time.now

  last_error = nil
  until (duration = Time.now - start_time) > timeout
    begin
      yield
      last_error = nil
                                    return true 
    rescue => e
      last_error = e
    end
    sleep polling_interval
  end

  raise "Timeout after #{duration.to_i} seconds with error: #{last_error}." if last_error
  raise "Timeout after #{duration.to_i} seconds."
end

# File lib/rwebspec/driver.rb, line 227
def use_current_browser(how = :title, what = /.*/)
  @web_browser = WebBrowser.attach_browser(how, what)
end

# File lib/rwebspec/driver.rb, line 720
def wait_for_element(element_id, timeout = @@default_timeout, interval = @@default_polling_interval)
  start_time = Time.now
  #TODO might not work with Firefox
  until @web_browser.element_by_id(element_id) do
    sleep(interval)
    if (Time.now - start_time) > timeout
      raise RuntimeError, "failed to find element: #{element_id} for max #{timeout}"
    end
  end
end

# File lib/rwebspec/driver.rb, line 680
def wait_until(timeout = @@default_timeout || 30, polling_interval = @@default_polling_interval || 1, & block)
  waiter = Watir::Waiter.new(timeout, polling_interval)
  waiter.wait_until { yield }
end