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')); // styling add_action('wp_head', array(&$this, 'register_stylesheets')); // make unnecessary: instead, inform of classes for styling add_action('admin_head', array(&$this, 'register_stylesheets')); // make unnecessary: shouldn't require styling in the options page if ($this->options['show_in_registration']) add_action('login_head', array(&$this, 'registration_style')); // make unnecessary: instead use jQuery and add to the footer? // options register_activation_hook(WPPlugin::path_to_plugin_directory() . '/wp-recaptcha.php', array(&$this, 'register_default_options')); // this way it only happens once, when the plugin is activated add_action('admin_init', array(&$this, 'register_settings_group')); // only register the hooks if the user wants recaptcha on the registration page if ($this->options['show_in_registration']) { // recaptcha form display 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')); } // only register the hooks if the user wants recaptcha on the comments page if ($this->options['show_in_comments']) { add_action('comment_form', array(&$this, 'show_recaptcha_in_comments')); // recaptcha comment processing (look into doing all of this with AJAX, optionally) 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() { // only register the hooks if the user wants recaptcha on the registration page if ($this->options['show_in_registration']) { // recaptcha validation 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() { if ($this->options) return; $option_defaults = array(); $old_options = WPPlugin::retrieve_options("recaptcha"); if ($old_options) { $option_defaults['public_key'] = $old_options['pubkey']; // the public key for reCAPTCHA $option_defaults['private_key'] = $old_options['privkey']; // the private key for reCAPTCHA // placement $option_defaults['show_in_comments'] = $old_options['re_comments']; // whether or not to show reCAPTCHA on the comment post $option_defaults['show_in_registration'] = $old_options['re_registration']; // whether or not to show reCAPTCHA on the registration page // bypass levels $option_defaults['bypass_for_registered_users'] = ($old_options['re_bypass'] == "on") ? 1 : 0; // whether to skip reCAPTCHAs for registered users $option_defaults['minimum_bypass_level'] = $old_options['re_bypasslevel']; // who doesn't have to do the reCAPTCHA (should be a valid WordPress capability slug) if ($option_defaults['minimum_bypass_level'] == "level_10") { $option_defaults['minimum_bypass_level'] = "activate_plugins"; } // styling $option_defaults['comments_theme'] = $old_options['re_theme']; // the default theme for reCAPTCHA on the comment post $option_defaults['registration_theme'] = $old_options['re_theme_reg']; // the default theme for reCAPTCHA on the registration form $option_defaults['recaptcha_language'] = $old_options['re_lang']; // the default language for reCAPTCHA $option_defaults['xhtml_compliance'] = $old_options['re_xhtml']; // whether or not to be XHTML 1.0 Strict compliant $option_defaults['comments_tab_index'] = $old_options['re_tabindex']; // the default tabindex for reCAPTCHA $option_defaults['registration_tab_index'] = 30; // the default tabindex for reCAPTCHA // error handling $option_defaults['no_response_error'] = $old_options['error_blank']; // message for no CAPTCHA response $option_defaults['incorrect_response_error'] = $old_options['error_incorrect']; // message for incorrect CAPTCHA response } else { // keys $option_defaults['public_key'] = ''; // the public key for reCAPTCHA $option_defaults['private_key'] = ''; // the private key for reCAPTCHA // placement $option_defaults['show_in_comments'] = 1; // whether or not to show reCAPTCHA on the comment post $option_defaults['show_in_registration'] = 1; // whether or not to show reCAPTCHA on the registration page // bypass levels $option_defaults['bypass_for_registered_users'] = 1; // whether to skip reCAPTCHAs for registered users $option_defaults['minimum_bypass_level'] = 'read'; // who doesn't have to do the reCAPTCHA (should be a valid WordPress capability slug) // styling $option_defaults['comments_theme'] = 'red'; // the default theme for reCAPTCHA on the comment post $option_defaults['registration_theme'] = 'red'; // the default theme for reCAPTCHA on the registration form $option_defaults['recaptcha_language'] = 'en'; // the default language for reCAPTCHA $option_defaults['xhtml_compliance'] = 0; // whether or not to be XHTML 1.0 Strict compliant $option_defaults['comments_tab_index'] = 5; // the default tabindex for reCAPTCHA $option_defaults['registration_tab_index'] = 30; // the default tabindex for reCAPTCHA // error handling $option_defaults['no_response_error'] = 'ERROR: Please fill in the reCAPTCHA form.'; // message for no CAPTCHA response $option_defaults['incorrect_response_error'] = 'ERROR: That reCAPTCHA response was incorrect.'; // message for incorrect CAPTCHA response } // add the option based on what environment we're in WPPlugin::add_options($this->options_name, $option_defaults); } // require the recaptcha library 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')); } // todo: make unnecessary function register_stylesheets() { $path = WPPlugin::url_to_plugin_directory() . '/recaptcha.css'; echo ''; } // stylesheet information // todo: this 'hack' isn't nice, try to figure out a workaround function registration_style() { $width = 0; // the width of the recaptcha form // every theme is 358 pixels wide except for the clean theme, so we have to programmatically handle that if ($this->options['registration_theme'] == 'clean') $width = 485; else $width = 360; echo << window.onload = function() { document.getElementById('login').style.width = '{$width}px'; document.getElementById('reg_passmail').style.marginTop = '10px'; document.getElementById('recaptcha_widget_div').style.marginBottom = '10px'; }; REGISTRATION; } function recaptcha_enabled() { return ($this->options['show_in_comments'] || $this->options['show_in_registration']); } function keys_missing() { return (empty($this->options['public_key']) || empty($this->options['private_key'])); } function create_error_notice($message, $anchor = '') { $options_url = admin_url('options-general.php?page=wp-recaptcha/recaptcha.php') . $anchor; $error_message = sprintf(__($message . ' Fix this', 'recaptcha'), $options_url); echo '

' . $error_message . '

'; } function missing_keys_notice() { if ($this->recaptcha_enabled() && $this->keys_missing()) { $this->create_error_notice('You enabled reCAPTCHA, but some of the reCAPTCHA API Keys seem to be missing.'); } } function validate_dropdown($array, $key, $value) { // make sure that the capability that was supplied is a valid capability from the drop-down list if (in_array($value, $array)) return $value; else // if not, load the old value return $this->options[$key]; } function validate_options($input) { // todo: make sure that 'incorrect_response_error' is not empty, prevent from being empty in the validation phase // trim the spaces out of the key, as they are usually present when copied and pasted // todo: keys seem to usually be 40 characters in length, verify and if confirmed, add to validation process $validated['public_key'] = trim($input['public_key']); $validated['private_key'] = trim($input['private_key']); $validated['show_in_comments'] = ($input['show_in_comments'] == 1 ? 1 : 0); $validated['bypass_for_registered_users'] = ($input['bypass_for_registered_users'] == 1 ? 1: 0); $capabilities = array ('read', 'edit_posts', 'publish_posts', 'moderate_comments', 'activate_plugins'); $themes = array ('red', 'white', 'blackglass', 'clean'); $recaptcha_languages = array ('en', 'nl', 'fr', 'de', 'pt', 'ru', 'es', 'tr'); $validated['minimum_bypass_level'] = $this->validate_dropdown($capabilities, 'minimum_bypass_level', $input['minimum_bypass_level']); $validated['comments_theme'] = $this->validate_dropdown($themes, 'comments_theme', $input['comments_theme']); $validated['comments_tab_index'] = $input['comments_tab_index'] ? $input["comments_tab_index"] : 5; // use the intval filter $validated['show_in_registration'] = ($input['show_in_registration'] == 1 ? 1 : 0); $validated['registration_theme'] = $this->validate_dropdown($themes, 'registration_theme', $input['registration_theme']); $validated['registration_tab_index'] = $input['registration_tab_index'] ? $input["registration_tab_index"] : 30; // use the intval filter $validated['recaptcha_language'] = $this->validate_dropdown($recaptcha_languages, 'recaptcha_language', $input['recaptcha_language']); $validated['xhtml_compliance'] = ($input['xhtml_compliance'] == 1 ? 1 : 0); $validated['no_response_error'] = $input['no_response_error']; $validated['incorrect_response_error'] = $input['incorrect_response_error']; return $validated; } // display recaptcha function show_recaptcha_in_registration($errors) { $format = << var RecaptchaOptions = { theme : '{$this->options['registration_theme']}', lang : '{$this->options['recaptcha_language']}' , tabindex : {$this->options['registration_tab_index']} }; FORMAT; $comment_string = << document.getElementById('recaptcha_table').style.direction = 'ltr'; COMMENT_FORM; // todo: is this check necessary? look at the latest recaptchalib.php if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == "on") $use_ssl = true; else $use_ssl = false; $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 'Verification:'; echo ($error ? '

'.$error.'

' : ''); echo $format . $this->get_recaptcha_html($escaped_error, $use_ssl); } // for regular wordpress else { echo $format . $this->get_recaptcha_html($escaped_error, $use_ssl); } } function validate_recaptcha_response($errors) { // empty so throw the empty response error if (empty($_POST['recaptcha_response_field']) || $_POST['recaptcha_response_field'] == '') { $errors->add('blank_captcha', $this->options['no_response_error']); return $errors; } $response = recaptcha_check_answer($this->options['private_key'], $_SERVER['REMOTE_ADDR'], $_POST['recaptcha_challenge_field'], $_POST['recaptcha_response_field']); // response is bad, add incorrect response error if (!$response->is_valid) if ($response->error == 'incorrect-captcha-sol') $errors->add('captcha_wrong', $this->options['incorrect_response_error']); return $errors; } function validate_recaptcha_response_wpmu($result) { // must make a check here, otherwise the wp-admin/user-new.php script will keep trying to call // this function despite not having called do_action('signup_extra_fields'), so the recaptcha // field was never shown. this way it won't validate if it's called in the admin interface 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['recaptcha_response_field']) || $_POST['recaptcha_response_field'] == '') { $result['errors']->add('blank_captcha', $this->options['no_response_error']); return $result; } $response = recaptcha_check_answer($this->options['private_key'], $_SERVER['REMOTEADDR'], $_POST['recaptcha_challenge_field'], $_POST['recaptcha_response_field']); // response is bad, add incorrect response error // todo: why echo the error here? wpmu specific? if (!$response->is_valid) if ($response->error == 'incorrect-captcha-sol') { $result['errors']->add('captcha_wrong', $this->options['incorrect_response_error']); echo '

' . $this->options['incorrect_response_error'] . '

'; } 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['private_key'] . $id); } function get_recaptcha_html($recaptcha_error, $use_ssl=false) { return recaptcha_get_html($this->options['public_key'], $recaptcha_error, $use_ssl, $this->options['xhtml_compliance']); } function show_recaptcha_in_comments() { global $user_ID; // set the minimum capability needed to skip the captcha if there is one if (isset($this->options['bypass_for_registered_users']) && $this->options['bypass_for_registered_users'] && $this->options['minimum_bypass_level']) $needed_capability = $this->options['minimum_bypass_level']; // skip the reCAPTCHA display if the minimum capability is met if ((isset($needed_capability) && $needed_capability && current_user_can($needed_capability)) || !$this->options['show_in_comments']) return; else { // Did the user fail to match the CAPTCHA? If so, let them know if ((isset($_GET['rerror']) && $_GET['rerror'] == 'incorrect-captcha-sol')) echo '

' . $this->options['incorrect_response_error'] . "

"; //modify the comment form for the reCAPTCHA widget $recaptcha_js_opts = << var RecaptchaOptions = { theme : '{$this->options['comments_theme']}', lang : '{$this->options['recaptcha_language']}' , tabindex : {$this->options['comments_tab_index']} }; OPTS; add_action('wp_footer', array(&$this, 'save_comment_script')); // preserve the comment that was entered // todo: replace this with jquery: http://digwp.com/2009/06/including-jquery-in-wordpress-the-right-way/ // todo: use math to increment+1 the submit button based on what the tab_index option is if ($this->options['xhtml_compliance']) { $comment_string = << COMMENT_FORM; } else { $comment_string = <<

#submit {display:none;}

COMMENT_FORM; } $use_ssl = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == "on"); $escaped_error = htmlentities($_GET['rerror'], ENT_QUOTES); echo $recaptcha_js_opts . $this->get_recaptcha_html(isset($escaped_error) ? $escaped_error : null, $use_ssl) . $comment_string; } } // this is what does the submit-button re-ordering function save_comment_script() { $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; } document.getElementById('recaptcha_table').style.direction = 'ltr'; JS; echo $javascript; } // todo: this doesn't seem necessary function show_captcha_for_comment() { global $user_ID; return true; } function check_comment($comment_data) { global $user_ID; if ($this->options['bypass_for_registered_users'] && $this->options['minimum_bypass_level']) $needed_capability = $this->options['minimum_bypass_level']; if (($needed_capability && current_user_can($needed_capability)) || !$this->options['show_in_comments']) return $comment_data; if ($this->show_captcha_for_comment()) { // do not check trackbacks/pingbacks if ($comment_data['comment_type'] == '') { $challenge = $_POST['recaptcha_challenge_field']; $response = $_POST['recaptcha_response_field']; $recaptcha_response = recaptcha_check_answer($this->options['private_key'], $_SERVER['REMOTE_ADDR'], $challenge, $response); if ($recaptcha_response->is_valid) return $comment_data; else { $this->saved_error = $recaptcha_response->error; // http://codex.wordpress.org/Plugin_API/Filter_Reference#Database_Writes_2 add_filter('pre_comment_approved', create_function('$a', 'return \'spam\';')); return $comment_data; } } } return $comment_data; } 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 " "; wp_delete_comment($comment->comment_ID); } } // todo: is this still needed? // this is used for the api keys url in the administration interface function blog_domain() { $uri = parse_url(get_option('siteurl')); return $uri['host']; } // 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 = '' . $settings . ''; 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', 'WP-reCAPTCHA', 'manage_options', __FILE__, array(&$this, 'show_settings_page')); /* re-add when we figure out a way to add network-wide settings in ms if ($this->environment == Environment::WordPressMS && $this->is_authority()) add_submenu_page('ms-admin.php', 'WP-reCAPTCHA', 'WP-reCAPTCHA', 'manage_options', __FILE__, array(&$this, 'show_settings_page')); */ add_options_page('WP-reCAPTCHA', 'WP-reCAPTCHA', '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 ' \n"; } function capabilities_dropdown() { // define choices: Display text => permission slug $capabilities = array ( __('all registered users', 'recaptcha') => 'read', __('edit posts', 'recaptcha') => 'edit_posts', __('publish posts', 'recaptcha') => 'publish_posts', __('moderate comments', 'recaptcha') => 'moderate_comments', __('activate plugins', 'recaptcha') => 'activate_plugins' ); $this->build_dropdown('recaptcha_options[minimum_bypass_level]', $capabilities, $this->options['minimum_bypass_level']); } function theme_dropdown($which) { $themes = array ( __('Red', 'recaptcha') => 'red', __('White', 'recaptcha') => 'white', __('Black Glass', 'recaptcha') => 'blackglass', __('Clean', 'recaptcha') => 'clean' ); if ($which == 'comments') $this->build_dropdown('recaptcha_options[comments_theme]', $themes, $this->options['comments_theme']); else if ($which == 'registration') $this->build_dropdown('recaptcha_options[registration_theme]', $themes, $this->options['registration_theme']); } function recaptcha_language_dropdown() { $languages = array ( __('English', 'recaptcha') => 'en', __('Dutch', 'recaptcha') => 'nl', __('French', 'recaptcha') => 'fr', __('German', 'recaptcha') => 'de', __('Portuguese', 'recaptcha') => 'pt', __('Russian', 'recaptcha') => 'ru', __('Spanish', 'recaptcha') => 'es', __('Turkish', 'recaptcha') => 'tr' ); $this->build_dropdown('recaptcha_options[recaptcha_language]', $languages, $this->options['recaptcha_language']); } } // end class declaration } // end of class exists clause ?>