Source code for webtraversallibrary.webdrivers

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at


# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

Module for different webdrivers considered.
import importlib.resources
import json
import logging
import os.path
from pathlib import Path
from typing import Iterable

from selenium import webdriver
from selenium.webdriver import DesiredCapabilities
from selenium.webdriver.remote.webdriver import WebDriver

from .config import Config
from .driver_check import Drivers, is_driver_installed, log_driver_version
from .error import WebDriverSendError

logger = logging.getLogger("wtl")

def _setup_chrome(config: Config, profile_path: Path = None) -> WebDriver:
    assert is_driver_installed(Drivers.GOOGLE_CHROME) or is_driver_installed(Drivers.CHROMIUM)
    assert is_driver_installed(Drivers.CHROMEDRIVER)

    log_driver_version("Google Chrome version", Drivers.GOOGLE_CHROME)
    log_driver_version("Chromium version", Drivers.CHROMIUM)
    log_driver_version("Chromedriver version", Drivers.CHROMEDRIVER)

    chrome_options = webdriver.ChromeOptions()
    browser = config.browser

    # Disable security
    # Don't enforce the same-origin policy, see
    # Without this the JS code executed with Selenium WebDriver cannot access cross-domain CSS which are popular.

    # Disable unused/annoying features

    chrome_options.headless = browser.headless

    if profile_path:
        profile_dir =
        user_data_dir = str(profile_path.parent)

    if browser.proxy:
        chrome_options.add_argument("--disk-cache-dir=chrometemp/")  # Proxy messes up access rights of cache folder

    if browser.enable_mhtml:
        with importlib.resources.path("webtraversallibrary.extension", "wtl_extension.crx") as filepath:
            "prefs", {"download.default_directory": os.path.expanduser(config.scraping.temp_path)}

    if "pixelRatio" in browser and browser.pixelRatio != 0:
        # Emulating a mobile device - the full set of parameters must be provided
                "deviceMetrics": {"width": browser.width, "height": browser.height, "pixelRatio": browser.pixelRatio},
                "userAgent": browser.useragent,
        if "useragent" in browser:

    if "width" in browser and "height" in browser:
        chrome_options.add_argument(f"--window-size={browser.width},{browser.height + 120}")

    capabilities = DesiredCapabilities.CHROME.copy()
    capabilities["goog:loggingPrefs"] = {"browser": "ALL"}

    def _add_script(driver: WebDriver, script_path: str):
        send(driver, "Page.addScriptToEvaluateOnNewDocument", {"source": script_path})

    WebDriver.add_script = _add_script

    # launch Chrome
    driver = webdriver.Chrome(options=chrome_options, desired_capabilities=capabilities)

    return driver

def _setup_firefox(config: Config, _profile_path: Path = None) -> WebDriver:
    assert is_driver_installed(Drivers.FIREFOX)
    assert is_driver_installed(Drivers.GECKODRIVER)

    log_driver_version("Firefox version", Drivers.FIREFOX)
    log_driver_version("Geckodriver version", Drivers.GECKODRIVER)

    firefox_profile = webdriver.FirefoxProfile()
    firefox_options = webdriver.FirefoxOptions()
    browser = config.browser

    # Disable security
    firefox_profile.set_preference("", 3)
    firefox_profile.set_preference("", 0)
    firefox_profile.set_preference("media.volume_scale", "0.0")

    firefox_options.headless = browser.headless

    if browser.proxy:
        address = browser.proxy.split(":")
        firefox_profile.set_preference("network.proxy.http", address[0])
        firefox_profile.set_preference("network.proxy.http_port", address[1])

    if browser.enable_mhtml:
        # TODO
        logger.critical("Firefox does not currently support MHTML")
        assert False

    if "pixelRatio" in browser and browser.pixelRatio != 0:
        # TODO
        logger.error("Firefox does not currently support custom pixelratio")

    if "useragent" in browser:
        firefox_profile.set_preference("general.useragent.override", browser.useragent)

    def _add_script(driver: WebDriver, script_path: str):
        send(driver, "Page.addScriptToEvaluateOnNewDocument", {"source": script_path})

    WebDriver.add_script = _add_script

    # TODO No support to output console logs for geckodriver

    driver = webdriver.Firefox(options=firefox_options, firefox_profile=firefox_profile)

    # Screen size (we can't set viewport size as for Chrome so we adjust screen size)
    if "width" in browser and "height" in browser:
        driver.set_window_size(browser.width, browser.height)

    return driver

[docs]def setup_driver(config: Config, profile_path: Path = None, preload_callbacks: Iterable[Path] = None) -> WebDriver: """ Creates a WebDriver object with the given configuration. :param: configuration Configuration dictionary :return: A WebDriver instance """ driver = None name = config.browser.browser.lower() if name == "chrome": driver = _setup_chrome(config=config, profile_path=profile_path) elif name == "firefox": driver = _setup_firefox(config=config, _profile_path=profile_path) else: raise NotImplementedError(f"Uninmplemented browser type given to setup_driver: {config.browser.browser}") preload_callbacks = preload_callbacks or [] for cb in preload_callbacks: driver.add_script(str(cb)) return driver
[docs]def send(driver: WebDriver, cmd: str, params: dict = None) -> int: """ Send command to the webdriver, return resulting status code. """ # pylint: disable=protected-access params = params or {} resource = f"/session/{driver.session_id}/chromium/send_command_and_get_result" url = driver.command_executor._url + resource body = json.dumps({"cmd": cmd, "params": params}) response = driver.command_executor._request("POST", url, body) value = response.get("value") if response.get("status", False): raise WebDriverSendError(f"Command '{cmd}' returned status={value}") return value