some corrections, only very minor things.

git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@9554 89ea8834-ac86-4346-8a33-228a782c2dd0

phpBB/includes/captcha/plugins/captcha_abstract.php

@@ -18,7 +18,9 @@ if (!defined('IN_PHPBB'))
 
 
 /**
-* This class holds the code shared by the two default 3.0 CAPTCHAs.
+* This class holds the code shared by the two default 3.0.x CAPTCHAs.
+*
+* @package VC
 */
 class phpbb_default_captcha
 {
@@ -29,18 +31,17 @@ class phpbb_default_captcha
 	var $type;
 	var $solved = false;
 
-
 	function init($type)
 	{
 		global $config, $db, $user;
-		
+
 		// read input
 		$this->confirm_id = request_var('confirm_id', '');
 		$this->confirm_code = request_var('confirm_code', '');
 		$refresh = request_var('refresh_vc', false) && $config['confirm_refresh'];
-		
+
 		$this->type = (int) $type;
-		
+
 		if (!strlen($this->confirm_id))
 		{
 			// we have no confirm ID, better get ready to display something
@@ -50,24 +51,22 @@ class phpbb_default_captcha
 		{
 			$this->regenerate_code();
 		}
-
 	}
-	
+
 	function execute_demo()
 	{
 		global $user;
-	
-		$this->code = gen_rand_string(mt_rand(5, 8));
+
+		$this->code = gen_rand_string(mt_rand(CAPTCHA_MIN_CHARS, CAPTCHA_MAX_CHARS));
 		$this->seed = hexdec(substr(unique_id(), 4, 10));
-				
+
 		// compute $seed % 0x7fffffff
 		$this->seed -= 0x7fffffff * floor($this->seed / 0x7fffffff);
-		
+
 		$captcha = new captcha();
 		$captcha->execute($this->code, $this->seed);
 	}
-	
-	
+
 	function execute()
 	{
 		if (empty($this->code))
@@ -81,46 +80,46 @@ class phpbb_default_captcha
 		$captcha = new captcha();
 		$captcha->execute($this->code, $this->seed);
 	}
-	
-	
+
 	function get_template()
 	{
 		global $config, $user, $template, $phpEx, $phpbb_root_path;
-		
+
 		$template->set_filenames(array(
 			'captcha' => 'captcha_default.html')
 		);
-		
+
 		$template->assign_vars(array(
 			'CONFIRM_IMAGE'				=> append_sid($phpbb_root_path . 'ucp.' . $phpEx . '?mode=confirm&confirm_id=' . $this->confirm_id . '&type=' . $this->type),
-			'CONFIRM_ID'				=> $this->confirm_id,			
+			'CONFIRM_ID'				=> $this->confirm_id,
 			'S_REFRESH'					=> (bool) $config['confirm_refresh'],
 
 		));
-	
+
 		return $template->assign_display('captcha');
 	}
-	
+
 	function get_demo_template($id)
 	{
 		global $config, $user, $template, $phpbb_admin_path, $phpEx;
-		
+
 		$template->set_filenames(array(
 			'captcha_demo' => 'captcha_default_acp_demo.html')
 		);
+
 		// acp_captcha has a delivery function; let's use it
 		$template->assign_vars(array(
 			'CONFIRM_IMAGE'		=> append_sid($phpbb_admin_path . 'index.' . $phpEx . '?captcha_demo=1&mode=visual&i=' . $id . '&select_captcha=' . $this->get_class_name()),
 			'CONFIRM_ID'		=> $this->confirm_id,
 		));
-		
+
 		return $template->assign_display('captcha_demo');
 	}
-		
+
 	function get_hidden_fields()
 	{
 		$hidden_fields = array();
-		
+
 		// this is required for postig.php - otherwise we would forget about the captcha being already solved
 		if ($this->solved)
 		{
@@ -129,16 +128,16 @@ class phpbb_default_captcha
 		$hidden_fields['confirm_id'] = $this->confirm_id;
 		return $hidden_fields;
 	}
-	
+
 	function garbage_collect($type)
 	{
 		global $db, $config;
 
 		$sql = 'SELECT DISTINCT c.session_id
-				FROM ' . CONFIRM_TABLE . ' c
-				LEFT JOIN ' . SESSIONS_TABLE . ' s ON (c.session_id = s.session_id)
-				WHERE s.session_id IS NULL' .
-					((empty($type)) ? '' : ' AND c.confirm_type = ' . (int) $type);
+			FROM ' . CONFIRM_TABLE . ' c
+			LEFT JOIN ' . SESSIONS_TABLE . ' s ON (c.session_id = s.session_id)
+			WHERE s.session_id IS NULL' .
+				((empty($type)) ? '' : ' AND c.confirm_type = ' . (int) $type);
 		$result = $db->sql_query($sql);
 
 		if ($row = $db->sql_fetchrow($result))
@@ -159,21 +158,21 @@ class phpbb_default_captcha
 		}
 		$db->sql_freeresult($result);
 	}
-	
+
 	function uninstall()
 	{
-		self::garbage_collect(0);
+		$this->garbage_collect(0);
 	}
-	
+
 	function install()
 	{
 		return;
 	}
-	
+
 	function validate()
 	{
 		global $config, $db, $user;
-		
+
 		$this->confirm_code = request_var('confirm_code', '');
 		if (!$this->confirm_id)
 		{
@@ -191,10 +190,10 @@ class phpbb_default_captcha
 				$error = $user->lang['CONFIRM_CODE_WRONG'];
 			}
 		}
-	
+
 		if (strlen($error))
 		{
-			// okay, inorect answer. Let's ask a new question
+			// okay, incorrect answer. Let's ask a new question.
 			$this->generate_code();
 			return $error;
 		}
@@ -203,16 +202,15 @@ class phpbb_default_captcha
 			return false;
 		}
 	}
-	
-	
+
 	/**
 	* The old way to generate code, suitable for GD and non-GD. Resets the internal state.
 	*/
 	function generate_code()
 	{
 		global $db, $user;
-		
-		$this->code = gen_rand_string(mt_rand(5, 8));
+
+		$this->code = gen_rand_string(mt_rand(CAPTCHA_MIN_CHARS, CAPTCHA_MAX_CHARS));
 		$this->confirm_id = md5(unique_id($user->ip));
 		$this->seed = hexdec(substr(unique_id(), 4, 10));
 		$this->solved = false;
@@ -228,19 +226,20 @@ class phpbb_default_captcha
 		);
 		$db->sql_query($sql);
 	}
-	
+
 	/**
 	* New Question, if desired.
 	*/
 	function regenerate_code()
 	{
 		global $db, $user;
-		
-		$this->code = gen_rand_string(mt_rand(5, 8));
+
+		$this->code = gen_rand_string(mt_rand(CAPTCHA_MIN_CHARS, CAPTCHA_MAX_CHARS));
 		$this->seed = hexdec(substr(unique_id(), 4, 10));
 		$this->solved = false;
 		// compute $seed % 0x7fffffff
 		$this->seed -= 0x7fffffff * floor($this->seed / 0x7fffffff);
+
 		$sql = 'UPDATE ' . CONFIRM_TABLE . ' SET ' . $db->sql_build_array('UPDATE', array(
 				'code'			=> (string) $this->code,
 				'seed'			=> (int) $this->seed)) . '
@@ -249,35 +248,37 @@ class phpbb_default_captcha
 				session_id = \'' . $db->sql_escape($user->session_id) . '\'';
 		$db->sql_query($sql);
 	}
-	
+
 	/**
-	* Look up everything we need for painting&checking. 
+	* Look up everything we need for painting&checking.
 	*/
 	function load_code()
 	{
 		global $db, $user;
+
 		$sql = 'SELECT code, seed
-				FROM ' . CONFIRM_TABLE . "
-				WHERE confirm_id = '" . $db->sql_escape($this->confirm_id) . "'
-				AND session_id = '" . $db->sql_escape($user->session_id) . "'
-					AND confirm_type = " . $this->type;
+			FROM ' . CONFIRM_TABLE . "
+			WHERE confirm_id = '" . $db->sql_escape($this->confirm_id) . "'
+			AND session_id = '" . $db->sql_escape($user->session_id) . "'
+				AND confirm_type = " . $this->type;
 		$result = $db->sql_query($sql);
 		$row = $db->sql_fetchrow($result);
 		$db->sql_freeresult($result);
+
 		if ($row)
 		{
 			$this->code = $row['code'];
 			$this->seed = $row['seed'];
 			return true;
 		}
+
 		return false;
-		
 	}
-	
+
 	function check_code()
 	{
 		global $db;
-		
+
 		if (empty($this->code))
 		{
 			if (!$this->load_code())
@@ -287,47 +288,45 @@ class phpbb_default_captcha
 		}
 		return (strcasecmp($this->code, $this->confirm_code) === 0);
 	}
-	
+
 	function delete_code()
 	{
 		global $db, $user;
-		
+
 		$sql = 'DELETE FROM ' . CONFIRM_TABLE . "
-				WHERE confirm_id = '" . $db->sql_escape($confirm_id) . "'
-					AND session_id = '" . $db->sql_escape($user->session_id) . "'
-					AND confirm_type = " . $this->type;
+			WHERE confirm_id = '" . $db->sql_escape($confirm_id) . "'
+				AND session_id = '" . $db->sql_escape($user->session_id) . "'
+				AND confirm_type = " . $this->type;
 		$db->sql_query($sql);
 	}
-	
+
 	function get_attempt_count()
 	{
 		global $db, $user;
-		
+
 		$sql = 'SELECT COUNT(session_id) AS attempts
-				FROM ' . CONFIRM_TABLE . "
-				WHERE session_id = '" . $db->sql_escape($user->session_id) . "'
-					AND confirm_type = " . $this->type;
+			FROM ' . CONFIRM_TABLE . "
+			WHERE session_id = '" . $db->sql_escape($user->session_id) . "'
+				AND confirm_type = " . $this->type;
 		$result = $db->sql_query($sql);
 		$attempts = (int) $db->sql_fetchfield('attempts');
 		$db->sql_freeresult($result);
-		
+
 		return $attempts;
 	}
-	
-	
+
 	function reset()
 	{
 		global $db, $user;
-		
+
 		$sql = 'DELETE FROM ' . CONFIRM_TABLE . "
-					WHERE session_id = '" . $db->sql_escape($user->session_id) . "'
-						AND confirm_type = " . (int) $this->type;
+			WHERE session_id = '" . $db->sql_escape($user->session_id) . "'
+				AND confirm_type = " . (int) $this->type;
 		$db->sql_query($sql);
-		
+
 		// we leave the class usable by generating a new question
 		$this->generate_code();
 	}
-	
 }
 
 ?>

phpBB/includes/captcha/plugins/phpbb_captcha_gd_plugin.php

@@ -16,7 +16,7 @@ if (!defined('IN_PHPBB'))
 	exit;
 }
 
-/** 
+/**
 * Placeholder for autoload
 */
 if (!class_exists('phpbb_default_captcha'))
@@ -24,6 +24,9 @@ if (!class_exists('phpbb_default_captcha'))
 	include($phpbb_root_path . 'includes/captcha/plugins/captcha_abstract.' . $phpEx);
 }
 
+/**
+* @package VC
+*/
 class phpbb_captcha_gd extends phpbb_default_captcha
 {
 	function phpbb_captcha_gd()
@@ -35,7 +38,7 @@ class phpbb_captcha_gd extends phpbb_default_captcha
 			include($phpbb_root_path . 'includes/captcha/captcha_gd.' . $phpEx);
 		}
 	}
-	
+
 	function get_instance()
 	{
 		return new phpbb_captcha_gd();
@@ -45,17 +48,17 @@ class phpbb_captcha_gd extends phpbb_default_captcha
 	{
 		return (@extension_loaded('gd') || can_load_dll('gd'));
 	}
-	
+
 	function get_name()
 	{
 		return 'CAPTCHA_GD';
 	}
-	
+
 	function get_class_name()
 	{
 		return 'phpbb_captcha_gd';
 	}
-		
+
 	function acp_page($id, &$module)
 	{
 		global $db, $user, $auth, $template;
@@ -80,7 +83,6 @@ class phpbb_captcha_gd extends phpbb_default_captcha
 			'captcha_gd'			=> 'CAPTCHA_GD',
 		);
 
-
 		$module->tpl_name = 'captcha_gd_acp';
 		$module->page_title = 'ACP_VC_SETTINGS';
 		$form_key = 'acp_captcha';
@@ -112,11 +114,11 @@ class phpbb_captcha_gd extends phpbb_default_captcha
 				$var = (isset($_REQUEST[$captcha_var])) ? request_var($captcha_var, 0) : $config[$captcha_var];
 				$template->assign_var($template_var, $var);
 			}
+
 			$template->assign_vars(array(
 				'CAPTCHA_PREVIEW'	=> $this->get_demo_template($id),
 				'CAPTCHA_NAME'		=> $this->get_class_name(),
 			));
-
 		}
 	}
 }

phpBB/includes/captcha/plugins/phpbb_captcha_gd_wave_plugin.php

@@ -24,6 +24,9 @@ if (!class_exists('captcha_abstract'))
 	include_once($phpbb_root_path . 'includes/captcha/plugins/captcha_abstract.' . $phpEx);
 }
 
+/**
+* @package VC
+*/
 class phpbb_captcha_gd_wave extends phpbb_default_captcha
 {
 
@@ -60,7 +63,7 @@ class phpbb_captcha_gd_wave extends phpbb_default_captcha
 	function acp_page($id, &$module)
 	{
 		global $config, $db, $template, $user;
-		
+
 		trigger_error($user->lang['CAPTCHA_NO_OPTIONS'] . adm_back_link($module->u_action));
 	}
 }

phpBB/includes/captcha/plugins/phpbb_captcha_nogd_plugin.php

@@ -16,7 +16,7 @@ if (!defined('IN_PHPBB'))
 	exit;
 }
 
-/** 
+/**
 * Placeholder for autoload
 */
 if (!class_exists('phpbb_default_captcha'))
@@ -24,6 +24,9 @@ if (!class_exists('phpbb_default_captcha'))
 	include_once($phpbb_root_path . 'includes/captcha/plugins/captcha_abstract.' . $phpEx);
 }
 
+/**
+* @package VC
+*/
 class phpbb_captcha_nogd extends phpbb_default_captcha
 {
 
@@ -36,7 +39,7 @@ class phpbb_captcha_nogd extends phpbb_default_captcha
 			include_once($phpbb_root_path . 'includes/captcha/captcha_non_gd.' . $phpEx);
 		}
 	}
-	
+
 	function get_instance()
 	{
 		return new phpbb_captcha_nogd();
@@ -46,25 +49,23 @@ class phpbb_captcha_nogd extends phpbb_default_captcha
 	{
 		return true;
 	}
-	
+
 	function get_name()
 	{
-		global $user;
-		
-		return 'CAPTCHA_NO_GD'; 
+		return 'CAPTCHA_NO_GD';
 	}
-	
+
 	function get_class_name()
 	{
 		return 'phpbb_captcha_nogd';
 	}
-	
-	
+
 	function acp_page($id, &$module)
 	{
 		global $user;
-		
+
 		trigger_error($user->lang['CAPTCHA_NO_OPTIONS'] . adm_back_link($module->u_action));
 	}
 }
 
+?>

phpBB/includes/captcha/plugins/phpbb_recaptcha_plugin.php

@@ -22,6 +22,9 @@ if (!class_exists('phpbb_default_captcha'))
 	include_once($phpbb_root_path . 'includes/captcha/plugins/captcha_abstract.' . $phpEx);
 }
 
+/**
+* @package VC
+*/
 class phpbb_recaptcha extends phpbb_default_captcha
 {
 	var $recaptcha_server = 'http://api.recaptcha.net';
@@ -29,18 +32,16 @@ class phpbb_recaptcha extends phpbb_default_captcha
 	var $challenge;
 	var $response;
 
-	
 	function init($type)
 	{
 		global $config, $db, $user;
-		
+
 		$user->add_lang('recaptcha');
 		parent::init($type);
 		$this->challenge = request_var('recaptcha_challenge_field', '');
 		$this->response = request_var('recaptcha_response_field', '');
 	}
-	
-	
+
 	function get_instance()
 	{
 		return new phpbb_recaptcha();
@@ -48,25 +49,25 @@ class phpbb_recaptcha extends phpbb_default_captcha
 
 	function is_available()
 	{
-		global $config, $user; 
+		global $config, $user;
 		$user->add_lang('recaptcha');
 		return (isset($config['recaptcha_pubkey']) && !empty($config['recaptcha_pubkey']));
 	}
-	
+
 	function get_name()
 	{
 		return 'CAPTCHA_RECAPTCHA';
 	}
-	
+
 	function get_class_name()
 	{
 		return 'phpbb_recaptcha';
 	}
-		
+
 	function acp_page($id, &$module)
 	{
 		global $config, $db, $template, $user;
-		
+
 		$captcha_vars = array(
 			'recaptcha_pubkey'				=> 'RECAPTCHA_PUBKEY',
 			'recaptcha_privkey'				=> 'RECAPTCHA_PRIVKEY',
@@ -103,6 +104,7 @@ class phpbb_recaptcha extends phpbb_default_captcha
 				$var = (isset($_REQUEST[$captcha_var])) ? request_var($captcha_var, '') : ((isset($config[$captcha_var])) ? $config[$captcha_var] : '');
 				$template->assign_var($template_var, $var);
 			}
+
 			$template->assign_vars(array(
 				'CAPTCHA_PREVIEW'	=> $this->get_demo_template($id),
 				'CAPTCHA_NAME'		=> $this->get_class_name(),
@@ -110,47 +112,44 @@ class phpbb_recaptcha extends phpbb_default_captcha
 
 		}
 	}
-	
-	
+
 	// not needed
 	function execute_demo()
 	{
 	}
-	
-	
+
 	// not needed
 	function execute()
 	{
 	}
-	
-	
+
 	function get_template()
 	{
 		global $config, $user, $template;
-		
+
 		$template->set_filenames(array(
 			'captcha' => 'captcha_recaptcha.html')
 		);
-		
+
 		$template->assign_vars(array(
 			'RECAPTCHA_SERVER'			=> $this->recaptcha_server,
 			'RECAPTCHA_PUBKEY'			=> isset($config['recaptcha_pubkey']) ? $config['recaptcha_pubkey'] : '',
 			'RECAPTCHA_ERRORGET'		=> '',
 			'S_RECAPTCHA_AVAILABLE'		=> $this->is_available(),
 		));
-	
+
 		return $template->assign_display('captcha');
 	}
-	
+
 	function get_demo_template($id)
 	{
 		return $this->get_template();
 	}
-		
+
 	function get_hidden_fields()
 	{
 		$hidden_fields = array();
-		
+
 		// this is required for postig.php - otherwise we would forget about the captcha being already solved
 		if ($this->solved)
 		{
@@ -159,17 +158,17 @@ class phpbb_recaptcha extends phpbb_default_captcha
 		$hidden_fields['confirm_id'] = $this->confirm_id;
 		return $hidden_fields;
 	}
-		
+
 	function uninstall()
 	{
-		self::garbage_collect(0);
+		$this->garbage_collect(0);
 	}
-	
+
 	function install()
 	{
 		return;
 	}
-	
+
 	function validate()
 	{
 		if (!parent::validate())
@@ -181,7 +180,6 @@ class phpbb_recaptcha extends phpbb_default_captcha
 			return $this->recaptcha_check_answer();
 		}
 	}
-	
 
 // Code from here on is based on recaptchalib.php
 /*
@@ -218,14 +216,14 @@ class phpbb_recaptcha extends phpbb_default_captcha
  */
 
 	/**
-	 * 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) 
+	* 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 = $this->_recaptcha_qsencode ($data);
 
@@ -238,52 +236,56 @@ class phpbb_recaptcha extends phpbb_default_captcha
 		$http_request .= $req;
 
 		$response = '';
-		if( false == ( $fs = @fsockopen($host, $port, $errno, $errstr, 10) ) ) {
-				die ('Could not open socket');
+		if (false == ($fs = @fsockopen($host, $port, $errno, $errstr, 10)))
+		{
+			trigger_error('Could not open socket', E_USER_ERROR);
 		}
 
 		fwrite($fs, $http_request);
 
-		while ( !feof($fs) )
-				$response .= fgets($fs, 1160); // One TCP-IP packet
+		while (!feof($fs))
+		{
+			// One TCP-IP packet
+			$response .= fgets($fs, 1160);
+		}
 		fclose($fs);
 		$response = explode("\r\n\r\n", $response, 2);
 
 		return $response;
 	}
 
-
 	/**
-	  * Calls an HTTP POST function to verify if the user's guess was correct
-	  * @param array $extra_params an array of extra variables to post to the server
-	  * @return ReCaptchaResponse
-	  */
-	function recaptcha_check_answer ($extra_params = array())
+	* Calls an HTTP POST function to verify if the user's guess was correct
+	* @param array $extra_params an array of extra variables to post to the server
+	* @return ReCaptchaResponse
+	*/
+	function recaptcha_check_answer($extra_params = array())
 	{
 		global $config, $user;
+
 		//discard spam submissions
-		if ($this->challenge == null || strlen($this->challenge) == 0 || $this->response == null || strlen($this->response) == 0) 
+		if ($this->challenge == null || strlen($this->challenge) == 0 || $this->response == null || strlen($this->response) == 0)
 		{
-				return $user->lang['RECAPTCHA_INCORRECT'];
+			return $user->lang['RECAPTCHA_INCORRECT'];
 		}
 
-		$response = $this->_recaptcha_http_post ($this->recaptcha_verify_server, "/verify",
-										  array (
-												 'privatekey'	=> $config['recaptcha_privkey'],
-												 'remoteip'		=> $user->ip,
-												 'challenge'	=> $this->challenge,
-												 'response'		=> $this->response
-												 ) + $extra_params
-										  );
+		$response = $this->_recaptcha_http_post($this->recaptcha_verify_server, '/verify',
+			array(
+				'privatekey'	=> $config['recaptcha_privkey'],
+				'remoteip'		=> $user->ip,
+				'challenge'		=> $this->challenge,
+				'response'		=> $this->response
+			) + $extra_params
+		);
 
-		$answers = explode ("\n", $response[1]);
-		
-		if (trim ($answers[0]) === 'true') 
+		$answers = explode("\n", $response[1]);
+
+		if (trim($answers[0]) === 'true')
 		{
 			$this->solved = true;
 			return false;
 		}
-		else 
+		else
 		{
 			if ($answers[1] === 'incorrect-captcha-sol')
 			{
@@ -291,22 +293,24 @@ class phpbb_recaptcha extends phpbb_default_captcha
 			}
 		}
 	}
-	
-		/**
-	 * 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)
+
+	/**
+	* 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 )
+		foreach ($data as $key => $value)
 		{
-			$req .= $key . '=' . urlencode( stripslashes($value) ) . '&';
+			$req .= $key . '=' . urlencode(stripslashes($value)) . '&';
 		}
+
 		// Cut the last '&'
-		$req=substr($req,0,strlen($req)-1);
+		$req = substr($req, 0, strlen($req) - 1);
 		return $req;
 	}
 }
 
+?>