Skip to main content
Latest Version Egg Status Supported - Python Versions License

collective.feedback

Feedback mechanism integration for volto. Requires volto-feedback >= 0.6.0

Users can add vote and a comment to every page on the site.

Bot protection

This product use collective.honeypot to prevent bot submissions.

You just need to set two environment variables:

  • EXTRA_PROTECTED_ACTIONS feedback-add

  • HONEYPOT_FIELD xxx

xxx should be a field name that bot should compile.

If you get hacked, you could simply change that variable.

Permissions

There are two new specific permission:

  • collective.feedback.ManageFeedbacks (collective.feedback: Manage Feedbacks) Allows to reset data (by default Manager and Site Administrator).

  • collective.feedback.AccessFeedbacks (collective.feedback: Access Feedbacks) Allows users to list feedbacks on contents where they have that permission (by default Editor, Manager and Site Administrator)

  • collective.feedback.ShowDeletedFeedbacks (collective.feedback: Show Deleted Feedbacks) Allows manager to see feedbacks of deleted objects

Feedbacks catalog

Reviews are stored inside an internal catalog (based on souper.plone).

You can access/edit data through restapi routes (see below) or through a Plone utility:

from zope.component import getUtility
from collective.feedback.interfaces import ICollectiveFeedbackStore

tool = getUtility(ICollectiveFeedbackStore)

Add a vote

  • Method add

  • Parameters: data (dictionary with parameters)

  • Response: unique-id of new record

  • Context: only the navigation root

data should be a dictionary with the following parameters:

  • uid [required]: the uid of the Plone content

  • vote [required]: the vote

  • answer: a custom string, like a comment

  • title: the title of the Plone content

  • comment: an optional comment

  • content: path of the object or name of the view

Others parameters will be ignored.

Search reviews

  • Method search

  • Parameters: query (dictionary with parameters), sort_index (default=date), reverse (default=False)

  • Response: a list of results

query is a dictionary of indexes where perform the search.

Right now data is not indexed so search filters does not work. You only need to call search method to get all data.

List update

PATCH

This endpoint allows update feedbacks by list. By now you can only change “read” property

Example:

curl http://localhost:8080/Plone/@feedback-list \
    -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
        "101010101": {"read": true},
    }'

Installation

Install collective.feedback by adding it to your buildout:

[buildout]

...

eggs =
    collective.feedback

and then running bin/buildout

Contribute

Compatibility

This product has been tested on Plone 6

Authors

This product was developed by RedTurtle Technology team.

RedTurtle Technology Site

Contributors

Changelog

1.2.0 (2025-02-28)

  • Feedback can now also be added for non-content paths. (Breaking) [eikichi18]

1.1.5 (2024-11-07)

  • Feedbacks list update endpoint @@feedback-list. [folix-01]

1.1.4 (2024-08-21)

  • Add feedback update endpoint. [folix-01]

  • Add read field to the comment. [folix-01]

1.1.3 (2024-04-29)

  • add a plone2volto url conversion method on feedback download [lucabel]

1.1.2 (2024-03-15)

  • Fix typo in actions.xml permission. [cekk]

1.1.1 (2024-03-13)

  • re-add actions.xml file to have a user-action needed on Volto. [cekk]

1.1.0 (2024-03-12)

  • Only managers can access deleted feedbacks. [cekk]

  • Allow all authenticated users to access @feedback endpoint. The endpoint will return only feedbacks on objects that they can edit. [cekk]

  • Improve tests. [cekk]

  • Install souper.plone to have its control-panel in backend. [cekk]

  • Remove unused user action. [cekk]

  • Add actions infos in @feedback endpoint, to let the frontend know what the user can do. [cekk]

1.0.0 (2023-02-16)

  • Initial release. [eikichi18]

Metadata

Release files for collective.feedback 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for collective.feedback 1.2.0
File Size Uploaded
collective.feedback-1.2.0.tar.gz 34.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for collective.feedback 1.2.0
File Interpreter ABI Platform
collective.feedback-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 77.0 kB

Release files / collective.feedback-1.2.0.tar.gz

Download URL collective.feedback-1.2.0.tar.gz
Size 34.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6e1d5e58a27a72084404b561ccdc808ca1cb76a885889f49586bc84aa967fa48
BLAKE2b-256 checksum
How to use checksums
715f07a10e310eab228328eb6c264f2bd79a7b6c32adb7c7b04ba04e6d29a2a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9

Release files / collective.feedback-1.2.0-py3-none-any.whl

Download URL collective.feedback-1.2.0-py3-none-any.whl
Size 42.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af80bd03cdaf702ee69cefbd098818c824d6add61b92ea24f70351f8ad48b8d2
BLAKE2b-256 checksum
How to use checksums
c1074f725d37e1fa452706167c1143aaed390c1e5ba47f08b80d8c79a9b6354c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page