Ideas for improved versions.
[toast/cookiecaptcha.git] / recaptchalib.php
index b8ac453903ee80326112a4da6a35af5ffb29003c..73fd63097767190e1ac9bdde3c0d0dde02c93be3 100644 (file)
-<?php\r
-/*\r
- * This is a PHP library that handles calling reCAPTCHA.\r
- *    - Documentation and latest version\r
- *          http://recaptcha.net/plugins/php/\r
- *    - Get a reCAPTCHA API Key\r
- *          http://recaptcha.net/api/getkey\r
- *    - Discussion group\r
- *          http://groups.google.com/group/recaptcha\r
- *\r
- * Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net\r
- * AUTHORS:\r
- *   Mike Crawford\r
- *   Ben Maurer\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy\r
- * of this software and associated documentation files (the "Software"), to deal\r
- * in the Software without restriction, including without limitation the rights\r
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
- * copies of the Software, and to permit persons to whom the Software is\r
- * furnished to do so, subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in\r
- * all copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
- * THE SOFTWARE.\r
- */\r
-\r
-/**\r
- * The reCAPTCHA server URL's\r
- */\r
-$recaptcha_api_server = 'http://api.recaptcha.net';\r
-$recaptcha_api_secure_server = 'https://api-secure.recaptcha.net';\r
-$recaptcha_verify_server = 'api-verify.recaptcha.net';\r
-\r
-\r
-/**\r
- * Encodes the given data into a query string format\r
- * @param $data - array of string elements to be encoded\r
- * @return string - encoded request\r
- */\r
-function _recaptcha_qsencode ($data) {\r
-        $req = "";\r
-        foreach ( $data as $key => $value )\r
-                $req .= $key . '=' . urlencode( stripslashes($value) ) . '&';\r
-\r
-        // Cut the last '&'\r
-        $req=substr($req,0,strlen($req)-1);\r
-        return $req;\r
-}\r
-\r
-\r
-\r
-/**\r
- * Submits an HTTP POST to a reCAPTCHA server\r
- * @param string $host\r
- * @param string $path\r
- * @param array $data\r
- * @param int port\r
- * @return array response\r
- */\r
-function _recaptcha_http_post($host, $path, $data, $port = 80) {\r
-\r
-        $req = _recaptcha_qsencode ($data);\r
-\r
-        $http_request  = "POST $path HTTP/1.0\r\n";\r
-        $http_request .= "Host: $host\r\n";\r
-        $http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";\r
-        $http_request .= "Content-Length: " . strlen($req) . "\r\n";\r
-        $http_request .= "User-Agent: reCAPTCHA/PHP\r\n";\r
-        $http_request .= "\r\n";\r
-        $http_request .= $req;\r
-\r
-        $response = '';\r
-        if( false == ( $fs = @fsockopen($host, $port, $errno, $errstr, 10) ) ) {\r
-                die ('Could not open socket');\r
-        }\r
-\r
-        fwrite($fs, $http_request);\r
-\r
-        while ( !feof($fs) )\r
-                $response .= fgets($fs, 1160); // One TCP-IP packet\r
-        fclose($fs);\r
-        $response = explode("\r\n\r\n", $response, 2);\r
-\r
-        return $response;\r
-}\r
-\r
-\r
-\r
-/**\r
- * Gets the challenge HTML (javascript and non-javascript version).\r
- * This is called from the browser, and the resulting reCAPTCHA HTML widget\r
- * is embedded within the HTML form it was called from.\r
- * @param string $pubkey A public key for reCAPTCHA\r
- * @param string $error The error given by reCAPTCHA (optional, default is null)\r
- * @param boolean $use_ssl Should the request be made over ssl? (optional, default is false)\r
-\r
- * @return string - The HTML to be embedded in the user's form.\r
- */\r
-function recaptcha_get_html ($pubkey, $error = null, $use_ssl = false)\r
-{\r
-        global $recaptcha_api_server, $recaptcha_api_ssl_server;\r
-\r
-       if ($pubkey == null || $pubkey == '') {\r
-               die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");\r
-       }\r
-       \r
-       if ($use_ssl) {\r
-           $server = $recaptcha_api_ssl_server;\r
-        } else {\r
-           $server = $recaptcha_api_server;\r
-        }\r
-        $errorpart = "";\r
-        if ($error) {\r
-           $errorpart = "&amp;error=" . $error;\r
-        }\r
-        return '<script type="text/javascript" src="'. $server . '/challenge?k=' . $pubkey . $errorpart . '"></script>\r
-\r
-       <noscript>\r
-               <iframe src="'. $server . '/noscript?k=' . $pubkey . $errorpart . '" height="300" width="500" frameborder="0"></iframe><br>\r
-               <textarea name="recaptcha_challenge_field" rows="3" cols="40"></textarea>\r
-               <input type="hidden" name="recaptcha_response_field" value="manual_challenge">\r
-       </noscript>';\r
-}\r
-\r
-\r
-\r
-\r
-/**\r
- * A ReCaptchaResponse is returned from recaptcha_check_answer()\r
- */\r
-class ReCaptchaResponse {\r
-        var $is_valid;\r
-        var $error;\r
-}\r
-\r
-\r
-/**\r
-  * Calls an HTTP POST function to verify if the user's guess was correct\r
-  * @param string $privkey\r
-  * @param string $remoteip\r
-  * @param string $challenge\r
-  * @param string $response\r
-  * @return ReCaptchaResponse\r
-  */\r
-function recaptcha_check_answer ($privkey, $remoteip, $challenge, $response)\r
-{\r
-       if ($privkey == null || $privkey == '') {\r
-               die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");\r
-       }\r
-\r
-       if ($remoteip == null || $remoteip == '') {\r
-               die ("For security reasons, you must pass the remote ip to reCAPTCHA");\r
-       }\r
-\r
-       \r
-       \r
-        //discard spam submissions\r
-        if ($challenge == null || strlen($challenge) == 0 || $response == null || strlen($response) == 0) {\r
-                $recaptcha_response = new ReCaptchaResponse();\r
-                $recaptcha_response->is_valid = false;\r
-                $recaptcha_response->error = 'incorrect-captcha-sol';\r
-                return $recaptcha_response;\r
-        }\r
-\r
-        global $recaptcha_verify_server;\r
-        $response = _recaptcha_http_post ($recaptcha_verify_server, "/verify",\r
-                                          array (\r
-                                                 'privatekey' => $privkey,\r
-                                                 'remoteip' => $remoteip,\r
-                                                 'challenge' => $challenge,\r
-                                                 'response' => $response\r
-                                                 )\r
-                                          );\r
-\r
-        $answers = explode ("\n", $response [1]);\r
-        $recaptcha_response = new ReCaptchaResponse();\r
-\r
-        if (trim ($answers [0]) == 'true') {\r
-                $recaptcha_response->is_valid = true;\r
-        }\r
-        else {\r
-                $recaptcha_response->is_valid = false;\r
-                $recaptcha_response->error = $answers [1];\r
-        }\r
-        return $recaptcha_response;\r
-\r
-}\r
-\r
-/**\r
- * gets a URL where the user can sign up for reCAPTCHA. If your application\r
- * has a configuration page where you enter a key, you should provide a link\r
- * using this function.\r
- * @param string $domain The domain where the page is hosted\r
- * @param string $appname The name of your application\r
- */\r
-function recaptcha_get_signup_url ($domain = null, $appname = null) {\r
-       return "http://recaptcha.net/api/getkey?" .  _recaptcha_qsencode (array ('domain' => $domain, 'app' => $appname));\r
-}\r
-\r
-\r
-\r
-/* Mailhide related code */\r
-\r
-function _recaptcha_aes_encrypt($val,$ky) {\r
-       if (! function_exists ("mcrypt_encrypt")) {\r
-               die ("To use reCAPTCHA Mailhide, you need to have the mcrypt php module installed.");\r
-       }\r
-       $mode=MCRYPT_MODE_CBC;   \r
-       $enc=MCRYPT_RIJNDAEL_128;\r
-       $val=str_pad($val, (16*(floor(strlen($val) / 16)+(strlen($val) % 16==0?2:1))), chr(16-(strlen($val) % 16)));\r
-       return mcrypt_encrypt($enc, $ky, $val, $mode, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");\r
-}\r
-\r
-\r
-function _recaptcha_mailhide_urlbase64 ($x) {\r
-       return strtr(base64_encode ($x), '+/', '-_');\r
-}\r
-\r
-/* gets the reCAPTCHA Mailhide url for a given email, public key and private key */\r
-function recaptcha_mailhide_url($pubkey, $privkey, $email) {\r
-       if ($pubkey == '' || $pubkey == null || $privkey == "" || $privkey == null) {\r
-               die ("To use reCAPTCHA Mailhide, you have to sign up for a public and private key, " .\r
-                    "you can do so at <a href='http://mailhide.recaptcha.net/apikey'>http://mailhide.recaptcha.net/apikey</a>");\r
-       }\r
-       \r
-\r
-       $ky = pack('H*', $privkey);\r
-       $cryptmail = _recaptcha_aes_encrypt ($email, $ky);\r
-       \r
-       return "http://mailhide.recaptcha.net/d?k=" . $pubkey . "&c=" . _recaptcha_mailhide_urlbase64 ($cryptmail);\r
-}\r
-\r
-/**\r
- * gets the parts of the email to expose to the user.\r
- * eg, given johndoe@example,com return ["john", "example.com"].\r
- * the email is then displayed as john...@example.com\r
- */\r
-function _recaptcha_mailhide_email_parts ($email) {\r
-       $arr = preg_split("/@/", $email );\r
-\r
-       if (strlen ($arr[0]) <= 4) {\r
-               $arr[0] = substr ($arr[0], 0, 1);\r
-       } else if (strlen ($arr[0]) <= 6) {\r
-               $arr[0] = substr ($arr[0], 0, 3);\r
-       } else {\r
-               $arr[0] = substr ($arr[0], 0, 4);\r
-       }\r
-       return $arr;\r
-}\r
-\r
-/**\r
- * Gets html to display an email address given a public an private key.\r
- * to get a key, go to:\r
- *\r
- * http://mailhide.recaptcha.net/apikey\r
- */\r
-function recaptcha_mailhide_html($pubkey, $privkey, $email) {\r
-       $emailparts = _recaptcha_mailhide_email_parts ($email);\r
-       $url = recaptcha_mailhide_url ($pubkey, $privkey, $email);\r
-       \r
-       return htmlentities($emailparts[0]) . "<a href='" . htmlentities ($url) .\r
-               "' onclick=\"window.open('" . htmlentities ($url) . "', '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return false;\" title=\"Reveal this e-mail address\">...</a>@" . htmlentities ($emailparts [1]);\r
-\r
-}\r
-\r
-\r
-?>\r
+<?php
+/**
+ * This is a PHP library that handles calling reCAPTCHA.
+ *    - Documentation and latest version
+ *          http://recaptcha.net/plugins/php/
+ *    - Get a reCAPTCHA API Key
+ *          https://www.google.com/recaptcha/admin/create
+ *    - Discussion group
+ *          http://groups.google.com/group/recaptcha
+ *
+ * Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net
+ * AUTHORS:
+ *   Mike Crawford
+ *   Ben Maurer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/**
+ * The reCAPTCHA server URL's
+ */
+define( "RECAPTCHA_API_SERVER", "http://www.google.com/recaptcha/api" );
+define( "RECAPTCHA_API_SECURE_SERVER", "https://www.google.com/recaptcha/api" );
+define( "RECAPTCHA_VERIFY_SERVER", "www.google.com" );
+
+/**
+ * Encodes the given data into a query string format
+ * @param $data - array of string elements to be encoded
+ * @return string - encoded request
+ */
+function _recaptcha_qsencode ( $data ) {
+        $req = "";
+        foreach ( $data as $key => $value )
+                $req .= $key . '=' . urlencode( stripslashes( $value ) ) . '&';
+
+        // Cut the last '&'
+        $req = substr( $req, 0, strlen( $req ) -1 );
+        return $req;
+}
+
+
+
+/**
+ * Submits an HTTP POST to a reCAPTCHA server
+ * @param string $host
+ * @param string $path
+ * @param array $data
+ * @param int port
+ * @return array response
+ */
+function _recaptcha_http_post( $host, $path, $data, $port = 80 ) {
+
+        $req = _recaptcha_qsencode ( $data );
+
+        $http_request  = "POST $path HTTP/1.0\r\n";
+        $http_request .= "Host: $host\r\n";
+        $http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";
+        $http_request .= "Content-Length: " . strlen( $req ) . "\r\n";
+        $http_request .= "User-Agent: reCAPTCHA/PHP\r\n";
+        $http_request .= "\r\n";
+        $http_request .= $req;
+
+        $response = '';
+        if ( false == ( $fs = @fsockopen( $host, $port, $errno, $errstr, 10 ) ) ) {
+                die ( 'Could not open socket' );
+        }
+
+        fwrite( $fs, $http_request );
+
+        while ( !feof( $fs ) )
+                $response .= fgets( $fs, 1160 ); // One TCP-IP packet
+        fclose( $fs );
+        $response = explode( "\r\n\r\n", $response, 2 );
+
+        return $response;
+}
+
+
+
+/**
+ * Gets the challenge HTML (javascript and non-javascript version).
+ * This is called from the browser, and the resulting reCAPTCHA HTML widget
+ * is embedded within the HTML form it was called from.
+ * @param string $pubkey A public key for reCAPTCHA
+ * @param string $error The error given by reCAPTCHA (optional, default is null)
+ * @param boolean $use_ssl Should the request be made over ssl? (optional, default is false)
+
+ * @return string - The HTML to be embedded in the user's form.
+ */
+function recaptcha_get_html ( $pubkey, $error = null, $use_ssl = false )
+{
+       if ( $pubkey == null || $pubkey == '' ) {
+               die ( "To use reCAPTCHA you must get an API key from <a href='https://www.google.com/recaptcha/admin/create'>https://www.google.com/recaptcha/admin/create</a>" );
+       }
+
+       if ( $use_ssl ) {
+                $server = RECAPTCHA_API_SECURE_SERVER;
+        } else {
+                $server = RECAPTCHA_API_SERVER;
+        }
+
+        $errorpart = "";
+        if ( $error ) {
+           $errorpart = "&amp;error=" . $error;
+        }
+        return '<script type="text/javascript" src="' . $server . '/challenge?k=' . $pubkey . $errorpart . '"></script>
+
+       <noscript>
+               <iframe src="' . $server . '/noscript?k=' . $pubkey . $errorpart . '" height="300" width="500" frameborder="0"></iframe><br/>
+               <textarea name="recaptcha_challenge_field" rows="3" cols="40"></textarea>
+               <input type="hidden" name="recaptcha_response_field" value="manual_challenge"/>
+       </noscript>';
+}
+
+
+
+
+/**
+ * A ReCaptchaResponse is returned from recaptcha_check_answer()
+ */
+class ReCaptchaResponse {
+        var $is_valid;
+        var $error;
+}
+
+
+/**
+  * Calls an HTTP POST function to verify if the user's guess was correct
+  * @param string $privkey
+  * @param string $remoteip
+  * @param string $challenge
+  * @param string $response
+  * @param array $extra_params an array of extra variables to post to the server
+  * @return ReCaptchaResponse
+  */
+function recaptcha_check_answer ( $privkey, $remoteip, $challenge, $response, $extra_params = array() )
+{
+       if ( $privkey == null || $privkey == '' ) {
+               die ( "To use reCAPTCHA you must get an API key from <a href='https://www.google.com/recaptcha/admin/create'>https://www.google.com/recaptcha/admin/create</a>" );
+       }
+
+       if ( $remoteip == null || $remoteip == '' ) {
+               die ( "For security reasons, you must pass the remote ip to reCAPTCHA" );
+       }
+
+
+
+        // discard spam submissions
+        if ( $challenge == null || strlen( $challenge ) == 0 || $response == null || strlen( $response ) == 0 ) {
+                $recaptcha_response = new ReCaptchaResponse();
+                $recaptcha_response->is_valid = false;
+                $recaptcha_response->error = 'incorrect-captcha-sol';
+                return $recaptcha_response;
+        }
+
+        $response = _recaptcha_http_post ( RECAPTCHA_VERIFY_SERVER, "/recaptcha/api/verify",
+                                          array (
+                                                 'privatekey' => $privkey,
+                                                 'remoteip' => $remoteip,
+                                                 'challenge' => $challenge,
+                                                 'response' => $response
+                                                 ) + $extra_params
+                                          );
+
+        $answers = explode ( "\n", $response [1] );
+        $recaptcha_response = new ReCaptchaResponse();
+
+        if ( trim ( $answers [0] ) == 'true' ) {
+                $recaptcha_response->is_valid = true;
+        }
+        else {
+                $recaptcha_response->is_valid = false;
+                $recaptcha_response->error = $answers [1];
+        }
+        return $recaptcha_response;
+
+}
+
+/**
+ * gets a URL where the user can sign up for reCAPTCHA. If your application
+ * has a configuration page where you enter a key, you should provide a link
+ * using this function.
+ * @param string $domain The domain where the page is hosted
+ * @param string $appname The name of your application
+ */
+function recaptcha_get_signup_url ( $domain = null, $appname = null ) {
+       return "https://www.google.com/recaptcha/admin/create?" .  _recaptcha_qsencode ( array ( 'domains' => $domain, 'app' => $appname ) );
+}
+
+function _recaptcha_aes_pad( $val ) {
+       $block_size = 16;
+       $numpad = $block_size - ( strlen ( $val ) % $block_size );
+       return str_pad( $val, strlen ( $val ) + $numpad, chr( $numpad ) );
+}
+
+/* Mailhide related code */
+
+function _recaptcha_aes_encrypt( $val, $ky ) {
+       if ( ! function_exists ( "mcrypt_encrypt" ) ) {
+               die ( "To use reCAPTCHA Mailhide, you need to have the mcrypt php module installed." );
+       }
+       $mode = MCRYPT_MODE_CBC;
+       $enc = MCRYPT_RIJNDAEL_128;
+       $val = _recaptcha_aes_pad( $val );
+       return mcrypt_encrypt( $enc, $ky, $val, $mode, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0" );
+}
+
+
+function _recaptcha_mailhide_urlbase64 ( $x ) {
+       return strtr( base64_encode ( $x ), '+/', '-_' );
+}
+
+/* gets the reCAPTCHA Mailhide url for a given email, public key and private key */
+function recaptcha_mailhide_url( $pubkey, $privkey, $email ) {
+       if ( $pubkey == '' || $pubkey == null || $privkey == "" || $privkey == null ) {
+               die ( "To use reCAPTCHA Mailhide, you have to sign up for a public and private key, " .
+                    "you can do so at <a href='http://www.google.com/recaptcha/mailhide/apikey'>http://www.google.com/recaptcha/mailhide/apikey</a>" );
+       }
+
+
+       $ky = pack( 'H*', $privkey );
+       $cryptmail = _recaptcha_aes_encrypt ( $email, $ky );
+
+       return "http://www.google.com/recaptcha/mailhide/d?k=" . $pubkey . "&c=" . _recaptcha_mailhide_urlbase64 ( $cryptmail );
+}
+
+/**
+ * gets the parts of the email to expose to the user.
+ * eg, given johndoe@example,com return ["john", "example.com"].
+ * the email is then displayed as john...@example.com
+ */
+function _recaptcha_mailhide_email_parts ( $email ) {
+       $arr = preg_split( "/@/", $email );
+
+       if ( strlen ( $arr[0] ) <= 4 ) {
+               $arr[0] = substr ( $arr[0], 0, 1 );
+       } elseif ( strlen ( $arr[0] ) <= 6 ) {
+               $arr[0] = substr ( $arr[0], 0, 3 );
+       } else {
+               $arr[0] = substr ( $arr[0], 0, 4 );
+       }
+       return $arr;
+}
+
+/**
+ * Gets html to display an email address given a public an private key.
+ * to get a key, go to:
+ *
+ * http://www.google.com/recaptcha/mailhide/apikey
+ */
+function recaptcha_mailhide_html( $pubkey, $privkey, $email ) {
+       $emailparts = _recaptcha_mailhide_email_parts ( $email );
+       $url = recaptcha_mailhide_url ( $pubkey, $privkey, $email );
+
+       return htmlentities( $emailparts[0] ) . "<a href='" . htmlentities ( $url ) .
+               "' onclick=\"window.open('" . htmlentities ( $url ) . "', '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return false;\" title=\"Reveal this e-mail address\">...</a>@" . htmlentities ( $emailparts [1] );
+
+}