ftw.activity 2.5.2

ftw.activity

ftw.activity 为Plone提供了一个包含活动流的视图。

工作原理

活动通过事件处理程序存储到自定义的 souper 目录中。然后活动视图使用活动渲染器递归地渲染每个上下文的活动。

支持的事件

默认事件处理程序适用于 Archetypes 和 Dexterity 对象。

• 对象添加

• 对象更改

• 对象删除

• 对象复制

• 对象移动

• 工作流转换

用法

• 将 ftw.activity 作为依赖项添加到您的包（setup.py）或构建配置中

[instance]
eggs +=
    ftw.activity

• 在Plone的插件控制面板中安装通用导入配置文件。

安装包后，将没有到视图的链接。视图可在任何上下文中作为 /activity 使用，因此您可能希望将其放在任何需要的位置或添加操作。

ftw.activity 还注册了一个名为 tabbedview_view-activity 的 ftw.tabbedview 选项卡。

自定义活动

自定义活动可以轻松地在 souper 目录中注册，并自动渲染

from ftw.activity.catalog import ActivityRecord
from ftw.activity.catalog import get_activity_soup

record = ActivityRecord(context, 'downloaded')
get_activity_soup().add(record)

活动渲染器

默认活动渲染器使用链接到对象（除非已删除）、事件和行动者渲染活动。

但是，如果您想更改活动渲染方式，您可以使用自定义渲染器轻松地做到这一点。活动渲染器是一个命名多适配器。

请注意，渲染器适应的是活动视图渲染的上下文，而不是活动发生的对象。原因在于该对象可能已不存在。

渲染器必须实现三个方法，position、match和render。由于可能存在多个可以渲染活动的适配器，因此使用position来决定哪个渲染器先执行。使用match方法来询问渲染器是否希望渲染某个活动。如果活动匹配，则使用render方法进行渲染。

警告 请注意，当对象被删除时，传递给match和render的对象可能是None。

示例 ZCML 注册

<adapter factory=".activity.CustomActivityRenderer" name="my.package-renderer" />

实现适配器（activity.py）

from ftw.activity.interfaces import IActivityRenderer
from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
from zope.component import adapts
from zope.interface import implements
from zope.interface import Interface


class CustomActivityRenderer(object):
    implements(IActivityRenderer)
    adapts(Interface, Interface, Interface)

    index = ViewPageTemplateFile('templates/activity_renderer.pt')

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view
        self.items = []

    def position(self):
        # The position of the default renderer is 1000
        return 500

    def match(self, activity, obj):
        return activity.attrs['portal_type'] == 'MyType'

    def render(self, activity, obj):
        return self.index(activity=activity, obj=obj)

在模板（templates/activity_renderer.pt）中，您可能想使用默认的活动宏并扩展它

<metal:wrapper use-macro="context/@@activity_macros/macros/event">
  <metal:CONTENT fill-slot="body-content"
                 tal:define="activity nocall:activity|nocall:options/activity">

    <div tal:attributes="class string:activity-icon-{$activity/action}"></div>

  </metal:CONTENT>
</metal:wrapper>

在活动中存储额外的信息

通过事件处理器可以轻松扩展存储在活动记录上的元数据

<subscriber
    for="ftw.activity.interfaces.IActivityCreatedEvent"
    handler=".subscribers.enhance_activity_record"
    />

def enhance_activity_record(event):
    record = event.activity
    obj = event.object
    record.attrs['creator'] = obj.Creator()

活动过滤器

可能存在各种自定义用例，这些用例需要在渲染活动视图时丢弃活动。例如，系统活动是为了内部目的而记录的，不应出现在活动流中。

可以通过注册一个IActivityFilter适配器轻松过滤活动

<adapter factory=".activity.CustomActivityFilter" name="my.package-filter" />

from ftw.activity.interfaces import IActivityFilter
from zope.component import adapts
from zope.interface import implements
from zope.interface import Interface


class CustomActivityFilter(object):
    implements(IActivityFilter)
    adapts(Interface, Interface, Interface)

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view

    def position(self):
        return 500

    def process(self, activities):
        for activity in activities:
            if activity.attrs['action'] == 'custom-action':
                continue

            yield activity

存在一个默认的FilterCloseChanges过滤器，它移除发生在同一对象上的连续“更改”活动，这些活动之间的时间间隔小于1分钟。当用户在短时间内大量编辑同一对象时（例如使用外部编辑器），这会从活动流中移除噪音。

本地活动视图

@@local-activity视图在任何上下文中都可用，并且仅显示当前上下文的活动，而不显示其子上下文的活动。

有关使用 ftw.testing.freeze 进行 Plone 5.1 测试的提示

由于某种原因，在使用 freeze（contextmanager）之前需要执行 transaction.commit()。有关详细信息，请参阅https://github.com/plone/plone.restapi/pull/747我认为这是一个类似的问题，也许在使用 freeze contextmanager 之前执行 transaction.commit() 可以意外地绕过问题。

链接

• github: https://github.com/4teamwork/ftw.activity

• pypi: http://pypi.python.org/pypi/ftw.activity

• CI: https://jenkins.4teamwork.ch/search?q=ftw.activity

版权

本软件包的版权属于4teamwork。

ftw.activity是在GNU通用公共许可证（GPL）第2版下许可的。

变更日志