GithubBackup/MoviePilot
1
0
Fork 0
mirror of https://github.com/jxxghp/MoviePilot.git synced 2026-07-02 13:21:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

optimize agent browser sessions

Browse Source
This commit is contained in:
jxxghp
2026-06-12 16:41:21 +08:00
parent dfabd695a8
commit a10361cc2f
5 changed files with 1131 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

435
app/agent/tools/impl/browse_webpage.py
View File

@@ -3,13 +3,13 @@
import base64
import json
from enum import Enum
from typing import Optional, Type
from typing import Any, Optional, Type
from pydantic import BaseModel, Field
from app.agent.tools.base import MoviePilotTool
from app.agent.tools.tags import ToolTag
from app.core.config import settings
from app.helper.browser import BrowserSessionHelper
from app.log import logger
# 页面内容最大长度
@@ -26,13 +26,22 @@ class BrowserAction(str, Enum):
"""浏览器操作类型"""
GOTO = "goto"
SNAPSHOT = "snapshot"
GET_CONTENT = "get_content"
SCREENSHOT = "screenshot"
CLICK = "click"
CLICK_REF = "click_ref"
FILL = "fill"
FILL_REF = "fill_ref"
SELECT = "select"
SELECT_REF = "select_ref"
EVALUATE = "evaluate"
WAIT = "wait"
LIST_TABS = "list_tabs"
OPEN_TAB = "open_tab"
FOCUS_TAB = "focus_tab"
CLOSE_TAB = "close_tab"
CLOSE_SESSION = "close_session"
class BrowseWebpageInput(BaseModel):
@@ -45,13 +54,22 @@ class BrowseWebpageInput(BaseModel):
description=(
"The browser action to perform. Available actions:\n"
"- 'goto': Navigate to a URL, returns page title and text summary\n"
"- 'snapshot': Get current page snapshot with interactive element refs\n"
"- 'get_content': Get current page content (text or HTML)\n"
"- 'screenshot': Take a screenshot of the current page, returns base64 image\n"
"- 'click': Click on an element specified by selector\n"
"- 'click_ref': Click an element by ref from the latest snapshot\n"
"- 'fill': Fill text into an input element specified by selector\n"
"- 'fill_ref': Fill text into an input element by ref from the latest snapshot\n"
"- 'select': Select an option from a dropdown element\n"
"- 'select_ref': Select an option by ref from the latest snapshot\n"
"- 'evaluate': Execute JavaScript code on the page and return the result\n"
"- 'wait': Wait for an element to appear on the page"
"- 'wait': Wait for an element to appear on the page\n"
"- 'list_tabs': List browser tabs in the current session\n"
"- 'open_tab': Open a new tab, optionally navigating to a URL\n"
"- 'focus_tab': Switch active tab by index\n"
"- 'close_tab': Close a tab by index\n"
"- 'close_session': Close the current browser session"
),
)
url: Optional[str] = Field(
@@ -62,6 +80,10 @@ class BrowseWebpageInput(BaseModel):
description="CSS selector or text selector for the target element (for 'click', 'fill', 'select', 'wait' actions). "
"Supports CSS selectors like '#id', '.class', 'tag', and Playwright text selectors like 'text=Click me'",
)
ref: Optional[str] = Field(
None,
description="Element ref returned by 'snapshot' or action results (for 'click_ref', 'fill_ref', 'select_ref')",
)
value: Optional[str] = Field(
None,
description="Value to fill into input or option value to select (for 'fill' and 'select' actions)",
@@ -85,6 +107,18 @@ class BrowseWebpageInput(BaseModel):
user_agent: Optional[str] = Field(
None, description="Custom User-Agent string for the browser context"
)
session_key: Optional[str] = Field(
None,
description="Browser session key. Defaults to the current agent session id.",
)
tab_index: Optional[int] = Field(
None,
description="Tab index for 'focus_tab' and 'close_tab' actions.",
)
allow_private_network: bool = Field(
False,
description="Allow browser navigation to localhost, loopback, private, or link-local addresses.",
)
class BrowseWebpageTool(MoviePilotTool):
@@ -96,11 +130,13 @@ class BrowseWebpageTool(MoviePilotTool):
description: str = (
"Control a real browser (Playwright) to interact with web pages. "
"Supports navigating to URLs, reading page content, taking screenshots, "
"clicking elements, filling forms, selecting dropdown options, executing JavaScript, and waiting for elements. "
"clicking elements, filling forms, selecting dropdown options, executing JavaScript, waiting for elements, "
"and managing tabs. "
"Use this tool when you need to interact with dynamic web pages, "
"fill in forms, click buttons, or extract content from JavaScript-rendered pages. "
"The browser session persists across multiple calls within the same conversation - "
"first call 'goto' to open a page, then use other actions to interact with it."
"first call 'goto' to open a page, inspect 'interactive_elements', then use *_ref actions when possible. "
"For safety, localhost and private network URLs are blocked by default unless allow_private_network is true."
)
args_schema: Type[BaseModel] = BrowseWebpageInput
@@ -111,13 +147,22 @@ class BrowseWebpageTool(MoviePilotTool):
selector = kwargs.get("selector", "")
action_messages = {
"goto": f"打开网页: {url}",
"snapshot": "读取页面快照",
"get_content": "获取页面内容",
"screenshot": "截取页面截图",
"click": f"点击元素: {selector}",
"click_ref": f"点击元素引用: {kwargs.get('ref', '')}",
"fill": f"填写表单: {selector}",
"fill_ref": f"填写元素引用: {kwargs.get('ref', '')}",
"select": f"选择选项: {selector}",
"select_ref": f"选择元素引用: {kwargs.get('ref', '')}",
"evaluate": "执行 JavaScript",
"wait": f"等待元素: {selector}",
"list_tabs": "列出浏览器标签页",
"open_tab": f"打开新标签页: {url}",
"focus_tab": f"切换浏览器标签页: {kwargs.get('tab_index', '')}",
"close_tab": f"关闭浏览器标签页: {kwargs.get('tab_index', '')}",
"close_session": "关闭浏览器会话",
}
return action_messages.get(action, f"执行浏览器操作: {action}")
@@ -126,12 +171,16 @@ class BrowseWebpageTool(MoviePilotTool):
action: str,
url: Optional[str] = None,
selector: Optional[str] = None,
ref: Optional[str] = None,
value: Optional[str] = None,
script: Optional[str] = None,
content_type: Optional[str] = "text",
timeout: Optional[int] = DEFAULT_TIMEOUT,
cookies: Optional[str] = None,
user_agent: Optional[str] = None,
session_key: Optional[str] = None,
tab_index: Optional[int] = None,
allow_private_network: bool = False,
**kwargs,
) -> str:
"""执行浏览器操作"""
@@ -150,6 +199,8 @@ class BrowseWebpageTool(MoviePilotTool):
# 参数校验
if browser_action == BrowserAction.GOTO and not url:
return "错误: 'goto' 操作需要提供 url 参数"
if browser_action == BrowserAction.OPEN_TAB and not url:
return "错误: 'open_tab' 操作需要提供 url 参数"
if (
browser_action
in (
@@ -161,10 +212,29 @@ class BrowseWebpageTool(MoviePilotTool):
and not selector
):
return f"错误: '{action}' 操作需要提供 selector 参数"
if (
browser_action
in (
BrowserAction.CLICK_REF,
BrowserAction.FILL_REF,
BrowserAction.SELECT_REF,
)
and not ref
):
return f"错误: '{action}' 操作需要提供 ref 参数"
if browser_action == BrowserAction.FILL and value is None:
return "错误: 'fill' 操作需要提供 value 参数"
if browser_action == BrowserAction.FILL_REF and value is None:
return "错误: 'fill_ref' 操作需要提供 value 参数"
if browser_action == BrowserAction.EVALUATE and not script:
return "错误: 'evaluate' 操作需要提供 script 参数"
if (
browser_action in (BrowserAction.FOCUS_TAB, BrowserAction.CLOSE_TAB)
and tab_index is None
):
return f"错误: '{action}' 操作需要提供 tab_index 参数"
effective_session_key = session_key or self._session_id
result = await self.run_blocking(
"web",
@@ -172,12 +242,16 @@ class BrowseWebpageTool(MoviePilotTool):
browser_action=browser_action,
url=url,
selector=selector,
ref=ref,
value=value,
script=script,
content_type=content_type,
timeout=timeout,
cookies=cookies,
user_agent=user_agent,
session_key=effective_session_key,
tab_index=tab_index,
allow_private_network=allow_private_network,
)
return result
@@ -190,65 +264,61 @@ class BrowseWebpageTool(MoviePilotTool):
browser_action: BrowserAction,
url: Optional[str],
selector: Optional[str],
ref: Optional[str],
value: Optional[str],
script: Optional[str],
content_type: Optional[str],
timeout: int,
cookies: Optional[str],
user_agent: Optional[str],
session_key: str,
tab_index: Optional[int],
allow_private_network: bool,
) -> str:
"""在同步上下文中执行 CloakBrowser 浏览器操作"""
from cloakbrowser import launch_context
try:
context = None
page = None
try:
context_kwargs = {
"viewport": {
"width": SCREENSHOT_MAX_WIDTH,
"height": SCREENSHOT_MAX_HEIGHT,
if browser_action == BrowserAction.CLOSE_SESSION:
closed = BrowserSessionHelper.close_session(session_key)
message = "浏览器会话已关闭" if closed else "浏览器会话不存在"
return self._json_response(
{
"success": closed,
"message": message,
}
}
if user_agent:
context_kwargs["user_agent"] = user_agent
context = launch_context(
headless=True,
humanize=settings.CLOAKBROWSER_HUMANIZE,
human_preset=settings.CLOAKBROWSER_HUMAN_PRESET,
**context_kwargs,
)
page = context.new_page()
page.set_default_timeout(timeout * 1000)
# 设置 cookies
if cookies:
page.set_extra_http_headers({"cookie": cookies})
helper = BrowserSessionHelper(
headless=True,
viewport={
"width": SCREENSHOT_MAX_WIDTH,
"height": SCREENSHOT_MAX_HEIGHT,
},
)
# 对于非 goto 操作，如果提供了 url 先导航
if url and browser_action != BrowserAction.GOTO:
page.goto(url, wait_until="domcontentloaded", timeout=timeout * 1000)
page.wait_for_load_state("networkidle", timeout=timeout * 1000)
# 执行具体操作
result = self._do_action(
page,
browser_action,
url,
selector,
value,
script,
content_type,
timeout,
def _callback(session) -> str:
return self._do_action(
helper=helper,
session=session,
browser_action=browser_action,
url=url,
selector=selector,
ref=ref,
value=value,
script=script,
content_type=content_type,
timeout=timeout,
tab_index=tab_index,
allow_private_network=allow_private_network,
)
return result
finally:
if page:
page.close()
if context:
context.close()
return helper.with_session(
session_key=session_key,
callback=_callback,
user_agent=user_agent,
cookies=cookies,
timeout=timeout,
)
except Exception as e:
logger.error(f"CloakBrowser 执行失败: {e}", exc_info=True)
@@ -256,19 +326,38 @@ class BrowseWebpageTool(MoviePilotTool):
def _do_action(
self,
page,
helper: BrowserSessionHelper,
session,
browser_action: BrowserAction,
url: Optional[str],
selector: Optional[str],
ref: Optional[str],
value: Optional[str],
script: Optional[str],
content_type: Optional[str],
timeout: int,
tab_index: Optional[int],
allow_private_network: bool,
) -> str:
"""执行具体的浏览器操作"""
page = session.active_page
if browser_action == BrowserAction.GOTO:
return self._action_goto(page, url, timeout)
return self._action_goto(
helper,
page,
url,
timeout,
allow_private_network=allow_private_network,
)
elif browser_action == BrowserAction.SNAPSHOT:
return self._json_response(
BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
)
)
elif browser_action == BrowserAction.GET_CONTENT:
return self._action_get_content(page, content_type)
@@ -279,89 +368,113 @@ class BrowseWebpageTool(MoviePilotTool):
elif browser_action == BrowserAction.CLICK:
return self._action_click(page, selector, timeout)
elif browser_action == BrowserAction.CLICK_REF:
return self._action_click(
page,
BrowserSessionHelper.ref_to_selector(ref),
timeout,
ref=ref,
)
elif browser_action == BrowserAction.FILL:
return self._action_fill(page, selector, value, timeout)
elif browser_action == BrowserAction.FILL_REF:
return self._action_fill(
page,
BrowserSessionHelper.ref_to_selector(ref),
value,
timeout,
ref=ref,
)
elif browser_action == BrowserAction.SELECT:
return self._action_select(page, selector, value, timeout)
elif browser_action == BrowserAction.SELECT_REF:
return self._action_select(
page,
BrowserSessionHelper.ref_to_selector(ref),
value,
timeout,
ref=ref,
)
elif browser_action == BrowserAction.EVALUATE:
return self._action_evaluate(page, script)
elif browser_action == BrowserAction.WAIT:
return self._action_wait(page, selector, timeout)
elif browser_action == BrowserAction.LIST_TABS:
return self._json_response({"tabs": BrowserSessionHelper.list_tabs(session)})
elif browser_action == BrowserAction.OPEN_TAB:
page = helper.open_tab(
session,
url=url,
timeout=timeout,
allow_private_network=allow_private_network,
)
return self._json_response(
{
"success": True,
"active_tab": session.active_index,
"tabs": BrowserSessionHelper.list_tabs(session),
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
elif browser_action == BrowserAction.FOCUS_TAB:
page = BrowserSessionHelper.focus_tab(session, tab_index)
return self._json_response(
{
"success": True,
"active_tab": session.active_index,
"tabs": BrowserSessionHelper.list_tabs(session),
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
elif browser_action == BrowserAction.CLOSE_TAB:
tabs = BrowserSessionHelper.close_tab(session, tab_index)
return self._json_response({"success": True, "tabs": tabs})
return f"未知操作: {browser_action}"
@staticmethod
def _action_goto(page, url: str, timeout: int) -> str:
def _json_response(payload: dict[str, Any]) -> str:
"""返回格式化 JSON 字符串"""
return json.dumps(payload, ensure_ascii=False, indent=2)
@staticmethod
def _action_goto(
helper: BrowserSessionHelper,
page,
url: str,
timeout: int,
allow_private_network: bool,
) -> str:
"""导航到URL"""
response = page.goto(url, wait_until="domcontentloaded", timeout=timeout * 1000)
try:
page.wait_for_load_state("networkidle", timeout=min(timeout, 15) * 1000)
except Exception:
# networkidle 超时不是致命错误，页面可能已经可用
pass
response = helper.goto(
page,
url,
timeout=timeout,
allow_private_network=allow_private_network,
)
status = response.status if response else "unknown"
title = page.title()
page_url = page.url
# 提取页面可读文本摘要
text_content = page.inner_text("body")
if text_content and len(text_content) > MAX_CONTENT_LENGTH:
text_content = text_content[:MAX_CONTENT_LENGTH] + "\n\n...(内容已截断)"
# 提取页面链接
links = page.evaluate("""
() => {
const links = [];
document.querySelectorAll('a[href]').forEach(a => {
const text = a.innerText.trim();
const href = a.href;
if (text && href && !href.startsWith('javascript:')) {
links.push({text: text.substring(0, 80), href: href});
}
});
return links.slice(0, 30);
}
""")
# 提取表单信息
forms = page.evaluate("""
() => {
const forms = [];
document.querySelectorAll('input, textarea, select, button').forEach(el => {
const info = {
tag: el.tagName.toLowerCase(),
type: el.type || '',
name: el.name || '',
id: el.id || '',
placeholder: el.placeholder || '',
value: el.tagName.toLowerCase() === 'select' ? '' : (el.value || '').substring(0, 50),
text: el.innerText ? el.innerText.trim().substring(0, 50) : ''
};
// 只保留有标识信息的元素
if (info.name || info.id || info.placeholder || info.text) {
forms.push(info);
}
});
return forms.slice(0, 30);
}
""")
result = {
"status": status,
"url": page_url,
"title": title,
"text_content": text_content,
}
if links:
result["links"] = links
if forms:
result["form_elements"] = forms
return json.dumps(result, ensure_ascii=False, indent=2)
result = BrowserSessionHelper.build_snapshot(
page,
status=status,
max_text_chars=MAX_CONTENT_LENGTH,
)
return BrowseWebpageTool._json_response(result)
@staticmethod
def _action_get_content(page, content_type: Optional[str]) -> str:
@@ -383,7 +496,7 @@ class BrowseWebpageTool(MoviePilotTool):
"content_type": content_type,
"content": content,
}
return json.dumps(result, ensure_ascii=False, indent=2)
return BrowseWebpageTool._json_response(result)
@staticmethod
def _action_screenshot(page) -> str:
@@ -416,10 +529,15 @@ class BrowseWebpageTool(MoviePilotTool):
"format": "jpeg",
"note": "截图已以 base64 编码返回",
}
return json.dumps(result, ensure_ascii=False, indent=2)
return BrowseWebpageTool._json_response(result)
@staticmethod
def _action_click(page, selector: str, timeout: int) -> str:
def _action_click(
page,
selector: str,
timeout: int,
ref: Optional[str] = None,
) -> str:
"""点击元素"""
page.click(selector, timeout=timeout * 1000)
@@ -429,49 +547,62 @@ class BrowseWebpageTool(MoviePilotTool):
except Exception:
pass
title = page.title()
page_url = page.url
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": True,
"message": f"成功点击元素: {selector}",
"current_url": page_url,
"current_title": title,
},
ensure_ascii=False,
indent=2,
"message": f"成功点击元素: {ref or selector}",
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
@staticmethod
def _action_fill(page, selector: str, value: str, timeout: int) -> str:
def _action_fill(
page,
selector: str,
value: str,
timeout: int,
ref: Optional[str] = None,
) -> str:
"""填写表单"""
page.fill(selector, value, timeout=timeout * 1000)
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": True,
"message": f"成功填写元素 '{selector}' 的值为 '{value}'",
},
ensure_ascii=False,
indent=2,
"message": f"成功填写元素 '{ref or selector}'",
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
@staticmethod
def _action_select(page, selector: str, value: Optional[str], timeout: int) -> str:
def _action_select(
page,
selector: str,
value: Optional[str],
timeout: int,
ref: Optional[str] = None,
) -> str:
"""选择下拉选项"""
if value:
page.select_option(selector, value=value, timeout=timeout * 1000)
else:
return "错误: 'select' 操作需要提供 value 参数"
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": True,
"message": f"成功选择元素 '{selector}' 的选项 '{value}'",
},
ensure_ascii=False,
indent=2,
"message": f"成功选择元素 '{ref or selector}' 的选项 '{value}'",
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
@staticmethod
@@ -491,13 +622,11 @@ class BrowseWebpageTool(MoviePilotTool):
if len(formatted) > MAX_CONTENT_LENGTH:
formatted = formatted[:MAX_CONTENT_LENGTH] + "\n\n...(结果已截断)"
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": True,
"result": formatted,
},
ensure_ascii=False,
indent=2,
}
)
@staticmethod
@@ -511,22 +640,22 @@ class BrowseWebpageTool(MoviePilotTool):
if text and len(text) > 200:
text = text[:200] + "..."
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": True,
"message": f"元素 '{selector}' 已出现",
"visible": visible,
"text": text,
},
ensure_ascii=False,
indent=2,
"snapshot": BrowserSessionHelper.build_snapshot(
page,
max_text_chars=MAX_CONTENT_LENGTH,
),
}
)
else:
return json.dumps(
return BrowseWebpageTool._json_response(
{
"success": False,
"message": f"等待元素 '{selector}' 超时",
},
ensure_ascii=False,
indent=2,
}
)

552
app/helper/browser.py
View File

@@ -1,5 +1,10 @@
import ipaddress
import threading
import time
import uuid
from typing import Callable, Any, Optional, Protocol
from dataclasses import dataclass, field
from typing import Any, Callable, Optional, Protocol
from urllib.parse import urlparse
from app.core.config import settings
from app.log import logger
@@ -12,9 +17,15 @@ class BrowserElement(Protocol):
"""
def is_visible(self) -> bool:
"""判断元素是否可见。"""
...
def fill(self, value: str) -> None:
"""向元素输入文本。"""
...
def inner_text(self) -> str:
"""获取元素可见文本。"""
...
@@ -24,12 +35,15 @@ class BrowserContext(Protocol):
"""
def new_page(self) -> "BrowserPage":
"""创建新的浏览器页面。"""
...
def cookies(self) -> list[dict[str, Any]]:
"""返回当前上下文 Cookie。"""
...
def close(self) -> None:
"""关闭浏览器上下文。"""
...
@@ -42,36 +56,572 @@ class BrowserPage(Protocol):
url: str
def set_extra_http_headers(self, headers: dict[str, str]) -> None:
"""设置页面额外请求头。"""
...
def set_default_timeout(self, timeout: int) -> None:
"""设置页面默认超时时间。"""
...
def goto(self, url: str, *args: Any, **kwargs: Any) -> Any:
"""导航到指定 URL。"""
...
def wait_for_load_state(self, state: str, *args: Any, **kwargs: Any) -> Any:
"""等待页面加载状态。"""
...
def wait_for_selector(self, selector: str, *args: Any, **kwargs: Any) -> Any:
"""等待指定选择器出现。"""
...
def fill(self, selector: str, value: str, *args: Any, **kwargs: Any) -> Any:
"""向指定选择器输入文本。"""
...
def click(self, selector: str, *args: Any, **kwargs: Any) -> Any:
"""点击指定选择器。"""
...
def select_option(self, selector: str, *args: Any, **kwargs: Any) -> Any:
"""选择下拉框选项。"""
...
def query_selector(self, selector: str) -> Optional[BrowserElement]:
"""查询指定选择器元素。"""
...
def title(self) -> str:
"""返回页面标题。"""
...
def inner_text(self, selector: str) -> str:
"""返回指定选择器的可见文本。"""
...
def content(self) -> str:
"""返回页面 HTML 内容。"""
...
def evaluate(self, expression: str, *args: Any, **kwargs: Any) -> Any:
"""执行页面 JavaScript 表达式。"""
...
def screenshot(self, *args: Any, **kwargs: Any) -> bytes:
"""截取页面截图。"""
...
def close(self) -> None:
"""关闭浏览器页面。"""
...
@dataclass
class _BrowserSessionState:
session_key: str
context: BrowserContext
pages: list[BrowserPage]
active_index: int = 0
user_agent: Optional[str] = None
cookies: Optional[str] = None
created_at: float = field(default_factory=time.monotonic)
last_used_at: float = field(default_factory=time.monotonic)
lock: threading.RLock = field(default_factory=threading.RLock)
@property
def active_page(self) -> BrowserPage:
return self.pages[self.active_index]
class BrowserSessionHelper:
"""
Agent 浏览器会话辅助类，负责复用 CloakBrowser 上下文并生成可操作页面快照。
"""
SESSION_TTL_SECONDS = 15 * 60
MAX_SESSIONS = 8
DEFAULT_VIEWPORT = {"width": 1280, "height": 720}
PRIVATE_HOST_SUFFIXES = (".localhost", ".local", ".lan", ".home", ".internal")
PRIVATE_HOSTNAMES = {"localhost", "ip6-localhost", "ip6-loopback"}
REF_ATTRIBUTE = "data-moviepilot-agent-ref"
_sessions: dict[str, _BrowserSessionState] = {}
_sessions_lock = threading.RLock()
def __init__(self, headless: bool = True, viewport: Optional[dict[str, int]] = None):
"""
初始化浏览器会话辅助类。
:param headless: 是否使用无头浏览器
:param viewport: 默认视口大小
"""
self.headless = headless
self.viewport = viewport or self.DEFAULT_VIEWPORT
@classmethod
def validate_url(cls, url: str, allow_private_network: bool = False) -> str:
"""
校验浏览器可访问的 URL，默认拒绝本机、私网和非 HTTP 协议。
:param url: 待访问的 URL
:param allow_private_network: 是否允许访问本机或私网地址
:return: 原始 URL
"""
parsed = urlparse(url or "")
if parsed.scheme not in {"http", "https"}:
raise ValueError("仅支持 http/https URL")
if not parsed.hostname:
raise ValueError("URL 缺少主机名")
hostname = parsed.hostname.lower().rstrip(".")
if allow_private_network:
return url
if hostname in cls.PRIVATE_HOSTNAMES or hostname.endswith(
cls.PRIVATE_HOST_SUFFIXES
):
raise ValueError("默认不允许访问本机或私网地址")
try:
ip_address = ipaddress.ip_address(hostname)
except ValueError:
return url
if not ip_address.is_global:
raise ValueError("默认不允许访问本机或私网地址")
return url
@classmethod
def ref_to_selector(cls, ref: str) -> str:
"""
将页面快照中的元素引用转换为稳定选择器。
:param ref: 快照返回的元素引用
:return: 可传给浏览器的属性选择器
"""
clean_ref = (ref or "").strip()
if not clean_ref:
raise ValueError("元素 ref 不能为空")
escaped_ref = clean_ref.replace("\\", "\\\\").replace('"', '\\"')
return f'[{cls.REF_ATTRIBUTE}="{escaped_ref}"]'
@classmethod
def close_all_sessions(cls) -> None:
"""
关闭所有 Agent 浏览器会话。
"""
with cls._sessions_lock:
session_keys = list(cls._sessions.keys())
for session_key in session_keys:
cls.close_session(session_key)
@classmethod
def close_session(cls, session_key: str) -> bool:
"""
关闭指定 Agent 浏览器会话。
:param session_key: 会话标识
:return: 找到并关闭会话时返回 True
"""
with cls._sessions_lock:
session = cls._sessions.pop(session_key, None)
if not session:
return False
cls._close_session_state(session)
return True
def with_session(
self,
session_key: str,
callback: Callable[[_BrowserSessionState], Any],
user_agent: Optional[str] = None,
cookies: Optional[str] = None,
timeout: Optional[int] = 30,
) -> Any:
"""
获取或创建浏览器会话，并在持有会话锁时执行回调。
:param session_key: 会话标识
:param callback: 使用浏览器会话执行操作的回调函数
:param user_agent: 新建会话时使用的 User-Agent
:param cookies: 本次操作要注入的 Cookie 请求头
:param timeout: 默认操作超时时间，单位秒
:return: 回调函数返回值
"""
self._prune_sessions()
session = self._get_or_create_session(
session_key=session_key,
user_agent=user_agent,
cookies=cookies,
)
with session.lock:
session.last_used_at = time.monotonic()
if timeout and hasattr(session.active_page, "set_default_timeout"):
session.active_page.set_default_timeout(int(timeout) * 1000)
if cookies:
session.cookies = cookies
session.active_page.set_extra_http_headers({"cookie": cookies})
return callback(session)
def open_tab(
self,
session: _BrowserSessionState,
url: Optional[str] = None,
timeout: Optional[int] = 30,
allow_private_network: bool = False,
) -> BrowserPage:
"""
在当前会话中新建标签页，并可选导航到指定 URL。
:param session: 当前浏览器会话
:param url: 可选的目标 URL
:param timeout: 导航超时时间，单位秒
:param allow_private_network: 是否允许访问本机或私网地址
:return: 新建的页面对象
"""
page = session.context.new_page()
if timeout and hasattr(page, "set_default_timeout"):
page.set_default_timeout(int(timeout) * 1000)
if session.cookies:
page.set_extra_http_headers({"cookie": session.cookies})
session.pages.append(page)
session.active_index = len(session.pages) - 1
if url:
self.goto(
page,
url,
timeout=timeout,
allow_private_network=allow_private_network,
)
return page
@staticmethod
def list_tabs(session: _BrowserSessionState) -> list[dict[str, Any]]:
"""
列出当前浏览器会话中的标签页。
:param session: 当前浏览器会话
:return: 标签页摘要列表
"""
tabs = []
for index, page in enumerate(session.pages):
tabs.append(
{
"index": index,
"active": index == session.active_index,
"url": getattr(page, "url", ""),
"title": BrowserSessionHelper._safe_page_title(page),
}
)
return tabs
@staticmethod
def focus_tab(session: _BrowserSessionState, tab_index: int) -> BrowserPage:
"""
切换当前会话的活动标签页。
:param session: 当前浏览器会话
:param tab_index: 标签页索引
:return: 切换后的页面对象
"""
if tab_index < 0 or tab_index >= len(session.pages):
raise ValueError(f"标签页索引不存在: {tab_index}")
session.active_index = tab_index
return session.active_page
@staticmethod
def close_tab(session: _BrowserSessionState, tab_index: int) -> list[dict[str, Any]]:
"""
关闭当前会话中的指定标签页。
:param session: 当前浏览器会话
:param tab_index: 标签页索引
:return: 关闭后的标签页列表
"""
if tab_index < 0 or tab_index >= len(session.pages):
raise ValueError(f"标签页索引不存在: {tab_index}")
page = session.pages.pop(tab_index)
try:
page.close()
except Exception as err:
logger.warning(f"关闭浏览器标签页失败: {str(err)}")
if not session.pages:
session.pages.append(session.context.new_page())
session.active_index = min(session.active_index, len(session.pages) - 1)
return BrowserSessionHelper.list_tabs(session)
def goto(
self,
page: BrowserPage,
url: str,
timeout: Optional[int] = 30,
allow_private_network: bool = False,
) -> Any:
"""
校验并导航页面到指定 URL。
:param page: 页面对象
:param url: 目标 URL
:param timeout: 导航超时时间，单位秒
:param allow_private_network: 是否允许访问本机或私网地址
:return: 浏览器导航响应对象
"""
self.validate_url(url, allow_private_network=allow_private_network)
response = page.goto(
url,
wait_until="domcontentloaded",
timeout=int(timeout or 30) * 1000,
)
try:
page.wait_for_load_state(
"networkidle",
timeout=min(int(timeout or 30), 15) * 1000,
)
except Exception:
pass
self.validate_current_url(page, allow_private_network=allow_private_network)
return response
@classmethod
def validate_current_url(
cls, page: BrowserPage, allow_private_network: bool = False
) -> None:
"""
校验当前页面地址，捕获跳转后的不安全目标。
:param page: 页面对象
:param allow_private_network: 是否允许访问本机或私网地址
"""
current_url = getattr(page, "url", "")
if current_url and current_url.startswith(("http://", "https://")):
cls.validate_url(current_url, allow_private_network=allow_private_network)
@classmethod
def build_snapshot(
cls,
page: BrowserPage,
status: Optional[Any] = None,
max_text_chars: int = 8000,
max_elements: int = 40,
) -> dict[str, Any]:
"""
构建包含可读文本和可交互元素 ref 的页面快照。
:param page: 页面对象
:param status: 可选的导航状态码
:param max_text_chars: 页面文本最大返回长度
:param max_elements: 最大可交互元素数量
:return: 页面快照字典
"""
text_content = cls._safe_inner_text(page, "body")
result = {
"url": getattr(page, "url", ""),
"title": cls._safe_page_title(page),
"text_content": cls._truncate_text(text_content, max_text_chars),
"interactive_elements": cls._extract_interactive_elements(
page, max_elements=max_elements
),
}
if status is not None:
result["status"] = status
links = [
{
"ref": element.get("ref"),
"text": element.get("text"),
"href": element.get("href"),
}
for element in result["interactive_elements"]
if element.get("tag") == "a" and element.get("href")
][:30]
forms = [
element
for element in result["interactive_elements"]
if element.get("tag") in {"input", "textarea", "select", "button"}
][:30]
if links:
result["links"] = links
if forms:
result["form_elements"] = forms
return result
@staticmethod
def _launch_context(
headless: bool,
user_agent: Optional[str] = None,
viewport: Optional[dict[str, int]] = None,
) -> BrowserContext:
from cloakbrowser import launch_context
context_kwargs = {
"headless": headless,
"humanize": settings.CLOAKBROWSER_HUMANIZE,
"human_preset": settings.CLOAKBROWSER_HUMAN_PRESET,
}
if user_agent:
context_kwargs["user_agent"] = user_agent
if viewport:
context_kwargs["viewport"] = viewport
return launch_context(**context_kwargs)
def _get_or_create_session(
self,
session_key: str,
user_agent: Optional[str] = None,
cookies: Optional[str] = None,
) -> _BrowserSessionState:
with self._sessions_lock:
session = self._sessions.get(session_key)
if session and user_agent and session.user_agent != user_agent:
self._sessions.pop(session_key, None)
self._close_session_state(session)
session = None
if session:
return session
context = self._launch_context(
headless=self.headless,
user_agent=user_agent,
viewport=self.viewport,
)
page = context.new_page()
if cookies:
page.set_extra_http_headers({"cookie": cookies})
session = _BrowserSessionState(
session_key=session_key,
context=context,
pages=[page],
user_agent=user_agent,
cookies=cookies,
)
self._sessions[session_key] = session
self._enforce_session_limit()
return session
@classmethod
def _prune_sessions(cls) -> None:
now = time.monotonic()
with cls._sessions_lock:
expired_keys = [
session_key
for session_key, session in cls._sessions.items()
if now - session.last_used_at > cls.SESSION_TTL_SECONDS
]
for session_key in expired_keys:
cls.close_session(session_key)
@classmethod
def _enforce_session_limit(cls) -> None:
while len(cls._sessions) > cls.MAX_SESSIONS:
oldest_key = min(
cls._sessions,
key=lambda key: cls._sessions[key].last_used_at,
)
session = cls._sessions.pop(oldest_key)
cls._close_session_state(session)
@staticmethod
def _close_session_state(session: _BrowserSessionState) -> None:
with session.lock:
for page in list(session.pages):
try:
page.close()
except Exception as err:
logger.warning(f"关闭浏览器页面失败: {str(err)}")
try:
session.context.close()
except Exception as err:
logger.warning(f"关闭浏览器上下文失败: {str(err)}")
@staticmethod
def _safe_page_title(page: BrowserPage) -> str:
try:
return page.title()
except Exception:
return ""
@staticmethod
def _safe_inner_text(page: BrowserPage, selector: str) -> str:
try:
return page.inner_text(selector)
except Exception:
return ""
@staticmethod
def _truncate_text(text: Optional[str], max_chars: int) -> str:
if not text:
return ""
if len(text) <= max_chars:
return text
return text[:max_chars] + "\n\n...(内容已截断)"
@classmethod
def _extract_interactive_elements(
cls, page: BrowserPage, max_elements: int
) -> list[dict[str, Any]]:
script = f"""
() => {{
const limit = {int(max_elements)};
const selector = [
'a[href]',
'button',
'input',
'textarea',
'select',
'[role="button"]',
'[role="link"]',
'[onclick]',
'summary'
].join(',');
const isVisible = (el) => {{
const style = window.getComputedStyle(el);
const rect = el.getBoundingClientRect();
return style && style.visibility !== 'hidden'
&& style.display !== 'none'
&& rect.width > 0
&& rect.height > 0;
}};
return Array.from(document.querySelectorAll(selector))
.filter(isVisible)
.slice(0, limit)
.map((el, index) => {{
const ref = `e${{index + 1}}`;
el.setAttribute('{cls.REF_ATTRIBUTE}', ref);
const tag = el.tagName.toLowerCase();
const text = (
el.innerText
|| el.value
|| el.getAttribute('aria-label')
|| el.getAttribute('title')
|| el.getAttribute('placeholder')
|| ''
).trim();
return {{
ref,
tag,
type: el.type || '',
text: text.substring(0, 120),
name: el.name || '',
id: el.id || '',
role: el.getAttribute('role') || '',
placeholder: el.getAttribute('placeholder') || '',
href: el.href || '',
value: tag === 'select' ? '' : (el.value || '').substring(0, 80),
selector: `[${cls.REF_ATTRIBUTE}="${{ref}}"]`
}};
}});
}}
"""
try:
elements = page.evaluate(script)
except Exception as err:
logger.debug(f"提取页面可交互元素失败: {str(err)}")
return []
if not isinstance(elements, list):
return []
return elements
class PlaywrightHelper:
def __init__(self, browser_type: Optional[str] = None, *args, **kwargs):
"""