(履歴とバージョン管理)

はじめに

Plone versioning allows you to go back between older edits of the same content object.

Versioning allows you to restore and diff previous copies of the same content. More about CMFEditions here.

See also

• Versioning tutorial for custom content types.

Enabling versioning on your custom content type

By default, version history is not enabled for custom content types. Below are some notes how to enable it.

• Inherit HistoryAwareMixin in your content type class:

  from Products.ATContentTypes.lib.historyaware import HistoryAwareMixin
  
  ..
  
  class CustomContent(base.ATCTContent, HistoryAwareMixin):

• Add versioning migration code to your setuphandlers.py / custom import steps:

  from Products.CMFCore.utils import getToolByName
  from Products.CMFEditions.setuphandlers import VERSIONING_ACTIONS, ADD_POLICIES, DEFAULT_POLICIES
  
  class DPSetup(object):
  
      def configureVersioning(self,portal):
         """
         Importing various settings
         Big thanks to amir toole from plone-users
         """
  
         for versioning_actions in ('MyositisPatient','MyositisVisit','MyositisOrdination','MyositisSeriousadverseevent','MyositisAdhoc','MyositisAdhoc1','MyositisAdhoc2','MyositisAdhoc3','MyositisAdhoc4'):
          VERSIONING_ACTIONS[versioning_actions] = 'version_document_view'
          portal_repository = getToolByName(portal, 'portal_repository')
          portal_repository.setAutoApplyMode(True)
          portal_repository.setVersionableContentTypes(VERSIONING_ACTIONS.keys())
          portal_repository._migrateVersionPolicies()
          portal_repository.manage_changePolicyDefs(ADD_POLICIES)
          for ctype in VERSIONING_ACTIONS:
           for policy_id in DEFAULT_POLICIES:
               portal_repository.addPolicyForContentType(ctype, policy_id)
  
    ...
  
    def importFinalSteps(context):
      """
      The last bit of code that runs as part of this setup profile.
      """
      site = context.getSite()
      configurator = DPSetup()
      configurator.configureVersioning(site)

• To see which fields differ between versions, diff tool must be configured to support your custom content types. GenericSetup support is available after Plone 3.2. For older you must manually create entries in portal_diff_tool. Example GenericSetup difftool.xml:

  <?xml version="1.0"?>
  
  <object>
  
    <difftypes>
        <type portal_type="Presentation">
          <!-- Field any will match all field names, otherwise you need to specify the field name in schema -->
          <field name="any" difftype="Compound Diff for AT types"/>
        </type>
    </difftypes>
  </object>

• If you have customized the edit process of your content type, make sure that your edit action traverses to update_version_before_edit.cpt. For hints how to do this, see portal_form_controller actions . Example:

  ## Script (Python) "diagnose_content_edit"
  ##title=Custom editing script for diagnose content type
  ##bind container=container
  ##bind context=context
  ##bind namespace=
  ##bind script=script
  ##bind state=state
  ##bind subpath=traverse_subpath
  ##parameters=id=''
  ##
  
  context.plone_log("Diagnose edit by doctor")
  
  #
  # TODO:
  # No freaking idea which of the update_version handlers is supposed to be run and when
  #
  
  # Run versioning support code
  # context.update_version_before_edit()
  
  state = context.content_edit_impl(state, id)
  
  # Run versioning support code
  context.update_version_on_edit()
  
  context.plone_log("Done")
  
  
  # Automatically trigger the workflow state change on edit
  context.portal_workflow.doActionFor(context, "push_to_review")
  
  return state
  

• If you are using custom roles you need to have at least CMFEditions: Save new version permission enabled for the roles or you’ll get exception:

  ...
  
  * Module Products.PythonScripts.PythonScript, line 327, in _exec
  * Module None, line 36, in update_version_before_edit
    <ControllerPythonScript at /xxx/update_version_before_edit used for /xxx/yyy>
    Line 36
  * Module Products.CMFEditions.CopyModifyMergeRepositoryTool, line 287, in save
  * Module Products.CMFEditions.CopyModifyMergeRepositoryTool, line 408, in _assertAuthorized
  
  Unauthorized: You are not allowed to access 'save' in this context

For more information

• http://plone.org/documentation/manual/developer-manual/archetypes/appendix-practicals/enabling-versioning-on-your-custom-content-types

Checking whether versioning is enabled

The following check is performed by update_versioning_before_edit and update_versioning_on_edit scripts:

pr = context.portal_repository

isVersionable = pr.isVersionable(context)

if pr.supportsPolicy(context, 'at_edit_autoversion') and isVersionable:
    # Versioning should work
    pass
else:
    # Something is wrong....
    pass

Inspecting versioning policies

Example:

portal_repository = context.portal_repository
map = portal_repository.getPolicyMap()
for i in map.items(): print i

Will output (inc. some custom content types):

('File Disease Description', ['at_edit_autoversion', 'version_on_revert'])
('Document', ['at_edit_autoversion', 'version_on_revert'])
('Free Text Disease Description', ['at_edit_autoversion', 'version_on_revert'])
('ATDocument', ['at_edit_autoversion', 'version_on_revert'])
('Diagnose Description', ['at_edit_autoversion', 'version_on_revert'])
('ATNewsItem', ['at_edit_autoversion', 'version_on_revert'])
('Link', ['at_edit_autoversion', 'version_on_revert'])
('News Item', ['at_edit_autoversion', 'version_on_revert'])
('Event', ['at_edit_autoversion', 'version_on_revert'])

How versioning (CMFEditions) works

• http://svn.zope.de/plone.org/collective/Products.CMFEditions/trunk/doc/DevelDoc.html

ノート

You might actually want to check out the package to get your web browser to properly read the file.