feat(plugins): 4 个业务插件代码 + 前台公开页面改造

plugins/navManager:导航 CRUD + 导航分类 CRUD(独立 blueprint)
plugins/friendManager:友情链接 CRUD
plugins/aboutManager:关于本站 CRUD
plugins/siteStats:访问统计主页 + JSON 接口 + /site/* GET 埋点 + nav 卡片点击埋点

applications/view/public/nav.py:导航聚合页 / 分类详情 / JSON 接口,支持 visit_count 注入
applications/view/public/about.py:关于本站公开页
applications/view/public/friend.py:友情链接公开页

templates/public/base.html:响应式首页(搜索框 / 分类抽屉 / 5 主题切换 / footer 隐私小字)
templates/public/index.html / category.html:卡片右下角访问次数
templates/public/about.html / friend.html:关于 + 友链前台页

docs/plugins-development.md:插件开发完整指南(生命周期 + 4 个示例 + FAQ + framework 迁移)

scripts/:探针与端到端验证脚本(probe_*/verify_*/test_*)
This commit is contained in:
bwstudio
2026-09-06 18:18:06 +08:00
parent 1ea69c2c34
commit 0ffc103e46
53 changed files with 4705 additions and 89 deletions
+5
View File
@@ -0,0 +1,5 @@
{
"plugin_name": "关于本站",
"plugin_version": "1.0.0",
"plugin_description": "关于本站后台编辑页与保存接口。表 site_about 单条记录。"
}
+9
View File
@@ -0,0 +1,9 @@
"""关于本站插件入口"""
from flask import Flask
from .view.about import bp
def event_init(app: Flask):
app.register_blueprint(bp)
print(" * aboutManager: registered /system/about/* blueprint")
@@ -0,0 +1,150 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>关于本站</title>
{% include 'system/common/header.html' %}
</head>
<body class="pear-container">
<div class="layui-card">
<div class="layui-card-header">
<span class="layui-icon layui-icon-about"></span> 关于本站
<span style="float:right;font-size:12px;color:#999;margin-top:5px;">
共 1 条记录(站点全局唯一,修改即时生效)
</span>
</div>
<div class="layui-card-body">
<form class="layui-form" lay-filter="about-form" style="padding-right: 20px;">
{{ csrf_input()|safe }}
<div class="layui-form-item">
<label class="layui-form-label">站点名</label>
<div class="layui-input-block">
<input type="text" name="siteName" value="{{ about.site_name or '' }}"
placeholder="公开页显示的标题" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">自我介绍</label>
<div class="layui-input-block">
<textarea name="contentMd" placeholder="支持 Markdown 语法(# 标题、- 列表、** 加粗**、` 代码、> 引用……)"
class="layui-textarea" rows="10"
style="font-family: Consolas, 'Microsoft YaHei', monospace;">{{ about.content_md or '' }}</textarea>
</div>
<div class="layui-form-mid layui-word-aux">
前台 /site/about 会用 Markdown 渲染,提交空内容则显示默认占位文字
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">ICP 备案</label>
<div class="layui-input-block">
<input type="text" name="icp" value="{{ about.icp or '' }}"
placeholder="如 京ICP备12345678号" autocomplete="off" class="layui-input">
</div>
</div>
<fieldset class="layui-elem-field" style="margin: 20px 0; padding: 0 20px;">
<legend>联系方式</legend>
<div class="layui-form-item">
<div class="layui-inline">
<label class="layui-form-label">邮箱</label>
<div class="layui-input-inline">
<input type="email" name="contactEmail" value="{{ about.contact_email or '' }}"
placeholder="hi@example.com" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-inline">
<label class="layui-form-label">QQ</label>
<div class="layui-input-inline">
<input type="text" name="contactQq" value="{{ about.contact_qq or '' }}"
placeholder="12345678" autocomplete="off" class="layui-input">
</div>
</div>
</div>
<div class="layui-form-item">
<div class="layui-inline">
<label class="layui-form-label">微信</label>
<div class="layui-input-inline">
<input type="text" name="contactWechat" value="{{ about.contact_wechat or '' }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-inline">
<label class="layui-form-label">Telegram</label>
<div class="layui-input-inline">
<input type="text" name="contactTelegram" value="{{ about.contact_telegram or '' }}"
placeholder="@your_id 或 https://t.me/xxx" autocomplete="off" class="layui-input">
</div>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">GitHub</label>
<div class="layui-input-block">
<input type="url" name="contactGithub" value="{{ about.contact_github or '' }}"
placeholder="https://github.com/yourname" autocomplete="off" class="layui-input">
</div>
</div>
</fieldset>
<div class="layui-form-item">
<label class="layui-form-label">打赏/捐赠</label>
<div class="layui-input-block">
<input type="text" name="donateUrl" value="{{ about.donate_url or '' }}"
placeholder="可填二维码图片地址 或 PayPal/支付宝收款链接" autocomplete="off" class="layui-input">
</div>
<div class="layui-form-mid layui-word-aux">
前台 /site/about 会在底部显示
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button type="button" class="layui-btn" lay-submit lay-filter="about-submit">
<i class="layui-icon layui-icon-ok"></i> 保存
</button>
<button type="reset" class="layui-btn layui-btn-primary">重置</button>
<a href="/site/about" target="_blank" class="layui-btn layui-btn-warm" style="margin-left: 16px;">
<i class="layui-icon layui-icon-link"></i> 查看前台效果
</a>
</div>
</div>
</form>
</div>
</div>
</body>
{% include 'system/common/footer.html' %}
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
// 隐藏字段随 Layui form 一起序列化
form.on('submit(about-submit)', function(data){
// data.field 已经包含 csrf_token(隐藏域)+ 所有可见字段
$.ajax({
url: '/system/about/save',
type: 'POST',
contentType: 'application/json',
data: JSON.stringify(data.field),
success: function(res){
if (res.success) {
layer.msg(res.msg, {icon: 1});
} else {
layer.msg(res.msg, {icon: 2});
}
},
error: function(){
layer.msg('保存失败,请稍后再试', {icon: 2});
}
});
return false;
});
});
</script>
</body>
</html>
+65
View File
@@ -0,0 +1,65 @@
"""
「关于本站」后台管理:编辑单条记录 (id=1)。
插件版。
"""
import os
from flask import Blueprint, render_template, request
from flask_wtf.csrf import validate_csrf
from wtforms.validators import ValidationError
from applications.common.utils.http import fail_api, success_api
from applications.common.utils.rights import authorize
from applications.common.utils.validate import str_escape
from applications.extensions import db
from applications.models import About
dir_path = os.path.dirname(os.path.abspath(__file__))
bp = Blueprint(
'about', __name__,
url_prefix='/system/about',
template_folder=os.path.join(dir_path, '..', 'templates'),
)
def _get_about() -> About:
a = About.query.get(1)
if a is None:
a = About(id=1, site_name='旺珂 · 导航')
db.session.add(a)
db.session.commit()
return a
@bp.get('/')
@authorize("site:about:main")
def main():
about = _get_about()
return render_template('system/about/main.html', about=about)
@bp.post('/save')
@authorize("site:about:main", log=True)
def save():
req_json = request.get_json(force=True, silent=True) or {}
try:
validate_csrf(req_json.get("csrf_token"))
except ValidationError:
return fail_api(msg='非法请求')
a = _get_about()
fields = {
'site_name': (req_json.get('siteName') or '').strip()[:120],
'content_md': (req_json.get('contentMd') or '').strip(),
'icp': (req_json.get('icp') or '').strip()[:120],
'contact_email': (req_json.get('contactEmail') or '').strip()[:120],
'contact_qq': (req_json.get('contactQq') or '').strip()[:32],
'contact_wechat': (req_json.get('contactWechat') or '').strip()[:120],
'contact_telegram': (req_json.get('contactTelegram') or '').strip()[:120],
'contact_github': (req_json.get('contactGithub') or '').strip()[:255],
'donate_url': (req_json.get('donateUrl') or '').strip()[:255],
}
for k, v in fields.items():
setattr(a, k, v)
db.session.commit()
return success_api(msg='保存成功')
+5
View File
@@ -0,0 +1,5 @@
{
"plugin_name": "友情链接",
"plugin_version": "1.0.0",
"plugin_description": "后台友情链接模块。后台菜单位于「站点管理 / 友情链接」。对 site_friend 表的增删改查与启用/禁用。"
}
+9
View File
@@ -0,0 +1,9 @@
"""友情链接插件入口"""
from flask import Flask
from .view.friend import bp
def event_init(app: Flask):
app.register_blueprint(bp)
print(" * friendManager: registered /system/friend/* blueprint")
@@ -0,0 +1,114 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>新增友情链接</title>
{% include 'system/common/header.html' %}
</head>
<body>
<div class="layui-form" lay-filter="friend-form" style="padding: 20px 30px 0 0;">
<div class="layui-form-item">
<label class="layui-form-label">名称</label>
<div class="layui-input-block">
<input type="text" name="title" required lay-verify="required" placeholder="显示在友链列表上的名字"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">链接</label>
<div class="layui-input-block">
<input type="text" name="url" required lay-verify="required|url" placeholder="https://example.com"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">Logo</label>
<div class="layui-input-block">
<input type="text" name="logo" placeholder="https://example.com/favicon.ico(可留空)"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<input type="text" name="description" placeholder="一句话介绍对方站"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">分组</label>
<div class="layui-input-block">
<input type="text" name="category" placeholder="默认「推荐友链」"
value="推荐友链" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-block">
<input type="number" name="sort" value="0" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">类型</label>
<div class="layui-input-block">
<input type="radio" name="isExternal" value="1" title="外链(新窗口)" checked>
<input type="radio" name="isExternal" value="0" title="站内(当前窗)">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
<input type="radio" name="enable" value="1" title="启用" checked>
<input type="radio" name="enable" value="0" title="禁用">
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button type="button" class="layui-btn" lay-submit lay-filter="friend-form-submit">立即提交</button>
<button type="reset" class="layui-btn layui-btn-primary">重置</button>
</div>
</div>
</div>
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.render();
form.on('submit(friend-form-submit)', function(){
var data = form.val('friend-form');
var submitBtn = $('button[lay-filter="friend-form-submit"]');
submitBtn.prop('disabled', true).addClass('layui-btn-disabled');
$.ajax({
url: '/system/friend/save',
type: 'POST',
contentType: 'application/json',
data: JSON.stringify({
title: data.title,
url: data.url,
logo: data.logo,
description: data.description,
category: data.category,
sort: data.sort,
isExternal: data.isExternal,
enable: data.enable
}),
success: function(res){
layer.msg(res.msg || (res.code === 0 ? '保存成功' : '保存失败'));
if (res.code === 0 || res.success) {
setTimeout(function(){ parent.layer.close(parent.layer.getFrameIndex(window.name)); }, 600);
}
},
error: function(){ layer.msg('请求失败'); },
complete: function(){
submitBtn.prop('disabled', false).removeClass('layui-btn-disabled');
}
});
return false;
});
});
</script>
</body>
</html>
@@ -0,0 +1,117 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>编辑友情链接</title>
{% include 'system/common/header.html' %}
</head>
<body>
<div class="layui-form" lay-filter="friend-form" style="padding: 20px 30px 0 0;">
<input type="hidden" name="id" value="{{ friend.id }}">
<div class="layui-form-item">
<label class="layui-form-label">名称</label>
<div class="layui-input-block">
<input type="text" name="title" required lay-verify="required" value="{{ friend.title }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">链接</label>
<div class="layui-input-block">
<input type="text" name="url" required lay-verify="required|url" value="{{ friend.url }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">Logo</label>
<div class="layui-input-block">
<input type="text" name="logo" value="{{ friend.logo or '' }}"
placeholder="https://example.com/favicon.ico(可留空)"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<input type="text" name="description" value="{{ friend.description or '' }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">分组</label>
<div class="layui-input-block">
<input type="text" name="category" value="{{ friend.category or '推荐友链' }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-block">
<input type="number" name="sort" value="{{ friend.sort or 0 }}" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">类型</label>
<div class="layui-input-block">
<input type="radio" name="isExternal" value="1" title="外链(新窗口)" {% if friend.is_external == 1 %}checked{% endif %}>
<input type="radio" name="isExternal" value="0" title="站内(当前窗)" {% if friend.is_external == 0 %}checked{% endif %}>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
<input type="radio" name="enable" value="1" title="启用" {% if friend.enable == 1 %}checked{% endif %}>
<input type="radio" name="enable" value="0" title="禁用" {% if friend.enable == 0 %}checked{% endif %}>
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button type="button" class="layui-btn" lay-submit lay-filter="friend-form-submit">保存</button>
<button type="reset" class="layui-btn layui-btn-primary">重置</button>
</div>
</div>
</div>
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.render();
form.on('submit(friend-form-submit)', function(){
var data = form.val('friend-form');
var submitBtn = $('button[lay-filter="friend-form-submit"]');
submitBtn.prop('disabled', true).addClass('layui-btn-disabled');
$.ajax({
url: '/system/friend/update',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({
friendId: data.id,
title: data.title,
url: data.url,
logo: data.logo,
description: data.description,
category: data.category,
sort: data.sort,
isExternal: data.isExternal,
enable: data.enable
}),
success: function(res){
layer.msg(res.msg || (res.code === 0 ? '保存成功' : '保存失败'));
if (res.code === 0 || res.success) {
setTimeout(function(){ parent.layer.close(parent.layer.getFrameIndex(window.name)); }, 600);
}
},
error: function(){ layer.msg('请求失败'); },
complete: function(){
submitBtn.prop('disabled', false).removeClass('layui-btn-disabled');
}
});
return false;
});
});
</script>
</body>
</html>
@@ -0,0 +1,171 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>友情链接</title>
{% include 'system/common/header.html' %}
</head>
<body class="pear-container">
<div class="layui-card">
<div class="layui-card-body">
<form class="layui-form" action="" lay-filter="friend-query-form">
<div class="layui-form-item" style="margin-bottom: unset;">
<label class="layui-form-label">关键词</label>
<div class="layui-input-inline">
<input type="text" name="keyword" placeholder="名称/链接/简介" class="layui-input">
</div>
<label class="layui-form-label">分类</label>
<div class="layui-input-inline">
<input type="text" name="category" placeholder="按分组过滤" class="layui-input">
</div>
<button class="layui-btn layui-btn-md" lay-submit lay-filter="friend-query">
<i class="layui-icon layui-icon-search"></i> 查询
</button>
<button type="reset" class="layui-btn layui-btn-primary layui-btn-md">
<i class="layui-icon layui-icon-refresh"></i> 重置
</button>
<button type="button" class="layui-btn layui-btn-normal layui-btn-md" id="btn-add">
<i class="layui-icon layui-icon-add-1"></i> 新增友链
</button>
</div>
</form>
</div>
</div>
<div class="layui-card">
<div class="layui-card-body">
<table id="friend-table" lay-filter="friend-table"></table>
</div>
</div>
{% include 'system/common/footer.html' %}
{% raw %}
<script type="text/html" id="col-friend-status">
{{# if(d.enable === 1){ }}
<span class="layui-badge layui-bg-green">启用</span>
{{# } else { }}
<span class="layui-badge layui-bg-gray">禁用</span>
{{# } }}
</script>
<script type="text/html" id="col-friend-external">
{{# if(d.is_external === 1){ }}
<span class="layui-badge layui-bg-blue">外链</span>
{{# } else { }}
<span class="layui-badge">站内</span>
{{# } }}
</script>
<script type="text/html" id="col-friend-logo">
{{# if(d.logo){ }}
<img src="{{ d.logo }}" style="height:24px;max-width:80px;" onerror="this.style.display='none'" />
{{# } else { }}
<span style="color:#999"></span>
{{# } }}
</script>
<script type="text/html" id="col-friend-op">
<a class="layui-btn layui-btn-xs" lay-event="edit">编辑</a>
{{# if(d.enable === 1){ }}
<a class="layui-btn layui-btn-xs layui-btn-warm" lay-event="disable">禁用</a>
{{# } else { }}
<a class="layui-btn layui-btn-xs layui-btn-normal" lay-event="enable">启用</a>
{{# } }}
<a class="layui-btn layui-btn-xs layui-btn-danger" lay-event="remove">删除</a>
</script>
{% endraw %}
<script>
layui.use(['table', 'form', 'layer'], function(){
var table = layui.table;
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
var renderTable = function(){
var keyword = $('input[name="keyword"]').val() || '';
var category = $('input[name="category"]').val() || '';
table.render({
elem: '#friend-table',
url: '/system/friend/data',
where: { keyword: keyword, category: category },
page: true,
limit: 20,
cols: [[
{field: 'id', title: 'ID', width: 60},
{field: 'title', title: '名称', width: 180},
{field: 'logo', title: 'Logo', width: 100, templet: '#col-friend-logo'},
{field: 'url', title: '链接', minWidth: 220},
{field: 'description', title: '简介', minWidth: 200},
{field: 'category', title: '分组', width: 120},
{field: 'sort', title: '排序', width: 70},
{field: 'is_external', title: '类型', width: 80, templet: '#col-friend-external'},
{field: 'enable', title: '状态', width: 80, templet: '#col-friend-status'},
{field: 'create_at', title: '创建时间', width: 170},
{fixed: 'right', title: '操作', toolbar: '#col-friend-op', width: 220}
]],
skin: 'line',
text: {none: '暂无友情链接'},
// table_api 默认返回 {code:0, data, count, msg, limit} 与 Layui 默认 statusCode:0 兼容
});
};
renderTable();
form.on('submit(friend-query)', function(){
renderTable();
return false;
});
$('#btn-add').on('click', function(){
layer.open({
type: 2,
title: '新增友情链接',
area: ['640px', '620px'],
content: '/system/friend/add'
});
});
table.on('tool(friend-table)', function(obj){
var data = obj.data;
if (obj.event === 'edit'){
layer.open({
type: 2,
title: '编辑友情链接',
area: ['640px', '620px'],
content: '/system/friend/edit?friendId=' + data.id
});
} else if (obj.event === 'remove'){
layer.confirm('确定删除该友链吗?', function(idx){
$.ajax({
url: '/system/friend/remove/' + data.id,
type: 'DELETE',
success: function(res){
if (res.code === 0 || res.success) { layer.msg(res.msg); obj.del(); }
else layer.msg(res.msg);
}
});
layer.close(idx);
});
} else if (obj.event === 'enable'){
$.ajax({
url: '/system/friend/enable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({friendId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
} else if (obj.event === 'disable'){
$.ajax({
url: '/system/friend/disable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({friendId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
}
});
});
</script>
</body>
</html>
+168
View File
@@ -0,0 +1,168 @@
"""
后台友情链接视图 — 插件版(不依赖 framework 系统蓝图)。
URL 前缀变更:原 `'/friend'` 改成 `'/system/friend'`,独立挂载到 app。
"""
import os
from flask import Blueprint, render_template, request
from flask_login import current_user
from applications.common import curd
from applications.common.utils.http import table_api, fail_api, success_api
from applications.common.utils.rights import authorize
from applications.common.utils.validate import str_escape
from applications.extensions import db
from applications.extensions.init_limit import limiter
from applications.models import Friend
from applications.schemas import FriendManageSchema
dir_path = os.path.dirname(os.path.abspath(__file__))
bp = Blueprint(
'friend', __name__,
url_prefix='/system/friend',
template_folder=os.path.join(dir_path, '..', 'templates'),
)
@bp.get('/')
@authorize("system:friend:main")
def main():
return render_template('system/friend/main.html')
@bp.get('/data')
@limiter.limit("60 per minute")
@authorize("system:friend:main")
def data():
keyword = str_escape(request.args.get('keyword', type=str))
category = str_escape(request.args.get('category', type=str))
query = Friend.query.filter()
if keyword:
query = query.filter(
db.or_(
Friend.title.contains(keyword),
Friend.url.contains(keyword),
Friend.description.contains(keyword),
)
)
if category:
query = query.filter(Friend.category == category)
items = query.order_by(Friend.category.asc(), Friend.sort.asc(), Friend.id.asc()).layui_paginate()
return table_api(
msg="请求成功",
data=curd.model_to_dicts(schema=FriendManageSchema, data=items.items),
count=items.total,
)
@bp.get('/add')
@authorize("system:friend:add", log=True)
def add():
return render_template('system/friend/add.html')
@bp.post('/save')
@authorize("system:friend:add", log=True)
def save():
req_json = request.get_json(force=True, silent=True) or {}
title = str_escape(req_json.get('title'))
url = str_escape(req_json.get('url'))
if not all([title, url]):
return fail_api(msg="名称/链接不得为空")
try:
friend = Friend(
title=title,
url=url,
logo=str_escape(req_json.get('logo')),
description=str_escape(req_json.get('description')),
category=str_escape(req_json.get('category')) or '推荐友链',
sort=int(req_json.get('sort') or 0),
enable=int(req_json.get('enable') or 1),
is_external=int(req_json.get('isExternal') or 1),
create_by=current_user.username if current_user.is_authenticated else 'admin',
)
db.session.add(friend)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f"新增失败:{e}")
return success_api(msg="新增成功")
@bp.get('/edit')
@authorize("site:friend:edit", log=True)
def edit():
friend_id = request.args.get('friendId', type=int)
friend = curd.get_one_by_id(Friend, friend_id)
if not friend:
return fail_api(msg="友链不存在")
return render_template('system/friend/edit.html', friend=friend)
@bp.put('/update')
@authorize("site:friend:edit", log=True)
def update():
req_json = request.get_json(force=True, silent=True) or {}
friend_id = req_json.get('friendId')
friend = curd.get_one_by_id(Friend, friend_id)
if not friend:
return fail_api(msg="友链不存在")
title = str_escape(req_json.get('title'))
url = str_escape(req_json.get('url'))
if not all([title, url]):
return fail_api(msg="名称/链接不得为空")
try:
friend.title = title
friend.url = url
friend.logo = str_escape(req_json.get('logo'))
friend.description = str_escape(req_json.get('description'))
friend.category = str_escape(req_json.get('category')) or '推荐友链'
friend.sort = int(req_json.get('sort') or 0)
friend.enable = int(req_json.get('enable') or 1)
friend.is_external = int(req_json.get('isExternal') or 1)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f"更新失败:{e}")
return success_api(msg="更新成功")
@bp.delete('/remove/<int:friend_id>')
@authorize("system:friend:remove", log=True)
def remove(friend_id):
res = curd.delete_one_by_id(Friend, friend_id)
if not res:
return fail_api(msg="删除失败")
return success_api(msg="删除成功")
@bp.put('/enable')
@authorize("site:friend:edit", log=True)
def enable():
req_json = request.get_json(force=True, silent=True) or {}
friend_id = req_json.get('friendId')
if not friend_id:
return fail_api(msg="数据错误")
res = curd.enable_status(Friend, friend_id)
if not res:
return fail_api(msg="操作失败")
return success_api(msg="已启用")
@bp.put('/disable')
@authorize("site:friend:edit", log=True)
def dis_enable():
req_json = request.get_json(force=True, silent=True) or {}
friend_id = req_json.get('friendId')
if not friend_id:
return fail_api(msg="数据错误")
res = curd.disable_status(Friend, friend_id)
if not res:
return fail_api(msg="操作失败")
return success_api(msg="已禁用")
+5
View File
@@ -0,0 +1,5 @@
{
"plugin_name": "导航管理",
"plugin_version": "1.0.0",
"plugin_description": "后台导航管理模块。后台菜单位于「站点管理 / 导航管理」。提供对 nav 表的增删改查、分页查询、关键字 + 分类过滤、启用/禁用切换。"
}
+19
View File
@@ -0,0 +1,19 @@
"""
导航管理插件入口
通过 Pear Admin Flask 插件系统注册到 /system/nav/* 与 /system/nav-category/* 路径。
此插件不修改 framework 任何代码,仅挂在对应前缀下,注册蓝图即可。
数据层沿用 applications.models.{Nav, NavCategory}SQLAlchemy 模型必须由 framework 加载以便 Alembic 跟踪)。
"""
from flask import Flask
from .view.nav import bp
from .view.nav_category import bp as nav_category_bp
def event_init(app: Flask):
"""初始化完成时注册蓝图到 app(直接挂到 app,而不是 framework 的 system_bp)。"""
app.register_blueprint(bp)
app.register_blueprint(nav_category_bp)
print(" * navManager: registered /system/nav/* and /system/nav-category/* blueprints")
@@ -0,0 +1,101 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>新增导航</title>
{% include 'system/common/header.html' %}
</head>
<body>
<div class="layui-form" lay-filter="nav-form" style="padding: 20px 30px 0 0;">
<div class="layui-form-item">
<label class="layui-form-label">分类</label>
<div class="layui-input-block">
<input type="text" name="category" required lay-verify="required" placeholder="如:开发工具 / AI / 设计资源"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">标题</label>
<div class="layui-input-block">
<input type="text" name="title" required lay-verify="required" placeholder="显示在卡片上的名称"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">链接 URL</label>
<div class="layui-input-block">
<input type="text" name="url" required lay-verify="required|url"
placeholder="https://example.com" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<textarea name="description" placeholder="选填,鼠标悬停时显示" class="layui-textarea"></textarea>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">图标</label>
<div class="layui-input-block">
<input type="text" name="icon" placeholder="layui-icon-website / layui-icon-ai / 等"
autocomplete="off" class="layui-input" value="layui-icon-link">
<div class="layui-form-mid layui-word-aux">参考:<a href="https://layui.dev/web/doc/element/icon.html" target="_blank">layui 图标库</a></div>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-inline">
<input type="number" name="sort" value="0" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">类型</label>
<div class="layui-input-block">
<input type="radio" name="isExternal" value="1" title="外链(新窗口)" checked>
<input type="radio" name="isExternal" value="0" title="站内(当前窗口)">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
<input type="radio" name="enable" value="1" title="启用" checked>
<input type="radio" name="enable" value="0" title="禁用">
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button class="layui-btn" lay-submit lay-filter="nav-submit">保存</button>
<button type="reset" class="layui-btn layui-btn-primary">重置</button>
</div>
</div>
</div>
{% include 'system/common/footer.html' %}
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.on('submit(nav-submit)', function(data){
$.ajax({
url: '/system/nav/save',
type: 'POST',
contentType: 'application/json',
data: JSON.stringify(data.field),
success: function(res){
if (res.success) {
layer.msg(res.msg, {icon: 1});
parent.layui.table.reload('nav-table');
setTimeout(function(){ parent.layer.closeAll(); }, 800);
} else {
layer.msg(res.msg, {icon: 2});
}
}
});
return false;
});
});
</script>
</body>
</html>
@@ -0,0 +1,84 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>新增导航分类</title>
{% include 'system/common/header.html' %}
<style>
.layui-form-label { width: 90px; }
.layui-input-block { margin-left: 120px; }
</style>
</head>
<body class="pear-container">
<form class="layui-form" lay-filter="cat-add-form" style="margin-top: 20px;">
<div class="layui-form-item">
<label class="layui-form-label">分类名</label>
<div class="layui-input-block">
<input type="text" name="name" required lay-verify="required" placeholder="请输入分类名(唯一)" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">图标 class</label>
<div class="layui-input-block">
<input type="text" name="icon" placeholder="layui-icon-list" value="layui-icon-list" class="layui-input">
<div class="layui-form-mid layui-word-aux">填写 layui 图标 class,例如 layui-icon-list / layui-icon-star</div>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<input type="text" name="description" placeholder="前台首页卡片标题下方的描述" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-block">
<input type="number" name="sort" value="0" class="layui-input">
<div class="layui-form-mid layui-word-aux">数字越大,越靠前</div>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
<input type="radio" name="enable" value="1" title="启用" checked>
<input type="radio" name="enable" value="0" title="禁用">
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button type="submit" class="layui-btn" lay-submit lay-filter="cat-submit">立即提交</button>
<button type="reset" class="layui-btn layui-btn-primary">重置</button>
</div>
</div>
</form>
{% include 'system/common/footer.html' %}
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.on('submit(cat-submit)', function(data){
$.ajax({
url: '/system/nav-category/save',
type: 'POST',
contentType: 'application/json',
data: JSON.stringify(data.field),
success: function(res){
if (res.code === 0 || res.success) {
layer.msg(res.msg, {icon: 1}, function(){
parent.layui.table.reload('cat-table');
parent.layer.closeAll();
});
} else {
layer.msg(res.msg, {icon: 2});
}
}
});
return false;
});
});
</script>
</body>
</html>
@@ -0,0 +1,95 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>编辑导航分类</title>
{% include 'system/common/header.html' %}
<style>
.layui-form-label { width: 90px; }
.layui-input-block { margin-left: 120px; }
</style>
</head>
<body class="pear-container">
<form class="layui-form" lay-filter="cat-edit-form" style="margin-top: 20px;">
<input type="hidden" name="catId" value="{{ cat.id }}">
<div class="layui-form-item">
<label class="layui-form-label">分类名</label>
<div class="layui-input-block">
<input type="text" name="name" required lay-verify="required" value="{{ cat.name }}" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">图标 class</label>
<div class="layui-input-block">
<input type="text" name="icon" value="{{ cat.icon or 'layui-icon-list' }}" class="layui-input">
<div class="layui-form-mid layui-word-aux">填写 layui 图标 class</div>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<input type="text" name="description" value="{{ cat.description or '' }}" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-block">
<input type="number" name="sort" value="{{ cat.sort or 0 }}" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
{% if cat.enable == 1 %}
<input type="radio" name="enable" value="1" title="启用" checked>
<input type="radio" name="enable" value="0" title="禁用">
{% else %}
<input type="radio" name="enable" value="1" title="启用">
<input type="radio" name="enable" value="0" title="禁用" checked>
{% endif %}
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button type="submit" class="layui-btn" lay-submit lay-filter="cat-submit">立即提交</button>
<button type="button" class="layui-btn layui-btn-primary" id="btn-cancel">取消</button>
</div>
</div>
</form>
{% include 'system/common/footer.html' %}
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.render();
form.on('submit(cat-submit)', function(data){
$.ajax({
url: '/system/nav-category/update',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify(data.field),
success: function(res){
if (res.code === 0 || res.success) {
layer.msg(res.msg, {icon: 1}, function(){
parent.layui.table.reload('cat-table');
parent.layer.closeAll();
});
} else {
layer.msg(res.msg, {icon: 2});
}
}
});
return false;
});
$('#btn-cancel').on('click', function(){
parent.layer.closeAll();
});
});
</script>
</body>
</html>
@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>导航分类管理</title>
{% include 'system/common/header.html' %}
</head>
<body class="pear-container">
<div class="layui-card">
<div class="layui-card-body">
<form class="layui-form" action="" lay-filter="cat-query-form">
<div class="layui-form-item" style="margin-bottom: unset;">
<label class="layui-form-label">关键词</label>
<div class="layui-input-inline">
<input type="text" name="keyword" placeholder="分类名/简介" class="layui-input">
</div>
<button class="layui-btn layui-btn-md" lay-submit lay-filter="cat-query">
<i class="layui-icon layui-icon-search"></i> 查询
</button>
<button type="reset" class="layui-btn layui-btn-primary layui-btn-md">
<i class="layui-icon layui-icon-refresh"></i> 重置
</button>
<button type="button" class="layui-btn layui-btn-normal layui-btn-md" id="btn-add">
<i class="layui-icon layui-icon-add-1"></i> 新增分类
</button>
</div>
</form>
</div>
</div>
<div class="layui-card">
<div class="layui-card-body">
<table id="cat-table" lay-filter="cat-table"></table>
</div>
</div>
{% include 'system/common/footer.html' %}
{% raw %}
<script type="text/html" id="col-cat-status">
{{# if(d.enable === 1){ }}
<span class="layui-badge layui-bg-green">启用</span>
{{# } else { }}
<span class="layui-badge layui-bg-gray">禁用</span>
{{# } }}
</script>
<script type="text/html" id="col-cat-op">
<a class="layui-btn layui-btn-xs" lay-event="edit">编辑</a>
{{# if(d.enable === 1){ }}
<a class="layui-btn layui-btn-xs layui-btn-warm" lay-event="disable">禁用</a>
{{# } else { }}
<a class="layui-btn layui-btn-xs layui-btn-normal" lay-event="enable">启用</a>
{{# } }}
<a class="layui-btn layui-btn-xs layui-btn-danger" lay-event="remove">删除</a>
</script>
{% endraw %}
<script>
layui.use(['table', 'form', 'layer'], function(){
var table = layui.table;
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
var renderTable = function(){
var keyword = $('input[name="keyword"]').val() || '';
table.render({
elem: '#cat-table',
url: '/system/nav-category/data',
where: { keyword: keyword },
page: true,
limit: 20,
cols: [[
{field: 'id', title: 'ID', width: 60},
{field: 'name', title: '分类名', width: 150},
{field: 'icon', title: '图标', width: 150},
{field: 'description', title: '简介', minWidth: 220},
{field: 'sort', title: '排序', width: 70},
{field: 'enable', title: '状态', width: 80, templet: '#col-cat-status'},
{field: 'create_at', title: '创建时间', width: 170},
{fixed: 'right', title: '操作', toolbar: '#col-cat-op', width: 220}
]],
skin: 'line',
text: {none: '暂无分类数据'}
});
};
renderTable();
form.on('submit(cat-query)', function(){
renderTable();
return false;
});
$('#btn-add').on('click', function(){
layer.open({
type: 2,
title: '新增导航分类',
area: ['520px', '520px'],
content: '/system/nav-category/add'
});
});
table.on('tool(cat-table)', function(obj){
var data = obj.data;
if (obj.event === 'edit'){
layer.open({
type: 2,
title: '编辑导航分类',
area: ['520px', '520px'],
content: '/system/nav-category/edit?catId=' + data.id
});
} else if (obj.event === 'remove'){
layer.confirm('确定删除该分类吗?\n(该分类下的导航不会删除,但前台将归入「未分组」)', function(idx){
$.ajax({
url: '/system/nav-category/remove/' + data.id,
type: 'DELETE',
success: function(res){
if (res.code === 0 || res.success) { layer.msg(res.msg); obj.del(); }
else layer.msg(res.msg);
}
});
layer.close(idx);
});
} else if (obj.event === 'enable'){
$.ajax({
url: '/system/nav-category/enable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({catId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
} else if (obj.event === 'disable'){
$.ajax({
url: '/system/nav-category/disable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({catId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
}
});
});
</script>
</body>
</html>
@@ -0,0 +1,100 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>编辑导航</title>
{% include 'system/common/header.html' %}
</head>
<body>
<div class="layui-form" lay-filter="nav-form" style="padding: 20px 30px 0 0;">
<input type="hidden" name="id" value="{{ nav.id }}">
<div class="layui-form-item">
<label class="layui-form-label">分类</label>
<div class="layui-input-block">
<input type="text" name="category" required lay-verify="required" value="{{ nav.category }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">标题</label>
<div class="layui-input-block">
<input type="text" name="title" required lay-verify="required" value="{{ nav.title }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">链接 URL</label>
<div class="layui-input-block">
<input type="text" name="url" required lay-verify="required|url" value="{{ nav.url }}"
autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">简介</label>
<div class="layui-input-block">
<textarea name="description" class="layui-textarea">{{ nav.description or '' }}</textarea>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">图标</label>
<div class="layui-input-block">
<input type="text" name="icon" value="{{ nav.icon }}" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">排序</label>
<div class="layui-input-inline">
<input type="number" name="sort" value="{{ nav.sort }}" autocomplete="off" class="layui-input">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">类型</label>
<div class="layui-input-block">
<input type="radio" name="isExternal" value="1" title="外链(新窗口)" {% if nav.is_external == 1 %}checked{% endif %}>
<input type="radio" name="isExternal" value="0" title="站内(当前窗口)" {% if nav.is_external != 1 %}checked{% endif %}>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label">状态</label>
<div class="layui-input-block">
<input type="radio" name="enable" value="1" title="启用" {% if nav.enable == 1 %}checked{% endif %}>
<input type="radio" name="enable" value="0" title="禁用" {% if nav.enable != 1 %}checked{% endif %}>
</div>
</div>
<div class="layui-form-item">
<div class="layui-input-block">
<button class="layui-btn" lay-submit lay-filter="nav-submit">保存</button>
<button type="button" class="layui-btn layui-btn-primary" onclick="parent.layer.closeAll();">取消</button>
</div>
</div>
</div>
{% include 'system/common/footer.html' %}
<script>
layui.use(['form', 'layer'], function(){
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
form.on('submit(nav-submit)', function(data){
$.ajax({
url: '/system/nav/update',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify(data.field),
success: function(res){
if (res.success) {
layer.msg(res.msg, {icon: 1});
parent.layui.table.reload('nav-table');
setTimeout(function(){ parent.layer.closeAll(); }, 800);
} else {
layer.msg(res.msg, {icon: 2});
}
}
});
return false;
});
});
</script>
</body>
</html>
@@ -0,0 +1,162 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>导航管理</title>
{% include 'system/common/header.html' %}
</head>
<body class="pear-container">
<div class="layui-card">
<div class="layui-card-body">
<form class="layui-form" action="" lay-filter="nav-query-form">
<div class="layui-form-item" style="margin-bottom: unset;">
<label class="layui-form-label">关键词</label>
<div class="layui-input-inline">
<input type="text" name="keyword" placeholder="标题/链接/简介" class="layui-input">
</div>
<label class="layui-form-label">分类</label>
<div class="layui-input-inline">
<input type="text" name="category" placeholder="按分类过滤" class="layui-input">
</div>
<button class="layui-btn layui-btn-md" lay-submit lay-filter="nav-query">
<i class="layui-icon layui-icon-search"></i> 查询
</button>
<button type="reset" class="layui-btn layui-btn-primary layui-btn-md">
<i class="layui-icon layui-icon-refresh"></i> 重置
</button>
<button type="button" class="layui-btn layui-btn-normal layui-btn-md" id="btn-add">
<i class="layui-icon layui-icon-add-1"></i> 新增导航
</button>
</div>
</form>
</div>
</div>
<div class="layui-card">
<div class="layui-card-body">
<table id="nav-table" lay-filter="nav-table"></table>
</div>
</div>
{% include 'system/common/footer.html' %}
{% raw %}
<script type="text/html" id="col-status">
{{# if(d.enable === 1){ }}
<span class="layui-badge layui-bg-green">启用</span>
{{# } else { }}
<span class="layui-badge layui-bg-gray">禁用</span>
{{# } }}
</script>
<script type="text/html" id="col-external">
{{# if(d.is_external === 1){ }}
<span class="layui-badge layui-bg-blue">外链</span>
{{# } else { }}
<span class="layui-badge">站内</span>
{{# } }}
</script>
<script type="text/html" id="col-op">
<a class="layui-btn layui-btn-xs" lay-event="edit">编辑</a>
{{# if(d.enable === 1){ }}
<a class="layui-btn layui-btn-xs layui-btn-warm" lay-event="disable">禁用</a>
{{# } else { }}
<a class="layui-btn layui-btn-xs layui-btn-normal" lay-event="enable">启用</a>
{{# } }}
<a class="layui-btn layui-btn-xs layui-btn-danger" lay-event="remove">删除</a>
</script>
{% endraw %}
<script>
layui.use(['table', 'form', 'layer'], function(){
var table = layui.table;
var form = layui.form;
var layer = layui.layer;
var $ = layui.$;
var renderTable = function(){
var keyword = $('input[name="keyword"]').val() || '';
var category = $('input[name="category"]').val() || '';
table.render({
elem: '#nav-table',
url: '/system/nav/data',
where: { keyword: keyword, category: category },
page: true,
limit: 20,
cols: [[
{field: 'id', title: 'ID', width: 60},
{field: 'category', title: '分类', width: 120},
{field: 'title', title: '标题', width: 180},
{field: 'url', title: '链接', minWidth: 200},
{field: 'icon', title: '图标', width: 100},
{field: 'sort', title: '排序', width: 70},
{field: 'is_external', title: '类型', width: 80, templet: '#col-external'},
{field: 'enable', title: '状态', width: 80, templet: '#col-status'},
{field: 'create_at', title: '创建时间', width: 170},
{fixed: 'right', title: '操作', toolbar: '#col-op', width: 220}
]],
skin: 'line',
text: {none: '暂无导航数据'},
// table_api 默认返回 {code:0, data, count, msg, limit},与 Layui 默认 statusCode: 0 匹配,无需 parseData/response
});
};
renderTable();
form.on('submit(nav-query)', function(){
renderTable();
return false;
});
$('#btn-add').on('click', function(){
layer.open({
type: 2,
title: '新增导航',
area: ['640px', '620px'],
content: '/system/nav/add'
});
});
table.on('tool(nav-table)', function(obj){
var data = obj.data;
if (obj.event === 'edit'){
layer.open({
type: 2,
title: '编辑导航',
area: ['640px', '620px'],
content: '/system/nav/edit?navId=' + data.id
});
} else if (obj.event === 'remove'){
layer.confirm('确定删除该导航吗?', function(idx){
$.ajax({
url: '/system/nav/remove/' + data.id,
type: 'DELETE',
success: function(res){
if (res.code === 0 || res.success) { layer.msg(res.msg); obj.del(); }
else layer.msg(res.msg);
}
});
layer.close(idx);
});
} else if (obj.event === 'enable'){
$.ajax({
url: '/system/nav/enable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({navId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
} else if (obj.event === 'disable'){
$.ajax({
url: '/system/nav/disable',
type: 'PUT',
contentType: 'application/json',
data: JSON.stringify({navId: data.id}),
success: function(res){ layer.msg(res.msg); renderTable(); }
});
}
});
});
</script>
</body>
</html>
+176
View File
@@ -0,0 +1,176 @@
"""
后台导航管理视图(通过插件方式开发)
URL 前缀变更:
- 原蓝图 url_prefix='/nav'(注册到 system_bp → /system/nav/...
- 改为 url_prefix='/system/nav' 直接挂到 app,这样去掉了对 framework 内 system_bp 的依赖
- 与用户原始菜单路径 /system/nav 完全兼容,权限码 system:nav:* 保持不变
"""
import os
from flask import Blueprint, render_template, request
from flask_login import current_user
from applications.common import curd
from applications.common.utils.http import table_api, fail_api, success_api
from applications.common.utils.rights import authorize
from applications.common.utils.validate import str_escape
from applications.extensions import db
from applications.extensions.init_limit import limiter
from applications.models import Nav
from applications.schemas import NavManageSchema
# 插件级 Blueprint:直接挂到 app,前缀 /system/nav,独立模板目录
dir_path = os.path.dirname(os.path.abspath(__file__))
bp = Blueprint(
'nav', __name__,
url_prefix='/system/nav',
template_folder=os.path.join(dir_path, '..', 'templates'),
)
@bp.get('/')
@authorize("system:nav:main")
def main():
return render_template('system/nav/main.html')
@bp.get('/data')
@limiter.limit("60 per minute")
@authorize("system:nav:main")
def data():
keyword = str_escape(request.args.get('keyword', type=str))
category = str_escape(request.args.get('category', type=str))
query = Nav.query.filter()
if keyword:
query = query.filter(
db.or_(
Nav.title.contains(keyword),
Nav.url.contains(keyword),
Nav.description.contains(keyword),
)
)
if category:
query = query.filter(Nav.category == category)
items = query.order_by(Nav.category.asc(), Nav.sort.asc(), Nav.id.asc()).layui_paginate()
return table_api(
msg="请求成功",
data=curd.model_to_dicts(schema=NavManageSchema, data=items.items),
count=items.total,
)
@bp.get('/add')
@authorize("system:nav:add", log=True)
def add():
return render_template('system/nav/add.html')
@bp.post('/save')
@authorize("system:nav:add", log=True)
def save():
req_json = request.get_json(force=True, silent=True) or {}
category = str_escape(req_json.get('category'))
title = str_escape(req_json.get('title'))
url = str_escape(req_json.get('url'))
icon = str_escape(req_json.get('icon')) or 'layui-icon-link'
if not all([category, title, url]):
return fail_api(msg="分类/标题/链接不得为空")
try:
nav = Nav(
category=category,
title=title,
url=url,
description=str_escape(req_json.get('description')),
icon=icon,
sort=int(req_json.get('sort') or 0),
enable=int(req_json.get('enable') or 1),
is_external=int(req_json.get('isExternal') or 1),
create_by=current_user.username if current_user.is_authenticated else 'admin',
)
db.session.add(nav)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f"新增失败:{e}")
return success_api(msg="新增成功")
@bp.get('/edit')
@authorize("system:nav:edit", log=True)
def edit():
nav_id = request.args.get('navId', type=int)
nav = curd.get_one_by_id(Nav, nav_id)
if not nav:
return fail_api(msg="导航不存在")
return render_template('system/nav/edit.html', nav=nav)
@bp.put('/update')
@authorize("system:nav:edit", log=True)
def update():
req_json = request.get_json(force=True, silent=True) or {}
nav_id = req_json.get('navId')
nav = curd.get_one_by_id(Nav, nav_id)
if not nav:
return fail_api(msg="导航不存在")
category = str_escape(req_json.get('category'))
title = str_escape(req_json.get('title'))
url = str_escape(req_json.get('url'))
if not all([category, title, url]):
return fail_api(msg="分类/标题/链接不得为空")
try:
nav.category = category
nav.title = title
nav.url = url
nav.description = str_escape(req_json.get('description'))
nav.icon = str_escape(req_json.get('icon')) or 'layui-icon-link'
nav.sort = int(req_json.get('sort') or 0)
nav.enable = int(req_json.get('enable') or 1)
nav.is_external = int(req_json.get('isExternal') or 1)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f"更新失败:{e}")
return success_api(msg="更新成功")
@bp.delete('/remove/<int:nav_id>')
@authorize("system:nav:remove", log=True)
def remove(nav_id):
res = curd.delete_one_by_id(Nav, nav_id)
if not res:
return fail_api(msg="删除失败")
return success_api(msg="删除成功")
@bp.put('/enable')
@authorize("system:nav:edit", log=True)
def enable():
req_json = request.get_json(force=True, silent=True) or {}
nav_id = req_json.get('navId')
if not nav_id:
return fail_api(msg="数据错误")
res = curd.enable_status(Nav, nav_id)
if not res:
return fail_api(msg="操作失败")
return success_api(msg="已启用")
@bp.put('/disable')
@authorize("system:nav:edit", log=True)
def dis_enable():
req_json = request.get_json(force=True, silent=True) or {}
nav_id = req_json.get('navId')
if not nav_id:
return fail_api(msg="数据错误")
res = curd.disable_status(Nav, nav_id)
if not res:
return fail_api(msg="操作失败")
return success_api(msg="已禁用")
+163
View File
@@ -0,0 +1,163 @@
"""
导航分类管理后台视图 — navManager 插件内的子模块。
URL/system/nav-category
权限:system:nav-category:*
"""
import os
from flask import Blueprint, render_template, request
from flask_login import current_user
from applications.common import curd
from applications.common.utils.http import table_api, fail_api, success_api
from applications.common.utils.rights import authorize
from applications.common.utils.validate import str_escape
from applications.extensions import db
from applications.extensions.init_limit import limiter
from applications.models import NavCategory
from applications.schemas import NavCategorySchema
dir_path = os.path.dirname(os.path.abspath(__file__))
bp = Blueprint(
'nav_category', __name__,
url_prefix='/system/nav-category',
template_folder=os.path.join(dir_path, '..', 'templates'),
)
@bp.get('/')
@authorize("system:nav-category:main")
def main():
return render_template('system/nav/category_main.html')
@bp.get('/data')
@limiter.limit("60 per minute")
@authorize("system:nav-category:main")
def data():
keyword = str_escape(request.args.get('keyword', type=str))
query = NavCategory.query.filter()
if keyword:
query = query.filter(
db.or_(
NavCategory.name.contains(keyword),
NavCategory.description.contains(keyword),
)
)
items = query.order_by(NavCategory.sort.desc(), NavCategory.id.asc()).layui_paginate()
return table_api(
msg='请求成功',
data=curd.model_to_dicts(schema=NavCategorySchema, data=items.items),
count=items.total,
)
@bp.get('/add')
@authorize("system:nav-category:add", log=True)
def add():
return render_template('system/nav/category_add.html')
@bp.post('/save')
@authorize("system:nav-category:add", log=True)
def save():
req_json = request.get_json(force=True, silent=True) or {}
name = str_escape(req_json.get('name'))
if not name:
return fail_api(msg='分类名不能为空')
if NavCategory.query.filter_by(name=name).first():
return fail_api(msg=f'分类"{name}"已存在')
try:
cat = NavCategory(
name=name,
icon=str_escape(req_json.get('icon')) or 'layui-icon-list',
description=str_escape(req_json.get('description')),
sort=int(req_json.get('sort') or 0),
enable=int(req_json.get('enable') or 1),
)
db.session.add(cat)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f'新增失败:{e}')
return success_api(msg='新增成功')
@bp.get('/edit')
@authorize("system:nav-category:edit", log=True)
def edit():
cat_id = request.args.get('catId', type=int)
cat = curd.get_one_by_id(NavCategory, cat_id)
if not cat:
return fail_api(msg='分类不存在')
return render_template('system/nav/category_edit.html', cat=cat)
@bp.put('/update')
@authorize("system:nav-category:edit", log=True)
def update():
req_json = request.get_json(force=True, silent=True) or {}
cat_id = req_json.get('catId')
cat = curd.get_one_by_id(NavCategory, cat_id)
if not cat:
return fail_api(msg='分类不存在')
name = str_escape(req_json.get('name'))
if not name:
return fail_api(msg='分类名不能为空')
# name 是否被其他行占用
other = NavCategory.query.filter(NavCategory.name == name, NavCategory.id != cat_id).first()
if other:
return fail_api(msg=f'分类"{name}"已被占用')
try:
cat.name = name
cat.icon = str_escape(req_json.get('icon')) or 'layui-icon-list'
cat.description = str_escape(req_json.get('description'))
cat.sort = int(req_json.get('sort') or 0)
cat.enable = int(req_json.get('enable') or 1)
db.session.commit()
except Exception as e:
db.session.rollback()
return fail_api(msg=f'更新失败:{e}')
return success_api(msg='更新成功')
@bp.delete('/remove/<int:cat_id>')
@authorize("system:nav-category:remove", log=True)
def remove(cat_id):
"""删除分类时不会动 Nav 记录,但 Nav.category 字段会孤立成 '未分组' 显示"""
cat = curd.get_one_by_id(NavCategory, cat_id)
if cat is None:
return fail_api(msg='分类不存在')
res = curd.delete_one_by_id(NavCategory, cat_id)
if not res:
return fail_api(msg='删除失败')
return success_api(msg='删除成功(分类下导航已自动归入「未分组」)')
@bp.put('/enable')
@authorize("system:nav-category:edit", log=True)
def enable():
req_json = request.get_json(force=True, silent=True) or {}
cat_id = req_json.get('catId')
if not cat_id:
return fail_api(msg='数据错误')
res = curd.enable_status(NavCategory, cat_id)
if not res:
return fail_api(msg='操作失败')
return success_api(msg='已启用')
@bp.put('/disable')
@authorize("system:nav-category:edit", log=True)
def dis_enable():
req_json = request.get_json(force=True, silent=True) or {}
cat_id = req_json.get('catId')
if not cat_id:
return fail_api(msg='数据错误')
res = curd.disable_status(NavCategory, cat_id)
if not res:
return fail_api(msg='操作失败')
return success_api(msg='已禁用')
+5
View File
@@ -0,0 +1,5 @@
{
"plugin_name": "访问统计",
"plugin_version": "1.0.0",
"plugin_description": "后台访问统计主页 + 汇总/按天/路径接口 + before_request 全站埋点。前台 /site/* GET 自动累计 PV/UV。"
}
+22
View File
@@ -0,0 +1,22 @@
"""
访问统计插件入口
- event_init:在 app 上注册 /system/stats/* 蓝图
- event_finish:挂 before_request 埋点
"""
from flask import Flask
from .view.stat import bp, site_bp, record_visit
def event_init(app: Flask):
app.register_blueprint(bp)
app.register_blueprint(site_bp)
print(" * siteStats: registered /system/stats/* and /site/nav/*click blueprints")
def event_finish(app: Flask):
@app.before_request
def _stat_record():
record_visit()
print(" * siteStats: registered /site/* before_request hook")
@@ -0,0 +1,169 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>访问统计</title>
{% include 'system/common/header.html' %}
</head>
<body class="pear-container">
<div class="layui-row layui-col-space16" style="margin-top:12px;">
<div class="layui-col-md3">
<div class="layui-card">
<div class="layui-card-body layui-text-center">
<div style="font-size:32px;color:var(--brand);font-weight:600;" id="stat-total-pv">--</div>
<div style="color:#888;margin-top:6px;">累计 PV(页面浏览)</div>
</div>
</div>
</div>
<div class="layui-col-md3">
<div class="layui-card">
<div class="layui-card-body layui-text-center">
<div style="font-size:32px;color:#5fb878;font-weight:600;" id="stat-total-uv">--</div>
<div style="color:#888;margin-top:6px;">累计 UV(独立访客)</div>
</div>
</div>
</div>
<div class="layui-col-md3">
<div class="layui-card">
<div class="layui-card-body layui-text-center">
<div style="font-size:32px;color:#ffb800;font-weight:600;" id="stat-today-pv">--</div>
<div style="color:#888;margin-top:6px;">今日 PV</div>
</div>
</div>
</div>
<div class="layui-col-md3">
<div class="layui-card">
<div class="layui-card-body layui-text-center">
<div style="font-size:32px;color:#ff5722;font-weight:600;" id="stat-today-uv">--</div>
<div style="color:#888;margin-top:6px;">今日 UV</div>
</div>
</div>
</div>
</div>
<div class="layui-card" style="margin-top:16px;">
<div class="layui-card-header">
<i class="layui-icon layui-icon-template-1"></i> 最近 7 天趋势
<select id="days-select" style="float:right;font-size:13px;height:32px;border-radius:4px;padding:0 8px;border:1px solid #ddd;">
<option value="7">近 7 天</option>
<option value="14">近 14 天</option>
<option value="30">近 30 天</option>
</select>
</div>
<div class="layui-card-body">
<div id="chart-days" style="height:280px;"></div>
</div>
</div>
<div class="layui-row layui-col-space16" style="margin-top:16px;">
<div class="layui-col-md7">
<div class="layui-card">
<div class="layui-card-header"><i class="layui-icon layui-icon-link"></i> 路径 TOP10</div>
<div class="layui-card-body">
<table class="layui-table" lay-skin="line">
<thead>
<tr><th>路径</th><th width="100">PV</th><th width="200">最近访问</th></tr>
</thead>
<tbody id="paths-tbody">
<tr><td colspan="3" class="layui-text-center" style="color:#999;">加载中…</td></tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="layui-col-md5">
<div class="layui-card">
<div class="layui-card-header"><i class="layui-icon layui-icon-time"></i> 最近访问</div>
<div class="layui-card-body">
<table class="layui-table" lay-skin="line">
<thead>
<tr><th>路径</th><th width="120">IP</th><th width="160">时间</th></tr>
</thead>
<tbody id="latest-tbody">
<tr><td colspan="3" class="layui-text-center" style="color:#999;">加载中…</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</body>
{% include 'system/common/footer.html' %}
<script src="{{ url_for('static', filename='system/component/pear/module/extends/echarts.js') }}"></script>
<script src="{{ url_for('static', filename='system/component/pear/module/extends/echartsTheme.js') }}"></script>
<script>
layui.use(['element', 'jquery'], function(){
var $ = layui.$;
var daysChart = echarts.init(document.getElementById('chart-days'));
function loadSummary(){
$.get('/system/stats/summary', function(res){
if (res.code === 0){
$('#stat-total-pv').text(res.data.pv_total);
$('#stat-total-uv').text(res.data.uv_total);
$('#stat-today-pv').text(res.data.today_pv);
$('#stat-today-uv').text(res.data.today_uv);
var rows = res.data.latest || [];
var html = '';
if (rows.length === 0){
html = '<tr><td colspan="3" class="layui-text-center" style="color:#999;">暂无访问</td></tr>';
} else {
rows.forEach(function(r){
html += '<tr><td>' + (r.path || '-') + '</td><td>' + (r.ip || '-') + '</td><td>' + (r.visit_at || '-') + '</td></tr>';
});
}
$('#latest-tbody').html(html);
}
});
}
function loadDays(n){
$.get('/system/stats/days?days=' + n, function(res){
if (res.code === 0){
var data = res.data || [];
daysChart.setOption({
tooltip: {trigger: 'axis'},
legend: {data: ['PV', 'UV']},
xAxis: {type: 'category', data: data.map(function(d){return d.day.slice(5);})},
yAxis: {type: 'value'},
series: [
{name: 'PV', type: 'line', smooth: true, data: data.map(function(d){return d.pv;})},
{name: 'UV', type: 'line', smooth: true, data: data.map(function(d){return d.uv;})}
]
});
}
});
}
function loadPaths(){
$.get('/system/stats/paths', function(res){
if (res.code === 0){
var rows = res.data || [];
var html = '';
if (rows.length === 0){
html = '<tr><td colspan="3" class="layui-text-center" style="color:#999;">暂无数据</td></tr>';
} else {
rows.forEach(function(r){
html += '<tr><td>' + (r.path || '-') + '</td><td><b>' + (r.pv || 0) + '</b></td><td>' + (r.last_hit || '-') + '</td></tr>';
});
}
$('#paths-tbody').html(html);
}
});
}
$('#days-select').on('change', function(){
loadDays(parseInt($(this).val(), 10));
});
loadSummary();
loadDays(7);
loadPaths();
window.addEventListener('resize', function(){ daysChart.resize(); });
});
</script>
</body>
</html>
+202
View File
@@ -0,0 +1,202 @@
"""
访问统计插件:后台统计主页 + 3 个 JSON 接口 + 全站 before_request 埋点。
URL 前缀:/system/stats (与框架原路径一致);埋点用 before_request 挂在框架 app 上。
"""
import datetime
import os
import time
from collections import defaultdict
from flask import Blueprint, render_template, request, jsonify
from applications.common.utils.rights import authorize
from applications.extensions import db
from applications.models import VisitLog, PageStat, NavClick
dir_path = os.path.dirname(os.path.abspath(__file__))
bp = Blueprint(
'site_stats', __name__,
url_prefix='/system/stats',
template_folder=os.path.join(dir_path, '..', 'templates'),
)
# 公开埋点 blueprint:无 url_prefix,路径就是 /site/nav/<id>/click
site_bp = Blueprint(
'site_stats_public', __name__,
template_folder=os.path.join(dir_path, '..', 'templates'),
)
@bp.get('/')
@authorize("site:stats:main")
def main():
return render_template('system/stat/main.html')
@bp.get('/summary')
@authorize("site:stats:main")
def summary():
today = datetime.date.today().strftime('%Y-%m-%d')
pv_total = db.session.query(db.func.coalesce(db.func.sum(PageStat.pv), 0)).scalar() or 0
today_pv = (db.session.query(db.func.coalesce(db.func.sum(PageStat.pv), 0))
.filter(PageStat.day == today).scalar()) or 0
today_uv_set = set()
for r in PageStat.query.filter(PageStat.day == today, PageStat.uv_ip_set != '').all():
for ip in (r.uv_ip_set or '').split(','):
ip = ip.strip()
if ip:
today_uv_set.add(ip)
today_uv = len(today_uv_set)
all_uv_set = set()
for r in PageStat.query.filter(PageStat.uv_ip_set != '').all():
for ip in (r.uv_ip_set or '').split(','):
ip = ip.strip()
if ip:
all_uv_set.add(ip)
uv_all = len(all_uv_set)
latest = VisitLog.query.order_by(VisitLog.visit_at.desc()).limit(5).all()
latest_rows = [{
'path': r.path,
'ip': r.ip or '-',
'visit_at': r.visit_at.strftime('%Y-%m-%d %H:%M:%S') if r.visit_at else '',
} for r in latest]
return jsonify({
'code': 0,
'msg': '请求成功',
'data': {
'pv_total': int(pv_total),
'uv_total': uv_all,
'today_pv': int(today_pv),
'today_uv': today_uv,
'latest': latest_rows,
}
})
@bp.get('/days')
@authorize("site:stats:main")
def days():
try:
days = max(1, min(30, int(request.args.get('days', 7))))
except (TypeError, ValueError):
days = 7
cutoff = datetime.date.today() - datetime.timedelta(days=days - 1)
cutoff_str = cutoff.strftime('%Y-%m-%d')
rows = PageStat.query.filter(PageStat.day >= cutoff_str).all()
pv_by_day = defaultdict(int)
uv_by_day = defaultdict(set)
for r in rows:
pv_by_day[r.day] += r.pv
for ip in (r.uv_ip_set or '').split(','):
ip = ip.strip()
if ip:
uv_by_day[r.day].add(ip)
out = []
for i in range(days):
d = (cutoff + datetime.timedelta(days=i)).strftime('%Y-%m-%d')
out.append({
'day': d,
'pv': pv_by_day.get(d, 0),
'uv': len(uv_by_day.get(d, set())),
})
return jsonify({'code': 0, 'msg': '请求成功', 'data': out})
@bp.get('/paths')
@authorize("site:stats:main")
def paths():
rows = PageStat.query.filter(PageStat.path != '').order_by(PageStat.pv.desc()).limit(10).all()
out = []
for r in rows:
out.append({
'path': r.path,
'pv': r.pv or 0,
'last_hit': r.last_hit.strftime('%Y-%m-%d %H:%M:%S') if r.last_hit else '',
})
return jsonify({'code': 0, 'msg': '请求成功', 'data': out})
def record_visit():
"""before_request 钩子调用:埋点 /site/* GET。"""
if not request.path.startswith('/site'):
return
if request.method != 'GET':
return
path = request.path
day = datetime.date.today().strftime('%Y-%m-%d')
ip = (request.headers.get('X-Forwarded-For', '').split(',')[0].strip()
or request.remote_addr or '')
ua_short = (request.user_agent.string or '')[:255]
referer = request.headers.get('Referer', '')[:255]
try:
log = VisitLog(path=path, referer=referer, ua=ua_short, ip=ip, day=day)
db.session.add(log)
stat = PageStat.query.filter_by(path=path, day=day).first()
if stat is None:
stat = PageStat(path=path, day=day, pv=1, uv=1 if ip else 0,
uv_ip_set=(ip + ',') if ip else '',
last_hit=datetime.datetime.now())
db.session.add(stat)
else:
stat.pv = (stat.pv or 0) + 1
stat.last_hit = datetime.datetime.now()
existing = (stat.uv_ip_set or '').split(',')
existing = [x.strip() for x in existing if x.strip()]
if ip and ip not in existing:
existing.append(ip)
stat.uv_ip_set = ','.join(existing) + ','
stat.uv = len(existing)
db.session.commit()
except Exception:
db.session.rollback()
# ---------- 导航卡片点击埋点 ----------
# 进程级内存缓存,避免每个聚合页请求都 GROUP BY 一次
# 结构:{nav_id: count}
_visit_count_cache = {}
_visit_count_cache_at = 0.0
_VISIT_COUNT_TTL = 60.0 # 秒
def get_nav_visit_counts():
"""返回 {nav_id: total_clicks}60 秒内走缓存。"""
global _visit_count_cache, _visit_count_cache_at
now = time.time()
if _visit_count_cache and (now - _visit_count_cache_at) < _VISIT_COUNT_TTL:
return _visit_count_cache
rows = db.session.query(
NavClick.nav_id,
db.func.count(NavClick.id),
).group_by(NavClick.nav_id).all()
counts = {int(nid): int(c) for nid, c in rows}
_visit_count_cache = counts
_visit_count_cache_at = now
return counts
@site_bp.post('/site/nav/<int:nav_id>/click')
def nav_click(nav_id):
"""导航卡片点击埋点:JS sendBeacon 调用,返回 204 无副作用。"""
try:
ip = (request.headers.get('X-Forwarded-For', '').split(',')[0].strip()
or request.remote_addr or '')
day = datetime.date.today().strftime('%Y-%m-%d')
db.session.add(NavClick(nav_id=nav_id, day=day, ip=ip[:64]))
db.session.commit()
# 让缓存尽快失效(最多延迟 60s 也无所谓,统计本来就不需要实时)
global _visit_count_cache_at
_visit_count_cache_at = 0.0
except Exception:
db.session.rollback()
# 204 No Content:无响应体,beacon 友好
return ('', 204)