CMFEditions

CMFEditions provides versioning in Plone.

• It works out of the box.
• It's highly extensible for specific use cases.

Out Of The Box Experience

Versionable content items edit views now allows saving a version on save (automatically or manually). The version history may be accessed quickly from the view view.

Versionable content types also have an additional tab with version related functionality:

• save new version
• preview an old version
• retrieve an old version (replacing the current state in the tree)
• diffing versions

A content panel allows configuring the versioning policy by content type:

• enable or disable versioning
• auto-versioning on save
• auto-versioning on retrieve

By default the contents of a folder is versioned independently of the folder. This may be changed through the ZMI and for specific cases on python level.

The current strategy is to save everything of the content item (incl. security information, workflow state, etc.). On retrieve some of these information are filtered out. This policy may completely be changed depending on specific needs (see modifiers below).

Extensibility

CMFEditions was from the beginning developed with extensibility in mind. A handful of tools provide the whole functionality:

• repository layer: This is the public main API. The repository layer cares about recursive storing and retrieving of content items from/to Zope 2's Object File System (OFS).
• archivist layer: It knows how to clone content items. The archivist "is Mr. Pickle".
• modifiers: They're invoked by the archivist and know what to clone. This the main customization point. A modifier knows about what information on an object is a reference and if the referenced object has to be versioned also.
• storage: Is responsible of storing content items versions in a history. The current storage implementation is a ZODB storage (it uses Zope Version Control Product from ZC). Other storages may be written (svn, file based, xml based, etc.). The storage API is quite simple and the storage implementation doesn't have to care about reference stuff as this is already done by the upper layers.
• purge policy: The purge policy is called on every save operations and has full control over the version to save and the whole history. The current implementation may be configured to only hold the n current versions by purging the older versions from the repository. This functionality is by default disabled. It may be enabled through the ZMI. You should take care when you're saving objects with a lot of interrelations. Purging functionality is quite new!

Additional Documentation

A couple of presentations and ReSt documents may be found in documentation package that has to be downloaded separately (or the doc folder of CMFEditions).

The CMFEditions team also started adding documentation in the download area <http://plone.org/products/cmfeditions/documentation&gt; of plone.org. You're welcome to help out.

Dependencies

CMFEditions is part of the Plone distribution and all dependencies are already included. Please refer to the dependency information of Plone for any details.

Migrating from Older Versions of CMFEditions

We know there are severe problems when migrating from 1.0alpha3, 1.0alpha4 or trunk checkout from May 2006 and before. Please contact us <mailto:collective-versioning@lists.sourceforge.net> for assistance. We're interested in making migrations bullet proof.

Feedback

• Please report bugs <https://github.com/plone/Products.CMFEditions/issues&gt; to the CMFEditions tracker on plone.org.
• For feedback and questions the developers may be contacted on the mailing list <mailto:collective-versioning@lists.sourceforge.net>.

Source Code

Contributors please read the document Process for Plone core's development

Sources are at the Plone code repository hosted at Github.

Credits & Sponsoring

Several people and organizations have made CMFEditions possible:

> See CREDITS.txt

Changelog

4.0.3 (2024-01-18)

Internal:

• Update configuration files. [plone devs] (cfffba8c)

4.0.2 (2023-10-07)

Bug fixes:

• Allow principal in sys_metadata with ArchivistTool init (#101)

4.0.1 (2023-04-15)

Internal:

• Update configuration files. [plone devs] (3333c742)

4.0.0 (2022-12-02)

Bug fixes:

• Final release for Plone 6.0.0 (#600)

4.0.0b3 (2022-10-03)

Bug fixes:

• Fix object remains locked after version retrieved (#93)

4.0.0b2 (2022-09-19)

Bug fixes:

• Only fire ObjectModifiedEvent once when an item is reverted to an old version. [davisagli] (#90)

4.0.0b1 (2022-07-21)

Bug fixes:

• Replaced label 'Working Copy' with 'Current revision' [rristow] (#55)
• Do not depend on Zope2 but Zope and remove transitional dependencies. [jensens] (#87)
• Fix deprecated imports and not depend on CMFPlone. Removes also circular dependency. [jensens] (#88)
• Fix test to work with updated CMFUid. [davisagli] (#89)

4.0.0a3 (2022-01-19)

Breaking changes:

• The VersionView class is deprecated because it contained just one method that is now part of the @@plone view [ale-rt] (#84)

4.0.0a2 (2021-12-29)

Breaking changes:

• Removed versioning_config.py and versioning_config_form.pt from skin. Instead, you can change the versioning config in the @@content-controlpanel. [maurits] (#72)
• Removed migration code from version 1.0alpha3 to 1.0beta1 from 2006. Removed Storage Migration Support. This had code for creating a test hierarchy for migration tests. [maurits] (#72)
• Removed unused versions_history.pt which defines a versions_history macro. We do still have versions_history_form. [maurits] (#72)

New features:

• Merged skin script checkUpToDate into versions_history_form view. Merged can_diff view into versions_history_form view. [maurits] (#71)
• Remove now empty CMFEditions skin layer in an upgrade step. [maurits] (#71)
• Moved various items from from skin to a browser view: saveasnewversion, revertversion, diff_legend, versions_history_form, compare.css. [maurits] (#71)

Bug fixes:

• Removed version_diff.pt. This template is deprecated. Use the @@history view instead. [maurits] (#71)
• QA: black, isort, flake8, fix deprecation warnings, remove use of six, upgrade to Python 3.7-only syntax. [maurits] (#80)

4.0.0a1 (2021-04-26)

Breaking changes:

• Removed support for Archetypes, Zope 2 and Python 2. Removed Archetypes-only modifiers: RetainATRefs, NotRetainATRefs, SkipBlobs, CloneBlobs. Added upgrade step to remove these modifiers from the portal_modifier tool. This is for Plone 6 only. [maurits] (#74)
• Update for Plone 6 with Bootstrap markup [petschki] (#79)

New features:

• Handle broken VersionPolicies and modifiers in a nicer way.

  • ConditionalModifier.isApplicable: return False when modifier is broken.
  • portal_repository.listPolicies: log and ignore Broken VersionPolicies.

  [maurits] (#74)

• Barceloneta LTS support [petschki] (#77)

3.3.4 (2020-04-23)

Bug fixes:

• Minor packaging updates. (#1)

3.3.3 (2019-08-29)

Bug fixes:

• Fix DeprecationWarning [jensens] (#71)

3.3.2 (2019-05-04)

Bug fixes:

• Fix release issue in 3.3.1 [esteele] (#69)

3.3.1 (2019-05-04)

Bug fixes:

• Avoid ResourceWarnings. [gforcada] (#65)
• Made removing of versioning behaviors less strict (named vs dotted). [iham] (#67)

3.3.0 (2018-11-06)

New features:

• Replaced usages of getObjSize with human_readable_size. (#60)

Bug fixes:

• Fix success() responses in controller actions browser views for AT types (#62)

3.2.2 (2018-09-23)

Bug fixes:

• Fix Unauthorized error due to importing six inside Restricted Python Plone issue 2463 [davilima6]
• Migrate Tests away from PloneTestCase [pbauer]
• Do not run webdav_history.txt in py3 since it breaks tests (no webdav support in py3). [pbauer]
• cleanup: isort/formatting/security decorators [jensens]
• InitializeClass was moved to AccessControl.class_init - use it. [jensens]
• setDefaultRoles is deprecated. addPermission from AccessControl.Permission is instead used. [jensens]

3.2.1 (2018-06-18)

Bug fixes:

• Test against plone.app.contenttypes instead of ATContentTypes. [davisagli]

3.2.0 (2018-04-03)

New features:

• Allow disabling versioning per object. Plone issue 2341 [tomgross]

Bug fixes:

• Make imports Python 3 compatible [ale-rt, pbauer]
• Don't depend on ZODB version 3 directly [tomgross]

3.1.1 (2018-02-05)

New features:

• Prepare for Python 2 / 3 compatibility [davilima6]

3.1 (2017-03-31)

New features:

• Use the processQueue from the merged collective.indexing. [gforcada]

3.0.1 (2017-02-12)

Bug fixes:

• Make tests run in Zope 4 (includes some cleanup). [pbauer]
• Get rid of CMFFormController scripts [tomgross]

3.0 (2016-12-05)

Breaking changes:

• Purge all old revisions of content about to be removed. [tschorr]

For older changes, 2.2.23 and earlier, see docs/old-changelog.rst.