3
* This is a PHP library that handles calling reCAPTCHA.
4
* - Documentation and latest version
5
* http://recaptcha.net/plugins/php/
6
* - Get a reCAPTCHA API Key
7
* http://recaptcha.net/api/getkey
9
* http://groups.google.com/group/recaptcha
11
* Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net
16
* Permission is hereby granted, free of charge, to any person obtaining a copy
17
* of this software and associated documentation files (the "Software"), to deal
18
* in the Software without restriction, including without limitation the rights
19
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
20
* copies of the Software, and to permit persons to whom the Software is
21
* furnished to do so, subject to the following conditions:
23
* The above copyright notice and this permission notice shall be included in
24
* all copies or substantial portions of the Software.
26
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
31
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
36
* The reCAPTCHA server URL's
38
define("RECAPTCHA_API_SERVER", "http://api.recaptcha.net");
39
define("RECAPTCHA_API_SECURE_SERVER", "https://api-secure.recaptcha.net");
40
define("RECAPTCHA_VERIFY_SERVER", "api-verify.recaptcha.net");
43
* Encodes the given data into a query string format
44
* @param $data - array of string elements to be encoded
45
* @return string - encoded request
47
function _recaptcha_qsencode ($data) {
49
foreach ( $data as $key => $value )
50
$req .= $key . '=' . urlencode( stripslashes($value) ) . '&';
53
$req=substr($req,0,strlen($req)-1);
60
* Submits an HTTP POST to a reCAPTCHA server
65
* @return array response
67
function _recaptcha_http_post($host, $path, $data, $port = 80) {
69
$req = _recaptcha_qsencode ($data);
71
$http_request = "POST $path HTTP/1.0\r\n";
72
$http_request .= "Host: $host\r\n";
73
$http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";
74
$http_request .= "Content-Length: " . strlen($req) . "\r\n";
75
$http_request .= "User-Agent: reCAPTCHA/PHP\r\n";
76
$http_request .= "\r\n";
77
$http_request .= $req;
80
if( false == ( $fs = @fsockopen($host, $port, $errno, $errstr, 10) ) ) {
81
die ('Could not open socket');
84
fwrite($fs, $http_request);
87
$response .= fgets($fs, 1160); // One TCP-IP packet
89
$response = explode("\r\n\r\n", $response, 2);
97
* Gets the challenge HTML (javascript and non-javascript version).
98
* This is called from the browser, and the resulting reCAPTCHA HTML widget
99
* is embedded within the HTML form it was called from.
100
* @param string $pubkey A public key for reCAPTCHA
101
* @param string $error The error given by reCAPTCHA (optional, default is null)
102
* @param boolean $use_ssl Should the request be made over ssl? (optional, default is false)
104
* @return string - The HTML to be embedded in the user's form.
106
function recaptcha_get_html ($pubkey, $error = null, $use_ssl = false)
108
if ($pubkey == null || $pubkey == '') {
109
die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");
113
$server = RECAPTCHA_API_SECURE_SERVER;
115
$server = RECAPTCHA_API_SERVER;
120
$errorpart = "&error=" . $error;
122
return '<script type="text/javascript" src="'. $server . '/challenge?k=' . $pubkey . $errorpart . '"></script>
125
<iframe src="'. $server . '/noscript?k=' . $pubkey . $errorpart . '" height="300" width="500" frameborder="0"></iframe><br>
126
<textarea name="recaptcha_challenge_field" rows="3" cols="40"></textarea>
127
<input type="hidden" name="recaptcha_response_field" value="manual_challenge">
135
* A ReCaptchaResponse is returned from recaptcha_check_answer()
137
class ReCaptchaResponse {
144
* Calls an HTTP POST function to verify if the user's guess was correct
145
* @param string $privkey
146
* @param string $remoteip
147
* @param string $challenge
148
* @param string $response
149
* @return ReCaptchaResponse
151
function recaptcha_check_answer ($privkey, $remoteip, $challenge, $response)
153
if ($privkey == null || $privkey == '') {
154
die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");
157
if ($remoteip == null || $remoteip == '') {
158
die ("For security reasons, you must pass the remote ip to reCAPTCHA");
163
//discard spam submissions
164
if ($challenge == null || strlen($challenge) == 0 || $response == null || strlen($response) == 0) {
165
$recaptcha_response = new ReCaptchaResponse();
166
$recaptcha_response->is_valid = false;
167
$recaptcha_response->error = 'incorrect-captcha-sol';
168
return $recaptcha_response;
171
$response = _recaptcha_http_post (RECAPTCHA_VERIFY_SERVER, "/verify",
173
'privatekey' => $privkey,
174
'remoteip' => $remoteip,
175
'challenge' => $challenge,
176
'response' => $response
180
$answers = explode ("\n", $response [1]);
181
$recaptcha_response = new ReCaptchaResponse();
183
if (trim ($answers [0]) == 'true') {
184
$recaptcha_response->is_valid = true;
187
$recaptcha_response->is_valid = false;
188
$recaptcha_response->error = $answers [1];
190
return $recaptcha_response;
195
* gets a URL where the user can sign up for reCAPTCHA. If your application
196
* has a configuration page where you enter a key, you should provide a link
197
* using this function.
198
* @param string $domain The domain where the page is hosted
199
* @param string $appname The name of your application
201
function recaptcha_get_signup_url ($domain = null, $appname = null) {
202
return "http://recaptcha.net/api/getkey?" . _recaptcha_qsencode (array ('domain' => $domain, 'app' => $appname));
205
function _recaptcha_aes_pad($val) {
207
$numpad = $block_size - (strlen ($val) % $block_size);
208
return str_pad($val, strlen ($val) + $numpad, chr($numpad));
211
/* Mailhide related code */
213
function _recaptcha_aes_encrypt($val,$ky) {
214
if (! function_exists ("mcrypt_encrypt")) {
215
die ("To use reCAPTCHA Mailhide, you need to have the mcrypt php module installed.");
217
$mode=MCRYPT_MODE_CBC;
218
$enc=MCRYPT_RIJNDAEL_128;
219
$val=_recaptcha_aes_pad($val);
220
return mcrypt_encrypt($enc, $ky, $val, $mode, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");
224
function _recaptcha_mailhide_urlbase64 ($x) {
225
return strtr(base64_encode ($x), '+/', '-_');
228
/* gets the reCAPTCHA Mailhide url for a given email, public key and private key */
229
function recaptcha_mailhide_url($pubkey, $privkey, $email) {
230
if ($pubkey == '' || $pubkey == null || $privkey == "" || $privkey == null) {
231
die ("To use reCAPTCHA Mailhide, you have to sign up for a public and private key, " .
232
"you can do so at <a href='http://mailhide.recaptcha.net/apikey'>http://mailhide.recaptcha.net/apikey</a>");
236
$ky = pack('H*', $privkey);
237
$cryptmail = _recaptcha_aes_encrypt ($email, $ky);
239
return "http://mailhide.recaptcha.net/d?k=" . $pubkey . "&c=" . _recaptcha_mailhide_urlbase64 ($cryptmail);
243
* gets the parts of the email to expose to the user.
244
* eg, given johndoe@example,com return ["john", "example.com"].
245
* the email is then displayed as john...@example.com
247
function _recaptcha_mailhide_email_parts ($email) {
248
$arr = preg_split("/@/", $email );
250
if (strlen ($arr[0]) <= 4) {
251
$arr[0] = substr ($arr[0], 0, 1);
252
} else if (strlen ($arr[0]) <= 6) {
253
$arr[0] = substr ($arr[0], 0, 3);
255
$arr[0] = substr ($arr[0], 0, 4);
261
* Gets html to display an email address given a public an private key.
262
* to get a key, go to:
264
* http://mailhide.recaptcha.net/apikey
266
function recaptcha_mailhide_html($pubkey, $privkey, $email) {
267
$emailparts = _recaptcha_mailhide_email_parts ($email);
268
$url = recaptcha_mailhide_url ($pubkey, $privkey, $email);
270
return htmlentities($emailparts[0]) . "<a href='" . htmlentities ($url) .
271
"' 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]);