collective.contentalerts 0.7

An add-on for Plone to get alerts about content

collective.contentalerts

Get alerts whenever a (custom list of) word is found on a content object, be that object any content type (Dexterity, Archetypes or comments).

Can be used to:

• moderate: used as a blacklist.

• highlight: used as a whitelist.

The basic idea is to use the power of plone.app.contentrules to inspect content being generated by users for certain words.

Upon that, regular plone.app.contentrules actions can be triggered: send an email, notify the user, apply a workflow transition…

Features

• manage a list of words that will be used to search (blacklist/whitelist)

• integration with plone.app.contentrules:

  • a condition to look for stop words

  • string substitutions to add on emails the snippets where the stop words where found (one for documents and one for comments)

• standalone utility

• provide different word lists if you need them, either a general one (plone.registry based) or on a per contentrule basis

• look for stop words on comments, dexterity and archetypes content types

• apply a marker interface to objects that are found to have stop words

• mark objects as reviewed

• monitor the list of words for changes and search for the new stop words on already reviewed objects

  • if [async]] extra is enable this review will be done via an asynchronous job (vi collective.taskqueue)

Where it searches on

collective.contentalerts searches either on the comments’ text, on getText() (for Archetypes based content types) or on text (for Dexterity based content types).

Standalone usage

While the main integration within Plone is via a p.a.contentrules condition, collective.contentalerts can also be used as a standalone utility.

Just get the utility (collective.contentalerts.interfaces.IAlert) and use the provided methods.

Documentation

Full documentation for end users can be found in the “docs” folder.

Installation

Install collective.contentalerts by adding it to your buildout:

[buildout]

 ...

 eggs =
     collective.contentalerts

and then running “bin/buildout”

Contribute

• Issue Tracker: https://github.com/collective/collective.contentalerts/issues

• Source Code: https://github.com/collective/collective.contentalerts

License

The project is licensed under the GPLv2.

Credits

der Freitag sponsored the creation of this add-on.

Contributors

• Gil Forcada, [e-mail]

Changelog

0.7 (2016-01-22)

• Monitor registry setting (stop words) for changes. If changes are found, verify if reviewed objects have those new stop words. [gforcada]

• Round of cleanups, refactorings and coverage fixes. [gforcada]

• Conditionally depend on collective.taskqueue to do mass processing asynchronously. [gforcada]

0.6 (2016-01-20)

• Apply IStopWordsVerified when discarding an alert. [gforcada] [staeff]

• Sort imports, use plone.api and some buildout cleanups. [gforcada]

0.5 (2016-01-19)

• Support Plone 4.3.7 [gforcada]

• Make normalize a global function [gforcada] [staeff]

0.4.post1 (2015-08-31)

• Add German translation. [staeff]

0.4.post0 (2015-08-19)

• Create wheels as well.

0.4 (2015-08-19)

• Add a browser view to remove the IHasStopWords marker interface on a per object basis. [gforcada]

0.3.1 (2015-08-17)

• Make sure that the IHasStopWords marker interface is indexed on the catalog. [gforcada]

0.3.post0 (2015-08-15)

• Fix package URL. [gforcada]

0.3 (2015-08-14)

• Correctly split stop words text so that it takes into account different line endings. [gforcada]

• Ignore empty lines on stop words to not produce unexpected results. [gforcada]

0.2 (2015-08-14)

• Split string subtitutions in two: text_alert and comment_alert. [gforcada]

0.1 (2015-08-14)

• Initial release. [gforcada]

• Fix package structure:

  • remove unneeded parts

  • add travis and coveralls badges

  [gforcada]

• Add a plone.registry to keep the general stop words list. [gforcada]

• Add a control panel configlet to edit the stop words list. [gforcada]

• Add more code analysis checks, dependency tracker and MANIFEST check [gforcada]

• Add utility to search for stop words on a given text [gforcada]

• Add a plone.app.contentrules condition: collective.contentalerts.TextAlert [gforcada]

• Add a string substitution: text_alert. To be used to compose emails on a contentrule [gforcada]

• Apply a marker interface to the objects that are found to have a stop words. [gforcada]