Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/setting_example.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ base_url = "" # 缓存文件访问的基础URL, 留空则使用服务器地址

[captcha]
captcha_method = "yescaptcha" # 打码方式: yescaptcha/flow2api_team(内置团队打码,地址与密钥固定)/captcharun/twocaptcha/capsolver/ezcaptcha/browser/personal/remote_browser
browser_headless = false # browser 模式是否启用无头 Chromium;启用后 Docker 无需 DISPLAY/Xvfb
browser_recaptcha_settle_seconds = 3.0 # 自定义站点分数测试在 reload/clr 就绪后的额外稳态等待
browser_flow_page_warmup_seconds = 6.0 # browser harvest 打开 Flow 页面后的稳定等待
browser_count = 1 # browser 模式的有头浏览器实例数量
Expand Down
5 changes: 5 additions & 0 deletions src/core/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,11 @@ def browser_launch_background(self) -> bool:
"""有头浏览器打码是否默认后台启动,避免抢占前台窗口。"""
return self._config.get("captcha", {}).get("browser_launch_background", True)

@property
def browser_headless(self) -> bool:
"""browser 模式是否启用无头模式(--headless=new / channel=chromium)。"""
return bool(self._config.get("captcha", {}).get("browser_headless", False))

def set_browser_launch_background(self, enabled: bool):
"""设置有头浏览器打码是否后台启动。"""
if "captcha" not in self._config:
Expand Down
25 changes: 15 additions & 10 deletions src/services/browser_captcha.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ def _ensure_browser_installed() -> bool:
BrowserContext = None
PLAYWRIGHT_AVAILABLE = False

if DOCKER_HEADED_BLOCKED:
if DOCKER_HEADED_BLOCKED and not config.browser_headless:
debug_logger.log_warning(
"[BrowserCaptcha] 检测到 Docker 环境,默认禁用有头浏览器打码。"
"如需启用请设置 ALLOW_DOCKER_HEADED_CAPTCHA=true,并提供 DISPLAY/Xvfb。"
Expand All @@ -263,7 +263,7 @@ def _ensure_browser_installed() -> bool:
"[BrowserCaptcha] 如需启用请设置 ALLOW_DOCKER_HEADED_CAPTCHA=true,并提供 DISPLAY/Xvfb"
)
else:
if IS_DOCKER and ALLOW_DOCKER_HEADED:
if IS_DOCKER and ALLOW_DOCKER_HEADED and not config.browser_headless:
debug_logger.log_warning(
"[BrowserCaptcha] Docker 有头浏览器打码白名单已启用,请确保 DISPLAY/Xvfb 可用"
)
Expand Down Expand Up @@ -1620,12 +1620,16 @@ async def _create_browser(
f"[BrowserCaptcha] Token-{self.token_id} using custom browser executable: {browser_executable_path}"
)

browser = await playwright.chromium.launch(
headless=False,
executable_path=browser_executable_path,
proxy=proxy_option,
args=browser_args,
)
use_headless = bool(getattr(config, "browser_headless", False))
launch_kwargs = {
"headless": use_headless,
"executable_path": browser_executable_path,
"proxy": proxy_option,
"args": browser_args,
}
if use_headless and not browser_executable_path:
launch_kwargs["channel"] = "chromium"
browser = await playwright.chromium.launch(**launch_kwargs)
context = await browser.new_context(
viewport=viewport,
locale="en-US",
Expand Down Expand Up @@ -3402,12 +3406,13 @@ async def get_instance(cls, db=None) -> "BrowserCaptchaService":

def _check_available(self):
"""检查服务是否可用"""
if DOCKER_HEADED_BLOCKED:
use_headless = config.browser_headless
if DOCKER_HEADED_BLOCKED and not use_headless:
raise RuntimeError(
"检测到 Docker 环境,默认禁用有头浏览器打码。"
"如需启用请设置环境变量 ALLOW_DOCKER_HEADED_CAPTCHA=true,并提供 DISPLAY/Xvfb。"
)
if IS_DOCKER and not os.environ.get("DISPLAY"):
if IS_DOCKER and not use_headless and not os.environ.get("DISPLAY"):
raise RuntimeError(
"Docker 有头浏览器打码已启用,但 DISPLAY 未设置。"
"请设置 DISPLAY(例如 :99)并启动 Xvfb。"
Expand Down
7 changes: 5 additions & 2 deletions src/services/recaptcha_runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,13 @@
typeof window.grecaptcha.enterprise.render === 'function' &&
window.__flow2apiRecaptchaClientId === undefined
) {
const holder = document.createElement('div');
holder.style.display = 'none';
(document.body || document.documentElement).appendChild(holder);
window.__flow2apiRecaptchaClientId =
window.grecaptcha.enterprise.render(
document.documentElement,
{ sitekey: siteKey, action: requestedAction }
holder,
{ sitekey: siteKey, size: 'invisible', action: requestedAction }
);
}
if (window.__flow2apiRecaptchaClientId !== undefined) {
Expand Down
106 changes: 106 additions & 0 deletions tests/test_browser_headless.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
"""Docker availability checks for headed and headless browser captcha."""

import importlib.util
import os
import sys
import types
import unittest
from pathlib import Path
from unittest.mock import Mock, patch

from src.core.config import config


class BrowserHeadlessTests(unittest.TestCase):
def load_browser_module(self, *, headless=False, allow_headed=False):
source = Path(__file__).parents[1] / "src/services/browser_captcha.py"
spec = importlib.util.spec_from_file_location(
"src.services._browser_headless_tests", source
)
module = importlib.util.module_from_spec(spec)
playwright = types.ModuleType("playwright")
playwright.__path__ = []
api = types.ModuleType("playwright.async_api")
api.async_playwright = Mock()
api.Route = object
api.BrowserContext = object
environment = {"DOCKER_CONTAINER": "1"}
if allow_headed:
environment["ALLOW_DOCKER_HEADED_CAPTCHA"] = "true"

with (
patch.dict(config._config, {"captcha": {"browser_headless": headless}}),
patch.dict(os.environ, environment, clear=True),
patch.dict(
sys.modules,
{
spec.name: module,
"playwright": playwright,
"playwright.async_api": api,
},
),
patch(
"subprocess.run",
return_value=types.SimpleNamespace(
returncode=0, stdout=str(source), stderr=""
),
) as run,
patch("builtins.print"),
):
spec.loader.exec_module(module)

# Keep each imported module's runtime configuration independent.
module.config = types.SimpleNamespace(browser_headless=headless)
return module, run

def test_docker_headless_imports_and_runs_without_display(self):
for allow_headed in (False, True):
with self.subTest(allow_headed=allow_headed):
module, run = self.load_browser_module(
headless=True, allow_headed=allow_headed
)
self.assertTrue(module.PLAYWRIGHT_AVAILABLE)
self.assertIsNotNone(module.async_playwright)
# Browser detection is mocked; no package/browser installation runs.
run.assert_called_once()
self.assertEqual(run.call_args.args[0][1], "-c")
with patch.dict(os.environ, {"DISPLAY": ""}):
module.BrowserCaptchaService._check_available(None)

def test_docker_headed_stays_blocked_without_permission(self):
module, run = self.load_browser_module()
self.assertFalse(module.PLAYWRIGHT_AVAILABLE)
run.assert_not_called()
with patch.dict(os.environ, {"DISPLAY": ":99"}):
with self.assertRaisesRegex(RuntimeError, "ALLOW_DOCKER_HEADED_CAPTCHA"):
module.BrowserCaptchaService._check_available(None)

def test_docker_headed_still_requires_display(self):
module, _ = self.load_browser_module(allow_headed=True)
self.assertTrue(module.PLAYWRIGHT_AVAILABLE)
with patch.dict(os.environ, {"DISPLAY": ""}):
with self.assertRaisesRegex(RuntimeError, "DISPLAY"):
module.BrowserCaptchaService._check_available(None)
with patch.dict(os.environ, {"DISPLAY": ":99"}):
module.BrowserCaptchaService._check_available(None)

def test_headless_still_requires_playwright(self):
module, _ = self.load_browser_module(headless=True)
with patch.dict(os.environ, {"DISPLAY": ""}):
for available, runtime in ((False, object()), (True, None)):
with self.subTest(available=available, runtime=runtime):
module.PLAYWRIGHT_AVAILABLE = available
module.async_playwright = runtime
with self.assertRaisesRegex(RuntimeError, "playwright"):
module.BrowserCaptchaService._check_available(None)

def test_switching_to_headed_rechecks_docker_permission(self):
module, _ = self.load_browser_module(headless=True)
module.config.browser_headless = False
with patch.dict(os.environ, {"DISPLAY": ":99"}):
with self.assertRaisesRegex(RuntimeError, "ALLOW_DOCKER_HEADED_CAPTCHA"):
module.BrowserCaptchaService._check_available(None)


if __name__ == "__main__":
unittest.main()