feat: add company site setup wizard and software service template

This commit is contained in:
2026-10-27 21:36:22 +08:00
parent f2927bae8e
commit d33174192d
6 changed files with 492 additions and 0 deletions
+54
View File
@@ -0,0 +1,54 @@
from django import forms
from django.contrib.auth.decorators import login_required
from django.core.exceptions import ValidationError
from django.http import HttpResponseForbidden
from django.shortcuts import redirect, render
from django.views.decorators.http import require_http_methods
from wagtail.admin import messages
from .models import SiteSettings
from .site_setup import COMPANY_FIELDS, default_site, setup_company_site
class CompanySetupForm(forms.ModelForm):
company_name = forms.CharField(label="企业名称", max_length=100)
create_demo = forms.BooleanField(
label="创建软件/技术服务企业示例站", required=False,
help_text="仅补齐缺失页面和菜单,新页面将公开发布;不会覆盖已有页面或菜单。",
)
class Meta:
model = SiteSettings
fields = COMPANY_FIELDS
help_texts = {
"contact_email": "新建咨询表单将使用此邮箱发送通知;需先配置服务器邮件服务。",
"icp_number": "请填写本企业真实备案号;未取得备案号时留空,不使用示例号码。",
}
@login_required(login_url="wagtailadmin_login")
@require_http_methods(["GET", "POST"])
def company_setup(request):
if not request.user.is_active or not request.user.is_superuser:
return HttpResponseForbidden("仅超级管理员可以初始化企业站点。")
try:
site = default_site()
except ValidationError as error:
return render(request, "core/site_setup.html", {"setup_error": ";".join(error.messages)})
settings = SiteSettings.for_site(site)
form = CompanySetupForm(request.POST if request.method == "POST" else None, instance=settings)
if request.method == "POST" and form.is_valid():
try:
created = setup_company_site(form.cleaned_data, form.cleaned_data["create_demo"])
except ValidationError as error:
form.add_error(None, ";".join(error.messages))
else:
result = f"企业资料已保存,新增 {len(created)} 个页面。" if form.cleaned_data["create_demo"] else "企业资料已保存,未创建示例内容。"
messages.success(request, result)
return redirect("company_site_setup")
return render(request, "core/site_setup.html", {
"form": form,
"site": site,
"pages": site.root_page.get_children().specific(),
})
+159
View File
@@ -0,0 +1,159 @@
"""企业开站模板。仅创建缺失内容,不修改或重新发布已有页面。"""
from django.core.exceptions import ValidationError
from django.db import transaction
from django.utils import timezone
from django.utils.html import format_html
from wagtail.models import Page, Site
from apps.blog.models import BlogIndexPage, BlogPage
from apps.cases.models import CaseStudyIndexPage, CaseStudyPage
from apps.core.management.commands.seed_contact_page import CONTACT_FORM_FIELDS
from apps.core.models import (
ContactPage, NavigationMenu, NavigationMenuItem, SimpleContentPage, SiteSettings,
)
from apps.forms.models import FormDefinition
from apps.home.models import HomePage
from apps.products.models import ProductIndexPage, ProductPage
from apps.solutions.models import SolutionIndexPage, SolutionPage
COMPANY_FIELDS = ("company_name", "contact_phone", "contact_email", "address", "icp_number")
def default_site():
site = Site.objects.filter(is_default_site=True).first()
if site is None:
raise ValidationError("未配置默认站点,请先在“设置 → 站点”中配置默认站点。")
return site
def _ensure_page(parent, model, slug, title, created, **fields):
existing = parent.get_children().filter(slug=slug).first()
if existing is not None:
if not isinstance(existing.specific, model):
raise ValidationError(f"路径 {slug} 已被其他类型的页面占用,请先调整页面路径。")
return existing.specific
page = model(title=title, slug=slug, **fields)
parent.add_child(instance=page)
page.save_revision().publish()
created.append(title)
return page
def _cta():
return ("cta", {
"heading": "一起讨论您的项目需求",
"description": "告诉我们业务目标、当前挑战与期望交付时间。",
"button": {"text": "预约项目咨询", "link": "/contact/"},
})
def _detail_body(heading, description):
return [
("richtext", str(format_html("<h2>{}</h2><p>{}</p>", heading, description))),
("feature_grid", {"heading": "服务流程", "items": [
{"icon": "1", "title": "需求梳理", "description": "明确业务场景、范围与验收标准。"},
{"icon": "2", "title": "迭代交付", "description": "分阶段演示并收集使用反馈。"},
{"icon": "3", "title": "持续维护", "description": "按约定提供培训、维护与优化支持。"},
]}),
_cta(),
]
def _create_template(site, company_name):
created = []
home = site.root_page.specific
if not isinstance(home, HomePage):
# 只允许接管全新 Wagtail 安装的空白通用欢迎页,不重绑定已有业务站点。
if type(home) is not Page or home.depth != 2 or home.get_children().exists() or home.slug != "home":
raise ValidationError("默认站点根页面不是企业首页。请先配置 HomePage,现有站点不会被替换。")
home = _ensure_page(home.get_parent(), HomePage, "company-home", "首页", created, body=[
("hero", {
"title": f"{company_name} · 软件与技术服务",
"subtitle": "从需求分析到软件交付,帮助企业构建适合自身业务的数字化系统。",
"background_image": None,
"buttons": [{"text": "了解服务", "link": "/products/"}, {"text": "项目咨询", "link": "/contact/"}],
}),
("feature_grid", {"heading": "我们可以帮助您", "items": [
{"icon": "", "title": "软件定制", "description": "围绕业务流程设计与开发应用。"},
{"icon": "", "title": "系统集成", "description": "连接现有系统,减少重复录入。"},
{"icon": "", "title": "运维支持", "description": "提供上线培训与持续维护服务。"},
]}),
("product_card", {"heading": "产品与服务", "items": [
{"title": "企业内容平台", "description": "统一管理官网内容与咨询入口。", "image": None, "link": "/products/content-platform/"},
{"title": "定制开发服务", "description": "从原型到交付,适配实际业务场景。", "image": None, "link": "/products/custom-development/"},
]}),
("faq", {"items": [
{"question": "如何开始合作?", "answer": "<p>通过咨询表单描述需求,我们会进一步确认范围与交付安排。</p>"},
{"question": "能否对接现有系统?", "answer": "<p>需要先评估现有接口、数据要求与安全边界,再确定实施方案。</p>"},
]}),
_cta(),
])
site.root_page = home
site.save(update_fields=["root_page"])
def ensure(parent, model, slug, title, **fields):
return _ensure_page(parent, model, slug, title, created, **fields)
products = ensure(home, ProductIndexPage, "products", "产品与服务", intro="探索企业内容平台与软件定制服务。")
for slug, title, summary in [
("content-platform", "企业内容平台", "集中管理品牌官网、产品内容、客户案例与咨询表单。"),
("custom-development", "定制开发服务", "根据业务流程提供 Web 应用、接口集成与运维支持。"),
]:
ensure(products, ProductPage, slug, title, summary=summary, body=_detail_body(title, summary))
solutions = ensure(home, SolutionIndexPage, "solutions", "解决方案", intro="以业务场景为起点,规划可落地的数字化方案。")
ensure(solutions, SolutionPage, "digital-workplace", "企业数字化协同", industry="企业服务",
summary="连接内容、流程与数据,减少团队之间的信息断层。",
body=_detail_body("从业务流程出发", "先梳理现有工具与协作瓶颈,再规划分阶段实施方案。"))
cases = ensure(home, CaseStudyIndexPage, "cases", "客户案例", intro="以下案例为模板演示,请上线前替换为获得授权的真实案例。")
ensure(cases, CaseStudyPage, "demo-content-project", "示例案例:企业内容管理项目(虚构)",
client_name="虚构示例企业", industry="企业服务", published_at=timezone.now(),
summary="仅用于展示案例结构,不代表真实客户、交付成果或业绩。",
body=_detail_body("示例内容,请勿作为真实业绩发布", "展示需求背景、实施过程与验收方式;请替换为客户授权的真实材料。"))
blog = ensure(home, BlogIndexPage, "blog", "技术与洞察", intro="分享技术实践、产品思考与项目经验。")
ensure(blog, BlogPage, "website-content-checklist", "示例文章:企业官网上线内容清单",
published_at=timezone.now(), intro="上线前核对品牌资料、产品信息、联系渠道与隐私说明。",
body=[("richtext", "<h2>上线前检查</h2><ul><li>替换所有示例内容与图片。</li><li>检查手机端布局与页面链接。</li><li>提交测试咨询,确认通知可达。</li><li>按实际情况审核备案和隐私说明。</li></ul>")])
about = ensure(home, SimpleContentPage, "about", "关于我们", body=str(format_html(
"<h2>关于 {}</h2><p>我们提供软件开发、系统集成与技术服务。</p>"
"<h2>我们的工作方式</h2><p>明确需求、迭代交付、持续支持。</p>"
"<p>模板提示:请补充真实的公司介绍、团队与资质,不要发布未经核实的业绩。</p>", company_name)))
privacy = ensure(home, SimpleContentPage, "privacy-policy", "隐私政策(待完善)",
body="<p>这是隐私说明占位内容。上线前请根据实际收集的数据、处理目的、保存期限、联系与删除方式完善,并完成必要审核。</p>")
contact = home.get_children().filter(slug="contact").first()
if contact is not None and not isinstance(contact.specific, ContactPage):
raise ValidationError("路径 contact 已被其他类型的页面占用,请先调整页面路径。")
if contact is None:
form = FormDefinition.objects.create(name="官网项目咨询", notification_email=SiteSettings.for_site(site).contact_email)
for order, field in enumerate(CONTACT_FORM_FIELDS):
form.fields.create(sort_order=order, **field)
contact = ensure(home, ContactPage, "contact", "联系我们", body=[
("richtext", "<h2>项目咨询</h2><p>请描述您的业务需求与预期,我们将与您进一步沟通。</p>"),
("form", {"form": form}),
])
else:
contact = contact.specific
for name, entries in [
("main", [("首页", home), ("产品与服务", products), ("解决方案", solutions), ("案例", cases), ("技术博客", blog), ("关于我们", about), ("联系咨询", contact)]),
("footer", [("关于我们", about), ("联系我们", contact), ("隐私政策", privacy)]),
]:
menu, is_new = NavigationMenu.objects.get_or_create(name=name)
if is_new:
for order, (label, page) in enumerate(entries):
if page.live:
NavigationMenuItem.objects.create(menu=menu, sort_order=order, label=label, link_page=page)
return created
@transaction.atomic
def setup_company_site(company_data, create_demo=False):
site = default_site()
# 序列化同一站点的初始化请求,避免重复页面/表单。
site = Site.objects.select_for_update().get(pk=site.pk)
settings = SiteSettings.for_site(site)
for field in COMPANY_FIELDS:
setattr(settings, field, company_data[field])
settings.full_clean()
settings.save()
site.site_name = settings.company_name
site.save(update_fields=["site_name"])
return _create_template(site, settings.company_name) if create_demo else []
+45
View File
@@ -0,0 +1,45 @@
{% extends "wagtailadmin/base.html" %}
{% load wagtailadmin_tags %}
{% block titletag %}企业开站向导{% endblock %}
{% block content %}
{% include "wagtailadmin/shared/header.html" with title="企业开站向导" icon="site" %}
<div class="nice-padding">
{% if setup_error %}
<p role="alert">{{ setup_error }}</p>
{% else %}
<h2>1. 填写企业资料</h2>
<p>当前默认站点:{{ site.hostname }}。保存将更新该站点的企业名称、联系方式和备案信息。</p>
<h2>2. 按需创建完整模板</h2>
<p>软件/技术服务模板包含首页、产品、解决方案、案例、博客、关于我们、联系我们和隐私说明,以及对应导航。</p>
<p><strong>新建页面会立即公开发布。</strong>已有页面、内容和菜单不会被替换,已有草稿也不会自动发布。若已有首页,则保留其原样。</p>
<p>示例案例为虚构内容,不代表真实业绩;隐私说明仅为占位。请在正式上线前替换、审核,不要作为真实客户材料使用。</p>
<form method="post" action="{% url 'company_site_setup' %}">
{% csrf_token %}
{{ form.non_field_errors }}
<ul class="fields">
{% for field in form %}
<li>{% formattedfield field %}</li>
{% endfor %}
</ul>
<button type="submit" class="button">保存资料并执行所选操作</button>
</form>
<h2>3. 编辑内容并检查上线</h2>
<ol>
<li>在页面管理中替换示例文案、产品、案例与图片,并检查手机端预览。</li>
<li>检查主导航和页脚;已有菜单保持原样,新增页面需手动加入已有菜单。</li>
<li>检查联系表单通知邮箱,提交测试咨询,确认后台记录与邮件均正常。</li>
<li>配置域名、HTTPS 与前端服务地址,审核备案、隐私说明和示例内容。</li>
<li>配置发布刷新通知;企业资料和导航的前端缓存通常最多约 60 秒后更新。</li>
</ol>
<p><a class="button button-secondary" href="{% url 'wagtailadmin_explore' site.root_page_id %}">进入页面管理</a></p>
<h3>当前一级页面</h3>
<ul>
{% for page in pages %}
<li>{{ page.title }} — {% if page.live %}已发布{% else %}未发布{% endif %}</li>
{% empty %}
<li>暂无页面,可勾选上方选项创建示例站。</li>
{% endfor %}
</ul>
{% endif %}
</div>
{% endblock %}
+162
View File
@@ -0,0 +1,162 @@
import pytest
from django.contrib.auth import get_user_model
from django.contrib.auth.models import Permission
from django.core.exceptions import ValidationError
from django.test import Client
from django.urls import reverse
from wagtail.models import Page, Site
from apps.core.models import ContactPage, NavigationMenu, NavigationMenuItem, SimpleContentPage, SiteSettings
from apps.core.site_setup import setup_company_site
from apps.core.wagtail_hooks import register_company_setup_menu
from apps.forms.models import FormDefinition
from apps.home.models import HomePage
from apps.products.models import ProductIndexPage
pytestmark = pytest.mark.django_db
@pytest.fixture
def company_data():
return {"company_name": "测试软件公司", "contact_phone": "010-12345678", "contact_email": "hello@example.com", "address": "测试地址", "icp_number": ""}
@pytest.fixture
def admin_user():
return get_user_model().objects.create_superuser("site-admin", "admin@example.com", "test-password")
def test_setup_creates_full_site_and_public_api(client, company_data):
created = setup_company_site(company_data, create_demo=True)
site = Site.objects.get(is_default_site=True)
assert isinstance(site.root_page.specific, HomePage)
assert len(created) == 13
assert set(site.root_page.get_children().values_list("slug", flat=True)) == {
"products", "solutions", "cases", "blog", "about", "contact", "privacy-policy",
}
assert SiteSettings.for_site(site).company_name == company_data["company_name"]
assert site.site_name == company_data["company_name"]
assert NavigationMenu.objects.get(name="main").items.count() == 7
assert NavigationMenu.objects.get(name="footer").items.count() == 3
assert FormDefinition.objects.get(name="官网项目咨询").notification_email == company_data["contact_email"]
for type_name, slug in [("core.SimpleContentPage", "about"), ("products.ProductPage", "content-platform"), ("core.ContactPage", "contact")]:
response = client.get("/api/v2/pages/", {"type": type_name, "slug": slug, "fields": "body"})
assert response.status_code == 200
assert response.json()["meta"]["total_count"] == 1
assert "虚构" in Page.objects.get(slug="demo-content-project").title
def test_setup_is_idempotent_and_preserves_edits(company_data):
setup_company_site(company_data, True)
page = SimpleContentPage.objects.get(slug="about")
page.title = "客户自己的介绍"
page.body = "<p>客户自己的内容</p>"
page.save_revision().publish()
count = Page.objects.count()
forms = FormDefinition.objects.count()
assert setup_company_site(company_data, True) == []
page.refresh_from_db()
assert page.title == "客户自己的介绍"
assert str(page.body) == "<p>客户自己的内容</p>"
assert Page.objects.count() == count
assert FormDefinition.objects.count() == forms
def test_existing_home_contact_menu_and_draft_are_preserved(home_page, company_data):
site = Site.objects.get(is_default_site=True)
site.root_page = home_page
site.save()
original_body = home_page.body.get_prep_value()
contact = home_page.add_child(instance=ContactPage(title="原有联系页", slug="contact", body=[("richtext", "<p>自定义</p>")]))
contact.save_revision().publish()
products = home_page.add_child(instance=ProductIndexPage(title="草稿栏目", slug="products", live=False))
products.save_revision()
menu = NavigationMenu.objects.create(name="main")
NavigationMenuItem.objects.create(menu=menu, label="原有菜单", link_url="/custom/")
setup_company_site(company_data, True)
home_page.refresh_from_db()
contact.refresh_from_db()
products.refresh_from_db()
assert home_page.body.get_prep_value() == original_body
assert contact.title == "原有联系页"
assert "自定义" in str(contact.body)
assert not products.live
assert menu.items.count() == 1
assert menu.items.first().label == "原有菜单"
assert FormDefinition.objects.count() == 0
def test_company_only_does_not_create_pages_or_forms(company_data):
before = Page.objects.count()
setup_company_site(company_data)
assert Page.objects.count() == before
assert FormDefinition.objects.count() == 0
assert NavigationMenu.objects.count() == 0
def test_conflict_rolls_back_all_changes(home_page, company_data):
site = Site.objects.get(is_default_site=True)
site.root_page = home_page
site.save()
home_page.add_child(instance=SimpleContentPage(title="路径冲突", slug="solutions"))
before = Page.objects.count()
with pytest.raises(ValidationError, match="solutions"):
setup_company_site(company_data, True)
assert Page.objects.count() == before
assert not SiteSettings.objects.filter(company_name=company_data["company_name"]).exists()
site.refresh_from_db()
assert site.site_name != company_data["company_name"]
def test_incompatible_root_is_not_replaced(company_data):
site = Site.objects.get(is_default_site=True)
site.root_page.slug = "existing-business"
site.root_page.save()
with pytest.raises(ValidationError, match="根页面"):
setup_company_site(company_data, True)
site.refresh_from_db()
assert site.root_page.slug == "existing-business"
def test_company_html_is_escaped(company_data):
company_data["company_name"] = '<script>alert("test")</script>'
setup_company_site(company_data, True)
assert "<script>" not in str(SimpleContentPage.objects.get(slug="about").body)
def test_wizard_get_and_post(client, admin_user, company_data):
client.force_login(admin_user)
url = reverse("company_site_setup")
response = client.get(url)
assert response.status_code == 200
assert "新建页面会立即公开发布" in response.content.decode()
before = Page.objects.count()
assert client.post(url, company_data).status_code == 302
assert Page.objects.count() == before
response = client.post(url, {**company_data, "create_demo": "on"}, follow=True)
assert response.status_code == 200
assert "新增 13 个页面" in response.content.decode()
def test_wizard_requires_superuser_and_csrf(client, admin_user, company_data):
url = reverse("company_site_setup")
assert client.get(url).status_code == 302
user = get_user_model().objects.create_user("editor", password="test-password", is_staff=True)
user.user_permissions.add(Permission.objects.get(content_type__app_label="wagtailadmin", codename="access_admin"))
client.force_login(user)
assert client.post(url, {**company_data, "create_demo": "on"}).status_code == 403
item = register_company_setup_menu()
request = type("Request", (), {"user": user})()
assert not item.is_shown(request)
csrf_client = Client(enforce_csrf_checks=True)
csrf_client.force_login(admin_user)
assert csrf_client.post(url, company_data).status_code == 403
def test_invalid_form_does_not_write(client, admin_user, company_data):
client.force_login(admin_user)
before = Page.objects.count()
response = client.post(reverse("company_site_setup"), {**company_data, "company_name": "", "contact_email": "invalid", "create_demo": "on"})
assert response.status_code == 200
assert response.context["form"].errors
assert Page.objects.count() == before
+20
View File
@@ -0,0 +1,20 @@
from django.urls import path, reverse
from wagtail import hooks
from wagtail.admin.menu import MenuItem
from .setup_views import company_setup
class CompanySetupMenuItem(MenuItem):
def is_shown(self, request):
return request.user.is_active and request.user.is_superuser
@hooks.register("register_admin_urls")
def register_company_setup_urls():
return [path("company-setup/", company_setup, name="company_site_setup")]
@hooks.register("register_admin_menu_item")
def register_company_setup_menu():
return CompanySetupMenuItem("企业开站向导", reverse("company_site_setup"), icon_name="site", order=250)
+52
View File
@@ -0,0 +1,52 @@
# 企业开站向导
## 使用方式
1. 按原有部署流程完成数据库迁移、管理员初始化并启动后端及前端。
2. 用超级管理员登录 Wagtail 后台,点击左侧 **企业开站向导**(后台路径 `company-setup/`)。
3. 填写企业名称、电话、邮箱、地址与真实备案号。仅保存资料时不要勾选示例站。
4. 需要完整演示内容时,主动勾选 **创建软件/技术服务企业示例站** 并提交。
5. 在页面管理中编辑内容,使用预览确认效果后发布。示例案例为虚构,不可作为真实业绩。
## 模板范围
- 首页:新站含首屏、核心服务、产品入口、常见问题及咨询入口。
- 产品与服务:内容平台、定制开发两个示例详情。
- 解决方案:企业数字化协同示例。
- 案例:明确标注虚构的示例案例。
- 博客:官网上线内容清单示例。
- 关于我们、联系咨询表单及待完善的隐私说明。
- 主导航及页脚导航。
不依赖外部图片服务,不生成虚假的客户 Logo、资质、业绩数字或备案号。可在后台补充获得授权的真实图片。
## 数据安全与重复执行
- 仅超级管理员可见并使用;提交受登录与 CSRF 保护。
- 面向默认站点;多站点独立品牌及独立菜单不在本版本范围内。
- 资料保存会更新企业名称、联系方式、备案号及站点名称。留空会清空对应资料,请确认后提交。
- 创建模板仅添加缺失页面;已有页面、草稿、联系表单和菜单保持原样,不重新发布旧页面。
- 原有部署流程通常已创建首页、联系页和隐私页,向导会保留这些页面;因此不会用完整模板替换已有首页。
- 已有主导航/页脚菜单不会被补写,新增页面请手动加入原菜单。
- 仅允许将全新安装的空白通用欢迎页切换为企业首页,不删除旧页面;其他不兼容根页面拒绝初始化。
- 路径被错误类型页面占用时,整次操作回滚,包括企业资料变更。
- 示例内容不会随部署自动导入;容器启动流程未增加示例导入行为。
## 上线检查
- **新建模板页面立即公开发布**:请在非公开的预上线环境操作,审核完成后再正式开放域名。
- 替换所有示例内容与图片,核实案例授权;按真实数据处理方式完善隐私说明。
- 配置真实域名、HTTPS、前后端地址和发布缓存刷新通知。
- 前端页头与站点标题读取企业名称;未配置备案号时不展示其他企业号码。
- 联系表单新建时使用企业联系邮箱作为通知邮箱。已有表单不会修改,需在“线索表单”中检查。
- 邮件可达性取决于服务器邮件配置;必须提交测试咨询,确认后台存档及邮件通知。
- 企业资料及导航通常有约 60 秒前端缓存;页面发布刷新依赖已有 revalidate 配置。
- 原有 `seed_contact_page`、`seed_privacy_policy` 命令仍按既有逻辑运行,向导的不覆盖保证仅针对本向导操作,不改变旧命令行为。
## 回归验证
后端:`.venv\Scripts\python.exe -m pytest apps/core/test_site_setup.py`
前端:在 `wagtailcms-frontend` 运行 `node --test tests/*.test.cjs`,然后 `npm run build`。
无需数据库迁移,无新增依赖。