Class: Selenium::WebDriver::Firefox::Profile

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 50

def from_name(name)
  profile = ini[name]
  return profile if profile

  raise Error::WebDriverError, "unable to find profile named: #{name.inspect}"
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 46

def ini
  @ini ||= ProfilesIni.new
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 42

attr_reader :name, :log_file

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 116

def log_file=(file)
  @log_file = file
  self[WEBDRIVER_PREFS[:log_file]] = file
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 42

attr_reader :name, :log_file

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 112

def port=(port)
  self[WEBDRIVER_PREFS[:port]] = port
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 129

def proxy=(proxy)
  raise TypeError, "expected #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}" unless proxy.is_a? Proxy

  case proxy.type
  when :manual
    self['network.proxy.type'] = 1

    set_manual_proxy_preference 'ftp', proxy.ftp
    set_manual_proxy_preference 'http', proxy.http
    set_manual_proxy_preference 'ssl', proxy.ssl
    set_manual_proxy_preference 'socks', proxy.socks

    self['network.proxy.no_proxies_on'] = proxy.no_proxy || ''
  when :pac
    self['network.proxy.type'] = 2
    self['network.proxy.autoconfig_url'] = proxy.pac
  when :auto_detect
    self['network.proxy.type'] = 4
  else
    raise ArgumentError, "unsupported proxy type #{proxy.type}"
  end
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 43

attr_writer :secure_ssl, :load_no_focus_lib

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 125

def add_extension(path, name = extension_name_for(path))
  @extensions[name] = Extension.new(path)
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 152

alias as_json encoded

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 180

def delete_extensions_cache(directory)
  FileUtils.rm_f File.join(directory, 'extensions.cache')
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 184

def delete_lock_files(directory)
  LOCK_FILES.each do |name|
    FileUtils.rm_f File.join(directory, name)
  end
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 190

def extension_name_for(path)
  File.basename(path, File.extname(path))
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 165

def install_extensions(directory)
  destination = File.join(directory, 'extensions')

  @extensions.each do |name, extension|
    WebDriver.logger.debug({extension: name}.inspect, id: :firefox_profile)
    extension.write_to(destination)
  end
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 81

def layout_on_disk
  profile_dir = @model ? create_tmp_copy(@model) : Dir.mktmpdir('webdriver-profile')
  FileReaper << profile_dir

  install_extensions(profile_dir)
  delete_lock_files(profile_dir)
  delete_extensions_cache(profile_dir)
  update_user_prefs_in(profile_dir)

  profile_dir
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 174

def read_model_prefs
  return {} unless @model

  read_user_prefs(File.join(@model, 'user.js'))
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 206

def read_user_prefs(path)
  prefs = {}
  return prefs unless File.exist?(path)

  File.read(path).split("\n").each do |line|
    next unless line =~ /user_pref\("([^"])"\s*,\s*(.?)\);/

    key = Regexp.last_match(1)&.strip
    value = Regexp.last_match(2)&.strip

    # wrap the value in an array to make it a valid JSON string.
    prefs[key] = JSON.parse("[#{value}]").first
  end

  prefs
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 156

def set_manual_proxy_preference(key, value)
  return unless value

  host, port = value.to_s.split(':', 2)

  self["network.proxy.#{key}"] = host
  self["network.proxy.#{key}_port"] = Integer(port) if port
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 194

def update_user_prefs_in(directory)
  path = File.join(directory, 'user.js')
  prefs = read_user_prefs(path)
  prefs.merge! self.class::DEFAULT_PREFERENCES
  prefs.merge!(@additional_prefs)

  # If the user sets the home page, we should also start up there
  prefs['startup.homepage_welcome_url'] ||= prefs['browser.startup.homepage']

  write_prefs prefs, path
end

# File 'rb/lib/selenium/webdriver/firefox/profile.rb', line 223

def write_prefs(prefs, path)
  File.open(path, 'w') do |file|
    prefs.each do |key, value|
      file.puts %{user_pref("#{key}", #{value.to_json});}
    end
  end
end