Akismet Silverstripe Module
Simple spam filter for Silverstripe using Akismet, (*1)
Also, please report any issues
you may encounter, as it helps us all out!, (*2)
Credits and Authors
Requirements
Installation Instructions
This module can be easily installed on any already-developed website, (*3)
- If using composer installation can be done as below
composer require tractorcow/silverstripe-akismet 3.1.x-dev
-
If not using composer you'll need to download the
akismet module,
spam protector,
and akismet, (*4)
-
Configure your environment to set 'AkismetSpamProtector' as the protector class, and get an API key from
akismet.com and set in the site against one of the following ways., (*5)
config.yml:, (*6)
---
Name: myspamprotection
---
FormSpamProtectionExtension:
default_spam_protector: AkismetSpamProtector
AkismetSpamProtector:
api_key: 5555dddd55d5d
_config.php:, (*7)
Config::inst()->update('FormSpamProtectionExtension', 'default_spam_protector', 'AkismetSpamProtector');
AkismetSpamProtector::set_api_key('5555dddd55d5d');
_ss_environment.php:, (*8)
define('SS_AKISMET_API_KEY', '5555dddd55d5d');
// and set AkismetSpamProtector as your spam protector using one of the above methods
Testing
By default, spam protection is disabled for users with ADMIN priviliges. There is also an option to disable
spam protection for all logged in users. In order to disable this for testing purposes, you can temporarily
modify these options in your development environment as below:, (*9)
if(!Director::isLive()) {
Config::inst()->remove('AkismetSpamProtector', 'bypass_permission');
Config::inst()->remove('AkismetSpamProtector', 'bypass_members');
}
In order to check that your form is blocking spam correctly, you can always set 'viagra-test-123' as
the author and Akismet will always mark this as spam., (*10)
If you're using Comments module you can quickly set akismet to filter these out by adding the CommentSpamProtection
extension to the CommentingController, (*11)
config.yml, (*12)
CommentingController:
extensions:
- CommentSpamProtection
_config.php, (*13)
CommentingController::add_extension('CommentSpamProtection');
To enable spam protection in your custom forms, call the enableSpamProtection method with your field names mapped to the akismet fields:, (*14)
$form = new Form($this, 'Form', $fields, $actions, $validator);
$form->enableSpamProtection(array(
'mapping' => array(
'Name' => 'authorName',
'Email' => 'authorMail',
'Comments' => 'body'
)
)
);
Important notes for those in the EU
Because of the way Akismet works (message, author, and other information sent to a third party) in some countries
it's legally necessary to notify and gain the user's permission prior to verification., (*15)
To create a checkbox style authorisation prompt for this field set the following configuration option:, (*16)
config.yml, (*17)
AkismetSpamProtector:
require_confirmation: true
_config.php, (*18)
Config::inst()->update('AkismetSpamProtector', 'require_confirmation', true);
License
Revised BSD License, (*19)
Copyright (c) 2013, Damian Mooyman
All rights reserved., (*20)
All rights reserved., (*21)
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:, (*22)
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- The name of Damian Mooyman may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE., (*23)
Wallogit.com
