727 lines
35 KiB
Python
727 lines
35 KiB
Python
from re import compile as re_compile
|
|
|
|
from playwright.sync_api import (
|
|
Response as SyncPlaywrightResponse,
|
|
sync_playwright,
|
|
Locator,
|
|
Page,
|
|
)
|
|
from playwright.async_api import (
|
|
async_playwright,
|
|
Response as AsyncPlaywrightResponse,
|
|
BrowserContext as AsyncBrowserContext,
|
|
Playwright as AsyncPlaywright,
|
|
Locator as AsyncLocator,
|
|
Page as async_Page,
|
|
)
|
|
from playwright._impl._errors import Error as PlaywrightError
|
|
|
|
from ._validators import validate_fetch as _validate
|
|
from ._base import SyncSession, AsyncSession, StealthySessionMixin
|
|
from scrapling.core.utils import log
|
|
from scrapling.core._types import (
|
|
Dict,
|
|
List,
|
|
Optional,
|
|
Callable,
|
|
SelectorWaitStates,
|
|
)
|
|
from scrapling.engines.toolbelt.convertor import (
|
|
Response,
|
|
ResponseFactory,
|
|
)
|
|
from scrapling.engines.toolbelt.fingerprints import generate_convincing_referer
|
|
|
|
__CF_PATTERN__ = re_compile("challenges.cloudflare.com/cdn-cgi/challenge-platform/.*")
|
|
_UNSET = object()
|
|
|
|
|
|
class StealthySession(StealthySessionMixin, SyncSession):
|
|
"""A Stealthy session manager with page pooling."""
|
|
|
|
__slots__ = (
|
|
"max_pages",
|
|
"headless",
|
|
"block_images",
|
|
"disable_resources",
|
|
"block_webrtc",
|
|
"allow_webgl",
|
|
"network_idle",
|
|
"load_dom",
|
|
"humanize",
|
|
"solve_cloudflare",
|
|
"wait",
|
|
"timeout",
|
|
"page_action",
|
|
"wait_selector",
|
|
"init_script",
|
|
"addons",
|
|
"wait_selector_state",
|
|
"cookies",
|
|
"google_search",
|
|
"extra_headers",
|
|
"proxy",
|
|
"os_randomize",
|
|
"disable_ads",
|
|
"geoip",
|
|
"selector_config",
|
|
"additional_args",
|
|
"playwright",
|
|
"browser",
|
|
"context",
|
|
"page_pool",
|
|
"_closed",
|
|
"launch_options",
|
|
"_headers_keys",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
__max_pages: int = 1,
|
|
headless: bool = True, # noqa: F821
|
|
block_images: bool = False,
|
|
disable_resources: bool = False,
|
|
block_webrtc: bool = False,
|
|
allow_webgl: bool = True,
|
|
network_idle: bool = False,
|
|
load_dom: bool = True,
|
|
humanize: bool | float = True,
|
|
solve_cloudflare: bool = False,
|
|
wait: int | float = 0,
|
|
timeout: int | float = 30000,
|
|
page_action: Optional[Callable] = None,
|
|
wait_selector: Optional[str] = None,
|
|
init_script: Optional[str] = None,
|
|
addons: Optional[List[str]] = None,
|
|
wait_selector_state: SelectorWaitStates = "attached",
|
|
cookies: Optional[List[Dict]] = None,
|
|
google_search: bool = True,
|
|
extra_headers: Optional[Dict[str, str]] = None,
|
|
proxy: Optional[str | Dict[str, str]] = None,
|
|
os_randomize: bool = False,
|
|
disable_ads: bool = False,
|
|
geoip: bool = False,
|
|
selector_config: Optional[Dict] = None,
|
|
additional_args: Optional[Dict] = None,
|
|
):
|
|
"""A Browser session manager with page pooling
|
|
|
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
|
:param block_images: Prevent the loading of images through Firefox preferences.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost. It depends, but it made requests ~25% faster in my tests for some websites.
|
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param block_webrtc: Blocks WebRTC entirely.
|
|
:param cookies: Set cookies for the next request.
|
|
:param addons: List of Firefox addons to use. Must be paths to extracted addons.
|
|
:param humanize: Humanize the cursor movement. Takes either True or the MAX duration in seconds of the cursor movement. The cursor typically takes up to 1.5 seconds to move across the window.
|
|
:param solve_cloudflare: Solves all 3 types of the Cloudflare's Turnstile wait page before returning the response to you.
|
|
:param allow_webgl: Enabled by default. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
|
:param disable_ads: Disabled by default, this installs the `uBlock Origin` addon on the browser if enabled.
|
|
:param os_randomize: If enabled, Scrapling will randomize the OS fingerprints used. The default is Scrapling matching the fingerprints with the current OS.
|
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
|
:param geoip: Recommended to use with proxies; Automatically use IP's longitude, latitude, timezone, country, locale, and spoof the WebRTC IP address.
|
|
It will also calculate and spoof the browser's language based on the distribution of language speakers in the target region.
|
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
:param additional_args: Additional arguments to be passed to Camoufox as additional settings, and it takes higher priority than Scrapling's settings.
|
|
"""
|
|
|
|
self.__validate__(
|
|
wait=wait,
|
|
proxy=proxy,
|
|
geoip=geoip,
|
|
addons=addons,
|
|
timeout=timeout,
|
|
cookies=cookies,
|
|
headless=headless,
|
|
humanize=humanize,
|
|
load_dom=load_dom,
|
|
max_pages=__max_pages,
|
|
disable_ads=disable_ads,
|
|
allow_webgl=allow_webgl,
|
|
page_action=page_action,
|
|
init_script=init_script,
|
|
network_idle=network_idle,
|
|
block_images=block_images,
|
|
block_webrtc=block_webrtc,
|
|
os_randomize=os_randomize,
|
|
wait_selector=wait_selector,
|
|
google_search=google_search,
|
|
extra_headers=extra_headers,
|
|
additional_args=additional_args,
|
|
selector_config=selector_config,
|
|
solve_cloudflare=solve_cloudflare,
|
|
disable_resources=disable_resources,
|
|
wait_selector_state=wait_selector_state,
|
|
)
|
|
super().__init__(max_pages=self.max_pages)
|
|
|
|
def __create__(self):
|
|
"""Create a browser for this instance and context."""
|
|
self.playwright = sync_playwright().start()
|
|
self.context = self.playwright.firefox.launch_persistent_context( # pragma: no cover
|
|
**self.launch_options
|
|
)
|
|
|
|
if self.init_script: # pragma: no cover
|
|
self.context.add_init_script(path=self.init_script)
|
|
|
|
if self.cookies: # pragma: no cover
|
|
self.context.add_cookies(self.cookies)
|
|
|
|
def __enter__(self): # pragma: no cover
|
|
self.__create__()
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_val, exc_tb):
|
|
self.close()
|
|
|
|
def close(self): # pragma: no cover
|
|
"""Close all resources"""
|
|
if self._closed: # pragma: no cover
|
|
return
|
|
|
|
if self.context:
|
|
self.context.close()
|
|
self.context = None
|
|
|
|
if self.playwright:
|
|
self.playwright.stop()
|
|
self.playwright = None
|
|
|
|
self._closed = True
|
|
|
|
@staticmethod
|
|
def _get_page_content(page: Page) -> str | None:
|
|
"""
|
|
A workaround for Playwright issue with `page.content()` on Windows. Ref.: https://github.com/microsoft/playwright/issues/16108
|
|
:param page: The page to extract content from.
|
|
:return:
|
|
"""
|
|
while True:
|
|
try:
|
|
return page.content() or ""
|
|
except PlaywrightError:
|
|
page.wait_for_timeout(1000)
|
|
continue
|
|
|
|
def _solve_cloudflare(self, page: Page) -> None: # pragma: no cover
|
|
"""Solve the cloudflare challenge displayed on the playwright page passed
|
|
|
|
:param page: The targeted page
|
|
:return:
|
|
"""
|
|
challenge_type = self._detect_cloudflare(self._get_page_content(page))
|
|
if not challenge_type:
|
|
log.error("No Cloudflare challenge found.")
|
|
return
|
|
else:
|
|
log.info(f'The turnstile version discovered is "{challenge_type}"')
|
|
if challenge_type == "non-interactive":
|
|
while "<title>Just a moment...</title>" in (self._get_page_content(page)):
|
|
log.info("Waiting for Cloudflare wait page to disappear.")
|
|
page.wait_for_timeout(1000)
|
|
page.wait_for_load_state()
|
|
log.info("Cloudflare captcha is solved")
|
|
return
|
|
|
|
else:
|
|
box_selector = "#cf_turnstile div, #cf-turnstile div, .turnstile>div>div"
|
|
if challenge_type != "embedded":
|
|
box_selector = ".main-content p+div>div>div"
|
|
while "Verifying you are human." in self._get_page_content(page):
|
|
# Waiting for the verify spinner to disappear, checking every 1s if it disappeared
|
|
page.wait_for_timeout(500)
|
|
|
|
iframe = page.frame(url=__CF_PATTERN__)
|
|
if iframe is None:
|
|
log.error("Didn't find Cloudflare iframe!")
|
|
return
|
|
|
|
if challenge_type != "embedded":
|
|
while not iframe.frame_element().is_visible():
|
|
# Double-checking that the iframe is loaded
|
|
page.wait_for_timeout(500)
|
|
|
|
iframe.wait_for_load_state(state="domcontentloaded")
|
|
iframe.wait_for_load_state("networkidle")
|
|
# Calculate the Captcha coordinates for any viewport
|
|
outer_box = page.locator(box_selector).last.bounding_box()
|
|
captcha_x, captcha_y = outer_box["x"] + 26, outer_box["y"] + 25
|
|
|
|
# Move the mouse to the center of the window, then press and hold the left mouse button
|
|
page.mouse.click(captcha_x, captcha_y, delay=60, button="left")
|
|
if challenge_type != "embedded":
|
|
page.locator(".zone-name-title").wait_for(state="hidden")
|
|
page.wait_for_load_state(state="domcontentloaded")
|
|
|
|
log.info("Cloudflare captcha is solved")
|
|
return
|
|
|
|
def fetch(
|
|
self,
|
|
url: str,
|
|
google_search: bool = _UNSET,
|
|
timeout: int | float = _UNSET,
|
|
wait: int | float = _UNSET,
|
|
page_action: Optional[Callable] = _UNSET,
|
|
extra_headers: Optional[Dict[str, str]] = _UNSET,
|
|
disable_resources: bool = _UNSET,
|
|
wait_selector: Optional[str] = _UNSET,
|
|
wait_selector_state: SelectorWaitStates = _UNSET,
|
|
network_idle: bool = _UNSET,
|
|
load_dom: bool = _UNSET,
|
|
solve_cloudflare: bool = _UNSET,
|
|
selector_config: Optional[Dict] = _UNSET,
|
|
) -> Response:
|
|
"""Opens up the browser and do your request based on your chosen options.
|
|
|
|
:param url: The Target url.
|
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost. It depends, but it made requests ~25% faster in my tests for some websites.
|
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
|
:param solve_cloudflare: Solves all 3 types of the Cloudflare's Turnstile wait page before returning the response to you.
|
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
:return: A `Response` object.
|
|
"""
|
|
params = _validate(
|
|
[
|
|
("google_search", google_search, self.google_search),
|
|
("timeout", timeout, self.timeout),
|
|
("wait", wait, self.wait),
|
|
("page_action", page_action, self.page_action),
|
|
("extra_headers", extra_headers, self.extra_headers),
|
|
("disable_resources", disable_resources, self.disable_resources),
|
|
("wait_selector", wait_selector, self.wait_selector),
|
|
("wait_selector_state", wait_selector_state, self.wait_selector_state),
|
|
("network_idle", network_idle, self.network_idle),
|
|
("load_dom", load_dom, self.load_dom),
|
|
("solve_cloudflare", solve_cloudflare, self.solve_cloudflare),
|
|
("selector_config", selector_config, self.selector_config),
|
|
],
|
|
_UNSET,
|
|
)
|
|
|
|
if self._closed: # pragma: no cover
|
|
raise RuntimeError("Context manager has been closed")
|
|
|
|
final_response = None
|
|
referer = (
|
|
generate_convincing_referer(url) if (params.google_search and "referer" not in self._headers_keys) else None
|
|
)
|
|
|
|
def handle_response(finished_response: SyncPlaywrightResponse):
|
|
nonlocal final_response
|
|
if (
|
|
finished_response.request.resource_type == "document"
|
|
and finished_response.request.is_navigation_request()
|
|
):
|
|
final_response = finished_response
|
|
|
|
page_info = self._get_page(params.timeout, params.extra_headers, params.disable_resources)
|
|
page_info.mark_busy(url=url)
|
|
|
|
try: # pragma: no cover
|
|
# Navigate to URL and wait for a specified state
|
|
page_info.page.on("response", handle_response)
|
|
first_response = page_info.page.goto(url, referer=referer)
|
|
if params.load_dom:
|
|
page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
|
|
if params.network_idle:
|
|
page_info.page.wait_for_load_state("networkidle")
|
|
|
|
if not first_response:
|
|
raise RuntimeError(f"Failed to get response for {url}")
|
|
|
|
if params.solve_cloudflare:
|
|
self._solve_cloudflare(page_info.page)
|
|
# Make sure the page is fully loaded after the captcha
|
|
page_info.page.wait_for_load_state(state="load")
|
|
if params.load_dom:
|
|
page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
if params.network_idle:
|
|
page_info.page.wait_for_load_state("networkidle")
|
|
|
|
if params.page_action:
|
|
try:
|
|
_ = params.page_action(page_info.page)
|
|
except Exception as e:
|
|
log.error(f"Error executing page_action: {e}")
|
|
|
|
if params.wait_selector:
|
|
try:
|
|
waiter: Locator = page_info.page.locator(params.wait_selector)
|
|
waiter.first.wait_for(state=params.wait_selector_state)
|
|
# Wait again after waiting for the selector, helpful with protections like Cloudflare
|
|
page_info.page.wait_for_load_state(state="load")
|
|
if params.load_dom:
|
|
page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
if params.network_idle:
|
|
page_info.page.wait_for_load_state("networkidle")
|
|
except Exception as e:
|
|
log.error(f"Error waiting for selector {params.wait_selector}: {e}")
|
|
|
|
page_info.page.wait_for_timeout(params.wait)
|
|
response = ResponseFactory.from_playwright_response(
|
|
page_info.page, first_response, final_response, params.selector_config
|
|
)
|
|
|
|
# Close the page, to free up resources
|
|
page_info.page.close()
|
|
self.page_pool.pages.remove(page_info)
|
|
|
|
return response
|
|
|
|
except Exception as e: # pragma: no cover
|
|
page_info.mark_error()
|
|
raise e
|
|
|
|
|
|
class AsyncStealthySession(StealthySessionMixin, AsyncSession):
|
|
"""A Stealthy session manager with page pooling."""
|
|
|
|
def __init__(
|
|
self,
|
|
max_pages: int = 1,
|
|
headless: bool = True, # noqa: F821
|
|
block_images: bool = False,
|
|
disable_resources: bool = False,
|
|
block_webrtc: bool = False,
|
|
allow_webgl: bool = True,
|
|
network_idle: bool = False,
|
|
load_dom: bool = True,
|
|
humanize: bool | float = True,
|
|
solve_cloudflare: bool = False,
|
|
wait: int | float = 0,
|
|
timeout: int | float = 30000,
|
|
page_action: Optional[Callable] = None,
|
|
wait_selector: Optional[str] = None,
|
|
init_script: Optional[str] = None,
|
|
addons: Optional[List[str]] = None,
|
|
wait_selector_state: SelectorWaitStates = "attached",
|
|
cookies: Optional[List[Dict]] = None,
|
|
google_search: bool = True,
|
|
extra_headers: Optional[Dict[str, str]] = None,
|
|
proxy: Optional[str | Dict[str, str]] = None,
|
|
os_randomize: bool = False,
|
|
disable_ads: bool = False,
|
|
geoip: bool = False,
|
|
selector_config: Optional[Dict] = None,
|
|
additional_args: Optional[Dict] = None,
|
|
):
|
|
"""A Browser session manager with page pooling
|
|
|
|
:param headless: Run the browser in headless/hidden (default), or headful/visible mode.
|
|
:param block_images: Prevent the loading of images through Firefox preferences.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost. It depends, but it made requests ~25% faster in my tests for some websites.
|
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param block_webrtc: Blocks WebRTC entirely.
|
|
:param cookies: Set cookies for the next request.
|
|
:param addons: List of Firefox addons to use. Must be paths to extracted addons.
|
|
:param humanize: Humanize the cursor movement. Takes either True or the MAX duration in seconds of the cursor movement. The cursor typically takes up to 1.5 seconds to move across the window.
|
|
:param solve_cloudflare: Solves all 3 types of the Cloudflare's Turnstile wait page before returning the response to you.
|
|
:param allow_webgl: Enabled by default. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled.
|
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
|
:param disable_ads: Disabled by default, this installs the `uBlock Origin` addon on the browser if enabled.
|
|
:param os_randomize: If enabled, Scrapling will randomize the OS fingerprints used. The default is Scrapling matching the fingerprints with the current OS.
|
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
|
:param init_script: An absolute path to a JavaScript file to be executed on page creation for all pages in this session.
|
|
:param geoip: Recommended to use with proxies; Automatically use IP's longitude, latitude, timezone, country, locale, and spoof the WebRTC IP address.
|
|
It will also calculate and spoof the browser's language based on the distribution of language speakers in the target region.
|
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
|
:param proxy: The proxy to be used with requests, it can be a string or a dictionary with the keys 'server', 'username', and 'password' only.
|
|
:param max_pages: The maximum number of tabs to be opened at the same time. It will be used in rotation through a PagePool.
|
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
:param additional_args: Additional arguments to be passed to Camoufox as additional settings, and it takes higher priority than Scrapling's settings.
|
|
"""
|
|
self.__validate__(
|
|
wait=wait,
|
|
proxy=proxy,
|
|
geoip=geoip,
|
|
addons=addons,
|
|
timeout=timeout,
|
|
cookies=cookies,
|
|
headless=headless,
|
|
load_dom=load_dom,
|
|
humanize=humanize,
|
|
max_pages=max_pages,
|
|
disable_ads=disable_ads,
|
|
allow_webgl=allow_webgl,
|
|
page_action=page_action,
|
|
init_script=init_script,
|
|
network_idle=network_idle,
|
|
block_images=block_images,
|
|
block_webrtc=block_webrtc,
|
|
os_randomize=os_randomize,
|
|
wait_selector=wait_selector,
|
|
google_search=google_search,
|
|
extra_headers=extra_headers,
|
|
additional_args=additional_args,
|
|
selector_config=selector_config,
|
|
solve_cloudflare=solve_cloudflare,
|
|
disable_resources=disable_resources,
|
|
wait_selector_state=wait_selector_state,
|
|
)
|
|
super().__init__(max_pages=self.max_pages)
|
|
|
|
async def __create__(self):
|
|
"""Create a browser for this instance and context."""
|
|
self.playwright: AsyncPlaywright = await async_playwright().start()
|
|
self.context: AsyncBrowserContext = await self.playwright.firefox.launch_persistent_context(
|
|
**self.launch_options
|
|
)
|
|
|
|
if self.init_script: # pragma: no cover
|
|
await self.context.add_init_script(path=self.init_script)
|
|
|
|
if self.cookies:
|
|
await self.context.add_cookies(self.cookies)
|
|
|
|
async def __aenter__(self):
|
|
await self.__create__()
|
|
return self
|
|
|
|
async def __aexit__(self, exc_type, exc_val, exc_tb):
|
|
await self.close()
|
|
|
|
async def close(self):
|
|
"""Close all resources"""
|
|
if self._closed: # pragma: no cover
|
|
return
|
|
|
|
if self.context:
|
|
await self.context.close()
|
|
self.context = None
|
|
|
|
if self.playwright:
|
|
await self.playwright.stop()
|
|
self.playwright = None
|
|
|
|
self._closed = True
|
|
|
|
@staticmethod
|
|
async def _get_page_content(page: async_Page) -> str | None:
|
|
"""
|
|
A workaround for Playwright issue with `page.content()` on Windows. Ref.: https://github.com/microsoft/playwright/issues/16108
|
|
:param page: The page to extract content from.
|
|
:return:
|
|
"""
|
|
while True:
|
|
try:
|
|
return (await page.content()) or ""
|
|
except PlaywrightError:
|
|
await page.wait_for_timeout(1000)
|
|
continue
|
|
|
|
async def _solve_cloudflare(self, page: async_Page):
|
|
"""Solve the cloudflare challenge displayed on the playwright page passed. The async version
|
|
|
|
:param page: The async targeted page
|
|
:return:
|
|
"""
|
|
challenge_type = self._detect_cloudflare(await self._get_page_content(page))
|
|
if not challenge_type:
|
|
log.error("No Cloudflare challenge found.")
|
|
return
|
|
else:
|
|
log.info(f'The turnstile version discovered is "{challenge_type}"')
|
|
if challenge_type == "non-interactive": # pragma: no cover
|
|
while "<title>Just a moment...</title>" in (await self._get_page_content(page)):
|
|
log.info("Waiting for Cloudflare wait page to disappear.")
|
|
await page.wait_for_timeout(1000)
|
|
await page.wait_for_load_state()
|
|
log.info("Cloudflare captcha is solved")
|
|
return
|
|
|
|
else:
|
|
box_selector = "#cf_turnstile div, #cf-turnstile div, .turnstile>div>div"
|
|
if challenge_type != "embedded":
|
|
box_selector = ".main-content p+div>div>div"
|
|
while "Verifying you are human." in (await self._get_page_content(page)):
|
|
# Waiting for the verify spinner to disappear, checking every 1s if it disappeared
|
|
await page.wait_for_timeout(500)
|
|
|
|
iframe = page.frame(url=__CF_PATTERN__)
|
|
if iframe is None:
|
|
log.error("Didn't find Cloudflare iframe!")
|
|
return
|
|
|
|
if challenge_type != "embedded":
|
|
while not await (await iframe.frame_element()).is_visible():
|
|
# Double-checking that the iframe is loaded
|
|
await page.wait_for_timeout(500)
|
|
|
|
await iframe.wait_for_load_state(state="domcontentloaded")
|
|
await iframe.wait_for_load_state("networkidle")
|
|
# Calculate the Captcha coordinates for any viewport
|
|
outer_box = await page.locator(box_selector).last.bounding_box()
|
|
captcha_x, captcha_y = outer_box["x"] + 26, outer_box["y"] + 25
|
|
|
|
# Move the mouse to the center of the window, then press and hold the left mouse button
|
|
await page.mouse.click(captcha_x, captcha_y, delay=60, button="left")
|
|
if challenge_type != "embedded":
|
|
await page.locator(".zone-name-title").wait_for(state="hidden")
|
|
await page.wait_for_load_state(state="domcontentloaded")
|
|
|
|
log.info("Cloudflare captcha is solved")
|
|
return
|
|
|
|
async def fetch(
|
|
self,
|
|
url: str,
|
|
google_search: bool = _UNSET,
|
|
timeout: int | float = _UNSET,
|
|
wait: int | float = _UNSET,
|
|
page_action: Optional[Callable] = _UNSET,
|
|
extra_headers: Optional[Dict[str, str]] = _UNSET,
|
|
disable_resources: bool = _UNSET,
|
|
wait_selector: Optional[str] = _UNSET,
|
|
wait_selector_state: SelectorWaitStates = _UNSET,
|
|
network_idle: bool = _UNSET,
|
|
load_dom: bool = _UNSET,
|
|
solve_cloudflare: bool = _UNSET,
|
|
selector_config: Optional[Dict] = _UNSET,
|
|
) -> Response:
|
|
"""Opens up the browser and do your request based on your chosen options.
|
|
|
|
:param url: The Target url.
|
|
:param google_search: Enabled by default, Scrapling will set the referer header to be as if this request came from a Google search of this website's domain name.
|
|
:param timeout: The timeout in milliseconds that is used in all operations and waits through the page. The default is 30,000
|
|
:param wait: The time (milliseconds) the fetcher will wait after everything finishes before closing the page and returning the ` Response ` object.
|
|
:param page_action: Added for automation. A function that takes the `page` object and does the automation you need.
|
|
:param extra_headers: A dictionary of extra headers to add to the request. _The referer set by the `google_search` argument takes priority over the referer set here if used together._
|
|
:param disable_resources: Drop requests of unnecessary resources for a speed boost. It depends, but it made requests ~25% faster in my tests for some websites.
|
|
Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`.
|
|
This can help save your proxy usage but be careful with this option as it makes some websites never finish loading.
|
|
:param wait_selector: Wait for a specific CSS selector to be in a specific state.
|
|
:param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`.
|
|
:param network_idle: Wait for the page until there are no network connections for at least 500 ms.
|
|
:param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute.
|
|
:param solve_cloudflare: Solves all 3 types of the Cloudflare's Turnstile wait page before returning the response to you.
|
|
:param selector_config: The arguments that will be passed in the end while creating the final Selector's class.
|
|
:return: A `Response` object.
|
|
"""
|
|
params = _validate(
|
|
[
|
|
("google_search", google_search, self.google_search),
|
|
("timeout", timeout, self.timeout),
|
|
("wait", wait, self.wait),
|
|
("page_action", page_action, self.page_action),
|
|
("extra_headers", extra_headers, self.extra_headers),
|
|
("disable_resources", disable_resources, self.disable_resources),
|
|
("wait_selector", wait_selector, self.wait_selector),
|
|
("wait_selector_state", wait_selector_state, self.wait_selector_state),
|
|
("network_idle", network_idle, self.network_idle),
|
|
("load_dom", load_dom, self.load_dom),
|
|
("solve_cloudflare", solve_cloudflare, self.solve_cloudflare),
|
|
("selector_config", selector_config, self.selector_config),
|
|
],
|
|
_UNSET,
|
|
)
|
|
|
|
if self._closed: # pragma: no cover
|
|
raise RuntimeError("Context manager has been closed")
|
|
|
|
final_response = None
|
|
referer = (
|
|
generate_convincing_referer(url) if (params.google_search and "referer" not in self._headers_keys) else None
|
|
)
|
|
|
|
async def handle_response(finished_response: AsyncPlaywrightResponse):
|
|
nonlocal final_response
|
|
if (
|
|
finished_response.request.resource_type == "document"
|
|
and finished_response.request.is_navigation_request()
|
|
):
|
|
final_response = finished_response
|
|
|
|
page_info = await self._get_page(params.timeout, params.extra_headers, params.disable_resources)
|
|
page_info.mark_busy(url=url)
|
|
|
|
try:
|
|
# Navigate to URL and wait for a specified state
|
|
page_info.page.on("response", handle_response)
|
|
first_response = await page_info.page.goto(url, referer=referer)
|
|
if params.load_dom:
|
|
await page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
|
|
if params.network_idle:
|
|
await page_info.page.wait_for_load_state("networkidle")
|
|
|
|
if not first_response:
|
|
raise RuntimeError(f"Failed to get response for {url}")
|
|
|
|
if params.solve_cloudflare:
|
|
await self._solve_cloudflare(page_info.page)
|
|
# Make sure the page is fully loaded after the captcha
|
|
await page_info.page.wait_for_load_state(state="load")
|
|
if params.load_dom:
|
|
await page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
if params.network_idle:
|
|
await page_info.page.wait_for_load_state("networkidle")
|
|
|
|
if params.page_action:
|
|
try:
|
|
_ = await params.page_action(page_info.page)
|
|
except Exception as e:
|
|
log.error(f"Error executing page_action: {e}")
|
|
|
|
if params.wait_selector:
|
|
try:
|
|
waiter: AsyncLocator = page_info.page.locator(params.wait_selector)
|
|
await waiter.first.wait_for(state=params.wait_selector_state)
|
|
# Wait again after waiting for the selector, helpful with protections like Cloudflare
|
|
await page_info.page.wait_for_load_state(state="load")
|
|
if params.load_dom:
|
|
await page_info.page.wait_for_load_state(state="domcontentloaded")
|
|
if params.network_idle:
|
|
await page_info.page.wait_for_load_state("networkidle")
|
|
except Exception as e:
|
|
log.error(f"Error waiting for selector {params.wait_selector}: {e}")
|
|
|
|
await page_info.page.wait_for_timeout(params.wait)
|
|
|
|
# Create response object
|
|
response = await ResponseFactory.from_async_playwright_response(
|
|
page_info.page, first_response, final_response, params.selector_config
|
|
)
|
|
|
|
# Close the page, to free up resources
|
|
await page_info.page.close()
|
|
self.page_pool.pages.remove(page_info)
|
|
|
|
return response
|
|
|
|
except Exception as e:
|
|
page_info.mark_error()
|
|
raise e
|