ftw.lawgiver 1.17.5

将权限注册到操作组

将权限注册到操作组应在定义权限的包中完成。这允许将权限和操作组注册的变化一起保存在分支中，用于审查等。ftw.lawgiver已将默认Plone / Zope权限分配给操作组。

注册是在ZCML中完成的。以下是一个示例lawgiver.zcml

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:lawgiver="http://namespaces.zope.org/lawgiver"
    i18n_domain="my.package">

    <include package="ftw.lawgiver" />

    <lawgiver:map_permissions
        action_group="add"
        permissions="my.package: Add Foo,
                     my.package: Add Bar"
        />

</configure>

如果您在同一个map_permissions指令中定义多个权限，请确保用逗号分隔它们。

通过将ZCML放入单独的lawgiver.zcml文件，您可以在您的插件包中定义lawgiver，而无需在默认的configure.zcml中通过使用zcml:condition来定义对ftw.lawgiver的依赖。

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:zcml="http://namespaces.zope.org/zcml"
    i18n_domain="my.package">

    <include zcml:condition="installed ftw.lawgiver" file="lawgiver.zcml" />

</configure>

覆盖操作组

可能权限到操作组映射对特定的流程不起作用，您希望仅为此流程更改映射。

这可以通过在ZCML中也定义该工作流程轻松实现。

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:lawgiver="http://namespaces.zope.org/lawgiver"
    i18n_domain="my.package">

    <include package="ftw.lawgiver" />

    <lawgiver:map_permissions
        action_group="add"
        permissions="my.package: Add Foo,
                     my.package: Add Bar"
        workflow="my_workflow"
        />

</configure>

将权限分配给多个操作组

有时，应将权限分配给多个操作组。这可以通过map_permissions指令的move属性来完成。只需确保在执行此操作之前，加载了所有其他map_permissions ZCML，特别是ftw.lawgiver的默认lawgiver.zcml。

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:lawgiver="http://namespaces.zope.org/lawgiver"
    i18n_domain="my.package">

    <include package="ftw.lawgiver" />

    <lawgiver:map_permissions
        action_group="add"
        permissions="Add portal content"
        />

    <lawgiver:map_permissions
        action_group="add ticket"
        permissions="my.package: Add Ticket"
        workflow="my_workflow"
        />

    <!-- We want to have "Add portal content" in the "add ticket" action group too,
         but we should not remove it from "add".
         By using move="False" we can add "Add portal content" to "add ticket" without
         removing it from "add".
         /-->

    <lawgiver:map_permissions
        action_group="add ticket"
        permissions="Add portal content"
        workflow="my_workflow"
        move="False"
        />

</configure>

工作流范围

可以使用lawgiver:workflow指令来组合多个语句并将它们应用于特定的工作流程。

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:lawgiver="http://namespaces.zope.org/lawgiver"
    i18n_domain="my.package">

  <include package="ftw.lawgiver" />

  <lawgiver:workflow name="the-workflow">

    <lawgiver:map_permissions
        action_group="add folder"
        permissions="Add folder"
        />

    <lawgiver:ignore
        permissions="ATContentTypes: View history"
        />

  </lawgiver:workflow>

</configure>

状态和转换

状态和转换由简单的列表定义

[My Custom Workflow]
Description: A three state publication workflow
Initial Status: Private

Status Private:

Status Pending:

Status Published:

Transitions:
  Publish (Private => Published)
  Submit for publication (Private => Pending)
  Reject (Pending => Private)
  Retract (Pending => Private)
  Publish (Pending => Published)
  Reject (Published => Private)

我们不使用任何内部ID来标识工作流程状态或转换。相反，我们使用用户实际上将看到的相同的标签-这些ID由ftw.lawgiver自动生成。

角色映射

在Plone中，我们有一组相当技术性的角色（例如，编辑器、贡献者、读者），这些角色可能不适用于现实生活中的所有用例。客户可能有具有不同名称的自己的角色。由于现有的角色已经在Plone中建立，因此通常不是在Plone中添加新角色的好方法。最好尝试重用现有角色。

由于客户对其角色的标签不同，因此我们需要将客户角色映射到Plone角色

Role mapping:
  editor-in-chief => Reviewer
  editor => Editor
  everyone => Anonymous

在我们的示例中，我们只有“普通”编辑器和一名可以审查和发布内容的“主编”。我们不需要使用贡献者角色，因为我们的编辑器可以编辑、添加新内容，并为现有内容请求审查。因此，没有必要区分编辑器和贡献者角色。

转换守卫表达式

转换保护表达式是一种动态隐藏转换的方法，除了保护角色之外。使用选项语法来定义保护表达式。

DCWorkflow中的表达式是TALES表达式。要查看表达式中可用的上下文，请查看

警告：转换保护表达式本身不保护转换。如果用户知道执行转换的URL，它将通过。它只是从用户那里隐藏了转换。

[My Custom Workflow]
Initial Status: Private

Status Private:
Status Published:

Transitions:
  Publish (Private => Published) [guard-expression => python:here.guard(state_change)]
  Reject (Published => Private) [guard-expression => here/guard_reject]

一般说明

通常有一些通用语句，例如，具有管理员角色的用户可以始终在任何工作流程状态下编辑内容。此类语句不应为每个状态重复，而应定义一次作为通用语句。

示例

General:
  An administrator can always view the content
  An administrator can always edit the content
  An administrator can always delete the content

这些通用语句适用于所有状态。

描述状态

对于每个状态，我们描述具有特定角色的用户可以执行的操作。我们遵循的原则是任何用户/角色默认情况下都不允许执行任何操作，我们必须明确列出他将被允许执行的所有操作。

Status Private:
  An editor can view this content.
  An editor can edit this content.
  An editor can delete this content.
  An editor can add new content.
  An editor can submit for publication.
  An editor-in-chief can view this content.
  An editor-in-chief can edit this content.
  An editor-in-chief can delete this content.
  An editor-in-chief can add new content.
  An editor-in-chief can publish this content.

Status Pending:
  An editor can view this content.
  An editor can add new content.
  An editor can retract this content.
  An editor-in-chief can view this content.
  An editor-in-chief can edit this content.
  An editor-in-chief can delete this content.
  An editor-in-chief can add new content.
  An editor-in-chief can publish this content.
  An editor-in-chief can reject this content.

Status Published:
  An editor can view this content.
  An editor can add new content.
  An editor can retract this content.
  An editor-in-chief can view this content.
  An editor-in-chief can add new content.
  An editor-in-chief can retract this content.
  Anyone can view this content.

角色继承

角色可以从其他角色继承，全局和单一状态

[Role Inheritance Workflow]
Initial Status: Foo

Role mapping:
  editor => Editor
  editor-in-chief => Reviewer
  administrator => Site Administrator

General:
  An administrator can always perform the same actions as an editor.
  An administrator can always perform the same actions as an editor-in-chief.

Status Foo:
  An editor-in-chief can perform the same actions as an editor.
  An editor can view this content.
  An editor can edit this content.

Status Bar:
  An editor can view this content.
  An editor-in-chief can view this content.
  An editor-in-chief can edit this content.

工作列表

当您授予访问工作列表的权限时，将自动为您生成工作列表

[A workflow]
...

Status Pending:
  An editor-in-chief can access the worklist.

那些“可以访问工作列表”的语句在“通用”部分中不起作用，它们需要在“状态”部分中定义。

对于每个具有“可以访问工作列表”语句的状态，将生成一个受相应角色保护的工作列表。

工作流规范发现

所有注册的通用设置配置文件中的工作流目录都会自动扫描工作流规范。只需在工作流目录中放置一个specification.txt，ftw.lawgiver将自动发现它。

示例路径

• 规范：profiles/default/workflows/my_custom_workflow/specification.txt

• 工作流XML：profiles/default/workflows/my_custom_workflow/definition.txt

在这个例子中，假设profiles/default是一个注册的通用设置配置文件目录。

更改转换URL

有时过渡URL需要指向另一个视图。这可以通过使用transition-url选项来实现，其中可以传递一个字符串，然后将其替换为transition id。确保在生成工作流时使用双%%来替换不应该被替换的部分，例如%%(content_url)s。

示例

transition-url = %%(content_url)s/custom_wf_action?workflow_action=%(transition)s

语言

当前支持的语言

英语（默认）

• 文件名：specification.txt

• 示例：ftw/lawgiver/tests/assets/languages/specification.txt

德语

• 文件名：specification.de.txt

• 示例：ftw/lawgiver/tests/assets/languages/specification.de.txt

贡献新语言

我们欢迎接受新语言的拉取请求！

创建新语言非常简单

• 在ftw/lawgiver/tests/assets/languages/中创建一个新的规范示例，实现与specification.txt相同的流程。

• 使用bin/test运行测试。此时应该失败。每次更改后都要继续运行它们。

• 在ftw/lawgiver/wdl/languages/中添加一个新的语言模块。

• 在ftw/lawgiver/wdl/languages/__init__.py中注册新语言。

• 在您的新的语言类中实现特定于语言的限制和提取方法，直到所有测试都通过。

• 将语言添加到readme中。

• 向我们发送拉取请求！

更新翻译

工作流详细信息视图中的“在本地目录更新翻译”按钮可以帮助您保持翻译的更新。它将直接写入您的机器上的本地目录。

在更新翻译时，这些文件会被写入

• your/package/locales/plone.pot

• your/package/locales/en/LC_MESSAGES/plone.po

在更新您的本地文件中的消息时，所有以工作流ID前缀开头的不再有效的消息将被自动删除。

共享视图中的角色

默认情况下，@@sharing 视图列出了一些默认的Plone角色

• 可以添加（Contributor）

• 可以编辑（Editor）

• 可以审核（Reviewer）

• 可以查看（Reader）

通常工作流程不使用所有这些角色，或者使用不同的角色。法规制定者允许您配置在 sharing 视图中显示哪些角色。如果您的用户正在 @@sharing 视图中授予角色，您可能需要配置角色，以便它们具有有意义的名称，并且只列出相关的角色。

如果您想自定义工作流程中显示的角色，您可以直接在工作流程规范中这样做

[A workflow]

Role mapping:
  editor => Editor
  editor-in-chief => Reviewer
  administrator => Site Administrator

Visible roles:
  editor
  editor-in-chief

法规制定者随后设置了正确管理角色所需的权限。这对于已注册的角色有效。Plone默认情况下仅注册 Contributor、Editor、Reviewer 和 Reader。请参阅注册附加角色部分。

翻译角色

法规制定者扩展了Plone的角色翻译系统，以便 @@sharing 视图中的角色可以按工作流程进行翻译。

这是通过Plone标准角色实用工具完成的，允许插件工具也能够使用正确的角色翻译，而无需进行自定义。

法规制定者在法规制定者控制面板中提供了示例翻译（plone.pot / plone.po），可以轻松地复制到您的本地plone翻译（locales）。这些翻译也包括角色翻译，可以根据您的需要进行修改。

法规制定者会根据您的工作流程自动查找正确的角色翻译。

注册其他角色

您可以轻松注册自定义角色或默认情况下不可见的Plone默认角色（例如 Site Manager）。

使用法规制定者指令进行注册新角色

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:lawgiver="http://namespaces.zope.org/lawgiver"
    i18n_domain="my.package">

    <include package="ftw.lawgiver" />

    <lawgiver:role name="Site Manager" />

</configure>

lawgiver:role 指令为您完成所有必要的事情，例如在zope中注册权限，将权限映射到默认的法规制定者 manage security 操作组，并注册所需的实用工具和适配器。

可选参数

• permission：授予此角色所需的权限。权限自动生成为 Sharing page: Delegate [ROLE] role。

• register_permission：自动在Zope中注册权限。默认情况下为 True。

• map_permission：自动将权限映射到默认的法规制定者 manage security 操作组。法规制定者还会根据您在工作流程规范中的 Visible roles 配置重新映射权限。

共享视图中角色的描述

ftw.lawgiver 在单击共享视图表头中的角色文本时自动注册一个覆盖层。覆盖层显示当前工作流程每个状态下此角色可以执行的操作描述。

[A workflow]

Role mapping:
  editor => Editor
  editor-in-chief => Reviewer
  administrator => Site Administrator

editor-in-chief role description:
  The editor-in-chief reviews and publishes content.

示例

1. 实现具有自定义行为的自定义视图

   from ftw.lawgiver.browser.modifystatus import ModifyStatusViewBase
   
   class WebModifyStatus(ModifyStatusViewBase):
   
       @ModifyStatusViewBase.intercept('web--TRANSITION--publish--draft-published')
       def verify_on_publish(self, context, transition):
           # verify things
           return self.redirect_to_content_status_modify(context, transition)

   对于未拦截的转换，默认行为是重定向到默认的content_status_modify脚本，这是Plone的默认行为。默认行为使用redirect_to_content_status_modify实现，因此上面的示例也回退到默认行为。

   基类提供功能作为方法

   • execute_transition(context, transition, **kwargs)：直接执行content_status_modify脚本，这样我们可以在稍后更改重定向或在同一事务中做更多的事情。

   • redirect_to_content_status_modify(context, transaction)：将浏览器重定向到content_status_modify脚本。脚本不在同一事务中执行。

   • set_workflow_state(context, review_state, **infos)：更改上下文的工作流状态，而不执行转换或尊重任何守卫。

   • in_state(context, review_state)：上下文管理器，用于暂时切换审查状态。

   • redirect_to(context)：重定向到上下文的绝对URL。

2. 在ZCML中注册视图

   <browser:page
       name="web-modify-status"
       for="*"
       class=".modifystatus.WebModifyStatus"
       permission="zope2.View"
       />

3. 配置lawgiver工作流使用此视图作为动作

   # Settings
   transition-url = %%(content_url)s/@@web-modify-status?transition=%(transition)s