Diferencia entre revisiones de «Ejemplo de reCAPTCHA en KumbiaPHP»

De KumbiaPHP Framework Wiki
(Página creada con ''''Nota previa''' Este ejemplo esta sacado de la documentacion de reCAPTCHA y adaptado a un controlador/vista de KumbiaPHP. Seguramente, la inclusion de la librería se podrá h...')
 
(Deshecha la revisión 3756 de 200.87.129.134 (disc.))
 
(No se muestran 17 ediciones intermedias de 4 usuarios)
Línea 1: Línea 1:
'''Nota previa''' Este ejemplo esta sacado de la documentacion de reCAPTCHA y adaptado a un controlador/vista de KumbiaPHP. Seguramente, la inclusion de la librería se podrá hacer de alguna otra forma con funciones própias de KumbiaPHP, pero esta es mi forma de hacerlo con los conocimientos que tengo de KumbiaPHP.
+
{{cleanupbox
 
+
|image=[[Archivo:Information_icon4.png|45px]]
 +
|texto ='''Este Artículo cumple con todos los quererimientos de los Kumbieros.'''<br />
 +
}}
 +
== Pasos previos ==
 +
'''Nota previa''' Este ejemplo esta sacado de la documentacion de reCAPTCHA y adaptado a un controlador/vista de KumbiaPHP de forma básica. Se puede mejorar creando un helper, pero queda fuera del ejemplo :)
  
 
* Descargar la libreria [http://code.google.com/p/recaptcha/downloads/list?q=label:phplib-Latest reCAPTCHA], descomprimela y copia el fichero '''recaptchalib.php''' en ''/app/libs'' de tu arbol de directorios de KumbiaPHP.
 
* Descargar la libreria [http://code.google.com/p/recaptcha/downloads/list?q=label:phplib-Latest reCAPTCHA], descomprimela y copia el fichero '''recaptchalib.php''' en ''/app/libs'' de tu arbol de directorios de KumbiaPHP.
  
 
+
* Si no lo has hecho ya, [https://admin.recaptcha.net/accounts/signup/?next= registrate] y solicita una key de API en la web de reCAPTCHA. Es '''importante''' que al solicitar la key, se indique que es ''global'', de lo contrario solo servirá si se usa desde el domínio usado. Explicación: Si en la generación de la key se indica el domínio ''midominio.com'', si intentamos usar el ejemplo desde un a web con URL ''http://localhost'' o desde ''http://otrodominio.com'', no funcionará.
* Si no lo has hecho ya, [https://admin.recaptcha.net/accounts/signup/?next= registrate] y solicita una key de API en la web de reCAPTCHA.
 
  
  
* Crea el fichero '''recaptcha.php''' en ''app/libs/'' con el siguiente contenido, sustituyendo '''X''' e '''Y''' por tus API Key obtenidas.
+
== Pasos ==
 +
* Creamos un controlador, ''app/controllers/captcha_controller.php''. para el captcha:
 
<source lang=php >
 
<source lang=php >
<?php
+
<?php
include ("recaptchalib.php");
+
// Incluimos el fichero con la libreria y nuestra API Key
$publickey  = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
+
require_once APP_PATH. '/libs/recaptchalib.php';
$privatekey = "YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY";
 
?>
 
</source>
 
  
 +
class CaptchaController extends ApplicationController {
 +
public $publickey  = "6LePF7oSAAAAALYNEfbbOfRAc9lCz3LKvoKcQkwZ";
 +
public $privatekey = "6LePF7oSAAAAADRQBaACf7imDRSwq-kPXyZOCBCA";
  
* Ahora creamos un controlador para el captcha:
 
<source lang=php >
 
<?php
 
class CaptchaController extends ApplicationController {
 
 
public function index() {  
 
public function index() {  
// Incluimos el fichero con la libreria y nuestra API Key
 
require_once('../libs/recaptcha.php');
 
 
 
// Generamos el reCAPTCHA
 
// Generamos el reCAPTCHA
$this->Captcha = recaptcha_get_html($publickey);
+
$this->Captcha = recaptcha_get_html($this->publickey);
 
}  
 
}  
  
public function comprobar() {  
+
public function comprobar() {
// Incluimos el fichero con la libreria y nuestra API Key
 
require_once('../libs/recaptcha.php');
 
 
 
 
// Comprobamos que se haya rellenado el reCAPTCHA
 
// Comprobamos que se haya rellenado el reCAPTCHA
if ($_POST["recaptcha_response_field"]) {
+
if ($this->has_post("recaptcha_response_field")) {
 
// Realizamos la comprobacion
 
// Realizamos la comprobacion
$resp = recaptcha_check_answer ($privatekey,
+
$resp = recaptcha_check_answer ($this->privatekey,
                $_SERVER["REMOTE_ADDR"],
+
                $_SERVER['REMOTE_ADDR'],
                $_POST["recaptcha_challenge_field"],
+
                $this->post('recaptcha_challenge_field'),
                $_POST["recaptcha_response_field"]);
+
                $this->post('recaptcha_response_field'));
  
 
if ($resp->is_valid) {
 
if ($resp->is_valid) {
 
// Aqui seguría nuestra comprobacion del resto de los  
 
// Aqui seguría nuestra comprobacion del resto de los  
 
// datos del formulario
 
// datos del formulario
echo "You got it!"; die;
+
$Datos = $this->post('Datos');
 +
echo "Hi ".$Datos['nombre']."! You got it!"; die;;
 
} else {
 
} else {
 
// Capturamos el error para mostrarlo
 
// Capturamos el error para mostrarlo
Línea 56: Línea 51:
  
 
// Generamos un nuevo reCAPTCHA con el codigo de error obtenido
 
// Generamos un nuevo reCAPTCHA con el codigo de error obtenido
$this->Captcha = recaptcha_get_html($publickey, $error);
+
$this->Captcha = recaptcha_get_html($this->publickey, $error);
  
 
// Mostramos la misma vista que en el index
 
// Mostramos la misma vista que en el index
$this->render("index");
+
$this->render('index');
 
}
 
}
 
}
 
}
Línea 66: Línea 61:
  
  
* Por último, creamos la vista:
+
* Por último, creamos la vista, ''app/views/captcha/index.phtml'':
 
 
 
<source lang=php >
 
<source lang=php >
<b>Rellena el cuadro con tu nombre: </b>
+
<strong>Rellena el cuadro con tu nombre: </strong>
 
<?php  
 
<?php  
 
echo form_tag('captcha/comprobar');
 
echo form_tag('captcha/comprobar');
echo input_field_tag('DatosForm.nombre');
+
echo input_field_tag('Datos.nombre');
 
echo $Captcha;
 
echo $Captcha;
 
echo submit_tag('Enviar datos');
 
echo submit_tag('Enviar datos');
Línea 79: Línea 73:
  
  
 +
== Prueba ==
 
* Ya esta! Ahora ya puedes visitar la URL de tu controlador en http://''<tuhost>''/captcha y probarlo.
 
* Ya esta! Ahora ya puedes visitar la URL de tu controlador en http://''<tuhost>''/captcha y probarlo.
 +
 +
 +
== Explicacion ==
 +
He metido los comentarios que creo necesarios, pero por si acaso, el funcionamiento es el siguiente:
 +
# Se carga la liberia, para tener las funciones disponibles. No usamos Load::Lib() porque KumbiaPHP espera que haya una clase definida, y no es el caso de la librería reCaptcha. Si en un futuro los desarrolladores de reCaptcha proporcionan una clase, lo haremos con Load::Lib(), pero el objetivo es usar la clase tal cual nos la den.
 +
# Generamos en index() el HTML necesario, y lo mostramos en la vista.
 +
# El formulario nos envia a comprobar(), la cual comprueba si hemos recibido una respuesta (vía POST) del formulario.
 +
# De haberla recibido, pedimos al API de reCapcha que nos compruebe la respuesta, El resultado lo tenemos en ''is_valid'', y el mensaje de error (si lo hubiera) en ''error''.
 +
# Si la respuesta es válida, hariamos un redirect(), un route(), o grabariamos una sesion, cookie, etc. para seguir con nuestra aplicación. En caso contrario seguimos la ejecución.
 +
# Posteriomente, si tuvieramos más datos del formulario (nombre, apellidos, telefono, mail, etc), los volvemos a cargar para que la vista los tenga. Esto lo hago porque si se rellenan 10 datos, pero falla el captcha, que el usuario no tenga que volver a rellenar todo otra vez.
 +
# Por último, generamos otro captcha para mostrarlo como siguiente prueba y llamamos a la misma vista, para no repetir.
 +
 +
 +
Espero que esté claro!
 +
  
 
Saludos,
 
Saludos,

Revisión actual del 14:22 27 may 2014

{{#if:Information icon4.png |}}

{{#if:

|}}


Pasos previos[editar]

Nota previa Este ejemplo esta sacado de la documentacion de reCAPTCHA y adaptado a un controlador/vista de KumbiaPHP de forma básica. Se puede mejorar creando un helper, pero queda fuera del ejemplo :)

  • Descargar la libreria reCAPTCHA, descomprimela y copia el fichero recaptchalib.php en /app/libs de tu arbol de directorios de KumbiaPHP.
  • Si no lo has hecho ya, registrate y solicita una key de API en la web de reCAPTCHA. Es importante que al solicitar la key, se indique que es global, de lo contrario solo servirá si se usa desde el domínio usado. Explicación: Si en la generación de la key se indica el domínio midominio.com, si intentamos usar el ejemplo desde un a web con URL http://localhost o desde http://otrodominio.com, no funcionará.


Pasos[editar]

  • Creamos un controlador, app/controllers/captcha_controller.php. para el captcha:
<?php
// Incluimos el fichero con la libreria y nuestra API Key
require_once APP_PATH. '/libs/recaptchalib.php';

class CaptchaController extends ApplicationController {
	public $publickey  = "6LePF7oSAAAAALYNEfbbOfRAc9lCz3LKvoKcQkwZ";
 	public $privatekey = "6LePF7oSAAAAADRQBaACf7imDRSwq-kPXyZOCBCA";

	public function index() { 
		// Generamos el reCAPTCHA
		$this->Captcha = recaptcha_get_html($this->publickey);
	} 

	public function comprobar() { 		
		// Comprobamos que se haya rellenado el reCAPTCHA
		if ($this->has_post("recaptcha_response_field")) {
			// Realizamos la comprobacion
			$resp = recaptcha_check_answer ($this->privatekey,
		                $_SERVER['REMOTE_ADDR'],
		                $this->post('recaptcha_challenge_field'),
		                $this->post('recaptcha_response_field'));

			if ($resp->is_valid) {
				// Aqui seguría nuestra comprobacion del resto de los 
				// datos del formulario
				$Datos = $this->post('Datos');
				echo "Hi ".$Datos['nombre']."! You got it!"; die;;
			} else {
				// Capturamos el error para mostrarlo
				$error = $resp->error;
			}
		}

		// Si vienen datos de formulario, los enviamos a la vista de nuevo
		if ($this->has_post('Datos')) $this->Datos = $this->post('Datos');

		// Generamos un nuevo reCAPTCHA con el codigo de error obtenido
		$this->Captcha = recaptcha_get_html($this->publickey, $error);

		// Mostramos la misma vista que en el index
		$this->render('index');
	}
}
?>


  • Por último, creamos la vista, app/views/captcha/index.phtml:
<strong>Rellena el cuadro con tu nombre: </strong>
<?php 
	echo form_tag('captcha/comprobar');
	echo input_field_tag('Datos.nombre');
	echo $Captcha;	
	echo submit_tag('Enviar datos');
?>


Prueba[editar]

  • Ya esta! Ahora ya puedes visitar la URL de tu controlador en http://<tuhost>/captcha y probarlo.


Explicacion[editar]

He metido los comentarios que creo necesarios, pero por si acaso, el funcionamiento es el siguiente:

  1. Se carga la liberia, para tener las funciones disponibles. No usamos Load::Lib() porque KumbiaPHP espera que haya una clase definida, y no es el caso de la librería reCaptcha. Si en un futuro los desarrolladores de reCaptcha proporcionan una clase, lo haremos con Load::Lib(), pero el objetivo es usar la clase tal cual nos la den.
  2. Generamos en index() el HTML necesario, y lo mostramos en la vista.
  3. El formulario nos envia a comprobar(), la cual comprueba si hemos recibido una respuesta (vía POST) del formulario.
  4. De haberla recibido, pedimos al API de reCapcha que nos compruebe la respuesta, El resultado lo tenemos en is_valid, y el mensaje de error (si lo hubiera) en error.
  5. Si la respuesta es válida, hariamos un redirect(), un route(), o grabariamos una sesion, cookie, etc. para seguir con nuestra aplicación. En caso contrario seguimos la ejecución.
  6. Posteriomente, si tuvieramos más datos del formulario (nombre, apellidos, telefono, mail, etc), los volvemos a cargar para que la vista los tenga. Esto lo hago porque si se rellenan 10 datos, pero falla el captcha, que el usuario no tenga que volver a rellenar todo otra vez.
  7. Por último, generamos otro captcha para mostrarlo como siguiente prueba y llamamos a la misma vista, para no repetir.


Espero que esté claro!


Saludos, Soukron