from random import randint from re import compile as re_compile from time import sleep as time_sleep from asyncio import sleep as asyncio_sleep from playwright.sync_api import ( Locator, Page, Playwright, ) from playwright.async_api import ( Page as async_Page, Locator as AsyncLocator, Playwright as AsyncPlaywright, BrowserContext as AsyncBrowserContext, ) from patchright.sync_api import sync_playwright from patchright.async_api import async_playwright from scrapling.core.utils import log from scrapling.core._types import Any, Unpack from ._config_tools import _compiled_stealth_scripts from ._types import StealthSession, StealthFetchParams from ._base import SyncSession, AsyncSession, StealthySessionMixin from ._validators import validate_fetch as _validate, StealthConfig 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/.*") class StealthySession(SyncSession, StealthySessionMixin): """A Stealthy Browser session manager with page pooling.""" __slots__ = ( "_config", "_context_options", "_launch_options", "max_pages", "page_pool", "_max_wait_for_page", "playwright", "context", ) def __init__(self, **kwargs: Unpack[StealthSession]): """A Browser session manager with page pooling, it's using a persistent browser Context by default with a temporary user profile directory. :param headless: Run the browser in headless/hidden (default), or headful/visible mode. :param disable_resources: Drop requests for unnecessary resources for a speed boost. Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`. :param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it. :param cookies: Set cookies for the next request. :param network_idle: Wait for the page until there are no network connections for at least 500 ms. :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 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 locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. :param timezone_id: Changes the timezone of the browser. Defaults to the system timezone. :param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`. :param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you. :param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it. :param hide_canvas: Add random noise to canvas operations to prevent fingerprinting. :param block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak. :param allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled. :param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute. :param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP. :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 user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory. :param extra_flags: A list of additional browser flags to pass to the browser on launch. :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 Playwright's context as additional settings, and it takes higher priority than Scrapling's settings. """ self.__validate__(**kwargs) super().__init__() def start(self): """Create a browser for this instance and context.""" if not self.playwright: self.playwright: Playwright = sync_playwright().start() # pyright: ignore [reportAttributeAccessIssue] if self._config.cdp_url: # pragma: no cover browser = self.playwright.chromium.connect_over_cdp(endpoint_url=self._config.cdp_url) self.context = browser.new_context(**self._context_options) else: self.context = self.playwright.chromium.launch_persistent_context(**self._launch_options) for script in _compiled_stealth_scripts(): self.context.add_init_script(script=script) if self._config.init_script: # pragma: no cover self.context.add_init_script(path=self._config.init_script) if self._config.cookies: # pragma: no cover self.context.add_cookies(self._config.cookies) self._is_alive = True else: raise RuntimeError("Session has been already started") def _cloudflare_solver(self, page: Page) -> None: # pragma: no cover """Solve the cloudflare challenge displayed on the playwright page passed :param page: The targeted page :return: """ self._wait_for_networkidle(page, timeout=5000) challenge_type = self._detect_cloudflare(ResponseFactory._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 "Just a moment..." in (ResponseFactory._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 ResponseFactory._get_page_content(page): # Waiting for the verify spinner to disappear, checking every 1s if it disappeared page.wait_for_timeout(500) outer_box = {} iframe = page.frame(url=__CF_PATTERN__) if iframe is not None: self._wait_for_page_stability(iframe, True, False) if challenge_type != "embedded": while not iframe.frame_element().is_visible(): # Double-checking that the iframe is loaded page.wait_for_timeout(500) outer_box: Any = iframe.frame_element().bounding_box() if not iframe or not outer_box: if "Just a moment..." not in (ResponseFactory._get_page_content(page)): log.info("Cloudflare captcha is solved") return outer_box: Any = page.locator(box_selector).last.bounding_box() # Calculate the Captcha coordinates for any viewport captcha_x, captcha_y = outer_box["x"] + randint(26, 28), outer_box["y"] + randint(25, 27) # 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=randint(100, 200), button="left") self._wait_for_networkidle(page) if iframe is not None: # Wait for the frame to be removed from the page (with 30s timeout = 300 iterations * 100 ms) attempts = 0 while iframe in page.frames: if attempts >= 300: log.info("Cloudflare iframe didn't disappear after 30s, continuing...") break page.wait_for_timeout(100) attempts += 1 if challenge_type != "embedded": page.locator(box_selector).last.wait_for(state="detached") page.locator(".zone-name-title").wait_for(state="hidden") self._wait_for_page_stability(page, True, False) log.info("Cloudflare captcha is solved") return def fetch(self, url: str, **kwargs: Unpack[StealthFetchParams]) -> 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 for unnecessary resources for a speed boost. Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`. :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 types of the Cloudflare's Turnstile/Interstitial challenges 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(kwargs, self, StealthConfig) if not self._is_alive: # pragma: no cover raise RuntimeError("Context manager has been closed") request_headers_keys = {h.lower() for h in params.extra_headers.keys()} if params.extra_headers else set() referer = ( generate_convincing_referer(url) if (params.google_search and "referer" not in request_headers_keys) else None ) for attempt in range(self._config.retries): page_info = self._get_page(params.timeout, params.extra_headers, params.disable_resources) final_response = [None] handle_response = self._create_response_handler(page_info, final_response) 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) self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) if not first_response: raise RuntimeError(f"Failed to get response for {url}") if params.solve_cloudflare: self._cloudflare_solver(page_info.page) # Make sure the page is fully loaded after the captcha self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) if params.page_action: try: _ = params.page_action(page_info.page) except Exception as e: # pragma: no cover 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 self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) except Exception as e: # pragma: no cover log.error(f"Error waiting for selector {params.wait_selector}: {e}") page_info.page.wait_for_timeout(params.wait) # Create response object response = ResponseFactory.from_playwright_response( page_info.page, first_response, final_response[0], 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: page_info.mark_error() page_info.page.close() self.page_pool.pages.remove(page_info) if attempt < self._config.retries - 1 and self._is_retriable(e): log.warning(f"Attempt {attempt + 1} failed: {e}. Retrying in {self._config.retry_delay}s...") time_sleep(self._config.retry_delay) else: raise # For type checking purposes only raise AssertionError("Unreachable: retry loop must return or raise") # pragma: no cover class AsyncStealthySession(AsyncSession, StealthySessionMixin): """An async Stealthy Browser session manager with page pooling.""" def __init__(self, **kwargs: Unpack[StealthSession]): """A Browser session manager with page pooling, it's using a persistent browser Context by default with a temporary user profile directory. :param headless: Run the browser in headless/hidden (default), or headful/visible mode. :param disable_resources: Drop requests for unnecessary resources for a speed boost. Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`. :param useragent: Pass a useragent string to be used. Otherwise the fetcher will generate a real Useragent of the same browser and use it. :param cookies: Set cookies for the next request. :param network_idle: Wait for the page until there are no network connections for at least 500 ms. :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 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 locale: Specify user locale, for example, `en-GB`, `de-DE`, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. :param timezone_id: Changes the timezone of the browser. Defaults to the system timezone. :param wait_selector_state: The state to wait for the selector given with `wait_selector`. The default state is `attached`. :param solve_cloudflare: Solves all types of the Cloudflare's Turnstile/Interstitial challenges before returning the response to you. :param real_chrome: If you have a Chrome browser installed on your device, enable this, and the Fetcher will launch an instance of your browser and use it. :param hide_canvas: Add random noise to canvas operations to prevent fingerprinting. :param block_webrtc: Forces WebRTC to respect proxy settings to prevent local IP address leak. :param allow_webgl: Enabled by default. Disabling it disables WebGL and WebGL 2.0 support entirely. Disabling WebGL is not recommended as many WAFs now check if WebGL is enabled. :param load_dom: Enabled by default, wait for all JavaScript on page(s) to fully load and execute. :param cdp_url: Instead of launching a new browser instance, connect to this CDP URL to control real browsers through CDP. :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 user_data_dir: Path to a User Data Directory, which stores browser session data like cookies and local storage. The default is to create a temporary directory. :param extra_flags: A list of additional browser flags to pass to the browser on launch. :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 Playwright's context as additional settings, and it takes higher priority than Scrapling's settings. """ self.__validate__(**kwargs) super().__init__(max_pages=self._config.max_pages) async def start(self): """Create a browser for this instance and context.""" if not self.playwright: self.playwright: AsyncPlaywright = await async_playwright().start() # pyright: ignore [reportAttributeAccessIssue] if self._config.cdp_url: browser = await self.playwright.chromium.connect_over_cdp(endpoint_url=self._config.cdp_url) self.context: AsyncBrowserContext = await browser.new_context(**self._context_options) else: self.context: AsyncBrowserContext = await self.playwright.chromium.launch_persistent_context( **self._launch_options ) for script in _compiled_stealth_scripts(): await self.context.add_init_script(script=script) if self._config.init_script: # pragma: no cover await self.context.add_init_script(path=self._config.init_script) if self._config.cookies: await self.context.add_cookies(self._config.cookies) # pyright: ignore self._is_alive = True else: raise RuntimeError("Session has been already started") async def _cloudflare_solver(self, page: async_Page) -> None: # pragma: no cover """Solve the cloudflare challenge displayed on the playwright page passed :param page: The targeted page :return: """ await self._wait_for_networkidle(page, timeout=5000) challenge_type = self._detect_cloudflare(await ResponseFactory._get_async_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 "Just a moment..." in (await ResponseFactory._get_async_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 ResponseFactory._get_async_page_content(page)): # Waiting for the verify spinner to disappear, checking every 1s if it disappeared await page.wait_for_timeout(500) outer_box = {} iframe = page.frame(url=__CF_PATTERN__) if iframe is not None: await self._wait_for_page_stability(iframe, True, False) 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) outer_box: Any = await (await iframe.frame_element()).bounding_box() if not iframe or not outer_box: if "Just a moment..." not in (await ResponseFactory._get_async_page_content(page)): log.info("Cloudflare captcha is solved") return outer_box: Any = await page.locator(box_selector).last.bounding_box() # Calculate the Captcha coordinates for any viewport captcha_x, captcha_y = outer_box["x"] + randint(26, 28), outer_box["y"] + randint(25, 27) # 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=randint(100, 200), button="left") await self._wait_for_networkidle(page) if iframe is not None: # Wait for the frame to be removed from the page (with 30s timeout = 300 iterations * 100 ms) attempts = 0 while iframe in page.frames: if attempts >= 300: log.info("Cloudflare iframe didn't disappear after 30s, continuing...") break await page.wait_for_timeout(100) attempts += 1 if challenge_type != "embedded": await page.locator(box_selector).last.wait_for(state="detached") await page.locator(".zone-name-title").wait_for(state="hidden") await self._wait_for_page_stability(page, True, False) log.info("Cloudflare captcha is solved") return async def fetch(self, url: str, **kwargs: Unpack[StealthFetchParams]) -> 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 for unnecessary resources for a speed boost. Requests dropped are of type `font`, `image`, `media`, `beacon`, `object`, `imageset`, `texttrack`, `websocket`, `csp_report`, and `stylesheet`. :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 types of the Cloudflare's Turnstile/Interstitial challenges 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(kwargs, self, StealthConfig) if not self._is_alive: # pragma: no cover raise RuntimeError("Context manager has been closed") request_headers_keys = {h.lower() for h in params.extra_headers.keys()} if params.extra_headers else set() referer = ( generate_convincing_referer(url) if (params.google_search and "referer" not in request_headers_keys) else None ) for attempt in range(self._config.retries): page_info = await self._get_page(params.timeout, params.extra_headers, params.disable_resources) final_response = [None] handle_response = self._create_response_handler(page_info, final_response) 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) await self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) if not first_response: raise RuntimeError(f"Failed to get response for {url}") if params.solve_cloudflare: await self._cloudflare_solver(page_info.page) # Make sure the page is fully loaded after the captcha await self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) 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 self._wait_for_page_stability(page_info.page, params.load_dom, params.network_idle) 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[0], 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: # pragma: no cover page_info.mark_error() await page_info.page.close() self.page_pool.pages.remove(page_info) if attempt < self._config.retries - 1 and self._is_retriable(e): log.warning(f"Attempt {attempt + 1} failed: {e}. Retrying in {self._config.retry_delay}s...") await asyncio_sleep(self._config.retry_delay) else: raise # For type checking purposes only raise AssertionError("Unreachable: retry loop must return or raise") # pragma: no cover