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_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="已禁用")