Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/collective/collective.revisionmanager

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/collective/collective.revisionmanager
Owner: collective
Created: 2016-02-29T12:12:33.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-07-15T16:34:00.000Z (4 months ago)
Last Synced: 2024-10-01T17:19:42.594Z (about 1 month ago)
Language: Python
Size: 229 KB
Stars: 6
Watchers: 10
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst

Awesome Lists containing this project

awesome-plone - collective.revisionmanager - Manage Products.CMFEditions histories that can bloat your database. (Sysadmin)

README

        .. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.

   If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html

   This text does not appear on pypi or github. It is a comment.

==============================================================================

collective.revisionmanager

==============================================================================

.. image:: https://img.shields.io/pypi/v/collective.revisionmanager.svg

    :target: https://pypi.python.org/pypi/collective.revisionmanager

.. image:: https://img.shields.io/coveralls/collective/collective.revisionmanager/master.svg

    :target: https://coveralls.io/r/collective/collective.revisionmanager

collective.revisionmanager is a Plone add-on that lets you manage Products.CMFEditions histories.

It can be used with Plone 6.0, 5.2, 5.1, 5.0 (untested) and Plone 4.3.

You will need Products.CMFEditions version >= 2.2.16.

This is available by default in the latest bugfix releases of all supported Plone versions.

Features

--------

- Sorted listing of histories storage (portal_historiesstorage) contents. Sort by: history id, number of versions, history size, size state, portal type or path

- Purge revisions or delete entire histories

- Maintain a cache for the statistics

- Plone controlpanel interface for portal_purgepolicy

Translations

------------

Brazilian Portuguese, German and Spanish translations are available.

Installation

------------

Install collective.revisionmanager by adding it to your buildout::

    [buildout]

    ...

    eggs =

        collective.revisionmanager

and then running ``bin/buildout``. During installation, ``collective.revisionmanager`` will check wether the ``cmf_uid`` catalog index is there - if not, the index will be added and indexed. This step may require a considerable amount of time depending on the number of objects and object revisions in your database. Also, a cache for the statistics will be created.

After installation, you will have to calculate the statistics initially before you can see anything. Statistics calculation was done automatically during installation in earlier releases, but for sites with large databases and limited memory it may be necessary to configure subtransactions prior to updating the cache.

Calculating Statistics

----------------------

Before you can use `collective.revisionmanager` you need to fill its history statistics cache. You can do so by visting Plone Control Panel -> Addon Configuration -> Manage Revisions and then clicking on the ``Recalculate Statistics`` button. Calculation may take a lot of time if you have lots of objects and object revisions in your database.

You will have to recalculate statistics from time to time to keep them up to date at intervals depending on database activity.

**Dealing with catalog inconsistencies**

If the installation fails with an ``AttributeError`` in ``Products.ZCatalog.CatalogBrains``, your ``portal_catalog`` is inconsistent and you need to `rebuild `_ it. As a quick workaround, you can also simply clear (or even delete) the ``cmf_uid`` catalog index - ``collective.revisionmanager`` will rebuild it during installation. But be aware that your ``portal_catalog`` is still inconsistent and needs rebuilding.

Always make sure the ``cmf_uid`` index is consistent because it is used to determine the working copy of a history. Incorrectly indexed content will show up as having no working copy in the histories list!

Contribute

----------

- Issue Tracker: https://github.com/collective/collective.revisionmanager/issues

- Source Code: https://github.com/collective/collective.revisionmanager

- Documentation: https://github.com/collective/collective.revisionmanager/README.rst

License

-------

The project is licensed under the GPLv2.