Defensio for EE

Current version: Decommissioned

Defensio for EE Documentation

Note: Defensio for EE has been decommissioned These documents are here just in case someone’s running an ancient version of the code.

Version History

1.0.2 Initial Release
1.0.3 Added code to prevent EE from notifying other commenters/authors when spammy comments appear

Installation

Unzip the folder to a temporary location on your local hard drive
FTP the following files from their local folders to the same locations in your EE install’s /system folder on the server:
- /extensions/ext.defensio_interface.php
- /language/english/lang.defensio_interface.php
- /language/english/lang.defensio.php
- /modules/defensio/mod.defensio.php
- /modules/defensio/mod.defensio.php
- /modules/defensio/mcp.defensio.php
Navigate to the “Modules” tab in your EE control panel and install the Defensio module. This installs the extension, too!

Configuration

If you haven’t already done so, get an API key from Defensio
Navigate to the “Modules” tab in your EE control panel, and then to the Defensio management page
Insert your API key into the appropriate field
The other settings in the configuration panel are…
- Announce new articles to Defensio?—Choose “Yes” to send new article content to Defensio, which will increase the accuracy of the spam filter. (Default: Yes)
- Content fields to send when announcing new articles—A comma-separated list of short field names containing the article content to announce (Default: summary,body,extended)
- Override Defensio’s default determination with your own threshhold?—Choose “Yes” to override Defensio’s own spam determination (Default: No)
- When overriding, moderate comments rated above…—The spam rating above which spammy comments will be isolated for moderation (Default: Not set)
- If Defensio has an error…—In case communication with Defensio fails for some reason, choose what should be done with comments (Default: Moderate)

Usage

After configuring Defensio for EE, comments will be automatically published or moderated, depending on the response from the Defensio service. All you need to do is visit the Defensio for EE control panel (via the “Modules” tab) and decide what to do with comments.

In most cases, comments will be classified appropriately. But if a comment is ever marked as spam that should not be, or if a comment is ever published that should be marked as spam, you can change it in the Defensio for EE control panel. Doing so will also alert the Defensio service that the comment was incorrectly classified, improving the quality of future results.

Updating

Updating Defensio for EE is easy:

Download new versions from this Web site, and extract on your hard drive.
Upload the new files to their appropriate locations.
The extension and module automatically update themselves.

Uninstallation

If you would like to uninstall Defensio for EE, it’s very simple. Please note that doing so will permanently remove all settings and data related to Defensio for EE. Comments will remain; but their spam rating will not.

Navigate to the “Modules” tab in your EE control panel and remove the Defensio module. This removes the extension, too!

BONUS: Hack a new hook into EE core for usability

(Recommended for expert users, but not required at all.)
When you open or close a comment using the Defensio for EE, EE redirects you to the comment module’s control panel. To fix this, we added a hook to cp.publish.php:
//—————————————————————- // ‘change_comment_status_redirect’ hook. // - Allows alternate redirection after calling this function. // - NOTE: you may need to add $EXT to the global statement above if ($EXT->active_hook(‘change_comment_status_redirect’) === TRUE) { $url = $EXT->call_extension('change_comment_status_redirect', $url); } //—————————————————————-
Notes:

This hook should be added right above $FNS->redirect($url) in the change_comment_status() function in cp.publish.php—approximately line 12360.
You may have to add $EXT to the global statement at the top of the function (
```
global $IN, $DSP, $DB, $LANG, $PREFS, $REGX, $FNS, $SESS, $STAT, $EXT;
```
)—approximately line 12090.