Files
searxng-use-cli/scripts/fetch.py
T
thzxx 6cedba9042 fix: 文档解析链路修复 —— 缺失导入 + 静默吞错
- fetch.py: 补全 subprocess/zipfile/xml.etree.ElementTree/io 导入
  (PDF/DOCX/XLSX 解析此前直接 NameError)
- fetch.py main(): 检查 FetchResult.error_code, 文档解析失败不再
  静默输出空内容 + exit 0, 改为明确报错并 exit 1
- search.py fetch_page(): 同样检查 error_code, 修复 --fetch 抓取
  PDF 失败被误报 status=ok 的问题
- _parse_document_content: image/audio/video/* 类型统一返回
  E_UNSUPPORTED_MEDIA (此前退化为乱码文本)
2026-08-03 17:51:05 +08:00

1333 lines
55 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#!/usr/bin/env python3
"""Fetch a web page and extract readable content.
Downloads page content via HTTP GET and extracts clean, readable text.
Strips navigation, ads, scripts, and other boilerplate using heuristic rules.
Dependencies: Python 3.8+ stdlib. Install `requests` and `beautifulsoup4`
for improved extraction quality (optional, falls back to stdlib).
"""
import argparse
import gzip
import io
import logging
import random
import re
import subprocess
import sys
import time
import urllib.error
import urllib.request
import xml.etree.ElementTree as ET
import zipfile
import zlib
from collections import namedtuple
from html.parser import HTMLParser
from pathlib import Path
from typing import Optional
# Brotli 解压支持检测(v2.2.1)。
# requests 自动解压 gzip/deflate,但**不自动解压 Brotli**(除非安装
# brotli/brotlicffi)。build_browser_headers() 已根据此检测智能声明
# Accept-Encoding,此处作为双保险:若代理/CDN 强制返回 br,仍可解压。
try:
import brotli as _brotli # type: ignore
_HAS_BROTLI = True
except ImportError:
try:
import brotlicffi as _brotli # type: ignore
_HAS_BROTLI = True
except ImportError:
_brotli = None
_HAS_BROTLI = False
# Allow running standalone from any working directory
sys.path.insert(0, str(Path(__file__).resolve().parent))
from _config import USER_AGENT, VERSION
from common import (
FALLBACK_UAS,
RETRYABLE_STATUS,
RETRY_BACKOFF_BASE,
apply_proxy,
build_auth_headers,
build_browser_headers,
build_wayback_url,
compute_backoff_delay,
detect_charset,
force_utf8_stdout,
get_ua_for_domain,
is_hard_blocked_domain,
is_retryable_error,
parse_retry_after,
resolve_auth_basic,
resolve_auth_bearer,
setup_logging,
should_try_wayback,
)
logger = logging.getLogger("searxng.fetch")
# 错误码:不支持的媒体类型(PDF/DOCX/XLSX 解析失败或未知二进制类型)。
# 与 common.py 中 E_CONFIG / E_AUTH / E_NETWORK 等错误码保持一致的 E_* 命名模式。
E_UNSUPPORTED_MEDIA = "E_UNSUPPORTED_MEDIA"
# ----- Auth helpers -----
# build_auth_headers is imported from common.py
# ----- stdlib HTML-to-text extractor -----
class TextExtractor(HTMLParser):
"""Extract visible text from HTML, skipping non-content elements."""
SKIP_TAGS = {"script", "style", "nav", "footer", "header",
"noscript", "iframe", "svg", "canvas", "template"}
BLOCK_TAGS = {"p", "div", "article", "section", "li", "h1", "h2", "h3",
"h4", "h5", "h6", "blockquote", "pre", "table", "tr",
"br", "hr", "main", "aside", "form", "fieldset"}
def __init__(self):
super().__init__()
self._skip_depth = 0
self._lines = []
self._current_line = []
self._block_pending = False
def handle_starttag(self, tag, attrs):
tag_lower = tag.lower()
if tag_lower in self.SKIP_TAGS:
self._skip_depth += 1
elif tag_lower in self.BLOCK_TAGS:
self._flush_line()
self._block_pending = True
def handle_endtag(self, tag):
tag_lower = tag.lower()
if tag_lower in self.SKIP_TAGS and self._skip_depth > 0:
self._skip_depth -= 1
elif tag_lower in self.BLOCK_TAGS:
self._flush_line()
def handle_data(self, data):
if self._skip_depth > 0:
return
text = data.strip()
if text:
self._current_line.append(text)
self._block_pending = False
def _flush_line(self):
if self._current_line:
self._lines.append(" ".join(self._current_line))
self._current_line = []
if self._block_pending:
self._lines.append("")
self._block_pending = False
def get_text(self) -> str:
self._flush_line()
text = "\n".join(self._lines)
text = re.sub(r"\n{3,}", "\n\n", text)
return text.strip()
# ----- Enhanced extraction with BeautifulSoup (optional) -----
_HAS_BS4 = False
_HAS_REQUESTS = False
try:
import requests as _requests
_HAS_REQUESTS = True
except ImportError:
pass
try:
from bs4 import BeautifulSoup as _BeautifulSoup
_HAS_BS4 = True
except ImportError:
pass
def extract_with_stdlib(html_content: str) -> str:
"""Extract text using stdlib HTMLParser."""
extractor = TextExtractor()
extractor.feed(html_content)
return extractor.get_text()
def extract_with_bs4(html_content: str) -> str:
"""Extract text using BeautifulSoup for better quality.
v2.0.0 增强:当 article/main/role=main/content 类 div 都找不到时,
使用 readability-lite 文本密度算法从 body 中选择最可能是正文的
子元素,避免回退到整个 body 导致噪声(导航/侧边栏/页脚)污染输出。
"""
soup = _BeautifulSoup(html_content, "html.parser")
for tag in soup(["script", "style", "nav", "footer", "header",
"noscript", "iframe", "svg", "canvas"]):
tag.decompose()
main = (soup.find("article") or
soup.find("main") or
soup.find(role="main") or
soup.find("div", class_=re.compile(r"content|article|post|entry")) or
soup.body)
if main is None:
main = soup
# v2.0.0: 如果 main 是 body(兜底),用 readability-lite 提取正文
if main.name == "body":
main = _readability_lite(main) or main
text = main.get_text(separator="\n", strip=True)
lines = [line.strip() for line in text.split("\n") if line.strip()]
text = "\n".join(lines)
text = re.sub(r"\n{3,}", "\n\n", text)
return text
# CJK 字符范围:中文 \u4e00-\u9fff、日文 \u3040-\u30ff、韩文 \uac00-\ud7af
_CJK_CHAR_RE = re.compile(
r"[\u4e00-\u9fff\u3040-\u30ff\uac00-\ud7af]"
)
def _is_cjk_text(text: str) -> bool:
"""判断文本是否以 CJK(中文/日文/韩文)为主。
统计 CJK 字符占非空白字符的比例,>30% 则视为 CJK 内容。
CJK 文本信息密度高,readability-lite 的最小字符阈值应相应降低。
"""
if not text:
return False
# 按非空白字符统计,避免大量空白/缩进拉低比例造成误判
non_ws_len = sum(1 for ch in text if not ch.isspace())
if non_ws_len == 0:
return False
cjk_count = len(_CJK_CHAR_RE.findall(text))
return cjk_count / non_ws_len > 0.30
def _min_content_length(text: str) -> int:
"""根据文本语言返回 readability-lite 最小正文字符阈值。
CJK 内容(信息密度高):100 字符
其他语言(英文等):200 字符
"""
return 100 if _is_cjk_text(text) else 200
def _readability_lite(root) -> "Optional[object]":
"""readability-lite:用文本密度算法选择最可能是正文的子元素。
算法(受 readability.js 启发,简化版):
1. 遍历 body 下所有 div/section/article 子节点
2. 计算每个节点的"文本密度" = 纯文本字符数 / 标签数
3. 排除明显是导航/侧边栏的节点(class/id 含 nav/sidebar/menu/footer
4. 返回文本密度最高且字符数超过阈值的节点(CJK 100,其他 200)
返回 bs4 Tag 或 None(找不到合适节点时)。
这是 extract_with_bs4 的兜底增强,不改变原有 article/main 优先级。
"""
if root is None:
return None
candidates = root.find_all(["div", "section", "article"])
if not candidates:
return None
# 排除明显非正文节点
noise_pattern = re.compile(r"nav|sidebar|menu|footer|header|comment|"
r"related|share|social|widget|advert|banner|"
r"cookie|popup|modal", re.IGNORECASE)
best_node = None
best_score = 0.0
for node in candidates:
# 排除 class/id 命中噪声模式的节点
cls = " ".join(node.get("class", []))
nid = node.get("id", "")
if noise_pattern.search(cls) or noise_pattern.search(nid):
continue
# 计算纯文本字符数(去空白)
text = node.get_text(separator=" ", strip=True)
text_len = len(text)
# 阈值按语言动态调整:CJK 内容 100 字符,其他 200 字符
min_len = _min_content_length(text)
if text_len < min_len:
continue # 正文至少 min_len 字符(CJK 100,其他 200
# 计算标签数(粗略:所有后代标签)
tag_count = len(node.find_all())
if tag_count == 0:
continue
# 文本密度 = 字符数 / 标签数;越高越可能是正文
density = text_len / tag_count
# 加权:段落 <p> 数量也是正文信号
p_count = len(node.find_all("p"))
score = density + (p_count * 10)
if score > best_score:
best_score = score
best_node = node
return best_node
def extract_text(html_content: str) -> str:
"""Extract readable text from HTML, preferring bs4 if available."""
if _HAS_BS4:
try:
return extract_with_bs4(html_content)
except Exception:
pass
return extract_with_stdlib(html_content)
# ----- Tree-based HTML-to-Markdown converter (robust) -----
class MarkdownConverter(HTMLParser):
"""Convert HTML to Markdown using a tag-stack approach.
Handles nested tags in <a> elements correctly unlike regex. Supports:
* GFM tables (``<table>`` → ``| a | b |`` with separator row)
* fenced code blocks (``<pre>`` → triple-backtick fences)
* inline code (``<code>`` → backticks)
* blockquotes (``<blockquote>`` → ``> `` prefix per line)
* headings, lists, images, emphasis, links
"""
def __init__(self):
super().__init__()
self._output = []
self._skip_depth = 0
self._list_stack = [] # list of [type, counter] for ol numbering
self._pending_indent = "" # preserved leading indent for li/dd
self._block_buffer = ""
self._link_href = None
self._link_text = []
self._in_link = False
self._in_pre = False
self._pre_content = []
self._heading_level = 0
self._block_empty = True
# Blockquote support
self._in_blockquote = False
# Table support (GFM)
self._in_table = False
self._table_rows = [] # list of (cells_list, is_header)
self._current_row = None
self._current_cell = None
self._in_cell = False
def _append_inline(self, text: str):
"""Append inline markup, routing to cell/link/block buffer.
In cell context, fragments go to ``_current_cell`` so table cell text
accumulates correctly. In link context, they go to ``_link_text``
and are collapsed at ``</a>`` time. Otherwise they append to the
block buffer; whitespace is normalized at ``_flush_block`` time.
"""
if self._in_cell:
self._current_cell.append(text)
elif self._in_link:
self._link_text.append(text)
else:
self._block_buffer += text
self._block_empty = False
def _flush_block(self):
t = self._block_buffer
# Normalize whitespace: collapse runs of spaces/tabs/newlines
t = re.sub(r'\s+', ' ', t).strip()
if t:
if self._in_blockquote:
# Prefix each line with "> " for markdown blockquote syntax
t = "\n".join(
("> " + line) if line.strip() else ">"
for line in t.split("\n")
)
if self._pending_indent:
self._output.append(self._pending_indent + t)
else:
self._output.append(t)
self._block_buffer = ""
self._block_empty = True
self._pending_indent = ""
def _emit_table(self):
"""Emit a GFM table from accumulated rows.
The first row becomes the header; a ``| --- | --- |`` separator row
follows; remaining rows become the body. Cells are padded to the
header width so the table renders correctly in strict GFM parsers.
"""
if not self._table_rows:
return
header_row, _ = self._table_rows[0]
body_rows = self._table_rows[1:]
if not header_row:
return
ncols = len(header_row)
self._output.append("| " + " | ".join(header_row) + " |")
self._output.append("| " + " | ".join("---" for _ in range(ncols)) + " |")
for row, _ in body_rows:
# Pad short rows; truncate long rows to header width
while len(row) < ncols:
row.append("")
self._output.append("| " + " | ".join(row[:ncols]) + " |")
self._output.append("")
def handle_starttag(self, tag, attrs):
tag_lower = tag.lower()
attrs_dict = dict(attrs)
if tag_lower in ("script", "style", "nav", "footer", "header",
"noscript", "iframe", "svg", "canvas", "template"):
self._skip_depth += 1
return
if self._skip_depth > 0:
self._skip_depth += 1
return
# Table structural elements are handled up-front so cell content
# routing (via _in_cell) takes effect before any other tag handler.
if tag_lower == "table":
self._flush_block()
self._in_table = True
self._table_rows = []
return
if self._in_table:
if tag_lower == "tr":
self._current_row = []
return
elif tag_lower in ("th", "td"):
self._in_cell = True
self._current_cell = []
return
elif tag_lower in ("thead", "tbody", "tfoot"):
return # container only — rows/cells drive the output
# Other tags inside cells (a/strong/em/code/br) fall through
# to normal handling; _append_inline routes them to _current_cell.
if tag_lower in ("p", "div", "section"):
self._flush_block()
elif tag_lower == "blockquote":
self._flush_block()
self._in_blockquote = True
elif tag_lower == "br":
self._append_inline("\n")
elif tag_lower in ("h1", "h2", "h3", "h4", "h5", "h6"):
self._flush_block()
self._heading_level = int(tag_lower[1])
elif tag_lower == "pre":
self._flush_block()
self._in_pre = True
self._pre_content = []
elif tag_lower == "code":
# Inline code. <pre><code> is handled by the pre path, which
# captures raw text verbatim — so only emit backticks when
# we're NOT inside a pre block.
if not self._in_pre:
self._append_inline("`")
elif tag_lower in ("ul", "ol"):
self._list_stack.append([tag_lower, 0])
elif tag_lower == "li":
self._flush_block()
depth = max(0, len(self._list_stack) - 1)
self._pending_indent = " " * depth
if self._list_stack and self._list_stack[-1][0] == "ol":
self._list_stack[-1][1] += 1
marker = f"{self._list_stack[-1][1]}. "
else:
marker = "- "
self._block_buffer = marker
self._block_empty = False
elif tag_lower == "dt":
self._flush_block()
self._block_buffer = "**"
self._block_empty = False
elif tag_lower == "dd":
self._flush_block()
self._pending_indent = " "
self._block_buffer = ""
self._block_empty = True
elif tag_lower == "a":
self._in_link = True
self._link_href = attrs_dict.get("href", "")
self._link_text = []
elif tag_lower in ("strong", "b"):
self._append_inline("**")
elif tag_lower in ("em", "i"):
self._append_inline("*")
elif tag_lower == "img":
alt = attrs_dict.get("alt", "")
src = attrs_dict.get("src", "")
if alt or src:
self._append_inline(f"![{alt}]({src})")
def handle_endtag(self, tag):
tag_lower = tag.lower()
if self._skip_depth > 0:
self._skip_depth -= 1
return
if tag_lower == "pre":
self._in_pre = False
code = "\n".join(self._pre_content)
self._output.append(f"```\n{code}\n```")
self._pre_content = []
self._block_empty = True
elif tag_lower in ("h1", "h2", "h3", "h4", "h5", "h6"):
prefix = "#" * self._heading_level
self._output.append(f"\n{prefix} {self._block_buffer.strip()}\n")
self._block_buffer = ""
self._heading_level = 0
self._block_empty = True
elif tag_lower in ("th", "td"):
# Collapse cell content to a single line (newlines from <br>
# would break the GFM table row). Pipe chars are escaped to
# avoid prematurely terminating cells.
cell_text = " ".join(self._current_cell).strip()
cell_text = re.sub(r'\s+', ' ', cell_text)
cell_text = cell_text.replace("|", "\\|")
if self._current_row is not None:
self._current_row.append(cell_text)
self._in_cell = False
self._current_cell = None
elif tag_lower == "tr":
if self._current_row is not None:
is_header = False # GFM doesn't distinguish; first row is header
self._table_rows.append((self._current_row, is_header))
self._current_row = None
elif tag_lower == "table":
self._emit_table()
self._in_table = False
self._table_rows = []
self._current_row = None
self._current_cell = None
self._in_cell = False
elif tag_lower == "blockquote":
self._flush_block()
self._in_blockquote = False
self._output.append("")
elif tag_lower in ("p", "div", "section"):
self._flush_block()
self._output.append("")
elif tag_lower in ("ul", "ol"):
if self._list_stack:
self._list_stack.pop()
self._output.append("")
elif tag_lower == "li":
self._flush_block()
elif tag_lower == "dt":
self._block_buffer = self._block_buffer.rstrip() + "**"
self._flush_block()
elif tag_lower == "dd":
self._flush_block()
elif tag_lower == "a":
if self._in_link:
link_text = " ".join("".join(self._link_text).split())
if link_text and self._link_href:
rendered = f"[{link_text}]({self._link_href})"
elif self._link_href:
rendered = f"<{self._link_href}>"
else:
rendered = ""
if self._in_cell:
self._current_cell.append(rendered)
else:
self._block_buffer += rendered
self._block_empty = False
self._in_link = False
self._link_href = None
self._link_text = []
elif tag_lower == "code":
if not self._in_pre:
self._append_inline("`")
elif tag_lower in ("strong", "b"):
self._append_inline("**")
elif tag_lower in ("em", "i"):
self._append_inline("*")
def handle_data(self, data):
if self._skip_depth > 0:
return
if self._in_pre:
self._pre_content.append(data)
elif self._in_cell:
self._current_cell.append(data)
elif self._in_link:
self._link_text.append(data)
else:
# Don't strip — let _flush_block normalize whitespace
if data.strip(): # only skip purely whitespace nodes
self._block_buffer += data
self._block_empty = False
def get_markdown(self) -> str:
self._flush_block()
# Emit a table if one was left open (malformed HTML)
if self._in_table and self._table_rows:
self._emit_table()
text = "\n".join(self._output)
text = re.sub(r"\n{3,}", "\n\n", text)
return text.strip()
def html_to_markdown(html_content: str) -> str:
"""Convert HTML to Markdown using tree-based parser."""
# Quick strip of scripts/styles first
html_content = re.sub(r'<script[^>]*>.*?</script>', '', html_content,
flags=re.DOTALL | re.IGNORECASE)
html_content = re.sub(r'<style[^>]*>.*?</style>', '', html_content,
flags=re.DOTALL | re.IGNORECASE)
converter = MarkdownConverter()
converter.feed(html_content)
return converter.get_markdown()
# ----- HTTP Fetch -----
# RETRY_BACKOFF_BASE, FALLBACK_UAS, detect_charset and is_retryable_error are
# imported from common.py (shared with search.py for a consistent retry policy).
#
# v2.0.0 改进:
# * 模块级 requests.Session 复用连接池 + cookie,减少 TLS 握手开销
# * 超时分离 (connect, read) 元组,避免大页面下载中途超时浪费已建连接
# * 集成 build_browser_headers() 发送完整浏览器指纹
# * 遵守 Retry-After header,避免盲目重试触发更严厉限流
# * compute_backoff_delay() 带封顶,避免高重试次数卡死进程
# 模块级 Session:复用 TCP 连接池、TLS 会话、cookie。
# 仅在 requests 可用时启用;stdlib 路径不受益但功能完整。
_session = None
def _get_session():
"""获取(惰性创建)模块级 requests.Session。
Session 复用带来:
* HTTP Keep-Alive 连接池(同站点多页面只握手一次)
* Cookie 持久化(某些站点登录态/反爬 cookie 自动携带)
* TLS 会话恢复(session resumption,节省 1-RTT
单元测试可通过 ``_reset_session()`` 重置后用 ``_HAS_REQUESTS=False``
强制走 stdlib 路径。
"""
global _session
if _session is None and _HAS_REQUESTS:
_session = _requests.Session()
# 配置连接池:每主机最多 10 连接,总最多 20 连接
adapter = _requests.adapters.HTTPAdapter(
pool_connections=10, pool_maxsize=10, max_retries=0,
)
_session.mount("http://", adapter)
_session.mount("https://", adapter)
return _session
def _reset_session() -> None:
"""关闭并重置模块级 Session。测试用。"""
global _session
if _session is not None:
try:
_session.close()
except Exception:
pass
_session = None
class _NoRedirectHandler(urllib.request.HTTPRedirectHandler):
"""urllib handler that returns the 3xx response instead of following it."""
def http_error_302(self, req, fp, code, msg, headers):
return fp
http_error_301 = http_error_303 = http_error_307 = http_error_308 = http_error_302
FetchResult = namedtuple(
"FetchResult",
["content", "content_type", "final_url", "truncated", "user_agent",
"error_code", "error_message"],
# error_code / error_message 默认 None
# * 向后兼容——旧的 5 参数构造(位置或关键字)仍然可用
# * 仅当 fetch_url 遇到不支持的媒体类型时才填充
defaults=[None, None],
)
def _handle_rate_limit_status(status_code, headers, attempt, max_retries):
"""处理 429/503 限流响应的 Retry-After,决定是否重试。
统一抽取自 requests 路径、stdlib 路径、requests.exceptions 路径三处
原本重复的 Retry-After 解析 + 退避 sleep 逻辑。
解析 Retry-After 头(秒数或 HTTP 日期,委托给 common.parse_retry_after),
与 compute_backoff_delay(attempt) 取较大值作为实际等待时间。
若 ``attempt < max_retries``sleep 后返回 ``(True, retry_after_sec)``
表示应当重试;否则返回 ``(False, retry_after_sec)``,由调用方决定后续
(通常会落到 raise_for_status / 抛 RuntimeError)。
``headers`` 兼容 dict 和 http.client.HTTPMessage(均支持 ``.get()``);
为 None 时按空 header 处理(retry_after=0)。
返回 ``(should_retry, retry_after_seconds)``。
"""
retry_after_raw = ""
if headers:
retry_after_raw = headers.get("Retry-After", "") or ""
retry_after_sec = parse_retry_after(retry_after_raw)
if attempt < max_retries:
delay = max(retry_after_sec, compute_backoff_delay(attempt))
logger.info(f" Fetch retry {attempt+1}/{max_retries} "
f"(HTTP {status_code}, Retry-After={retry_after_sec:.1f}s) "
f"in {delay:.1f}s")
time.sleep(delay)
return (True, retry_after_sec)
return (False, retry_after_sec)
# 明确的非文本二进制 MIME 类型:无法作为文本 decode,直接拒绝。
# application/octet-stream 是通用二进制兜底类型;其余为已知归档/可执行/
# 旧版 Office.doc/.xls/.ppt 不在本次支持范围)等。
_BINARY_CONTENT_TYPES = frozenset([
"application/octet-stream",
"application/zip",
"application/x-gzip",
"application/gzip",
"application/x-rar-compressed",
"application/x-7z-compressed",
"application/x-tar",
"application/x-bzip",
"application/x-bzip2",
"application/x-msdownload",
"application/x-shockwave-flash",
"application/msword", # 旧 .doc(不支持)
"application/vnd.ms-excel", # 旧 .xls(不支持)
"application/vnd.ms-powerpoint", # 旧 .ppt(不支持)
"application/x-elf",
"application/x-executable",
])
# OOXML.docx / .xlsx)主命名空间,ElementTree 用 {ns}tag 形式匹配
_W_NS = "{http://schemas.openxmlformats.org/wordprocessingml/2006/main}"
_S_NS = "{http://schemas.openxmlformats.org/spreadsheetml/2006/main}"
def _parse_pdf(raw: bytes):
"""用 pdftotextpoppler-utils)从 PDF 字节流提取文本。
通过 subprocess 调用 ``pdftotext - -``stdin 读、stdout 写),
不引入新依赖。pdftotext 不存在或失败时返回 E_UNSUPPORTED_MEDIA。
返回 ``(content, error_code, error_message)``
成功 → ``(text, None, None)``;失败 → ``(None, E_UNSUPPORTED_MEDIA, msg)``。
"""
try:
proc = subprocess.run(
["pdftotext", "-", "-"],
input=raw,
capture_output=True,
timeout=30,
)
except FileNotFoundError:
return (None, E_UNSUPPORTED_MEDIA,
"PDF parsing requires poppler-utils (pdftotext) to be installed")
except subprocess.TimeoutExpired:
return (None, E_UNSUPPORTED_MEDIA, "PDF parsing timed out (>30s)")
except OSError as e:
return (None, E_UNSUPPORTED_MEDIA, f"PDF parsing failed: {e}")
if proc.returncode != 0:
stderr = proc.stderr.decode("utf-8", errors="replace").strip()
msg = f"pdftotext exited {proc.returncode}"
if stderr:
msg += f": {stderr[:200]}"
return (None, E_UNSUPPORTED_MEDIA, msg)
text = proc.stdout.decode("utf-8", errors="replace")
return (text, None, None)
def _parse_docx(raw: bytes):
"""从 .docx 字节流提取文本(stdlib zipfile + ElementTree)。
读取 ``word/document.xml``,按段落(<w:p>)提取 <w:t> 文本,
段落间以换行分隔。失败时返回 E_UNSUPPORTED_MEDIA。
返回 ``(content, error_code, error_message)``。
"""
try:
with zipfile.ZipFile(io.BytesIO(raw)) as zf:
xml_bytes = zf.read("word/document.xml")
except (zipfile.BadZipFile, KeyError) as e:
return (None, E_UNSUPPORTED_MEDIA, f"DOCX parsing failed: {e}")
try:
root = ET.fromstring(xml_bytes)
except ET.ParseError as e:
return (None, E_UNSUPPORTED_MEDIA, f"DOCX XML parse failed: {e}")
# 遍历段落,每段内拼接所有 <w:t>,段落间换行
lines = []
for p in root.iter(_W_NS + "p"):
parts = [t.text for t in p.iter(_W_NS + "t") if t.text]
if parts:
lines.append("".join(parts))
return ("\n".join(lines), None, None)
def _parse_xlsx(raw: bytes):
"""从 .xlsx 字节流提取文本(stdlib zipfile + ElementTree)。
读取 ``xl/sharedStrings.xml``(共享字符串表)与各
``xl/worksheets/sheetN.xml``,按行提取单元格文本,单元格以制表符
分隔、行以换行分隔。失败时返回 E_UNSUPPORTED_MEDIA。
返回 ``(content, error_code, error_message)``。
"""
try:
with zipfile.ZipFile(io.BytesIO(raw)) as zf:
# 共享字符串表(可能不存在——纯数字表格)
shared = []
try:
sroot = ET.fromstring(zf.read("xl/sharedStrings.xml"))
for si in sroot.iter(_S_NS + "si"):
parts = [t.text for t in si.iter(_S_NS + "t") if t.text]
shared.append("".join(parts))
except (KeyError, ET.ParseError):
pass # 无共享字符串表,单元格均为内联值
sheet_names = [n for n in zf.namelist()
if re.match(r"xl/worksheets/sheet\d+\.xml$", n)]
lines = []
for sheet_name in sorted(sheet_names):
try:
sroot = ET.fromstring(zf.read(sheet_name))
except ET.ParseError:
continue
for row in sroot.iter(_S_NS + "row"):
cells = []
for c in row.iter(_S_NS + "c"):
cell_type = c.get("t")
v = c.find(_S_NS + "v")
if v is not None and v.text is not None:
if cell_type == "s":
# 共享字符串索引引用
try:
idx = int(v.text)
cells.append(
shared[idx] if 0 <= idx < len(shared) else "")
except (ValueError, IndexError):
cells.append("")
else:
cells.append(v.text)
else:
# 内联字符串 <is><t>...</t></is>
is_el = c.find(_S_NS + "is")
if is_el is not None:
parts = [t.text for t in is_el.iter(_S_NS + "t")
if t.text]
cells.append("".join(parts))
if cells:
lines.append("\t".join(cells))
return ("\n".join(lines), None, None)
except (zipfile.BadZipFile, ET.ParseError) as e:
return (None, E_UNSUPPORTED_MEDIA, f"XLSX parsing failed: {e}")
def _parse_document_content(raw: bytes, content_type: str):
"""根据 Content-Type 将二进制文档解析为文本。
支持:PDF(需 pdftotext)、DOCX、XLSX。
对明确的非文本二进制 MIMEapplication/octet-stream、zip、rar 等)返回
E_UNSUPPORTED_MEDIA。其他类型(text/* 、application/json、HTML 等)返回
``(None, None, None)``,由调用方走原有 decode 流程。
返回 ``(content, error_code, error_message)``
* 非文档类型 → ``(None, None, None)``:调用方继续 decode
* 解析成功 → ``(text, None, None)``
* 解析失败 → ``(None, E_UNSUPPORTED_MEDIA, msg)``
"""
ct = (content_type or "").lower().split(";")[0].strip()
if ct == "application/pdf":
return _parse_pdf(raw)
if ct == "application/vnd.openxmlformats-officedocument.wordprocessingml.document":
return _parse_docx(raw)
if ct == "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":
return _parse_xlsx(raw)
if ct.startswith(("image/", "audio/", "video/")) or ct in _BINARY_CONTENT_TYPES:
return (None, E_UNSUPPORTED_MEDIA,
f"Unsupported binary content type: {ct}")
return (None, None, None)
def fetch_url(url: str, timeout=15, user_agent: str = None,
encoding: str = None, auth_headers: dict = None,
max_retries: int = 3, max_size: int = None,
allow_redirects: bool = True,
referer: str = None) -> "FetchResult":
"""Fetch a URL with retry, encoding detection, UA fallback, and optional size limit.
Returns a :class:`FetchResult` namedtuple with fields:
``content`` (str), ``content_type`` (str), ``final_url`` (str),
``truncated`` (bool — True if ``max_size`` cut the response short),
``user_agent`` (str — the UA string that succeeded; useful for logging
whether a fallback UA was needed).
max_size=None means unlimited (full page). Set to e.g. 5242880 for a 5MB cap.
allow_redirects=False stops the client from following HTTP 3xx redirects.
v2.0.0 改进:
* ``timeout`` 支持标量(向后兼容)或 ``(connect, read)`` 元组;
标量会被转换为 ``(timeout, timeout*2)`` 分离建连和读超时
* ``referer`` 参数:设置 Referer 头,伪装来自搜索引擎的流量
* 浏览器指纹头:通过 build_browser_headers() 发送完整 Sec-* 头
* 确定性 UA:通过 get_ua_for_domain() 为同域名固定 UA
* Retry-After429/503 响应读取 Retry-After header 作为最小重试延迟
* 退避封顶:compute_backoff_delay() 上限 60s
* Session 复用:requests 路径复用模块级 Session
"""
# 超时归一化:标量 → (connect, read) 元组
if isinstance(timeout, (int, float)):
connect_timeout = min(float(timeout), 10.0) # 建连不超过 10s
read_timeout = float(timeout)
timeout_tuple = (connect_timeout, read_timeout)
else:
timeout_tuple = timeout # 已是元组,原样使用
# 确定性 UA 选择:同域名固定 UA
effective_ua = get_ua_for_domain(url, user_agent)
last_error = None
# UA 轮换池:首次用 effective_ua,后续重试轮换其他 UA
user_agents = [effective_ua] + [ua for ua in FALLBACK_UAS if ua != effective_ua]
for attempt in range(max_retries + 1):
# 同一域名内 UA 固定;仅在重试失败后才换(避免会话内突变)
# 但当退避原因可能是 UA 被屏蔽(403)时,必须换 UA
ua = user_agents[min(attempt, len(user_agents) - 1)]
# 构造完整浏览器头(v2.0.0 核心)
headers = build_browser_headers(ua, referer=referer, accept_html=True)
if auth_headers:
headers.update(auth_headers)
try:
if _HAS_REQUESTS:
session = _get_session()
resp = session.get(url, timeout=timeout_tuple, headers=headers,
allow_redirects=allow_redirects, stream=True)
# stream=True holds the socket open; must close explicitly,
# including on raise_for_status() / max_size break / decode
# errors — otherwise the connection leaks back to the pool
# and long-running agents exhaust ports.
try:
# 429/503:读取 Retry-After,作为最小重试延迟
if resp.status_code in (429, 503) and attempt < max_retries:
resp.close()
should_retry, _ = _handle_rate_limit_status(
resp.status_code, resp.headers, attempt, max_retries)
if should_retry:
continue
resp.raise_for_status()
# Read: unlimited if max_size is None, chunked with limit otherwise
if max_size is None:
raw = resp.content
truncated = False
else:
chunks = []
total = 0
for chunk in resp.iter_content(chunk_size=65536, decode_unicode=False):
if chunk:
chunks.append(chunk)
total += len(chunk)
if total > max_size:
break
raw = b"".join(chunks)
truncated = total > max_size
# v2.2.1 修复:requests 自动解压 gzip/deflate,但**不自动
# 解压 Brotli**(除非安装 brotli 包)。当服务器返回
# Content-Encoding: br 而本机有 brotli 解压器时,手动解压;
# 否则保留原 raw,让下游 errors="replace" 兜底(虽是乱码但
# 不崩溃)。build_browser_headers() 已尽量避免声明 br,此处
# 作为双保险,应对代理/CDN 强制返回 br 的边缘情况。
content_encoding = (resp.headers.get("Content-Encoding", "")
.lower().strip())
if "br" in content_encoding and _HAS_BROTLI and raw:
try:
raw = _brotli.decompress(raw)
except Exception as e:
logger.debug(f" brotli decompress failed: {e}")
# 二进制文档解析(PDF/DOCX/XLSX)及不支持的媒体类型检测。
# 命中时直接返回,跳过后续文本 decode 流程。
doc_text, doc_err_code, doc_err_msg = _parse_document_content(
raw, resp.headers.get("Content-Type", ""))
if doc_err_code is not None:
return FetchResult(
"", resp.headers.get("Content-Type", ""), resp.url,
truncated, ua, doc_err_code, doc_err_msg)
if doc_text is not None:
return FetchResult(
doc_text, resp.headers.get("Content-Type", ""), resp.url,
truncated, ua, None, None)
if encoding:
content = raw.decode(encoding)
else:
charset = detect_charset(raw, resp.headers.get("Content-Type", ""))
try:
content = raw.decode(charset)
except (UnicodeDecodeError, LookupError):
content = raw.decode("utf-8", errors="replace")
return FetchResult(content, resp.headers.get("Content-Type", ""),
resp.url, truncated, ua)
finally:
resp.close()
# stdlib fallback
req = urllib.request.Request(url, headers=headers)
if allow_redirects:
_opener = urllib.request.urlopen(req, timeout=timeout_tuple[1])
else:
_opener = urllib.request.build_opener(_NoRedirectHandler).open(
req, timeout=timeout_tuple[1])
with _opener as resp:
if max_size is None:
raw = resp.read()
truncated = False
else:
chunks = []
total = 0
while True:
chunk = resp.read(65536)
if not chunk:
break
chunks.append(chunk)
total += len(chunk)
if total > max_size:
break
raw = b"".join(chunks)
truncated = total > max_size
content_type = resp.headers.get("Content-Type", "")
final_url = resp.geturl()
# v2.1.1 修复:stdlib urllib 不自动解压 gzip/deflate
# 服务器返回压缩字节流时 raw.decode() 会失败 →
# errors="replace" → 全页 U+FFFD 乱码。
# requests 库会自动处理 Content-Encoding,但 stdlib 不会。
# 此前该 bug 被沙箱伪响应掩盖(两者都产生 U+FFFD),
# 实际在无 requests 的真实环境中会复现。
# v2.2.1 补充:br 解压(与 requests 路径对齐)。
content_encoding = (resp.headers.get("Content-Encoding", "")
.lower().strip())
if content_encoding and raw:
try:
if "br" in content_encoding and _HAS_BROTLI:
raw = _brotli.decompress(raw)
elif "gzip" in content_encoding:
raw = gzip.decompress(raw)
elif "deflate" in content_encoding:
# deflate 可能是 zlib 包装或裸 deflate
try:
raw = zlib.decompress(raw)
except zlib.error:
raw = zlib.decompress(raw, -zlib.MAX_WBITS)
except (OSError, zlib.error) as e:
logger.debug(f" decompress failed ({content_encoding}): {e}")
# 解压失败保留原 raw,让下游 decode 兜底
# 二进制文档解析(PDF/DOCX/XLSX)及不支持的媒体类型检测。
# 命中时直接返回,跳过后续文本 decode 流程。
doc_text, doc_err_code, doc_err_msg = _parse_document_content(
raw, content_type)
if doc_err_code is not None:
return FetchResult(
"", content_type, final_url, truncated, ua,
doc_err_code, doc_err_msg)
if doc_text is not None:
return FetchResult(
doc_text, content_type, final_url, truncated, ua,
None, None)
if encoding:
charset = encoding
else:
charset = detect_charset(raw, content_type)
try:
content = raw.decode(charset)
except (UnicodeDecodeError, LookupError):
content = raw.decode("utf-8", errors="replace")
return FetchResult(content, content_type, final_url, truncated, ua)
except urllib.error.HTTPError as e:
last_error = e
# 429/503:读取 Retry-Afterstdlib 路径)
if e.code in (429, 503) and attempt < max_retries:
# HTTPError 本身是可读的响应对象(fp 已被 urllib 消费),
# 无需显式 close;直接进入退避。
should_retry, _ = _handle_rate_limit_status(
e.code, e.headers, attempt, max_retries)
if should_retry:
continue
if is_retryable_error(e) and attempt < max_retries:
delay = compute_backoff_delay(attempt)
logger.info(f" Fetch retry {attempt+1}/{max_retries} ({e}) in {delay:.1f}s")
time.sleep(delay)
continue
raise RuntimeError(f"HTTP {e.code} for {url}") from e
except (urllib.error.URLError, OSError, TimeoutError) as e:
last_error = e
if attempt < max_retries:
delay = compute_backoff_delay(attempt)
logger.info(f" Fetch retry {attempt+1}/{max_retries} ({e}) in {delay:.1f}s")
time.sleep(delay)
continue
raise RuntimeError(f"Request failed for {url}: {e}") from e
except Exception as e:
# requests backend: retry only on connection errors (no response)
# or transient 429/5xx; do NOT retry permanent errors like 404.
if _HAS_REQUESTS and isinstance(e, _requests.exceptions.RequestException):
last_error = e
status = getattr(getattr(e, "response", None), "status_code", None)
# 429/503 with Retry-After
if status in (429, 503) and attempt < max_retries:
resp_obj = getattr(e, "response", None)
resp_headers = resp_obj.headers if resp_obj is not None else None
if resp_obj is not None:
resp_obj.close()
should_retry, _ = _handle_rate_limit_status(
status, resp_headers, attempt, max_retries)
if should_retry:
continue
if (status is None or status in RETRYABLE_STATUS) and attempt < max_retries:
delay = compute_backoff_delay(attempt)
logger.info(f" Fetch retry {attempt+1}/{max_retries} ({e}) in {delay:.1f}s")
time.sleep(delay)
continue
raise RuntimeError(f"Request failed for {url}: {e}") from e
raise RuntimeError(f"All {max_retries+1} attempts failed for {url}: {last_error}") from last_error
# ----- Main -----
def main():
parser = argparse.ArgumentParser(
description="Fetch a web page and extract readable content",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=f"""searxng-cli v{VERSION}
Examples:
%(prog)s -u https://example.com extract clean text
%(prog)s -u https://example.com -e html raw HTML
%(prog)s -u https://example.com -e markdown markdown conversion
%(prog)s -u https://example.com -o page.txt save to file
%(prog)s -u https://example.cn -e text --encoding gbk force charset
""",
)
parser.add_argument("--url", "-u", required=True, help="URL to fetch")
parser.add_argument("--extract", "-e", choices=["text", "html", "markdown"],
default="text", help="Extraction mode (default: text)")
parser.add_argument("--timeout", "-t", type=int, default=15,
help="Request timeout in seconds (default: 15)")
parser.add_argument("--retries", type=int, default=3,
help="Max retries on transient errors (default: 3)")
parser.add_argument("--max-size", type=int, default=None, metavar="BYTES",
help="Max page size in bytes (default: unlimited). Set to 5242880 for 5MB cap.")
parser.add_argument("--user-agent", default=None,
help="Custom User-Agent header")
parser.add_argument("--encoding", default=None,
help="Force charset for decoding (e.g. gbk, shift_jis)")
parser.add_argument("--no-redirect", action="store_true",
help="Do not follow HTTP redirects")
parser.add_argument("--no-fallback", action="store_true",
help="Disable Wayback Machine fallback (v2.1.0). "
"By default, 403/404/timeout automatically retries "
"via web.archive.org. Hard-blocked domains "
"(baike.baidu.com, zhihu.com, etc.) always get "
"Wayback priority.")
parser.add_argument("--referer", default=None, metavar="URL",
help="Set Referer header (e.g. https://www.google.com/) to "
"disguise traffic source. v2.0.0 anti-bot measure.")
parser.add_argument("--proxy", default=None, metavar="URL",
help="HTTP/HTTPS proxy URL (e.g. http://corp-proxy:8080). "
"Respects existing HTTP_PROXY/HTTPS_PROXY env vars when omitted.")
parser.add_argument("--output", "-o", default=None,
help="Save to file instead of stdout")
parser.add_argument("--auth-bearer", default=None, metavar="TOKEN",
help="Authorization: Bearer <TOKEN> for authenticated endpoints")
parser.add_argument("--auth-bearer-file", default=None, metavar="FILE",
help="Read Bearer token from a file (first non-empty, non-# line). "
"Avoids leaving tokens in shell history.")
parser.add_argument("--auth-basic", default=None, metavar="USER:PASS",
help="Authorization: Basic base64(user:pass) for authenticated endpoints")
parser.add_argument("--auth-basic-file", default=None, metavar="FILE",
help="Read basic auth 'user:pass' from a file (first non-empty, non-# line). "
"Avoids leaving passwords in shell history. "
"Env var SEARXNG_BASIC_AUTH is also honored.")
parser.add_argument("--verbose", "-v", action="store_true", default=False,
help="Verbose output: show debug-level diagnostics on stderr")
parser.add_argument("--quiet", action="store_true", default=False,
help="Quiet output: suppress progress messages on stderr; "
"only warnings and errors are shown")
parser.add_argument("--version", action="version", version=f"searxng-cli v{VERSION}")
args = parser.parse_args()
setup_logging(verbose=args.verbose, quiet=args.quiet)
force_utf8_stdout() # Windows: prevent GBK crash on non-ASCII chars
if not args.url.startswith(("http://", "https://")):
logger.error("Error: URL must start with http:// or https://")
sys.exit(1)
# Apply proxy via env vars so both urllib and requests honor it.
if args.proxy:
apply_proxy(args.proxy)
logger.info(f"Proxy: {args.proxy}")
try:
bearer_token = resolve_auth_bearer(args.auth_bearer, args.auth_bearer_file)
basic_auth = resolve_auth_basic(args.auth_basic, args.auth_basic_file)
except RuntimeError as e:
logger.error(f"Error: {e}")
sys.exit(1)
auth_headers = build_auth_headers(
bearer_token=bearer_token,
basic_auth=basic_auth,
)
if auth_headers:
auth_type = "Bearer" if bearer_token else "Basic"
logger.info(f"Auth: {auth_type} ***")
# v2.1.0: 被墙站点提示
fallback_enabled = not args.no_fallback
hard_blocked = is_hard_blocked_domain(args.url)
if hard_blocked:
logger.info(f"Hard-blocked domain detected — Wayback fallback "
f"will be prioritized if main fetch fails")
try:
result = fetch_url(
args.url, timeout=args.timeout, user_agent=args.user_agent,
encoding=args.encoding, auth_headers=auth_headers,
max_retries=args.retries, max_size=args.max_size,
allow_redirects=not args.no_redirect,
referer=args.referer,
)
content, content_type, final_url = (
result.content, result.content_type, result.final_url,
)
# 文档解析失败(PDF/DOCX/XLSX 等)时 fetch_url 不抛异常,
# 而是返回带 error_code 的 FetchResult——必须显式检查,
# 否则失败会被静默吞掉(空输出 + exit 0)。
if result.error_code:
logger.error(
f"Error: {result.error_message or result.error_code} "
f"(error_code={result.error_code}, url={args.url})")
sys.exit(1)
except Exception as e:
# 诊断信息增强:从 __cause__ 链中提取 HTTP 状态码、原始异常类型,
# 让 AI Agent 能程序化判断失败原因(404 vs 403 vs DNS 失败等),
# 而不是只看到一句 "HTTP 404 for ..."。
cause = e.__cause__
status_code = None
cause_type = type(cause).__name__ if cause else type(e).__name__
# urllib HTTPError 有 .code 属性;requests HTTPError 有 .response.status_code
if cause is not None:
status_code = (getattr(cause, "code", None) or
getattr(getattr(cause, "response", None), "status_code", None))
if status_code is None:
# 最后一道兜底:从异常消息里提取 "HTTP NNN" 模式
m = re.search(r'HTTP (\d{3})', str(e))
if m:
status_code = int(m.group(1))
diag_parts = [f"Error: {e}"]
if status_code is not None:
diag_parts.append(f"status_code={status_code}")
diag_parts.append(f"cause={cause_type}")
diag_parts.append(f"url={args.url}")
if args.no_redirect:
diag_parts.append("redirects=disabled")
logger.error(" | ".join(diag_parts))
# v2.1.0: Wayback Machine 兜底
# 触发条件:兜底启用 + (错误可恢复 OR 命中被墙站点)
error_msg = str(e) if str(e) else e.__class__.__name__
if fallback_enabled and (should_try_wayback(error_msg) or hard_blocked):
wayback_url = build_wayback_url(args.url)
wb_timeout = min(args.timeout, 10) # Wayback 独立超时,不阻塞
logger.info(f"[FALLBACK] Trying Wayback Machine: {wayback_url[:70]}")
try:
wb_result = fetch_url(
wayback_url, timeout=wb_timeout,
user_agent=args.user_agent, encoding=args.encoding,
auth_headers=None, # Wayback 不需要原始站点的认证
max_retries=min(args.retries, 2),
max_size=args.max_size,
allow_redirects=True,
)
content, content_type, final_url = (
wb_result.content, wb_result.content_type,
wb_result.final_url,
)
logger.info(f"[FALLBACK] Wayback recovery successful "
f"({len(content)} chars)")
except Exception as wb_e:
logger.error(f"[FALLBACK] Wayback also failed: {wb_e}")
sys.exit(1)
else:
sys.exit(1)
if final_url != args.url:
logger.info(f"Redirected to: {final_url}")
is_html = ("html" in content_type.lower() or
content.strip().startswith("<!") or
content.strip().startswith("<htm"))
if args.extract == "html":
output = content
elif args.extract == "markdown":
output = html_to_markdown(content) if is_html else content
else: # text
output = extract_text(content) if is_html else content
# Quality check (threshold: 500 chars)
if args.extract == "text" and len(output.strip()) < 500 and is_html:
logger.warning(f"Warning: extracted text is very short ({len(output.strip())} chars). "
"The page may be JS-heavy or use anti-bot protection.")
if args.output:
with open(args.output, "w", encoding="utf-8") as f:
f.write(output)
logger.info(f"Saved {len(output)} chars to {args.output}")
else:
print(output)
if __name__ == "__main__":
main()