Files
bettafish-company/ReportEngine/flask_interface.py
T
BaiFu f004407f4b Add final report download button (#329)
* fix(app): 改进应用健康检查机制并更新默认配置

添加专用的健康检查路径和代理配置,重构健康检查URL构建逻辑
增加健康检查失败时的日志记录
延长应用启动等待时间至90秒

* style(templates): 统一CSS选择器缩进格式并修复空格问题

* feat(报告下载): 实现报告文件下载功能并增强任务状态管理

- 在ReportAgent中修改generate_report返回包含文件路径的字典
- 在ReportTask中添加文件路径相关字段
- 新增/download接口用于下载报告文件
- 在前端添加下载按钮及相关控制逻辑
- 完善任务状态显示,增加文件路径信息

* feat(report): 添加报告下载功能并优化状态管理

- 在ReportAgent中返回报告文件保存路径信息
- 新增Flask接口/download/<task_id>用于下载报告文件
- 在前端添加下载按钮及相关控制逻辑
- 修复报告生成状态重置问题
- 优化健康检查URL构建和代理设置
- 统一CSS样式中的空格和缩进

---------

Co-authored-by: HKLHaoBin <we3q@qq.com>
Co-authored-by: Zhang Yuxiang <51037789+NTFago@users.noreply.github.com>
2025-11-13 00:48:52 +08:00

537 lines
16 KiB
Python

"""
Report Engine Flask接口
提供HTTP API用于报告生成
"""
import os
import json
import threading
import time
from datetime import datetime
from flask import Blueprint, request, jsonify, Response, send_file
from typing import Dict, Any
from loguru import logger
from .agent import ReportAgent, create_agent
from .utils.config import settings
# 创建Blueprint
report_bp = Blueprint('report_engine', __name__)
# 全局变量
report_agent = None
current_task = None
task_lock = threading.Lock()
def initialize_report_engine():
"""初始化Report Engine"""
global report_agent
try:
report_agent = create_agent()
logger.info("Report Engine初始化成功")
return True
except Exception as e:
logger.exception(f"Report Engine初始化失败: {str(e)}")
return False
class ReportTask:
"""报告生成任务"""
def __init__(self, query: str, task_id: str, custom_template: str = ""):
self.task_id = task_id
self.query = query
self.custom_template = custom_template
self.status = "pending" # pending, running, completed, error
self.progress = 0
self.result = None
self.error_message = ""
self.created_at = datetime.now()
self.updated_at = datetime.now()
self.html_content = ""
self.report_file_path = ""
self.report_file_relative_path = ""
self.report_file_name = ""
self.state_file_path = ""
self.state_file_relative_path = ""
def update_status(self, status: str, progress: int = None, error_message: str = ""):
"""更新任务状态"""
self.status = status
if progress is not None:
self.progress = progress
if error_message:
self.error_message = error_message
self.updated_at = datetime.now()
def to_dict(self) -> Dict[str, Any]:
"""转换为字典格式"""
return {
'task_id': self.task_id,
'query': self.query,
'status': self.status,
'progress': self.progress,
'error_message': self.error_message,
'created_at': self.created_at.isoformat(),
'updated_at': self.updated_at.isoformat(),
'has_result': bool(self.html_content),
'report_file_ready': bool(self.report_file_path),
'report_file_name': self.report_file_name,
'report_file_path': self.report_file_relative_path
}
def check_engines_ready() -> Dict[str, Any]:
"""检查三个子引擎是否都有新文件"""
directories = {
'insight': 'insight_engine_streamlit_reports',
'media': 'media_engine_streamlit_reports',
'query': 'query_engine_streamlit_reports'
}
forum_log_path = 'logs/forum.log'
if not report_agent:
return {
'ready': False,
'error': 'Report Engine未初始化'
}
return report_agent.check_input_files(
directories['insight'],
directories['media'],
directories['query'],
forum_log_path
)
def run_report_generation(task: ReportTask, query: str, custom_template: str = ""):
"""在后台线程中运行报告生成"""
global current_task
try:
task.update_status("running", 10)
# 检查输入文件
check_result = check_engines_ready()
if not check_result['ready']:
task.update_status("error", 0, f"输入文件未准备就绪: {check_result.get('missing_files', [])}")
return
task.update_status("running", 30)
# 加载输入文件
content = report_agent.load_input_files(check_result['latest_files'])
task.update_status("running", 50)
# 生成报告
generation_result = report_agent.generate_report(
query=query,
reports=content['reports'],
forum_logs=content['forum_logs'],
custom_template=custom_template,
save_report=True
)
html_report = generation_result.get('html_content', '')
task.update_status("running", 90)
# 保存结果
task.html_content = html_report
task.report_file_path = generation_result.get('report_filepath', '')
task.report_file_relative_path = generation_result.get('report_relative_path', '')
task.report_file_name = generation_result.get('report_filename', '')
task.state_file_path = generation_result.get('state_filepath', '')
task.state_file_relative_path = generation_result.get('state_relative_path', '')
task.update_status("completed", 100)
except Exception as e:
logger.exception(f"报告生成过程中发生错误: {str(e)}")
task.update_status("error", 0, str(e))
# 只在出错时清理任务
with task_lock:
if current_task and current_task.task_id == task.task_id:
current_task = None
@report_bp.route('/status', methods=['GET'])
def get_status():
"""获取Report Engine状态"""
try:
engines_status = check_engines_ready()
return jsonify({
'success': True,
'initialized': report_agent is not None,
'engines_ready': engines_status['ready'],
'files_found': engines_status.get('files_found', []),
'missing_files': engines_status.get('missing_files', []),
'current_task': current_task.to_dict() if current_task else None
})
except Exception as e:
logger.exception(f"获取Report Engine状态失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/generate', methods=['POST'])
def generate_report():
"""开始生成报告"""
global current_task
try:
# 检查是否有任务在运行
with task_lock:
if current_task and current_task.status == "running":
return jsonify({
'success': False,
'error': '已有报告生成任务在运行中',
'current_task': current_task.to_dict()
}), 400
# 如果有已完成的任务,清理它
if current_task and current_task.status in ["completed", "error"]:
current_task = None
# 获取请求参数
data = request.get_json() or {}
query = data.get('query', '智能舆情分析报告')
custom_template = data.get('custom_template', '')
# 清空日志文件
clear_report_log()
# 检查Report Engine是否初始化
if not report_agent:
return jsonify({
'success': False,
'error': 'Report Engine未初始化'
}), 500
# 检查输入文件是否准备就绪
engines_status = check_engines_ready()
if not engines_status['ready']:
return jsonify({
'success': False,
'error': '输入文件未准备就绪',
'missing_files': engines_status.get('missing_files', [])
}), 400
# 创建新任务
task_id = f"report_{int(time.time())}"
task = ReportTask(query, task_id, custom_template)
with task_lock:
current_task = task
# 在后台线程中运行报告生成
thread = threading.Thread(
target=run_report_generation,
args=(task, query, custom_template),
daemon=True
)
thread.start()
return jsonify({
'success': True,
'task_id': task_id,
'message': '报告生成已启动',
'task': task.to_dict()
})
except Exception as e:
logger.exception(f"开始生成报告失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/progress/<task_id>', methods=['GET'])
def get_progress(task_id: str):
"""获取报告生成进度"""
try:
if not current_task or current_task.task_id != task_id:
# 如果任务不存在,可能是已经完成并被清理了
# 返回一个默认的完成状态而不是404
return jsonify({
'success': True,
'task': {
'task_id': task_id,
'status': 'completed',
'progress': 100,
'error_message': '',
'has_result': True,
'report_file_ready': False,
'report_file_name': '',
'report_file_path': ''
}
})
return jsonify({
'success': True,
'task': current_task.to_dict()
})
except Exception as e:
logger.exception(f"获取报告生成进度失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/result/<task_id>', methods=['GET'])
def get_result(task_id: str):
"""获取报告生成结果"""
try:
if not current_task or current_task.task_id != task_id:
return jsonify({
'success': False,
'error': '任务不存在'
}), 404
if current_task.status != "completed":
return jsonify({
'success': False,
'error': '报告尚未完成',
'task': current_task.to_dict()
}), 400
return Response(
current_task.html_content,
mimetype='text/html'
)
except Exception as e:
logger.exception(f"获取报告生成结果失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/result/<task_id>/json', methods=['GET'])
def get_result_json(task_id: str):
"""获取报告生成结果(JSON格式)"""
try:
if not current_task or current_task.task_id != task_id:
return jsonify({
'success': False,
'error': '任务不存在'
}), 404
if current_task.status != "completed":
return jsonify({
'success': False,
'error': '报告尚未完成',
'task': current_task.to_dict()
}), 400
return jsonify({
'success': True,
'task': current_task.to_dict(),
'html_content': current_task.html_content
})
except Exception as e:
logger.exception(f"获取报告生成结果失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/download/<task_id>', methods=['GET'])
def download_report(task_id: str):
"""下载已生成的报告HTML文件"""
try:
if not current_task or current_task.task_id != task_id:
return jsonify({
'success': False,
'error': '任务不存在'
}), 404
if current_task.status != "completed" or not current_task.report_file_path:
return jsonify({
'success': False,
'error': '报告尚未完成或尚未保存'
}), 400
if not os.path.exists(current_task.report_file_path):
return jsonify({
'success': False,
'error': '报告文件不存在或已被删除'
}), 404
download_name = current_task.report_file_name or os.path.basename(current_task.report_file_path)
return send_file(
current_task.report_file_path,
mimetype='text/html',
as_attachment=True,
download_name=download_name
)
except Exception as e:
logger.exception(f"下载报告失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/cancel/<task_id>', methods=['POST'])
def cancel_task(task_id: str):
"""取消报告生成任务"""
global current_task
try:
with task_lock:
if current_task and current_task.task_id == task_id:
if current_task.status == "running":
current_task.update_status("cancelled", 0, "用户取消任务")
current_task = None
return jsonify({
'success': True,
'message': '任务已取消'
})
else:
return jsonify({
'success': False,
'error': '任务不存在或无法取消'
}), 404
except Exception as e:
logger.exception(f"取消报告生成任务失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
@report_bp.route('/templates', methods=['GET'])
def get_templates():
"""获取可用模板列表"""
try:
if not report_agent:
return jsonify({
'success': False,
'error': 'Report Engine未初始化'
}), 500
template_dir = settings.TEMPLATE_DIR
templates = []
if os.path.exists(template_dir):
for filename in os.listdir(template_dir):
if filename.endswith('.md'):
template_path = os.path.join(template_dir, filename)
try:
with open(template_path, 'r', encoding='utf-8') as f:
content = f.read()
templates.append({
'name': filename.replace('.md', ''),
'filename': filename,
'description': content.split('\n')[0] if content else '无描述',
'size': len(content)
})
except Exception as e:
logger.exception(f"读取模板失败 {filename}: {str(e)}")
return jsonify({
'success': True,
'templates': templates,
'template_dir': template_dir
})
except Exception as e:
logger.exception(f"获取可用模板列表失败: {str(e)}")
return jsonify({
'success': False,
'error': str(e)
}), 500
# 错误处理
@report_bp.errorhandler(404)
def not_found(error):
logger.exception(f"API端点不存在: {str(error)}")
return jsonify({
'success': False,
'error': 'API端点不存在'
}), 404
@report_bp.errorhandler(500)
def internal_error(error):
logger.exception(f"服务器内部错误: {str(error)}")
return jsonify({
'success': False,
'error': '服务器内部错误'
}), 500
def clear_report_log():
"""清空report.log文件"""
try:
log_file = settings.LOG_FILE
with open(log_file, 'w', encoding='utf-8') as f:
f.write('')
logger.info(f"已清空日志文件: {log_file}")
except Exception as e:
logger.exception(f"清空日志文件失败: {str(e)}")
@report_bp.route('/log', methods=['GET'])
def get_report_log():
"""获取report.log内容"""
try:
log_file = settings.LOG_FILE
if not os.path.exists(log_file):
return jsonify({
'success': True,
'log_lines': []
})
with open(log_file, 'r', encoding='utf-8') as f:
lines = f.readlines()
# 清理行尾的换行符
log_lines = [line.rstrip('\n\r') for line in lines if line.strip()]
return jsonify({
'success': True,
'log_lines': log_lines
})
except Exception as e:
logger.exception(f"读取日志失败: {str(e)}")
return jsonify({
'success': False,
'error': f'读取日志失败: {str(e)}'
}), 500
@report_bp.route('/log/clear', methods=['POST'])
def clear_log():
"""手动清空日志"""
try:
clear_report_log()
return jsonify({
'success': True,
'message': '日志已清空'
})
except Exception as e:
logger.exception(f"清空日志失败: {str(e)}")
return jsonify({
'success': False,
'error': f'清空日志失败: {str(e)}'
}), 500