recaptcha.php 19.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?php
/**
 * This is a PHP library that handles calling reCAPTCHA.
 *    - Documentation and latest version
 *          https://developers.google.com/recaptcha/docs/php
 *    - Get a reCAPTCHA API Key
 *          https://www.google.com/recaptcha/admin/create
 *    - Discussion group
 *          http://groups.google.com/group/recaptcha
 *
 * @link      http://www.google.com/recaptcha
 */

14
require_once('config.php');
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
require_once('wp-plugin.php');

if (class_exists('ReCAPTCHAPlugin'))
{
    return;
}

class ReCAPTCHAPlugin extends WPPlugin
{
    private $_saved_error;
    private $_reCaptchaLib;

    /**
     * Php 4 Constructor.
     *
     * @param string $options_name
     */
    function ReCAPTCHAPlugin($options_name) {
        $args = func_get_args();
        call_user_func_array(array(&$this, "__construct"), $args);
    }

    /**
     * Php 5 Constructor.
     *
     * @param string $options_name
     */
    function __construct($options_name) {
        parent::__construct($options_name);
        $this->register_default_options();

        // require the recaptcha library
        $this->_require_library();

        // register the hooks
        $this->register_actions();
        $this->register_filters();
    }

    function register_actions() {
        // load the plugin's textdomain for localization
        add_action('init', array(&$this, 'load_textdomain'));

        // options
        register_activation_hook(WPPlugin::path_to_plugin_directory() .
            '/wp-recaptcha.php',
            array(&$this, 'register_default_options'));
        add_action('admin_init', array(&$this, 'register_settings_group'));

        if ($this->is_multi_blog()) {
            add_action('signup_extra_fields', array(&$this,
                'show_recaptcha_in_registration'));
        } else {
            add_action('register_form', array(&$this,
                'show_recaptcha_in_registration'));
            add_action('bp_before_registration_submit_buttons', array(&$this,
                'show_recaptcha_in_registration'));
            add_action('bp_signup_validate', array(&$this,
                'check_recaptcha_generic'), 0);
        }

        add_action('lostpassword_form', array(&$this,
                'show_recaptcha_in_registration'));
        add_action('lostpassword_post', array(&$this,
                'check_recaptcha_generic'), 0);

        add_action('comment_form', array(&$this, 'show_recaptcha_in_comments'));

        // recaptcha comment processing
        add_action('wp_head', array(&$this, 'saved_comment'), 0);
        add_action('preprocess_comment', array(&$this, 'check_comment'), 0);
        add_action('comment_post_redirect', array(&$this, 'relative_redirect'),
            0, 2);

        // administration (menus, pages, notifications, etc.)
        add_filter("plugin_action_links", array(&$this, 'show_settings_link'),
            10, 2);

        add_action('admin_menu', array(&$this, 'add_settings_page'));
        // admin notices
        add_action('admin_notices', array(&$this, 'missing_keys_notice'));
    }

    function register_filters() {
        if ($this->is_multi_blog()) {
            add_filter('wpmu_validate_user_signup',
                array(&$this, 'validate_recaptcha_response_wpmu'));
        } else {
            add_filter('registration_errors', array(&$this,
                'validate_recaptcha_response'));
        }
    }

    function load_textdomain() {
        load_plugin_textdomain('recaptcha', false, 'languages');
    }

    // set the default options
    function register_default_options() {
114 115 116 117 118 119
        if ($this->options) {
            if ($this->keys_missing()) {
                $this->options['site_key'] = GLOBAL_RECAPTCHA_KEY;
                $this->options['secret'] = GLOBAL_RECAPTCHA_PRIVATE_KEY;
                WPPlugin::add_options($this->options_name, $this->options);
            }
120
            return;
121
        }
122 123 124
        $option_defaults = array();
        $old_options = WPPlugin::retrieve_options("recaptcha");
        if ($old_options) {
125 126
           $option_defaults['site_key'] = $old_options['pubkey'] ? $old_options['pubkey'] : GLOBAL_RECAPTCHA_KEY;
           $option_defaults['secret'] = $old_options['privkey'] ? $old_options['privkey'] : GLOBAL_RECAPTCHA_PRIVATE_KEY;
127 128 129 130 131 132 133 134 135

           // styling
           $option_defaults['recaptcha_language'] = $old_options['re_lang'];

           // error handling
           $option_defaults['no_response_error'] = $old_options['error_blank'];
        } else {
           $old_options = WPPlugin::retrieve_options($this->options_name);
           if ($old_options) {
136 137
               $option_defaults['site_key'] = $old_options['public_key'] ? $old_options['pubkey'] : GLOBAL_RECAPTCHA_KEY;
               $option_defaults['secret'] = $old_options['private_key'] ? $old_options['privkey'] : GLOBAL_RECAPTCHA_PRIVATE_KEY;
138 139 140 141
               $option_defaults['comments_theme'] = 'standard';
               $option_defaults['recaptcha_language'] = $old_options['recaptcha_language'];
               $option_defaults['no_response_error'] = $old_options['no_response_error'];
           } else {           
142 143
               $option_defaults['site_key'] = GLOBAL_RECAPTCHA_KEY;
               $option_defaults['secret'] = GLOBAL_RECAPTCHA_PRIVATE_KEY;
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
               $option_defaults['comments_theme'] = 'standard';
               $option_defaults['recaptcha_language'] = 'en';
               $option_defaults['no_response_error'] =
                   '<strong>ERROR</strong>: Please fill in the reCAPTCHA form.';
           }
        }
        // add the option based on what environment we're in
        WPPlugin::add_options($this->options_name, $option_defaults);
    }

    // require the recaptcha library
    private function _require_library() {
        require_once($this->path_to_plugin_directory() . '/recaptchalib.php');
    }

    // register the settings
    function register_settings_group() {
        register_setting("recaptcha_options_group", 'recaptcha_options',
            array(&$this, 'validate_options'));
    }

    function keys_missing() {
        return (empty($this->options['site_key']) ||
            empty($this->options['secret']));
    }

    function create_error_notice($message, $anchor = '') {
        $options_url = admin_url(
            'options-general.php?page=wp-recaptcha-bp/recaptcha.php') . $anchor;
        $error_message = sprintf(__($message .
            ' <a href="%s" title="WP-reCAPTCHA-bp Options">Fix this</a>',
            'recaptcha'), $options_url);
        echo '<div class="error"><p><strong>' . $error_message .
            '</strong></p></div>';
    }

    function missing_keys_notice() {
181
        /*
182 183 184
        if ($this->keys_missing()) {
            $this->create_error_notice('reCAPTCHA API Keys are missing.');
        }
185
        */
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    }

    function validate_dropdown($array, $key, $value) {
        if (in_array($value, $array)) {
            return $value;
        } else { // if not, load the old value
            return $this->options[$key];
        }
    }

    function validate_options($input) {
        // trim the spaces out of the key
        $validated['site_key'] = trim($input['site_key']);
        $validated['secret'] = trim($input['secret']);

        $themes = array ('standard', 'light', 'dark');
        $validated['comments_theme'] = $this->validate_dropdown($themes,
            'comments_theme', $input['comments_theme']);
        $validated['recaptcha_language'] = $input['recaptcha_language'];
        $validated['no_response_error'] = $input['no_response_error'];
        return $validated;
    }
    // display recaptcha
    function show_recaptcha_in_registration($errors) {
        $escaped_error = htmlentities($_GET['rerror'], ENT_QUOTES);

        // if it's for wordpress mu, show the errors
        if ($this->is_multi_blog()) {
            $error = $errors->get_error_message('captcha');
            echo '<label for="verification">Verification:</label>';
            echo ($error ? '<p class="error">' . $error . '</p>' : '');
            echo $this->get_recaptcha_html();
        } else {        // for regular wordpress
            echo $this->get_recaptcha_html();
        }
    }

    function validate_recaptcha_response($errors) {
        if (empty($_POST['g-recaptcha-response']) ||
            $_POST['g-recaptcha-response'] == '') {
            $errors->add('blank_captcha', $this->options['no_response_error']);
            return $errors;
        }

        if ($this->_reCaptchaLib == null) {
            $this->_reCaptchaLib = new ReCaptcha($this->options['secret']);
        }
        $response = $this->_reCaptchaLib->verifyResponse(
            $_SERVER['REMOTE_ADDR'],
            $_POST['g-recaptcha-response']);

        // response is bad, add incorrect response error
        if (!$response->success)
            $errors->add('captcha_wrong', $response->error);

        return $errors;
    }

    function validate_recaptcha_response_wpmu($result) {
        if (!$this->is_authority()) {
            // blogname in 2.6, blog_id prior to that
            // todo: why is this done?
            if (isset($_POST['blog_id']) || isset($_POST['blogname']))
                return $result;
                    // no text entered
            if (empty($_POST['g-recaptcha-response']) ||
                $_POST['g-recaptcha-response'] == '') {
                $result['errors']->add('blank_captcha',
                    $this->options['no_response_error']);
                return $result['errors'];
            }

            if ($this->_reCaptchaLib == null) {
                $this->_reCaptchaLib = new ReCaptcha($this->options['secret']);
            }
            $response = $this->_reCaptchaLib->verifyResponse(
                $_SERVER['REMOTE_ADDR'],
                $_POST['g-recaptcha-response']);

            // response is bad, add incorrect response error
            if (!$response->success) {
                $result['errors']->add('captcha_wrong', $response->error);
                echo '<div class="error">' . $response->error . '</div>';
            }
                    return $result;
        }
    }
    // utility methods
    function hash_comment($id) {
        define ("RECAPTCHA_WP_HASH_SALT", "b7e0638d85f5d7f3694f68e944136d62");
        if (function_exists('wp_hash'))
            return wp_hash(RECAPTCHA_WP_HASH_SALT . $id);
        else
            return md5(RECAPTCHA_WP_HASH_SALT . $this->options['secret'] . $id);
    }

    function get_recaptcha_html() {
        return '<div class="g-recaptcha" data-sitekey="' .
            $this->options['site_key'] .
            '" data-theme="' . $this->options['comments_theme'] .
            '"></div><script type="text/javascript"' .
            'src="https://www.google.com/recaptcha/api.js?hl=' .
            $this->options['recaptcha_language'] .
            '"></script>';
    }

    function show_recaptcha_in_comments() {
        global $user_ID;

        //modify the comment form for the reCAPTCHA widget
        add_action('wp_footer', array(&$this, 'save_comment_script'));

        $comment_string = <<<COMMENT_FORM
            <div id="recaptcha-submit-btn-area">&nbsp;</div>
            <noscript>
            <style type='text/css'>#submit {display:none;}</style>
            <input name="submit" type="submit" id="submit-alt" tabindex="6"
                value="Submit Comment"/> 
            </noscript>
COMMENT_FORM;

        $use_ssl = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == "on");

        $escaped_error = htmlentities($_GET['rerror'], ENT_QUOTES);

        echo $this->get_recaptcha_html() . $comment_string;
    }

    // this is what does the submit-button re-ordering
    function save_comment_script() {
        $javascript = <<<JS
            <script type="text/javascript">
            var sub = document.getElementById('submit');
            document.getElementById('recaptcha-submit-btn-area').appendChild (sub);
            document.getElementById('submit').tabIndex = 6;
            if ( typeof _recaptcha_wordpress_savedcomment != 'undefined') {
                document.getElementById('comment').value = 
                    _recaptcha_wordpress_savedcomment;
            }
            </script>
JS;
        echo $javascript;
    }

    function check_comment($comment_data) {
        global $user_ID;
        // do not check trackbacks/pingbacks
        if ($comment_data['comment_type'] == '') {
            if ($this->_reCaptchaLib == null) {
                $this->_reCaptchaLib = new ReCaptcha($this->options['secret']);
            }
            $response = $this->_reCaptchaLib->verifyResponse(
                $_SERVER['REMOTE_ADDR'],
                $_POST['g-recaptcha-response']);

            if (!$response->success) {
                $this->_saved_error = $response->error;
                add_filter('pre_comment_approved',
                    create_function('$a', 'return \'spam\';'));
            }
        }
        return $comment_data;
    }

    function check_recaptcha_generic() {
        global $user_ID;
        if ($this->_reCaptchaLib == null) {
            $this->_reCaptchaLib = new ReCaptcha($this->options['secret']);
        }
        $response = $this->_reCaptchaLib->verifyResponse(
            $_SERVER['REMOTE_ADDR'],
            $_POST['g-recaptcha-response']);

        if (!$response->success) {
            $this->_saved_error = $response->error;
            $error = __('Please check the CAPTCHA code. It\'s not correct.', 'g-recaptcha');
            wp_die("<strong>$error</strong>");
            return false;
        }
        return true;
    }

    function relative_redirect($location, $comment) {
        if ($this->_saved_error != '') {
            // replace #comment- at the end of $location with #commentform
                $location = substr($location, 0, strpos($location, '#')) .
                ((strpos($location, "?") === false) ? "?" : "&") .
                'rcommentid=' . $comment->comment_ID .
                '&rerror=' . $this->_saved_error .
                '&rchash=' . $this->hash_comment($comment->comment_ID) .
                '#commentform';
        }
        return $location;
    }

    function saved_comment() {
        if (!is_single() && !is_page())
            return;
        $comment_id = $_REQUEST['rcommentid'];
        $comment_hash = $_REQUEST['rchash'];
        if (empty($comment_id) || empty($comment_hash))
           return;
        if ($comment_hash == $this->hash_comment($comment_id)) {
           $comment = get_comment($comment_id);

           // todo: removed double quote from list of 'dangerous characters'
           $com = preg_replace('/([\\/\(\)\+\;\'])/e',
               '\'%\' . dechex(ord(\'$1\'))',
               $comment->comment_content);
               $com = preg_replace('/\\r\\n/m', '\\\n', $com);
               echo "
            <script type='text/javascript'>
            var _recaptcha_wordpress_savedcomment =  '" . $com  ."';
            _recaptcha_wordpress_savedcomment =
                unescape(_recaptcha_wordpress_savedcomment);
            </script>
            ";

            wp_delete_comment($comment->comment_ID);
        }
    }
 
   // add a settings link to the plugin in the plugin list
    function show_settings_link($links, $file) {
        if ($file == plugin_basename($this->path_to_plugin_directory() .
            '/wp-recaptcha.php')) {
            $settings_title = __('Settings for this Plugin', 'recaptcha');
            $settings = __('Settings', 'recaptcha');
            $settings_link =
               '<a href="options-general.php?page=wp-recaptcha-bp/recaptcha.php"' .
               ' title="' . $settings_title . '">' . $settings . '</a>';
           array_unshift($links, $settings_link);
        }
        return $links;
    }

    // add the settings page
    function add_settings_page() {
        // add the options page
        if ($this->environment == Environment::WordPressMU &&
            $this->is_authority())
            add_submenu_page('wpmu-admin.php', 'WP-reCAPTCHA-bp', 'WP-reCAPTCHA-bp',
                'manage_options', __FILE__, array(&$this, 'show_settings_page'));
            add_options_page('WP-reCAPTCHA-bp', 'WP-reCAPTCHA-bp', 'manage_options',
                 __FILE__, array(&$this, 'show_settings_page'));
        }
        // store the xhtml in a separate file and use include on it
        function show_settings_page() {
        include("settings.php");
    }

    function build_dropdown($name, $keyvalue, $checked_value) {
        echo '<select name="' . $name . '" id="' . $name . '">' . "\n";
        foreach ($keyvalue as $key => $value) {
            $checked = ($value == $checked_value) ?
                ' selected="selected" ' : '';
            echo '\t <option value="' . $value . '"' . $checked .
                ">$key</option> \n";
            $checked = NULL;
        }
        echo "</select> \n";
    }

    function theme_dropdown() {
        $themes = array (
            __('Standard', 'recaptcha') => 'standard',
            __('Light', 'recaptcha') => 'light',
            __('Dark', 'recaptcha') => 'dark'
        );
        $this->build_dropdown('recaptcha_options[comments_theme]', $themes,
            $this->options['comments_theme']);
    }

    function recaptcha_language_dropdown() {
        $languages = array (
            __('English', 'recaptcha') => 'en',
            __('Arabic', 'recaptcha') => 'ar',
            __('Bulgarian', 'recaptcha') => 'bg',
            __('Catalan Valencian', 'recaptcha') => 'ca',
            __('Czech', 'recaptcha') => 'cs',
            __('Danish', 'recaptcha') => 'da',
            __('German', 'recaptcha') => 'de',
            __('Greek', 'recaptcha') => 'el',
            __('British English', 'recaptcha') => 'en_gb',
            __('Spanish', 'recaptcha') => 'es',
            __('Persian', 'recaptcha') => 'fa',
            __('French', 'recaptcha') => 'fr',
            __('Canadian French', 'recaptcha') => 'fr_ca',
            __('Hindi', 'recaptcha') => 'hi',
            __('Croatian', 'recaptcha') => 'hr',
            __('Hungarian', 'recaptcha') => 'hu',
            __('Indonesian', 'recaptcha') => 'id',
            __('Italian', 'recaptcha') => 'it',
            __('Hebrew', 'recaptcha') => 'iw',
            __('Jananese', 'recaptcha') => 'ja',
            __('Korean', 'recaptcha') => 'ko',
            __('Lithuanian', 'recaptcha') => 'lt',
            __('Latvian', 'recaptcha') => 'lv',
            __('Dutch', 'recaptcha') => 'nl',
            __('Norwegian', 'recaptcha') => 'no',
            __('Polish', 'recaptcha') => 'pl',
            __('Portuguese', 'recaptcha') => 'pt',
            __('Romanian', 'recaptcha') => 'ro',
            __('Russian', 'recaptcha') => 'ru',
            __('Slovak', 'recaptcha') => 'sk',
            __('Slovene', 'recaptcha') => 'sl',
            __('Serbian', 'recaptcha') => 'sr',
            __('Swedish', 'recaptcha') => 'sv',
            __('Thai', 'recaptcha') => 'th',
            __('Turkish', 'recaptcha') => 'tr',
            __('Ukrainian', 'recaptcha') => 'uk',
            __('Vietnamese', 'recaptcha') => 'vi',
            __('Simplified Chinese', 'recaptcha') => 'zh_cn',
            __('Traditional Chinese', 'recaptcha') => 'zh_tw'
        );

        $this->build_dropdown('recaptcha_options[recaptcha_language]',
            $languages, $this->options['recaptcha_language']);
    }
} // end class declaration

?>