README.md

php-antispam

A PHP API for antispam service cleantalk.org. Invisible protection from spam, no captches, no puzzles, no animals and no math.

How API stops spam?

API uses several simple tests to stop spammers.

• Spam bots signatures.
• Blacklists checks by Email, IP, web-sites domain names.
• JavaScript availability.
• Relevance test for the comment.

How API works?

API sends a comment's text and several previous approved comments to the servers. Servers evaluates the relevance of the comment's text on the topic, tests on spam and finaly provides a solution - to publish or put on manual moderation of comments. If a comment is placed on manual moderation, the plugin adds to the text of a comment explaining the reason for the ban server publishing.

Requirements

• PHP 5.6 and above
• CURL support

You can unpack the archive with the plugin to the root of the site or install it using the composer

composer require cleantalk/php-antispam

Sample SPAM test for text comment

Notice: You can use the example PHP file from ./examples/form_with_handler

<?php
session_start();

$apikey = '';
$email_field = 'name_email_form_field';
$user_name_field = 'name_user_name_form_field';
$message_field = 'name_message_form_field';
$type_form = 'contact'; // use 'signup' for user signup form

// if downloaded, unzip and include the app, take your own relative path:
require_once 'php-antispam/cleantalk-antispam.php';
// if install the app by composer package:
use Cleantalk\CleantalkAntispam;

//require_once "lib/cleantalk-php-patch.php"; -- PHP-FPM

$cleantalk_antispam = new CleantalkAntispam($apikey, $email_field, $user_name_field, $message_field, $type_form);
$api_result = $cleantalk_antispam->handle();
if ($api_result) { // the check fired
    if ($api_result->account_status !== 1) {
        // something wrong with your key or license, to know why read $api_result->codes
        echo 'Allowed. Spam protection disabled.'; // or do nothing
    } else {
        if ($api_result->allow === 1) {
            echo 'Allowed. Spam protection OK.'; // or do nothing
        } else {
            die('Blocked. Spam protection OK. Reason: ' . $api_result->comment); // or make your own handler
        }
    }
}
// your further code flow here
?>

<form method="post">
    <label for="login">Login:</label>
    <input type="text" name="name_user_name_form_field" id="login" />
    <br />
    <label for="email">Email:</label>
    <input type="text" name="name_email_form_field" id="email" value="" />
    <br />
    <label for="message">Message:</label>
    <textarea name="name_message_form_field" id="message"></textarea>
    <br />
    <input type="submit" />
</form>

<?php $cleantalk_antispam->frontendScript(); ?>

API Response description

API returns ($api_result) PHP object:

• allow (0|1) - allow to publish or not, in other words spam or ham
• comment (string) - server comment for requests.
• id (string MD5 HEX hash) - unique request idenifier.
• errno (int) - error number. errno == 0 if requests successfull.
• errstr (string) - comment for error issue, errstr == null if requests successfull.
• account_status - 0 account disabled, 1 account enabled, -1 unknown status.

Don't want to deal with all this?

Universal solution for any CMS or custom website: https://github.com/CleanTalk/php-uni