Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 4.07 KB

README.md

File metadata and controls

73 lines (46 loc) · 4.07 KB
Raw

Suspend Spammer

Build Status

Overview

This module checks new Member object writes against a user defined set of trigger keywords which may indicated that the Member is in fact a spammer. This is for use alongside the silverstripe/silverstripe-forum.

Maintainers

Cam Findlay [email protected]

Requirements

Installation

Best practice is to install via composer (otherwise download files and unzip to your webroot):

composer require camfindlay/silverstripe-suspendspammer dev-master

Run dev/build in the browser (http://yourwebsite/dev/build?flush=all)

or

via command line

sake (cd <yourwebroot> && ./sapphire/sake dev/build flush=all)

Usage

Simply go to the CMS, access the Spam Keywords menu then add any spam related keywords you wish to check when a new member registers or posts the content of their first forum post.

By default SuspendSpammer check the Occupation and Company fields (added by the silverstripe/forum module). This can be changed by setting the following static in your _config/config.yml file and supplying an array of keywords.

Member:
  fields_to_check:
    - Occupation
    - Company
    - AnyOtherKeywords

You can also create a CSV file of keywords using the column heading 'Title' and import through the default ModelAdmin importer.

Email Notifications

In order to be notified when a suspected spam registration or post is automatically suspended you can enable email notification and designate an email address to receive the notification emails.

The notification email includes the email address of the suspected spammer (so you can look them up in the Security section of SilverStripe CMS) as well as the fields set in the '$fields_to_check' against which the spam keywords matched.

This will allow you to perform a quick smoke test in case there was a false-positive and the registration was a legitimate member.

To enable set the following in your _config/config.yml file:

Admin:
  admin_email: '[email protected]'
SuspendSpammerEmail:
  email_to: [email protected]
  enable_email: true

The 'admin_email' is the address the email will come from, 'email_to' sets the address of the person you wish to be notified of the spam registration. Lastly you have to enable notification emails with 'enable_email'.

License

Copyright (c) 2015, Cam Findlay All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

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

  3. Neither the name of the copyright holder nor the names of its contributors may 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.