ftw.publisher.sender 2.2.0

Core packages

ftw.publisher.sender

The sender package provides a configuration panel and is responsible for sending contents to the target instance. It’s usually installed on a editorial site. ftw.publisher.sender source | ftw.publisher.sender pypi

ftw.publisher.receiver

The receiver package is installed on the public site and is the target of the publishing process. It has tools for receiving a request and creating, updating or deleting objects which should be published or retrieved. ftw.publisher.receiver source | ftw.publisher.receiver pypi

ftw.publisher.core

The core package is installed on both, sender and receiver instances. It provides adapters for serializing and unserializing components of plone contents (such as portlets). ftw.publisher.core source | ftw.publisher.core pypi

Addon packages

ftw.publisher.example

This example package provides a publisher-bound workflow and shows how to write an integration package for this use case. ftw.publisher.example source | ftw.publisher.example pypi

ftw.publisher.monitor

Sends alert mails when the publisher queue is blocked and publishing does no longer work. ftw.publisher.monitor source | ftw.publisher.monitor pypi

ftw.publisher.mailreport

Sends scheduled reports about the publishing state (executed jobs, failed jobs, etc.). ftw.publisher.mailreport source | ftw.publisher.mailreport pypi

ftw.publisher.controlling

Views for comparing the editorial and the public site. Detects inconsistencies and problems by comparing the catalogs of the two sites. Useful in workflow based publishing environments. ftw.publisher.controlling source | ftw.publisher.controlling pypi

Override realm configuration with ZCML

The realms are by default configured in the database through the control panel. When copying the database from a production environment to a staging environment the realm configuration is copied too, which could result in publishing from the staging editorial site to the production public site, which is very bad.

For solving this issue it is possible to override the realm configuration with ZCML, so that it can be configured also using the zcml-additional option of the buildout.

<configure xmlns:publisher="http://namespaces.zope.org/ftw.publisher">

    <include package="ftw.publisher.sender" file="meta.zcml" />

    <publisher:override-realm
        url="http://localhost:9090/site"
        username="publisher-user"
        password="publisher-password" />

</configure>

Defining a publisher configuration

A publisher configuration is a simple IWorkflowConfiguration adapter, which could look like this:

from ftw.publisher.sender.workflows import interfaces
from zope.component import adapts
from zope.interface import Interface
from zope.interface import implements


class MyWorkflowConfiguration(object):
    implements(interfaces.IWorkflowConfiguration)
    adapts(Interface)

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

    def states(self):
        return {
            'private': None,
            'pending': None,
            'published': interfaces.PUBLISHED,
            'revision': interfaces.REVISION}

    def transitions(self):
        return {
            'submit': interfaces.SUBMIT,
            'publish': interfaces.PUBLISH,
            'reject': interfaces.RETRACT,
            'retract': interfaces.RETRACT,
            'revise': None}

The named-adapter is then registered with some ZCML, where the name of the adapter is the ID of the workflow in portal_workflow.

<adapter factory=".config.MyWorkflowConfiguration"
         name="my-workflow" />

Lawgiver-Workflows

ftw.lawgiver is a tool for writing workflows. If you are using the lawgiver, you can use LawgiverWorkflowConfiguration as a base class, which allows you to define the states and transitions by name / statement instead of ID:

from ftw.publisher.sender.workflows import config
from ftw.publisher.sender.workflows import interfaces


class ExampleWorkflowConfiguration(config.LawgiverWorkflowConfiguration):
    workflow_id = 'publisher-example-workflow'

    def lawgiver_states(self):
        return {
            'Internal': None,
            'Pending': None,
            'Published': interfaces.PUBLISHED,
            'Revision': interfaces.REVISION}

    def lawgiver_transitions(self):
        return {
            'submit (Internal => Pending)': interfaces.SUBMIT,
            'publish (Internal => Published)': interfaces.PUBLISH,
            'reject (Pending => Internal)': None,
            'publish (Pending => Published)': interfaces.PUBLISH,
            'retract (Published => Internal)': interfaces.RETRACT,
            'revise (Published => Revision)': None,
            'publish (Revision => Published)': interfaces.PUBLISH,
            }

Transition validation (constraints)

When a user publishes a content and its container is not yet published it will fail on the remote system, because the container is missing.

The publisher provides workflow constraints for prohibiting bad transitions and for warning when something should be done (e.g. references should also be published).

You should enable those constraints for your workflow by changing the transition action URL (“Display in actions box” -> “URL (formatted)”) to the format %(content_url)s/publisher-modify-status?transition=TRANSITION (replace TRANSITION) with the transition ID. The default Plone URL is %(content_url)s/content_status_modify?workflow_action=TRANSITION.

The constraints are adapters registered for each workflows. This allows to change the constraints per workflow easily. Take a look at the publisher example workflow constraints.

You might either subclass the example workflow constraint and extend it, write your own constraint definitions from scratch or directly use the example workflow constraints for your workflow.

Reusing the example workflow constraints is as simple as registering a named adapter (your workflow ID in portal_workflow is the name of the adapter):

<adapter factory="ftw.publisher.sender.workflows.example.ExampleWorkflowConstraintDefinition"
         name="my-workflow" />

Testing workflows

For automatically testing whether your worlfow configuration is correct you can reuse the publisher example workflow configuration tests <https://github.com/4teamwork/ftw.publisher.sender/blob/master/ftw/publisher/sender/tests/test_example_workflow_config.py>:

from ftw.publisher.sender.tests import test_example_workflow_config
from my.package.testing import MY_INTEGRATION_TESTING

class TestMyWorkflowConfig(test_example_workflow_config.TestWorkflowConfig):
    layer = MY_INTEGRATION_TESTING
    workflow_id = 'my-workflow'

If you write custom constraints you should also take at the example constraints tests.

Copyright

This package is copyright by 4teamwork.

ftw.publisher.sender is licensed under GNU General Public License, version 2.

2.2.0 (2013-09-02)

• Add simplelayout support: publish blocks within simplelayout containers automatically when they have no workflow. [jone]

• Provide workflow integration with an example publisher workflow. [jone]

• Use publisher permission for protecting publisher control panel action. Required permission: “ftw.publisher.sender: Change Publisher Configuration” [jone]

2.1.0 (2013-06-13)

• Add separate permission for accessing the publisher settings in the control panel. By default, the permission is granted to Manager and Site Administrator. The permission is “ftw.publisher.sender: Change Publisher Configuration” [jone]

2.0.1 (2013-05-24)

• Execute queue view: add batch size argument. [jone]

2.0 (2013-05-24)

• Make status messages transaction aware, so that it works with integrity check rollbacks. [jone]

• Implement an override-realm ZCML directive for overriding database settings with ZCML. [jone]

• Make ugprade step 1.1 -> 1.2 save: do not migrate when there is no data. [jone]

• Plone 4.3 compatibility. [jone]

• Add “disable-publisher-for-testing” environment variable for disabling event handler. [jone]

• Fixed error if data-adapter (JSON-data) doesnt contain field_data_adapter. [jinfanger]

• UnicodeError in log. LogStream should not be mixed utf8 and unicode. [jinfanger]

• Ignored fields can be configurated, which will be ignored by the publisher. [jinfanger]

• Drop Plone 3 support. [jone]

1.5 (2011-07-05)

• Fixed authentication problem (base64) (issue #1) [jone]

• Fix PloneFormGen publish support. Recursively publish all items from a FormFolder. [mathias.leimgruber]

1.4 (2011-04-06)

• Cleanup, move to github (https://github.com/4teamwork/ftw.publisher.sender) and prepare for release. [jone]

1.3 (2011-01-19)

• Added some german translations and added plain english po-file [mathias.leimgruber]

• Merged lock-config-branch into trunk Bei Direktem Publishing ohne Queu macht das Locking keinen Sinn. Daher kann man nun das Locking einschalten/ausschalten. [mathias.leimgruber]

• Added new IBeforeQueueExecutionEvent, which allows third party packages to do dome stuff. [jone]

1.2 (2010-09-27)

• Added missing message factory import in publishploneformgen.py [jone]

• Added QueueExecutedEvent [jone]

• Added viewlet manager on configlet page. [jone]

• Do not catch BadStatusLine exceptions since the should be moved to the executed jobs list like when regular exceptions occur. [jone]

• Added batching to executed jobs view [jone]

• Added upgrade step for migrating the executed jobs storage to IOBTree [jone]

• Added some storage tests and changed the executed jobs storage to a IOBTree storage for better performance. [jone]

UPGRADES:

• portal_setup: run the ftw.publisher.sender upgrade step for migrating storage

1.1 (2010-07-21)

• Use the translated communication state names [jone]

• Show json cache path in configuration [jone]

• Executed jobs list: made more robust ; reversed listing [jone]

1.0c4 (2010-06-24)

• Fixed bad adapter usage [jone]

1.0c3 (2010-06-24)

• Added string encoding / decoding methods which work with json [jone]

1.0c2 (2010-06-22)

• Fixed fixed namespace_packages in setup.py [jone]

1.0c1 (2010-06-18)

• Locking while executing queue [jone]

• Added possiblity to disable automatic publishing in control panel [jone]

• Added possibility to execute / delete a single job in the queue [jone]

• Added executed jobs list [jone]

• Added publisher control panel icon [jone]

• Implemented blacklist support [jone]

• Added modification date to medata: it will be set by the receiver [jone]

• Fixed encoding problem: the dumped data should always contain unicode strings [jone]

• Client-Objects are now IAttributeAnnotable [jone]

• Using z3c.autoinclude for including zcml-dependencies [jone]

• implement rename action [mle]