python - 我可以从 wagtail 页面按钮触发 python 中的操作吗

Question

在 wagtail 中，可以使用register_page_listing_buttons向页面添加按钮。钩子(Hook)。

但是，这些示例只是将您带到您选择的网址。

就我而言，我有一个 ProjectPage 模型，并且有一个函数 regenerate_project_geo_features() (目前是一个管理命令，尽管不需要) .

我想要一个按钮，无论是在页面列表中还是在页面编辑 View 本身中，可用于触发 python 中的操作。

是否可以修改该钩子(Hook)，或者使用另一个我不知道的钩子(Hook)来简单地调用 python 中的函数？ (最好使用一些参数，例如 ProjectPage id 来告诉函数它在哪个页面上调用)？

Answer 1

实现此目的的一种方法是使用 Javascript，本质上是向被单击的链接/按钮添加一个监听器。然后，这将触发对您管理的 URL 的某种 POST 请求，该请求将完成重新生成的“工作”。

本质上，因为这是一个 Web 框架 (Django)，所以一切都应该被视为一堆具有请求/响应处理的 View (页面)。

方法

• 创建自定义管理 URL 和 View (仅可通过管理员访问)
• 此 View 基本上会处理 POST 请求，当使用页面 ID 调用时，它将完成您需要的工作。
• 该链接现在仅成为一个按钮，单击它将使用 Javascript 进行调用 fetch (发生在后台)
• 然后您可以更新 View ，以便在后台对页面执行任何您想要的操作。
• 注意:示例很粗糙，没有任何错误处理或向用户发送消息(即，当用户单击它时，他们不知道它是否已工作/完成等)。

示例代码

• 这将位于您的 wagtail_hooks.py 文件中

from django.conf.urls import url
from django.http import HttpResponse
from django.urls import reverse
from django.utils.html import format_html
from django.views.decorators.http import require_http_methods
from django.views.decorators.csrf import csrf_exempt

from wagtail.admin.widgets import PageListingButton
from wagtail.core import hooks


@csrf_exempt # not recommended - but helpful to get to the POC stage
@require_http_methods(["POST"])
def regnerate_admin_features(request):
    page_pk = request.GET.get('id', '')
    # do whatever you need here with the PK to process the action

    return HttpResponse(
        "Success/Error handling goes here",
        content_type="text/plain")

@hooks.register('register_admin_urls')
def urlconf_time():
  return [
    url(r'^regenerate_geo_features/$', regnerate_admin_features, name='regenerate_geo_features'),
  ]

@hooks.register('register_page_listing_buttons')
def page_listing_buttons(page, page_perms, is_parent=False):

    attrs = {
        'data-id': page.pk, # note - may want to html encode this for a more secure implementation
    }

    yield PageListingButton(
        'Regenerate Geo Features',
        reverse('regenerate_geo_features'),
        attrs=attrs,
        classes=["action-regenerate-geo-features"],
        priority=100
    )

@hooks.register('insert_global_admin_js')
def global_admin_js():
    # note - this is very rough, no error, loading or sucess messaging
    # reminder - using format_html means all `{` must be written as `{{`
    return format_html(
        """
        <script>
        const onClickHandler = function(event) {{
            event.preventDefault(); // ensure the hash does not change
            const url = event.target.href + '?id=' + event.target.dataset.id;
            console.log('button clicked - about to POST to URL:', url);
            fetch(url, {{
                method: 'POST', // or 'PUT'
            }})
        }};

        window.addEventListener('DOMContentLoaded', function(event) {{
            const actionButtons = Array.from(document.getElementsByClassName('action-regenerate-geo-features'));

            actionButtons.forEach(function(element) {{
                element.addEventListener('click', onClickHandler);
            }});
        }});
        </script>
        """,
    )