plugins/Recaptcha/RecaptchaPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to show reCaptcha when a user registers
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Eric Helgeson <erichelgeson@gmail.com>
  25  * @copyright 2009
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once(INSTALLDIR.'/plugins/Recaptcha/recaptchalib.php');
  35
  36 class RecaptchaPlugin extends Plugin
  37 {
  38     var $private_key;
  39     var $public_key;
  40     var $display_errors;
  41     var $failed;
  42     var $ssl;
  43
  44     function onInitializePlugin()
  45     {
  46         if(!isset($this->private_key)) {
  47             common_log(LOG_ERR, 'Recaptcha: Must specify private_key in config.php');
  48         }
  49         if(!isset($this->public_key)) {
  50             common_log(LOG_ERR, 'Recaptcha: Must specify public_key in config.php');
  51         }
  52     }
  53
  54     function checkssl()
  55     {
  56         if(common_config('site', 'ssl') === 'sometimes' || common_config('site', 'ssl') === 'always') {
  57             return true;
  58         }
  59         return false;
  60     }
  61
  62
  63     function onEndRegistrationFormData($action)
  64     {
  65         $action->elementStart('li');
  66         $action->raw('<label for="recaptcha">Captcha</label>');
  67
  68         // AJAX API will fill this div out.
  69         // We're calling that instead of the regular one so we stay compatible
  70         // with application/xml+xhtml output as for mobile.
  71         $action->element('div', array('id' => 'recaptcha'));
  72         $action->elementEnd('li');
  73
  74         $action->recaptchaPluginNeedsOutput = true;
  75         return true;
  76     }
  77
  78     function onEndShowScripts($action)
  79     {
  80         if (isset($action->recaptchaPluginNeedsOutput) && $action->recaptchaPluginNeedsOutput) {
  81             // Load the AJAX API
  82             if ($this->checkssl()) {
  83                 $url = "https://api-secure.recaptcha.net/js/recaptcha_ajax.js";
  84             } else {
  85                 $url = "http://api.recaptcha.net/js/recaptcha_ajax.js";
  86             }
  87             $action->script($url);
  88
  89             // And when we're ready, fill out the captcha!
  90             $key = json_encode($this->public_key);
  91             $action->inlinescript("\$(function(){Recaptcha.create($key, 'recaptcha');});");
  92         }
  93         return true;
  94     }
  95
  96     function onStartRegistrationTry($action)
  97     {
  98         $resp = recaptcha_check_answer ($this->private_key,
  99                                         $_SERVER["REMOTE_ADDR"],
 100                                         $action->trimmed('recaptcha_challenge_field'),
 101                                         $action->trimmed('recaptcha_response_field'));
 102
 103         if (!$resp->is_valid) {
 104             if($this->display_errors) {
 105                 $action->showForm ("(reCAPTCHA error: " . $resp->error . ")");
 106             }
 107             $action->showForm(_m("Captcha does not match!"));
 108             return false;
 109         }
 110     }
 111
 112     function onPluginVersion(&$versions)
 113     {
 114         $versions[] = array('name' => 'Recaptcha',
 115                             'version' => STATUSNET_VERSION,
 116                             'author' => 'Eric Helgeson',
 117                             'homepage' => 'http://status.net/wiki/Plugin:Recaptcha',
 118                             'rawdescription' =>
 119                             _m('Uses <a href="http://recaptcha.org/">Recaptcha</a> service to add a  '.
 120                                'captcha to the registration page.'));
 121         return true;
 122     }
 123 }