Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/collective/collective.contactformprotection

This package protects the default contact form of Plone which is generally accessible via /contact-form. It provides a checkbox in the controlpanel to disable it globally and adds a (H/Re)captcha field depending on your installation.
https://github.com/collective/collective.contactformprotection

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/collective/collective.contactformprotection
Owner: collective
License: gpl-3.0
Created: 2024-04-29T10:15:46.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-04-29T13:35:36.000Z (7 months ago)
Last Synced: 2024-11-02T18:41:29.933Z (10 days ago)
Language: Python
Size: 78.1 KB
Stars: 0
Watchers: 7
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE.GPL

Awesome Lists containing this project

awesome-plone - collective.contactformprotection - Disables the default `contact-info` form or protect it with `plone.formwidget.[h|re]captcha`. (Security)

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.html

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

.. image:: https://github.com/collective/collective.contactformprotection/actions/workflows/meta.yml/badge.svg

    :target: https://github.com/collective/collective.contactformprotection/actions/workflows/meta.yml

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

collective.contactformprotection

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

This package protects the default contact form of Plone which is generally accessible via ``/contact-info``.

If you have installed this product, you can go to the ``Contacformprotection Control Panel`` and adjust its settings.

Settings

--------

- Provide a checkbox in the controlpanel to disable the form globally

- Add a H/Recaptcha field depending on the installed 3rd party addon ``plone.formwidget.[h|re]captcha``.

Captcha support

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

If you have installed ``plone.formwidget.recaptcha`` or ``plone.formwidget.hcaptcha`` it is automatically

added to the form. In case both are installed, you can make a choice in the controlpanel.

You can install the packages by adding the ``extra_required`` to this package::

    [buildout]

    ...

    eggs =

        collective.contactformprotection[hcaptcha,recaptcha]

The settings mentioned above are all set in the configuration registry. See ``plone.app.registry`` how to set these

values TTW or in a package profile.

Installation

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

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

    [buildout]

    ...

    eggs =

        collective.contactformprotection

and then running ``bin/buildout``

Customizing Captcha vocabulary

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

The captcha settings is provided by a zope vocabulary with enhanced term objects::

    class CaptchaVocabItem(object):

        def __init__(self, token, value, widget=None, validator_view=""):

            self.token = token

            self.value = value

            self.widget = widget

            self.validator_view = validator_view

If you have additional captcha addons or want to override the provided widget and validator view, you can

override the vocabulary utility ``contactformprotection.captchavocabulary`` with your terms.

Authors

-------

Peter Mathis, petschki

Contribute

----------

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

- Source Code/Documentation: https://github.com/collective/collective.contactformprotection

License

-------

The project is licensed under the GPLv3.