def deploy_firefox(status_queue, browser_params, manager_params, crash_recovery):
""" launches a firefox instance with parameters set by the input dictionary """
root_dir = os.path.dirname(__file__) # directory of this file
logger = loggingclient(*manager_params['logger_address'])
display_pid = None
display_port = None
fp = webdriver.FirefoxProfile()
browser_profile_path = fp.path + '/'
status_queue.put(('STATUS','Profile Created',browser_profile_path))
profile_settings = None # Imported browser settings
if browser_params['profile_tar'] and not crash_recovery:
logger.debug("BROWSER %i: Loading initial browser profile from: %s" % (browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params, browser_params,
browser_params['profile_tar'],
load_flash=browser_params['disable_flash'] is False)
elif browser_params['profile_tar']:
logger.debug("BROWSER %i: Loading recovered browser profile from: %s" % (browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params, browser_params,
browser_params['profile_tar'])
status_queue.put(('STATUS','Profile Tar',None))
if browser_params['random_attributes'] and profile_settings is None:
logger.debug("BROWSER %i: Loading random attributes for browser" % browser_params['crawl_id'])
profile_settings = dict()
# choose a random screen-res from list
resolutions = list()
with open(os.path.join(root_dir, 'screen_resolutions.txt'), 'r') as f:
for line in f:
resolutions.append(tuple(line.strip().split(',')))
profile_settings['screen_res'] = random.choice(resolutions)
# set a random user agent from list
ua_strings = list()
with open(os.path.join(root_dir, 'user_agent_strings.txt'), 'r') as f:
for line in f:
ua_strings.append(line.strip())
profile_settings['ua_string'] = random.choice(ua_strings)
# If profile settings still not set - set defaults
if profile_settings is None:
profile_settings = dict()
profile_settings['screen_res'] = DEFAULT_SCREEN_RES
profile_settings['ua_string'] = None
if profile_settings['ua_string'] is not None:
logger.debug("BROWSER %i: Overriding user agent string with the following: %s" % (browser_params['crawl_id'], profile_settings['ua_string']))
fp.set_preference("general.useragent.override", profile_settings['ua_string'])
if browser_params['headless']:
display = Display(visible=0, size=profile_settings['screen_res'])
display.start()
display_pid = display.pid
display_port = display.cmd_param[5][1:]
status_queue.put(('STATUS','Display',(display_pid, display_port)))
if browser_params['debugging']:
firebug_loc = os.path.join(root_dir, 'firefox_extensions/firebug-1.11.0.xpi')
fp.add_extension(extension=firebug_loc)
fp.set_preference("extensions.firebug.currentVersion", "1.11.0") # Avoid startup screen
if browser_params['extension']['enabled']:
ext_loc = os.path.join(root_dir + "/../", 'Extension/firefox/@openwpm-0.0.1.xpi')
ext_loc = os.path.normpath(ext_loc)
fp.add_extension(extension=ext_loc)
with open(browser_profile_path + 'database_settings.txt', 'w') as f:
host, port = manager_params['aggregator_address']
crawl_id = browser_params['crawl_id']
f.write(host + ',' + str(port) + ',' + str(crawl_id))
f.write(','+str(browser_params['extension']['cookieInstrument']))
f.write(','+str(browser_params['extension']['jsInstrument']))
f.write(','+str(browser_params['extension']['cpInstrument']))
logger.debug("BROWSER %i: OpenWPM Firefox extension loaded" % browser_params['crawl_id'])
if browser_params['proxy']:
PROXY_HOST = "localhost"
PROXY_PORT = browser_params['proxy']
# Direct = 0, Manual = 1, PAC = 2, AUTODETECT = 4, SYSTEM = 5
fp.set_preference("network.proxy.type", 1)
fp.set_preference("network.proxy.http", PROXY_HOST)
fp.set_preference("network.proxy.http_port", PROXY_PORT)
fp.set_preference("network.proxy.ssl", PROXY_HOST) # https sites
fp.set_preference("network.proxy.ssl_port", PROXY_PORT)
# set this to exclude sites from using proxy
# http://kb.mozillazine.org/Network.proxy.no_proxies_on
fp.set_preference("network.proxy.no_proxies_on", "")
# copy the dbs into temp profile
# these were created by manually adding the cert to
# a previous tmp selenium profile
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/key3.db'), fp.path + '/key3.db')
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/cert8.db'), fp.path + '/cert8.db')
# Disable flash
if browser_params['disable_flash']:
fp.set_preference('plugin.state.flash', 0)
# Configure privacy settings
configure_firefox.privacy(browser_params, fp, root_dir, browser_profile_path)
# Set various prefs to improve speed and eliminate traffic to Mozilla
configure_firefox.optimize_prefs(fp)
# Launch the webdriver
status_queue.put("LAUNCHING BROWSER")
#fb = FirefoxBinary(root_dir + "/../../firefox/firefox", log_file=open(root_dir + '/../../firefox_logging','w'))
if platform.system() == "Darwin":
fb = FirefoxBinary("/Applications/Firefox.app/Contents/MacOS/firefox")
else:
fb = FirefoxBinary(root_dir + "/../../firefox-bin/firefox")
# fb = FirefoxBinary("/Users/surya/Code/OpenWPM/Firefox.app/Contents/MacOS/firefox")
driver = webdriver.Firefox(firefox_profile=fp, firefox_binary=fb)
status_queue.put(('STATUS','Browser Launched',(int(driver.binary.process.pid), profile_settings)))
# set window size
driver.set_window_size(*profile_settings['screen_res'])
return driver, browser_profile_path, profile_settings
def deploy_firefox(status_queue, browser_params, manager_params, crash_recovery):
""" launches a firefox instance with parameters set by the input dictionary """
root_dir = os.path.dirname(__file__) # directory of this file
logger = loggingclient(*manager_params['logger_address'])
display_pid = None
display_port = None
fp = webdriver.FirefoxProfile()
browser_profile_path = fp.path + '/'
status_queue.put(('STATUS','Profile Created',browser_profile_path))
profile_settings = None # Imported browser settings
if browser_params['profile_tar'] and not crash_recovery:
logger.debug("BROWSER %i: Loading initial browser profile from: %s" % (browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params, browser_params,
browser_params['profile_tar'],
load_flash=browser_params['disable_flash'] is False)
elif browser_params['profile_tar']:
logger.debug("BROWSER %i: Loading recovered browser profile from: %s" % (browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params, browser_params,
browser_params['profile_tar'])
status_queue.put(('STATUS','Profile Tar',None))
if browser_params['random_attributes'] and profile_settings is None:
logger.debug("BROWSER %i: Loading random attributes for browser" % browser_params['crawl_id'])
profile_settings = dict()
# choose a random screen-res from list
resolutions = list()
with open(os.path.join(root_dir, 'screen_resolutions.txt'), 'r') as f:
for line in f:
resolutions.append(tuple(line.strip().split(',')))
profile_settings['screen_res'] = random.choice(resolutions)
# set a random user agent from list
ua_strings = list()
with open(os.path.join(root_dir, 'user_agent_strings.txt'), 'r') as f:
for line in f:
ua_strings.append(line.strip())
profile_settings['ua_string'] = random.choice(ua_strings)
# If profile settings still not set - set defaults
if profile_settings is None:
profile_settings = dict()
profile_settings['screen_res'] = DEFAULT_SCREEN_RES
profile_settings['ua_string'] = None
if profile_settings['ua_string'] is not None:
logger.debug("BROWSER %i: Overriding user agent string with the following: %s" % (browser_params['crawl_id'], profile_settings['ua_string']))
fp.set_preference("general.useragent.override", profile_settings['ua_string'])
if browser_params['headless']:
display = Display(visible=0, size=profile_settings['screen_res'])
display.start()
display_pid = display.pid
display_port = display.cmd_param[5][1:]
status_queue.put(('STATUS','Display',(display_pid, display_port)))
# Write extension configuration
if browser_params['extension_enabled']:
ext_loc = os.path.join(root_dir + "/../", 'Extension/firefox/openwpm.xpi')
ext_loc = os.path.normpath(ext_loc)
fp.add_extension(extension=ext_loc)
fp.set_preference("*****@*****.**", "all")
extension_config = dict()
extension_config.update(browser_params)
extension_config['logger_address'] = manager_params['logger_address']
extension_config['sqlite_address'] = manager_params['aggregator_address']
if manager_params.has_key('ldb_address'):
extension_config['leveldb_address'] = manager_params['ldb_address']
else:
extension_config['leveldb_address'] = None
extension_config['testing'] = manager_params['testing']
with open(browser_profile_path + 'browser_params.json', 'w') as f:
json.dump(extension_config, f)
logger.debug("BROWSER %i: OpenWPM Firefox extension loaded" % browser_params['crawl_id'])
if browser_params['proxy']:
logger.warning("BROWSER %i: Use of the proxy is DEPRECATED and will be "
"removed from future releases. Use http_instrument." %
browser_params['crawl_id'])
PROXY_HOST = "localhost"
PROXY_PORT = browser_params['proxy']
# Direct = 0, Manual = 1, PAC = 2, AUTODETECT = 4, SYSTEM = 5
fp.set_preference("network.proxy.type", 1)
fp.set_preference("network.proxy.http", PROXY_HOST)
fp.set_preference("network.proxy.http_port", PROXY_PORT)
fp.set_preference("network.proxy.ssl", PROXY_HOST) # https sites
fp.set_preference("network.proxy.ssl_port", PROXY_PORT)
# set this to exclude sites from using proxy
# http://kb.mozillazine.org/Network.proxy.no_proxies_on
fp.set_preference("network.proxy.no_proxies_on", "")
# copy the dbs into temp profile
# these were created by manually adding the cert to
# a previous tmp selenium profile
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/key3.db'), fp.path + '/key3.db')
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/cert8.db'), fp.path + '/cert8.db')
# Disable flash
if browser_params['disable_flash']:
fp.set_preference('plugin.state.flash', 0)
# Configure privacy settings
configure_firefox.privacy(browser_params, fp, root_dir, browser_profile_path)
# Set various prefs to improve speed and eliminate traffic to Mozilla
configure_firefox.optimize_prefs(fp)
# Launch the webdriver
status_queue.put(('STATUS','Launch Attempted',None))
fb = FirefoxBinary(root_dir + "/../../firefox-bin/firefox")
driver = webdriver.Firefox(firefox_profile=fp, firefox_binary=fb)
status_queue.put(('STATUS','Browser Launched',(int(driver.binary.process.pid), profile_settings)))
# set window size
driver.set_window_size(*profile_settings['screen_res'])
return driver, browser_profile_path, profile_settings
def deploy_firefox(status_queue, browser_params, manager_params,
crash_recovery):
""" launches a firefox instance with parameters set by the input dictionary """
root_dir = os.path.dirname(__file__) # directory of this file
logger = loggingclient(*manager_params['logger_address'])
display_pid = None
display_port = None
# fp = webdriver.FirefoxProfile()
fp = MyFirefoxProfile()
browser_profile_path = fp.path + '/'
status_queue.put(('STATUS', 'Profile Created', browser_profile_path))
profile_settings = None # Imported browser settings
if browser_params['profile_tar'] and not crash_recovery:
logger.debug(
"BROWSER %i: Loading initial browser profile from: %s" %
(browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(
browser_profile_path,
manager_params,
browser_params,
browser_params['profile_tar'],
load_flash=browser_params['disable_flash'] is False)
elif browser_params['profile_tar']:
logger.debug(
"BROWSER %i: Loading recovered browser profile from: %s" %
(browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params,
browser_params,
browser_params['profile_tar'])
status_queue.put(('STATUS', 'Profile Tar', None))
if browser_params['random_attributes'] and profile_settings is None:
logger.debug("BROWSER %i: Loading random attributes for browser" %
browser_params['crawl_id'])
profile_settings = dict()
# choose a random screen-res from list
resolutions = list()
with open(os.path.join(root_dir, 'screen_resolutions.txt'), 'r') as f:
for line in f:
resolutions.append(tuple(line.strip().split(',')))
profile_settings['screen_res'] = random.choice(resolutions)
# set a random user agent from list
ua_strings = list()
with open(os.path.join(root_dir, 'user_agent_strings.txt'), 'r') as f:
for line in f:
ua_strings.append(line.strip())
profile_settings['ua_string'] = random.choice(ua_strings)
# If profile settings still not set - set defaults
if profile_settings is None:
profile_settings = dict()
profile_settings['screen_res'] = DEFAULT_SCREEN_RES
profile_settings['ua_string'] = None
if profile_settings['ua_string'] is not None:
logger.debug(
"BROWSER %i: Overriding user agent string with the following: %s" %
(browser_params['crawl_id'], profile_settings['ua_string']))
fp.set_preference("general.useragent.override",
profile_settings['ua_string'])
if browser_params['headless']:
display = Display(visible=0, size=profile_settings['screen_res'])
display.start()
display_pid = display.pid
display_port = display.cmd_param[5][1:]
status_queue.put(('STATUS', 'Display', (display_pid, display_port)))
# Write extension configuration
if browser_params['extension_enabled']:
ext_dir = join(dirname(root_dir), 'Extension', 'firefox')
ext_loc = join(ext_dir, 'openwpm.xpi') # Requires jpm >=1.2.0
fp.add_extension(extension=ext_loc)
fp.set_preference("*****@*****.**", "all")
extension_config = dict()
extension_config.update(browser_params)
extension_config['logger_address'] = manager_params['logger_address']
extension_config['sqlite_address'] = manager_params[
'aggregator_address']
if manager_params.has_key('ldb_address'):
extension_config['leveldb_address'] = manager_params['ldb_address']
else:
extension_config['leveldb_address'] = None
extension_config['testing'] = manager_params['testing']
with open(browser_profile_path + 'browser_params.json', 'w') as f:
json.dump(extension_config, f)
logger.debug("BROWSER %i: OpenWPM Firefox extension loaded" %
browser_params['crawl_id'])
if browser_params['proxy']:
logger.warning(
"BROWSER %i: Use of the proxy is DEPRECATED and will be "
"removed from future releases. Use http_instrument." %
browser_params['crawl_id'])
PROXY_HOST = "localhost"
PROXY_PORT = browser_params['proxy']
# Direct = 0, Manual = 1, PAC = 2, AUTODETECT = 4, SYSTEM = 5
fp.set_preference("network.proxy.type", 1)
fp.set_preference("network.proxy.http", PROXY_HOST)
fp.set_preference("network.proxy.http_port", PROXY_PORT)
fp.set_preference("network.proxy.ssl", PROXY_HOST) # https sites
fp.set_preference("network.proxy.ssl_port", PROXY_PORT)
# set this to exclude sites from using proxy
# http://kb.mozillazine.org/Network.proxy.no_proxies_on
fp.set_preference("network.proxy.no_proxies_on", "")
# copy the dbs into temp profile
# these were created by manually adding the cert to
# a previous tmp selenium profile
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/key3.db'),
fp.path + '/key3.db')
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/cert8.db'),
fp.path + '/cert8.db')
# Disable flash
if browser_params['disable_flash']:
fp.set_preference('plugin.state.flash', 0)
# Configure privacy settings
configure_firefox.privacy(browser_params, fp, root_dir,
browser_profile_path)
configure_firefox.custom_prefs(fp, browser_params)
# Set various prefs to improve speed and eliminate traffic to Mozilla
configure_firefox.optimize_prefs(fp)
# Launch the webdriver
status_queue.put(('STATUS', 'Launch Attempted', None))
fb = FirefoxBinary(root_dir + "/../../firefox-bin/firefox")
driver = webdriver.Firefox(firefox_profile=fp,
firefox_binary=fb,
timeout=BROWSER_LAUNCH_TIMEOUT)
status_queue.put(('STATUS', 'Browser Launched',
(int(driver.binary.process.pid), profile_settings)))
# set window size
driver.set_window_size(*profile_settings['screen_res'])
return driver, browser_profile_path, profile_settings
def deploy_firefox(status_queue, browser_params, manager_params,
crash_recovery):
""" launches a firefox instance with parameters set by the input dictionary """
root_dir = os.path.dirname(__file__) # directory of this file
logger = loggingclient(*manager_params['logger_address'])
display_pid = None
display_port = None
fp = webdriver.FirefoxProfile()
browser_profile_path = fp.path + '/'
status_queue.put(('STATUS', 'Profile Created', browser_profile_path))
profile_settings = None # Imported browser settings
if browser_params['profile_tar'] and not crash_recovery:
logger.debug(
"BROWSER %i: Loading initial browser profile from: %s" %
(browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(
browser_profile_path,
manager_params,
browser_params,
browser_params['profile_tar'],
load_flash=browser_params['disable_flash'] is False)
elif browser_params['profile_tar']:
logger.debug(
"BROWSER %i: Loading recovered browser profile from: %s" %
(browser_params['crawl_id'], browser_params['profile_tar']))
profile_settings = load_profile(browser_profile_path, manager_params,
browser_params,
browser_params['profile_tar'])
status_queue.put(('STATUS', 'Profile Tar', None))
if browser_params['random_attributes'] and profile_settings is None:
logger.debug("BROWSER %i: Loading random attributes for browser" %
browser_params['crawl_id'])
profile_settings = dict()
# choose a random screen-res from list
resolutions = list()
with open(os.path.join(root_dir, 'screen_resolutions.txt'), 'r') as f:
for line in f:
resolutions.append(tuple(line.strip().split(',')))
profile_settings['screen_res'] = random.choice(resolutions)
# set a random user agent from list
ua_strings = list()
with open(os.path.join(root_dir, 'user_agent_strings.txt'), 'r') as f:
for line in f:
ua_strings.append(line.strip())
profile_settings['ua_string'] = random.choice(ua_strings)
# If profile settings still not set - set defaults
if profile_settings is None:
profile_settings = dict()
profile_settings['screen_res'] = DEFAULT_SCREEN_RES
profile_settings['ua_string'] = None
if profile_settings['ua_string'] is not None:
logger.debug(
"BROWSER %i: Overriding user agent string with the following: %s" %
(browser_params['crawl_id'], profile_settings['ua_string']))
fp.set_preference("general.useragent.override",
profile_settings['ua_string'])
if browser_params['headless']:
display = Display(visible=0, size=profile_settings['screen_res'])
display.start()
display_pid = display.pid
display_port = display.cmd_param[5][1:]
status_queue.put(('STATUS', 'Display', (display_pid, display_port)))
if browser_params['debugging']:
firebug_loc = os.path.join(root_dir,
'firefox_extensions/firebug-1.11.0.xpi')
fp.add_extension(extension=firebug_loc)
fp.set_preference("extensions.firebug.currentVersion",
"1.11.0") # Avoid startup screen
if browser_params['extension']['enabled']:
ext_loc = os.path.join(root_dir + "/../",
'Extension/firefox/@openwpm-0.0.1.xpi')
ext_loc = os.path.normpath(ext_loc)
fp.add_extension(extension=ext_loc)
with open(browser_profile_path + 'database_settings.txt', 'w') as f:
host, port = manager_params['aggregator_address']
crawl_id = browser_params['crawl_id']
f.write(host + ',' + str(port) + ',' + str(crawl_id))
f.write(',' + str(browser_params['extension']['cookieInstrument']))
f.write(',' + str(browser_params['extension']['jsInstrument']))
f.write(',' + str(browser_params['extension']['cpInstrument']))
logger.debug("BROWSER %i: OpenWPM Firefox extension loaded" %
browser_params['crawl_id'])
sproxy = None #init value of sockproxy is None
if browser_params["socks"]:
#======== Set socks proxy ===================================
#fp.set_preference("network.proxy.socks",browser_params["socks"])
#fp.set_preference("network.proxy.socks_port",int(browser_params["socks_port"]))
#fp.set_preference("network.proxy.type", 1)
#socks proxy
proxy = browser_params["socks"] + ":" + browser_params["socks_port"]
print("proxy is: " + proxy)
sproxy = Proxy({
'socksProxy': proxy,
'noProxy': '' # set this value as desired
})
#=========End set socks proxy ===============================
if browser_params['proxy']:
PROXY_HOST = "localhost"
PROXY_PORT = browser_params['proxy']
# Direct = 0, Manual = 1, PAC = 2, AUTODETECT = 4, SYSTEM = 5
fp.set_preference("network.proxy.type", 1)
fp.set_preference("network.proxy.http", PROXY_HOST)
fp.set_preference("network.proxy.http_port", PROXY_PORT)
fp.set_preference("network.proxy.ssl", PROXY_HOST) # https sites
fp.set_preference("network.proxy.ssl_port", PROXY_PORT)
# set this to exclude sites from using proxy
# http://kb.mozillazine.org/Network.proxy.no_proxies_on
fp.set_preference("network.proxy.no_proxies_on", "")
# copy the dbs into temp profile
# these were created by manually adding the cert to
# a previous tmp selenium profile
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/key3.db'),
fp.path + '/key3.db')
shutil.copy(os.path.join(root_dir + "/../", 'Proxy/cert8.db'),
fp.path + '/cert8.db')
# Disable flash
if browser_params['disable_flash']:
fp.set_preference('plugin.state.flash', 0)
# Configure privacy settings
configure_firefox.privacy(browser_params, fp, root_dir,
browser_profile_path)
# Set various prefs to improve speed and eliminate traffic to Mozilla
configure_firefox.optimize_prefs(fp)
# Launch the webdriver
status_queue.put(('STATUS', 'Launch Attempted', None))
fb = FirefoxBinary(root_dir + "/../../firefox-bin/firefox")
# ========for MAC=========
import sys
if sys.platform == 'darwin':
fb = FirefoxBinary("/Applications/Firefox.app/Contents/MacOS/firefox")
# =========end============
driver = webdriver.Firefox(firefox_profile=fp,
firefox_binary=fb,
proxy=sproxy)
status_queue.put(('STATUS', 'Browser Launched',
(int(driver.binary.process.pid), profile_settings)))
# set window size
driver.set_window_size(*profile_settings['screen_res'])
return driver, browser_profile_path, profile_settings
