Merge branch 'refs/heads/master' into dev

Author: alexandergull

README.md

@@ -47,7 +47,7 @@ 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);
-$cleantalk_antispam->handle();
+$api_result = $cleantalk_antispam->handle();
 ?>
 
 <form method="post">
@@ -67,7 +67,7 @@ $cleantalk_antispam->handle();
 ```
 
 ## API Response description
-API returns PHP object:
+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.

example.php

@@ -37,8 +37,7 @@
 $ct_request->example = str_repeat('Just text ', 10);
 $ct_request->agent = 'php-api';
 $ct_request->sender_ip = '178.32.183.43';
-$ct_request->js_on = 1; # Site visitor has JavaScript
-$ct_request->submit_time = 12; # Seconds from start form filling till the form POST
+$ct_request->event_token = isset($_POST['ct_bot_detector_event_token']) ? $_POST['ct_bot_detector_event_token'] : null;
 
 $ct = new Cleantalk();
 $ct->server_url = $config_url;

lib/Cleantalk.php

@@ -153,7 +153,20 @@ public function sendFeedback( CleantalkRequest $request ){
 
 		return $this->httpRequest( $filtered_request );
 	}
-	
+
+    /**
+     * Function checks if visitor is bot or not based on the Bot-detector event token.
+     *
+     * @param CleantalkRequest $request
+     *
+     * @return CleantalkResponse
+     */
+    public function checkBot( CleantalkRequest $request ){
+        $request          = $this->filterRequest( $request );
+        $filtered_request = $this->createMsg( 'check_bot', $request );
+        return $this->httpRequest( $filtered_request );
+    }
+
 	/**
 	 *  Filter request params
 	 *

lib/CleantalkAntispam.php

@@ -45,7 +45,6 @@ public function handle()
 		$ct_request->sender_ip = $sender_ip;
 		$ct_request->sender_nickname = $sender_nickname;
 		$ct_request->message = $message;
-		$ct_request->submit_time = time() - (int) $_SESSION['ct_submit_time'];
 		$ct_request->event_token = isset($_POST['ct_bot_detector_event_token']) ? $_POST['ct_bot_detector_event_token'] : null;
 
 		$ct = new Cleantalk();
@@ -59,22 +58,7 @@ public function handle()
 			$ct_result = $ct->isAllowMessage($ct_request);
 		}
 
-		if ($ct_result->allow == 1) {
-			if ($this->type_form === 'signup') {
-				echo 'User allowed. Reason ' . $ct_result->comment;
-			}
-			if ($this->type_form === 'contact') {
-				echo 'Message allowed. Reason ' . $ct_result->comment;
-			}
-		} else {
-			if ($this->type_form === 'signup') {
-				echo 'User forbidden. Reason ' . $ct_result->comment;
-			}
-			if ($this->type_form === 'contact') {
-				echo 'Message forbidden. Reason ' . $ct_result->comment;
-			}
-		}
-		echo '<br /><br />';
+        return $ct_result;
 	}
 
 	public function frontendScript()

lib/CleantalkResponse.php

@@ -5,31 +5,31 @@
  * Response class
  */
 class CleantalkResponse {
-	
+
 	/**
 	 * Checked IP
 	 * @var string
 	 */
 	public $sender_ip = null;
-	
+
 	/**
 	 * Checked Email
 	 * @var string
 	 */
 	public $sender_email = null;
-	
+
     /**
      * Received feedback nubmer
      * @var int
      */
     public $received = null;
-	
+
     /**
      *  Is stop words
      * @var int
      */
     public $stop_words = null;
-    
+
     /**
      * Cleantalk comment
      * @var string
@@ -80,57 +80,75 @@ class CleantalkResponse {
 
     /**
      * Is JS
-     * @var type 
+     * @var type
      */
     public $js_disabled = null;
 
     /**
      * Sms check
-     * @var type 
+     * @var type
      */
     public $sms_allow = null;
 
     /**
      * Sms code result
-     * @var type 
+     * @var type
      */
     public $sms = null;
-	
+
     /**
      * Sms error code
-     * @var type 
+     * @var type
      */
     public $sms_error_code = null;
-	
+
     /**
      * Sms error code
-     * @var type 
+     * @var type
      */
     public $sms_error_text = null;
-    
+
 	/**
      * Stop queue message, 1|0
-     * @var int  
+     * @var int
      */
     public $stop_queue = null;
-	
+
     /**
      * Account shuld by deactivated after registration, 1|0
-     * @var int  
+     * @var int
      */
     public $inactive = null;
 
     /**
-     * Account status 
-     * @var int  
+     * Account status
+     * @var int
      */
     public $account_status = -1;
-	
+
 	/**
 	 * @var array Contains codes returned from server
 	 */
 	public $codes = array();
-	
+
+    /**
+     * @var int Frequency of visitor spotted in 24 hours
+     */
+    public $ip_frequency_24hour = 0;
+
+    /**
+     * @var int Frequency of visitor spotted in 24 hours
+     */
+    public $ip_frequency_10min = 0;
+    /**
+     * @var int Frequency of visitor spotted in 24 hours
+     */
+    public $ip_frequency_1hour = 0;
+    /**
+     * @var float Bot expectation percentage.
+     */
+    public $bot_expectation = 0.0;
+
     /**
      * Create server response
      *
@@ -168,8 +186,14 @@ function __construct($response = null, $obj = null) {
 			$this->received = (isset($obj->received)) ? $obj->received : -1;
 			$this->codes = (isset($obj->codes)) ? explode(' ', $obj->codes) : array();
 
+            $this->bot_expectation = (isset($obj->bot_expectation)) ? $obj->bot_expectation : 0.0;
+            $this->ip_frequency_24hour = (isset($obj->ip_frequency_24hour)) ? $obj->ip_frequency_24hour : 0;
+            $this->ip_frequency_1hour = (isset($obj->ip_frequency_1hour)) ? $obj->ip_frequency_1hour : 0;
+            $this->ip_frequency_10min = (isset($obj->ip_frequency_10min)) ? $obj->ip_frequency_10min : 0;
+
+
             if ($this->errno !== 0 && $this->errstr !== null && $this->comment === null)
-                $this->comment = '*** ' . $this->errstr . ' Antispam service cleantalk.org ***'; 
+                $this->comment = '*** ' . $this->errstr . ' Antispam service cleantalk.org ***';
         }
     }
 }