Package: collective.contentalerts
collective.contentalertsGet alerts whenever a (two custom lists of) word is found on a content object,
be that object of any content type (Dexterity or comments).Can be used to:moderate: used as a blacklist.highlight: used as a whitelist.The main idea is to use the power ofplone.app.contentrulesto inspect content being generated by users for certain words.Upon that, regularplone.app.contentrulesactions can be triggered:
send an email, notify the user, apply a workflow transition…The secondary idea is to be able to do different actions on the content depending on if the words where found on one or the other list.Featuresmanage two lists of words that will be used to search (blacklist/whitelist)namedforbidden_wordsandinadequate_wordsintegration withplone.app.contentrules:conditions to look for stop words (either from any list or from a specific one)string substitutions to add on emails the snippets where the stop words where found
(one for documents and one for comments)standalone utilitywith methods to either look for words on both lists or only on one of themprovide different word lists if you need them,
either two general ones (plone.registry based) or on a per contentrule basislook for stop words on comments and dexterity content typesapply a marker interface to objects that are found to have stop wordsmark objects as reviewedmonitor the list of words for changes and search for the new stop words on already reviewed objectsif[async]extra is enable this review will be done via an asynchronous job (viacollective.taskqueue)Where it searches oncollective.contentalerts searches either on the comments’ text or ontext(for Dexterity based content types).Standalone usageWhile the main integration within Plone is via a plone.app.contentrules condition,collective.contentalertscan also be used as a standalone utility.Use the provided utility (collective.contentalerts.interfaces.IAlert).DocumentationFull documentation for end users can be found in the “docs” folder.InstallationInstall collective.contentalerts by adding it to your buildout:[buildout]

 ...

 eggs =
     collective.contentalertsand then running “bin/buildout”Upgrade notesVersion 3.0This version is meant to be compatible with Plone 5.2 (still on python 2.7).Version 2.0This version only supports Plone 5 and Dexterity,
if you are using Archetypes or Plone 4.3.x stick with version 1.x.So far only the migration to Plone 5 differs from the last 1.x release.Keep an eye onCHANGES.rst.Version 1.0 and belowIf you are upgrading from 0.7 to any later version there’s one manual step that needs to be done.On version 1.0 the single list of stop words was split intoinadequate_wordsandforbidden_words.As it can not be guessed which list the former list is supposed to map,
no automatic migration is provided.Anupgrade stepneeds to be written then.See below an example on how to migrate the former list to the newforbidden_wordslist:from plone import api
from plone.registry.interfaces import IRegistry
from zope.component import getUtility

# safe the stop words on the old location
old_setting = 'collective.contentalerts.interfaces.IStopWords.stop_words'
current_forbidden_words = api.portal.get_registry_record(name=old_setting)

# update registry
setup = api.portal.get_tool('portal_setup')
setup.runImportStepFromProfile(
    'profile-collective.contentalerts:default',
    'plone.app.registry'
)

# set the stop words on the new field
api.portal.set_registry_record(
    name='collective.contentalerts.interfaces.IStopWords.forbidden_words',
    value=current_forbidden_words
)

# remove the old setting
registry = getUtility(IRegistry)
del registry.records[old_setting]ContributeIssue Tracker:https://github.com/collective/collective.contentalerts/issuesSource Code:https://github.com/collective/collective.contentalertsLicenseThe project is licensed under the GPLv2.Creditsder Freitagsponsored the creation of this add-on.ContributorsGil Forcada,gilforcada@gmail.comChangelog3.2.1 (2022-12-17)Bug fixes:Add linting actions via GitHub Actions.
[gforcada] (#1)Add support for Plone 5.2.10.
[gforcada] (#2)3.2.0 (2021-03-31)Make it python 3 compatible.
[gforcada]3.1.0 (2020-05-07)Make text normalization more thorough (#14).
[staeff]3.0.0 (2020-02-11)Nothing changed yet.3.0.0a0 (2020-02-10)Add uninstall profile.
[gforcada]Adapt code and tests to Plone 5.2.
[gforcada]2.0.0 (2019-02-11)Test against Plone 4.3, 5.0, 5.1 and (experimental) 5.2.2.0a1 (2016-07-28)Make collective.contentalerts work with Plone 5
Following adaptions were needed: Remove session_data_manager, use z3c.form instead of
formlib, access text via IRichText object, several changes in tests.
[staeff]1.1 (2016-03-29)Be sure to remove the marker interface only when its needed.
[gforcada]1.0.post0 (2016-03-12)Update German translation.
[staeff]1.0 (2016-03-11)Renamed the registry setting,
now two lists are used:forbidden_wordsandinadequate_words.
See theREADME.rstfor instructions on how to create an upgrade step to migrate them.
[gforcada]UpdatedIAlertutility to use either both stop words list,
or just one if told so (passed as an argument).
[gforcada]Add ahas_forbidden_wordsmethod toIAlertutility.
It allows to check only for forbidden stop words only.
[gforcada]Make@@review-objectsview more generic by allowing a marker interface and review states to be passed.
This allows filtering which elements will be checked for stop words.
[gforcada]Triple the content rules so one can decide to monitor for any kind of word,
only forbidden words or only inadequate ones.
[gforcada]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 theIHasStopWordsmarker 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_alertandcomment_alert.
[gforcada]0.1 (2015-08-14)Initial release.
[gforcada]Fix package structure:remove unneeded partsadd travis and coveralls badges[gforcada]Add aplone.registryto 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]